Package com.mypurecloud.sdk.v2.api

Class UsageApi

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

  • Constructor Details

    • UsageApi

      public UsageApi()

    • UsageApi

      public UsageApi(ApiClient apiClient)

  • Method Details

    • getOauthClientUsageQueryResult

      public ApiUsageQueryResult getOauthClientUsageQueryResult(String executionId, String clientId) throws IOException, ApiException
      Get the results of a usage query
      Parameters:
      executionId - ID of the query execution (required)
      clientId - Client ID (required)
      Returns:
      ApiUsageQueryResult
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getOauthClientUsageQueryResultWithHttpInfo

      public ApiResponse<ApiUsageQueryResult> getOauthClientUsageQueryResultWithHttpInfo(String executionId, String clientId) throws IOException
      Get the results of a usage query
      Parameters:
      executionId - ID of the query execution (required)
      clientId - Client ID (required)
      Returns:
      ApiUsageQueryResult
      Throws:
      IOException - if the request fails to be processed

    • getOauthClientUsageQueryResult

      public ApiUsageQueryResult getOauthClientUsageQueryResult(GetOauthClientUsageQueryResultRequest request) throws IOException, ApiException
      Get the results of a usage query
      Parameters:
      request - The request object
      Returns:
      ApiUsageQueryResult
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getOauthClientUsageQueryResult

      public ApiResponse<ApiUsageQueryResult> getOauthClientUsageQueryResult(ApiRequest<Void> request) throws IOException
      Get the results of a usage query
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • getOauthClientUsageSummary

      public UsageExecutionResult getOauthClientUsageSummary(String clientId, String days) throws IOException, ApiException
      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:
      clientId - Client ID (required)
      days - Previous number of days to query (optional, default to 7)
      Returns:
      UsageExecutionResult
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getOauthClientUsageSummaryWithHttpInfo

      public ApiResponse<UsageExecutionResult> getOauthClientUsageSummaryWithHttpInfo(String clientId, String days) throws IOException
      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:
      clientId - Client ID (required)
      days - Previous number of days to query (optional, default to 7)
      Returns:
      UsageExecutionResult
      Throws:
      IOException - if the request fails to be processed

    • getOauthClientUsageSummary

      public UsageExecutionResult getOauthClientUsageSummary(GetOauthClientUsageSummaryRequest request) throws IOException, ApiException
      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
      Returns:
      UsageExecutionResult
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getOauthClientUsageSummary

      public ApiResponse<UsageExecutionResult> getOauthClientUsageSummary(ApiRequest<Void> request) throws IOException
      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
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • getUsageAggregatesQueryJob

      public OrganizationPublicApiUsageResultsResponse getUsageAggregatesQueryJob(String jobId, Integer pageSize, String after) throws IOException, ApiException
      Get the status and results of the usage query
      Parameters:
      jobId - jobId (required)
      pageSize - Page size of the results. Max is 1000. (optional, default to 100)
      after - The cursor that points to the end of the set of entities that has been returned. (optional)
      Returns:
      OrganizationPublicApiUsageResultsResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getUsageAggregatesQueryJobWithHttpInfo

      public ApiResponse<OrganizationPublicApiUsageResultsResponse> getUsageAggregatesQueryJobWithHttpInfo(String jobId, Integer pageSize, String after) throws IOException
      Get the status and results of the usage query
      Parameters:
      jobId - jobId (required)
      pageSize - Page size of the results. Max is 1000. (optional, default to 100)
      after - The cursor that points to the end of the set of entities that has been returned. (optional)
      Returns:
      OrganizationPublicApiUsageResultsResponse
      Throws:
      IOException - if the request fails to be processed

    • getUsageAggregatesQueryJob

      public OrganizationPublicApiUsageResultsResponse getUsageAggregatesQueryJob(GetUsageAggregatesQueryJobRequest request) throws IOException, ApiException
      Get the status and results of the usage query
      Parameters:
      request - The request object
      Returns:
      OrganizationPublicApiUsageResultsResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getUsageAggregatesQueryJob

      public ApiResponse<OrganizationPublicApiUsageResultsResponse> getUsageAggregatesQueryJob(ApiRequest<Void> request) throws IOException
      Get the status and results of the usage query
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • getUsageClientClientIdAggregatesQueryJob

      public ClientPublicApiUsageResultsResponse getUsageClientClientIdAggregatesQueryJob(String clientId, String jobId, Integer pageSize, String after) throws IOException, ApiException
      Get the status and results of the usage query
      Parameters:
      clientId - clientId (required)
      jobId - jobId (required)
      pageSize - Page size of the results. Max is 1000. (optional, default to 100)
      after - The cursor that points to the end of the set of entities that has been returned. (optional)
      Returns:
      ClientPublicApiUsageResultsResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getUsageClientClientIdAggregatesQueryJobWithHttpInfo

      public ApiResponse<ClientPublicApiUsageResultsResponse> getUsageClientClientIdAggregatesQueryJobWithHttpInfo(String clientId, String jobId, Integer pageSize, String after) throws IOException
      Get the status and results of the usage query
      Parameters:
      clientId - clientId (required)
      jobId - jobId (required)
      pageSize - Page size of the results. Max is 1000. (optional, default to 100)
      after - The cursor that points to the end of the set of entities that has been returned. (optional)
      Returns:
      ClientPublicApiUsageResultsResponse
      Throws:
      IOException - if the request fails to be processed

    • getUsageClientClientIdAggregatesQueryJob

      public ClientPublicApiUsageResultsResponse getUsageClientClientIdAggregatesQueryJob(GetUsageClientClientIdAggregatesQueryJobRequest request) throws IOException, ApiException
      Get the status and results of the usage query
      Parameters:
      request - The request object
      Returns:
      ClientPublicApiUsageResultsResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getUsageClientClientIdAggregatesQueryJob

      public ApiResponse<ClientPublicApiUsageResultsResponse> getUsageClientClientIdAggregatesQueryJob(ApiRequest<Void> request) throws IOException
      Get the status and results of the usage query
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • getUsageQueryExecutionIdResults

      public ApiUsageQueryResult getUsageQueryExecutionIdResults(String executionId) throws IOException, ApiException
      Get the results of a usage query
      Parameters:
      executionId - ID of the query execution (required)
      Returns:
      ApiUsageQueryResult
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getUsageQueryExecutionIdResultsWithHttpInfo

      public ApiResponse<ApiUsageQueryResult> getUsageQueryExecutionIdResultsWithHttpInfo(String executionId) throws IOException
      Get the results of a usage query
      Parameters:
      executionId - ID of the query execution (required)
      Returns:
      ApiUsageQueryResult
      Throws:
      IOException - if the request fails to be processed

    • getUsageQueryExecutionIdResults

      public ApiUsageQueryResult getUsageQueryExecutionIdResults(GetUsageQueryExecutionIdResultsRequest request) throws IOException, ApiException
      Get the results of a usage query
      Parameters:
      request - The request object
      Returns:
      ApiUsageQueryResult
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getUsageQueryExecutionIdResults

      public ApiResponse<ApiUsageQueryResult> getUsageQueryExecutionIdResults(ApiRequest<Void> request) throws IOException
      Get the results of a usage query
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • getUsageSimplesearchExecutionIdResults

      public ApiUsageQueryResult getUsageSimplesearchExecutionIdResults(String executionId, String after, Integer pageSize) throws IOException, ApiException
      Get the results of a usage search. Number of records to be returned is limited to 20,000 results.
      Parameters:
      executionId - ID of the search execution (required)
      after - The cursor that points to the end of the set of entities that has been returned (optional)
      pageSize - The max number of entities to be returned per request. Maximum page size of 1000 (optional)
      Returns:
      ApiUsageQueryResult
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getUsageSimplesearchExecutionIdResultsWithHttpInfo

      public ApiResponse<ApiUsageQueryResult> getUsageSimplesearchExecutionIdResultsWithHttpInfo(String executionId, String after, Integer pageSize) throws IOException
      Get the results of a usage search. Number of records to be returned is limited to 20,000 results.
      Parameters:
      executionId - ID of the search execution (required)
      after - The cursor that points to the end of the set of entities that has been returned (optional)
      pageSize - The max number of entities to be returned per request. Maximum page size of 1000 (optional)
      Returns:
      ApiUsageQueryResult
      Throws:
      IOException - if the request fails to be processed

    • getUsageSimplesearchExecutionIdResults

      public ApiUsageQueryResult getUsageSimplesearchExecutionIdResults(GetUsageSimplesearchExecutionIdResultsRequest request) throws IOException, ApiException
      Get the results of a usage search. Number of records to be returned is limited to 20,000 results.
      Parameters:
      request - The request object
      Returns:
      ApiUsageQueryResult
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getUsageSimplesearchExecutionIdResults

      public ApiResponse<ApiUsageQueryResult> getUsageSimplesearchExecutionIdResults(ApiRequest<Void> request) throws IOException
      Get the results of a usage search. Number of records to be returned is limited to 20,000 results.
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • postOauthClientUsageQuery

      public UsageExecutionResult postOauthClientUsageQuery(String clientId, ApiUsageClientQuery body) throws IOException, ApiException
      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:
      clientId - Client ID (required)
      body - Query (required)
      Returns:
      UsageExecutionResult
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • postOauthClientUsageQueryWithHttpInfo

      public ApiResponse<UsageExecutionResult> postOauthClientUsageQueryWithHttpInfo(String clientId, ApiUsageClientQuery body) throws IOException
      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:
      clientId - Client ID (required)
      body - Query (required)
      Returns:
      UsageExecutionResult
      Throws:
      IOException - if the request fails to be processed

    • postOauthClientUsageQuery

      public UsageExecutionResult postOauthClientUsageQuery(PostOauthClientUsageQueryRequest request) throws IOException, ApiException
      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
      Returns:
      UsageExecutionResult
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • postOauthClientUsageQuery

      public ApiResponse<UsageExecutionResult> postOauthClientUsageQuery(ApiRequest<ApiUsageClientQuery> request) throws IOException
      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
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • postUsageAggregatesQueryJobs

      public OrganizationUsageQueryResponse postUsageAggregatesQueryJobs(OrganizationPublicApiUsageQueryRequest body) throws IOException, ApiException
      Query your organization's public api usage. After calling this method, you will need to save the queryExecutionId from the response and use it in a call to the results endpoint to get the results
      Parameters:
      body - Query (required)
      Returns:
      OrganizationUsageQueryResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • postUsageAggregatesQueryJobsWithHttpInfo

      public ApiResponse<OrganizationUsageQueryResponse> postUsageAggregatesQueryJobsWithHttpInfo(OrganizationPublicApiUsageQueryRequest body) throws IOException
      Query your organization's public api usage. After calling this method, you will need to save the queryExecutionId from the response and use it in a call to the results endpoint to get the results
      Parameters:
      body - Query (required)
      Returns:
      OrganizationUsageQueryResponse
      Throws:
      IOException - if the request fails to be processed

    • postUsageAggregatesQueryJobs

      public OrganizationUsageQueryResponse postUsageAggregatesQueryJobs(PostUsageAggregatesQueryJobsRequest request) throws IOException, ApiException
      Query your organization's public api usage. After calling this method, you will need to save the queryExecutionId from the response and use it in a call to the results endpoint to get the results
      Parameters:
      request - The request object
      Returns:
      OrganizationUsageQueryResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • postUsageAggregatesQueryJobs

      public ApiResponse<OrganizationUsageQueryResponse> postUsageAggregatesQueryJobs(ApiRequest<OrganizationPublicApiUsageQueryRequest> request) throws IOException
      Query your organization's public api usage. After calling this method, you will need to save the queryExecutionId from the response and use it in a call to the results endpoint to get the results
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • postUsageClientClientIdAggregatesQueryJobs

      public ClientUsageQueryResponse postUsageClientClientIdAggregatesQueryJobs(String clientId, ClientPublicApiUsageQueryRequest body) throws IOException, ApiException
      Query your client's public api usage. After calling this method, you will need to save the queryExecutionId from the response and use it in a call to the results endpoint to get the results
      Parameters:
      clientId - clientId (required)
      body - Query (required)
      Returns:
      ClientUsageQueryResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • postUsageClientClientIdAggregatesQueryJobsWithHttpInfo

      public ApiResponse<ClientUsageQueryResponse> postUsageClientClientIdAggregatesQueryJobsWithHttpInfo(String clientId, ClientPublicApiUsageQueryRequest body) throws IOException
      Query your client's public api usage. After calling this method, you will need to save the queryExecutionId from the response and use it in a call to the results endpoint to get the results
      Parameters:
      clientId - clientId (required)
      body - Query (required)
      Returns:
      ClientUsageQueryResponse
      Throws:
      IOException - if the request fails to be processed

    • postUsageClientClientIdAggregatesQueryJobs

      public ClientUsageQueryResponse postUsageClientClientIdAggregatesQueryJobs(PostUsageClientClientIdAggregatesQueryJobsRequest request) throws IOException, ApiException
      Query your client's public api usage. After calling this method, you will need to save the queryExecutionId from the response and use it in a call to the results endpoint to get the results
      Parameters:
      request - The request object
      Returns:
      ClientUsageQueryResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • postUsageClientClientIdAggregatesQueryJobs

      public ApiResponse<ClientUsageQueryResponse> postUsageClientClientIdAggregatesQueryJobs(ApiRequest<ClientPublicApiUsageQueryRequest> request) throws IOException
      Query your client's public api usage. After calling this method, you will need to save the queryExecutionId from the response and use it in a call to the results endpoint to get the results
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • postUsageQuery

      public UsageExecutionResult postUsageQuery(ApiUsageOrganizationQuery body) throws IOException, ApiException
      Query organization API Usage - After calling this method, you will then need to poll for the query results based on the returned execution Id
      Parameters:
      body - Query (required)
      Returns:
      UsageExecutionResult
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • postUsageQueryWithHttpInfo

      public ApiResponse<UsageExecutionResult> postUsageQueryWithHttpInfo(ApiUsageOrganizationQuery body) throws IOException
      Query organization API Usage - After calling this method, you will then need to poll for the query results based on the returned execution Id
      Parameters:
      body - Query (required)
      Returns:
      UsageExecutionResult
      Throws:
      IOException - if the request fails to be processed

    • postUsageQuery

      public UsageExecutionResult postUsageQuery(PostUsageQueryRequest request) throws IOException, ApiException
      Query organization 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
      Returns:
      UsageExecutionResult
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • postUsageQuery

      public ApiResponse<UsageExecutionResult> postUsageQuery(ApiRequest<ApiUsageOrganizationQuery> request) throws IOException
      Query organization 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
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • postUsageSimplesearch

      public UsageExecutionResult postUsageSimplesearch(ApiUsageSimpleSearch body) throws IOException, ApiException
      Search organization API Usage After calling this method, you will then need to poll for the query results based on the returned execution Id. The number of records is limited to 20,000 results
      Parameters:
      body - SimpleSearch (required)
      Returns:
      UsageExecutionResult
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • postUsageSimplesearchWithHttpInfo

      public ApiResponse<UsageExecutionResult> postUsageSimplesearchWithHttpInfo(ApiUsageSimpleSearch body) throws IOException
      Search organization API Usage After calling this method, you will then need to poll for the query results based on the returned execution Id. The number of records is limited to 20,000 results
      Parameters:
      body - SimpleSearch (required)
      Returns:
      UsageExecutionResult
      Throws:
      IOException - if the request fails to be processed

    • postUsageSimplesearch

      public UsageExecutionResult postUsageSimplesearch(PostUsageSimplesearchRequest request) throws IOException, ApiException
      Search organization API Usage After calling this method, you will then need to poll for the query results based on the returned execution Id. The number of records is limited to 20,000 results
      Parameters:
      request - The request object
      Returns:
      UsageExecutionResult
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • postUsageSimplesearch

      public ApiResponse<UsageExecutionResult> postUsageSimplesearch(ApiRequest<ApiUsageSimpleSearch> request) throws IOException
      Search organization API Usage After calling this method, you will then need to poll for the query results based on the returned execution Id. The number of records is limited to 20,000 results
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed