107.0.0

Author: PureCloud Jenkins

README.md

@@ -54,7 +54,36 @@ print(usersApi.get_users_me())
 
 ```
 
+### Authorization Code Grant
 
+* The app is authenticating as a human, the [Authorization Code Grant](https://developer.mypurecloud.com/api/rest/authorization/use-authorization-code.html)
+* The app is served via a web server
+* There is server-side code that will be making API requests
+
+```{"language":"python"}
+apiclient, auth_token_info = apiclient.get_code_authorization_token("565c3091-4107-4675-b606-b1fead2d15a4",
+                                                                    "9pal483eSr_vCZf0qQomFK298I8htjBZo49FI_lLZQ8",
+                                                                    "fjaXJaIG7Y-gFhgwvxvNZLj-dcqhWS_pm_n-_1MziN8",
+                                                                    "https://redirect-uri.com/oauth/callback")
+usersApi = PureCloudPlatformClientV2.UsersApi(apiclient)
+```
+
+By default the SDK will use the refresh token to request a new access token transparently when it expires. If multiple threads are running 1 thread will request a new token, other threads will wait a maximum of 10 seconds for the token refresh to complete, this time can be overriden with the _refresh_token_wait_time_ field of the _Configuration_ object.  
+If you wish to implement the refresh logic, set _should_refresh_access_token_ to false and store the refresh token from the auth response. The expires_in value can be used to proactively request a new one before it expires:
+
+```{"language":"python"}
+refresh_token = auth_token_info["refresh_token"]
+expires_in = auth_token_info["expires_in"]
+PureCloudPlatformClientV2.configuration.should_refresh_access_token = False
+```
+
+When the access token expires refresh it using the refresh_code_authorization_token method using the same clientId and clientSecret as used to request it.
+
+```{"language":"python"}
+apiclient, auth_token_info = apiclient.refresh_code_authorization_token("565c3091-4107-4675-b606-b1fead2d15a4",
+                                                                        "9pal483eSr_vCZf0qQomFK298I8htjBZo49FI_lLZQ8",
+                                                                        refresh_token)
+```
 
 ### Setting the Environment
 

build/PureCloudPlatformClientV2/__init__.py

@@ -1277,6 +1277,7 @@
 from .models.participant import Participant
 from .models.participant_attributes import ParticipantAttributes
 from .models.participant_basic import ParticipantBasic
+from .models.participant_metrics import ParticipantMetrics
 from .models.patch_action_target import PatchActionTarget
 from .models.patch_bu_rescheduling_options_management_unit_request import PatchBuReschedulingOptionsManagementUnitRequest
 from .models.patch_bu_rescheduling_options_request import PatchBuReschedulingOptionsRequest
@@ -2052,6 +2053,9 @@
 from .models.web_chat_routing_target import WebChatRoutingTarget
 from .models.web_chat_settings import WebChatSettings
 from .models.web_chat_typing import WebChatTyping
+from .models.web_deployments_config_topic_web_messaging_config_change_event_body import WebDeploymentsConfigTopicWebMessagingConfigChangeEventBody
+from .models.web_deployments_deployment_topic_web_messaging_config_change_event_body import WebDeploymentsDeploymentTopicWebMessagingConfigChangeEventBody
+from .models.web_deployments_deployment_topic_web_messaging_deployment_change_event_body import WebDeploymentsDeploymentTopicWebMessagingDeploymentChangeEventBody
 from .models.week_schedule import WeekSchedule
 from .models.week_schedule_generation_result import WeekScheduleGenerationResult
 from .models.week_schedule_list_item_response import WeekScheduleListItemResponse

build/PureCloudPlatformClientV2/api_client.py

@@ -34,6 +34,7 @@
 import threading
 import base64
 import json
+import time
 
 
 from datetime import datetime
@@ -86,8 +87,17 @@ def __init__(self, host=None, header_name=None, header_value=None, cookie=None):
         # Set default User-Agent.
         self.user_agent = 'PureCloud SDK/python'
 
+        # store clientId and clientSecret to request new access token for OAuth (Code Authorization)
+        self.client_id = ""
+        self.client_secret = ""
         # access token for OAuth
         self.access_token = ""
+        # refresh token for OAuth (Code Authorization)
+        self.refresh_token = ""
+        # lock object used to ensure 1 thread tries to request a new access token
+        self.refresh_token_lock = threading.Lock()
+        # flag indicating a token refresh is being carried out
+        self.refresh_in_progress = False
 
 
 
@@ -156,6 +166,83 @@ def get_saml2bearer_token(self,client_id,client_secret,org_name,assertion):
         self.access_token = data[0]["access_token"]
         return self;  
 
+    def get_code_authorization_token(self,client_id,client_secret,auth_code,redirect_uri):
+        """:param client_id: Client Id to authenticate with
+         :param client_secret: Client Secret to authenticate with
+         :param auth_code: Authorization code
+         :param redirect_uri: Authorized redirect URI for your Code Authorization client
+         :return:
+         """
+
+        self.client_id = client_id
+        self.client_secret = client_secret
+
+        query_params = {}
+        body = None
+        url = re.sub(r'\/\/(api)\.', '//login.', self.host) + '/oauth/token'
+
+        post_params = {'grant_type': 'authorization_code',
+                       'code': auth_code,
+                       'redirect_uri': redirect_uri
+                       }
+
+        auth_string = 'Basic ' + base64.b64encode(bytes((client_id + ':' + client_secret).encode('ascii'))).decode(
+            'ascii')
+
+        header_params = {
+            "Authorization": auth_string,
+            'Content-Type': 'application/x-www-form-urlencoded'
+        }
+        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 + ']')
+
+        self.access_token = data[0]["access_token"]
+        self.refresh_token = data[0]["refresh_token"]
+
+        return self, data[0]
+
+    def refresh_code_authorization_token(self,client_id,client_secret,refresh_token):
+        """:param client_id: Client Id to authenticate with
+         :param client_secret: Client Secret to authenticate with
+         :param refresh_token: Refresh token used to request a new access token
+         :return:
+         """
+
+        query_params = {}
+        body = None
+        url = re.sub(r'\/\/(api)\.', '//login.', self.host) + '/oauth/token'
+
+        post_params = {'grant_type': 'refresh_token',
+                       'refresh_token': refresh_token
+                       }
+
+        auth_string = 'Basic ' + base64.b64encode(bytes((client_id + ':' + client_secret).encode('ascii'))).decode(
+            'ascii')
+
+        header_params = {
+            "Authorization": auth_string,
+            'Content-Type': 'application/x-www-form-urlencoded'
+        }
+        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 + ']')
+
+        self.access_token = data[0]["access_token"]
+        self.refresh_token = data[0]["refresh_token"]
+
+        return self, data[0]
+
     @property
     def user_agent(self):
         """
@@ -173,19 +260,42 @@ def user_agent(self, value):
     def set_default_header(self, header_name, header_value):
         self.default_headers[header_name] = header_value
 
+    def handle_expired_access_token(self):
+        if self.refresh_token_lock.acquire(False):
+            try:
+                self.refresh_in_progress = True
+                self.refresh_code_authorization_token(self.client_id, self.client_secret, self.refresh_token)
+            finally:
+                self.refresh_in_progress = False
+                self.refresh_token_lock.release()
+        else:
+            start_time = time.time()
+            sleep_duration = 0.200
+            # Wait maximum of refresh_token_wait_time seconds for other thread to complete refresh
+            # It would be ideal to use refresh_token_lock.acquire with a timeout value here but that was added in python 3.2 and we have to support older versions
+            while time.time() - start_time < Configuration().refresh_token_wait_time:
+                time.sleep(sleep_duration)
+                if not self.refresh_in_progress:
+                    return
+            # Abort with error if we have waited refresh_token_wait_time seconds and refresh still isn't complete
+            raise ApiException(
+                status=500,
+                reason="Token refresh took longer than `{0}` seconds"
+                .format(str(Configuration().refresh_token_wait_time))
+            )
+
     def __call_api(self, resource_path, method,
                    path_params=None, query_params=None, header_params=None,
                    body=None, post_params=None, files=None,
                    response_type=None, auth_settings=None, callback=None):
-
         # headers parameters
         header_params = header_params or {}
         header_params.update(self.default_headers)
         if self.cookie:
             header_params['Cookie'] = self.cookie
         if header_params:
             header_params = self.sanitize_for_serialization(header_params)
-        header_params['purecloud-sdk'] = '106.0.0'
+        header_params['purecloud-sdk'] = '107.0.0'
 
         # path parameters
         if path_params:
@@ -216,11 +326,20 @@ def __call_api(self, resource_path, method,
         # request url
         url = self.host + resource_path
 
-        # perform request and return response
-        response_data = self.request(method, url,
-                                     query_params=query_params,
-                                     headers=header_params,
-                                     post_params=post_params, body=body)
+        response_data = None
+
+        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)
+        except ApiException as e:
+            if Configuration().should_refresh_access_token and e.status == 401 and self.refresh_token != "":
+                self.handle_expired_access_token()
+                return self.__call_api(resource_path, method, path_params,
+                            query_params, header_params, body, post_params,
+                            files, response_type, auth_settings, callback)
+            else:
+                raise
 
         self.last_response = response_data
 

build/PureCloudPlatformClientV2/apis/architect_api.py

@@ -3536,7 +3536,7 @@ def get_flow(self, flow_id, **kwargs):
         :param callback function: The callback function
             for asynchronous request. (optional)
         :param str flow_id: Flow ID (required)
-        :param bool deleted: Include deleted flows
+        :param bool deleted: Deleted flows
         :return: Flow
                  If the method is called asynchronously,
                  returns the request thread.
@@ -3716,7 +3716,7 @@ def get_flow_latestconfiguration(self, flow_id, **kwargs):
         :param callback function: The callback function
             for asynchronous request. (optional)
         :param str flow_id: Flow ID (required)
-        :param bool deleted: Include deleted flows
+        :param bool deleted: Deleted flows
         :return: object
                  If the method is called asynchronously,
                  returns the request thread.
@@ -3798,7 +3798,7 @@ def get_flow_version(self, flow_id, version_id, **kwargs):
             for asynchronous request. (optional)
         :param str flow_id: Flow ID (required)
         :param str version_id: Version ID (required)
-        :param str deleted: Include deleted flows
+        :param str deleted: Deleted flows
         :return: FlowVersion
                  If the method is called asynchronously,
                  returns the request thread.
@@ -3885,7 +3885,7 @@ def get_flow_version_configuration(self, flow_id, version_id, **kwargs):
             for asynchronous request. (optional)
         :param str flow_id: Flow ID (required)
         :param str version_id: Version ID (required)
-        :param str deleted: Include deleted flows
+        :param str deleted: Deleted flows
         :return: object
                  If the method is called asynchronously,
                  returns the request thread.
@@ -3973,7 +3973,7 @@ def get_flow_versions(self, flow_id, **kwargs):
         :param str flow_id: Flow ID (required)
         :param int page_number: Page number
         :param int page_size: Page size
-        :param bool deleted: Include deleted flows
+        :param bool deleted: Include Deleted flows
         :return: FlowVersionEntityListing
                  If the method is called asynchronously,
                  returns the request thread.

build/PureCloudPlatformClientV2/apis/conversations_api.py

@@ -8776,6 +8776,90 @@ def post_conversations_call(self, conversation_id, body, **kwargs):
                                             callback=params.get('callback'))
         return response
 
+    def post_conversations_call_participant_coach(self, conversation_id, participant_id, **kwargs):
+        """
+        Listen in on the conversation from the point of view of a given participant while speaking to just the given participant.
+        
+
+        This method makes a synchronous HTTP request by default. To make an
+        asynchronous HTTP request, please define a `callback` function
+        to be invoked when receiving the response.
+        >>> def callback_function(response):
+        >>>     pprint(response)
+        >>>
+        >>> thread = api.post_conversations_call_participant_coach(conversation_id, participant_id, callback=callback_function)
+
+        :param callback function: The callback function
+            for asynchronous request. (optional)
+        :param str conversation_id: conversationId (required)
+        :param str participant_id: participantId (required)
+        :return: None
+                 If the method is called asynchronously,
+                 returns the request thread.
+        """
+
+        all_params = ['conversation_id', 'participant_id']
+        all_params.append('callback')
+
+        params = locals()
+        for key, val in iteritems(params['kwargs']):
+            if key not in all_params:
+                raise TypeError(
+                    "Got an unexpected keyword argument '%s'"
+                    " to method post_conversations_call_participant_coach" % key
+                )
+            params[key] = val
+        del params['kwargs']
+
+        # verify the required parameter 'conversation_id' is set
+        if ('conversation_id' not in params) or (params['conversation_id'] is None):
+            raise ValueError("Missing the required parameter `conversation_id` when calling `post_conversations_call_participant_coach`")
+        # verify the required parameter 'participant_id' is set
+        if ('participant_id' not in params) or (params['participant_id'] is None):
+            raise ValueError("Missing the required parameter `participant_id` when calling `post_conversations_call_participant_coach`")
+
+
+        resource_path = '/api/v2/conversations/calls/{conversationId}/participants/{participantId}/coach'.replace('{format}', 'json')
+        path_params = {}
+        if 'conversation_id' in params:
+            path_params['conversationId'] = params['conversation_id']
+        if 'participant_id' in params:
+            path_params['participantId'] = params['participant_id']
+
+        query_params = {}
+
+        header_params = {}
+
+        form_params = []
+        local_var_files = {}
+
+        body_params = None
+
+        # HTTP header `Accept`
+        header_params['Accept'] = self.api_client.\
+            select_header_accept(['application/json'])
+        if not header_params['Accept']:
+            del header_params['Accept']
+
+        # HTTP header `Content-Type`
+        header_params['Content-Type'] = self.api_client.\
+            select_header_content_type(['application/json'])
+
+        # Authentication setting
+        auth_settings = ['PureCloud OAuth']
+
+        response = self.api_client.call_api(resource_path, 'POST',
+                                            path_params,
+                                            query_params,
+                                            header_params,
+                                            body=body_params,
+                                            post_params=form_params,
+                                            files=local_var_files,
+                                            response_type=None,
+                                            auth_settings=auth_settings,
+                                            callback=params.get('callback'))
+        return response
+
     def post_conversations_call_participant_consult(self, conversation_id, participant_id, body, **kwargs):
         """
         Initiate and update consult transfer