egain-api-python 0.1.1__py3-none-any.whl

egain_api_python/escalation.py

@@ -0,0 +1,955 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from .basesdk import BaseSDK
+from egain_api_python import errors, models, utils
+from egain_api_python._hooks import HookContext
+from egain_api_python.types import OptionalNullable, UNSET
+from egain_api_python.utils import get_security_from_env
+from egain_api_python.utils.unmarshal_json_response import unmarshal_json_response
+from typing import Any, Mapping, Optional, Union
+
+
+class Escalation(BaseSDK):
+    def start_customer_escalation(
+        self,
+        *,
+        accept_language: models.AcceptLanguage,
+        portal_id: str,
+        language: models.MandatoryLanguageQueryParameter,
+        subject: str,
+        body: str,
+        channel: models.ChannelEnum,
+        url: str,
+        customer: Optional[Union[models.Customer, models.CustomerTypedDict]] = None,
+        captcha: Optional[Union[models.Captcha, models.CaptchaTypedDict]] = None,
+        retries: OptionalNullable[utils.RetryConfig] = UNSET,
+        server_url: Optional[str] = None,
+        timeout_ms: Optional[int] = None,
+        http_headers: Optional[Mapping[str, str]] = None,
+    ) -> models.StartCustomerEscalationResponse:
+        r"""Start Customer Escalation
+
+        ## Overview
+        The Start Escalation API is called to initiate an escalation and it must be called before any other escalation API.
+        An escalation occurs when a customer is referred to a higher level of support, such as chat or email, to address their issue.
+        This process is initiated when the initial support resources are insufficient by themselves.
+
+        Customer object is optional for authenticated customers. Values provided in request takes precedence over the values provided during customer registration.
+
+
+        :param accept_language: The Language locale accepted by the client (used for locale specific fields in resource representation and in error responses).
+        :param portal_id: The ID of the portal being accessed.<br><br>A portal ID is composed of a 2-4 letter prefix, followed by a dash and 4-15 digits.
+        :param language: The language used for fetching the details of a resource. Resources available in different languages may differ from each other.
+        :param subject: The subject of the email message.
+        :param body: The body of the email message.
+        :param channel: The type of escalation
+        :param url: The url of the page that the customer was viewing at the time when the ecalation started.
+        :param customer: The contact point details of the customer who is starting the escalation.
+        :param captcha: Only required when captcha is enabled for portal.
+        :param retries: Override the default retry configuration for this method
+        :param server_url: Override the default server URL for this method
+        :param timeout_ms: Override the default request timeout configuration for this method in milliseconds
+        :param http_headers: Additional headers to set or replace on requests.
+        """
+        base_url = None
+        url_variables = None
+        if timeout_ms is None:
+            timeout_ms = self.sdk_configuration.timeout_ms
+
+        if server_url is not None:
+            base_url = server_url
+        else:
+            base_url = self._get_url(base_url, url_variables)
+
+        request = models.StartCustomerEscalationRequest(
+            accept_language=accept_language,
+            portal_id=portal_id,
+            language=language,
+            start_escalation_request=models.StartEscalationRequest(
+                customer=utils.get_pydantic_model(customer, Optional[models.Customer]),
+                subject=subject,
+                body=body,
+                channel=channel,
+                url=url,
+                captcha=utils.get_pydantic_model(captcha, Optional[models.Captcha]),
+            ),
+        )
+
+        req = self._build_request(
+            method="POST",
+            path="/portals/{portalID}/escalate",
+            base_url=base_url,
+            url_variables=url_variables,
+            request=request,
+            request_body_required=True,
+            request_has_path_params=True,
+            request_has_query_params=True,
+            user_agent_header="user-agent",
+            accept_header_value="application/json",
+            http_headers=http_headers,
+            security=self.sdk_configuration.security,
+            get_serialized_body=lambda: utils.serialize_request_body(
+                request.start_escalation_request,
+                False,
+                False,
+                "json",
+                models.StartEscalationRequest,
+            ),
+            timeout_ms=timeout_ms,
+        )
+
+        if retries == UNSET:
+            if self.sdk_configuration.retry_config is not UNSET:
+                retries = self.sdk_configuration.retry_config
+
+        retry_config = None
+        if isinstance(retries, utils.RetryConfig):
+            retry_config = (retries, ["429", "500", "502", "503", "504"])
+
+        http_res = self.do_request(
+            hook_ctx=HookContext(
+                config=self.sdk_configuration,
+                base_url=base_url or "",
+                operation_id="startCustomerEscalation",
+                oauth2_scopes=[],
+                security_source=get_security_from_env(
+                    self.sdk_configuration.security, models.Security
+                ),
+            ),
+            request=req,
+            error_status_codes=["400", "401", "403", "406", "415", "4XX", "500", "5XX"],
+            retry_config=retry_config,
+        )
+
+        response_data: Any = None
+        if utils.match_response(http_res, "201", "*"):
+            return models.StartCustomerEscalationResponse(
+                headers=utils.get_response_headers(http_res.headers)
+            )
+        if utils.match_response(
+            http_res, ["400", "401", "403", "406"], "application/json"
+        ):
+            response_data = unmarshal_json_response(errors.WSErrorCommonData, http_res)
+            raise errors.WSErrorCommon(response_data, http_res)
+        if utils.match_response(http_res, "500", "application/json"):
+            response_data = unmarshal_json_response(errors.WSErrorCommonData, http_res)
+            raise errors.WSErrorCommon(response_data, http_res)
+        if utils.match_response(http_res, ["415", "4XX"], "*"):
+            http_res_text = utils.stream_to_text(http_res)
+            raise errors.EgainDefaultError(
+                "API error occurred", http_res, http_res_text
+            )
+        if utils.match_response(http_res, "5XX", "*"):
+            http_res_text = utils.stream_to_text(http_res)
+            raise errors.EgainDefaultError(
+                "API error occurred", http_res, http_res_text
+            )
+
+        raise errors.EgainDefaultError("Unexpected response received", http_res)
+
+    async def start_customer_escalation_async(
+        self,
+        *,
+        accept_language: models.AcceptLanguage,
+        portal_id: str,
+        language: models.MandatoryLanguageQueryParameter,
+        subject: str,
+        body: str,
+        channel: models.ChannelEnum,
+        url: str,
+        customer: Optional[Union[models.Customer, models.CustomerTypedDict]] = None,
+        captcha: Optional[Union[models.Captcha, models.CaptchaTypedDict]] = None,
+        retries: OptionalNullable[utils.RetryConfig] = UNSET,
+        server_url: Optional[str] = None,
+        timeout_ms: Optional[int] = None,
+        http_headers: Optional[Mapping[str, str]] = None,
+    ) -> models.StartCustomerEscalationResponse:
+        r"""Start Customer Escalation
+
+        ## Overview
+        The Start Escalation API is called to initiate an escalation and it must be called before any other escalation API.
+        An escalation occurs when a customer is referred to a higher level of support, such as chat or email, to address their issue.
+        This process is initiated when the initial support resources are insufficient by themselves.
+
+        Customer object is optional for authenticated customers. Values provided in request takes precedence over the values provided during customer registration.
+
+
+        :param accept_language: The Language locale accepted by the client (used for locale specific fields in resource representation and in error responses).
+        :param portal_id: The ID of the portal being accessed.<br><br>A portal ID is composed of a 2-4 letter prefix, followed by a dash and 4-15 digits.
+        :param language: The language used for fetching the details of a resource. Resources available in different languages may differ from each other.
+        :param subject: The subject of the email message.
+        :param body: The body of the email message.
+        :param channel: The type of escalation
+        :param url: The url of the page that the customer was viewing at the time when the ecalation started.
+        :param customer: The contact point details of the customer who is starting the escalation.
+        :param captcha: Only required when captcha is enabled for portal.
+        :param retries: Override the default retry configuration for this method
+        :param server_url: Override the default server URL for this method
+        :param timeout_ms: Override the default request timeout configuration for this method in milliseconds
+        :param http_headers: Additional headers to set or replace on requests.
+        """
+        base_url = None
+        url_variables = None
+        if timeout_ms is None:
+            timeout_ms = self.sdk_configuration.timeout_ms
+
+        if server_url is not None:
+            base_url = server_url
+        else:
+            base_url = self._get_url(base_url, url_variables)
+
+        request = models.StartCustomerEscalationRequest(
+            accept_language=accept_language,
+            portal_id=portal_id,
+            language=language,
+            start_escalation_request=models.StartEscalationRequest(
+                customer=utils.get_pydantic_model(customer, Optional[models.Customer]),
+                subject=subject,
+                body=body,
+                channel=channel,
+                url=url,
+                captcha=utils.get_pydantic_model(captcha, Optional[models.Captcha]),
+            ),
+        )
+
+        req = self._build_request_async(
+            method="POST",
+            path="/portals/{portalID}/escalate",
+            base_url=base_url,
+            url_variables=url_variables,
+            request=request,
+            request_body_required=True,
+            request_has_path_params=True,
+            request_has_query_params=True,
+            user_agent_header="user-agent",
+            accept_header_value="application/json",
+            http_headers=http_headers,
+            security=self.sdk_configuration.security,
+            get_serialized_body=lambda: utils.serialize_request_body(
+                request.start_escalation_request,
+                False,
+                False,
+                "json",
+                models.StartEscalationRequest,
+            ),
+            timeout_ms=timeout_ms,
+        )
+
+        if retries == UNSET:
+            if self.sdk_configuration.retry_config is not UNSET:
+                retries = self.sdk_configuration.retry_config
+
+        retry_config = None
+        if isinstance(retries, utils.RetryConfig):
+            retry_config = (retries, ["429", "500", "502", "503", "504"])
+
+        http_res = await self.do_request_async(
+            hook_ctx=HookContext(
+                config=self.sdk_configuration,
+                base_url=base_url or "",
+                operation_id="startCustomerEscalation",
+                oauth2_scopes=[],
+                security_source=get_security_from_env(
+                    self.sdk_configuration.security, models.Security
+                ),
+            ),
+            request=req,
+            error_status_codes=["400", "401", "403", "406", "415", "4XX", "500", "5XX"],
+            retry_config=retry_config,
+        )
+
+        response_data: Any = None
+        if utils.match_response(http_res, "201", "*"):
+            return models.StartCustomerEscalationResponse(
+                headers=utils.get_response_headers(http_res.headers)
+            )
+        if utils.match_response(
+            http_res, ["400", "401", "403", "406"], "application/json"
+        ):
+            response_data = unmarshal_json_response(errors.WSErrorCommonData, http_res)
+            raise errors.WSErrorCommon(response_data, http_res)
+        if utils.match_response(http_res, "500", "application/json"):
+            response_data = unmarshal_json_response(errors.WSErrorCommonData, http_res)
+            raise errors.WSErrorCommon(response_data, http_res)
+        if utils.match_response(http_res, ["415", "4XX"], "*"):
+            http_res_text = await utils.stream_to_text_async(http_res)
+            raise errors.EgainDefaultError(
+                "API error occurred", http_res, http_res_text
+            )
+        if utils.match_response(http_res, "5XX", "*"):
+            http_res_text = await utils.stream_to_text_async(http_res)
+            raise errors.EgainDefaultError(
+                "API error occurred", http_res, http_res_text
+            )
+
+        raise errors.EgainDefaultError("Unexpected response received", http_res)
+
+    def search_prior_to_escalation(
+        self,
+        *,
+        accept_language: models.AcceptLanguage,
+        portal_id: str,
+        escalation_id: str,
+        filter_articles_in_topic_tree: Optional[str] = None,
+        additional_attributes: Optional[models.OptionalArticleAttributes] = None,
+        max_results: Optional[int] = None,
+        pagenum: Optional[int] = 1,
+        pagesize: Optional[int] = 25,
+        retries: OptionalNullable[utils.RetryConfig] = UNSET,
+        server_url: Optional[str] = None,
+        timeout_ms: Optional[int] = None,
+        http_headers: Optional[Mapping[str, str]] = None,
+    ) -> Optional[models.ArticleSearchResults]:
+        r"""Search Prior To Customer Escalation
+
+        ## Overview
+        The Search Prior to Customer Escalation API performs search on the subject and description parameters, but filters out any articles that the customer has viewed in the current session.
+
+
+        :param accept_language: The Language locale accepted by the client (used for locale specific fields in resource representation and in error responses).
+        :param portal_id: The ID of the portal being accessed.<br><br>A portal ID is composed of a 2-4 letter prefix, followed by a dash and 4-15 digits.
+        :param escalation_id: The ID (uuid) of the customer escalation.
+        :param filter_articles_in_topic_tree: This parameter will restrict the search scope to the provided topic and it's sub topic.
+        :param additional_attributes: The fields of the article to be returned.
+        :param max_results: The \"maxResults\" parameter specifies the number of articles that should be included in the response.  It is only required when the escalation type is chat escalation.If not specified then default value 5 will be considered for chat escalation.  If the escalation type is email, the maximum results value specified in the portal settings for email escalation will be taken into consideration.
+        :param pagenum: Pagination parameter that specifies the page number of results to be returned. Used in conjunction with $pagesize.
+        :param pagesize: Pagination parameter that specifies the number of results per page. Used in conjunction with $pagenum.<br>Valid range of 5-75<br>_Default value_: 25
+        :param retries: Override the default retry configuration for this method
+        :param server_url: Override the default server URL for this method
+        :param timeout_ms: Override the default request timeout configuration for this method in milliseconds
+        :param http_headers: Additional headers to set or replace on requests.
+        """
+        base_url = None
+        url_variables = None
+        if timeout_ms is None:
+            timeout_ms = self.sdk_configuration.timeout_ms
+
+        if server_url is not None:
+            base_url = server_url
+        else:
+            base_url = self._get_url(base_url, url_variables)
+
+        request = models.SearchPriorToEscalationRequest(
+            accept_language=accept_language,
+            portal_id=portal_id,
+            escalation_id=escalation_id,
+            filter_articles_in_topic_tree=filter_articles_in_topic_tree,
+            additional_attributes=additional_attributes,
+            max_results=max_results,
+            pagenum=pagenum,
+            pagesize=pagesize,
+        )
+
+        req = self._build_request(
+            method="GET",
+            path="/portals/{portalID}/escalate/{escalationId}/search",
+            base_url=base_url,
+            url_variables=url_variables,
+            request=request,
+            request_body_required=False,
+            request_has_path_params=True,
+            request_has_query_params=True,
+            user_agent_header="user-agent",
+            accept_header_value="application/json",
+            http_headers=http_headers,
+            security=self.sdk_configuration.security,
+            timeout_ms=timeout_ms,
+        )
+
+        if retries == UNSET:
+            if self.sdk_configuration.retry_config is not UNSET:
+                retries = self.sdk_configuration.retry_config
+
+        retry_config = None
+        if isinstance(retries, utils.RetryConfig):
+            retry_config = (retries, ["429", "500", "502", "503", "504"])
+
+        http_res = self.do_request(
+            hook_ctx=HookContext(
+                config=self.sdk_configuration,
+                base_url=base_url or "",
+                operation_id="searchPriorToEscalation",
+                oauth2_scopes=[],
+                security_source=get_security_from_env(
+                    self.sdk_configuration.security, models.Security
+                ),
+            ),
+            request=req,
+            error_status_codes=["400", "401", "403", "406", "4XX", "500", "5XX"],
+            retry_config=retry_config,
+        )
+
+        response_data: Any = None
+        if utils.match_response(http_res, "200", "application/json"):
+            return unmarshal_json_response(models.ArticleSearchResults, http_res)
+        if utils.match_response(http_res, "204", "*"):
+            return None
+        if utils.match_response(
+            http_res, ["400", "401", "403", "406"], "application/json"
+        ):
+            response_data = unmarshal_json_response(errors.WSErrorCommonData, http_res)
+            raise errors.WSErrorCommon(response_data, http_res)
+        if utils.match_response(http_res, "500", "application/json"):
+            response_data = unmarshal_json_response(errors.WSErrorCommonData, http_res)
+            raise errors.WSErrorCommon(response_data, http_res)
+        if utils.match_response(http_res, "4XX", "*"):
+            http_res_text = utils.stream_to_text(http_res)
+            raise errors.EgainDefaultError(
+                "API error occurred", http_res, http_res_text
+            )
+        if utils.match_response(http_res, "5XX", "*"):
+            http_res_text = utils.stream_to_text(http_res)
+            raise errors.EgainDefaultError(
+                "API error occurred", http_res, http_res_text
+            )
+
+        raise errors.EgainDefaultError("Unexpected response received", http_res)
+
+    async def search_prior_to_escalation_async(
+        self,
+        *,
+        accept_language: models.AcceptLanguage,
+        portal_id: str,
+        escalation_id: str,
+        filter_articles_in_topic_tree: Optional[str] = None,
+        additional_attributes: Optional[models.OptionalArticleAttributes] = None,
+        max_results: Optional[int] = None,
+        pagenum: Optional[int] = 1,
+        pagesize: Optional[int] = 25,
+        retries: OptionalNullable[utils.RetryConfig] = UNSET,
+        server_url: Optional[str] = None,
+        timeout_ms: Optional[int] = None,
+        http_headers: Optional[Mapping[str, str]] = None,
+    ) -> Optional[models.ArticleSearchResults]:
+        r"""Search Prior To Customer Escalation
+
+        ## Overview
+        The Search Prior to Customer Escalation API performs search on the subject and description parameters, but filters out any articles that the customer has viewed in the current session.
+
+
+        :param accept_language: The Language locale accepted by the client (used for locale specific fields in resource representation and in error responses).
+        :param portal_id: The ID of the portal being accessed.<br><br>A portal ID is composed of a 2-4 letter prefix, followed by a dash and 4-15 digits.
+        :param escalation_id: The ID (uuid) of the customer escalation.
+        :param filter_articles_in_topic_tree: This parameter will restrict the search scope to the provided topic and it's sub topic.
+        :param additional_attributes: The fields of the article to be returned.
+        :param max_results: The \"maxResults\" parameter specifies the number of articles that should be included in the response.  It is only required when the escalation type is chat escalation.If not specified then default value 5 will be considered for chat escalation.  If the escalation type is email, the maximum results value specified in the portal settings for email escalation will be taken into consideration.
+        :param pagenum: Pagination parameter that specifies the page number of results to be returned. Used in conjunction with $pagesize.
+        :param pagesize: Pagination parameter that specifies the number of results per page. Used in conjunction with $pagenum.<br>Valid range of 5-75<br>_Default value_: 25
+        :param retries: Override the default retry configuration for this method
+        :param server_url: Override the default server URL for this method
+        :param timeout_ms: Override the default request timeout configuration for this method in milliseconds
+        :param http_headers: Additional headers to set or replace on requests.
+        """
+        base_url = None
+        url_variables = None
+        if timeout_ms is None:
+            timeout_ms = self.sdk_configuration.timeout_ms
+
+        if server_url is not None:
+            base_url = server_url
+        else:
+            base_url = self._get_url(base_url, url_variables)
+
+        request = models.SearchPriorToEscalationRequest(
+            accept_language=accept_language,
+            portal_id=portal_id,
+            escalation_id=escalation_id,
+            filter_articles_in_topic_tree=filter_articles_in_topic_tree,
+            additional_attributes=additional_attributes,
+            max_results=max_results,
+            pagenum=pagenum,
+            pagesize=pagesize,
+        )
+
+        req = self._build_request_async(
+            method="GET",
+            path="/portals/{portalID}/escalate/{escalationId}/search",
+            base_url=base_url,
+            url_variables=url_variables,
+            request=request,
+            request_body_required=False,
+            request_has_path_params=True,
+            request_has_query_params=True,
+            user_agent_header="user-agent",
+            accept_header_value="application/json",
+            http_headers=http_headers,
+            security=self.sdk_configuration.security,
+            timeout_ms=timeout_ms,
+        )
+
+        if retries == UNSET:
+            if self.sdk_configuration.retry_config is not UNSET:
+                retries = self.sdk_configuration.retry_config
+
+        retry_config = None
+        if isinstance(retries, utils.RetryConfig):
+            retry_config = (retries, ["429", "500", "502", "503", "504"])
+
+        http_res = await self.do_request_async(
+            hook_ctx=HookContext(
+                config=self.sdk_configuration,
+                base_url=base_url or "",
+                operation_id="searchPriorToEscalation",
+                oauth2_scopes=[],
+                security_source=get_security_from_env(
+                    self.sdk_configuration.security, models.Security
+                ),
+            ),
+            request=req,
+            error_status_codes=["400", "401", "403", "406", "4XX", "500", "5XX"],
+            retry_config=retry_config,
+        )
+
+        response_data: Any = None
+        if utils.match_response(http_res, "200", "application/json"):
+            return unmarshal_json_response(models.ArticleSearchResults, http_res)
+        if utils.match_response(http_res, "204", "*"):
+            return None
+        if utils.match_response(
+            http_res, ["400", "401", "403", "406"], "application/json"
+        ):
+            response_data = unmarshal_json_response(errors.WSErrorCommonData, http_res)
+            raise errors.WSErrorCommon(response_data, http_res)
+        if utils.match_response(http_res, "500", "application/json"):
+            response_data = unmarshal_json_response(errors.WSErrorCommonData, http_res)
+            raise errors.WSErrorCommon(response_data, http_res)
+        if utils.match_response(http_res, "4XX", "*"):
+            http_res_text = await utils.stream_to_text_async(http_res)
+            raise errors.EgainDefaultError(
+                "API error occurred", http_res, http_res_text
+            )
+        if utils.match_response(http_res, "5XX", "*"):
+            http_res_text = await utils.stream_to_text_async(http_res)
+            raise errors.EgainDefaultError(
+                "API error occurred", http_res, http_res_text
+            )
+
+        raise errors.EgainDefaultError("Unexpected response received", http_res)
+
+    def complete_customer_escalation(
+        self,
+        *,
+        accept_language: models.AcceptLanguage,
+        portal_id: str,
+        escalation_id: str,
+        retries: OptionalNullable[utils.RetryConfig] = UNSET,
+        server_url: Optional[str] = None,
+        timeout_ms: Optional[int] = None,
+        http_headers: Optional[Mapping[str, str]] = None,
+    ):
+        r"""Complete Customer Escalation
+
+        ## Overview
+        The Complete Customer Escalation API allows customer to complete escalation and send an email to a customer service agent on behalf of the customer.
+
+        After invoking the Complete Escalation or Avert Escalation APIs, the escalation ID associated with the escalation becomes invalid.
+        **Important:** Further attempts to use or reference the same escalation ID results in an error or failure.
+
+
+        :param accept_language: The Language locale accepted by the client (used for locale specific fields in resource representation and in error responses).
+        :param portal_id: The ID of the portal being accessed.<br><br>A portal ID is composed of a 2-4 letter prefix, followed by a dash and 4-15 digits.
+        :param escalation_id: The ID (uuid) of the customer escalation.
+        :param retries: Override the default retry configuration for this method
+        :param server_url: Override the default server URL for this method
+        :param timeout_ms: Override the default request timeout configuration for this method in milliseconds
+        :param http_headers: Additional headers to set or replace on requests.
+        """
+        base_url = None
+        url_variables = None
+        if timeout_ms is None:
+            timeout_ms = self.sdk_configuration.timeout_ms
+
+        if server_url is not None:
+            base_url = server_url
+        else:
+            base_url = self._get_url(base_url, url_variables)
+
+        request = models.CompleteCustomerEscalationRequest(
+            accept_language=accept_language,
+            portal_id=portal_id,
+            escalation_id=escalation_id,
+        )
+
+        req = self._build_request(
+            method="PUT",
+            path="/portals/{portalID}/escalate/{escalationId}/complete",
+            base_url=base_url,
+            url_variables=url_variables,
+            request=request,
+            request_body_required=False,
+            request_has_path_params=True,
+            request_has_query_params=True,
+            user_agent_header="user-agent",
+            accept_header_value="application/json",
+            http_headers=http_headers,
+            security=self.sdk_configuration.security,
+            timeout_ms=timeout_ms,
+        )
+
+        if retries == UNSET:
+            if self.sdk_configuration.retry_config is not UNSET:
+                retries = self.sdk_configuration.retry_config
+
+        retry_config = None
+        if isinstance(retries, utils.RetryConfig):
+            retry_config = (retries, ["429", "500", "502", "503", "504"])
+
+        http_res = self.do_request(
+            hook_ctx=HookContext(
+                config=self.sdk_configuration,
+                base_url=base_url or "",
+                operation_id="completeCustomerEscalation",
+                oauth2_scopes=[],
+                security_source=get_security_from_env(
+                    self.sdk_configuration.security, models.Security
+                ),
+            ),
+            request=req,
+            error_status_codes=["400", "401", "403", "406", "4XX", "500", "5XX"],
+            retry_config=retry_config,
+        )
+
+        response_data: Any = None
+        if utils.match_response(http_res, "204", "*"):
+            return
+        if utils.match_response(
+            http_res, ["400", "401", "403", "406"], "application/json"
+        ):
+            response_data = unmarshal_json_response(errors.WSErrorCommonData, http_res)
+            raise errors.WSErrorCommon(response_data, http_res)
+        if utils.match_response(http_res, "500", "application/json"):
+            response_data = unmarshal_json_response(errors.WSErrorCommonData, http_res)
+            raise errors.WSErrorCommon(response_data, http_res)
+        if utils.match_response(http_res, "4XX", "*"):
+            http_res_text = utils.stream_to_text(http_res)
+            raise errors.EgainDefaultError(
+                "API error occurred", http_res, http_res_text
+            )
+        if utils.match_response(http_res, "5XX", "*"):
+            http_res_text = utils.stream_to_text(http_res)
+            raise errors.EgainDefaultError(
+                "API error occurred", http_res, http_res_text
+            )
+
+        raise errors.EgainDefaultError("Unexpected response received", http_res)
+
+    async def complete_customer_escalation_async(
+        self,
+        *,
+        accept_language: models.AcceptLanguage,
+        portal_id: str,
+        escalation_id: str,
+        retries: OptionalNullable[utils.RetryConfig] = UNSET,
+        server_url: Optional[str] = None,
+        timeout_ms: Optional[int] = None,
+        http_headers: Optional[Mapping[str, str]] = None,
+    ):
+        r"""Complete Customer Escalation
+
+        ## Overview
+        The Complete Customer Escalation API allows customer to complete escalation and send an email to a customer service agent on behalf of the customer.
+
+        After invoking the Complete Escalation or Avert Escalation APIs, the escalation ID associated with the escalation becomes invalid.
+        **Important:** Further attempts to use or reference the same escalation ID results in an error or failure.
+
+
+        :param accept_language: The Language locale accepted by the client (used for locale specific fields in resource representation and in error responses).
+        :param portal_id: The ID of the portal being accessed.<br><br>A portal ID is composed of a 2-4 letter prefix, followed by a dash and 4-15 digits.
+        :param escalation_id: The ID (uuid) of the customer escalation.
+        :param retries: Override the default retry configuration for this method
+        :param server_url: Override the default server URL for this method
+        :param timeout_ms: Override the default request timeout configuration for this method in milliseconds
+        :param http_headers: Additional headers to set or replace on requests.
+        """
+        base_url = None
+        url_variables = None
+        if timeout_ms is None:
+            timeout_ms = self.sdk_configuration.timeout_ms
+
+        if server_url is not None:
+            base_url = server_url
+        else:
+            base_url = self._get_url(base_url, url_variables)
+
+        request = models.CompleteCustomerEscalationRequest(
+            accept_language=accept_language,
+            portal_id=portal_id,
+            escalation_id=escalation_id,
+        )
+
+        req = self._build_request_async(
+            method="PUT",
+            path="/portals/{portalID}/escalate/{escalationId}/complete",
+            base_url=base_url,
+            url_variables=url_variables,
+            request=request,
+            request_body_required=False,
+            request_has_path_params=True,
+            request_has_query_params=True,
+            user_agent_header="user-agent",
+            accept_header_value="application/json",
+            http_headers=http_headers,
+            security=self.sdk_configuration.security,
+            timeout_ms=timeout_ms,
+        )
+
+        if retries == UNSET:
+            if self.sdk_configuration.retry_config is not UNSET:
+                retries = self.sdk_configuration.retry_config
+
+        retry_config = None
+        if isinstance(retries, utils.RetryConfig):
+            retry_config = (retries, ["429", "500", "502", "503", "504"])
+
+        http_res = await self.do_request_async(
+            hook_ctx=HookContext(
+                config=self.sdk_configuration,
+                base_url=base_url or "",
+                operation_id="completeCustomerEscalation",
+                oauth2_scopes=[],
+                security_source=get_security_from_env(
+                    self.sdk_configuration.security, models.Security
+                ),
+            ),
+            request=req,
+            error_status_codes=["400", "401", "403", "406", "4XX", "500", "5XX"],
+            retry_config=retry_config,
+        )
+
+        response_data: Any = None
+        if utils.match_response(http_res, "204", "*"):
+            return
+        if utils.match_response(
+            http_res, ["400", "401", "403", "406"], "application/json"
+        ):
+            response_data = unmarshal_json_response(errors.WSErrorCommonData, http_res)
+            raise errors.WSErrorCommon(response_data, http_res)
+        if utils.match_response(http_res, "500", "application/json"):
+            response_data = unmarshal_json_response(errors.WSErrorCommonData, http_res)
+            raise errors.WSErrorCommon(response_data, http_res)
+        if utils.match_response(http_res, "4XX", "*"):
+            http_res_text = await utils.stream_to_text_async(http_res)
+            raise errors.EgainDefaultError(
+                "API error occurred", http_res, http_res_text
+            )
+        if utils.match_response(http_res, "5XX", "*"):
+            http_res_text = await utils.stream_to_text_async(http_res)
+            raise errors.EgainDefaultError(
+                "API error occurred", http_res, http_res_text
+            )
+
+        raise errors.EgainDefaultError("Unexpected response received", http_res)
+
+    def avert_customer_escalation(
+        self,
+        *,
+        accept_language: models.AcceptLanguage,
+        portal_id: str,
+        escalation_id: str,
+        retries: OptionalNullable[utils.RetryConfig] = UNSET,
+        server_url: Optional[str] = None,
+        timeout_ms: Optional[int] = None,
+        http_headers: Optional[Mapping[str, str]] = None,
+    ):
+        r"""Avert Customer Escalation
+
+        ## Overview
+        The Avert Customer Escalation API notifies the server that escalation to a live agent has been averted. Usually this means that the customer found the information they needed.
+
+        After invoking the Complete Escalation or Avert Escalation APIs, the escalation ID associated with the escalation becomes invalid.
+        **Important:** Further attempts to use or reference the same escalation ID results in an error or failure.
+
+
+        :param accept_language: The Language locale accepted by the client (used for locale specific fields in resource representation and in error responses).
+        :param portal_id: The ID of the portal being accessed.<br><br>A portal ID is composed of a 2-4 letter prefix, followed by a dash and 4-15 digits.
+        :param escalation_id: The ID (uuid) of the customer escalation.
+        :param retries: Override the default retry configuration for this method
+        :param server_url: Override the default server URL for this method
+        :param timeout_ms: Override the default request timeout configuration for this method in milliseconds
+        :param http_headers: Additional headers to set or replace on requests.
+        """
+        base_url = None
+        url_variables = None
+        if timeout_ms is None:
+            timeout_ms = self.sdk_configuration.timeout_ms
+
+        if server_url is not None:
+            base_url = server_url
+        else:
+            base_url = self._get_url(base_url, url_variables)
+
+        request = models.AvertCustomerEscalationRequest(
+            accept_language=accept_language,
+            portal_id=portal_id,
+            escalation_id=escalation_id,
+        )
+
+        req = self._build_request(
+            method="PUT",
+            path="/portals/{portalID}/escalate/{escalationId}/avert",
+            base_url=base_url,
+            url_variables=url_variables,
+            request=request,
+            request_body_required=False,
+            request_has_path_params=True,
+            request_has_query_params=True,
+            user_agent_header="user-agent",
+            accept_header_value="application/json",
+            http_headers=http_headers,
+            security=self.sdk_configuration.security,
+            timeout_ms=timeout_ms,
+        )
+
+        if retries == UNSET:
+            if self.sdk_configuration.retry_config is not UNSET:
+                retries = self.sdk_configuration.retry_config
+
+        retry_config = None
+        if isinstance(retries, utils.RetryConfig):
+            retry_config = (retries, ["429", "500", "502", "503", "504"])
+
+        http_res = self.do_request(
+            hook_ctx=HookContext(
+                config=self.sdk_configuration,
+                base_url=base_url or "",
+                operation_id="avertCustomerEscalation",
+                oauth2_scopes=[],
+                security_source=get_security_from_env(
+                    self.sdk_configuration.security, models.Security
+                ),
+            ),
+            request=req,
+            error_status_codes=["400", "401", "403", "406", "4XX", "500", "5XX"],
+            retry_config=retry_config,
+        )
+
+        response_data: Any = None
+        if utils.match_response(http_res, "204", "*"):
+            return
+        if utils.match_response(
+            http_res, ["400", "401", "403", "406"], "application/json"
+        ):
+            response_data = unmarshal_json_response(errors.WSErrorCommonData, http_res)
+            raise errors.WSErrorCommon(response_data, http_res)
+        if utils.match_response(http_res, "500", "application/json"):
+            response_data = unmarshal_json_response(errors.WSErrorCommonData, http_res)
+            raise errors.WSErrorCommon(response_data, http_res)
+        if utils.match_response(http_res, "4XX", "*"):
+            http_res_text = utils.stream_to_text(http_res)
+            raise errors.EgainDefaultError(
+                "API error occurred", http_res, http_res_text
+            )
+        if utils.match_response(http_res, "5XX", "*"):
+            http_res_text = utils.stream_to_text(http_res)
+            raise errors.EgainDefaultError(
+                "API error occurred", http_res, http_res_text
+            )
+
+        raise errors.EgainDefaultError("Unexpected response received", http_res)
+
+    async def avert_customer_escalation_async(
+        self,
+        *,
+        accept_language: models.AcceptLanguage,
+        portal_id: str,
+        escalation_id: str,
+        retries: OptionalNullable[utils.RetryConfig] = UNSET,
+        server_url: Optional[str] = None,
+        timeout_ms: Optional[int] = None,
+        http_headers: Optional[Mapping[str, str]] = None,
+    ):
+        r"""Avert Customer Escalation
+
+        ## Overview
+        The Avert Customer Escalation API notifies the server that escalation to a live agent has been averted. Usually this means that the customer found the information they needed.
+
+        After invoking the Complete Escalation or Avert Escalation APIs, the escalation ID associated with the escalation becomes invalid.
+        **Important:** Further attempts to use or reference the same escalation ID results in an error or failure.
+
+
+        :param accept_language: The Language locale accepted by the client (used for locale specific fields in resource representation and in error responses).
+        :param portal_id: The ID of the portal being accessed.<br><br>A portal ID is composed of a 2-4 letter prefix, followed by a dash and 4-15 digits.
+        :param escalation_id: The ID (uuid) of the customer escalation.
+        :param retries: Override the default retry configuration for this method
+        :param server_url: Override the default server URL for this method
+        :param timeout_ms: Override the default request timeout configuration for this method in milliseconds
+        :param http_headers: Additional headers to set or replace on requests.
+        """
+        base_url = None
+        url_variables = None
+        if timeout_ms is None:
+            timeout_ms = self.sdk_configuration.timeout_ms
+
+        if server_url is not None:
+            base_url = server_url
+        else:
+            base_url = self._get_url(base_url, url_variables)
+
+        request = models.AvertCustomerEscalationRequest(
+            accept_language=accept_language,
+            portal_id=portal_id,
+            escalation_id=escalation_id,
+        )
+
+        req = self._build_request_async(
+            method="PUT",
+            path="/portals/{portalID}/escalate/{escalationId}/avert",
+            base_url=base_url,
+            url_variables=url_variables,
+            request=request,
+            request_body_required=False,
+            request_has_path_params=True,
+            request_has_query_params=True,
+            user_agent_header="user-agent",
+            accept_header_value="application/json",
+            http_headers=http_headers,
+            security=self.sdk_configuration.security,
+            timeout_ms=timeout_ms,
+        )
+
+        if retries == UNSET:
+            if self.sdk_configuration.retry_config is not UNSET:
+                retries = self.sdk_configuration.retry_config
+
+        retry_config = None
+        if isinstance(retries, utils.RetryConfig):
+            retry_config = (retries, ["429", "500", "502", "503", "504"])
+
+        http_res = await self.do_request_async(
+            hook_ctx=HookContext(
+                config=self.sdk_configuration,
+                base_url=base_url or "",
+                operation_id="avertCustomerEscalation",
+                oauth2_scopes=[],
+                security_source=get_security_from_env(
+                    self.sdk_configuration.security, models.Security
+                ),
+            ),
+            request=req,
+            error_status_codes=["400", "401", "403", "406", "4XX", "500", "5XX"],
+            retry_config=retry_config,
+        )
+
+        response_data: Any = None
+        if utils.match_response(http_res, "204", "*"):
+            return
+        if utils.match_response(
+            http_res, ["400", "401", "403", "406"], "application/json"
+        ):
+            response_data = unmarshal_json_response(errors.WSErrorCommonData, http_res)
+            raise errors.WSErrorCommon(response_data, http_res)
+        if utils.match_response(http_res, "500", "application/json"):
+            response_data = unmarshal_json_response(errors.WSErrorCommonData, http_res)
+            raise errors.WSErrorCommon(response_data, http_res)
+        if utils.match_response(http_res, "4XX", "*"):
+            http_res_text = await utils.stream_to_text_async(http_res)
+            raise errors.EgainDefaultError(
+                "API error occurred", http_res, http_res_text
+            )
+        if utils.match_response(http_res, "5XX", "*"):
+            http_res_text = await utils.stream_to_text_async(http_res)
+            raise errors.EgainDefaultError(
+                "API error occurred", http_res, http_res_text
+            )
+
+        raise errors.EgainDefaultError("Unexpected response received", http_res)