240.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 239.0.0
+Documentation version PureCloudPlatformClientV2 240.0.0
 
 ## Preview APIs
 

build/.openapi-generator/FILES

@@ -716,6 +716,10 @@ PureCloudPlatformClientV2/models/bulk_update_shift_trade_state_response.py
 PureCloudPlatformClientV2/models/bulk_update_shift_trade_state_result.py
 PureCloudPlatformClientV2/models/bulk_update_shift_trade_state_result_item.py
 PureCloudPlatformClientV2/models/bullseye.py
+PureCloudPlatformClientV2/models/business_rules_data_schema.py
+PureCloudPlatformClientV2/models/business_rules_data_schema_listing.py
+PureCloudPlatformClientV2/models/business_rules_schema_create_request.py
+PureCloudPlatformClientV2/models/business_rules_schema_update_request.py
 PureCloudPlatformClientV2/models/business_unit_activity_code.py
 PureCloudPlatformClientV2/models/business_unit_activity_code_listing.py
 PureCloudPlatformClientV2/models/business_unit_list_item.py
@@ -1091,6 +1095,10 @@ PureCloudPlatformClientV2/models/context_pattern.py
 PureCloudPlatformClientV2/models/continuous_forecast_get_session_response.py
 PureCloudPlatformClientV2/models/continuous_forecast_session_response.py
 PureCloudPlatformClientV2/models/continuous_forecast_snapshot_response.py
+PureCloudPlatformClientV2/models/contract_definition.py
+PureCloudPlatformClientV2/models/contract_items.py
+PureCloudPlatformClientV2/models/contract_json_schema.py
+PureCloudPlatformClientV2/models/contract_property_definition.py
 PureCloudPlatformClientV2/models/contractual.py
 PureCloudPlatformClientV2/models/conversation.py
 PureCloudPlatformClientV2/models/conversation_activity_data.py
@@ -6432,6 +6440,10 @@ docs/BulkUpdateShiftTradeStateResultItem.md
 docs/Bullseye.md
 docs/BusinessRulesApi.json
 docs/BusinessRulesApi.md
+docs/BusinessRulesDataSchema.md
+docs/BusinessRulesDataSchemaListing.md
+docs/BusinessRulesSchemaCreateRequest.md
+docs/BusinessRulesSchemaUpdateRequest.md
 docs/BusinessUnitActivityCode.md
 docs/BusinessUnitActivityCodeListing.md
 docs/BusinessUnitListItem.md
@@ -6815,6 +6827,10 @@ docs/ContextPattern.md
 docs/ContinuousForecastGetSessionResponse.md
 docs/ContinuousForecastSessionResponse.md
 docs/ContinuousForecastSnapshotResponse.md
+docs/ContractDefinition.md
+docs/ContractItems.md
+docs/ContractJsonSchema.md
+docs/ContractPropertyDefinition.md
 docs/Contractual.md
 docs/Conversation.md
 docs/ConversationActivityData.md

build/APIData.json

@@ -629,6 +629,10 @@
 from .models.bulk_update_shift_trade_state_result import BulkUpdateShiftTradeStateResult
 from .models.bulk_update_shift_trade_state_result_item import BulkUpdateShiftTradeStateResultItem
 from .models.bullseye import Bullseye
+from .models.business_rules_data_schema import BusinessRulesDataSchema
+from .models.business_rules_data_schema_listing import BusinessRulesDataSchemaListing
+from .models.business_rules_schema_create_request import BusinessRulesSchemaCreateRequest
+from .models.business_rules_schema_update_request import BusinessRulesSchemaUpdateRequest
 from .models.business_unit_activity_code import BusinessUnitActivityCode
 from .models.business_unit_activity_code_listing import BusinessUnitActivityCodeListing
 from .models.business_unit_list_item import BusinessUnitListItem
@@ -1004,6 +1008,10 @@
 from .models.continuous_forecast_get_session_response import ContinuousForecastGetSessionResponse
 from .models.continuous_forecast_session_response import ContinuousForecastSessionResponse
 from .models.continuous_forecast_snapshot_response import ContinuousForecastSnapshotResponse
+from .models.contract_definition import ContractDefinition
+from .models.contract_items import ContractItems
+from .models.contract_json_schema import ContractJsonSchema
+from .models.contract_property_definition import ContractPropertyDefinition
 from .models.contractual import Contractual
 from .models.conversation import Conversation
 from .models.conversation_activity_data import ConversationActivityData

build/PureCloudPlatformClientV2/__init__.py

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

build/PureCloudPlatformClientV2/api_client.py

@@ -35,13 +35,15 @@
 from typing import Any
 
 from ..models import Empty
+from ..models import BusinessRulesDataSchema
+from ..models import BusinessRulesDataSchemaListing
+from ..models import BusinessRulesSchemaCreateRequest
+from ..models import BusinessRulesSchemaUpdateRequest
 from ..models import CopyDecisionTableRequest
 from ..models import Coretype
 from ..models import CoretypeListing
 from ..models import CreateDecisionTableRequest
 from ..models import CreateDecisionTableRowRequest
-from ..models import DataSchema
-from ..models import DataSchemaListing
 from ..models import DecisionTable
 from ..models import DecisionTableExecutionRequest
 from ..models import DecisionTableExecutionResponse
@@ -1019,7 +1021,7 @@ def get_businessrules_decisiontables_search(self, **kwargs) -> 'DecisionTableLis
                                             callback=params.get('callback'))
         return response
 
-    def get_businessrules_schema(self, schema_id: str, **kwargs) -> 'DataSchema':
+    def get_businessrules_schema(self, schema_id: str, **kwargs) -> 'BusinessRulesDataSchema':
         """
         Get a schema
         
@@ -1036,7 +1038,7 @@ def get_businessrules_schema(self, schema_id: str, **kwargs) -> 'DataSchema':
         :param callback function: The callback function
             for asynchronous request. (optional)
         :param str schema_id: Schema ID (required)
-        :return: DataSchema
+        :return: BusinessRulesDataSchema
                  If the method is called asynchronously,
                  returns the request thread.
         """
@@ -1093,12 +1095,12 @@ def get_businessrules_schema(self, schema_id: str, **kwargs) -> 'DataSchema':
                                             body=body_params,
                                             post_params=form_params,
                                             files=local_var_files,
-                                            response_type='DataSchema',
+                                            response_type='BusinessRulesDataSchema',
                                             auth_settings=auth_settings,
                                             callback=params.get('callback'))
         return response
 
-    def get_businessrules_schemas(self, **kwargs) -> 'DataSchemaListing':
+    def get_businessrules_schemas(self, **kwargs) -> 'BusinessRulesDataSchemaListing':
         """
         Get a list of schemas.
         
@@ -1114,7 +1116,7 @@ def get_businessrules_schemas(self, **kwargs) -> 'DataSchemaListing':
 
         :param callback function: The callback function
             for asynchronous request. (optional)
-        :return: DataSchemaListing
+        :return: BusinessRulesDataSchemaListing
                  If the method is called asynchronously,
                  returns the request thread.
         """
@@ -1166,7 +1168,7 @@ def get_businessrules_schemas(self, **kwargs) -> 'DataSchemaListing':
                                             body=body_params,
                                             post_params=form_params,
                                             files=local_var_files,
-                                            response_type='DataSchemaListing',
+                                            response_type='BusinessRulesDataSchemaListing',
                                             auth_settings=auth_settings,
                                             callback=params.get('callback'))
         return response
@@ -2197,7 +2199,7 @@ def post_businessrules_decisiontables(self, body: 'CreateDecisionTableRequest',
                                             callback=params.get('callback'))
         return response
 
-    def post_businessrules_schemas(self, body: 'DataSchema', **kwargs) -> 'DataSchema':
+    def post_businessrules_schemas(self, body: 'BusinessRulesSchemaCreateRequest', **kwargs) -> 'BusinessRulesDataSchema':
         """
         Create a schema
         
@@ -2213,8 +2215,8 @@ def post_businessrules_schemas(self, body: 'DataSchema', **kwargs) -> 'DataSchem
 
         :param callback function: The callback function
             for asynchronous request. (optional)
-        :param DataSchema body: Schema (required)
-        :return: DataSchema
+        :param BusinessRulesSchemaCreateRequest body: Business Rules Schema Create Request (required)
+        :return: BusinessRulesDataSchema
                  If the method is called asynchronously,
                  returns the request thread.
         """
@@ -2271,7 +2273,7 @@ def post_businessrules_schemas(self, body: 'DataSchema', **kwargs) -> 'DataSchem
                                             body=body_params,
                                             post_params=form_params,
                                             files=local_var_files,
-                                            response_type='DataSchema',
+                                            response_type='BusinessRulesDataSchema',
                                             auth_settings=auth_settings,
                                             callback=params.get('callback'))
         return response
@@ -2458,7 +2460,7 @@ def put_businessrules_decisiontable_version_row(self, table_id: str, table_versi
                                             callback=params.get('callback'))
         return response
 
-    def put_businessrules_schema(self, schema_id: str, body: 'DataSchema', **kwargs) -> 'DataSchema':
+    def put_businessrules_schema(self, schema_id: str, body: 'BusinessRulesSchemaUpdateRequest', **kwargs) -> 'BusinessRulesDataSchema':
         """
         Update a schema
         
@@ -2475,8 +2477,8 @@ def put_businessrules_schema(self, schema_id: str, body: 'DataSchema', **kwargs)
         :param callback function: The callback function
             for asynchronous request. (optional)
         :param str schema_id: Schema ID (required)
-        :param DataSchema body: Data Schema (required)
-        :return: DataSchema
+        :param BusinessRulesSchemaUpdateRequest body: Business Rules Schema Update Request (required)
+        :return: BusinessRulesDataSchema
                  If the method is called asynchronously,
                  returns the request thread.
         """
@@ -2538,7 +2540,7 @@ def put_businessrules_schema(self, schema_id: str, body: 'DataSchema', **kwargs)
                                             body=body_params,
                                             post_params=form_params,
                                             files=local_var_files,
-                                            response_type='DataSchema',
+                                            response_type='BusinessRulesDataSchema',
                                             auth_settings=auth_settings,
                                             callback=params.get('callback'))
         return response

build/PureCloudPlatformClientV2/apis/business_rules_api.py

@@ -1131,12 +1131,13 @@ def get_gamification_insights(self, filter_type: str, filter_id: str, granularit
         :param str sort_metric_id: Sort Metric Id
         :param str sort_order: Sort order
         :param str user_ids: A list of up to 100 comma-separated user Ids
+        :param str reports_to: The reportsTo used by ABAC policies.
         :return: InsightsSummary
                  If the method is called asynchronously,
                  returns the request thread.
         """
 
-        all_params = ['filter_type', 'filter_id', 'granularity', 'comparative_period_start_workday', 'primary_period_start_workday', 'page_size', 'page_number', 'sort_key', 'sort_metric_id', 'sort_order', 'user_ids']
+        all_params = ['filter_type', 'filter_id', 'granularity', 'comparative_period_start_workday', 'primary_period_start_workday', 'page_size', 'page_number', 'sort_key', 'sort_metric_id', 'sort_order', 'user_ids', 'reports_to']
         all_params.append('callback')
 
         params = locals()
@@ -1192,6 +1193,8 @@ def get_gamification_insights(self, filter_type: str, filter_id: str, granularit
             query_params['sortOrder'] = params['sort_order']
         if 'user_ids' in params:
             query_params['userIds'] = params['user_ids']
+        if 'reports_to' in params:
+            query_params['reportsTo'] = params['reports_to']
 
         header_params = {}
 
@@ -1574,12 +1577,13 @@ def get_gamification_insights_members(self, filter_type: str, filter_id: str, gr
         :param str filter_id: ID for the filter type. (required)
         :param str granularity: Granularity (required)
         :param date start_workday: The start work day. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd (required)
+        :param str reports_to: The reportsTo used by ABAC policies.
         :return: InsightsAgents
                  If the method is called asynchronously,
                  returns the request thread.
         """
 
-        all_params = ['filter_type', 'filter_id', 'granularity', 'start_workday']
+        all_params = ['filter_type', 'filter_id', 'granularity', 'start_workday', 'reports_to']
         all_params.append('callback')
 
         params = locals()
@@ -1618,6 +1622,8 @@ def get_gamification_insights_members(self, filter_type: str, filter_id: str, gr
             query_params['granularity'] = params['granularity']
         if 'start_workday' in params:
             query_params['startWorkday'] = params['start_workday']
+        if 'reports_to' in params:
+            query_params['reportsTo'] = params['reports_to']
 
         header_params = {}
 
@@ -1675,12 +1681,13 @@ def get_gamification_insights_rankings(self, filter_type: str, filter_id: str, g
         :param str sort_metric_id: Sort Metric Id
         :param int section_size: The number of top and bottom users to return before ties
         :param str user_ids: A list of up to 100 comma-separated user Ids
+        :param str reports_to: The reportsTo used by ABAC policies.
         :return: InsightsRankings
                  If the method is called asynchronously,
                  returns the request thread.
         """
 
-        all_params = ['filter_type', 'filter_id', 'granularity', 'comparative_period_start_workday', 'primary_period_start_workday', 'sort_key', 'sort_metric_id', 'section_size', 'user_ids']
+        all_params = ['filter_type', 'filter_id', 'granularity', 'comparative_period_start_workday', 'primary_period_start_workday', 'sort_key', 'sort_metric_id', 'section_size', 'user_ids', 'reports_to']
         all_params.append('callback')
 
         params = locals()
@@ -1735,6 +1742,8 @@ def get_gamification_insights_rankings(self, filter_type: str, filter_id: str, g
             query_params['sectionSize'] = params['section_size']
         if 'user_ids' in params:
             query_params['userIds'] = params['user_ids']
+        if 'reports_to' in params:
+            query_params['reportsTo'] = params['reports_to']
 
         header_params = {}
 

build/PureCloudPlatformClientV2/apis/gamification_api.py

@@ -2877,6 +2877,7 @@ def get_speechandtextanalytics_topics(self, **kwargs) -> 'TopicsEntityListing':
             for asynchronous request. (optional)
         :param str next_page: The key for listing the next page
         :param int page_size: The page size for the listing. The max that will be returned is 500.
+        :param int page_number: The page number for the listing
         :param str state: Topic state. Defaults to latest
         :param str name: Case insensitive partial name to filter by
         :param list[str] ids: Comma separated Topic IDs to filter by. Cannot be used with other filters. Maximum of 50 IDs allowed.
@@ -2888,7 +2889,7 @@ def get_speechandtextanalytics_topics(self, **kwargs) -> 'TopicsEntityListing':
                  returns the request thread.
         """
 
-        all_params = ['next_page', 'page_size', 'state', 'name', 'ids', 'dialects', 'sort_by', 'sort_order']
+        all_params = ['next_page', 'page_size', 'page_number', 'state', 'name', 'ids', 'dialects', 'sort_by', 'sort_order']
         all_params.append('callback')
 
         params = locals()
@@ -2911,6 +2912,8 @@ def get_speechandtextanalytics_topics(self, **kwargs) -> 'TopicsEntityListing':
             query_params['nextPage'] = params['next_page']
         if 'page_size' in params:
             query_params['pageSize'] = params['page_size']
+        if 'page_number' in params:
+            query_params['pageNumber'] = params['page_number']
         if 'state' in params:
             query_params['state'] = params['state']
         if 'name' in params:

build/PureCloudPlatformClientV2/apis/speech_text_analytics_api.py

@@ -1271,7 +1271,7 @@ def get_taskmanagement_workitem(self, workitem_id: str, **kwargs) -> 'Workitem':
         :param callback function: The callback function
             for asynchronous request. (optional)
         :param str workitem_id: Workitem ID (required)
-        :param str expands: Which fields to expand. Comma separated if more than one.
+        :param list[str] expands: Which fields to expand. Comma separated if more than one.
         :return: Workitem
                  If the method is called asynchronously,
                  returns the request thread.

build/PureCloudPlatformClientV2/apis/task_management_api.py

@@ -256,7 +256,7 @@ def to_debug_report(self):
                "OS: {env}\n"\
                "Python Version: {pyversion}\n"\
                "Version of the API: v2\n"\
-               "SDK Package Version: 239.0.0".\
+               "SDK Package Version: 240.0.0".\
                format(env=sys.platform, pyversion=sys.version)
 
     def _update_config_from_file(self):