purecloudplatformclientv2 71.0.0 → 72.0.0

data/docs/LogicalInterfaceEntityListing.md

@@ -12,10 +12,10 @@ title: LogicalInterfaceEntityListing
 | **page_number** | **Integer** |  | [optional] |
 | **total** | **Integer** |  | [optional] |
 | **first_uri** | **String** |  | [optional] |
-| **self_uri** | **String** |  | [optional] |
-| **next_uri** | **String** |  | [optional] |
-| **last_uri** | **String** |  | [optional] |
 | **previous_uri** | **String** |  | [optional] |
+| **last_uri** | **String** |  | [optional] |
+| **next_uri** | **String** |  | [optional] |
+| **self_uri** | **String** |  | [optional] |
 | **page_count** | **Integer** |  | [optional] |
 {: class="table table-striped"}
 

data/docs/ManagementUnitListing.md

@@ -12,10 +12,10 @@ title: ManagementUnitListing
 | **page_number** | **Integer** |  | [optional] |
 | **total** | **Integer** |  | [optional] |
 | **first_uri** | **String** |  | [optional] |
-| **self_uri** | **String** |  | [optional] |
-| **next_uri** | **String** |  | [optional] |
-| **last_uri** | **String** |  | [optional] |
 | **previous_uri** | **String** |  | [optional] |
+| **last_uri** | **String** |  | [optional] |
+| **next_uri** | **String** |  | [optional] |
+| **self_uri** | **String** |  | [optional] |
 | **page_count** | **Integer** |  | [optional] |
 {: class="table table-striped"}
 

data/docs/MessageConversationEntityListing.md

@@ -12,10 +12,10 @@ title: MessageConversationEntityListing
 | **page_number** | **Integer** |  | [optional] |
 | **total** | **Integer** |  | [optional] |
 | **first_uri** | **String** |  | [optional] |
-| **self_uri** | **String** |  | [optional] |
-| **next_uri** | **String** |  | [optional] |
-| **last_uri** | **String** |  | [optional] |
 | **previous_uri** | **String** |  | [optional] |
+| **last_uri** | **String** |  | [optional] |
+| **next_uri** | **String** |  | [optional] |
+| **self_uri** | **String** |  | [optional] |
 | **page_count** | **Integer** |  | [optional] |
 {: class="table table-striped"}
 

data/docs/MessagingIntegrationEntityListing.md

@@ -12,10 +12,10 @@ title: MessagingIntegrationEntityListing
 | **page_number** | **Integer** |  | [optional] |
 | **total** | **Integer** |  | [optional] |
 | **first_uri** | **String** |  | [optional] |
-| **self_uri** | **String** |  | [optional] |
-| **next_uri** | **String** |  | [optional] |
-| **last_uri** | **String** |  | [optional] |
 | **previous_uri** | **String** |  | [optional] |
+| **last_uri** | **String** |  | [optional] |
+| **next_uri** | **String** |  | [optional] |
+| **self_uri** | **String** |  | [optional] |
 | **page_count** | **Integer** |  | [optional] |
 {: class="table table-striped"}
 

data/docs/MessagingStickerEntityListing.md

@@ -12,10 +12,10 @@ title: MessagingStickerEntityListing
 | **page_number** | **Integer** |  | [optional] |
 | **total** | **Integer** |  | [optional] |
 | **first_uri** | **String** |  | [optional] |
-| **self_uri** | **String** |  | [optional] |
-| **next_uri** | **String** |  | [optional] |
-| **last_uri** | **String** |  | [optional] |
 | **previous_uri** | **String** |  | [optional] |
+| **last_uri** | **String** |  | [optional] |
+| **next_uri** | **String** |  | [optional] |
+| **self_uri** | **String** |  | [optional] |
 | **page_count** | **Integer** |  | [optional] |
 {: class="table table-striped"}
 

data/docs/NoteListing.md

@@ -12,10 +12,10 @@ title: NoteListing
 | **page_number** | **Integer** |  | [optional] |
 | **total** | **Integer** |  | [optional] |
 | **first_uri** | **String** |  | [optional] |
-| **self_uri** | **String** |  | [optional] |
-| **next_uri** | **String** |  | [optional] |
-| **last_uri** | **String** |  | [optional] |
 | **previous_uri** | **String** |  | [optional] |
+| **last_uri** | **String** |  | [optional] |
+| **next_uri** | **String** |  | [optional] |
+| **self_uri** | **String** |  | [optional] |
 | **page_count** | **Integer** |  | [optional] |
 {: class="table table-striped"}
 

data/docs/OAuthApi.md

@@ -9,8 +9,12 @@ All URIs are relative to *https://api.mypurecloud.com*
 Method | Description
 ------------- | ------------- | -------------
 [**delete_oauth_client**](OAuthApi.html#delete_oauth_client) | Delete OAuth Client
+[**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_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_clients**](OAuthApi.html#post_oauth_clients) | Create OAuth client
 [**put_oauth_client**](OAuthApi.html#put_oauth_client) | Update OAuth Client
@@ -80,6 +84,130 @@ nil (empty response body)
 
 
 
+<a name="get_oauth_authorization"></a>
+
+## [**OAuthAuthorization**](OAuthAuthorization.html) get_oauth_authorization(client_id)
+
+
+
+Get a client that is authorized by the resource owner
+
+
+
+Wraps GET /api/v2/oauth/authorizations/{clientId} 
+
+Requires ANY permissions: 
+
+* oauth:client:authorize
+
+
+### 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 | The ID of client
+
+
+begin
+  #Get a client that is authorized by the resource owner
+  result = api_instance.get_oauth_authorization(client_id)
+  p result
+rescue PureCloud::ApiError => e
+  puts "Exception when calling OAuthApi->get_oauth_authorization: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **client_id** | **String**| The ID of client |  |
+{: class="table table-striped"}
+
+
+### Return type
+
+[**OAuthAuthorization**](OAuthAuthorization.html)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+<a name="get_oauth_authorizations"></a>
+
+## [**OAuthAuthorizationListing**](OAuthAuthorizationListing.html) get_oauth_authorizations
+
+
+
+List clients that are authorized by the resource owner
+
+
+
+Wraps GET /api/v2/oauth/authorizations 
+
+Requires ANY permissions: 
+
+* oauth:client:authorize
+
+
+### 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
+
+begin
+  #List clients that are authorized by the resource owner
+  result = api_instance.get_oauth_authorizations
+  p result
+rescue PureCloud::ApiError => e
+  puts "Exception when calling OAuthApi->get_oauth_authorizations: #{e}"
+end
+```
+
+### Parameters
+This endpoint does not need any parameter.
+{: class="table table-striped"}
+
+
+### Return type
+
+[**OAuthAuthorizationListing**](OAuthAuthorizationListing.html)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
 <a name="get_oauth_client"></a>
 
 ## [**OAuthClient**](OAuthClient.html) get_oauth_client(client_id)
@@ -204,6 +332,139 @@ This endpoint does not need any parameter.
 
 
 
+<a name="get_oauth_scope"></a>
+
+## [**OAuthScope**](OAuthScope.html) get_oauth_scope(scope_id, opts)
+
+
+
+An OAuth scope
+
+
+
+Wraps GET /api/v2/oauth/scopes/{scopeId} 
+
+Requires NO permissions: 
+
+
+
+### 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
+
+scope_id = "scope_id_example" # String | Scope ID
+
+opts = { 
+  accept_language: "en-us" # String | The language with which to display the scope description.
+}
+
+begin
+  #An OAuth scope
+  result = api_instance.get_oauth_scope(scope_id, opts)
+  p result
+rescue PureCloud::ApiError => e
+  puts "Exception when calling OAuthApi->get_oauth_scope: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **scope_id** | **String**| Scope ID |  |
+ **accept_language** | **String**| The language with which to display the scope description. | [optional] [default to en-us] |
+{: class="table table-striped"}
+
+
+### Return type
+
+[**OAuthScope**](OAuthScope.html)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+<a name="get_oauth_scopes"></a>
+
+## [**OAuthScopeListing**](OAuthScopeListing.html) get_oauth_scopes(opts)
+
+
+
+The list of OAuth scopes
+
+
+
+Wraps GET /api/v2/oauth/scopes 
+
+Requires NO permissions: 
+
+
+
+### 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
+
+opts = { 
+  accept_language: "en-us" # String | The language with which to display the scope descriptions.
+}
+
+begin
+  #The list of OAuth scopes
+  result = api_instance.get_oauth_scopes(opts)
+  p result
+rescue PureCloud::ApiError => e
+  puts "Exception when calling OAuthApi->get_oauth_scopes: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **accept_language** | **String**| The language with which to display the scope descriptions. | [optional] [default to en-us] |
+{: class="table table-striped"}
+
+
+### Return type
+
+[**OAuthScopeListing**](OAuthScopeListing.html)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
 <a name="post_oauth_client_secret"></a>
 
 ## [**OAuthClient**](OAuthClient.html) post_oauth_client_secret(client_id)

data/docs/OAuthAuthorization.md

@@ -0,0 +1,20 @@
+---
+title: OAuthAuthorization
+---
+## PureCloud::OAuthAuthorization
+
+## Properties
+
+|Name | Type | Description | Notes|
+|------------ | ------------- | ------------- | -------------|
+| **client** | [**OAuthClient**](OAuthClient.html) |  | [optional] |
+| **scope** | **Array<String>** |  | [optional] |
+| **resource_owner** | [**DomainEntityRef**](DomainEntityRef.html) |  | [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] |
+| **created_by** | [**DomainEntityRef**](DomainEntityRef.html) |  | [optional] |
+| **modified_by** | [**DomainEntityRef**](DomainEntityRef.html) |  | [optional] |
+| **self_uri** | **String** | The URI for this object | [optional] |
+{: class="table table-striped"}
+
+

data/docs/OAuthAuthorizationListing.md

@@ -0,0 +1,14 @@
+---
+title: OAuthAuthorizationListing
+---
+## PureCloud::OAuthAuthorizationListing
+
+## Properties
+
+|Name | Type | Description | Notes|
+|------------ | ------------- | ------------- | -------------|
+| **entities** | [**Array<OAuthAuthorization>**](OAuthAuthorization.html) |  | [optional] |
+| **self_uri** | **String** |  | [optional] |
+{: class="table table-striped"}
+
+

data/docs/OAuthClientEntityListing.md

@@ -12,10 +12,10 @@ title: OAuthClientEntityListing
 | **page_number** | **Integer** |  | [optional] |
 | **total** | **Integer** |  | [optional] |
 | **first_uri** | **String** |  | [optional] |
-| **self_uri** | **String** |  | [optional] |
-| **next_uri** | **String** |  | [optional] |
-| **last_uri** | **String** |  | [optional] |
 | **previous_uri** | **String** |  | [optional] |
+| **last_uri** | **String** |  | [optional] |
+| **next_uri** | **String** |  | [optional] |
+| **self_uri** | **String** |  | [optional] |
 | **page_count** | **Integer** |  | [optional] |
 {: class="table table-striped"}
 

data/docs/OAuthProviderEntityListing.md

@@ -12,10 +12,10 @@ title: OAuthProviderEntityListing
 | **page_number** | **Integer** |  | [optional] |
 | **total** | **Integer** |  | [optional] |
 | **first_uri** | **String** |  | [optional] |
-| **self_uri** | **String** |  | [optional] |
-| **next_uri** | **String** |  | [optional] |
-| **last_uri** | **String** |  | [optional] |
 | **previous_uri** | **String** |  | [optional] |
+| **last_uri** | **String** |  | [optional] |
+| **next_uri** | **String** |  | [optional] |
+| **self_uri** | **String** |  | [optional] |
 | **page_count** | **Integer** |  | [optional] |
 {: class="table table-striped"}
 

data/docs/OAuthScope.md

@@ -0,0 +1,15 @@
+---
+title: OAuthScope
+---
+## PureCloud::OAuthScope
+
+## Properties
+
+|Name | Type | Description | Notes|
+|------------ | ------------- | ------------- | -------------|
+| **id** | **String** | The globally unique identifier for the object. | [optional] |
+| **description** | **String** |  | [optional] |
+| **self_uri** | **String** | The URI for this object | [optional] |
+{: class="table table-striped"}
+
+