purecloudplatformclientv2 86.0.0 → 91.0.0

data/docs/IdentityProviderApi.md

@@ -10,6 +10,7 @@ Method | Description
 ------------- | ------------- | -------------
 [**delete_identityproviders_adfs**](IdentityProviderApi.html#delete_identityproviders_adfs) | Delete ADFS Identity Provider
 [**delete_identityproviders_cic**](IdentityProviderApi.html#delete_identityproviders_cic) | Delete Customer Interaction Center (CIC) Identity Provider
+[**delete_identityproviders_generic**](IdentityProviderApi.html#delete_identityproviders_generic) | Delete Generic SAML Identity Provider
 [**delete_identityproviders_gsuite**](IdentityProviderApi.html#delete_identityproviders_gsuite) | Delete G Suite Identity Provider
 [**delete_identityproviders_identitynow**](IdentityProviderApi.html#delete_identityproviders_identitynow) | Delete IdentityNow Provider
 [**delete_identityproviders_okta**](IdentityProviderApi.html#delete_identityproviders_okta) | Delete Okta Identity Provider
@@ -21,6 +22,7 @@ Method | Description
 [**get_identityproviders**](IdentityProviderApi.html#get_identityproviders) | The list of identity providers
 [**get_identityproviders_adfs**](IdentityProviderApi.html#get_identityproviders_adfs) | Get ADFS Identity Provider
 [**get_identityproviders_cic**](IdentityProviderApi.html#get_identityproviders_cic) | Get Customer Interaction Center (CIC) Identity Provider
+[**get_identityproviders_generic**](IdentityProviderApi.html#get_identityproviders_generic) | Get Generic SAML Identity Provider
 [**get_identityproviders_gsuite**](IdentityProviderApi.html#get_identityproviders_gsuite) | Get G Suite Identity Provider
 [**get_identityproviders_identitynow**](IdentityProviderApi.html#get_identityproviders_identitynow) | Get IdentityNow Provider
 [**get_identityproviders_okta**](IdentityProviderApi.html#get_identityproviders_okta) | Get Okta Identity Provider
@@ -31,6 +33,7 @@ Method | Description
 [**get_identityproviders_salesforce**](IdentityProviderApi.html#get_identityproviders_salesforce) | Get Salesforce Identity Provider
 [**put_identityproviders_adfs**](IdentityProviderApi.html#put_identityproviders_adfs) | Update/Create ADFS Identity Provider
 [**put_identityproviders_cic**](IdentityProviderApi.html#put_identityproviders_cic) | Update/Create Customer Interaction Center (CIC) Identity Provider
+[**put_identityproviders_generic**](IdentityProviderApi.html#put_identityproviders_generic) | Update/Create Generic SAML Identity Provider
 [**put_identityproviders_gsuite**](IdentityProviderApi.html#put_identityproviders_gsuite) | Update/Create G Suite Identity Provider
 [**put_identityproviders_identitynow**](IdentityProviderApi.html#put_identityproviders_identitynow) | Update/Create IdentityNow Provider
 [**put_identityproviders_okta**](IdentityProviderApi.html#put_identityproviders_okta) | Update/Create Okta Identity Provider
@@ -159,6 +162,65 @@ This endpoint does not need any parameter.
 
 
 
+<a name="delete_identityproviders_generic"></a>
+
+## [**Empty**](Empty.html) delete_identityproviders_generic
+
+
+
+Delete Generic SAML Identity Provider
+
+
+
+Wraps DELETE /api/v2/identityproviders/generic 
+
+Requires ANY permissions: 
+
+* sso:provider: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::IdentityProviderApi.new
+
+begin
+  #Delete Generic SAML Identity Provider
+  result = api_instance.delete_identityproviders_generic
+  p result
+rescue PureCloud::ApiError => e
+  puts "Exception when calling IdentityProviderApi->delete_identityproviders_generic: #{e}"
+end
+```
+
+### Parameters
+This endpoint does not need any parameter.
+{: class="table table-striped"}
+
+
+### Return type
+
+[**Empty**](Empty.html)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
 <a name="delete_identityproviders_gsuite"></a>
 
 ## [**Empty**](Empty.html) delete_identityproviders_gsuite
@@ -808,6 +870,65 @@ This endpoint does not need any parameter.
 
 
 
+<a name="get_identityproviders_generic"></a>
+
+## [**GenericSAML**](GenericSAML.html) get_identityproviders_generic
+
+
+
+Get Generic SAML Identity Provider
+
+
+
+Wraps GET /api/v2/identityproviders/generic 
+
+Requires ANY permissions: 
+
+* sso:provider: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::IdentityProviderApi.new
+
+begin
+  #Get Generic SAML Identity Provider
+  result = api_instance.get_identityproviders_generic
+  p result
+rescue PureCloud::ApiError => e
+  puts "Exception when calling IdentityProviderApi->get_identityproviders_generic: #{e}"
+end
+```
+
+### Parameters
+This endpoint does not need any parameter.
+{: class="table table-striped"}
+
+
+### Return type
+
+[**GenericSAML**](GenericSAML.html)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
 <a name="get_identityproviders_gsuite"></a>
 
 ## [**GSuite**](GSuite.html) get_identityproviders_gsuite
@@ -1412,6 +1533,72 @@ Name | Type | Description  | Notes
 
 
 
+<a name="put_identityproviders_generic"></a>
+
+## [**OAuthProvider**](OAuthProvider.html) put_identityproviders_generic(body)
+
+
+
+Update/Create Generic SAML Identity Provider
+
+
+
+Wraps PUT /api/v2/identityproviders/generic 
+
+Requires ANY permissions: 
+
+* sso:provider:add
+* sso:provider:edit
+
+
+### 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::IdentityProviderApi.new
+
+body = PureCloud::GenericSAML.new # GenericSAML | Provider
+
+
+begin
+  #Update/Create Generic SAML Identity Provider
+  result = api_instance.put_identityproviders_generic(body)
+  p result
+rescue PureCloud::ApiError => e
+  puts "Exception when calling IdentityProviderApi->put_identityproviders_generic: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **body** | [**GenericSAML**](GenericSAML.html)| Provider |  |
+{: class="table table-striped"}
+
+
+### Return type
+
+[**OAuthProvider**](OAuthProvider.html)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
 <a name="put_identityproviders_gsuite"></a>
 
 ## [**OAuthProvider**](OAuthProvider.html) put_identityproviders_gsuite(body)

data/docs/IpAddressAuthentication.md

@@ -0,0 +1,13 @@
+---
+title: IpAddressAuthentication
+---
+## PureCloud::IpAddressAuthentication
+
+## Properties
+
+|Name | Type | Description | Notes|
+|------------ | ------------- | ------------- | -------------|
+| **network_whitelist** | **Array<String>** |  | [optional] |
+{: class="table table-striped"}
+
+

data/docs/KnowledgeSearchResponse.md

@@ -7,11 +7,11 @@ title: KnowledgeSearchResponse
 
 |Name | Type | Description | Notes|
 |------------ | ------------- | ------------- | -------------|
+| **search_id** | **String** | Search Id | [optional] |
 | **total** | **Integer** | Total number of records returned | [optional] |
 | **page_count** | **Integer** | Number of pages returned in the result calculated according to the pageSize and the total | [optional] |
 | **page_size** | **Integer** | Number of records according to the page size | [optional] |
 | **page_number** | **Integer** | Current page number for the returned records | [optional] |
-| **search_id** | **String** | ID of the Search Response | [optional] |
 | **results** | [**Array<KnowledgeSearchDocument>**](KnowledgeSearchDocument.html) | Results associated to the search response | [optional] |
 {: class="table table-striped"}
 

data/docs/NluDomainVersion.md

@@ -16,6 +16,7 @@ title: NluDomainVersion
 | **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/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)