Package com.mypurecloud.sdk.v2.api

Class AgentAssistantsApi

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

  • Constructor Details

    • AgentAssistantsApi

      public AgentAssistantsApi()

    • AgentAssistantsApi

      public AgentAssistantsApi(ApiClient apiClient)

  • Method Details

    • deleteAssistant

      public void deleteAssistant(String assistantId) throws IOException, ApiException
      Delete an assistant.
      Parameters:
      assistantId - Assistant ID (required)
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • deleteAssistantWithHttpInfo

      public ApiResponse<Void> deleteAssistantWithHttpInfo(String assistantId) throws IOException
      Delete an assistant.
      Parameters:
      assistantId - Assistant ID (required)
      Throws:
      IOException - if the request fails to be processed

    • deleteAssistant

      public void deleteAssistant(DeleteAssistantRequest request) throws IOException, ApiException
      Delete an assistant.
      Parameters:
      request - The request object
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • deleteAssistant

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

    • deleteAssistantQueue

      public void deleteAssistantQueue(String assistantId, String queueId) throws IOException, ApiException
      Disassociate a queue from an assistant.
      Parameters:
      assistantId - Assistant ID (required)
      queueId - Queue ID (required)
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • deleteAssistantQueueWithHttpInfo

      public ApiResponse<Void> deleteAssistantQueueWithHttpInfo(String assistantId, String queueId) throws IOException
      Disassociate a queue from an assistant.
      Parameters:
      assistantId - Assistant ID (required)
      queueId - Queue ID (required)
      Throws:
      IOException - if the request fails to be processed

    • deleteAssistantQueue

      public void deleteAssistantQueue(DeleteAssistantQueueRequest request) throws IOException, ApiException
      Disassociate a queue from an assistant.
      Parameters:
      request - The request object
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • deleteAssistantQueue

      public ApiResponse<Void> deleteAssistantQueue(ApiRequest<Void> request) throws IOException
      Disassociate a queue from an assistant.
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • deleteAssistantQueues

      public void deleteAssistantQueues(String assistantId, String queueIds) throws IOException, ApiException
      Disassociate the queues from an assistant for the given assistant ID and queue IDs.
      Parameters:
      assistantId - Assistant ID (required)
      queueIds - Comma-separated identifiers of the queues that need to be deleted. (optional)
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • deleteAssistantQueuesWithHttpInfo

      public ApiResponse<Void> deleteAssistantQueuesWithHttpInfo(String assistantId, String queueIds) throws IOException
      Disassociate the queues from an assistant for the given assistant ID and queue IDs.
      Parameters:
      assistantId - Assistant ID (required)
      queueIds - Comma-separated identifiers of the queues that need to be deleted. (optional)
      Throws:
      IOException - if the request fails to be processed

    • deleteAssistantQueues

      public void deleteAssistantQueues(DeleteAssistantQueuesRequest request) throws IOException, ApiException
      Disassociate the queues from an assistant for the given assistant ID and queue IDs.
      Parameters:
      request - The request object
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • deleteAssistantQueues

      public ApiResponse<Void> deleteAssistantQueues(ApiRequest<Void> request) throws IOException
      Disassociate the queues from an assistant for the given assistant ID and queue IDs.
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • deleteAssistantsAgentchecklist

      public void deleteAssistantsAgentchecklist(String agentChecklistId) throws IOException, ApiException
      Delete an agent checklist
      Parameters:
      agentChecklistId - Agent Checklist ID (required)
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • deleteAssistantsAgentchecklistWithHttpInfo

      public ApiResponse<Void> deleteAssistantsAgentchecklistWithHttpInfo(String agentChecklistId) throws IOException
      Delete an agent checklist
      Parameters:
      agentChecklistId - Agent Checklist ID (required)
      Throws:
      IOException - if the request fails to be processed

    • deleteAssistantsAgentchecklist

      public void deleteAssistantsAgentchecklist(DeleteAssistantsAgentchecklistRequest request) throws IOException, ApiException
      Delete an agent checklist
      Parameters:
      request - The request object
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • deleteAssistantsAgentchecklist

      public ApiResponse<Void> deleteAssistantsAgentchecklist(ApiRequest<Void> request) throws IOException
      Delete an agent checklist
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • getAssistant

      public Assistant getAssistant(String assistantId, String expand, String languageVariation, Boolean fallbackToPrimaryAssistant) throws IOException, ApiException
      Get an assistant.
      Parameters:
      assistantId - Assistant ID (required)
      expand - Which fields, if any, to expand. (optional)
      languageVariation - Language variation (optional)
      fallbackToPrimaryAssistant - Fall back to primary assistant if specified variation is not found (optional)
      Returns:
      Assistant
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getAssistantWithHttpInfo

      public ApiResponse<Assistant> getAssistantWithHttpInfo(String assistantId, String expand, String languageVariation, Boolean fallbackToPrimaryAssistant) throws IOException
      Get an assistant.
      Parameters:
      assistantId - Assistant ID (required)
      expand - Which fields, if any, to expand. (optional)
      languageVariation - Language variation (optional)
      fallbackToPrimaryAssistant - Fall back to primary assistant if specified variation is not found (optional)
      Returns:
      Assistant
      Throws:
      IOException - if the request fails to be processed

    • getAssistant

      public Assistant getAssistant(GetAssistantRequest request) throws IOException, ApiException
      Get an assistant.
      Parameters:
      request - The request object
      Returns:
      Assistant
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getAssistant

      public ApiResponse<Assistant> getAssistant(ApiRequest<Void> request) throws IOException
      Get an assistant.
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • getAssistantQueue

      public AssistantQueue getAssistantQueue(String assistantId, String queueId, String expand) throws IOException, ApiException
      Get queue Information for an assistant.
      Parameters:
      assistantId - Assistant ID (required)
      queueId - Queue ID (required)
      expand - Which fields, if any, to expand. (optional)
      Returns:
      AssistantQueue
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getAssistantQueueWithHttpInfo

      public ApiResponse<AssistantQueue> getAssistantQueueWithHttpInfo(String assistantId, String queueId, String expand) throws IOException
      Get queue Information for an assistant.
      Parameters:
      assistantId - Assistant ID (required)
      queueId - Queue ID (required)
      expand - Which fields, if any, to expand. (optional)
      Returns:
      AssistantQueue
      Throws:
      IOException - if the request fails to be processed

    • getAssistantQueue

      public AssistantQueue getAssistantQueue(GetAssistantQueueRequest request) throws IOException, ApiException
      Get queue Information for an assistant.
      Parameters:
      request - The request object
      Returns:
      AssistantQueue
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getAssistantQueue

      public ApiResponse<AssistantQueue> getAssistantQueue(ApiRequest<Void> request) throws IOException
      Get queue Information for an assistant.
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • getAssistantQueueUsersJob

      public AssistantQueueUsersJobsResponse getAssistantQueueUsersJob(String assistantId, String queueId, String jobId) throws IOException, ApiException
      Get job details.
      Parameters:
      assistantId - Assistant ID (required)
      queueId - Queue ID (required)
      jobId - Job ID (required)
      Returns:
      AssistantQueueUsersJobsResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getAssistantQueueUsersJobWithHttpInfo

      public ApiResponse<AssistantQueueUsersJobsResponse> getAssistantQueueUsersJobWithHttpInfo(String assistantId, String queueId, String jobId) throws IOException
      Get job details.
      Parameters:
      assistantId - Assistant ID (required)
      queueId - Queue ID (required)
      jobId - Job ID (required)
      Returns:
      AssistantQueueUsersJobsResponse
      Throws:
      IOException - if the request fails to be processed

    • getAssistantQueueUsersJob

      public AssistantQueueUsersJobsResponse getAssistantQueueUsersJob(GetAssistantQueueUsersJobRequest request) throws IOException, ApiException
      Get job details.
      Parameters:
      request - The request object
      Returns:
      AssistantQueueUsersJobsResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getAssistantQueueUsersJob

      public ApiResponse<AssistantQueueUsersJobsResponse> getAssistantQueueUsersJob(ApiRequest<Void> request) throws IOException
      Get job details.
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • getAssistantQueues

      public AssistantQueueListing getAssistantQueues(String assistantId, String before, String after, String pageSize, String expand) throws IOException, ApiException
      Get all the queues associated with an assistant.
      Parameters:
      assistantId - Assistant ID (required)
      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 - Number of entities to return. Maximum of 200. (optional)
      expand - Which fields, if any, to expand. (optional)
      Returns:
      AssistantQueueListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getAssistantQueuesWithHttpInfo

      public ApiResponse<AssistantQueueListing> getAssistantQueuesWithHttpInfo(String assistantId, String before, String after, String pageSize, String expand) throws IOException
      Get all the queues associated with an assistant.
      Parameters:
      assistantId - Assistant ID (required)
      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 - Number of entities to return. Maximum of 200. (optional)
      expand - Which fields, if any, to expand. (optional)
      Returns:
      AssistantQueueListing
      Throws:
      IOException - if the request fails to be processed

    • getAssistantQueues

      public AssistantQueueListing getAssistantQueues(GetAssistantQueuesRequest request) throws IOException, ApiException
      Get all the queues associated with an assistant.
      Parameters:
      request - The request object
      Returns:
      AssistantQueueListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getAssistantQueues

      public ApiResponse<AssistantQueueListing> getAssistantQueues(ApiRequest<Void> request) throws IOException
      Get all the queues associated with an assistant.
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • getAssistants

      public AssistantListing getAssistants(String before, String after, String limit, String pageSize, String name, String expand) throws IOException, ApiException
      Get all assistants.
      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)
      limit - Number of entities to return. Maximum of 200. Deprecated in favour of pageSize (optional)
      pageSize - Number of entities to return. Maximum of 200. (optional)
      name - Return the assistant by the given name. (optional)
      expand - Which fields, if any, to expand (optional)
      Returns:
      AssistantListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getAssistantsWithHttpInfo

      public ApiResponse<AssistantListing> getAssistantsWithHttpInfo(String before, String after, String limit, String pageSize, String name, String expand) throws IOException
      Get all assistants.
      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)
      limit - Number of entities to return. Maximum of 200. Deprecated in favour of pageSize (optional)
      pageSize - Number of entities to return. Maximum of 200. (optional)
      name - Return the assistant by the given name. (optional)
      expand - Which fields, if any, to expand (optional)
      Returns:
      AssistantListing
      Throws:
      IOException - if the request fails to be processed

    • getAssistants

      public AssistantListing getAssistants(GetAssistantsRequest request) throws IOException, ApiException
      Get all assistants.
      Parameters:
      request - The request object
      Returns:
      AssistantListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getAssistants

      public ApiResponse<AssistantListing> getAssistants(ApiRequest<Void> request) throws IOException
      Get all assistants.
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • getAssistantsAgentchecklist

      public AgentChecklist getAssistantsAgentchecklist(String agentChecklistId) throws IOException, ApiException
      Get an agent checklist
      Parameters:
      agentChecklistId - Agent Checklist ID (required)
      Returns:
      AgentChecklist
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getAssistantsAgentchecklistWithHttpInfo

      public ApiResponse<AgentChecklist> getAssistantsAgentchecklistWithHttpInfo(String agentChecklistId) throws IOException
      Get an agent checklist
      Parameters:
      agentChecklistId - Agent Checklist ID (required)
      Returns:
      AgentChecklist
      Throws:
      IOException - if the request fails to be processed

    • getAssistantsAgentchecklist

      public AgentChecklist getAssistantsAgentchecklist(GetAssistantsAgentchecklistRequest request) throws IOException, ApiException
      Get an agent checklist
      Parameters:
      request - The request object
      Returns:
      AgentChecklist
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getAssistantsAgentchecklist

      public ApiResponse<AgentChecklist> getAssistantsAgentchecklist(ApiRequest<Void> request) throws IOException
      Get an agent checklist
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • getAssistantsAgentchecklists

      public AgentChecklistListing getAssistantsAgentchecklists(String before, String after, String pageSize, String namePrefix, String language, String sortOrder, String sortBy, List<String> agentChecklistIds) throws IOException, ApiException
      Get the list of agent checklists
      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 - The page size for the listing. The max that will be returned is 100. (optional, default to 25)
      namePrefix - The agent checklist name prefix filter applied to the listing. (optional)
      language - The agent checklist language filter applied to the listing. (optional)
      sortOrder - The sort order for the listing (optional)
      sortBy - The field to sort by for the listing. (optional)
      agentChecklistIds - Agent checklist IDs (repeat param or comma-separated). Do not use with other optional filters. (optional)
      Returns:
      AgentChecklistListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getAssistantsAgentchecklistsWithHttpInfo

      public ApiResponse<AgentChecklistListing> getAssistantsAgentchecklistsWithHttpInfo(String before, String after, String pageSize, String namePrefix, String language, String sortOrder, String sortBy, List<String> agentChecklistIds) throws IOException
      Get the list of agent checklists
      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 - The page size for the listing. The max that will be returned is 100. (optional, default to 25)
      namePrefix - The agent checklist name prefix filter applied to the listing. (optional)
      language - The agent checklist language filter applied to the listing. (optional)
      sortOrder - The sort order for the listing (optional)
      sortBy - The field to sort by for the listing. (optional)
      agentChecklistIds - Agent checklist IDs (repeat param or comma-separated). Do not use with other optional filters. (optional)
      Returns:
      AgentChecklistListing
      Throws:
      IOException - if the request fails to be processed

    • getAssistantsAgentchecklists

      public AgentChecklistListing getAssistantsAgentchecklists(GetAssistantsAgentchecklistsRequest request) throws IOException, ApiException
      Get the list of agent checklists
      Parameters:
      request - The request object
      Returns:
      AgentChecklistListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getAssistantsAgentchecklists

      public ApiResponse<AgentChecklistListing> getAssistantsAgentchecklists(ApiRequest<Void> request) throws IOException
      Get the list of agent checklists
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • getAssistantsAgentchecklistsLanguages

      public EntityListing getAssistantsAgentchecklistsLanguages() throws IOException, ApiException
      Get the list of supported languages
      Returns:
      EntityListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getAssistantsAgentchecklistsLanguagesWithHttpInfo

      public ApiResponse<EntityListing> getAssistantsAgentchecklistsLanguagesWithHttpInfo() throws IOException
      Get the list of supported languages
      Returns:
      EntityListing
      Throws:
      IOException - if the request fails to be processed

    • getAssistantsAgentchecklistsLanguages

      public EntityListing getAssistantsAgentchecklistsLanguages(GetAssistantsAgentchecklistsLanguagesRequest request) throws IOException, ApiException
      Get the list of supported languages
      Parameters:
      request - The request object
      Returns:
      EntityListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getAssistantsAgentchecklistsLanguages

      public ApiResponse<EntityListing> getAssistantsAgentchecklistsLanguages(ApiRequest<Void> request) throws IOException
      Get the list of supported languages
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • getAssistantsQueues

      public AssistantQueueListing getAssistantsQueues(String before, String after, String pageSize, String queueIds, String expand) throws IOException, ApiException
      Get all queues assigned to any assistant.
      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 - Number of entities to return. Maximum of 200. (optional)
      queueIds - Comma-separated identifiers of the queues that need to be retrieved. (optional)
      expand - Which fields, if any, to expand. (optional)
      Returns:
      AssistantQueueListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getAssistantsQueuesWithHttpInfo

      public ApiResponse<AssistantQueueListing> getAssistantsQueuesWithHttpInfo(String before, String after, String pageSize, String queueIds, String expand) throws IOException
      Get all queues assigned to any assistant.
      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 - Number of entities to return. Maximum of 200. (optional)
      queueIds - Comma-separated identifiers of the queues that need to be retrieved. (optional)
      expand - Which fields, if any, to expand. (optional)
      Returns:
      AssistantQueueListing
      Throws:
      IOException - if the request fails to be processed

    • getAssistantsQueues

      public AssistantQueueListing getAssistantsQueues(GetAssistantsQueuesRequest request) throws IOException, ApiException
      Get all queues assigned to any assistant.
      Parameters:
      request - The request object
      Returns:
      AssistantQueueListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getAssistantsQueues

      public ApiResponse<AssistantQueueListing> getAssistantsQueues(ApiRequest<Void> request) throws IOException
      Get all queues assigned to any assistant.
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • patchAssistant

      public Assistant patchAssistant(String assistantId, Assistant body) throws IOException, ApiException
      Update an assistant.
      Parameters:
      assistantId - Assistant ID (required)
      body - (required)
      Returns:
      Assistant
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • patchAssistantWithHttpInfo

      public ApiResponse<Assistant> patchAssistantWithHttpInfo(String assistantId, Assistant body) throws IOException
      Update an assistant.
      Parameters:
      assistantId - Assistant ID (required)
      body - (required)
      Returns:
      Assistant
      Throws:
      IOException - if the request fails to be processed

    • patchAssistant

      public Assistant patchAssistant(PatchAssistantRequest request) throws IOException, ApiException
      Update an assistant.
      Parameters:
      request - The request object
      Returns:
      Assistant
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • patchAssistant

      public ApiResponse<Assistant> patchAssistant(ApiRequest<Assistant> request) throws IOException
      Update an assistant.
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • patchAssistantQueues

      public AssistantQueueListing patchAssistantQueues(String assistantId, List<AssistantQueue> body) throws IOException, ApiException
      Update Queues for an Assistant.
      Parameters:
      assistantId - Assistant ID (required)
      body - (required)
      Returns:
      AssistantQueueListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • patchAssistantQueuesWithHttpInfo

      public ApiResponse<AssistantQueueListing> patchAssistantQueuesWithHttpInfo(String assistantId, List<AssistantQueue> body) throws IOException
      Update Queues for an Assistant.
      Parameters:
      assistantId - Assistant ID (required)
      body - (required)
      Returns:
      AssistantQueueListing
      Throws:
      IOException - if the request fails to be processed

    • patchAssistantQueues

      public AssistantQueueListing patchAssistantQueues(PatchAssistantQueuesRequest request) throws IOException, ApiException
      Update Queues for an Assistant.
      Parameters:
      request - The request object
      Returns:
      AssistantQueueListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • patchAssistantQueues

      public ApiResponse<AssistantQueueListing> patchAssistantQueues(ApiRequest<List<AssistantQueue>> request) throws IOException
      Update Queues for an Assistant.
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • postAssistantQueueUsersBulkAdd

      public BulkResponse postAssistantQueueUsersBulkAdd(String assistantId, String queueId, AssistantQueueUsersBulkAddRequest body) throws IOException, ApiException
      Bulk add users to assistant-queue (requires manual assignment mode).
      Parameters:
      assistantId - Assistant ID (required)
      queueId - Queue ID (required)
      body - (required)
      Returns:
      BulkResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • postAssistantQueueUsersBulkAddWithHttpInfo

      public ApiResponse<BulkResponse> postAssistantQueueUsersBulkAddWithHttpInfo(String assistantId, String queueId, AssistantQueueUsersBulkAddRequest body) throws IOException
      Bulk add users to assistant-queue (requires manual assignment mode).
      Parameters:
      assistantId - Assistant ID (required)
      queueId - Queue ID (required)
      body - (required)
      Returns:
      BulkResponse
      Throws:
      IOException - if the request fails to be processed

    • postAssistantQueueUsersBulkAdd

      public BulkResponse postAssistantQueueUsersBulkAdd(PostAssistantQueueUsersBulkAddRequest request) throws IOException, ApiException
      Bulk add users to assistant-queue (requires manual assignment mode).
      Parameters:
      request - The request object
      Returns:
      BulkResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • postAssistantQueueUsersBulkAdd

      public ApiResponse<BulkResponse> postAssistantQueueUsersBulkAdd(ApiRequest<AssistantQueueUsersBulkAddRequest> request) throws IOException
      Bulk add users to assistant-queue (requires manual assignment mode).
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • postAssistantQueueUsersBulkRemove

      public BulkResponse postAssistantQueueUsersBulkRemove(String assistantId, String queueId, AssistantQueueUsersBulkRemoveRequest body) throws IOException, ApiException
      Bulk remove users from assistant-queue (requires manual assignment mode).
      Parameters:
      assistantId - Assistant ID (required)
      queueId - Queue ID (required)
      body - (required)
      Returns:
      BulkResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • postAssistantQueueUsersBulkRemoveWithHttpInfo

      public ApiResponse<BulkResponse> postAssistantQueueUsersBulkRemoveWithHttpInfo(String assistantId, String queueId, AssistantQueueUsersBulkRemoveRequest body) throws IOException
      Bulk remove users from assistant-queue (requires manual assignment mode).
      Parameters:
      assistantId - Assistant ID (required)
      queueId - Queue ID (required)
      body - (required)
      Returns:
      BulkResponse
      Throws:
      IOException - if the request fails to be processed

    • postAssistantQueueUsersBulkRemove

      public BulkResponse postAssistantQueueUsersBulkRemove(PostAssistantQueueUsersBulkRemoveRequest request) throws IOException, ApiException
      Bulk remove users from assistant-queue (requires manual assignment mode).
      Parameters:
      request - The request object
      Returns:
      BulkResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • postAssistantQueueUsersBulkRemove

      public ApiResponse<BulkResponse> postAssistantQueueUsersBulkRemove(ApiRequest<AssistantQueueUsersBulkRemoveRequest> request) throws IOException
      Bulk remove users from assistant-queue (requires manual assignment mode).
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • postAssistantQueueUsersJobs

      public AssistantQueueUsersJobsResponse postAssistantQueueUsersJobs(String assistantId, String queueId, AssistantQueueUsersJobsRequest body) throws IOException, ApiException
      Start a new job to assistant-queue.
      Parameters:
      assistantId - Assistant ID (required)
      queueId - Queue ID (required)
      body - (required)
      Returns:
      AssistantQueueUsersJobsResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • postAssistantQueueUsersJobsWithHttpInfo

      public ApiResponse<AssistantQueueUsersJobsResponse> postAssistantQueueUsersJobsWithHttpInfo(String assistantId, String queueId, AssistantQueueUsersJobsRequest body) throws IOException
      Start a new job to assistant-queue.
      Parameters:
      assistantId - Assistant ID (required)
      queueId - Queue ID (required)
      body - (required)
      Returns:
      AssistantQueueUsersJobsResponse
      Throws:
      IOException - if the request fails to be processed

    • postAssistantQueueUsersJobs

      public AssistantQueueUsersJobsResponse postAssistantQueueUsersJobs(PostAssistantQueueUsersJobsRequest request) throws IOException, ApiException
      Start a new job to assistant-queue.
      Parameters:
      request - The request object
      Returns:
      AssistantQueueUsersJobsResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • postAssistantQueueUsersJobs

      public ApiResponse<AssistantQueueUsersJobsResponse> postAssistantQueueUsersJobs(ApiRequest<AssistantQueueUsersJobsRequest> request) throws IOException
      Start a new job to assistant-queue.
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • postAssistantQueueUsersQuery

      public AssistantQueueUsersQueryResponse postAssistantQueueUsersQuery(String assistantId, String queueId, AssistantQueueUsersQueryRequest body, List<String> expand) throws IOException, ApiException
      Query for users in the assistant-queue (requires manual assignment mode).
      Parameters:
      assistantId - Assistant ID (required)
      queueId - Queue ID (required)
      body - (required)
      expand - Which fields, if any, to expand with. (optional)
      Returns:
      AssistantQueueUsersQueryResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • postAssistantQueueUsersQueryWithHttpInfo

      public ApiResponse<AssistantQueueUsersQueryResponse> postAssistantQueueUsersQueryWithHttpInfo(String assistantId, String queueId, AssistantQueueUsersQueryRequest body, List<String> expand) throws IOException
      Query for users in the assistant-queue (requires manual assignment mode).
      Parameters:
      assistantId - Assistant ID (required)
      queueId - Queue ID (required)
      body - (required)
      expand - Which fields, if any, to expand with. (optional)
      Returns:
      AssistantQueueUsersQueryResponse
      Throws:
      IOException - if the request fails to be processed

    • postAssistantQueueUsersQuery

      public AssistantQueueUsersQueryResponse postAssistantQueueUsersQuery(PostAssistantQueueUsersQueryRequest request) throws IOException, ApiException
      Query for users in the assistant-queue (requires manual assignment mode).
      Parameters:
      request - The request object
      Returns:
      AssistantQueueUsersQueryResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • postAssistantQueueUsersQuery

      public ApiResponse<AssistantQueueUsersQueryResponse> postAssistantQueueUsersQuery(ApiRequest<AssistantQueueUsersQueryRequest> request) throws IOException
      Query for users in the assistant-queue (requires manual assignment mode).
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • postAssistants

      public Assistant postAssistants(Assistant body) throws IOException, ApiException
      Create an Assistant.
      Parameters:
      body - (required)
      Returns:
      Assistant
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • postAssistantsWithHttpInfo

      public ApiResponse<Assistant> postAssistantsWithHttpInfo(Assistant body) throws IOException
      Create an Assistant.
      Parameters:
      body - (required)
      Returns:
      Assistant
      Throws:
      IOException - if the request fails to be processed

    • postAssistants

      public Assistant postAssistants(PostAssistantsRequest request) throws IOException, ApiException
      Create an Assistant.
      Parameters:
      request - The request object
      Returns:
      Assistant
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • postAssistants

      public ApiResponse<Assistant> postAssistants(ApiRequest<Assistant> request) throws IOException
      Create an Assistant.
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • postAssistantsAgentchecklists

      public AgentChecklist postAssistantsAgentchecklists(AgentChecklist body) throws IOException, ApiException
      Create an agent checklist
      Parameters:
      body - Request body containing details of checklist to be added (required)
      Returns:
      AgentChecklist
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • postAssistantsAgentchecklistsWithHttpInfo

      public ApiResponse<AgentChecklist> postAssistantsAgentchecklistsWithHttpInfo(AgentChecklist body) throws IOException
      Create an agent checklist
      Parameters:
      body - Request body containing details of checklist to be added (required)
      Returns:
      AgentChecklist
      Throws:
      IOException - if the request fails to be processed

    • postAssistantsAgentchecklists

      public AgentChecklist postAssistantsAgentchecklists(PostAssistantsAgentchecklistsRequest request) throws IOException, ApiException
      Create an agent checklist
      Parameters:
      request - The request object
      Returns:
      AgentChecklist
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • postAssistantsAgentchecklists

      public ApiResponse<AgentChecklist> postAssistantsAgentchecklists(ApiRequest<AgentChecklist> request) throws IOException
      Create an agent checklist
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • putAssistantQueue

      public AssistantQueue putAssistantQueue(String assistantId, String queueId, AssistantQueue body) throws IOException, ApiException
      Create a queue assistant association.
      Parameters:
      assistantId - Assistant ID (required)
      queueId - Queue ID (required)
      body - (required)
      Returns:
      AssistantQueue
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • putAssistantQueueWithHttpInfo

      public ApiResponse<AssistantQueue> putAssistantQueueWithHttpInfo(String assistantId, String queueId, AssistantQueue body) throws IOException
      Create a queue assistant association.
      Parameters:
      assistantId - Assistant ID (required)
      queueId - Queue ID (required)
      body - (required)
      Returns:
      AssistantQueue
      Throws:
      IOException - if the request fails to be processed

    • putAssistantQueue

      public AssistantQueue putAssistantQueue(PutAssistantQueueRequest request) throws IOException, ApiException
      Create a queue assistant association.
      Parameters:
      request - The request object
      Returns:
      AssistantQueue
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • putAssistantQueue

      public ApiResponse<AssistantQueue> putAssistantQueue(ApiRequest<AssistantQueue> request) throws IOException
      Create a queue assistant association.
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • putAssistantsAgentchecklist

      public AgentChecklist putAssistantsAgentchecklist(String agentChecklistId, AgentChecklist body) throws IOException, ApiException
      Update an agent checklist
      Parameters:
      agentChecklistId - Agent Checklist ID (required)
      body - Request body containing details of checklist to be updated (required)
      Returns:
      AgentChecklist
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • putAssistantsAgentchecklistWithHttpInfo

      public ApiResponse<AgentChecklist> putAssistantsAgentchecklistWithHttpInfo(String agentChecklistId, AgentChecklist body) throws IOException
      Update an agent checklist
      Parameters:
      agentChecklistId - Agent Checklist ID (required)
      body - Request body containing details of checklist to be updated (required)
      Returns:
      AgentChecklist
      Throws:
      IOException - if the request fails to be processed

    • putAssistantsAgentchecklist

      public AgentChecklist putAssistantsAgentchecklist(PutAssistantsAgentchecklistRequest request) throws IOException, ApiException
      Update an agent checklist
      Parameters:
      request - The request object
      Returns:
      AgentChecklist
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • putAssistantsAgentchecklist

      public ApiResponse<AgentChecklist> putAssistantsAgentchecklist(ApiRequest<AgentChecklist> request) throws IOException
      Update an agent checklist
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed