Package com.mypurecloud.sdk.v2.api

Class ResponseManagementApi

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

  • Constructor Details

    • ResponseManagementApi

      public ResponseManagementApi()

    • ResponseManagementApi

      public ResponseManagementApi(ApiClient apiClient)

  • Method Details

    • deleteResponsemanagementLibrary

      public void deleteResponsemanagementLibrary(String libraryId) throws IOException, ApiException
      Delete an existing response library. This will remove any responses associated with the library.
      Parameters:
      libraryId - Library ID (required)
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • deleteResponsemanagementLibraryWithHttpInfo

      public ApiResponse<Void> deleteResponsemanagementLibraryWithHttpInfo(String libraryId) throws IOException
      Delete an existing response library. This will remove any responses associated with the library.
      Parameters:
      libraryId - Library ID (required)
      Throws:
      IOException - if the request fails to be processed

    • deleteResponsemanagementLibrary

      public void deleteResponsemanagementLibrary(DeleteResponsemanagementLibraryRequest request) throws IOException, ApiException
      Delete an existing response library. This will remove any responses associated with the library.
      Parameters:
      request - The request object
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • deleteResponsemanagementLibrary

      public ApiResponse<Void> deleteResponsemanagementLibrary(ApiRequest<Void> request) throws IOException
      Delete an existing response library. This will remove any responses associated with the library.
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • deleteResponsemanagementResponse

      public void deleteResponsemanagementResponse(String responseId) throws IOException, ApiException
      Delete an existing response. This will remove the response from any libraries associated with it.
      Parameters:
      responseId - Response ID (required)
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • deleteResponsemanagementResponseWithHttpInfo

      public ApiResponse<Void> deleteResponsemanagementResponseWithHttpInfo(String responseId) throws IOException
      Delete an existing response. This will remove the response from any libraries associated with it.
      Parameters:
      responseId - Response ID (required)
      Throws:
      IOException - if the request fails to be processed

    • deleteResponsemanagementResponse

      public void deleteResponsemanagementResponse(DeleteResponsemanagementResponseRequest request) throws IOException, ApiException
      Delete an existing response. This will remove the response from any libraries associated with it.
      Parameters:
      request - The request object
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • deleteResponsemanagementResponse

      public ApiResponse<Void> deleteResponsemanagementResponse(ApiRequest<Void> request) throws IOException
      Delete an existing response. This will remove the response from any libraries associated with it.
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • deleteResponsemanagementResponseasset

      public void deleteResponsemanagementResponseasset(String responseAssetId) throws IOException, ApiException
      Delete response asset
      Parameters:
      responseAssetId - Asset Id (required)
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • deleteResponsemanagementResponseassetWithHttpInfo

      public ApiResponse<Void> deleteResponsemanagementResponseassetWithHttpInfo(String responseAssetId) throws IOException
      Delete response asset
      Parameters:
      responseAssetId - Asset Id (required)
      Throws:
      IOException - if the request fails to be processed

    • deleteResponsemanagementResponseasset

      public void deleteResponsemanagementResponseasset(DeleteResponsemanagementResponseassetRequest request) throws IOException, ApiException
      Delete response asset
      Parameters:
      request - The request object
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • deleteResponsemanagementResponseasset

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

    • getResponsemanagementLibraries

      public LibraryEntityListing getResponsemanagementLibraries(Integer pageNumber, Integer pageSize, String messagingTemplateFilter, String libraryPrefix) throws IOException, ApiException
      Gets a list of existing response libraries.
      Parameters:
      pageNumber - Page number (optional, default to 1)
      pageSize - Page size (optional, default to 25)
      messagingTemplateFilter - Returns a list of libraries that contain responses with at least one messaging template defined for a specific message channel (optional)
      libraryPrefix - Returns a list of libraries that contain the prefix provided (optional)
      Returns:
      LibraryEntityListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getResponsemanagementLibrariesWithHttpInfo

      public ApiResponse<LibraryEntityListing> getResponsemanagementLibrariesWithHttpInfo(Integer pageNumber, Integer pageSize, String messagingTemplateFilter, String libraryPrefix) throws IOException
      Gets a list of existing response libraries.
      Parameters:
      pageNumber - Page number (optional, default to 1)
      pageSize - Page size (optional, default to 25)
      messagingTemplateFilter - Returns a list of libraries that contain responses with at least one messaging template defined for a specific message channel (optional)
      libraryPrefix - Returns a list of libraries that contain the prefix provided (optional)
      Returns:
      LibraryEntityListing
      Throws:
      IOException - if the request fails to be processed

    • getResponsemanagementLibraries

      public LibraryEntityListing getResponsemanagementLibraries(GetResponsemanagementLibrariesRequest request) throws IOException, ApiException
      Gets a list of existing response libraries.
      Parameters:
      request - The request object
      Returns:
      LibraryEntityListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getResponsemanagementLibraries

      public ApiResponse<LibraryEntityListing> getResponsemanagementLibraries(ApiRequest<Void> request) throws IOException
      Gets a list of existing response libraries.
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • getResponsemanagementLibrary

      public Library getResponsemanagementLibrary(String libraryId) throws IOException, ApiException
      Get details about an existing response library.
      Parameters:
      libraryId - Library ID (required)
      Returns:
      Library
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getResponsemanagementLibraryWithHttpInfo

      public ApiResponse<Library> getResponsemanagementLibraryWithHttpInfo(String libraryId) throws IOException
      Get details about an existing response library.
      Parameters:
      libraryId - Library ID (required)
      Returns:
      Library
      Throws:
      IOException - if the request fails to be processed

    • getResponsemanagementLibrary

      public Library getResponsemanagementLibrary(GetResponsemanagementLibraryRequest request) throws IOException, ApiException
      Get details about an existing response library.
      Parameters:
      request - The request object
      Returns:
      Library
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getResponsemanagementLibrary

      public ApiResponse<Library> getResponsemanagementLibrary(ApiRequest<Void> request) throws IOException
      Get details about an existing response library.
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • getResponsemanagementResponse

      public Response getResponsemanagementResponse(String responseId, String expand) throws IOException, ApiException
      Get details about an existing response.
      Parameters:
      responseId - Response ID (required)
      expand - Expand instructions for the return value. (optional)
      Returns:
      Response
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getResponsemanagementResponseWithHttpInfo

      public ApiResponse<Response> getResponsemanagementResponseWithHttpInfo(String responseId, String expand) throws IOException
      Get details about an existing response.
      Parameters:
      responseId - Response ID (required)
      expand - Expand instructions for the return value. (optional)
      Returns:
      Response
      Throws:
      IOException - if the request fails to be processed

    • getResponsemanagementResponse

      public Response getResponsemanagementResponse(GetResponsemanagementResponseRequest request) throws IOException, ApiException
      Get details about an existing response.
      Parameters:
      request - The request object
      Returns:
      Response
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getResponsemanagementResponse

      public ApiResponse<Response> getResponsemanagementResponse(ApiRequest<Void> request) throws IOException
      Get details about an existing response.
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • getResponsemanagementResponseasset

      public ResponseAsset getResponsemanagementResponseasset(String responseAssetId) throws IOException, ApiException
      Get response asset information
      Parameters:
      responseAssetId - Asset Id (required)
      Returns:
      ResponseAsset
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getResponsemanagementResponseassetWithHttpInfo

      public ApiResponse<ResponseAsset> getResponsemanagementResponseassetWithHttpInfo(String responseAssetId) throws IOException
      Get response asset information
      Parameters:
      responseAssetId - Asset Id (required)
      Returns:
      ResponseAsset
      Throws:
      IOException - if the request fails to be processed

    • getResponsemanagementResponseasset

      public ResponseAsset getResponsemanagementResponseasset(GetResponsemanagementResponseassetRequest request) throws IOException, ApiException
      Get response asset information
      Parameters:
      request - The request object
      Returns:
      ResponseAsset
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getResponsemanagementResponseasset

      public ApiResponse<ResponseAsset> getResponsemanagementResponseasset(ApiRequest<Void> request) throws IOException
      Get response asset information
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • getResponsemanagementResponseassetsStatusStatusId

      public ResponseAssetStatus getResponsemanagementResponseassetsStatusStatusId(String statusId) throws IOException, ApiException
      Get response asset upload status
      Parameters:
      statusId - Status Id (required)
      Returns:
      ResponseAssetStatus
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getResponsemanagementResponseassetsStatusStatusIdWithHttpInfo

      public ApiResponse<ResponseAssetStatus> getResponsemanagementResponseassetsStatusStatusIdWithHttpInfo(String statusId) throws IOException
      Get response asset upload status
      Parameters:
      statusId - Status Id (required)
      Returns:
      ResponseAssetStatus
      Throws:
      IOException - if the request fails to be processed

    • getResponsemanagementResponseassetsStatusStatusId

      public ResponseAssetStatus getResponsemanagementResponseassetsStatusStatusId(GetResponsemanagementResponseassetsStatusStatusIdRequest request) throws IOException, ApiException
      Get response asset upload status
      Parameters:
      request - The request object
      Returns:
      ResponseAssetStatus
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getResponsemanagementResponseassetsStatusStatusId

      public ApiResponse<ResponseAssetStatus> getResponsemanagementResponseassetsStatusStatusId(ApiRequest<Void> request) throws IOException
      Get response asset upload status
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • getResponsemanagementResponses

      public ResponseEntityListing getResponsemanagementResponses(String libraryId, Integer pageNumber, Integer pageSize, String expand) throws IOException, ApiException
      Gets a list of existing responses.
      Parameters:
      libraryId - Library ID (required)
      pageNumber - Page number (optional, default to 1)
      pageSize - Page size (optional, default to 25)
      expand - Expand instructions for the return value. (optional)
      Returns:
      ResponseEntityListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getResponsemanagementResponsesWithHttpInfo

      public ApiResponse<ResponseEntityListing> getResponsemanagementResponsesWithHttpInfo(String libraryId, Integer pageNumber, Integer pageSize, String expand) throws IOException
      Gets a list of existing responses.
      Parameters:
      libraryId - Library ID (required)
      pageNumber - Page number (optional, default to 1)
      pageSize - Page size (optional, default to 25)
      expand - Expand instructions for the return value. (optional)
      Returns:
      ResponseEntityListing
      Throws:
      IOException - if the request fails to be processed

    • getResponsemanagementResponses

      public ResponseEntityListing getResponsemanagementResponses(GetResponsemanagementResponsesRequest request) throws IOException, ApiException
      Gets a list of existing responses.
      Parameters:
      request - The request object
      Returns:
      ResponseEntityListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getResponsemanagementResponses

      public ApiResponse<ResponseEntityListing> getResponsemanagementResponses(ApiRequest<Void> request) throws IOException
      Gets a list of existing responses.
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • postResponsemanagementLibraries

      public Library postResponsemanagementLibraries(Library body) throws IOException, ApiException
      Create a response library.
      Parameters:
      body - Library (required)
      Returns:
      Library
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • postResponsemanagementLibrariesWithHttpInfo

      public ApiResponse<Library> postResponsemanagementLibrariesWithHttpInfo(Library body) throws IOException
      Create a response library.
      Parameters:
      body - Library (required)
      Returns:
      Library
      Throws:
      IOException - if the request fails to be processed

    • postResponsemanagementLibraries

      public Library postResponsemanagementLibraries(PostResponsemanagementLibrariesRequest request) throws IOException, ApiException
      Create a response library.
      Parameters:
      request - The request object
      Returns:
      Library
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • postResponsemanagementLibraries

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

    • postResponsemanagementLibrariesBulk

      public LibraryEntityListing postResponsemanagementLibrariesBulk(LibraryBatchRequest body) throws IOException, ApiException
      Get response libraries.
      Parameters:
      body - LibraryIDs (max allowed 50) (required)
      Returns:
      LibraryEntityListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • postResponsemanagementLibrariesBulkWithHttpInfo

      public ApiResponse<LibraryEntityListing> postResponsemanagementLibrariesBulkWithHttpInfo(LibraryBatchRequest body) throws IOException
      Get response libraries.
      Parameters:
      body - LibraryIDs (max allowed 50) (required)
      Returns:
      LibraryEntityListing
      Throws:
      IOException - if the request fails to be processed

    • postResponsemanagementLibrariesBulk

      public LibraryEntityListing postResponsemanagementLibrariesBulk(PostResponsemanagementLibrariesBulkRequest request) throws IOException, ApiException
      Get response libraries.
      Parameters:
      request - The request object
      Returns:
      LibraryEntityListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • postResponsemanagementLibrariesBulk

      public ApiResponse<LibraryEntityListing> postResponsemanagementLibrariesBulk(ApiRequest<LibraryBatchRequest> request) throws IOException
      Get response libraries.
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • postResponsemanagementLibrariesQuery

      public LibraryEntityListing postResponsemanagementLibrariesQuery(QueryCriteriaQuery body, Integer pageNumber, Integer pageSize) throws IOException, ApiException
      Query libraries using criteria. Users can set DivisionId parameter as '*' to fetch libraries that aren't associated with any divisions.
      Parameters:
      body - Query criteria (required)
      pageNumber - Page number (optional, default to 1)
      pageSize - Page size (optional, default to 25)
      Returns:
      LibraryEntityListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • postResponsemanagementLibrariesQueryWithHttpInfo

      public ApiResponse<LibraryEntityListing> postResponsemanagementLibrariesQueryWithHttpInfo(QueryCriteriaQuery body, Integer pageNumber, Integer pageSize) throws IOException
      Query libraries using criteria. Users can set DivisionId parameter as '*' to fetch libraries that aren't associated with any divisions.
      Parameters:
      body - Query criteria (required)
      pageNumber - Page number (optional, default to 1)
      pageSize - Page size (optional, default to 25)
      Returns:
      LibraryEntityListing
      Throws:
      IOException - if the request fails to be processed

    • postResponsemanagementLibrariesQuery

      public LibraryEntityListing postResponsemanagementLibrariesQuery(PostResponsemanagementLibrariesQueryRequest request) throws IOException, ApiException
      Query libraries using criteria. Users can set DivisionId parameter as '*' to fetch libraries that aren't associated with any divisions.
      Parameters:
      request - The request object
      Returns:
      LibraryEntityListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • postResponsemanagementLibrariesQuery

      public ApiResponse<LibraryEntityListing> postResponsemanagementLibrariesQuery(ApiRequest<QueryCriteriaQuery> request) throws IOException
      Query libraries using criteria. Users can set DivisionId parameter as '*' to fetch libraries that aren't associated with any divisions.
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • postResponsemanagementResponseassetsBulk

      public ResponseAssetEntityListing postResponsemanagementResponseassetsBulk(ResponseAssetBulkRequest body) throws IOException, ApiException
      Get response assets.
      Parameters:
      body - Asset IDs (max allowed 50) (required)
      Returns:
      ResponseAssetEntityListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • postResponsemanagementResponseassetsBulkWithHttpInfo

      public ApiResponse<ResponseAssetEntityListing> postResponsemanagementResponseassetsBulkWithHttpInfo(ResponseAssetBulkRequest body) throws IOException
      Get response assets.
      Parameters:
      body - Asset IDs (max allowed 50) (required)
      Returns:
      ResponseAssetEntityListing
      Throws:
      IOException - if the request fails to be processed

    • postResponsemanagementResponseassetsBulk

      public ResponseAssetEntityListing postResponsemanagementResponseassetsBulk(PostResponsemanagementResponseassetsBulkRequest request) throws IOException, ApiException
      Get response assets.
      Parameters:
      request - The request object
      Returns:
      ResponseAssetEntityListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • postResponsemanagementResponseassetsBulk

      public ApiResponse<ResponseAssetEntityListing> postResponsemanagementResponseassetsBulk(ApiRequest<ResponseAssetBulkRequest> request) throws IOException
      Get response assets.
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • postResponsemanagementResponseassetsSearch

      public ResponseAssetSearchResults postResponsemanagementResponseassetsSearch(ResponseAssetSearchRequest body, List<String> expand) throws IOException, ApiException
      Search response assets
      Parameters:
      body - request (required)
      expand - Which fields, if any, to expand (optional)
      Returns:
      ResponseAssetSearchResults
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • postResponsemanagementResponseassetsSearchWithHttpInfo

      public ApiResponse<ResponseAssetSearchResults> postResponsemanagementResponseassetsSearchWithHttpInfo(ResponseAssetSearchRequest body, List<String> expand) throws IOException
      Search response assets
      Parameters:
      body - request (required)
      expand - Which fields, if any, to expand (optional)
      Returns:
      ResponseAssetSearchResults
      Throws:
      IOException - if the request fails to be processed

    • postResponsemanagementResponseassetsSearch

      public ResponseAssetSearchResults postResponsemanagementResponseassetsSearch(PostResponsemanagementResponseassetsSearchRequest request) throws IOException, ApiException
      Search response assets
      Parameters:
      request - The request object
      Returns:
      ResponseAssetSearchResults
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • postResponsemanagementResponseassetsSearch

      public ApiResponse<ResponseAssetSearchResults> postResponsemanagementResponseassetsSearch(ApiRequest<ResponseAssetSearchRequest> request) throws IOException
      Search response assets
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • postResponsemanagementResponseassetsUploads

      public CreateResponseAssetResponse postResponsemanagementResponseassetsUploads(CreateResponseAssetRequest body) throws IOException, ApiException
      Creates pre-signed url for uploading response asset
      Parameters:
      body - request (required)
      Returns:
      CreateResponseAssetResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • postResponsemanagementResponseassetsUploadsWithHttpInfo

      public ApiResponse<CreateResponseAssetResponse> postResponsemanagementResponseassetsUploadsWithHttpInfo(CreateResponseAssetRequest body) throws IOException
      Creates pre-signed url for uploading response asset
      Parameters:
      body - request (required)
      Returns:
      CreateResponseAssetResponse
      Throws:
      IOException - if the request fails to be processed

    • postResponsemanagementResponseassetsUploads

      public CreateResponseAssetResponse postResponsemanagementResponseassetsUploads(PostResponsemanagementResponseassetsUploadsRequest request) throws IOException, ApiException
      Creates pre-signed url for uploading response asset
      Parameters:
      request - The request object
      Returns:
      CreateResponseAssetResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • postResponsemanagementResponseassetsUploads

      public ApiResponse<CreateResponseAssetResponse> postResponsemanagementResponseassetsUploads(ApiRequest<CreateResponseAssetRequest> request) throws IOException
      Creates pre-signed url for uploading response asset
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • postResponsemanagementResponses

      public Response postResponsemanagementResponses(Response body, String expand) throws IOException, ApiException
      Create a response.
      Parameters:
      body - Response (required)
      expand - Expand instructions for the return value. (optional)
      Returns:
      Response
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • postResponsemanagementResponsesWithHttpInfo

      public ApiResponse<Response> postResponsemanagementResponsesWithHttpInfo(Response body, String expand) throws IOException
      Create a response.
      Parameters:
      body - Response (required)
      expand - Expand instructions for the return value. (optional)
      Returns:
      Response
      Throws:
      IOException - if the request fails to be processed

    • postResponsemanagementResponses

      public Response postResponsemanagementResponses(PostResponsemanagementResponsesRequest request) throws IOException, ApiException
      Create a response.
      Parameters:
      request - The request object
      Returns:
      Response
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • postResponsemanagementResponses

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

    • postResponsemanagementResponsesQuery

      public ResponseQueryResults postResponsemanagementResponsesQuery(ResponseQueryRequest body) throws IOException, ApiException
      Query responses
      Parameters:
      body - Response (required)
      Returns:
      ResponseQueryResults
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • postResponsemanagementResponsesQueryWithHttpInfo

      public ApiResponse<ResponseQueryResults> postResponsemanagementResponsesQueryWithHttpInfo(ResponseQueryRequest body) throws IOException
      Query responses
      Parameters:
      body - Response (required)
      Returns:
      ResponseQueryResults
      Throws:
      IOException - if the request fails to be processed

    • postResponsemanagementResponsesQuery

      public ResponseQueryResults postResponsemanagementResponsesQuery(PostResponsemanagementResponsesQueryRequest request) throws IOException, ApiException
      Query responses
      Parameters:
      request - The request object
      Returns:
      ResponseQueryResults
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • postResponsemanagementResponsesQuery

      public ApiResponse<ResponseQueryResults> postResponsemanagementResponsesQuery(ApiRequest<ResponseQueryRequest> request) throws IOException
      Query responses
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • putResponsemanagementLibrary

      public Library putResponsemanagementLibrary(String libraryId, Library body) throws IOException, ApiException
      Update an existing response library. Fields that can be updated: name. The most recent version is required for updates.
      Parameters:
      libraryId - Library ID (required)
      body - Library (required)
      Returns:
      Library
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • putResponsemanagementLibraryWithHttpInfo

      public ApiResponse<Library> putResponsemanagementLibraryWithHttpInfo(String libraryId, Library body) throws IOException
      Update an existing response library. Fields that can be updated: name. The most recent version is required for updates.
      Parameters:
      libraryId - Library ID (required)
      body - Library (required)
      Returns:
      Library
      Throws:
      IOException - if the request fails to be processed

    • putResponsemanagementLibrary

      public Library putResponsemanagementLibrary(PutResponsemanagementLibraryRequest request) throws IOException, ApiException
      Update an existing response library. Fields that can be updated: name. The most recent version is required for updates.
      Parameters:
      request - The request object
      Returns:
      Library
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • putResponsemanagementLibrary

      public ApiResponse<Library> putResponsemanagementLibrary(ApiRequest<Library> request) throws IOException
      Update an existing response library. Fields that can be updated: name. The most recent version is required for updates.
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • putResponsemanagementResponse

      public Response putResponsemanagementResponse(String responseId, Response body, String expand) throws IOException, ApiException
      Update an existing response. Fields that can be updated: name, libraries, and texts. The most recent version is required for updates.
      Parameters:
      responseId - Response ID (required)
      body - Response (required)
      expand - Expand instructions for the return value. (optional)
      Returns:
      Response
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • putResponsemanagementResponseWithHttpInfo

      public ApiResponse<Response> putResponsemanagementResponseWithHttpInfo(String responseId, Response body, String expand) throws IOException
      Update an existing response. Fields that can be updated: name, libraries, and texts. The most recent version is required for updates.
      Parameters:
      responseId - Response ID (required)
      body - Response (required)
      expand - Expand instructions for the return value. (optional)
      Returns:
      Response
      Throws:
      IOException - if the request fails to be processed

    • putResponsemanagementResponse

      public Response putResponsemanagementResponse(PutResponsemanagementResponseRequest request) throws IOException, ApiException
      Update an existing response. Fields that can be updated: name, libraries, and texts. The most recent version is required for updates.
      Parameters:
      request - The request object
      Returns:
      Response
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • putResponsemanagementResponse

      public ApiResponse<Response> putResponsemanagementResponse(ApiRequest<Response> request) throws IOException
      Update an existing response. Fields that can be updated: name, libraries, and texts. The most recent version is required for updates.
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • putResponsemanagementResponseasset

      public ResponseAsset putResponsemanagementResponseasset(String responseAssetId, ResponseAssetRequest body) throws IOException, ApiException
      Update response asset
      Parameters:
      responseAssetId - Asset Id (required)
      body - request (required)
      Returns:
      ResponseAsset
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • putResponsemanagementResponseassetWithHttpInfo

      public ApiResponse<ResponseAsset> putResponsemanagementResponseassetWithHttpInfo(String responseAssetId, ResponseAssetRequest body) throws IOException
      Update response asset
      Parameters:
      responseAssetId - Asset Id (required)
      body - request (required)
      Returns:
      ResponseAsset
      Throws:
      IOException - if the request fails to be processed

    • putResponsemanagementResponseasset

      public ResponseAsset putResponsemanagementResponseasset(PutResponsemanagementResponseassetRequest request) throws IOException, ApiException
      Update response asset
      Parameters:
      request - The request object
      Returns:
      ResponseAsset
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • putResponsemanagementResponseasset

      public ApiResponse<ResponseAsset> putResponsemanagementResponseasset(ApiRequest<ResponseAssetRequest> request) throws IOException
      Update response asset
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed