purecloudplatformclientv2 15.0.0 → 16.0.0

data/docs/JsonNode.md

@@ -7,16 +7,13 @@ title: JsonNode
 
 |Name | Type | Description | Notes|
 |------------ | ------------- | ------------- | -------------|
-| **array** | **BOOLEAN** |  | [optional] |
-| **null** | **BOOLEAN** |  | [optional] |
 | **node_type** | **String** |  | [optional] |
 | **float** | **BOOLEAN** |  | [optional] |
 | **object** | **BOOLEAN** |  | [optional] |
 | **boolean** | **BOOLEAN** |  | [optional] |
 | **number** | **BOOLEAN** |  | [optional] |
-| **value_node** | **BOOLEAN** |  | [optional] |
-| **container_node** | **BOOLEAN** |  | [optional] |
 | **missing_node** | **BOOLEAN** |  | [optional] |
+| **container_node** | **BOOLEAN** |  | [optional] |
 | **pojo** | **BOOLEAN** |  | [optional] |
 | **integral_number** | **BOOLEAN** |  | [optional] |
 | **floating_point_number** | **BOOLEAN** |  | [optional] |
@@ -28,6 +25,9 @@ title: JsonNode
 | **big_integer** | **BOOLEAN** |  | [optional] |
 | **textual** | **BOOLEAN** |  | [optional] |
 | **binary** | **BOOLEAN** |  | [optional] |
+| **value_node** | **BOOLEAN** |  | [optional] |
+| **array** | **BOOLEAN** |  | [optional] |
+| **null** | **BOOLEAN** |  | [optional] |
 {: class="table table-striped"}
 
 

data/docs/ManagementUnit.md

@@ -10,7 +10,7 @@ title: ManagementUnit
 | **id** | **String** | The globally unique identifier for the object. | [optional] |
 | **name** | **String** |  | [optional] |
 | **start_day_of_week** | **String** | Start day of week for workforce management planning purposes | [optional] |
-| **timezone** | **String** | The time zone for the management unit in standard Olson Format (See https://en.wikipedia.org/wiki/Tz_database) | [optional] |
+| **time_zone** | **String** | The time zone for the management unit in standard Olson Format (See https://en.wikipedia.org/wiki/Tz_database) | [optional] |
 | **version** | **Integer** | The version of the underlying ManagementUnit object. Useful for handling eventual consistency issues.  User must submit the current version they of the ManagementUnit in any write requests | |
 | **date_modified** | **DateTime** | The date and time at which this management unit was last modified. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
 | **self_uri** | **String** | The URI for this object | [optional] |

data/docs/ManagementUnitListing.md

@@ -0,0 +1,22 @@
+---
+title: ManagementUnitListing
+---
+## PureCloud::ManagementUnitListing
+
+## Properties
+
+|Name | Type | Description | Notes|
+|------------ | ------------- | ------------- | -------------|
+| **entities** | [**Array<ManagementUnit>**](ManagementUnit.html) |  | [optional] |
+| **page_size** | **Integer** |  | [optional] |
+| **page_number** | **Integer** |  | [optional] |
+| **total** | **Integer** |  | [optional] |
+| **self_uri** | **String** |  | [optional] |
+| **first_uri** | **String** |  | [optional] |
+| **next_uri** | **String** |  | [optional] |
+| **previous_uri** | **String** |  | [optional] |
+| **last_uri** | **String** |  | [optional] |
+| **page_count** | **Integer** |  | [optional] |
+{: class="table table-striped"}
+
+

data/docs/OutboundApi.md

@@ -18,6 +18,7 @@ Method | Description
 [**delete_outbound_contactlist_contact**](OutboundApi.html#delete_outbound_contactlist_contact) | Delete a contact.
 [**delete_outbound_contactlist_contacts**](OutboundApi.html#delete_outbound_contactlist_contacts) | Delete contacts from a contact list.
 [**delete_outbound_contactlistfilter**](OutboundApi.html#delete_outbound_contactlistfilter) | Delete Contact List Filter
+[**delete_outbound_contactlists**](OutboundApi.html#delete_outbound_contactlists) | Delete multiple contact lists.
 [**delete_outbound_dnclist**](OutboundApi.html#delete_outbound_dnclist) | Delete dialer DNC list
 [**delete_outbound_ruleset**](OutboundApi.html#delete_outbound_ruleset) | Delete a Rule set.
 [**delete_outbound_schedules_campaign**](OutboundApi.html#delete_outbound_schedules_campaign) | Delete a dialer campaign schedule.
@@ -682,6 +683,64 @@ nil (empty response body)
 
 
 
+<a name="delete_outbound_contactlists"></a>
+
+## - delete_outbound_contactlists(id)
+
+Delete multiple contact lists.
+
+
+
+Wraps DELETE /api/v2/outbound/contactlists 
+
+
+### 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
+
+id = ["id_example"] # Array<String> | contact list id(s) to delete
+
+
+begin
+  #Delete multiple contact lists.
+  api_instance.delete_outbound_contactlists(id)
+rescue PureCloud::ApiError => e
+  puts "Exception when calling OutboundApi->delete_outbound_contactlists: #{e}"
+end
+~~~
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **id** | [**Array&lt;String&gt;**](String.html)| contact list id(s) to delete |  |
+{: class="table table-striped"}
+
+
+### Return type
+
+nil (empty response body)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
 <a name="delete_outbound_dnclist"></a>
 
 ## - delete_outbound_dnclist(dnc_list_id)

data/docs/PostActionInput.md

@@ -0,0 +1,18 @@
+---
+title: PostActionInput
+---
+## PureCloud::PostActionInput
+
+## Properties
+
+|Name | Type | Description | Notes|
+|------------ | ------------- | ------------- | -------------|
+| **category** | **String** | Category of action | |
+| **name** | **String** | Name of action | |
+| **integration_id** | **String** | The ID of the integration this action is associated to | |
+| **config** | [**ActionConfig**](ActionConfig.html) | Configuration to support request and response processing | |
+| **contract** | [**ActionContractInput**](ActionContractInput.html) | Action contract | |
+| **secure** | **BOOLEAN** | Indication of whether or not the action is designed to accept sensitive data | [optional] |
+{: class="table table-striped"}
+
+

data/docs/PostInputContract.md

@@ -0,0 +1,13 @@
+---
+title: PostInputContract
+---
+## PureCloud::PostInputContract
+
+## Properties
+
+|Name | Type | Description | Notes|
+|------------ | ------------- | ------------- | -------------|
+| **input_schema** | [**JsonSchemaDocument**](JsonSchemaDocument.html) | JSON Schema that defines the body of the request that the client (edge/architect/postman) is sending to the service, on the /execute path. | |
+{: class="table table-striped"}
+
+

data/docs/PostOutputContract.md

@@ -0,0 +1,13 @@
+---
+title: PostOutputContract
+---
+## PureCloud::PostOutputContract
+
+## Properties
+
+|Name | Type | Description | Notes|
+|------------ | ------------- | ------------- | -------------|
+| **success_schema** | [**JsonSchemaDocument**](JsonSchemaDocument.html) | JSON schema that defines the transformed, successful result that will be sent back to the caller. | |
+{: class="table table-striped"}
+
+

data/docs/PublishDraftInput.md

@@ -0,0 +1,13 @@
+---
+title: PublishDraftInput
+---
+## PureCloud::PublishDraftInput
+
+## Properties
+
+|Name | Type | Description | Notes|
+|------------ | ------------- | ------------- | -------------|
+| **version** | **Integer** | The current draft version. | |
+{: class="table table-striped"}
+
+

data/docs/RecordingApi.md

@@ -15,6 +15,8 @@ Method | Description
 [**get_conversation_recording**](RecordingApi.html#get_conversation_recording) | Gets a specific recording.
 [**get_conversation_recording_annotation**](RecordingApi.html#get_conversation_recording_annotation) | Get annotation
 [**get_conversation_recording_annotations**](RecordingApi.html#get_conversation_recording_annotations) | Get annotations for recording
+[**get_conversation_recordingmetadata**](RecordingApi.html#get_conversation_recordingmetadata) | Get recording metadata for a conversation. Does not return playable media.
+[**get_conversation_recordingmetadata_recording_id**](RecordingApi.html#get_conversation_recordingmetadata_recording_id) | Get metadata for a specific recording. Does not return playable media.
 [**get_conversation_recordings**](RecordingApi.html#get_conversation_recordings) | Get all of a Conversation's Recordings.
 [**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
@@ -479,6 +481,127 @@ Name | Type | Description  | Notes
 
 
 
+<a name="get_conversation_recordingmetadata"></a>
+
+## -[**Array&lt;Recording&gt;**](Recording.html) get_conversation_recordingmetadata(conversation_id)
+
+Get recording metadata for a conversation. Does not return playable media.
+
+
+
+Wraps GET /api/v2/conversations/{conversationId}/recordingmetadata 
+
+
+### 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
+
+conversation_id = "conversation_id_example" # String | Conversation ID
+
+
+begin
+  #Get recording metadata for a conversation. Does not return playable media.
+  result = api_instance.get_conversation_recordingmetadata(conversation_id)
+  p result
+rescue PureCloud::ApiError => e
+  puts "Exception when calling RecordingApi->get_conversation_recordingmetadata: #{e}"
+end
+~~~
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **conversation_id** | **String**| Conversation ID |  |
+{: class="table table-striped"}
+
+
+### Return type
+
+[**Array&lt;Recording&gt;**](Recording.html)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+<a name="get_conversation_recordingmetadata_recording_id"></a>
+
+## -[**Recording**](Recording.html) get_conversation_recordingmetadata_recording_id(conversation_id, recording_id)
+
+Get metadata for a specific recording. Does not return playable media.
+
+
+
+Wraps GET /api/v2/conversations/{conversationId}/recordingmetadata/{recordingId} 
+
+
+### 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
+
+conversation_id = "conversation_id_example" # String | Conversation ID
+
+recording_id = "recording_id_example" # String | Recording ID
+
+
+begin
+  #Get metadata for a specific recording. Does not return playable media.
+  result = api_instance.get_conversation_recordingmetadata_recording_id(conversation_id, recording_id)
+  p result
+rescue PureCloud::ApiError => e
+  puts "Exception when calling RecordingApi->get_conversation_recordingmetadata_recording_id: #{e}"
+end
+~~~
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **conversation_id** | **String**| Conversation ID |  |
+ **recording_id** | **String**| Recording ID |  |
+{: class="table table-striped"}
+
+
+### Return type
+
+[**Recording**](Recording.html)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
 <a name="get_conversation_recordings"></a>
 
 ## -[**Array&lt;Recording&gt;**](Recording.html) get_conversation_recordings(conversation_id, opts)

data/docs/RequestConfig.md

@@ -0,0 +1,17 @@
+---
+title: RequestConfig
+---
+## PureCloud::RequestConfig
+
+## Properties
+
+|Name | Type | Description | Notes|
+|------------ | ------------- | ------------- | -------------|
+| **request_url_template** | **String** | URL that may include placeholders for requests to 3rd party service | [optional] |
+| **request_template** | **String** | Velocity template to define request body sent to 3rd party service. | [optional] |
+| **request_template_uri** | **String** | URI to retrieve requestTemplate | [optional] |
+| **request_type** | **String** | HTTP method to use for request | [optional] |
+| **headers** | **Hash<String, String>** | Headers to include in request in (Header Name, Value) pairs. | [optional] |
+{: class="table table-striped"}
+
+

data/docs/ResponseConfig.md

@@ -0,0 +1,15 @@
+---
+title: ResponseConfig
+---
+## PureCloud::ResponseConfig
+
+## Properties
+
+|Name | Type | Description | Notes|
+|------------ | ------------- | ------------- | -------------|
+| **translation_map** | **Hash<String, String>** | Map 'attribute name' and 'JSON path' pairs used to extract data from REST response. | [optional] |
+| **success_template** | **String** | Velocity template to build response to return from Action. | [optional] |
+| **success_template_uri** | **String** | URI to retrieve success template. | [optional] |
+{: class="table table-striped"}
+
+

data/docs/ScreenShareConversationNotificationParticipants.md

@@ -33,6 +33,7 @@ title: ScreenShareConversationNotificationParticipants
 | **external_organization** | [**ScreenShareConversationNotificationUriReference**](ScreenShareConversationNotificationUriReference.html) |  | [optional] |
 | **wrapup** | [**ConversationNotificationWrapup**](ConversationNotificationWrapup.html) |  | [optional] |
 | **peer** | **String** |  | [optional] |
+| **screen_recording_state** | **String** |  | [optional] |
 | **context** | **String** |  | [optional] |
 | **peer_count** | **Integer** |  | [optional] |
 | **sharing** | **BOOLEAN** |  | [optional] |

data/docs/ScreenShareConversationNotificationScreenShareMediaParticipant.md

@@ -33,6 +33,7 @@ title: ScreenShareConversationNotificationScreenShareMediaParticipant
 | **external_organization** | [**ScreenShareConversationNotificationUriReference**](ScreenShareConversationNotificationUriReference.html) |  | [optional] |
 | **wrapup** | [**ConversationNotificationWrapup**](ConversationNotificationWrapup.html) |  | [optional] |
 | **peer** | **String** |  | [optional] |
+| **screen_recording_state** | **String** |  | [optional] |
 | **context** | **String** |  | [optional] |
 | **peer_count** | **Integer** |  | [optional] |
 | **sharing** | **BOOLEAN** |  | [optional] |

data/docs/SocialConversationNotificationParticipants.md

@@ -33,6 +33,7 @@ title: SocialConversationNotificationParticipants
 | **external_organization** | [**SocialConversationNotificationUriReference**](SocialConversationNotificationUriReference.html) |  | [optional] |
 | **wrapup** | [**ConversationNotificationWrapup**](ConversationNotificationWrapup.html) |  | [optional] |
 | **peer** | **String** |  | [optional] |
+| **screen_recording_state** | **String** |  | [optional] |
 | **social_media_id** | **String** |  | [optional] |
 | **social_media_hub** | **String** |  | [optional] |
 | **social_user_name** | **String** |  | [optional] |

data/docs/SocialConversationNotificationSocialMediaParticipant.md

@@ -33,6 +33,7 @@ title: SocialConversationNotificationSocialMediaParticipant
 | **external_organization** | [**SocialConversationNotificationUriReference**](SocialConversationNotificationUriReference.html) |  | [optional] |
 | **wrapup** | [**ConversationNotificationWrapup**](ConversationNotificationWrapup.html) |  | [optional] |
 | **peer** | **String** |  | [optional] |
+| **screen_recording_state** | **String** |  | [optional] |
 | **social_media_id** | **String** |  | [optional] |
 | **social_media_hub** | **String** |  | [optional] |
 | **social_user_name** | **String** |  | [optional] |

data/docs/TestExecutionOperationResult.md

@@ -0,0 +1,17 @@
+---
+title: TestExecutionOperationResult
+---
+## PureCloud::TestExecutionOperationResult
+
+## Properties
+
+|Name | Type | Description | Notes|
+|------------ | ------------- | ------------- | -------------|
+| **step** | **Integer** | The step number to indicate the order in which the operation was performed | [optional] |
+| **name** | **String** | Name of the operation performed | [optional] |
+| **success** | **BOOLEAN** | Indicated whether or not the operation was successful | [optional] |
+| **result** | **Object** | The result of the operation | [optional] |
+| **error** | [**ErrorBody**](ErrorBody.html) | Error that occurred during the operation | [optional] |
+{: class="table table-striped"}
+
+

data/docs/TestExecutionResult.md

@@ -0,0 +1,16 @@
+---
+title: TestExecutionResult
+---
+## PureCloud::TestExecutionResult
+
+## Properties
+
+|Name | Type | Description | Notes|
+|------------ | ------------- | ------------- | -------------|
+| **operations** | [**Array<TestExecutionOperationResult>**](TestExecutionOperationResult.html) | Execution operations performed as part of the test | [optional] |
+| **error** | [**ErrorBody**](ErrorBody.html) | The final error encountered during the test that resulted in test failure | [optional] |
+| **final_result** | **Object** | The final result of the test. This is the response that would be returned during normal action execution | [optional] |
+| **success** | **BOOLEAN** | Indicates whether or not the test was a success | [optional] |
+{: class="table table-striped"}
+
+

data/docs/UpdateActionInput.md

@@ -0,0 +1,16 @@
+---
+title: UpdateActionInput
+---
+## PureCloud::UpdateActionInput
+
+## Properties
+
+|Name | Type | Description | Notes|
+|------------ | ------------- | ------------- | -------------|
+| **category** | **String** | Category of action | [optional] |
+| **name** | **String** | Name of action | [optional] |
+| **config** | [**ActionConfig**](ActionConfig.html) | Configuration to support request and response processing | [optional] |
+| **version** | **Integer** | Version of this action | |
+{: class="table table-striped"}
+
+