purecloud 0.49.1 → 0.50.1

data/doc_out/QualityAudit.html.md

@@ -11,8 +11,8 @@ title: QualityAudit
 | **name** | **String** |  | [optional] |
 | **user** | [**User**](User.html) |  | [optional] |
 | **timestamp** | **String** |  | [optional] |
-| **entity** | [**AuditEntity**](AuditEntity.html) |  | [optional] |
 | **level** | **String** |  | [optional] |
+| **entity** | [**AuditEntity**](AuditEntity.html) |  | [optional] |
 | **action** | **String** |  | [optional] |
 | **status** | **String** |  | [optional] |
 | **changes** | [**Array<Change>**](Change.html) |  | [optional] |

data/doc_out/RecordingApi.html.md

@@ -538,7 +538,7 @@ opts = {
   page_size: 25, # Integer | The total page size requested
   page_number: 1, # Integer | The page number requested
   sort_by: "sort_by_example", # String | variable name requested to sort by
-  expand: ["expand_example"], # Array<String> | variable name requested by expand list
+  expand: nil, # Array<Object> | variable name requested by expand list
   next_page: "next_page_example", # String | next page token
   previous_page: "previous_page_example", # String | Previous page token
   name: "name_example", # String | the policy name - used for filtering results in searches.
@@ -563,7 +563,7 @@ Name | Type | Description  | Notes
  **page_size** | **Integer**| The total page size requested | [optional] [default to 25]
  **page_number** | **Integer**| The page number requested | [optional] [default to 1]
  **sort_by** | **String**| variable name requested to sort by | [optional] 
- **expand** | [**Array&lt;String&gt;**](String.html)| variable name requested by expand list | [optional] 
+ **expand** | [**Array&lt;Object&gt;**](Object.html)| variable name requested by expand list | [optional] 
  **next_page** | **String**| next page token | [optional] 
  **previous_page** | **String**| Previous page token | [optional] 
  **name** | **String**| the policy name - used for filtering results in searches. | [optional] 
@@ -725,7 +725,7 @@ opts = {
   page_size: 25, # Integer | The total page size requested
   page_number: 1, # Integer | The page number requested
   sort_by: "sort_by_example", # String | variable name requested to sort by
-  expand: ["expand_example"], # Array<String> | variable name requested by expand list
+  expand: nil, # Array<Object> | variable name requested by expand list
   next_page: "next_page_example", # String | next page token
   previous_page: "previous_page_example" # String | Previous page token
 }
@@ -746,7 +746,7 @@ Name | Type | Description  | Notes
  **page_size** | **Integer**| The total page size requested | [optional] [default to 25]
  **page_number** | **Integer**| The page number requested | [optional] [default to 1]
  **sort_by** | **String**| variable name requested to sort by | [optional] 
- **expand** | [**Array&lt;String&gt;**](String.html)| variable name requested by expand list | [optional] 
+ **expand** | [**Array&lt;Object&gt;**](Object.html)| variable name requested by expand list | [optional] 
  **next_page** | **String**| next page token | [optional] 
  **previous_page** | **String**| Previous page token | [optional] 
 {: class="table table-striped"}

data/doc_out/RoutingApi.html.md

@@ -23,6 +23,11 @@ Method | HTTP request | Description
 |[**get_email_setup**](RoutingApi.html#get_email_setup) | **GET** /api/v2/routing/email/setup | Get email setup|
 |[**get_queues**](RoutingApi.html#get_queues) | **GET** /api/v2/routing/queues | Get list of queues.|
 |[**get_queues_queue_id**](RoutingApi.html#get_queues_queue_id) | **GET** /api/v2/routing/queues/{queueId} | Get details about this queue.|
+|[**get_queues_queue_id_conversations**](RoutingApi.html#get_queues_queue_id_conversations) | **GET** /api/v2/routing/queues/{queueId}/conversations | Get recent conversations that are still active|
+|[**get_queues_queue_id_conversations_callbacks**](RoutingApi.html#get_queues_queue_id_conversations_callbacks) | **GET** /api/v2/routing/queues/{queueId}/conversations/callbacks | Get recent callback conversations that are still active|
+|[**get_queues_queue_id_conversations_calls**](RoutingApi.html#get_queues_queue_id_conversations_calls) | **GET** /api/v2/routing/queues/{queueId}/conversations/calls | Get recent call conversations that are still active|
+|[**get_queues_queue_id_conversations_chats**](RoutingApi.html#get_queues_queue_id_conversations_chats) | **GET** /api/v2/routing/queues/{queueId}/conversations/chats | Get recent chat conversations that are still active|
+|[**get_queues_queue_id_conversations_emails**](RoutingApi.html#get_queues_queue_id_conversations_emails) | **GET** /api/v2/routing/queues/{queueId}/conversations/emails | Get recent email conversations that are still active|
 |[**get_queues_queue_id_estimatedwaittime**](RoutingApi.html#get_queues_queue_id_estimatedwaittime) | **GET** /api/v2/routing/queues/{queueId}/estimatedwaittime | Get Estimated Wait Time|
 |[**get_queues_queue_id_users**](RoutingApi.html#get_queues_queue_id_users) | **GET** /api/v2/routing/queues/{queueId}/users | Get the members of this queue|
 |[**get_queues_queue_id_wrapupcodes**](RoutingApi.html#get_queues_queue_id_wrapupcodes) | **GET** /api/v2/routing/queues/{queueId}/wrapupcodes | Get the wrap-up codes for a queue|
@@ -900,6 +905,316 @@ Name | Type | Description  | Notes
 
 
 
+<a name="get_queues_queue_id_conversations"></a>
+
+## -[**CallConversationEntityListing**](CallConversationEntityListing.html) get_queues_queue_id_conversations(queue_id, opts)
+
+Get recent conversations that are still active
+
+
+
+### Example
+~~~ruby
+# load the gem
+require 'purecloud'
+# 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
+
+queue_id = "queue_id_example" # String | Queue ID
+
+opts = { 
+  page_size: 25, # Integer | Page size
+  page_number: 1 # Integer | Page number
+}
+
+begin
+  #Get recent conversations that are still active
+  result = api_instance.get_queues_queue_id_conversations(queue_id, opts)
+  p result
+rescue PureCloud::ApiError => e
+  puts "Exception when calling RoutingApi->get_queues_queue_id_conversations: #{e}"
+end
+~~~
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **queue_id** | **String**| Queue ID | 
+ **page_size** | **Integer**| Page size | [optional] [default to 25]
+ **page_number** | **Integer**| Page number | [optional] [default to 1]
+{: class="table table-striped"}
+
+
+### Return type
+
+[**CallConversationEntityListing**](CallConversationEntityListing.html)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+<a name="get_queues_queue_id_conversations_callbacks"></a>
+
+## -[**CallbackConversationEntityListing**](CallbackConversationEntityListing.html) get_queues_queue_id_conversations_callbacks(queue_id, opts)
+
+Get recent callback conversations that are still active
+
+
+
+### Example
+~~~ruby
+# load the gem
+require 'purecloud'
+# 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
+
+queue_id = "queue_id_example" # String | Queue ID
+
+opts = { 
+  page_size: 25, # Integer | Page size
+  page_number: 1 # Integer | Page number
+}
+
+begin
+  #Get recent callback conversations that are still active
+  result = api_instance.get_queues_queue_id_conversations_callbacks(queue_id, opts)
+  p result
+rescue PureCloud::ApiError => e
+  puts "Exception when calling RoutingApi->get_queues_queue_id_conversations_callbacks: #{e}"
+end
+~~~
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **queue_id** | **String**| Queue ID | 
+ **page_size** | **Integer**| Page size | [optional] [default to 25]
+ **page_number** | **Integer**| Page number | [optional] [default to 1]
+{: class="table table-striped"}
+
+
+### Return type
+
+[**CallbackConversationEntityListing**](CallbackConversationEntityListing.html)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+<a name="get_queues_queue_id_conversations_calls"></a>
+
+## -[**CallConversationEntityListing**](CallConversationEntityListing.html) get_queues_queue_id_conversations_calls(queue_id, opts)
+
+Get recent call conversations that are still active
+
+
+
+### Example
+~~~ruby
+# load the gem
+require 'purecloud'
+# 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
+
+queue_id = "queue_id_example" # String | Queue ID
+
+opts = { 
+  page_size: 25, # Integer | Page size
+  page_number: 1 # Integer | Page number
+}
+
+begin
+  #Get recent call conversations that are still active
+  result = api_instance.get_queues_queue_id_conversations_calls(queue_id, opts)
+  p result
+rescue PureCloud::ApiError => e
+  puts "Exception when calling RoutingApi->get_queues_queue_id_conversations_calls: #{e}"
+end
+~~~
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **queue_id** | **String**| Queue ID | 
+ **page_size** | **Integer**| Page size | [optional] [default to 25]
+ **page_number** | **Integer**| Page number | [optional] [default to 1]
+{: class="table table-striped"}
+
+
+### Return type
+
+[**CallConversationEntityListing**](CallConversationEntityListing.html)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+<a name="get_queues_queue_id_conversations_chats"></a>
+
+## -[**ChatConversationEntityListing**](ChatConversationEntityListing.html) get_queues_queue_id_conversations_chats(queue_id, opts)
+
+Get recent chat conversations that are still active
+
+
+
+### Example
+~~~ruby
+# load the gem
+require 'purecloud'
+# 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
+
+queue_id = "queue_id_example" # String | Queue ID
+
+opts = { 
+  page_size: 25, # Integer | Page size
+  page_number: 1 # Integer | Page number
+}
+
+begin
+  #Get recent chat conversations that are still active
+  result = api_instance.get_queues_queue_id_conversations_chats(queue_id, opts)
+  p result
+rescue PureCloud::ApiError => e
+  puts "Exception when calling RoutingApi->get_queues_queue_id_conversations_chats: #{e}"
+end
+~~~
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **queue_id** | **String**| Queue ID | 
+ **page_size** | **Integer**| Page size | [optional] [default to 25]
+ **page_number** | **Integer**| Page number | [optional] [default to 1]
+{: class="table table-striped"}
+
+
+### Return type
+
+[**ChatConversationEntityListing**](ChatConversationEntityListing.html)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+<a name="get_queues_queue_id_conversations_emails"></a>
+
+## -[**EmailConversationEntityListing**](EmailConversationEntityListing.html) get_queues_queue_id_conversations_emails(queue_id, opts)
+
+Get recent email conversations that are still active
+
+
+
+### Example
+~~~ruby
+# load the gem
+require 'purecloud'
+# 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
+
+queue_id = "queue_id_example" # String | Queue ID
+
+opts = { 
+  page_size: 25, # Integer | Page size
+  page_number: 1 # Integer | Page number
+}
+
+begin
+  #Get recent email conversations that are still active
+  result = api_instance.get_queues_queue_id_conversations_emails(queue_id, opts)
+  p result
+rescue PureCloud::ApiError => e
+  puts "Exception when calling RoutingApi->get_queues_queue_id_conversations_emails: #{e}"
+end
+~~~
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **queue_id** | **String**| Queue ID | 
+ **page_size** | **Integer**| Page size | [optional] [default to 25]
+ **page_number** | **Integer**| Page number | [optional] [default to 1]
+{: class="table table-striped"}
+
+
+### Return type
+
+[**EmailConversationEntityListing**](EmailConversationEntityListing.html)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
 <a name="get_queues_queue_id_estimatedwaittime"></a>
 
 ## -[**EstimatedWaitTimePredictions**](EstimatedWaitTimePredictions.html) get_queues_queue_id_estimatedwaittime(queue_id, opts)

data/doc_out/RuleSetDiagnostic.html.md

@@ -0,0 +1,14 @@
+---
+title: RuleSetDiagnostic
+---
+## PureCloud::RuleSetDiagnostic
+
+## Properties
+
+|Name | Type | Description | Notes|
+|------------ | ------------- | ------------- | -------------|
+| **rule_set** | [**UriReference**](UriReference.html) | A campaign rule set | [optional] |
+| **warnings** | **Array<String>** | Diagnostic warnings for the rule set | [optional] |
+{: class="table table-striped"}
+
+

data/doc_out/ScreenRecordingSession.html.md

@@ -8,7 +8,7 @@ title: ScreenRecordingSession
 |Name | Type | Description | Notes|
 |------------ | ------------- | ------------- | -------------|
 | **user** | [**User**](User.html) |  | [optional] |
-| **participant_id** | **String** |  | [optional] |
+| **participant_id** | **String** | The id of the participant whose screen is being recorded on the conversation | [optional] |
 | **conversation** | [**Conversation**](Conversation.html) |  | [optional] |
 | **start_time** | **DateTime** | Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
 {: class="table table-striped"}

data/doc_out/TelephonyProvidersEdgeApi.html.md

@@ -1489,7 +1489,7 @@ Name | Type | Description  | Notes
 
 <a name="get_providers_edges_edge_id_logicalinterfaces"></a>
 
-## -[**LogicalInterfaceEntityListing**](LogicalInterfaceEntityListing.html) get_providers_edges_edge_id_logicalinterfaces(edge_id)
+## -[**LogicalInterfaceEntityListing**](LogicalInterfaceEntityListing.html) get_providers_edges_edge_id_logicalinterfaces(edge_id, opts)
 
 Get edge logical interfaces.
 
@@ -1514,10 +1514,13 @@ api_instance = PureCloud::TelephonyProvidersEdgeApi.new
 
 edge_id = "edge_id_example" # String | Edge ID
 
+opts = { 
+  expand: ["expand_example"] # Array<String> | Field to expand in the response
+}
 
 begin
   #Get edge logical interfaces.
-  result = api_instance.get_providers_edges_edge_id_logicalinterfaces(edge_id)
+  result = api_instance.get_providers_edges_edge_id_logicalinterfaces(edge_id, opts)
   p result
 rescue PureCloud::ApiError => e
   puts "Exception when calling TelephonyProvidersEdgeApi->get_providers_edges_edge_id_logicalinterfaces: #{e}"
@@ -1529,6 +1532,7 @@ end
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
  **edge_id** | **String**| Edge ID | 
+ **expand** | [**Array&lt;String&gt;**](String.html)| Field to expand in the response | [optional] 
 {: class="table table-striped"}
 
 
@@ -1545,7 +1549,7 @@ Name | Type | Description  | Notes
 
 <a name="get_providers_edges_edge_id_logicalinterfaces_interface_id"></a>
 
-## -[**DomainLogicalInterface**](DomainLogicalInterface.html) get_providers_edges_edge_id_logicalinterfaces_interface_id(edge_id, interface_id)
+## -[**DomainLogicalInterface**](DomainLogicalInterface.html) get_providers_edges_edge_id_logicalinterfaces_interface_id(edge_id, interface_id, opts)
 
 Get an edge logical interface
 
@@ -1572,10 +1576,13 @@ edge_id = "edge_id_example" # String | Edge ID
 
 interface_id = "interface_id_example" # String | Interface ID
 
+opts = { 
+  expand: ["expand_example"] # Array<String> | Field to expand in the response
+}
 
 begin
   #Get an edge logical interface
-  result = api_instance.get_providers_edges_edge_id_logicalinterfaces_interface_id(edge_id, interface_id)
+  result = api_instance.get_providers_edges_edge_id_logicalinterfaces_interface_id(edge_id, interface_id, opts)
   p result
 rescue PureCloud::ApiError => e
   puts "Exception when calling TelephonyProvidersEdgeApi->get_providers_edges_edge_id_logicalinterfaces_interface_id: #{e}"
@@ -1588,6 +1595,7 @@ Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
  **edge_id** | **String**| Edge ID | 
  **interface_id** | **String**| Interface ID | 
+ **expand** | [**Array&lt;String&gt;**](String.html)| Field to expand in the response | [optional] 
 {: class="table table-striped"}
 
 
@@ -1953,7 +1961,7 @@ Name | Type | Description  | Notes
 
 <a name="get_providers_edges_edgegroups_edgegroup_id"></a>
 
-## -[**EdgeGroup**](EdgeGroup.html) get_providers_edges_edgegroups_edgegroup_id(edge_group_id)
+## -[**EdgeGroup**](EdgeGroup.html) get_providers_edges_edgegroups_edgegroup_id(edge_group_id, opts)
 
 Get edge group.
 
@@ -1978,10 +1986,13 @@ api_instance = PureCloud::TelephonyProvidersEdgeApi.new
 
 edge_group_id = "edge_group_id_example" # String | Edge group ID
 
+opts = { 
+  expand: ["expand_example"] # Array<String> | Fields to expand in the response
+}
 
 begin
   #Get edge group.
-  result = api_instance.get_providers_edges_edgegroups_edgegroup_id(edge_group_id)
+  result = api_instance.get_providers_edges_edgegroups_edgegroup_id(edge_group_id, opts)
   p result
 rescue PureCloud::ApiError => e
   puts "Exception when calling TelephonyProvidersEdgeApi->get_providers_edges_edgegroups_edgegroup_id: #{e}"
@@ -1993,6 +2004,7 @@ end
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
  **edge_group_id** | **String**| Edge group ID | 
+ **expand** | [**Array&lt;String&gt;**](String.html)| Fields to expand in the response | [optional] 
 {: class="table table-striped"}
 
 
@@ -3101,6 +3113,7 @@ opts = {
   web_rtc_user_id: "web_rtc_user_id_example", # String | Filter by webRtcUser.id
   phone_base_settings_id: "phone_base_settings_id_example", # String | Filter by phoneBaseSettings.id
   lines_logged_in_user_id: "lines_logged_in_user_id_example", # String | Filter by lines.loggedInUser.id
+  lines_default_for_user_id: "lines_default_for_user_id_example", # String | Filter by lines.defaultForUser.id
   phone_hardware_id: "phone_hardware_id_example", # String | Filter by phone_hardwareId
   lines_id: "lines_id_example", # String | Filter by lines.id
   lines_name: "lines_name_example", # String | Filter by lines.name
@@ -3129,6 +3142,7 @@ Name | Type | Description  | Notes
  **web_rtc_user_id** | **String**| Filter by webRtcUser.id | [optional] 
  **phone_base_settings_id** | **String**| Filter by phoneBaseSettings.id | [optional] 
  **lines_logged_in_user_id** | **String**| Filter by lines.loggedInUser.id | [optional] 
+ **lines_default_for_user_id** | **String**| Filter by lines.defaultForUser.id | [optional] 
  **phone_hardware_id** | **String**| Filter by phone_hardwareId | [optional] 
  **lines_id** | **String**| Filter by lines.id | [optional] 
  **lines_name** | **String**| Filter by lines.name | [optional]