24.0.0

Author: InIn Devops

README.md

@@ -57,3 +57,15 @@ print usersApi.get_me()
 ## SDK Source Code Generation
 
 The SDK is automatically regenerated and published from the API's definition after each API release. For more information on the build process, see the [platform-client-sdk-common](https://github.com/MyPureCloud/platform-client-sdk-common) project.
+
+
+## Versioning
+
+The SDK's version is incremented according to the [Semantic Versioning Specification](https://semver.org/). The decision to increment version numbers is determined by [diffing the Platform API's swagger](https://github.com/purecloudlabs/platform-client-sdk-common/blob/master/modules/swaggerDiff.js) for automated builds, and optionally forcing a version bump when a build is triggered manually (e.g. releasing a bugfix).
+
+
+## Support
+
+This package is intended to be forwards compatible with v2 of PureCloud's Platform API. While the general policy for the API is not to introduce breaking changes, there are certain additions and changes to the API that cause breaking changes for the SDK, often due to the way the API is expressed in its swagger definition. Because of this, the SDK can have a major version bump while the API remains at major version 2. While the SDK is intended to be forward compatible, patches will only be released to the latest version. For these reasons, it is strongly recommended that all applications using this SDK are kept up to date and use the latest version of the SDK.
+
+For any issues, questions, or suggestions for the SDK, visit the [PureCloud Developer Forum](https://developer.mypurecloud.com/forum/).

build/PureCloudPlatformClientV2/__init__.py

@@ -50,6 +50,7 @@
 from .models.analytics_query_predicate import AnalyticsQueryPredicate
 from .models.analytics_routing_status_record import AnalyticsRoutingStatusRecord
 from .models.analytics_session import AnalyticsSession
+from .models.analytics_session_metric import AnalyticsSessionMetric
 from .models.analytics_user_detail import AnalyticsUserDetail
 from .models.analytics_user_details_query_response import AnalyticsUserDetailsQueryResponse
 from .models.analytics_user_presence_record import AnalyticsUserPresenceRecord
@@ -395,6 +396,7 @@
 from .models.domain_entity_listing import DomainEntityListing
 from .models.domain_entity_listing_evaluation_form import DomainEntityListingEvaluationForm
 from .models.domain_entity_listing_query_result import DomainEntityListingQueryResult
+from .models.domain_entity_listing_survey_form import DomainEntityListingSurveyForm
 from .models.domain_logical_interface import DomainLogicalInterface
 from .models.domain_network_address import DomainNetworkAddress
 from .models.domain_network_command_response import DomainNetworkCommandResponse
@@ -769,6 +771,7 @@
 from .models.property_index_request import PropertyIndexRequest
 from .models.provision_info import ProvisionInfo
 from .models.publish_draft_input import PublishDraftInput
+from .models.publish_form import PublishForm
 from .models.pure_cloud import PureCloud
 from .models.qualifier_mapping_observation_query_response import QualifierMappingObservationQueryResponse
 from .models.quality_audit import QualityAudit
@@ -923,6 +926,8 @@
 from .models.subscriber_response import SubscriberResponse
 from .models.suggest_search_criteria import SuggestSearchCriteria
 from .models.suggest_search_request import SuggestSearchRequest
+from .models.survey_form import SurveyForm
+from .models.survey_form_entity_listing import SurveyFormEntityListing
 from .models.system_presence import SystemPresence
 from .models.system_prompt import SystemPrompt
 from .models.system_prompt_asset import SystemPromptAsset
@@ -1068,10 +1073,19 @@
 from .models.voicemail_search_request import VoicemailSearchRequest
 from .models.voicemail_user_policy import VoicemailUserPolicy
 from .models.voicemails_search_response import VoicemailsSearchResponse
+from .models.web_chat_deployment import WebChatDeployment
+from .models.web_chat_deployment_entity_listing import WebChatDeploymentEntityListing
+from .models.web_chat_settings import WebChatSettings
 from .models.wfm_historical_adherence_calculations_complete_notice_notification import WfmHistoricalAdherenceCalculationsCompleteNoticeNotification
 from .models.wfm_historical_adherence_query import WfmHistoricalAdherenceQuery
 from .models.wfm_historical_adherence_response import WfmHistoricalAdherenceResponse
 from .models.wfm_intraday_queue_listing import WfmIntradayQueueListing
+from .models.wfm_move_agents_complete_notification import WfmMoveAgentsCompleteNotification
+from .models.wfm_move_agents_complete_notification_management_unit import WfmMoveAgentsCompleteNotificationManagementUnit
+from .models.wfm_move_agents_complete_notification_move_agent_results import WfmMoveAgentsCompleteNotificationMoveAgentResults
+from .models.wfm_move_agents_complete_notification_user import WfmMoveAgentsCompleteNotificationUser
+from .models.wfm_move_agents_complete_notification_wfm_move_agent_data import WfmMoveAgentsCompleteNotificationWfmMoveAgentData
+from .models.wfm_update_agent_details_complete_notification import WfmUpdateAgentDetailsCompleteNotification
 from .models.wfm_user_entity_listing import WfmUserEntityListing
 from .models.wfm_versioned_entity_metadata import WfmVersionedEntityMetadata
 from .models.workspace import Workspace
@@ -1127,6 +1141,7 @@
 from .apis.users_api import UsersApi
 from .apis.utilities_api import UtilitiesApi
 from .apis.voicemail_api import VoicemailApi
+from .apis.web_chat_api import WebChatApi
 from .apis.workforce_management_api import WorkforceManagementApi
 
 # import ApiClient

build/PureCloudPlatformClientV2/api_client.py

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

build/PureCloudPlatformClientV2/apis/__init__.py

@@ -40,4 +40,5 @@
 from .users_api import UsersApi
 from .utilities_api import UtilitiesApi
 from .voicemail_api import VoicemailApi
+from .web_chat_api import WebChatApi
 from .workforce_management_api import WorkforceManagementApi

build/PureCloudPlatformClientV2/apis/conversations_api.py

@@ -6471,7 +6471,7 @@ def post_conversations_cobrowsesession_participant_replace(self, conversation_id
 
     def post_conversations_email_inboundmessages(self, conversation_id, body, **kwargs):
         """
-        Send an email to an external conversation. An external conversation is one where the provider is not PureCloud based.This endpoint allows the sender of the external email to reply or send a new message to the existing conversation. The new message will be treated as part of the existing conversation and chained to it.
+        Send an email to an external conversation. An external conversation is one where the provider is not PureCloud based. This endpoint allows the sender of the external email to reply or send a new message to the existing conversation. The new message will be treated as part of the existing conversation and chained to it.
         
 
         This method makes a synchronous HTTP request by default. To make an
@@ -6730,7 +6730,7 @@ def post_conversations_email_participant_replace(self, conversation_id, particip
     def post_conversations_emails(self, body, **kwargs):
         """
         Create an email conversation
-        
+        If the direction of the request is INBOUND, this will create an external conversation with a third party provider. If the direction of the the request is OUTBOUND, this will create a conversation to send outbound emails on behalf of a queue.
 
         This method makes a synchronous HTTP request by default. To make an
         asynchronous HTTP request, please define a `callback` function

build/PureCloudPlatformClientV2/apis/outbound_api.py

@@ -5097,14 +5097,15 @@ def post_outbound_contactlist_contacts(self, contact_list_id, body, **kwargs):
             for asynchronous request. (optional)
         :param str contact_list_id: Contact List ID (required)
         :param list[DialerContact] body: Contact (required)
-        :param bool priority: Contact priority.  True means the contact(s) will be dialed next, false means the contact will go to the end of the contact queue.
-        :param bool clear_system_data: Clear system data.  True means the system data stored on the contact will be cleared if the contact already exists (attempts, callable status, etc), false means it won't.
+        :param bool priority: Contact priority. True means the contact(s) will be dialed next; false means the contact will go to the end of the contact queue.
+        :param bool clear_system_data: Clear system data. True means the system columns (attempts, callable status, etc) stored on the contact will be cleared if the contact already exists; false means they won't.
+        :param bool do_not_queue: Do not queue. True means that updated contacts will not have their positions in the queue altered, so contacts that have already been dialed will not be redialed; False means that updated contacts will be requeued, according to the 'priority' parameter.
         :return: list[DialerContact]
                  If the method is called asynchronously,
                  returns the request thread.
         """
 
-        all_params = ['contact_list_id', 'body', 'priority', 'clear_system_data']
+        all_params = ['contact_list_id', 'body', 'priority', 'clear_system_data', 'do_not_queue']
         all_params.append('callback')
 
         params = locals()
@@ -5135,6 +5136,8 @@ def post_outbound_contactlist_contacts(self, contact_list_id, body, **kwargs):
             query_params['priority'] = params['priority']
         if 'clear_system_data' in params:
             query_params['clearSystemData'] = params['clear_system_data']
+        if 'do_not_queue' in params:
+            query_params['doNotQueue'] = params['do_not_queue']
 
         header_params = {}