Package com.docusign.esign.api

Class PowerFormsApi

java.lang.Object

com.docusign.esign.api.PowerFormsApi

public class PowerFormsApi
extends Object

PowerFormsApi class.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
class	PowerFormsApi.GetPowerFormDataOptions	GetPowerFormDataOptions Class.
class	PowerFormsApi.ListPowerFormSendersOptions	ListPowerFormSendersOptions Class.
class	PowerFormsApi.ListPowerFormsOptions	ListPowerFormsOptions Class.

Constructor Summary

Constructors

Constructor	Description
PowerFormsApi()	PowerFormsApi.
PowerFormsApi(ApiClient apiClient)	PowerFormsApi.

Method Summary

Modifier and Type	Method	Description
PowerForm	createPowerForm(String accountId, PowerForm powerForm)	Creates a new PowerForm..
ApiResponse<PowerForm>	createPowerFormWithHttpInfo(String accountId, PowerForm powerForm)	Creates a new PowerForm.
void	deletePowerForm(String accountId, String powerFormId)	Delete a PowerForm..
PowerFormsResponse	deletePowerForms(String accountId, PowerFormsRequest powerFormsRequest)	Deletes one or more PowerForms.
ApiResponse<PowerFormsResponse>	deletePowerFormsWithHttpInfo(String accountId, PowerFormsRequest powerFormsRequest)	Deletes one or more PowerForms This method deletes one or more PowerForms.
ApiResponse<Object>	deletePowerFormWithHttpInfo(String accountId, String powerFormId)	Delete a PowerForm.
ApiClient	getApiClient()	getApiClient Method.
PowerForm	getPowerForm(String accountId, String powerFormId)	Returns a single PowerForm..
PowerFormsFormDataResponse	getPowerFormData(String accountId, String powerFormId)	Returns the form data associated with the usage of a PowerForm..
PowerFormsFormDataResponse	getPowerFormData(String accountId, String powerFormId, PowerFormsApi.GetPowerFormDataOptions options)	Returns the form data associated with the usage of a PowerForm..
ApiResponse<PowerFormsFormDataResponse>	getPowerFormDataWithHttpInfo(String accountId, String powerFormId, PowerFormsApi.GetPowerFormDataOptions options)	Returns the form data associated with the usage of a PowerForm.
ApiResponse<PowerForm>	getPowerFormWithHttpInfo(String accountId, String powerFormId)	Returns a single PowerForm.
PowerFormsResponse	listPowerForms(String accountId)	Returns the list of PowerForms available to the user..
PowerFormsResponse	listPowerForms(String accountId, PowerFormsApi.ListPowerFormsOptions options)	Returns the list of PowerForms available to the user..
PowerFormSendersResponse	listPowerFormSenders(String accountId)	Returns the list of PowerForms available to the user..
PowerFormSendersResponse	listPowerFormSenders(String accountId, PowerFormsApi.ListPowerFormSendersOptions options)	Returns the list of PowerForms available to the user..
ApiResponse<PowerFormSendersResponse>	listPowerFormSendersWithHttpInfo(String accountId, PowerFormsApi.ListPowerFormSendersOptions options)	Returns the list of PowerForms available to the user.
ApiResponse<PowerFormsResponse>	listPowerFormsWithHttpInfo(String accountId, PowerFormsApi.ListPowerFormsOptions options)	Returns the list of PowerForms available to the user.
void	setApiClient(ApiClient apiClient)	setApiClient Method.
PowerForm	updatePowerForm(String accountId, String powerFormId, PowerForm powerForm)	Creates a new PowerForm..
ApiResponse<PowerForm>	updatePowerFormWithHttpInfo(String accountId, String powerFormId, PowerForm powerForm)	Creates a new PowerForm.

Methods inherited from class java.lang.Object

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

Constructor Detail

PowerFormsApi

public PowerFormsApi()

PowerFormsApi.

PowerFormsApi

public PowerFormsApi(ApiClient apiClient)

PowerFormsApi.

Method Detail

getApiClient

public ApiClient getApiClient()

getApiClient Method.

Returns:

ApiClient

setApiClient

public void setApiClient(ApiClient apiClient)

setApiClient Method.

createPowerForm

public PowerForm createPowerForm(String accountId,
                                 PowerForm powerForm)
                          throws ApiException

Creates a new PowerForm.. This method creates a new PowerForm. You create a PowerForm from an existing DocuSign [template](/docs/esign-rest-api/reference/templates/templates/create/), based on the `templateId` in the request body. PowerForms that you create from a template are referred to as *web PowerForms*. **Note:** The DocuSign Admin console also supports creating a PowerForm by uploading a PDF file that has active form fields (referred to as a *PDF PowerForm*). However, PDF PowerForms are deprecated and are not supported in the API. **Note:** A PowerForm can have only one sender. (Because PowerForms are not necessarily sent by email, this user is also referred to as the PowerForm *initiator*.) If you need to associate multiple senders with a PowerForm, create multiple copies of the PowerForm by using the same template (one copy for each sender). By default, the sender is the PowerForm Administrator who creates the PowerForm. ### Signing modes You can use one of the following signing modes for a PowerForm: **`email`** This mode verifies the recipient's identity by using email authentication before the recipient can sign a document. The recipient enters their email address on the landing page and then clicks **Begin Signing** to begin the signing process. The system then sends an email message with a validation code to the recipient. If the recipient does not provide a valid email address, they do not receive the email message containing the access code and are not able to open and sign the document. Alternatively, you can make the process easier for signers by using email authentication only and omitting the access code. To do this, you append the `activateonly` flag to the PowerForm URL and set it to true by passing in the value `1`. When the flag is active, the first recipient receives an email with a link that initiates the signing session without having to enter access code. Example: `activateonly=1` **`direct`** This mode does not require any verification. After a recipient enters their email address on the landing page and clicks **Begin Signing,** a new browser tab opens and the recipient can immediately begin the signing process. Because the `direct` signing mode does not verify the recipient's identity by using email authentication, we strongly recommend that you use this mode only when the PowerForm is accessible behind a secure portal where the recipient's identity is already authenticated, or where another form of authentication is specified for the recipient in the DocuSign template (for example, an access code, phone authentication, or ID check). **Note:** In the account settings, `enablePowerFormDirect` must be **true** to use `direct` as the `signingMode`. ### Redirect URLs You can control the URL to which signers are redirected after signing your PowerForm. However, the URL is specified elsewhere, outside of the PowerForm creation process. For details, see [How do I specify a URL to redirect to when a PowerForm is completed?](https://support.docusign.com/en/articles/How-do-I-specify-a-URL-to-redirect-to-when-a-Powerform-is-completed). ### More information For more information about creating PowerForms, see [Create a PowerForm](https://support.docusign.com/en/guides/ndse-user-guide-create-a-powerform).

Parameters:

accountId - The external account number (int) or account ID Guid. (required)

powerForm - (optional)

Returns:

PowerForm

Throws:

ApiException - if fails to make API call

createPowerFormWithHttpInfo

public ApiResponse<PowerForm> createPowerFormWithHttpInfo(String accountId,
                                                          PowerForm powerForm)
                                                   throws ApiException

Creates a new PowerForm. This method creates a new PowerForm. You create a PowerForm from an existing DocuSign [template](/docs/esign-rest-api/reference/templates/templates/create/), based on the `templateId` in the request body. PowerForms that you create from a template are referred to as *web PowerForms*. **Note:** The DocuSign Admin console also supports creating a PowerForm by uploading a PDF file that has active form fields (referred to as a *PDF PowerForm*). However, PDF PowerForms are deprecated and are not supported in the API. **Note:** A PowerForm can have only one sender. (Because PowerForms are not necessarily sent by email, this user is also referred to as the PowerForm *initiator*.) If you need to associate multiple senders with a PowerForm, create multiple copies of the PowerForm by using the same template (one copy for each sender). By default, the sender is the PowerForm Administrator who creates the PowerForm. ### Signing modes You can use one of the following signing modes for a PowerForm: **`email`** This mode verifies the recipient's identity by using email authentication before the recipient can sign a document. The recipient enters their email address on the landing page and then clicks **Begin Signing** to begin the signing process. The system then sends an email message with a validation code to the recipient. If the recipient does not provide a valid email address, they do not receive the email message containing the access code and are not able to open and sign the document. Alternatively, you can make the process easier for signers by using email authentication only and omitting the access code. To do this, you append the `activateonly` flag to the PowerForm URL and set it to true by passing in the value `1`. When the flag is active, the first recipient receives an email with a link that initiates the signing session without having to enter access code. Example: `activateonly=1` **`direct`** This mode does not require any verification. After a recipient enters their email address on the landing page and clicks **Begin Signing,** a new browser tab opens and the recipient can immediately begin the signing process. Because the `direct` signing mode does not verify the recipient's identity by using email authentication, we strongly recommend that you use this mode only when the PowerForm is accessible behind a secure portal where the recipient's identity is already authenticated, or where another form of authentication is specified for the recipient in the DocuSign template (for example, an access code, phone authentication, or ID check). **Note:** In the account settings, `enablePowerFormDirect` must be **true** to use `direct` as the `signingMode`. ### Redirect URLs You can control the URL to which signers are redirected after signing your PowerForm. However, the URL is specified elsewhere, outside of the PowerForm creation process. For details, see [How do I specify a URL to redirect to when a PowerForm is completed?](https://support.docusign.com/en/articles/How-do-I-specify-a-URL-to-redirect-to-when-a-Powerform-is-completed). ### More information For more information about creating PowerForms, see [Create a PowerForm](https://support.docusign.com/en/guides/ndse-user-guide-create-a-powerform).

Parameters:

accountId - The external account number (int) or account ID Guid. (required)

powerForm - (optional)

Returns:

PowerForm

Throws:

ApiException - if fails to make API call

deletePowerForm

public void deletePowerForm(String accountId,
                            String powerFormId)
                     throws ApiException

Delete a PowerForm.. This method deletes a PowerForm.

Parameters:

accountId - The external account number (int) or account ID Guid. (required)

powerFormId - (required)

Throws:

ApiException - if fails to make API call

deletePowerFormWithHttpInfo

public ApiResponse<Object> deletePowerFormWithHttpInfo(String accountId,
                                                       String powerFormId)
                                                throws ApiException

Delete a PowerForm. This method deletes a PowerForm.

Parameters:

accountId - The external account number (int) or account ID Guid. (required)

powerFormId - (required)

Throws:

ApiException - if fails to make API call

deletePowerForms

public PowerFormsResponse deletePowerForms(String accountId,
                                           PowerFormsRequest powerFormsRequest)
                                    throws ApiException

Deletes one or more PowerForms. This method deletes one or more PowerForms. The request body takes an array of PowerForm objects that are deleted based on the `powerFormId`.

Parameters:

accountId - The external account number (int) or account ID Guid. (required)

powerFormsRequest - (optional)

Returns:

PowerFormsResponse

Throws:

ApiException - if fails to make API call

deletePowerFormsWithHttpInfo

public ApiResponse<PowerFormsResponse> deletePowerFormsWithHttpInfo(String accountId,
                                                                    PowerFormsRequest powerFormsRequest)
                                                             throws ApiException

Deletes one or more PowerForms This method deletes one or more PowerForms. The request body takes an array of PowerForm objects that are deleted based on the `powerFormId`.

Parameters:

accountId - The external account number (int) or account ID Guid. (required)

powerFormsRequest - (optional)

Returns:

PowerFormsResponse

Throws:

ApiException - if fails to make API call

getPowerForm

public PowerForm getPowerForm(String accountId,
                              String powerFormId)
                       throws ApiException

Returns a single PowerForm.. This method returns detailed information about a specific PowerForm.

Parameters:

accountId - The external account number (int) or account ID Guid. (required)

powerFormId - (required)

Returns:

PowerForm

Throws:

ApiException - if fails to make API call

getPowerFormWithHttpInfo

public ApiResponse<PowerForm> getPowerFormWithHttpInfo(String accountId,
                                                       String powerFormId)
                                                throws ApiException

Returns a single PowerForm. This method returns detailed information about a specific PowerForm.

Parameters:

accountId - The external account number (int) or account ID Guid. (required)

powerFormId - (required)

Returns:

PowerForm

Throws:

ApiException - if fails to make API call

getPowerFormData

public PowerFormsFormDataResponse getPowerFormData(String accountId,
                                                   String powerFormId)
                                            throws ApiException

Returns the form data associated with the usage of a PowerForm.. This method enables Powerform Administrators or the sender of a PowerForm to download the data that recipients have entered into a PowerForm. You specify the format in which you want to retrieve the data in the `Accept` header. This header accepts the following values: - `application/json`: JSON format - `application/xml`: XML format - `text/csv`: Comma-separated value (CSV) format **Note:** Only PowerForm Administrators or the PowerForm Sender can download the data associated with a PowerForm.

Parameters:

accountId - The external account number (int) or account ID Guid. (required)

powerFormId - (required)

Returns:

PowerFormsFormDataResponse

Throws:

ApiException

getPowerFormData

public PowerFormsFormDataResponse getPowerFormData(String accountId,
                                                   String powerFormId,
                                                   PowerFormsApi.GetPowerFormDataOptions options)
                                            throws ApiException

Returns the form data associated with the usage of a PowerForm.. This method enables Powerform Administrators or the sender of a PowerForm to download the data that recipients have entered into a PowerForm. You specify the format in which you want to retrieve the data in the `Accept` header. This header accepts the following values: - `application/json`: JSON format - `application/xml`: XML format - `text/csv`: Comma-separated value (CSV) format **Note:** Only PowerForm Administrators or the PowerForm Sender can download the data associated with a PowerForm.

Parameters:

accountId - The external account number (int) or account ID Guid. (required)

powerFormId - (required)

options - for modifying the method behavior.

Returns:

PowerFormsFormDataResponse

Throws:

ApiException - if fails to make API call

getPowerFormDataWithHttpInfo

public ApiResponse<PowerFormsFormDataResponse> getPowerFormDataWithHttpInfo(String accountId,
                                                                            String powerFormId,
                                                                            PowerFormsApi.GetPowerFormDataOptions options)
                                                                     throws ApiException

Returns the form data associated with the usage of a PowerForm. This method enables Powerform Administrators or the sender of a PowerForm to download the data that recipients have entered into a PowerForm. You specify the format in which you want to retrieve the data in the `Accept` header. This header accepts the following values: - `application/json`: JSON format - `application/xml`: XML format - `text/csv`: Comma-separated value (CSV) format **Note:** Only PowerForm Administrators or the PowerForm Sender can download the data associated with a PowerForm.

Parameters:

accountId - The external account number (int) or account ID Guid. (required)

powerFormId - (required)

options - for modifying the method behavior.

Returns:

PowerFormsFormDataResponse

Throws:

ApiException - if fails to make API call

listPowerFormSenders

public PowerFormSendersResponse listPowerFormSenders(String accountId)
                                              throws ApiException

Returns the list of PowerForms available to the user.. This method returns a list of users who have sent PowerForms.

Parameters:

accountId - The external account number (int) or account ID Guid. (required)

Returns:

PowerFormSendersResponse

Throws:

ApiException

listPowerFormSenders

public PowerFormSendersResponse listPowerFormSenders(String accountId,
                                                     PowerFormsApi.ListPowerFormSendersOptions options)
                                              throws ApiException

Returns the list of PowerForms available to the user.. This method returns a list of users who have sent PowerForms.

Parameters:

accountId - The external account number (int) or account ID Guid. (required)

options - for modifying the method behavior.

Returns:

PowerFormSendersResponse

Throws:

ApiException - if fails to make API call

listPowerFormSendersWithHttpInfo

public ApiResponse<PowerFormSendersResponse> listPowerFormSendersWithHttpInfo(String accountId,
                                                                              PowerFormsApi.ListPowerFormSendersOptions options)
                                                                       throws ApiException

Returns the list of PowerForms available to the user. This method returns a list of users who have sent PowerForms.

Parameters:

accountId - The external account number (int) or account ID Guid. (required)

options - for modifying the method behavior.

Returns:

PowerFormSendersResponse

Throws:

ApiException - if fails to make API call

listPowerForms

public PowerFormsResponse listPowerForms(String accountId)
                                  throws ApiException

Returns the list of PowerForms available to the user.. This method returns a list of PowerForms that are available to the user.

Parameters:

accountId - The external account number (int) or account ID Guid. (required)

Returns:

PowerFormsResponse

Throws:

ApiException

listPowerForms

public PowerFormsResponse listPowerForms(String accountId,
                                         PowerFormsApi.ListPowerFormsOptions options)
                                  throws ApiException

Returns the list of PowerForms available to the user.. This method returns a list of PowerForms that are available to the user.

Parameters:

accountId - The external account number (int) or account ID Guid. (required)

options - for modifying the method behavior.

Returns:

PowerFormsResponse

Throws:

ApiException - if fails to make API call

listPowerFormsWithHttpInfo

public ApiResponse<PowerFormsResponse> listPowerFormsWithHttpInfo(String accountId,
                                                                  PowerFormsApi.ListPowerFormsOptions options)
                                                           throws ApiException

Returns the list of PowerForms available to the user. This method returns a list of PowerForms that are available to the user.

Parameters:

accountId - The external account number (int) or account ID Guid. (required)

options - for modifying the method behavior.

Returns:

PowerFormsResponse

Throws:

ApiException - if fails to make API call

updatePowerForm

public PowerForm updatePowerForm(String accountId,
                                 String powerFormId,
                                 PowerForm powerForm)
                          throws ApiException

Creates a new PowerForm.. This method updates an existing PowerForm.

Parameters:

accountId - The external account number (int) or account ID Guid. (required)

powerFormId - (required)

powerForm - (optional)

Returns:

PowerForm

Throws:

ApiException - if fails to make API call

updatePowerFormWithHttpInfo

public ApiResponse<PowerForm> updatePowerFormWithHttpInfo(String accountId,
                                                          String powerFormId,
                                                          PowerForm powerForm)
                                                   throws ApiException

Creates a new PowerForm. This method updates an existing PowerForm.

Parameters:

accountId - The external account number (int) or account ID Guid. (required)

powerFormId - (required)

powerForm - (optional)

Returns:

PowerForm

Throws:

ApiException - if fails to make API call