Docusign CSharp Docs
|
Represents a collection of functions to interact with the API endpoints More...
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< CustomFields > | CreateCustomFieldsWithHttpInfo (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< CustomFields > | CreateCustomFieldsAsync (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< DocumentFieldsInformation > | CreateDocumentFieldsWithHttpInfo (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< DocumentFieldsInformation > | CreateDocumentFieldsAsync (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< ViewUrl > | CreateEditViewWithHttpInfo (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< ViewUrl > | CreateEditViewAsync (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 `canLockEnvelopes` must be set to true for the user). More... | |
ApiResponse< LockInformation > | CreateLockWithHttpInfo (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 `canLockEnvelopes` must be set to true for the user). More... | |
async System.Threading.Tasks.Task< LockInformation > | CreateLockAsync (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 `canLockEnvelopes` 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 `canLockEnvelopes` 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< Recipients > | CreateRecipientsWithHttpInfo (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< Recipients > | CreateRecipientsAsync (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< Tabs > | CreateTabsWithHttpInfo (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< Tabs > | CreateTabsAsync (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's role name, are added to the `emailSubject` 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's name in the subject line add the following text in the `emailSubject` property when creating the template or when sending an envelope from a template: [[<roleName>_UserName]] Example: `"emailSubject":"[[Signer 1_UserName]], Please sign this NDA",` To add a recipient's email address in the subject line add the following text in the `emailSubject` property when creating the template or when sending an envelope from a template: [[<roleName>_Email]] Example: `"emailSubject":"[[Signer 1_Email]], Please sign this NDA",` In both cases the <roleName> is the recipient's contents of the `roleName` 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< TemplateSummary > | CreateTemplateWithHttpInfo (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's role name, are added to the `emailSubject` 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's name in the subject line add the following text in the `emailSubject` property when creating the template or when sending an envelope from a template: [[<roleName>_UserName]] Example: `"emailSubject":"[[Signer 1_UserName]], Please sign this NDA",` To add a recipient's email address in the subject line add the following text in the `emailSubject` property when creating the template or when sending an envelope from a template: [[<roleName>_Email]] Example: `"emailSubject":"[[Signer 1_Email]], Please sign this NDA",` In both cases the <roleName> is the recipient's contents of the `roleName` 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< TemplateSummary > | CreateTemplateAsync (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's role name, are added to the `emailSubject` 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's name in the subject line add the following text in the `emailSubject` property when creating the template or when sending an envelope from a template: [[<roleName>_UserName]] Example: `"emailSubject":"[[Signer 1_UserName]], Please sign this NDA",` To add a recipient's email address in the subject line add the following text in the `emailSubject` property when creating the template or when sending an envelope from a template: [[<roleName>_Email]] Example: `"emailSubject":"[[Signer 1_Email]], Please sign this NDA",` In both cases the <roleName> is the recipient's contents of the `roleName` 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's role name, are added to the `emailSubject` 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's name in the subject line add the following text in the `emailSubject` property when creating the template or when sending an envelope from a template: [[<roleName>_UserName]] Example: `"emailSubject":"[[Signer 1_UserName]], Please sign this NDA",` To add a recipient's email address in the subject line add the following text in the `emailSubject` property when creating the template or when sending an envelope from a template: [[<roleName>_Email]] Example: `"emailSubject":"[[Signer 1_Email]], Please sign this NDA",` In both cases the <roleName> is the recipient's contents of the `roleName` 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 `documentHtmlDefinition` object, which holds the responsive signing parameters that define how to generate the HTML version of the signing document. More... | |
ApiResponse< DocumentHtmlDefinitions > | CreateTemplateDocumentResponsiveHtmlPreviewWithHttpInfo (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 `documentHtmlDefinition` 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< DocumentHtmlDefinitions > | CreateTemplateDocumentResponsiveHtmlPreviewAsync (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 `documentHtmlDefinition` 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 `documentHtmlDefinition` 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 `documentId` in the template specified by `templateId`. 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: ``` { "prefillTabs": { "textTabs": [ { "value": "a prefill text tab", "pageNumber": "1", "documentId": "1", "xPosition": 316, "yPosition": 97 } ] } } ``` More... | |
ApiResponse< Tabs > | CreateTemplateDocumentTabsWithHttpInfo (string accountId, string templateId, string documentId, TemplateTabs templateTabs=null) |
Adds the tabs to a tempate Adds tabs to the document specified by `documentId` in the template specified by `templateId`. 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: ``` { "prefillTabs": { "textTabs": [ { "value": "a prefill text tab", "pageNumber": "1", "documentId": "1", "xPosition": 316, "yPosition": 97 } ] } } ``` More... | |
async System.Threading.Tasks.Task< Tabs > | CreateTemplateDocumentTabsAsync (string accountId, string templateId, string documentId, TemplateTabs templateTabs=null) |
Adds the tabs to a tempate Adds tabs to the document specified by `documentId` in the template specified by `templateId`. 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: ``` { "prefillTabs": { "textTabs": [ { "value": "a prefill text tab", "pageNumber": "1", "documentId": "1", "xPosition": 316, "yPosition": 97 } ] } } ``` 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 `documentId` in the template specified by `templateId`. 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: ``` { "prefillTabs": { "textTabs": [ { "value": "a prefill text tab", "pageNumber": "1", "documentId": "1", "xPosition": 316, "yPosition": 97 } ] } } ``` 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' experience. For more information, see Preview and Send. More... | |
ApiResponse< ViewUrl > | CreateTemplateRecipientPreviewWithHttpInfo (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' experience. For more information, see Preview and Send. More... | |
async System.Threading.Tasks.Task< ViewUrl > | CreateTemplateRecipientPreviewAsync (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' 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' 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 `documentHtmlDefinition` object, which holds the responsive signing parameters that define how to generate the HTML version of the documents. More... | |
ApiResponse< DocumentHtmlDefinitions > | CreateTemplateResponsiveHtmlPreviewWithHttpInfo (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 `documentHtmlDefinition` object, which holds the responsive signing parameters that define how to generate the HTML version of the documents. More... | |
async System.Threading.Tasks.Task< DocumentHtmlDefinitions > | CreateTemplateResponsiveHtmlPreviewAsync (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 `documentHtmlDefinition` 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 `documentHtmlDefinition` 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< CustomFields > | DeleteCustomFieldsWithHttpInfo (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< CustomFields > | DeleteCustomFieldsAsync (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< DocumentFieldsInformation > | DeleteDocumentFieldsWithHttpInfo (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< DocumentFieldsInformation > | DeleteDocumentFieldsAsync (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< TemplateDocumentsResult > | DeleteDocumentsWithHttpInfo (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< TemplateDocumentsResult > | DeleteDocumentsAsync (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's sharing permissions for a template. Removes a member group's sharing permissions for a specified template. More... | |
ApiResponse< GroupInformation > | DeleteGroupShareWithHttpInfo (string accountId, string templateId, string templatePart, GroupInformation groupInformation=null) |
Removes a member group's sharing permissions for a template. Removes a member group's sharing permissions for a specified template. More... | |
async System.Threading.Tasks.Task< GroupInformation > | DeleteGroupShareAsync (string accountId, string templateId, string templatePart, GroupInformation groupInformation=null) |
Removes a member group's sharing permissions for a template. Removes a member group'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's sharing permissions for a template. Removes a member group'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 `X-DocuSign-Edit` header must be included in the request. More... | |
ApiResponse< LockInformation > | DeleteLockWithHttpInfo (string accountId, string templateId, LockRequest lockRequest=null) |
Deletes a template lock. Deletes the lock from the specified template. The `X-DocuSign-Edit` header must be included in the request. More... | |
async System.Threading.Tasks.Task< LockInformation > | DeleteLockAsync (string accountId, string templateId, LockRequest lockRequest=null) |
Deletes a template lock. Deletes the lock from the specified template. The `X-DocuSign-Edit` 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 `X-DocuSign-Edit` 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< Recipients > | DeleteRecipientWithHttpInfo (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< Recipients > | DeleteRecipientAsync (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 `recipientId` being used as the key for deleting recipients. More... | |
ApiResponse< Recipients > | DeleteRecipientsWithHttpInfo (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 `recipientId` being used as the key for deleting recipients. More... | |
async System.Threading.Tasks.Task< Recipients > | DeleteRecipientsAsync (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 `recipientId` 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 `recipientId` 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< Tabs > | DeleteTabsWithHttpInfo (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< Tabs > | DeleteTabsAsync (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 `documentId` in the template specified by `templateId`. More... | |
ApiResponse< Tabs > | DeleteTemplateDocumentTabsWithHttpInfo (string accountId, string templateId, string documentId, TemplateTabs templateTabs=null) |
Deletes tabs from an envelope document Deletes tabs from the document specified by `documentId` in the template specified by `templateId`. More... | |
async System.Threading.Tasks.Task< Tabs > | DeleteTemplateDocumentTabsAsync (string accountId, string templateId, string documentId, TemplateTabs templateTabs=null) |
Deletes tabs from an envelope document Deletes tabs from the document specified by `documentId` in the template specified by `templateId`. 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 `documentId` in the template specified by `templateId`. 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< EnvelopeTemplate > | GetWithHttpInfo (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< EnvelopeTemplate > | GetAsync (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 `combined` 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 `combined` 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 `combined` 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 `combined` 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 `documentId` in the template specified by `templateId`. More... | |
ApiResponse< Tabs > | GetDocumentTabsWithHttpInfo (string accountId, string templateId, string documentId, TemplatesApi.GetDocumentTabsOptions options=null) |
Returns tabs on the document. Returns the tabs on the document specified by `documentId` in the template specified by `templateId`. More... | |
async System.Threading.Tasks.Task< Tabs > | GetDocumentTabsAsync (string accountId, string templateId, string documentId, TemplatesApi.GetDocumentTabsOptions options=null) |
Returns tabs on the document. Returns the tabs on the document specified by `documentId` in the template specified by `templateId`. 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 `documentId` in the template specified by `templateId`. 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 `X-DocuSign-Edit` header field and additional lock information is included in the response. This allows users to recover a lost editing session token and the `X-DocuSign-Edit` header. More... | |
ApiResponse< LockInformation > | GetLockWithHttpInfo (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 `X-DocuSign-Edit` header field and additional lock information is included in the response. This allows users to recover a lost editing session token and the `X-DocuSign-Edit` header. More... | |
async System.Threading.Tasks.Task< LockInformation > | GetLockAsync (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 `X-DocuSign-Edit` header field and additional lock information is included in the response. This allows users to recover a lost editing session token and the `X-DocuSign-Edit` 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 `X-DocuSign-Edit` header field and additional lock information is included in the response. This allows users to recover a lost editing session token and the `X-DocuSign-Edit` 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< Notification > | GetNotificationSettingsWithHttpInfo (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< Notification > | GetNotificationSettingsAsync (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 `pageNumber` of the document specified by `documentId` in the template specified by `templateId`. More... | |
ApiResponse< Tabs > | GetPageTabsWithHttpInfo (string accountId, string templateId, string documentId, string pageNumber) |
Returns tabs on the specified page. Returns the tabs from the page specified by `pageNumber` of the document specified by `documentId` in the template specified by `templateId`. More... | |
async System.Threading.Tasks.Task< Tabs > | GetPageTabsAsync (string accountId, string templateId, string documentId, string pageNumber) |
Returns tabs on the specified page. Returns the tabs from the page specified by `pageNumber` of the document specified by `documentId` in the template specified by `templateId`. 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 `pageNumber` of the document specified by `documentId` in the template specified by `templateId`. 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< PageImages > | GetPagesWithHttpInfo (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< PageImages > | GetPagesAsync (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< DocumentHtmlDefinitionOriginals > | GetTemplateDocumentHtmlDefinitionsWithHttpInfo (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< DocumentHtmlDefinitionOriginals > | GetTemplateDocumentHtmlDefinitionsAsync (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< DocumentHtmlDefinitionOriginals > | GetTemplateHtmlDefinitionsWithHttpInfo (string accountId, string templateId) |
Get the Original HTML Definition used to generate the Responsive HTML for the template. More... | |
async System.Threading.Tasks.Task< DocumentHtmlDefinitionOriginals > | GetTemplateHtmlDefinitionsAsync (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< CustomFields > | ListCustomFieldsWithHttpInfo (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< CustomFields > | ListCustomFieldsAsync (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< DocumentFieldsInformation > | ListDocumentFieldsWithHttpInfo (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< DocumentFieldsInformation > | ListDocumentFieldsAsync (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< TemplateDocumentsResult > | ListDocumentsWithHttpInfo (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< TemplateDocumentsResult > | ListDocumentsAsync (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< Recipients > | ListRecipientsWithHttpInfo (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< Recipients > | ListRecipientsAsync (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< Tabs > | ListTabsWithHttpInfo (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< Tabs > | ListTabsAsync (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< EnvelopeTemplateResults > | ListTemplatesWithHttpInfo (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< EnvelopeTemplateResults > | ListTemplatesAsync (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< TemplateUpdateSummary > | UpdateWithHttpInfo (string accountId, string templateId, EnvelopeTemplate envelopeTemplate=null) |
Updates an existing template. Updates an existing template. More... | |
async System.Threading.Tasks.Task< TemplateUpdateSummary > | UpdateAsync (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< CustomFields > | UpdateCustomFieldsWithHttpInfo (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< CustomFields > | UpdateCustomFieldsAsync (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< EnvelopeDocument > | UpdateDocumentWithHttpInfo (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< EnvelopeDocument > | UpdateDocumentAsync (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< DocumentFieldsInformation > | UpdateDocumentFieldsWithHttpInfo (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< DocumentFieldsInformation > | UpdateDocumentFieldsAsync (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< TemplateDocumentsResult > | UpdateDocumentsWithHttpInfo (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< TemplateDocumentsResult > | UpdateDocumentsAsync (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< GroupInformation > | UpdateGroupShareWithHttpInfo (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< GroupInformation > | UpdateGroupShareAsync (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 `lockedByApp` property information for the specified template. The user and integrator key must match the user specified by the `lockByUser` property and integrator key information and the `X-DocuSign-Edit` header must be included or an error will be generated. More... | |
ApiResponse< LockInformation > | UpdateLockWithHttpInfo (string accountId, string templateId, LockRequest lockRequest=null) |
Updates a template lock. Updates the lock duration time or update the `lockedByApp` property information for the specified template. The user and integrator key must match the user specified by the `lockByUser` property and integrator key information and the `X-DocuSign-Edit` header must be included or an error will be generated. More... | |
async System.Threading.Tasks.Task< LockInformation > | UpdateLockAsync (string accountId, string templateId, LockRequest lockRequest=null) |
Updates a template lock. Updates the lock duration time or update the `lockedByApp` property information for the specified template. The user and integrator key must match the user specified by the `lockByUser` property and integrator key information and the `X-DocuSign-Edit` 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 `lockedByApp` property information for the specified template. The user and integrator key must match the user specified by the `lockByUser` property and integrator key information and the `X-DocuSign-Edit` 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< Notification > | UpdateNotificationSettingsWithHttpInfo (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< Notification > | UpdateNotificationSettingsAsync (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: `email`, `userName`, `routingOrder`, `faxNumber`, `deliveryMethod`, `accessCode`, and `requireIdLookup`. More... | |
ApiResponse< RecipientsUpdateSummary > | UpdateRecipientsWithHttpInfo (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: `email`, `userName`, `routingOrder`, `faxNumber`, `deliveryMethod`, `accessCode`, and `requireIdLookup`. More... | |
async System.Threading.Tasks.Task< RecipientsUpdateSummary > | UpdateRecipientsAsync (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: `email`, `userName`, `routingOrder`, `faxNumber`, `deliveryMethod`, `accessCode`, and `requireIdLookup`. 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: `email`, `userName`, `routingOrder`, `faxNumber`, `deliveryMethod`, `accessCode`, and `requireIdLookup`. 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< Tabs > | UpdateTabsWithHttpInfo (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< Tabs > | UpdateTabsAsync (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 `documentId` in the template specified by `templateId`. More... | |
ApiResponse< Tabs > | UpdateTemplateDocumentTabsWithHttpInfo (string accountId, string templateId, string documentId, TemplateTabs templateTabs=null) |
Updates the tabs for a template Updates tabs in the document specified by `documentId` in the template specified by `templateId`. More... | |
async System.Threading.Tasks.Task< Tabs > | UpdateTemplateDocumentTabsAsync (string accountId, string templateId, string documentId, TemplateTabs templateTabs=null) |
Updates the tabs for a template Updates tabs in the document specified by `documentId` in the template specified by `templateId`. 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 `documentId` in the template specified by `templateId`. 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< Recipients > | CreateRecipientsWithHttpInfo (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< EnvelopeTemplate > | GetWithHttpInfo (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< Tabs > | GetDocumentTabsWithHttpInfo (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< PageImages > | GetPagesWithHttpInfo (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< TemplateDocumentsResult > | ListDocumentsWithHttpInfo (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< Recipients > | ListRecipientsWithHttpInfo (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< Tabs > | ListTabsWithHttpInfo (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< EnvelopeTemplateResults > | ListTemplatesWithHttpInfo (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< EnvelopeDocument > | UpdateDocumentWithHttpInfo (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< RecipientsUpdateSummary > | UpdateRecipientsWithHttpInfo (string accountId, string templateId, TemplateRecipients templateRecipients=null, TemplatesApi.UpdateRecipientsOptions options=null) |
Updates recipients in a template. More... | |
System.Threading.Tasks.Task< Recipients > | CreateRecipientsAsync (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< EnvelopeTemplate > | GetAsync (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< Tabs > | GetDocumentTabsAsync (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< PageImages > | GetPagesAsync (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< TemplateDocumentsResult > | ListDocumentsAsync (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< Recipients > | ListRecipientsAsync (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< Tabs > | ListTabsAsync (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< EnvelopeTemplateResults > | ListTemplatesAsync (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< EnvelopeDocument > | UpdateDocumentAsync (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< RecipientsUpdateSummary > | UpdateRecipientsAsync (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... | |
Represents a collection of functions to interact with the API endpoints
|
inline |
Initializes a new instance of the TemplatesApi class using AplClient object
aplClient | An instance of AplClient |
|
inline |
Creates custom document fields in an existing template document. Creates custom document fields in an existing template document.
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
templateId | The ID of the template being accessed. |
templateCustomFields | (optional) |
Implements DocuSign.eSign.Api.ITemplatesApi.
|
inline |
Creates custom document fields in an existing template document. Creates custom document fields in an existing template document.
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
templateId | The ID of the template being accessed. |
templateCustomFields | (optional) |
Implements DocuSign.eSign.Api.ITemplatesApi.
|
inline |
Creates custom document fields in an existing template document. Creates custom document fields in an existing template document.
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
templateId | The ID of the template being accessed. |
templateCustomFields | (optional) |
Implements DocuSign.eSign.Api.ITemplatesApi.
|
inline |
Creates custom document fields in an existing template document. Creates custom document fields in an existing template document.
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
templateId | The ID of the template being accessed. |
templateCustomFields | (optional) |
Implements DocuSign.eSign.Api.ITemplatesApi.
|
inline |
Creates custom document fields in an existing template document. Creates custom document fields in an existing template document.
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
templateId | The ID of the template being accessed. |
documentId | The ID of the document being accessed. |
documentFieldsInformation | (optional) |
Implements DocuSign.eSign.Api.ITemplatesApi.
|
inline |
Creates custom document fields in an existing template document. Creates custom document fields in an existing template document.
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
templateId | The ID of the template being accessed. |
documentId | The ID of the document being accessed. |
documentFieldsInformation | (optional) |
Implements DocuSign.eSign.Api.ITemplatesApi.
|
inline |
Creates custom document fields in an existing template document. Creates custom document fields in an existing template document.
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
templateId | The ID of the template being accessed. |
documentId | The ID of the document being accessed. |
documentFieldsInformation | (optional) |
Implements DocuSign.eSign.Api.ITemplatesApi.
|
inline |
Creates custom document fields in an existing template document. Creates custom document fields in an existing template document.
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
templateId | The ID of the template being accessed. |
documentId | The ID of the document being accessed. |
documentFieldsInformation | (optional) |
Implements DocuSign.eSign.Api.ITemplatesApi.
|
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.
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
templateId | The ID of the template being accessed. |
templateViewRequest | (optional) |
Implements DocuSign.eSign.Api.ITemplatesApi.
|
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.
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
templateId | The ID of the template being accessed. |
templateViewRequest | (optional) |
Implements DocuSign.eSign.Api.ITemplatesApi.
|
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.
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
templateId | The ID of the template being accessed. |
templateViewRequest | (optional) |
Implements DocuSign.eSign.Api.ITemplatesApi.
|
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.
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
templateId | The ID of the template being accessed. |
templateViewRequest | (optional) |
Implements DocuSign.eSign.Api.ITemplatesApi.
|
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 `canLockEnvelopes` must be set to true for the user).
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
templateId | The ID of the template being accessed. |
lockRequest | (optional) |
Implements DocuSign.eSign.Api.ITemplatesApi.
|
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 `canLockEnvelopes` must be set to true for the user).
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
templateId | The ID of the template being accessed. |
lockRequest | (optional) |
Implements DocuSign.eSign.Api.ITemplatesApi.
|
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 `canLockEnvelopes` must be set to true for the user).
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
templateId | The ID of the template being accessed. |
lockRequest | (optional) |
Implements DocuSign.eSign.Api.ITemplatesApi.
|
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 `canLockEnvelopes` must be set to true for the user).
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
templateId | The ID of the template being accessed. |
lockRequest | (optional) |
Implements DocuSign.eSign.Api.ITemplatesApi.
|
inline |
Adds tabs for a recipient. Adds one or more recipients to a template.
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
templateId | The ID of the template being accessed. |
templateRecipients | (optional) |
options | Options for modifying the behavior of the function. |
|
inline |
Adds tabs for a recipient. Adds one or more recipients to a template.
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
templateId | The ID of the template being accessed. |
templateRecipients | (optional) |
options | Options for modifying the behavior of the function. |
|
inline |
Adds tabs for a recipient. Adds one or more recipients to a template.
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
templateId | The ID of the template being accessed. |
templateRecipients | (optional) |
options | Options for modifying the behavior of the function. |
|
inline |
Adds tabs for a recipient. Adds one or more recipients to a template.
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
templateId | The ID of the template being accessed. |
templateRecipients | (optional) |
options | Options for modifying the behavior of the function. |
|
inline |
Adds tabs for a recipient. Adds one or more tabs for a recipient.
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
templateId | The ID of the template being accessed. |
recipientId | The ID of the recipient being accessed. |
templateTabs | (optional) |
Implements DocuSign.eSign.Api.ITemplatesApi.
|
inline |
Adds tabs for a recipient. Adds one or more tabs for a recipient.
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
templateId | The ID of the template being accessed. |
recipientId | The ID of the recipient being accessed. |
templateTabs | (optional) |
Implements DocuSign.eSign.Api.ITemplatesApi.
|
inline |
Adds tabs for a recipient. Adds one or more tabs for a recipient.
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
templateId | The ID of the template being accessed. |
recipientId | The ID of the recipient being accessed. |
templateTabs | (optional) |
Implements DocuSign.eSign.Api.ITemplatesApi.
|
inline |
Adds tabs for a recipient. Adds one or more tabs for a recipient.
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
templateId | The ID of the template being accessed. |
recipientId | The ID of the recipient being accessed. |
templateTabs | (optional) |
Implements DocuSign.eSign.Api.ITemplatesApi.
|
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's role name, are added to the `emailSubject` 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's name in the subject line add the following text in the `emailSubject` property when creating the template or when sending an envelope from a template: [[<roleName>_UserName]] Example: `"emailSubject":"[[Signer 1_UserName]], Please sign this NDA",` To add a recipient's email address in the subject line add the following text in the `emailSubject` property when creating the template or when sending an envelope from a template: [[<roleName>_Email]] Example: `"emailSubject":"[[Signer 1_Email]], Please sign this NDA",` In both cases the <roleName> is the recipient's contents of the `roleName` 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.
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
envelopeTemplate | (optional) |
Implements DocuSign.eSign.Api.ITemplatesApi.
|
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's role name, are added to the `emailSubject` 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's name in the subject line add the following text in the `emailSubject` property when creating the template or when sending an envelope from a template: [[<roleName>_UserName]] Example: `"emailSubject":"[[Signer 1_UserName]], Please sign this NDA",` To add a recipient's email address in the subject line add the following text in the `emailSubject` property when creating the template or when sending an envelope from a template: [[<roleName>_Email]] Example: `"emailSubject":"[[Signer 1_Email]], Please sign this NDA",` In both cases the <roleName> is the recipient's contents of the `roleName` 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.
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
envelopeTemplate | (optional) |
Implements DocuSign.eSign.Api.ITemplatesApi.
|
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's role name, are added to the `emailSubject` 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's name in the subject line add the following text in the `emailSubject` property when creating the template or when sending an envelope from a template: [[<roleName>_UserName]] Example: `"emailSubject":"[[Signer 1_UserName]], Please sign this NDA",` To add a recipient's email address in the subject line add the following text in the `emailSubject` property when creating the template or when sending an envelope from a template: [[<roleName>_Email]] Example: `"emailSubject":"[[Signer 1_Email]], Please sign this NDA",` In both cases the <roleName> is the recipient's contents of the `roleName` 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.
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
envelopeTemplate | (optional) |
Implements DocuSign.eSign.Api.ITemplatesApi.
|
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 `documentHtmlDefinition` object, which holds the responsive signing parameters that define how to generate the HTML version of the signing document.
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
templateId | The ID of the template being accessed. |
documentId | The ID of the document being accessed. |
documentHtmlDefinition | (optional) |
Implements DocuSign.eSign.Api.ITemplatesApi.
|
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 `documentHtmlDefinition` object, which holds the responsive signing parameters that define how to generate the HTML version of the signing document.
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
templateId | The ID of the template being accessed. |
documentId | The ID of the document being accessed. |
documentHtmlDefinition | (optional) |
Implements DocuSign.eSign.Api.ITemplatesApi.
|
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 `documentHtmlDefinition` object, which holds the responsive signing parameters that define how to generate the HTML version of the signing document.
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
templateId | The ID of the template being accessed. |
documentId | The ID of the document being accessed. |
documentHtmlDefinition | (optional) |
Implements DocuSign.eSign.Api.ITemplatesApi.
|
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 `documentHtmlDefinition` object, which holds the responsive signing parameters that define how to generate the HTML version of the signing document.
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
templateId | The ID of the template being accessed. |
documentId | The ID of the document being accessed. |
documentHtmlDefinition | (optional) |
Implements DocuSign.eSign.Api.ITemplatesApi.
|
inline |
Adds the tabs to a tempate Adds tabs to the document specified by `documentId` in the template specified by `templateId`. 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: ``` { "prefillTabs": { "textTabs": [ { "value": "a prefill text tab", "pageNumber": "1", "documentId": "1", "xPosition": 316, "yPosition": 97 } ] } } ```
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
templateId | The ID of the template being accessed. |
documentId | The ID of the document being accessed. |
templateTabs | (optional) |
Implements DocuSign.eSign.Api.ITemplatesApi.
|
inline |
Adds the tabs to a tempate Adds tabs to the document specified by `documentId` in the template specified by `templateId`. 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: ``` { "prefillTabs": { "textTabs": [ { "value": "a prefill text tab", "pageNumber": "1", "documentId": "1", "xPosition": 316, "yPosition": 97 } ] } } ```
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
templateId | The ID of the template being accessed. |
documentId | The ID of the document being accessed. |
templateTabs | (optional) |
Implements DocuSign.eSign.Api.ITemplatesApi.
|
inline |
Adds the tabs to a tempate Adds tabs to the document specified by `documentId` in the template specified by `templateId`. 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: ``` { "prefillTabs": { "textTabs": [ { "value": "a prefill text tab", "pageNumber": "1", "documentId": "1", "xPosition": 316, "yPosition": 97 } ] } } ```
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
templateId | The ID of the template being accessed. |
documentId | The ID of the document being accessed. |
templateTabs | (optional) |
Implements DocuSign.eSign.Api.ITemplatesApi.
|
inline |
Adds the tabs to a tempate Adds tabs to the document specified by `documentId` in the template specified by `templateId`. 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: ``` { "prefillTabs": { "textTabs": [ { "value": "a prefill text tab", "pageNumber": "1", "documentId": "1", "xPosition": 316, "yPosition": 97 } ] } } ```
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
templateId | The ID of the template being accessed. |
documentId | The ID of the document being accessed. |
templateTabs | (optional) |
Implements DocuSign.eSign.Api.ITemplatesApi.
|
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' experience. For more information, see Preview and Send.
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
templateId | The ID of the template being accessed. |
recipientPreviewRequest | (optional) |
Implements DocuSign.eSign.Api.ITemplatesApi.
|
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' experience. For more information, see Preview and Send.
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
templateId | The ID of the template being accessed. |
recipientPreviewRequest | (optional) |
Implements DocuSign.eSign.Api.ITemplatesApi.
|
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' experience. For more information, see Preview and Send.
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
templateId | The ID of the template being accessed. |
recipientPreviewRequest | (optional) |
Implements DocuSign.eSign.Api.ITemplatesApi.
|
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' experience. For more information, see Preview and Send.
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
templateId | The ID of the template being accessed. |
recipientPreviewRequest | (optional) |
Implements DocuSign.eSign.Api.ITemplatesApi.
|
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 `documentHtmlDefinition` object, which holds the responsive signing parameters that define how to generate the HTML version of the documents.
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
templateId | The ID of the template being accessed. |
documentHtmlDefinition | (optional) |
Implements DocuSign.eSign.Api.ITemplatesApi.
|
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 `documentHtmlDefinition` object, which holds the responsive signing parameters that define how to generate the HTML version of the documents.
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
templateId | The ID of the template being accessed. |
documentHtmlDefinition | (optional) |
Implements DocuSign.eSign.Api.ITemplatesApi.
|
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 `documentHtmlDefinition` object, which holds the responsive signing parameters that define how to generate the HTML version of the documents.
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
templateId | The ID of the template being accessed. |
documentHtmlDefinition | (optional) |
Implements DocuSign.eSign.Api.ITemplatesApi.
|
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 `documentHtmlDefinition` object, which holds the responsive signing parameters that define how to generate the HTML version of the documents.
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
templateId | The ID of the template being accessed. |
documentHtmlDefinition | (optional) |
Implements DocuSign.eSign.Api.ITemplatesApi.
|
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's role name, are added to the `emailSubject` 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's name in the subject line add the following text in the `emailSubject` property when creating the template or when sending an envelope from a template: [[<roleName>_UserName]] Example: `"emailSubject":"[[Signer 1_UserName]], Please sign this NDA",` To add a recipient's email address in the subject line add the following text in the `emailSubject` property when creating the template or when sending an envelope from a template: [[<roleName>_Email]] Example: `"emailSubject":"[[Signer 1_Email]], Please sign this NDA",` In both cases the <roleName> is the recipient's contents of the `roleName` 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.
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
envelopeTemplate | (optional) |
Implements DocuSign.eSign.Api.ITemplatesApi.
|
inline |
Deletes envelope custom fields in a template. Deletes envelope custom fields in a template.
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
templateId | The ID of the template being accessed. |
templateCustomFields | (optional) |
Implements DocuSign.eSign.Api.ITemplatesApi.
|
inline |
Deletes envelope custom fields in a template. Deletes envelope custom fields in a template.
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
templateId | The ID of the template being accessed. |
templateCustomFields | (optional) |
Implements DocuSign.eSign.Api.ITemplatesApi.
|
inline |
Deletes envelope custom fields in a template. Deletes envelope custom fields in a template.
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
templateId | The ID of the template being accessed. |
templateCustomFields | (optional) |
Implements DocuSign.eSign.Api.ITemplatesApi.
|
inline |
Deletes envelope custom fields in a template. Deletes envelope custom fields in a template.
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
templateId | The ID of the template being accessed. |
templateCustomFields | (optional) |
Implements DocuSign.eSign.Api.ITemplatesApi.
|
inline |
Deletes custom document fields from an existing template document. Deletes custom document fields from an existing template document.
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
templateId | The ID of the template being accessed. |
documentId | The ID of the document being accessed. |
documentFieldsInformation | (optional) |
Implements DocuSign.eSign.Api.ITemplatesApi.
|
inline |
Deletes custom document fields from an existing template document. Deletes custom document fields from an existing template document.
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
templateId | The ID of the template being accessed. |
documentId | The ID of the document being accessed. |
documentFieldsInformation | (optional) |
Implements DocuSign.eSign.Api.ITemplatesApi.
|
inline |
Deletes custom document fields from an existing template document. Deletes custom document fields from an existing template document.
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
templateId | The ID of the template being accessed. |
documentId | The ID of the document being accessed. |
documentFieldsInformation | (optional) |
Implements DocuSign.eSign.Api.ITemplatesApi.
|
inline |
Deletes custom document fields from an existing template document. Deletes custom document fields from an existing template document.
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
templateId | The ID of the template being accessed. |
documentId | The ID of the document being accessed. |
documentFieldsInformation | (optional) |
Implements DocuSign.eSign.Api.ITemplatesApi.
|
inline |
Deletes a page from a document in an template. Deletes a page from a document in a template based on the page number.
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
templateId | The ID of the template being accessed. |
documentId | The ID of the document being accessed. |
pageNumber | The page number being accessed. |
pageRequest | (optional) |
Implements DocuSign.eSign.Api.ITemplatesApi.
|
inline |
Deletes a page from a document in an template. Deletes a page from a document in a template based on the page number.
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
templateId | The ID of the template being accessed. |
documentId | The ID of the document being accessed. |
pageNumber | The page number being accessed. |
pageRequest | (optional) |
Implements DocuSign.eSign.Api.ITemplatesApi.
|
inline |
Deletes a page from a document in an template. Deletes a page from a document in a template based on the page number.
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
templateId | The ID of the template being accessed. |
documentId | The ID of the document being accessed. |
pageNumber | The page number being accessed. |
pageRequest | (optional) |
Implements DocuSign.eSign.Api.ITemplatesApi.
|
inline |
Deletes a page from a document in an template. Deletes a page from a document in a template based on the page number.
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
templateId | The ID of the template being accessed. |
documentId | The ID of the document being accessed. |
pageNumber | The page number being accessed. |
pageRequest | (optional) |
Implements DocuSign.eSign.Api.ITemplatesApi.
|
inline |
Deletes documents from a template. Deletes one or more documents from an existing template.
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
templateId | The ID of the template being accessed. |
envelopeDefinition | (optional) |
Implements DocuSign.eSign.Api.ITemplatesApi.
|
inline |
Deletes documents from a template. Deletes one or more documents from an existing template.
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
templateId | The ID of the template being accessed. |
envelopeDefinition | (optional) |
Implements DocuSign.eSign.Api.ITemplatesApi.
|
inline |
Deletes documents from a template. Deletes one or more documents from an existing template.
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
templateId | The ID of the template being accessed. |
envelopeDefinition | (optional) |
Implements DocuSign.eSign.Api.ITemplatesApi.
|
inline |
Deletes documents from a template. Deletes one or more documents from an existing template.
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
templateId | The ID of the template being accessed. |
envelopeDefinition | (optional) |
Implements DocuSign.eSign.Api.ITemplatesApi.
|
inline |
Removes a member group's sharing permissions for a template. Removes a member group's sharing permissions for a specified template.
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
templateId | The ID of the template being accessed. |
templatePart | Currently, the only defined part is groups. |
groupInformation | (optional) |
Implements DocuSign.eSign.Api.ITemplatesApi.
|
inline |
Removes a member group's sharing permissions for a template. Removes a member group's sharing permissions for a specified template.
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
templateId | The ID of the template being accessed. |
templatePart | Currently, the only defined part is groups. |
groupInformation | (optional) |
Implements DocuSign.eSign.Api.ITemplatesApi.
|
inline |
Removes a member group's sharing permissions for a template. Removes a member group's sharing permissions for a specified template.
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
templateId | The ID of the template being accessed. |
templatePart | Currently, the only defined part is groups. |
groupInformation | (optional) |
Implements DocuSign.eSign.Api.ITemplatesApi.
|
inline |
Removes a member group's sharing permissions for a template. Removes a member group's sharing permissions for a specified template.
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
templateId | The ID of the template being accessed. |
templatePart | Currently, the only defined part is groups. |
groupInformation | (optional) |
Implements DocuSign.eSign.Api.ITemplatesApi.
|
inline |
Deletes a template lock. Deletes the lock from the specified template. The `X-DocuSign-Edit` header must be included in the request.
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
templateId | The ID of the template being accessed. |
lockRequest | (optional) |
Implements DocuSign.eSign.Api.ITemplatesApi.
|
inline |
Deletes a template lock. Deletes the lock from the specified template. The `X-DocuSign-Edit` header must be included in the request.
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
templateId | The ID of the template being accessed. |
lockRequest | (optional) |
Implements DocuSign.eSign.Api.ITemplatesApi.
|
inline |
Deletes a template lock. Deletes the lock from the specified template. The `X-DocuSign-Edit` header must be included in the request.
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
templateId | The ID of the template being accessed. |
lockRequest | (optional) |
Implements DocuSign.eSign.Api.ITemplatesApi.
|
inline |
Deletes a template lock. Deletes the lock from the specified template. The `X-DocuSign-Edit` header must be included in the request.
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
templateId | The ID of the template being accessed. |
lockRequest | (optional) |
Implements DocuSign.eSign.Api.ITemplatesApi.
|
inline |
Deletes the specified recipient file from a template. Deletes the specified recipient file from the specified template.
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
templateId | The ID of the template being accessed. |
recipientId | The ID of the recipient being accessed. |
templateRecipients | (optional) |
Implements DocuSign.eSign.Api.ITemplatesApi.
|
inline |
Deletes the specified recipient file from a template. Deletes the specified recipient file from the specified template.
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
templateId | The ID of the template being accessed. |
recipientId | The ID of the recipient being accessed. |
templateRecipients | (optional) |
Implements DocuSign.eSign.Api.ITemplatesApi.
|
inline |
Deletes the specified recipient file from a template. Deletes the specified recipient file from the specified template.
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
templateId | The ID of the template being accessed. |
recipientId | The ID of the recipient being accessed. |
templateRecipients | (optional) |
Implements DocuSign.eSign.Api.ITemplatesApi.
|
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 `recipientId` being used as the key for deleting recipients.
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
templateId | The ID of the template being accessed. |
templateRecipients | (optional) |
Implements DocuSign.eSign.Api.ITemplatesApi.
|
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 `recipientId` being used as the key for deleting recipients.
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
templateId | The ID of the template being accessed. |
templateRecipients | (optional) |
Implements DocuSign.eSign.Api.ITemplatesApi.
|
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 `recipientId` being used as the key for deleting recipients.
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
templateId | The ID of the template being accessed. |
templateRecipients | (optional) |
Implements DocuSign.eSign.Api.ITemplatesApi.
|
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 `recipientId` being used as the key for deleting recipients.
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
templateId | The ID of the template being accessed. |
templateRecipients | (optional) |
Implements DocuSign.eSign.Api.ITemplatesApi.
|
inline |
Deletes the specified recipient file from a template. Deletes the specified recipient file from the specified template.
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
templateId | The ID of the template being accessed. |
recipientId | The ID of the recipient being accessed. |
templateRecipients | (optional) |
Implements DocuSign.eSign.Api.ITemplatesApi.
|
inline |
Deletes the tabs associated with a recipient in a template. Deletes one or more tabs associated with a recipient in a template.
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
templateId | The ID of the template being accessed. |
recipientId | The ID of the recipient being accessed. |
templateTabs | (optional) |
Implements DocuSign.eSign.Api.ITemplatesApi.
|
inline |
Deletes the tabs associated with a recipient in a template. Deletes one or more tabs associated with a recipient in a template.
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
templateId | The ID of the template being accessed. |
recipientId | The ID of the recipient being accessed. |
templateTabs | (optional) |
Implements DocuSign.eSign.Api.ITemplatesApi.
|
inline |
Deletes the tabs associated with a recipient in a template. Deletes one or more tabs associated with a recipient in a template.
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
templateId | The ID of the template being accessed. |
recipientId | The ID of the recipient being accessed. |
templateTabs | (optional) |
Implements DocuSign.eSign.Api.ITemplatesApi.
|
inline |
Deletes the tabs associated with a recipient in a template. Deletes one or more tabs associated with a recipient in a template.
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
templateId | The ID of the template being accessed. |
recipientId | The ID of the recipient being accessed. |
templateTabs | (optional) |
Implements DocuSign.eSign.Api.ITemplatesApi.
|
inline |
Deletes tabs from an envelope document Deletes tabs from the document specified by `documentId` in the template specified by `templateId`.
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
templateId | The ID of the template being accessed. |
documentId | The ID of the document being accessed. |
templateTabs | (optional) |
Implements DocuSign.eSign.Api.ITemplatesApi.
|
inline |
Deletes tabs from an envelope document Deletes tabs from the document specified by `documentId` in the template specified by `templateId`.
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
templateId | The ID of the template being accessed. |
documentId | The ID of the document being accessed. |
templateTabs | (optional) |
Implements DocuSign.eSign.Api.ITemplatesApi.
|
inline |
Deletes tabs from an envelope document Deletes tabs from the document specified by `documentId` in the template specified by `templateId`.
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
templateId | The ID of the template being accessed. |
documentId | The ID of the document being accessed. |
templateTabs | (optional) |
Implements DocuSign.eSign.Api.ITemplatesApi.
|
inline |
Deletes tabs from an envelope document Deletes tabs from the document specified by `documentId` in the template specified by `templateId`.
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
templateId | The ID of the template being accessed. |
documentId | The ID of the document being accessed. |
templateTabs | (optional) |
Implements DocuSign.eSign.Api.ITemplatesApi.
|
inline |
Gets a list of templates for a specified account. Retrieves the definition of the specified template.
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
templateId | The ID of the template being accessed. |
options | Options for modifying the behavior of the function. |
|
inline |
Gets a list of templates for a specified account. Retrieves the definition of the specified template.
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
templateId | The ID of the template being accessed. |
options | Options for modifying the behavior of the function. |
|
inline |
Gets a list of templates for a specified account. Retrieves the definition of the specified template.
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
templateId | The ID of the template being accessed. |
options | Options for modifying the behavior of the function. |
|
inline |
|
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 `combined` to retrieve all documents in the template as one pdf.
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
templateId | The ID of the template being accessed. |
documentId | The ID of the document being accessed. |
options | Options for modifying the behavior of the function. |
|
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 `combined` to retrieve all documents in the template as one pdf.
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
templateId | The ID of the template being accessed. |
documentId | The ID of the document being accessed. |
options | Options for modifying the behavior of the function. |
|
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 `combined` to retrieve all documents in the template as one pdf.
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
templateId | The ID of the template being accessed. |
documentId | The ID of the document being accessed. |
options | Options for modifying the behavior of the function. |
|
inline |
Gets a page image from a template for display. Retrieves a page image for display from the specified template.
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
templateId | The ID of the template being accessed. |
documentId | The ID of the document being accessed. |
pageNumber | The page number being accessed. |
options | Options for modifying the behavior of the function. |
|
inline |
Gets a page image from a template for display. Retrieves a page image for display from the specified template.
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
templateId | The ID of the template being accessed. |
documentId | The ID of the document being accessed. |
pageNumber | The page number being accessed. |
options | Options for modifying the behavior of the function. |
|
inline |
Gets a page image from a template for display. Retrieves a page image for display from the specified template.
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
templateId | The ID of the template being accessed. |
documentId | The ID of the document being accessed. |
pageNumber | The page number being accessed. |
options | Options for modifying the behavior of the function. |
|
inline |
Gets a page image from a template for display. Retrieves a page image for display from the specified template.
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
templateId | The ID of the template being accessed. |
documentId | The ID of the document being accessed. |
pageNumber | The page number being accessed. |
options | Options for modifying the behavior of the function. |
|
inline |
Returns tabs on the document. Returns the tabs on the document specified by `documentId` in the template specified by `templateId`.
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
templateId | The ID of the template being accessed. |
documentId | The ID of the document being accessed. |
options | Options for modifying the behavior of the function. |
|
inline |
Returns tabs on the document. Returns the tabs on the document specified by `documentId` in the template specified by `templateId`.
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
templateId | The ID of the template being accessed. |
documentId | The ID of the document being accessed. |
options | Options for modifying the behavior of the function. |
|
inline |
Returns tabs on the document. Returns the tabs on the document specified by `documentId` in the template specified by `templateId`.
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
templateId | The ID of the template being accessed. |
documentId | The ID of the document being accessed. |
options | Options for modifying the behavior of the function. |
|
inline |
Returns tabs on the document. Returns the tabs on the document specified by `documentId` in the template specified by `templateId`.
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
templateId | The ID of the template being accessed. |
documentId | The ID of the document being accessed. |
options | Options for modifying the behavior of the function. |
|
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 `combined` to retrieve all documents in the template as one pdf.
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
templateId | The ID of the template being accessed. |
documentId | The ID of the document being accessed. |
options | Options for modifying the behavior of the function. |
|
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 `X-DocuSign-Edit` header field and additional lock information is included in the response. This allows users to recover a lost editing session token and the `X-DocuSign-Edit` header.
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
templateId | The ID of the template being accessed. |
Implements DocuSign.eSign.Api.ITemplatesApi.
|
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 `X-DocuSign-Edit` header field and additional lock information is included in the response. This allows users to recover a lost editing session token and the `X-DocuSign-Edit` header.
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
templateId | The ID of the template being accessed. |
Implements DocuSign.eSign.Api.ITemplatesApi.
|
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 `X-DocuSign-Edit` header field and additional lock information is included in the response. This allows users to recover a lost editing session token and the `X-DocuSign-Edit` header.
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
templateId | The ID of the template being accessed. |
Implements DocuSign.eSign.Api.ITemplatesApi.
|
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 `X-DocuSign-Edit` header field and additional lock information is included in the response. This allows users to recover a lost editing session token and the `X-DocuSign-Edit` header.
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
templateId | The ID of the template being accessed. |
Implements DocuSign.eSign.Api.ITemplatesApi.
|
inline |
Gets template notification information. Retrieves the envelope notification, reminders and expirations, information for an existing template.
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
templateId | The ID of the template being accessed. |
Implements DocuSign.eSign.Api.ITemplatesApi.
|
inline |
Gets template notification information. Retrieves the envelope notification, reminders and expirations, information for an existing template.
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
templateId | The ID of the template being accessed. |
Implements DocuSign.eSign.Api.ITemplatesApi.
|
inline |
Gets template notification information. Retrieves the envelope notification, reminders and expirations, information for an existing template.
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
templateId | The ID of the template being accessed. |
Implements DocuSign.eSign.Api.ITemplatesApi.
|
inline |
Gets template notification information. Retrieves the envelope notification, reminders and expirations, information for an existing template.
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
templateId | The ID of the template being accessed. |
Implements DocuSign.eSign.Api.ITemplatesApi.
|
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.
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
templateId | The ID of the template being accessed. |
documentId | The ID of the document being accessed. |
options | Options for modifying the behavior of the function. |
|
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.
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
templateId | The ID of the template being accessed. |
documentId | The ID of the document being accessed. |
options | Options for modifying the behavior of the function. |
|
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.
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
templateId | The ID of the template being accessed. |
documentId | The ID of the document being accessed. |
options | Options for modifying the behavior of the function. |
|
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.
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
templateId | The ID of the template being accessed. |
documentId | The ID of the document being accessed. |
options | Options for modifying the behavior of the function. |
|
inline |
Returns tabs on the specified page. Returns the tabs from the page specified by `pageNumber` of the document specified by `documentId` in the template specified by `templateId`.
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
templateId | The ID of the template being accessed. |
documentId | The ID of the document being accessed. |
pageNumber | The page number being accessed. |
Implements DocuSign.eSign.Api.ITemplatesApi.
|
inline |
Returns tabs on the specified page. Returns the tabs from the page specified by `pageNumber` of the document specified by `documentId` in the template specified by `templateId`.
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
templateId | The ID of the template being accessed. |
documentId | The ID of the document being accessed. |
pageNumber | The page number being accessed. |
Implements DocuSign.eSign.Api.ITemplatesApi.
|
inline |
Returns tabs on the specified page. Returns the tabs from the page specified by `pageNumber` of the document specified by `documentId` in the template specified by `templateId`.
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
templateId | The ID of the template being accessed. |
documentId | The ID of the document being accessed. |
pageNumber | The page number being accessed. |
Implements DocuSign.eSign.Api.ITemplatesApi.
|
inline |
Returns tabs on the specified page. Returns the tabs from the page specified by `pageNumber` of the document specified by `documentId` in the template specified by `templateId`.
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
templateId | The ID of the template being accessed. |
documentId | The ID of the document being accessed. |
pageNumber | The page number being accessed. |
Implements DocuSign.eSign.Api.ITemplatesApi.
|
inline |
Get the Original HTML Definition used to generate the Responsive HTML for a given document in a template.
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
templateId | The ID of the template being accessed. |
documentId | The ID of the document being accessed. |
Implements DocuSign.eSign.Api.ITemplatesApi.
|
inline |
Get the Original HTML Definition used to generate the Responsive HTML for a given document in a template.
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
templateId | The ID of the template being accessed. |
documentId | The ID of the document being accessed. |
Implements DocuSign.eSign.Api.ITemplatesApi.
|
inline |
Get the Original HTML Definition used to generate the Responsive HTML for a given document in a template.
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
templateId | The ID of the template being accessed. |
documentId | The ID of the document being accessed. |
Implements DocuSign.eSign.Api.ITemplatesApi.
|
inline |
Get the Original HTML Definition used to generate the Responsive HTML for a given document in a template.
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
templateId | The ID of the template being accessed. |
documentId | The ID of the document being accessed. |
Implements DocuSign.eSign.Api.ITemplatesApi.
|
inline |
Get the Original HTML Definition used to generate the Responsive HTML for the template.
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
templateId | The ID of the template being accessed. |
Implements DocuSign.eSign.Api.ITemplatesApi.
|
inline |
Get the Original HTML Definition used to generate the Responsive HTML for the template.
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
templateId | The ID of the template being accessed. |
Implements DocuSign.eSign.Api.ITemplatesApi.
|
inline |
Get the Original HTML Definition used to generate the Responsive HTML for the template.
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
templateId | The ID of the template being accessed. |
Implements DocuSign.eSign.Api.ITemplatesApi.
|
inline |
Get the Original HTML Definition used to generate the Responsive HTML for the template.
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
templateId | The ID of the template being accessed. |
Implements DocuSign.eSign.Api.ITemplatesApi.
|
inline |
Gets a list of templates for a specified account. Retrieves the definition of the specified template.
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
templateId | The ID of the template being accessed. |
options | Options for modifying the behavior of the function. |
|
inline |
Gets the custom document fields from a template. Retrieves the custom document field information from an existing template.
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
templateId | The ID of the template being accessed. |
Implements DocuSign.eSign.Api.ITemplatesApi.
|
inline |
Gets the custom document fields from a template. Retrieves the custom document field information from an existing template.
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
templateId | The ID of the template being accessed. |
Implements DocuSign.eSign.Api.ITemplatesApi.
|
inline |
Gets the custom document fields from a template. Retrieves the custom document field information from an existing template.
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
templateId | The ID of the template being accessed. |
Implements DocuSign.eSign.Api.ITemplatesApi.
|
inline |
Gets the custom document fields from a template. Retrieves the custom document field information from an existing template.
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
templateId | The ID of the template being accessed. |
Implements DocuSign.eSign.Api.ITemplatesApi.
|
inline |
Gets the custom document fields for a an existing template document. Retrieves the custom document fields for an existing template document.
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
templateId | The ID of the template being accessed. |
documentId | The ID of the document being accessed. |
Implements DocuSign.eSign.Api.ITemplatesApi.
|
inline |
Gets the custom document fields for a an existing template document. Retrieves the custom document fields for an existing template document.
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
templateId | The ID of the template being accessed. |
documentId | The ID of the document being accessed. |
Implements DocuSign.eSign.Api.ITemplatesApi.
|
inline |
Gets the custom document fields for a an existing template document. Retrieves the custom document fields for an existing template document.
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
templateId | The ID of the template being accessed. |
documentId | The ID of the document being accessed. |
Implements DocuSign.eSign.Api.ITemplatesApi.
|
inline |
Gets the custom document fields for a an existing template document. Retrieves the custom document fields for an existing template document.
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
templateId | The ID of the template being accessed. |
documentId | The ID of the document being accessed. |
Implements DocuSign.eSign.Api.ITemplatesApi.
|
inline |
Gets a list of documents associated with a template. Retrieves a list of documents associated with the specified template.
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
templateId | The ID of the template being accessed. |
options | Options for modifying the behavior of the function. |
|
inline |
Gets a list of documents associated with a template. Retrieves a list of documents associated with the specified template.
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
templateId | The ID of the template being accessed. |
options | Options for modifying the behavior of the function. |
|
inline |
Gets a list of documents associated with a template. Retrieves a list of documents associated with the specified template.
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
templateId | The ID of the template being accessed. |
options | Options for modifying the behavior of the function. |
|
inline |
Gets a list of documents associated with a template. Retrieves a list of documents associated with the specified template.
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
templateId | The ID of the template being accessed. |
options | Options for modifying the behavior of the function. |
|
inline |
Gets recipient information from a template. Retrieves the information for all recipients in the specified template.
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
templateId | The ID of the template being accessed. |
options | Options for modifying the behavior of the function. |
|
inline |
Gets recipient information from a template. Retrieves the information for all recipients in the specified template.
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
templateId | The ID of the template being accessed. |
options | Options for modifying the behavior of the function. |
|
inline |
Gets recipient information from a template. Retrieves the information for all recipients in the specified template.
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
templateId | The ID of the template being accessed. |
options | Options for modifying the behavior of the function. |
|
inline |
Gets recipient information from a template. Retrieves the information for all recipients in the specified template.
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
templateId | The ID of the template being accessed. |
options | Options for modifying the behavior of the function. |
|
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.
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
templateId | The ID of the template being accessed. |
recipientId | The ID of the recipient being accessed. |
options | Options for modifying the behavior of the function. |
|
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.
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
templateId | The ID of the template being accessed. |
recipientId | The ID of the recipient being accessed. |
options | Options for modifying the behavior of the function. |
|
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.
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
templateId | The ID of the template being accessed. |
recipientId | The ID of the recipient being accessed. |
options | Options for modifying the behavior of the function. |
|
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.
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
templateId | The ID of the template being accessed. |
recipientId | The ID of the recipient being accessed. |
options | Options for modifying the behavior of the function. |
|
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.
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
options | Options for modifying the behavior of the function. |
|
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.
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
options | Options for modifying the behavior of the function. |
|
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.
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
options | Options for modifying the behavior of the function. |
|
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.
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
options | Options for modifying the behavior of the function. |
|
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.
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
templateId | The ID of the template being accessed. |
documentId | The ID of the document being accessed. |
pageNumber | The page number being accessed. |
pageRequest | (optional) |
Implements DocuSign.eSign.Api.ITemplatesApi.
|
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.
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
templateId | The ID of the template being accessed. |
documentId | The ID of the document being accessed. |
pageNumber | The page number being accessed. |
pageRequest | (optional) |
Implements DocuSign.eSign.Api.ITemplatesApi.
|
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.
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
templateId | The ID of the template being accessed. |
documentId | The ID of the document being accessed. |
pageNumber | The page number being accessed. |
pageRequest | (optional) |
Implements DocuSign.eSign.Api.ITemplatesApi.
|
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.
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
templateId | The ID of the template being accessed. |
documentId | The ID of the document being accessed. |
pageNumber | The page number being accessed. |
pageRequest | (optional) |
Implements DocuSign.eSign.Api.ITemplatesApi.
|
inline |
Updates an existing template. Updates an existing template.
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
templateId | The ID of the template being accessed. |
envelopeTemplate | (optional) |
Implements DocuSign.eSign.Api.ITemplatesApi.
|
inline |
Updates an existing template. Updates an existing template.
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
templateId | The ID of the template being accessed. |
envelopeTemplate | (optional) |
Implements DocuSign.eSign.Api.ITemplatesApi.
|
inline |
Updates an existing template. Updates an existing template.
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
templateId | The ID of the template being accessed. |
envelopeTemplate | (optional) |
Implements DocuSign.eSign.Api.ITemplatesApi.
|
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.
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
templateId | The ID of the template being accessed. |
templateCustomFields | (optional) |
Implements DocuSign.eSign.Api.ITemplatesApi.
|
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.
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
templateId | The ID of the template being accessed. |
templateCustomFields | (optional) |
Implements DocuSign.eSign.Api.ITemplatesApi.
|
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.
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
templateId | The ID of the template being accessed. |
templateCustomFields | (optional) |
Implements DocuSign.eSign.Api.ITemplatesApi.
|
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.
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
templateId | The ID of the template being accessed. |
templateCustomFields | (optional) |
Implements DocuSign.eSign.Api.ITemplatesApi.
|
inline |
Adds a document to a template document. Adds the specified document to an existing template document.
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
templateId | The ID of the template being accessed. |
documentId | The ID of the document being accessed. |
envelopeDefinition | (optional) |
options | Options for modifying the behavior of the function. |
|
inline |
Adds a document to a template document. Adds the specified document to an existing template document.
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
templateId | The ID of the template being accessed. |
documentId | The ID of the document being accessed. |
envelopeDefinition | (optional) |
options | Options for modifying the behavior of the function. |
|
inline |
Adds a document to a template document. Adds the specified document to an existing template document.
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
templateId | The ID of the template being accessed. |
documentId | The ID of the document being accessed. |
envelopeDefinition | (optional) |
options | Options for modifying the behavior of the function. |
|
inline |
Updates existing custom document fields in an existing template document. Updates existing custom document fields in an existing template document.
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
templateId | The ID of the template being accessed. |
documentId | The ID of the document being accessed. |
documentFieldsInformation | (optional) |
Implements DocuSign.eSign.Api.ITemplatesApi.
|
inline |
Updates existing custom document fields in an existing template document. Updates existing custom document fields in an existing template document.
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
templateId | The ID of the template being accessed. |
documentId | The ID of the document being accessed. |
documentFieldsInformation | (optional) |
Implements DocuSign.eSign.Api.ITemplatesApi.
|
inline |
Updates existing custom document fields in an existing template document. Updates existing custom document fields in an existing template document.
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
templateId | The ID of the template being accessed. |
documentId | The ID of the document being accessed. |
documentFieldsInformation | (optional) |
Implements DocuSign.eSign.Api.ITemplatesApi.
|
inline |
Updates existing custom document fields in an existing template document. Updates existing custom document fields in an existing template document.
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
templateId | The ID of the template being accessed. |
documentId | The ID of the document being accessed. |
documentFieldsInformation | (optional) |
Implements DocuSign.eSign.Api.ITemplatesApi.
|
inline |
Adds documents to a template document. Adds one or more documents to an existing template document.
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
templateId | The ID of the template being accessed. |
envelopeDefinition | (optional) |
Implements DocuSign.eSign.Api.ITemplatesApi.
|
inline |
Adds documents to a template document. Adds one or more documents to an existing template document.
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
templateId | The ID of the template being accessed. |
envelopeDefinition | (optional) |
Implements DocuSign.eSign.Api.ITemplatesApi.
|
inline |
Adds documents to a template document. Adds one or more documents to an existing template document.
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
templateId | The ID of the template being accessed. |
envelopeDefinition | (optional) |
Implements DocuSign.eSign.Api.ITemplatesApi.
|
inline |
Adds documents to a template document. Adds one or more documents to an existing template document.
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
templateId | The ID of the template being accessed. |
envelopeDefinition | (optional) |
Implements DocuSign.eSign.Api.ITemplatesApi.
|
inline |
Adds a document to a template document. Adds the specified document to an existing template document.
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
templateId | The ID of the template being accessed. |
documentId | The ID of the document being accessed. |
envelopeDefinition | (optional) |
options | Options for modifying the behavior of the function. |
|
inline |
Shares a template with a group Shares a template with the specified members group.
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
templateId | The ID of the template being accessed. |
templatePart | Currently, the only defined part is groups. |
groupInformation | (optional) |
Implements DocuSign.eSign.Api.ITemplatesApi.
|
inline |
Shares a template with a group Shares a template with the specified members group.
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
templateId | The ID of the template being accessed. |
templatePart | Currently, the only defined part is groups. |
groupInformation | (optional) |
Implements DocuSign.eSign.Api.ITemplatesApi.
|
inline |
Shares a template with a group Shares a template with the specified members group.
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
templateId | The ID of the template being accessed. |
templatePart | Currently, the only defined part is groups. |
groupInformation | (optional) |
Implements DocuSign.eSign.Api.ITemplatesApi.
|
inline |
Shares a template with a group Shares a template with the specified members group.
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
templateId | The ID of the template being accessed. |
templatePart | Currently, the only defined part is groups. |
groupInformation | (optional) |
Implements DocuSign.eSign.Api.ITemplatesApi.
|
inline |
Updates a template lock. Updates the lock duration time or update the `lockedByApp` property information for the specified template. The user and integrator key must match the user specified by the `lockByUser` property and integrator key information and the `X-DocuSign-Edit` header must be included or an error will be generated.
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
templateId | The ID of the template being accessed. |
lockRequest | (optional) |
Implements DocuSign.eSign.Api.ITemplatesApi.
|
inline |
Updates a template lock. Updates the lock duration time or update the `lockedByApp` property information for the specified template. The user and integrator key must match the user specified by the `lockByUser` property and integrator key information and the `X-DocuSign-Edit` header must be included or an error will be generated.
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
templateId | The ID of the template being accessed. |
lockRequest | (optional) |
Implements DocuSign.eSign.Api.ITemplatesApi.
|
inline |
Updates a template lock. Updates the lock duration time or update the `lockedByApp` property information for the specified template. The user and integrator key must match the user specified by the `lockByUser` property and integrator key information and the `X-DocuSign-Edit` header must be included or an error will be generated.
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
templateId | The ID of the template being accessed. |
lockRequest | (optional) |
Implements DocuSign.eSign.Api.ITemplatesApi.
|
inline |
Updates a template lock. Updates the lock duration time or update the `lockedByApp` property information for the specified template. The user and integrator key must match the user specified by the `lockByUser` property and integrator key information and the `X-DocuSign-Edit` header must be included or an error will be generated.
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
templateId | The ID of the template being accessed. |
lockRequest | (optional) |
Implements DocuSign.eSign.Api.ITemplatesApi.
|
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.
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
templateId | The ID of the template being accessed. |
templateNotificationRequest | (optional) |
Implements DocuSign.eSign.Api.ITemplatesApi.
|
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.
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
templateId | The ID of the template being accessed. |
templateNotificationRequest | (optional) |
Implements DocuSign.eSign.Api.ITemplatesApi.
|
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.
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
templateId | The ID of the template being accessed. |
templateNotificationRequest | (optional) |
Implements DocuSign.eSign.Api.ITemplatesApi.
|
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.
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
templateId | The ID of the template being accessed. |
templateNotificationRequest | (optional) |
Implements DocuSign.eSign.Api.ITemplatesApi.
|
inline |
Updates recipients in a template. Updates recipients in a template. You can edit the following properties: `email`, `userName`, `routingOrder`, `faxNumber`, `deliveryMethod`, `accessCode`, and `requireIdLookup`.
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
templateId | The ID of the template being accessed. |
templateRecipients | (optional) |
options | Options for modifying the behavior of the function. |
|
inline |
Updates recipients in a template. Updates recipients in a template. You can edit the following properties: `email`, `userName`, `routingOrder`, `faxNumber`, `deliveryMethod`, `accessCode`, and `requireIdLookup`.
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
templateId | The ID of the template being accessed. |
templateRecipients | (optional) |
options | Options for modifying the behavior of the function. |
|
inline |
Updates recipients in a template. Updates recipients in a template. You can edit the following properties: `email`, `userName`, `routingOrder`, `faxNumber`, `deliveryMethod`, `accessCode`, and `requireIdLookup`.
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
templateId | The ID of the template being accessed. |
templateRecipients | (optional) |
options | Options for modifying the behavior of the function. |
|
inline |
Updates recipients in a template. Updates recipients in a template. You can edit the following properties: `email`, `userName`, `routingOrder`, `faxNumber`, `deliveryMethod`, `accessCode`, and `requireIdLookup`.
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
templateId | The ID of the template being accessed. |
templateRecipients | (optional) |
options | Options for modifying the behavior of the function. |
|
inline |
Updates the tabs for a recipient. Updates one or more tabs for a recipient in a template.
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
templateId | The ID of the template being accessed. |
recipientId | The ID of the recipient being accessed. |
templateTabs | (optional) |
Implements DocuSign.eSign.Api.ITemplatesApi.
|
inline |
Updates the tabs for a recipient. Updates one or more tabs for a recipient in a template.
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
templateId | The ID of the template being accessed. |
recipientId | The ID of the recipient being accessed. |
templateTabs | (optional) |
Implements DocuSign.eSign.Api.ITemplatesApi.
|
inline |
Updates the tabs for a recipient. Updates one or more tabs for a recipient in a template.
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
templateId | The ID of the template being accessed. |
recipientId | The ID of the recipient being accessed. |
templateTabs | (optional) |
Implements DocuSign.eSign.Api.ITemplatesApi.
|
inline |
Updates the tabs for a recipient. Updates one or more tabs for a recipient in a template.
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
templateId | The ID of the template being accessed. |
recipientId | The ID of the recipient being accessed. |
templateTabs | (optional) |
Implements DocuSign.eSign.Api.ITemplatesApi.
|
inline |
Updates the tabs for a template Updates tabs in the document specified by `documentId` in the template specified by `templateId`.
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
templateId | The ID of the template being accessed. |
documentId | The ID of the document being accessed. |
templateTabs | (optional) |
Implements DocuSign.eSign.Api.ITemplatesApi.
|
inline |
Updates the tabs for a template Updates tabs in the document specified by `documentId` in the template specified by `templateId`.
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
templateId | The ID of the template being accessed. |
documentId | The ID of the document being accessed. |
templateTabs | (optional) |
Implements DocuSign.eSign.Api.ITemplatesApi.
|
inline |
Updates the tabs for a template Updates tabs in the document specified by `documentId` in the template specified by `templateId`.
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
templateId | The ID of the template being accessed. |
documentId | The ID of the document being accessed. |
templateTabs | (optional) |
Implements DocuSign.eSign.Api.ITemplatesApi.
|
inline |
Updates the tabs for a template Updates tabs in the document specified by `documentId` in the template specified by `templateId`.
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
templateId | The ID of the template being accessed. |
documentId | The ID of the document being accessed. |
templateTabs | (optional) |
Implements DocuSign.eSign.Api.ITemplatesApi.
|
inline |
Updates an existing template. Updates an existing template.
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
templateId | The ID of the template being accessed. |
envelopeTemplate | (optional) |
Implements DocuSign.eSign.Api.ITemplatesApi.
|
getset |
Gets or sets the ApiClient object
An instance of the ApiClient
|
getset |
Provides a factory method hook for the creation of exceptions.