purecloudplatformclientv2 17.0.0 → 18.0.0

data/docs/Line.md

@@ -9,15 +9,15 @@ title: Line
 |------------ | ------------- | ------------- | -------------|
 | **id** | **String** | The globally unique identifier for the object. | [optional] |
 | **name** | **String** | The name of the entity. | |
-| **description** | **String** |  | [optional] |
-| **version** | **Integer** |  | [optional] |
-| **date_created** | **DateTime** | Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
-| **date_modified** | **DateTime** | Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
-| **modified_by** | **String** |  | [optional] |
-| **created_by** | **String** |  | [optional] |
-| **state** | **String** |  | [optional] |
-| **modified_by_app** | **String** |  | [optional] |
-| **created_by_app** | **String** |  | [optional] |
+| **description** | **String** | The resource's description. | [optional] |
+| **version** | **Integer** | The current version of the resource. | [optional] |
+| **date_created** | **DateTime** | The date the resource was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
+| **date_modified** | **DateTime** | The date of the last modification to the resource. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
+| **modified_by** | **String** | The ID of the user that last modified the resource. | [optional] |
+| **created_by** | **String** | The ID of the user that created the resource. | [optional] |
+| **state** | **String** | Indicates if the resource is active, inactive, or deleted. | [optional] |
+| **modified_by_app** | **String** | The application that last modified the resource. | [optional] |
+| **created_by_app** | **String** | The application that created the resource. | [optional] |
 | **properties** | **Hash<String, Object>** |  | [optional] |
 | **edge_group** | [**UriReference**](UriReference.html) |  | [optional] |
 | **template** | [**UriReference**](UriReference.html) |  | [optional] |

data/docs/LineBase.md

@@ -9,15 +9,15 @@ title: LineBase
 |------------ | ------------- | ------------- | -------------|
 | **id** | **String** | The globally unique identifier for the object. | [optional] |
 | **name** | **String** | The name of the entity. | |
-| **description** | **String** |  | [optional] |
-| **version** | **Integer** |  | [optional] |
-| **date_created** | **DateTime** | Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
-| **date_modified** | **DateTime** | Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
-| **modified_by** | **String** |  | [optional] |
-| **created_by** | **String** |  | [optional] |
-| **state** | **String** |  | [optional] |
-| **modified_by_app** | **String** |  | [optional] |
-| **created_by_app** | **String** |  | [optional] |
+| **description** | **String** | The resource's description. | [optional] |
+| **version** | **Integer** | The current version of the resource. | [optional] |
+| **date_created** | **DateTime** | The date the resource was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
+| **date_modified** | **DateTime** | The date of the last modification to the resource. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
+| **modified_by** | **String** | The ID of the user that last modified the resource. | [optional] |
+| **created_by** | **String** | The ID of the user that created the resource. | [optional] |
+| **state** | **String** | Indicates if the resource is active, inactive, or deleted. | [optional] |
+| **modified_by_app** | **String** | The application that last modified the resource. | [optional] |
+| **created_by_app** | **String** | The application that created the resource. | [optional] |
 | **line_meta_base** | [**UriReference**](UriReference.html) |  | [optional] |
 | **properties** | **Hash<String, Object>** |  | [optional] |
 | **self_uri** | **String** | The URI for this object | [optional] |

data/docs/Metabase.md

@@ -10,14 +10,14 @@ title: Metabase
 | **id** | **String** | The globally unique identifier for the object. | [optional] |
 | **name** | **String** | The name of the entity. | |
 | **description** | **String** |  | [optional] |
-| **version** | **Integer** |  | [optional] |
-| **date_created** | **DateTime** | Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
-| **date_modified** | **DateTime** | Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
-| **modified_by** | **String** |  | [optional] |
-| **created_by** | **String** |  | [optional] |
-| **state** | **String** |  | [optional] |
-| **modified_by_app** | **String** |  | [optional] |
-| **created_by_app** | **String** |  | [optional] |
+| **version** | **Integer** | The current version of the resource. | [optional] |
+| **date_created** | **DateTime** | The date the resource was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
+| **date_modified** | **DateTime** | The date of the last modification to the resource. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
+| **modified_by** | **String** | The ID of the user that last modified the resource. | [optional] |
+| **created_by** | **String** | The ID of the user that created the resource. | [optional] |
+| **state** | **String** | Indicates if the resource is active, inactive, or deleted. | [optional] |
+| **modified_by_app** | **String** | The application that last modified the resource. | [optional] |
+| **created_by_app** | **String** | The application that created the resource. | [optional] |
 | **self_uri** | **String** | The URI for this object | [optional] |
 {: class="table table-striped"}
 

data/docs/MobileDevicesApi.md

@@ -0,0 +1,320 @@
+---
+title: MobileDevicesApi
+---
+
+## PureCloud::MobileDevicesApi
+
+All URIs are relative to *https://api.mypurecloud.com*
+
+Method | Description
+------------- | ------------- | -------------
+[**delete_mobiledevice**](MobileDevicesApi.html#delete_mobiledevice) | Delete device
+[**get_mobiledevice**](MobileDevicesApi.html#get_mobiledevice) | Get device
+[**get_mobiledevices**](MobileDevicesApi.html#get_mobiledevices) | Get a list of all devices.
+[**post_mobiledevices**](MobileDevicesApi.html#post_mobiledevices) | Create User device
+[**put_mobiledevice**](MobileDevicesApi.html#put_mobiledevice) | Update device
+{: class="table table-striped"}
+
+<a name="delete_mobiledevice"></a>
+
+## - delete_mobiledevice(device_id)
+
+Delete device
+
+
+
+Wraps DELETE /api/v2/mobiledevices/{deviceId} 
+
+
+### 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::MobileDevicesApi.new
+
+device_id = "device_id_example" # String | Device ID
+
+
+begin
+  #Delete device
+  api_instance.delete_mobiledevice(device_id)
+rescue PureCloud::ApiError => e
+  puts "Exception when calling MobileDevicesApi->delete_mobiledevice: #{e}"
+end
+~~~
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **device_id** | **String**| Device ID |  |
+{: class="table table-striped"}
+
+
+### Return type
+
+nil (empty response body)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+<a name="get_mobiledevice"></a>
+
+## -[**UserDevice**](UserDevice.html) get_mobiledevice(device_id)
+
+Get device
+
+
+
+Wraps GET /api/v2/mobiledevices/{deviceId} 
+
+
+### 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::MobileDevicesApi.new
+
+device_id = "device_id_example" # String | Device ID
+
+
+begin
+  #Get device
+  result = api_instance.get_mobiledevice(device_id)
+  p result
+rescue PureCloud::ApiError => e
+  puts "Exception when calling MobileDevicesApi->get_mobiledevice: #{e}"
+end
+~~~
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **device_id** | **String**| Device ID |  |
+{: class="table table-striped"}
+
+
+### Return type
+
+[**UserDevice**](UserDevice.html)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+<a name="get_mobiledevices"></a>
+
+## -[**DirectoryUserDevicesListing**](DirectoryUserDevicesListing.html) get_mobiledevices(opts)
+
+Get a list of all devices.
+
+
+
+Wraps GET /api/v2/mobiledevices 
+
+
+### 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::MobileDevicesApi.new
+
+opts = { 
+  page_size: 25, # Integer | Page size
+  page_number: 1, # Integer | Page number
+  sort_order: "ascending" # String | Ascending or descending sort order
+}
+
+begin
+  #Get a list of all devices.
+  result = api_instance.get_mobiledevices(opts)
+  p result
+rescue PureCloud::ApiError => e
+  puts "Exception when calling MobileDevicesApi->get_mobiledevices: #{e}"
+end
+~~~
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **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 ascending]<br />**Values**: ascending, descending |
+{: class="table table-striped"}
+
+
+### Return type
+
+[**DirectoryUserDevicesListing**](DirectoryUserDevicesListing.html)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+<a name="post_mobiledevices"></a>
+
+## -[**UserDevice**](UserDevice.html) post_mobiledevices(body)
+
+Create User device
+
+
+
+Wraps POST /api/v2/mobiledevices 
+
+
+### 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::MobileDevicesApi.new
+
+body = PureCloud::UserDevice.new # UserDevice | Device
+
+
+begin
+  #Create User device
+  result = api_instance.post_mobiledevices(body)
+  p result
+rescue PureCloud::ApiError => e
+  puts "Exception when calling MobileDevicesApi->post_mobiledevices: #{e}"
+end
+~~~
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **body** | [**UserDevice**](UserDevice.html)| Device |  |
+{: class="table table-striped"}
+
+
+### Return type
+
+[**UserDevice**](UserDevice.html)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+<a name="put_mobiledevice"></a>
+
+## -[**UserDevice**](UserDevice.html) put_mobiledevice(device_id, opts)
+
+Update device
+
+
+
+Wraps PUT /api/v2/mobiledevices/{deviceId} 
+
+
+### 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::MobileDevicesApi.new
+
+device_id = "device_id_example" # String | Device ID
+
+opts = { 
+  body: PureCloud::UserDevice.new # UserDevice | Device
+}
+
+begin
+  #Update device
+  result = api_instance.put_mobiledevice(device_id, opts)
+  p result
+rescue PureCloud::ApiError => e
+  puts "Exception when calling MobileDevicesApi->put_mobiledevice: #{e}"
+end
+~~~
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **device_id** | **String**| Device ID |  |
+ **body** | [**UserDevice**](UserDevice.html)| Device | [optional]  |
+{: class="table table-striped"}
+
+
+### Return type
+
+[**UserDevice**](UserDevice.html)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+

data/docs/NumberPlan.md

@@ -9,15 +9,15 @@ title: NumberPlan
 |------------ | ------------- | ------------- | -------------|
 | **id** | **String** | The globally unique identifier for the object. | [optional] |
 | **name** | **String** | The name of the entity. | |
-| **description** | **String** |  | [optional] |
-| **version** | **Integer** |  | [optional] |
-| **date_created** | **DateTime** | Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
-| **date_modified** | **DateTime** | Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
-| **modified_by** | **String** |  | [optional] |
-| **created_by** | **String** |  | [optional] |
-| **state** | **String** |  | [optional] |
-| **modified_by_app** | **String** |  | [optional] |
-| **created_by_app** | **String** |  | [optional] |
+| **description** | **String** | The resource's description. | [optional] |
+| **version** | **Integer** | The current version of the resource. | [optional] |
+| **date_created** | **DateTime** | The date the resource was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
+| **date_modified** | **DateTime** | The date of the last modification to the resource. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
+| **modified_by** | **String** | The ID of the user that last modified the resource. | [optional] |
+| **created_by** | **String** | The ID of the user that created the resource. | [optional] |
+| **state** | **String** | Indicates if the resource is active, inactive, or deleted. | [optional] |
+| **modified_by_app** | **String** | The application that last modified the resource. | [optional] |
+| **created_by_app** | **String** | The application that created the resource. | [optional] |
 | **match** | **String** |  | [optional] |
 | **normalized_format** | **String** |  | [optional] |
 | **priority** | **Integer** |  | [optional] |

data/docs/OutboundApi.md

@@ -59,7 +59,9 @@ Method | Description
 [**get_outbound_schedules_sequences**](OutboundApi.html#get_outbound_schedules_sequences) | Query for a list of dialer sequence schedules.
 [**get_outbound_sequence**](OutboundApi.html#get_outbound_sequence) | Get a dialer campaign sequence.
 [**get_outbound_sequences**](OutboundApi.html#get_outbound_sequences) | Query a list of dialer campaign sequences.
+[**get_outbound_settings**](OutboundApi.html#get_outbound_settings) | Get the outbound settings for this organization
 [**get_outbound_wrapupcodemappings**](OutboundApi.html#get_outbound_wrapupcodemappings) | Get the Dialer wrap up code mapping.
+[**patch_outbound_settings**](OutboundApi.html#patch_outbound_settings) | Update the outbound settings for this organization
 [**post_outbound_attemptlimits**](OutboundApi.html#post_outbound_attemptlimits) | Create attempt limits
 [**post_outbound_audits**](OutboundApi.html#post_outbound_audits) | Retrieves audits for dialer.
 [**post_outbound_callabletimesets**](OutboundApi.html#post_outbound_callabletimesets) | Create callable time set
@@ -3250,6 +3252,59 @@ Name | Type | Description  | Notes
 
 
 
+<a name="get_outbound_settings"></a>
+
+## -[**OutboundSettings**](OutboundSettings.html) get_outbound_settings
+
+Get the outbound settings for this organization
+
+
+
+Wraps GET /api/v2/outbound/settings 
+
+
+### 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::OutboundApi.new
+
+begin
+  #Get the outbound settings for this organization
+  result = api_instance.get_outbound_settings
+  p result
+rescue PureCloud::ApiError => e
+  puts "Exception when calling OutboundApi->get_outbound_settings: #{e}"
+end
+~~~
+
+### Parameters
+This endpoint does not need any parameter.
+{: class="table table-striped"}
+
+
+### Return type
+
+[**OutboundSettings**](OutboundSettings.html)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
 <a name="get_outbound_wrapupcodemappings"></a>
 
 ## -[**WrapUpCodeMapping**](WrapUpCodeMapping.html) get_outbound_wrapupcodemappings
@@ -3303,6 +3358,64 @@ This endpoint does not need any parameter.
 
 
 
+<a name="patch_outbound_settings"></a>
+
+## - patch_outbound_settings(body)
+
+Update the outbound settings for this organization
+
+
+
+Wraps PATCH /api/v2/outbound/settings 
+
+
+### 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::OutboundApi.new
+
+body = PureCloud::OutboundSettings.new # OutboundSettings | outboundSettings
+
+
+begin
+  #Update the outbound settings for this organization
+  api_instance.patch_outbound_settings(body)
+rescue PureCloud::ApiError => e
+  puts "Exception when calling OutboundApi->patch_outbound_settings: #{e}"
+end
+~~~
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **body** | [**OutboundSettings**](OutboundSettings.html)| outboundSettings |  |
+{: class="table table-striped"}
+
+
+### Return type
+
+nil (empty response body)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
 <a name="post_outbound_attemptlimits"></a>
 
 ## -[**AttemptLimits**](AttemptLimits.html) post_outbound_attemptlimits(body)