242.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 241.0.0
+Documentation version PureCloudPlatformClientV2 242.0.0
 
 ## Preview APIs
 

build/.openapi-generator/FILES

@@ -822,6 +822,11 @@
 from .models.coaching_appointment_status_response_list import CoachingAppointmentStatusResponseList
 from .models.coaching_notification import CoachingNotification
 from .models.coaching_notification_list import CoachingNotificationList
+from .models.coaching_schedule_slots_job_request import CoachingScheduleSlotsJobRequest
+from .models.coaching_schedule_slots_job_response import CoachingScheduleSlotsJobResponse
+from .models.coaching_schedule_slots_job_result import CoachingScheduleSlotsJobResult
+from .models.coaching_schedule_slots_job_schedule import CoachingScheduleSlotsJobSchedule
+from .models.coaching_schedule_slots_job_slot import CoachingScheduleSlotsJobSlot
 from .models.coaching_slot import CoachingSlot
 from .models.coaching_slots_request import CoachingSlotsRequest
 from .models.coaching_slots_response import CoachingSlotsResponse
@@ -1041,6 +1046,7 @@
 from .models.conversation_association import ConversationAssociation
 from .models.conversation_async_aggregate_query_response import ConversationAsyncAggregateQueryResponse
 from .models.conversation_async_aggregation_query import ConversationAsyncAggregationQuery
+from .models.conversation_attribute_filter import ConversationAttributeFilter
 from .models.conversation_basic import ConversationBasic
 from .models.conversation_call_event_topic_call_conversation import ConversationCallEventTopicCallConversation
 from .models.conversation_call_event_topic_call_media_participant import ConversationCallEventTopicCallMediaParticipant
@@ -1337,6 +1343,9 @@
 from .models.conversation_response_suggestions_topic_suggestion_context import ConversationResponseSuggestionsTopicSuggestionContext
 from .models.conversation_response_suggestions_topic_suggestion_feedback import ConversationResponseSuggestionsTopicSuggestionFeedback
 from .models.conversation_routing_data import ConversationRoutingData
+from .models.conversation_schema_attribute import ConversationSchemaAttribute
+from .models.conversation_schema_data import ConversationSchemaData
+from .models.conversation_schema_reference import ConversationSchemaReference
 from .models.conversation_screen_share_event_topic_conversation_division_membership import ConversationScreenShareEventTopicConversationDivisionMembership
 from .models.conversation_screen_share_event_topic_conversation_routing_data import ConversationScreenShareEventTopicConversationRoutingData
 from .models.conversation_screen_share_event_topic_detail import ConversationScreenShareEventTopicDetail
@@ -2060,8 +2069,6 @@
 from .models.evaluation_entity_listing import EvaluationEntityListing
 from .models.evaluation_form import EvaluationForm
 from .models.evaluation_form_and_scoring_set import EvaluationFormAndScoringSet
-from .models.evaluation_form_division_view import EvaluationFormDivisionView
-from .models.evaluation_form_division_view_listing import EvaluationFormDivisionViewListing
 from .models.evaluation_form_response import EvaluationFormResponse
 from .models.evaluation_form_response_entity_listing import EvaluationFormResponseEntityListing
 from .models.evaluation_quality_v2_topic_calibration import EvaluationQualityV2TopicCalibration
@@ -2906,6 +2913,7 @@
 from .models.knowledge_parse_record import KnowledgeParseRecord
 from .models.knowledge_search_client_application import KnowledgeSearchClientApplication
 from .models.knowledge_search_document_response import KnowledgeSearchDocumentResponse
+from .models.knowledge_setting import KnowledgeSetting
 from .models.knowledge_suggestion_config import KnowledgeSuggestionConfig
 from .models.knowledge_sync_job_report import KnowledgeSyncJobReport
 from .models.knowledge_sync_job_request import KnowledgeSyncJobRequest
@@ -3000,6 +3008,11 @@
 from .models.learning_module_rule_parts import LearningModuleRuleParts
 from .models.learning_module_summary import LearningModuleSummary
 from .models.learning_modules_domain_entity_listing import LearningModulesDomainEntityListing
+from .models.learning_schedule_slots_job_request import LearningScheduleSlotsJobRequest
+from .models.learning_schedule_slots_job_response import LearningScheduleSlotsJobResponse
+from .models.learning_schedule_slots_job_result import LearningScheduleSlotsJobResult
+from .models.learning_schedule_slots_job_schedule import LearningScheduleSlotsJobSchedule
+from .models.learning_schedule_slots_job_slot import LearningScheduleSlotsJobSlot
 from .models.learning_schedule_slots_query_request import LearningScheduleSlotsQueryRequest
 from .models.learning_schedule_slots_query_response import LearningScheduleSlotsQueryResponse
 from .models.learning_scorm_response import LearningScormResponse
@@ -4579,11 +4592,13 @@
 from .models.subscription_overview_usage import SubscriptionOverviewUsage
 from .models.suggest_search_criteria import SuggestSearchCriteria
 from .models.suggest_search_request import SuggestSearchRequest
+from .models.suggested_search_chunk import SuggestedSearchChunk
 from .models.suggestion import Suggestion
 from .models.suggestion_canned_response import SuggestionCannedResponse
 from .models.suggestion_context import SuggestionContext
 from .models.suggestion_engagement import SuggestionEngagement
 from .models.suggestion_feedback import SuggestionFeedback
+from .models.suggestion_generated_knowledge_answer import SuggestionGeneratedKnowledgeAnswer
 from .models.suggestion_knowledge_answer import SuggestionKnowledgeAnswer
 from .models.suggestion_knowledge_article import SuggestionKnowledgeArticle
 from .models.suggestion_knowledge_search import SuggestionKnowledgeSearch
@@ -4648,8 +4663,6 @@
 from .models.survey_error_details import SurveyErrorDetails
 from .models.survey_form import SurveyForm
 from .models.survey_form_and_scoring_set import SurveyFormAndScoringSet
-from .models.survey_form_division_view import SurveyFormDivisionView
-from .models.survey_form_division_view_listing import SurveyFormDivisionViewListing
 from .models.survey_form_entity_listing import SurveyFormEntityListing
 from .models.survey_question import SurveyQuestion
 from .models.survey_question_group import SurveyQuestionGroup
@@ -4718,7 +4731,11 @@
 from .models.test_topic_phrase_job_request import TestTopicPhraseJobRequest
 from .models.test_topic_phrase_jobs import TestTopicPhraseJobs
 from .models.test_topic_phrase_phrase import TestTopicPhrasePhrase
+from .models.test_topic_phrase_test_phrase_detected_phrase import TestTopicPhraseTestPhraseDetectedPhrase
+from .models.test_topic_phrase_test_phrase_matched_transcript import TestTopicPhraseTestPhraseMatchedTranscript
+from .models.test_topic_phrase_test_topic_phrase_results import TestTopicPhraseTestTopicPhraseResults
 from .models.test_topic_phrase_topic import TestTopicPhraseTopic
+from .models.test_topic_phrase_topics_definitions_job import TestTopicPhraseTopicsDefinitionsJob
 from .models.text_bot_channel import TextBotChannel
 from .models.text_bot_disconnect_action import TextBotDisconnectAction
 from .models.text_bot_error_input_event import TextBotErrorInputEvent
@@ -4833,6 +4850,7 @@
 from .models.transfer_to_external_contact_request import TransferToExternalContactRequest
 from .models.transfer_to_external_request import TransferToExternalRequest
 from .models.transfer_to_queue_request import TransferToQueueRequest
+from .models.transfers_full_time_equivalent import TransfersFullTimeEquivalent
 from .models.translate_supported_language import TranslateSupportedLanguage
 from .models.translate_supported_language_list import TranslateSupportedLanguageList
 from .models.trend_data import TrendData
@@ -5024,6 +5042,7 @@
 from .models.user_conversations_event_media_summary_detail import UserConversationsEventMediaSummaryDetail
 from .models.user_conversations_event_user_conversation_summary import UserConversationsEventUserConversationSummary
 from .models.user_cursor_entity_listing import UserCursorEntityListing
+from .models.user_custom_attributes import UserCustomAttributes
 from .models.user_detail_query_clause import UserDetailQueryClause
 from .models.user_detail_query_filter import UserDetailQueryFilter
 from .models.user_detail_query_predicate import UserDetailQueryPredicate
@@ -5164,19 +5183,17 @@
 from .models.v2_mobius_rules_topic_condition_rule_predicate import V2MobiusRulesTopicConditionRulePredicate
 from .models.v2_mobius_rules_topic_entity_properties import V2MobiusRulesTopicEntityProperties
 from .models.v2_mobius_rules_topic_rule import V2MobiusRulesTopicRule
-from .models.v2_queue_observation_metric_data import V2QueueObservationMetricData
-from .models.v2_queue_observation_metric_group import V2QueueObservationMetricGroup
-from .models.v2_queue_observation_metric_stats import V2QueueObservationMetricStats
-from .models.v2_queue_observation_observation import V2QueueObservationObservation
-from .models.v2_queue_observation_observation_notification import V2QueueObservationObservationNotification
-from .models.v2_queue_observation_scored_agent import V2QueueObservationScoredAgent
+from .models.v2_queue_observation_metric_count_data import V2QueueObservationMetricCountData
+from .models.v2_queue_observation_metric_count_group import V2QueueObservationMetricCountGroup
+from .models.v2_queue_observation_observation_count_notification import V2QueueObservationObservationCountNotification
 from .models.v2_reprocess_job_state_changed_topic_job_state_changed import V2ReprocessJobStateChangedTopicJobStateChanged
 from .models.v2_session_conversations_summary_settings_preview_event_conversation_followup_action import V2SessionConversationsSummarySettingsPreviewEventConversationFollowupAction
 from .models.v2_session_conversations_summary_settings_preview_event_conversation_reason_message import V2SessionConversationsSummarySettingsPreviewEventConversationReasonMessage
 from .models.v2_session_conversations_summary_settings_preview_event_conversation_resolution_message import V2SessionConversationsSummarySettingsPreviewEventConversationResolutionMessage
 from .models.v2_session_conversations_summary_settings_preview_event_conversation_summary_extracted_entity import V2SessionConversationsSummarySettingsPreviewEventConversationSummaryExtractedEntity
 from .models.v2_session_conversations_summary_settings_preview_event_conversation_summary_message import V2SessionConversationsSummarySettingsPreviewEventConversationSummaryMessage
 from .models.v2_session_conversations_summary_settings_preview_event_conversation_summary_settings_preview_message import V2SessionConversationsSummarySettingsPreviewEventConversationSummarySettingsPreviewMessage
+from .models.v2_sta_conversation_categories_sta_conversation_categories_message import V2StaConversationCategoriesStaConversationCategoriesMessage
 from .models.v2_sta_empathy_overall_topic_agent_empathy_score import V2StaEmpathyOverallTopicAgentEmpathyScore
 from .models.v2_sta_empathy_overall_topic_overall_empathy_message import V2StaEmpathyOverallTopicOverallEmpathyMessage
 from .models.v2_sta_sentiment_overall_topic_overall_sentiment_message import V2StaSentimentOverallTopicOverallSentimentMessage

build/APIData.json

@@ -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'] = '241.0.0'
+        header_params['purecloud-sdk'] = '242.0.0'
 
         # path parameters
         if path_params:

build/PureCloudPlatformClientV2/__init__.py

@@ -50,6 +50,8 @@
 from ..models import CoachingAppointmentStatusResponseList
 from ..models import CoachingNotification
 from ..models import CoachingNotificationList
+from ..models import CoachingScheduleSlotsJobRequest
+from ..models import CoachingScheduleSlotsJobResponse
 from ..models import CoachingSlotsRequest
 from ..models import CoachingSlotsResponse
 from ..models import CreateCoachingAppointmentRequest
@@ -936,6 +938,84 @@ def get_coaching_notifications(self, **kwargs) -> 'CoachingNotificationList':
                                             callback=params.get('callback'))
         return response
 
+    def get_coaching_scheduleslots_job(self, job_id: str, **kwargs) -> 'CoachingScheduleSlotsJobResponse':
+        """
+        Retrieve the status of the job for the slots where a coaching appointment can be scheduled.
+        
+
+        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_coaching_scheduleslots_job(job_id, callback=callback_function)
+
+        :param callback function: The callback function
+            for asynchronous request. (optional)
+        :param str job_id: The ID of job (required)
+        :return: CoachingScheduleSlotsJobResponse
+                 If the method is called asynchronously,
+                 returns the request thread.
+        """
+
+        all_params = ['job_id']
+        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 get_coaching_scheduleslots_job" % key
+                )
+            params[key] = val
+        del params['kwargs']
+
+        # verify the required parameter 'job_id' is set
+        if ('job_id' not in params) or (params['job_id'] is None):
+            raise ValueError("Missing the required parameter `job_id` when calling `get_coaching_scheduleslots_job`")
+
+
+        resource_path = '/api/v2/coaching/scheduleslots/jobs/{jobId}'.replace('{format}', 'json')
+        path_params = {}
+        if 'job_id' in params:
+            path_params['jobId'] = params['job_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, 'GET',
+                                            path_params,
+                                            query_params,
+                                            header_params,
+                                            body=body_params,
+                                            post_params=form_params,
+                                            files=local_var_files,
+                                            response_type='CoachingScheduleSlotsJobResponse',
+                                            auth_settings=auth_settings,
+                                            callback=params.get('callback'))
+        return response
+
     def patch_coaching_appointment(self, appointment_id: str, body: 'UpdateCoachingAppointmentRequest', **kwargs) -> 'CoachingAppointmentResponse':
         """
         Update an existing appointment
@@ -1602,6 +1682,84 @@ def post_coaching_appointments_aggregates_query(self, body: 'CoachingAppointment
                                             callback=params.get('callback'))
         return response
 
+    def post_coaching_scheduleslots_jobs(self, body: 'CoachingScheduleSlotsJobRequest', **kwargs) -> 'CoachingScheduleSlotsJobResponse':
+        """
+        Start job to retrieve the slots where a coaching appointment can be scheduled.
+        
+
+        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_coaching_scheduleslots_jobs(body, callback=callback_function)
+
+        :param callback function: The callback function
+            for asynchronous request. (optional)
+        :param CoachingScheduleSlotsJobRequest body: The slots search request (required)
+        :return: CoachingScheduleSlotsJobResponse
+                 If the method is called asynchronously,
+                 returns the request thread.
+        """
+
+        all_params = ['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_coaching_scheduleslots_jobs" % key
+                )
+            params[key] = val
+        del params['kwargs']
+
+        # 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_coaching_scheduleslots_jobs`")
+
+
+        resource_path = '/api/v2/coaching/scheduleslots/jobs'.replace('{format}', 'json')
+        path_params = {}
+
+        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='CoachingScheduleSlotsJobResponse',
+                                            auth_settings=auth_settings,
+                                            callback=params.get('callback'))
+        return response
+
     def post_coaching_scheduleslots_query(self, body: 'CoachingSlotsRequest', **kwargs) -> 'CoachingSlotsResponse':
         """
         Get list of possible slots where a coaching appointment can be scheduled.