Package com.mypurecloud.sdk.v2.api

Class OAuthApiAsync

java.lang.Object
com.mypurecloud.sdk.v2.api.OAuthApiAsync
public class OAuthApiAsync extends Object

  • Constructor Details

    • OAuthApiAsync

      public OAuthApiAsync()

    • OAuthApiAsync

      public OAuthApiAsync(ApiClient apiClient)

  • Method Details

    • deleteOauthClientAsync

      public Future<Void> deleteOauthClientAsync(DeleteOauthClientRequest request, AsyncApiCallback<Void> callback)
      Delete OAuth Client
      Parameters:
      request - the request object
      callback - the action to perform when the request is completed
      Returns:
      the future indication when the request has completed

    • deleteOauthClientAsync

      public Future<ApiResponse<Void>> deleteOauthClientAsync(ApiRequest<Void> request, AsyncApiCallback<ApiResponse<Void>> callback)
      Delete OAuth Client
      Parameters:
      request - the request object
      callback - the action to perform when the request is completed
      Returns:
      the future indication when the request has completed

    • getOauthAuthorizationAsync

      public Future<OAuthAuthorization> getOauthAuthorizationAsync(GetOauthAuthorizationRequest request, AsyncApiCallback<OAuthAuthorization> callback)
      Get a client that is authorized by the resource owner
      Parameters:
      request - the request object
      callback - the action to perform when the request is completed
      Returns:
      the future indication when the request has completed

    • getOauthAuthorizationAsync

      public Future<ApiResponse<OAuthAuthorization>> getOauthAuthorizationAsync(ApiRequest<Void> request, AsyncApiCallback<ApiResponse<OAuthAuthorization>> callback)
      Get a client that is authorized by the resource owner
      Parameters:
      request - the request object
      callback - the action to perform when the request is completed
      Returns:
      the future indication when the request has completed

    • getOauthAuthorizationsAsync

      public Future<OAuthAuthorizationListing> getOauthAuthorizationsAsync(GetOauthAuthorizationsRequest request, AsyncApiCallback<OAuthAuthorizationListing> callback)
      List clients that have been authorized, requested, or revoked by the resource owner
      Parameters:
      request - the request object
      callback - the action to perform when the request is completed
      Returns:
      the future indication when the request has completed

    • getOauthAuthorizationsAsync

      public Future<ApiResponse<OAuthAuthorizationListing>> getOauthAuthorizationsAsync(ApiRequest<Void> request, AsyncApiCallback<ApiResponse<OAuthAuthorizationListing>> callback)
      List clients that have been authorized, requested, or revoked by the resource owner
      Parameters:
      request - the request object
      callback - the action to perform when the request is completed
      Returns:
      the future indication when the request has completed

    • getOauthClientAsync

      public Future<OAuthClient> getOauthClientAsync(GetOauthClientRequest request, AsyncApiCallback<OAuthClient> callback)
      Get OAuth Client
      Parameters:
      request - the request object
      callback - the action to perform when the request is completed
      Returns:
      the future indication when the request has completed

    • getOauthClientAsync

      public Future<ApiResponse<OAuthClient>> getOauthClientAsync(ApiRequest<Void> request, AsyncApiCallback<ApiResponse<OAuthClient>> callback)
      Get OAuth Client
      Parameters:
      request - the request object
      callback - the action to perform when the request is completed
      Returns:
      the future indication when the request has completed

    • getOauthClientUsageQueryResultAsync

      public Future<ApiUsageQueryResult> getOauthClientUsageQueryResultAsync(GetOauthClientUsageQueryResultRequest request, AsyncApiCallback<ApiUsageQueryResult> callback)
      Get the results of a usage query
      Parameters:
      request - the request object
      callback - the action to perform when the request is completed
      Returns:
      the future indication when the request has completed

    • getOauthClientUsageQueryResultAsync

      public Future<ApiResponse<ApiUsageQueryResult>> getOauthClientUsageQueryResultAsync(ApiRequest<Void> request, AsyncApiCallback<ApiResponse<ApiUsageQueryResult>> callback)
      Get the results of a usage query
      Parameters:
      request - the request object
      callback - the action to perform when the request is completed
      Returns:
      the future indication when the request has completed

    • getOauthClientUsageSummaryAsync

      public Future<UsageExecutionResult> getOauthClientUsageSummaryAsync(GetOauthClientUsageSummaryRequest request, AsyncApiCallback<UsageExecutionResult> callback)
      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
      Parameters:
      request - the request object
      callback - the action to perform when the request is completed
      Returns:
      the future indication when the request has completed

    • getOauthClientUsageSummaryAsync

      public Future<ApiResponse<UsageExecutionResult>> getOauthClientUsageSummaryAsync(ApiRequest<Void> request, AsyncApiCallback<ApiResponse<UsageExecutionResult>> callback)
      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
      Parameters:
      request - the request object
      callback - the action to perform when the request is completed
      Returns:
      the future indication when the request has completed

    • getOauthClientsAsync

      public Future<OAuthClientEntityListing> getOauthClientsAsync(GetOauthClientsRequest request, AsyncApiCallback<OAuthClientEntityListing> callback)
      The list of OAuth clients
      Parameters:
      request - the request object
      callback - the action to perform when the request is completed
      Returns:
      the future indication when the request has completed

    • getOauthClientsAsync

      public Future<ApiResponse<OAuthClientEntityListing>> getOauthClientsAsync(ApiRequest<Void> request, AsyncApiCallback<ApiResponse<OAuthClientEntityListing>> callback)
      The list of OAuth clients
      Parameters:
      request - the request object
      callback - the action to perform when the request is completed
      Returns:
      the future indication when the request has completed

    • getOauthScopeAsync

      public Future<OAuthScope> getOauthScopeAsync(GetOauthScopeRequest request, AsyncApiCallback<OAuthScope> callback)
      An OAuth scope
      Parameters:
      request - the request object
      callback - the action to perform when the request is completed
      Returns:
      the future indication when the request has completed

    • getOauthScopeAsync

      public Future<ApiResponse<OAuthScope>> getOauthScopeAsync(ApiRequest<Void> request, AsyncApiCallback<ApiResponse<OAuthScope>> callback)
      An OAuth scope
      Parameters:
      request - the request object
      callback - the action to perform when the request is completed
      Returns:
      the future indication when the request has completed

    • getOauthScopesAsync

      public Future<OAuthScopeListing> getOauthScopesAsync(GetOauthScopesRequest request, AsyncApiCallback<OAuthScopeListing> callback)
      The list of OAuth scopes
      Parameters:
      request - the request object
      callback - the action to perform when the request is completed
      Returns:
      the future indication when the request has completed

    • getOauthScopesAsync

      public Future<ApiResponse<OAuthScopeListing>> getOauthScopesAsync(ApiRequest<Void> request, AsyncApiCallback<ApiResponse<OAuthScopeListing>> callback)
      The list of OAuth scopes
      Parameters:
      request - the request object
      callback - the action to perform when the request is completed
      Returns:
      the future indication when the request has completed

    • postOauthClientSecretAsync

      public Future<OAuthClient> postOauthClientSecretAsync(PostOauthClientSecretRequest request, AsyncApiCallback<OAuthClient> callback)
      Regenerate Client Secret This operation will set the client secret to a randomly generated cryptographically random value. All clients must be updated with the new secret. This operation should be used with caution.
      Parameters:
      request - the request object
      callback - the action to perform when the request is completed
      Returns:
      the future indication when the request has completed

    • postOauthClientSecretAsync

      public Future<ApiResponse<OAuthClient>> postOauthClientSecretAsync(ApiRequest<Void> request, AsyncApiCallback<ApiResponse<OAuthClient>> callback)
      Regenerate Client Secret This operation will set the client secret to a randomly generated cryptographically random value. All clients must be updated with the new secret. This operation should be used with caution.
      Parameters:
      request - the request object
      callback - the action to perform when the request is completed
      Returns:
      the future indication when the request has completed

    • postOauthClientUsageQueryAsync

      public Future<UsageExecutionResult> postOauthClientUsageQueryAsync(PostOauthClientUsageQueryRequest request, AsyncApiCallback<UsageExecutionResult> callback)
      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
      Parameters:
      request - the request object
      callback - the action to perform when the request is completed
      Returns:
      the future indication when the request has completed

    • postOauthClientUsageQueryAsync

      public Future<ApiResponse<UsageExecutionResult>> postOauthClientUsageQueryAsync(ApiRequest<ApiUsageClientQuery> request, AsyncApiCallback<ApiResponse<UsageExecutionResult>> callback)
      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
      Parameters:
      request - the request object
      callback - the action to perform when the request is completed
      Returns:
      the future indication when the request has completed

    • postOauthClientsAsync

      public Future<OAuthClient> postOauthClientsAsync(PostOauthClientsRequest request, AsyncApiCallback<OAuthClient> callback)
      Create OAuth client The OAuth Grant/Client is required in order to create an authentication token and gain access to PureCloud. The preferred authorizedGrantTypes is 'CODE' which requires applications to send a client ID and client secret. This is typically a web server. If the client is unable to secure the client secret then the 'TOKEN' grant type aka IMPLICIT should be used. This is would be for browser or mobile apps. If a client is to be used outside of the context of a user then the 'CLIENT-CREDENTIALS' grant may be used. In this case the client must be granted roles via the 'roleIds' field.
      Parameters:
      request - the request object
      callback - the action to perform when the request is completed
      Returns:
      the future indication when the request has completed

    • postOauthClientsAsync

      public Future<ApiResponse<OAuthClient>> postOauthClientsAsync(ApiRequest<OAuthClientRequest> request, AsyncApiCallback<ApiResponse<OAuthClient>> callback)
      Create OAuth client The OAuth Grant/Client is required in order to create an authentication token and gain access to PureCloud. The preferred authorizedGrantTypes is 'CODE' which requires applications to send a client ID and client secret. This is typically a web server. If the client is unable to secure the client secret then the 'TOKEN' grant type aka IMPLICIT should be used. This is would be for browser or mobile apps. If a client is to be used outside of the context of a user then the 'CLIENT-CREDENTIALS' grant may be used. In this case the client must be granted roles via the 'roleIds' field.
      Parameters:
      request - the request object
      callback - the action to perform when the request is completed
      Returns:
      the future indication when the request has completed

    • putOauthClientAsync

      public Future<OAuthClient> putOauthClientAsync(PutOauthClientRequest request, AsyncApiCallback<OAuthClient> callback)
      Update OAuth Client
      Parameters:
      request - the request object
      callback - the action to perform when the request is completed
      Returns:
      the future indication when the request has completed

    • putOauthClientAsync

      public Future<ApiResponse<OAuthClient>> putOauthClientAsync(ApiRequest<OAuthClientRequest> request, AsyncApiCallback<ApiResponse<OAuthClient>> callback)
      Update OAuth Client
      Parameters:
      request - the request object
      callback - the action to perform when the request is completed
      Returns:
      the future indication when the request has completed