purecloud 0.37.1 → 0.38.1

data/doc_out/LocationEmergencyNumber.html.md

@@ -0,0 +1,15 @@
+---
+title: LocationEmergencyNumber
+---
+## PureCloud::LocationEmergencyNumber
+
+## Properties
+
+|Name | Type | Description | Notes|
+|------------ | ------------- | ------------- | -------------|
+| **e164** | **String** |  | [optional] |
+| **number** | **String** |  | [optional] |
+| **type** | **String** | The type of emergency number. | [optional] |
+{: class="table table-striped"}
+
+

data/doc_out/LocationsApi.html.md

@@ -0,0 +1,249 @@
+---
+title: LocationsApi
+---
+
+## PureCloud::LocationsApi
+
+All URIs are relative to *https://api.mypurecloud.com*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+|[**get_location_id**](LocationsApi.html#get_location_id) | **GET** /api/v2/locations/{locationId} | Get Location by ID.|
+|[**get_locations**](LocationsApi.html#get_locations) | **GET** /api/v2/locations | Get a list of all locations.|
+|[**get_search**](LocationsApi.html#get_search) | **GET** /api/v2/locations/search | Search using q64|
+|[**post_search**](LocationsApi.html#post_search) | **POST** /api/v2/locations/search | Search|
+{: class="table table-striped"}
+
+<a name="get_location_id"></a>
+
+## -[**Location**](Location.html) get_location_id(location_id)
+
+Get Location by ID.
+
+
+
+### 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::LocationsApi.new
+
+location_id = "location_id_example" # String | Location ID
+
+
+begin
+  #Get Location by ID.
+  result = api_instance.get_location_id(location_id)
+  p result
+rescue PureCloud::ApiError => e
+  puts "Exception when calling LocationsApi->get_location_id: #{e}"
+end
+~~~
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **location_id** | **String**| Location ID | 
+{: class="table table-striped"}
+
+
+### Return type
+
+[**Location**](Location.html)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+<a name="get_locations"></a>
+
+## -[**Array&lt;Location&gt;**](Location.html) get_locations(opts)
+
+Get a list of all locations.
+
+
+
+### 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::LocationsApi.new
+
+opts = { 
+  page_size: 25, # Integer | Page size
+  page_number: 1, # Integer | Page number
+  sort_order: "sort_order_example" # String | Sort order
+}
+
+begin
+  #Get a list of all locations.
+  result = api_instance.get_locations(opts)
+  p result
+rescue PureCloud::ApiError => e
+  puts "Exception when calling LocationsApi->get_locations: #{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**| Sort order | [optional] 
+{: class="table table-striped"}
+
+
+### Return type
+
+[**Array&lt;Location&gt;**](Location.html)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+<a name="get_search"></a>
+
+## -[**GroupsSearchResponse**](GroupsSearchResponse.html) get_search(opts)
+
+Search using q64
+
+
+
+### 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::LocationsApi.new
+
+opts = { 
+  q64: "q64_example", # String | 
+  expand: ["expand_example"] # Array<String> | 
+}
+
+begin
+  #Search using q64
+  result = api_instance.get_search(opts)
+  p result
+rescue PureCloud::ApiError => e
+  puts "Exception when calling LocationsApi->get_search: #{e}"
+end
+~~~
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **q64** | **String**|  | [optional] 
+ **expand** | [**Array&lt;String&gt;**](String.html)|  | [optional] 
+{: class="table table-striped"}
+
+
+### Return type
+
+[**GroupsSearchResponse**](GroupsSearchResponse.html)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+<a name="post_search"></a>
+
+## -[**GroupsSearchResponse**](GroupsSearchResponse.html) post_search(opts)
+
+Search
+
+
+
+### 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::LocationsApi.new
+
+opts = { 
+  body: PureCloud::SearchRequest.new # SearchRequest | Search request options
+}
+
+begin
+  #Search
+  result = api_instance.post_search(opts)
+  p result
+rescue PureCloud::ApiError => e
+  puts "Exception when calling LocationsApi->post_search: #{e}"
+end
+~~~
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **body** | [**SearchRequest**](SearchRequest.html)| Search request options | [optional] 
+{: class="table table-striped"}
+
+
+### Return type
+
+[**GroupsSearchResponse**](GroupsSearchResponse.html)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+

data/doc_out/ObjectsApi.html.md

@@ -0,0 +1,69 @@
+---
+title: ObjectsApi
+---
+
+## PureCloud::ObjectsApi
+
+All URIs are relative to *https://api.mypurecloud.com*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+|[**get_objects_object_id**](ObjectsApi.html#get_objects_object_id) | **GET** /api/v2/authorization/objects/{objectId} | Returns a permission-protected object, showing the permission contexts it belongs to.|
+{: class="table table-striped"}
+
+<a name="get_objects_object_id"></a>
+
+## -[**AuthzObject**](AuthzObject.html) get_objects_object_id(object_id)
+
+Returns a permission-protected object, showing the permission contexts it belongs to.
+
+
+
+### 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::ObjectsApi.new
+
+object_id = "object_id_example" # String | Object ID
+
+
+begin
+  #Returns a permission-protected object, showing the permission contexts it belongs to.
+  result = api_instance.get_objects_object_id(object_id)
+  p result
+rescue PureCloud::ApiError => e
+  puts "Exception when calling ObjectsApi->get_objects_object_id: #{e}"
+end
+~~~
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **object_id** | **String**| Object ID | 
+{: class="table table-striped"}
+
+
+### Return type
+
+[**AuthzObject**](AuthzObject.html)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+

data/doc_out/OrganizationCreate.html.md

@@ -7,12 +7,12 @@ title: OrganizationCreate
 
 |Name | Type | Description | Notes|
 |------------ | ------------- | ------------- | -------------|
-| **name** | **String** | Display Name for Organization | |
-| **admin_username** | **String** | Administrator username for this organization | |
-| **admin_password** | **String** | Administrator password for this organization | |
+| **name** | **String** | Display name for this organization. | |
+| **admin_username** | **String** | Administrator username for this organization in the form of an email address. | |
+| **admin_password** | **String** | Administrator password for this organization. | |
 | **domain** | **String** | Fully qualified domain name for this organization (Ex. example.com). | |
-| **third_party_org_name** | **String** | Organization Name which does not contain special characters like spaces. | |
-| **deletable** | **BOOLEAN** | Deletable Property for Organization. | [optional] [default to false]|
+| **third_party_org_name** | **String** | Organization name which does not contain special characters like spaces. | |
+| **deletable** | **BOOLEAN** | Deletable property for this organization. | [optional] [default to false]|
 {: class="table table-striped"}
 
 

data/doc_out/OutboundApi.html.md

@@ -31,9 +31,11 @@ Method | HTTP request | Description
 |[**get_contactlists**](OutboundApi.html#get_contactlists) | **GET** /api/v2/outbound/contactlists | Query a list of contact lists.|
 |[**get_contactlists_contactlist_id**](OutboundApi.html#get_contactlists_contactlist_id) | **GET** /api/v2/outbound/contactlists/{contactListId} | Get dialer contactList.|
 |[**get_contactlists_contactlist_id_contacts_contact_id**](OutboundApi.html#get_contactlists_contactlist_id_contacts_contact_id) | **GET** /api/v2/outbound/contactlists/{contactListId}/contacts/{contactId} | Get dialer contactList.|
+|[**get_contactlists_contactlist_id_export**](OutboundApi.html#get_contactlists_contactlist_id_export) | **GET** /api/v2/outbound/contactlists/{contactListId}/export | Get the URI of a contact list export.|
 |[**get_contactlists_contactlist_id_importstatus**](OutboundApi.html#get_contactlists_contactlist_id_importstatus) | **GET** /api/v2/outbound/contactlists/{contactListId}/importstatus | Get dialer contactList import status.|
 |[**get_dnclists**](OutboundApi.html#get_dnclists) | **GET** /api/v2/outbound/dnclists | Query dialer DNC lists|
 |[**get_dnclists_dnclist_id**](OutboundApi.html#get_dnclists_dnclist_id) | **GET** /api/v2/outbound/dnclists/{dncListId} | Get dialer DNC list|
+|[**get_dnclists_dnclist_id_export**](OutboundApi.html#get_dnclists_dnclist_id_export) | **GET** /api/v2/outbound/dnclists/{dncListId}/export | Get the URI of a DNC list export.|
 |[**get_dnclists_dnclist_id_importstatus**](OutboundApi.html#get_dnclists_dnclist_id_importstatus) | **GET** /api/v2/outbound/dnclists/{dncListId}/importstatus | Get dialer dncList import status.|
 |[**get_rulesets**](OutboundApi.html#get_rulesets) | **GET** /api/v2/outbound/rulesets | Query a list of Rule Sets.|
 |[**get_rulesets_ruleset_id**](OutboundApi.html#get_rulesets_ruleset_id) | **GET** /api/v2/outbound/rulesets/{ruleSetId} | Get a Rule Set by ID.|
@@ -1431,6 +1433,66 @@ Name | Type | Description  | Notes
 
 
 
+<a name="get_contactlists_contactlist_id_export"></a>
+
+## -[**ExportUri**](ExportUri.html) get_contactlists_contactlist_id_export(contact_list_id, opts)
+
+Get the URI of a contact list export.
+
+
+
+### 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::OutboundApi.new
+
+contact_list_id = "contact_list_id_example" # String | ContactList ID
+
+opts = { 
+  download: "false" # String | Redirect to download uri
+}
+
+begin
+  #Get the URI of a contact list export.
+  result = api_instance.get_contactlists_contactlist_id_export(contact_list_id, opts)
+  p result
+rescue PureCloud::ApiError => e
+  puts "Exception when calling OutboundApi->get_contactlists_contactlist_id_export: #{e}"
+end
+~~~
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **contact_list_id** | **String**| ContactList ID | 
+ **download** | **String**| Redirect to download uri | [optional] [default to false]
+{: class="table table-striped"}
+
+
+### Return type
+
+[**ExportUri**](ExportUri.html)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
 <a name="get_contactlists_contactlist_id_importstatus"></a>
 
 ## -[**ImportStatus**](ImportStatus.html) get_contactlists_contactlist_id_importstatus(contact_list_id)
@@ -1620,6 +1682,66 @@ Name | Type | Description  | Notes
 
 
 
+<a name="get_dnclists_dnclist_id_export"></a>
+
+## -[**ExportUri**](ExportUri.html) get_dnclists_dnclist_id_export(dnc_list_id, opts)
+
+Get the URI of a DNC list export.
+
+
+
+### 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::OutboundApi.new
+
+dnc_list_id = "dnc_list_id_example" # String | DncList ID
+
+opts = { 
+  download: "false" # String | Redirect to download uri
+}
+
+begin
+  #Get the URI of a DNC list export.
+  result = api_instance.get_dnclists_dnclist_id_export(dnc_list_id, opts)
+  p result
+rescue PureCloud::ApiError => e
+  puts "Exception when calling OutboundApi->get_dnclists_dnclist_id_export: #{e}"
+end
+~~~
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **dnc_list_id** | **String**| DncList ID | 
+ **download** | **String**| Redirect to download uri | [optional] [default to false]
+{: class="table table-striped"}
+
+
+### Return type
+
+[**ExportUri**](ExportUri.html)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
 <a name="get_dnclists_dnclist_id_importstatus"></a>
 
 ## -[**ImportStatus**](ImportStatus.html) get_dnclists_dnclist_id_importstatus(dnc_list_id)