Docusign CSharp Docs
Classes | Public Member Functions | Properties | List of all members
DocuSign.eSign.Api.TemplatesApi Class Reference

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

Inheritance diagram for DocuSign.eSign.Api.TemplatesApi:
DocuSign.eSign.Api.ITemplatesApi DocuSign.eSign.Client.IApiAccessor

Classes

class  CreateRecipientsOptions
 Adds tabs for a recipient. Adds one or more recipients to a template. More...
 
class  GetDocumentOptions
 Gets PDF documents from a template. Retrieves one or more PDF documents from the specified template. You can specify the ID of the document to retrieve or can specify `combined` to retrieve all documents in the template as one pdf. More...
 
class  GetDocumentPageImageOptions
 Gets a page image from a template for display. Retrieves a page image for display from the specified template. More...
 
class  GetDocumentTabsOptions
 Returns tabs on the document. Returns the tabs on the document specified by `documentId` in the template specified by `templateId`. More...
 
class  GetOptions
 Gets a list of templates for a specified account. Retrieves the definition of the specified template. More...
 
class  GetPagesOptions
 Returns document page image(s) based on input. Returns images of the pages in a template document for display based on the parameters that you specify. More...
 
class  ListDocumentsOptions
 Gets a list of documents associated with a template. Retrieves a list of documents associated with the specified template. More...
 
class  ListRecipientsOptions
 Gets recipient information from a template. Retrieves the information for all recipients in the specified template. More...
 
class  ListTabsOptions
 Gets the tabs information for a signer or sign-in-person recipient in a template. Gets the tabs information for a signer or sign-in-person recipient in a template. More...
 
class  ListTemplatesOptions
 Gets the definition of a template. Retrieves the list of templates for the specified account. The request can be limited to a specific folder. More...
 
class  UpdateDocumentOptions
 Adds a document to a template document. Adds the specified document to an existing template document. More...
 
class  UpdateRecipientsOptions
 Updates recipients in a template. Updates recipients in a template. You can edit the following properties: `email`, `userName`, `routingOrder`, `faxNumber`, `deliveryMethod`, `accessCode`, and `requireIdLookup`. More...
 

Public Member Functions

 TemplatesApi (DocuSignClient aplClient)
 Initializes a new instance of the TemplatesApi class using AplClient object More...
 
String GetBasePath ()
 Gets the base path of the API client. More...
 
CustomFields CreateCustomFields (string accountId, string templateId, TemplateCustomFields templateCustomFields=null)
 Creates custom document fields in an existing template document. Creates custom document fields in an existing template document. More...
 
ApiResponse< CustomFieldsCreateCustomFieldsWithHttpInfo (string accountId, string templateId, TemplateCustomFields templateCustomFields=null)
 Creates custom document fields in an existing template document. Creates custom document fields in an existing template document. More...
 
async System.Threading.Tasks.Task< CustomFieldsCreateCustomFieldsAsync (string accountId, string templateId, TemplateCustomFields templateCustomFields=null)
 Creates custom document fields in an existing template document. Creates custom document fields in an existing template document. More...
 
async System.Threading.Tasks.Task< ApiResponse< CustomFields > > CreateCustomFieldsAsyncWithHttpInfo (string accountId, string templateId, TemplateCustomFields templateCustomFields=null)
 Creates custom document fields in an existing template document. Creates custom document fields in an existing template document. More...
 
DocumentFieldsInformation CreateDocumentFields (string accountId, string templateId, string documentId, DocumentFieldsInformation documentFieldsInformation=null)
 Creates custom document fields in an existing template document. Creates custom document fields in an existing template document. More...
 
ApiResponse< DocumentFieldsInformationCreateDocumentFieldsWithHttpInfo (string accountId, string templateId, string documentId, DocumentFieldsInformation documentFieldsInformation=null)
 Creates custom document fields in an existing template document. Creates custom document fields in an existing template document. More...
 
async System.Threading.Tasks.Task< DocumentFieldsInformationCreateDocumentFieldsAsync (string accountId, string templateId, string documentId, DocumentFieldsInformation documentFieldsInformation=null)
 Creates custom document fields in an existing template document. Creates custom document fields in an existing template document. More...
 
async System.Threading.Tasks.Task< ApiResponse< DocumentFieldsInformation > > CreateDocumentFieldsAsyncWithHttpInfo (string accountId, string templateId, string documentId, DocumentFieldsInformation documentFieldsInformation=null)
 Creates custom document fields in an existing template document. Creates custom document fields in an existing template document. More...
 
ViewUrl CreateEditView (string accountId, string templateId, TemplateViewRequest templateViewRequest=null)
 Provides a URL to start an edit view of the Template UI This method returns a URL for starting an edit view of a template that uses the DocuSign Template UI. More...
 
ApiResponse< ViewUrlCreateEditViewWithHttpInfo (string accountId, string templateId, TemplateViewRequest templateViewRequest=null)
 Provides a URL to start an edit view of the Template UI This method returns a URL for starting an edit view of a template that uses the DocuSign Template UI. More...
 
async System.Threading.Tasks.Task< ViewUrlCreateEditViewAsync (string accountId, string templateId, TemplateViewRequest templateViewRequest=null)
 Provides a URL to start an edit view of the Template UI This method returns a URL for starting an edit view of a template that uses the DocuSign Template UI. More...
 
async System.Threading.Tasks.Task< ApiResponse< ViewUrl > > CreateEditViewAsyncWithHttpInfo (string accountId, string templateId, TemplateViewRequest templateViewRequest=null)
 Provides a URL to start an edit view of the Template UI This method returns a URL for starting an edit view of a template that uses the DocuSign Template UI. More...
 
LockInformation CreateLock (string accountId, string templateId, LockRequest lockRequest=null)
 Lock a template. Locks the specified template, and sets the time until the lock expires, to prevent other users or recipients from accessing and changing the template. ###### Note: Users must have envelope locking capability enabled to use this function (the userSetting property &#x60;canLockEnvelopes&#x60; must be set to true for the user). More...
 
ApiResponse< LockInformationCreateLockWithHttpInfo (string accountId, string templateId, LockRequest lockRequest=null)
 Lock a template. Locks the specified template, and sets the time until the lock expires, to prevent other users or recipients from accessing and changing the template. ###### Note: Users must have envelope locking capability enabled to use this function (the userSetting property &#x60;canLockEnvelopes&#x60; must be set to true for the user). More...
 
async System.Threading.Tasks.Task< LockInformationCreateLockAsync (string accountId, string templateId, LockRequest lockRequest=null)
 Lock a template. Locks the specified template, and sets the time until the lock expires, to prevent other users or recipients from accessing and changing the template. ###### Note: Users must have envelope locking capability enabled to use this function (the userSetting property &#x60;canLockEnvelopes&#x60; must be set to true for the user). More...
 
async System.Threading.Tasks.Task< ApiResponse< LockInformation > > CreateLockAsyncWithHttpInfo (string accountId, string templateId, LockRequest lockRequest=null)
 Lock a template. Locks the specified template, and sets the time until the lock expires, to prevent other users or recipients from accessing and changing the template. ###### Note: Users must have envelope locking capability enabled to use this function (the userSetting property &#x60;canLockEnvelopes&#x60; must be set to true for the user). More...
 
Recipients CreateRecipients (string accountId, string templateId, TemplateRecipients templateRecipients=null, TemplatesApi.CreateRecipientsOptions options=null)
 Adds tabs for a recipient. Adds one or more recipients to a template. More...
 
ApiResponse< RecipientsCreateRecipientsWithHttpInfo (string accountId, string templateId, TemplateRecipients templateRecipients=null, TemplatesApi.CreateRecipientsOptions options=null)
 Adds tabs for a recipient. Adds one or more recipients to a template. More...
 
async System.Threading.Tasks.Task< RecipientsCreateRecipientsAsync (string accountId, string templateId, TemplateRecipients templateRecipients=null, TemplatesApi.CreateRecipientsOptions options=null)
 Adds tabs for a recipient. Adds one or more recipients to a template. More...
 
async System.Threading.Tasks.Task< ApiResponse< Recipients > > CreateRecipientsAsyncWithHttpInfo (string accountId, string templateId, TemplateRecipients templateRecipients=null, TemplatesApi.CreateRecipientsOptions options=null)
 Adds tabs for a recipient. Adds one or more recipients to a template. More...
 
Tabs CreateTabs (string accountId, string templateId, string recipientId, TemplateTabs templateTabs=null)
 Adds tabs for a recipient. Adds one or more tabs for a recipient. More...
 
ApiResponse< TabsCreateTabsWithHttpInfo (string accountId, string templateId, string recipientId, TemplateTabs templateTabs=null)
 Adds tabs for a recipient. Adds one or more tabs for a recipient. More...
 
async System.Threading.Tasks.Task< TabsCreateTabsAsync (string accountId, string templateId, string recipientId, TemplateTabs templateTabs=null)
 Adds tabs for a recipient. Adds one or more tabs for a recipient. More...
 
async System.Threading.Tasks.Task< ApiResponse< Tabs > > CreateTabsAsyncWithHttpInfo (string accountId, string templateId, string recipientId, TemplateTabs templateTabs=null)
 Adds tabs for a recipient. Adds one or more tabs for a recipient. More...
 
TemplateSummary CreateTemplate (string accountId, EnvelopeTemplate envelopeTemplate=null)
 Creates an envelope from a template. Creates a template definition using a multipart request. ###Template Email Subject Merge Fields Call this endpoint to insert a recipient name and email address merge fields into the email subject line when creating or sending from a template. The merge fields, based on the recipient&#39;s role name, are added to the &#x60;emailSubject&#x60; property when the template is created or when the template is used to create an envelope. After a template sender adds the name and email information for the recipient and sends the envelope, the recipient information is automatically merged into the appropriate fields in the email subject line. Both the sender and the recipients will see the information in the email subject line for any emails associated with the template. This provides an easy way for senders to organize their envelope emails without having to open an envelope to check the recipient. ###### Note: If merging the recipient information into the subject line causes the subject line to exceed 100 characters, then any characters over the 100 character limit are not included in the subject line. For cases where the recipient name or email is expected to be long, you should consider placing the merge field at the start of the email subject. To add a recipient&#39;s name in the subject line add the following text in the &#x60;emailSubject&#x60; property when creating the template or when sending an envelope from a template: [[<roleName>_UserName]] Example: &#x60;&quot;emailSubject&quot;:&quot;[[Signer 1_UserName]], Please sign this NDA&quot;,&#x60; To add a recipient&#39;s email address in the subject line add the following text in the &#x60;emailSubject&#x60; property when creating the template or when sending an envelope from a template: [[<roleName>_Email]] Example: &#x60;&quot;emailSubject&quot;:&quot;[[Signer 1_Email]], Please sign this NDA&quot;,&#x60; In both cases the <roleName> is the recipient&#39;s contents of the &#x60;roleName&#x60; property in the template. For cases where another recipient (such as an Agent, Editor, or Intermediary recipient) is entering the name and email information for the recipient included in the email subject, then [[<roleName>_UserName]] or [[<roleName>_Email]] is shown in the email subject. More...
 
ApiResponse< TemplateSummaryCreateTemplateWithHttpInfo (string accountId, EnvelopeTemplate envelopeTemplate=null)
 Creates an envelope from a template. Creates a template definition using a multipart request. ###Template Email Subject Merge Fields Call this endpoint to insert a recipient name and email address merge fields into the email subject line when creating or sending from a template. The merge fields, based on the recipient&#39;s role name, are added to the &#x60;emailSubject&#x60; property when the template is created or when the template is used to create an envelope. After a template sender adds the name and email information for the recipient and sends the envelope, the recipient information is automatically merged into the appropriate fields in the email subject line. Both the sender and the recipients will see the information in the email subject line for any emails associated with the template. This provides an easy way for senders to organize their envelope emails without having to open an envelope to check the recipient. ###### Note: If merging the recipient information into the subject line causes the subject line to exceed 100 characters, then any characters over the 100 character limit are not included in the subject line. For cases where the recipient name or email is expected to be long, you should consider placing the merge field at the start of the email subject. To add a recipient&#39;s name in the subject line add the following text in the &#x60;emailSubject&#x60; property when creating the template or when sending an envelope from a template: [[<roleName>_UserName]] Example: &#x60;&quot;emailSubject&quot;:&quot;[[Signer 1_UserName]], Please sign this NDA&quot;,&#x60; To add a recipient&#39;s email address in the subject line add the following text in the &#x60;emailSubject&#x60; property when creating the template or when sending an envelope from a template: [[<roleName>_Email]] Example: &#x60;&quot;emailSubject&quot;:&quot;[[Signer 1_Email]], Please sign this NDA&quot;,&#x60; In both cases the <roleName> is the recipient&#39;s contents of the &#x60;roleName&#x60; property in the template. For cases where another recipient (such as an Agent, Editor, or Intermediary recipient) is entering the name and email information for the recipient included in the email subject, then [[<roleName>_UserName]] or [[<roleName>_Email]] is shown in the email subject. More...
 
async System.Threading.Tasks.Task< TemplateSummaryCreateTemplateAsync (string accountId, EnvelopeTemplate envelopeTemplate=null)
 Creates an envelope from a template. Creates a template definition using a multipart request. ###Template Email Subject Merge Fields Call this endpoint to insert a recipient name and email address merge fields into the email subject line when creating or sending from a template. The merge fields, based on the recipient&#39;s role name, are added to the &#x60;emailSubject&#x60; property when the template is created or when the template is used to create an envelope. After a template sender adds the name and email information for the recipient and sends the envelope, the recipient information is automatically merged into the appropriate fields in the email subject line. Both the sender and the recipients will see the information in the email subject line for any emails associated with the template. This provides an easy way for senders to organize their envelope emails without having to open an envelope to check the recipient. ###### Note: If merging the recipient information into the subject line causes the subject line to exceed 100 characters, then any characters over the 100 character limit are not included in the subject line. For cases where the recipient name or email is expected to be long, you should consider placing the merge field at the start of the email subject. To add a recipient&#39;s name in the subject line add the following text in the &#x60;emailSubject&#x60; property when creating the template or when sending an envelope from a template: [[<roleName>_UserName]] Example: &#x60;&quot;emailSubject&quot;:&quot;[[Signer 1_UserName]], Please sign this NDA&quot;,&#x60; To add a recipient&#39;s email address in the subject line add the following text in the &#x60;emailSubject&#x60; property when creating the template or when sending an envelope from a template: [[<roleName>_Email]] Example: &#x60;&quot;emailSubject&quot;:&quot;[[Signer 1_Email]], Please sign this NDA&quot;,&#x60; In both cases the <roleName> is the recipient&#39;s contents of the &#x60;roleName&#x60; property in the template. For cases where another recipient (such as an Agent, Editor, or Intermediary recipient) is entering the name and email information for the recipient included in the email subject, then [[<roleName>_UserName]] or [[<roleName>_Email]] is shown in the email subject. More...
 
async System.Threading.Tasks.Task< ApiResponse< TemplateSummary > > CreateTemplateAsyncWithHttpInfo (string accountId, EnvelopeTemplate envelopeTemplate=null)
 Creates an envelope from a template. Creates a template definition using a multipart request. ###Template Email Subject Merge Fields Call this endpoint to insert a recipient name and email address merge fields into the email subject line when creating or sending from a template. The merge fields, based on the recipient&#39;s role name, are added to the &#x60;emailSubject&#x60; property when the template is created or when the template is used to create an envelope. After a template sender adds the name and email information for the recipient and sends the envelope, the recipient information is automatically merged into the appropriate fields in the email subject line. Both the sender and the recipients will see the information in the email subject line for any emails associated with the template. This provides an easy way for senders to organize their envelope emails without having to open an envelope to check the recipient. ###### Note: If merging the recipient information into the subject line causes the subject line to exceed 100 characters, then any characters over the 100 character limit are not included in the subject line. For cases where the recipient name or email is expected to be long, you should consider placing the merge field at the start of the email subject. To add a recipient&#39;s name in the subject line add the following text in the &#x60;emailSubject&#x60; property when creating the template or when sending an envelope from a template: [[<roleName>_UserName]] Example: &#x60;&quot;emailSubject&quot;:&quot;[[Signer 1_UserName]], Please sign this NDA&quot;,&#x60; To add a recipient&#39;s email address in the subject line add the following text in the &#x60;emailSubject&#x60; property when creating the template or when sending an envelope from a template: [[<roleName>_Email]] Example: &#x60;&quot;emailSubject&quot;:&quot;[[Signer 1_Email]], Please sign this NDA&quot;,&#x60; In both cases the <roleName> is the recipient&#39;s contents of the &#x60;roleName&#x60; property in the template. For cases where another recipient (such as an Agent, Editor, or Intermediary recipient) is entering the name and email information for the recipient included in the email subject, then [[<roleName>_UserName]] or [[<roleName>_Email]] is shown in the email subject. More...
 
DocumentHtmlDefinitions CreateTemplateDocumentResponsiveHtmlPreview (string accountId, string templateId, string documentId, DocumentHtmlDefinition documentHtmlDefinition=null)
 Post Responsive HTML Preview for a document in a template. Creates a preview of the responsive, HTML version of a specific template document. This method enables you to preview a PDF document conversion to responsive HTML across device types prior to sending. The request body is a &#x60;documentHtmlDefinition&#x60; object, which holds the responsive signing parameters that define how to generate the HTML version of the signing document. More...
 
ApiResponse< DocumentHtmlDefinitionsCreateTemplateDocumentResponsiveHtmlPreviewWithHttpInfo (string accountId, string templateId, string documentId, DocumentHtmlDefinition documentHtmlDefinition=null)
 Post Responsive HTML Preview for a document in a template. Creates a preview of the responsive, HTML version of a specific template document. This method enables you to preview a PDF document conversion to responsive HTML across device types prior to sending. The request body is a &#x60;documentHtmlDefinition&#x60; object, which holds the responsive signing parameters that define how to generate the HTML version of the signing document. More...
 
async System.Threading.Tasks.Task< DocumentHtmlDefinitionsCreateTemplateDocumentResponsiveHtmlPreviewAsync (string accountId, string templateId, string documentId, DocumentHtmlDefinition documentHtmlDefinition=null)
 Post Responsive HTML Preview for a document in a template. Creates a preview of the responsive, HTML version of a specific template document. This method enables you to preview a PDF document conversion to responsive HTML across device types prior to sending. The request body is a &#x60;documentHtmlDefinition&#x60; object, which holds the responsive signing parameters that define how to generate the HTML version of the signing document. More...
 
async System.Threading.Tasks.Task< ApiResponse< DocumentHtmlDefinitions > > CreateTemplateDocumentResponsiveHtmlPreviewAsyncWithHttpInfo (string accountId, string templateId, string documentId, DocumentHtmlDefinition documentHtmlDefinition=null)
 Post Responsive HTML Preview for a document in a template. Creates a preview of the responsive, HTML version of a specific template document. This method enables you to preview a PDF document conversion to responsive HTML across device types prior to sending. The request body is a &#x60;documentHtmlDefinition&#x60; object, which holds the responsive signing parameters that define how to generate the HTML version of the signing document. More...
 
Tabs CreateTemplateDocumentTabs (string accountId, string templateId, string documentId, TemplateTabs templateTabs=null)
 Adds the tabs to a tempate Adds tabs to the document specified by &#x60;documentId&#x60; in the template specified by &#x60;templateId&#x60;. In the request body, you only need to specify the tabs that your are adding. For example, to add a text prefill tab, your request body might look like this: &#x60;&#x60;&#x60; { &quot;prefillTabs&quot;: { &quot;textTabs&quot;: [ { &quot;value&quot;: &quot;a prefill text tab&quot;, &quot;pageNumber&quot;: &quot;1&quot;, &quot;documentId&quot;: &quot;1&quot;, &quot;xPosition&quot;: 316, &quot;yPosition&quot;: 97 } ] } } &#x60;&#x60;&#x60; More...
 
ApiResponse< TabsCreateTemplateDocumentTabsWithHttpInfo (string accountId, string templateId, string documentId, TemplateTabs templateTabs=null)
 Adds the tabs to a tempate Adds tabs to the document specified by &#x60;documentId&#x60; in the template specified by &#x60;templateId&#x60;. In the request body, you only need to specify the tabs that your are adding. For example, to add a text prefill tab, your request body might look like this: &#x60;&#x60;&#x60; { &quot;prefillTabs&quot;: { &quot;textTabs&quot;: [ { &quot;value&quot;: &quot;a prefill text tab&quot;, &quot;pageNumber&quot;: &quot;1&quot;, &quot;documentId&quot;: &quot;1&quot;, &quot;xPosition&quot;: 316, &quot;yPosition&quot;: 97 } ] } } &#x60;&#x60;&#x60; More...
 
async System.Threading.Tasks.Task< TabsCreateTemplateDocumentTabsAsync (string accountId, string templateId, string documentId, TemplateTabs templateTabs=null)
 Adds the tabs to a tempate Adds tabs to the document specified by &#x60;documentId&#x60; in the template specified by &#x60;templateId&#x60;. In the request body, you only need to specify the tabs that your are adding. For example, to add a text prefill tab, your request body might look like this: &#x60;&#x60;&#x60; { &quot;prefillTabs&quot;: { &quot;textTabs&quot;: [ { &quot;value&quot;: &quot;a prefill text tab&quot;, &quot;pageNumber&quot;: &quot;1&quot;, &quot;documentId&quot;: &quot;1&quot;, &quot;xPosition&quot;: 316, &quot;yPosition&quot;: 97 } ] } } &#x60;&#x60;&#x60; More...
 
async System.Threading.Tasks.Task< ApiResponse< Tabs > > CreateTemplateDocumentTabsAsyncWithHttpInfo (string accountId, string templateId, string documentId, TemplateTabs templateTabs=null)
 Adds the tabs to a tempate Adds tabs to the document specified by &#x60;documentId&#x60; in the template specified by &#x60;templateId&#x60;. In the request body, you only need to specify the tabs that your are adding. For example, to add a text prefill tab, your request body might look like this: &#x60;&#x60;&#x60; { &quot;prefillTabs&quot;: { &quot;textTabs&quot;: [ { &quot;value&quot;: &quot;a prefill text tab&quot;, &quot;pageNumber&quot;: &quot;1&quot;, &quot;documentId&quot;: &quot;1&quot;, &quot;xPosition&quot;: 316, &quot;yPosition&quot;: 97 } ] } } &#x60;&#x60;&#x60; More...
 
ViewUrl CreateTemplateRecipientPreview (string accountId, string templateId, RecipientPreviewRequest recipientPreviewRequest=null)
 Provides a URL to start a recipient view of the Envelope UI This method returns a URL for a template recipient preview in the DocuSign UI that you can embed in your application. You use this method to enable the sender to preview the recipients&#39; experience. For more information, see Preview and Send. More...
 
ApiResponse< ViewUrlCreateTemplateRecipientPreviewWithHttpInfo (string accountId, string templateId, RecipientPreviewRequest recipientPreviewRequest=null)
 Provides a URL to start a recipient view of the Envelope UI This method returns a URL for a template recipient preview in the DocuSign UI that you can embed in your application. You use this method to enable the sender to preview the recipients&#39; experience. For more information, see Preview and Send. More...
 
async System.Threading.Tasks.Task< ViewUrlCreateTemplateRecipientPreviewAsync (string accountId, string templateId, RecipientPreviewRequest recipientPreviewRequest=null)
 Provides a URL to start a recipient view of the Envelope UI This method returns a URL for a template recipient preview in the DocuSign UI that you can embed in your application. You use this method to enable the sender to preview the recipients&#39; experience. For more information, see Preview and Send. More...
 
async System.Threading.Tasks.Task< ApiResponse< ViewUrl > > CreateTemplateRecipientPreviewAsyncWithHttpInfo (string accountId, string templateId, RecipientPreviewRequest recipientPreviewRequest=null)
 Provides a URL to start a recipient view of the Envelope UI This method returns a URL for a template recipient preview in the DocuSign UI that you can embed in your application. You use this method to enable the sender to preview the recipients&#39; experience. For more information, see Preview and Send. More...
 
DocumentHtmlDefinitions CreateTemplateResponsiveHtmlPreview (string accountId, string templateId, DocumentHtmlDefinition documentHtmlDefinition=null)
 Get Responsive HTML Preview for all documents in a template. Creates a preview of the responsive, HTML versions of all of the documents associated with a template. This method enables you to preview the PDF document conversions to responsive HTML across device types prior to sending. The request body is a &#x60;documentHtmlDefinition&#x60; object, which holds the responsive signing parameters that define how to generate the HTML version of the documents. More...
 
ApiResponse< DocumentHtmlDefinitionsCreateTemplateResponsiveHtmlPreviewWithHttpInfo (string accountId, string templateId, DocumentHtmlDefinition documentHtmlDefinition=null)
 Get Responsive HTML Preview for all documents in a template. Creates a preview of the responsive, HTML versions of all of the documents associated with a template. This method enables you to preview the PDF document conversions to responsive HTML across device types prior to sending. The request body is a &#x60;documentHtmlDefinition&#x60; object, which holds the responsive signing parameters that define how to generate the HTML version of the documents. More...
 
async System.Threading.Tasks.Task< DocumentHtmlDefinitionsCreateTemplateResponsiveHtmlPreviewAsync (string accountId, string templateId, DocumentHtmlDefinition documentHtmlDefinition=null)
 Get Responsive HTML Preview for all documents in a template. Creates a preview of the responsive, HTML versions of all of the documents associated with a template. This method enables you to preview the PDF document conversions to responsive HTML across device types prior to sending. The request body is a &#x60;documentHtmlDefinition&#x60; object, which holds the responsive signing parameters that define how to generate the HTML version of the documents. More...
 
async System.Threading.Tasks.Task< ApiResponse< DocumentHtmlDefinitions > > CreateTemplateResponsiveHtmlPreviewAsyncWithHttpInfo (string accountId, string templateId, DocumentHtmlDefinition documentHtmlDefinition=null)
 Get Responsive HTML Preview for all documents in a template. Creates a preview of the responsive, HTML versions of all of the documents associated with a template. This method enables you to preview the PDF document conversions to responsive HTML across device types prior to sending. The request body is a &#x60;documentHtmlDefinition&#x60; object, which holds the responsive signing parameters that define how to generate the HTML version of the documents. More...
 
CustomFields DeleteCustomFields (string accountId, string templateId, TemplateCustomFields templateCustomFields=null)
 Deletes envelope custom fields in a template. Deletes envelope custom fields in a template. More...
 
ApiResponse< CustomFieldsDeleteCustomFieldsWithHttpInfo (string accountId, string templateId, TemplateCustomFields templateCustomFields=null)
 Deletes envelope custom fields in a template. Deletes envelope custom fields in a template. More...
 
async System.Threading.Tasks.Task< CustomFieldsDeleteCustomFieldsAsync (string accountId, string templateId, TemplateCustomFields templateCustomFields=null)
 Deletes envelope custom fields in a template. Deletes envelope custom fields in a template. More...
 
async System.Threading.Tasks.Task< ApiResponse< CustomFields > > DeleteCustomFieldsAsyncWithHttpInfo (string accountId, string templateId, TemplateCustomFields templateCustomFields=null)
 Deletes envelope custom fields in a template. Deletes envelope custom fields in a template. More...
 
DocumentFieldsInformation DeleteDocumentFields (string accountId, string templateId, string documentId, DocumentFieldsInformation documentFieldsInformation=null)
 Deletes custom document fields from an existing template document. Deletes custom document fields from an existing template document. More...
 
ApiResponse< DocumentFieldsInformationDeleteDocumentFieldsWithHttpInfo (string accountId, string templateId, string documentId, DocumentFieldsInformation documentFieldsInformation=null)
 Deletes custom document fields from an existing template document. Deletes custom document fields from an existing template document. More...
 
async System.Threading.Tasks.Task< DocumentFieldsInformationDeleteDocumentFieldsAsync (string accountId, string templateId, string documentId, DocumentFieldsInformation documentFieldsInformation=null)
 Deletes custom document fields from an existing template document. Deletes custom document fields from an existing template document. More...
 
async System.Threading.Tasks.Task< ApiResponse< DocumentFieldsInformation > > DeleteDocumentFieldsAsyncWithHttpInfo (string accountId, string templateId, string documentId, DocumentFieldsInformation documentFieldsInformation=null)
 Deletes custom document fields from an existing template document. Deletes custom document fields from an existing template document. More...
 
void DeleteDocumentPage (string accountId, string templateId, string documentId, string pageNumber, PageRequest pageRequest=null)
 Deletes a page from a document in an template. Deletes a page from a document in a template based on the page number. More...
 
ApiResponse< Object > DeleteDocumentPageWithHttpInfo (string accountId, string templateId, string documentId, string pageNumber, PageRequest pageRequest=null)
 Deletes a page from a document in an template. Deletes a page from a document in a template based on the page number. More...
 
async System.Threading.Tasks.Task DeleteDocumentPageAsync (string accountId, string templateId, string documentId, string pageNumber, PageRequest pageRequest=null)
 Deletes a page from a document in an template. Deletes a page from a document in a template based on the page number. More...
 
async System.Threading.Tasks.Task< ApiResponse< Object > > DeleteDocumentPageAsyncWithHttpInfo (string accountId, string templateId, string documentId, string pageNumber, PageRequest pageRequest=null)
 Deletes a page from a document in an template. Deletes a page from a document in a template based on the page number. More...
 
TemplateDocumentsResult DeleteDocuments (string accountId, string templateId, EnvelopeDefinition envelopeDefinition=null)
 Deletes documents from a template. Deletes one or more documents from an existing template. More...
 
ApiResponse< TemplateDocumentsResultDeleteDocumentsWithHttpInfo (string accountId, string templateId, EnvelopeDefinition envelopeDefinition=null)
 Deletes documents from a template. Deletes one or more documents from an existing template. More...
 
async System.Threading.Tasks.Task< TemplateDocumentsResultDeleteDocumentsAsync (string accountId, string templateId, EnvelopeDefinition envelopeDefinition=null)
 Deletes documents from a template. Deletes one or more documents from an existing template. More...
 
async System.Threading.Tasks.Task< ApiResponse< TemplateDocumentsResult > > DeleteDocumentsAsyncWithHttpInfo (string accountId, string templateId, EnvelopeDefinition envelopeDefinition=null)
 Deletes documents from a template. Deletes one or more documents from an existing template. More...
 
GroupInformation DeleteGroupShare (string accountId, string templateId, string templatePart, GroupInformation groupInformation=null)
 Removes a member group&#39;s sharing permissions for a template. Removes a member group&#39;s sharing permissions for a specified template. More...
 
ApiResponse< GroupInformationDeleteGroupShareWithHttpInfo (string accountId, string templateId, string templatePart, GroupInformation groupInformation=null)
 Removes a member group&#39;s sharing permissions for a template. Removes a member group&#39;s sharing permissions for a specified template. More...
 
async System.Threading.Tasks.Task< GroupInformationDeleteGroupShareAsync (string accountId, string templateId, string templatePart, GroupInformation groupInformation=null)
 Removes a member group&#39;s sharing permissions for a template. Removes a member group&#39;s sharing permissions for a specified template. More...
 
async System.Threading.Tasks.Task< ApiResponse< GroupInformation > > DeleteGroupShareAsyncWithHttpInfo (string accountId, string templateId, string templatePart, GroupInformation groupInformation=null)
 Removes a member group&#39;s sharing permissions for a template. Removes a member group&#39;s sharing permissions for a specified template. More...
 
LockInformation DeleteLock (string accountId, string templateId, LockRequest lockRequest=null)
 Deletes a template lock. Deletes the lock from the specified template. The &#x60;X-DocuSign-Edit&#x60; header must be included in the request. More...
 
ApiResponse< LockInformationDeleteLockWithHttpInfo (string accountId, string templateId, LockRequest lockRequest=null)
 Deletes a template lock. Deletes the lock from the specified template. The &#x60;X-DocuSign-Edit&#x60; header must be included in the request. More...
 
async System.Threading.Tasks.Task< LockInformationDeleteLockAsync (string accountId, string templateId, LockRequest lockRequest=null)
 Deletes a template lock. Deletes the lock from the specified template. The &#x60;X-DocuSign-Edit&#x60; header must be included in the request. More...
 
async System.Threading.Tasks.Task< ApiResponse< LockInformation > > DeleteLockAsyncWithHttpInfo (string accountId, string templateId, LockRequest lockRequest=null)
 Deletes a template lock. Deletes the lock from the specified template. The &#x60;X-DocuSign-Edit&#x60; header must be included in the request. More...
 
Recipients DeleteRecipient (string accountId, string templateId, string recipientId, TemplateRecipients templateRecipients=null)
 Deletes the specified recipient file from a template. Deletes the specified recipient file from the specified template. More...
 
ApiResponse< RecipientsDeleteRecipientWithHttpInfo (string accountId, string templateId, string recipientId, TemplateRecipients templateRecipients=null)
 Deletes the specified recipient file from a template. Deletes the specified recipient file from the specified template. More...
 
async System.Threading.Tasks.Task< RecipientsDeleteRecipientAsync (string accountId, string templateId, string recipientId, TemplateRecipients templateRecipients=null)
 Deletes the specified recipient file from a template. Deletes the specified recipient file from the specified template. More...
 
async System.Threading.Tasks.Task< ApiResponse< Recipients > > DeleteRecipientAsyncWithHttpInfo (string accountId, string templateId, string recipientId, TemplateRecipients templateRecipients=null)
 Deletes the specified recipient file from a template. Deletes the specified recipient file from the specified template. More...
 
Recipients DeleteRecipients (string accountId, string templateId, TemplateRecipients templateRecipients=null)
 Deletes recipients from a template. Deletes one or more recipients from a template. Recipients to be deleted are listed in the request, with the &#x60;recipientId&#x60; being used as the key for deleting recipients. More...
 
ApiResponse< RecipientsDeleteRecipientsWithHttpInfo (string accountId, string templateId, TemplateRecipients templateRecipients=null)
 Deletes recipients from a template. Deletes one or more recipients from a template. Recipients to be deleted are listed in the request, with the &#x60;recipientId&#x60; being used as the key for deleting recipients. More...
 
async System.Threading.Tasks.Task< RecipientsDeleteRecipientsAsync (string accountId, string templateId, TemplateRecipients templateRecipients=null)
 Deletes recipients from a template. Deletes one or more recipients from a template. Recipients to be deleted are listed in the request, with the &#x60;recipientId&#x60; being used as the key for deleting recipients. More...
 
async System.Threading.Tasks.Task< ApiResponse< Recipients > > DeleteRecipientsAsyncWithHttpInfo (string accountId, string templateId, TemplateRecipients templateRecipients=null)
 Deletes recipients from a template. Deletes one or more recipients from a template. Recipients to be deleted are listed in the request, with the &#x60;recipientId&#x60; being used as the key for deleting recipients. More...
 
Tabs DeleteTabs (string accountId, string templateId, string recipientId, TemplateTabs templateTabs=null)
 Deletes the tabs associated with a recipient in a template. Deletes one or more tabs associated with a recipient in a template. More...
 
ApiResponse< TabsDeleteTabsWithHttpInfo (string accountId, string templateId, string recipientId, TemplateTabs templateTabs=null)
 Deletes the tabs associated with a recipient in a template. Deletes one or more tabs associated with a recipient in a template. More...
 
async System.Threading.Tasks.Task< TabsDeleteTabsAsync (string accountId, string templateId, string recipientId, TemplateTabs templateTabs=null)
 Deletes the tabs associated with a recipient in a template. Deletes one or more tabs associated with a recipient in a template. More...
 
async System.Threading.Tasks.Task< ApiResponse< Tabs > > DeleteTabsAsyncWithHttpInfo (string accountId, string templateId, string recipientId, TemplateTabs templateTabs=null)
 Deletes the tabs associated with a recipient in a template. Deletes one or more tabs associated with a recipient in a template. More...
 
Tabs DeleteTemplateDocumentTabs (string accountId, string templateId, string documentId, TemplateTabs templateTabs=null)
 Deletes tabs from an envelope document Deletes tabs from the document specified by &#x60;documentId&#x60; in the template specified by &#x60;templateId&#x60;. More...
 
ApiResponse< TabsDeleteTemplateDocumentTabsWithHttpInfo (string accountId, string templateId, string documentId, TemplateTabs templateTabs=null)
 Deletes tabs from an envelope document Deletes tabs from the document specified by &#x60;documentId&#x60; in the template specified by &#x60;templateId&#x60;. More...
 
async System.Threading.Tasks.Task< TabsDeleteTemplateDocumentTabsAsync (string accountId, string templateId, string documentId, TemplateTabs templateTabs=null)
 Deletes tabs from an envelope document Deletes tabs from the document specified by &#x60;documentId&#x60; in the template specified by &#x60;templateId&#x60;. More...
 
async System.Threading.Tasks.Task< ApiResponse< Tabs > > DeleteTemplateDocumentTabsAsyncWithHttpInfo (string accountId, string templateId, string documentId, TemplateTabs templateTabs=null)
 Deletes tabs from an envelope document Deletes tabs from the document specified by &#x60;documentId&#x60; in the template specified by &#x60;templateId&#x60;. More...
 
EnvelopeTemplate Get (string accountId, string templateId, TemplatesApi.GetOptions options=null)
 Gets a list of templates for a specified account. Retrieves the definition of the specified template. More...
 
ApiResponse< EnvelopeTemplateGetWithHttpInfo (string accountId, string templateId, TemplatesApi.GetOptions options=null)
 Gets a list of templates for a specified account. Retrieves the definition of the specified template. More...
 
async System.Threading.Tasks.Task< EnvelopeTemplateGetAsync (string accountId, string templateId, TemplatesApi.GetOptions options=null)
 Gets a list of templates for a specified account. Retrieves the definition of the specified template. More...
 
async System.Threading.Tasks.Task< ApiResponse< EnvelopeTemplate > > GetAsyncWithHttpInfo (string accountId, string templateId, TemplatesApi.GetOptions options=null)
 Gets a list of templates for a specified account. Retrieves the definition of the specified template. More...
 
System.IO.Stream GetDocument (string accountId, string templateId, string documentId, TemplatesApi.GetDocumentOptions options=null)
 Gets PDF documents from a template. Retrieves one or more PDF documents from the specified template. You can specify the ID of the document to retrieve or can specify &#x60;combined&#x60; to retrieve all documents in the template as one pdf. More...
 
ApiResponse< System.IO.Stream > GetDocumentWithHttpInfo (string accountId, string templateId, string documentId, TemplatesApi.GetDocumentOptions options=null)
 Gets PDF documents from a template. Retrieves one or more PDF documents from the specified template. You can specify the ID of the document to retrieve or can specify &#x60;combined&#x60; to retrieve all documents in the template as one pdf. More...
 
async System.Threading.Tasks.Task< System.IO.Stream > GetDocumentAsync (string accountId, string templateId, string documentId, TemplatesApi.GetDocumentOptions options=null)
 Gets PDF documents from a template. Retrieves one or more PDF documents from the specified template. You can specify the ID of the document to retrieve or can specify &#x60;combined&#x60; to retrieve all documents in the template as one pdf. More...
 
async System.Threading.Tasks.Task< ApiResponse< System.IO.Stream > > GetDocumentAsyncWithHttpInfo (string accountId, string templateId, string documentId, TemplatesApi.GetDocumentOptions options=null)
 Gets PDF documents from a template. Retrieves one or more PDF documents from the specified template. You can specify the ID of the document to retrieve or can specify &#x60;combined&#x60; to retrieve all documents in the template as one pdf. More...
 
System.IO.Stream GetDocumentPageImage (string accountId, string templateId, string documentId, string pageNumber, TemplatesApi.GetDocumentPageImageOptions options=null)
 Gets a page image from a template for display. Retrieves a page image for display from the specified template. More...
 
ApiResponse< System.IO.Stream > GetDocumentPageImageWithHttpInfo (string accountId, string templateId, string documentId, string pageNumber, TemplatesApi.GetDocumentPageImageOptions options=null)
 Gets a page image from a template for display. Retrieves a page image for display from the specified template. More...
 
async System.Threading.Tasks.Task< System.IO.Stream > GetDocumentPageImageAsync (string accountId, string templateId, string documentId, string pageNumber, TemplatesApi.GetDocumentPageImageOptions options=null)
 Gets a page image from a template for display. Retrieves a page image for display from the specified template. More...
 
async System.Threading.Tasks.Task< ApiResponse< System.IO.Stream > > GetDocumentPageImageAsyncWithHttpInfo (string accountId, string templateId, string documentId, string pageNumber, TemplatesApi.GetDocumentPageImageOptions options=null)
 Gets a page image from a template for display. Retrieves a page image for display from the specified template. More...
 
Tabs GetDocumentTabs (string accountId, string templateId, string documentId, TemplatesApi.GetDocumentTabsOptions options=null)
 Returns tabs on the document. Returns the tabs on the document specified by &#x60;documentId&#x60; in the template specified by &#x60;templateId&#x60;. More...
 
ApiResponse< TabsGetDocumentTabsWithHttpInfo (string accountId, string templateId, string documentId, TemplatesApi.GetDocumentTabsOptions options=null)
 Returns tabs on the document. Returns the tabs on the document specified by &#x60;documentId&#x60; in the template specified by &#x60;templateId&#x60;. More...
 
async System.Threading.Tasks.Task< TabsGetDocumentTabsAsync (string accountId, string templateId, string documentId, TemplatesApi.GetDocumentTabsOptions options=null)
 Returns tabs on the document. Returns the tabs on the document specified by &#x60;documentId&#x60; in the template specified by &#x60;templateId&#x60;. More...
 
async System.Threading.Tasks.Task< ApiResponse< Tabs > > GetDocumentTabsAsyncWithHttpInfo (string accountId, string templateId, string documentId, TemplatesApi.GetDocumentTabsOptions options=null)
 Returns tabs on the document. Returns the tabs on the document specified by &#x60;documentId&#x60; in the template specified by &#x60;templateId&#x60;. More...
 
LockInformation GetLock (string accountId, string templateId)
 Gets template lock information. Retrieves general information about the template lock. If the call is made by the user who has the lock and the request has the same integrator key as original, then the &#x60;X-DocuSign-Edit&#x60; header field and additional lock information is included in the response. This allows users to recover a lost editing session token and the &#x60;X-DocuSign-Edit&#x60; header. More...
 
ApiResponse< LockInformationGetLockWithHttpInfo (string accountId, string templateId)
 Gets template lock information. Retrieves general information about the template lock. If the call is made by the user who has the lock and the request has the same integrator key as original, then the &#x60;X-DocuSign-Edit&#x60; header field and additional lock information is included in the response. This allows users to recover a lost editing session token and the &#x60;X-DocuSign-Edit&#x60; header. More...
 
async System.Threading.Tasks.Task< LockInformationGetLockAsync (string accountId, string templateId)
 Gets template lock information. Retrieves general information about the template lock. If the call is made by the user who has the lock and the request has the same integrator key as original, then the &#x60;X-DocuSign-Edit&#x60; header field and additional lock information is included in the response. This allows users to recover a lost editing session token and the &#x60;X-DocuSign-Edit&#x60; header. More...
 
async System.Threading.Tasks.Task< ApiResponse< LockInformation > > GetLockAsyncWithHttpInfo (string accountId, string templateId)
 Gets template lock information. Retrieves general information about the template lock. If the call is made by the user who has the lock and the request has the same integrator key as original, then the &#x60;X-DocuSign-Edit&#x60; header field and additional lock information is included in the response. This allows users to recover a lost editing session token and the &#x60;X-DocuSign-Edit&#x60; header. More...
 
Notification GetNotificationSettings (string accountId, string templateId)
 Gets template notification information. Retrieves the envelope notification, reminders and expirations, information for an existing template. More...
 
ApiResponse< NotificationGetNotificationSettingsWithHttpInfo (string accountId, string templateId)
 Gets template notification information. Retrieves the envelope notification, reminders and expirations, information for an existing template. More...
 
async System.Threading.Tasks.Task< NotificationGetNotificationSettingsAsync (string accountId, string templateId)
 Gets template notification information. Retrieves the envelope notification, reminders and expirations, information for an existing template. More...
 
async System.Threading.Tasks.Task< ApiResponse< Notification > > GetNotificationSettingsAsyncWithHttpInfo (string accountId, string templateId)
 Gets template notification information. Retrieves the envelope notification, reminders and expirations, information for an existing template. More...
 
Tabs GetPageTabs (string accountId, string templateId, string documentId, string pageNumber)
 Returns tabs on the specified page. Returns the tabs from the page specified by &#x60;pageNumber&#x60; of the document specified by &#x60;documentId&#x60; in the template specified by &#x60;templateId&#x60;. More...
 
ApiResponse< TabsGetPageTabsWithHttpInfo (string accountId, string templateId, string documentId, string pageNumber)
 Returns tabs on the specified page. Returns the tabs from the page specified by &#x60;pageNumber&#x60; of the document specified by &#x60;documentId&#x60; in the template specified by &#x60;templateId&#x60;. More...
 
async System.Threading.Tasks.Task< TabsGetPageTabsAsync (string accountId, string templateId, string documentId, string pageNumber)
 Returns tabs on the specified page. Returns the tabs from the page specified by &#x60;pageNumber&#x60; of the document specified by &#x60;documentId&#x60; in the template specified by &#x60;templateId&#x60;. More...
 
async System.Threading.Tasks.Task< ApiResponse< Tabs > > GetPageTabsAsyncWithHttpInfo (string accountId, string templateId, string documentId, string pageNumber)
 Returns tabs on the specified page. Returns the tabs from the page specified by &#x60;pageNumber&#x60; of the document specified by &#x60;documentId&#x60; in the template specified by &#x60;templateId&#x60;. More...
 
PageImages GetPages (string accountId, string templateId, string documentId, TemplatesApi.GetPagesOptions options=null)
 Returns document page image(s) based on input. Returns images of the pages in a template document for display based on the parameters that you specify. More...
 
ApiResponse< PageImagesGetPagesWithHttpInfo (string accountId, string templateId, string documentId, TemplatesApi.GetPagesOptions options=null)
 Returns document page image(s) based on input. Returns images of the pages in a template document for display based on the parameters that you specify. More...
 
async System.Threading.Tasks.Task< PageImagesGetPagesAsync (string accountId, string templateId, string documentId, TemplatesApi.GetPagesOptions options=null)
 Returns document page image(s) based on input. Returns images of the pages in a template document for display based on the parameters that you specify. More...
 
async System.Threading.Tasks.Task< ApiResponse< PageImages > > GetPagesAsyncWithHttpInfo (string accountId, string templateId, string documentId, TemplatesApi.GetPagesOptions options=null)
 Returns document page image(s) based on input. Returns images of the pages in a template document for display based on the parameters that you specify. More...
 
DocumentHtmlDefinitionOriginals GetTemplateDocumentHtmlDefinitions (string accountId, string templateId, string documentId)
 Get the Original HTML Definition used to generate the Responsive HTML for a given document in a template. More...
 
ApiResponse< DocumentHtmlDefinitionOriginalsGetTemplateDocumentHtmlDefinitionsWithHttpInfo (string accountId, string templateId, string documentId)
 Get the Original HTML Definition used to generate the Responsive HTML for a given document in a template. More...
 
async System.Threading.Tasks.Task< DocumentHtmlDefinitionOriginalsGetTemplateDocumentHtmlDefinitionsAsync (string accountId, string templateId, string documentId)
 Get the Original HTML Definition used to generate the Responsive HTML for a given document in a template. More...
 
async System.Threading.Tasks.Task< ApiResponse< DocumentHtmlDefinitionOriginals > > GetTemplateDocumentHtmlDefinitionsAsyncWithHttpInfo (string accountId, string templateId, string documentId)
 Get the Original HTML Definition used to generate the Responsive HTML for a given document in a template. More...
 
DocumentHtmlDefinitionOriginals GetTemplateHtmlDefinitions (string accountId, string templateId)
 Get the Original HTML Definition used to generate the Responsive HTML for the template. More...
 
ApiResponse< DocumentHtmlDefinitionOriginalsGetTemplateHtmlDefinitionsWithHttpInfo (string accountId, string templateId)
 Get the Original HTML Definition used to generate the Responsive HTML for the template. More...
 
async System.Threading.Tasks.Task< DocumentHtmlDefinitionOriginalsGetTemplateHtmlDefinitionsAsync (string accountId, string templateId)
 Get the Original HTML Definition used to generate the Responsive HTML for the template. More...
 
async System.Threading.Tasks.Task< ApiResponse< DocumentHtmlDefinitionOriginals > > GetTemplateHtmlDefinitionsAsyncWithHttpInfo (string accountId, string templateId)
 Get the Original HTML Definition used to generate the Responsive HTML for the template. More...
 
CustomFields ListCustomFields (string accountId, string templateId)
 Gets the custom document fields from a template. Retrieves the custom document field information from an existing template. More...
 
ApiResponse< CustomFieldsListCustomFieldsWithHttpInfo (string accountId, string templateId)
 Gets the custom document fields from a template. Retrieves the custom document field information from an existing template. More...
 
async System.Threading.Tasks.Task< CustomFieldsListCustomFieldsAsync (string accountId, string templateId)
 Gets the custom document fields from a template. Retrieves the custom document field information from an existing template. More...
 
async System.Threading.Tasks.Task< ApiResponse< CustomFields > > ListCustomFieldsAsyncWithHttpInfo (string accountId, string templateId)
 Gets the custom document fields from a template. Retrieves the custom document field information from an existing template. More...
 
DocumentFieldsInformation ListDocumentFields (string accountId, string templateId, string documentId)
 Gets the custom document fields for a an existing template document. Retrieves the custom document fields for an existing template document. More...
 
ApiResponse< DocumentFieldsInformationListDocumentFieldsWithHttpInfo (string accountId, string templateId, string documentId)
 Gets the custom document fields for a an existing template document. Retrieves the custom document fields for an existing template document. More...
 
async System.Threading.Tasks.Task< DocumentFieldsInformationListDocumentFieldsAsync (string accountId, string templateId, string documentId)
 Gets the custom document fields for a an existing template document. Retrieves the custom document fields for an existing template document. More...
 
async System.Threading.Tasks.Task< ApiResponse< DocumentFieldsInformation > > ListDocumentFieldsAsyncWithHttpInfo (string accountId, string templateId, string documentId)
 Gets the custom document fields for a an existing template document. Retrieves the custom document fields for an existing template document. More...
 
TemplateDocumentsResult ListDocuments (string accountId, string templateId, TemplatesApi.ListDocumentsOptions options=null)
 Gets a list of documents associated with a template. Retrieves a list of documents associated with the specified template. More...
 
ApiResponse< TemplateDocumentsResultListDocumentsWithHttpInfo (string accountId, string templateId, TemplatesApi.ListDocumentsOptions options=null)
 Gets a list of documents associated with a template. Retrieves a list of documents associated with the specified template. More...
 
async System.Threading.Tasks.Task< TemplateDocumentsResultListDocumentsAsync (string accountId, string templateId, TemplatesApi.ListDocumentsOptions options=null)
 Gets a list of documents associated with a template. Retrieves a list of documents associated with the specified template. More...
 
async System.Threading.Tasks.Task< ApiResponse< TemplateDocumentsResult > > ListDocumentsAsyncWithHttpInfo (string accountId, string templateId, TemplatesApi.ListDocumentsOptions options=null)
 Gets a list of documents associated with a template. Retrieves a list of documents associated with the specified template. More...
 
Recipients ListRecipients (string accountId, string templateId, TemplatesApi.ListRecipientsOptions options=null)
 Gets recipient information from a template. Retrieves the information for all recipients in the specified template. More...
 
ApiResponse< RecipientsListRecipientsWithHttpInfo (string accountId, string templateId, TemplatesApi.ListRecipientsOptions options=null)
 Gets recipient information from a template. Retrieves the information for all recipients in the specified template. More...
 
async System.Threading.Tasks.Task< RecipientsListRecipientsAsync (string accountId, string templateId, TemplatesApi.ListRecipientsOptions options=null)
 Gets recipient information from a template. Retrieves the information for all recipients in the specified template. More...
 
async System.Threading.Tasks.Task< ApiResponse< Recipients > > ListRecipientsAsyncWithHttpInfo (string accountId, string templateId, TemplatesApi.ListRecipientsOptions options=null)
 Gets recipient information from a template. Retrieves the information for all recipients in the specified template. More...
 
Tabs ListTabs (string accountId, string templateId, string recipientId, TemplatesApi.ListTabsOptions options=null)
 Gets the tabs information for a signer or sign-in-person recipient in a template. Gets the tabs information for a signer or sign-in-person recipient in a template. More...
 
ApiResponse< TabsListTabsWithHttpInfo (string accountId, string templateId, string recipientId, TemplatesApi.ListTabsOptions options=null)
 Gets the tabs information for a signer or sign-in-person recipient in a template. Gets the tabs information for a signer or sign-in-person recipient in a template. More...
 
async System.Threading.Tasks.Task< TabsListTabsAsync (string accountId, string templateId, string recipientId, TemplatesApi.ListTabsOptions options=null)
 Gets the tabs information for a signer or sign-in-person recipient in a template. Gets the tabs information for a signer or sign-in-person recipient in a template. More...
 
async System.Threading.Tasks.Task< ApiResponse< Tabs > > ListTabsAsyncWithHttpInfo (string accountId, string templateId, string recipientId, TemplatesApi.ListTabsOptions options=null)
 Gets the tabs information for a signer or sign-in-person recipient in a template. Gets the tabs information for a signer or sign-in-person recipient in a template. More...
 
EnvelopeTemplateResults ListTemplates (string accountId, TemplatesApi.ListTemplatesOptions options=null)
 Gets the definition of a template. Retrieves the list of templates for the specified account. The request can be limited to a specific folder. More...
 
ApiResponse< EnvelopeTemplateResultsListTemplatesWithHttpInfo (string accountId, TemplatesApi.ListTemplatesOptions options=null)
 Gets the definition of a template. Retrieves the list of templates for the specified account. The request can be limited to a specific folder. More...
 
async System.Threading.Tasks.Task< EnvelopeTemplateResultsListTemplatesAsync (string accountId, TemplatesApi.ListTemplatesOptions options=null)
 Gets the definition of a template. Retrieves the list of templates for the specified account. The request can be limited to a specific folder. More...
 
async System.Threading.Tasks.Task< ApiResponse< EnvelopeTemplateResults > > ListTemplatesAsyncWithHttpInfo (string accountId, TemplatesApi.ListTemplatesOptions options=null)
 Gets the definition of a template. Retrieves the list of templates for the specified account. The request can be limited to a specific folder. More...
 
void RotateDocumentPage (string accountId, string templateId, string documentId, string pageNumber, PageRequest pageRequest=null)
 Rotates page image from a template for display. Rotates page image from a template for display. The page image can be rotated to the left or right. More...
 
ApiResponse< Object > RotateDocumentPageWithHttpInfo (string accountId, string templateId, string documentId, string pageNumber, PageRequest pageRequest=null)
 Rotates page image from a template for display. Rotates page image from a template for display. The page image can be rotated to the left or right. More...
 
async System.Threading.Tasks.Task RotateDocumentPageAsync (string accountId, string templateId, string documentId, string pageNumber, PageRequest pageRequest=null)
 Rotates page image from a template for display. Rotates page image from a template for display. The page image can be rotated to the left or right. More...
 
async System.Threading.Tasks.Task< ApiResponse< Object > > RotateDocumentPageAsyncWithHttpInfo (string accountId, string templateId, string documentId, string pageNumber, PageRequest pageRequest=null)
 Rotates page image from a template for display. Rotates page image from a template for display. The page image can be rotated to the left or right. More...
 
TemplateUpdateSummary Update (string accountId, string templateId, EnvelopeTemplate envelopeTemplate=null)
 Updates an existing template. Updates an existing template. More...
 
ApiResponse< TemplateUpdateSummaryUpdateWithHttpInfo (string accountId, string templateId, EnvelopeTemplate envelopeTemplate=null)
 Updates an existing template. Updates an existing template. More...
 
async System.Threading.Tasks.Task< TemplateUpdateSummaryUpdateAsync (string accountId, string templateId, EnvelopeTemplate envelopeTemplate=null)
 Updates an existing template. Updates an existing template. More...
 
async System.Threading.Tasks.Task< ApiResponse< TemplateUpdateSummary > > UpdateAsyncWithHttpInfo (string accountId, string templateId, EnvelopeTemplate envelopeTemplate=null)
 Updates an existing template. Updates an existing template. More...
 
CustomFields UpdateCustomFields (string accountId, string templateId, TemplateCustomFields templateCustomFields=null)
 Updates envelope custom fields in a template. Updates the custom fields in a template. Each custom field used in a template must have a unique name. More...
 
ApiResponse< CustomFieldsUpdateCustomFieldsWithHttpInfo (string accountId, string templateId, TemplateCustomFields templateCustomFields=null)
 Updates envelope custom fields in a template. Updates the custom fields in a template. Each custom field used in a template must have a unique name. More...
 
async System.Threading.Tasks.Task< CustomFieldsUpdateCustomFieldsAsync (string accountId, string templateId, TemplateCustomFields templateCustomFields=null)
 Updates envelope custom fields in a template. Updates the custom fields in a template. Each custom field used in a template must have a unique name. More...
 
async System.Threading.Tasks.Task< ApiResponse< CustomFields > > UpdateCustomFieldsAsyncWithHttpInfo (string accountId, string templateId, TemplateCustomFields templateCustomFields=null)
 Updates envelope custom fields in a template. Updates the custom fields in a template. Each custom field used in a template must have a unique name. More...
 
EnvelopeDocument UpdateDocument (string accountId, string templateId, string documentId, EnvelopeDefinition envelopeDefinition=null, TemplatesApi.UpdateDocumentOptions options=null)
 Adds a document to a template document. Adds the specified document to an existing template document. More...
 
ApiResponse< EnvelopeDocumentUpdateDocumentWithHttpInfo (string accountId, string templateId, string documentId, EnvelopeDefinition envelopeDefinition=null, TemplatesApi.UpdateDocumentOptions options=null)
 Adds a document to a template document. Adds the specified document to an existing template document. More...
 
async System.Threading.Tasks.Task< EnvelopeDocumentUpdateDocumentAsync (string accountId, string templateId, string documentId, EnvelopeDefinition envelopeDefinition=null, TemplatesApi.UpdateDocumentOptions options=null)
 Adds a document to a template document. Adds the specified document to an existing template document. More...
 
async System.Threading.Tasks.Task< ApiResponse< EnvelopeDocument > > UpdateDocumentAsyncWithHttpInfo (string accountId, string templateId, string documentId, EnvelopeDefinition envelopeDefinition=null, TemplatesApi.UpdateDocumentOptions options=null)
 Adds a document to a template document. Adds the specified document to an existing template document. More...
 
DocumentFieldsInformation UpdateDocumentFields (string accountId, string templateId, string documentId, DocumentFieldsInformation documentFieldsInformation=null)
 Updates existing custom document fields in an existing template document. Updates existing custom document fields in an existing template document. More...
 
ApiResponse< DocumentFieldsInformationUpdateDocumentFieldsWithHttpInfo (string accountId, string templateId, string documentId, DocumentFieldsInformation documentFieldsInformation=null)
 Updates existing custom document fields in an existing template document. Updates existing custom document fields in an existing template document. More...
 
async System.Threading.Tasks.Task< DocumentFieldsInformationUpdateDocumentFieldsAsync (string accountId, string templateId, string documentId, DocumentFieldsInformation documentFieldsInformation=null)
 Updates existing custom document fields in an existing template document. Updates existing custom document fields in an existing template document. More...
 
async System.Threading.Tasks.Task< ApiResponse< DocumentFieldsInformation > > UpdateDocumentFieldsAsyncWithHttpInfo (string accountId, string templateId, string documentId, DocumentFieldsInformation documentFieldsInformation=null)
 Updates existing custom document fields in an existing template document. Updates existing custom document fields in an existing template document. More...
 
TemplateDocumentsResult UpdateDocuments (string accountId, string templateId, EnvelopeDefinition envelopeDefinition=null)
 Adds documents to a template document. Adds one or more documents to an existing template document. More...
 
ApiResponse< TemplateDocumentsResultUpdateDocumentsWithHttpInfo (string accountId, string templateId, EnvelopeDefinition envelopeDefinition=null)
 Adds documents to a template document. Adds one or more documents to an existing template document. More...
 
async System.Threading.Tasks.Task< TemplateDocumentsResultUpdateDocumentsAsync (string accountId, string templateId, EnvelopeDefinition envelopeDefinition=null)
 Adds documents to a template document. Adds one or more documents to an existing template document. More...
 
async System.Threading.Tasks.Task< ApiResponse< TemplateDocumentsResult > > UpdateDocumentsAsyncWithHttpInfo (string accountId, string templateId, EnvelopeDefinition envelopeDefinition=null)
 Adds documents to a template document. Adds one or more documents to an existing template document. More...
 
GroupInformation UpdateGroupShare (string accountId, string templateId, string templatePart, GroupInformation groupInformation=null)
 Shares a template with a group Shares a template with the specified members group. More...
 
ApiResponse< GroupInformationUpdateGroupShareWithHttpInfo (string accountId, string templateId, string templatePart, GroupInformation groupInformation=null)
 Shares a template with a group Shares a template with the specified members group. More...
 
async System.Threading.Tasks.Task< GroupInformationUpdateGroupShareAsync (string accountId, string templateId, string templatePart, GroupInformation groupInformation=null)
 Shares a template with a group Shares a template with the specified members group. More...
 
async System.Threading.Tasks.Task< ApiResponse< GroupInformation > > UpdateGroupShareAsyncWithHttpInfo (string accountId, string templateId, string templatePart, GroupInformation groupInformation=null)
 Shares a template with a group Shares a template with the specified members group. More...
 
LockInformation UpdateLock (string accountId, string templateId, LockRequest lockRequest=null)
 Updates a template lock. Updates the lock duration time or update the &#x60;lockedByApp&#x60; property information for the specified template. The user and integrator key must match the user specified by the &#x60;lockByUser&#x60; property and integrator key information and the &#x60;X-DocuSign-Edit&#x60; header must be included or an error will be generated. More...
 
ApiResponse< LockInformationUpdateLockWithHttpInfo (string accountId, string templateId, LockRequest lockRequest=null)
 Updates a template lock. Updates the lock duration time or update the &#x60;lockedByApp&#x60; property information for the specified template. The user and integrator key must match the user specified by the &#x60;lockByUser&#x60; property and integrator key information and the &#x60;X-DocuSign-Edit&#x60; header must be included or an error will be generated. More...
 
async System.Threading.Tasks.Task< LockInformationUpdateLockAsync (string accountId, string templateId, LockRequest lockRequest=null)
 Updates a template lock. Updates the lock duration time or update the &#x60;lockedByApp&#x60; property information for the specified template. The user and integrator key must match the user specified by the &#x60;lockByUser&#x60; property and integrator key information and the &#x60;X-DocuSign-Edit&#x60; header must be included or an error will be generated. More...
 
async System.Threading.Tasks.Task< ApiResponse< LockInformation > > UpdateLockAsyncWithHttpInfo (string accountId, string templateId, LockRequest lockRequest=null)
 Updates a template lock. Updates the lock duration time or update the &#x60;lockedByApp&#x60; property information for the specified template. The user and integrator key must match the user specified by the &#x60;lockByUser&#x60; property and integrator key information and the &#x60;X-DocuSign-Edit&#x60; header must be included or an error will be generated. More...
 
Notification UpdateNotificationSettings (string accountId, string templateId, TemplateNotificationRequest templateNotificationRequest=null)
 Updates the notification structure for an existing template. Updates the notification structure for an existing template. Use this endpoint to set reminder and expiration notifications. More...
 
ApiResponse< NotificationUpdateNotificationSettingsWithHttpInfo (string accountId, string templateId, TemplateNotificationRequest templateNotificationRequest=null)
 Updates the notification structure for an existing template. Updates the notification structure for an existing template. Use this endpoint to set reminder and expiration notifications. More...
 
async System.Threading.Tasks.Task< NotificationUpdateNotificationSettingsAsync (string accountId, string templateId, TemplateNotificationRequest templateNotificationRequest=null)
 Updates the notification structure for an existing template. Updates the notification structure for an existing template. Use this endpoint to set reminder and expiration notifications. More...
 
async System.Threading.Tasks.Task< ApiResponse< Notification > > UpdateNotificationSettingsAsyncWithHttpInfo (string accountId, string templateId, TemplateNotificationRequest templateNotificationRequest=null)
 Updates the notification structure for an existing template. Updates the notification structure for an existing template. Use this endpoint to set reminder and expiration notifications. More...
 
RecipientsUpdateSummary UpdateRecipients (string accountId, string templateId, TemplateRecipients templateRecipients=null, TemplatesApi.UpdateRecipientsOptions options=null)
 Updates recipients in a template. Updates recipients in a template. You can edit the following properties: &#x60;email&#x60;, &#x60;userName&#x60;, &#x60;routingOrder&#x60;, &#x60;faxNumber&#x60;, &#x60;deliveryMethod&#x60;, &#x60;accessCode&#x60;, and &#x60;requireIdLookup&#x60;. More...
 
ApiResponse< RecipientsUpdateSummaryUpdateRecipientsWithHttpInfo (string accountId, string templateId, TemplateRecipients templateRecipients=null, TemplatesApi.UpdateRecipientsOptions options=null)
 Updates recipients in a template. Updates recipients in a template. You can edit the following properties: &#x60;email&#x60;, &#x60;userName&#x60;, &#x60;routingOrder&#x60;, &#x60;faxNumber&#x60;, &#x60;deliveryMethod&#x60;, &#x60;accessCode&#x60;, and &#x60;requireIdLookup&#x60;. More...
 
async System.Threading.Tasks.Task< RecipientsUpdateSummaryUpdateRecipientsAsync (string accountId, string templateId, TemplateRecipients templateRecipients=null, TemplatesApi.UpdateRecipientsOptions options=null)
 Updates recipients in a template. Updates recipients in a template. You can edit the following properties: &#x60;email&#x60;, &#x60;userName&#x60;, &#x60;routingOrder&#x60;, &#x60;faxNumber&#x60;, &#x60;deliveryMethod&#x60;, &#x60;accessCode&#x60;, and &#x60;requireIdLookup&#x60;. More...
 
async System.Threading.Tasks.Task< ApiResponse< RecipientsUpdateSummary > > UpdateRecipientsAsyncWithHttpInfo (string accountId, string templateId, TemplateRecipients templateRecipients=null, TemplatesApi.UpdateRecipientsOptions options=null)
 Updates recipients in a template. Updates recipients in a template. You can edit the following properties: &#x60;email&#x60;, &#x60;userName&#x60;, &#x60;routingOrder&#x60;, &#x60;faxNumber&#x60;, &#x60;deliveryMethod&#x60;, &#x60;accessCode&#x60;, and &#x60;requireIdLookup&#x60;. More...
 
Tabs UpdateTabs (string accountId, string templateId, string recipientId, TemplateTabs templateTabs=null)
 Updates the tabs for a recipient. Updates one or more tabs for a recipient in a template. More...
 
ApiResponse< TabsUpdateTabsWithHttpInfo (string accountId, string templateId, string recipientId, TemplateTabs templateTabs=null)
 Updates the tabs for a recipient. Updates one or more tabs for a recipient in a template. More...
 
async System.Threading.Tasks.Task< TabsUpdateTabsAsync (string accountId, string templateId, string recipientId, TemplateTabs templateTabs=null)
 Updates the tabs for a recipient. Updates one or more tabs for a recipient in a template. More...
 
async System.Threading.Tasks.Task< ApiResponse< Tabs > > UpdateTabsAsyncWithHttpInfo (string accountId, string templateId, string recipientId, TemplateTabs templateTabs=null)
 Updates the tabs for a recipient. Updates one or more tabs for a recipient in a template. More...
 
Tabs UpdateTemplateDocumentTabs (string accountId, string templateId, string documentId, TemplateTabs templateTabs=null)
 Updates the tabs for a template Updates tabs in the document specified by &#x60;documentId&#x60; in the template specified by &#x60;templateId&#x60;. More...
 
ApiResponse< TabsUpdateTemplateDocumentTabsWithHttpInfo (string accountId, string templateId, string documentId, TemplateTabs templateTabs=null)
 Updates the tabs for a template Updates tabs in the document specified by &#x60;documentId&#x60; in the template specified by &#x60;templateId&#x60;. More...
 
async System.Threading.Tasks.Task< TabsUpdateTemplateDocumentTabsAsync (string accountId, string templateId, string documentId, TemplateTabs templateTabs=null)
 Updates the tabs for a template Updates tabs in the document specified by &#x60;documentId&#x60; in the template specified by &#x60;templateId&#x60;. More...
 
async System.Threading.Tasks.Task< ApiResponse< Tabs > > UpdateTemplateDocumentTabsAsyncWithHttpInfo (string accountId, string templateId, string documentId, TemplateTabs templateTabs=null)
 Updates the tabs for a template Updates tabs in the document specified by &#x60;documentId&#x60; in the template specified by &#x60;templateId&#x60;. More...
 
- Public Member Functions inherited from DocuSign.eSign.Api.ITemplatesApi
Recipients CreateRecipients (string accountId, string templateId, TemplateRecipients templateRecipients=null, TemplatesApi.CreateRecipientsOptions options=null)
 Adds tabs for a recipient. More...
 
ApiResponse< RecipientsCreateRecipientsWithHttpInfo (string accountId, string templateId, TemplateRecipients templateRecipients=null, TemplatesApi.CreateRecipientsOptions options=null)
 Adds tabs for a recipient. More...
 
EnvelopeTemplate Get (string accountId, string templateId, TemplatesApi.GetOptions options=null)
 Gets a list of templates for a specified account. More...
 
ApiResponse< EnvelopeTemplateGetWithHttpInfo (string accountId, string templateId, TemplatesApi.GetOptions options=null)
 Gets a list of templates for a specified account. More...
 
System.IO.Stream GetDocument (string accountId, string templateId, string documentId, TemplatesApi.GetDocumentOptions options=null)
 Gets PDF documents from a template. More...
 
ApiResponse< System.IO.Stream > GetDocumentWithHttpInfo (string accountId, string templateId, string documentId, TemplatesApi.GetDocumentOptions options=null)
 Gets PDF documents from a template. More...
 
System.IO.Stream GetDocumentPageImage (string accountId, string templateId, string documentId, string pageNumber, TemplatesApi.GetDocumentPageImageOptions options=null)
 Gets a page image from a template for display. More...
 
ApiResponse< System.IO.Stream > GetDocumentPageImageWithHttpInfo (string accountId, string templateId, string documentId, string pageNumber, TemplatesApi.GetDocumentPageImageOptions options=null)
 Gets a page image from a template for display. More...
 
Tabs GetDocumentTabs (string accountId, string templateId, string documentId, TemplatesApi.GetDocumentTabsOptions options=null)
 Returns tabs on the document. More...
 
ApiResponse< TabsGetDocumentTabsWithHttpInfo (string accountId, string templateId, string documentId, TemplatesApi.GetDocumentTabsOptions options=null)
 Returns tabs on the document. More...
 
PageImages GetPages (string accountId, string templateId, string documentId, TemplatesApi.GetPagesOptions options=null)
 Returns document page image(s) based on input. More...
 
ApiResponse< PageImagesGetPagesWithHttpInfo (string accountId, string templateId, string documentId, TemplatesApi.GetPagesOptions options=null)
 Returns document page image(s) based on input. More...
 
TemplateDocumentsResult ListDocuments (string accountId, string templateId, TemplatesApi.ListDocumentsOptions options=null)
 Gets a list of documents associated with a template. More...
 
ApiResponse< TemplateDocumentsResultListDocumentsWithHttpInfo (string accountId, string templateId, TemplatesApi.ListDocumentsOptions options=null)
 Gets a list of documents associated with a template. More...
 
Recipients ListRecipients (string accountId, string templateId, TemplatesApi.ListRecipientsOptions options=null)
 Gets recipient information from a template. More...
 
ApiResponse< RecipientsListRecipientsWithHttpInfo (string accountId, string templateId, TemplatesApi.ListRecipientsOptions options=null)
 Gets recipient information from a template. More...
 
Tabs ListTabs (string accountId, string templateId, string recipientId, TemplatesApi.ListTabsOptions options=null)
 Gets the tabs information for a signer or sign-in-person recipient in a template. More...
 
ApiResponse< TabsListTabsWithHttpInfo (string accountId, string templateId, string recipientId, TemplatesApi.ListTabsOptions options=null)
 Gets the tabs information for a signer or sign-in-person recipient in a template. More...
 
EnvelopeTemplateResults ListTemplates (string accountId, TemplatesApi.ListTemplatesOptions options=null)
 Gets the definition of a template. More...
 
ApiResponse< EnvelopeTemplateResultsListTemplatesWithHttpInfo (string accountId, TemplatesApi.ListTemplatesOptions options=null)
 Gets the definition of a template. More...
 
EnvelopeDocument UpdateDocument (string accountId, string templateId, string documentId, EnvelopeDefinition envelopeDefinition=null, TemplatesApi.UpdateDocumentOptions options=null)
 Adds a document to a template document. More...
 
ApiResponse< EnvelopeDocumentUpdateDocumentWithHttpInfo (string accountId, string templateId, string documentId, EnvelopeDefinition envelopeDefinition=null, TemplatesApi.UpdateDocumentOptions options=null)
 Adds a document to a template document. More...
 
RecipientsUpdateSummary UpdateRecipients (string accountId, string templateId, TemplateRecipients templateRecipients=null, TemplatesApi.UpdateRecipientsOptions options=null)
 Updates recipients in a template. More...
 
ApiResponse< RecipientsUpdateSummaryUpdateRecipientsWithHttpInfo (string accountId, string templateId, TemplateRecipients templateRecipients=null, TemplatesApi.UpdateRecipientsOptions options=null)
 Updates recipients in a template. More...
 
System.Threading.Tasks.Task< RecipientsCreateRecipientsAsync (string accountId, string templateId, TemplateRecipients templateRecipients=null, TemplatesApi.CreateRecipientsOptions options=null)
 Adds tabs for a recipient. More...
 
System.Threading.Tasks.Task< ApiResponse< Recipients > > CreateRecipientsAsyncWithHttpInfo (string accountId, string templateId, TemplateRecipients templateRecipients=null, TemplatesApi.CreateRecipientsOptions options=null)
 Adds tabs for a recipient. More...
 
System.Threading.Tasks.Task< EnvelopeTemplateGetAsync (string accountId, string templateId, TemplatesApi.GetOptions options=null)
 Gets a list of templates for a specified account. More...
 
System.Threading.Tasks.Task< ApiResponse< EnvelopeTemplate > > GetAsyncWithHttpInfo (string accountId, string templateId, TemplatesApi.GetOptions options=null)
 Gets a list of templates for a specified account. More...
 
System.Threading.Tasks.Task< System.IO.Stream > GetDocumentAsync (string accountId, string templateId, string documentId, TemplatesApi.GetDocumentOptions options=null)
 Gets PDF documents from a template. More...
 
System.Threading.Tasks.Task< ApiResponse< System.IO.Stream > > GetDocumentAsyncWithHttpInfo (string accountId, string templateId, string documentId, TemplatesApi.GetDocumentOptions options=null)
 Gets PDF documents from a template. More...
 
System.Threading.Tasks.Task< System.IO.Stream > GetDocumentPageImageAsync (string accountId, string templateId, string documentId, string pageNumber, TemplatesApi.GetDocumentPageImageOptions options=null)
 Gets a page image from a template for display. More...
 
System.Threading.Tasks.Task< ApiResponse< System.IO.Stream > > GetDocumentPageImageAsyncWithHttpInfo (string accountId, string templateId, string documentId, string pageNumber, TemplatesApi.GetDocumentPageImageOptions options=null)
 Gets a page image from a template for display. More...
 
System.Threading.Tasks.Task< TabsGetDocumentTabsAsync (string accountId, string templateId, string documentId, TemplatesApi.GetDocumentTabsOptions options=null)
 Returns tabs on the document. More...
 
System.Threading.Tasks.Task< ApiResponse< Tabs > > GetDocumentTabsAsyncWithHttpInfo (string accountId, string templateId, string documentId, TemplatesApi.GetDocumentTabsOptions options=null)
 Returns tabs on the document. More...
 
System.Threading.Tasks.Task< PageImagesGetPagesAsync (string accountId, string templateId, string documentId, TemplatesApi.GetPagesOptions options=null)
 Returns document page image(s) based on input. More...
 
System.Threading.Tasks.Task< ApiResponse< PageImages > > GetPagesAsyncWithHttpInfo (string accountId, string templateId, string documentId, TemplatesApi.GetPagesOptions options=null)
 Returns document page image(s) based on input. More...
 
System.Threading.Tasks.Task< TemplateDocumentsResultListDocumentsAsync (string accountId, string templateId, TemplatesApi.ListDocumentsOptions options=null)
 Gets a list of documents associated with a template. More...
 
System.Threading.Tasks.Task< ApiResponse< TemplateDocumentsResult > > ListDocumentsAsyncWithHttpInfo (string accountId, string templateId, TemplatesApi.ListDocumentsOptions options=null)
 Gets a list of documents associated with a template. More...
 
System.Threading.Tasks.Task< RecipientsListRecipientsAsync (string accountId, string templateId, TemplatesApi.ListRecipientsOptions options=null)
 Gets recipient information from a template. More...
 
System.Threading.Tasks.Task< ApiResponse< Recipients > > ListRecipientsAsyncWithHttpInfo (string accountId, string templateId, TemplatesApi.ListRecipientsOptions options=null)
 Gets recipient information from a template. More...
 
System.Threading.Tasks.Task< TabsListTabsAsync (string accountId, string templateId, string recipientId, TemplatesApi.ListTabsOptions options=null)
 Gets the tabs information for a signer or sign-in-person recipient in a template. More...
 
System.Threading.Tasks.Task< ApiResponse< Tabs > > ListTabsAsyncWithHttpInfo (string accountId, string templateId, string recipientId, TemplatesApi.ListTabsOptions options=null)
 Gets the tabs information for a signer or sign-in-person recipient in a template. More...
 
System.Threading.Tasks.Task< EnvelopeTemplateResultsListTemplatesAsync (string accountId, TemplatesApi.ListTemplatesOptions options=null)
 Gets the definition of a template. More...
 
System.Threading.Tasks.Task< ApiResponse< EnvelopeTemplateResults > > ListTemplatesAsyncWithHttpInfo (string accountId, TemplatesApi.ListTemplatesOptions options=null)
 Gets the definition of a template. More...
 
System.Threading.Tasks.Task< EnvelopeDocumentUpdateDocumentAsync (string accountId, string templateId, string documentId, EnvelopeDefinition envelopeDefinition=null, TemplatesApi.UpdateDocumentOptions options=null)
 Adds a document to a template document. More...
 
System.Threading.Tasks.Task< ApiResponse< EnvelopeDocument > > UpdateDocumentAsyncWithHttpInfo (string accountId, string templateId, string documentId, EnvelopeDefinition envelopeDefinition=null, TemplatesApi.UpdateDocumentOptions options=null)
 Adds a document to a template document. More...
 
System.Threading.Tasks.Task< RecipientsUpdateSummaryUpdateRecipientsAsync (string accountId, string templateId, TemplateRecipients templateRecipients=null, TemplatesApi.UpdateRecipientsOptions options=null)
 Updates recipients in a template. More...
 
System.Threading.Tasks.Task< ApiResponse< RecipientsUpdateSummary > > UpdateRecipientsAsyncWithHttpInfo (string accountId, string templateId, TemplateRecipients templateRecipients=null, TemplatesApi.UpdateRecipientsOptions options=null)
 Updates recipients in a template. 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

◆ TemplatesApi()

DocuSign.eSign.Api.TemplatesApi.TemplatesApi ( DocuSignClient  aplClient)
inline

Initializes a new instance of the TemplatesApi class using AplClient object

Parameters
aplClientAn instance of AplClient
Returns

Member Function Documentation

◆ CreateCustomFields()

CustomFields DocuSign.eSign.Api.TemplatesApi.CreateCustomFields ( string  accountId,
string  templateId,
TemplateCustomFields  templateCustomFields = null 
)
inline

Creates custom document fields in an existing template document. Creates custom document fields in an existing template document.

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
templateIdThe ID of the template being accessed.
templateCustomFields(optional)
Returns
CustomFields

Implements DocuSign.eSign.Api.ITemplatesApi.

◆ CreateCustomFieldsAsync()

async System.Threading.Tasks.Task<CustomFields> DocuSign.eSign.Api.TemplatesApi.CreateCustomFieldsAsync ( string  accountId,
string  templateId,
TemplateCustomFields  templateCustomFields = null 
)
inline

Creates custom document fields in an existing template document. Creates custom document fields in an existing template document.

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
templateIdThe ID of the template being accessed.
templateCustomFields(optional)
Returns
Task of CustomFields

Implements DocuSign.eSign.Api.ITemplatesApi.

◆ CreateCustomFieldsAsyncWithHttpInfo()

async System.Threading.Tasks.Task<ApiResponse<CustomFields> > DocuSign.eSign.Api.TemplatesApi.CreateCustomFieldsAsyncWithHttpInfo ( string  accountId,
string  templateId,
TemplateCustomFields  templateCustomFields = null 
)
inline

Creates custom document fields in an existing template document. Creates custom document fields in an existing template document.

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
templateIdThe ID of the template being accessed.
templateCustomFields(optional)
Returns
Task of ApiResponse (CustomFields)

Implements DocuSign.eSign.Api.ITemplatesApi.

◆ CreateCustomFieldsWithHttpInfo()

ApiResponse<CustomFields> DocuSign.eSign.Api.TemplatesApi.CreateCustomFieldsWithHttpInfo ( string  accountId,
string  templateId,
TemplateCustomFields  templateCustomFields = null 
)
inline

Creates custom document fields in an existing template document. Creates custom document fields in an existing template document.

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
templateIdThe ID of the template being accessed.
templateCustomFields(optional)
Returns
ApiResponse of CustomFields

Implements DocuSign.eSign.Api.ITemplatesApi.

◆ CreateDocumentFields()

DocumentFieldsInformation DocuSign.eSign.Api.TemplatesApi.CreateDocumentFields ( string  accountId,
string  templateId,
string  documentId,
DocumentFieldsInformation  documentFieldsInformation = null 
)
inline

Creates custom document fields in an existing template document. Creates custom document fields in an existing template document.

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
templateIdThe ID of the template being accessed.
documentIdThe ID of the document being accessed.
documentFieldsInformation(optional)
Returns
DocumentFieldsInformation

Implements DocuSign.eSign.Api.ITemplatesApi.

◆ CreateDocumentFieldsAsync()

async System.Threading.Tasks.Task<DocumentFieldsInformation> DocuSign.eSign.Api.TemplatesApi.CreateDocumentFieldsAsync ( string  accountId,
string  templateId,
string  documentId,
DocumentFieldsInformation  documentFieldsInformation = null 
)
inline

Creates custom document fields in an existing template document. Creates custom document fields in an existing template document.

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
templateIdThe ID of the template being accessed.
documentIdThe ID of the document being accessed.
documentFieldsInformation(optional)
Returns
Task of DocumentFieldsInformation

Implements DocuSign.eSign.Api.ITemplatesApi.

◆ CreateDocumentFieldsAsyncWithHttpInfo()

async System.Threading.Tasks.Task<ApiResponse<DocumentFieldsInformation> > DocuSign.eSign.Api.TemplatesApi.CreateDocumentFieldsAsyncWithHttpInfo ( string  accountId,
string  templateId,
string  documentId,
DocumentFieldsInformation  documentFieldsInformation = null 
)
inline

Creates custom document fields in an existing template document. Creates custom document fields in an existing template document.

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
templateIdThe ID of the template being accessed.
documentIdThe ID of the document being accessed.
documentFieldsInformation(optional)
Returns
Task of ApiResponse (DocumentFieldsInformation)

Implements DocuSign.eSign.Api.ITemplatesApi.

◆ CreateDocumentFieldsWithHttpInfo()

ApiResponse<DocumentFieldsInformation> DocuSign.eSign.Api.TemplatesApi.CreateDocumentFieldsWithHttpInfo ( string  accountId,
string  templateId,
string  documentId,
DocumentFieldsInformation  documentFieldsInformation = null 
)
inline

Creates custom document fields in an existing template document. Creates custom document fields in an existing template document.

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
templateIdThe ID of the template being accessed.
documentIdThe ID of the document being accessed.
documentFieldsInformation(optional)
Returns
ApiResponse of DocumentFieldsInformation

Implements DocuSign.eSign.Api.ITemplatesApi.

◆ CreateEditView()

ViewUrl DocuSign.eSign.Api.TemplatesApi.CreateEditView ( string  accountId,
string  templateId,
TemplateViewRequest  templateViewRequest = null 
)
inline

Provides a URL to start an edit view of the Template UI This method returns a URL for starting an edit view of a template that uses the DocuSign Template UI.

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
templateIdThe ID of the template being accessed.
templateViewRequest(optional)
Returns
ViewUrl

Implements DocuSign.eSign.Api.ITemplatesApi.

◆ CreateEditViewAsync()

async System.Threading.Tasks.Task<ViewUrl> DocuSign.eSign.Api.TemplatesApi.CreateEditViewAsync ( string  accountId,
string  templateId,
TemplateViewRequest  templateViewRequest = null 
)
inline

Provides a URL to start an edit view of the Template UI This method returns a URL for starting an edit view of a template that uses the DocuSign Template UI.

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
templateIdThe ID of the template being accessed.
templateViewRequest(optional)
Returns
Task of ViewUrl

Implements DocuSign.eSign.Api.ITemplatesApi.

◆ CreateEditViewAsyncWithHttpInfo()

async System.Threading.Tasks.Task<ApiResponse<ViewUrl> > DocuSign.eSign.Api.TemplatesApi.CreateEditViewAsyncWithHttpInfo ( string  accountId,
string  templateId,
TemplateViewRequest  templateViewRequest = null 
)
inline

Provides a URL to start an edit view of the Template UI This method returns a URL for starting an edit view of a template that uses the DocuSign Template UI.

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
templateIdThe ID of the template being accessed.
templateViewRequest(optional)
Returns
Task of ApiResponse (ViewUrl)

Implements DocuSign.eSign.Api.ITemplatesApi.

◆ CreateEditViewWithHttpInfo()

ApiResponse<ViewUrl> DocuSign.eSign.Api.TemplatesApi.CreateEditViewWithHttpInfo ( string  accountId,
string  templateId,
TemplateViewRequest  templateViewRequest = null 
)
inline

Provides a URL to start an edit view of the Template UI This method returns a URL for starting an edit view of a template that uses the DocuSign Template UI.

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
templateIdThe ID of the template being accessed.
templateViewRequest(optional)
Returns
ApiResponse of ViewUrl

Implements DocuSign.eSign.Api.ITemplatesApi.

◆ CreateLock()

LockInformation DocuSign.eSign.Api.TemplatesApi.CreateLock ( string  accountId,
string  templateId,
LockRequest  lockRequest = null 
)
inline

Lock a template. Locks the specified template, and sets the time until the lock expires, to prevent other users or recipients from accessing and changing the template. ###### Note: Users must have envelope locking capability enabled to use this function (the userSetting property &#x60;canLockEnvelopes&#x60; must be set to true for the user).

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
templateIdThe ID of the template being accessed.
lockRequest(optional)
Returns
LockInformation

Implements DocuSign.eSign.Api.ITemplatesApi.

◆ CreateLockAsync()

async System.Threading.Tasks.Task<LockInformation> DocuSign.eSign.Api.TemplatesApi.CreateLockAsync ( string  accountId,
string  templateId,
LockRequest  lockRequest = null 
)
inline

Lock a template. Locks the specified template, and sets the time until the lock expires, to prevent other users or recipients from accessing and changing the template. ###### Note: Users must have envelope locking capability enabled to use this function (the userSetting property &#x60;canLockEnvelopes&#x60; must be set to true for the user).

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
templateIdThe ID of the template being accessed.
lockRequest(optional)
Returns
Task of LockInformation

Implements DocuSign.eSign.Api.ITemplatesApi.

◆ CreateLockAsyncWithHttpInfo()

async System.Threading.Tasks.Task<ApiResponse<LockInformation> > DocuSign.eSign.Api.TemplatesApi.CreateLockAsyncWithHttpInfo ( string  accountId,
string  templateId,
LockRequest  lockRequest = null 
)
inline

Lock a template. Locks the specified template, and sets the time until the lock expires, to prevent other users or recipients from accessing and changing the template. ###### Note: Users must have envelope locking capability enabled to use this function (the userSetting property &#x60;canLockEnvelopes&#x60; must be set to true for the user).

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
templateIdThe ID of the template being accessed.
lockRequest(optional)
Returns
Task of ApiResponse (LockInformation)

Implements DocuSign.eSign.Api.ITemplatesApi.

◆ CreateLockWithHttpInfo()

ApiResponse<LockInformation> DocuSign.eSign.Api.TemplatesApi.CreateLockWithHttpInfo ( string  accountId,
string  templateId,
LockRequest  lockRequest = null 
)
inline

Lock a template. Locks the specified template, and sets the time until the lock expires, to prevent other users or recipients from accessing and changing the template. ###### Note: Users must have envelope locking capability enabled to use this function (the userSetting property &#x60;canLockEnvelopes&#x60; must be set to true for the user).

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
templateIdThe ID of the template being accessed.
lockRequest(optional)
Returns
ApiResponse of LockInformation

Implements DocuSign.eSign.Api.ITemplatesApi.

◆ CreateRecipients()

Recipients DocuSign.eSign.Api.TemplatesApi.CreateRecipients ( string  accountId,
string  templateId,
TemplateRecipients  templateRecipients = null,
TemplatesApi.CreateRecipientsOptions  options = null 
)
inline

Adds tabs for a recipient. Adds one or more recipients to a template.

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
templateIdThe ID of the template being accessed.
templateRecipients(optional)
optionsOptions for modifying the behavior of the function.
Returns
Recipients

◆ CreateRecipientsAsync()

async System.Threading.Tasks.Task<Recipients> DocuSign.eSign.Api.TemplatesApi.CreateRecipientsAsync ( string  accountId,
string  templateId,
TemplateRecipients  templateRecipients = null,
TemplatesApi.CreateRecipientsOptions  options = null 
)
inline

Adds tabs for a recipient. Adds one or more recipients to a template.

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
templateIdThe ID of the template being accessed.
templateRecipients(optional)
optionsOptions for modifying the behavior of the function.
Returns
Task of Recipients

◆ CreateRecipientsAsyncWithHttpInfo()

async System.Threading.Tasks.Task<ApiResponse<Recipients> > DocuSign.eSign.Api.TemplatesApi.CreateRecipientsAsyncWithHttpInfo ( string  accountId,
string  templateId,
TemplateRecipients  templateRecipients = null,
TemplatesApi.CreateRecipientsOptions  options = null 
)
inline

Adds tabs for a recipient. Adds one or more recipients to a template.

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
templateIdThe ID of the template being accessed.
templateRecipients(optional)
optionsOptions for modifying the behavior of the function.
Returns
Task of ApiResponse (Recipients)

◆ CreateRecipientsWithHttpInfo()

ApiResponse<Recipients> DocuSign.eSign.Api.TemplatesApi.CreateRecipientsWithHttpInfo ( string  accountId,
string  templateId,
TemplateRecipients  templateRecipients = null,
TemplatesApi.CreateRecipientsOptions  options = null 
)
inline

Adds tabs for a recipient. Adds one or more recipients to a template.

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
templateIdThe ID of the template being accessed.
templateRecipients(optional)
optionsOptions for modifying the behavior of the function.
Returns
ApiResponse of Recipients

◆ CreateTabs()

Tabs DocuSign.eSign.Api.TemplatesApi.CreateTabs ( string  accountId,
string  templateId,
string  recipientId,
TemplateTabs  templateTabs = null 
)
inline

Adds tabs for a recipient. Adds one or more tabs for a recipient.

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
templateIdThe ID of the template being accessed.
recipientIdThe ID of the recipient being accessed.
templateTabs(optional)
Returns
Tabs

Implements DocuSign.eSign.Api.ITemplatesApi.

◆ CreateTabsAsync()

async System.Threading.Tasks.Task<Tabs> DocuSign.eSign.Api.TemplatesApi.CreateTabsAsync ( string  accountId,
string  templateId,
string  recipientId,
TemplateTabs  templateTabs = null 
)
inline

Adds tabs for a recipient. Adds one or more tabs for a recipient.

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
templateIdThe ID of the template being accessed.
recipientIdThe ID of the recipient being accessed.
templateTabs(optional)
Returns
Task of Tabs

Implements DocuSign.eSign.Api.ITemplatesApi.

◆ CreateTabsAsyncWithHttpInfo()

async System.Threading.Tasks.Task<ApiResponse<Tabs> > DocuSign.eSign.Api.TemplatesApi.CreateTabsAsyncWithHttpInfo ( string  accountId,
string  templateId,
string  recipientId,
TemplateTabs  templateTabs = null 
)
inline

Adds tabs for a recipient. Adds one or more tabs for a recipient.

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
templateIdThe ID of the template being accessed.
recipientIdThe ID of the recipient being accessed.
templateTabs(optional)
Returns
Task of ApiResponse (Tabs)

Implements DocuSign.eSign.Api.ITemplatesApi.

◆ CreateTabsWithHttpInfo()

ApiResponse<Tabs> DocuSign.eSign.Api.TemplatesApi.CreateTabsWithHttpInfo ( string  accountId,
string  templateId,
string  recipientId,
TemplateTabs  templateTabs = null 
)
inline

Adds tabs for a recipient. Adds one or more tabs for a recipient.

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
templateIdThe ID of the template being accessed.
recipientIdThe ID of the recipient being accessed.
templateTabs(optional)
Returns
ApiResponse of Tabs

Implements DocuSign.eSign.Api.ITemplatesApi.

◆ CreateTemplate()

TemplateSummary DocuSign.eSign.Api.TemplatesApi.CreateTemplate ( string  accountId,
EnvelopeTemplate  envelopeTemplate = null 
)
inline

Creates an envelope from a template. Creates a template definition using a multipart request. ###Template Email Subject Merge Fields Call this endpoint to insert a recipient name and email address merge fields into the email subject line when creating or sending from a template. The merge fields, based on the recipient&#39;s role name, are added to the &#x60;emailSubject&#x60; property when the template is created or when the template is used to create an envelope. After a template sender adds the name and email information for the recipient and sends the envelope, the recipient information is automatically merged into the appropriate fields in the email subject line. Both the sender and the recipients will see the information in the email subject line for any emails associated with the template. This provides an easy way for senders to organize their envelope emails without having to open an envelope to check the recipient. ###### Note: If merging the recipient information into the subject line causes the subject line to exceed 100 characters, then any characters over the 100 character limit are not included in the subject line. For cases where the recipient name or email is expected to be long, you should consider placing the merge field at the start of the email subject. To add a recipient&#39;s name in the subject line add the following text in the &#x60;emailSubject&#x60; property when creating the template or when sending an envelope from a template: [[<roleName>_UserName]] Example: &#x60;&quot;emailSubject&quot;:&quot;[[Signer 1_UserName]], Please sign this NDA&quot;,&#x60; To add a recipient&#39;s email address in the subject line add the following text in the &#x60;emailSubject&#x60; property when creating the template or when sending an envelope from a template: [[<roleName>_Email]] Example: &#x60;&quot;emailSubject&quot;:&quot;[[Signer 1_Email]], Please sign this NDA&quot;,&#x60; In both cases the <roleName> is the recipient&#39;s contents of the &#x60;roleName&#x60; property in the template. For cases where another recipient (such as an Agent, Editor, or Intermediary recipient) is entering the name and email information for the recipient included in the email subject, then [[<roleName>_UserName]] or [[<roleName>_Email]] is shown in the email subject.

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
envelopeTemplate(optional)
Returns
TemplateSummary

Implements DocuSign.eSign.Api.ITemplatesApi.

◆ CreateTemplateAsync()

async System.Threading.Tasks.Task<TemplateSummary> DocuSign.eSign.Api.TemplatesApi.CreateTemplateAsync ( string  accountId,
EnvelopeTemplate  envelopeTemplate = null 
)
inline

Creates an envelope from a template. Creates a template definition using a multipart request. ###Template Email Subject Merge Fields Call this endpoint to insert a recipient name and email address merge fields into the email subject line when creating or sending from a template. The merge fields, based on the recipient&#39;s role name, are added to the &#x60;emailSubject&#x60; property when the template is created or when the template is used to create an envelope. After a template sender adds the name and email information for the recipient and sends the envelope, the recipient information is automatically merged into the appropriate fields in the email subject line. Both the sender and the recipients will see the information in the email subject line for any emails associated with the template. This provides an easy way for senders to organize their envelope emails without having to open an envelope to check the recipient. ###### Note: If merging the recipient information into the subject line causes the subject line to exceed 100 characters, then any characters over the 100 character limit are not included in the subject line. For cases where the recipient name or email is expected to be long, you should consider placing the merge field at the start of the email subject. To add a recipient&#39;s name in the subject line add the following text in the &#x60;emailSubject&#x60; property when creating the template or when sending an envelope from a template: [[<roleName>_UserName]] Example: &#x60;&quot;emailSubject&quot;:&quot;[[Signer 1_UserName]], Please sign this NDA&quot;,&#x60; To add a recipient&#39;s email address in the subject line add the following text in the &#x60;emailSubject&#x60; property when creating the template or when sending an envelope from a template: [[<roleName>_Email]] Example: &#x60;&quot;emailSubject&quot;:&quot;[[Signer 1_Email]], Please sign this NDA&quot;,&#x60; In both cases the <roleName> is the recipient&#39;s contents of the &#x60;roleName&#x60; property in the template. For cases where another recipient (such as an Agent, Editor, or Intermediary recipient) is entering the name and email information for the recipient included in the email subject, then [[<roleName>_UserName]] or [[<roleName>_Email]] is shown in the email subject.

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
envelopeTemplate(optional)
Returns
Task of TemplateSummary

Implements DocuSign.eSign.Api.ITemplatesApi.

◆ CreateTemplateAsyncWithHttpInfo()

async System.Threading.Tasks.Task<ApiResponse<TemplateSummary> > DocuSign.eSign.Api.TemplatesApi.CreateTemplateAsyncWithHttpInfo ( string  accountId,
EnvelopeTemplate  envelopeTemplate = null 
)
inline

Creates an envelope from a template. Creates a template definition using a multipart request. ###Template Email Subject Merge Fields Call this endpoint to insert a recipient name and email address merge fields into the email subject line when creating or sending from a template. The merge fields, based on the recipient&#39;s role name, are added to the &#x60;emailSubject&#x60; property when the template is created or when the template is used to create an envelope. After a template sender adds the name and email information for the recipient and sends the envelope, the recipient information is automatically merged into the appropriate fields in the email subject line. Both the sender and the recipients will see the information in the email subject line for any emails associated with the template. This provides an easy way for senders to organize their envelope emails without having to open an envelope to check the recipient. ###### Note: If merging the recipient information into the subject line causes the subject line to exceed 100 characters, then any characters over the 100 character limit are not included in the subject line. For cases where the recipient name or email is expected to be long, you should consider placing the merge field at the start of the email subject. To add a recipient&#39;s name in the subject line add the following text in the &#x60;emailSubject&#x60; property when creating the template or when sending an envelope from a template: [[<roleName>_UserName]] Example: &#x60;&quot;emailSubject&quot;:&quot;[[Signer 1_UserName]], Please sign this NDA&quot;,&#x60; To add a recipient&#39;s email address in the subject line add the following text in the &#x60;emailSubject&#x60; property when creating the template or when sending an envelope from a template: [[<roleName>_Email]] Example: &#x60;&quot;emailSubject&quot;:&quot;[[Signer 1_Email]], Please sign this NDA&quot;,&#x60; In both cases the <roleName> is the recipient&#39;s contents of the &#x60;roleName&#x60; property in the template. For cases where another recipient (such as an Agent, Editor, or Intermediary recipient) is entering the name and email information for the recipient included in the email subject, then [[<roleName>_UserName]] or [[<roleName>_Email]] is shown in the email subject.

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
envelopeTemplate(optional)
Returns
Task of ApiResponse (TemplateSummary)

Implements DocuSign.eSign.Api.ITemplatesApi.

◆ CreateTemplateDocumentResponsiveHtmlPreview()

DocumentHtmlDefinitions DocuSign.eSign.Api.TemplatesApi.CreateTemplateDocumentResponsiveHtmlPreview ( string  accountId,
string  templateId,
string  documentId,
DocumentHtmlDefinition  documentHtmlDefinition = null 
)
inline

Post Responsive HTML Preview for a document in a template. Creates a preview of the responsive, HTML version of a specific template document. This method enables you to preview a PDF document conversion to responsive HTML across device types prior to sending. The request body is a &#x60;documentHtmlDefinition&#x60; object, which holds the responsive signing parameters that define how to generate the HTML version of the signing document.

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
templateIdThe ID of the template being accessed.
documentIdThe ID of the document being accessed.
documentHtmlDefinition(optional)
Returns
DocumentHtmlDefinitions

Implements DocuSign.eSign.Api.ITemplatesApi.

◆ CreateTemplateDocumentResponsiveHtmlPreviewAsync()

async System.Threading.Tasks.Task<DocumentHtmlDefinitions> DocuSign.eSign.Api.TemplatesApi.CreateTemplateDocumentResponsiveHtmlPreviewAsync ( string  accountId,
string  templateId,
string  documentId,
DocumentHtmlDefinition  documentHtmlDefinition = null 
)
inline

Post Responsive HTML Preview for a document in a template. Creates a preview of the responsive, HTML version of a specific template document. This method enables you to preview a PDF document conversion to responsive HTML across device types prior to sending. The request body is a &#x60;documentHtmlDefinition&#x60; object, which holds the responsive signing parameters that define how to generate the HTML version of the signing document.

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
templateIdThe ID of the template being accessed.
documentIdThe ID of the document being accessed.
documentHtmlDefinition(optional)
Returns
Task of DocumentHtmlDefinitions

Implements DocuSign.eSign.Api.ITemplatesApi.

◆ CreateTemplateDocumentResponsiveHtmlPreviewAsyncWithHttpInfo()

async System.Threading.Tasks.Task<ApiResponse<DocumentHtmlDefinitions> > DocuSign.eSign.Api.TemplatesApi.CreateTemplateDocumentResponsiveHtmlPreviewAsyncWithHttpInfo ( string  accountId,
string  templateId,
string  documentId,
DocumentHtmlDefinition  documentHtmlDefinition = null 
)
inline

Post Responsive HTML Preview for a document in a template. Creates a preview of the responsive, HTML version of a specific template document. This method enables you to preview a PDF document conversion to responsive HTML across device types prior to sending. The request body is a &#x60;documentHtmlDefinition&#x60; object, which holds the responsive signing parameters that define how to generate the HTML version of the signing document.

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
templateIdThe ID of the template being accessed.
documentIdThe ID of the document being accessed.
documentHtmlDefinition(optional)
Returns
Task of ApiResponse (DocumentHtmlDefinitions)

Implements DocuSign.eSign.Api.ITemplatesApi.

◆ CreateTemplateDocumentResponsiveHtmlPreviewWithHttpInfo()

ApiResponse<DocumentHtmlDefinitions> DocuSign.eSign.Api.TemplatesApi.CreateTemplateDocumentResponsiveHtmlPreviewWithHttpInfo ( string  accountId,
string  templateId,
string  documentId,
DocumentHtmlDefinition  documentHtmlDefinition = null 
)
inline

Post Responsive HTML Preview for a document in a template. Creates a preview of the responsive, HTML version of a specific template document. This method enables you to preview a PDF document conversion to responsive HTML across device types prior to sending. The request body is a &#x60;documentHtmlDefinition&#x60; object, which holds the responsive signing parameters that define how to generate the HTML version of the signing document.

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
templateIdThe ID of the template being accessed.
documentIdThe ID of the document being accessed.
documentHtmlDefinition(optional)
Returns
ApiResponse of DocumentHtmlDefinitions

Implements DocuSign.eSign.Api.ITemplatesApi.

◆ CreateTemplateDocumentTabs()

Tabs DocuSign.eSign.Api.TemplatesApi.CreateTemplateDocumentTabs ( string  accountId,
string  templateId,
string  documentId,
TemplateTabs  templateTabs = null 
)
inline

Adds the tabs to a tempate Adds tabs to the document specified by &#x60;documentId&#x60; in the template specified by &#x60;templateId&#x60;. In the request body, you only need to specify the tabs that your are adding. For example, to add a text prefill tab, your request body might look like this: &#x60;&#x60;&#x60; { &quot;prefillTabs&quot;: { &quot;textTabs&quot;: [ { &quot;value&quot;: &quot;a prefill text tab&quot;, &quot;pageNumber&quot;: &quot;1&quot;, &quot;documentId&quot;: &quot;1&quot;, &quot;xPosition&quot;: 316, &quot;yPosition&quot;: 97 } ] } } &#x60;&#x60;&#x60;

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
templateIdThe ID of the template being accessed.
documentIdThe ID of the document being accessed.
templateTabs(optional)
Returns
Tabs

Implements DocuSign.eSign.Api.ITemplatesApi.

◆ CreateTemplateDocumentTabsAsync()

async System.Threading.Tasks.Task<Tabs> DocuSign.eSign.Api.TemplatesApi.CreateTemplateDocumentTabsAsync ( string  accountId,
string  templateId,
string  documentId,
TemplateTabs  templateTabs = null 
)
inline

Adds the tabs to a tempate Adds tabs to the document specified by &#x60;documentId&#x60; in the template specified by &#x60;templateId&#x60;. In the request body, you only need to specify the tabs that your are adding. For example, to add a text prefill tab, your request body might look like this: &#x60;&#x60;&#x60; { &quot;prefillTabs&quot;: { &quot;textTabs&quot;: [ { &quot;value&quot;: &quot;a prefill text tab&quot;, &quot;pageNumber&quot;: &quot;1&quot;, &quot;documentId&quot;: &quot;1&quot;, &quot;xPosition&quot;: 316, &quot;yPosition&quot;: 97 } ] } } &#x60;&#x60;&#x60;

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
templateIdThe ID of the template being accessed.
documentIdThe ID of the document being accessed.
templateTabs(optional)
Returns
Task of Tabs

Implements DocuSign.eSign.Api.ITemplatesApi.

◆ CreateTemplateDocumentTabsAsyncWithHttpInfo()

async System.Threading.Tasks.Task<ApiResponse<Tabs> > DocuSign.eSign.Api.TemplatesApi.CreateTemplateDocumentTabsAsyncWithHttpInfo ( string  accountId,
string  templateId,
string  documentId,
TemplateTabs  templateTabs = null 
)
inline

Adds the tabs to a tempate Adds tabs to the document specified by &#x60;documentId&#x60; in the template specified by &#x60;templateId&#x60;. In the request body, you only need to specify the tabs that your are adding. For example, to add a text prefill tab, your request body might look like this: &#x60;&#x60;&#x60; { &quot;prefillTabs&quot;: { &quot;textTabs&quot;: [ { &quot;value&quot;: &quot;a prefill text tab&quot;, &quot;pageNumber&quot;: &quot;1&quot;, &quot;documentId&quot;: &quot;1&quot;, &quot;xPosition&quot;: 316, &quot;yPosition&quot;: 97 } ] } } &#x60;&#x60;&#x60;

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
templateIdThe ID of the template being accessed.
documentIdThe ID of the document being accessed.
templateTabs(optional)
Returns
Task of ApiResponse (Tabs)

Implements DocuSign.eSign.Api.ITemplatesApi.

◆ CreateTemplateDocumentTabsWithHttpInfo()

ApiResponse<Tabs> DocuSign.eSign.Api.TemplatesApi.CreateTemplateDocumentTabsWithHttpInfo ( string  accountId,
string  templateId,
string  documentId,
TemplateTabs  templateTabs = null 
)
inline

Adds the tabs to a tempate Adds tabs to the document specified by &#x60;documentId&#x60; in the template specified by &#x60;templateId&#x60;. In the request body, you only need to specify the tabs that your are adding. For example, to add a text prefill tab, your request body might look like this: &#x60;&#x60;&#x60; { &quot;prefillTabs&quot;: { &quot;textTabs&quot;: [ { &quot;value&quot;: &quot;a prefill text tab&quot;, &quot;pageNumber&quot;: &quot;1&quot;, &quot;documentId&quot;: &quot;1&quot;, &quot;xPosition&quot;: 316, &quot;yPosition&quot;: 97 } ] } } &#x60;&#x60;&#x60;

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
templateIdThe ID of the template being accessed.
documentIdThe ID of the document being accessed.
templateTabs(optional)
Returns
ApiResponse of Tabs

Implements DocuSign.eSign.Api.ITemplatesApi.

◆ CreateTemplateRecipientPreview()

ViewUrl DocuSign.eSign.Api.TemplatesApi.CreateTemplateRecipientPreview ( string  accountId,
string  templateId,
RecipientPreviewRequest  recipientPreviewRequest = null 
)
inline

Provides a URL to start a recipient view of the Envelope UI This method returns a URL for a template recipient preview in the DocuSign UI that you can embed in your application. You use this method to enable the sender to preview the recipients&#39; experience. For more information, see Preview and Send.

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
templateIdThe ID of the template being accessed.
recipientPreviewRequest(optional)
Returns
ViewUrl

Implements DocuSign.eSign.Api.ITemplatesApi.

◆ CreateTemplateRecipientPreviewAsync()

async System.Threading.Tasks.Task<ViewUrl> DocuSign.eSign.Api.TemplatesApi.CreateTemplateRecipientPreviewAsync ( string  accountId,
string  templateId,
RecipientPreviewRequest  recipientPreviewRequest = null 
)
inline

Provides a URL to start a recipient view of the Envelope UI This method returns a URL for a template recipient preview in the DocuSign UI that you can embed in your application. You use this method to enable the sender to preview the recipients&#39; experience. For more information, see Preview and Send.

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
templateIdThe ID of the template being accessed.
recipientPreviewRequest(optional)
Returns
Task of ViewUrl

Implements DocuSign.eSign.Api.ITemplatesApi.

◆ CreateTemplateRecipientPreviewAsyncWithHttpInfo()

async System.Threading.Tasks.Task<ApiResponse<ViewUrl> > DocuSign.eSign.Api.TemplatesApi.CreateTemplateRecipientPreviewAsyncWithHttpInfo ( string  accountId,
string  templateId,
RecipientPreviewRequest  recipientPreviewRequest = null 
)
inline

Provides a URL to start a recipient view of the Envelope UI This method returns a URL for a template recipient preview in the DocuSign UI that you can embed in your application. You use this method to enable the sender to preview the recipients&#39; experience. For more information, see Preview and Send.

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
templateIdThe ID of the template being accessed.
recipientPreviewRequest(optional)
Returns
Task of ApiResponse (ViewUrl)

Implements DocuSign.eSign.Api.ITemplatesApi.

◆ CreateTemplateRecipientPreviewWithHttpInfo()

ApiResponse<ViewUrl> DocuSign.eSign.Api.TemplatesApi.CreateTemplateRecipientPreviewWithHttpInfo ( string  accountId,
string  templateId,
RecipientPreviewRequest  recipientPreviewRequest = null 
)
inline

Provides a URL to start a recipient view of the Envelope UI This method returns a URL for a template recipient preview in the DocuSign UI that you can embed in your application. You use this method to enable the sender to preview the recipients&#39; experience. For more information, see Preview and Send.

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
templateIdThe ID of the template being accessed.
recipientPreviewRequest(optional)
Returns
ApiResponse of ViewUrl

Implements DocuSign.eSign.Api.ITemplatesApi.

◆ CreateTemplateResponsiveHtmlPreview()

DocumentHtmlDefinitions DocuSign.eSign.Api.TemplatesApi.CreateTemplateResponsiveHtmlPreview ( string  accountId,
string  templateId,
DocumentHtmlDefinition  documentHtmlDefinition = null 
)
inline

Get Responsive HTML Preview for all documents in a template. Creates a preview of the responsive, HTML versions of all of the documents associated with a template. This method enables you to preview the PDF document conversions to responsive HTML across device types prior to sending. The request body is a &#x60;documentHtmlDefinition&#x60; object, which holds the responsive signing parameters that define how to generate the HTML version of the documents.

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
templateIdThe ID of the template being accessed.
documentHtmlDefinition(optional)
Returns
DocumentHtmlDefinitions

Implements DocuSign.eSign.Api.ITemplatesApi.

◆ CreateTemplateResponsiveHtmlPreviewAsync()

async System.Threading.Tasks.Task<DocumentHtmlDefinitions> DocuSign.eSign.Api.TemplatesApi.CreateTemplateResponsiveHtmlPreviewAsync ( string  accountId,
string  templateId,
DocumentHtmlDefinition  documentHtmlDefinition = null 
)
inline

Get Responsive HTML Preview for all documents in a template. Creates a preview of the responsive, HTML versions of all of the documents associated with a template. This method enables you to preview the PDF document conversions to responsive HTML across device types prior to sending. The request body is a &#x60;documentHtmlDefinition&#x60; object, which holds the responsive signing parameters that define how to generate the HTML version of the documents.

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
templateIdThe ID of the template being accessed.
documentHtmlDefinition(optional)
Returns
Task of DocumentHtmlDefinitions

Implements DocuSign.eSign.Api.ITemplatesApi.

◆ CreateTemplateResponsiveHtmlPreviewAsyncWithHttpInfo()

async System.Threading.Tasks.Task<ApiResponse<DocumentHtmlDefinitions> > DocuSign.eSign.Api.TemplatesApi.CreateTemplateResponsiveHtmlPreviewAsyncWithHttpInfo ( string  accountId,
string  templateId,
DocumentHtmlDefinition  documentHtmlDefinition = null 
)
inline

Get Responsive HTML Preview for all documents in a template. Creates a preview of the responsive, HTML versions of all of the documents associated with a template. This method enables you to preview the PDF document conversions to responsive HTML across device types prior to sending. The request body is a &#x60;documentHtmlDefinition&#x60; object, which holds the responsive signing parameters that define how to generate the HTML version of the documents.

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
templateIdThe ID of the template being accessed.
documentHtmlDefinition(optional)
Returns
Task of ApiResponse (DocumentHtmlDefinitions)

Implements DocuSign.eSign.Api.ITemplatesApi.

◆ CreateTemplateResponsiveHtmlPreviewWithHttpInfo()

ApiResponse<DocumentHtmlDefinitions> DocuSign.eSign.Api.TemplatesApi.CreateTemplateResponsiveHtmlPreviewWithHttpInfo ( string  accountId,
string  templateId,
DocumentHtmlDefinition  documentHtmlDefinition = null 
)
inline

Get Responsive HTML Preview for all documents in a template. Creates a preview of the responsive, HTML versions of all of the documents associated with a template. This method enables you to preview the PDF document conversions to responsive HTML across device types prior to sending. The request body is a &#x60;documentHtmlDefinition&#x60; object, which holds the responsive signing parameters that define how to generate the HTML version of the documents.

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
templateIdThe ID of the template being accessed.
documentHtmlDefinition(optional)
Returns
ApiResponse of DocumentHtmlDefinitions

Implements DocuSign.eSign.Api.ITemplatesApi.

◆ CreateTemplateWithHttpInfo()

ApiResponse<TemplateSummary> DocuSign.eSign.Api.TemplatesApi.CreateTemplateWithHttpInfo ( string  accountId,
EnvelopeTemplate  envelopeTemplate = null 
)
inline

Creates an envelope from a template. Creates a template definition using a multipart request. ###Template Email Subject Merge Fields Call this endpoint to insert a recipient name and email address merge fields into the email subject line when creating or sending from a template. The merge fields, based on the recipient&#39;s role name, are added to the &#x60;emailSubject&#x60; property when the template is created or when the template is used to create an envelope. After a template sender adds the name and email information for the recipient and sends the envelope, the recipient information is automatically merged into the appropriate fields in the email subject line. Both the sender and the recipients will see the information in the email subject line for any emails associated with the template. This provides an easy way for senders to organize their envelope emails without having to open an envelope to check the recipient. ###### Note: If merging the recipient information into the subject line causes the subject line to exceed 100 characters, then any characters over the 100 character limit are not included in the subject line. For cases where the recipient name or email is expected to be long, you should consider placing the merge field at the start of the email subject. To add a recipient&#39;s name in the subject line add the following text in the &#x60;emailSubject&#x60; property when creating the template or when sending an envelope from a template: [[<roleName>_UserName]] Example: &#x60;&quot;emailSubject&quot;:&quot;[[Signer 1_UserName]], Please sign this NDA&quot;,&#x60; To add a recipient&#39;s email address in the subject line add the following text in the &#x60;emailSubject&#x60; property when creating the template or when sending an envelope from a template: [[<roleName>_Email]] Example: &#x60;&quot;emailSubject&quot;:&quot;[[Signer 1_Email]], Please sign this NDA&quot;,&#x60; In both cases the <roleName> is the recipient&#39;s contents of the &#x60;roleName&#x60; property in the template. For cases where another recipient (such as an Agent, Editor, or Intermediary recipient) is entering the name and email information for the recipient included in the email subject, then [[<roleName>_UserName]] or [[<roleName>_Email]] is shown in the email subject.

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
envelopeTemplate(optional)
Returns
ApiResponse of TemplateSummary

Implements DocuSign.eSign.Api.ITemplatesApi.

◆ DeleteCustomFields()

CustomFields DocuSign.eSign.Api.TemplatesApi.DeleteCustomFields ( string  accountId,
string  templateId,
TemplateCustomFields  templateCustomFields = null 
)
inline

Deletes envelope custom fields in a template. Deletes envelope custom fields in a template.

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
templateIdThe ID of the template being accessed.
templateCustomFields(optional)
Returns
CustomFields

Implements DocuSign.eSign.Api.ITemplatesApi.

◆ DeleteCustomFieldsAsync()

async System.Threading.Tasks.Task<CustomFields> DocuSign.eSign.Api.TemplatesApi.DeleteCustomFieldsAsync ( string  accountId,
string  templateId,
TemplateCustomFields  templateCustomFields = null 
)
inline

Deletes envelope custom fields in a template. Deletes envelope custom fields in a template.

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
templateIdThe ID of the template being accessed.
templateCustomFields(optional)
Returns
Task of CustomFields

Implements DocuSign.eSign.Api.ITemplatesApi.

◆ DeleteCustomFieldsAsyncWithHttpInfo()

async System.Threading.Tasks.Task<ApiResponse<CustomFields> > DocuSign.eSign.Api.TemplatesApi.DeleteCustomFieldsAsyncWithHttpInfo ( string  accountId,
string  templateId,
TemplateCustomFields  templateCustomFields = null 
)
inline

Deletes envelope custom fields in a template. Deletes envelope custom fields in a template.

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
templateIdThe ID of the template being accessed.
templateCustomFields(optional)
Returns
Task of ApiResponse (CustomFields)

Implements DocuSign.eSign.Api.ITemplatesApi.

◆ DeleteCustomFieldsWithHttpInfo()

ApiResponse<CustomFields> DocuSign.eSign.Api.TemplatesApi.DeleteCustomFieldsWithHttpInfo ( string  accountId,
string  templateId,
TemplateCustomFields  templateCustomFields = null 
)
inline

Deletes envelope custom fields in a template. Deletes envelope custom fields in a template.

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
templateIdThe ID of the template being accessed.
templateCustomFields(optional)
Returns
ApiResponse of CustomFields

Implements DocuSign.eSign.Api.ITemplatesApi.

◆ DeleteDocumentFields()

DocumentFieldsInformation DocuSign.eSign.Api.TemplatesApi.DeleteDocumentFields ( string  accountId,
string  templateId,
string  documentId,
DocumentFieldsInformation  documentFieldsInformation = null 
)
inline

Deletes custom document fields from an existing template document. Deletes custom document fields from an existing template document.

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
templateIdThe ID of the template being accessed.
documentIdThe ID of the document being accessed.
documentFieldsInformation(optional)
Returns
DocumentFieldsInformation

Implements DocuSign.eSign.Api.ITemplatesApi.

◆ DeleteDocumentFieldsAsync()

async System.Threading.Tasks.Task<DocumentFieldsInformation> DocuSign.eSign.Api.TemplatesApi.DeleteDocumentFieldsAsync ( string  accountId,
string  templateId,
string  documentId,
DocumentFieldsInformation  documentFieldsInformation = null 
)
inline

Deletes custom document fields from an existing template document. Deletes custom document fields from an existing template document.

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
templateIdThe ID of the template being accessed.
documentIdThe ID of the document being accessed.
documentFieldsInformation(optional)
Returns
Task of DocumentFieldsInformation

Implements DocuSign.eSign.Api.ITemplatesApi.

◆ DeleteDocumentFieldsAsyncWithHttpInfo()

async System.Threading.Tasks.Task<ApiResponse<DocumentFieldsInformation> > DocuSign.eSign.Api.TemplatesApi.DeleteDocumentFieldsAsyncWithHttpInfo ( string  accountId,
string  templateId,
string  documentId,
DocumentFieldsInformation  documentFieldsInformation = null 
)
inline

Deletes custom document fields from an existing template document. Deletes custom document fields from an existing template document.

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
templateIdThe ID of the template being accessed.
documentIdThe ID of the document being accessed.
documentFieldsInformation(optional)
Returns
Task of ApiResponse (DocumentFieldsInformation)

Implements DocuSign.eSign.Api.ITemplatesApi.

◆ DeleteDocumentFieldsWithHttpInfo()

ApiResponse<DocumentFieldsInformation> DocuSign.eSign.Api.TemplatesApi.DeleteDocumentFieldsWithHttpInfo ( string  accountId,
string  templateId,
string  documentId,
DocumentFieldsInformation  documentFieldsInformation = null 
)
inline

Deletes custom document fields from an existing template document. Deletes custom document fields from an existing template document.

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
templateIdThe ID of the template being accessed.
documentIdThe ID of the document being accessed.
documentFieldsInformation(optional)
Returns
ApiResponse of DocumentFieldsInformation

Implements DocuSign.eSign.Api.ITemplatesApi.

◆ DeleteDocumentPage()

void DocuSign.eSign.Api.TemplatesApi.DeleteDocumentPage ( string  accountId,
string  templateId,
string  documentId,
string  pageNumber,
PageRequest  pageRequest = null 
)
inline

Deletes a page from a document in an template. Deletes a page from a document in a template based on the page number.

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
templateIdThe ID of the template being accessed.
documentIdThe ID of the document being accessed.
pageNumberThe page number being accessed.
pageRequest(optional)
Returns

Implements DocuSign.eSign.Api.ITemplatesApi.

◆ DeleteDocumentPageAsync()

async System.Threading.Tasks.Task DocuSign.eSign.Api.TemplatesApi.DeleteDocumentPageAsync ( string  accountId,
string  templateId,
string  documentId,
string  pageNumber,
PageRequest  pageRequest = null 
)
inline

Deletes a page from a document in an template. Deletes a page from a document in a template based on the page number.

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
templateIdThe ID of the template being accessed.
documentIdThe ID of the document being accessed.
pageNumberThe page number being accessed.
pageRequest(optional)
Returns
Task of void

Implements DocuSign.eSign.Api.ITemplatesApi.

◆ DeleteDocumentPageAsyncWithHttpInfo()

async System.Threading.Tasks.Task<ApiResponse<Object> > DocuSign.eSign.Api.TemplatesApi.DeleteDocumentPageAsyncWithHttpInfo ( string  accountId,
string  templateId,
string  documentId,
string  pageNumber,
PageRequest  pageRequest = null 
)
inline

Deletes a page from a document in an template. Deletes a page from a document in a template based on the page number.

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
templateIdThe ID of the template being accessed.
documentIdThe ID of the document being accessed.
pageNumberThe page number being accessed.
pageRequest(optional)
Returns
Task of ApiResponse

Implements DocuSign.eSign.Api.ITemplatesApi.

◆ DeleteDocumentPageWithHttpInfo()

ApiResponse<Object> DocuSign.eSign.Api.TemplatesApi.DeleteDocumentPageWithHttpInfo ( string  accountId,
string  templateId,
string  documentId,
string  pageNumber,
PageRequest  pageRequest = null 
)
inline

Deletes a page from a document in an template. Deletes a page from a document in a template based on the page number.

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
templateIdThe ID of the template being accessed.
documentIdThe ID of the document being accessed.
pageNumberThe page number being accessed.
pageRequest(optional)
Returns
ApiResponse of Object(void)

Implements DocuSign.eSign.Api.ITemplatesApi.

◆ DeleteDocuments()

TemplateDocumentsResult DocuSign.eSign.Api.TemplatesApi.DeleteDocuments ( string  accountId,
string  templateId,
EnvelopeDefinition  envelopeDefinition = null 
)
inline

Deletes documents from a template. Deletes one or more documents from an existing template.

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
templateIdThe ID of the template being accessed.
envelopeDefinition(optional)
Returns
TemplateDocumentsResult

Implements DocuSign.eSign.Api.ITemplatesApi.

◆ DeleteDocumentsAsync()

async System.Threading.Tasks.Task<TemplateDocumentsResult> DocuSign.eSign.Api.TemplatesApi.DeleteDocumentsAsync ( string  accountId,
string  templateId,
EnvelopeDefinition  envelopeDefinition = null 
)
inline

Deletes documents from a template. Deletes one or more documents from an existing template.

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
templateIdThe ID of the template being accessed.
envelopeDefinition(optional)
Returns
Task of TemplateDocumentsResult

Implements DocuSign.eSign.Api.ITemplatesApi.

◆ DeleteDocumentsAsyncWithHttpInfo()

async System.Threading.Tasks.Task<ApiResponse<TemplateDocumentsResult> > DocuSign.eSign.Api.TemplatesApi.DeleteDocumentsAsyncWithHttpInfo ( string  accountId,
string  templateId,
EnvelopeDefinition  envelopeDefinition = null 
)
inline

Deletes documents from a template. Deletes one or more documents from an existing template.

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
templateIdThe ID of the template being accessed.
envelopeDefinition(optional)
Returns
Task of ApiResponse (TemplateDocumentsResult)

Implements DocuSign.eSign.Api.ITemplatesApi.

◆ DeleteDocumentsWithHttpInfo()

ApiResponse<TemplateDocumentsResult> DocuSign.eSign.Api.TemplatesApi.DeleteDocumentsWithHttpInfo ( string  accountId,
string  templateId,
EnvelopeDefinition  envelopeDefinition = null 
)
inline

Deletes documents from a template. Deletes one or more documents from an existing template.

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
templateIdThe ID of the template being accessed.
envelopeDefinition(optional)
Returns
ApiResponse of TemplateDocumentsResult

Implements DocuSign.eSign.Api.ITemplatesApi.

◆ DeleteGroupShare()

GroupInformation DocuSign.eSign.Api.TemplatesApi.DeleteGroupShare ( string  accountId,
string  templateId,
string  templatePart,
GroupInformation  groupInformation = null 
)
inline

Removes a member group&#39;s sharing permissions for a template. Removes a member group&#39;s sharing permissions for a specified template.

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
templateIdThe ID of the template being accessed.
templatePartCurrently, the only defined part is groups.
groupInformation(optional)
Returns
GroupInformation

Implements DocuSign.eSign.Api.ITemplatesApi.

◆ DeleteGroupShareAsync()

async System.Threading.Tasks.Task<GroupInformation> DocuSign.eSign.Api.TemplatesApi.DeleteGroupShareAsync ( string  accountId,
string  templateId,
string  templatePart,
GroupInformation  groupInformation = null 
)
inline

Removes a member group&#39;s sharing permissions for a template. Removes a member group&#39;s sharing permissions for a specified template.

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
templateIdThe ID of the template being accessed.
templatePartCurrently, the only defined part is groups.
groupInformation(optional)
Returns
Task of GroupInformation

Implements DocuSign.eSign.Api.ITemplatesApi.

◆ DeleteGroupShareAsyncWithHttpInfo()

async System.Threading.Tasks.Task<ApiResponse<GroupInformation> > DocuSign.eSign.Api.TemplatesApi.DeleteGroupShareAsyncWithHttpInfo ( string  accountId,
string  templateId,
string  templatePart,
GroupInformation  groupInformation = null 
)
inline

Removes a member group&#39;s sharing permissions for a template. Removes a member group&#39;s sharing permissions for a specified template.

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
templateIdThe ID of the template being accessed.
templatePartCurrently, the only defined part is groups.
groupInformation(optional)
Returns
Task of ApiResponse (GroupInformation)

Implements DocuSign.eSign.Api.ITemplatesApi.

◆ DeleteGroupShareWithHttpInfo()

ApiResponse<GroupInformation> DocuSign.eSign.Api.TemplatesApi.DeleteGroupShareWithHttpInfo ( string  accountId,
string  templateId,
string  templatePart,
GroupInformation  groupInformation = null 
)
inline

Removes a member group&#39;s sharing permissions for a template. Removes a member group&#39;s sharing permissions for a specified template.

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
templateIdThe ID of the template being accessed.
templatePartCurrently, the only defined part is groups.
groupInformation(optional)
Returns
ApiResponse of GroupInformation

Implements DocuSign.eSign.Api.ITemplatesApi.

◆ DeleteLock()

LockInformation DocuSign.eSign.Api.TemplatesApi.DeleteLock ( string  accountId,
string  templateId,
LockRequest  lockRequest = null 
)
inline

Deletes a template lock. Deletes the lock from the specified template. The &#x60;X-DocuSign-Edit&#x60; header must be included in the request.

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
templateIdThe ID of the template being accessed.
lockRequest(optional)
Returns
LockInformation

Implements DocuSign.eSign.Api.ITemplatesApi.

◆ DeleteLockAsync()

async System.Threading.Tasks.Task<LockInformation> DocuSign.eSign.Api.TemplatesApi.DeleteLockAsync ( string  accountId,
string  templateId,
LockRequest  lockRequest = null 
)
inline

Deletes a template lock. Deletes the lock from the specified template. The &#x60;X-DocuSign-Edit&#x60; header must be included in the request.

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
templateIdThe ID of the template being accessed.
lockRequest(optional)
Returns
Task of LockInformation

Implements DocuSign.eSign.Api.ITemplatesApi.

◆ DeleteLockAsyncWithHttpInfo()

async System.Threading.Tasks.Task<ApiResponse<LockInformation> > DocuSign.eSign.Api.TemplatesApi.DeleteLockAsyncWithHttpInfo ( string  accountId,
string  templateId,
LockRequest  lockRequest = null 
)
inline

Deletes a template lock. Deletes the lock from the specified template. The &#x60;X-DocuSign-Edit&#x60; header must be included in the request.

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
templateIdThe ID of the template being accessed.
lockRequest(optional)
Returns
Task of ApiResponse (LockInformation)

Implements DocuSign.eSign.Api.ITemplatesApi.

◆ DeleteLockWithHttpInfo()

ApiResponse<LockInformation> DocuSign.eSign.Api.TemplatesApi.DeleteLockWithHttpInfo ( string  accountId,
string  templateId,
LockRequest  lockRequest = null 
)
inline

Deletes a template lock. Deletes the lock from the specified template. The &#x60;X-DocuSign-Edit&#x60; header must be included in the request.

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
templateIdThe ID of the template being accessed.
lockRequest(optional)
Returns
ApiResponse of LockInformation

Implements DocuSign.eSign.Api.ITemplatesApi.

◆ DeleteRecipient()

Recipients DocuSign.eSign.Api.TemplatesApi.DeleteRecipient ( string  accountId,
string  templateId,
string  recipientId,
TemplateRecipients  templateRecipients = null 
)
inline

Deletes the specified recipient file from a template. Deletes the specified recipient file from the specified template.

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
templateIdThe ID of the template being accessed.
recipientIdThe ID of the recipient being accessed.
templateRecipients(optional)
Returns
Recipients

Implements DocuSign.eSign.Api.ITemplatesApi.

◆ DeleteRecipientAsync()

async System.Threading.Tasks.Task<Recipients> DocuSign.eSign.Api.TemplatesApi.DeleteRecipientAsync ( string  accountId,
string  templateId,
string  recipientId,
TemplateRecipients  templateRecipients = null 
)
inline

Deletes the specified recipient file from a template. Deletes the specified recipient file from the specified template.

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
templateIdThe ID of the template being accessed.
recipientIdThe ID of the recipient being accessed.
templateRecipients(optional)
Returns
Task of Recipients

Implements DocuSign.eSign.Api.ITemplatesApi.

◆ DeleteRecipientAsyncWithHttpInfo()

async System.Threading.Tasks.Task<ApiResponse<Recipients> > DocuSign.eSign.Api.TemplatesApi.DeleteRecipientAsyncWithHttpInfo ( string  accountId,
string  templateId,
string  recipientId,
TemplateRecipients  templateRecipients = null 
)
inline

Deletes the specified recipient file from a template. Deletes the specified recipient file from the specified template.

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
templateIdThe ID of the template being accessed.
recipientIdThe ID of the recipient being accessed.
templateRecipients(optional)
Returns
Task of ApiResponse (Recipients)

Implements DocuSign.eSign.Api.ITemplatesApi.

◆ DeleteRecipients()

Recipients DocuSign.eSign.Api.TemplatesApi.DeleteRecipients ( string  accountId,
string  templateId,
TemplateRecipients  templateRecipients = null 
)
inline

Deletes recipients from a template. Deletes one or more recipients from a template. Recipients to be deleted are listed in the request, with the &#x60;recipientId&#x60; being used as the key for deleting recipients.

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
templateIdThe ID of the template being accessed.
templateRecipients(optional)
Returns
Recipients

Implements DocuSign.eSign.Api.ITemplatesApi.

◆ DeleteRecipientsAsync()

async System.Threading.Tasks.Task<Recipients> DocuSign.eSign.Api.TemplatesApi.DeleteRecipientsAsync ( string  accountId,
string  templateId,
TemplateRecipients  templateRecipients = null 
)
inline

Deletes recipients from a template. Deletes one or more recipients from a template. Recipients to be deleted are listed in the request, with the &#x60;recipientId&#x60; being used as the key for deleting recipients.

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
templateIdThe ID of the template being accessed.
templateRecipients(optional)
Returns
Task of Recipients

Implements DocuSign.eSign.Api.ITemplatesApi.

◆ DeleteRecipientsAsyncWithHttpInfo()

async System.Threading.Tasks.Task<ApiResponse<Recipients> > DocuSign.eSign.Api.TemplatesApi.DeleteRecipientsAsyncWithHttpInfo ( string  accountId,
string  templateId,
TemplateRecipients  templateRecipients = null 
)
inline

Deletes recipients from a template. Deletes one or more recipients from a template. Recipients to be deleted are listed in the request, with the &#x60;recipientId&#x60; being used as the key for deleting recipients.

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
templateIdThe ID of the template being accessed.
templateRecipients(optional)
Returns
Task of ApiResponse (Recipients)

Implements DocuSign.eSign.Api.ITemplatesApi.

◆ DeleteRecipientsWithHttpInfo()

ApiResponse<Recipients> DocuSign.eSign.Api.TemplatesApi.DeleteRecipientsWithHttpInfo ( string  accountId,
string  templateId,
TemplateRecipients  templateRecipients = null 
)
inline

Deletes recipients from a template. Deletes one or more recipients from a template. Recipients to be deleted are listed in the request, with the &#x60;recipientId&#x60; being used as the key for deleting recipients.

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
templateIdThe ID of the template being accessed.
templateRecipients(optional)
Returns
ApiResponse of Recipients

Implements DocuSign.eSign.Api.ITemplatesApi.

◆ DeleteRecipientWithHttpInfo()

ApiResponse<Recipients> DocuSign.eSign.Api.TemplatesApi.DeleteRecipientWithHttpInfo ( string  accountId,
string  templateId,
string  recipientId,
TemplateRecipients  templateRecipients = null 
)
inline

Deletes the specified recipient file from a template. Deletes the specified recipient file from the specified template.

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
templateIdThe ID of the template being accessed.
recipientIdThe ID of the recipient being accessed.
templateRecipients(optional)
Returns
ApiResponse of Recipients

Implements DocuSign.eSign.Api.ITemplatesApi.

◆ DeleteTabs()

Tabs DocuSign.eSign.Api.TemplatesApi.DeleteTabs ( string  accountId,
string  templateId,
string  recipientId,
TemplateTabs  templateTabs = null 
)
inline

Deletes the tabs associated with a recipient in a template. Deletes one or more tabs associated with a recipient in a template.

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
templateIdThe ID of the template being accessed.
recipientIdThe ID of the recipient being accessed.
templateTabs(optional)
Returns
Tabs

Implements DocuSign.eSign.Api.ITemplatesApi.

◆ DeleteTabsAsync()

async System.Threading.Tasks.Task<Tabs> DocuSign.eSign.Api.TemplatesApi.DeleteTabsAsync ( string  accountId,
string  templateId,
string  recipientId,
TemplateTabs  templateTabs = null 
)
inline

Deletes the tabs associated with a recipient in a template. Deletes one or more tabs associated with a recipient in a template.

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
templateIdThe ID of the template being accessed.
recipientIdThe ID of the recipient being accessed.
templateTabs(optional)
Returns
Task of Tabs

Implements DocuSign.eSign.Api.ITemplatesApi.

◆ DeleteTabsAsyncWithHttpInfo()

async System.Threading.Tasks.Task<ApiResponse<Tabs> > DocuSign.eSign.Api.TemplatesApi.DeleteTabsAsyncWithHttpInfo ( string  accountId,
string  templateId,
string  recipientId,
TemplateTabs  templateTabs = null 
)
inline

Deletes the tabs associated with a recipient in a template. Deletes one or more tabs associated with a recipient in a template.

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
templateIdThe ID of the template being accessed.
recipientIdThe ID of the recipient being accessed.
templateTabs(optional)
Returns
Task of ApiResponse (Tabs)

Implements DocuSign.eSign.Api.ITemplatesApi.

◆ DeleteTabsWithHttpInfo()

ApiResponse<Tabs> DocuSign.eSign.Api.TemplatesApi.DeleteTabsWithHttpInfo ( string  accountId,
string  templateId,
string  recipientId,
TemplateTabs  templateTabs = null 
)
inline

Deletes the tabs associated with a recipient in a template. Deletes one or more tabs associated with a recipient in a template.

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
templateIdThe ID of the template being accessed.
recipientIdThe ID of the recipient being accessed.
templateTabs(optional)
Returns
ApiResponse of Tabs

Implements DocuSign.eSign.Api.ITemplatesApi.

◆ DeleteTemplateDocumentTabs()

Tabs DocuSign.eSign.Api.TemplatesApi.DeleteTemplateDocumentTabs ( string  accountId,
string  templateId,
string  documentId,
TemplateTabs  templateTabs = null 
)
inline

Deletes tabs from an envelope document Deletes tabs from the document specified by &#x60;documentId&#x60; in the template specified by &#x60;templateId&#x60;.

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
templateIdThe ID of the template being accessed.
documentIdThe ID of the document being accessed.
templateTabs(optional)
Returns
Tabs

Implements DocuSign.eSign.Api.ITemplatesApi.

◆ DeleteTemplateDocumentTabsAsync()

async System.Threading.Tasks.Task<Tabs> DocuSign.eSign.Api.TemplatesApi.DeleteTemplateDocumentTabsAsync ( string  accountId,
string  templateId,
string  documentId,
TemplateTabs  templateTabs = null 
)
inline

Deletes tabs from an envelope document Deletes tabs from the document specified by &#x60;documentId&#x60; in the template specified by &#x60;templateId&#x60;.

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
templateIdThe ID of the template being accessed.
documentIdThe ID of the document being accessed.
templateTabs(optional)
Returns
Task of Tabs

Implements DocuSign.eSign.Api.ITemplatesApi.

◆ DeleteTemplateDocumentTabsAsyncWithHttpInfo()

async System.Threading.Tasks.Task<ApiResponse<Tabs> > DocuSign.eSign.Api.TemplatesApi.DeleteTemplateDocumentTabsAsyncWithHttpInfo ( string  accountId,
string  templateId,
string  documentId,
TemplateTabs  templateTabs = null 
)
inline

Deletes tabs from an envelope document Deletes tabs from the document specified by &#x60;documentId&#x60; in the template specified by &#x60;templateId&#x60;.

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
templateIdThe ID of the template being accessed.
documentIdThe ID of the document being accessed.
templateTabs(optional)
Returns
Task of ApiResponse (Tabs)

Implements DocuSign.eSign.Api.ITemplatesApi.

◆ DeleteTemplateDocumentTabsWithHttpInfo()

ApiResponse<Tabs> DocuSign.eSign.Api.TemplatesApi.DeleteTemplateDocumentTabsWithHttpInfo ( string  accountId,
string  templateId,
string  documentId,
TemplateTabs  templateTabs = null 
)
inline

Deletes tabs from an envelope document Deletes tabs from the document specified by &#x60;documentId&#x60; in the template specified by &#x60;templateId&#x60;.

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
templateIdThe ID of the template being accessed.
documentIdThe ID of the document being accessed.
templateTabs(optional)
Returns
ApiResponse of Tabs

Implements DocuSign.eSign.Api.ITemplatesApi.

◆ Get()

EnvelopeTemplate DocuSign.eSign.Api.TemplatesApi.Get ( string  accountId,
string  templateId,
TemplatesApi.GetOptions  options = null 
)
inline

Gets a list of templates for a specified account. Retrieves the definition of the specified template.

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
templateIdThe ID of the template being accessed.
optionsOptions for modifying the behavior of the function.
Returns
EnvelopeTemplate

◆ GetAsync()

async System.Threading.Tasks.Task<EnvelopeTemplate> DocuSign.eSign.Api.TemplatesApi.GetAsync ( string  accountId,
string  templateId,
TemplatesApi.GetOptions  options = null 
)
inline

Gets a list of templates for a specified account. Retrieves the definition of the specified template.

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
templateIdThe ID of the template being accessed.
optionsOptions for modifying the behavior of the function.
Returns
Task of EnvelopeTemplate

◆ GetAsyncWithHttpInfo()

async System.Threading.Tasks.Task<ApiResponse<EnvelopeTemplate> > DocuSign.eSign.Api.TemplatesApi.GetAsyncWithHttpInfo ( string  accountId,
string  templateId,
TemplatesApi.GetOptions  options = null 
)
inline

Gets a list of templates for a specified account. Retrieves the definition of the specified template.

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
templateIdThe ID of the template being accessed.
optionsOptions for modifying the behavior of the function.
Returns
Task of ApiResponse (EnvelopeTemplate)

◆ GetBasePath()

String DocuSign.eSign.Api.TemplatesApi.GetBasePath ( )
inline

Gets the base path of the API client.

The base path

Implements DocuSign.eSign.Client.IApiAccessor.

◆ GetDocument()

System.IO.Stream DocuSign.eSign.Api.TemplatesApi.GetDocument ( string  accountId,
string  templateId,
string  documentId,
TemplatesApi.GetDocumentOptions  options = null 
)
inline

Gets PDF documents from a template. Retrieves one or more PDF documents from the specified template. You can specify the ID of the document to retrieve or can specify &#x60;combined&#x60; to retrieve all documents in the template as one pdf.

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
templateIdThe ID of the template being accessed.
documentIdThe ID of the document being accessed.
optionsOptions for modifying the behavior of the function.
Returns
System.IO.Stream

◆ GetDocumentAsync()

async System.Threading.Tasks.Task<System.IO.Stream> DocuSign.eSign.Api.TemplatesApi.GetDocumentAsync ( string  accountId,
string  templateId,
string  documentId,
TemplatesApi.GetDocumentOptions  options = null 
)
inline

Gets PDF documents from a template. Retrieves one or more PDF documents from the specified template. You can specify the ID of the document to retrieve or can specify &#x60;combined&#x60; to retrieve all documents in the template as one pdf.

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
templateIdThe ID of the template being accessed.
documentIdThe ID of the document being accessed.
optionsOptions for modifying the behavior of the function.
Returns
Task of System.IO.Stream

◆ GetDocumentAsyncWithHttpInfo()

async System.Threading.Tasks.Task<ApiResponse<System.IO.Stream> > DocuSign.eSign.Api.TemplatesApi.GetDocumentAsyncWithHttpInfo ( string  accountId,
string  templateId,
string  documentId,
TemplatesApi.GetDocumentOptions  options = null 
)
inline

Gets PDF documents from a template. Retrieves one or more PDF documents from the specified template. You can specify the ID of the document to retrieve or can specify &#x60;combined&#x60; to retrieve all documents in the template as one pdf.

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
templateIdThe ID of the template being accessed.
documentIdThe ID of the document being accessed.
optionsOptions for modifying the behavior of the function.
Returns
Task of ApiResponse (System.IO.Stream)

◆ GetDocumentPageImage()

System.IO.Stream DocuSign.eSign.Api.TemplatesApi.GetDocumentPageImage ( string  accountId,
string  templateId,
string  documentId,
string  pageNumber,
TemplatesApi.GetDocumentPageImageOptions  options = null 
)
inline

Gets a page image from a template for display. Retrieves a page image for display from the specified template.

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
templateIdThe ID of the template being accessed.
documentIdThe ID of the document being accessed.
pageNumberThe page number being accessed.
optionsOptions for modifying the behavior of the function.
Returns
System.IO.Stream

◆ GetDocumentPageImageAsync()

async System.Threading.Tasks.Task<System.IO.Stream> DocuSign.eSign.Api.TemplatesApi.GetDocumentPageImageAsync ( string  accountId,
string  templateId,
string  documentId,
string  pageNumber,
TemplatesApi.GetDocumentPageImageOptions  options = null 
)
inline

Gets a page image from a template for display. Retrieves a page image for display from the specified template.

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
templateIdThe ID of the template being accessed.
documentIdThe ID of the document being accessed.
pageNumberThe page number being accessed.
optionsOptions for modifying the behavior of the function.
Returns
Task of System.IO.Stream

◆ GetDocumentPageImageAsyncWithHttpInfo()

async System.Threading.Tasks.Task<ApiResponse<System.IO.Stream> > DocuSign.eSign.Api.TemplatesApi.GetDocumentPageImageAsyncWithHttpInfo ( string  accountId,
string  templateId,
string  documentId,
string  pageNumber,
TemplatesApi.GetDocumentPageImageOptions  options = null 
)
inline

Gets a page image from a template for display. Retrieves a page image for display from the specified template.

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
templateIdThe ID of the template being accessed.
documentIdThe ID of the document being accessed.
pageNumberThe page number being accessed.
optionsOptions for modifying the behavior of the function.
Returns
Task of ApiResponse (System.IO.Stream)

◆ GetDocumentPageImageWithHttpInfo()

ApiResponse<System.IO.Stream> DocuSign.eSign.Api.TemplatesApi.GetDocumentPageImageWithHttpInfo ( string  accountId,
string  templateId,
string  documentId,
string  pageNumber,
TemplatesApi.GetDocumentPageImageOptions  options = null 
)
inline

Gets a page image from a template for display. Retrieves a page image for display from the specified template.

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
templateIdThe ID of the template being accessed.
documentIdThe ID of the document being accessed.
pageNumberThe page number being accessed.
optionsOptions for modifying the behavior of the function.
Returns
ApiResponse of System.IO.Stream

◆ GetDocumentTabs()

Tabs DocuSign.eSign.Api.TemplatesApi.GetDocumentTabs ( string  accountId,
string  templateId,
string  documentId,
TemplatesApi.GetDocumentTabsOptions  options = null 
)
inline

Returns tabs on the document. Returns the tabs on the document specified by &#x60;documentId&#x60; in the template specified by &#x60;templateId&#x60;.

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
templateIdThe ID of the template being accessed.
documentIdThe ID of the document being accessed.
optionsOptions for modifying the behavior of the function.
Returns
Tabs

◆ GetDocumentTabsAsync()

async System.Threading.Tasks.Task<Tabs> DocuSign.eSign.Api.TemplatesApi.GetDocumentTabsAsync ( string  accountId,
string  templateId,
string  documentId,
TemplatesApi.GetDocumentTabsOptions  options = null 
)
inline

Returns tabs on the document. Returns the tabs on the document specified by &#x60;documentId&#x60; in the template specified by &#x60;templateId&#x60;.

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
templateIdThe ID of the template being accessed.
documentIdThe ID of the document being accessed.
optionsOptions for modifying the behavior of the function.
Returns
Task of Tabs

◆ GetDocumentTabsAsyncWithHttpInfo()

async System.Threading.Tasks.Task<ApiResponse<Tabs> > DocuSign.eSign.Api.TemplatesApi.GetDocumentTabsAsyncWithHttpInfo ( string  accountId,
string  templateId,
string  documentId,
TemplatesApi.GetDocumentTabsOptions  options = null 
)
inline

Returns tabs on the document. Returns the tabs on the document specified by &#x60;documentId&#x60; in the template specified by &#x60;templateId&#x60;.

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
templateIdThe ID of the template being accessed.
documentIdThe ID of the document being accessed.
optionsOptions for modifying the behavior of the function.
Returns
Task of ApiResponse (Tabs)

◆ GetDocumentTabsWithHttpInfo()

ApiResponse<Tabs> DocuSign.eSign.Api.TemplatesApi.GetDocumentTabsWithHttpInfo ( string  accountId,
string  templateId,
string  documentId,
TemplatesApi.GetDocumentTabsOptions  options = null 
)
inline

Returns tabs on the document. Returns the tabs on the document specified by &#x60;documentId&#x60; in the template specified by &#x60;templateId&#x60;.

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
templateIdThe ID of the template being accessed.
documentIdThe ID of the document being accessed.
optionsOptions for modifying the behavior of the function.
Returns
ApiResponse of Tabs

◆ GetDocumentWithHttpInfo()

ApiResponse<System.IO.Stream> DocuSign.eSign.Api.TemplatesApi.GetDocumentWithHttpInfo ( string  accountId,
string  templateId,
string  documentId,
TemplatesApi.GetDocumentOptions  options = null 
)
inline

Gets PDF documents from a template. Retrieves one or more PDF documents from the specified template. You can specify the ID of the document to retrieve or can specify &#x60;combined&#x60; to retrieve all documents in the template as one pdf.

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
templateIdThe ID of the template being accessed.
documentIdThe ID of the document being accessed.
optionsOptions for modifying the behavior of the function.
Returns
ApiResponse of System.IO.Stream

◆ GetLock()

LockInformation DocuSign.eSign.Api.TemplatesApi.GetLock ( string  accountId,
string  templateId 
)
inline

Gets template lock information. Retrieves general information about the template lock. If the call is made by the user who has the lock and the request has the same integrator key as original, then the &#x60;X-DocuSign-Edit&#x60; header field and additional lock information is included in the response. This allows users to recover a lost editing session token and the &#x60;X-DocuSign-Edit&#x60; header.

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
templateIdThe ID of the template being accessed.
Returns
LockInformation

Implements DocuSign.eSign.Api.ITemplatesApi.

◆ GetLockAsync()

async System.Threading.Tasks.Task<LockInformation> DocuSign.eSign.Api.TemplatesApi.GetLockAsync ( string  accountId,
string  templateId 
)
inline

Gets template lock information. Retrieves general information about the template lock. If the call is made by the user who has the lock and the request has the same integrator key as original, then the &#x60;X-DocuSign-Edit&#x60; header field and additional lock information is included in the response. This allows users to recover a lost editing session token and the &#x60;X-DocuSign-Edit&#x60; header.

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
templateIdThe ID of the template being accessed.
Returns
Task of LockInformation

Implements DocuSign.eSign.Api.ITemplatesApi.

◆ GetLockAsyncWithHttpInfo()

async System.Threading.Tasks.Task<ApiResponse<LockInformation> > DocuSign.eSign.Api.TemplatesApi.GetLockAsyncWithHttpInfo ( string  accountId,
string  templateId 
)
inline

Gets template lock information. Retrieves general information about the template lock. If the call is made by the user who has the lock and the request has the same integrator key as original, then the &#x60;X-DocuSign-Edit&#x60; header field and additional lock information is included in the response. This allows users to recover a lost editing session token and the &#x60;X-DocuSign-Edit&#x60; header.

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
templateIdThe ID of the template being accessed.
Returns
Task of ApiResponse (LockInformation)

Implements DocuSign.eSign.Api.ITemplatesApi.

◆ GetLockWithHttpInfo()

ApiResponse<LockInformation> DocuSign.eSign.Api.TemplatesApi.GetLockWithHttpInfo ( string  accountId,
string  templateId 
)
inline

Gets template lock information. Retrieves general information about the template lock. If the call is made by the user who has the lock and the request has the same integrator key as original, then the &#x60;X-DocuSign-Edit&#x60; header field and additional lock information is included in the response. This allows users to recover a lost editing session token and the &#x60;X-DocuSign-Edit&#x60; header.

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
templateIdThe ID of the template being accessed.
Returns
ApiResponse of LockInformation

Implements DocuSign.eSign.Api.ITemplatesApi.

◆ GetNotificationSettings()

Notification DocuSign.eSign.Api.TemplatesApi.GetNotificationSettings ( string  accountId,
string  templateId 
)
inline

Gets template notification information. Retrieves the envelope notification, reminders and expirations, information for an existing template.

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
templateIdThe ID of the template being accessed.
Returns
Notification

Implements DocuSign.eSign.Api.ITemplatesApi.

◆ GetNotificationSettingsAsync()

async System.Threading.Tasks.Task<Notification> DocuSign.eSign.Api.TemplatesApi.GetNotificationSettingsAsync ( string  accountId,
string  templateId 
)
inline

Gets template notification information. Retrieves the envelope notification, reminders and expirations, information for an existing template.

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
templateIdThe ID of the template being accessed.
Returns
Task of Notification

Implements DocuSign.eSign.Api.ITemplatesApi.

◆ GetNotificationSettingsAsyncWithHttpInfo()

async System.Threading.Tasks.Task<ApiResponse<Notification> > DocuSign.eSign.Api.TemplatesApi.GetNotificationSettingsAsyncWithHttpInfo ( string  accountId,
string  templateId 
)
inline

Gets template notification information. Retrieves the envelope notification, reminders and expirations, information for an existing template.

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
templateIdThe ID of the template being accessed.
Returns
Task of ApiResponse (Notification)

Implements DocuSign.eSign.Api.ITemplatesApi.

◆ GetNotificationSettingsWithHttpInfo()

ApiResponse<Notification> DocuSign.eSign.Api.TemplatesApi.GetNotificationSettingsWithHttpInfo ( string  accountId,
string  templateId 
)
inline

Gets template notification information. Retrieves the envelope notification, reminders and expirations, information for an existing template.

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
templateIdThe ID of the template being accessed.
Returns
ApiResponse of Notification

Implements DocuSign.eSign.Api.ITemplatesApi.

◆ GetPages()

PageImages DocuSign.eSign.Api.TemplatesApi.GetPages ( string  accountId,
string  templateId,
string  documentId,
TemplatesApi.GetPagesOptions  options = null 
)
inline

Returns document page image(s) based on input. Returns images of the pages in a template document for display based on the parameters that you specify.

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
templateIdThe ID of the template being accessed.
documentIdThe ID of the document being accessed.
optionsOptions for modifying the behavior of the function.
Returns
PageImages

◆ GetPagesAsync()

async System.Threading.Tasks.Task<PageImages> DocuSign.eSign.Api.TemplatesApi.GetPagesAsync ( string  accountId,
string  templateId,
string  documentId,
TemplatesApi.GetPagesOptions  options = null 
)
inline

Returns document page image(s) based on input. Returns images of the pages in a template document for display based on the parameters that you specify.

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
templateIdThe ID of the template being accessed.
documentIdThe ID of the document being accessed.
optionsOptions for modifying the behavior of the function.
Returns
Task of PageImages

◆ GetPagesAsyncWithHttpInfo()

async System.Threading.Tasks.Task<ApiResponse<PageImages> > DocuSign.eSign.Api.TemplatesApi.GetPagesAsyncWithHttpInfo ( string  accountId,
string  templateId,
string  documentId,
TemplatesApi.GetPagesOptions  options = null 
)
inline

Returns document page image(s) based on input. Returns images of the pages in a template document for display based on the parameters that you specify.

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
templateIdThe ID of the template being accessed.
documentIdThe ID of the document being accessed.
optionsOptions for modifying the behavior of the function.
Returns
Task of ApiResponse (PageImages)

◆ GetPagesWithHttpInfo()

ApiResponse<PageImages> DocuSign.eSign.Api.TemplatesApi.GetPagesWithHttpInfo ( string  accountId,
string  templateId,
string  documentId,
TemplatesApi.GetPagesOptions  options = null 
)
inline

Returns document page image(s) based on input. Returns images of the pages in a template document for display based on the parameters that you specify.

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
templateIdThe ID of the template being accessed.
documentIdThe ID of the document being accessed.
optionsOptions for modifying the behavior of the function.
Returns
ApiResponse of PageImages

◆ GetPageTabs()

Tabs DocuSign.eSign.Api.TemplatesApi.GetPageTabs ( string  accountId,
string  templateId,
string  documentId,
string  pageNumber 
)
inline

Returns tabs on the specified page. Returns the tabs from the page specified by &#x60;pageNumber&#x60; of the document specified by &#x60;documentId&#x60; in the template specified by &#x60;templateId&#x60;.

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
templateIdThe ID of the template being accessed.
documentIdThe ID of the document being accessed.
pageNumberThe page number being accessed.
Returns
Tabs

Implements DocuSign.eSign.Api.ITemplatesApi.

◆ GetPageTabsAsync()

async System.Threading.Tasks.Task<Tabs> DocuSign.eSign.Api.TemplatesApi.GetPageTabsAsync ( string  accountId,
string  templateId,
string  documentId,
string  pageNumber 
)
inline

Returns tabs on the specified page. Returns the tabs from the page specified by &#x60;pageNumber&#x60; of the document specified by &#x60;documentId&#x60; in the template specified by &#x60;templateId&#x60;.

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
templateIdThe ID of the template being accessed.
documentIdThe ID of the document being accessed.
pageNumberThe page number being accessed.
Returns
Task of Tabs

Implements DocuSign.eSign.Api.ITemplatesApi.

◆ GetPageTabsAsyncWithHttpInfo()

async System.Threading.Tasks.Task<ApiResponse<Tabs> > DocuSign.eSign.Api.TemplatesApi.GetPageTabsAsyncWithHttpInfo ( string  accountId,
string  templateId,
string  documentId,
string  pageNumber 
)
inline

Returns tabs on the specified page. Returns the tabs from the page specified by &#x60;pageNumber&#x60; of the document specified by &#x60;documentId&#x60; in the template specified by &#x60;templateId&#x60;.

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
templateIdThe ID of the template being accessed.
documentIdThe ID of the document being accessed.
pageNumberThe page number being accessed.
Returns
Task of ApiResponse (Tabs)

Implements DocuSign.eSign.Api.ITemplatesApi.

◆ GetPageTabsWithHttpInfo()

ApiResponse<Tabs> DocuSign.eSign.Api.TemplatesApi.GetPageTabsWithHttpInfo ( string  accountId,
string  templateId,
string  documentId,
string  pageNumber 
)
inline

Returns tabs on the specified page. Returns the tabs from the page specified by &#x60;pageNumber&#x60; of the document specified by &#x60;documentId&#x60; in the template specified by &#x60;templateId&#x60;.

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
templateIdThe ID of the template being accessed.
documentIdThe ID of the document being accessed.
pageNumberThe page number being accessed.
Returns
ApiResponse of Tabs

Implements DocuSign.eSign.Api.ITemplatesApi.

◆ GetTemplateDocumentHtmlDefinitions()

DocumentHtmlDefinitionOriginals DocuSign.eSign.Api.TemplatesApi.GetTemplateDocumentHtmlDefinitions ( string  accountId,
string  templateId,
string  documentId 
)
inline

Get the Original HTML Definition used to generate the Responsive HTML for a given document in a template.

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
templateIdThe ID of the template being accessed.
documentIdThe ID of the document being accessed.
Returns
DocumentHtmlDefinitionOriginals

Implements DocuSign.eSign.Api.ITemplatesApi.

◆ GetTemplateDocumentHtmlDefinitionsAsync()

async System.Threading.Tasks.Task<DocumentHtmlDefinitionOriginals> DocuSign.eSign.Api.TemplatesApi.GetTemplateDocumentHtmlDefinitionsAsync ( string  accountId,
string  templateId,
string  documentId 
)
inline

Get the Original HTML Definition used to generate the Responsive HTML for a given document in a template.

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
templateIdThe ID of the template being accessed.
documentIdThe ID of the document being accessed.
Returns
Task of DocumentHtmlDefinitionOriginals

Implements DocuSign.eSign.Api.ITemplatesApi.

◆ GetTemplateDocumentHtmlDefinitionsAsyncWithHttpInfo()

async System.Threading.Tasks.Task<ApiResponse<DocumentHtmlDefinitionOriginals> > DocuSign.eSign.Api.TemplatesApi.GetTemplateDocumentHtmlDefinitionsAsyncWithHttpInfo ( string  accountId,
string  templateId,
string  documentId 
)
inline

Get the Original HTML Definition used to generate the Responsive HTML for a given document in a template.

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
templateIdThe ID of the template being accessed.
documentIdThe ID of the document being accessed.
Returns
Task of ApiResponse (DocumentHtmlDefinitionOriginals)

Implements DocuSign.eSign.Api.ITemplatesApi.

◆ GetTemplateDocumentHtmlDefinitionsWithHttpInfo()

ApiResponse<DocumentHtmlDefinitionOriginals> DocuSign.eSign.Api.TemplatesApi.GetTemplateDocumentHtmlDefinitionsWithHttpInfo ( string  accountId,
string  templateId,
string  documentId 
)
inline

Get the Original HTML Definition used to generate the Responsive HTML for a given document in a template.

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
templateIdThe ID of the template being accessed.
documentIdThe ID of the document being accessed.
Returns
ApiResponse of DocumentHtmlDefinitionOriginals

Implements DocuSign.eSign.Api.ITemplatesApi.

◆ GetTemplateHtmlDefinitions()

DocumentHtmlDefinitionOriginals DocuSign.eSign.Api.TemplatesApi.GetTemplateHtmlDefinitions ( string  accountId,
string  templateId 
)
inline

Get the Original HTML Definition used to generate the Responsive HTML for the template.

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
templateIdThe ID of the template being accessed.
Returns
DocumentHtmlDefinitionOriginals

Implements DocuSign.eSign.Api.ITemplatesApi.

◆ GetTemplateHtmlDefinitionsAsync()

async System.Threading.Tasks.Task<DocumentHtmlDefinitionOriginals> DocuSign.eSign.Api.TemplatesApi.GetTemplateHtmlDefinitionsAsync ( string  accountId,
string  templateId 
)
inline

Get the Original HTML Definition used to generate the Responsive HTML for the template.

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
templateIdThe ID of the template being accessed.
Returns
Task of DocumentHtmlDefinitionOriginals

Implements DocuSign.eSign.Api.ITemplatesApi.

◆ GetTemplateHtmlDefinitionsAsyncWithHttpInfo()

async System.Threading.Tasks.Task<ApiResponse<DocumentHtmlDefinitionOriginals> > DocuSign.eSign.Api.TemplatesApi.GetTemplateHtmlDefinitionsAsyncWithHttpInfo ( string  accountId,
string  templateId 
)
inline

Get the Original HTML Definition used to generate the Responsive HTML for the template.

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
templateIdThe ID of the template being accessed.
Returns
Task of ApiResponse (DocumentHtmlDefinitionOriginals)

Implements DocuSign.eSign.Api.ITemplatesApi.

◆ GetTemplateHtmlDefinitionsWithHttpInfo()

ApiResponse<DocumentHtmlDefinitionOriginals> DocuSign.eSign.Api.TemplatesApi.GetTemplateHtmlDefinitionsWithHttpInfo ( string  accountId,
string  templateId 
)
inline

Get the Original HTML Definition used to generate the Responsive HTML for the template.

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
templateIdThe ID of the template being accessed.
Returns
ApiResponse of DocumentHtmlDefinitionOriginals

Implements DocuSign.eSign.Api.ITemplatesApi.

◆ GetWithHttpInfo()

ApiResponse<EnvelopeTemplate> DocuSign.eSign.Api.TemplatesApi.GetWithHttpInfo ( string  accountId,
string  templateId,
TemplatesApi.GetOptions  options = null 
)
inline

Gets a list of templates for a specified account. Retrieves the definition of the specified template.

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
templateIdThe ID of the template being accessed.
optionsOptions for modifying the behavior of the function.
Returns
ApiResponse of EnvelopeTemplate

◆ ListCustomFields()

CustomFields DocuSign.eSign.Api.TemplatesApi.ListCustomFields ( string  accountId,
string  templateId 
)
inline

Gets the custom document fields from a template. Retrieves the custom document field information from an existing template.

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
templateIdThe ID of the template being accessed.
Returns
CustomFields

Implements DocuSign.eSign.Api.ITemplatesApi.

◆ ListCustomFieldsAsync()

async System.Threading.Tasks.Task<CustomFields> DocuSign.eSign.Api.TemplatesApi.ListCustomFieldsAsync ( string  accountId,
string  templateId 
)
inline

Gets the custom document fields from a template. Retrieves the custom document field information from an existing template.

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
templateIdThe ID of the template being accessed.
Returns
Task of CustomFields

Implements DocuSign.eSign.Api.ITemplatesApi.

◆ ListCustomFieldsAsyncWithHttpInfo()

async System.Threading.Tasks.Task<ApiResponse<CustomFields> > DocuSign.eSign.Api.TemplatesApi.ListCustomFieldsAsyncWithHttpInfo ( string  accountId,
string  templateId 
)
inline

Gets the custom document fields from a template. Retrieves the custom document field information from an existing template.

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
templateIdThe ID of the template being accessed.
Returns
Task of ApiResponse (CustomFields)

Implements DocuSign.eSign.Api.ITemplatesApi.

◆ ListCustomFieldsWithHttpInfo()

ApiResponse<CustomFields> DocuSign.eSign.Api.TemplatesApi.ListCustomFieldsWithHttpInfo ( string  accountId,
string  templateId 
)
inline

Gets the custom document fields from a template. Retrieves the custom document field information from an existing template.

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
templateIdThe ID of the template being accessed.
Returns
ApiResponse of CustomFields

Implements DocuSign.eSign.Api.ITemplatesApi.

◆ ListDocumentFields()

DocumentFieldsInformation DocuSign.eSign.Api.TemplatesApi.ListDocumentFields ( string  accountId,
string  templateId,
string  documentId 
)
inline

Gets the custom document fields for a an existing template document. Retrieves the custom document fields for an existing template document.

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
templateIdThe ID of the template being accessed.
documentIdThe ID of the document being accessed.
Returns
DocumentFieldsInformation

Implements DocuSign.eSign.Api.ITemplatesApi.

◆ ListDocumentFieldsAsync()

async System.Threading.Tasks.Task<DocumentFieldsInformation> DocuSign.eSign.Api.TemplatesApi.ListDocumentFieldsAsync ( string  accountId,
string  templateId,
string  documentId 
)
inline

Gets the custom document fields for a an existing template document. Retrieves the custom document fields for an existing template document.

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
templateIdThe ID of the template being accessed.
documentIdThe ID of the document being accessed.
Returns
Task of DocumentFieldsInformation

Implements DocuSign.eSign.Api.ITemplatesApi.

◆ ListDocumentFieldsAsyncWithHttpInfo()

async System.Threading.Tasks.Task<ApiResponse<DocumentFieldsInformation> > DocuSign.eSign.Api.TemplatesApi.ListDocumentFieldsAsyncWithHttpInfo ( string  accountId,
string  templateId,
string  documentId 
)
inline

Gets the custom document fields for a an existing template document. Retrieves the custom document fields for an existing template document.

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
templateIdThe ID of the template being accessed.
documentIdThe ID of the document being accessed.
Returns
Task of ApiResponse (DocumentFieldsInformation)

Implements DocuSign.eSign.Api.ITemplatesApi.

◆ ListDocumentFieldsWithHttpInfo()

ApiResponse<DocumentFieldsInformation> DocuSign.eSign.Api.TemplatesApi.ListDocumentFieldsWithHttpInfo ( string  accountId,
string  templateId,
string  documentId 
)
inline

Gets the custom document fields for a an existing template document. Retrieves the custom document fields for an existing template document.

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
templateIdThe ID of the template being accessed.
documentIdThe ID of the document being accessed.
Returns
ApiResponse of DocumentFieldsInformation

Implements DocuSign.eSign.Api.ITemplatesApi.

◆ ListDocuments()

TemplateDocumentsResult DocuSign.eSign.Api.TemplatesApi.ListDocuments ( string  accountId,
string  templateId,
TemplatesApi.ListDocumentsOptions  options = null 
)
inline

Gets a list of documents associated with a template. Retrieves a list of documents associated with the specified template.

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
templateIdThe ID of the template being accessed.
optionsOptions for modifying the behavior of the function.
Returns
TemplateDocumentsResult

◆ ListDocumentsAsync()

async System.Threading.Tasks.Task<TemplateDocumentsResult> DocuSign.eSign.Api.TemplatesApi.ListDocumentsAsync ( string  accountId,
string  templateId,
TemplatesApi.ListDocumentsOptions  options = null 
)
inline

Gets a list of documents associated with a template. Retrieves a list of documents associated with the specified template.

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
templateIdThe ID of the template being accessed.
optionsOptions for modifying the behavior of the function.
Returns
Task of TemplateDocumentsResult

◆ ListDocumentsAsyncWithHttpInfo()

async System.Threading.Tasks.Task<ApiResponse<TemplateDocumentsResult> > DocuSign.eSign.Api.TemplatesApi.ListDocumentsAsyncWithHttpInfo ( string  accountId,
string  templateId,
TemplatesApi.ListDocumentsOptions  options = null 
)
inline

Gets a list of documents associated with a template. Retrieves a list of documents associated with the specified template.

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
templateIdThe ID of the template being accessed.
optionsOptions for modifying the behavior of the function.
Returns
Task of ApiResponse (TemplateDocumentsResult)

◆ ListDocumentsWithHttpInfo()

ApiResponse<TemplateDocumentsResult> DocuSign.eSign.Api.TemplatesApi.ListDocumentsWithHttpInfo ( string  accountId,
string  templateId,
TemplatesApi.ListDocumentsOptions  options = null 
)
inline

Gets a list of documents associated with a template. Retrieves a list of documents associated with the specified template.

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
templateIdThe ID of the template being accessed.
optionsOptions for modifying the behavior of the function.
Returns
ApiResponse of TemplateDocumentsResult

◆ ListRecipients()

Recipients DocuSign.eSign.Api.TemplatesApi.ListRecipients ( string  accountId,
string  templateId,
TemplatesApi.ListRecipientsOptions  options = null 
)
inline

Gets recipient information from a template. Retrieves the information for all recipients in the specified template.

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
templateIdThe ID of the template being accessed.
optionsOptions for modifying the behavior of the function.
Returns
Recipients

◆ ListRecipientsAsync()

async System.Threading.Tasks.Task<Recipients> DocuSign.eSign.Api.TemplatesApi.ListRecipientsAsync ( string  accountId,
string  templateId,
TemplatesApi.ListRecipientsOptions  options = null 
)
inline

Gets recipient information from a template. Retrieves the information for all recipients in the specified template.

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
templateIdThe ID of the template being accessed.
optionsOptions for modifying the behavior of the function.
Returns
Task of Recipients

◆ ListRecipientsAsyncWithHttpInfo()

async System.Threading.Tasks.Task<ApiResponse<Recipients> > DocuSign.eSign.Api.TemplatesApi.ListRecipientsAsyncWithHttpInfo ( string  accountId,
string  templateId,
TemplatesApi.ListRecipientsOptions  options = null 
)
inline

Gets recipient information from a template. Retrieves the information for all recipients in the specified template.

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
templateIdThe ID of the template being accessed.
optionsOptions for modifying the behavior of the function.
Returns
Task of ApiResponse (Recipients)

◆ ListRecipientsWithHttpInfo()

ApiResponse<Recipients> DocuSign.eSign.Api.TemplatesApi.ListRecipientsWithHttpInfo ( string  accountId,
string  templateId,
TemplatesApi.ListRecipientsOptions  options = null 
)
inline

Gets recipient information from a template. Retrieves the information for all recipients in the specified template.

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
templateIdThe ID of the template being accessed.
optionsOptions for modifying the behavior of the function.
Returns
ApiResponse of Recipients

◆ ListTabs()

Tabs DocuSign.eSign.Api.TemplatesApi.ListTabs ( string  accountId,
string  templateId,
string  recipientId,
TemplatesApi.ListTabsOptions  options = null 
)
inline

Gets the tabs information for a signer or sign-in-person recipient in a template. Gets the tabs information for a signer or sign-in-person recipient in a template.

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
templateIdThe ID of the template being accessed.
recipientIdThe ID of the recipient being accessed.
optionsOptions for modifying the behavior of the function.
Returns
Tabs

◆ ListTabsAsync()

async System.Threading.Tasks.Task<Tabs> DocuSign.eSign.Api.TemplatesApi.ListTabsAsync ( string  accountId,
string  templateId,
string  recipientId,
TemplatesApi.ListTabsOptions  options = null 
)
inline

Gets the tabs information for a signer or sign-in-person recipient in a template. Gets the tabs information for a signer or sign-in-person recipient in a template.

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
templateIdThe ID of the template being accessed.
recipientIdThe ID of the recipient being accessed.
optionsOptions for modifying the behavior of the function.
Returns
Task of Tabs

◆ ListTabsAsyncWithHttpInfo()

async System.Threading.Tasks.Task<ApiResponse<Tabs> > DocuSign.eSign.Api.TemplatesApi.ListTabsAsyncWithHttpInfo ( string  accountId,
string  templateId,
string  recipientId,
TemplatesApi.ListTabsOptions  options = null 
)
inline

Gets the tabs information for a signer or sign-in-person recipient in a template. Gets the tabs information for a signer or sign-in-person recipient in a template.

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
templateIdThe ID of the template being accessed.
recipientIdThe ID of the recipient being accessed.
optionsOptions for modifying the behavior of the function.
Returns
Task of ApiResponse (Tabs)

◆ ListTabsWithHttpInfo()

ApiResponse<Tabs> DocuSign.eSign.Api.TemplatesApi.ListTabsWithHttpInfo ( string  accountId,
string  templateId,
string  recipientId,
TemplatesApi.ListTabsOptions  options = null 
)
inline

Gets the tabs information for a signer or sign-in-person recipient in a template. Gets the tabs information for a signer or sign-in-person recipient in a template.

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
templateIdThe ID of the template being accessed.
recipientIdThe ID of the recipient being accessed.
optionsOptions for modifying the behavior of the function.
Returns
ApiResponse of Tabs

◆ ListTemplates()

EnvelopeTemplateResults DocuSign.eSign.Api.TemplatesApi.ListTemplates ( string  accountId,
TemplatesApi.ListTemplatesOptions  options = null 
)
inline

Gets the definition of a template. Retrieves the list of templates for the specified account. The request can be limited to a specific folder.

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
optionsOptions for modifying the behavior of the function.
Returns
EnvelopeTemplateResults

◆ ListTemplatesAsync()

async System.Threading.Tasks.Task<EnvelopeTemplateResults> DocuSign.eSign.Api.TemplatesApi.ListTemplatesAsync ( string  accountId,
TemplatesApi.ListTemplatesOptions  options = null 
)
inline

Gets the definition of a template. Retrieves the list of templates for the specified account. The request can be limited to a specific folder.

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
optionsOptions for modifying the behavior of the function.
Returns
Task of EnvelopeTemplateResults

◆ ListTemplatesAsyncWithHttpInfo()

async System.Threading.Tasks.Task<ApiResponse<EnvelopeTemplateResults> > DocuSign.eSign.Api.TemplatesApi.ListTemplatesAsyncWithHttpInfo ( string  accountId,
TemplatesApi.ListTemplatesOptions  options = null 
)
inline

Gets the definition of a template. Retrieves the list of templates for the specified account. The request can be limited to a specific folder.

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
optionsOptions for modifying the behavior of the function.
Returns
Task of ApiResponse (EnvelopeTemplateResults)

◆ ListTemplatesWithHttpInfo()

ApiResponse<EnvelopeTemplateResults> DocuSign.eSign.Api.TemplatesApi.ListTemplatesWithHttpInfo ( string  accountId,
TemplatesApi.ListTemplatesOptions  options = null 
)
inline

Gets the definition of a template. Retrieves the list of templates for the specified account. The request can be limited to a specific folder.

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
optionsOptions for modifying the behavior of the function.
Returns
ApiResponse of EnvelopeTemplateResults

◆ RotateDocumentPage()

void DocuSign.eSign.Api.TemplatesApi.RotateDocumentPage ( string  accountId,
string  templateId,
string  documentId,
string  pageNumber,
PageRequest  pageRequest = null 
)
inline

Rotates page image from a template for display. Rotates page image from a template for display. The page image can be rotated to the left or right.

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
templateIdThe ID of the template being accessed.
documentIdThe ID of the document being accessed.
pageNumberThe page number being accessed.
pageRequest(optional)
Returns

Implements DocuSign.eSign.Api.ITemplatesApi.

◆ RotateDocumentPageAsync()

async System.Threading.Tasks.Task DocuSign.eSign.Api.TemplatesApi.RotateDocumentPageAsync ( string  accountId,
string  templateId,
string  documentId,
string  pageNumber,
PageRequest  pageRequest = null 
)
inline

Rotates page image from a template for display. Rotates page image from a template for display. The page image can be rotated to the left or right.

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
templateIdThe ID of the template being accessed.
documentIdThe ID of the document being accessed.
pageNumberThe page number being accessed.
pageRequest(optional)
Returns
Task of void

Implements DocuSign.eSign.Api.ITemplatesApi.

◆ RotateDocumentPageAsyncWithHttpInfo()

async System.Threading.Tasks.Task<ApiResponse<Object> > DocuSign.eSign.Api.TemplatesApi.RotateDocumentPageAsyncWithHttpInfo ( string  accountId,
string  templateId,
string  documentId,
string  pageNumber,
PageRequest  pageRequest = null 
)
inline

Rotates page image from a template for display. Rotates page image from a template for display. The page image can be rotated to the left or right.

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
templateIdThe ID of the template being accessed.
documentIdThe ID of the document being accessed.
pageNumberThe page number being accessed.
pageRequest(optional)
Returns
Task of ApiResponse

Implements DocuSign.eSign.Api.ITemplatesApi.

◆ RotateDocumentPageWithHttpInfo()

ApiResponse<Object> DocuSign.eSign.Api.TemplatesApi.RotateDocumentPageWithHttpInfo ( string  accountId,
string  templateId,
string  documentId,
string  pageNumber,
PageRequest  pageRequest = null 
)
inline

Rotates page image from a template for display. Rotates page image from a template for display. The page image can be rotated to the left or right.

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
templateIdThe ID of the template being accessed.
documentIdThe ID of the document being accessed.
pageNumberThe page number being accessed.
pageRequest(optional)
Returns
ApiResponse of Object(void)

Implements DocuSign.eSign.Api.ITemplatesApi.

◆ Update()

TemplateUpdateSummary DocuSign.eSign.Api.TemplatesApi.Update ( string  accountId,
string  templateId,
EnvelopeTemplate  envelopeTemplate = null 
)
inline

Updates an existing template. Updates an existing template.

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
templateIdThe ID of the template being accessed.
envelopeTemplate(optional)
Returns
TemplateUpdateSummary

Implements DocuSign.eSign.Api.ITemplatesApi.

◆ UpdateAsync()

async System.Threading.Tasks.Task<TemplateUpdateSummary> DocuSign.eSign.Api.TemplatesApi.UpdateAsync ( string  accountId,
string  templateId,
EnvelopeTemplate  envelopeTemplate = null 
)
inline

Updates an existing template. Updates an existing template.

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
templateIdThe ID of the template being accessed.
envelopeTemplate(optional)
Returns
Task of TemplateUpdateSummary

Implements DocuSign.eSign.Api.ITemplatesApi.

◆ UpdateAsyncWithHttpInfo()

async System.Threading.Tasks.Task<ApiResponse<TemplateUpdateSummary> > DocuSign.eSign.Api.TemplatesApi.UpdateAsyncWithHttpInfo ( string  accountId,
string  templateId,
EnvelopeTemplate  envelopeTemplate = null 
)
inline

Updates an existing template. Updates an existing template.

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
templateIdThe ID of the template being accessed.
envelopeTemplate(optional)
Returns
Task of ApiResponse (TemplateUpdateSummary)

Implements DocuSign.eSign.Api.ITemplatesApi.

◆ UpdateCustomFields()

CustomFields DocuSign.eSign.Api.TemplatesApi.UpdateCustomFields ( string  accountId,
string  templateId,
TemplateCustomFields  templateCustomFields = null 
)
inline

Updates envelope custom fields in a template. Updates the custom fields in a template. Each custom field used in a template must have a unique name.

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
templateIdThe ID of the template being accessed.
templateCustomFields(optional)
Returns
CustomFields

Implements DocuSign.eSign.Api.ITemplatesApi.

◆ UpdateCustomFieldsAsync()

async System.Threading.Tasks.Task<CustomFields> DocuSign.eSign.Api.TemplatesApi.UpdateCustomFieldsAsync ( string  accountId,
string  templateId,
TemplateCustomFields  templateCustomFields = null 
)
inline

Updates envelope custom fields in a template. Updates the custom fields in a template. Each custom field used in a template must have a unique name.

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
templateIdThe ID of the template being accessed.
templateCustomFields(optional)
Returns
Task of CustomFields

Implements DocuSign.eSign.Api.ITemplatesApi.

◆ UpdateCustomFieldsAsyncWithHttpInfo()

async System.Threading.Tasks.Task<ApiResponse<CustomFields> > DocuSign.eSign.Api.TemplatesApi.UpdateCustomFieldsAsyncWithHttpInfo ( string  accountId,
string  templateId,
TemplateCustomFields  templateCustomFields = null 
)
inline

Updates envelope custom fields in a template. Updates the custom fields in a template. Each custom field used in a template must have a unique name.

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
templateIdThe ID of the template being accessed.
templateCustomFields(optional)
Returns
Task of ApiResponse (CustomFields)

Implements DocuSign.eSign.Api.ITemplatesApi.

◆ UpdateCustomFieldsWithHttpInfo()

ApiResponse<CustomFields> DocuSign.eSign.Api.TemplatesApi.UpdateCustomFieldsWithHttpInfo ( string  accountId,
string  templateId,
TemplateCustomFields  templateCustomFields = null 
)
inline

Updates envelope custom fields in a template. Updates the custom fields in a template. Each custom field used in a template must have a unique name.

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
templateIdThe ID of the template being accessed.
templateCustomFields(optional)
Returns
ApiResponse of CustomFields

Implements DocuSign.eSign.Api.ITemplatesApi.

◆ UpdateDocument()

EnvelopeDocument DocuSign.eSign.Api.TemplatesApi.UpdateDocument ( string  accountId,
string  templateId,
string  documentId,
EnvelopeDefinition  envelopeDefinition = null,
TemplatesApi.UpdateDocumentOptions  options = null 
)
inline

Adds a document to a template document. Adds the specified document to an existing template document.

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
templateIdThe ID of the template being accessed.
documentIdThe ID of the document being accessed.
envelopeDefinition(optional)
optionsOptions for modifying the behavior of the function.
Returns
EnvelopeDocument

◆ UpdateDocumentAsync()

async System.Threading.Tasks.Task<EnvelopeDocument> DocuSign.eSign.Api.TemplatesApi.UpdateDocumentAsync ( string  accountId,
string  templateId,
string  documentId,
EnvelopeDefinition  envelopeDefinition = null,
TemplatesApi.UpdateDocumentOptions  options = null 
)
inline

Adds a document to a template document. Adds the specified document to an existing template document.

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
templateIdThe ID of the template being accessed.
documentIdThe ID of the document being accessed.
envelopeDefinition(optional)
optionsOptions for modifying the behavior of the function.
Returns
Task of EnvelopeDocument

◆ UpdateDocumentAsyncWithHttpInfo()

async System.Threading.Tasks.Task<ApiResponse<EnvelopeDocument> > DocuSign.eSign.Api.TemplatesApi.UpdateDocumentAsyncWithHttpInfo ( string  accountId,
string  templateId,
string  documentId,
EnvelopeDefinition  envelopeDefinition = null,
TemplatesApi.UpdateDocumentOptions  options = null 
)
inline

Adds a document to a template document. Adds the specified document to an existing template document.

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
templateIdThe ID of the template being accessed.
documentIdThe ID of the document being accessed.
envelopeDefinition(optional)
optionsOptions for modifying the behavior of the function.
Returns
Task of ApiResponse (EnvelopeDocument)

◆ UpdateDocumentFields()

DocumentFieldsInformation DocuSign.eSign.Api.TemplatesApi.UpdateDocumentFields ( string  accountId,
string  templateId,
string  documentId,
DocumentFieldsInformation  documentFieldsInformation = null 
)
inline

Updates existing custom document fields in an existing template document. Updates existing custom document fields in an existing template document.

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
templateIdThe ID of the template being accessed.
documentIdThe ID of the document being accessed.
documentFieldsInformation(optional)
Returns
DocumentFieldsInformation

Implements DocuSign.eSign.Api.ITemplatesApi.

◆ UpdateDocumentFieldsAsync()

async System.Threading.Tasks.Task<DocumentFieldsInformation> DocuSign.eSign.Api.TemplatesApi.UpdateDocumentFieldsAsync ( string  accountId,
string  templateId,
string  documentId,
DocumentFieldsInformation  documentFieldsInformation = null 
)
inline

Updates existing custom document fields in an existing template document. Updates existing custom document fields in an existing template document.

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
templateIdThe ID of the template being accessed.
documentIdThe ID of the document being accessed.
documentFieldsInformation(optional)
Returns
Task of DocumentFieldsInformation

Implements DocuSign.eSign.Api.ITemplatesApi.

◆ UpdateDocumentFieldsAsyncWithHttpInfo()

async System.Threading.Tasks.Task<ApiResponse<DocumentFieldsInformation> > DocuSign.eSign.Api.TemplatesApi.UpdateDocumentFieldsAsyncWithHttpInfo ( string  accountId,
string  templateId,
string  documentId,
DocumentFieldsInformation  documentFieldsInformation = null 
)
inline

Updates existing custom document fields in an existing template document. Updates existing custom document fields in an existing template document.

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
templateIdThe ID of the template being accessed.
documentIdThe ID of the document being accessed.
documentFieldsInformation(optional)
Returns
Task of ApiResponse (DocumentFieldsInformation)

Implements DocuSign.eSign.Api.ITemplatesApi.

◆ UpdateDocumentFieldsWithHttpInfo()

ApiResponse<DocumentFieldsInformation> DocuSign.eSign.Api.TemplatesApi.UpdateDocumentFieldsWithHttpInfo ( string  accountId,
string  templateId,
string  documentId,
DocumentFieldsInformation  documentFieldsInformation = null 
)
inline

Updates existing custom document fields in an existing template document. Updates existing custom document fields in an existing template document.

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
templateIdThe ID of the template being accessed.
documentIdThe ID of the document being accessed.
documentFieldsInformation(optional)
Returns
ApiResponse of DocumentFieldsInformation

Implements DocuSign.eSign.Api.ITemplatesApi.

◆ UpdateDocuments()

TemplateDocumentsResult DocuSign.eSign.Api.TemplatesApi.UpdateDocuments ( string  accountId,
string  templateId,
EnvelopeDefinition  envelopeDefinition = null 
)
inline

Adds documents to a template document. Adds one or more documents to an existing template document.

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
templateIdThe ID of the template being accessed.
envelopeDefinition(optional)
Returns
TemplateDocumentsResult

Implements DocuSign.eSign.Api.ITemplatesApi.

◆ UpdateDocumentsAsync()

async System.Threading.Tasks.Task<TemplateDocumentsResult> DocuSign.eSign.Api.TemplatesApi.UpdateDocumentsAsync ( string  accountId,
string  templateId,
EnvelopeDefinition  envelopeDefinition = null 
)
inline

Adds documents to a template document. Adds one or more documents to an existing template document.

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
templateIdThe ID of the template being accessed.
envelopeDefinition(optional)
Returns
Task of TemplateDocumentsResult

Implements DocuSign.eSign.Api.ITemplatesApi.

◆ UpdateDocumentsAsyncWithHttpInfo()

async System.Threading.Tasks.Task<ApiResponse<TemplateDocumentsResult> > DocuSign.eSign.Api.TemplatesApi.UpdateDocumentsAsyncWithHttpInfo ( string  accountId,
string  templateId,
EnvelopeDefinition  envelopeDefinition = null 
)
inline

Adds documents to a template document. Adds one or more documents to an existing template document.

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
templateIdThe ID of the template being accessed.
envelopeDefinition(optional)
Returns
Task of ApiResponse (TemplateDocumentsResult)

Implements DocuSign.eSign.Api.ITemplatesApi.

◆ UpdateDocumentsWithHttpInfo()

ApiResponse<TemplateDocumentsResult> DocuSign.eSign.Api.TemplatesApi.UpdateDocumentsWithHttpInfo ( string  accountId,
string  templateId,
EnvelopeDefinition  envelopeDefinition = null 
)
inline

Adds documents to a template document. Adds one or more documents to an existing template document.

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
templateIdThe ID of the template being accessed.
envelopeDefinition(optional)
Returns
ApiResponse of TemplateDocumentsResult

Implements DocuSign.eSign.Api.ITemplatesApi.

◆ UpdateDocumentWithHttpInfo()

ApiResponse<EnvelopeDocument> DocuSign.eSign.Api.TemplatesApi.UpdateDocumentWithHttpInfo ( string  accountId,
string  templateId,
string  documentId,
EnvelopeDefinition  envelopeDefinition = null,
TemplatesApi.UpdateDocumentOptions  options = null 
)
inline

Adds a document to a template document. Adds the specified document to an existing template document.

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
templateIdThe ID of the template being accessed.
documentIdThe ID of the document being accessed.
envelopeDefinition(optional)
optionsOptions for modifying the behavior of the function.
Returns
ApiResponse of EnvelopeDocument

◆ UpdateGroupShare()

GroupInformation DocuSign.eSign.Api.TemplatesApi.UpdateGroupShare ( string  accountId,
string  templateId,
string  templatePart,
GroupInformation  groupInformation = null 
)
inline

Shares a template with a group Shares a template with the specified members group.

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
templateIdThe ID of the template being accessed.
templatePartCurrently, the only defined part is groups.
groupInformation(optional)
Returns
GroupInformation

Implements DocuSign.eSign.Api.ITemplatesApi.

◆ UpdateGroupShareAsync()

async System.Threading.Tasks.Task<GroupInformation> DocuSign.eSign.Api.TemplatesApi.UpdateGroupShareAsync ( string  accountId,
string  templateId,
string  templatePart,
GroupInformation  groupInformation = null 
)
inline

Shares a template with a group Shares a template with the specified members group.

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
templateIdThe ID of the template being accessed.
templatePartCurrently, the only defined part is groups.
groupInformation(optional)
Returns
Task of GroupInformation

Implements DocuSign.eSign.Api.ITemplatesApi.

◆ UpdateGroupShareAsyncWithHttpInfo()

async System.Threading.Tasks.Task<ApiResponse<GroupInformation> > DocuSign.eSign.Api.TemplatesApi.UpdateGroupShareAsyncWithHttpInfo ( string  accountId,
string  templateId,
string  templatePart,
GroupInformation  groupInformation = null 
)
inline

Shares a template with a group Shares a template with the specified members group.

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
templateIdThe ID of the template being accessed.
templatePartCurrently, the only defined part is groups.
groupInformation(optional)
Returns
Task of ApiResponse (GroupInformation)

Implements DocuSign.eSign.Api.ITemplatesApi.

◆ UpdateGroupShareWithHttpInfo()

ApiResponse<GroupInformation> DocuSign.eSign.Api.TemplatesApi.UpdateGroupShareWithHttpInfo ( string  accountId,
string  templateId,
string  templatePart,
GroupInformation  groupInformation = null 
)
inline

Shares a template with a group Shares a template with the specified members group.

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
templateIdThe ID of the template being accessed.
templatePartCurrently, the only defined part is groups.
groupInformation(optional)
Returns
ApiResponse of GroupInformation

Implements DocuSign.eSign.Api.ITemplatesApi.

◆ UpdateLock()

LockInformation DocuSign.eSign.Api.TemplatesApi.UpdateLock ( string  accountId,
string  templateId,
LockRequest  lockRequest = null 
)
inline

Updates a template lock. Updates the lock duration time or update the &#x60;lockedByApp&#x60; property information for the specified template. The user and integrator key must match the user specified by the &#x60;lockByUser&#x60; property and integrator key information and the &#x60;X-DocuSign-Edit&#x60; header must be included or an error will be generated.

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
templateIdThe ID of the template being accessed.
lockRequest(optional)
Returns
LockInformation

Implements DocuSign.eSign.Api.ITemplatesApi.

◆ UpdateLockAsync()

async System.Threading.Tasks.Task<LockInformation> DocuSign.eSign.Api.TemplatesApi.UpdateLockAsync ( string  accountId,
string  templateId,
LockRequest  lockRequest = null 
)
inline

Updates a template lock. Updates the lock duration time or update the &#x60;lockedByApp&#x60; property information for the specified template. The user and integrator key must match the user specified by the &#x60;lockByUser&#x60; property and integrator key information and the &#x60;X-DocuSign-Edit&#x60; header must be included or an error will be generated.

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
templateIdThe ID of the template being accessed.
lockRequest(optional)
Returns
Task of LockInformation

Implements DocuSign.eSign.Api.ITemplatesApi.

◆ UpdateLockAsyncWithHttpInfo()

async System.Threading.Tasks.Task<ApiResponse<LockInformation> > DocuSign.eSign.Api.TemplatesApi.UpdateLockAsyncWithHttpInfo ( string  accountId,
string  templateId,
LockRequest  lockRequest = null 
)
inline

Updates a template lock. Updates the lock duration time or update the &#x60;lockedByApp&#x60; property information for the specified template. The user and integrator key must match the user specified by the &#x60;lockByUser&#x60; property and integrator key information and the &#x60;X-DocuSign-Edit&#x60; header must be included or an error will be generated.

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
templateIdThe ID of the template being accessed.
lockRequest(optional)
Returns
Task of ApiResponse (LockInformation)

Implements DocuSign.eSign.Api.ITemplatesApi.

◆ UpdateLockWithHttpInfo()

ApiResponse<LockInformation> DocuSign.eSign.Api.TemplatesApi.UpdateLockWithHttpInfo ( string  accountId,
string  templateId,
LockRequest  lockRequest = null 
)
inline

Updates a template lock. Updates the lock duration time or update the &#x60;lockedByApp&#x60; property information for the specified template. The user and integrator key must match the user specified by the &#x60;lockByUser&#x60; property and integrator key information and the &#x60;X-DocuSign-Edit&#x60; header must be included or an error will be generated.

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
templateIdThe ID of the template being accessed.
lockRequest(optional)
Returns
ApiResponse of LockInformation

Implements DocuSign.eSign.Api.ITemplatesApi.

◆ UpdateNotificationSettings()

Notification DocuSign.eSign.Api.TemplatesApi.UpdateNotificationSettings ( string  accountId,
string  templateId,
TemplateNotificationRequest  templateNotificationRequest = null 
)
inline

Updates the notification structure for an existing template. Updates the notification structure for an existing template. Use this endpoint to set reminder and expiration notifications.

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
templateIdThe ID of the template being accessed.
templateNotificationRequest(optional)
Returns
Notification

Implements DocuSign.eSign.Api.ITemplatesApi.

◆ UpdateNotificationSettingsAsync()

async System.Threading.Tasks.Task<Notification> DocuSign.eSign.Api.TemplatesApi.UpdateNotificationSettingsAsync ( string  accountId,
string  templateId,
TemplateNotificationRequest  templateNotificationRequest = null 
)
inline

Updates the notification structure for an existing template. Updates the notification structure for an existing template. Use this endpoint to set reminder and expiration notifications.

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
templateIdThe ID of the template being accessed.
templateNotificationRequest(optional)
Returns
Task of Notification

Implements DocuSign.eSign.Api.ITemplatesApi.

◆ UpdateNotificationSettingsAsyncWithHttpInfo()

async System.Threading.Tasks.Task<ApiResponse<Notification> > DocuSign.eSign.Api.TemplatesApi.UpdateNotificationSettingsAsyncWithHttpInfo ( string  accountId,
string  templateId,
TemplateNotificationRequest  templateNotificationRequest = null 
)
inline

Updates the notification structure for an existing template. Updates the notification structure for an existing template. Use this endpoint to set reminder and expiration notifications.

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
templateIdThe ID of the template being accessed.
templateNotificationRequest(optional)
Returns
Task of ApiResponse (Notification)

Implements DocuSign.eSign.Api.ITemplatesApi.

◆ UpdateNotificationSettingsWithHttpInfo()

ApiResponse<Notification> DocuSign.eSign.Api.TemplatesApi.UpdateNotificationSettingsWithHttpInfo ( string  accountId,
string  templateId,
TemplateNotificationRequest  templateNotificationRequest = null 
)
inline

Updates the notification structure for an existing template. Updates the notification structure for an existing template. Use this endpoint to set reminder and expiration notifications.

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
templateIdThe ID of the template being accessed.
templateNotificationRequest(optional)
Returns
ApiResponse of Notification

Implements DocuSign.eSign.Api.ITemplatesApi.

◆ UpdateRecipients()

RecipientsUpdateSummary DocuSign.eSign.Api.TemplatesApi.UpdateRecipients ( string  accountId,
string  templateId,
TemplateRecipients  templateRecipients = null,
TemplatesApi.UpdateRecipientsOptions  options = null 
)
inline

Updates recipients in a template. Updates recipients in a template. You can edit the following properties: &#x60;email&#x60;, &#x60;userName&#x60;, &#x60;routingOrder&#x60;, &#x60;faxNumber&#x60;, &#x60;deliveryMethod&#x60;, &#x60;accessCode&#x60;, and &#x60;requireIdLookup&#x60;.

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
templateIdThe ID of the template being accessed.
templateRecipients(optional)
optionsOptions for modifying the behavior of the function.
Returns
RecipientsUpdateSummary

◆ UpdateRecipientsAsync()

async System.Threading.Tasks.Task<RecipientsUpdateSummary> DocuSign.eSign.Api.TemplatesApi.UpdateRecipientsAsync ( string  accountId,
string  templateId,
TemplateRecipients  templateRecipients = null,
TemplatesApi.UpdateRecipientsOptions  options = null 
)
inline

Updates recipients in a template. Updates recipients in a template. You can edit the following properties: &#x60;email&#x60;, &#x60;userName&#x60;, &#x60;routingOrder&#x60;, &#x60;faxNumber&#x60;, &#x60;deliveryMethod&#x60;, &#x60;accessCode&#x60;, and &#x60;requireIdLookup&#x60;.

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
templateIdThe ID of the template being accessed.
templateRecipients(optional)
optionsOptions for modifying the behavior of the function.
Returns
Task of RecipientsUpdateSummary

◆ UpdateRecipientsAsyncWithHttpInfo()

async System.Threading.Tasks.Task<ApiResponse<RecipientsUpdateSummary> > DocuSign.eSign.Api.TemplatesApi.UpdateRecipientsAsyncWithHttpInfo ( string  accountId,
string  templateId,
TemplateRecipients  templateRecipients = null,
TemplatesApi.UpdateRecipientsOptions  options = null 
)
inline

Updates recipients in a template. Updates recipients in a template. You can edit the following properties: &#x60;email&#x60;, &#x60;userName&#x60;, &#x60;routingOrder&#x60;, &#x60;faxNumber&#x60;, &#x60;deliveryMethod&#x60;, &#x60;accessCode&#x60;, and &#x60;requireIdLookup&#x60;.

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
templateIdThe ID of the template being accessed.
templateRecipients(optional)
optionsOptions for modifying the behavior of the function.
Returns
Task of ApiResponse (RecipientsUpdateSummary)

◆ UpdateRecipientsWithHttpInfo()

ApiResponse<RecipientsUpdateSummary> DocuSign.eSign.Api.TemplatesApi.UpdateRecipientsWithHttpInfo ( string  accountId,
string  templateId,
TemplateRecipients  templateRecipients = null,
TemplatesApi.UpdateRecipientsOptions  options = null 
)
inline

Updates recipients in a template. Updates recipients in a template. You can edit the following properties: &#x60;email&#x60;, &#x60;userName&#x60;, &#x60;routingOrder&#x60;, &#x60;faxNumber&#x60;, &#x60;deliveryMethod&#x60;, &#x60;accessCode&#x60;, and &#x60;requireIdLookup&#x60;.

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
templateIdThe ID of the template being accessed.
templateRecipients(optional)
optionsOptions for modifying the behavior of the function.
Returns
ApiResponse of RecipientsUpdateSummary

◆ UpdateTabs()

Tabs DocuSign.eSign.Api.TemplatesApi.UpdateTabs ( string  accountId,
string  templateId,
string  recipientId,
TemplateTabs  templateTabs = null 
)
inline

Updates the tabs for a recipient. Updates one or more tabs for a recipient in a template.

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
templateIdThe ID of the template being accessed.
recipientIdThe ID of the recipient being accessed.
templateTabs(optional)
Returns
Tabs

Implements DocuSign.eSign.Api.ITemplatesApi.

◆ UpdateTabsAsync()

async System.Threading.Tasks.Task<Tabs> DocuSign.eSign.Api.TemplatesApi.UpdateTabsAsync ( string  accountId,
string  templateId,
string  recipientId,
TemplateTabs  templateTabs = null 
)
inline

Updates the tabs for a recipient. Updates one or more tabs for a recipient in a template.

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
templateIdThe ID of the template being accessed.
recipientIdThe ID of the recipient being accessed.
templateTabs(optional)
Returns
Task of Tabs

Implements DocuSign.eSign.Api.ITemplatesApi.

◆ UpdateTabsAsyncWithHttpInfo()

async System.Threading.Tasks.Task<ApiResponse<Tabs> > DocuSign.eSign.Api.TemplatesApi.UpdateTabsAsyncWithHttpInfo ( string  accountId,
string  templateId,
string  recipientId,
TemplateTabs  templateTabs = null 
)
inline

Updates the tabs for a recipient. Updates one or more tabs for a recipient in a template.

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
templateIdThe ID of the template being accessed.
recipientIdThe ID of the recipient being accessed.
templateTabs(optional)
Returns
Task of ApiResponse (Tabs)

Implements DocuSign.eSign.Api.ITemplatesApi.

◆ UpdateTabsWithHttpInfo()

ApiResponse<Tabs> DocuSign.eSign.Api.TemplatesApi.UpdateTabsWithHttpInfo ( string  accountId,
string  templateId,
string  recipientId,
TemplateTabs  templateTabs = null 
)
inline

Updates the tabs for a recipient. Updates one or more tabs for a recipient in a template.

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
templateIdThe ID of the template being accessed.
recipientIdThe ID of the recipient being accessed.
templateTabs(optional)
Returns
ApiResponse of Tabs

Implements DocuSign.eSign.Api.ITemplatesApi.

◆ UpdateTemplateDocumentTabs()

Tabs DocuSign.eSign.Api.TemplatesApi.UpdateTemplateDocumentTabs ( string  accountId,
string  templateId,
string  documentId,
TemplateTabs  templateTabs = null 
)
inline

Updates the tabs for a template Updates tabs in the document specified by &#x60;documentId&#x60; in the template specified by &#x60;templateId&#x60;.

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
templateIdThe ID of the template being accessed.
documentIdThe ID of the document being accessed.
templateTabs(optional)
Returns
Tabs

Implements DocuSign.eSign.Api.ITemplatesApi.

◆ UpdateTemplateDocumentTabsAsync()

async System.Threading.Tasks.Task<Tabs> DocuSign.eSign.Api.TemplatesApi.UpdateTemplateDocumentTabsAsync ( string  accountId,
string  templateId,
string  documentId,
TemplateTabs  templateTabs = null 
)
inline

Updates the tabs for a template Updates tabs in the document specified by &#x60;documentId&#x60; in the template specified by &#x60;templateId&#x60;.

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
templateIdThe ID of the template being accessed.
documentIdThe ID of the document being accessed.
templateTabs(optional)
Returns
Task of Tabs

Implements DocuSign.eSign.Api.ITemplatesApi.

◆ UpdateTemplateDocumentTabsAsyncWithHttpInfo()

async System.Threading.Tasks.Task<ApiResponse<Tabs> > DocuSign.eSign.Api.TemplatesApi.UpdateTemplateDocumentTabsAsyncWithHttpInfo ( string  accountId,
string  templateId,
string  documentId,
TemplateTabs  templateTabs = null 
)
inline

Updates the tabs for a template Updates tabs in the document specified by &#x60;documentId&#x60; in the template specified by &#x60;templateId&#x60;.

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
templateIdThe ID of the template being accessed.
documentIdThe ID of the document being accessed.
templateTabs(optional)
Returns
Task of ApiResponse (Tabs)

Implements DocuSign.eSign.Api.ITemplatesApi.

◆ UpdateTemplateDocumentTabsWithHttpInfo()

ApiResponse<Tabs> DocuSign.eSign.Api.TemplatesApi.UpdateTemplateDocumentTabsWithHttpInfo ( string  accountId,
string  templateId,
string  documentId,
TemplateTabs  templateTabs = null 
)
inline

Updates the tabs for a template Updates tabs in the document specified by &#x60;documentId&#x60; in the template specified by &#x60;templateId&#x60;.

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
templateIdThe ID of the template being accessed.
documentIdThe ID of the document being accessed.
templateTabs(optional)
Returns
ApiResponse of Tabs

Implements DocuSign.eSign.Api.ITemplatesApi.

◆ UpdateWithHttpInfo()

ApiResponse<TemplateUpdateSummary> DocuSign.eSign.Api.TemplatesApi.UpdateWithHttpInfo ( string  accountId,
string  templateId,
EnvelopeTemplate  envelopeTemplate = null 
)
inline

Updates an existing template. Updates an existing template.

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
templateIdThe ID of the template being accessed.
envelopeTemplate(optional)
Returns
ApiResponse of TemplateUpdateSummary

Implements DocuSign.eSign.Api.ITemplatesApi.

Property Documentation

◆ ApiClient

DocuSignClient DocuSign.eSign.Api.TemplatesApi.ApiClient
getset

Gets or sets the ApiClient object

An instance of the ApiClient

◆ ExceptionFactory

DocuSign.eSign.Client.ExceptionFactory DocuSign.eSign.Api.TemplatesApi.ExceptionFactory
getset

Provides a factory method hook for the creation of exceptions.


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