Package com.docusign.webforms.api

Class FormInstanceManagementApi

java.lang.Object

com.docusign.webforms.api.FormInstanceManagementApi

public class FormInstanceManagementApi
extends Object

FormInstanceManagementApi class.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
class	FormInstanceManagementApi.ListInstancesOptions	ListInstancesOptions Class.

Constructor Summary

Constructors

Constructor	Description
FormInstanceManagementApi()	FormInstanceManagementApi.
FormInstanceManagementApi(ApiClient apiClient)	FormInstanceManagementApi.

Method Summary

Modifier and Type	Method	Description
WebFormInstance	createInstance(String accountId, String formId, CreateInstanceRequestBody createInstanceBody)	Creates an instance of the web form.
ApiResponse<WebFormInstance>	createInstanceWithHttpInfo(String accountId, String formId, CreateInstanceRequestBody createInstanceBody)	Creates an instance of the web form Creates an instance of the web form.
ApiClient	getApiClient()	getApiClient Method.
WebFormInstance	getInstance(String accountId, String formId, String instanceId)	Get form instance.
ApiResponse<WebFormInstance>	getInstanceWithHttpInfo(String accountId, String formId, String instanceId)	Get form instance Retrieves instance information filter by instance id
WebFormInstanceList	listInstances(String accountId, String formId)	List instances.
WebFormInstanceList	listInstances(String accountId, String formId, FormInstanceManagementApi.ListInstancesOptions options)	List instances.
ApiResponse<WebFormInstanceList>	listInstancesWithHttpInfo(String accountId, String formId, FormInstanceManagementApi.ListInstancesOptions options)	List instances List all the instances of a web form in an account.
WebFormInstance	refreshToken(String accountId, String formId, String instanceId)	Refreshes the instance token.
ApiResponse<WebFormInstance>	refreshTokenWithHttpInfo(String accountId, String formId, String instanceId)	Refreshes the instance token Generates new instance token for the existing Web Form Instance.
void	setApiClient(ApiClient apiClient)	setApiClient Method.

Methods inherited from class java.lang.Object

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

Constructor Detail

FormInstanceManagementApi

public FormInstanceManagementApi()

FormInstanceManagementApi.

FormInstanceManagementApi

public FormInstanceManagementApi(ApiClient apiClient)

FormInstanceManagementApi.

Method Detail

getApiClient

public ApiClient getApiClient()

getApiClient Method.

Returns:

ApiClient

setApiClient

public void setApiClient(ApiClient apiClient)

setApiClient Method.

createInstance

public WebFormInstance createInstance(String accountId,
                                      String formId,
                                      CreateInstanceRequestBody createInstanceBody)
                               throws ApiException

Creates an instance of the web form. Creates an instance of the web form.

Parameters:

accountId - Account identifier in which the web form resides (required)

formId - Unique identifier for a web form entity that is consistent for it's lifetime (required)

createInstanceBody - Request body containing properties that will be used to create instance. (required)

Returns:

WebFormInstance

Throws:

ApiException - if fails to make API call

createInstanceWithHttpInfo

public ApiResponse<WebFormInstance> createInstanceWithHttpInfo(String accountId,
                                                               String formId,
                                                               CreateInstanceRequestBody createInstanceBody)
                                                        throws ApiException

Creates an instance of the web form Creates an instance of the web form.

Parameters:

accountId - Account identifier in which the web form resides (required)

formId - Unique identifier for a web form entity that is consistent for it's lifetime (required)

createInstanceBody - Request body containing properties that will be used to create instance. (required)

Returns:

WebFormInstance

Throws:

ApiException - if fails to make API call

getInstance

public WebFormInstance getInstance(String accountId,
                                   String formId,
                                   String instanceId)
                            throws ApiException

Get form instance. Retrieves instance information filter by instance id

Parameters:

accountId - Account identifier in which the web form resides (required)

formId - Unique identifier for a web form entity that is consistent for it's lifetime (required)

instanceId - Unique identifier for a Web Form Instance that is consistent until its expiration (required)

Returns:

WebFormInstance

Throws:

ApiException - if fails to make API call

getInstanceWithHttpInfo

public ApiResponse<WebFormInstance> getInstanceWithHttpInfo(String accountId,
                                                            String formId,
                                                            String instanceId)
                                                     throws ApiException

Get form instance Retrieves instance information filter by instance id

Parameters:

accountId - Account identifier in which the web form resides (required)

formId - Unique identifier for a web form entity that is consistent for it's lifetime (required)

instanceId - Unique identifier for a Web Form Instance that is consistent until its expiration (required)

Returns:

WebFormInstance

Throws:

ApiException - if fails to make API call

listInstances

public WebFormInstanceList listInstances(String accountId,
                                         String formId)
                                  throws ApiException

List instances. List all the instances of a web form in an account. When filtered by clientUserId, it will return instances having same clientUserId

Parameters:

accountId - Account identifier in which the web form resides (required)

formId - Unique identifier for a web form that is consistent for it's lifetime (required)

Returns:

WebFormInstanceList

Throws:

ApiException

listInstances

public WebFormInstanceList listInstances(String accountId,
                                         String formId,
                                         FormInstanceManagementApi.ListInstancesOptions options)
                                  throws ApiException

List instances. List all the instances of a web form in an account. When filtered by clientUserId, it will return instances having same clientUserId

Parameters:

accountId - Account identifier in which the web form resides (required)

formId - Unique identifier for a web form that is consistent for it's lifetime (required)

options - for modifying the method behavior.

Returns:

WebFormInstanceList

Throws:

ApiException - if fails to make API call

listInstancesWithHttpInfo

public ApiResponse<WebFormInstanceList> listInstancesWithHttpInfo(String accountId,
                                                                  String formId,
                                                                  FormInstanceManagementApi.ListInstancesOptions options)
                                                           throws ApiException

List instances List all the instances of a web form in an account. When filtered by clientUserId, it will return instances having same clientUserId

Parameters:

accountId - Account identifier in which the web form resides (required)

formId - Unique identifier for a web form that is consistent for it's lifetime (required)

options - for modifying the method behavior.

Returns:

WebFormInstanceList

Throws:

ApiException - if fails to make API call

refreshToken

public WebFormInstance refreshToken(String accountId,
                                    String formId,
                                    String instanceId)
                             throws ApiException

Refreshes the instance token. Generates new instance token for the existing Web Form Instance.

Parameters:

accountId - Account identifier in which the web form resides (required)

formId - Unique identifier for a web form entity that is consistent for it's lifetime (required)

instanceId - Unique identifier for a Web Form Instance that is consistent until its expiration (required)

Returns:

WebFormInstance

Throws:

ApiException - if fails to make API call

refreshTokenWithHttpInfo

public ApiResponse<WebFormInstance> refreshTokenWithHttpInfo(String accountId,
                                                             String formId,
                                                             String instanceId)
                                                      throws ApiException

Refreshes the instance token Generates new instance token for the existing Web Form Instance.

Parameters:

accountId - Account identifier in which the web form resides (required)

formId - Unique identifier for a web form entity that is consistent for it's lifetime (required)

instanceId - Unique identifier for a Web Form Instance that is consistent until its expiration (required)

Returns:

WebFormInstance

Throws:

ApiException - if fails to make API call