257.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 256.0.0
+Documentation version PureCloudPlatformClientV2 257.0.0
 
 ## Preview APIs
 

build/.openapi-generator/FILES

@@ -457,6 +457,7 @@
 from .models.batch_download_job_submission_result import BatchDownloadJobSubmissionResult
 from .models.batch_download_request import BatchDownloadRequest
 from .models.batch_event_response import BatchEventResponse
+from .models.batch_predictive_routing_custom_kpi_attribution_event_request import BatchPredictiveRoutingCustomKpiAttributionEventRequest
 from .models.batch_user_presence_event_request import BatchUserPresenceEventRequest
 from .models.batch_user_routing_status_event_request import BatchUserRoutingStatusEventRequest
 from .models.benefit_assessment import BenefitAssessment
@@ -841,6 +842,8 @@
 from .models.caseplan_data_schema import CaseplanDataSchema
 from .models.caseplan_data_schema_listing import CaseplanDataSchemaListing
 from .models.caseplan_listing import CaseplanListing
+from .models.caseplan_query_entity_listing import CaseplanQueryEntityListing
+from .models.caseplan_query_request import CaseplanQueryRequest
 from .models.caseplan_reference import CaseplanReference
 from .models.caseplan_update import CaseplanUpdate
 from .models.categories_entity_listing import CategoriesEntityListing
@@ -1257,6 +1260,7 @@
 from .models.conversation_content_list_picker_item import ConversationContentListPickerItem
 from .models.conversation_content_list_picker_section import ConversationContentListPickerSection
 from .models.conversation_content_location import ConversationContentLocation
+from .models.conversation_content_notification_response import ConversationContentNotificationResponse
 from .models.conversation_content_notification_template import ConversationContentNotificationTemplate
 from .models.conversation_content_payment_request import ConversationContentPaymentRequest
 from .models.conversation_content_payment_response import ConversationContentPaymentResponse
@@ -1575,8 +1579,11 @@
 from .models.copilot_async_aggregation_query import CopilotAsyncAggregationQuery
 from .models.copilot_condition import CopilotCondition
 from .models.copilot_context import CopilotContext
+from .models.copilot_context_entity import CopilotContextEntity
 from .models.copilot_context_filter import CopilotContextFilter
 from .models.copilot_context_value import CopilotContextValue
+from .models.copilot_context_value_item import CopilotContextValueItem
+from .models.copilot_context_values import CopilotContextValues
 from .models.copilot_fallback_action import CopilotFallbackAction
 from .models.copilot_nlu_domain import CopilotNluDomain
 from .models.copilot_nlu_domain_version import CopilotNluDomainVersion
@@ -1865,6 +1872,9 @@
 from .models.dialer_campaign_schedule_config_change_schedule_interval import DialerCampaignScheduleConfigChangeScheduleInterval
 from .models.dialer_campaign_schedule_config_change_schedule_recurrence import DialerCampaignScheduleConfigChangeScheduleRecurrence
 from .models.dialer_campaign_schedule_config_change_uri_reference import DialerCampaignScheduleConfigChangeUriReference
+from .models.dialer_campaign_skill_combination_stats_event_campaign_skill_combination_stats import DialerCampaignSkillCombinationStatsEventCampaignSkillCombinationStats
+from .models.dialer_campaign_skill_combination_stats_event_skill_combination_detail_notification import DialerCampaignSkillCombinationStatsEventSkillCombinationDetailNotification
+from .models.dialer_campaign_skill_combination_stats_event_uri_reference import DialerCampaignSkillCombinationStatsEventUriReference
 from .models.dialer_contact import DialerContact
 from .models.dialer_contact_id import DialerContactId
 from .models.dialer_contactlist_config_change_contact_list import DialerContactlistConfigChangeContactList
@@ -2731,6 +2741,7 @@
 from .models.ivr_division_view_entity_listing import IVRDivisionViewEntityListing
 from .models.ivr_entity_listing import IVREntityListing
 from .models.ivr_identity_resolution_config import IVRIdentityResolutionConfig
+from .models.icon import Icon
 from .models.identifier_claim_request import IdentifierClaimRequest
 from .models.identity_now import IdentityNow
 from .models.identity_provider import IdentityProvider
@@ -3308,6 +3319,7 @@
 from .models.list_picker import ListPicker
 from .models.list_picker_item import ListPickerItem
 from .models.list_picker_section import ListPickerSection
+from .models.list_values import ListValues
 from .models.list_wrapper_agent_work_plan_field import ListWrapperAgentWorkPlanField
 from .models.list_wrapper_alternative_shift_bu_settings_activity_category import ListWrapperAlternativeShiftBuSettingsActivityCategory
 from .models.list_wrapper_alternative_shift_bu_settings_granularity import ListWrapperAlternativeShiftBuSettingsGranularity
@@ -3796,7 +3808,11 @@
 from .models.outcome_scores_result import OutcomeScoresResult
 from .models.outgoing_message_request import OutgoingMessageRequest
 from .models.outgoing_message_response import OutgoingMessageResponse
+from .models.outlier import Outlier
+from .models.outlier_data import OutlierData
 from .models.outlier_info import OutlierInfo
+from .models.outlier_result_body import OutlierResultBody
+from .models.outlier_result_template import OutlierResultTemplate
 from .models.output_value import OutputValue
 from .models.overall_best_points import OverallBestPoints
 from .models.overall_best_points_item import OverallBestPointsItem
@@ -3940,6 +3956,7 @@
 from .models.post_text_response import PostTextResponse
 from .models.prediction_results import PredictionResults
 from .models.predictive_routing import PredictiveRouting
+from .models.predictive_routing_custom_kpi_attribution_event import PredictiveRoutingCustomKpiAttributionEvent
 from .models.predictor import Predictor
 from .models.predictor_listing import PredictorListing
 from .models.predictor_model import PredictorModel
@@ -4852,6 +4869,7 @@
 from .models.social_media_async_detail_query_response import SocialMediaAsyncDetailQueryResponse
 from .models.social_media_detail_data_container import SocialMediaDetailDataContainer
 from .models.social_media_detail_message_container import SocialMediaDetailMessageContainer
+from .models.social_media_engagement import SocialMediaEngagement
 from .models.social_media_message_data import SocialMediaMessageData
 from .models.social_media_message_escalation_info import SocialMediaMessageEscalationInfo
 from .models.social_media_query_clause import SocialMediaQueryClause
@@ -5127,6 +5145,7 @@
 from .models.text_bots_rich_media_input_event import TextBotsRichMediaInputEvent
 from .models.text_message_listing import TextMessageListing
 from .models.text_style_properties import TextStyleProperties
+from .models.third_party_suggestion import ThirdPartySuggestion
 from .models.ticker import Ticker
 from .models.time_allowed import TimeAllowed
 from .models.time_and_date_sub_condition import TimeAndDateSubCondition
@@ -5623,7 +5642,9 @@
 from .models.v3_knowledge_search_client_application import V3KnowledgeSearchClientApplication
 from .models.v3_source_create_request import V3SourceCreateRequest
 from .models.v3_source_detailed_response import V3SourceDetailedResponse
-from .models.v3_source_detailed_with_error_response import V3SourceDetailedWithErrorResponse
+from .models.v3_source_expandable_list_response import V3SourceExpandableListResponse
+from .models.v3_source_expandable_listing import V3SourceExpandableListing
+from .models.v3_source_expandable_response import V3SourceExpandableResponse
 from .models.v3_source_filter import V3SourceFilter
 from .models.v3_source_filter_details import V3SourceFilterDetails
 from .models.v3_source_folder_details import V3SourceFolderDetails
@@ -5632,8 +5653,6 @@
 from .models.v3_source_schedule_settings import V3SourceScheduleSettings
 from .models.v3_source_site_details import V3SourceSiteDetails
 from .models.v3_source_update_request import V3SourceUpdateRequest
-from .models.v3_source_with_error_listing import V3SourceWithErrorListing
-from .models.v3_source_with_error_response import V3SourceWithErrorResponse
 from .models.v3_start_manual_sync_request import V3StartManualSyncRequest
 from .models.v3_synchronization import V3Synchronization
 from .models.v3_synchronization_listing import V3SynchronizationListing
@@ -5772,15 +5791,17 @@
 from .models.wem_coaching_schedule_slot_job_complete_topic_coaching_schedule_slot_job_results_slot_schedule import WemCoachingScheduleSlotJobCompleteTopicCoachingScheduleSlotJobResultsSlotSchedule
 from .models.wem_coaching_user_notification_topic_coaching_appointment_reference import WemCoachingUserNotificationTopicCoachingAppointmentReference
 from .models.wem_coaching_user_notification_topic_coaching_user_notification import WemCoachingUserNotificationTopicCoachingUserNotification
+from .models.wfm_activity_plan_job_complete_topic_activity_plan_job_complete_notification import WfmActivityPlanJobCompleteTopicActivityPlanJobCompleteNotification
 from .models.wfm_activity_plan_job_complete_topic_activity_plan_job_exception import WfmActivityPlanJobCompleteTopicActivityPlanJobException
-from .models.wfm_activity_plan_job_complete_topic_activity_plan_occurrence_deletion_job_complete_notification import WfmActivityPlanJobCompleteTopicActivityPlanOccurrenceDeletionJobCompleteNotification
 from .models.wfm_activity_plan_job_complete_topic_activity_plan_occurrence_reference import WfmActivityPlanJobCompleteTopicActivityPlanOccurrenceReference
 from .models.wfm_activity_plan_job_complete_topic_activity_plan_reference import WfmActivityPlanJobCompleteTopicActivityPlanReference
+from .models.wfm_activity_plan_job_complete_topic_activity_plan_session_reference import WfmActivityPlanJobCompleteTopicActivityPlanSessionReference
 from .models.wfm_activity_plan_job_complete_topic_error_body import WfmActivityPlanJobCompleteTopicErrorBody
+from .models.wfm_activity_plan_run_job_complete_topic_activity_plan_job_complete_notification import WfmActivityPlanRunJobCompleteTopicActivityPlanJobCompleteNotification
 from .models.wfm_activity_plan_run_job_complete_topic_activity_plan_job_exception import WfmActivityPlanRunJobCompleteTopicActivityPlanJobException
 from .models.wfm_activity_plan_run_job_complete_topic_activity_plan_occurrence_reference import WfmActivityPlanRunJobCompleteTopicActivityPlanOccurrenceReference
 from .models.wfm_activity_plan_run_job_complete_topic_activity_plan_reference import WfmActivityPlanRunJobCompleteTopicActivityPlanReference
-from .models.wfm_activity_plan_run_job_complete_topic_activity_plan_run_job_complete_notification import WfmActivityPlanRunJobCompleteTopicActivityPlanRunJobCompleteNotification
+from .models.wfm_activity_plan_run_job_complete_topic_activity_plan_session_reference import WfmActivityPlanRunJobCompleteTopicActivityPlanSessionReference
 from .models.wfm_activity_plan_run_job_complete_topic_error_body import WfmActivityPlanRunJobCompleteTopicErrorBody
 from .models.wfm_adherence_explanation_job_complete_topic_adherence_explanation_changed_notification import WfmAdherenceExplanationJobCompleteTopicAdherenceExplanationChangedNotification
 from .models.wfm_adherence_explanation_job_complete_topic_adherence_explanation_job_notification import WfmAdherenceExplanationJobCompleteTopicAdherenceExplanationJobNotification

build/APIData.json

@@ -420,7 +420,7 @@ def __call_api(self, resource_path, method,
             header_params['Cookie'] = self.cookie
         if header_params:
             header_params = self.sanitize_params_for_serialization(header_params)
-        header_params['purecloud-sdk'] = '256.0.0'
+        header_params['purecloud-sdk'] = '257.0.0'
 
         # path parameters
         if path_params:

build/PureCloudPlatformClientV2/__init__.py

@@ -10491,9 +10491,94 @@ def post_flows_datatable_export_jobs(self, datatable_id: str, **kwargs) -> 'Data
                                             callback=params.get('callback'))
         return response
 
+    def post_flows_datatable_import_csv_jobs(self, datatable_id: str, body: 'DataTableImportJob', **kwargs) -> 'DataTableImportJob':
+        """
+        Begin an import process for importing rows from a CSV file into a datatable. CSV file is uploaded by performing a PUT request against the URL in the returned 'uploadURI' field. Headers for the PUT request must contain all headers contained in the returned 'uploadHeaders' field.
+        Create an import job for importing rows from a CSV file. The caller can then poll for status of the import using the token returned in the response
+
+        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_flows_datatable_import_csv_jobs(datatable_id, body, callback=callback_function)
+
+        :param callback function: The callback function
+            for asynchronous request. (optional)
+        :param str datatable_id: id of datatable (required)
+        :param DataTableImportJob body: import job information (required)
+        :return: DataTableImportJob
+                 If the method is called asynchronously,
+                 returns the request thread.
+        """
+
+        all_params = ['datatable_id', 'body']
+        all_params.append('callback')
+
+        params = locals()
+        for key, val in params['kwargs'].items():
+            if key not in all_params:
+                raise TypeError(
+                    "Got an unexpected keyword argument '%s'"
+                    " to method post_flows_datatable_import_csv_jobs" % key
+                )
+            params[key] = val
+        del params['kwargs']
+
+        # verify the required parameter 'datatable_id' is set
+        if ('datatable_id' not in params) or (params['datatable_id'] is None):
+            raise ValueError("Missing the required parameter `datatable_id` when calling `post_flows_datatable_import_csv_jobs`")
+        # verify the required parameter 'body' is set
+        if ('body' not in params) or (params['body'] is None):
+            raise ValueError("Missing the required parameter `body` when calling `post_flows_datatable_import_csv_jobs`")
+
+
+        resource_path = '/api/v2/flows/datatables/{datatableId}/import/csv/jobs'.replace('{format}', 'json')
+        path_params = {}
+        if 'datatable_id' in params:
+            path_params['datatableId'] = params['datatable_id']
+
+        query_params = {}
+
+        header_params = {}
+
+        form_params = []
+        local_var_files = {}
+
+        body_params = None
+        if 'body' in params:
+            body_params = params['body']
+
+        # 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='DataTableImportJob',
+                                            auth_settings=auth_settings,
+                                            callback=params.get('callback'))
+        return response
+
+    @deprecated("post_flows_datatable_import_jobs is deprecated")
     def post_flows_datatable_import_jobs(self, datatable_id: str, body: 'DataTableImportJob', **kwargs) -> 'DataTableImportJob':
         """
-        Begin an import process for importing rows into a datatable
+        Begin an import process for importing rows into a datatable. Apps should migrate to use POST /api/v2/flows/datatables/{datatableId}/import/csv/jobs instead
         Create an import job for importing rows. The caller can then poll for status of the import using the token returned in the response
 
         This method makes a synchronous HTTP request by default. To make an