purecloudplatformclientv2 52.0.0 → 53.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 52514f5c1b499a5f3857f8697fdd87fc2c44066a
-  data.tar.gz: f3c26d26d2edcf1fedf36789c99da62ee30f8269
+  metadata.gz: 5eb559e9eb2a901b45bed1a4769b7b7e0882d01d
+  data.tar.gz: a2666189774e5e36ae90baced82bd7eeb16b758e
 SHA512:
-  metadata.gz: 1566540eac5e7f52b496d52737b444cf1188d093170d8b447f3ffb50832b69a82a9dfa661177b92970e5d47093abd29c0e627017b552d90848a15cfc2e1a86c6
-  data.tar.gz: 65df12f9105471c730f071b08baa8cd750cc97599f77e743acf25e57992a39d42af6853003d219712881850da9cbb1fc81e6139d176ab6e791357ea28599de2c
+  metadata.gz: e219dfa7a6c7c59bdc59e4bcbbb89f453163c2ab1890355db97dd3513eec33def3655d279814d0021075be8e07e336fbfa4fa1d628fde8204b2ebd56c8d6b2ba
+  data.tar.gz: 193cff9ba709b21e3600f16fa998f257fac23d4c0a1d76e9dc7c4f8d72ec9bc3dde3282d763e1ff4e5b4c0cb074e1a8109c33df83c3b4b63a7045e59d6c210bb

data/README.md

@@ -1,7 +1,7 @@
 ---
 title: PureCloud Ruby Gem
 ---
-![](http://ruby-gem-downloads-badge.herokuapp.com/purecloudplatformclientv2?label=52.0.0)
+![](http://ruby-gem-downloads-badge.herokuapp.com/purecloudplatformclientv2?label=53.0.0)
 
 Documentation can be found at [https://developer.mypurecloud.com/api/rest/client-libraries/ruby/](https://developer.mypurecloud.com/api/rest/client-libraries/ruby/)
 
@@ -10,7 +10,7 @@ Documentation can be found at [https://developer.mypurecloud.com/api/rest/client
 ### from rubygems.org
 
 ```{"language":"ruby"}
-gem install 'purecloudplatformclientv2', '~> 52.0.0'
+gem install 'purecloudplatformclientv2', '~> 53.0.0'
 ```
 
 ### Install from Git

data/docs/ActionEntityListing.md

@@ -13,9 +13,9 @@ title: ActionEntityListing
 | **total** | **Integer** |  | [optional] |
 | **first_uri** | **String** |  | [optional] |
 | **self_uri** | **String** |  | [optional] |
-| **next_uri** | **String** |  | [optional] |
-| **previous_uri** | **String** |  | [optional] |
 | **last_uri** | **String** |  | [optional] |
+| **previous_uri** | **String** |  | [optional] |
+| **next_uri** | **String** |  | [optional] |
 | **page_count** | **Integer** |  | [optional] |
 {: class="table table-striped"}
 

data/docs/ActionMap.md

@@ -0,0 +1,30 @@
+---
+title: ActionMap
+---
+## PureCloud::ActionMap
+
+## Properties
+
+|Name | Type | Description | Notes|
+|------------ | ------------- | ------------- | -------------|
+| **id** | **String** | The globally unique identifier for the object. | [optional] |
+| **name** | **String** |  | [optional] |
+| **version** | **Integer** | The version of the action map. | [optional] |
+| **is_active** | **BOOLEAN** | Whether the action map is active. | [optional] |
+| **display_name** | **String** | Display name of the action map. | |
+| **trigger_with_segments** | **Array<String>** | Trigger action map if any segment in the list is assigned to a given customer. | |
+| **trigger_with_event_conditions** | [**Array<EventCondition>**](EventCondition.html) | List of event conditions that must be satisfied to trigger the action map. | [optional] |
+| **trigger_with_outcome_probability_conditions** | [**Array<OutcomeProbabilityCondition>**](OutcomeProbabilityCondition.html) | Probability conditions for outcomes that must be satisfied to trigger the action map. | [optional] |
+| **page_url_conditions** | [**Array<UrlCondition>**](UrlCondition.html) | URL conditions that a page must match for web actions to be displayable. | |
+| **activation** | [**Activation**](Activation.html) | Type of activation. | [optional] |
+| **weight** | **Integer** | Weight of the action map with higher number denoting higher weight. | [optional] |
+| **action** | [**ActionMapAction**](ActionMapAction.html) | The action that will be executed if this action map is triggered. | [optional] |
+| **estimated_wait_time_limit** | **Integer** | The estimated wait time limit above which actions will not be offered. | [optional] |
+| **self_uri** | **String** | The URI for this object | [optional] |
+| **created_date** | **DateTime** | Timestamp indicating when the action map was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
+| **modified_date** | **DateTime** | Timestamp indicating when the action map was last updated. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
+| **start_date** | **DateTime** | Timestamp at which the action map is scheduled to start firing. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
+| **end_date** | **DateTime** | Timestamp at which the action map is scheduled to stop firing. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
+{: class="table table-striped"}
+
+

data/docs/ActionMapAction.md

@@ -0,0 +1,16 @@
+---
+title: ActionMapAction
+---
+## PureCloud::ActionMapAction
+
+## Properties
+
+|Name | Type | Description | Notes|
+|------------ | ------------- | ------------- | -------------|
+| **media_type** | **String** | Media type of action. | |
+| **action_target_id** | **String** | Action target ID. | [optional] |
+| **is_pacing_enabled** | **BOOLEAN** | Whether this action should be throttled. | [optional] |
+| **props** | [**ActionProperties**](ActionProperties.html) | Additional properties. | [optional] |
+{: class="table table-striped"}
+
+

data/docs/ActionProperties.md

@@ -0,0 +1,14 @@
+---
+title: ActionProperties
+---
+## PureCloud::ActionProperties
+
+## Properties
+
+|Name | Type | Description | Notes|
+|------------ | ------------- | ------------- | -------------|
+| **webchat_prompt** | **String** | Prompt message shown to user, used for webchat type action. | [optional] |
+| **webchat_survey** | [**ActionSurvey**](ActionSurvey.html) | Survey provided to the user, used for webchat type action. | [optional] |
+{: class="table table-striped"}
+
+

data/docs/ActionSurvey.md

@@ -0,0 +1,13 @@
+---
+title: ActionSurvey
+---
+## PureCloud::ActionSurvey
+
+## Properties
+
+|Name | Type | Description | Notes|
+|------------ | ------------- | ------------- | -------------|
+| **questions** | [**Array<JourneySurveyQuestion>**](JourneySurveyQuestion.html) | Questions shown to the user. | |
+{: class="table table-striped"}
+
+

data/docs/ActionTarget.md

@@ -0,0 +1,15 @@
+---
+title: ActionTarget
+---
+## PureCloud::ActionTarget
+
+## Properties
+
+|Name | Type | Description | Notes|
+|------------ | ------------- | ------------- | -------------|
+| **id** | **String** | The globally unique identifier for the object. | [optional] |
+| **name** | **String** |  | [optional] |
+| **self_uri** | **String** | The URI for this object | [optional] |
+{: class="table table-striped"}
+
+

data/docs/Activation.md

@@ -0,0 +1,14 @@
+---
+title: Activation
+---
+## PureCloud::Activation
+
+## Properties
+
+|Name | Type | Description | Notes|
+|------------ | ------------- | ------------- | -------------|
+| **type** | **String** | Type of activation. | |
+| **delay_in_seconds** | **Integer** | Activation delay time amount. | [optional] |
+{: class="table table-striped"}
+
+

data/docs/AddShiftTradeRequest.md

@@ -0,0 +1,17 @@
+---
+title: AddShiftTradeRequest
+---
+## PureCloud::AddShiftTradeRequest
+
+## Properties
+
+|Name | Type | Description | Notes|
+|------------ | ------------- | ------------- | -------------|
+| **schedule_id** | **String** | The ID of the schedule to which the initiating and receiving shifts belong | |
+| **initiating_shift_id** | **String** | The ID of the shift that the initiating user wants to give up | |
+| **receiving_user_id** | **String** | The ID of the user to whom to send the request (for use in direct trade requests) | [optional] |
+| **expiration** | **DateTime** | When this shift trade request should expire. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
+| **acceptable_intervals** | [**Array<ShiftTradeResponseAcceptableIntervals>**](ShiftTradeResponseAcceptableIntervals.html) |  | [optional] |
+{: class="table table-striped"}
+
+

data/docs/AgentActivityEntityListing.md

@@ -13,9 +13,9 @@ title: AgentActivityEntityListing
 | **total** | **Integer** |  | [optional] |
 | **first_uri** | **String** |  | [optional] |
 | **self_uri** | **String** |  | [optional] |
-| **next_uri** | **String** |  | [optional] |
-| **previous_uri** | **String** |  | [optional] |
 | **last_uri** | **String** |  | [optional] |
+| **previous_uri** | **String** |  | [optional] |
+| **next_uri** | **String** |  | [optional] |
 | **page_count** | **Integer** |  | [optional] |
 {: class="table table-striped"}
 

data/docs/AnalyticsApi.md

@@ -167,7 +167,7 @@ Name | Type | Description  | Notes
 
 <a name="get_analytics_conversations_details"></a>
 
-## [**AnalyticsConversation**](AnalyticsConversation.html) get_analytics_conversations_details(opts)
+## [**AnalyticsConversationMultiGetResponse**](AnalyticsConversationMultiGetResponse.html) get_analytics_conversations_details(opts)
 
 
 
@@ -222,7 +222,7 @@ Name | Type | Description  | Notes
 
 ### Return type
 
-[**AnalyticsConversation**](AnalyticsConversation.html)
+[**AnalyticsConversationMultiGetResponse**](AnalyticsConversationMultiGetResponse.html)
 
 ### HTTP request headers
 

data/docs/AnalyticsConversationMultiGetResponse.md

@@ -0,0 +1,13 @@
+---
+title: AnalyticsConversationMultiGetResponse
+---
+## PureCloud::AnalyticsConversationMultiGetResponse
+
+## Properties
+
+|Name | Type | Description | Notes|
+|------------ | ------------- | ------------- | -------------|
+| **conversations** | [**Array<AnalyticsConversation>**](AnalyticsConversation.html) |  | [optional] |
+{: class="table table-striped"}
+
+

data/docs/AnalyticsEvaluation.md

@@ -16,8 +16,8 @@ title: AnalyticsEvaluation
 | **context_id** | **String** | A unique identifier for an evaluation form, regardless of version | [optional] |
 | **form_name** | **String** | Name of the evaluation form | [optional] |
 | **calibration_id** | **String** | The calibration id used for the purpose of training evaluators | [optional] |
-| **o_total_critical_score** | **Integer** |  | [optional] |
 | **o_total_score** | **Integer** |  | [optional] |
+| **o_total_critical_score** | **Integer** |  | [optional] |
 {: class="table table-striped"}
 
 

data/docs/AnalyticsSession.md

@@ -55,6 +55,7 @@ title: AnalyticsSession
 | **journey_action_id** | **String** | Journey action ID | [optional] |
 | **journey_action_map_id** | **String** | Journey action map ID | [optional] |
 | **journey_action_map_version** | **String** | Journey action map version | [optional] |
+| **protocol_call_id** | **String** | The original voice protocol call ID, e.g. a SIP call ID | [optional] |
 {: class="table table-striped"}
 
 

data/docs/ArchitectApi.md

@@ -12,6 +12,7 @@ Method | Description
 [**delete_architect_ivr**](ArchitectApi.html#delete_architect_ivr) | Delete an IVR Config.
 [**delete_architect_prompt**](ArchitectApi.html#delete_architect_prompt) | Delete specified user prompt
 [**delete_architect_prompt_resource**](ArchitectApi.html#delete_architect_prompt_resource) | Delete specified user prompt resource
+[**delete_architect_prompt_resource_audio**](ArchitectApi.html#delete_architect_prompt_resource_audio) | Delete specified user prompt resource audio
 [**delete_architect_prompts**](ArchitectApi.html#delete_architect_prompts) | Batch-delete a list of prompts
 [**delete_architect_schedule**](ArchitectApi.html#delete_architect_schedule) | Delete a schedule by id
 [**delete_architect_schedulegroup**](ArchitectApi.html#delete_architect_schedulegroup) | Deletes a schedule group by ID
@@ -56,7 +57,7 @@ Method | Description
 [**get_flows**](ArchitectApi.html#get_flows) | Get a pageable list of flows, filtered by query parameters
 [**get_flows_datatable**](ArchitectApi.html#get_flows_datatable) | Returns a specific datatable by id
 [**get_flows_datatable_row**](ArchitectApi.html#get_flows_datatable_row) | Returns a specific row for the datatable
-[**get_flows_datatable_rows**](ArchitectApi.html#get_flows_datatable_rows) | Returns the rows for the datatable
+[**get_flows_datatable_rows**](ArchitectApi.html#get_flows_datatable_rows) | Returns the rows for the datatable with the given id
 [**get_flows_datatables**](ArchitectApi.html#get_flows_datatables) | Retrieve a list of datatables for the org
 [**get_flows_divisionviews**](ArchitectApi.html#get_flows_divisionviews) | Get a pageable list of basic flow information objects filterable by query parameters.
 [**post_architect_dependencytracking_build**](ArchitectApi.html#post_architect_dependencytracking_build) | Rebuild Dependency Tracking data for an organization
@@ -77,7 +78,7 @@ Method | Description
 [**post_flows_actions_publish**](ArchitectApi.html#post_flows_actions_publish) | Publish flow
 [**post_flows_actions_revert**](ArchitectApi.html#post_flows_actions_revert) | Revert flow
 [**post_flows_actions_unlock**](ArchitectApi.html#post_flows_actions_unlock) | Unlock flow
-[**post_flows_datatable_rows**](ArchitectApi.html#post_flows_datatable_rows) | Create a new row entry
+[**post_flows_datatable_rows**](ArchitectApi.html#post_flows_datatable_rows) | Create a new row entry for the datatable.
 [**post_flows_datatables**](ArchitectApi.html#post_flows_datatables) | Create a new datatable with the specified json-schema definition
 [**put_architect_emergencygroup**](ArchitectApi.html#put_architect_emergencygroup) | Updates a emergency group by ID
 [**put_architect_ivr**](ArchitectApi.html#put_architect_ivr) | Update an IVR Config.
@@ -354,6 +355,73 @@ nil (empty response body)
 
 
 
+<a name="delete_architect_prompt_resource_audio"></a>
+
+##  delete_architect_prompt_resource_audio(prompt_id, language_code)
+
+
+
+Delete specified user prompt resource audio
+
+
+
+Wraps DELETE /api/v2/architect/prompts/{promptId}/resources/{languageCode}/audio 
+
+Requires ANY permissions: 
+
+* architect:userPrompt:edit
+
+
+### Example
+```{"language":"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::ArchitectApi.new
+
+prompt_id = "prompt_id_example" # String | Prompt ID
+
+language_code = "language_code_example" # String | Language
+
+
+begin
+  #Delete specified user prompt resource audio
+  api_instance.delete_architect_prompt_resource_audio(prompt_id, language_code)
+rescue PureCloud::ApiError => e
+  puts "Exception when calling ArchitectApi->delete_architect_prompt_resource_audio: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **prompt_id** | **String**| Prompt ID |  |
+ **language_code** | **String**| Language |  |
+{: class="table table-striped"}
+
+
+### Return type
+
+nil (empty response body)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
 <a name="delete_architect_prompts"></a>
 
 ## [**Operation**](Operation.html) delete_architect_prompts(id)
@@ -751,7 +819,7 @@ Name | Type | Description  | Notes
 
 deletes a specific datatable by id
 
-deletes an entire datatable (including schema and data) with a given id)
+Deletes an entire datatable (including the schema and data) with a given datatableId
 
 Wraps DELETE /api/v2/flows/datatables/{datatableId} 
 
@@ -819,7 +887,7 @@ nil (empty response body)
 
 Delete a row entry
 
-Deletes a row with a given rowId.
+Deletes a row with a given rowId (the value of the key field).
 
 Wraps DELETE /api/v2/flows/datatables/{datatableId}/rows/{rowId} 
 
@@ -2130,7 +2198,7 @@ api_instance = PureCloud::ArchitectApi.new
 opts = { 
   page_number: 1, # Integer | Page number
   page_size: 25, # Integer | Page size
-  name: "name_example", # String | Name
+  name: ["name_example"], # Array<String> | Name
   description: "description_example", # String | Description
   name_or_description: "name_or_description_example", # String | Name or description
   sort_by: "id", # String | Sort by
@@ -2152,7 +2220,7 @@ Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
  **page_number** | **Integer**| Page number | [optional] [default to 1] |
  **page_size** | **Integer**| Page size | [optional] [default to 25] |
- **name** | **String**| Name | [optional]  |
+ **name** | [**Array&lt;String&gt;**](String.html)| Name | [optional]  |
  **description** | **String**| Description | [optional]  |
  **name_or_description** | **String**| Name or description | [optional]  |
  **sort_by** | **String**| Sort by | [optional] [default to id] |
@@ -3358,7 +3426,7 @@ Name | Type | Description  | Notes
 
 Returns a specific datatable by id
 
-Given a datableid returns the schema associated with it.
+Given a datatableId returns the datatable object and schema associated with it.
 
 Wraps GET /api/v2/flows/datatables/{datatableId} 
 
@@ -3427,7 +3495,7 @@ Name | Type | Description  | Notes
 
 Returns a specific row for the datatable
 
-Given a datatable id and a rowId (key)  will return the full row contents for that rowId.
+Given a datatableId and a rowId (the value of the key field) this will return the full row contents for that rowId.
 
 Wraps GET /api/v2/flows/datatables/{datatableId}/rows/{rowId} 
 
@@ -3497,9 +3565,9 @@ Name | Type | Description  | Notes
 
 
 
-Returns the rows for the datatable
+Returns the rows for the datatable with the given id
 
-Returns all of the rows for the datatable with the given id.  By default this will just be a shortened list returning the key for each row.  Set expand to all to return all of the row contents.
+Returns all of the rows for the datatable with the given datatableId.  By default this will just be a truncated list returning the key for each row. Set showBrief to false to return all of the row contents.
 
 Wraps GET /api/v2/flows/datatables/{datatableId}/rows 
 
@@ -3534,7 +3602,7 @@ opts = {
 }
 
 begin
-  #Returns the rows for the datatable
+  #Returns the rows for the datatable with the given id
   result = api_instance.get_flows_datatable_rows(datatable_id, opts)
   p result
 rescue PureCloud::ApiError => e
@@ -3572,7 +3640,7 @@ Name | Type | Description  | Notes
 
 Retrieve a list of datatables for the org
 
-Returns a metadata list of the datatables associated with this org, including ID, name and description.
+Returns a metadata list of the datatables associated with this org, including datatableId, name and description.
 
 Wraps GET /api/v2/flows/datatables 
 
@@ -4508,7 +4576,7 @@ Name | Type | Description  | Notes
 
 <a name="post_flows_actions_checkin"></a>
 
-## [**Flow**](Flow.html) post_flows_actions_checkin(flow)
+## [**Operation**](Operation.html) post_flows_actions_checkin(flow)
 
 
 
@@ -4563,7 +4631,7 @@ Name | Type | Description  | Notes
 
 ### Return type
 
-[**Flow**](Flow.html)
+[**Operation**](Operation.html)
 
 ### HTTP request headers
 
@@ -4908,9 +4976,9 @@ Name | Type | Description  | Notes
 
 
 
-Create a new row entry
+Create a new row entry for the datatable.
 
-Will add the passed in row entry to the datatable with the given id after verifying it against the schema.
+Will add the passed in row entry to the datatable with the given datatableId after verifying it against the schema.  The DataTableRow should be a json-ized' stream of key -> value pairs {      \"Field1\": \"XYZZY\",      \"Field2\": false,      \"KEY\": \"27272\"  }
 
 Wraps POST /api/v2/flows/datatables/{datatableId}/rows 
 
@@ -4942,7 +5010,7 @@ data_table_row = nil # Object |
 
 
 begin
-  #Create a new row entry
+  #Create a new row entry for the datatable.
   result = api_instance.post_flows_datatable_rows(datatable_id, data_table_row)
   p result
 rescue PureCloud::ApiError => e
@@ -4978,7 +5046,7 @@ Name | Type | Description  | Notes
 
 Create a new datatable with the specified json-schema definition
 
-This will create a new datatable with fields that match the property definitions in the JSON schema.  The name of the table from the title field of the json-schema.  See also http://json-schema.org/
+This will create a new datatable with fields that match the property definitions in the JSON schema.  The schema's title field will be overridden by the name field in the DataTable object.  See also http://json-schema.org/
 
 Wraps POST /api/v2/flows/datatables 
 
@@ -5593,7 +5661,7 @@ Name | Type | Description  | Notes
 
 Updates a specific datatable by id
 
-Updates a schema for a datatable with the given id - updates are additive only, no changes or removals of existing fields.
+Updates a schema for a datatable with the given datatableId -updates allow only new fields to be added in the schema, no changes or removals of existing fields.
 
 Wraps PUT /api/v2/flows/datatables/{datatableId} 
 
@@ -5664,7 +5732,7 @@ Name | Type | Description  | Notes
 
 Update a row entry
 
-Updates a row with the given to the new values.
+Updates a row with the given rowId (the value of the key field) to the new values.  The DataTableRow should be a json-ized' stream of key -> value pairs {     \"Field1\": \"XYZZY\",     \"Field2\": false,     \"KEY\": \"27272\" }
 
 Wraps PUT /api/v2/flows/datatables/{datatableId}/rows/{rowId}