com.docusign.esign.api

Class PowerFormsApi

java.lang.Object

com.docusign.esign.api.PowerFormsApi

public class PowerFormsApi
extends Object

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

Constructor and Description
PowerFormsApi()
PowerFormsApi(ApiClient apiClient)

Method Summary

Methods

Modifier and Type	Method and Description
PowerForm	createPowerForm(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
ApiClient	getApiClient()
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.
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.
void	setApiClient(ApiClient apiClient)
PowerForm	updatePowerForm(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

public PowerFormsApi(ApiClient apiClient)

Method Detail

getApiClient

public ApiClient getApiClient()

setApiClient

public void setApiClient(ApiClient apiClient)

createPowerForm

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

Creates a new 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.

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

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.

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.

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.

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.

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.

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.

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.

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.

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