Package com.docusign.maestro.api

Class WorkflowManagementApi

java.lang.Object

com.docusign.maestro.api.WorkflowManagementApi

public class WorkflowManagementApi
extends Object

WorkflowManagementApi class.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
class	WorkflowManagementApi.GetWorkflowDefinitionOptions	GetWorkflowDefinitionOptions Class.
class	WorkflowManagementApi.GetWorkflowDefinitionsOptions	GetWorkflowDefinitionsOptions Class.

Constructor Summary

Constructors

Constructor	Description
WorkflowManagementApi()	WorkflowManagementApi.
WorkflowManagementApi(ApiClient apiClient)	WorkflowManagementApi.

Method Summary

Modifier and Type	Method	Description
NewOrUpdatedWorkflowDefinitionResponse	createWorkflowDefinition(String accountId, CreateOrUpdateWorkflowDefinitionRequestBody body)	Creates a new workflow definition..
ApiResponse<NewOrUpdatedWorkflowDefinitionResponse>	createWorkflowDefinitionWithHttpInfo(String accountId, CreateOrUpdateWorkflowDefinitionRequestBody body)	Creates a new workflow definition.
WorkflowDeleteResponse	deleteWorkflowDefinition(String accountId, String workflowDefinitionId)	Deletes a workflow definition..
ApiResponse<WorkflowDeleteResponse>	deleteWorkflowDefinitionWithHttpInfo(String accountId, String workflowDefinitionId)	Deletes a workflow definition.
ApiClient	getApiClient()	getApiClient Method.
WorkflowDefinitionWithId	getWorkflowDefinition(String accountId, String workflowDefinitionId)	Get Workflow Definition.
WorkflowDefinitionWithId	getWorkflowDefinition(String accountId, String workflowDefinitionId, WorkflowManagementApi.GetWorkflowDefinitionOptions options)	Get Workflow Definition.
GetConfigurationInstancesResponse	getWorkflowDefinitionConfigInstances(String accountId, String workflowDefinitionId)	Gets configuration instances.
ApiResponse<GetConfigurationInstancesResponse>	getWorkflowDefinitionConfigInstancesWithHttpInfo(String accountId, String workflowDefinitionId)	Gets configuration instances Returns a list of configuration instances for a workflow definition
WorkflowDefinitionList	getWorkflowDefinitions(String accountId)	Get Workflow Definitions metadata.
WorkflowDefinitionList	getWorkflowDefinitions(String accountId, WorkflowManagementApi.GetWorkflowDefinitionsOptions options)	Get Workflow Definitions metadata.
ApiResponse<WorkflowDefinitionList>	getWorkflowDefinitionsWithHttpInfo(String accountId, WorkflowManagementApi.GetWorkflowDefinitionsOptions options)	Get Workflow Definitions metadata Returns a list of workflow definitions' metadata.
ApiResponse<WorkflowDefinitionWithId>	getWorkflowDefinitionWithHttpInfo(String accountId, String workflowDefinitionId, WorkflowManagementApi.GetWorkflowDefinitionOptions options)	Get Workflow Definition Returns a workflow definition.
DeployResponse	publishOrUnPublishWorkflowDefinition(String accountId, String workflowDefinitionId, DeployRequest body)	Publishes or unpublishes a workflow definition..
ApiResponse<DeployResponse>	publishOrUnPublishWorkflowDefinitionWithHttpInfo(String accountId, String workflowDefinitionId, DeployRequest body)	Publishes or unpublishes a workflow definition.
void	setApiClient(ApiClient apiClient)	setApiClient Method.
NewOrUpdatedWorkflowDefinitionResponse	updateWorkflowDefinition(String accountId, String workflowDefinitionId, CreateOrUpdateWorkflowDefinitionRequestBody body)	Updates a workflow definition..
ApiResponse<NewOrUpdatedWorkflowDefinitionResponse>	updateWorkflowDefinitionWithHttpInfo(String accountId, String workflowDefinitionId, CreateOrUpdateWorkflowDefinitionRequestBody body)	Updates a workflow definition.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

WorkflowManagementApi

public WorkflowManagementApi()

WorkflowManagementApi.

WorkflowManagementApi

public WorkflowManagementApi(ApiClient apiClient)

WorkflowManagementApi.

Method Detail

getApiClient

public ApiClient getApiClient()

getApiClient Method.

Returns:

ApiClient

setApiClient

public void setApiClient(ApiClient apiClient)

setApiClient Method.

createWorkflowDefinition

public NewOrUpdatedWorkflowDefinitionResponse createWorkflowDefinition(String accountId,
                                                                       CreateOrUpdateWorkflowDefinitionRequestBody body)
                                                                throws ApiException

Creates a new workflow definition.. Creates a new workflow definition.

Parameters:

accountId - Account ID (required)

body - Request Body to create a new workflow definition. (required)

Returns:

NewOrUpdatedWorkflowDefinitionResponse

Throws:

ApiException - if fails to make API call

createWorkflowDefinitionWithHttpInfo

public ApiResponse<NewOrUpdatedWorkflowDefinitionResponse> createWorkflowDefinitionWithHttpInfo(String accountId,
                                                                                                CreateOrUpdateWorkflowDefinitionRequestBody body)
                                                                                         throws ApiException

Creates a new workflow definition. Creates a new workflow definition.

Parameters:

accountId - Account ID (required)

body - Request Body to create a new workflow definition. (required)

Returns:

NewOrUpdatedWorkflowDefinitionResponse

Throws:

ApiException - if fails to make API call

deleteWorkflowDefinition

public WorkflowDeleteResponse deleteWorkflowDefinition(String accountId,
                                                       String workflowDefinitionId)
                                                throws ApiException

Deletes a workflow definition.. Deletes a workflow definition.

Parameters:

accountId - Account ID (required)

workflowDefinitionId - Workflow Definition ID (required)

Returns:

WorkflowDeleteResponse

Throws:

ApiException - if fails to make API call

deleteWorkflowDefinitionWithHttpInfo

public ApiResponse<WorkflowDeleteResponse> deleteWorkflowDefinitionWithHttpInfo(String accountId,
                                                                                String workflowDefinitionId)
                                                                         throws ApiException

Deletes a workflow definition. Deletes a workflow definition.

Parameters:

accountId - Account ID (required)

workflowDefinitionId - Workflow Definition ID (required)

Returns:

WorkflowDeleteResponse

Throws:

ApiException - if fails to make API call

getWorkflowDefinition

public WorkflowDefinitionWithId getWorkflowDefinition(String accountId,
                                                      String workflowDefinitionId)
                                               throws ApiException

Get Workflow Definition. Returns a workflow definition.

Parameters:

accountId - Account ID (required)

workflowDefinitionId - Workflow Definition ID (required)

Returns:

WorkflowDefinitionWithId

Throws:

ApiException

getWorkflowDefinition

public WorkflowDefinitionWithId getWorkflowDefinition(String accountId,
                                                      String workflowDefinitionId,
                                                      WorkflowManagementApi.GetWorkflowDefinitionOptions options)
                                               throws ApiException

Get Workflow Definition. Returns a workflow definition.

Parameters:

accountId - Account ID (required)

workflowDefinitionId - Workflow Definition ID (required)

options - for modifying the method behavior.

Returns:

WorkflowDefinitionWithId

Throws:

ApiException - if fails to make API call

getWorkflowDefinitionWithHttpInfo

public ApiResponse<WorkflowDefinitionWithId> getWorkflowDefinitionWithHttpInfo(String accountId,
                                                                               String workflowDefinitionId,
                                                                               WorkflowManagementApi.GetWorkflowDefinitionOptions options)
                                                                        throws ApiException

Get Workflow Definition Returns a workflow definition.

Parameters:

accountId - Account ID (required)

workflowDefinitionId - Workflow Definition ID (required)

options - for modifying the method behavior.

Returns:

WorkflowDefinitionWithId

Throws:

ApiException - if fails to make API call

getWorkflowDefinitionConfigInstances

public GetConfigurationInstancesResponse getWorkflowDefinitionConfigInstances(String accountId,
                                                                              String workflowDefinitionId)
                                                                       throws ApiException

Gets configuration instances. Returns a list of configuration instances for a workflow definition

Parameters:

accountId - Account ID (required)

workflowDefinitionId - Workflow Definition ID (required)

Returns:

GetConfigurationInstancesResponse

Throws:

ApiException - if fails to make API call

getWorkflowDefinitionConfigInstancesWithHttpInfo

public ApiResponse<GetConfigurationInstancesResponse> getWorkflowDefinitionConfigInstancesWithHttpInfo(String accountId,
                                                                                                       String workflowDefinitionId)
                                                                                                throws ApiException

Gets configuration instances Returns a list of configuration instances for a workflow definition

Parameters:

accountId - Account ID (required)

workflowDefinitionId - Workflow Definition ID (required)

Returns:

GetConfigurationInstancesResponse

Throws:

ApiException - if fails to make API call

getWorkflowDefinitions

public WorkflowDefinitionList getWorkflowDefinitions(String accountId)
                                              throws ApiException

Get Workflow Definitions metadata. Returns a list of workflow definitions' metadata.

Parameters:

accountId - Account ID (required)

Returns:

WorkflowDefinitionList

Throws:

ApiException

getWorkflowDefinitions

public WorkflowDefinitionList getWorkflowDefinitions(String accountId,
                                                     WorkflowManagementApi.GetWorkflowDefinitionsOptions options)
                                              throws ApiException

Get Workflow Definitions metadata. Returns a list of workflow definitions' metadata.

Parameters:

accountId - Account ID (required)

options - for modifying the method behavior.

Returns:

WorkflowDefinitionList

Throws:

ApiException - if fails to make API call

getWorkflowDefinitionsWithHttpInfo

public ApiResponse<WorkflowDefinitionList> getWorkflowDefinitionsWithHttpInfo(String accountId,
                                                                              WorkflowManagementApi.GetWorkflowDefinitionsOptions options)
                                                                       throws ApiException

Get Workflow Definitions metadata Returns a list of workflow definitions' metadata.

Parameters:

accountId - Account ID (required)

options - for modifying the method behavior.

Returns:

WorkflowDefinitionList

Throws:

ApiException - if fails to make API call

publishOrUnPublishWorkflowDefinition

public DeployResponse publishOrUnPublishWorkflowDefinition(String accountId,
                                                           String workflowDefinitionId,
                                                           DeployRequest body)
                                                    throws ApiException

Publishes or unpublishes a workflow definition.. Publishes or unpublishes a workflow definition.

Parameters:

accountId - Account ID (required)

workflowDefinitionId - Workflow Definition ID (required)

body - Request Body to publish or unpublish a workflow definition. (required)

Returns:

DeployResponse

Throws:

ApiException - if fails to make API call

publishOrUnPublishWorkflowDefinitionWithHttpInfo

public ApiResponse<DeployResponse> publishOrUnPublishWorkflowDefinitionWithHttpInfo(String accountId,
                                                                                    String workflowDefinitionId,
                                                                                    DeployRequest body)
                                                                             throws ApiException

Publishes or unpublishes a workflow definition. Publishes or unpublishes a workflow definition.

Parameters:

accountId - Account ID (required)

workflowDefinitionId - Workflow Definition ID (required)

body - Request Body to publish or unpublish a workflow definition. (required)

Returns:

DeployResponse

Throws:

ApiException - if fails to make API call

updateWorkflowDefinition

public NewOrUpdatedWorkflowDefinitionResponse updateWorkflowDefinition(String accountId,
                                                                       String workflowDefinitionId,
                                                                       CreateOrUpdateWorkflowDefinitionRequestBody body)
                                                                throws ApiException

Updates a workflow definition.. Updates a workflow definition.

Parameters:

accountId - Account ID (required)

workflowDefinitionId - Workflow Definition ID (required)

body - Request Body to update a workflow definition. (required)

Returns:

NewOrUpdatedWorkflowDefinitionResponse

Throws:

ApiException - if fails to make API call

updateWorkflowDefinitionWithHttpInfo

public ApiResponse<NewOrUpdatedWorkflowDefinitionResponse> updateWorkflowDefinitionWithHttpInfo(String accountId,
                                                                                                String workflowDefinitionId,
                                                                                                CreateOrUpdateWorkflowDefinitionRequestBody body)
                                                                                         throws ApiException

Updates a workflow definition. Updates a workflow definition.

Parameters:

accountId - Account ID (required)

workflowDefinitionId - Workflow Definition ID (required)

body - Request Body to update a workflow definition. (required)

Returns:

NewOrUpdatedWorkflowDefinitionResponse

Throws:

ApiException - if fails to make API call