purecloudplatformclientv2 30.0.0 → 30.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e553de448fcbb92f1ae2dd413e835fd14020ce0a
-  data.tar.gz: 13078b48250c1e148465b440b8f6dbce8109b0c7
+  metadata.gz: '05168040eba6b25e5235474e8bfbf81f0d386586'
+  data.tar.gz: a62c28dac8fc699fafbf65c5edec49dc2952b3db
 SHA512:
-  metadata.gz: 06a2ea34a877728bdc3f0ec5a02585456cf1355b10eaa3593d8c5f0d6ce352ddefee8109ac86f2b865299445d9df18c5541d1d12155a6f39a1d43c2594395865
-  data.tar.gz: 325f6047df2fc639edbb83afa29f7879ee9d82e5e17d1b13ce05bb12e44c53fc55ee94589674f2604f560d3239aacbb1067b9c93fff81e718b60d5ccc697afe9
+  metadata.gz: d095d608a6aea0f8b0b75335b37c3ca5d5177c56adf30e3c5276e045946f13e5278c0830a2288902386f7e1f29342972d70249db3a10a75bf556897244b49ab4
+  data.tar.gz: e573a5c538f13532d85e57268be24724b0f555581dfa6778002c973136af919a7c1d042b04c15f7b81d205efc70e0439b2495611f0e7fee17643595eae9b2fd0

data/README.md

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

data/docs/ConversationsApi.md

@@ -78,6 +78,7 @@ Method | Description
 [**post_analytics_conversation_details_properties**](ConversationsApi.html#post_analytics_conversation_details_properties) | Index conversation properties
 [**post_analytics_conversations_aggregates_query**](ConversationsApi.html#post_analytics_conversations_aggregates_query) | Query for conversation aggregates
 [**post_analytics_conversations_details_query**](ConversationsApi.html#post_analytics_conversations_details_query) | Query for conversation details
+[**post_conversation_disconnect**](ConversationsApi.html#post_conversation_disconnect) | Performs a full conversation teardown. Issues disconnect requests for any connected media. Applies a system wrap-up code to any participants that are pending wrap-up. This is not intended to be the normal way of ending interactions but is available in the event of problems with the application to allow a resyncronization of state across all components. It is recommended that users submit a support case if they are relying on this endpoint systematically as there is likely something that needs investigation.
 [**post_conversation_participant_callbacks**](ConversationsApi.html#post_conversation_participant_callbacks) | Create a new callback for the specified participant on the conversation.
 [**post_conversation_participant_digits**](ConversationsApi.html#post_conversation_participant_digits) | Sends DTMF to the participant
 [**post_conversation_participant_replace**](ConversationsApi.html#post_conversation_participant_replace) | Replace this participant with the specified user and/or address
@@ -4450,6 +4451,65 @@ Name | Type | Description  | Notes
 
 
 
+<a name="post_conversation_disconnect"></a>
+
+## -String** post_conversation_disconnect(conversation_id)
+
+Performs a full conversation teardown. Issues disconnect requests for any connected media. Applies a system wrap-up code to any participants that are pending wrap-up. This is not intended to be the normal way of ending interactions but is available in the event of problems with the application to allow a resyncronization of state across all components. It is recommended that users submit a support case if they are relying on this endpoint systematically as there is likely something that needs investigation.
+
+
+
+Wraps POST /api/v2/conversations/{conversationId}/disconnect 
+
+
+### 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::ConversationsApi.new
+
+conversation_id = "conversation_id_example" # String | conversation ID
+
+
+begin
+  #Performs a full conversation teardown. Issues disconnect requests for any connected media. Applies a system wrap-up code to any participants that are pending wrap-up. This is not intended to be the normal way of ending interactions but is available in the event of problems with the application to allow a resyncronization of state across all components. It is recommended that users submit a support case if they are relying on this endpoint systematically as there is likely something that needs investigation.
+  result = api_instance.post_conversation_disconnect(conversation_id)
+  p result
+rescue PureCloud::ApiError => e
+  puts "Exception when calling ConversationsApi->post_conversation_disconnect: #{e}"
+end
+~~~
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **conversation_id** | **String**| conversation ID |  |
+{: class="table table-striped"}
+
+
+### Return type
+
+**String**
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
 <a name="post_conversation_participant_callbacks"></a>
 
 ## - post_conversation_participant_callbacks(conversation_id, participant_id, opts)

data/docs/CreateActivityCodeRequest.md

@@ -9,9 +9,9 @@ title: CreateActivityCodeRequest
 |------------ | ------------- | ------------- | -------------|
 | **name** | **String** | The name of the activity code | |
 | **category** | **String** | The activity code's category | |
-| **length_in_minutes** | **Integer** | The default length of the activity in minutes | |
-| **counts_as_paid_time** | **BOOLEAN** | Whether an agent is paid while performing this activity | |
-| **counts_as_work_time** | **BOOLEAN** | Indicates whether or not the activity should be counted as work time | |
+| **length_in_minutes** | **Integer** | The default length of the activity in minutes | [optional] |
+| **counts_as_paid_time** | **BOOLEAN** | Whether an agent is paid while performing this activity | [optional] |
+| **counts_as_work_time** | **BOOLEAN** | Indicates whether or not the activity should be counted as work time | [optional] |
 | **agent_time_off_selectable** | **BOOLEAN** | Whether an agent can select this activity code when creating or editing a time off request | [optional] |
 {: class="table table-striped"}
 

data/docs/JsonNode.md

@@ -12,11 +12,11 @@ title: JsonNode
 | **boolean** | **BOOLEAN** |  | [optional] |
 | **number** | **BOOLEAN** |  | [optional] |
 | **float** | **BOOLEAN** |  | [optional] |
-| **floating_point_number** | **BOOLEAN** |  | [optional] |
 | **container_node** | **BOOLEAN** |  | [optional] |
 | **missing_node** | **BOOLEAN** |  | [optional] |
 | **pojo** | **BOOLEAN** |  | [optional] |
 | **integral_number** | **BOOLEAN** |  | [optional] |
+| **floating_point_number** | **BOOLEAN** |  | [optional] |
 | **short** | **BOOLEAN** |  | [optional] |
 | **int** | **BOOLEAN** |  | [optional] |
 | **long** | **BOOLEAN** |  | [optional] |

data/docs/RoutingApi.md

@@ -17,6 +17,7 @@ Method | Description
 [**delete_routing_sms_phonenumber**](RoutingApi.html#delete_routing_sms_phonenumber) | Delete a phone number provisioned for SMS.
 [**delete_routing_utilization**](RoutingApi.html#delete_routing_utilization) | Delete utilization settings and revert to system defaults.
 [**delete_routing_wrapupcode**](RoutingApi.html#delete_routing_wrapupcode) | Delete wrap-up code
+[**delete_user_routinglanguage**](RoutingApi.html#delete_user_routinglanguage) | Remove routing language from user
 [**delete_user_routingskill**](RoutingApi.html#delete_user_routingskill) | Remove routing skill from user
 [**get_routing_email_domain**](RoutingApi.html#get_routing_email_domain) | Get domain
 [**get_routing_email_domain_route**](RoutingApi.html#get_routing_email_domain_route) | Get a route
@@ -40,9 +41,11 @@ Method | Description
 [**get_routing_utilization**](RoutingApi.html#get_routing_utilization) | Get the utilization settings.
 [**get_routing_wrapupcode**](RoutingApi.html#get_routing_wrapupcode) | Get details about this wrap-up code.
 [**get_routing_wrapupcodes**](RoutingApi.html#get_routing_wrapupcodes) | Get list of wrapup codes.
+[**get_user_routinglanguages**](RoutingApi.html#get_user_routinglanguages) | List routing language for user
 [**get_user_routingskills**](RoutingApi.html#get_user_routingskills) | List routing skills for user
 [**patch_routing_queue_user**](RoutingApi.html#patch_routing_queue_user) | Update the ring number of joined status for a User in a Queue
 [**patch_routing_queue_users**](RoutingApi.html#patch_routing_queue_users) | Join or unjoin a set of users for a queue
+[**patch_user_routinglanguage**](RoutingApi.html#patch_user_routinglanguage) | Update routing language proficiency or state.
 [**post_analytics_queues_observations_query**](RoutingApi.html#post_analytics_queues_observations_query) | Query for queue observations
 [**post_routing_email_domain_routes**](RoutingApi.html#post_routing_email_domain_routes) | Create a route
 [**post_routing_email_domains**](RoutingApi.html#post_routing_email_domains) | Create a domain
@@ -54,6 +57,7 @@ Method | Description
 [**post_routing_sms_addresses**](RoutingApi.html#post_routing_sms_addresses) | Provision an Address for SMS
 [**post_routing_sms_phonenumbers**](RoutingApi.html#post_routing_sms_phonenumbers) | Provision a phone number for SMS
 [**post_routing_wrapupcodes**](RoutingApi.html#post_routing_wrapupcodes) | Create a wrap-up code
+[**post_user_routinglanguages**](RoutingApi.html#post_user_routinglanguages) | Add routing language to user
 [**post_user_routingskills**](RoutingApi.html#post_user_routingskills) | Add routing skill to user
 [**put_routing_email_domain_route**](RoutingApi.html#put_routing_email_domain_route) | Update a route
 [**put_routing_message_recipient**](RoutingApi.html#put_routing_message_recipient) | Update a recipient
@@ -593,6 +597,67 @@ nil (empty response body)
 
 
 
+<a name="delete_user_routinglanguage"></a>
+
+## - delete_user_routinglanguage(user_id, language_id)
+
+Remove routing language from user
+
+
+
+Wraps DELETE /api/v2/users/{userId}/routinglanguages/{languageId} 
+
+
+### 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::RoutingApi.new
+
+user_id = "user_id_example" # String | User ID
+
+language_id = "language_id_example" # String | languageId
+
+
+begin
+  #Remove routing language from user
+  api_instance.delete_user_routinglanguage(user_id, language_id)
+rescue PureCloud::ApiError => e
+  puts "Exception when calling RoutingApi->delete_user_routinglanguage: #{e}"
+end
+~~~
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **user_id** | **String**| User ID |  |
+ **language_id** | **String**| languageId |  |
+{: class="table table-striped"}
+
+
+### Return type
+
+nil (empty response body)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
 <a name="delete_user_routingskill"></a>
 
 ## - delete_user_routingskill(user_id, skill_id)
@@ -2031,6 +2096,73 @@ Name | Type | Description  | Notes
 
 
 
+<a name="get_user_routinglanguages"></a>
+
+## -[**UserLanguageEntityListing**](UserLanguageEntityListing.html) get_user_routinglanguages(user_id, opts)
+
+List routing language for user
+
+
+
+Wraps GET /api/v2/users/{userId}/routinglanguages 
+
+
+### 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::RoutingApi.new
+
+user_id = "user_id_example" # String | User ID
+
+opts = { 
+  page_size: 25, # Integer | Page size
+  page_number: 1, # Integer | Page number
+  sort_order: "ASC" # String | Ascending or descending sort order
+}
+
+begin
+  #List routing language for user
+  result = api_instance.get_user_routinglanguages(user_id, opts)
+  p result
+rescue PureCloud::ApiError => e
+  puts "Exception when calling RoutingApi->get_user_routinglanguages: #{e}"
+end
+~~~
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **user_id** | **String**| User ID |  |
+ **page_size** | **Integer**| Page size | [optional] [default to 25] |
+ **page_number** | **Integer**| Page number | [optional] [default to 1] |
+ **sort_order** | **String**| Ascending or descending sort order | [optional] [default to ASC]<br />**Values**: ascending, descending |
+{: class="table table-striped"}
+
+
+### Return type
+
+[**UserLanguageEntityListing**](UserLanguageEntityListing.html)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
 <a name="get_user_routingskills"></a>
 
 ## -[**UserSkillEntityListing**](UserSkillEntityListing.html) get_user_routingskills(user_id, opts)
@@ -2225,6 +2357,71 @@ Name | Type | Description  | Notes
 
 
 
+<a name="patch_user_routinglanguage"></a>
+
+## -[**UserRoutingLanguage**](UserRoutingLanguage.html) patch_user_routinglanguage(user_id, language_id, body)
+
+Update routing language proficiency or state.
+
+
+
+Wraps PATCH /api/v2/users/{userId}/routinglanguages/{languageId} 
+
+
+### 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::RoutingApi.new
+
+user_id = "user_id_example" # String | User ID
+
+language_id = "language_id_example" # String | languageId
+
+body = PureCloud::UserRoutingLanguage.new # UserRoutingLanguage | Language
+
+
+begin
+  #Update routing language proficiency or state.
+  result = api_instance.patch_user_routinglanguage(user_id, language_id, body)
+  p result
+rescue PureCloud::ApiError => e
+  puts "Exception when calling RoutingApi->patch_user_routinglanguage: #{e}"
+end
+~~~
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **user_id** | **String**| User ID |  |
+ **language_id** | **String**| languageId |  |
+ **body** | [**UserRoutingLanguage**](UserRoutingLanguage.html)| Language |  |
+{: class="table table-striped"}
+
+
+### Return type
+
+[**UserRoutingLanguage**](UserRoutingLanguage.html)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
 <a name="post_analytics_queues_observations_query"></a>
 
 ## -[**QualifierMappingObservationQueryResponse**](QualifierMappingObservationQueryResponse.html) post_analytics_queues_observations_query(body)
@@ -2887,6 +3084,68 @@ Name | Type | Description  | Notes
 
 
 
+<a name="post_user_routinglanguages"></a>
+
+## -[**UserRoutingLanguage**](UserRoutingLanguage.html) post_user_routinglanguages(user_id, body)
+
+Add routing language to user
+
+
+
+Wraps POST /api/v2/users/{userId}/routinglanguages 
+
+
+### 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::RoutingApi.new
+
+user_id = "user_id_example" # String | User ID
+
+body = PureCloud::UserRoutingLanguagePost.new # UserRoutingLanguagePost | Language
+
+
+begin
+  #Add routing language to user
+  result = api_instance.post_user_routinglanguages(user_id, body)
+  p result
+rescue PureCloud::ApiError => e
+  puts "Exception when calling RoutingApi->post_user_routinglanguages: #{e}"
+end
+~~~
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **user_id** | **String**| User ID |  |
+ **body** | [**UserRoutingLanguagePost**](UserRoutingLanguagePost.html)| Language |  |
+{: class="table table-striped"}
+
+
+### Return type
+
+[**UserRoutingLanguage**](UserRoutingLanguage.html)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
 <a name="post_user_routingskills"></a>
 
 ## -[**UserRoutingSkill**](UserRoutingSkill.html) post_user_routingskills(user_id, body)

data/docs/UserLanguageEntityListing.md

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