Represents a collection of functions to interact with the API endpoints More...

Inheritance diagram for DocuSign.eSign.Api.PowerFormsApi:

Classes
class	GetPowerFormDataOptions
	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. More...

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

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

Public Member Functions
	PowerFormsApi (DocuSignClient aplClient)
	Initializes a new instance of the PowerFormsApi class using AplClient object More...

String	GetBasePath ()
	Gets the base path of the API client. More...

PowerForm	CreatePowerForm (string accountId, PowerForm powerForm=null)
	Creates a new PowerForm. This method creates a new PowerForm. You create a PowerForm from an existing DocuSign template, 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?. ### More information For more information about creating PowerForms, see Create a PowerForm. More...

ApiResponse< PowerForm >	CreatePowerFormWithHttpInfo (string accountId, PowerForm powerForm=null)
	Creates a new PowerForm. This method creates a new PowerForm. You create a PowerForm from an existing DocuSign template, 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?. ### More information For more information about creating PowerForms, see Create a PowerForm. More...

async System.Threading.Tasks.Task< PowerForm >	CreatePowerFormAsync (string accountId, PowerForm powerForm=null)
	Creates a new PowerForm. This method creates a new PowerForm. You create a PowerForm from an existing DocuSign template, 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?. ### More information For more information about creating PowerForms, see Create a PowerForm. More...

async System.Threading.Tasks.Task< ApiResponse< PowerForm > >	CreatePowerFormAsyncWithHttpInfo (string accountId, PowerForm powerForm=null)
	Creates a new PowerForm. This method creates a new PowerForm. You create a PowerForm from an existing DocuSign template, 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?. ### More information For more information about creating PowerForms, see Create a PowerForm. More...

void	DeletePowerForm (string accountId, string powerFormId)
	Delete a PowerForm. This method deletes a PowerForm. More...

ApiResponse< Object >	DeletePowerFormWithHttpInfo (string accountId, string powerFormId)
	Delete a PowerForm. This method deletes a PowerForm. More...

async System.Threading.Tasks.Task	DeletePowerFormAsync (string accountId, string powerFormId)
	Delete a PowerForm. This method deletes a PowerForm. More...

async System.Threading.Tasks.Task< ApiResponse< Object > >	DeletePowerFormAsyncWithHttpInfo (string accountId, string powerFormId)
	Delete a PowerForm. This method deletes a PowerForm. More...

PowerFormsResponse	DeletePowerForms (string accountId, PowerFormsRequest powerFormsRequest=null)
	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`. More...

ApiResponse< PowerFormsResponse >	DeletePowerFormsWithHttpInfo (string accountId, PowerFormsRequest powerFormsRequest=null)
	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`. More...

async System.Threading.Tasks.Task< PowerFormsResponse >	DeletePowerFormsAsync (string accountId, PowerFormsRequest powerFormsRequest=null)
	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`. More...

async System.Threading.Tasks.Task< ApiResponse< PowerFormsResponse > >	DeletePowerFormsAsyncWithHttpInfo (string accountId, PowerFormsRequest powerFormsRequest=null)
	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`. More...

PowerForm	GetPowerForm (string accountId, string powerFormId)
	Returns a single PowerForm. This method returns detailed information about a specific PowerForm. More...

ApiResponse< PowerForm >	GetPowerFormWithHttpInfo (string accountId, string powerFormId)
	Returns a single PowerForm. This method returns detailed information about a specific PowerForm. More...

async System.Threading.Tasks.Task< PowerForm >	GetPowerFormAsync (string accountId, string powerFormId)
	Returns a single PowerForm. This method returns detailed information about a specific PowerForm. More...

async System.Threading.Tasks.Task< ApiResponse< PowerForm > >	GetPowerFormAsyncWithHttpInfo (string accountId, string powerFormId)
	Returns a single PowerForm. This method returns detailed information about a specific PowerForm. More...

PowerFormsFormDataResponse	GetPowerFormData (string accountId, string powerFormId, PowerFormsApi.GetPowerFormDataOptions options=null)
	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. More...

ApiResponse< PowerFormsFormDataResponse >	GetPowerFormDataWithHttpInfo (string accountId, string powerFormId, PowerFormsApi.GetPowerFormDataOptions options=null)
	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. More...

async System.Threading.Tasks.Task< PowerFormsFormDataResponse >	GetPowerFormDataAsync (string accountId, string powerFormId, PowerFormsApi.GetPowerFormDataOptions options=null)
	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. More...

async System.Threading.Tasks.Task< ApiResponse< PowerFormsFormDataResponse > >	GetPowerFormDataAsyncWithHttpInfo (string accountId, string powerFormId, PowerFormsApi.GetPowerFormDataOptions options=null)
	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. More...

PowerFormSendersResponse	ListPowerFormSenders (string accountId, PowerFormsApi.ListPowerFormSendersOptions options=null)
	Returns the list of PowerForms available to the user. This method returns a list of users who have sent PowerForms. More...

ApiResponse< PowerFormSendersResponse >	ListPowerFormSendersWithHttpInfo (string accountId, PowerFormsApi.ListPowerFormSendersOptions options=null)
	Returns the list of PowerForms available to the user. This method returns a list of users who have sent PowerForms. More...

async System.Threading.Tasks.Task< PowerFormSendersResponse >	ListPowerFormSendersAsync (string accountId, PowerFormsApi.ListPowerFormSendersOptions options=null)
	Returns the list of PowerForms available to the user. This method returns a list of users who have sent PowerForms. More...

async System.Threading.Tasks.Task< ApiResponse< PowerFormSendersResponse > >	ListPowerFormSendersAsyncWithHttpInfo (string accountId, PowerFormsApi.ListPowerFormSendersOptions options=null)
	Returns the list of PowerForms available to the user. This method returns a list of users who have sent PowerForms. More...

PowerFormsResponse	ListPowerForms (string accountId, PowerFormsApi.ListPowerFormsOptions options=null)
	Returns the list of PowerForms available to the user. This method returns a list of PowerForms that are available to the user. More...

ApiResponse< PowerFormsResponse >	ListPowerFormsWithHttpInfo (string accountId, PowerFormsApi.ListPowerFormsOptions options=null)
	Returns the list of PowerForms available to the user. This method returns a list of PowerForms that are available to the user. More...

async System.Threading.Tasks.Task< PowerFormsResponse >	ListPowerFormsAsync (string accountId, PowerFormsApi.ListPowerFormsOptions options=null)
	Returns the list of PowerForms available to the user. This method returns a list of PowerForms that are available to the user. More...

async System.Threading.Tasks.Task< ApiResponse< PowerFormsResponse > >	ListPowerFormsAsyncWithHttpInfo (string accountId, PowerFormsApi.ListPowerFormsOptions options=null)
	Returns the list of PowerForms available to the user. This method returns a list of PowerForms that are available to the user. More...

PowerForm	UpdatePowerForm (string accountId, string powerFormId, PowerForm powerForm=null)
	Creates a new PowerForm. This method updates an existing PowerForm. More...

ApiResponse< PowerForm >	UpdatePowerFormWithHttpInfo (string accountId, string powerFormId, PowerForm powerForm=null)
	Creates a new PowerForm. This method updates an existing PowerForm. More...

async System.Threading.Tasks.Task< PowerForm >	UpdatePowerFormAsync (string accountId, string powerFormId, PowerForm powerForm=null)
	Creates a new PowerForm. This method updates an existing PowerForm. More...

async System.Threading.Tasks.Task< ApiResponse< PowerForm > >	UpdatePowerFormAsyncWithHttpInfo (string accountId, string powerFormId, PowerForm powerForm=null)
	Creates a new PowerForm. This method updates an existing PowerForm. More...

Public Member Functions inherited from DocuSign.eSign.Api.IPowerFormsApi
PowerFormsFormDataResponse	GetPowerFormData (string accountId, string powerFormId, PowerFormsApi.GetPowerFormDataOptions options=null)
	Returns the form data associated with the usage of a PowerForm. More...

ApiResponse< PowerFormsFormDataResponse >	GetPowerFormDataWithHttpInfo (string accountId, string powerFormId, PowerFormsApi.GetPowerFormDataOptions options=null)
	Returns the form data associated with the usage of a PowerForm. More...

PowerFormSendersResponse	ListPowerFormSenders (string accountId, PowerFormsApi.ListPowerFormSendersOptions options=null)
	Returns the list of PowerForms available to the user. More...

ApiResponse< PowerFormSendersResponse >	ListPowerFormSendersWithHttpInfo (string accountId, PowerFormsApi.ListPowerFormSendersOptions options=null)
	Returns the list of PowerForms available to the user. More...

PowerFormsResponse	ListPowerForms (string accountId, PowerFormsApi.ListPowerFormsOptions options=null)
	Returns the list of PowerForms available to the user. More...

ApiResponse< PowerFormsResponse >	ListPowerFormsWithHttpInfo (string accountId, PowerFormsApi.ListPowerFormsOptions options=null)
	Returns the list of PowerForms available to the user. More...

System.Threading.Tasks.Task< PowerFormsFormDataResponse >	GetPowerFormDataAsync (string accountId, string powerFormId, PowerFormsApi.GetPowerFormDataOptions options=null)
	Returns the form data associated with the usage of a PowerForm. More...

System.Threading.Tasks.Task< ApiResponse< PowerFormsFormDataResponse > >	GetPowerFormDataAsyncWithHttpInfo (string accountId, string powerFormId, PowerFormsApi.GetPowerFormDataOptions options=null)
	Returns the form data associated with the usage of a PowerForm. More...

System.Threading.Tasks.Task< PowerFormSendersResponse >	ListPowerFormSendersAsync (string accountId, PowerFormsApi.ListPowerFormSendersOptions options=null)
	Returns the list of PowerForms available to the user. More...

System.Threading.Tasks.Task< ApiResponse< PowerFormSendersResponse > >	ListPowerFormSendersAsyncWithHttpInfo (string accountId, PowerFormsApi.ListPowerFormSendersOptions options=null)
	Returns the list of PowerForms available to the user. More...

System.Threading.Tasks.Task< PowerFormsResponse >	ListPowerFormsAsync (string accountId, PowerFormsApi.ListPowerFormsOptions options=null)
	Returns the list of PowerForms available to the user. More...

System.Threading.Tasks.Task< ApiResponse< PowerFormsResponse > >	ListPowerFormsAsyncWithHttpInfo (string accountId, PowerFormsApi.ListPowerFormsOptions options=null)
	Returns the list of PowerForms available to the user. More...

Properties
DocuSignClient	ApiClient `[get, set]`
	Gets or sets the ApiClient object More...

DocuSign.eSign.Client.ExceptionFactory	ExceptionFactory `[get, set]`
	Provides a factory method hook for the creation of exceptions. More...

Properties inherited from DocuSign.eSign.Client.IApiAccessor
DocuSignClient	ApiClient `[get, set]`
	Gets or sets the ApiClient object More...

ExceptionFactory	ExceptionFactory `[get, set]`
	Provides a factory method hook for the creation of exceptions. More...

Detailed Description

Represents a collection of functions to interact with the API endpoints

Constructor & Destructor Documentation

◆ PowerFormsApi()

DocuSign.eSign.Api.PowerFormsApi.PowerFormsApi ( DocuSignClient aplClient )

inline

Initializes a new instance of the PowerFormsApi class using AplClient object

Parameters

aplClient An instance of AplClient

Returns

Member Function Documentation

◆ CreatePowerForm()

PowerForm DocuSign.eSign.Api.PowerFormsApi.CreatePowerForm	(	string	accountId,
		PowerForm	powerForm = `null`
	)

inline

Creates a new PowerForm. This method creates a new PowerForm. You create a PowerForm from an existing DocuSign template, 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?. ### More information For more information about creating PowerForms, see Create a PowerForm.

Exceptions

DocuSign.eSign.Client.ApiException Thrown when fails to make API call

Parameters

accountId	The external account number (int) or account ID Guid.
powerForm	(optional)

Returns: PowerForm

Implements DocuSign.eSign.Api.IPowerFormsApi.

◆ CreatePowerFormAsync()

async System.Threading.Tasks.Task<PowerForm> DocuSign.eSign.Api.PowerFormsApi.CreatePowerFormAsync	(	string	accountId,
		PowerForm	powerForm = `null`
	)

inline

Creates a new PowerForm. This method creates a new PowerForm. You create a PowerForm from an existing DocuSign template, 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?. ### More information For more information about creating PowerForms, see Create a PowerForm.

Exceptions

DocuSign.eSign.Client.ApiException Thrown when fails to make API call

Parameters

accountId	The external account number (int) or account ID Guid.
powerForm	(optional)

Returns: Task of PowerForm

Implements DocuSign.eSign.Api.IPowerFormsApi.

◆ CreatePowerFormAsyncWithHttpInfo()

async System.Threading.Tasks.Task<ApiResponse<PowerForm> > DocuSign.eSign.Api.PowerFormsApi.CreatePowerFormAsyncWithHttpInfo	(	string	accountId,
		PowerForm	powerForm = `null`
	)

inline

Creates a new PowerForm. This method creates a new PowerForm. You create a PowerForm from an existing DocuSign template, 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?. ### More information For more information about creating PowerForms, see Create a PowerForm.

Exceptions

DocuSign.eSign.Client.ApiException Thrown when fails to make API call

Parameters

accountId	The external account number (int) or account ID Guid.
powerForm	(optional)

Returns: Task of ApiResponse (PowerForm)

Implements DocuSign.eSign.Api.IPowerFormsApi.

◆ CreatePowerFormWithHttpInfo()

ApiResponse<PowerForm> DocuSign.eSign.Api.PowerFormsApi.CreatePowerFormWithHttpInfo	(	string	accountId,
		PowerForm	powerForm = `null`
	)

inline

Creates a new PowerForm. This method creates a new PowerForm. You create a PowerForm from an existing DocuSign template, 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?. ### More information For more information about creating PowerForms, see Create a PowerForm.

Exceptions

DocuSign.eSign.Client.ApiException Thrown when fails to make API call

Parameters

accountId	The external account number (int) or account ID Guid.
powerForm	(optional)

Returns: ApiResponse of PowerForm

Implements DocuSign.eSign.Api.IPowerFormsApi.

◆ DeletePowerForm()

void DocuSign.eSign.Api.PowerFormsApi.DeletePowerForm	(	string	accountId,
		string	powerFormId
	)

inline

Delete a PowerForm. This method deletes a PowerForm.

Exceptions

DocuSign.eSign.Client.ApiException Thrown when fails to make API call

Parameters

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

Returns

Implements DocuSign.eSign.Api.IPowerFormsApi.

◆ DeletePowerFormAsync()

async System.Threading.Tasks.Task DocuSign.eSign.Api.PowerFormsApi.DeletePowerFormAsync	(	string	accountId,
		string	powerFormId
	)

inline

Delete a PowerForm. This method deletes a PowerForm.

Exceptions

DocuSign.eSign.Client.ApiException Thrown when fails to make API call

Parameters

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

Returns: Task of void

Implements DocuSign.eSign.Api.IPowerFormsApi.

◆ DeletePowerFormAsyncWithHttpInfo()

async System.Threading.Tasks.Task<ApiResponse<Object> > DocuSign.eSign.Api.PowerFormsApi.DeletePowerFormAsyncWithHttpInfo	(	string	accountId,
		string	powerFormId
	)

inline

Delete a PowerForm. This method deletes a PowerForm.

Exceptions

DocuSign.eSign.Client.ApiException Thrown when fails to make API call

Parameters

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

Returns: Task of ApiResponse

Implements DocuSign.eSign.Api.IPowerFormsApi.

◆ DeletePowerForms()

PowerFormsResponse DocuSign.eSign.Api.PowerFormsApi.DeletePowerForms	(	string	accountId,
		PowerFormsRequest	powerFormsRequest = `null`
	)

inline

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`.

Exceptions

DocuSign.eSign.Client.ApiException Thrown when fails to make API call

Parameters

accountId	The external account number (int) or account ID Guid.
powerFormsRequest	(optional)

Returns: PowerFormsResponse

Implements DocuSign.eSign.Api.IPowerFormsApi.

◆ DeletePowerFormsAsync()

async System.Threading.Tasks.Task<PowerFormsResponse> DocuSign.eSign.Api.PowerFormsApi.DeletePowerFormsAsync	(	string	accountId,
		PowerFormsRequest	powerFormsRequest = `null`
	)

inline

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`.

Exceptions

DocuSign.eSign.Client.ApiException Thrown when fails to make API call

Parameters

accountId	The external account number (int) or account ID Guid.
powerFormsRequest	(optional)

Returns: Task of PowerFormsResponse

Implements DocuSign.eSign.Api.IPowerFormsApi.

◆ DeletePowerFormsAsyncWithHttpInfo()

async System.Threading.Tasks.Task<ApiResponse<PowerFormsResponse> > DocuSign.eSign.Api.PowerFormsApi.DeletePowerFormsAsyncWithHttpInfo	(	string	accountId,
		PowerFormsRequest	powerFormsRequest = `null`
	)

inline

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`.

Exceptions

DocuSign.eSign.Client.ApiException Thrown when fails to make API call

Parameters

accountId	The external account number (int) or account ID Guid.
powerFormsRequest	(optional)

Returns: Task of ApiResponse (PowerFormsResponse)

Implements DocuSign.eSign.Api.IPowerFormsApi.

◆ DeletePowerFormsWithHttpInfo()

ApiResponse<PowerFormsResponse> DocuSign.eSign.Api.PowerFormsApi.DeletePowerFormsWithHttpInfo	(	string	accountId,
		PowerFormsRequest	powerFormsRequest = `null`
	)

inline

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`.

Exceptions

DocuSign.eSign.Client.ApiException Thrown when fails to make API call

Parameters

accountId	The external account number (int) or account ID Guid.
powerFormsRequest	(optional)

Returns: ApiResponse of PowerFormsResponse

Implements DocuSign.eSign.Api.IPowerFormsApi.

◆ DeletePowerFormWithHttpInfo()

ApiResponse<Object> DocuSign.eSign.Api.PowerFormsApi.DeletePowerFormWithHttpInfo	(	string	accountId,
		string	powerFormId
	)

inline

Delete a PowerForm. This method deletes a PowerForm.

Exceptions

DocuSign.eSign.Client.ApiException Thrown when fails to make API call

Parameters

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

Returns: ApiResponse of Object(void)

Implements DocuSign.eSign.Api.IPowerFormsApi.

◆ GetBasePath()

String DocuSign.eSign.Api.PowerFormsApi.GetBasePath ( )

inline

Gets the base path of the API client.

The base path

Implements DocuSign.eSign.Client.IApiAccessor.

◆ GetPowerForm()

PowerForm DocuSign.eSign.Api.PowerFormsApi.GetPowerForm	(	string	accountId,
		string	powerFormId
	)

inline

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

Exceptions

DocuSign.eSign.Client.ApiException Thrown when fails to make API call

Parameters

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

Returns: PowerForm

Implements DocuSign.eSign.Api.IPowerFormsApi.

◆ GetPowerFormAsync()

async System.Threading.Tasks.Task<PowerForm> DocuSign.eSign.Api.PowerFormsApi.GetPowerFormAsync	(	string	accountId,
		string	powerFormId
	)

inline

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

Exceptions

DocuSign.eSign.Client.ApiException Thrown when fails to make API call

Parameters

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

Returns: Task of PowerForm

Implements DocuSign.eSign.Api.IPowerFormsApi.

◆ GetPowerFormAsyncWithHttpInfo()

async System.Threading.Tasks.Task<ApiResponse<PowerForm> > DocuSign.eSign.Api.PowerFormsApi.GetPowerFormAsyncWithHttpInfo	(	string	accountId,
		string	powerFormId
	)

inline

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

Exceptions

DocuSign.eSign.Client.ApiException Thrown when fails to make API call

Parameters

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

Returns: Task of ApiResponse (PowerForm)

Implements DocuSign.eSign.Api.IPowerFormsApi.

◆ GetPowerFormData()

PowerFormsFormDataResponse DocuSign.eSign.Api.PowerFormsApi.GetPowerFormData	(	string	accountId,
		string	powerFormId,
		PowerFormsApi.GetPowerFormDataOptions	options = `null`
	)

inline

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.

Exceptions

DocuSign.eSign.Client.ApiException Thrown when fails to make API call

Parameters

accountId	The external account number (int) or account ID Guid.
powerFormId
options	Options for modifying the behavior of the function.

Returns: PowerFormsFormDataResponse

◆ GetPowerFormDataAsync()

async System.Threading.Tasks.Task<PowerFormsFormDataResponse> DocuSign.eSign.Api.PowerFormsApi.GetPowerFormDataAsync	(	string	accountId,
		string	powerFormId,
		PowerFormsApi.GetPowerFormDataOptions	options = `null`
	)

inline

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.

Exceptions

DocuSign.eSign.Client.ApiException Thrown when fails to make API call

Parameters

accountId	The external account number (int) or account ID Guid.
powerFormId
options	Options for modifying the behavior of the function.

Returns: Task of PowerFormsFormDataResponse

◆ GetPowerFormDataAsyncWithHttpInfo()

async System.Threading.Tasks.Task<ApiResponse<PowerFormsFormDataResponse> > DocuSign.eSign.Api.PowerFormsApi.GetPowerFormDataAsyncWithHttpInfo	(	string	accountId,
		string	powerFormId,
		PowerFormsApi.GetPowerFormDataOptions	options = `null`
	)

inline

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.

Exceptions

DocuSign.eSign.Client.ApiException Thrown when fails to make API call

Parameters

accountId	The external account number (int) or account ID Guid.
powerFormId
options	Options for modifying the behavior of the function.

Returns: Task of ApiResponse (PowerFormsFormDataResponse)

◆ GetPowerFormDataWithHttpInfo()

ApiResponse<PowerFormsFormDataResponse> DocuSign.eSign.Api.PowerFormsApi.GetPowerFormDataWithHttpInfo	(	string	accountId,
		string	powerFormId,
		PowerFormsApi.GetPowerFormDataOptions	options = `null`
	)

inline

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.

Exceptions

DocuSign.eSign.Client.ApiException Thrown when fails to make API call

Parameters

accountId	The external account number (int) or account ID Guid.
powerFormId
options	Options for modifying the behavior of the function.

Returns: ApiResponse of PowerFormsFormDataResponse

◆ GetPowerFormWithHttpInfo()

ApiResponse<PowerForm> DocuSign.eSign.Api.PowerFormsApi.GetPowerFormWithHttpInfo	(	string	accountId,
		string	powerFormId
	)

inline

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

Exceptions

DocuSign.eSign.Client.ApiException Thrown when fails to make API call

Parameters

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

Returns: ApiResponse of PowerForm

Implements DocuSign.eSign.Api.IPowerFormsApi.

◆ ListPowerForms()

PowerFormsResponse DocuSign.eSign.Api.PowerFormsApi.ListPowerForms	(	string	accountId,
		PowerFormsApi.ListPowerFormsOptions	options = `null`
	)

inline

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

Exceptions

DocuSign.eSign.Client.ApiException Thrown when fails to make API call

Parameters

accountId	The external account number (int) or account ID Guid.
options	Options for modifying the behavior of the function.

Returns: PowerFormsResponse

◆ ListPowerFormsAsync()

async System.Threading.Tasks.Task<PowerFormsResponse> DocuSign.eSign.Api.PowerFormsApi.ListPowerFormsAsync	(	string	accountId,
		PowerFormsApi.ListPowerFormsOptions	options = `null`
	)

inline

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

Exceptions

DocuSign.eSign.Client.ApiException Thrown when fails to make API call

Parameters

accountId	The external account number (int) or account ID Guid.
options	Options for modifying the behavior of the function.

Returns: Task of PowerFormsResponse

◆ ListPowerFormsAsyncWithHttpInfo()

async System.Threading.Tasks.Task<ApiResponse<PowerFormsResponse> > DocuSign.eSign.Api.PowerFormsApi.ListPowerFormsAsyncWithHttpInfo	(	string	accountId,
		PowerFormsApi.ListPowerFormsOptions	options = `null`
	)

inline

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

Exceptions

DocuSign.eSign.Client.ApiException Thrown when fails to make API call

Parameters

accountId	The external account number (int) or account ID Guid.
options	Options for modifying the behavior of the function.

Returns: Task of ApiResponse (PowerFormsResponse)

◆ ListPowerFormSenders()

PowerFormSendersResponse DocuSign.eSign.Api.PowerFormsApi.ListPowerFormSenders	(	string	accountId,
		PowerFormsApi.ListPowerFormSendersOptions	options = `null`
	)

inline

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

Exceptions

DocuSign.eSign.Client.ApiException Thrown when fails to make API call

Parameters

accountId	The external account number (int) or account ID Guid.
options	Options for modifying the behavior of the function.

Returns: PowerFormSendersResponse

◆ ListPowerFormSendersAsync()

async System.Threading.Tasks.Task<PowerFormSendersResponse> DocuSign.eSign.Api.PowerFormsApi.ListPowerFormSendersAsync	(	string	accountId,
		PowerFormsApi.ListPowerFormSendersOptions	options = `null`
	)

inline

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

Exceptions

DocuSign.eSign.Client.ApiException Thrown when fails to make API call

Parameters

accountId	The external account number (int) or account ID Guid.
options	Options for modifying the behavior of the function.

Returns: Task of PowerFormSendersResponse

◆ ListPowerFormSendersAsyncWithHttpInfo()

async System.Threading.Tasks.Task<ApiResponse<PowerFormSendersResponse> > DocuSign.eSign.Api.PowerFormsApi.ListPowerFormSendersAsyncWithHttpInfo	(	string	accountId,
		PowerFormsApi.ListPowerFormSendersOptions	options = `null`
	)

inline

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

Exceptions

DocuSign.eSign.Client.ApiException Thrown when fails to make API call

Parameters

accountId	The external account number (int) or account ID Guid.
options	Options for modifying the behavior of the function.

Returns: Task of ApiResponse (PowerFormSendersResponse)

◆ ListPowerFormSendersWithHttpInfo()

ApiResponse<PowerFormSendersResponse> DocuSign.eSign.Api.PowerFormsApi.ListPowerFormSendersWithHttpInfo	(	string	accountId,
		PowerFormsApi.ListPowerFormSendersOptions	options = `null`
	)

inline

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

Exceptions

DocuSign.eSign.Client.ApiException Thrown when fails to make API call

Parameters

accountId	The external account number (int) or account ID Guid.
options	Options for modifying the behavior of the function.

Returns: ApiResponse of PowerFormSendersResponse

◆ ListPowerFormsWithHttpInfo()

ApiResponse<PowerFormsResponse> DocuSign.eSign.Api.PowerFormsApi.ListPowerFormsWithHttpInfo	(	string	accountId,
		PowerFormsApi.ListPowerFormsOptions	options = `null`
	)

inline

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

Exceptions

DocuSign.eSign.Client.ApiException Thrown when fails to make API call

Parameters

accountId	The external account number (int) or account ID Guid.
options	Options for modifying the behavior of the function.

Returns: ApiResponse of PowerFormsResponse

◆ UpdatePowerForm()

PowerForm DocuSign.eSign.Api.PowerFormsApi.UpdatePowerForm	(	string	accountId,
		string	powerFormId,
		PowerForm	powerForm = `null`
	)

inline

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

Exceptions

DocuSign.eSign.Client.ApiException Thrown when fails to make API call

Parameters

accountId	The external account number (int) or account ID Guid.
powerFormId
powerForm	(optional)

Returns: PowerForm

Implements DocuSign.eSign.Api.IPowerFormsApi.

◆ UpdatePowerFormAsync()

async System.Threading.Tasks.Task<PowerForm> DocuSign.eSign.Api.PowerFormsApi.UpdatePowerFormAsync	(	string	accountId,
		string	powerFormId,
		PowerForm	powerForm = `null`
	)

inline

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

Exceptions

DocuSign.eSign.Client.ApiException Thrown when fails to make API call

Parameters

accountId	The external account number (int) or account ID Guid.
powerFormId
powerForm	(optional)

Returns: Task of PowerForm

Implements DocuSign.eSign.Api.IPowerFormsApi.

◆ UpdatePowerFormAsyncWithHttpInfo()

async System.Threading.Tasks.Task<ApiResponse<PowerForm> > DocuSign.eSign.Api.PowerFormsApi.UpdatePowerFormAsyncWithHttpInfo	(	string	accountId,
		string	powerFormId,
		PowerForm	powerForm = `null`
	)

inline

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

Exceptions

DocuSign.eSign.Client.ApiException Thrown when fails to make API call

Parameters

accountId	The external account number (int) or account ID Guid.
powerFormId
powerForm	(optional)

Returns: Task of ApiResponse (PowerForm)

Implements DocuSign.eSign.Api.IPowerFormsApi.

◆ UpdatePowerFormWithHttpInfo()

ApiResponse<PowerForm> DocuSign.eSign.Api.PowerFormsApi.UpdatePowerFormWithHttpInfo	(	string	accountId,
		string	powerFormId,
		PowerForm	powerForm = `null`
	)

inline

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

Exceptions

DocuSign.eSign.Client.ApiException Thrown when fails to make API call

Parameters

accountId	The external account number (int) or account ID Guid.
powerFormId
powerForm	(optional)

Returns: ApiResponse of PowerForm

Implements DocuSign.eSign.Api.IPowerFormsApi.

Property Documentation

◆ ApiClient

DocuSignClient DocuSign.eSign.Api.PowerFormsApi.ApiClient

getset

Gets or sets the ApiClient object

An instance of the ApiClient

◆ ExceptionFactory

DocuSign.eSign.Client.ExceptionFactory DocuSign.eSign.Api.PowerFormsApi.ExceptionFactory

getset

Provides a factory method hook for the creation of exceptions.

The documentation for this class was generated from the following file:

sdk/src/DocuSign.eSign/Api/PowerFormsApi.cs

Classes

Public Member Functions

Properties

Detailed Description

Constructor & Destructor Documentation

◆ PowerFormsApi()

Member Function Documentation

◆ CreatePowerForm()

◆ CreatePowerFormAsync()

◆ CreatePowerFormAsyncWithHttpInfo()

◆ CreatePowerFormWithHttpInfo()

◆ DeletePowerForm()

◆ DeletePowerFormAsync()

◆ DeletePowerFormAsyncWithHttpInfo()

◆ DeletePowerForms()

◆ DeletePowerFormsAsync()

◆ DeletePowerFormsAsyncWithHttpInfo()

◆ DeletePowerFormsWithHttpInfo()

◆ DeletePowerFormWithHttpInfo()

◆ GetBasePath()

◆ GetPowerForm()

◆ GetPowerFormAsync()

◆ GetPowerFormAsyncWithHttpInfo()

◆ GetPowerFormData()

◆ GetPowerFormDataAsync()

◆ GetPowerFormDataAsyncWithHttpInfo()

◆ GetPowerFormDataWithHttpInfo()

◆ GetPowerFormWithHttpInfo()

◆ ListPowerForms()

◆ ListPowerFormsAsync()

◆ ListPowerFormsAsyncWithHttpInfo()

◆ ListPowerFormSenders()

◆ ListPowerFormSendersAsync()

◆ ListPowerFormSendersAsyncWithHttpInfo()

◆ ListPowerFormSendersWithHttpInfo()

◆ ListPowerFormsWithHttpInfo()

◆ UpdatePowerForm()

◆ UpdatePowerFormAsync()

◆ UpdatePowerFormAsyncWithHttpInfo()

◆ UpdatePowerFormWithHttpInfo()

Property Documentation

◆ ApiClient

◆ ExceptionFactory