Package com.mypurecloud.sdk.v2.api

Class ObjectsApi

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

  • Constructor Details

    • ObjectsApi

      public ObjectsApi()

    • ObjectsApi

      public ObjectsApi(ApiClient apiClient)

  • Method Details

    • deleteAuthorizationDivision

      public void deleteAuthorizationDivision(String divisionId, Boolean force) throws IOException, ApiException
      Delete a division.
      Parameters:
      divisionId - Division ID (required)
      force - DEPRECATED - Force delete this division. Warning: This option may cause any remaining objects in this division to be inaccessible. (optional, default to false)
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • deleteAuthorizationDivisionWithHttpInfo

      public ApiResponse<Void> deleteAuthorizationDivisionWithHttpInfo(String divisionId, Boolean force) throws IOException
      Delete a division.
      Parameters:
      divisionId - Division ID (required)
      force - DEPRECATED - Force delete this division. Warning: This option may cause any remaining objects in this division to be inaccessible. (optional, default to false)
      Throws:
      IOException - if the request fails to be processed

    • deleteAuthorizationDivision

      public void deleteAuthorizationDivision(DeleteAuthorizationDivisionRequest request) throws IOException, ApiException
      Delete a division.
      Parameters:
      request - The request object
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • deleteAuthorizationDivision

      public ApiResponse<Void> deleteAuthorizationDivision(ApiRequest<Void> request) throws IOException
      Delete a division.
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • getAuthorizationDivision

      public AuthzDivision getAuthorizationDivision(String divisionId, Boolean objectCount) throws IOException, ApiException
      Returns an authorization division.
      Parameters:
      divisionId - Division ID (required)
      objectCount - Get count of objects in this division, grouped by type (optional, default to false)
      Returns:
      AuthzDivision
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getAuthorizationDivisionWithHttpInfo

      public ApiResponse<AuthzDivision> getAuthorizationDivisionWithHttpInfo(String divisionId, Boolean objectCount) throws IOException
      Returns an authorization division.
      Parameters:
      divisionId - Division ID (required)
      objectCount - Get count of objects in this division, grouped by type (optional, default to false)
      Returns:
      AuthzDivision
      Throws:
      IOException - if the request fails to be processed

    • getAuthorizationDivision

      public AuthzDivision getAuthorizationDivision(GetAuthorizationDivisionRequest request) throws IOException, ApiException
      Returns an authorization division.
      Parameters:
      request - The request object
      Returns:
      AuthzDivision
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getAuthorizationDivision

      public ApiResponse<AuthzDivision> getAuthorizationDivision(ApiRequest<Void> request) throws IOException
      Returns an authorization division.
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • getAuthorizationDivisions

      public AuthzDivisionEntityListing getAuthorizationDivisions(Integer pageSize, Integer pageNumber, String sortBy, List<String> expand, String nextPage, String previousPage, Boolean objectCount, List<String> id, String name) throws IOException, ApiException
      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:
      pageSize - The total page size requested (optional, default to 25)
      pageNumber - The page number requested (optional, default to 1)
      sortBy - variable name requested to sort by (optional)
      expand - variable name requested by expand list (optional)
      nextPage - next page token (optional)
      previousPage - Previous page token (optional)
      objectCount - Include the count of objects contained in the division (optional, default to false)
      id - Optionally request specific divisions by their IDs (optional)
      name - Search term to filter by division name (optional)
      Returns:
      AuthzDivisionEntityListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getAuthorizationDivisionsWithHttpInfo

      public ApiResponse<AuthzDivisionEntityListing> getAuthorizationDivisionsWithHttpInfo(Integer pageSize, Integer pageNumber, String sortBy, List<String> expand, String nextPage, String previousPage, Boolean objectCount, List<String> id, String name) throws IOException
      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:
      pageSize - The total page size requested (optional, default to 25)
      pageNumber - The page number requested (optional, default to 1)
      sortBy - variable name requested to sort by (optional)
      expand - variable name requested by expand list (optional)
      nextPage - next page token (optional)
      previousPage - Previous page token (optional)
      objectCount - Include the count of objects contained in the division (optional, default to false)
      id - Optionally request specific divisions by their IDs (optional)
      name - Search term to filter by division name (optional)
      Returns:
      AuthzDivisionEntityListing
      Throws:
      IOException - if the request fails to be processed

    • getAuthorizationDivisions

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

    • getAuthorizationDivisions

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

    • getAuthorizationDivisionsDeleted

      public AuthzDivisionEntityListing getAuthorizationDivisionsDeleted(Integer pageNumber, Integer pageSize) throws IOException, ApiException
      Get a list of soft deleted divisions for the org
      Parameters:
      pageNumber - Page number (optional, default to 1)
      pageSize - Page size (optional, default to 25)
      Returns:
      AuthzDivisionEntityListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getAuthorizationDivisionsDeletedWithHttpInfo

      public ApiResponse<AuthzDivisionEntityListing> getAuthorizationDivisionsDeletedWithHttpInfo(Integer pageNumber, Integer pageSize) throws IOException
      Get a list of soft deleted divisions for the org
      Parameters:
      pageNumber - Page number (optional, default to 1)
      pageSize - Page size (optional, default to 25)
      Returns:
      AuthzDivisionEntityListing
      Throws:
      IOException - if the request fails to be processed

    • getAuthorizationDivisionsDeleted

      public AuthzDivisionEntityListing getAuthorizationDivisionsDeleted(GetAuthorizationDivisionsDeletedRequest request) throws IOException, ApiException
      Get a list of soft deleted divisions for the org
      Parameters:
      request - The request object
      Returns:
      AuthzDivisionEntityListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getAuthorizationDivisionsDeleted

      public ApiResponse<AuthzDivisionEntityListing> getAuthorizationDivisionsDeleted(ApiRequest<Void> request) throws IOException
      Get a list of soft deleted divisions for the org
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • getAuthorizationDivisionsHome

      public AuthzDivision getAuthorizationDivisionsHome() throws IOException, ApiException
      Retrieve the home division for the organization. Will not include object counts.
      Returns:
      AuthzDivision
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getAuthorizationDivisionsHomeWithHttpInfo

      public ApiResponse<AuthzDivision> getAuthorizationDivisionsHomeWithHttpInfo() throws IOException
      Retrieve the home division for the organization. Will not include object counts.
      Returns:
      AuthzDivision
      Throws:
      IOException - if the request fails to be processed

    • getAuthorizationDivisionsHome

      public AuthzDivision getAuthorizationDivisionsHome(GetAuthorizationDivisionsHomeRequest request) throws IOException, ApiException
      Retrieve the home division for the organization. Will not include object counts.
      Parameters:
      request - The request object
      Returns:
      AuthzDivision
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getAuthorizationDivisionsHome

      public ApiResponse<AuthzDivision> getAuthorizationDivisionsHome(ApiRequest<Void> request) throws IOException
      Retrieve the home division for the organization. Will not include object counts.
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • getAuthorizationDivisionsLimit

      public Integer getAuthorizationDivisionsLimit() throws IOException, ApiException
      Returns the maximum allowed number of divisions.
      Returns:
      Integer
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getAuthorizationDivisionsLimitWithHttpInfo

      public ApiResponse<Integer> getAuthorizationDivisionsLimitWithHttpInfo() throws IOException
      Returns the maximum allowed number of divisions.
      Returns:
      Integer
      Throws:
      IOException - if the request fails to be processed

    • getAuthorizationDivisionsLimit

      public Integer getAuthorizationDivisionsLimit(GetAuthorizationDivisionsLimitRequest request) throws IOException, ApiException
      Returns the maximum allowed number of divisions.
      Parameters:
      request - The request object
      Returns:
      Integer
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getAuthorizationDivisionsLimit

      public ApiResponse<Integer> getAuthorizationDivisionsLimit(ApiRequest<Void> request) throws IOException
      Returns the maximum allowed number of divisions.
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • getAuthorizationDivisionsQuery

      public AuthzDivisionCursorListing getAuthorizationDivisionsQuery(String before, String after, String pageSize, List<String> id, String name) throws IOException, ApiException
      Retrieve a list of all divisions defined for the organization with cursor Use \"after\" and \"before\" param to fetch next/previous page}
      Parameters:
      before - The cursor that points to the start of the set of entities that has been returned. (optional)
      after - The cursor that points to the end of the set of entities that has been returned. (optional)
      pageSize - Page size (max 200, default 25) (optional, default to 25)
      id - Optionally request specific divisions by their IDs (optional)
      name - Optionally request specific divisions by division name (optional)
      Returns:
      AuthzDivisionCursorListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getAuthorizationDivisionsQueryWithHttpInfo

      public ApiResponse<AuthzDivisionCursorListing> getAuthorizationDivisionsQueryWithHttpInfo(String before, String after, String pageSize, List<String> id, String name) throws IOException
      Retrieve a list of all divisions defined for the organization with cursor Use \"after\" and \"before\" param to fetch next/previous page}
      Parameters:
      before - The cursor that points to the start of the set of entities that has been returned. (optional)
      after - The cursor that points to the end of the set of entities that has been returned. (optional)
      pageSize - Page size (max 200, default 25) (optional, default to 25)
      id - Optionally request specific divisions by their IDs (optional)
      name - Optionally request specific divisions by division name (optional)
      Returns:
      AuthzDivisionCursorListing
      Throws:
      IOException - if the request fails to be processed

    • getAuthorizationDivisionsQuery

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

    • getAuthorizationDivisionsQuery

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

    • postAuthorizationDivisionObject

      public void postAuthorizationDivisionObject(String divisionId, String objectType, List<String> body) throws IOException, ApiException
      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:
      divisionId - Division ID (required)
      objectType - The type of the objects. Must be one of the valid object types (required)
      body - Object Id List (required)
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • postAuthorizationDivisionObjectWithHttpInfo

      public ApiResponse<Void> postAuthorizationDivisionObjectWithHttpInfo(String divisionId, String objectType, List<String> body) throws IOException
      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:
      divisionId - Division ID (required)
      objectType - The type of the objects. Must be one of the valid object types (required)
      body - Object Id List (required)
      Throws:
      IOException - if the request fails to be processed

    • postAuthorizationDivisionObject

      public void postAuthorizationDivisionObject(PostAuthorizationDivisionObjectRequest request) throws IOException, ApiException
      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
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • postAuthorizationDivisionObject

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

    • postAuthorizationDivisionRestore

      public AuthzDivision postAuthorizationDivisionRestore(String divisionId, AuthzDivision body) throws IOException, ApiException
      Recreate a previously deleted division.
      Parameters:
      divisionId - Division ID (required)
      body - Recreated division data (required)
      Returns:
      AuthzDivision
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • postAuthorizationDivisionRestoreWithHttpInfo

      public ApiResponse<AuthzDivision> postAuthorizationDivisionRestoreWithHttpInfo(String divisionId, AuthzDivision body) throws IOException
      Recreate a previously deleted division.
      Parameters:
      divisionId - Division ID (required)
      body - Recreated division data (required)
      Returns:
      AuthzDivision
      Throws:
      IOException - if the request fails to be processed

    • postAuthorizationDivisionRestore

      public AuthzDivision postAuthorizationDivisionRestore(PostAuthorizationDivisionRestoreRequest request) throws IOException, ApiException
      Recreate a previously deleted division.
      Parameters:
      request - The request object
      Returns:
      AuthzDivision
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • postAuthorizationDivisionRestore

      public ApiResponse<AuthzDivision> postAuthorizationDivisionRestore(ApiRequest<AuthzDivision> request) throws IOException
      Recreate a previously deleted division.
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • postAuthorizationDivisions

      public AuthzDivision postAuthorizationDivisions(AuthzDivision body) throws IOException, ApiException
      Create a division.
      Parameters:
      body - Division (required)
      Returns:
      AuthzDivision
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • postAuthorizationDivisionsWithHttpInfo

      public ApiResponse<AuthzDivision> postAuthorizationDivisionsWithHttpInfo(AuthzDivision body) throws IOException
      Create a division.
      Parameters:
      body - Division (required)
      Returns:
      AuthzDivision
      Throws:
      IOException - if the request fails to be processed

    • postAuthorizationDivisions

      public AuthzDivision postAuthorizationDivisions(PostAuthorizationDivisionsRequest request) throws IOException, ApiException
      Create a division.
      Parameters:
      request - The request object
      Returns:
      AuthzDivision
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • postAuthorizationDivisions

      public ApiResponse<AuthzDivision> postAuthorizationDivisions(ApiRequest<AuthzDivision> request) throws IOException
      Create a division.
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • putAuthorizationDivision

      public AuthzDivision putAuthorizationDivision(String divisionId, AuthzDivision body) throws IOException, ApiException
      Update a division.
      Parameters:
      divisionId - Division ID (required)
      body - Updated division data (required)
      Returns:
      AuthzDivision
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • putAuthorizationDivisionWithHttpInfo

      public ApiResponse<AuthzDivision> putAuthorizationDivisionWithHttpInfo(String divisionId, AuthzDivision body) throws IOException
      Update a division.
      Parameters:
      divisionId - Division ID (required)
      body - Updated division data (required)
      Returns:
      AuthzDivision
      Throws:
      IOException - if the request fails to be processed

    • putAuthorizationDivision

      public AuthzDivision putAuthorizationDivision(PutAuthorizationDivisionRequest request) throws IOException, ApiException
      Update a division.
      Parameters:
      request - The request object
      Returns:
      AuthzDivision
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • putAuthorizationDivision

      public ApiResponse<AuthzDivision> putAuthorizationDivision(ApiRequest<AuthzDivision> request) throws IOException
      Update a division.
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed