purecloudplatformclientv2 22.0.0 → 23.0.0

data/docs/ExternalContact.md

@@ -26,6 +26,7 @@ title: ExternalContact
 | **create_date** | **DateTime** | Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
 | **external_organization** | [**ExternalOrganization**](ExternalOrganization.html) |  | [optional] |
 | **survey_opt_out** | **BOOLEAN** |  | [optional] |
+| **external_system_url** | **String** |  | [optional] |
 | **external_data_sources** | [**Array<ExternalDataSource>**](ExternalDataSource.html) | Links to the sources of data (e.g. one source might be a CRM) that contributed data to this record.  Read-only, and only populated when requested via expand param. | [optional] |
 | **self_uri** | **String** | The URI for this object | [optional] |
 {: class="table table-striped"}

data/docs/IgnoredActivityCategories.md

@@ -0,0 +1,13 @@
+---
+title: IgnoredActivityCategories
+---
+## PureCloud::IgnoredActivityCategories
+
+## Properties
+
+|Name | Type | Description | Notes|
+|------------ | ------------- | ------------- | -------------|
+| **values** | **Array<String>** | Activity categories list | [optional] |
+{: class="table table-striped"}
+
+

data/docs/ManagementUnit.md

@@ -12,9 +12,10 @@ title: ManagementUnit
 | **start_day_of_week** | **String** | Start day of week for scheduling and forecasting purposes | [optional] |
 | **time_zone** | **String** | The time zone for the management unit in standard Olson Format (See https://en.wikipedia.org/wiki/Tz_database) | [optional] |
 | **settings** | [**ManagementUnitSettings**](ManagementUnitSettings.html) | The configuration settings for this management unit | [optional] |
-| **version** | **Integer** | The version of the underlying entity | |
-| **date_modified** | **DateTime** | The date and time at which this entity was last modified. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
-| **modified_by** | [**User**](User.html) | The user who last modified this entity | [optional] |
+| **version** | **Integer** | The version of the underlying entity.  Deprecated, use metadata field instead | |
+| **date_modified** | **DateTime** | The date and time at which this entity was last modified.  Deprecated, use metadata field instead. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
+| **modified_by** | [**UserReference**](UserReference.html) | The user who last modified this entity.  Deprecated, use metadata field instead | [optional] |
+| **metadata** | [**WfmVersionedEntityMetadata**](WfmVersionedEntityMetadata.html) | Version info metadata for this management unit | |
 | **self_uri** | **String** | The URI for this object | [optional] |
 {: class="table table-striped"}
 

data/docs/ManagementUnitSettings.md

@@ -11,9 +11,7 @@ title: ManagementUnitSettings
 | **short_term_forecasting** | [**ShortTermForecastingSettings**](ShortTermForecastingSettings.html) | Short term forecasting settings for this management unit | [optional] |
 | **time_off** | [**TimeOffRequestSettings**](TimeOffRequestSettings.html) | Time off request settings for this management unit | [optional] |
 | **scheduling** | [**SchedulingSettings**](SchedulingSettings.html) | Scheduling settings for this management unit | [optional] |
-| **version** | **Integer** | The version of the underlying entity | |
-| **date_modified** | **DateTime** | The date and time at which this entity was last modified. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
-| **modified_by** | [**User**](User.html) | The user who last modified this entity | [optional] |
+| **metadata** | [**WfmVersionedEntityMetadata**](WfmVersionedEntityMetadata.html) | Version info metadata for the associated management unit | |
 {: class="table table-striped"}
 
 

data/docs/MessageDetails.md

@@ -12,6 +12,7 @@ title: MessageDetails
 | **message_status** | **String** | Indicates the delivery status of the message. | [optional] |
 | **message_segment_count** | **Integer** | The message segment count, greater than 1 if the message content was split into multiple parts for this message type, e.g. SMS character limits. | [optional] |
 | **message_time** | **DateTime** | The time when the message was sent or received. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
+| **media** | [**Array<MessageMedia>**](MessageMedia.html) | The media (images, files, etc) associated with this message, if any | [optional] |
 {: class="table table-striped"}
 
 

data/docs/MessageMedia.md

@@ -0,0 +1,14 @@
+---
+title: MessageMedia
+---
+## PureCloud::MessageMedia
+
+## Properties
+
+|Name | Type | Description | Notes|
+|------------ | ------------- | ------------- | -------------|
+| **url** | **String** | The location of the media, useful for retrieving it | [optional] |
+| **media_type** | **String** | The optional internet media type of the the media object.  If null then the media type should be dictated by the url | [optional] |
+{: class="table table-striped"}
+
+

data/docs/MoveAgentResponse.md

@@ -0,0 +1,14 @@
+---
+title: MoveAgentResponse
+---
+## PureCloud::MoveAgentResponse
+
+## Properties
+
+|Name | Type | Description | Notes|
+|------------ | ------------- | ------------- | -------------|
+| **user** | [**UserReference**](UserReference.html) | The user associated with the move | [optional] |
+| **result** | **String** | The result of the move | [optional] |
+{: class="table table-striped"}
+
+

data/docs/MoveAgentsRequest.md

@@ -0,0 +1,14 @@
+---
+title: MoveAgentsRequest
+---
+## PureCloud::MoveAgentsRequest
+
+## Properties
+
+|Name | Type | Description | Notes|
+|------------ | ------------- | ------------- | -------------|
+| **user_ids** | **Array<String>** | The list of user ids to move | |
+| **destination_management_unit_id** | **String** | The id of the management unit for which the move will be performed. To remove users from their management unit this should be set to null. | [optional] |
+{: class="table table-striped"}
+
+

data/docs/MoveAgentsResponse.md

@@ -0,0 +1,15 @@
+---
+title: MoveAgentsResponse
+---
+## PureCloud::MoveAgentsResponse
+
+## Properties
+
+|Name | Type | Description | Notes|
+|------------ | ------------- | ------------- | -------------|
+| **requesting_user** | [**UserReference**](UserReference.html) | The user that made the request | [optional] |
+| **destination_management_unit** | [**ManagementUnitReference**](ManagementUnitReference.html) | The management unit specified on the request | [optional] |
+| **results** | [**Array<MoveAgentResponse>**](MoveAgentResponse.html) | The list containing the agent and result of the move operation | [optional] |
+{: class="table table-striped"}
+
+

data/docs/NTPSettings.md

@@ -0,0 +1,13 @@
+---
+title: NTPSettings
+---
+## PureCloud::NTPSettings
+
+## Properties
+
+|Name | Type | Description | Notes|
+|------------ | ------------- | ------------- | -------------|
+| **servers** | **Array<String>** | List of NTP servers, in priority order | [optional] |
+{: class="table table-striped"}
+
+

data/docs/OrganizationAuthorizationApi.md

@@ -1038,7 +1038,7 @@ api_instance = PureCloud::OrganizationAuthorizationApi.new
 
 trustee_org_id = "trustee_org_id_example" # String | Trustee Organization Id
 
-body = PureCloud::TrustUserCreate.new # TrustUserCreate | Trust
+body = PureCloud::TrustMemberCreate.new # TrustMemberCreate | Trust
 
 
 begin
@@ -1055,7 +1055,7 @@ end
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
  **trustee_org_id** | **String**| Trustee Organization Id |  |
- **body** | [**TrustUserCreate**](TrustUserCreate.html)| Trust |  |
+ **body** | [**TrustMemberCreate**](TrustMemberCreate.html)| Trust |  |
 {: class="table table-striped"}
 
 

data/docs/OutOfOfficeNotification.md

@@ -9,6 +9,7 @@ title: OutOfOfficeNotification
 |------------ | ------------- | ------------- | -------------|
 | **user** | [**DocumentDataV2NotificationWorkspace**](DocumentDataV2NotificationWorkspace.html) |  | [optional] |
 | **active** | **BOOLEAN** |  | [optional] |
+| **indefinite** | **BOOLEAN** |  | [optional] |
 | **start_date** | **DateTime** |  | [optional] |
 | **end_date** | **DateTime** |  | [optional] |
 {: class="table table-striped"}

data/docs/OutboundApi.md

@@ -71,6 +71,7 @@ Method | Description
 [**post_outbound_campaigns**](OutboundApi.html#post_outbound_campaigns) | Create a campaign.
 [**post_outbound_campaigns_progress**](OutboundApi.html#post_outbound_campaigns_progress) | Get progress for a list of campaigns
 [**post_outbound_contactlist_contacts**](OutboundApi.html#post_outbound_contactlist_contacts) | Add contacts to a contact list.
+[**post_outbound_contactlist_contacts_bulk**](OutboundApi.html#post_outbound_contactlist_contacts_bulk) | Get contacts from a contact list.
 [**post_outbound_contactlist_export**](OutboundApi.html#post_outbound_contactlist_export) | Initiate the export of a contact list.
 [**post_outbound_contactlistfilters**](OutboundApi.html#post_outbound_contactlistfilters) | Create Contact List Filter
 [**post_outbound_contactlistfilters_preview**](OutboundApi.html#post_outbound_contactlistfilters_preview) | Get a preview of the output of a contact list filter
@@ -3971,6 +3972,68 @@ Name | Type | Description  | Notes
 
 
 
+<a name="post_outbound_contactlist_contacts_bulk"></a>
+
+## -[**Array&lt;DialerContact&gt;**](DialerContact.html) post_outbound_contactlist_contacts_bulk(contact_list_id, body)
+
+Get contacts from a contact list.
+
+
+
+Wraps POST /api/v2/outbound/contactlists/{contactListId}/contacts/bulk 
+
+
+### Example
+~~~ruby
+# load the gem
+require 'purecloudplatformclientv2'
+# setup authorization
+@secret = ENV['PURECLOUD_SECRET']
+@id = ENV['PURECLOUD_CLIENT_ID']
+environment = "mypurecloud.com"
+
+@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
+
+PureCloud.configure do |config|
+  config.access_token = @authToken
+end
+
+api_instance = PureCloud::OutboundApi.new
+
+contact_list_id = "contact_list_id_example" # String | Contact List ID
+
+body = [PureCloud::Array<String>.new] # Array<String> | ContactIds to get.
+
+
+begin
+  #Get contacts from a contact list.
+  result = api_instance.post_outbound_contactlist_contacts_bulk(contact_list_id, body)
+  p result
+rescue PureCloud::ApiError => e
+  puts "Exception when calling OutboundApi->post_outbound_contactlist_contacts_bulk: #{e}"
+end
+~~~
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **contact_list_id** | **String**| Contact List ID |  |
+ **body** | **Array&lt;String&gt;**| ContactIds to get. |  |
+{: class="table table-striped"}
+
+
+### Return type
+
+[**Array&lt;DialerContact&gt;**](DialerContact.html)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
 <a name="post_outbound_contactlist_export"></a>
 
 ## -[**UriReference**](UriReference.html) post_outbound_contactlist_export(contact_list_id)

data/docs/Queue.md

@@ -9,22 +9,23 @@ title: Queue
 |------------ | ------------- | ------------- | -------------|
 | **id** | **String** | The globally unique identifier for the object. | [optional] |
 | **name** | **String** |  | [optional] |
-| **description** | **String** | The resource's description. | [optional] |
-| **version** | **Integer** | The current version of the resource. | [optional] |
-| **date_created** | **DateTime** | The date the resource was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
-| **date_modified** | **DateTime** | The date of the last modification to the resource. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
-| **modified_by** | **String** | The ID of the user that last modified the resource. | [optional] |
-| **created_by** | **String** | The ID of the user that created the resource. | [optional] |
-| **state** | **String** | Indicates if the resource is active, inactive, or deleted. | [optional] |
-| **modified_by_app** | **String** | The application that last modified the resource. | [optional] |
-| **created_by_app** | **String** | The application that created the resource. | [optional] |
+| **description** | **String** | The queue description. | [optional] |
+| **version** | **Integer** | The current version of the queue. | [optional] |
+| **division** | [**UriReference**](UriReference.html) | The division to which this queue belongs. | [optional] |
+| **date_created** | **DateTime** | The date the queue was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
+| **date_modified** | **DateTime** | The date of the last modification to the queue. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
+| **modified_by** | **String** | The ID of the user that last modified the queue. | [optional] |
+| **created_by** | **String** | The ID of the user that created the queue. | [optional] |
+| **state** | **String** | Indicates if the queue is active, inactive, or deleted. | [optional] |
+| **modified_by_app** | **String** | The application that last modified the queue. | [optional] |
+| **created_by_app** | **String** | The application that created the queue. | [optional] |
 | **media_settings** | [**Hash<String, MediaSetting>**](MediaSetting.html) | The media settings for the queue. Valid Key Values: CALL, CALLBACK, CHAT, EMAIL, SOCIAL_EXPRESSION | |
 | **bullseye** | [**Bullseye**](Bullseye.html) | The bulls-eye settings for the queue. | [optional] |
 | **acw_settings** | [**AcwSettings**](AcwSettings.html) | The ACW settings for the queue. | |
 | **skill_evaluation_method** | **String** | The skill evaluation method to use when routing conversations. | |
 | **queue_flow** | [**UriReference**](UriReference.html) | The in-queue flow to use for conversations waiting in queue. | [optional] |
-| **whisper** | [**UriReference**](UriReference.html) | The prompt used for whisper audio on the queue, if configured. | [optional] |
-| **auto_answer_only** | **BOOLEAN** | Specifies whether the configured whisper audio should play for all ACD calls, or only for those which are auto-answered. | [optional] |
+| **whisper** | [**UriReference**](UriReference.html) | ID of the whisper configured for this queue, if any. | [optional] |
+| **auto_answer_only** | **BOOLEAN** | Specifies whether the configured whisper should play for all ACD calls, or only for those which are auto-answered. | [optional] |
 | **calling_party_name** | **String** | The name to use for caller identification for outbound calls from this queue. | [optional] |
 | **calling_party_number** | **String** | The phone number to use for caller identification for outbound calls from this queue. | [optional] |
 | **default_scripts** | [**Hash<String, Script>**](Script.html) | The default script Ids for the communication types. | [optional] |

data/docs/Recording.md

@@ -17,6 +17,7 @@ title: Recording
 | **annotations** | [**Array<Annotation>**](Annotation.html) | Annotations that belong to the recording. | [optional] |
 | **transcript** | [**Array<ChatMessage>**](ChatMessage.html) | Represents a chat transcript | [optional] |
 | **email_transcript** | [**Array<RecordingEmailMessage>**](RecordingEmailMessage.html) | Represents an email transcript | [optional] |
+| **messaging_transcript** | [**Array<RecordingMessagingMessage>**](RecordingMessagingMessage.html) | Represents a messaging transcript | [optional] |
 | **file_state** | **String** | Represents the current file state for a recording. Examples: Uploading, Archived, etc | [optional] |
 | **restore_expiration_time** | **DateTime** | The amount of time a restored recording will remain restored before being archived again. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
 | **media_uris** | [**Hash<String, MediaResult>**](MediaResult.html) | The different mediaUris for the recording. | [optional] |

data/docs/RecordingApi.md

@@ -21,6 +21,7 @@ Method | Description
 [**get_orphanrecording**](RecordingApi.html#get_orphanrecording) | Gets a single orphan recording
 [**get_orphanrecording_media**](RecordingApi.html#get_orphanrecording_media) | Gets the media of a single orphan recording
 [**get_orphanrecordings**](RecordingApi.html#get_orphanrecordings) | Gets all orphan recordings
+[**get_recording_batchrequest**](RecordingApi.html#get_recording_batchrequest) | Get the status and results for a batch request job, only the user that submitted the job may retrieve results
 [**get_recording_localkeys_setting**](RecordingApi.html#get_recording_localkeys_setting) | Get the local encryption settings
 [**get_recording_localkeys_settings**](RecordingApi.html#get_recording_localkeys_settings) | gets a list local key settings data
 [**get_recording_mediaretentionpolicies**](RecordingApi.html#get_recording_mediaretentionpolicies) | Gets media retention policy list with query options to filter on name and enabled.
@@ -32,6 +33,7 @@ Method | Description
 [**patch_recording_mediaretentionpolicy**](RecordingApi.html#patch_recording_mediaretentionpolicy) | Patch a media retention policy
 [**patch_recordings_screensession**](RecordingApi.html#patch_recordings_screensession) | Update a screen recording session
 [**post_conversation_recording_annotations**](RecordingApi.html#post_conversation_recording_annotations) | Create annotation
+[**post_recording_batchrequests**](RecordingApi.html#post_recording_batchrequests) | Submit a batch download request
 [**post_recording_localkeys**](RecordingApi.html#post_recording_localkeys) | create a local recording key
 [**post_recording_localkeys_settings**](RecordingApi.html#post_recording_localkeys_settings) | create settings for local key creation
 [**post_recording_mediaretentionpolicies**](RecordingApi.html#post_recording_mediaretentionpolicies) | Create media retention policy
@@ -867,6 +869,65 @@ Name | Type | Description  | Notes
 
 
 
+<a name="get_recording_batchrequest"></a>
+
+## -[**BatchDownloadJobStatusResult**](BatchDownloadJobStatusResult.html) get_recording_batchrequest(job_id)
+
+Get the status and results for a batch request job, only the user that submitted the job may retrieve results
+
+
+
+Wraps GET /api/v2/recording/batchrequests/{jobId} 
+
+
+### Example
+~~~ruby
+# load the gem
+require 'purecloudplatformclientv2'
+# setup authorization
+@secret = ENV['PURECLOUD_SECRET']
+@id = ENV['PURECLOUD_CLIENT_ID']
+environment = "mypurecloud.com"
+
+@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
+
+PureCloud.configure do |config|
+  config.access_token = @authToken
+end
+
+api_instance = PureCloud::RecordingApi.new
+
+job_id = "job_id_example" # String | jobId
+
+
+begin
+  #Get the status and results for a batch request job, only the user that submitted the job may retrieve results
+  result = api_instance.get_recording_batchrequest(job_id)
+  p result
+rescue PureCloud::ApiError => e
+  puts "Exception when calling RecordingApi->get_recording_batchrequest: #{e}"
+end
+~~~
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **job_id** | **String**| jobId |  |
+{: class="table table-striped"}
+
+
+### Return type
+
+[**BatchDownloadJobStatusResult**](BatchDownloadJobStatusResult.html)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
 <a name="get_recording_localkeys_setting"></a>
 
 ## -[**LocalEncryptionConfiguration**](LocalEncryptionConfiguration.html) get_recording_localkeys_setting(settings_id)
@@ -1542,6 +1603,65 @@ Name | Type | Description  | Notes
 
 
 
+<a name="post_recording_batchrequests"></a>
+
+## -[**BatchDownloadJobSubmissionResult**](BatchDownloadJobSubmissionResult.html) post_recording_batchrequests(body)
+
+Submit a batch download request
+
+
+
+Wraps POST /api/v2/recording/batchrequests 
+
+
+### Example
+~~~ruby
+# load the gem
+require 'purecloudplatformclientv2'
+# setup authorization
+@secret = ENV['PURECLOUD_SECRET']
+@id = ENV['PURECLOUD_CLIENT_ID']
+environment = "mypurecloud.com"
+
+@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
+
+PureCloud.configure do |config|
+  config.access_token = @authToken
+end
+
+api_instance = PureCloud::RecordingApi.new
+
+body = PureCloud::BatchDownloadJobSubmission.new # BatchDownloadJobSubmission | Job submission criteria
+
+
+begin
+  #Submit a batch download request
+  result = api_instance.post_recording_batchrequests(body)
+  p result
+rescue PureCloud::ApiError => e
+  puts "Exception when calling RecordingApi->post_recording_batchrequests: #{e}"
+end
+~~~
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **body** | [**BatchDownloadJobSubmission**](BatchDownloadJobSubmission.html)| Job submission criteria |  |
+{: class="table table-striped"}
+
+
+### Return type
+
+[**BatchDownloadJobSubmissionResult**](BatchDownloadJobSubmissionResult.html)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
 <a name="post_recording_localkeys"></a>
 
 ## -[**EncryptionKey**](EncryptionKey.html) post_recording_localkeys(body)

data/docs/RecordingMessagingMessage.md

@@ -0,0 +1,18 @@
+---
+title: RecordingMessagingMessage
+---
+## PureCloud::RecordingMessagingMessage
+
+## Properties
+
+|Name | Type | Description | Notes|
+|------------ | ------------- | ------------- | -------------|
+| **from** | **String** |  | [optional] |
+| **from_user** | [**User**](User.html) |  | [optional] |
+| **from_external_contact** | [**ExternalContact**](ExternalContact.html) |  | [optional] |
+| **to** | **String** |  | [optional] |
+| **timestamp** | **DateTime** | Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
+| **message_text** | **String** |  | [optional] |
+{: class="table table-striped"}
+
+