Package com.mypurecloud.sdk.v2.api

Class ObjectsApiAsync

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

  • Constructor Details

    • ObjectsApiAsync

      public ObjectsApiAsync()

    • ObjectsApiAsync

      public ObjectsApiAsync(ApiClient apiClient)

  • Method Details

    • deleteAuthorizationDivisionAsync

      public Future<Void> deleteAuthorizationDivisionAsync(DeleteAuthorizationDivisionRequest request, AsyncApiCallback<Void> callback)
      Delete a division.
      Parameters:
      request - the request object
      callback - the action to perform when the request is completed
      Returns:
      the future indication when the request has completed

    • deleteAuthorizationDivisionAsync

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

    • getAuthorizationDivisionAsync

      public Future<AuthzDivision> getAuthorizationDivisionAsync(GetAuthorizationDivisionRequest request, AsyncApiCallback<AuthzDivision> callback)
      Returns an authorization division.
      Parameters:
      request - the request object
      callback - the action to perform when the request is completed
      Returns:
      the future indication when the request has completed

    • getAuthorizationDivisionAsync

      public Future<ApiResponse<AuthzDivision>> getAuthorizationDivisionAsync(ApiRequest<Void> request, AsyncApiCallback<ApiResponse<AuthzDivision>> callback)
      Returns an authorization division.
      Parameters:
      request - the request object
      callback - the action to perform when the request is completed
      Returns:
      the future indication when the request has completed

    • getAuthorizationDivisionsAsync

      public Future<AuthzDivisionEntityListing> getAuthorizationDivisionsAsync(GetAuthorizationDivisionsRequest request, AsyncApiCallback<AuthzDivisionEntityListing> callback)
      Retrieve a list of all divisions defined for the organization Request specific divisions by id using a query param \"id\", e.g. ?id=5f777167-63be-4c24-ad41-374155d9e28b&id=72e9fb25-c484-488d-9312-7acba82435b3
      Parameters:
      request - the request object
      callback - the action to perform when the request is completed
      Returns:
      the future indication when the request has completed

    • getAuthorizationDivisionsAsync

      public Future<ApiResponse<AuthzDivisionEntityListing>> getAuthorizationDivisionsAsync(ApiRequest<Void> request, AsyncApiCallback<ApiResponse<AuthzDivisionEntityListing>> callback)
      Retrieve a list of all divisions defined for the organization Request specific divisions by id using a query param \"id\", e.g. ?id=5f777167-63be-4c24-ad41-374155d9e28b&id=72e9fb25-c484-488d-9312-7acba82435b3
      Parameters:
      request - the request object
      callback - the action to perform when the request is completed
      Returns:
      the future indication when the request has completed

    • getAuthorizationDivisionsDeletedAsync

      public Future<AuthzDivisionEntityListing> getAuthorizationDivisionsDeletedAsync(GetAuthorizationDivisionsDeletedRequest request, AsyncApiCallback<AuthzDivisionEntityListing> callback)
      Get a list of soft deleted divisions for the org
      Parameters:
      request - the request object
      callback - the action to perform when the request is completed
      Returns:
      the future indication when the request has completed

    • getAuthorizationDivisionsDeletedAsync

      public Future<ApiResponse<AuthzDivisionEntityListing>> getAuthorizationDivisionsDeletedAsync(ApiRequest<Void> request, AsyncApiCallback<ApiResponse<AuthzDivisionEntityListing>> callback)
      Get a list of soft deleted divisions for the org
      Parameters:
      request - the request object
      callback - the action to perform when the request is completed
      Returns:
      the future indication when the request has completed

    • getAuthorizationDivisionsHomeAsync

      public Future<AuthzDivision> getAuthorizationDivisionsHomeAsync(GetAuthorizationDivisionsHomeRequest request, AsyncApiCallback<AuthzDivision> callback)
      Retrieve the home division for the organization. Will not include object counts.
      Parameters:
      request - the request object
      callback - the action to perform when the request is completed
      Returns:
      the future indication when the request has completed

    • getAuthorizationDivisionsHomeAsync

      public Future<ApiResponse<AuthzDivision>> getAuthorizationDivisionsHomeAsync(ApiRequest<Void> request, AsyncApiCallback<ApiResponse<AuthzDivision>> callback)
      Retrieve the home division for the organization. Will not include object counts.
      Parameters:
      request - the request object
      callback - the action to perform when the request is completed
      Returns:
      the future indication when the request has completed

    • getAuthorizationDivisionsLimitAsync

      public Future<Integer> getAuthorizationDivisionsLimitAsync(GetAuthorizationDivisionsLimitRequest request, AsyncApiCallback<Integer> callback)
      Returns the maximum allowed number of divisions.
      Parameters:
      request - the request object
      callback - the action to perform when the request is completed
      Returns:
      the future indication when the request has completed

    • getAuthorizationDivisionsLimitAsync

      public Future<ApiResponse<Integer>> getAuthorizationDivisionsLimitAsync(ApiRequest<Void> request, AsyncApiCallback<ApiResponse<Integer>> callback)
      Returns the maximum allowed number of divisions.
      Parameters:
      request - the request object
      callback - the action to perform when the request is completed
      Returns:
      the future indication when the request has completed

    • getAuthorizationDivisionsQueryAsync

      public Future<AuthzDivisionCursorListing> getAuthorizationDivisionsQueryAsync(GetAuthorizationDivisionsQueryRequest request, AsyncApiCallback<AuthzDivisionCursorListing> callback)
      Retrieve a list of all divisions defined for the organization with cursor Use \"after\" and \"before\" param to fetch next/previous page}
      Parameters:
      request - the request object
      callback - the action to perform when the request is completed
      Returns:
      the future indication when the request has completed

    • getAuthorizationDivisionsQueryAsync

      public Future<ApiResponse<AuthzDivisionCursorListing>> getAuthorizationDivisionsQueryAsync(ApiRequest<Void> request, AsyncApiCallback<ApiResponse<AuthzDivisionCursorListing>> callback)
      Retrieve a list of all divisions defined for the organization with cursor Use \"after\" and \"before\" param to fetch next/previous page}
      Parameters:
      request - the request object
      callback - the action to perform when the request is completed
      Returns:
      the future indication when the request has completed

    • postAuthorizationDivisionObjectAsync

      public Future<Void> postAuthorizationDivisionObjectAsync(PostAuthorizationDivisionObjectRequest request, AsyncApiCallback<Void> callback)
      Assign a list of objects to a division Set the division of a specified list of objects. The objects must all be of the same type, one of: CAMPAIGN, MANAGEMENTUNIT, FLOW, QUEUE, DATATABLES or USER. The body of the request is a list of object IDs, which are expected to be GUIDs, e.g. [\"206ce31f-61ec-40ed-a8b1-be6f06303998\",\"250a754e-f5e4-4f51-800f-a92f09d3bf8c\"]
      Parameters:
      request - the request object
      callback - the action to perform when the request is completed
      Returns:
      the future indication when the request has completed

    • postAuthorizationDivisionObjectAsync

      public Future<ApiResponse<Void>> postAuthorizationDivisionObjectAsync(ApiRequest<List<String>> request, AsyncApiCallback<ApiResponse<Void>> callback)
      Assign a list of objects to a division Set the division of a specified list of objects. The objects must all be of the same type, one of: CAMPAIGN, MANAGEMENTUNIT, FLOW, QUEUE, DATATABLES or USER. The body of the request is a list of object IDs, which are expected to be GUIDs, e.g. [\"206ce31f-61ec-40ed-a8b1-be6f06303998\",\"250a754e-f5e4-4f51-800f-a92f09d3bf8c\"]
      Parameters:
      request - the request object
      callback - the action to perform when the request is completed
      Returns:
      the future indication when the request has completed

    • postAuthorizationDivisionRestoreAsync

      public Future<AuthzDivision> postAuthorizationDivisionRestoreAsync(PostAuthorizationDivisionRestoreRequest request, AsyncApiCallback<AuthzDivision> callback)
      Recreate a previously deleted division.
      Parameters:
      request - the request object
      callback - the action to perform when the request is completed
      Returns:
      the future indication when the request has completed

    • postAuthorizationDivisionRestoreAsync

      public Future<ApiResponse<AuthzDivision>> postAuthorizationDivisionRestoreAsync(ApiRequest<AuthzDivision> request, AsyncApiCallback<ApiResponse<AuthzDivision>> callback)
      Recreate a previously deleted division.
      Parameters:
      request - the request object
      callback - the action to perform when the request is completed
      Returns:
      the future indication when the request has completed

    • postAuthorizationDivisionsAsync

      public Future<AuthzDivision> postAuthorizationDivisionsAsync(PostAuthorizationDivisionsRequest request, AsyncApiCallback<AuthzDivision> callback)
      Create a division.
      Parameters:
      request - the request object
      callback - the action to perform when the request is completed
      Returns:
      the future indication when the request has completed

    • postAuthorizationDivisionsAsync

      public Future<ApiResponse<AuthzDivision>> postAuthorizationDivisionsAsync(ApiRequest<AuthzDivision> request, AsyncApiCallback<ApiResponse<AuthzDivision>> callback)
      Create a division.
      Parameters:
      request - the request object
      callback - the action to perform when the request is completed
      Returns:
      the future indication when the request has completed

    • putAuthorizationDivisionAsync

      public Future<AuthzDivision> putAuthorizationDivisionAsync(PutAuthorizationDivisionRequest request, AsyncApiCallback<AuthzDivision> callback)
      Update a division.
      Parameters:
      request - the request object
      callback - the action to perform when the request is completed
      Returns:
      the future indication when the request has completed

    • putAuthorizationDivisionAsync

      public Future<ApiResponse<AuthzDivision>> putAuthorizationDivisionAsync(ApiRequest<AuthzDivision> request, AsyncApiCallback<ApiResponse<AuthzDivision>> callback)
      Update a division.
      Parameters:
      request - the request object
      callback - the action to perform when the request is completed
      Returns:
      the future indication when the request has completed