o ɶd@sddlmZddlmZddlmZddlmZmZddlm Z ddl m Z m Z ddl mZddlmZmZmZd d lmZed ZGd d d eZdS))absolute_import)requests)six)retrycircuit_breaker) BaseClient)get_config_value_or_defaultvalidate_config)Signer)Sentinel#get_signer_from_authentication_typeAUTHENTICATION_TYPE_FIELD_NAME)cims_type_mappingZMissingc@sPeZdZdZddZddZddZdd Zd d Zd d Z ddZ ddZ dS)IncidentClienta Use the Support Management API to manage support requests. For more information, see [Getting Help and Contacting Support](/iaas/Content/GSG/Tasks/contactingsupport.htm). **Note**: Before you can create service requests with this API, you need to have an Oracle Single Sign On (SSO) account, and you need to register your Customer Support Identifier (CSI) with My Oracle Support. c Kst||ddd|vr|d}n"t|vrt|}nt|d|d|d|dt|d|dd }d |d d d i|dd|dtj|dd}d|vrY|d|d<|dduretj|d<d|vrp|d|d<t d||t fi||_ |d|_ |d|_ dS)a Creates a new service client :param dict config: Configuration keys and values as per `SDK and Tool Configuration `__. The :py:meth:`~oci.config.from_file` method can be used to load configuration from a file. Alternatively, a ``dict`` can be passed. You can validate_config the dict using :py:meth:`~oci.config.validate_config` :param str service_endpoint: (optional) The endpoint of the service to call using this client. For example ``https://iaas.us-ashburn-1.oraclecloud.com``. If this keyword argument is not provided then it will be derived using the region in the config parameter. You should only provide this keyword argument if you have an explicit need to specify a service endpoint. :param timeout: (optional) The connection and read timeouts for the client. The default values are connection timeout 10 seconds and read timeout 60 seconds. This keyword argument can be provided as a single float, in which case the value provided is used for both the read and connection timeouts, or as a tuple of two floats. If a tuple is provided then the first value is used as the connection timeout and the second value as the read timeout. :type timeout: float or tuple(float, float) :param signer: (optional) The signer to use when signing requests made by the service client. The default is to use a :py:class:`~oci.signer.Signer` based on the values provided in the config parameter. One use case for this parameter is for `Instance Principals authentication `__ by passing an instance of :py:class:`~oci.auth.signers.InstancePrincipalsSecurityTokenSigner` as the value for this keyword argument :type signer: :py:class:`~oci.signer.AbstractBaseSigner` :param obj retry_strategy: (optional) A retry strategy to apply to all calls made by this service client (i.e. at the client level). There is no retry strategy applied by default. Retry strategies can also be applied at the operation level by passing a ``retry_strategy`` keyword argument as part of calling the operation. Any value provided at the operation level will override whatever is specified at the client level. This should be one of the strategies available in the :py:mod:`~oci.retry` module. A convenience :py:data:`~oci.retry.DEFAULT_RETRY_STRATEGY` is also available. The specifics of the default retry strategy are described `here `__. :param obj circuit_breaker_strategy: (optional) A circuit breaker strategy to apply to all calls made by this service client (i.e. at the client level). This client uses :py:data:`~oci.circuit_breaker.DEFAULT_CIRCUIT_BREAKER_STRATEGY` as default if no circuit breaker strategy is provided. The specifics of circuit breaker strategy are described `here `__. :param function circuit_breaker_callback: (optional) Callback function to receive any exceptions triggerred by the circuit breaker. :param bool client_level_realm_specific_endpoint_template_enabled: (optional) A boolean flag to indicate whether or not this client should be created with realm specific endpoint template enabled or disable. By default, this will be set as None. :param allow_control_chars: (optional) allow_control_chars is a boolean to indicate whether or not this client should allow control characters in the response object. By default, the client will not allow control characters to be in the response object. signer)rtenancyuser fingerprintZkey_file pass_phraseZ key_content)rrrZprivate_key_file_locationrZprivate_key_contentTservice_endpointz /20181231z7https://incidentmanagement.{region}.{secondLevelDomain}skip_deserializationFcircuit_breaker_strategy5client_level_realm_specific_endpoint_template_enabled)Zregional_clientr base_pathZservice_endpoint_templateZ#service_endpoint_template_per_realmrrrtimeoutNallow_control_charsZincidentretry_strategycircuit_breaker_callback)r getr r r rrZGLOBAL_CIRCUIT_BREAKER_STRATEGYZ DEFAULT_CIRCUIT_BREAKER_STRATEGYrr base_clientrr)selfconfigkwargsrZbase_client_init_kwargsr$3        zIncidentClient.__init__c sg}d}d}d}d}gdfddt|D} | r#td| d d |d t||d td } d dt| D} |jj|d|j d} | rqt | t j s]|j | | |j| j|jj||| |d|d|||d S|jj||| |d|d|||d S)a Enables the customer to create an support ticket. :param oci.cims.models.CreateIncident create_incident_details: (required) Incident information :param str ocid: (required) User OCID for Oracle Identity Cloud Service (IDCS) users who also have a federated Oracle Cloud Infrastructure account. :param str opc_request_id: (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. :param str homeregion: (optional) The region of the tenancy. :param obj retry_strategy: (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the :py:mod:`~oci.retry` module. This operation will not retry by default, users can also use the convenient :py:data:`~oci.retry.DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described `here `__. To have this operation explicitly not perform any retries, pass an instance of :py:class:`~oci.retry.NoneRetryStrategy`. :param bool allow_control_chars: (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.cims.models.Incident` :rtype: :class:`~oci.response.Response` :example: Click `here `__ to see an example of how to use create_incident API. /v2/incidentsZPOSTcreate_incidentzYhttps://docs.oracle.com/iaas/api/#/en/incidentmanagement/20181231/Incident/CreateIncidentrropc_request_id homeregioncg|]}|vr|qSr$r$.0_keyZexpected_kwargsr$r% z2IncidentClient.create_incident..z(create_incident got unknown kwargs: {!r}application/jsonr*r+accept content-typeopc-request-idocidr+cS&i|]\}}|tur|dur||qSNmissingr.kvr$r$r% &z2IncidentClient.create_incident..rZoperation_retry_strategyZclient_retry_strategyIncidentr) resource_pathmethod header_paramsbody response_typeroperation_nameapi_reference_linkrequired_argumentsriterkeys ValueErrorformatrr< iteritemsr get_preferred_retry_strategyr isinstancerNoneRetryStrategyadd_opc_client_retries_headeradd_circuit_breaker_callbackrmake_retrying_callcall_api) r!Zcreate_incident_detailsr8r#rKrDrErIrJ extra_kwargsrFrr$r0r%r(rsb$      zIncidentClient.create_incidentc svdg}d}d}d}d} gdfddt|D} | r$td | d|i} d d t| D} t| D]\} } | d usMt| tjrTt| d krTtd| q7dd| dt ||| dt | dt d}dd t|D}|j j | d|j d}|rt|tjs|j |||j|j|j j||| |d| d|| |d S|j j||| |d| d|| |d S)a Gets the details of the support ticket. :param str incident_key: (required) Unique identifier for the support ticket. :param str csi: (required) The Customer Support Identifier associated with the support account. :param str ocid: (required) User OCID for Oracle Identity Cloud Service (IDCS) users who also have a federated Oracle Cloud Infrastructure account. :param str opc_request_id: (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. :param str homeregion: (optional) The region of the tenancy. :param str problem_type: (optional) The kind of support request. :param obj retry_strategy: (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the :py:mod:`~oci.retry` module. This operation will not retry by default, users can also use the convenient :py:data:`~oci.retry.DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described `here `__. To have this operation explicitly not perform any retries, pass an instance of :py:class:`~oci.retry.NoneRetryStrategy`. :param bool allow_control_chars: (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.cims.models.Incident` :rtype: :class:`~oci.response.Response` :example: Click `here `__ to see an example of how to use get_incident API. incidentKey/v2/incidents/{incidentKey}GET get_incidentzVhttps://docs.oracle.com/iaas/api/#/en/incidentmanagement/20181231/Incident/GetIncident)rrr*r+ problem_typecr,r$r$r-r0r$r%r1 r2z/IncidentClient.get_incident..z%get_incident got unknown kwargs: {!r}cSi|] \}}|tur||qSr$r;r=r$r$r%r@z/IncidentClient.get_incident..Nr7Parameter {} cannot be None, whitespace or empty stringr3r*r+r])r5r6r7csir8r+z problem-typecSr9r:r;r=r$r$r%r@!rArrBrCr rDrE path_paramsrFrHrrIrJrKrrMrNrOrPrRZ string_typeslenstriprr<r rQrrrSrTrUrrVrW)r! incident_keyrar8r#rKrDrErIrJrXrcr>r?rFrr$r0r%r\st*$        zIncidentClient.get_incidentc sjdg}d}d}d}d}gdfddt|D} | r$td | d|i} d d t| D} t| D]\} } | d usMt| tjrTt| d krTtd| q7dd| dt || dt d} dd t| D} |j j | d|j d}|rt|tjs|j | ||j|j|j j||| | d| d|||d S|j j||| | d| d|||d S)a Gets the status of the service. :param str source: (required) The system that generated the support ticket, such as My Oracle Support. :param str ocid: (required) User OCID for Oracle Identity Cloud Service (IDCS) users who also have a federated Oracle Cloud Infrastructure account. :param str opc_request_id: (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. :param str homeregion: (optional) The region of the tenancy. :param obj retry_strategy: (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the :py:mod:`~oci.retry` module. This operation will not retry by default, users can also use the convenient :py:data:`~oci.retry.DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described `here `__. To have this operation explicitly not perform any retries, pass an instance of :py:class:`~oci.retry.NoneRetryStrategy`. :param bool allow_control_chars: (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.cims.models.Status` :rtype: :class:`~oci.response.Response` :example: Click `here `__ to see an example of how to use get_status API. sourcez/v2/incidents/status/{source}r[ get_statuszRhttps://docs.oracle.com/iaas/api/#/en/incidentmanagement/20181231/Status/GetStatusr)cr,r$r$r-r0r$r%r1tr2z-IncidentClient.get_status..z#get_status got unknown kwargs: {!r}cSr^r$r;r=r$r$r%r@}r_z-IncidentClient.get_status..Nrr`r3r*r+r4cSr9r:r;r=r$r$r%r@rArrBZStatusrrbrd)r!rhr8r#rKrDrErIrJrXrcr>r?rFrr$r0r%riCsp$$      zIncidentClient.get_statusc sddg}d}d}d} d} gdfdd t|D} | r%td | d |vr:d d g} |d | vr:td| d|vrOddg} |d| vrOtd| ||dt|dt|d t|dt||dtd}ddt|D}dd|dt|||dtd}ddt|D}|jj|d|j d}|rt |t j s|j |||j|j|jj||||d |d!| | |d" S|jj||||d |d!| | |d" S)#a During support ticket creation, returns the list of all possible products that Oracle Cloud Infrastructure supports. :param str problem_type: (required) The kind of support request. :param str compartment_id: (required) The OCID of the tenancy. :param str csi: (required) The Customer Support Identifier associated with the support account. :param str ocid: (required) User OCID for Oracle Identity Cloud Service (IDCS) users who also have a federated Oracle Cloud Infrastructure account. :param str opc_request_id: (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. :param int limit: (optional) For list pagination. The maximum number of results per page, or items to return in a paginated "List" call. For important details about how pagination works, see `List Pagination`__. __ https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine :param str page: (optional) For list pagination. The value of the `opc-next-page` response header from the previous "List" call. For important details about how pagination works, see `List Pagination`__. __ https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine :param str sort_by: (optional) The key to use to sort the returned items. Allowed values are: "dateUpdated", "severity" :param str sort_order: (optional) The order to sort the results in. Allowed values are: "ASC", "DESC" :param str name: (optional) The user-friendly name of the incident type. :param str homeregion: (optional) The region of the tenancy. :param obj retry_strategy: (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the :py:mod:`~oci.retry` module. This operation will not retry by default, users can also use the convenient :py:data:`~oci.retry.DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described `here `__. To have this operation explicitly not perform any retries, pass an instance of :py:class:`~oci.retry.NoneRetryStrategy`. :param bool allow_control_chars: (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings :return: A :class:`~oci.response.Response` object with data of type list of :class:`~oci.cims.models.IncidentResourceType` :rtype: :class:`~oci.response.Response` :example: Click `here `__ to see an example of how to use list_incident_resource_types API. problemType compartmentIdz#/v2/incidents/incidentResourceTypesr[list_incident_resource_typeszphttps://docs.oracle.com/iaas/api/#/en/incidentmanagement/20181231/IncidentResourceType/ListIncidentResourceTypes) rrr*limitpagesort_by sort_ordernamer+cr,r$r$r-r0r$r%r1r2z?IncidentClient.list_incident_resource_types..z5list_incident_resource_types got unknown kwargs: {!r}ro dateUpdatedseverity/Invalid value for `sort_by`, must be one of {0}rpASCDESC2Invalid value for `sort_order`, must be one of {0}rmrnrq)rjrmrnsortBy sortOrderrkrqcSr9r:r;r=r$r$r%r@rAz?IncidentClient.list_incident_resource_types..r3r*r+)r5r6r7rar8r+cSr9r:r;r=r$r$r%r@%rArrBzlist[IncidentResourceType]r rDrE query_paramsrFrHrrIrJrKrL)r!r]compartment_idrar8r#rKrDrErIrJrXsort_by_allowed_valuessort_order_allowed_valuesr{rFrr$r0r%rlsA               z+IncidentClient.list_incident_resource_typesc sdg}d}d}d}d} gdfddt|D} | r$td | d |vr9d d g} |d | vr9td | d|vrNddg} |d| vrNtd| d|vrcddg} |d| vrctd| |dt||d t|dt|dt|dt|dtd}ddt|D}dd||dt||dtd}d dt|D}|jj|d!|j d"}|rt |t j s|j |||j|j|jj||||d#|d$|| |d% S|jj||||d#|d$|| |d% S)&a Returns the list of support tickets raised by the tenancy. :param str csi: (required) The Customer Support Identifier associated with the support account. :param str compartment_id: (required) The OCID of the tenancy. :param str ocid: (required) User OCID for Oracle Identity Cloud Service (IDCS) users who also have a federated Oracle Cloud Infrastructure account. :param int limit: (optional) For list pagination. The maximum number of results per page, or items to return in a paginated "List" call. For important details about how pagination works, see `List Pagination`__. __ https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine :param str sort_by: (optional) The key to use to sort the returned items. Allowed values are: "dateUpdated", "severity" :param str sort_order: (optional) The order to sort the results in. Allowed values are: "ASC", "DESC" :param str lifecycle_state: (optional) The current state of the ticket. Allowed values are: "ACTIVE", "CLOSED" :param str page: (optional) For list pagination. The value of the `opc-next-page` response header from the previous "List" call. For important details about how pagination works, see `List Pagination`__. __ https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine :param str opc_request_id: (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. :param str homeregion: (optional) The region of the tenancy. :param str problem_type: (optional) The kind of support request. :param obj retry_strategy: (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the :py:mod:`~oci.retry` module. This operation will not retry by default, users can also use the convenient :py:data:`~oci.retry.DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described `here `__. To have this operation explicitly not perform any retries, pass an instance of :py:class:`~oci.retry.NoneRetryStrategy`. :param bool allow_control_chars: (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings :return: A :class:`~oci.response.Response` object with data of type list of :class:`~oci.cims.models.IncidentSummary` :rtype: :class:`~oci.response.Response` :example: Click `here `__ to see an example of how to use list_incidents API. rkr'r[list_incidentsz_https://docs.oracle.com/iaas/api/#/en/incidentmanagement/20181231/IncidentSummary/ListIncidents) rrrmrorplifecycle_staternr*r+r]cr,r$r$r-r0r$r%r1r2z1IncidentClient.list_incidents..z'list_incidents got unknown kwargs: {!r}rorrrsrtrprurvrwrZACTIVEZCLOSEDz7Invalid value for `lifecycle_state`, must be one of {0}rmrnr])rmrkrxryZlifecycleStaternrjcSr9r:r;r=r$r$r%r@rAz1IncidentClient.list_incidents..r3r*r+r5r6rar7r8r+cSr9r:r;r=r$r$r%r@rArrBzlist[IncidentSummary]rrzrL)r!rar|r8r#rKrDrErIrJrXr}r~Zlifecycle_state_allowed_valuesr{rFrr$r0r%rGsC                 zIncidentClient.list_incidentsc szdg}d}d}d} d} gdfddt|D} | r$td | d|i} d d t| D} t| D]\} }|d usMt|tjrTt|d krTtd| q7dd|| dt | dt || dt d}dd t|D}|j j | d|j d}|rt|tjs|j |||j|j|j j||| ||d| d| | |d S|j j||| ||d| d| | |d S)a2 Updates the specified support ticket's information. :param str incident_key: (required) Unique identifier for the support ticket. :param str csi: (required) The Customer Support Identifier associated with the support account. :param oci.cims.models.UpdateIncident update_incident_details: (required) Details about the support ticket being updated. :param str ocid: (required) User OCID for Oracle Identity Cloud Service (IDCS) users who also have a federated Oracle Cloud Infrastructure account. :param str opc_request_id: (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. :param str if_match: (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match` parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value. :param str homeregion: (optional) The region of the tenancy. :param obj retry_strategy: (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the :py:mod:`~oci.retry` module. This operation will not retry by default, users can also use the convenient :py:data:`~oci.retry.DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described `here `__. To have this operation explicitly not perform any retries, pass an instance of :py:class:`~oci.retry.NoneRetryStrategy`. :param bool allow_control_chars: (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.cims.models.Incident` :rtype: :class:`~oci.response.Response` :example: Click `here `__ to see an example of how to use update_incident API. rYrZZPUTupdate_incidentz_https://docs.oracle.com/iaas/api/#/en/incidentmanagement/20181231/UpdateIncident/UpdateIncident)rrr*if_matchr+cr,r$r$r-r0r$r%r1'r2z2IncidentClient.update_incident..z(update_incident got unknown kwargs: {!r}cSr^r$r;r=r$r$r%r@0r_z2IncidentClient.update_incident..Nrr`r3r*rr+)r5r6rar7zif-matchr8r+cSr9r:r;r=r$r$r%r@?rArrBrCr) rDrErcrFrGrHrrIrJrKrd)r!rgraZupdate_incident_detailsr8r#rKrDrErIrJrXrcr>r?rFrr$r0r%rsx-$        zIncidentClient.update_incidentc s,g}d}d}d}d}gdfddt|D} | r#td| d |d ti} d d t| D} d d ||dt||dtd} dd t| D} |jj|d|j d} | rt | t j sp|j | | |j| j|jj||| | d|d|||d S|jj||| | d|d|||d S)a. Checks whether the requested user is valid. :param str csi: (required) The Customer Support Identifier number for the support account. :param str ocid: (required) User OCID for Oracle Identity Cloud Service (IDCS) users who also have a federated Oracle Cloud Infrastructure account. :param str opc_request_id: (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. :param str problem_type: (optional) The kind of support request. :param str homeregion: (optional) The region of the tenancy. :param obj retry_strategy: (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the :py:mod:`~oci.retry` module. This operation will not retry by default, users can also use the convenient :py:data:`~oci.retry.DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described `here `__. To have this operation explicitly not perform any retries, pass an instance of :py:class:`~oci.retry.NoneRetryStrategy`. :param bool allow_control_chars: (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.cims.models.ValidationResponse` :rtype: :class:`~oci.response.Response` :example: Click `here `__ to see an example of how to use validate_user API. z/v2/incidents/user/validater[ validate_userzahttps://docs.oracle.com/iaas/api/#/en/incidentmanagement/20181231/ValidationResponse/ValidateUser)rrr*r]r+cr,r$r$r-r0r$r%r1r2z0IncidentClient.validate_user..z&validate_user got unknown kwargs: {!r}rjr]cSr9r:r;r=r$r$r%r@rAz0IncidentClient.validate_user..r3r*r+rcSr9r:r;r=r$r$r%r@rArrBZValidationResponserrzrL) r!rar8r#rKrDrErIrJrXr{rFrr$r0r%rcsj'       zIncidentClient.validate_userN) __name__ __module__ __qualname____doc__r&r(r\rirlrrrr$r$r$r%rsX_ri& wrN) __future__rZ oci._vendorrrocirrZoci.base_clientrZ oci.configrr Z oci.signerr Zoci.utilr r r Zmodelsrr<objectrr$r$r$r%s