203.0.0

Author: PureCloud Jenkins

build/.openapi-generator/FILES

@@ -599,6 +599,7 @@ PureCloudPlatformClientV2/models/callback_media_settings.py
 PureCloudPlatformClientV2/models/callheader.py
 PureCloudPlatformClientV2/models/callmessage.py
 PureCloudPlatformClientV2/models/campaign.py
+PureCloudPlatformClientV2/models/campaign_business_category_metrics.py
 PureCloudPlatformClientV2/models/campaign_diagnostics.py
 PureCloudPlatformClientV2/models/campaign_division_view.py
 PureCloudPlatformClientV2/models/campaign_division_view_listing.py
@@ -2122,6 +2123,7 @@ PureCloudPlatformClientV2/models/journey_view_element_attributes.py
 PureCloudPlatformClientV2/models/journey_view_element_filter.py
 PureCloudPlatformClientV2/models/journey_view_element_filter_predicate.py
 PureCloudPlatformClientV2/models/journey_view_job.py
+PureCloudPlatformClientV2/models/journey_view_job_listing.py
 PureCloudPlatformClientV2/models/journey_view_link.py
 PureCloudPlatformClientV2/models/journey_view_link_time_constraint.py
 PureCloudPlatformClientV2/models/journey_view_listing.py
@@ -5031,6 +5033,7 @@ docs/CallbackMediaSettings.md
 docs/Callheader.md
 docs/Callmessage.md
 docs/Campaign.md
+docs/CampaignBusinessCategoryMetrics.md
 docs/CampaignDiagnostics.md
 docs/CampaignDivisionView.md
 docs/CampaignDivisionViewListing.md
@@ -6596,6 +6599,7 @@ docs/JourneyViewElementAttributes.md
 docs/JourneyViewElementFilter.md
 docs/JourneyViewElementFilterPredicate.md
 docs/JourneyViewJob.md
+docs/JourneyViewJobListing.md
 docs/JourneyViewLink.md
 docs/JourneyViewLinkTimeConstraint.md
 docs/JourneyViewListing.md
@@ -9848,6 +9852,7 @@ docs/get_journey_view_version_jobs_latest-example.txt
 docs/get_journey_views-example.txt
 docs/get_journey_views_eventdefinition-example.txt
 docs/get_journey_views_eventdefinitions-example.txt
+docs/get_journey_views_jobs-example.txt
 docs/get_knowledge_guest_session_categories-example.txt
 docs/get_knowledge_guest_session_document-example.txt
 docs/get_knowledge_guest_session_documents-example.txt

build/APIData.json

@@ -19239,6 +19239,35 @@
     "return": "JourneyEventDefinitionListing",
     "example": "import PureCloudPlatformClientV2\nfrom PureCloudPlatformClientV2.rest import ApiException\nfrom pprint import pprint\n\n# Configure OAuth2 access token for authorization: PureCloud OAuth\nPureCloudPlatformClientV2.configuration.access_token = 'your_access_token'\n# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)\n\n# create an instance of the API class\napi_instance = PureCloudPlatformClientV2.JourneyApi();\n\ntry:\n    # Get a list of Event Definitions\n    api_response = api_instance.get_journey_views_eventdefinitions()\n    pprint(api_response)\nexcept ApiException as e:\n    print(\"Exception when calling JourneyApi->get_journey_views_eventdefinitions: %s\\n\" % e)"
   },
+  "get_journey_views_jobs": {
+    "operationId": "get_journey_views_jobs",
+    "functionName": "get_journey_views_jobs",
+    "signature": "get_journey_views_jobs(page_number, page_size, interval, statuses)",
+    "parameters": [
+      {
+        "name": "page_number",
+        "type": "int",
+        "required": "false"
+      },
+      {
+        "name": "page_size",
+        "type": "int",
+        "required": "false"
+      },
+      {
+        "name": "interval",
+        "type": "str",
+        "required": "false"
+      },
+      {
+        "name": "statuses",
+        "type": "str",
+        "required": "false"
+      }
+    ],
+    "return": "JourneyViewJobListing",
+    "example": "import PureCloudPlatformClientV2\nfrom PureCloudPlatformClientV2.rest import ApiException\nfrom pprint import pprint\n\n# Configure OAuth2 access token for authorization: PureCloud OAuth\nPureCloudPlatformClientV2.configuration.access_token = 'your_access_token'\n# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)\n\n# create an instance of the API class\napi_instance = PureCloudPlatformClientV2.JourneyApi();\npage_number = 1 # int | The number of the page to return (optional) (default to 1)\npage_size = 25 # int | Max number of entities to return (optional) (default to 25)\ninterval = '2023-07-17T00:00:00Z/2023-07-18T00:00:00Z' # str | An absolute timeframe for filtering the jobs, expressed as an ISO 8601 interval. (optional)\nstatuses = 'statuses=Accepted,Executing,Complete,Failed' # str | Job statuses to filter for (optional)\n\ntry:\n    # Get the jobs for an organization.\n    api_response = api_instance.get_journey_views_jobs(page_number=page_number, page_size=page_size, interval=interval, statuses=statuses)\n    pprint(api_response)\nexcept ApiException as e:\n    print(\"Exception when calling JourneyApi->get_journey_views_jobs: %s\\n\" % e)"
+  },
   "patch_journey_actionmap": {
     "operationId": "patch_journey_actionmap",
     "functionName": "patch_journey_actionmap",
@@ -30000,7 +30029,7 @@
   "get_quality_evaluations_query": {
     "operationId": "get_quality_evaluations_query",
     "functionName": "get_quality_evaluations_query",
-    "signature": "get_quality_evaluations_query(page_size, page_number, sort_by, expand, next_page, previous_page, conversation_id, agent_user_id, agent_team_id, evaluator_user_id, assignee_user_id, queue_id, start_time, end_time, form_context_id, evaluation_state, is_released, agent_has_read, expand_answer_total_scores, maximum, sort_order)",
+    "signature": "get_quality_evaluations_query(page_size, page_number, expand, previous_page, conversation_id, agent_user_id, agent_team_id, evaluator_user_id, assignee_user_id, queue_id, start_time, end_time, form_context_id, evaluation_state, is_released, agent_has_read, expand_answer_total_scores, maximum, sort_order)",
     "parameters": [
       {
         "name": "page_size",
@@ -30012,21 +30041,11 @@
         "type": "int",
         "required": "false"
       },
-      {
-        "name": "sort_by",
-        "type": "str",
-        "required": "false"
-      },
       {
         "name": "expand",
         "type": "list[str]",
         "required": "false"
       },
-      {
-        "name": "next_page",
-        "type": "str",
-        "required": "false"
-      },
       {
         "name": "previous_page",
         "type": "str",
@@ -30109,7 +30128,7 @@
       }
     ],
     "return": "EvaluationEntityListing",
-    "example": "import PureCloudPlatformClientV2\nfrom PureCloudPlatformClientV2.rest import ApiException\nfrom pprint import pprint\n\n# Configure OAuth2 access token for authorization: PureCloud OAuth\nPureCloudPlatformClientV2.configuration.access_token = 'your_access_token'\n# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)\n\n# create an instance of the API class\napi_instance = PureCloudPlatformClientV2.QualityApi();\npage_size = 25 # int | The total page size requested (optional) (default to 25)\npage_number = 1 # int | The page number requested (optional) (default to 1)\nsort_by = 'sort_by_example' # str | NOTE: Does not work when querying evaluations (optional)\nexpand = ['expand_example'] # list[str] | variable name requested by expand list (optional)\nnext_page = 'next_page_example' # str | NOTE: Does not work when querying evaluations (optional)\nprevious_page = 'previous_page_example' # str | Previous page token (optional)\nconversation_id = 'conversation_id_example' # str | conversationId specified (optional)\nagent_user_id = 'agent_user_id_example' # str | user id of the agent (optional)\nagent_team_id = 'agent_team_id_example' # str | team id of the agent (optional)\nevaluator_user_id = 'evaluator_user_id_example' # str | evaluator user id (optional)\nassignee_user_id = 'assignee_user_id_example' # str | assignee user id (optional)\nqueue_id = 'queue_id_example' # str | queue id (optional)\nstart_time = 'start_time_example' # str | start time of the evaluation query (optional)\nend_time = 'end_time_example' # str | end time of the evaluation query (optional)\nform_context_id = 'form_context_id_example' # str | shared id between form versions (optional)\nevaluation_state = ['evaluation_state_example'] # list[str] |  (optional)\nis_released = True # bool | the evaluation has been released (optional)\nagent_has_read = True # bool | agent has the evaluation (optional)\nexpand_answer_total_scores = True # bool | get the total scores for evaluations. NOTE: The answers will only be populated if this parameter is set to true in the request. (optional)\nmaximum = 56 # int | the maximum number of results to return (optional)\nsort_order = 'sort_order_example' # str | NOTE: Does not work when conversationId is supplied. (optional)\n\ntry:\n    # Queries Evaluations and returns a paged list\n    api_response = api_instance.get_quality_evaluations_query(page_size=page_size, page_number=page_number, sort_by=sort_by, expand=expand, next_page=next_page, previous_page=previous_page, conversation_id=conversation_id, agent_user_id=agent_user_id, agent_team_id=agent_team_id, evaluator_user_id=evaluator_user_id, assignee_user_id=assignee_user_id, queue_id=queue_id, start_time=start_time, end_time=end_time, form_context_id=form_context_id, evaluation_state=evaluation_state, is_released=is_released, agent_has_read=agent_has_read, expand_answer_total_scores=expand_answer_total_scores, maximum=maximum, sort_order=sort_order)\n    pprint(api_response)\nexcept ApiException as e:\n    print(\"Exception when calling QualityApi->get_quality_evaluations_query: %s\\n\" % e)"
+    "example": "import PureCloudPlatformClientV2\nfrom PureCloudPlatformClientV2.rest import ApiException\nfrom pprint import pprint\n\n# Configure OAuth2 access token for authorization: PureCloud OAuth\nPureCloudPlatformClientV2.configuration.access_token = 'your_access_token'\n# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)\n\n# create an instance of the API class\napi_instance = PureCloudPlatformClientV2.QualityApi();\npage_size = 25 # int | The total page size requested (optional) (default to 25)\npage_number = 1 # int | The page number requested (optional) (default to 1)\nexpand = ['expand_example'] # list[str] | variable name requested by expand list (optional)\nprevious_page = 'previous_page_example' # str | Previous page token (optional)\nconversation_id = 'conversation_id_example' # str | conversationId specified (optional)\nagent_user_id = 'agent_user_id_example' # str | user id of the agent (optional)\nagent_team_id = 'agent_team_id_example' # str | team id of the agent (optional)\nevaluator_user_id = 'evaluator_user_id_example' # str | evaluator user id (optional)\nassignee_user_id = 'assignee_user_id_example' # str | assignee user id (optional)\nqueue_id = 'queue_id_example' # str | queue id (optional)\nstart_time = 'start_time_example' # str | start time of the evaluation query (optional)\nend_time = 'end_time_example' # str | end time of the evaluation query (optional)\nform_context_id = 'form_context_id_example' # str | shared id between form versions (optional)\nevaluation_state = ['evaluation_state_example'] # list[str] |  (optional)\nis_released = True # bool | the evaluation has been released (optional)\nagent_has_read = True # bool | agent has the evaluation (optional)\nexpand_answer_total_scores = True # bool | get the total scores for evaluations. NOTE: The answers will only be populated if this parameter is set to true in the request. (optional)\nmaximum = 56 # int | the maximum number of results to return (optional)\nsort_order = 'sort_order_example' # str | NOTE: Does not work when conversationId is supplied. (optional)\n\ntry:\n    # Queries Evaluations and returns a paged list\n    api_response = api_instance.get_quality_evaluations_query(page_size=page_size, page_number=page_number, expand=expand, previous_page=previous_page, conversation_id=conversation_id, agent_user_id=agent_user_id, agent_team_id=agent_team_id, evaluator_user_id=evaluator_user_id, assignee_user_id=assignee_user_id, queue_id=queue_id, start_time=start_time, end_time=end_time, form_context_id=form_context_id, evaluation_state=evaluation_state, is_released=is_released, agent_has_read=agent_has_read, expand_answer_total_scores=expand_answer_total_scores, maximum=maximum, sort_order=sort_order)\n    pprint(api_response)\nexcept ApiException as e:\n    print(\"Exception when calling QualityApi->get_quality_evaluations_query: %s\\n\" % e)"
   },
   "get_quality_evaluators_activity": {
     "operationId": "get_quality_evaluators_activity",

build/PureCloudPlatformClientV2/__init__.py

@@ -520,6 +520,7 @@
 from .models.callheader import Callheader
 from .models.callmessage import Callmessage
 from .models.campaign import Campaign
+from .models.campaign_business_category_metrics import CampaignBusinessCategoryMetrics
 from .models.campaign_diagnostics import CampaignDiagnostics
 from .models.campaign_division_view import CampaignDivisionView
 from .models.campaign_division_view_listing import CampaignDivisionViewListing
@@ -2043,6 +2044,7 @@
 from .models.journey_view_element_filter import JourneyViewElementFilter
 from .models.journey_view_element_filter_predicate import JourneyViewElementFilterPredicate
 from .models.journey_view_job import JourneyViewJob
+from .models.journey_view_job_listing import JourneyViewJobListing
 from .models.journey_view_link import JourneyViewLink
 from .models.journey_view_link_time_constraint import JourneyViewLinkTimeConstraint
 from .models.journey_view_listing import JourneyViewListing

build/PureCloudPlatformClientV2/api_client.py

@@ -357,7 +357,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'] = '202.0.0'
+        header_params['purecloud-sdk'] = '203.0.0'
 
         # path parameters
         if path_params:

build/PureCloudPlatformClientV2/apis/journey_api.py

@@ -68,6 +68,7 @@
 from ..models import JourneySegmentRequest
 from ..models import JourneyView
 from ..models import JourneyViewJob
+from ..models import JourneyViewJobListing
 from ..models import JourneyViewListing
 from ..models import JourneyViewResult
 from ..models import Label
@@ -3127,6 +3128,91 @@ def get_journey_views_eventdefinitions(self, **kwargs) -> 'JourneyEventDefinitio
                                             callback=params.get('callback'))
         return response
 
+    def get_journey_views_jobs(self, **kwargs) -> 'JourneyViewJobListing':
+        """
+        Get the jobs for an organization.
+        
+	    get_journey_views_jobs is a preview method and is subject to both breaking and non-breaking changes at any time without notice
+
+        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.get_journey_views_jobs(callback=callback_function)
+
+        :param callback function: The callback function
+            for asynchronous request. (optional)
+        :param int page_number: The number of the page to return
+        :param int page_size: Max number of entities to return
+        :param str interval: An absolute timeframe for filtering the jobs, expressed as an ISO 8601 interval.
+        :param str statuses: Job statuses to filter for
+        :return: JourneyViewJobListing
+                 If the method is called asynchronously,
+                 returns the request thread.
+        """
+
+        all_params = ['page_number', 'page_size', 'interval', 'statuses']
+        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 get_journey_views_jobs" % key
+                )
+            params[key] = val
+        del params['kwargs']
+
+
+
+        resource_path = '/api/v2/journey/views/jobs'.replace('{format}', 'json')
+        path_params = {}
+
+        query_params = {}
+        if 'page_number' in params:
+            query_params['pageNumber'] = params['page_number']
+        if 'page_size' in params:
+            query_params['pageSize'] = params['page_size']
+        if 'interval' in params:
+            query_params['interval'] = params['interval']
+        if 'statuses' in params:
+            query_params['statuses'] = params['statuses']
+
+        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, 'GET',
+                                            path_params,
+                                            query_params,
+                                            header_params,
+                                            body=body_params,
+                                            post_params=form_params,
+                                            files=local_var_files,
+                                            response_type='JourneyViewJobListing',
+                                            auth_settings=auth_settings,
+                                            callback=params.get('callback'))
+        return response
+
     def patch_journey_actionmap(self, action_map_id: str, **kwargs) -> 'ActionMap':
         """
         Update single action map.

build/PureCloudPlatformClientV2/apis/quality_api.py

@@ -1469,9 +1469,7 @@ def get_quality_evaluations_query(self, **kwargs) -> 'EvaluationEntityListing':
             for asynchronous request. (optional)
         :param int page_size: The total page size requested
         :param int page_number: The page number requested
-        :param str sort_by: NOTE: Does not work when querying evaluations
         :param list[str] expand: variable name requested by expand list
-        :param str next_page: NOTE: Does not work when querying evaluations
         :param str previous_page: Previous page token
         :param str conversation_id: conversationId specified
         :param str agent_user_id: user id of the agent
@@ -1493,7 +1491,7 @@ def get_quality_evaluations_query(self, **kwargs) -> 'EvaluationEntityListing':
                  returns the request thread.
         """
 
-        all_params = ['page_size', 'page_number', 'sort_by', 'expand', 'next_page', 'previous_page', 'conversation_id', 'agent_user_id', 'agent_team_id', 'evaluator_user_id', 'assignee_user_id', 'queue_id', 'start_time', 'end_time', 'form_context_id', 'evaluation_state', 'is_released', 'agent_has_read', 'expand_answer_total_scores', 'maximum', 'sort_order']
+        all_params = ['page_size', 'page_number', 'expand', 'previous_page', 'conversation_id', 'agent_user_id', 'agent_team_id', 'evaluator_user_id', 'assignee_user_id', 'queue_id', 'start_time', 'end_time', 'form_context_id', 'evaluation_state', 'is_released', 'agent_has_read', 'expand_answer_total_scores', 'maximum', 'sort_order']
         all_params.append('callback')
 
         params = locals()
@@ -1516,12 +1514,8 @@ def get_quality_evaluations_query(self, **kwargs) -> 'EvaluationEntityListing':
             query_params['pageSize'] = params['page_size']
         if 'page_number' in params:
             query_params['pageNumber'] = params['page_number']
-        if 'sort_by' in params:
-            query_params['sortBy'] = params['sort_by']
         if 'expand' in params:
             query_params['expand'] = params['expand']
-        if 'next_page' in params:
-            query_params['nextPage'] = params['next_page']
         if 'previous_page' in params:
             query_params['previousPage'] = params['previous_page']
         if 'conversation_id' in params: