229.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 228.0.0
+Documentation version PureCloudPlatformClientV2 229.0.0
 
 ## Preview APIs
 
@@ -460,6 +460,28 @@ apiclient_mtls.set_gateway(
 
 If you require a custom HTTP client to handle mTLS, you can utilize the set_http_client() method of the API client instance to integrate your own implementation. Remember that you will be responsible for configuring the mTLS settings within your custom HTTP client.
 
+### Using Pre Commit and Post Commit Hooks
+
+For any custom requirements like pre validations or post cleanups (for ex: OCSP and CRL validation), we can inject the prehook and posthook functions.
+The SDK's default client will make sure the injected hook functions are executed.
+
+```python
+def pre_hook(http_request_options):
+    try:
+        print('Running PreHook: Certificate Validation Checks')
+
+        // Custom validation logic here
+
+        print('Certificate Validation Complete')
+    except:
+        raise Exception('Error in prehook validation')
+
+apiclient = PureCloudPlatformClientV2.api_client.ApiClient()
+http_client = apiclient.get_http_client()
+
+http_client.set_pre_request_hook(pre_hook)
+```
+
 
 ## SDK Source Code Generation
 

build/.openapi-generator/FILES

@@ -249,6 +249,7 @@
 from .models.app_event_response import AppEventResponse
 from .models.app_event_response_session import AppEventResponseSession
 from .models.append_to_dnc_action_settings import AppendToDncActionSettings
+from .models.apple_opaque_id import AppleOpaqueId
 from .models.approval_namespace import ApprovalNamespace
 from .models.architect_dependency_tracking_build_notification_client import ArchitectDependencyTrackingBuildNotificationClient
 from .models.architect_dependency_tracking_build_notification_dependency_tracking_build_notification import ArchitectDependencyTrackingBuildNotificationDependencyTrackingBuildNotification
@@ -479,7 +480,8 @@
 from .models.bu_full_day_time_off_marker import BuFullDayTimeOffMarker
 from .models.bu_generate_schedule_request import BuGenerateScheduleRequest
 from .models.bu_get_current_agent_schedule_request import BuGetCurrentAgentScheduleRequest
-from .models.bu_headcount_forecast import BuHeadcountForecast
+from .models.bu_headcount_forecast_bu_planning_group_headcount_forecast_result import BuHeadcountForecastBuPlanningGroupHeadcountForecastResult
+from .models.bu_headcount_forecast_bu_planning_group_headcount_forecast_upload_schema import BuHeadcountForecastBuPlanningGroupHeadcountForecastUploadSchema
 from .models.bu_headcount_forecast_response import BuHeadcountForecastResponse
 from .models.bu_import_agent_schedule_upload_schema import BuImportAgentScheduleUploadSchema
 from .models.bu_import_short_term_forecast_schema import BuImportShortTermForecastSchema
@@ -491,7 +493,8 @@
 from .models.bu_management_unit_schedule_summary import BuManagementUnitScheduleSummary
 from .models.bu_notification_settings_request import BuNotificationSettingsRequest
 from .models.bu_notification_settings_response import BuNotificationSettingsResponse
-from .models.bu_planning_group_headcount_forecast import BuPlanningGroupHeadcountForecast
+from .models.bu_planning_group_headcount_forecast_result import BuPlanningGroupHeadcountForecastResult
+from .models.bu_planning_group_headcount_forecast_upload_schema import BuPlanningGroupHeadcountForecastUploadSchema
 from .models.bu_query_adherence_explanations_request import BuQueryAdherenceExplanationsRequest
 from .models.bu_query_adherence_explanations_response import BuQueryAdherenceExplanationsResponse
 from .models.bu_query_agent_schedules_request import BuQueryAgentSchedulesRequest
@@ -1058,15 +1061,20 @@
 from .models.conversation_content_date_picker import ConversationContentDatePicker
 from .models.conversation_content_date_picker_available_time import ConversationContentDatePickerAvailableTime
 from .models.conversation_content_interactive_application import ConversationContentInteractiveApplication
+from .models.conversation_content_line_item import ConversationContentLineItem
 from .models.conversation_content_list_picker import ConversationContentListPicker
 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_template import ConversationContentNotificationTemplate
+from .models.conversation_content_payment_request import ConversationContentPaymentRequest
+from .models.conversation_content_payment_response import ConversationContentPaymentResponse
+from .models.conversation_content_push import ConversationContentPush
 from .models.conversation_content_quick_reply import ConversationContentQuickReply
 from .models.conversation_content_quick_reply_v2 import ConversationContentQuickReplyV2
 from .models.conversation_content_reaction import ConversationContentReaction
 from .models.conversation_content_received_reply_message import ConversationContentReceivedReplyMessage
+from .models.conversation_content_required_contact_field import ConversationContentRequiredContactField
 from .models.conversation_content_story import ConversationContentStory
 from .models.conversation_content_text import ConversationContentText
 from .models.conversation_deletion_protection_query import ConversationDeletionProtectionQuery
@@ -1202,6 +1210,9 @@
 from .models.conversation_profile import ConversationProfile
 from .models.conversation_properties import ConversationProperties
 from .models.conversation_public_metadata import ConversationPublicMetadata
+from .models.conversation_push_failed_message_references import ConversationPushFailedMessageReferences
+from .models.conversation_push_notification_message_label import ConversationPushNotificationMessageLabel
+from .models.conversation_push_provider_integration import ConversationPushProviderIntegration
 from .models.conversation_query import ConversationQuery
 from .models.conversation_queue_media_settings import ConversationQueueMediaSettings
 from .models.conversation_reason import ConversationReason
@@ -1259,6 +1270,7 @@
 from .models.conversation_summary_topic_conversation_summary_event import ConversationSummaryTopicConversationSummaryEvent
 from .models.conversation_summary_topic_conversation_summary_participant import ConversationSummaryTopicConversationSummaryParticipant
 from .models.conversation_summary_topic_conversation_wrap_up_code import ConversationSummaryTopicConversationWrapUpCode
+from .models.conversation_summary_topic_summary_extracted_custom_entity import ConversationSummaryTopicSummaryExtractedCustomEntity
 from .models.conversation_summary_topic_trigger_source import ConversationSummaryTopicTriggerSource
 from .models.conversation_summary_topic_virtual_agents_conversation_followup_action import ConversationSummaryTopicVirtualAgentsConversationFollowupAction
 from .models.conversation_summary_topic_virtual_agents_conversation_headline import ConversationSummaryTopicVirtualAgentsConversationHeadline
@@ -1268,6 +1280,7 @@
 from .models.conversation_summary_topic_virtual_agents_conversation_summary_event import ConversationSummaryTopicVirtualAgentsConversationSummaryEvent
 from .models.conversation_summary_topic_virtual_agents_conversation_summary_participant import ConversationSummaryTopicVirtualAgentsConversationSummaryParticipant
 from .models.conversation_summary_topic_virtual_agents_conversation_wrap_up_code import ConversationSummaryTopicVirtualAgentsConversationWrapUpCode
+from .models.conversation_summary_topic_virtual_agents_summary_extracted_custom_entity import ConversationSummaryTopicVirtualAgentsSummaryExtractedCustomEntity
 from .models.conversation_summary_topic_virtual_agents_trigger_source import ConversationSummaryTopicVirtualAgentsTriggerSource
 from .models.conversation_summary_wrapup_code import ConversationSummaryWrapupCode
 from .models.conversation_tags_update import ConversationTagsUpdate
@@ -1961,6 +1974,7 @@
 from .models.extension_pool_entity_listing import ExtensionPoolEntityListing
 from .models.external_contact import ExternalContact
 from .models.external_contact_reference import ExternalContactReference
+from .models.external_contacts_contact_changed_topic_apple_opaque_id import ExternalContactsContactChangedTopicAppleOpaqueId
 from .models.external_contacts_contact_changed_topic_contact import ExternalContactsContactChangedTopicContact
 from .models.external_contacts_contact_changed_topic_contact_address import ExternalContactsContactChangedTopicContactAddress
 from .models.external_contacts_contact_changed_topic_data_schema import ExternalContactsContactChangedTopicDataSchema
@@ -2004,6 +2018,7 @@
 from .models.external_contacts_relationship_changed_topic_twitter_id import ExternalContactsRelationshipChangedTopicTwitterId
 from .models.external_contacts_relationship_changed_topic_user import ExternalContactsRelationshipChangedTopicUser
 from .models.external_contacts_settings import ExternalContactsSettings
+from .models.external_contacts_unresolved_contact_changed_topic_apple_opaque_id import ExternalContactsUnresolvedContactChangedTopicAppleOpaqueId
 from .models.external_contacts_unresolved_contact_changed_topic_contact import ExternalContactsUnresolvedContactChangedTopicContact
 from .models.external_contacts_unresolved_contact_changed_topic_contact_address import ExternalContactsUnresolvedContactChangedTopicContactAddress
 from .models.external_contacts_unresolved_contact_changed_topic_data_schema import ExternalContactsUnresolvedContactChangedTopicDataSchema
@@ -2870,6 +2885,9 @@
 from .models.long_term_forecast_planning_group_data import LongTermForecastPlanningGroupData
 from .models.long_term_forecast_result import LongTermForecastResult
 from .models.long_term_forecast_result_response import LongTermForecastResultResponse
+from .models.maestro_webhooks_invocation_topic_object import MaestroWebhooksInvocationTopicObject
+from .models.maestro_webhooks_invocation_topic_public_webhooks_event import MaestroWebhooksInvocationTopicPublicWebhooksEvent
+from .models.maestro_webhooks_invocation_topic_webhooks_invocation import MaestroWebhooksInvocationTopicWebhooksInvocation
 from .models.mail_from_result import MailFromResult
 from .models.management_unit import ManagementUnit
 from .models.management_unit_listing import ManagementUnitListing
@@ -4266,6 +4284,7 @@
 from .models.summary_async_aggregate_query_response import SummaryAsyncAggregateQueryResponse
 from .models.summary_async_aggregation_query import SummaryAsyncAggregationQuery
 from .models.summary_generation_config import SummaryGenerationConfig
+from .models.summary_setting_entity import SummarySettingEntity
 from .models.support_center_category import SupportCenterCategory
 from .models.support_center_compact_category_module_template import SupportCenterCompactCategoryModuleTemplate
 from .models.support_center_custom_message import SupportCenterCustomMessage
@@ -4798,6 +4817,12 @@
 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_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_web_messaging_undelivered_message_topic_message import V2WebMessagingUndeliveredMessageTopicMessage
 from .models.v2_web_messaging_undelivered_message_topic_web_messaging_undelivered_message_event_body import V2WebMessagingUndeliveredMessageTopicWebMessagingUndeliveredMessageEventBody
 from .models.v2_wem_engagement_celebration_updates_topic_contest_complete_data import V2WemEngagementCelebrationUpdatesTopicContestCompleteData
@@ -5259,20 +5284,23 @@
 from .models.workitems_events_notification_assignment_segment import WorkitemsEventsNotificationAssignmentSegment
 from .models.workitems_events_notification_custom_attribute import WorkitemsEventsNotificationCustomAttribute
 from .models.workitems_events_notification_delta import WorkitemsEventsNotificationDelta
+from .models.workitems_events_notification_property_change import WorkitemsEventsNotificationPropertyChange
 from .models.workitems_events_notification_scored_agent import WorkitemsEventsNotificationScoredAgent
 from .models.workitems_events_notification_session import WorkitemsEventsNotificationSession
 from .models.workitems_events_notification_workitem import WorkitemsEventsNotificationWorkitem
 from .models.workitems_events_notification_wrapup import WorkitemsEventsNotificationWrapup
 from .models.workitems_queue_events_notification_assignment_segment import WorkitemsQueueEventsNotificationAssignmentSegment
 from .models.workitems_queue_events_notification_custom_attribute import WorkitemsQueueEventsNotificationCustomAttribute
 from .models.workitems_queue_events_notification_delta import WorkitemsQueueEventsNotificationDelta
+from .models.workitems_queue_events_notification_property_change import WorkitemsQueueEventsNotificationPropertyChange
 from .models.workitems_queue_events_notification_scored_agent import WorkitemsQueueEventsNotificationScoredAgent
 from .models.workitems_queue_events_notification_session import WorkitemsQueueEventsNotificationSession
 from .models.workitems_queue_events_notification_workitem import WorkitemsQueueEventsNotificationWorkitem
 from .models.workitems_queue_events_notification_wrapup import WorkitemsQueueEventsNotificationWrapup
 from .models.workitems_user_events_notification_assignment_segment import WorkitemsUserEventsNotificationAssignmentSegment
 from .models.workitems_user_events_notification_custom_attribute import WorkitemsUserEventsNotificationCustomAttribute
 from .models.workitems_user_events_notification_delta import WorkitemsUserEventsNotificationDelta
+from .models.workitems_user_events_notification_property_change import WorkitemsUserEventsNotificationPropertyChange
 from .models.workitems_user_events_notification_scored_agent import WorkitemsUserEventsNotificationScoredAgent
 from .models.workitems_user_events_notification_session import WorkitemsUserEventsNotificationSession
 from .models.workitems_user_events_notification_workitem import WorkitemsUserEventsNotificationWorkitem

build/APIData.json

@@ -4,11 +4,35 @@ class AbstractHttpClient(ABC):
     def __init__(self):
         self.timeout = 16000        
         self.https_agent = None #it is a http proxy agent will be used later
+        self.pre_hook = None
+        self.post_hook = None
 
     def set_timeout(self, timeout):
         if not isinstance(timeout, (int, float)):
             raise ValueError("The 'timeout' property must be a number")
         self.timeout = timeout
+
+    def set_pre_request_hook(self, hook):
+        """
+        Sets a pre-request hook that will be called before each request
+        
+        Args:
+            hook: A function that takes an HTTP request and returns a modified HTTP request
+        """
+        if not callable(hook) or hook.__code__.co_argcount != 1:
+            raise ValueError("preHook must be a function that accepts (http_request_options)")
+        self.pre_hook = hook
+    
+    def set_post_request_hook(self, hook):
+        """
+        Sets a post-request hook that will be called after each request
+        
+        Args:
+            hook: A function that takes an HTTP response and returns a modified HTTP response
+        """
+        if not callable(hook) or hook.__code__.co_argcount != 1:
+            raise ValueError("postHook must be a function that accepts (RESTResponse)")
+        self.post_hook = hook
 
     @abstractmethod
     def request(self, http_request_options):

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

build/PureCloudPlatformClientV2/abstract_http_client.py

@@ -5768,6 +5768,7 @@ def get_flows(self, **kwargs) -> 'FlowEntityListing':
         :param str secure: Secure
         :param bool deleted: Include deleted
         :param bool include_schemas: Include variable schemas
+        :param bool virtual_agent_enabled: Include/exclude virtual agent flows
         :param str published_after: Published after
         :param str published_before: Published before
         :param list[str] division_id: division ID(s)
@@ -5776,7 +5777,7 @@ def get_flows(self, **kwargs) -> 'FlowEntityListing':
                  returns the request thread.
         """
 
-        all_params = ['type', 'page_number', 'page_size', 'sort_by', 'sort_order', 'id', 'name', 'description', 'name_or_description', 'publish_version_id', 'editable_by', 'locked_by', 'locked_by_client_id', 'secure', 'deleted', 'include_schemas', 'published_after', 'published_before', 'division_id']
+        all_params = ['type', 'page_number', 'page_size', 'sort_by', 'sort_order', 'id', 'name', 'description', 'name_or_description', 'publish_version_id', 'editable_by', 'locked_by', 'locked_by_client_id', 'secure', 'deleted', 'include_schemas', 'virtual_agent_enabled', 'published_after', 'published_before', 'division_id']
         all_params.append('callback')
 
         params = locals()
@@ -5827,6 +5828,8 @@ def get_flows(self, **kwargs) -> 'FlowEntityListing':
             query_params['deleted'] = params['deleted']
         if 'include_schemas' in params:
             query_params['includeSchemas'] = params['include_schemas']
+        if 'virtual_agent_enabled' in params:
+            query_params['virtualAgentEnabled'] = params['virtual_agent_enabled']
         if 'published_after' in params:
             query_params['publishedAfter'] = params['published_after']
         if 'published_before' in params: