227.0.0

Author: PureCloud Jenkins

README.md

@@ -5,7 +5,7 @@
 
 Documentation can be found at https://mypurecloud.github.io/platform-client-sdk-python/
 
-Documentation version PureCloudPlatformClientV2 226.0.0
+Documentation version PureCloudPlatformClientV2 227.0.0
 
 ## Preview APIs
 
@@ -379,6 +379,39 @@ worktype_update.default_queue_id = PureCloudPlatformClientV2.ApiNullValue()
 task_api.patch_taskmanagement_worktype(worktype_id, worktype_update)
 ```
 
+### Managing updates in Platform API Enumerations
+
+The Platform API Client SDKs (Java, Javascript/NodeJs, Python, Go, .Net, iOS/Swift) are automatically generated using the Platform API OpenAPI v2 definition.
+The Platform API definition file is downloaded at the time of the SDK build and is used to generate operations (i.e. API methods) and definitions (i.e. classes for the different models, enumerations, ...) in the different SDK languages.
+
+The Python Platform API Client SDK implements the following strategy to manage the introduction of new enumeration values in the Platform API (i.e. in a version of the SDK which doesn't include these changes):
+* If an unknown enumeration value is received (i.e. a new enumeration value, introduced in Platform API, after the SDK version you are using was built), the SDK will map it to a `outdated_sdk_version` string value. This is to prevent errors during deserialization when an unknown enumeration value is received from Genesys Cloud.
+
+## Inject Custom HTTP Client
+By default, the SDK uses the urllib3 library as the default HTTP client. If you want to inject a new third-party/custom implementation of the client, you can set the HTTP client instance.
+
+The CustomHttpClient should be a class that inherits from AbstractHttpClient defined in the SDK and implements the request method. Here's an example:
+
+```python
+from PureCloudPlatformClientV2 import AbstractHttpClient
+import requests
+
+class CustomHttpClient(AbstractHttpClient):
+    def __init__(self):
+        super().__init__()
+        self._session = requests.Session()
+
+    def request(self, options):
+        return self._session.request(**options)
+
+# Initialize the API client
+api_client = PureCloudPlatformClientV2.api_client.ApiClient()
+
+# Create and set custom HTTP client
+http_client = CustomHttpClient()
+api_client.set_http_client(http_client)
+
+
 ## SDK Source Code Generation
 
 The SDK is automatically regenerated and published from the API's definition after each API release. For more information on the build process, see the [platform-client-sdk-common](https://github.com/MyPureCloud/platform-client-sdk-common) project.
@@ -391,4 +424,4 @@ The SDK's version is incremented according to the [Semantic Versioning Specifica
 
 This package is intended to be forwards compatible with v2 of Genesys Cloud's Platform API. While the general policy for the API is not to introduce breaking changes, there are certain additions and changes to the API that cause breaking changes for the SDK, often due to the way the API is expressed in its swagger definition. Because of this, the SDK can have a major version bump while the API remains at major version 2. While the SDK is intended to be forward compatible, patches will only be released to the latest version. For these reasons, it is strongly recommended that all applications using this SDK are kept up to date and use the latest version of the SDK.
 
-For any issues, questions, or suggestions for the SDK, visit the [Genesys Cloud Developer Forum](https://developer.genesys.cloud/forum/).
+For any issues, questions, or suggestions for the SDK, visit the [Genesys Cloud Developer Community](https://community.genesys.com/communities/community-home1/digestviewer?CommunityKey=a39cc4d6-857e-43cb-be7b-019581ab9f38).

build/.openapi-generator/FILES

@@ -0,0 +1,15 @@
+from abc import ABC, abstractmethod
+
+class AbstractHttpClient(ABC):
+    def __init__(self):
+        self.timeout = 16000        
+        self.https_agent = None #it is a http proxy agent will be used later
+
+    def set_timeout(self, timeout):
+        if not isinstance(timeout, (int, float)):
+            raise ValueError("The 'timeout' property must be a number")
+        self.timeout = timeout
+    
+    @abstractmethod
+    def request(self, http_request_options):
+        raise NotImplementedError("method must be implemented")

build/APIData.json

@@ -20,7 +20,9 @@
 
 from __future__ import absolute_import
 from . import models
-from .rest import RESTClientObject
+from .abstract_http_client import AbstractHttpClient
+from .default_http_client import DefaultHttpClient
+from .http_request_options import HttpRequestOptions
 from .rest import ApiException
 from .api_null_value import ApiNullValue
 
@@ -76,7 +78,7 @@ def __init__(self, host=None, header_name=None, header_value=None, cookie=None):
         """
         Constructor of the class.
         """
-        self.rest_client = RESTClientObject()
+        self.http_client = None
         self.default_headers = {}
         if header_name is not None:
             self.default_headers[header_name] = header_value
@@ -133,6 +135,21 @@ def get_conf_url(self, path_type, base_path):
                         url = url + "/" + self.gateway_configuration.path_params_api
                 return url
 
+    def get_http_client(self):
+        if self.http_client is None:
+            self.http_client = DefaultHttpClient()
+        
+        return self.http_client
+
+    def set_http_client(self, http_client):
+        if http_client is None:
+            raise ValueError("http_client cannot be None")
+
+        if not isinstance(http_client, AbstractHttpClient):
+            raise ValueError("http_client must be an instance of AbstractHttpClient")
+
+        self.http_client = http_client
+
     def get_client_credentials_token(self, client_id, client_secret):
         """
         :param client_id: Client ID to authenticate with
@@ -155,10 +172,13 @@ def get_client_credentials_token(self, client_id, client_secret):
         header_params = self.sanitize_for_serialization(header_params)
         post_params = self.sanitize_for_serialization(post_params)
 
-        response = self.request("POST", url,
-                                query_params=query_params,
-                                headers=header_params,
-                                post_params=post_params, body=body);
+        request_options = HttpRequestOptions(url = url, method = "POST", 
+                                             headers = header_params, 
+                                             post_params = post_params, 
+                                             body = body)
+        http_client  = self.get_http_client()
+        response = http_client.request(request_options)
+
         data = json.loads('[' + response.data + ']')
         self.access_token = data[0]["access_token"]
         return self;
@@ -190,10 +210,13 @@ def get_saml2bearer_token(self,client_id,client_secret,org_name,assertion):
         header_params = self.sanitize_for_serialization(header_params)
         post_params = self.sanitize_for_serialization(post_params)
 
-        response = self.request("POST", url,
-                                query_params=query_params,
-                                headers=header_params,
-                                post_params=post_params, body=body);
+        request_options = HttpRequestOptions(url = url, method = "POST", 
+                                             headers = header_params, 
+                                             post_params = post_params, 
+                                             body = body)
+        http_client  = self.get_http_client()
+        response = http_client.request(request_options)
+
         data = json.loads('[' + response.data + ']')
         self.access_token = data[0]["access_token"]
         return self;  
@@ -228,12 +251,14 @@ def get_code_authorization_token(self,client_id,client_secret,auth_code,redirect
         header_params = self.sanitize_for_serialization(header_params)
         post_params = self.sanitize_for_serialization(post_params)
 
-        response = self.request("POST", url,
-                                query_params=query_params,
-                                headers=header_params,
-                                post_params=post_params, body=body)
-        data = json.loads('[' + response.data + ']')
+        request_options = HttpRequestOptions(url = url, method = "POST", 
+                                             headers = header_params, 
+                                             post_params = post_params, 
+                                             body = body)
+        http_client  = self.get_http_client()
+        response = http_client.request(request_options)
 
+        data = json.loads('[' + response.data + ']')
         self.access_token = data[0]["access_token"]
         self.refresh_token = data[0]["refresh_token"]
 
@@ -264,12 +289,14 @@ def refresh_code_authorization_token(self,client_id,client_secret,refresh_token)
         header_params = self.sanitize_for_serialization(header_params)
         post_params = self.sanitize_for_serialization(post_params)
 
-        response = self.request("POST", url,
-                                query_params=query_params,
-                                headers=header_params,
-                                post_params=post_params, body=body)
-        data = json.loads('[' + response.data + ']')
+        request_options = HttpRequestOptions(url = url, method = "POST", 
+                                             headers = header_params, 
+                                             post_params = post_params, 
+                                             body = body)
+        http_client  = self.get_http_client()
+        response = http_client.request(request_options)
 
+        data = json.loads('[' + response.data + ']')
         self.access_token = data[0]["access_token"]
         self.refresh_token = data[0]["refresh_token"]
 
@@ -325,12 +352,14 @@ def get_pkce_token(self,client_id,code_verifier,auth_code,redirect_uri):
         header_params = self.sanitize_for_serialization(header_params)
         post_params = self.sanitize_for_serialization(post_params)
 
-        response = self.request("POST", url,
-                                query_params=query_params,
-                                headers=header_params,
-                                post_params=post_params, body=body)
-        data = json.loads('[' + response.data + ']')
+        request_options = HttpRequestOptions(url = url, method = "POST", 
+                                             headers = header_params,
+                                             post_params = post_params, 
+                                             body = body)
+        http_client  = self.get_http_client()
+        response = http_client.request(request_options)
 
+        data = json.loads('[' + response.data + ']')
         self.access_token = data[0]["access_token"]
 
         return self, data[0]
@@ -390,7 +419,7 @@ def __call_api(self, resource_path, method,
             header_params['Cookie'] = self.cookie
         if header_params:
             header_params = self.sanitize_for_serialization(header_params)
-        header_params['purecloud-sdk'] = '226.0.0'
+        header_params['purecloud-sdk'] = '227.0.0'
 
         # path parameters
         if path_params:
@@ -435,8 +464,13 @@ def __call_api(self, resource_path, method,
 
         try:
             # perform request and return response
-            response_data = self.request(method, url, query_params=query_params,
-                                        headers=header_params, post_params=post_params, body=body)
+            request_options = HttpRequestOptions(url = url, method = method, 
+                                                headers = header_params, 
+                                                query_params = query_params,
+                                                post_params = post_params, 
+                                                body = body)
+            http_client  = self.get_http_client()
+            response_data = http_client.request(request_options)                                                    
             Configuration().logger.trace(method, log_url, body, response_data.status, header_params, response_data.getheaders())
             Configuration().logger.debug(method, log_url, body, response_data.status, header_params)
         except ApiException as e:
@@ -645,54 +679,6 @@ def call_api(self, resource_path, method,
         thread.start()
         return thread
 
-    def request(self, method, url, query_params=None, headers=None,
-                post_params=None, body=None):
-        """
-        Makes the HTTP request using RESTClient.
-        """
-        if method == "GET":
-            return self.rest_client.GET(url,
-                                        query_params=query_params,
-                                        headers=headers)
-        elif method == "HEAD":
-            return self.rest_client.HEAD(url,
-                                         query_params=query_params,
-                                         headers=headers)
-        elif method == "OPTIONS":
-            return self.rest_client.OPTIONS(url,
-                                            query_params=query_params,
-                                            headers=headers,
-                                            post_params=post_params,
-                                            body=body)
-        elif method == "POST":
-            return self.rest_client.POST(url,
-                                         query_params=query_params,
-                                         headers=headers,
-                                         post_params=post_params,
-                                         body=body)
-        elif method == "PUT":
-            return self.rest_client.PUT(url,
-                                        query_params=query_params,
-                                        headers=headers,
-                                        post_params=post_params,
-                                        body=body)
-        elif method == "PATCH":
-            return self.rest_client.PATCH(url,
-                                          query_params=query_params,
-                                          headers=headers,
-                                          post_params=post_params,
-                                          body=body)
-        elif method == "DELETE":
-            return self.rest_client.DELETE(url,
-                                           query_params=query_params,
-                                           headers=headers,
-                                           body=body)
-        else:
-            raise ValueError(
-                "http method must be `GET`, `HEAD`,"
-                " `POST`, `PATCH`, `PUT` or `DELETE`."
-            )
-
     def prepare_post_parameters(self, post_params=None, files=None):
         """
         Builds form parameters.

build/PureCloudPlatformClientV2/__init__.py

@@ -51,6 +51,7 @@
 from ..models import RoomParticipantsResponse
 from ..models import RoomUpdateRequest
 from ..models import SendMessageBody
+from ..models import UserSettingsForChat
 
 class ChatApi(object):
     """
@@ -1463,7 +1464,7 @@ def get_chats_user_settings(self, user_id: str, **kwargs) -> 'ChatUserSettings':
                                             callback=params.get('callback'))
         return response
 
-    def get_chats_users_me_settings(self, **kwargs) -> 'ChatUserSettings':
+    def get_chats_users_me_settings(self, **kwargs) -> 'UserSettingsForChat':
         """
         Get a user's chat settings
         
@@ -1478,7 +1479,7 @@ def get_chats_users_me_settings(self, **kwargs) -> 'ChatUserSettings':
 
         :param callback function: The callback function
             for asynchronous request. (optional)
-        :return: ChatUserSettings
+        :return: UserSettingsForChat
                  If the method is called asynchronously,
                  returns the request thread.
         """
@@ -1530,7 +1531,7 @@ def get_chats_users_me_settings(self, **kwargs) -> 'ChatUserSettings':
                                             body=body_params,
                                             post_params=form_params,
                                             files=local_var_files,
-                                            response_type='ChatUserSettings',
+                                            response_type='UserSettingsForChat',
                                             auth_settings=auth_settings,
                                             callback=params.get('callback'))
         return response
@@ -1961,7 +1962,7 @@ def patch_chats_user_settings(self, user_id: str, body: 'ChatUserSettings', **kw
                                             callback=params.get('callback'))
         return response
 
-    def patch_chats_users_me_settings(self, body: 'ChatUserSettings', **kwargs) -> 'ChatUserSettings':
+    def patch_chats_users_me_settings(self, body: 'UserSettingsForChat', **kwargs) -> 'UserSettingsForChat':
         """
         Update a user's chat settings
         
@@ -1976,8 +1977,8 @@ def patch_chats_users_me_settings(self, body: 'ChatUserSettings', **kwargs) -> '
 
         :param callback function: The callback function
             for asynchronous request. (optional)
-        :param ChatUserSettings body:  (required)
-        :return: ChatUserSettings
+        :param UserSettingsForChat body:  (required)
+        :return: UserSettingsForChat
                  If the method is called asynchronously,
                  returns the request thread.
         """
@@ -2034,7 +2035,7 @@ def patch_chats_users_me_settings(self, body: 'ChatUserSettings', **kwargs) -> '
                                             body=body_params,
                                             post_params=form_params,
                                             files=local_var_files,
-                                            response_type='ChatUserSettings',
+                                            response_type='UserSettingsForChat',
                                             auth_settings=auth_settings,
                                             callback=params.get('callback'))
         return response