Package com.mypurecloud.sdk.v2.api

Class CaseManagementApi

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

  • Constructor Details

    • CaseManagementApi

      public CaseManagementApi()

    • CaseManagementApi

      public CaseManagementApi(ApiClient apiClient)

  • Method Details

    • deleteCasemanagementCase

      public Empty deleteCasemanagementCase(String caseId) throws IOException, ApiException
      Delete a Case.
      Parameters:
      caseId - Case identifier. (required)
      Returns:
      Empty
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • deleteCasemanagementCaseWithHttpInfo

      public ApiResponse<Empty> deleteCasemanagementCaseWithHttpInfo(String caseId) throws IOException
      Delete a Case.
      Parameters:
      caseId - Case identifier. (required)
      Returns:
      Empty
      Throws:
      IOException - if the request fails to be processed

    • deleteCasemanagementCase

      public Empty deleteCasemanagementCase(DeleteCasemanagementCaseRequest request) throws IOException, ApiException
      Delete a Case.
      Parameters:
      request - The request object
      Returns:
      Empty
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • deleteCasemanagementCase

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

    • deleteCasemanagementCaseplan

      public Empty deleteCasemanagementCaseplan(String caseplanId) throws IOException, ApiException
      Delete a Caseplan.
      Parameters:
      caseplanId - Caseplan identifier. (required)
      Returns:
      Empty
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • deleteCasemanagementCaseplanWithHttpInfo

      public ApiResponse<Empty> deleteCasemanagementCaseplanWithHttpInfo(String caseplanId) throws IOException
      Delete a Caseplan.
      Parameters:
      caseplanId - Caseplan identifier. (required)
      Returns:
      Empty
      Throws:
      IOException - if the request fails to be processed

    • deleteCasemanagementCaseplan

      public Empty deleteCasemanagementCaseplan(DeleteCasemanagementCaseplanRequest request) throws IOException, ApiException
      Delete a Caseplan.
      Parameters:
      request - The request object
      Returns:
      Empty
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • deleteCasemanagementCaseplan

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

    • deleteCasemanagementCaseplanDataschema

      public Empty deleteCasemanagementCaseplanDataschema(String caseplanId, String schemaKeyName) throws IOException, ApiException
      Remove a data schema from a draft Caseplan.
      Parameters:
      caseplanId - Caseplan identifier. (required)
      schemaKeyName - Schema key (for example \"default\"). (required)
      Returns:
      Empty
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • deleteCasemanagementCaseplanDataschemaWithHttpInfo

      public ApiResponse<Empty> deleteCasemanagementCaseplanDataschemaWithHttpInfo(String caseplanId, String schemaKeyName) throws IOException
      Remove a data schema from a draft Caseplan.
      Parameters:
      caseplanId - Caseplan identifier. (required)
      schemaKeyName - Schema key (for example \"default\"). (required)
      Returns:
      Empty
      Throws:
      IOException - if the request fails to be processed

    • deleteCasemanagementCaseplanDataschema

      public Empty deleteCasemanagementCaseplanDataschema(DeleteCasemanagementCaseplanDataschemaRequest request) throws IOException, ApiException
      Remove a data schema from a draft Caseplan.
      Parameters:
      request - The request object
      Returns:
      Empty
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • deleteCasemanagementCaseplanDataschema

      public ApiResponse<Empty> deleteCasemanagementCaseplanDataschema(ApiRequest<Void> request) throws IOException
      Remove a data schema from a draft Caseplan.
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • getCasemanagementCase

      public ModelCase getCasemanagementCase(String caseId, String expands) throws IOException, ApiException
      Get a Case.
      Parameters:
      caseId - Case identifier. (required)
      expands - Fields to expand. (optional)
      Returns:
      ModelCase
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getCasemanagementCaseWithHttpInfo

      public ApiResponse<ModelCase> getCasemanagementCaseWithHttpInfo(String caseId, String expands) throws IOException
      Get a Case.
      Parameters:
      caseId - Case identifier. (required)
      expands - Fields to expand. (optional)
      Returns:
      ModelCase
      Throws:
      IOException - if the request fails to be processed

    • getCasemanagementCase

      public ModelCase getCasemanagementCase(GetCasemanagementCaseRequest request) throws IOException, ApiException
      Get a Case.
      Parameters:
      request - The request object
      Returns:
      ModelCase
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getCasemanagementCase

      public ApiResponse<ModelCase> getCasemanagementCase(ApiRequest<Void> request) throws IOException
      Get a Case.
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • getCasemanagementCaseAssociation

      public CaseAssociation getCasemanagementCaseAssociation(String caseId, String associationId) throws IOException, ApiException
      Get a Case Association.
      Parameters:
      caseId - Case identifier. (required)
      associationId - Case association identifier. (required)
      Returns:
      CaseAssociation
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getCasemanagementCaseAssociationWithHttpInfo

      public ApiResponse<CaseAssociation> getCasemanagementCaseAssociationWithHttpInfo(String caseId, String associationId) throws IOException
      Get a Case Association.
      Parameters:
      caseId - Case identifier. (required)
      associationId - Case association identifier. (required)
      Returns:
      CaseAssociation
      Throws:
      IOException - if the request fails to be processed

    • getCasemanagementCaseAssociation

      public CaseAssociation getCasemanagementCaseAssociation(GetCasemanagementCaseAssociationRequest request) throws IOException, ApiException
      Get a Case Association.
      Parameters:
      request - The request object
      Returns:
      CaseAssociation
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getCasemanagementCaseAssociation

      public ApiResponse<CaseAssociation> getCasemanagementCaseAssociation(ApiRequest<Void> request) throws IOException
      Get a Case Association.
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • getCasemanagementCaseAssociations

      public CaseAssociationListing getCasemanagementCaseAssociations(String caseId, String before, String after, String pageSize) throws IOException, ApiException
      Get a list of Case associations for the Case.
      Parameters:
      caseId - Case identifier. (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)
      Returns:
      CaseAssociationListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getCasemanagementCaseAssociationsWithHttpInfo

      public ApiResponse<CaseAssociationListing> getCasemanagementCaseAssociationsWithHttpInfo(String caseId, String before, String after, String pageSize) throws IOException
      Get a list of Case associations for the Case.
      Parameters:
      caseId - Case identifier. (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)
      Returns:
      CaseAssociationListing
      Throws:
      IOException - if the request fails to be processed

    • getCasemanagementCaseAssociations

      public CaseAssociationListing getCasemanagementCaseAssociations(GetCasemanagementCaseAssociationsRequest request) throws IOException, ApiException
      Get a list of Case associations for the Case.
      Parameters:
      request - The request object
      Returns:
      CaseAssociationListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getCasemanagementCaseAssociations

      public ApiResponse<CaseAssociationListing> getCasemanagementCaseAssociations(ApiRequest<Void> request) throws IOException
      Get a list of Case associations for the Case.
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • getCasemanagementCaseStage

      public Stage getCasemanagementCaseStage(String caseId, String stageId) throws IOException, ApiException
      Get a Stage.
      Parameters:
      caseId - Case identifier. (required)
      stageId - Stage identifier. (required)
      Returns:
      Stage
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getCasemanagementCaseStageWithHttpInfo

      public ApiResponse<Stage> getCasemanagementCaseStageWithHttpInfo(String caseId, String stageId) throws IOException
      Get a Stage.
      Parameters:
      caseId - Case identifier. (required)
      stageId - Stage identifier. (required)
      Returns:
      Stage
      Throws:
      IOException - if the request fails to be processed

    • getCasemanagementCaseStage

      public Stage getCasemanagementCaseStage(GetCasemanagementCaseStageRequest request) throws IOException, ApiException
      Get a Stage.
      Parameters:
      request - The request object
      Returns:
      Stage
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getCasemanagementCaseStage

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

    • getCasemanagementCaseStageStep

      public Step getCasemanagementCaseStageStep(String caseId, String stageId, String stepId) throws IOException, ApiException
      Get a Step.
      Parameters:
      caseId - Case identifier. (required)
      stageId - Stage identifier. (required)
      stepId - Step identifier. (required)
      Returns:
      Step
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getCasemanagementCaseStageStepWithHttpInfo

      public ApiResponse<Step> getCasemanagementCaseStageStepWithHttpInfo(String caseId, String stageId, String stepId) throws IOException
      Get a Step.
      Parameters:
      caseId - Case identifier. (required)
      stageId - Stage identifier. (required)
      stepId - Step identifier. (required)
      Returns:
      Step
      Throws:
      IOException - if the request fails to be processed

    • getCasemanagementCaseStageStep

      public Step getCasemanagementCaseStageStep(GetCasemanagementCaseStageStepRequest request) throws IOException, ApiException
      Get a Step.
      Parameters:
      request - The request object
      Returns:
      Step
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getCasemanagementCaseStageStep

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

    • getCasemanagementCaseStageSteps

      public StepListing getCasemanagementCaseStageSteps(String caseId, String stageId, String before, String after, String pageSize) throws IOException, ApiException
      Get a list of Steps.
      Parameters:
      caseId - Case identifier. (required)
      stageId - Stage identifier. (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)
      Returns:
      StepListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getCasemanagementCaseStageStepsWithHttpInfo

      public ApiResponse<StepListing> getCasemanagementCaseStageStepsWithHttpInfo(String caseId, String stageId, String before, String after, String pageSize) throws IOException
      Get a list of Steps.
      Parameters:
      caseId - Case identifier. (required)
      stageId - Stage identifier. (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)
      Returns:
      StepListing
      Throws:
      IOException - if the request fails to be processed

    • getCasemanagementCaseStageSteps

      public StepListing getCasemanagementCaseStageSteps(GetCasemanagementCaseStageStepsRequest request) throws IOException, ApiException
      Get a list of Steps.
      Parameters:
      request - The request object
      Returns:
      StepListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getCasemanagementCaseStageSteps

      public ApiResponse<StepListing> getCasemanagementCaseStageSteps(ApiRequest<Void> request) throws IOException
      Get a list of Steps.
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • getCasemanagementCaseStages

      public StageListing getCasemanagementCaseStages(String caseId, String before, String after, String pageSize) throws IOException, ApiException
      Get a list of Stages.
      Parameters:
      caseId - Case identifier. (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)
      Returns:
      StageListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getCasemanagementCaseStagesWithHttpInfo

      public ApiResponse<StageListing> getCasemanagementCaseStagesWithHttpInfo(String caseId, String before, String after, String pageSize) throws IOException
      Get a list of Stages.
      Parameters:
      caseId - Case identifier. (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)
      Returns:
      StageListing
      Throws:
      IOException - if the request fails to be processed

    • getCasemanagementCaseStages

      public StageListing getCasemanagementCaseStages(GetCasemanagementCaseStagesRequest request) throws IOException, ApiException
      Get a list of Stages.
      Parameters:
      request - The request object
      Returns:
      StageListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getCasemanagementCaseStages

      public ApiResponse<StageListing> getCasemanagementCaseStages(ApiRequest<Void> request) throws IOException
      Get a list of Stages.
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • getCasemanagementCaseTerminateJob

      public TerminateJob getCasemanagementCaseTerminateJob(String caseId, String jobId) throws IOException, ApiException
      Get a Terminate Job for a Case.
      Parameters:
      caseId - Case identifier. (required)
      jobId - Terminate Job identifier. (required)
      Returns:
      TerminateJob
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getCasemanagementCaseTerminateJobWithHttpInfo

      public ApiResponse<TerminateJob> getCasemanagementCaseTerminateJobWithHttpInfo(String caseId, String jobId) throws IOException
      Get a Terminate Job for a Case.
      Parameters:
      caseId - Case identifier. (required)
      jobId - Terminate Job identifier. (required)
      Returns:
      TerminateJob
      Throws:
      IOException - if the request fails to be processed

    • getCasemanagementCaseTerminateJob

      public TerminateJob getCasemanagementCaseTerminateJob(GetCasemanagementCaseTerminateJobRequest request) throws IOException, ApiException
      Get a Terminate Job for a Case.
      Parameters:
      request - The request object
      Returns:
      TerminateJob
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getCasemanagementCaseTerminateJob

      public ApiResponse<TerminateJob> getCasemanagementCaseTerminateJob(ApiRequest<Void> request) throws IOException
      Get a Terminate Job for a Case.
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • getCasemanagementCaseplan

      public Caseplan getCasemanagementCaseplan(String caseplanId) throws IOException, ApiException
      Get a Caseplan.
      Parameters:
      caseplanId - Caseplan identifier. (required)
      Returns:
      Caseplan
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getCasemanagementCaseplanWithHttpInfo

      public ApiResponse<Caseplan> getCasemanagementCaseplanWithHttpInfo(String caseplanId) throws IOException
      Get a Caseplan.
      Parameters:
      caseplanId - Caseplan identifier. (required)
      Returns:
      Caseplan
      Throws:
      IOException - if the request fails to be processed

    • getCasemanagementCaseplan

      public Caseplan getCasemanagementCaseplan(GetCasemanagementCaseplanRequest request) throws IOException, ApiException
      Get a Caseplan.
      Parameters:
      request - The request object
      Returns:
      Caseplan
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getCasemanagementCaseplan

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

    • getCasemanagementCaseplanVersion

      public Caseplan getCasemanagementCaseplanVersion(String caseplanId, String versionId) throws IOException, ApiException
      Get a Caseplan version.
      Parameters:
      caseplanId - Caseplan identifier. (required)
      versionId - Caseplan version identifier. (required)
      Returns:
      Caseplan
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getCasemanagementCaseplanVersionWithHttpInfo

      public ApiResponse<Caseplan> getCasemanagementCaseplanVersionWithHttpInfo(String caseplanId, String versionId) throws IOException
      Get a Caseplan version.
      Parameters:
      caseplanId - Caseplan identifier. (required)
      versionId - Caseplan version identifier. (required)
      Returns:
      Caseplan
      Throws:
      IOException - if the request fails to be processed

    • getCasemanagementCaseplanVersion

      public Caseplan getCasemanagementCaseplanVersion(GetCasemanagementCaseplanVersionRequest request) throws IOException, ApiException
      Get a Caseplan version.
      Parameters:
      request - The request object
      Returns:
      Caseplan
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getCasemanagementCaseplanVersion

      public ApiResponse<Caseplan> getCasemanagementCaseplanVersion(ApiRequest<Void> request) throws IOException
      Get a Caseplan version.
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • getCasemanagementCaseplanVersionDataschemas

      public CaseplanDataSchemaListing getCasemanagementCaseplanVersionDataschemas(String caseplanId, String versionId) throws IOException, ApiException
      Get the data schemas for a Caseplan version.
      Parameters:
      caseplanId - Caseplan identifier. (required)
      versionId - Caseplan version identifier. (required)
      Returns:
      CaseplanDataSchemaListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getCasemanagementCaseplanVersionDataschemasWithHttpInfo

      public ApiResponse<CaseplanDataSchemaListing> getCasemanagementCaseplanVersionDataschemasWithHttpInfo(String caseplanId, String versionId) throws IOException
      Get the data schemas for a Caseplan version.
      Parameters:
      caseplanId - Caseplan identifier. (required)
      versionId - Caseplan version identifier. (required)
      Returns:
      CaseplanDataSchemaListing
      Throws:
      IOException - if the request fails to be processed

    • getCasemanagementCaseplanVersionDataschemas

      public CaseplanDataSchemaListing getCasemanagementCaseplanVersionDataschemas(GetCasemanagementCaseplanVersionDataschemasRequest request) throws IOException, ApiException
      Get the data schemas for a Caseplan version.
      Parameters:
      request - The request object
      Returns:
      CaseplanDataSchemaListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getCasemanagementCaseplanVersionDataschemas

      public ApiResponse<CaseplanDataSchemaListing> getCasemanagementCaseplanVersionDataschemas(ApiRequest<Void> request) throws IOException
      Get the data schemas for a Caseplan version.
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • getCasemanagementCaseplanVersionIntakesettings

      public IntakeSettingsListing getCasemanagementCaseplanVersionIntakesettings(String caseplanId, String versionId) throws IOException, ApiException
      Get the intake settings for a Caseplan version.
      Parameters:
      caseplanId - Caseplan identifier. (required)
      versionId - Caseplan version identifier. (required)
      Returns:
      IntakeSettingsListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getCasemanagementCaseplanVersionIntakesettingsWithHttpInfo

      public ApiResponse<IntakeSettingsListing> getCasemanagementCaseplanVersionIntakesettingsWithHttpInfo(String caseplanId, String versionId) throws IOException
      Get the intake settings for a Caseplan version.
      Parameters:
      caseplanId - Caseplan identifier. (required)
      versionId - Caseplan version identifier. (required)
      Returns:
      IntakeSettingsListing
      Throws:
      IOException - if the request fails to be processed

    • getCasemanagementCaseplanVersionIntakesettings

      public IntakeSettingsListing getCasemanagementCaseplanVersionIntakesettings(GetCasemanagementCaseplanVersionIntakesettingsRequest request) throws IOException, ApiException
      Get the intake settings for a Caseplan version.
      Parameters:
      request - The request object
      Returns:
      IntakeSettingsListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getCasemanagementCaseplanVersionIntakesettings

      public ApiResponse<IntakeSettingsListing> getCasemanagementCaseplanVersionIntakesettings(ApiRequest<Void> request) throws IOException
      Get the intake settings for a Caseplan version.
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • getCasemanagementCaseplanVersionStageplan

      public Stageplan getCasemanagementCaseplanVersionStageplan(String caseplanId, String versionId, String stageplanId, List<String> expands) throws IOException, ApiException
      Get a Stageplan.
      Parameters:
      caseplanId - Caseplan identifier. (required)
      versionId - Caseplan version identifier. (required)
      stageplanId - Stageplan identifier. (required)
      expands - Fields to expand. (optional)
      Returns:
      Stageplan
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getCasemanagementCaseplanVersionStageplanWithHttpInfo

      public ApiResponse<Stageplan> getCasemanagementCaseplanVersionStageplanWithHttpInfo(String caseplanId, String versionId, String stageplanId, List<String> expands) throws IOException
      Get a Stageplan.
      Parameters:
      caseplanId - Caseplan identifier. (required)
      versionId - Caseplan version identifier. (required)
      stageplanId - Stageplan identifier. (required)
      expands - Fields to expand. (optional)
      Returns:
      Stageplan
      Throws:
      IOException - if the request fails to be processed

    • getCasemanagementCaseplanVersionStageplan

      public Stageplan getCasemanagementCaseplanVersionStageplan(GetCasemanagementCaseplanVersionStageplanRequest request) throws IOException, ApiException
      Get a Stageplan.
      Parameters:
      request - The request object
      Returns:
      Stageplan
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getCasemanagementCaseplanVersionStageplan

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

    • getCasemanagementCaseplanVersionStageplanStepplan

      public Stepplan getCasemanagementCaseplanVersionStageplanStepplan(String caseplanId, String versionId, String stageplanId, String stepplanId, List<String> expands) throws IOException, ApiException
      Get a Stepplan.
      Parameters:
      caseplanId - Caseplan identifier. (required)
      versionId - Caseplan version identifier. (required)
      stageplanId - Stageplan identifier. (required)
      stepplanId - Stepplan identifier. (required)
      expands - Fields to expand. (optional)
      Returns:
      Stepplan
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getCasemanagementCaseplanVersionStageplanStepplanWithHttpInfo

      public ApiResponse<Stepplan> getCasemanagementCaseplanVersionStageplanStepplanWithHttpInfo(String caseplanId, String versionId, String stageplanId, String stepplanId, List<String> expands) throws IOException
      Get a Stepplan.
      Parameters:
      caseplanId - Caseplan identifier. (required)
      versionId - Caseplan version identifier. (required)
      stageplanId - Stageplan identifier. (required)
      stepplanId - Stepplan identifier. (required)
      expands - Fields to expand. (optional)
      Returns:
      Stepplan
      Throws:
      IOException - if the request fails to be processed

    • getCasemanagementCaseplanVersionStageplanStepplan

      public Stepplan getCasemanagementCaseplanVersionStageplanStepplan(GetCasemanagementCaseplanVersionStageplanStepplanRequest request) throws IOException, ApiException
      Get a Stepplan.
      Parameters:
      request - The request object
      Returns:
      Stepplan
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getCasemanagementCaseplanVersionStageplanStepplan

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

    • getCasemanagementCaseplanVersionStageplanStepplans

      public StepplanListing getCasemanagementCaseplanVersionStageplanStepplans(String caseplanId, String versionId, String stageplanId, String before, String after, String pageSize, List<String> expands) throws IOException, ApiException
      Get a list of Stepplans.
      Parameters:
      caseplanId - Caseplan identifier. (required)
      versionId - Caseplan version identifier. (required)
      stageplanId - Stageplan identifier. (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)
      expands - Fields to expand. (optional)
      Returns:
      StepplanListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getCasemanagementCaseplanVersionStageplanStepplansWithHttpInfo

      public ApiResponse<StepplanListing> getCasemanagementCaseplanVersionStageplanStepplansWithHttpInfo(String caseplanId, String versionId, String stageplanId, String before, String after, String pageSize, List<String> expands) throws IOException
      Get a list of Stepplans.
      Parameters:
      caseplanId - Caseplan identifier. (required)
      versionId - Caseplan version identifier. (required)
      stageplanId - Stageplan identifier. (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)
      expands - Fields to expand. (optional)
      Returns:
      StepplanListing
      Throws:
      IOException - if the request fails to be processed

    • getCasemanagementCaseplanVersionStageplanStepplans

      public StepplanListing getCasemanagementCaseplanVersionStageplanStepplans(GetCasemanagementCaseplanVersionStageplanStepplansRequest request) throws IOException, ApiException
      Get a list of Stepplans.
      Parameters:
      request - The request object
      Returns:
      StepplanListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getCasemanagementCaseplanVersionStageplanStepplans

      public ApiResponse<StepplanListing> getCasemanagementCaseplanVersionStageplanStepplans(ApiRequest<Void> request) throws IOException
      Get a list of Stepplans.
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • getCasemanagementCaseplanVersionStageplans

      public StageplanListing getCasemanagementCaseplanVersionStageplans(String caseplanId, String versionId, String before, String after, String pageSize, List<String> expands) throws IOException, ApiException
      Get a list of Stageplans.
      Parameters:
      caseplanId - Caseplan identifier. (required)
      versionId - Caseplan version identifier. (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)
      expands - Fields to expand. (optional)
      Returns:
      StageplanListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getCasemanagementCaseplanVersionStageplansWithHttpInfo

      public ApiResponse<StageplanListing> getCasemanagementCaseplanVersionStageplansWithHttpInfo(String caseplanId, String versionId, String before, String after, String pageSize, List<String> expands) throws IOException
      Get a list of Stageplans.
      Parameters:
      caseplanId - Caseplan identifier. (required)
      versionId - Caseplan version identifier. (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)
      expands - Fields to expand. (optional)
      Returns:
      StageplanListing
      Throws:
      IOException - if the request fails to be processed

    • getCasemanagementCaseplanVersionStageplans

      public StageplanListing getCasemanagementCaseplanVersionStageplans(GetCasemanagementCaseplanVersionStageplansRequest request) throws IOException, ApiException
      Get a list of Stageplans.
      Parameters:
      request - The request object
      Returns:
      StageplanListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getCasemanagementCaseplanVersionStageplans

      public ApiResponse<StageplanListing> getCasemanagementCaseplanVersionStageplans(ApiRequest<Void> request) throws IOException
      Get a list of Stageplans.
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • getCasemanagementCaseplans

      public CaseplanListing getCasemanagementCaseplans(String after, Integer pageSize, String customerIntentId, String divisionIds) throws IOException, ApiException
      Get a list of Caseplans.
      Parameters:
      after - Cursor that points to the end of the previously returned set of Caseplans. (optional)
      pageSize - Number of Caseplans to return. Maximum is 200. (optional)
      customerIntentId - Filter by customer intent. (optional)
      divisionIds - Filter by divisions. (optional)
      Returns:
      CaseplanListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getCasemanagementCaseplansWithHttpInfo

      public ApiResponse<CaseplanListing> getCasemanagementCaseplansWithHttpInfo(String after, Integer pageSize, String customerIntentId, String divisionIds) throws IOException
      Get a list of Caseplans.
      Parameters:
      after - Cursor that points to the end of the previously returned set of Caseplans. (optional)
      pageSize - Number of Caseplans to return. Maximum is 200. (optional)
      customerIntentId - Filter by customer intent. (optional)
      divisionIds - Filter by divisions. (optional)
      Returns:
      CaseplanListing
      Throws:
      IOException - if the request fails to be processed

    • getCasemanagementCaseplans

      public CaseplanListing getCasemanagementCaseplans(GetCasemanagementCaseplansRequest request) throws IOException, ApiException
      Get a list of Caseplans.
      Parameters:
      request - The request object
      Returns:
      CaseplanListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getCasemanagementCaseplans

      public ApiResponse<CaseplanListing> getCasemanagementCaseplans(ApiRequest<Void> request) throws IOException
      Get a list of Caseplans.
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • getCasemanagementCasesExternalcontact

      public CaseListing getCasemanagementCasesExternalcontact(String externalContactId, String after, Integer pageSize, String divisionIds, List<String> expands) throws IOException, ApiException
      Get a list of Cases for an External Contact.
      Parameters:
      externalContactId - External contact identifier. (required)
      after - Cursor pointing to the end of the previously returned page of Cases. (optional)
      pageSize - Number of Cases to return (maximum 200). (optional)
      divisionIds - Filter by divisions. (optional)
      expands - Fields to expand. (optional)
      Returns:
      CaseListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getCasemanagementCasesExternalcontactWithHttpInfo

      public ApiResponse<CaseListing> getCasemanagementCasesExternalcontactWithHttpInfo(String externalContactId, String after, Integer pageSize, String divisionIds, List<String> expands) throws IOException
      Get a list of Cases for an External Contact.
      Parameters:
      externalContactId - External contact identifier. (required)
      after - Cursor pointing to the end of the previously returned page of Cases. (optional)
      pageSize - Number of Cases to return (maximum 200). (optional)
      divisionIds - Filter by divisions. (optional)
      expands - Fields to expand. (optional)
      Returns:
      CaseListing
      Throws:
      IOException - if the request fails to be processed

    • getCasemanagementCasesExternalcontact

      public CaseListing getCasemanagementCasesExternalcontact(GetCasemanagementCasesExternalcontactRequest request) throws IOException, ApiException
      Get a list of Cases for an External Contact.
      Parameters:
      request - The request object
      Returns:
      CaseListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getCasemanagementCasesExternalcontact

      public ApiResponse<CaseListing> getCasemanagementCasesExternalcontact(ApiRequest<Void> request) throws IOException
      Get a list of Cases for an External Contact.
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • getCasemanagementCasesReference

      public ModelCase getCasemanagementCasesReference(String referenceId, String expands) throws IOException, ApiException
      Get a Case by reference.
      Parameters:
      referenceId - Case reference. (required)
      expands - Fields to expand. (optional)
      Returns:
      ModelCase
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getCasemanagementCasesReferenceWithHttpInfo

      public ApiResponse<ModelCase> getCasemanagementCasesReferenceWithHttpInfo(String referenceId, String expands) throws IOException
      Get a Case by reference.
      Parameters:
      referenceId - Case reference. (required)
      expands - Fields to expand. (optional)
      Returns:
      ModelCase
      Throws:
      IOException - if the request fails to be processed

    • getCasemanagementCasesReference

      public ModelCase getCasemanagementCasesReference(GetCasemanagementCasesReferenceRequest request) throws IOException, ApiException
      Get a Case by reference.
      Parameters:
      request - The request object
      Returns:
      ModelCase
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getCasemanagementCasesReference

      public ApiResponse<ModelCase> getCasemanagementCasesReference(ApiRequest<Void> request) throws IOException
      Get a Case by reference.
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • patchCasemanagementCaseDatedue

      public ModelCase patchCasemanagementCaseDatedue(String caseId, CaseDateDueUpdate body) throws IOException, ApiException
      Update the due date of a Case.
      Parameters:
      caseId - Case identifier. (required)
      body - Due date update. (required)
      Returns:
      ModelCase
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • patchCasemanagementCaseDatedueWithHttpInfo

      public ApiResponse<ModelCase> patchCasemanagementCaseDatedueWithHttpInfo(String caseId, CaseDateDueUpdate body) throws IOException
      Update the due date of a Case.
      Parameters:
      caseId - Case identifier. (required)
      body - Due date update. (required)
      Returns:
      ModelCase
      Throws:
      IOException - if the request fails to be processed

    • patchCasemanagementCaseDatedue

      public ModelCase patchCasemanagementCaseDatedue(PatchCasemanagementCaseDatedueRequest request) throws IOException, ApiException
      Update the due date of a Case.
      Parameters:
      request - The request object
      Returns:
      ModelCase
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • patchCasemanagementCaseDatedue

      public ApiResponse<ModelCase> patchCasemanagementCaseDatedue(ApiRequest<CaseDateDueUpdate> request) throws IOException
      Update the due date of a Case.
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • patchCasemanagementCasePriority

      public ModelCase patchCasemanagementCasePriority(String caseId, CasePriorityUpdate body) throws IOException, ApiException
      Update priority of a Case.
      Parameters:
      caseId - Case identifier. (required)
      body - Priority update. (required)
      Returns:
      ModelCase
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • patchCasemanagementCasePriorityWithHttpInfo

      public ApiResponse<ModelCase> patchCasemanagementCasePriorityWithHttpInfo(String caseId, CasePriorityUpdate body) throws IOException
      Update priority of a Case.
      Parameters:
      caseId - Case identifier. (required)
      body - Priority update. (required)
      Returns:
      ModelCase
      Throws:
      IOException - if the request fails to be processed

    • patchCasemanagementCasePriority

      public ModelCase patchCasemanagementCasePriority(PatchCasemanagementCasePriorityRequest request) throws IOException, ApiException
      Update priority of a Case.
      Parameters:
      request - The request object
      Returns:
      ModelCase
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • patchCasemanagementCasePriority

      public ApiResponse<ModelCase> patchCasemanagementCasePriority(ApiRequest<CasePriorityUpdate> request) throws IOException
      Update priority of a Case.
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • patchCasemanagementCaseSummary

      public ModelCase patchCasemanagementCaseSummary(String caseId, CaseSummaryUpdate body) throws IOException, ApiException
      Update summary of a Case.
      Parameters:
      caseId - Case identifier. (required)
      body - Summary update. (required)
      Returns:
      ModelCase
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • patchCasemanagementCaseSummaryWithHttpInfo

      public ApiResponse<ModelCase> patchCasemanagementCaseSummaryWithHttpInfo(String caseId, CaseSummaryUpdate body) throws IOException
      Update summary of a Case.
      Parameters:
      caseId - Case identifier. (required)
      body - Summary update. (required)
      Returns:
      ModelCase
      Throws:
      IOException - if the request fails to be processed

    • patchCasemanagementCaseSummary

      public ModelCase patchCasemanagementCaseSummary(PatchCasemanagementCaseSummaryRequest request) throws IOException, ApiException
      Update summary of a Case.
      Parameters:
      request - The request object
      Returns:
      ModelCase
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • patchCasemanagementCaseSummary

      public ApiResponse<ModelCase> patchCasemanagementCaseSummary(ApiRequest<CaseSummaryUpdate> request) throws IOException
      Update summary of a Case.
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • patchCasemanagementCaseplan

      public Caseplan patchCasemanagementCaseplan(String caseplanId, CaseplanUpdate body) throws IOException, ApiException
      Update the attributes of a Caseplan.
      Parameters:
      caseplanId - Caseplan identifier. (required)
      body - Caseplan update. (required)
      Returns:
      Caseplan
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • patchCasemanagementCaseplanWithHttpInfo

      public ApiResponse<Caseplan> patchCasemanagementCaseplanWithHttpInfo(String caseplanId, CaseplanUpdate body) throws IOException
      Update the attributes of a Caseplan.
      Parameters:
      caseplanId - Caseplan identifier. (required)
      body - Caseplan update. (required)
      Returns:
      Caseplan
      Throws:
      IOException - if the request fails to be processed

    • patchCasemanagementCaseplan

      public Caseplan patchCasemanagementCaseplan(PatchCasemanagementCaseplanRequest request) throws IOException, ApiException
      Update the attributes of a Caseplan.
      Parameters:
      request - The request object
      Returns:
      Caseplan
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • patchCasemanagementCaseplan

      public ApiResponse<Caseplan> patchCasemanagementCaseplan(ApiRequest<CaseplanUpdate> request) throws IOException
      Update the attributes of a Caseplan.
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • patchCasemanagementCaseplanStageplan

      public Stageplan patchCasemanagementCaseplanStageplan(String caseplanId, String stageplanId, StageplanUpdate body) throws IOException, ApiException
      Update the attributes of a Stageplan.
      Parameters:
      caseplanId - Caseplan identifier. (required)
      stageplanId - Stageplan identifier. (required)
      body - Stageplan update. (required)
      Returns:
      Stageplan
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • patchCasemanagementCaseplanStageplanWithHttpInfo

      public ApiResponse<Stageplan> patchCasemanagementCaseplanStageplanWithHttpInfo(String caseplanId, String stageplanId, StageplanUpdate body) throws IOException
      Update the attributes of a Stageplan.
      Parameters:
      caseplanId - Caseplan identifier. (required)
      stageplanId - Stageplan identifier. (required)
      body - Stageplan update. (required)
      Returns:
      Stageplan
      Throws:
      IOException - if the request fails to be processed

    • patchCasemanagementCaseplanStageplan

      public Stageplan patchCasemanagementCaseplanStageplan(PatchCasemanagementCaseplanStageplanRequest request) throws IOException, ApiException
      Update the attributes of a Stageplan.
      Parameters:
      request - The request object
      Returns:
      Stageplan
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • patchCasemanagementCaseplanStageplan

      public ApiResponse<Stageplan> patchCasemanagementCaseplanStageplan(ApiRequest<StageplanUpdate> request) throws IOException
      Update the attributes of a Stageplan.
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • patchCasemanagementCaseplanStageplanStepplan

      public Stepplan patchCasemanagementCaseplanStageplanStepplan(String caseplanId, String stageplanId, String stepplanId, StepplanUpdate body) throws IOException, ApiException
      Update the attributes of a Stepplan.
      Parameters:
      caseplanId - Caseplan identifier. (required)
      stageplanId - Stageplan identifier. (required)
      stepplanId - Stepplan identifier. (required)
      body - Stepplan update. (required)
      Returns:
      Stepplan
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • patchCasemanagementCaseplanStageplanStepplanWithHttpInfo

      public ApiResponse<Stepplan> patchCasemanagementCaseplanStageplanStepplanWithHttpInfo(String caseplanId, String stageplanId, String stepplanId, StepplanUpdate body) throws IOException
      Update the attributes of a Stepplan.
      Parameters:
      caseplanId - Caseplan identifier. (required)
      stageplanId - Stageplan identifier. (required)
      stepplanId - Stepplan identifier. (required)
      body - Stepplan update. (required)
      Returns:
      Stepplan
      Throws:
      IOException - if the request fails to be processed

    • patchCasemanagementCaseplanStageplanStepplan

      public Stepplan patchCasemanagementCaseplanStageplanStepplan(PatchCasemanagementCaseplanStageplanStepplanRequest request) throws IOException, ApiException
      Update the attributes of a Stepplan.
      Parameters:
      request - The request object
      Returns:
      Stepplan
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • patchCasemanagementCaseplanStageplanStepplan

      public ApiResponse<Stepplan> patchCasemanagementCaseplanStageplanStepplan(ApiRequest<StepplanUpdate> request) throws IOException
      Update the attributes of a Stepplan.
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • postCasemanagementCaseAssociations

      public CaseAssociation postCasemanagementCaseAssociations(String caseId, CaseAssociationCreate body) throws IOException, ApiException
      Create a Case association.
      Parameters:
      caseId - Case identifier. (required)
      body - Case association create request. (required)
      Returns:
      CaseAssociation
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • postCasemanagementCaseAssociationsWithHttpInfo

      public ApiResponse<CaseAssociation> postCasemanagementCaseAssociationsWithHttpInfo(String caseId, CaseAssociationCreate body) throws IOException
      Create a Case association.
      Parameters:
      caseId - Case identifier. (required)
      body - Case association create request. (required)
      Returns:
      CaseAssociation
      Throws:
      IOException - if the request fails to be processed

    • postCasemanagementCaseAssociations

      public CaseAssociation postCasemanagementCaseAssociations(PostCasemanagementCaseAssociationsRequest request) throws IOException, ApiException
      Create a Case association.
      Parameters:
      request - The request object
      Returns:
      CaseAssociation
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • postCasemanagementCaseAssociations

      public ApiResponse<CaseAssociation> postCasemanagementCaseAssociations(ApiRequest<CaseAssociationCreate> request) throws IOException
      Create a Case association.
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • postCasemanagementCaseTerminateJobs

      public TerminateJob postCasemanagementCaseTerminateJobs(String caseId) throws IOException, ApiException
      Create a Terminate Job for a Case.
      Parameters:
      caseId - Case identifier. (required)
      Returns:
      TerminateJob
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • postCasemanagementCaseTerminateJobsWithHttpInfo

      public ApiResponse<TerminateJob> postCasemanagementCaseTerminateJobsWithHttpInfo(String caseId) throws IOException
      Create a Terminate Job for a Case.
      Parameters:
      caseId - Case identifier. (required)
      Returns:
      TerminateJob
      Throws:
      IOException - if the request fails to be processed

    • postCasemanagementCaseTerminateJobs

      public TerminateJob postCasemanagementCaseTerminateJobs(PostCasemanagementCaseTerminateJobsRequest request) throws IOException, ApiException
      Create a Terminate Job for a Case.
      Parameters:
      request - The request object
      Returns:
      TerminateJob
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • postCasemanagementCaseTerminateJobs

      public ApiResponse<TerminateJob> postCasemanagementCaseTerminateJobs(ApiRequest<Void> request) throws IOException
      Create a Terminate Job for a Case.
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • postCasemanagementCaseplanDataschemas

      public CaseplanDataSchema postCasemanagementCaseplanDataschemas(String caseplanId, CaseplanDataSchemaRequest body) throws IOException, ApiException
      Add a data schema to a draft Caseplan.
      Parameters:
      caseplanId - Caseplan identifier. (required)
      body - Data schema reference. (required)
      Returns:
      CaseplanDataSchema
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • postCasemanagementCaseplanDataschemasWithHttpInfo

      public ApiResponse<CaseplanDataSchema> postCasemanagementCaseplanDataschemasWithHttpInfo(String caseplanId, CaseplanDataSchemaRequest body) throws IOException
      Add a data schema to a draft Caseplan.
      Parameters:
      caseplanId - Caseplan identifier. (required)
      body - Data schema reference. (required)
      Returns:
      CaseplanDataSchema
      Throws:
      IOException - if the request fails to be processed

    • postCasemanagementCaseplanDataschemas

      public CaseplanDataSchema postCasemanagementCaseplanDataschemas(PostCasemanagementCaseplanDataschemasRequest request) throws IOException, ApiException
      Add a data schema to a draft Caseplan.
      Parameters:
      request - The request object
      Returns:
      CaseplanDataSchema
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • postCasemanagementCaseplanDataschemas

      public ApiResponse<CaseplanDataSchema> postCasemanagementCaseplanDataschemas(ApiRequest<CaseplanDataSchemaRequest> request) throws IOException
      Add a data schema to a draft Caseplan.
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • postCasemanagementCaseplanPublish

      public Caseplan postCasemanagementCaseplanPublish(String caseplanId) throws IOException, ApiException
      Publish Caseplan.
      Parameters:
      caseplanId - Caseplan identifier. (required)
      Returns:
      Caseplan
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • postCasemanagementCaseplanPublishWithHttpInfo

      public ApiResponse<Caseplan> postCasemanagementCaseplanPublishWithHttpInfo(String caseplanId) throws IOException
      Publish Caseplan.
      Parameters:
      caseplanId - Caseplan identifier. (required)
      Returns:
      Caseplan
      Throws:
      IOException - if the request fails to be processed

    • postCasemanagementCaseplanPublish

      public Caseplan postCasemanagementCaseplanPublish(PostCasemanagementCaseplanPublishRequest request) throws IOException, ApiException
      Publish Caseplan.
      Parameters:
      request - The request object
      Returns:
      Caseplan
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • postCasemanagementCaseplanPublish

      public ApiResponse<Caseplan> postCasemanagementCaseplanPublish(ApiRequest<Void> request) throws IOException
      Publish Caseplan.
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • postCasemanagementCaseplanVersions

      public Caseplan postCasemanagementCaseplanVersions(String caseplanId) throws IOException, ApiException
      Create Caseplan version.
      Parameters:
      caseplanId - Caseplan identifier. (required)
      Returns:
      Caseplan
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • postCasemanagementCaseplanVersionsWithHttpInfo

      public ApiResponse<Caseplan> postCasemanagementCaseplanVersionsWithHttpInfo(String caseplanId) throws IOException
      Create Caseplan version.
      Parameters:
      caseplanId - Caseplan identifier. (required)
      Returns:
      Caseplan
      Throws:
      IOException - if the request fails to be processed

    • postCasemanagementCaseplanVersions

      public Caseplan postCasemanagementCaseplanVersions(PostCasemanagementCaseplanVersionsRequest request) throws IOException, ApiException
      Create Caseplan version.
      Parameters:
      request - The request object
      Returns:
      Caseplan
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • postCasemanagementCaseplanVersions

      public ApiResponse<Caseplan> postCasemanagementCaseplanVersions(ApiRequest<Void> request) throws IOException
      Create Caseplan version.
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • postCasemanagementCaseplans

      public CaseplanCreateResponse postCasemanagementCaseplans(CaseplanCreate body) throws IOException, ApiException
      Create a Caseplan.
      Parameters:
      body - Caseplan create request. (required)
      Returns:
      CaseplanCreateResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • postCasemanagementCaseplansWithHttpInfo

      public ApiResponse<CaseplanCreateResponse> postCasemanagementCaseplansWithHttpInfo(CaseplanCreate body) throws IOException
      Create a Caseplan.
      Parameters:
      body - Caseplan create request. (required)
      Returns:
      CaseplanCreateResponse
      Throws:
      IOException - if the request fails to be processed

    • postCasemanagementCaseplans

      public CaseplanCreateResponse postCasemanagementCaseplans(PostCasemanagementCaseplansRequest request) throws IOException, ApiException
      Create a Caseplan.
      Parameters:
      request - The request object
      Returns:
      CaseplanCreateResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • postCasemanagementCaseplans

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

    • postCasemanagementCaseplansQuery

      public CaseplanQueryEntityListing postCasemanagementCaseplansQuery(CaseplanQueryRequest body) throws IOException, ApiException
      Query for Caseplans.
      Parameters:
      body - Caseplan query request. (required)
      Returns:
      CaseplanQueryEntityListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • postCasemanagementCaseplansQueryWithHttpInfo

      public ApiResponse<CaseplanQueryEntityListing> postCasemanagementCaseplansQueryWithHttpInfo(CaseplanQueryRequest body) throws IOException
      Query for Caseplans.
      Parameters:
      body - Caseplan query request. (required)
      Returns:
      CaseplanQueryEntityListing
      Throws:
      IOException - if the request fails to be processed

    • postCasemanagementCaseplansQuery

      public CaseplanQueryEntityListing postCasemanagementCaseplansQuery(PostCasemanagementCaseplansQueryRequest request) throws IOException, ApiException
      Query for Caseplans.
      Parameters:
      request - The request object
      Returns:
      CaseplanQueryEntityListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • postCasemanagementCaseplansQuery

      public ApiResponse<CaseplanQueryEntityListing> postCasemanagementCaseplansQuery(ApiRequest<CaseplanQueryRequest> request) throws IOException
      Query for Caseplans.
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • postCasemanagementCases

      public ModelCase postCasemanagementCases(CaseCreate body) throws IOException, ApiException
      Create a Case.
      Parameters:
      body - Case create request. (required)
      Returns:
      ModelCase
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • postCasemanagementCasesWithHttpInfo

      public ApiResponse<ModelCase> postCasemanagementCasesWithHttpInfo(CaseCreate body) throws IOException
      Create a Case.
      Parameters:
      body - Case create request. (required)
      Returns:
      ModelCase
      Throws:
      IOException - if the request fails to be processed

    • postCasemanagementCases

      public ModelCase postCasemanagementCases(PostCasemanagementCasesRequest request) throws IOException, ApiException
      Create a Case.
      Parameters:
      request - The request object
      Returns:
      ModelCase
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • postCasemanagementCases

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

    • postCasemanagementCasesAssociationsQuery

      public CaseAssociationQueryEntityListing postCasemanagementCasesAssociationsQuery(CaseAssociationQuery body) throws IOException, ApiException
      Query for Case associations by interaction.
      Parameters:
      body - Case association query request. (required)
      Returns:
      CaseAssociationQueryEntityListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • postCasemanagementCasesAssociationsQueryWithHttpInfo

      public ApiResponse<CaseAssociationQueryEntityListing> postCasemanagementCasesAssociationsQueryWithHttpInfo(CaseAssociationQuery body) throws IOException
      Query for Case associations by interaction.
      Parameters:
      body - Case association query request. (required)
      Returns:
      CaseAssociationQueryEntityListing
      Throws:
      IOException - if the request fails to be processed

    • postCasemanagementCasesAssociationsQuery

      public CaseAssociationQueryEntityListing postCasemanagementCasesAssociationsQuery(PostCasemanagementCasesAssociationsQueryRequest request) throws IOException, ApiException
      Query for Case associations by interaction.
      Parameters:
      request - The request object
      Returns:
      CaseAssociationQueryEntityListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • postCasemanagementCasesAssociationsQuery

      public ApiResponse<CaseAssociationQueryEntityListing> postCasemanagementCasesAssociationsQuery(ApiRequest<CaseAssociationQuery> request) throws IOException
      Query for Case associations by interaction.
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • putCasemanagementCaseplanDataschema

      public CaseplanDataSchema putCasemanagementCaseplanDataschema(String caseplanId, String schemaKeyName, CaseplanDataSchemaRequest body) throws IOException, ApiException
      Update a data schema on a draft Caseplan.
      Parameters:
      caseplanId - Caseplan identifier. (required)
      schemaKeyName - Schema key (for example \"default\"). (required)
      body - Data schema reference. (required)
      Returns:
      CaseplanDataSchema
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • putCasemanagementCaseplanDataschemaWithHttpInfo

      public ApiResponse<CaseplanDataSchema> putCasemanagementCaseplanDataschemaWithHttpInfo(String caseplanId, String schemaKeyName, CaseplanDataSchemaRequest body) throws IOException
      Update a data schema on a draft Caseplan.
      Parameters:
      caseplanId - Caseplan identifier. (required)
      schemaKeyName - Schema key (for example \"default\"). (required)
      body - Data schema reference. (required)
      Returns:
      CaseplanDataSchema
      Throws:
      IOException - if the request fails to be processed

    • putCasemanagementCaseplanDataschema

      public CaseplanDataSchema putCasemanagementCaseplanDataschema(PutCasemanagementCaseplanDataschemaRequest request) throws IOException, ApiException
      Update a data schema on a draft Caseplan.
      Parameters:
      request - The request object
      Returns:
      CaseplanDataSchema
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • putCasemanagementCaseplanDataschema

      public ApiResponse<CaseplanDataSchema> putCasemanagementCaseplanDataschema(ApiRequest<CaseplanDataSchemaRequest> request) throws IOException
      Update a data schema on a draft Caseplan.
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • putCasemanagementCaseplanIntakesettings

      public IntakeSettingsListing putCasemanagementCaseplanIntakesettings(String caseplanId, IntakeSettingsUpdate body) throws IOException, ApiException
      Update the intake settings for a Caseplan.
      Parameters:
      caseplanId - Caseplan identifier. (required)
      body - Intake settings update. (required)
      Returns:
      IntakeSettingsListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • putCasemanagementCaseplanIntakesettingsWithHttpInfo

      public ApiResponse<IntakeSettingsListing> putCasemanagementCaseplanIntakesettingsWithHttpInfo(String caseplanId, IntakeSettingsUpdate body) throws IOException
      Update the intake settings for a Caseplan.
      Parameters:
      caseplanId - Caseplan identifier. (required)
      body - Intake settings update. (required)
      Returns:
      IntakeSettingsListing
      Throws:
      IOException - if the request fails to be processed

    • putCasemanagementCaseplanIntakesettings

      public IntakeSettingsListing putCasemanagementCaseplanIntakesettings(PutCasemanagementCaseplanIntakesettingsRequest request) throws IOException, ApiException
      Update the intake settings for a Caseplan.
      Parameters:
      request - The request object
      Returns:
      IntakeSettingsListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • putCasemanagementCaseplanIntakesettings

      public ApiResponse<IntakeSettingsListing> putCasemanagementCaseplanIntakesettings(ApiRequest<IntakeSettingsUpdate> request) throws IOException
      Update the intake settings for a Caseplan.
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed