purecloudplatformclientv2 87.0.0 → 92.0.0

data/docs/ListItemComponent.md

@@ -0,0 +1,19 @@
+---
+title: ListItemComponent
+---
+## PureCloud::ListItemComponent
+
+## Properties
+
+|Name | Type | Description | Notes|
+|------------ | ------------- | ------------- | -------------|
+| **id** | **String** | An ID assigned to this component | [optional] |
+| **rmid** | **String** | An ID of the rich message instance | [optional] |
+| **type** | **String** | The type of component to render | [optional] |
+| **image** | **String** | Path or URI to an image file | [optional] |
+| **title** | **String** | The main headline of the list item | [optional] |
+| **description** | **String** | Text to show in the description row | [optional] |
+| **actions** | [**ContentActions**](ContentActions.html) | User actions available on the content. All actions are optional and all actions are executed simultaneously. | [optional] |
+{: class="table table-striped"}
+
+

data/docs/MessageContent.md

@@ -0,0 +1,19 @@
+---
+title: MessageContent
+---
+## PureCloud::MessageContent
+
+## Properties
+
+|Name | Type | Description | Notes|
+|------------ | ------------- | ------------- | -------------|
+| **content_type** | **String** | Type of this content element. If contentType = \"Attachment\" only one item is allowed. | |
+| **location** | [**ContentLocation**](ContentLocation.html) | Location object | [optional] |
+| **attachment** | [**ContentAttachment**](ContentAttachment.html) | Attachment object | [optional] |
+| **quick_reply** | [**ContentQuickReply**](ContentQuickReply.html) | Quick reply object | [optional] |
+| **generic** | [**ContentGeneric**](ContentGeneric.html) | Generic content object | [optional] |
+| **list** | [**ContentList**](ContentList.html) | List content object | [optional] |
+| **template** | [**ContentNotificationTemplate**](ContentNotificationTemplate.html) | Template notification object | [optional] |
+{: class="table table-striped"}
+
+

data/docs/NluDomainVersion.md

@@ -10,12 +10,14 @@ title: NluDomainVersion
 | **id** | **String** | The globally unique identifier for the object. | [optional] |
 | **domain** | [**NluDomain**](NluDomain.html) | The NLU domain of the version. | [optional] |
 | **description** | **String** | The description of the NLU domain version. | [optional] |
-| **language** | **String** | The language that the NLU domain version supports. | [optional] |
+| **language** | **String** | The language that the NLU domain version supports. | |
+| **published** | **BOOLEAN** | Whether this NLU domain version has been published. | [optional] |
 | **date_created** | **DateTime** | The date when the NLU domain version 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 when the NLU domain version was updated. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
 | **date_trained** | **DateTime** | The date when the NLU domain version was trained. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
 | **date_published** | **DateTime** | The date when the NLU domain version was published. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
 | **training_status** | **String** | The training status of the NLU domain version. | [optional] |
+| **evaluation_status** | **String** | The evaluation status of the NLU domain version. | [optional] |
 | **intents** | [**Array<IntentDefinition>**](IntentDefinition.html) | The intents defined for this NLU domain version. | [optional] |
 | **entity_types** | [**Array<NamedEntityTypeDefinition>**](NamedEntityTypeDefinition.html) | The entity types defined for this NLU domain version. | [optional] |
 | **self_uri** | **String** | The URI for this object | [optional] |

data/docs/NotificationTemplateBody.md

@@ -0,0 +1,14 @@
+---
+title: NotificationTemplateBody
+---
+## PureCloud::NotificationTemplateBody
+
+## Properties
+
+|Name | Type | Description | Notes|
+|------------ | ------------- | ------------- | -------------|
+| **text** | **String** | Body text. For WhatsApp, ignored | [optional] |
+| **parameters** | [**Array<NotificationTemplateParameter>**](NotificationTemplateParameter.html) | Template parameters for placeholders in template | |
+{: class="table table-striped"}
+
+

data/docs/NotificationTemplateFooter.md

@@ -0,0 +1,13 @@
+---
+title: NotificationTemplateFooter
+---
+## PureCloud::NotificationTemplateFooter
+
+## Properties
+
+|Name | Type | Description | Notes|
+|------------ | ------------- | ------------- | -------------|
+| **text** | **String** | Footer text. For WhatsApp, ignored | [optional] |
+{: class="table table-striped"}
+
+

data/docs/NotificationTemplateHeader.md

@@ -0,0 +1,16 @@
+---
+title: NotificationTemplateHeader
+---
+## PureCloud::NotificationTemplateHeader
+
+## Properties
+
+|Name | Type | Description | Notes|
+|------------ | ------------- | ------------- | -------------|
+| **type** | **String** | Template header type | |
+| **text** | **String** | Header text. For WhatsApp, ignored | [optional] |
+| **media** | [**ContentAttachment**](ContentAttachment.html) | Attachment object | [optional] |
+| **parameters** | [**Array<NotificationTemplateParameter>**](NotificationTemplateParameter.html) | Template parameters for placeholders in template | [optional] |
+{: class="table table-striped"}
+
+

data/docs/NotificationTemplateParameter.md

@@ -0,0 +1,14 @@
+---
+title: NotificationTemplateParameter
+---
+## PureCloud::NotificationTemplateParameter
+
+## Properties
+
+|Name | Type | Description | Notes|
+|------------ | ------------- | ------------- | -------------|
+| **name** | **String** | Parameter name | [optional] |
+| **text** | **String** | Parameter text value | |
+{: class="table table-striped"}
+
+

data/docs/OAuthApi.md

@@ -12,10 +12,13 @@ Method | Description
 [**get_oauth_authorization**](OAuthApi.html#get_oauth_authorization) | Get a client that is authorized by the resource owner
 [**get_oauth_authorizations**](OAuthApi.html#get_oauth_authorizations) | List clients that are authorized by the resource owner
 [**get_oauth_client**](OAuthApi.html#get_oauth_client) | Get OAuth Client
+[**get_oauth_client_usage_query_result**](OAuthApi.html#get_oauth_client_usage_query_result) | Get the results of a usage query
+[**get_oauth_client_usage_summary**](OAuthApi.html#get_oauth_client_usage_summary) | Get a summary of OAuth client API usage
 [**get_oauth_clients**](OAuthApi.html#get_oauth_clients) | The list of OAuth clients
 [**get_oauth_scope**](OAuthApi.html#get_oauth_scope) | An OAuth scope
 [**get_oauth_scopes**](OAuthApi.html#get_oauth_scopes) | The list of OAuth scopes
 [**post_oauth_client_secret**](OAuthApi.html#post_oauth_client_secret) | Regenerate Client Secret
+[**post_oauth_client_usage_query**](OAuthApi.html#post_oauth_client_usage_query) | Query for OAuth client API usage
 [**post_oauth_clients**](OAuthApi.html#post_oauth_clients) | Create OAuth client
 [**put_oauth_client**](OAuthApi.html#put_oauth_client) | Update OAuth Client
 {: class="table table-striped"}
@@ -273,6 +276,143 @@ Name | Type | Description  | Notes
 
 
 
+<a name="get_oauth_client_usage_query_result"></a>
+
+## [**ApiUsageQueryResult**](ApiUsageQueryResult.html) get_oauth_client_usage_query_result(execution_id, client_id)
+
+
+
+Get the results of a usage query
+
+
+
+Wraps GET /api/v2/oauth/clients/{clientId}/usage/query/results/{executionId} 
+
+Requires ANY permissions: 
+
+* oauth:client: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::OAuthApi.new
+
+execution_id = "execution_id_example" # String | ID of the query execution
+
+client_id = "client_id_example" # String | Client ID
+
+
+begin
+  #Get the results of a usage query
+  result = api_instance.get_oauth_client_usage_query_result(execution_id, client_id)
+  p result
+rescue PureCloud::ApiError => e
+  puts "Exception when calling OAuthApi->get_oauth_client_usage_query_result: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **execution_id** | **String**| ID of the query execution |  |
+ **client_id** | **String**| Client ID |  |
+{: class="table table-striped"}
+
+
+### Return type
+
+[**ApiUsageQueryResult**](ApiUsageQueryResult.html)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+<a name="get_oauth_client_usage_summary"></a>
+
+## [**UsageExecutionResult**](UsageExecutionResult.html) get_oauth_client_usage_summary(client_id, opts)
+
+
+
+Get a summary of OAuth client API usage
+
+After calling this method, you will then need to poll for the query results based on the returned execution Id
+
+Wraps GET /api/v2/oauth/clients/{clientId}/usage/summary 
+
+Requires ANY permissions: 
+
+* oauth:client: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::OAuthApi.new
+
+client_id = "client_id_example" # String | Client ID
+
+opts = { 
+  days: "7" # String | Previous number of days to query
+}
+
+begin
+  #Get a summary of OAuth client API usage
+  result = api_instance.get_oauth_client_usage_summary(client_id, opts)
+  p result
+rescue PureCloud::ApiError => e
+  puts "Exception when calling OAuthApi->get_oauth_client_usage_summary: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **client_id** | **String**| Client ID |  |
+ **days** | **String**| Previous number of days to query | [optional] [default to 7] |
+{: class="table table-striped"}
+
+
+### Return type
+
+[**UsageExecutionResult**](UsageExecutionResult.html)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
 <a name="get_oauth_clients"></a>
 
 ## [**OAuthClientEntityListing**](OAuthClientEntityListing.html) get_oauth_clients
@@ -530,6 +670,74 @@ Name | Type | Description  | Notes
 
 
 
+<a name="post_oauth_client_usage_query"></a>
+
+## [**UsageExecutionResult**](UsageExecutionResult.html) post_oauth_client_usage_query(client_id, body)
+
+
+
+Query for OAuth client API usage
+
+After calling this method, you will then need to poll for the query results based on the returned execution Id
+
+Wraps POST /api/v2/oauth/clients/{clientId}/usage/query 
+
+Requires ANY permissions: 
+
+* oauth:client: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::OAuthApi.new
+
+client_id = "client_id_example" # String | Client ID
+
+body = PureCloud::ApiUsageQuery.new # ApiUsageQuery | Query
+
+
+begin
+  #Query for OAuth client API usage
+  result = api_instance.post_oauth_client_usage_query(client_id, body)
+  p result
+rescue PureCloud::ApiError => e
+  puts "Exception when calling OAuthApi->post_oauth_client_usage_query: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **client_id** | **String**| Client ID |  |
+ **body** | [**ApiUsageQuery**](ApiUsageQuery.html)| Query |  |
+{: class="table table-striped"}
+
+
+### Return type
+
+[**UsageExecutionResult**](UsageExecutionResult.html)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
 <a name="post_oauth_clients"></a>
 
 ## [**OAuthClient**](OAuthClient.html) post_oauth_clients(body)

data/docs/OrganizationApi.md

@@ -10,10 +10,12 @@ Method | Description
 ------------- | ------------- | -------------
 [**get_fieldconfig**](OrganizationApi.html#get_fieldconfig) | Fetch field config for an entity type
 [**get_organizations_embeddedintegration**](OrganizationApi.html#get_organizations_embeddedintegration) | Get the list of domains that will be allowed to embed PureCloud applications
+[**get_organizations_ipaddressauthentication**](OrganizationApi.html#get_organizations_ipaddressauthentication) | Get organization IP address whitelist settings
 [**get_organizations_me**](OrganizationApi.html#get_organizations_me) | Get organization.
 [**get_organizations_whitelist**](OrganizationApi.html#get_organizations_whitelist) | Use PUT /api/v2/organizations/embeddedintegration instead
 [**patch_organizations_feature**](OrganizationApi.html#patch_organizations_feature) | Update organization
 [**put_organizations_embeddedintegration**](OrganizationApi.html#put_organizations_embeddedintegration) | Update the list of domains that will be allowed to embed PureCloud applications
+[**put_organizations_ipaddressauthentication**](OrganizationApi.html#put_organizations_ipaddressauthentication) | Update organization IP address whitelist settings
 [**put_organizations_me**](OrganizationApi.html#put_organizations_me) | Update organization.
 [**put_organizations_whitelist**](OrganizationApi.html#put_organizations_whitelist) | Use PUT /api/v2/organizations/embeddedintegration instead
 {: class="table table-striped"}
@@ -140,6 +142,65 @@ This endpoint does not need any parameter.
 
 
 
+<a name="get_organizations_ipaddressauthentication"></a>
+
+## [**IpAddressAuthentication**](IpAddressAuthentication.html) get_organizations_ipaddressauthentication
+
+
+
+Get organization IP address whitelist settings
+
+
+
+Wraps GET /api/v2/organizations/ipaddressauthentication 
+
+Requires ANY permissions: 
+
+* directory:organization:admin
+
+
+### 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::OrganizationApi.new
+
+begin
+  #Get organization IP address whitelist settings
+  result = api_instance.get_organizations_ipaddressauthentication
+  p result
+rescue PureCloud::ApiError => e
+  puts "Exception when calling OrganizationApi->get_organizations_ipaddressauthentication: #{e}"
+end
+```
+
+### Parameters
+This endpoint does not need any parameter.
+{: class="table table-striped"}
+
+
+### Return type
+
+[**IpAddressAuthentication**](IpAddressAuthentication.html)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
 <a name="get_organizations_me"></a>
 
 ## [**Organization**](Organization.html) get_organizations_me
@@ -389,6 +450,71 @@ Name | Type | Description  | Notes
 
 
 
+<a name="put_organizations_ipaddressauthentication"></a>
+
+## [**IpAddressAuthentication**](IpAddressAuthentication.html) put_organizations_ipaddressauthentication(body)
+
+
+
+Update organization IP address whitelist settings
+
+
+
+Wraps PUT /api/v2/organizations/ipaddressauthentication 
+
+Requires ANY permissions: 
+
+* directory:organization:admin
+
+
+### 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::OrganizationApi.new
+
+body = PureCloud::IpAddressAuthentication.new # IpAddressAuthentication | IP address Whitelist settings
+
+
+begin
+  #Update organization IP address whitelist settings
+  result = api_instance.put_organizations_ipaddressauthentication(body)
+  p result
+rescue PureCloud::ApiError => e
+  puts "Exception when calling OrganizationApi->put_organizations_ipaddressauthentication: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **body** | [**IpAddressAuthentication**](IpAddressAuthentication.html)| IP address Whitelist settings |  |
+{: class="table table-striped"}
+
+
+### Return type
+
+[**IpAddressAuthentication**](IpAddressAuthentication.html)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
 <a name="put_organizations_me"></a>
 
 ## [**Organization**](Organization.html) put_organizations_me(opts)