233.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 232.0.0
+Documentation version PureCloudPlatformClientV2 233.0.0
 
 ## Preview APIs
 

build/.openapi-generator/FILES

@@ -1535,6 +1535,7 @@ PureCloudPlatformClientV2/models/custom_event_attribute.py
 PureCloudPlatformClientV2/models/custom_event_attribute_list.py
 PureCloudPlatformClientV2/models/custom_i18n_labels.py
 PureCloudPlatformClientV2/models/custom_provider.py
+PureCloudPlatformClientV2/models/custom_smtp_server_request.py
 PureCloudPlatformClientV2/models/customer.py
 PureCloudPlatformClientV2/models/customer_end_detail_event_topic_customer_end_event.py
 PureCloudPlatformClientV2/models/customer_interaction_center.py
@@ -2452,6 +2453,7 @@ PureCloudPlatformClientV2/models/identity_provider.py
 PureCloudPlatformClientV2/models/identity_provider_entity_listing.py
 PureCloudPlatformClientV2/models/identity_resolution_automerge_config.py
 PureCloudPlatformClientV2/models/identity_resolution_config.py
+PureCloudPlatformClientV2/models/identity_resolution_external_source.py
 PureCloudPlatformClientV2/models/identity_resolution_queue_config.py
 PureCloudPlatformClientV2/models/idle_event_trigger.py
 PureCloudPlatformClientV2/models/idle_token_timeout.py
@@ -3327,6 +3329,7 @@ PureCloudPlatformClientV2/models/out_of_office_event_user.py
 PureCloudPlatformClientV2/models/outbound_detail_event_topic_outbound_init_event.py
 PureCloudPlatformClientV2/models/outbound_domain.py
 PureCloudPlatformClientV2/models/outbound_domain_entity_listing.py
+PureCloudPlatformClientV2/models/outbound_domain_request.py
 PureCloudPlatformClientV2/models/outbound_messaging_campaign_post_contact_email_event_topic_email_attributes.py
 PureCloudPlatformClientV2/models/outbound_messaging_campaign_post_contact_email_event_topic_outbound_messaging_campaign_post_contact_email_event.py
 PureCloudPlatformClientV2/models/outbound_messaging_campaign_post_contact_sms_event_topic_outbound_messaging_campaign_post_contact_sms_event.py
@@ -4850,6 +4853,7 @@ PureCloudPlatformClientV2/models/user_available_times.py
 PureCloudPlatformClientV2/models/user_best_points.py
 PureCloudPlatformClientV2/models/user_best_points_item.py
 PureCloudPlatformClientV2/models/user_chat_settings.py
+PureCloudPlatformClientV2/models/user_chat_settings_post.py
 PureCloudPlatformClientV2/models/user_conversation_summary.py
 PureCloudPlatformClientV2/models/user_conversations_event_media_summary.py
 PureCloudPlatformClientV2/models/user_conversations_event_media_summary_detail.py
@@ -7007,6 +7011,7 @@ docs/CustomEventAttribute.md
 docs/CustomEventAttributeList.md
 docs/CustomI18nLabels.md
 docs/CustomProvider.md
+docs/CustomSmtpServerRequest.md
 docs/Customer.md
 docs/CustomerEndDetailEventTopicCustomerEndEvent.md
 docs/CustomerInteractionCenter.md
@@ -7958,6 +7963,7 @@ docs/IdentityProviderApi.md
 docs/IdentityProviderEntityListing.md
 docs/IdentityResolutionAutomergeConfig.md
 docs/IdentityResolutionConfig.md
+docs/IdentityResolutionExternalSource.md
 docs/IdentityResolutionQueueConfig.md
 docs/IdleEventTrigger.md
 docs/IdleTokenTimeout.md
@@ -8867,6 +8873,7 @@ docs/OutboundApi.md
 docs/OutboundDetailEventTopicOutboundInitEvent.md
 docs/OutboundDomain.md
 docs/OutboundDomainEntityListing.md
+docs/OutboundDomainRequest.md
 docs/OutboundMessagingCampaignPostContactEmailEventTopicEmailAttributes.md
 docs/OutboundMessagingCampaignPostContactEmailEventTopicOutboundMessagingCampaignPostContactEmailEvent.md
 docs/OutboundMessagingCampaignPostContactSmsEventTopicOutboundMessagingCampaignPostContactSMSEvent.md
@@ -10436,6 +10443,7 @@ docs/UserAvailableTimes.md
 docs/UserBestPoints.md
 docs/UserBestPointsItem.md
 docs/UserChatSettings.md
+docs/UserChatSettingsPost.md
 docs/UserConversationSummary.md
 docs/UserConversationsEventMediaSummary.md
 docs/UserConversationsEventMediaSummaryDetail.md
@@ -11168,6 +11176,7 @@ docs/delete_chats_room_messages_pin-example.txt
 docs/delete_chats_room_participant-example.txt
 docs/delete_chats_user_message-example.txt
 docs/delete_chats_user_messages_pin-example.txt
+docs/delete_chats_users_me_settings-example.txt
 docs/delete_coaching_appointment-example.txt
 docs/delete_coaching_appointment_annotation-example.txt
 docs/delete_contentmanagement_document-example.txt
@@ -12818,6 +12827,7 @@ docs/get_workforcemanagement_notifications-example.txt
 docs/get_workforcemanagement_schedulingjob-example.txt
 docs/get_workforcemanagement_shifttrades-example.txt
 docs/get_workforcemanagement_shrinkage_job-example.txt
+docs/get_workforcemanagement_team_adherence-example.txt
 docs/get_workforcemanagement_timeoffbalance_job-example.txt
 docs/get_workforcemanagement_timeoffrequest-example.txt
 docs/get_workforcemanagement_timeoffrequest_waitlistpositions-example.txt
@@ -13182,6 +13192,7 @@ docs/post_chats_room_participant-example.txt
 docs/post_chats_rooms-example.txt
 docs/post_chats_user_messages-example.txt
 docs/post_chats_user_messages_pins-example.txt
+docs/post_chats_users_me_settings-example.txt
 docs/post_coaching_appointment_annotations-example.txt
 docs/post_coaching_appointment_conversations-example.txt
 docs/post_coaching_appointments-example.txt

build/APIData.json

@@ -8341,6 +8341,12 @@
     ],
     "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.ChatApi();\nuser_id = 'user_id_example' # str | userId\npinned_message_id = 'pinned_message_id_example' # str | pinnedMessageId\n\ntry:\n    # Remove a pinned message from a 1on1\n    api_instance.delete_chats_user_messages_pin(user_id, pinned_message_id)\nexcept ApiException as e:\n    print(\"Exception when calling ChatApi->delete_chats_user_messages_pin: %s\\n\" % e)"
   },
+  "delete_chats_users_me_settings": {
+    "operationId": "delete_chats_users_me_settings",
+    "functionName": "delete_chats_users_me_settings",
+    "signature": "delete_chats_users_me_settings()",
+    "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.ChatApi();\n\ntry:\n    # Delete a user's chat settings\n    api_instance.delete_chats_users_me_settings()\nexcept ApiException as e:\n    print(\"Exception when calling ChatApi->delete_chats_users_me_settings: %s\\n\" % e)"
+  },
   "get_chats_message": {
     "operationId": "get_chats_message",
     "functionName": "get_chats_message",
@@ -8793,6 +8799,19 @@
     ],
     "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.ChatApi();\nuser_id = 'user_id_example' # str | userId\nbody = PureCloudPlatformClientV2.PinnedMessageRequest() # PinnedMessageRequest | Pinned Message Ids\n\ntry:\n    # Add pinned messages for a 1on1, up to a maximum of 5 pinned messages\n    api_instance.post_chats_user_messages_pins(user_id, body)\nexcept ApiException as e:\n    print(\"Exception when calling ChatApi->post_chats_user_messages_pins: %s\\n\" % e)"
   },
+  "post_chats_users_me_settings": {
+    "operationId": "post_chats_users_me_settings",
+    "functionName": "post_chats_users_me_settings",
+    "signature": "post_chats_users_me_settings(body)",
+    "parameters": [
+      {
+        "name": "body",
+        "type": "UserChatSettingsPost",
+        "required": "true"
+      }
+    ],
+    "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.ChatApi();\nbody = PureCloudPlatformClientV2.UserChatSettingsPost() # UserChatSettingsPost | \n\ntry:\n    # Create a user's chat settings\n    api_instance.post_chats_users_me_settings(body)\nexcept ApiException as e:\n    print(\"Exception when calling ChatApi->post_chats_users_me_settings: %s\\n\" % e)"
+  },
   "put_chats_message_reactions": {
     "operationId": "put_chats_message_reactions",
     "functionName": "put_chats_message_reactions",
@@ -15840,7 +15859,7 @@
         "required": "true"
       }
     ],
-    "return": "DataSchema",
+    "return": "DataSchemaListing",
     "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.ExternalContactsApi();\nschema_id = 'schema_id_example' # str | Schema ID\n\ntry:\n    # Get all versions of an external contact's schema\n    api_response = api_instance.get_externalcontacts_contacts_schema_versions(schema_id)\n    pprint(api_response)\nexcept ApiException as e:\n    print(\"Exception when calling ExternalContactsApi->get_externalcontacts_contacts_schema_versions: %s\\n\" % e)"
   },
   "get_externalcontacts_contacts_schemas": {
@@ -16345,7 +16364,7 @@
         "required": "true"
       }
     ],
-    "return": "DataSchema",
+    "return": "DataSchemaListing",
     "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.ExternalContactsApi();\nschema_id = 'schema_id_example' # str | Schema ID\n\ntry:\n    # Get all versions of an external organization's schema\n    api_response = api_instance.get_externalcontacts_organizations_schema_versions(schema_id)\n    pprint(api_response)\nexcept ApiException as e:\n    print(\"Exception when calling ExternalContactsApi->get_externalcontacts_organizations_schema_versions: %s\\n\" % e)"
   },
   "get_externalcontacts_organizations_schemas": {
@@ -40151,12 +40170,12 @@
     "parameters": [
       {
         "name": "body",
-        "type": "OutboundDomain",
+        "type": "OutboundDomainRequest",
         "required": "true"
       }
     ],
     "return": "EmailOutboundDomainResult",
-    "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.RoutingApi();\nbody = PureCloudPlatformClientV2.OutboundDomain() # OutboundDomain | Domain\n\ntry:\n    # Create a domain\n    api_response = api_instance.post_routing_email_outbound_domains(body)\n    pprint(api_response)\nexcept ApiException as e:\n    print(\"Exception when calling RoutingApi->post_routing_email_outbound_domains: %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.RoutingApi();\nbody = PureCloudPlatformClientV2.OutboundDomainRequest() # OutboundDomainRequest | Domain\n\ntry:\n    # Create a domain\n    api_response = api_instance.post_routing_email_outbound_domains(body)\n    pprint(api_response)\nexcept ApiException as e:\n    print(\"Exception when calling RoutingApi->post_routing_email_outbound_domains: %s\\n\" % e)"
   },
   "post_routing_email_outbound_domains_simulated": {
     "operationId": "post_routing_email_outbound_domains_simulated",
@@ -40165,12 +40184,12 @@
     "parameters": [
       {
         "name": "body",
-        "type": "OutboundDomain",
+        "type": "OutboundDomainRequest",
         "required": "true"
       }
     ],
     "return": "EmailOutboundDomainResult",
-    "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.RoutingApi();\nbody = PureCloudPlatformClientV2.OutboundDomain() # OutboundDomain | Domain\n\ntry:\n    # Create a simulated domain\n    api_response = api_instance.post_routing_email_outbound_domains_simulated(body)\n    pprint(api_response)\nexcept ApiException as e:\n    print(\"Exception when calling RoutingApi->post_routing_email_outbound_domains_simulated: %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.RoutingApi();\nbody = PureCloudPlatformClientV2.OutboundDomainRequest() # OutboundDomainRequest | Domain\n\ntry:\n    # Create a simulated domain\n    api_response = api_instance.post_routing_email_outbound_domains_simulated(body)\n    pprint(api_response)\nexcept ApiException as e:\n    print(\"Exception when calling RoutingApi->post_routing_email_outbound_domains_simulated: %s\\n\" % e)"
   },
   "post_routing_languages": {
     "operationId": "post_routing_languages",
@@ -44749,7 +44768,7 @@
         "required": "true"
       }
     ],
-    "return": "DataSchema",
+    "return": "DataSchemaListing",
     "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.TaskManagementApi();\nschema_id = 'schema_id_example' # str | Schema ID\n\ntry:\n    # Get all versions of a schema\n    api_response = api_instance.get_taskmanagement_workitems_schema_versions(schema_id)\n    pprint(api_response)\nexcept ApiException as e:\n    print(\"Exception when calling TaskManagementApi->get_taskmanagement_workitems_schema_versions: %s\\n\" % e)"
   },
   "get_taskmanagement_workitems_schemas": {
@@ -53199,6 +53218,20 @@
     "return": "WfmHistoricalShrinkageResponse",
     "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.WorkforceManagementApi();\njob_id = 'job_id_example' # str | jobId\n\ntry:\n    # Request to fetch the status of the historical shrinkage query\n    api_response = api_instance.get_workforcemanagement_shrinkage_job(job_id)\n    pprint(api_response)\nexcept ApiException as e:\n    print(\"Exception when calling WorkforceManagementApi->get_workforcemanagement_shrinkage_job: %s\\n\" % e)"
   },
+  "get_workforcemanagement_team_adherence": {
+    "operationId": "get_workforcemanagement_team_adherence",
+    "functionName": "get_workforcemanagement_team_adherence",
+    "signature": "get_workforcemanagement_team_adherence(team_id)",
+    "parameters": [
+      {
+        "name": "team_id",
+        "type": "str",
+        "required": "true"
+      }
+    ],
+    "return": "UserScheduleAdherenceListing",
+    "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.WorkforceManagementApi();\nteam_id = 'team_id_example' # str | The ID of the team\n\ntry:\n    # Get a list of user schedule adherence records for the requested team\n    api_response = api_instance.get_workforcemanagement_team_adherence(team_id)\n    pprint(api_response)\nexcept ApiException as e:\n    print(\"Exception when calling WorkforceManagementApi->get_workforcemanagement_team_adherence: %s\\n\" % e)"
+  },
   "get_workforcemanagement_timeoffbalance_job": {
     "operationId": "get_workforcemanagement_timeoffbalance_job",
     "functionName": "get_workforcemanagement_timeoffbalance_job",