purecloudplatformclientv2 70.0.0 → 71.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: fdc176a95215b27f1975044c414dec3e4e4c5fd6
-  data.tar.gz: c8d3275a36a557cb45601cdea1c6445fcbbc3147
+  metadata.gz: 1862707a3f45de0a91a07d11e3a7f90539d204ec
+  data.tar.gz: 263189a8fc54b59e9c0944e11d33ae718ace917e
 SHA512:
-  metadata.gz: 834631ed8fbd4e0bd68f7fe440e6992fa99179dac99a30852be0ae63ab772ca1e8e62f99d672b667591a1c7e2f94ee8d967c2c3a4c97cfc614ff148636866938
-  data.tar.gz: 8966ea96a1e36270db28e0b0964f4e29a1f825bee12c689234f9684db378abf2dfe9828b2f5b61304b77927b9b16cd011010210c8eb4f32afdeb5db3b420e91d
+  metadata.gz: 4eb3307c7247082de5d2d1a66d4c817ba525b6276dbec07739fc3d44e108353f5143c3241fb6274065f74ee4393ec78d6f2eacc4d2062a66c610498bd39f7793
+  data.tar.gz: 9364e57a2200b6918a1eaa5904f8356c368fba9f1276d0fe02ed61f113dd2ae91a6d15787e41f10907f3aedbe93ff146e9547d653d895304c155a919398dd596

data/README.md

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

data/docs/AnalyticsSession.md

@@ -57,6 +57,7 @@ title: AnalyticsSession
 | **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] |
 | **provider** | **String** | The source provider for the communication | [optional] |
+| **remote** | **String** | Name, phone number, or email address of the remote party. | [optional] |
 {: class="table table-striped"}
 
 

data/docs/BuSearchAgentSchedulesRequest.md

@@ -0,0 +1,15 @@
+---
+title: BuSearchAgentSchedulesRequest
+---
+## PureCloud::BuSearchAgentSchedulesRequest
+
+## Properties
+
+|Name | Type | Description | Notes|
+|------------ | ------------- | ------------- | -------------|
+| **start_date** | **DateTime** | Start date of the range to search. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | |
+| **end_date** | **DateTime** | End date of the range to search. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | |
+| **user_ids** | **Array<String>** | IDs of the users for whose schedules to search | [optional] |
+{: class="table table-striped"}
+
+

data/docs/ConversationsApi.md

@@ -16,6 +16,7 @@ Method | Description
 [**delete_conversations_messaging_integrations_facebook_integration_id**](ConversationsApi.html#delete_conversations_messaging_integrations_facebook_integration_id) | Delete a Facebook messaging integration
 [**delete_conversations_messaging_integrations_line_integration_id**](ConversationsApi.html#delete_conversations_messaging_integrations_line_integration_id) | Delete a LINE messenger integration
 [**delete_conversations_messaging_integrations_twitter_integration_id**](ConversationsApi.html#delete_conversations_messaging_integrations_twitter_integration_id) | Delete a Twitter messaging integration
+[**delete_conversations_messaging_integrations_whatsapp_integration_id**](ConversationsApi.html#delete_conversations_messaging_integrations_whatsapp_integration_id) | Delete a WhatsApp messaging integration
 [**get_analytics_conversation_details**](ConversationsApi.html#get_analytics_conversation_details) | Get a conversation by id
 [**get_analytics_conversations_details**](ConversationsApi.html#get_analytics_conversations_details) | Gets multiple conversations by id
 [**get_analytics_conversations_details_job**](ConversationsApi.html#get_analytics_conversations_details_job) | Get status for async query for conversation details
@@ -129,9 +130,11 @@ Method | Description
 [**post_conversations_message_messages_bulk**](ConversationsApi.html#post_conversations_message_messages_bulk) | Get messages in batch
 [**post_conversations_message_participant_replace**](ConversationsApi.html#post_conversations_message_participant_replace) | Replace this participant with the specified user and/or address
 [**post_conversations_messages**](ConversationsApi.html#post_conversations_messages) | Create an outbound messaging conversation.
+[**post_conversations_messages_agentless**](ConversationsApi.html#post_conversations_messages_agentless) | Send an agentless outbound message
 [**post_conversations_messaging_integrations_facebook**](ConversationsApi.html#post_conversations_messaging_integrations_facebook) | Create a Facebook Integration
 [**post_conversations_messaging_integrations_line**](ConversationsApi.html#post_conversations_messaging_integrations_line) | Create a LINE messenger Integration
 [**post_conversations_messaging_integrations_twitter**](ConversationsApi.html#post_conversations_messaging_integrations_twitter) | Create a Twitter Integration
+[**post_conversations_messaging_integrations_whatsapp**](ConversationsApi.html#post_conversations_messaging_integrations_whatsapp) | Create a WhatsApp Integration
 [**put_conversation_participant_flaggedreason**](ConversationsApi.html#put_conversation_participant_flaggedreason) | Set flagged reason on conversation participant to indicate bad conversation quality.
 [**put_conversations_call_participant_communication_uuidata**](ConversationsApi.html#put_conversations_call_participant_communication_uuidata) | Set uuiData to be sent on future commands.
 [**put_conversations_email_messages_draft**](ConversationsApi.html#put_conversations_email_messages_draft) | Update conversation draft reply
@@ -661,6 +664,71 @@ nil (empty response body)
 
 
 
+<a name="delete_conversations_messaging_integrations_whatsapp_integration_id"></a>
+
+## [**WhatsAppIntegration**](WhatsAppIntegration.html) delete_conversations_messaging_integrations_whatsapp_integration_id(integration_id)
+
+
+
+Delete a WhatsApp messaging integration
+
+
+
+Wraps DELETE /api/v2/conversations/messaging/integrations/whatsapp/{integrationId} 
+
+Requires ANY permissions: 
+
+* messaging:integration:delete
+
+
+### 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::ConversationsApi.new
+
+integration_id = "integration_id_example" # String | Integration ID
+
+
+begin
+  #Delete a WhatsApp messaging integration
+  result = api_instance.delete_conversations_messaging_integrations_whatsapp_integration_id(integration_id)
+  p result
+rescue PureCloud::ApiError => e
+  puts "Exception when calling ConversationsApi->delete_conversations_messaging_integrations_whatsapp_integration_id: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **integration_id** | **String**| Integration ID |  |
+{: class="table table-striped"}
+
+
+### Return type
+
+[**WhatsAppIntegration**](WhatsAppIntegration.html)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
 <a name="get_analytics_conversation_details"></a>
 
 ## [**AnalyticsConversation**](AnalyticsConversation.html) get_analytics_conversation_details(conversation_id)
@@ -8283,6 +8351,71 @@ Name | Type | Description  | Notes
 
 
 
+<a name="post_conversations_messages_agentless"></a>
+
+## [**SendAgentlessOutboundMessageResponse**](SendAgentlessOutboundMessageResponse.html) post_conversations_messages_agentless(body)
+
+
+
+Send an agentless outbound message
+
+Send an agentlesss (api participant) outbound message using a client credential grant. In order to call this endpoint you will need OAuth token generated using OAuth client credentials authorized with at least messaging scope. This will generate a new Conversation, if there is an existing active Conversation between the fromAddress and toAddress already, then this POST will fail.
+
+Wraps POST /api/v2/conversations/messages/agentless 
+
+Requires ANY permissions: 
+
+* conversation:message:create
+
+
+### 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::ConversationsApi.new
+
+body = PureCloud::SendAgentlessOutboundMessageRequest.new # SendAgentlessOutboundMessageRequest | Create agentless outbound messaging request
+
+
+begin
+  #Send an agentless outbound message
+  result = api_instance.post_conversations_messages_agentless(body)
+  p result
+rescue PureCloud::ApiError => e
+  puts "Exception when calling ConversationsApi->post_conversations_messages_agentless: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **body** | [**SendAgentlessOutboundMessageRequest**](SendAgentlessOutboundMessageRequest.html)| Create agentless outbound messaging request |  |
+{: class="table table-striped"}
+
+
+### Return type
+
+[**SendAgentlessOutboundMessageResponse**](SendAgentlessOutboundMessageResponse.html)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
 <a name="post_conversations_messaging_integrations_facebook"></a>
 
 ## [**FacebookIntegration**](FacebookIntegration.html) post_conversations_messaging_integrations_facebook(body)
@@ -8478,6 +8611,71 @@ Name | Type | Description  | Notes
 
 
 
+<a name="post_conversations_messaging_integrations_whatsapp"></a>
+
+## [**WhatsAppIntegration**](WhatsAppIntegration.html) post_conversations_messaging_integrations_whatsapp(body)
+
+
+
+Create a WhatsApp Integration
+
+
+
+Wraps POST /api/v2/conversations/messaging/integrations/whatsapp 
+
+Requires ANY permissions: 
+
+* messaging:whatsappIntegration:add
+
+
+### 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::ConversationsApi.new
+
+body = PureCloud::WhatsAppIntegrationRequest.new # WhatsAppIntegrationRequest | WhatsAppIntegrationRequest
+
+
+begin
+  #Create a WhatsApp Integration
+  result = api_instance.post_conversations_messaging_integrations_whatsapp(body)
+  p result
+rescue PureCloud::ApiError => e
+  puts "Exception when calling ConversationsApi->post_conversations_messaging_integrations_whatsapp: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **body** | [**WhatsAppIntegrationRequest**](WhatsAppIntegrationRequest.html)| WhatsAppIntegrationRequest |  |
+{: class="table table-striped"}
+
+
+### Return type
+
+[**WhatsAppIntegration**](WhatsAppIntegration.html)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
 <a name="put_conversation_participant_flaggedreason"></a>
 
 ##  put_conversation_participant_flaggedreason(conversation_id, participant_id)

data/docs/ManagementUnitReference.md

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

data/docs/RoutingApi.md

@@ -37,6 +37,7 @@ Method | Description
 [**get_routing_queues_divisionviews_all**](RoutingApi.html#get_routing_queues_divisionviews_all) | Get a paged listing of simplified queue objects.  Can be used to get a digest of all queues in an organization.
 [**get_routing_queues_me**](RoutingApi.html#get_routing_queues_me) | Get a paged listing of queues the user is a member of.
 [**get_routing_settings_contactcenter**](RoutingApi.html#get_routing_settings_contactcenter) | Get Contact Center Settings
+[**get_routing_settings_transcription**](RoutingApi.html#get_routing_settings_transcription) | Get Transcription Settings
 [**get_routing_skill**](RoutingApi.html#get_routing_skill) | Get Routing Skill
 [**get_routing_skills**](RoutingApi.html#get_routing_skills) | Get the list of routing skills.
 [**get_routing_sms_address**](RoutingApi.html#get_routing_sms_address) | Get an Address by Id for SMS
@@ -71,6 +72,7 @@ Method | Description
 [**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
 [**put_routing_queue**](RoutingApi.html#put_routing_queue) | Update a queue
+[**put_routing_settings_transcription**](RoutingApi.html#put_routing_settings_transcription) | Update Transcription Settings
 [**put_routing_sms_phonenumber**](RoutingApi.html#put_routing_sms_phonenumber) | Update a phone number provisioned for SMS.
 [**put_routing_utilization**](RoutingApi.html#put_routing_utilization) | Update the utilization settings.
 [**put_routing_wrapupcode**](RoutingApi.html#put_routing_wrapupcode) | Update wrap-up code
@@ -2047,6 +2049,65 @@ This endpoint does not need any parameter.
 
 
 
+<a name="get_routing_settings_transcription"></a>
+
+## [**TranscriptionSettings**](TranscriptionSettings.html) get_routing_settings_transcription
+
+
+
+Get Transcription Settings
+
+
+
+Wraps GET /api/v2/routing/settings/transcription 
+
+Requires ANY permissions: 
+
+* routing:transcriptionSettings:view
+
+
+### 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::RoutingApi.new
+
+begin
+  #Get Transcription Settings
+  result = api_instance.get_routing_settings_transcription
+  p result
+rescue PureCloud::ApiError => e
+  puts "Exception when calling RoutingApi->get_routing_settings_transcription: #{e}"
+end
+```
+
+### Parameters
+This endpoint does not need any parameter.
+{: class="table table-striped"}
+
+
+### Return type
+
+[**TranscriptionSettings**](TranscriptionSettings.html)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
 <a name="get_routing_skill"></a>
 
 ## [**RoutingSkill**](RoutingSkill.html) get_routing_skill(skill_id)
@@ -4359,6 +4420,71 @@ Name | Type | Description  | Notes
 
 
 
+<a name="put_routing_settings_transcription"></a>
+
+## [**TranscriptionSettings**](TranscriptionSettings.html) put_routing_settings_transcription(body)
+
+
+
+Update Transcription Settings
+
+
+
+Wraps PUT /api/v2/routing/settings/transcription 
+
+Requires ANY permissions: 
+
+* routing:transcriptionSettings:add
+
+
+### 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::RoutingApi.new
+
+body = PureCloud::TranscriptionSettings.new # TranscriptionSettings | Organization Settings
+
+
+begin
+  #Update Transcription Settings
+  result = api_instance.put_routing_settings_transcription(body)
+  p result
+rescue PureCloud::ApiError => e
+  puts "Exception when calling RoutingApi->put_routing_settings_transcription: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **body** | [**TranscriptionSettings**](TranscriptionSettings.html)| Organization Settings |  |
+{: class="table table-striped"}
+
+
+### Return type
+
+[**TranscriptionSettings**](TranscriptionSettings.html)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
 <a name="put_routing_sms_phonenumber"></a>
 
 ## [**SmsPhoneNumber**](SmsPhoneNumber.html) put_routing_sms_phonenumber(address_id, body)