purecloudplatformclientv2 19.0.0 → 20.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 343fce23a939e6ce27938a41cc404ce1a9ac8449
-  data.tar.gz: 5c7d300f2fe3ef57162c40850a71f89f84f0985e
+  metadata.gz: 98380b8edea068546ab07b9662d09bffa4ee1dc6
+  data.tar.gz: 33b8addd525713dd7d60865731a83322bda1b85a
 SHA512:
-  metadata.gz: 830dc310922eac84dd7e6a438a0192985e1f99c23a810632138746306829c1b491eb325558f1977106009c9a933925372148a7d0dd84cc0f526d5e7c0e899f8b
-  data.tar.gz: 788acebb305b8c07f860b22acb1860f4b24c6da217fffb92a3a90257bb0434ae04c8ef00ccd9f7fc06d4b1887b47d3cb3aaafe61dd45ee8ac42622a7c0b87874
+  metadata.gz: d35dc98a16b3eb8501ab777a3d5faa724c6e111ab2a9e72431cc0d36d2d70b089825d22cd6682dcf8f886663df7bb83ccb1e34aaa9544adbd994fe90a6427e10
+  data.tar.gz: bc12d5b80f67d1c62e7c72482d5ee18585414305645786142bc013ba9d3e5060674e79d93ae0d54c94e98dff5f26c15bf5b098658db1a16776cfd1269f7a9042

data/README.md

@@ -1,7 +1,7 @@
 ---
 title: PureCloud Ruby Gem
 ---
-![](http://ruby-gem-downloads-badge.herokuapp.com/purecloudplatformclientv2?label=19.0.0)
+![](http://ruby-gem-downloads-badge.herokuapp.com/purecloudplatformclientv2?label=20.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
 
 ~~~ ruby
-gem install 'purecloudplatformclientv2', '~> 19.0.0'
+gem install 'purecloudplatformclientv2', '~> 20.0.0'
 ~~~
 
 ### Install from Git

data/docs/ActionEntityListing.md

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

data/docs/AgentActivityEntityListing.md

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

data/docs/AnalyticsSession.md

@@ -11,6 +11,8 @@ title: AnalyticsSession
 | **session_id** | **String** | The unique identifier of this session | [optional] |
 | **address_other** | **String** |  | [optional] |
 | **address_self** | **String** |  | [optional] |
+| **address_from** | **String** |  | [optional] |
+| **address_to** | **String** |  | [optional] |
 | **ani** | **String** | Automatic Number Identification (caller's number) | [optional] |
 | **direction** | **String** | Direction | [optional] |
 | **dnis** | **String** | Automatic Number Identification (caller's number) | [optional] |
@@ -28,6 +30,7 @@ title: AnalyticsSession
 | **callback_numbers** | **Array<String>** | List of numbers to callback | [optional] |
 | **callback_scheduled_time** | **DateTime** | Scheduled callback date/time. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
 | **script_id** | **String** | Scheduled callback date/time, Date time is represented as an ISO-8601 string.  | [optional] |
+| **peer_id** | **String** | A unique identifier for a peer | [optional] |
 | **skip_enabled** | **BOOLEAN** | (Dialer) Whether the agent can skip the dialer contact | [optional] |
 | **timeout_seconds** | **Integer** | The number of seconds before PureCloud begins the call for a call back. 0 disables automatic calling | [optional] |
 | **cobrowse_role** | **String** | Describe side of the cobrowse (sharer or viewer) | [optional] |

data/docs/ArchitectApi.md

@@ -29,6 +29,7 @@ Method | Description
 [**get_architect_ivr**](ArchitectApi.html#get_architect_ivr) | Get an IVR config.
 [**get_architect_ivrs**](ArchitectApi.html#get_architect_ivrs) | Get IVR configs.
 [**get_architect_prompt**](ArchitectApi.html#get_architect_prompt) | Get specified user prompt
+[**get_architect_prompt_history_history_id**](ArchitectApi.html#get_architect_prompt_history_history_id) | Get generated prompt history
 [**get_architect_prompt_resource**](ArchitectApi.html#get_architect_prompt_resource) | Get specified user prompt resource
 [**get_architect_prompt_resources**](ArchitectApi.html#get_architect_prompt_resources) | Get a pageable list of user prompt resources
 [**get_architect_prompts**](ArchitectApi.html#get_architect_prompts) | Get a pageable list of user prompts
@@ -37,6 +38,7 @@ Method | Description
 [**get_architect_schedulegroups**](ArchitectApi.html#get_architect_schedulegroups) | Get a list of schedule groups.
 [**get_architect_schedules**](ArchitectApi.html#get_architect_schedules) | Get a list of schedules.
 [**get_architect_systemprompt**](ArchitectApi.html#get_architect_systemprompt) | Get a system prompt
+[**get_architect_systemprompt_history_history_id**](ArchitectApi.html#get_architect_systemprompt_history_history_id) | Get generated prompt history
 [**get_architect_systemprompt_resource**](ArchitectApi.html#get_architect_systemprompt_resource) | Get a system prompt resource.
 [**get_architect_systemprompt_resources**](ArchitectApi.html#get_architect_systemprompt_resources) | Get system prompt resources.
 [**get_architect_systemprompts**](ArchitectApi.html#get_architect_systemprompts) | Get System Prompts
@@ -49,10 +51,12 @@ Method | Description
 [**get_flows**](ArchitectApi.html#get_flows) | Get a pageable list of flows, filtered by query parameters
 [**post_architect_dependencytracking_build**](ArchitectApi.html#post_architect_dependencytracking_build) | Rebuild Dependency Tracking data for an organization
 [**post_architect_ivrs**](ArchitectApi.html#post_architect_ivrs) | Create IVR config.
+[**post_architect_prompt_history**](ArchitectApi.html#post_architect_prompt_history) | Generate prompt history
 [**post_architect_prompt_resources**](ArchitectApi.html#post_architect_prompt_resources) | Create a new user prompt resource
 [**post_architect_prompts**](ArchitectApi.html#post_architect_prompts) | Create a new user prompt
 [**post_architect_schedulegroups**](ArchitectApi.html#post_architect_schedulegroups) | Creates a new schedule group
 [**post_architect_schedules**](ArchitectApi.html#post_architect_schedules) | Create a new schedule.
+[**post_architect_systemprompt_history**](ArchitectApi.html#post_architect_systemprompt_history) | Generate system prompt history
 [**post_architect_systemprompt_resources**](ArchitectApi.html#post_architect_systemprompt_resources) | Create system prompt resource override.
 [**post_flow_versions**](ArchitectApi.html#post_flow_versions) | Create flow version
 [**post_flows**](ArchitectApi.html#post_flows) | Create flow
@@ -1390,6 +1394,80 @@ Name | Type | Description  | Notes
 
 
 
+<a name="get_architect_prompt_history_history_id"></a>
+
+## -[**HistoryListing**](HistoryListing.html) get_architect_prompt_history_history_id(prompt_id, history_id, opts)
+
+Get generated prompt history
+
+
+
+Wraps GET /api/v2/architect/prompts/{promptId}/history/{historyId} 
+
+
+### 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::ArchitectApi.new
+
+prompt_id = "prompt_id_example" # String | Prompt ID
+
+history_id = "history_id_example" # String | History request ID
+
+opts = { 
+  page_number: 1, # Integer | Page number
+  page_size: 25, # Integer | Page size
+  sort_order: "desc", # String | Sort order
+  sort_by: "timestamp", # String | Sort by
+  action: ["action_example"] # Array<String> | Flow actions to include (omit to include all)
+}
+
+begin
+  #Get generated prompt history
+  result = api_instance.get_architect_prompt_history_history_id(prompt_id, history_id, opts)
+  p result
+rescue PureCloud::ApiError => e
+  puts "Exception when calling ArchitectApi->get_architect_prompt_history_history_id: #{e}"
+end
+~~~
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **prompt_id** | **String**| Prompt ID |  |
+ **history_id** | **String**| History request ID |  |
+ **page_number** | **Integer**| Page number | [optional] [default to 1] |
+ **page_size** | **Integer**| Page size | [optional] [default to 25] |
+ **sort_order** | **String**| Sort order | [optional] [default to desc] |
+ **sort_by** | **String**| Sort by | [optional] [default to timestamp]<br />**Values**: action, timestamp, user |
+ **action** | [**Array&lt;String&gt;**](String.html)| Flow actions to include (omit to include all) | [optional] <br />**Values**: checkin, checkout, create, deactivate, debug, delete, publish, revert, save |
+{: class="table table-striped"}
+
+
+### Return type
+
+[**HistoryListing**](HistoryListing.html)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
 <a name="get_architect_prompt_resource"></a>
 
 ## -[**PromptAsset**](PromptAsset.html) get_architect_prompt_resource(prompt_id, language_code)
@@ -1898,6 +1976,80 @@ Name | Type | Description  | Notes
 
 
 
+<a name="get_architect_systemprompt_history_history_id"></a>
+
+## -[**HistoryListing**](HistoryListing.html) get_architect_systemprompt_history_history_id(prompt_id, history_id, opts)
+
+Get generated prompt history
+
+
+
+Wraps GET /api/v2/architect/systemprompts/{promptId}/history/{historyId} 
+
+
+### 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::ArchitectApi.new
+
+prompt_id = "prompt_id_example" # String | promptId
+
+history_id = "history_id_example" # String | History request ID
+
+opts = { 
+  page_number: 1, # Integer | Page number
+  page_size: 25, # Integer | Page size
+  sort_order: "desc", # String | Sort order
+  sort_by: "timestamp", # String | Sort by
+  action: ["action_example"] # Array<String> | Flow actions to include (omit to include all)
+}
+
+begin
+  #Get generated prompt history
+  result = api_instance.get_architect_systemprompt_history_history_id(prompt_id, history_id, opts)
+  p result
+rescue PureCloud::ApiError => e
+  puts "Exception when calling ArchitectApi->get_architect_systemprompt_history_history_id: #{e}"
+end
+~~~
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **prompt_id** | **String**| promptId |  |
+ **history_id** | **String**| History request ID |  |
+ **page_number** | **Integer**| Page number | [optional] [default to 1] |
+ **page_size** | **Integer**| Page size | [optional] [default to 25] |
+ **sort_order** | **String**| Sort order | [optional] [default to desc] |
+ **sort_by** | **String**| Sort by | [optional] [default to timestamp]<br />**Values**: action, timestamp, user |
+ **action** | [**Array&lt;String&gt;**](String.html)| Flow actions to include (omit to include all) | [optional] <br />**Values**: checkin, checkout, create, deactivate, debug, delete, publish, revert, save |
+{: class="table table-striped"}
+
+
+### Return type
+
+[**HistoryListing**](HistoryListing.html)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
 <a name="get_architect_systemprompt_resource"></a>
 
 ## -[**SystemPromptAsset**](SystemPromptAsset.html) get_architect_systemprompt_resource(prompt_id, language_code)
@@ -2194,7 +2346,7 @@ api_instance = PureCloud::ArchitectApi.new
 
 flow_id = "flow_id_example" # String | Flow ID
 
-history_id = "history_id_example" # String | History ID (generated history)
+history_id = "history_id_example" # String | History request ID
 
 opts = { 
   page_number: 1, # Integer | Page number
@@ -2218,7 +2370,7 @@ end
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
  **flow_id** | **String**| Flow ID |  |
- **history_id** | **String**| History ID (generated history) |  |
+ **history_id** | **String**| History request ID |  |
  **page_number** | **Integer**| Page number | [optional] [default to 1] |
  **page_size** | **Integer**| Page size | [optional] [default to 25] |
  **sort_order** | **String**| Sort order | [optional] [default to desc] |
@@ -2705,6 +2857,65 @@ Name | Type | Description  | Notes
 
 
 
+<a name="post_architect_prompt_history"></a>
+
+## -[**Operation**](Operation.html) post_architect_prompt_history(prompt_id)
+
+Generate prompt history
+
+Asynchronous.  Notification topic: v2.architect.prompts.{promptId}
+
+Wraps POST /api/v2/architect/prompts/{promptId}/history 
+
+
+### 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::ArchitectApi.new
+
+prompt_id = "prompt_id_example" # String | Prompt ID
+
+
+begin
+  #Generate prompt history
+  result = api_instance.post_architect_prompt_history(prompt_id)
+  p result
+rescue PureCloud::ApiError => e
+  puts "Exception when calling ArchitectApi->post_architect_prompt_history: #{e}"
+end
+~~~
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **prompt_id** | **String**| Prompt ID |  |
+{: class="table table-striped"}
+
+
+### Return type
+
+[**Operation**](Operation.html)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
 <a name="post_architect_prompt_resources"></a>
 
 ## -[**PromptAsset**](PromptAsset.html) post_architect_prompt_resources(prompt_id, opts)
@@ -2948,6 +3159,65 @@ Name | Type | Description  | Notes
 
 
 
+<a name="post_architect_systemprompt_history"></a>
+
+## -[**Operation**](Operation.html) post_architect_systemprompt_history(prompt_id)
+
+Generate system prompt history
+
+Asynchronous.  Notification topic: v2.architect.systemprompts.{systemPromptId}
+
+Wraps POST /api/v2/architect/systemprompts/{promptId}/history 
+
+
+### 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::ArchitectApi.new
+
+prompt_id = "prompt_id_example" # String | promptId
+
+
+begin
+  #Generate system prompt history
+  result = api_instance.post_architect_systemprompt_history(prompt_id)
+  p result
+rescue PureCloud::ApiError => e
+  puts "Exception when calling ArchitectApi->post_architect_systemprompt_history: #{e}"
+end
+~~~
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **prompt_id** | **String**| promptId |  |
+{: class="table table-striped"}
+
+
+### Return type
+
+[**Operation**](Operation.html)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
 <a name="post_architect_systemprompt_resources"></a>
 
 ## -[**SystemPromptAsset**](SystemPromptAsset.html) post_architect_systemprompt_resources(prompt_id, opts)

data/docs/AttemptLimitsEntityListing.md

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

data/docs/AttributeEntityListing.md

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

data/docs/CalibrationEntityListing.md

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

data/docs/CallConversationEntityListing.md

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