/*
* Docusign eSignature REST API
*
* The Docusign eSignature REST API provides you with a powerful, convenient, and simple Web services API for interacting with Docusign.
*
* OpenAPI spec version: v2.1
* Contact: devcenter@docusign.com
* Generated by: https://github.com/swagger-api/swagger-codegen.git
*/
using System;
using System.Collections.Generic;
using System.Linq;
using System.Net.Http;
using DocuSign.eSign.Client;
using DocuSign.eSign.Model;
namespace DocuSign.eSign.Api
{
///
/// Represents a collection of functions to interact with the API endpoints
///
public interface IEnvelopesApi : IApiAccessor
{
#region Synchronous Operations
///
/// Adds templates to an envelope.
///
///
/// Adds templates to the specified envelope.
///
/// Thrown when fails to make API call
///
/// Adds templates to an envelope.
///
///
/// Adds templates to the specified envelope.
///
/// Thrown when fails to make API call
/// ApiResponse of
ApiResponse ApplyTemplateWithHttpInfo(string accountId, string envelopeId, DocumentTemplateList documentTemplateList = null, EnvelopesApi.ApplyTemplateOptions options = null);
///
/// Adds templates to a document in an envelope.
///
///
/// Adds templates to a document in the specified envelope.
///
/// Thrown when fails to make API call
///
/// Adds templates to a document in an envelope.
///
///
/// Adds templates to a document in the specified envelope.
///
/// Thrown when fails to make API call
/// ApiResponse of
ApiResponse ApplyTemplateToDocumentWithHttpInfo(string accountId, string envelopeId, string documentId, DocumentTemplateList documentTemplateList = null, EnvelopesApi.ApplyTemplateToDocumentOptions options = null);
///
/// Initiate a new ChunkedUpload.
///
///
/// This method initiates a new chunked upload with the first part of the content.
///
/// Thrown when fails to make API call
///
/// Initiate a new ChunkedUpload.
///
///
/// This method initiates a new chunked upload with the first part of the content.
///
/// Thrown when fails to make API call
/// ApiResponse of
ApiResponse CreateChunkedUploadWithHttpInfo(string accountId, ChunkedUploadRequest chunkedUploadRequest = null);
///
/// Returns a URL to the authentication view UI.
///
///
/// Returns a URL that allows you to embed the authentication view of the DocuSign UI in your applications.
///
/// Thrown when fails to make API call
///
/// Returns a URL to the authentication view UI.
///
///
/// Returns a URL that allows you to embed the authentication view of the DocuSign UI in your applications.
///
/// Thrown when fails to make API call
/// ApiResponse of
ApiResponse CreateConsoleViewWithHttpInfo(string accountId, ConsoleViewRequest consoleViewRequest = null);
///
/// Returns a URL to the envelope correction UI.
///
///
/// Returns a URL that allows you to embed the envelope correction view of the DocuSign UI in your applications. Important: iFrames should not be used for embedded operations on mobile devices due to screen space issues. For iOS devices DocuSign recommends using a WebView.
///
/// Thrown when fails to make API call
///
/// Returns a URL to the envelope correction UI.
///
///
/// Returns a URL that allows you to embed the envelope correction view of the DocuSign UI in your applications. Important: iFrames should not be used for embedded operations on mobile devices due to screen space issues. For iOS devices DocuSign recommends using a WebView.
///
/// Thrown when fails to make API call
/// ApiResponse of
ApiResponse CreateCorrectViewWithHttpInfo(string accountId, string envelopeId, EnvelopeViewRequest envelopeViewRequest = null);
///
/// Updates envelope custom fields for an envelope.
///
///
/// Updates the envelope custom fields for draft and in-process envelopes. Each custom field used in an envelope must have a unique name.
///
/// Thrown when fails to make API call
///
/// Updates envelope custom fields for an envelope.
///
///
/// Updates the envelope custom fields for draft and in-process envelopes. Each custom field used in an envelope must have a unique name.
///
/// Thrown when fails to make API call
/// ApiResponse of
ApiResponse CreateCustomFieldsWithHttpInfo(string accountId, string envelopeId, CustomFields customFields = null);
///
/// Creates custom document fields in an existing envelope document.
///
///
/// Creates custom document fields in an existing envelope document.
///
/// Thrown when fails to make API call
///
/// Creates custom document fields in an existing envelope document.
///
///
/// Creates custom document fields in an existing envelope document.
///
/// Thrown when fails to make API call
/// ApiResponse of
ApiResponse CreateDocumentFieldsWithHttpInfo(string accountId, string envelopeId, string documentId, DocumentFieldsInformation documentFieldsInformation = null);
///
/// Get Responsive HTML Preview for a document in an envelope.
///
///
/// Creates a preview of the [responsive](/docs/esign-rest-api/esign101/concepts/responsive/) HTML version of a specific 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.
///
/// Thrown when fails to make API call
///
/// Get Responsive HTML Preview for a document in an envelope.
///
///
/// Creates a preview of the [responsive](/docs/esign-rest-api/esign101/concepts/responsive/) HTML version of a specific 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.
///
/// Thrown when fails to make API call
/// ApiResponse of
ApiResponse CreateDocumentResponsiveHtmlPreviewWithHttpInfo(string accountId, string envelopeId, string documentId, DocumentHtmlDefinition documentHtmlDefinition = null);
///
/// Adds the tabs to an envelope document
///
///
/// Adds tabs to the document specified by `documentId` in the envelope specified by `envelopeId`. In the request body, you only need to specify the tabs that your are adding. For example, to add a text [prefill tab](/docs/esign-rest-api/reference/envelopes/envelopedocumenttabs/create/#definition__tabs_prefilltabs), your request body might look like this: ``` { \"prefillTabs\": { \"textTabs\": [ { \"value\": \"a prefill text tab\", \"pageNumber\": \"1\", \"documentId\": \"1\", \"xPosition\": 316, \"yPosition\": 97 } ] } } ```
///
/// Thrown when fails to make API call
///
/// Adds the tabs to an envelope document
///
///
/// Adds tabs to the document specified by `documentId` in the envelope specified by `envelopeId`. In the request body, you only need to specify the tabs that your are adding. For example, to add a text [prefill tab](/docs/esign-rest-api/reference/envelopes/envelopedocumenttabs/create/#definition__tabs_prefilltabs), your request body might look like this: ``` { \"prefillTabs\": { \"textTabs\": [ { \"value\": \"a prefill text tab\", \"pageNumber\": \"1\", \"documentId\": \"1\", \"xPosition\": 316, \"yPosition\": 97 } ] } } ```
///
/// Thrown when fails to make API call
/// ApiResponse of
ApiResponse CreateDocumentTabsWithHttpInfo(string accountId, string envelopeId, string documentId, Tabs tabs = null);
///
/// Returns a URL to the edit view UI.
///
///
/// Returns a URL that allows you to embed the edit view of the DocuSign UI in your applications. This is a one-time use login token that allows the user to be placed into the DocuSign editing view. Upon sending completion, the user is returned to the return URL provided by the API application. Important: iFrames should not be used for embedded operations on mobile devices due to screen space issues. For iOS devices DocuSign recommends using a WebView.
///
/// Thrown when fails to make API call
///
/// Returns a URL to the edit view UI.
///
///
/// Returns a URL that allows you to embed the edit view of the DocuSign UI in your applications. This is a one-time use login token that allows the user to be placed into the DocuSign editing view. Upon sending completion, the user is returned to the return URL provided by the API application. Important: iFrames should not be used for embedded operations on mobile devices due to screen space issues. For iOS devices DocuSign recommends using a WebView.
///
/// Thrown when fails to make API call
/// ApiResponse of
ApiResponse CreateEditViewWithHttpInfo(string accountId, string envelopeId, EnvelopeViewRequest envelopeViewRequest = null);
///
/// Adds email setting overrides to an envelope.
///
///
/// Adds email override settings, changing the email address to reply to an email address, name, or the BCC for email archive information, for the envelope. Note that adding email settings will only affect email communications that occur after the addition was made. ### Important: The BCC Email address feature is designed to provide a copy of all email communications for external archiving purposes. DocuSign recommends that envelopes sent using the BCC for Email Archive feature, including the BCC Email Override option, include additional signer authentication options. To send a copy of the envelope to a recipient who does not need to sign, use a Carbon Copies or Certified Deliveries Recipient Type.
///
/// Thrown when fails to make API call
///
/// Adds email setting overrides to an envelope.
///
///
/// Adds email override settings, changing the email address to reply to an email address, name, or the BCC for email archive information, for the envelope. Note that adding email settings will only affect email communications that occur after the addition was made. ### Important: The BCC Email address feature is designed to provide a copy of all email communications for external archiving purposes. DocuSign recommends that envelopes sent using the BCC for Email Archive feature, including the BCC Email Override option, include additional signer authentication options. To send a copy of the envelope to a recipient who does not need to sign, use a Carbon Copies or Certified Deliveries Recipient Type.
///
/// Thrown when fails to make API call
/// ApiResponse of
ApiResponse CreateEmailSettingsWithHttpInfo(string accountId, string envelopeId, EmailSettings emailSettings = null);
///
/// Creates an envelope.
///
///
/// Creates an envelope. Using this function you can: * Create an envelope and send it. * Create an envelope from an existing template and send it. In either case, you can choose to save the envelope as a draft envelope instead of sending it by setting the request's `status` property to `created` instead of `sent`. ## Sending Envelopes Documents can be included with the Envelopes::create call itself or a template can include documents. Documents can be added by using a multi-part/form request or by using the `documentBase64` field of the [`document` object](#/definitions/document) ### Recipient Types An [`envelopeDefinition` object](#/definitions/envelopeDefinition) is used as the method's body. Envelope recipients can be defined in the envelope or in templates. The `envelopeDefinition` object's `recipients` field is an [`EnvelopeRecipients` resource object](#/definitions/EnvelopeRecipients). It includes arrays of the seven types of recipients defined by DocuSign: Recipient type | Object definition - -- -- -- -- -- -- - | - -- -- -- -- -- -- -- -- agent (can add name and email information for later recipients/signers) | [`agent`](#/definitions/agent) carbon copy (receives a copy of the documents) | [`carbonCopy`](#/definitions/carbonCopy) certified delivery (receives a copy of the documents and must acknowledge receipt) | [`certifiedDelivery`](#/definitions/certifiedDelivery) editor (can change recipients and document fields for later recipients/signers) | [`editor`](#/definitions/editor) in-person signer (\"hosts\" someone who signs in-person) | [`inPersonSigner`](#/definitions/inPersonSigner) intermediary (can add name and email information for some later recipients/signers.) | [`intermediary`](#/definitions/intermediary) signer (signs and/or updates document fields) | [`signer`](#/definitions/signer) Additional information about the different types of recipients is available from the [`EnvelopeRecipients` resource page](../../EnvelopeRecipients) and from the [Developer Center](https://www.docusign.com/developer-center/explore/features/recipients) ### Tabs Tabs (also referred to as `tags` and as `fields` in the web sending user interface), can be defined in the `envelopeDefinition`, in templates, by transforming PDF Form Fields, or by using Composite Templates (see below). Defining tabs: the `inPersonSigner`, and `signer` recipient objects include a `tabs` field. It is an [`EnvelopeTabs` resource object](#/definitions/EnvelopeTabs). It includes arrays of the 24 different tab types available. See the [`EnvelopeTabs` resource](../../EnvelopeTabs) for more information. ## Using Templates Envelopes use specific people or groups as recipients. Templates can specify a role, eg `account_manager.` When a template is used in an envelope, the roles must be replaced with specific people or groups. When you create an envelope using a `templateId`, the different recipient type objects within the [`EnvelopeRecipients` object](#/definitions/EnvelopeRecipients) are used to assign recipients to the template's roles via the `roleName` property. The recipient objects can also override settings that were specified in the template, and set values for tab fields that were defined in the template. ### Message Lock When a template is added or applied to an envelope and the template has a locked email subject and message, that subject and message are used for the envelope and cannot be changed even if another locked template is subsequently added or applied to the envelope. The field `messageLock` is used to lock the email subject and message. If an email subject or message is entered before adding or applying a template with `messageLock` **true**, the email subject and message is overwritten with the locked email subject and message from the template. ## Envelope Status The status of sent envelopes can be determined through the DocuSign webhook system or by polling. Webhooks are highly recommended: they provide your application with the quickest updates when an envelope's status changes. DocuSign limits polling to once every 15 minutes or less frequently. When a webhook is used, DocuSign calls your application, via the URL you provide, with a notification XML message. See the [Webhook recipe](https://www.docusign.com/developer-center/recipes/webhook-status) for examples and live demos of using webhooks. ## Webhook Options The two webhook options, *eventNotification* and *Connect* use the same notification mechanism and message formats. eventNotification is used to create a webhook for a specific envelope sent via the API. Connect webhooks can be used for any envelope sent from an account, from any user, from any client. ### eventNotification Webhooks The Envelopes::create method includes an optional [eventNotification object](#definition-eventNotification) that adds a webhook to the envelope. eventNotification webhooks are available for all DocuSign accounts with API access. ### Connect Webhooks Connect can be used to create a webhook for all envelopes sent by all users in an account, either through the API or via other DocuSign clients (web, mobile, etc). Connect configurations are independent of specific envelopes. A Connect configuration includes a filter that may be used to limit the webhook to specific users, envelope statuses, etc. Connect configurations may be created and managed using the [ConnectConfigurations resource](../../Connect/ConnectConfigurations). Configurations can also be created and managed from the Administration tool accessed by selecting \"Go to Admin\" from the menu next to your picture on the DocuSign web app. See the Integrations/Connect section of the Admin tool. For repeatability, and to minimize support questions, creating Connect configurations via the API is recommended, especially for ISVs. Connect is available for some DocuSign account types. Please contact DocuSign Sales for more information. ## Composite Templates The Composite Templates feature, like [compositing in film production](https://en.wikipedia.org/wiki/Compositing), enables you to *overlay* document, recipient, and tab definitions from multiple sources, including PDF Form Field definitions, templates defined on the server, and more. Each Composite Template consists of optional elements: server templates, inline templates, PDF Metadata templates, and documents. * The Composite Template ID is an optional element used to identify the composite template. It is used as a reference when adding document object information via a multi-part HTTP message. If used, the document content-disposition must include the `compositeTemplateId` to which the document should be added. If `compositeTemplateId` is not specified in the content-disposition, the document is applied based on the `documentId` only. If no document object is specified, the composite template inherits the first document. * Server Templates are server-side templates stored on the DocuSign platform. If supplied, they are overlaid into the envelope in the order of their Sequence value. * Inline Templates provide a container to add documents, recipients, tabs, and custom fields. If inline templates are supplied, they are overlaid into the envelope in the order of their Sequence value. * Document objects are optional structures that provide a container to pass in a document or form. If this object is not included, the composite template inherits the *first* document it finds from a server template or inline template, starting with the lowest sequence value. PDF Form objects are only transformed from the document object. DocuSign does not derive PDF form properties from server templates or inline templates. To instruct DocuSign to transform fields from the PDF form, set `transformPdfFields` to \"true\" for the document. See the Transform PDF Fields section for more information about process. * PDF Metadata Templates provide a container to embed design-time template information into a PDF document. DocuSign uses this information when processing the Envelope. This convention allows the document to carry the signing instructions with it, so that less information needs to be provided at run-time through an inline template or synchronized with an external structure like a server template. PDF Metadata templates are stored in the Metadata layer of a PDF in accordance with Acrobat's XMP specification. DocuSign will only find PDF Metadata templates inside documents passed in the Document object (see below). If supplied, the PDF metadata template will be overlaid into the envelope in the order of its Sequence value. ### Compositing the definitions Each Composite Template adds a new document and templates overlay into the envelope. For each Composite Template these rules are applied: * Templates are overlaid in the order of their Sequence value. * If Document is not passed into the Composite Template's `document` field, the *first* template's document (based on the template's Sequence value) is used. * Last in wins in all cases except for the document (i.e. envelope information, recipient information, secure field information). There is no special casing. For example, if you want higher security on a tab, then that needs to be specified in a later template (by sequence number) then where the tab is included. If you want higher security on a role recipient, then it needs to be in a later template then where that role recipient is specified. * Recipient matching is based on Recipient Role and Routing Order. If there are matches, the recipient information is merged together. A final pass is done on all Composite Templates, after all template overlays have been applied, to collapse recipients with the same email, username and routing order. This prevents having the same recipients at the same routing order. * If you specify in a template that a recipient is locked, once that recipient is overlaid the recipient attributes can no longer be changed. The only items that can be changed for the recipient in this case are the email, username, access code and IDCheckInformationInput. * Tab matching is based on Tab Labels, Tab Types and Documents. If a Tab Label matches but the Document is not supplied, the Tab is overlaid for all the Documents. For example, if you have a simple inline template with only one tab in it with a label and a value, the Signature, Initial, Company, Envelope ID, User Name tabs will only be matched and collapsed if they fall in the exact same X and Y locations. * roleName and tabLabel matching is case sensitive. * The defaultRecipient field enables you to specify which recipient the generated tabs from a PDF form are mapped to. You can also set PDF form generated tabs to a recipient other than the DefaultRecipient by specifying the mapping of the tab label that is created to one of the template recipients. * You can use tabLabel wild carding to map a series of tabs from the PDF form. To use this you must end a tab label with \"\\*\" and then the system matches tabs that start with the label. * If no DefaultRecipient is specified, tabs must be explicitly mapped to recipients in order to be generated from the form. Unmapped form objects will not be generated into their DocuSign equivalents. (In the case of Signature/Initials, the tabs will be disregarded entirely; in the case of pdf text fields, the field data will be flattened on the Envelope document, but there will not be a corresponding DocuSign data tab.) ### Including the Document Content for Composite Templates Document content can be supplied inline, using the `documentBase64` or can be included in a multi-part HTTP message. If a multi-part message is used and there are multiple Composite Templates, the document content-disposition can include the `compositeTemplateId` to which the document should be added. Using the `compositeTemplateId` sets which documents are associated with particular composite templates. An example of this usage is: ``` - -5cd3320a-5aac-4453-b3a4-cbb52a4cba5d Content-Type: application/pdf Content-Disposition: file; filename=\"eula.pdf\"; documentId=1; compositeTemplateId=\"1\" Content-Transfer-Encoding: base64 ``` ### PDF Form Field Transformation Only the following PDF Form FieldTypes will be transformed to DocuSign tabs: CheckBox, DateTime, ListBox, Numeric, Password, Radio, Signature, and Text Field Properties that will be transformed: Read Only, Required, Max Length, Positions, and Initial Data. When transforming a *PDF Form Digital Signature Field,* the following rules are used: If the PDF Field Name Contains | Then the DocuSign Tab Will be - -- -- -- | - -- -- -- - DocuSignSignHere or eSignSignHere | Signature DocuSignSignHereOptional or eSignSignHereOptional | Optional Signature DocuSignInitialHere or eSignInitialHere | Initials DocuSignInitialHereOptional or eSignInitialHereOptional | Optional Initials Any other PDF Form Digital Signature Field will be transformed to a DocuSign Signature tab When transforming *PDF Form Text Fields,* the following rules are used: If the PDF Field Name Contains | Then the DocuSign Tab Will be - -- -- -- | - -- -- -- - DocuSignSignHere or eSignSignHere | Signature DocuSignSignHereOptional or eSignSignHereOptional | Optional Signature DocuSignInitialHere or eSignInitialHere | Initials DocuSignInitialHereOptional or eSignInitialHereOptional | Optional Initials DocuSignEnvelopeID or eSignEnvelopeID | EnvelopeID DocuSignCompany or eSignCompany | Company DocuSignDateSigned or eSignDateSigned | Date Signed DocuSignTitle or eSignTitle | Title DocuSignFullName or eSignFullName | Full Name DocuSignSignerAttachmentOptional or eSignSignerAttachmentOptional | Optional Signer Attachment Any other PDF Form Text Field will be transformed to a DocuSign data (text) tab. PDF Form Field Names that include \"DocuSignIgnoreTransform\" or \"eSignIgnoreTransform\" will not be transformed. PDF Form Date fields will be transformed to Date Signed fields if their name includes DocuSignDateSigned or eSignDateSigned. ## Template Email Subject Merge Fields This feature enables you to insert 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 `roleName`, are added to the `emailSubject` 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. 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` 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 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 `roleName` 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. ## Branding an envelope The following rules are used to determine the `brandId` used in an envelope: * If a `brandId` is specified in the envelope/template and that brandId is available to the account, that brand is used in the envelope. * If more than one template is used in an envelope and more than one `brandId` is specified, the first `brandId` specified is used throughout the envelope. * In cases where no brand is specified and the sender belongs to a Group; if there is only one brand associated with the Group, then that brand is used in the envelope. Otherwise, the account's default signing brand is used. * For envelopes that do not meet any of the previous criteria, the account's default signing brand is used for the envelope. ## BCC Email address feature The BCC Email address feature is designed to provide a copy of all email communications for external archiving purposes. DocuSign recommends that envelopes sent using the BCC for Email Archive feature, including the BCC Email Override option, include additional signer authentication options. To send a copy of the envelope to a recipient who does not need to sign, don't use the BCC Email field. Use a Carbon Copy or Certified Delivery Recipient type. ## Merge Recipient Roles for Draft Envelopes When an envelope with multiple templates is sent, the recipients from the templates are merged according to the template roles, and empty recipients are removed. When creating an envelope with multiple templates, but not sending it (keeping it in a created state), duplicate recipients are not merged, which could cause leave duplicate recipients in the envelope. To prevent this, the query parameter `merge_roles_on_draft` should be added when posting a draft envelope (status=created) with multiple templates. Doing this will merge template roles and remove empty recipients. ###### Note: DocuSign recommends that the `merge_roles_on_draft` query parameter be used anytime you are creating an envelope with multiple templates and keeping it in draft (created) status.
///
/// Thrown when fails to make API call
///
/// Creates an envelope.
///
///
/// Creates an envelope. Using this function you can: * Create an envelope and send it. * Create an envelope from an existing template and send it. In either case, you can choose to save the envelope as a draft envelope instead of sending it by setting the request's `status` property to `created` instead of `sent`. ## Sending Envelopes Documents can be included with the Envelopes::create call itself or a template can include documents. Documents can be added by using a multi-part/form request or by using the `documentBase64` field of the [`document` object](#/definitions/document) ### Recipient Types An [`envelopeDefinition` object](#/definitions/envelopeDefinition) is used as the method's body. Envelope recipients can be defined in the envelope or in templates. The `envelopeDefinition` object's `recipients` field is an [`EnvelopeRecipients` resource object](#/definitions/EnvelopeRecipients). It includes arrays of the seven types of recipients defined by DocuSign: Recipient type | Object definition - -- -- -- -- -- -- - | - -- -- -- -- -- -- -- -- agent (can add name and email information for later recipients/signers) | [`agent`](#/definitions/agent) carbon copy (receives a copy of the documents) | [`carbonCopy`](#/definitions/carbonCopy) certified delivery (receives a copy of the documents and must acknowledge receipt) | [`certifiedDelivery`](#/definitions/certifiedDelivery) editor (can change recipients and document fields for later recipients/signers) | [`editor`](#/definitions/editor) in-person signer (\"hosts\" someone who signs in-person) | [`inPersonSigner`](#/definitions/inPersonSigner) intermediary (can add name and email information for some later recipients/signers.) | [`intermediary`](#/definitions/intermediary) signer (signs and/or updates document fields) | [`signer`](#/definitions/signer) Additional information about the different types of recipients is available from the [`EnvelopeRecipients` resource page](../../EnvelopeRecipients) and from the [Developer Center](https://www.docusign.com/developer-center/explore/features/recipients) ### Tabs Tabs (also referred to as `tags` and as `fields` in the web sending user interface), can be defined in the `envelopeDefinition`, in templates, by transforming PDF Form Fields, or by using Composite Templates (see below). Defining tabs: the `inPersonSigner`, and `signer` recipient objects include a `tabs` field. It is an [`EnvelopeTabs` resource object](#/definitions/EnvelopeTabs). It includes arrays of the 24 different tab types available. See the [`EnvelopeTabs` resource](../../EnvelopeTabs) for more information. ## Using Templates Envelopes use specific people or groups as recipients. Templates can specify a role, eg `account_manager.` When a template is used in an envelope, the roles must be replaced with specific people or groups. When you create an envelope using a `templateId`, the different recipient type objects within the [`EnvelopeRecipients` object](#/definitions/EnvelopeRecipients) are used to assign recipients to the template's roles via the `roleName` property. The recipient objects can also override settings that were specified in the template, and set values for tab fields that were defined in the template. ### Message Lock When a template is added or applied to an envelope and the template has a locked email subject and message, that subject and message are used for the envelope and cannot be changed even if another locked template is subsequently added or applied to the envelope. The field `messageLock` is used to lock the email subject and message. If an email subject or message is entered before adding or applying a template with `messageLock` **true**, the email subject and message is overwritten with the locked email subject and message from the template. ## Envelope Status The status of sent envelopes can be determined through the DocuSign webhook system or by polling. Webhooks are highly recommended: they provide your application with the quickest updates when an envelope's status changes. DocuSign limits polling to once every 15 minutes or less frequently. When a webhook is used, DocuSign calls your application, via the URL you provide, with a notification XML message. See the [Webhook recipe](https://www.docusign.com/developer-center/recipes/webhook-status) for examples and live demos of using webhooks. ## Webhook Options The two webhook options, *eventNotification* and *Connect* use the same notification mechanism and message formats. eventNotification is used to create a webhook for a specific envelope sent via the API. Connect webhooks can be used for any envelope sent from an account, from any user, from any client. ### eventNotification Webhooks The Envelopes::create method includes an optional [eventNotification object](#definition-eventNotification) that adds a webhook to the envelope. eventNotification webhooks are available for all DocuSign accounts with API access. ### Connect Webhooks Connect can be used to create a webhook for all envelopes sent by all users in an account, either through the API or via other DocuSign clients (web, mobile, etc). Connect configurations are independent of specific envelopes. A Connect configuration includes a filter that may be used to limit the webhook to specific users, envelope statuses, etc. Connect configurations may be created and managed using the [ConnectConfigurations resource](../../Connect/ConnectConfigurations). Configurations can also be created and managed from the Administration tool accessed by selecting \"Go to Admin\" from the menu next to your picture on the DocuSign web app. See the Integrations/Connect section of the Admin tool. For repeatability, and to minimize support questions, creating Connect configurations via the API is recommended, especially for ISVs. Connect is available for some DocuSign account types. Please contact DocuSign Sales for more information. ## Composite Templates The Composite Templates feature, like [compositing in film production](https://en.wikipedia.org/wiki/Compositing), enables you to *overlay* document, recipient, and tab definitions from multiple sources, including PDF Form Field definitions, templates defined on the server, and more. Each Composite Template consists of optional elements: server templates, inline templates, PDF Metadata templates, and documents. * The Composite Template ID is an optional element used to identify the composite template. It is used as a reference when adding document object information via a multi-part HTTP message. If used, the document content-disposition must include the `compositeTemplateId` to which the document should be added. If `compositeTemplateId` is not specified in the content-disposition, the document is applied based on the `documentId` only. If no document object is specified, the composite template inherits the first document. * Server Templates are server-side templates stored on the DocuSign platform. If supplied, they are overlaid into the envelope in the order of their Sequence value. * Inline Templates provide a container to add documents, recipients, tabs, and custom fields. If inline templates are supplied, they are overlaid into the envelope in the order of their Sequence value. * Document objects are optional structures that provide a container to pass in a document or form. If this object is not included, the composite template inherits the *first* document it finds from a server template or inline template, starting with the lowest sequence value. PDF Form objects are only transformed from the document object. DocuSign does not derive PDF form properties from server templates or inline templates. To instruct DocuSign to transform fields from the PDF form, set `transformPdfFields` to \"true\" for the document. See the Transform PDF Fields section for more information about process. * PDF Metadata Templates provide a container to embed design-time template information into a PDF document. DocuSign uses this information when processing the Envelope. This convention allows the document to carry the signing instructions with it, so that less information needs to be provided at run-time through an inline template or synchronized with an external structure like a server template. PDF Metadata templates are stored in the Metadata layer of a PDF in accordance with Acrobat's XMP specification. DocuSign will only find PDF Metadata templates inside documents passed in the Document object (see below). If supplied, the PDF metadata template will be overlaid into the envelope in the order of its Sequence value. ### Compositing the definitions Each Composite Template adds a new document and templates overlay into the envelope. For each Composite Template these rules are applied: * Templates are overlaid in the order of their Sequence value. * If Document is not passed into the Composite Template's `document` field, the *first* template's document (based on the template's Sequence value) is used. * Last in wins in all cases except for the document (i.e. envelope information, recipient information, secure field information). There is no special casing. For example, if you want higher security on a tab, then that needs to be specified in a later template (by sequence number) then where the tab is included. If you want higher security on a role recipient, then it needs to be in a later template then where that role recipient is specified. * Recipient matching is based on Recipient Role and Routing Order. If there are matches, the recipient information is merged together. A final pass is done on all Composite Templates, after all template overlays have been applied, to collapse recipients with the same email, username and routing order. This prevents having the same recipients at the same routing order. * If you specify in a template that a recipient is locked, once that recipient is overlaid the recipient attributes can no longer be changed. The only items that can be changed for the recipient in this case are the email, username, access code and IDCheckInformationInput. * Tab matching is based on Tab Labels, Tab Types and Documents. If a Tab Label matches but the Document is not supplied, the Tab is overlaid for all the Documents. For example, if you have a simple inline template with only one tab in it with a label and a value, the Signature, Initial, Company, Envelope ID, User Name tabs will only be matched and collapsed if they fall in the exact same X and Y locations. * roleName and tabLabel matching is case sensitive. * The defaultRecipient field enables you to specify which recipient the generated tabs from a PDF form are mapped to. You can also set PDF form generated tabs to a recipient other than the DefaultRecipient by specifying the mapping of the tab label that is created to one of the template recipients. * You can use tabLabel wild carding to map a series of tabs from the PDF form. To use this you must end a tab label with \"\\*\" and then the system matches tabs that start with the label. * If no DefaultRecipient is specified, tabs must be explicitly mapped to recipients in order to be generated from the form. Unmapped form objects will not be generated into their DocuSign equivalents. (In the case of Signature/Initials, the tabs will be disregarded entirely; in the case of pdf text fields, the field data will be flattened on the Envelope document, but there will not be a corresponding DocuSign data tab.) ### Including the Document Content for Composite Templates Document content can be supplied inline, using the `documentBase64` or can be included in a multi-part HTTP message. If a multi-part message is used and there are multiple Composite Templates, the document content-disposition can include the `compositeTemplateId` to which the document should be added. Using the `compositeTemplateId` sets which documents are associated with particular composite templates. An example of this usage is: ``` - -5cd3320a-5aac-4453-b3a4-cbb52a4cba5d Content-Type: application/pdf Content-Disposition: file; filename=\"eula.pdf\"; documentId=1; compositeTemplateId=\"1\" Content-Transfer-Encoding: base64 ``` ### PDF Form Field Transformation Only the following PDF Form FieldTypes will be transformed to DocuSign tabs: CheckBox, DateTime, ListBox, Numeric, Password, Radio, Signature, and Text Field Properties that will be transformed: Read Only, Required, Max Length, Positions, and Initial Data. When transforming a *PDF Form Digital Signature Field,* the following rules are used: If the PDF Field Name Contains | Then the DocuSign Tab Will be - -- -- -- | - -- -- -- - DocuSignSignHere or eSignSignHere | Signature DocuSignSignHereOptional or eSignSignHereOptional | Optional Signature DocuSignInitialHere or eSignInitialHere | Initials DocuSignInitialHereOptional or eSignInitialHereOptional | Optional Initials Any other PDF Form Digital Signature Field will be transformed to a DocuSign Signature tab When transforming *PDF Form Text Fields,* the following rules are used: If the PDF Field Name Contains | Then the DocuSign Tab Will be - -- -- -- | - -- -- -- - DocuSignSignHere or eSignSignHere | Signature DocuSignSignHereOptional or eSignSignHereOptional | Optional Signature DocuSignInitialHere or eSignInitialHere | Initials DocuSignInitialHereOptional or eSignInitialHereOptional | Optional Initials DocuSignEnvelopeID or eSignEnvelopeID | EnvelopeID DocuSignCompany or eSignCompany | Company DocuSignDateSigned or eSignDateSigned | Date Signed DocuSignTitle or eSignTitle | Title DocuSignFullName or eSignFullName | Full Name DocuSignSignerAttachmentOptional or eSignSignerAttachmentOptional | Optional Signer Attachment Any other PDF Form Text Field will be transformed to a DocuSign data (text) tab. PDF Form Field Names that include \"DocuSignIgnoreTransform\" or \"eSignIgnoreTransform\" will not be transformed. PDF Form Date fields will be transformed to Date Signed fields if their name includes DocuSignDateSigned or eSignDateSigned. ## Template Email Subject Merge Fields This feature enables you to insert 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 `roleName`, are added to the `emailSubject` 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. 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` 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 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 `roleName` 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. ## Branding an envelope The following rules are used to determine the `brandId` used in an envelope: * If a `brandId` is specified in the envelope/template and that brandId is available to the account, that brand is used in the envelope. * If more than one template is used in an envelope and more than one `brandId` is specified, the first `brandId` specified is used throughout the envelope. * In cases where no brand is specified and the sender belongs to a Group; if there is only one brand associated with the Group, then that brand is used in the envelope. Otherwise, the account's default signing brand is used. * For envelopes that do not meet any of the previous criteria, the account's default signing brand is used for the envelope. ## BCC Email address feature The BCC Email address feature is designed to provide a copy of all email communications for external archiving purposes. DocuSign recommends that envelopes sent using the BCC for Email Archive feature, including the BCC Email Override option, include additional signer authentication options. To send a copy of the envelope to a recipient who does not need to sign, don't use the BCC Email field. Use a Carbon Copy or Certified Delivery Recipient type. ## Merge Recipient Roles for Draft Envelopes When an envelope with multiple templates is sent, the recipients from the templates are merged according to the template roles, and empty recipients are removed. When creating an envelope with multiple templates, but not sending it (keeping it in a created state), duplicate recipients are not merged, which could cause leave duplicate recipients in the envelope. To prevent this, the query parameter `merge_roles_on_draft` should be added when posting a draft envelope (status=created) with multiple templates. Doing this will merge template roles and remove empty recipients. ###### Note: DocuSign recommends that the `merge_roles_on_draft` query parameter be used anytime you are creating an envelope with multiple templates and keeping it in draft (created) status.
///
/// Thrown when fails to make API call
/// ApiResponse of
ApiResponse CreateEnvelopeWithHttpInfo(string accountId, EnvelopeDefinition envelopeDefinition = null, EnvelopesApi.CreateEnvelopeOptions options = null);
///
/// Posts a list of comments for authorized user
///
///
///
///
/// Thrown when fails to make API call
///
/// Posts a list of comments for authorized user
///
///
///
///
/// Thrown when fails to make API call
/// ApiResponse of
ApiResponse CreateEnvelopeCommentsWithHttpInfo(string accountId, string envelopeId, CommentsPublish commentsPublish = null);
///
/// Provides a URL to start a recipient view of the Envelope UI
///
///
/// This method returns a URL for an envelope 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](https://support.docusign.com/en/guides/ndse-user-guide-send-your-documents).
///
/// Thrown when fails to make API call
///
/// Provides a URL to start a recipient view of the Envelope UI
///
///
/// This method returns a URL for an envelope 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](https://support.docusign.com/en/guides/ndse-user-guide-send-your-documents).
///
/// Thrown when fails to make API call
/// ApiResponse of
ApiResponse CreateEnvelopeRecipientPreviewWithHttpInfo(string accountId, string envelopeId, RecipientPreviewRequest recipientPreviewRequest = null);
///
/// Provides a URL to start a shared recipient view of the Envelope UI
///
///
/// Returns a URL that enables you to embed the DocuSign UI recipient view of a [shared envelope](https://support.docusign.com/en/guides/ndse-admin-guide-share-envelopes) in your applications. This is the view that a user sees of an envelope that a recipient on the same account has shared with them. Due to screen space issues, do not use an `<iframe>` for embedded operations on mobile devices. For iOS devices, DocuSign recommends using a WebView. ### Revoking the URL You can revoke this URL by making a DELETE HTTP request to the URL with no request body. ### Related topics - [Embedded signing and sending](/docs/esign-rest-api/esign101/concepts/embedding/) - [How to send an envelope via your app](/docs/esign-rest-api/how-to/embedded-sending/) - [How to embed the DocuSign UI in your app](/docs/esign-rest-api/how-to/embed-ui/)
///
/// Thrown when fails to make API call
///
/// Provides a URL to start a shared recipient view of the Envelope UI
///
///
/// Returns a URL that enables you to embed the DocuSign UI recipient view of a [shared envelope](https://support.docusign.com/en/guides/ndse-admin-guide-share-envelopes) in your applications. This is the view that a user sees of an envelope that a recipient on the same account has shared with them. Due to screen space issues, do not use an `<iframe>` for embedded operations on mobile devices. For iOS devices, DocuSign recommends using a WebView. ### Revoking the URL You can revoke this URL by making a DELETE HTTP request to the URL with no request body. ### Related topics - [Embedded signing and sending](/docs/esign-rest-api/esign101/concepts/embedding/) - [How to send an envelope via your app](/docs/esign-rest-api/how-to/embedded-sending/) - [How to embed the DocuSign UI in your app](/docs/esign-rest-api/how-to/embed-ui/)
///
/// Thrown when fails to make API call
/// ApiResponse of
ApiResponse CreateEnvelopeRecipientSharedViewWithHttpInfo(string accountId, string envelopeId, RecipientViewRequest recipientViewRequest = null);
///
/// Add envelope transfer rules to an account.
///
///
/// This method creates an envelope transfer rule. When you create an envelope transfer rule, you specify the following properties: - `eventType` - `fromGroups` - `toUser` - `toFolder` - `carbonCopyOriginalOwner` - `enabled` **Note:** Only Administrators can create envelope transfer rules. In addition, to use envelope transfer rules, the **Transfer Custody** feature must be enabled for your account.
///
/// Thrown when fails to make API call
///
/// Add envelope transfer rules to an account.
///
///
/// This method creates an envelope transfer rule. When you create an envelope transfer rule, you specify the following properties: - `eventType` - `fromGroups` - `toUser` - `toFolder` - `carbonCopyOriginalOwner` - `enabled` **Note:** Only Administrators can create envelope transfer rules. In addition, to use envelope transfer rules, the **Transfer Custody** feature must be enabled for your account.
///
/// Thrown when fails to make API call
/// ApiResponse of
ApiResponse CreateEnvelopeTransferRulesWithHttpInfo(string accountId, EnvelopeTransferRuleRequest envelopeTransferRuleRequest = null);
///
/// Creates and adds a new workflow step definition for an envelope's workflow
///
///
///
///
/// Thrown when fails to make API call
///
/// Creates and adds a new workflow step definition for an envelope's workflow
///
///
///
///
/// Thrown when fails to make API call
/// ApiResponse of
ApiResponse CreateEnvelopeWorkflowStepDefinitionWithHttpInfo(string accountId, string envelopeId, WorkflowStep workflowStep = null);
///
/// Submits a batch of historical envelopes for republish to an adhoc config.
///
///
///
///
/// Thrown when fails to make API call
///
/// Submits a batch of historical envelopes for republish to an adhoc config.
///
///
///
///
/// Thrown when fails to make API call
/// ApiResponse of
ApiResponse CreateHistoricalEnvelopePublishTransactionWithHttpInfo(string accountId, ConnectHistoricalEnvelopeRepublish connectHistoricalEnvelopeRepublish = null);
///
/// Lock an envelope.
///
///
/// Locks the specified envelope, and sets the time until the lock expires, to prevent other users or recipients from accessing and changing the envelope. ###### Note: Users must have envelope locking capability enabled to use this function (userSetting `canLockEnvelopes` must be set to true for the user).
///
/// Thrown when fails to make API call
///
/// Lock an envelope.
///
///
/// Locks the specified envelope, and sets the time until the lock expires, to prevent other users or recipients from accessing and changing the envelope. ###### Note: Users must have envelope locking capability enabled to use this function (userSetting `canLockEnvelopes` must be set to true for the user).
///
/// Thrown when fails to make API call
/// ApiResponse of
ApiResponse CreateLockWithHttpInfo(string accountId, string envelopeId, LockRequest lockRequest = null);
///
/// Adds one or more recipients to an envelope.
///
///
/// Adds one or more recipients to an envelope. For an in process envelope, one that has been sent and has not been completed or voided, an email is sent to a new recipient when they are reached in the routing order. If the new recipient's routing order is before or the same as the envelope's next recipient, an email is only sent if the optional `resend_envelope` query string is set to **true**.
///
/// Thrown when fails to make API call
///
/// Adds one or more recipients to an envelope.
///
///
/// Adds one or more recipients to an envelope. For an in process envelope, one that has been sent and has not been completed or voided, an email is sent to a new recipient when they are reached in the routing order. If the new recipient's routing order is before or the same as the envelope's next recipient, an email is only sent if the optional `resend_envelope` query string is set to **true**.
///
/// Thrown when fails to make API call
/// ApiResponse of
ApiResponse CreateRecipientWithHttpInfo(string accountId, string envelopeId, Recipients recipients = null, EnvelopesApi.CreateRecipientOptions options = null);
///
/// Provides a link to access the Identity manual review related to a recipient.
///
///
/// This method returns the URL of the page that allows a sender to [manually review](https://support.docusign.com/en/guides/ndse-user-guide-send-documents-with-id-verification) the ID of a recipient.
///
/// Thrown when fails to make API call
///
/// Provides a link to access the Identity manual review related to a recipient.
///
///
/// This method returns the URL of the page that allows a sender to [manually review](https://support.docusign.com/en/guides/ndse-user-guide-send-documents-with-id-verification) the ID of a recipient.
///
/// Thrown when fails to make API call
/// ApiResponse of
ApiResponse CreateRecipientManualReviewViewWithHttpInfo(string accountId, string envelopeId, string recipientId);
///
/// Returns a link to access to the identity events stored in the proof service related to this recipient.
///
///
///
///
/// Thrown when fails to make API call
///
/// Returns a link to access to the identity events stored in the proof service related to this recipient.
///
///
///
///
/// Thrown when fails to make API call
/// ApiResponse of
ApiResponse CreateRecipientProofFileLinkWithHttpInfo(string accountId, string envelopeId, string recipientId);
///
/// Returns a resource token to get access to the identity events stored in the proof service related to this recipient.
///
///
/// Creates a resource token for a sender. This token allows a sender to return identification data for a recipient using the [ID Evidence API](/docs/idevidence-api/).
///
/// Thrown when fails to make API call
///
/// Returns a resource token to get access to the identity events stored in the proof service related to this recipient.
///
///
/// Creates a resource token for a sender. This token allows a sender to return identification data for a recipient using the [ID Evidence API](/docs/idevidence-api/).
///
/// Thrown when fails to make API call
/// ApiResponse of
ApiResponse CreateRecipientProofFileResourceTokenWithHttpInfo(string accountId, string envelopeId, string recipientId, EnvelopesApi.CreateRecipientProofFileResourceTokenOptions options = null);
///
/// Returns a URL to the recipient view UI.
///
///
/// Returns a URL that allows you to embed the recipient view of the DocuSign UI in your applications. This call cannot be used to view draft envelopes, since those envelopes have not been sent. Important: iFrames should not be used for embedded operations on mobile devices due to screen space issues. For iOS devices DocuSign recommends using a WebView. An entry is added into the Security Level section of the DocuSign Certificate of Completion that reflects the `securityDomain` and `authenticationMethod` properties used to verify the user identity.
///
/// Thrown when fails to make API call
///
/// Returns a URL to the recipient view UI.
///
///
/// Returns a URL that allows you to embed the recipient view of the DocuSign UI in your applications. This call cannot be used to view draft envelopes, since those envelopes have not been sent. Important: iFrames should not be used for embedded operations on mobile devices due to screen space issues. For iOS devices DocuSign recommends using a WebView. An entry is added into the Security Level section of the DocuSign Certificate of Completion that reflects the `securityDomain` and `authenticationMethod` properties used to verify the user identity.
///
/// Thrown when fails to make API call
/// ApiResponse of
ApiResponse CreateRecipientViewWithHttpInfo(string accountId, string envelopeId, RecipientViewRequest recipientViewRequest = null);
///
/// Get Responsive HTML Preview for all documents in an envelope.
///
///
/// Creates a preview of the [responsive](/docs/esign-rest-api/esign101/concepts/responsive/), HTML versions of all of the documents in an envelope. 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.
///
/// Thrown when fails to make API call
///
/// Get Responsive HTML Preview for all documents in an envelope.
///
///
/// Creates a preview of the [responsive](/docs/esign-rest-api/esign101/concepts/responsive/), HTML versions of all of the documents in an envelope. 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.
///
/// Thrown when fails to make API call
/// ApiResponse of
ApiResponse CreateResponsiveHtmlPreviewWithHttpInfo(string accountId, string envelopeId, DocumentHtmlDefinition documentHtmlDefinition = null);
///
/// Returns a URL to the sender view UI.
///
///
/// Returns a URL that allows you to embed the sender view of the DocuSign UI in your applications. This is a one-time use login token that allows the user to be placed into the DocuSign sending view. Upon sending completion, the user is returned to the return URL provided by the API application. Important: iFrames should not be used for embedded operations on mobile devices due to screen space issues. For iOS devices DocuSign recommends using a WebView.
///
/// Thrown when fails to make API call
///
/// Returns a URL to the sender view UI.
///
///
/// Returns a URL that allows you to embed the sender view of the DocuSign UI in your applications. This is a one-time use login token that allows the user to be placed into the DocuSign sending view. Upon sending completion, the user is returned to the return URL provided by the API application. Important: iFrames should not be used for embedded operations on mobile devices due to screen space issues. For iOS devices DocuSign recommends using a WebView.
///
/// Thrown when fails to make API call
/// ApiResponse of
ApiResponse CreateSenderViewWithHttpInfo(string accountId, string envelopeId, EnvelopeViewRequest envelopeViewRequest = null);
///
/// Adds tabs for a recipient.
///
///
/// Adds one or more tabs for a recipient.
///
/// Thrown when fails to make API call
///
/// Adds tabs for a recipient.
///
///
/// Adds one or more tabs for a recipient.
///
/// Thrown when fails to make API call
/// ApiResponse of
ApiResponse CreateTabsWithHttpInfo(string accountId, string envelopeId, string recipientId, Tabs tabs = null);
///
/// Creates and adds a new workflow step definition for a template's workflow
///
///
///
///
/// Thrown when fails to make API call
///
/// Creates and adds a new workflow step definition for a template's workflow
///
///
///
///
/// Thrown when fails to make API call
/// ApiResponse of
ApiResponse CreateTemplateWorkflowStepDefinitionWithHttpInfo(string accountId, string templateId, WorkflowStep workflowStep = null);
///
/// Delete one or more attachments from a DRAFT envelope.
///
///
/// Deletes one or more attachments from a draft envelope.
///
/// Thrown when fails to make API call
///
/// Delete one or more attachments from a DRAFT envelope.
///
///
/// Deletes one or more attachments from a draft envelope.
///
/// Thrown when fails to make API call
/// ApiResponse of
ApiResponse DeleteAttachmentsWithHttpInfo(string accountId, string envelopeId, EnvelopeAttachmentsRequest envelopeAttachmentsRequest = null);
///
/// Delete an existing ChunkedUpload.
///
///
/// Deletes a chunked upload that has been committed but not yet consumed. This method cannot be used to delete the following types of chunked uploads, which the system deletes automatically: - Chunked uploads that have been consumed by use in another API call. - Expired chunked uploads. **Note:** If you are aware of a chunked upload that can be discarded, the best practice is to explicitly delete it. If you wait for the system to automatically delete it after it expires, the chunked upload will continue to count against your quota.
///
/// Thrown when fails to make API call
///
/// Delete an existing ChunkedUpload.
///
///
/// Deletes a chunked upload that has been committed but not yet consumed. This method cannot be used to delete the following types of chunked uploads, which the system deletes automatically: - Chunked uploads that have been consumed by use in another API call. - Expired chunked uploads. **Note:** If you are aware of a chunked upload that can be discarded, the best practice is to explicitly delete it. If you wait for the system to automatically delete it after it expires, the chunked upload will continue to count against your quota.
///
/// Thrown when fails to make API call
/// ApiResponse of
ApiResponse DeleteChunkedUploadWithHttpInfo(string accountId, string chunkedUploadId);
///
/// Deletes envelope custom fields for draft and in-process envelopes.
///
///
/// Deletes envelope custom fields for draft and in-process envelopes.
///
/// Thrown when fails to make API call
///
/// Deletes envelope custom fields for draft and in-process envelopes.
///
///
/// Deletes envelope custom fields for draft and in-process envelopes.
///
/// Thrown when fails to make API call
/// ApiResponse of
ApiResponse DeleteCustomFieldsWithHttpInfo(string accountId, string envelopeId, CustomFields customFields = null);
///
/// Deletes custom document fields from an existing envelope document.
///
///
/// Deletes custom document fields from an existing envelope document.
///
/// Thrown when fails to make API call
///
/// Deletes custom document fields from an existing envelope document.
///
///
/// Deletes custom document fields from an existing envelope document.
///
/// Thrown when fails to make API call
/// ApiResponse of
ApiResponse DeleteDocumentFieldsWithHttpInfo(string accountId, string envelopeId, string documentId, DocumentFieldsInformation documentFieldsInformation = null);
///
/// Deletes a page from a document in an envelope.
///
///
/// Deletes a page from a document in an envelope based on the page number.
///
/// Thrown when fails to make API call
///
/// Deletes a page from a document in an envelope.
///
///
/// Deletes a page from a document in an envelope based on the page number.
///
/// Thrown when fails to make API call
/// ApiResponse of Object(void)
ApiResponse DeleteDocumentPageWithHttpInfo(string accountId, string envelopeId, string documentId, string pageNumber);
///
/// Deletes tabs from an envelope document
///
///
/// Deletes tabs from the document specified by `documentId` in the envelope specified by `envelopeId`.
///
/// Thrown when fails to make API call
///
/// Deletes tabs from an envelope document
///
///
/// Deletes tabs from the document specified by `documentId` in the envelope specified by `envelopeId`.
///
/// Thrown when fails to make API call
/// ApiResponse of
ApiResponse DeleteDocumentTabsWithHttpInfo(string accountId, string envelopeId, string documentId, Tabs tabs = null);
///
/// Deletes documents from a draft envelope.
///
///
/// Deletes one or more documents from an existing draft envelope.
///
/// Thrown when fails to make API call
///
/// Deletes documents from a draft envelope.
///
///
/// Deletes one or more documents from an existing draft envelope.
///
/// Thrown when fails to make API call
/// ApiResponse of
ApiResponse DeleteDocumentsWithHttpInfo(string accountId, string envelopeId, EnvelopeDefinition envelopeDefinition = null);
///
/// Deletes the email setting overrides for an envelope.
///
///
/// Deletes all existing email override settings for the envelope. If you want to delete an individual email override setting, use the PUT and set the value to an empty string. Note that deleting email settings will only affect email communications that occur after the deletion and the normal account email settings are used for future email communications.
///
/// Thrown when fails to make API call
///
/// Deletes the email setting overrides for an envelope.
///
///
/// Deletes all existing email override settings for the envelope. If you want to delete an individual email override setting, use the PUT and set the value to an empty string. Note that deleting email settings will only affect email communications that occur after the deletion and the normal account email settings are used for future email communications.
///
/// Thrown when fails to make API call
/// ApiResponse of
ApiResponse DeleteEmailSettingsWithHttpInfo(string accountId, string envelopeId);
///
/// Revokes the correction view URL to the Envelope UI
///
///
/// Revokes the correction view URL to the Envelope UI.
///
/// Thrown when fails to make API call
///
/// Revokes the correction view URL to the Envelope UI
///
///
/// Revokes the correction view URL to the Envelope UI.
///
/// Thrown when fails to make API call
/// ApiResponse of Object(void)
ApiResponse DeleteEnvelopeCorrectViewWithHttpInfo(string accountId, string envelopeId, CorrectViewRequest correctViewRequest = null);
///
/// Deletes the delayed routing rules for the specified envelope workflow step.
///
///
///
///
/// Thrown when fails to make API call
///
/// Deletes the delayed routing rules for the specified envelope workflow step.
///
///
///
///
/// Thrown when fails to make API call
/// ApiResponse of Object(void)
ApiResponse DeleteEnvelopeDelayedRoutingDefinitionWithHttpInfo(string accountId, string envelopeId, string workflowStepId);
///
/// Deletes the scheduled sending rules for the envelope's workflow.
///
///
///
///
/// Thrown when fails to make API call
///
/// Deletes the scheduled sending rules for the envelope's workflow.
///
///
///
///
/// Thrown when fails to make API call
/// ApiResponse of Object(void)
ApiResponse DeleteEnvelopeScheduledSendingDefinitionWithHttpInfo(string accountId, string envelopeId);
///
/// Delete envelope transfer rules for an account.
///
///
/// This method deletes an envelope transfer rule. **Note:** Only Administrators can delete envelope transfer rules. In addition, to use envelope transfer rules, the **Transfer Custody** feature must be enabled for your account.
///
/// Thrown when fails to make API call
///
/// Delete envelope transfer rules for an account.
///
///
/// This method deletes an envelope transfer rule. **Note:** Only Administrators can delete envelope transfer rules. In addition, to use envelope transfer rules, the **Transfer Custody** feature must be enabled for your account.
///
/// Thrown when fails to make API call
/// ApiResponse of Object(void)
ApiResponse DeleteEnvelopeTransferRulesWithHttpInfo(string accountId, string envelopeTransferRuleId);
///
/// Delete the workflow definition for an envelope.
///
///
/// Deletes the specified envelope's workflow definition if it has one.
///
/// Thrown when fails to make API call
///
/// Delete the workflow definition for an envelope.
///
///
/// Deletes the specified envelope's workflow definition if it has one.
///
/// Thrown when fails to make API call
/// ApiResponse of Object(void)
ApiResponse DeleteEnvelopeWorkflowDefinitionWithHttpInfo(string accountId, string envelopeId);
///
/// Deletes the envelope workflow step definition for an envelope's workflow by step id.
///
///
///
///
/// Thrown when fails to make API call
///
/// Deletes the envelope workflow step definition for an envelope's workflow by step id.
///
///
///
///
/// Thrown when fails to make API call
/// ApiResponse of Object(void)
ApiResponse DeleteEnvelopeWorkflowStepDefinitionWithHttpInfo(string accountId, string envelopeId, string workflowStepId);
///
/// Deletes an envelope lock.
///
///
/// Deletes the lock from the specified envelope. The `X-DocuSign-Edit` header must be included in the request.
///
/// Thrown when fails to make API call
///
/// Deletes an envelope lock.
///
///
/// Deletes the lock from the specified envelope. The `X-DocuSign-Edit` header must be included in the request.
///
/// Thrown when fails to make API call
/// ApiResponse of
ApiResponse DeleteLockWithHttpInfo(string accountId, string envelopeId);
///
/// Deletes a recipient from an envelope.
///
///
/// Deletes the specified recipient file from the specified envelope. This cannot be used if the envelope has been sent.
///
/// Thrown when fails to make API call
///
/// Deletes a recipient from an envelope.
///
///
/// Deletes the specified recipient file from the specified envelope. This cannot be used if the envelope has been sent.
///
/// Thrown when fails to make API call
/// ApiResponse of
ApiResponse DeleteRecipientWithHttpInfo(string accountId, string envelopeId, string recipientId);
///
/// Deletes recipients from an envelope.
///
///
/// Deletes one or more recipients from a draft or sent envelope. Recipients to be deleted are listed in the request, with the `recipientId` being used as the key for deleting recipients. If the envelope is `In Process`, meaning that it has been sent and has not been completed or voided, recipients that have completed their actions cannot be deleted.
///
/// Thrown when fails to make API call
///
/// Deletes recipients from an envelope.
///
///
/// Deletes one or more recipients from a draft or sent envelope. Recipients to be deleted are listed in the request, with the `recipientId` being used as the key for deleting recipients. If the envelope is `In Process`, meaning that it has been sent and has not been completed or voided, recipients that have completed their actions cannot be deleted.
///
/// Thrown when fails to make API call
/// ApiResponse of
ApiResponse DeleteRecipientsWithHttpInfo(string accountId, string envelopeId, Recipients recipients = null);
///
/// Deletes the tabs associated with a recipient.
///
///
/// Deletes one or more tabs associated with a recipient in a draft envelope.
///
/// Thrown when fails to make API call
///
/// Deletes the tabs associated with a recipient.
///
///
/// Deletes one or more tabs associated with a recipient in a draft envelope.
///
/// Thrown when fails to make API call
/// ApiResponse of
ApiResponse DeleteTabsWithHttpInfo(string accountId, string envelopeId, string recipientId, Tabs tabs = null);
///
/// Deletes the delayed routing rules for the specified template workflow step.
///
///
///
///
/// Thrown when fails to make API call
///
/// Deletes the delayed routing rules for the specified template workflow step.
///
///
///
///
/// Thrown when fails to make API call
/// ApiResponse of Object(void)
ApiResponse DeleteTemplateDelayedRoutingDefinitionWithHttpInfo(string accountId, string templateId, string workflowStepId);
///
/// Deletes the scheduled sending rules for the template's workflow.
///
///
///
///
/// Thrown when fails to make API call
///
/// Deletes the scheduled sending rules for the template's workflow.
///
///
///
///
/// Thrown when fails to make API call
/// ApiResponse of Object(void)
ApiResponse DeleteTemplateScheduledSendingDefinitionWithHttpInfo(string accountId, string templateId);
///
/// Delete the workflow definition for a template.
///
///
/// Deletes the specified template's workflow definition if it has one.
///
/// Thrown when fails to make API call
///
/// Delete the workflow definition for a template.
///
///
/// Deletes the specified template's workflow definition if it has one.
///
/// Thrown when fails to make API call
/// ApiResponse of Object(void)
ApiResponse DeleteTemplateWorkflowDefinitionWithHttpInfo(string accountId, string templateId);
///
/// Deletes the workflow step definition for an template's workflow by step id.
///
///
///
///
/// Thrown when fails to make API call
///
/// Deletes the workflow step definition for an template's workflow by step id.
///
///
///
///
/// Thrown when fails to make API call
/// ApiResponse of Object(void)
ApiResponse DeleteTemplateWorkflowStepDefinitionWithHttpInfo(string accountId, string templateId, string workflowStepId);
///
/// Deletes a template from a document in an existing envelope.
///
///
/// Deletes the specified template from a document in an existing envelope.
///
/// Thrown when fails to make API call
///
/// Deletes a template from a document in an existing envelope.
///
///
/// Deletes the specified template from a document in an existing envelope.
///
/// Thrown when fails to make API call
/// ApiResponse of Object(void)
ApiResponse DeleteTemplatesFromDocumentWithHttpInfo(string accountId, string envelopeId, string documentId, string templateId);
///
/// Retrieves an attachment from the envelope.
///
///
/// Retrieves an attachment from an envelope.
///
/// Thrown when fails to make API call
///
/// Retrieves an attachment from the envelope.
///
///
/// Retrieves an attachment from an envelope.
///
/// Thrown when fails to make API call
/// ApiResponse of
ApiResponse GetAttachmentWithHttpInfo(string accountId, string envelopeId, string attachmentId);
///
/// Returns a list of attachments associated with the specified envelope
///
///
/// Returns a list of attachments associated with a specified envelope
///
/// Thrown when fails to make API call
///
/// Returns a list of attachments associated with the specified envelope
///
///
/// Returns a list of attachments associated with a specified envelope
///
/// Thrown when fails to make API call
/// ApiResponse of
ApiResponse GetAttachmentsWithHttpInfo(string accountId, string envelopeId);
///
/// Retrieves the current metadata of a ChunkedUpload.
///
///
/// Returns the details (but not the content) about a chunked upload. **Note:** You cannot obtain details about a chunked upload that has expired, been deleted, or consumed by other actions.
///
/// Thrown when fails to make API call
///
/// Retrieves the current metadata of a ChunkedUpload.
///
///
/// Returns the details (but not the content) about a chunked upload. **Note:** You cannot obtain details about a chunked upload that has expired, been deleted, or consumed by other actions.
///
/// Thrown when fails to make API call
/// ApiResponse of
ApiResponse GetChunkedUploadWithHttpInfo(string accountId, string chunkedUploadId, EnvelopesApi.GetChunkedUploadOptions options = null);
///
/// Gets comment transcript for envelope and user
///
///
/// Retrieves a PDF file containing all of the comments that senders and recipients have added to the documents in an envelope. The response body of this method is the PDF file as a byte stream. **Note:** Comments are disabled by default. To use the comments feature, an account administrator must enable comments on the account (in the `accountSettingsInformation` object, set the `enableSigningExtensionComments` property to **true**).
///
/// Thrown when fails to make API call
///
/// Gets comment transcript for envelope and user
///
///
/// Retrieves a PDF file containing all of the comments that senders and recipients have added to the documents in an envelope. The response body of this method is the PDF file as a byte stream. **Note:** Comments are disabled by default. To use the comments feature, an account administrator must enable comments on the account (in the `accountSettingsInformation` object, set the `enableSigningExtensionComments` property to **true**).
///
/// Thrown when fails to make API call
/// ApiResponse of
ApiResponse GetCommentsTranscriptWithHttpInfo(string accountId, string envelopeId, EnvelopesApi.GetCommentsTranscriptOptions options = null);
///
/// Reserved: Gets the Electronic Record and Signature Disclosure associated with the account.
///
///
/// Reserved: Retrieves the Electronic Record and Signature Disclosure, with HTML formatting, associated with the account.
///
/// Thrown when fails to make API call
///
/// Reserved: Gets the Electronic Record and Signature Disclosure associated with the account.
///
///
/// Reserved: Retrieves the Electronic Record and Signature Disclosure, with HTML formatting, associated with the account.
///
/// Thrown when fails to make API call
/// ApiResponse of
ApiResponse GetConsumerDisclosureWithHttpInfo(string accountId, string envelopeId, string recipientId, string langCode, EnvelopesApi.GetConsumerDisclosureOptions options = null);
///
/// Gets the Electronic Record and Signature Disclosure associated with the account.
///
///
/// Retrieves the Electronic Record and Signature Disclosure, with html formatting, associated with the account. You can use an optional query string to set the language for the disclosure.
///
/// Thrown when fails to make API call
///
/// Gets the Electronic Record and Signature Disclosure associated with the account.
///
///
/// Retrieves the Electronic Record and Signature Disclosure, with html formatting, associated with the account. You can use an optional query string to set the language for the disclosure.
///
/// Thrown when fails to make API call
/// ApiResponse of
ApiResponse GetConsumerDisclosureDefaultWithHttpInfo(string accountId, string envelopeId, string recipientId, EnvelopesApi.GetConsumerDisclosureDefaultOptions options = null);
///
/// Gets a document from an envelope.
///
///
/// Retrieves the specified document from the envelope. If the account has the Highlight Data Changes feature enabled, there is an option to request that any changes in the envelope be highlighted. You can also use this method to retrieve a PDF containing the combined content of all documents and the certificate. If the account has the Highlight Data Changes feature enabled, there is an option to request that any changes in the envelope be highlighted. To retrieve the combined content replace the `{documentId}` parameter in the endpoint with `combined`. /accounts/{accountId}/envelopes/{envelopeId}/documents/combined
///
/// Thrown when fails to make API call
///
/// Gets a document from an envelope.
///
///
/// Retrieves the specified document from the envelope. If the account has the Highlight Data Changes feature enabled, there is an option to request that any changes in the envelope be highlighted. You can also use this method to retrieve a PDF containing the combined content of all documents and the certificate. If the account has the Highlight Data Changes feature enabled, there is an option to request that any changes in the envelope be highlighted. To retrieve the combined content replace the `{documentId}` parameter in the endpoint with `combined`. /accounts/{accountId}/envelopes/{envelopeId}/documents/combined
///
/// Thrown when fails to make API call
/// ApiResponse of
ApiResponse GetDocumentWithHttpInfo(string accountId, string envelopeId, string documentId, EnvelopesApi.GetDocumentOptions options = null);
///
/// Gets a page image from an envelope for display.
///
///
/// Retrieves a page image for display from the specified envelope.
///
/// Thrown when fails to make API call
///
/// Gets a page image from an envelope for display.
///
///
/// Retrieves a page image for display from the specified envelope.
///
/// Thrown when fails to make API call
/// ApiResponse of
ApiResponse GetDocumentPageImageWithHttpInfo(string accountId, string envelopeId, string documentId, string pageNumber, EnvelopesApi.GetDocumentPageImageOptions options = null);
///
/// Returns tabs on the document.
///
///
/// Returns the tabs on the document specified by `documentId` in the envelope specified by `envelopeId`.
///
/// Thrown when fails to make API call
///
/// Returns tabs on the document.
///
///
/// Returns the tabs on the document specified by `documentId` in the envelope specified by `envelopeId`.
///
/// Thrown when fails to make API call
/// ApiResponse of
ApiResponse GetDocumentTabsWithHttpInfo(string accountId, string envelopeId, string documentId, EnvelopesApi.GetDocumentTabsOptions options = null);
///
/// Gets the email setting overrides for an envelope.
///
///
/// Retrieves the email override settings for the specified envelope.
///
/// Thrown when fails to make API call
///
/// Gets the email setting overrides for an envelope.
///
///
/// Retrieves the email override settings for the specified envelope.
///
/// Thrown when fails to make API call
/// ApiResponse of
ApiResponse GetEmailSettingsWithHttpInfo(string accountId, string envelopeId);
///
/// Gets the status of a envelope.
///
///
/// Retrieves the overall status for the specified envelope.
///
/// Thrown when fails to make API call
///
/// Gets the status of a envelope.
///
///
/// Retrieves the overall status for the specified envelope.
///
/// Thrown when fails to make API call
/// ApiResponse of
ApiResponse GetEnvelopeWithHttpInfo(string accountId, string envelopeId, EnvelopesApi.GetEnvelopeOptions options = null);
///
/// Returns the delayed routing rules for an envelope's workflow step definition.
///
///
///
///
/// Thrown when fails to make API call
///
/// Returns the delayed routing rules for an envelope's workflow step definition.
///
///
///
///
/// Thrown when fails to make API call
/// ApiResponse of
ApiResponse GetEnvelopeDelayedRoutingDefinitionWithHttpInfo(string accountId, string envelopeId, string workflowStepId);
///
/// Returns formfields for an envelope
///
///
///
///
/// Thrown when fails to make API call
///
/// Returns formfields for an envelope
///
///
///
///
/// Thrown when fails to make API call
/// ApiResponse of
ApiResponse GetEnvelopeDocGenFormFieldsWithHttpInfo(string accountId, string envelopeId);
///
/// Get the Original HTML Definition used to generate the Responsive HTML for a given document.
///
///
///
///
/// Thrown when fails to make API call
///
/// Get the Original HTML Definition used to generate the Responsive HTML for a given document.
///
///
///
///
/// Thrown when fails to make API call
/// ApiResponse of
ApiResponse GetEnvelopeDocumentHtmlDefinitionsWithHttpInfo(string accountId, string envelopeId, string documentId);
///
/// Get the Original HTML Definition used to generate the Responsive HTML for the envelope.
///
///
///
///
/// Thrown when fails to make API call
///
/// Get the Original HTML Definition used to generate the Responsive HTML for the envelope.
///
///
///
///
/// Thrown when fails to make API call
/// ApiResponse of
ApiResponse GetEnvelopeHtmlDefinitionsWithHttpInfo(string accountId, string envelopeId);
///
/// Returns the scheduled sending rules for an envelope's workflow definition.
///
///
///
///
/// Thrown when fails to make API call
///
/// Returns the scheduled sending rules for an envelope's workflow definition.
///
///
///
///
/// Thrown when fails to make API call
/// ApiResponse of
ApiResponse GetEnvelopeScheduledSendingDefinitionWithHttpInfo(string accountId, string envelopeId);
///
/// Returns a list of envelope transfer rules in the specified account.
///
///
/// This method retrieves a list of envelope transfer rules associated with an account. **Note:** Only Administrators can create and use envelope transfer rules. In addition, to use envelope transfer rules, the **Transfer Custody** feature must be enabled for your account.
///
/// Thrown when fails to make API call
///
/// Returns a list of envelope transfer rules in the specified account.
///
///
/// This method retrieves a list of envelope transfer rules associated with an account. **Note:** Only Administrators can create and use envelope transfer rules. In addition, to use envelope transfer rules, the **Transfer Custody** feature must be enabled for your account.
///
/// Thrown when fails to make API call
/// ApiResponse of
ApiResponse GetEnvelopeTransferRulesWithHttpInfo(string accountId, EnvelopesApi.GetEnvelopeTransferRulesOptions options = null);
///
/// Returns the workflow definition for an envelope.
///
///
/// Returns an envelope's workflow definition if the envelope specified by `envelopeId` has one.
///
/// Thrown when fails to make API call
///
/// Returns the workflow definition for an envelope.
///
///
/// Returns an envelope's workflow definition if the envelope specified by `envelopeId` has one.
///
/// Thrown when fails to make API call
/// ApiResponse of
ApiResponse GetEnvelopeWorkflowDefinitionWithHttpInfo(string accountId, string envelopeId);
///
/// Returns the workflow step definition for an envelope by step id.
///
///
///
///
/// Thrown when fails to make API call
///
/// Returns the workflow step definition for an envelope by step id.
///
///
///
///
/// Thrown when fails to make API call
/// ApiResponse of
ApiResponse GetEnvelopeWorkflowStepDefinitionWithHttpInfo(string accountId, string envelopeId, string workflowStepId);
///
/// Returns envelope form data for an existing envelope.
///
///
/// This method downloads the envelope and tab data (also called form data) from any in-process, completed, or canceled envelope that you sent or that is shared with you. Recipients who are also full administrators on an account can view form data for any envelopes that another user on the account has sent to them. **Note:** To use this feature, the Sending Setting \"Allow sender to download form data\" must be enabled for the account. ### Related topics - [How to get envelope tab values](/docs/esign-rest-api/how-to/get-envelope-tab-values/)
///
/// Thrown when fails to make API call
///
/// Returns envelope form data for an existing envelope.
///
///
/// This method downloads the envelope and tab data (also called form data) from any in-process, completed, or canceled envelope that you sent or that is shared with you. Recipients who are also full administrators on an account can view form data for any envelopes that another user on the account has sent to them. **Note:** To use this feature, the Sending Setting \"Allow sender to download form data\" must be enabled for the account. ### Related topics - [How to get envelope tab values](/docs/esign-rest-api/how-to/get-envelope-tab-values/)
///
/// Thrown when fails to make API call
/// ApiResponse of
ApiResponse GetFormDataWithHttpInfo(string accountId, string envelopeId);
///
/// Gets envelope lock information.
///
///
/// Retrieves general information about the envelope lock. If the call is made by the locked by user and the request has the same integrator key as original, then the `X-DocuSign-Edit` header 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.
///
/// Thrown when fails to make API call
///
/// Gets envelope lock information.
///
///
/// Retrieves general information about the envelope lock. If the call is made by the locked by user and the request has the same integrator key as original, then the `X-DocuSign-Edit` header 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.
///
/// Thrown when fails to make API call
/// ApiResponse of
ApiResponse GetLockWithHttpInfo(string accountId, string envelopeId);
///
/// Gets envelope notification information.
///
///
/// Retrieves the envelope notification, reminders and expirations, information for an existing envelope.
///
/// Thrown when fails to make API call
///
/// Gets envelope notification information.
///
///
/// Retrieves the envelope notification, reminders and expirations, information for an existing envelope.
///
/// Thrown when fails to make API call
/// ApiResponse of
ApiResponse GetNotificationSettingsWithHttpInfo(string accountId, string envelopeId);
///
/// Returns tabs on the specified page.
///
///
/// Returns the tabs from the page specified by `pageNumber` of the document specified by `documentId` in the envelope specified by `envelopeId`.
///
/// Thrown when fails to make API call
///
/// Returns tabs on the specified page.
///
///
/// Returns the tabs from the page specified by `pageNumber` of the document specified by `documentId` in the envelope specified by `envelopeId`.
///
/// Thrown when fails to make API call
/// ApiResponse of
ApiResponse GetPageTabsWithHttpInfo(string accountId, string envelopeId, string documentId, string pageNumber);
///
/// Returns document page image(s) based on input.
///
///
/// Returns images of the pages in a document for display based on the parameters that you specify.
///
/// Thrown when fails to make API call
///
/// Returns document page image(s) based on input.
///
///
/// Returns images of the pages in a document for display based on the parameters that you specify.
///
/// Thrown when fails to make API call
/// ApiResponse of
ApiResponse GetPagesWithHttpInfo(string accountId, string envelopeId, string documentId, EnvelopesApi.GetPagesOptions options = null);
///
/// Returns document visibility for the recipients
///
///
/// This method returns information about document visibility for a recipient.
///
/// Thrown when fails to make API call
///
/// Returns document visibility for the recipients
///
///
/// This method returns information about document visibility for a recipient.
///
/// Thrown when fails to make API call
/// ApiResponse of
ApiResponse GetRecipientDocumentVisibilityWithHttpInfo(string accountId, string envelopeId, string recipientId);
///
/// Gets the initials image for a user.
///
///
/// Retrieves the initials image for the specified user. The image is returned in the same format as it was uploaded. In the request you can specify if the chrome (the added line and identifier around the initial image) is returned with the image. The userId specified in the endpoint must match the authenticated user's user id and the user must be a member of the account. The `signatureIdOrName` paramter accepts signature ID or signature name. DocuSign recommends you use signature ID (`signatureId`), since some names contain characters that do not properly URL encode. If you use the user name, it is likely that the name includes spaces and you might need to URL encode the name before using it in the endpoint. For example: \"Bob Smith\" to \"Bob%20Smith\" Older envelopes might only contain chromed images. If getting the non-chromed image fails, try getting the chromed image.
///
/// Thrown when fails to make API call
///
/// Gets the initials image for a user.
///
///
/// Retrieves the initials image for the specified user. The image is returned in the same format as it was uploaded. In the request you can specify if the chrome (the added line and identifier around the initial image) is returned with the image. The userId specified in the endpoint must match the authenticated user's user id and the user must be a member of the account. The `signatureIdOrName` paramter accepts signature ID or signature name. DocuSign recommends you use signature ID (`signatureId`), since some names contain characters that do not properly URL encode. If you use the user name, it is likely that the name includes spaces and you might need to URL encode the name before using it in the endpoint. For example: \"Bob Smith\" to \"Bob%20Smith\" Older envelopes might only contain chromed images. If getting the non-chromed image fails, try getting the chromed image.
///
/// Thrown when fails to make API call
/// ApiResponse of
ApiResponse GetRecipientInitialsImageWithHttpInfo(string accountId, string envelopeId, string recipientId, EnvelopesApi.GetRecipientInitialsImageOptions options = null);
///
/// Gets signature information for a signer or sign-in-person recipient.
///
///
/// Retrieves signature information for a signer or sign-in-person recipient.
///
/// Thrown when fails to make API call
///
/// Gets signature information for a signer or sign-in-person recipient.
///
///
/// Retrieves signature information for a signer or sign-in-person recipient.
///
/// Thrown when fails to make API call
/// ApiResponse of
ApiResponse GetRecipientSignatureWithHttpInfo(string accountId, string envelopeId, string recipientId);
///
/// Retrieve signature image information for a signer/sign-in-person recipient.
///
///
/// Retrieves the specified user signature image. The image is returned in the same format as uploaded. In the request you can specify if the chrome (the added line and identifier around the initial image) is returned with the image. The userId specified in the endpoint must match the authenticated user's user ID and the user must be a member of the account. The `signatureIdOrName` parameter accepts signature ID or signature name. DocuSign recommends you use signature ID (`signatureId`), since some names contain characters that don't properly URL encode. If you use the user name, it is likely that the name includes spaces and you might need to URL encode the name before using it in the endpoint. For example: \"Bob Smith\" to \"Bob%20Smith\" Older envelopes might only have chromed images. If getting the non-chromed image fails, try getting the chromed image.
///
/// Thrown when fails to make API call
///
/// Retrieve signature image information for a signer/sign-in-person recipient.
///
///
/// Retrieves the specified user signature image. The image is returned in the same format as uploaded. In the request you can specify if the chrome (the added line and identifier around the initial image) is returned with the image. The userId specified in the endpoint must match the authenticated user's user ID and the user must be a member of the account. The `signatureIdOrName` parameter accepts signature ID or signature name. DocuSign recommends you use signature ID (`signatureId`), since some names contain characters that don't properly URL encode. If you use the user name, it is likely that the name includes spaces and you might need to URL encode the name before using it in the endpoint. For example: \"Bob Smith\" to \"Bob%20Smith\" Older envelopes might only have chromed images. If getting the non-chromed image fails, try getting the chromed image.
///
/// Thrown when fails to make API call
/// ApiResponse of
ApiResponse GetRecipientSignatureImageWithHttpInfo(string accountId, string envelopeId, string recipientId, EnvelopesApi.GetRecipientSignatureImageOptions options = null);
///
/// Get encrypted tabs for envelope.
///
///
///
///
/// Thrown when fails to make API call
///
/// Get encrypted tabs for envelope.
///
///
///
///
/// Thrown when fails to make API call
/// ApiResponse of Object(void)
ApiResponse GetTabsBlobWithHttpInfo(string accountId, string envelopeId);
///
/// Returns the delayed routing rules for a template's workflow step definition.
///
///
///
///
/// Thrown when fails to make API call
///
/// Returns the delayed routing rules for a template's workflow step definition.
///
///
///
///
/// Thrown when fails to make API call
/// ApiResponse of
ApiResponse GetTemplateDelayedRoutingDefinitionWithHttpInfo(string accountId, string templateId, string workflowStepId);
///
/// Returns document visibility for the recipients
///
///
/// This method returns information about document visibility for a template recipient.
///
/// Thrown when fails to make API call
///
/// Returns document visibility for the recipients
///
///
/// This method returns information about document visibility for a template recipient.
///
/// Thrown when fails to make API call
/// ApiResponse of
ApiResponse GetTemplateRecipientDocumentVisibilityWithHttpInfo(string accountId, string templateId, string recipientId);
///
/// Returns the scheduled sending rules for a template's workflow definition.
///
///
///
///
/// Thrown when fails to make API call
///
/// Returns the scheduled sending rules for a template's workflow definition.
///
///
///
///
/// Thrown when fails to make API call
/// ApiResponse of
ApiResponse GetTemplateScheduledSendingDefinitionWithHttpInfo(string accountId, string templateId);
///
/// Returns the workflow definition for a template.
///
///
/// Returns template's workflow definition if the template specified by `templateId` has one.
///
/// Thrown when fails to make API call
///
/// Returns the workflow definition for a template.
///
///
/// Returns template's workflow definition if the template specified by `templateId` has one.
///
/// Thrown when fails to make API call
/// ApiResponse of
ApiResponse GetTemplateWorkflowDefinitionWithHttpInfo(string accountId, string templateId);
///
/// Returns the workflow step definition for a template by step id.
///
///
///
///
/// Thrown when fails to make API call
///
/// Returns the workflow step definition for a template by step id.
///
///
///
///
/// Thrown when fails to make API call
/// ApiResponse of
ApiResponse GetTemplateWorkflowStepDefinitionWithHttpInfo(string accountId, string templateId, string workflowStepId);
///
/// Gets the envelope audit events for an envelope.
///
///
/// Gets the envelope audit events for the specified envelope.
///
/// Thrown when fails to make API call
///
/// Gets the envelope audit events for an envelope.
///
///
/// Gets the envelope audit events for the specified envelope.
///
/// Thrown when fails to make API call
/// ApiResponse of
ApiResponse ListAuditEventsWithHttpInfo(string accountId, string envelopeId, EnvelopesApi.ListAuditEventsOptions options = null);
///
/// Gets the custom field information for the specified envelope.
///
///
/// Retrieves the custom field information for the specified envelope. You can use these fields in the envelopes for your account to record information about the envelope, help search for envelopes, and track information. The envelope custom fields are shown in the Envelope Settings section when a user is creating an envelope in the DocuSign member console. The envelope custom fields are not seen by the envelope recipients. There are two types of envelope custom fields, text, and list. A text custom field lets the sender enter the value for the field. With a list custom field, the sender selects the value of the field from a pre-made list.
///
/// Thrown when fails to make API call
///
/// Gets the custom field information for the specified envelope.
///
///
/// Retrieves the custom field information for the specified envelope. You can use these fields in the envelopes for your account to record information about the envelope, help search for envelopes, and track information. The envelope custom fields are shown in the Envelope Settings section when a user is creating an envelope in the DocuSign member console. The envelope custom fields are not seen by the envelope recipients. There are two types of envelope custom fields, text, and list. A text custom field lets the sender enter the value for the field. With a list custom field, the sender selects the value of the field from a pre-made list.
///
/// Thrown when fails to make API call
/// ApiResponse of
ApiResponse ListCustomFieldsWithHttpInfo(string accountId, string envelopeId);
///
/// Gets the custom document fields from an existing envelope document.
///
///
/// Retrieves the custom document field information from an existing envelope document.
///
/// Thrown when fails to make API call
///
/// Gets the custom document fields from an existing envelope document.
///
///
/// Retrieves the custom document field information from an existing envelope document.
///
/// Thrown when fails to make API call
/// ApiResponse of
ApiResponse ListDocumentFieldsWithHttpInfo(string accountId, string envelopeId, string documentId);
///
/// Gets a list of envelope documents.
///
///
/// Retrieves a list of documents associated with the specified envelope.
///
/// Thrown when fails to make API call
///
/// Gets a list of envelope documents.
///
///
/// Retrieves a list of documents associated with the specified envelope.
///
/// Thrown when fails to make API call
/// ApiResponse of
ApiResponse ListDocumentsWithHttpInfo(string accountId, string envelopeId, EnvelopesApi.ListDocumentsOptions options = null);
///
/// Gets the status of recipients for an envelope.
///
///
/// Retrieves the status of all recipients in a single envelope and identifies the current recipient in the routing list. The `currentRoutingOrder` property of the response contains the `routingOrder` value of the current recipient indicating that the envelope has been sent to the recipient, but the recipient has not completed their actions.
///
/// Thrown when fails to make API call
///
/// Gets the status of recipients for an envelope.
///
///
/// Retrieves the status of all recipients in a single envelope and identifies the current recipient in the routing list. The `currentRoutingOrder` property of the response contains the `routingOrder` value of the current recipient indicating that the envelope has been sent to the recipient, but the recipient has not completed their actions.
///
/// Thrown when fails to make API call
/// ApiResponse of
ApiResponse ListRecipientsWithHttpInfo(string accountId, string envelopeId, EnvelopesApi.ListRecipientsOptions options = null);
///
/// Gets the envelope status for the specified envelopes.
///
///
/// Retrieves the envelope status for the specified envelopes.
///
/// Thrown when fails to make API call
///
/// Gets the envelope status for the specified envelopes.
///
///
/// Retrieves the envelope status for the specified envelopes.
///
/// Thrown when fails to make API call
/// ApiResponse of
ApiResponse ListStatusWithHttpInfo(string accountId, EnvelopeIdsRequest envelopeIdsRequest = null, EnvelopesApi.ListStatusOptions options = null);
///
/// Gets status changes for one or more envelopes.
///
///
/// Retrieves envelope status changes for all envelopes. You can modify the information returned by adding query strings to limit the request to check between certain dates and times, or for certain envelopes, or for certain status codes. It is recommended that you use one or more of the query strings in order to limit the size of the response. ### Important: Unless you are requesting the status for specific envelopes (using the `envelopeIds` or `transactionIds` properties), you must add a set the `from_date` property in the request. Getting envelope status using `transactionIds` is useful for offline signing situations where it can be used determine if an envelope was created or not, for the cases where a network connection was lost, before the envelope status could be returned. ### Request Envelope Status Notes ### The REST API GET /envelopes call uses certain filters to find results. In some cases requests are check for \"any status change\" instead of the just the single status requested. In these cases, more envelopes might be returned by the request than otherwise would be. For example, for a request with the begin date is set to Jan 1st, an end date set to Jan 7th and the status qualifier (`from_to_status`) set to `Delivered` — the response set might contain envelopes that were created during that time period, but not delivered during the time period. To avoid unnecessary database queries, the DocuSign system checks requests to ensure that the added filters will not result in a zero-size response before acting on the request. The following table shows the valid envelope statuses (in the Valid Current Statuses column) for the status qualifiers in the request. If the status and status qualifiers in the API request do not contain any of the values shown in the valid current statuses column, then an empty list is returned. For example, a request with a status qualifier (from_to_status) of `Delivered` and a status of \"`Created`,`Sent`\", DocuSign will always return an empty list. This is because the request essentially translates to: find the envelopes that were delivered between the begin and end dates that have a current status of `Created` or `Sent`, and since an envelope that has been delivered can never have a status of `Created` or `Sent`, a zero-size response would be generated. In this case, DocuSign does not run the request, but just returns the empty list. Client applications should check that the statuses they are requesting make sense for a given status qualifier.
///
/// Thrown when fails to make API call
///
/// Gets status changes for one or more envelopes.
///
///
/// Retrieves envelope status changes for all envelopes. You can modify the information returned by adding query strings to limit the request to check between certain dates and times, or for certain envelopes, or for certain status codes. It is recommended that you use one or more of the query strings in order to limit the size of the response. ### Important: Unless you are requesting the status for specific envelopes (using the `envelopeIds` or `transactionIds` properties), you must add a set the `from_date` property in the request. Getting envelope status using `transactionIds` is useful for offline signing situations where it can be used determine if an envelope was created or not, for the cases where a network connection was lost, before the envelope status could be returned. ### Request Envelope Status Notes ### The REST API GET /envelopes call uses certain filters to find results. In some cases requests are check for \"any status change\" instead of the just the single status requested. In these cases, more envelopes might be returned by the request than otherwise would be. For example, for a request with the begin date is set to Jan 1st, an end date set to Jan 7th and the status qualifier (`from_to_status`) set to `Delivered` — the response set might contain envelopes that were created during that time period, but not delivered during the time period. To avoid unnecessary database queries, the DocuSign system checks requests to ensure that the added filters will not result in a zero-size response before acting on the request. The following table shows the valid envelope statuses (in the Valid Current Statuses column) for the status qualifiers in the request. If the status and status qualifiers in the API request do not contain any of the values shown in the valid current statuses column, then an empty list is returned. For example, a request with a status qualifier (from_to_status) of `Delivered` and a status of \"`Created`,`Sent`\", DocuSign will always return an empty list. This is because the request essentially translates to: find the envelopes that were delivered between the begin and end dates that have a current status of `Created` or `Sent`, and since an envelope that has been delivered can never have a status of `Created` or `Sent`, a zero-size response would be generated. In this case, DocuSign does not run the request, but just returns the empty list. Client applications should check that the statuses they are requesting make sense for a given status qualifier.
///
/// Thrown when fails to make API call
/// ApiResponse of
ApiResponse ListStatusChangesWithHttpInfo(string accountId, EnvelopesApi.ListStatusChangesOptions options = null);
///
/// Gets the tabs information for a signer or sign-in-person recipient in an envelope.
///
///
/// Retrieves information about the tabs associated with a recipient in a draft envelope.
///
/// Thrown when fails to make API call
///
/// Gets the tabs information for a signer or sign-in-person recipient in an envelope.
///
///
/// Retrieves information about the tabs associated with a recipient in a draft envelope.
///
/// Thrown when fails to make API call
/// ApiResponse of
ApiResponse ListTabsWithHttpInfo(string accountId, string envelopeId, string recipientId, EnvelopesApi.ListTabsOptions options = null);
///
/// Get List of Templates used in an Envelope
///
///
/// This returns a list of the server-side templates, their name and ID, used in an envelope.
///
/// Thrown when fails to make API call
///
/// Get List of Templates used in an Envelope
///
///
/// This returns a list of the server-side templates, their name and ID, used in an envelope.
///
/// Thrown when fails to make API call
/// ApiResponse of
ApiResponse ListTemplatesWithHttpInfo(string accountId, string envelopeId, EnvelopesApi.ListTemplatesOptions options = null);
///
/// Gets the templates associated with a document in an existing envelope.
///
///
/// Retrieves the templates associated with a document in the specified envelope.
///
/// Thrown when fails to make API call
///
/// Gets the templates associated with a document in an existing envelope.
///
///
/// Retrieves the templates associated with a document in the specified envelope.
///
/// Thrown when fails to make API call
/// ApiResponse of
ApiResponse ListTemplatesForDocumentWithHttpInfo(string accountId, string envelopeId, string documentId, EnvelopesApi.ListTemplatesForDocumentOptions options = null);
///
/// Add an attachment to a DRAFT or IN-PROCESS envelope.
///
///
/// Adds an attachment to a draft or in-process envelope.
///
/// Thrown when fails to make API call
///
/// Add an attachment to a DRAFT or IN-PROCESS envelope.
///
///
/// Adds an attachment to a draft or in-process envelope.
///
/// Thrown when fails to make API call
/// ApiResponse of
ApiResponse PutAttachmentWithHttpInfo(string accountId, string envelopeId, string attachmentId, Attachment attachment = null);
///
/// Add one or more attachments to a DRAFT or IN-PROCESS envelope.
///
///
/// Adds one or more attachments to a draft or in-process envelope. Envelope attachments are files that an application can include in an envelope. They are not converted to PDF. Envelope attachments are available only through the API. There is no user interface in the DocuSign web application for them. For a list of supported file formats, see [Supported File Formats](https://support.docusign.com/guides/ndse-user-guide-supported-file-formats).
///
/// Thrown when fails to make API call
///
/// Add one or more attachments to a DRAFT or IN-PROCESS envelope.
///
///
/// Adds one or more attachments to a draft or in-process envelope. Envelope attachments are files that an application can include in an envelope. They are not converted to PDF. Envelope attachments are available only through the API. There is no user interface in the DocuSign web application for them. For a list of supported file formats, see [Supported File Formats](https://support.docusign.com/guides/ndse-user-guide-supported-file-formats).
///
/// Thrown when fails to make API call
/// ApiResponse of
ApiResponse PutAttachmentsWithHttpInfo(string accountId, string envelopeId, EnvelopeAttachmentsRequest envelopeAttachmentsRequest = null);
///
/// Rotates page image from an envelope for display.
///
///
/// Rotates page image from an envelope for display. The page image can be rotated to the left or right.
///
/// Thrown when fails to make API call
///
/// Rotates page image from an envelope for display.
///
///
/// Rotates page image from an envelope for display. The page image can be rotated to the left or right.
///
/// Thrown when fails to make API call
/// ApiResponse of Object(void)
ApiResponse RotateDocumentPageWithHttpInfo(string accountId, string envelopeId, string documentId, string pageNumber, PageRequest pageRequest = null);
///
/// Send Draft Envelope/Void Envelope/Move/Purge Envelope/Modify draft
///
///
/// The Put Envelopes endpoint provides the following functionality: * Sends the specified single draft envelope. Add {\"status\":\"sent\"} to the request body to send the envelope. * Voids the specified in-process envelope. Add {\"status\":\"voided\", \"voidedReason\":\"The reason for voiding the envelope\"} to the request body to void the envelope. * Replaces the current email subject and message for a draft envelope. Add {\"emailSubject\":\"subject\", \"emailBlurb\":\"message\"} to the request body to modify the subject and message. * Place the envelope documents and envelope metadata in a purge queue so that this information is removed from the DocuSign system. Add {\"purgeState\":\"purge type\"} to the request body. *Additional information on purging documents* The purge request can only be used for completed envelopes that are not marked as the authoritative copy. The requesting user must have permission to purge documents and must be the sender (the requesting user can act as the sender using Send On Behalf Of). ###### Note: If you have set the Document Retention policy on your account, envelope documents are automatically placed in the purge queue and the warning emails are sent at the end of the retention period. ###### Note: You can set the Document Retention policy in the Classic DocuSign Experience by specifying the number of days to retain documents. ###### Note: Setting a Document Retention policy is the same as setting a schedule for purging documents. When the purge request is initiated the envelope documents, or documents and envelope metadata, are placed in a purge queue for deletion in 14 days. A warning email notification is sent to the sender and recipients associated with the envelope, notifying them that the envelope documents will be deleted in 14 days and providing a link to the documents. A second email is sent 7 days later with the same message. At the end of the 14-day period, the envelope documents are deleted from the system. If `purgeState=\"documents_queued\"` is used in the request, then only the documents are deleted and any corresponding attachments and tabs remain in the DocuSign system. If `purgeState= \"documents_and_metadata_queued\"` is used in the request, then the documents, attachments, and tabs are deleted.
///
/// Thrown when fails to make API call
///
/// Send Draft Envelope/Void Envelope/Move/Purge Envelope/Modify draft
///
///
/// The Put Envelopes endpoint provides the following functionality: * Sends the specified single draft envelope. Add {\"status\":\"sent\"} to the request body to send the envelope. * Voids the specified in-process envelope. Add {\"status\":\"voided\", \"voidedReason\":\"The reason for voiding the envelope\"} to the request body to void the envelope. * Replaces the current email subject and message for a draft envelope. Add {\"emailSubject\":\"subject\", \"emailBlurb\":\"message\"} to the request body to modify the subject and message. * Place the envelope documents and envelope metadata in a purge queue so that this information is removed from the DocuSign system. Add {\"purgeState\":\"purge type\"} to the request body. *Additional information on purging documents* The purge request can only be used for completed envelopes that are not marked as the authoritative copy. The requesting user must have permission to purge documents and must be the sender (the requesting user can act as the sender using Send On Behalf Of). ###### Note: If you have set the Document Retention policy on your account, envelope documents are automatically placed in the purge queue and the warning emails are sent at the end of the retention period. ###### Note: You can set the Document Retention policy in the Classic DocuSign Experience by specifying the number of days to retain documents. ###### Note: Setting a Document Retention policy is the same as setting a schedule for purging documents. When the purge request is initiated the envelope documents, or documents and envelope metadata, are placed in a purge queue for deletion in 14 days. A warning email notification is sent to the sender and recipients associated with the envelope, notifying them that the envelope documents will be deleted in 14 days and providing a link to the documents. A second email is sent 7 days later with the same message. At the end of the 14-day period, the envelope documents are deleted from the system. If `purgeState=\"documents_queued\"` is used in the request, then only the documents are deleted and any corresponding attachments and tabs remain in the DocuSign system. If `purgeState= \"documents_and_metadata_queued\"` is used in the request, then the documents, attachments, and tabs are deleted.
///
/// Thrown when fails to make API call
/// ApiResponse of
ApiResponse UpdateWithHttpInfo(string accountId, string envelopeId, Envelope envelope = null, EnvelopesApi.UpdateOptions options = null);
///
/// Integrity-Check and Commit a ChunkedUpload, readying it for use elsewhere.
///
///
/// This method checks the integrity of a chunked upload and then commits it. When this request is successful, the chunked upload is then ready to be referenced in other API calls. If the request is unsuccessful, ensure that you have uploaded all of the parts by using the Update method. **Note:** After you commit a chunked upload, it no longer accepts additional parts.
///
/// Thrown when fails to make API call
///
/// Integrity-Check and Commit a ChunkedUpload, readying it for use elsewhere.
///
///
/// This method checks the integrity of a chunked upload and then commits it. When this request is successful, the chunked upload is then ready to be referenced in other API calls. If the request is unsuccessful, ensure that you have uploaded all of the parts by using the Update method. **Note:** After you commit a chunked upload, it no longer accepts additional parts.
///
/// Thrown when fails to make API call
/// ApiResponse of
ApiResponse UpdateChunkedUploadWithHttpInfo(string accountId, string chunkedUploadId, EnvelopesApi.UpdateChunkedUploadOptions options = null);
///
/// Add a chunk, a chunk 'part', to an existing ChunkedUpload.
///
///
/// Adds a chunk or part to an existing chunked upload. After you use the Create method to initiate a new chunked upload and upload the first part, use this method to upload subsequent parts. For simplicity, DocuSign recommends that you upload the parts in their sequential order ( 1,2, 3, 4, etc.). The Create method adds the first part and assigns it the `sequence` value `0`. As a result, DocuSign recommends that you start with a `sequence` value of `1` when you use this method, and continue uploading parts contiguously until you have uploaded the entirety of the original content to DocuSign. Example: ``` PUT /v2.1/accounts/{accountId}/chunked_uploads/{chunkedUploadId}/1 PUT /v2.1/accounts/{accountId}/chunked_uploads/{chunkedUploadId}/2 PUT /v2.1/accounts/{accountId}/chunked_uploads/{chunkedUploadId}/3 ``` **Note:** You cannot replace a part that DocuSign has already received, or add parts to a chunked upload that is already successfully committed.
///
/// Thrown when fails to make API call
///
/// Add a chunk, a chunk 'part', to an existing ChunkedUpload.
///
///
/// Adds a chunk or part to an existing chunked upload. After you use the Create method to initiate a new chunked upload and upload the first part, use this method to upload subsequent parts. For simplicity, DocuSign recommends that you upload the parts in their sequential order ( 1,2, 3, 4, etc.). The Create method adds the first part and assigns it the `sequence` value `0`. As a result, DocuSign recommends that you start with a `sequence` value of `1` when you use this method, and continue uploading parts contiguously until you have uploaded the entirety of the original content to DocuSign. Example: ``` PUT /v2.1/accounts/{accountId}/chunked_uploads/{chunkedUploadId}/1 PUT /v2.1/accounts/{accountId}/chunked_uploads/{chunkedUploadId}/2 PUT /v2.1/accounts/{accountId}/chunked_uploads/{chunkedUploadId}/3 ``` **Note:** You cannot replace a part that DocuSign has already received, or add parts to a chunked upload that is already successfully committed.
///
/// Thrown when fails to make API call
/// ApiResponse of
ApiResponse UpdateChunkedUploadPartWithHttpInfo(string accountId, string chunkedUploadId, string chunkedUploadPartSeq, ChunkedUploadRequest chunkedUploadRequest = null);
///
/// Updates envelope custom fields in an envelope.
///
///
/// Updates the envelope custom fields in draft and in-process envelopes. Each custom field used in an envelope must have a unique name.
///
/// Thrown when fails to make API call
///
/// Updates envelope custom fields in an envelope.
///
///
/// Updates the envelope custom fields in draft and in-process envelopes. Each custom field used in an envelope must have a unique name.
///
/// Thrown when fails to make API call
/// ApiResponse of
ApiResponse UpdateCustomFieldsWithHttpInfo(string accountId, string envelopeId, CustomFields customFields = null);
///
/// Adds a document to an existing draft envelope.
///
///
/// Adds a document to an existing draft envelope.
///
/// Thrown when fails to make API call
///
/// Adds a document to an existing draft envelope.
///
///
/// Adds a document to an existing draft envelope.
///
/// Thrown when fails to make API call
/// ApiResponse of
ApiResponse UpdateDocumentWithHttpInfo(string accountId, string envelopeId, string documentId, byte[] documentFileBytes);
///
/// Updates existing custom document fields in an existing envelope document.
///
///
/// Updates existing custom document fields in an existing envelope document.
///
/// Thrown when fails to make API call
///
/// Updates existing custom document fields in an existing envelope document.
///
///
/// Updates existing custom document fields in an existing envelope document.
///
/// Thrown when fails to make API call
/// ApiResponse of
ApiResponse UpdateDocumentFieldsWithHttpInfo(string accountId, string envelopeId, string documentId, DocumentFieldsInformation documentFieldsInformation = null);
///
/// Updates the tabs for an envelope document
///
///
/// Updates tabs in the document specified by `documentId` in the envelope specified by `envelopeId`.
///
/// Thrown when fails to make API call
///
/// Updates the tabs for an envelope document
///
///
/// Updates tabs in the document specified by `documentId` in the envelope specified by `envelopeId`.
///
/// Thrown when fails to make API call
/// ApiResponse of
ApiResponse UpdateDocumentTabsWithHttpInfo(string accountId, string envelopeId, string documentId, Tabs tabs = null);
///
/// Adds one or more documents to an existing envelope document.
///
///
/// Adds one or more documents to an existing envelope document.
///
/// Thrown when fails to make API call
///
/// Adds one or more documents to an existing envelope document.
///
///
/// Adds one or more documents to an existing envelope document.
///
/// Thrown when fails to make API call
/// ApiResponse of
ApiResponse UpdateDocumentsWithHttpInfo(string accountId, string envelopeId, EnvelopeDefinition envelopeDefinition = null);
///
/// Updates the email setting overrides for an envelope.
///
///
/// Updates the existing email override settings for the specified envelope. Note that modifying email settings will only affect email communications that occur after the modification was made. This can also be used to delete an individual email override setting by using an empty string for the value to be deleted.
///
/// Thrown when fails to make API call
///
/// Updates the email setting overrides for an envelope.
///
///
/// Updates the existing email override settings for the specified envelope. Note that modifying email settings will only affect email communications that occur after the modification was made. This can also be used to delete an individual email override setting by using an empty string for the value to be deleted.
///
/// Thrown when fails to make API call
/// ApiResponse of
ApiResponse UpdateEmailSettingsWithHttpInfo(string accountId, string envelopeId, EmailSettings emailSettings = null);
///
/// Updates the delayed routing rules for an envelope's workflow step definition.
///
///
///
///
/// Thrown when fails to make API call
///
/// Updates the delayed routing rules for an envelope's workflow step definition.
///
///
///
///
/// Thrown when fails to make API call
/// ApiResponse of
ApiResponse UpdateEnvelopeDelayedRoutingDefinitionWithHttpInfo(string accountId, string envelopeId, string workflowStepId, DelayedRouting delayedRouting = null);
///
/// Updates formfields for an envelope
///
///
///
///
/// Thrown when fails to make API call
///
/// Updates formfields for an envelope
///
///
///
///
/// Thrown when fails to make API call
/// ApiResponse of
ApiResponse UpdateEnvelopeDocGenFormFieldsWithHttpInfo(string accountId, string envelopeId, DocGenFormFieldRequest docGenFormFieldRequest = null, EnvelopesApi.UpdateEnvelopeDocGenFormFieldsOptions options = null);
///
/// Updates the scheduled sending rules for an envelope's workflow definition.
///
///
///
///
/// Thrown when fails to make API call
///
/// Updates the scheduled sending rules for an envelope's workflow definition.
///
///
///
///
/// Thrown when fails to make API call
/// ApiResponse of
ApiResponse UpdateEnvelopeScheduledSendingDefinitionWithHttpInfo(string accountId, string envelopeId, ScheduledSending scheduledSending = null);
///
/// Update an envelope transfer rule for an account.
///
///
/// This method changes the status of an envelope transfer rule. You use this method to change whether or not the rule is enabled. You must include the `envelopeTransferRuleId` both as a query parameter, and in the request body. **Note:** You cannot change any other information about the envelope transfer rule. Only Administrators can update an envelope transfer rule. In addition, to use envelope transfer rules, the **Transfer Custody** feature must be enabled for your account.
///
/// Thrown when fails to make API call
///
/// Update an envelope transfer rule for an account.
///
///
/// This method changes the status of an envelope transfer rule. You use this method to change whether or not the rule is enabled. You must include the `envelopeTransferRuleId` both as a query parameter, and in the request body. **Note:** You cannot change any other information about the envelope transfer rule. Only Administrators can update an envelope transfer rule. In addition, to use envelope transfer rules, the **Transfer Custody** feature must be enabled for your account.
///
/// Thrown when fails to make API call
/// ApiResponse of
ApiResponse UpdateEnvelopeTransferRuleWithHttpInfo(string accountId, string envelopeTransferRuleId, EnvelopeTransferRule envelopeTransferRule = null);
///
/// Update envelope transfer rules for an account.
///
///
/// This method changes the status for one or more envelope transfer rules based on the `envelopeTransferRuleId`s in the request body. You use this method to change whether or not the rules are enabled. **Note:** You cannot change any other information about the envelope transfer rule. Only Administrators can update envelope transfer rules. In addition, to use envelope transfer rules, the **Transfer Custody** feature must be enabled for your account.
///
/// Thrown when fails to make API call
///
/// Update envelope transfer rules for an account.
///
///
/// This method changes the status for one or more envelope transfer rules based on the `envelopeTransferRuleId`s in the request body. You use this method to change whether or not the rules are enabled. **Note:** You cannot change any other information about the envelope transfer rule. Only Administrators can update envelope transfer rules. In addition, to use envelope transfer rules, the **Transfer Custody** feature must be enabled for your account.
///
/// Thrown when fails to make API call
/// ApiResponse of
ApiResponse UpdateEnvelopeTransferRulesWithHttpInfo(string accountId, EnvelopeTransferRuleInformation envelopeTransferRuleInformation = null);
///
/// Updates the envelope workflow definition for an envelope.
///
///
/// Updates the specified envelope's workflow definition if it has one.
///
/// Thrown when fails to make API call
///
/// Updates the envelope workflow definition for an envelope.
///
///
/// Updates the specified envelope's workflow definition if it has one.
///
/// Thrown when fails to make API call
/// ApiResponse of
ApiResponse UpdateEnvelopeWorkflowDefinitionWithHttpInfo(string accountId, string envelopeId, Workflow workflow = null);
///
/// Updates the envelope workflow step definition for an envelope.
///
///
///
///
/// Thrown when fails to make API call
///
/// Updates the envelope workflow step definition for an envelope.
///
///
///
///
/// Thrown when fails to make API call
/// ApiResponse of
ApiResponse UpdateEnvelopeWorkflowStepDefinitionWithHttpInfo(string accountId, string envelopeId, string workflowStepId, WorkflowStep workflowStep = null);
///
/// Updates an envelope lock.
///
///
/// Updates the lock duration time or update the `lockedByApp` property information for the specified envelope. 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.
///
/// Thrown when fails to make API call
///
/// Updates an envelope lock.
///
///
/// Updates the lock duration time or update the `lockedByApp` property information for the specified envelope. 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.
///
/// Thrown when fails to make API call
/// ApiResponse of
ApiResponse UpdateLockWithHttpInfo(string accountId, string envelopeId, LockRequest lockRequest = null);
///
/// Sets envelope notification (Reminders/Expirations) structure for an existing envelope.
///
///
/// This method sets the notifications (reminders and expirations) for an existing envelope. The request body sends a structure containing reminders and expirations settings. It also specifies whether to use the settings specified in the request, or the account default notification settings for the envelope. Note that this request only specifies when notifications are sent; it does not initiate sending of email messages.
///
/// Thrown when fails to make API call
///
/// Sets envelope notification (Reminders/Expirations) structure for an existing envelope.
///
///
/// This method sets the notifications (reminders and expirations) for an existing envelope. The request body sends a structure containing reminders and expirations settings. It also specifies whether to use the settings specified in the request, or the account default notification settings for the envelope. Note that this request only specifies when notifications are sent; it does not initiate sending of email messages.
///
/// Thrown when fails to make API call
/// ApiResponse of
ApiResponse UpdateNotificationSettingsWithHttpInfo(string accountId, string envelopeId, EnvelopeNotificationRequest envelopeNotificationRequest = null);
///
/// Updates document visibility for the recipients
///
///
/// This method updates document visibility for a recipient. **Note:** A document cannot be hidden from a recipient if the recipient has tabs assigned to them on the document. Carbon Copy, Certified Delivery (Needs to Sign), Editor, and Agent recipients can always see all documents.
///
/// Thrown when fails to make API call
///
/// Updates document visibility for the recipients
///
///
/// This method updates document visibility for a recipient. **Note:** A document cannot be hidden from a recipient if the recipient has tabs assigned to them on the document. Carbon Copy, Certified Delivery (Needs to Sign), Editor, and Agent recipients can always see all documents.
///
/// Thrown when fails to make API call
/// ApiResponse of
ApiResponse UpdateRecipientDocumentVisibilityWithHttpInfo(string accountId, string envelopeId, string recipientId, DocumentVisibilityList documentVisibilityList = null);
///
/// Sets the initials image for an accountless signer.
///
///
/// Updates the initials image for a signer that does not have a DocuSign account. The supported image formats for this file are: gif, png, jpeg, and bmp. The file size must be less than 200K. For the Authentication/Authorization for this call, the credentials must match the sender of the envelope, the recipient must be an accountless signer or in person signer. The account must have the `CanSendEnvelope` property set to **true** and the `ExpressSendOnly` property in `SendingUser` structure must be set to **false**.
///
/// Thrown when fails to make API call
///
/// Sets the initials image for an accountless signer.
///
///
/// Updates the initials image for a signer that does not have a DocuSign account. The supported image formats for this file are: gif, png, jpeg, and bmp. The file size must be less than 200K. For the Authentication/Authorization for this call, the credentials must match the sender of the envelope, the recipient must be an accountless signer or in person signer. The account must have the `CanSendEnvelope` property set to **true** and the `ExpressSendOnly` property in `SendingUser` structure must be set to **false**.
///
/// Thrown when fails to make API call
/// ApiResponse of Object(void)
ApiResponse UpdateRecipientInitialsImageWithHttpInfo(string accountId, string envelopeId, string recipientId);
///
/// Sets the signature image for an accountless signer.
///
///
/// Updates the signature image for an accountless signer. The supported image formats for this file are: gif, png, jpeg, and bmp. The file size must be less than 200K. For the Authentication/Authorization for this call, the credentials must match the sender of the envelope, the recipient must be an accountless signer or in person signer. The account must have the `CanSendEnvelope` property set to **true** and the `ExpressSendOnly` property in `SendingUser` structure must be set to **false**.
///
/// Thrown when fails to make API call
///
/// Sets the signature image for an accountless signer.
///
///
/// Updates the signature image for an accountless signer. The supported image formats for this file are: gif, png, jpeg, and bmp. The file size must be less than 200K. For the Authentication/Authorization for this call, the credentials must match the sender of the envelope, the recipient must be an accountless signer or in person signer. The account must have the `CanSendEnvelope` property set to **true** and the `ExpressSendOnly` property in `SendingUser` structure must be set to **false**.
///
/// Thrown when fails to make API call
/// ApiResponse of Object(void)
ApiResponse UpdateRecipientSignatureImageWithHttpInfo(string accountId, string envelopeId, string recipientId);
///
/// Updates recipients in a draft envelope or corrects recipient information for an in process envelope.
///
///
/// Updates recipients in a draft envelope or corrects recipient information for an in process envelope. For draft envelopes, you can edit the following properties: `email`, `userName`, `routingOrder`, `faxNumber`, `deliveryMethod`, `accessCode`, and `requireIdLookup`. Once an envelope has been sent, you can only edit: `email`, `userName`, `signerName`, `routingOrder`, `faxNumber`, and `deliveryMethod`. You can also select to resend an envelope by using the `resend_envelope` option. If you send information for a recipient that does not already exist in a draft envelope, the recipient is added to the envelope (similar to the POST).
///
/// Thrown when fails to make API call
///
/// Updates recipients in a draft envelope or corrects recipient information for an in process envelope.
///
///
/// Updates recipients in a draft envelope or corrects recipient information for an in process envelope. For draft envelopes, you can edit the following properties: `email`, `userName`, `routingOrder`, `faxNumber`, `deliveryMethod`, `accessCode`, and `requireIdLookup`. Once an envelope has been sent, you can only edit: `email`, `userName`, `signerName`, `routingOrder`, `faxNumber`, and `deliveryMethod`. You can also select to resend an envelope by using the `resend_envelope` option. If you send information for a recipient that does not already exist in a draft envelope, the recipient is added to the envelope (similar to the POST).
///
/// Thrown when fails to make API call
/// ApiResponse of
ApiResponse UpdateRecipientsWithHttpInfo(string accountId, string envelopeId, Recipients recipients = null, EnvelopesApi.UpdateRecipientsOptions options = null);
///
/// Updates document visibility for the recipients
///
///
/// This method updates document visibility for one or more recipients based on the `recipientId` and `visible` values that you include in the request body. **Note:** A document cannot be hidden from a recipient if the recipient has tabs assigned to them on the document. Carbon Copy, Certified Delivery (Needs to Sign), Editor, and Agent recipients can always see all documents.
///
/// Thrown when fails to make API call
///
/// Updates document visibility for the recipients
///
///
/// This method updates document visibility for one or more recipients based on the `recipientId` and `visible` values that you include in the request body. **Note:** A document cannot be hidden from a recipient if the recipient has tabs assigned to them on the document. Carbon Copy, Certified Delivery (Needs to Sign), Editor, and Agent recipients can always see all documents.
///
/// Thrown when fails to make API call
/// ApiResponse of
ApiResponse UpdateRecipientsDocumentVisibilityWithHttpInfo(string accountId, string envelopeId, DocumentVisibilityList documentVisibilityList = null);
///
/// Updates the tabs for a recipient.
///
///
/// Updates one or more tabs for a recipient in a draft envelope.
///
/// Thrown when fails to make API call
///
/// Updates the tabs for a recipient.
///
///
/// Updates one or more tabs for a recipient in a draft envelope.
///
/// Thrown when fails to make API call
/// ApiResponse of
ApiResponse UpdateTabsWithHttpInfo(string accountId, string envelopeId, string recipientId, Tabs tabs = null);
///
/// Update encrypted tabs for envelope.
///
///
///
///
/// Thrown when fails to make API call
///
/// Update encrypted tabs for envelope.
///
///
///
///
/// Thrown when fails to make API call
/// ApiResponse of Object(void)
ApiResponse UpdateTabsBlobWithHttpInfo(string accountId, string envelopeId);
///
/// Updates the delayed routing rules for a template's workflow step definition.
///
///
///
///
/// Thrown when fails to make API call
///
/// Updates the delayed routing rules for a template's workflow step definition.
///
///
///
///
/// Thrown when fails to make API call
/// ApiResponse of
ApiResponse UpdateTemplateDelayedRoutingDefinitionWithHttpInfo(string accountId, string templateId, string workflowStepId, DelayedRouting delayedRouting = null);
///
/// Updates document visibility for the recipients
///
///
/// This method updates the document visibility for a template recipient. **Note:** A document cannot be hidden from a recipient if the recipient has tabs assigned to them on the document. Carbon Copy, Certified Delivery (Needs to Sign), Editor, and Agent recipients can always see all documents.
///
/// Thrown when fails to make API call
///
/// Updates document visibility for the recipients
///
///
/// This method updates the document visibility for a template recipient. **Note:** A document cannot be hidden from a recipient if the recipient has tabs assigned to them on the document. Carbon Copy, Certified Delivery (Needs to Sign), Editor, and Agent recipients can always see all documents.
///
/// Thrown when fails to make API call
/// ApiResponse of
ApiResponse UpdateTemplateRecipientDocumentVisibilityWithHttpInfo(string accountId, string templateId, string recipientId, TemplateDocumentVisibilityList templateDocumentVisibilityList = null);
///
/// Updates document visibility for the recipients
///
///
/// This method updates document visibility for one or more template recipients based on the `recipientId` and `visible` values that you include in the request body. **Note:** A document cannot be hidden from a recipient if the recipient has tabs assigned to them on the document. Carbon Copy, Certified Delivery (Needs to Sign), Editor, and Agent recipients can always see all documents.
///
/// Thrown when fails to make API call
///
/// Updates document visibility for the recipients
///
///
/// This method updates document visibility for one or more template recipients based on the `recipientId` and `visible` values that you include in the request body. **Note:** A document cannot be hidden from a recipient if the recipient has tabs assigned to them on the document. Carbon Copy, Certified Delivery (Needs to Sign), Editor, and Agent recipients can always see all documents.
///
/// Thrown when fails to make API call
/// ApiResponse of
ApiResponse UpdateTemplateRecipientsDocumentVisibilityWithHttpInfo(string accountId, string templateId, TemplateDocumentVisibilityList templateDocumentVisibilityList = null);
///
/// Updates the scheduled sending rules for a template's workflow definition.
///
///
///
///
/// Thrown when fails to make API call
///
/// Updates the scheduled sending rules for a template's workflow definition.
///
///
///
///
/// Thrown when fails to make API call
/// ApiResponse of
ApiResponse UpdateTemplateScheduledSendingDefinitionWithHttpInfo(string accountId, string templateId, ScheduledSending scheduledSending = null);
///
/// Updates the workflow definition for a template.
///
///
/// Updates the specified template's workflow definition if it has one.
///
/// Thrown when fails to make API call
///
/// Updates the workflow definition for a template.
///
///
/// Updates the specified template's workflow definition if it has one.
///
/// Thrown when fails to make API call
/// ApiResponse of
ApiResponse UpdateTemplateWorkflowDefinitionWithHttpInfo(string accountId, string templateId, Workflow workflow = null);
///
/// Updates the template workflow step definition for an envelope.
///
///
///
///
/// Thrown when fails to make API call
///
/// Updates the template workflow step definition for an envelope.
///
///
///
///
/// Thrown when fails to make API call
/// ApiResponse of
ApiResponse UpdateTemplateWorkflowStepDefinitionWithHttpInfo(string accountId, string templateId, string workflowStepId, WorkflowStep workflowStep = null);
#endregion Synchronous Operations
#region Asynchronous Operations
///
/// Adds templates to an envelope.
///
///
/// Adds templates to the specified envelope.
///
/// Thrown when fails to make API call
/// Task of DocumentTemplateList
System.Threading.Tasks.Task ApplyTemplateAsync(string accountId, string envelopeId, DocumentTemplateList documentTemplateList = null, EnvelopesApi.ApplyTemplateOptions options = null);
///
/// Adds templates to an envelope.
///
///
/// Adds templates to the specified envelope.
///
/// Thrown when fails to make API call
/// Task of ApiResponse (DocumentTemplateList)
System.Threading.Tasks.Task> ApplyTemplateAsyncWithHttpInfo(string accountId, string envelopeId, DocumentTemplateList documentTemplateList = null, EnvelopesApi.ApplyTemplateOptions options = null);
///
/// Adds templates to a document in an envelope.
///
///
/// Adds templates to a document in the specified envelope.
///
/// Thrown when fails to make API call
/// Task of DocumentTemplateList
System.Threading.Tasks.Task ApplyTemplateToDocumentAsync(string accountId, string envelopeId, string documentId, DocumentTemplateList documentTemplateList = null, EnvelopesApi.ApplyTemplateToDocumentOptions options = null);
///
/// Adds templates to a document in an envelope.
///
///
/// Adds templates to a document in the specified envelope.
///
/// Thrown when fails to make API call
/// Task of ApiResponse (DocumentTemplateList)
System.Threading.Tasks.Task> ApplyTemplateToDocumentAsyncWithHttpInfo(string accountId, string envelopeId, string documentId, DocumentTemplateList documentTemplateList = null, EnvelopesApi.ApplyTemplateToDocumentOptions options = null);
///
/// Initiate a new ChunkedUpload.
///
///
/// This method initiates a new chunked upload with the first part of the content.
///
/// Thrown when fails to make API call
/// Task of ChunkedUploadResponse
System.Threading.Tasks.Task CreateChunkedUploadAsync(string accountId, ChunkedUploadRequest chunkedUploadRequest = null);
///
/// Initiate a new ChunkedUpload.
///
///
/// This method initiates a new chunked upload with the first part of the content.
///
/// Thrown when fails to make API call
/// Task of ApiResponse (ChunkedUploadResponse)
System.Threading.Tasks.Task> CreateChunkedUploadAsyncWithHttpInfo(string accountId, ChunkedUploadRequest chunkedUploadRequest = null);
///
/// Returns a URL to the authentication view UI.
///
///
/// Returns a URL that allows you to embed the authentication view of the DocuSign UI in your applications.
///
/// Thrown when fails to make API call
/// Task of ViewUrl
System.Threading.Tasks.Task CreateConsoleViewAsync(string accountId, ConsoleViewRequest consoleViewRequest = null);
///
/// Returns a URL to the authentication view UI.
///
///
/// Returns a URL that allows you to embed the authentication view of the DocuSign UI in your applications.
///
/// Thrown when fails to make API call
/// Task of ApiResponse (ViewUrl)
System.Threading.Tasks.Task> CreateConsoleViewAsyncWithHttpInfo(string accountId, ConsoleViewRequest consoleViewRequest = null);
///
/// Returns a URL to the envelope correction UI.
///
///
/// Returns a URL that allows you to embed the envelope correction view of the DocuSign UI in your applications. Important: iFrames should not be used for embedded operations on mobile devices due to screen space issues. For iOS devices DocuSign recommends using a WebView.
///
/// Thrown when fails to make API call
/// Task of ViewUrl
System.Threading.Tasks.Task CreateCorrectViewAsync(string accountId, string envelopeId, EnvelopeViewRequest envelopeViewRequest = null);
///
/// Returns a URL to the envelope correction UI.
///
///
/// Returns a URL that allows you to embed the envelope correction view of the DocuSign UI in your applications. Important: iFrames should not be used for embedded operations on mobile devices due to screen space issues. For iOS devices DocuSign recommends using a WebView.
///
/// Thrown when fails to make API call
/// Task of ApiResponse (ViewUrl)
System.Threading.Tasks.Task> CreateCorrectViewAsyncWithHttpInfo(string accountId, string envelopeId, EnvelopeViewRequest envelopeViewRequest = null);
///
/// Updates envelope custom fields for an envelope.
///
///
/// Updates the envelope custom fields for draft and in-process envelopes. Each custom field used in an envelope must have a unique name.
///
/// Thrown when fails to make API call
/// Task of CustomFields
System.Threading.Tasks.Task CreateCustomFieldsAsync(string accountId, string envelopeId, CustomFields customFields = null);
///
/// Updates envelope custom fields for an envelope.
///
///
/// Updates the envelope custom fields for draft and in-process envelopes. Each custom field used in an envelope must have a unique name.
///
/// Thrown when fails to make API call
/// Task of ApiResponse (CustomFields)
System.Threading.Tasks.Task> CreateCustomFieldsAsyncWithHttpInfo(string accountId, string envelopeId, CustomFields customFields = null);
///
/// Creates custom document fields in an existing envelope document.
///
///
/// Creates custom document fields in an existing envelope document.
///
/// Thrown when fails to make API call
/// Task of DocumentFieldsInformation
System.Threading.Tasks.Task CreateDocumentFieldsAsync(string accountId, string envelopeId, string documentId, DocumentFieldsInformation documentFieldsInformation = null);
///
/// Creates custom document fields in an existing envelope document.
///
///
/// Creates custom document fields in an existing envelope document.
///
/// Thrown when fails to make API call
/// Task of ApiResponse (DocumentFieldsInformation)
System.Threading.Tasks.Task> CreateDocumentFieldsAsyncWithHttpInfo(string accountId, string envelopeId, string documentId, DocumentFieldsInformation documentFieldsInformation = null);
///
/// Get Responsive HTML Preview for a document in an envelope.
///
///
/// Creates a preview of the [responsive](/docs/esign-rest-api/esign101/concepts/responsive/) HTML version of a specific 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.
///
/// Thrown when fails to make API call
/// Task of DocumentHtmlDefinitions
System.Threading.Tasks.Task CreateDocumentResponsiveHtmlPreviewAsync(string accountId, string envelopeId, string documentId, DocumentHtmlDefinition documentHtmlDefinition = null);
///
/// Get Responsive HTML Preview for a document in an envelope.
///
///
/// Creates a preview of the [responsive](/docs/esign-rest-api/esign101/concepts/responsive/) HTML version of a specific 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.
///
/// Thrown when fails to make API call
/// Task of ApiResponse (DocumentHtmlDefinitions)
System.Threading.Tasks.Task> CreateDocumentResponsiveHtmlPreviewAsyncWithHttpInfo(string accountId, string envelopeId, string documentId, DocumentHtmlDefinition documentHtmlDefinition = null);
///
/// Adds the tabs to an envelope document
///
///
/// Adds tabs to the document specified by `documentId` in the envelope specified by `envelopeId`. In the request body, you only need to specify the tabs that your are adding. For example, to add a text [prefill tab](/docs/esign-rest-api/reference/envelopes/envelopedocumenttabs/create/#definition__tabs_prefilltabs), your request body might look like this: ``` { \"prefillTabs\": { \"textTabs\": [ { \"value\": \"a prefill text tab\", \"pageNumber\": \"1\", \"documentId\": \"1\", \"xPosition\": 316, \"yPosition\": 97 } ] } } ```
///
/// Thrown when fails to make API call
/// Task of Tabs
System.Threading.Tasks.Task CreateDocumentTabsAsync(string accountId, string envelopeId, string documentId, Tabs tabs = null);
///
/// Adds the tabs to an envelope document
///
///
/// Adds tabs to the document specified by `documentId` in the envelope specified by `envelopeId`. In the request body, you only need to specify the tabs that your are adding. For example, to add a text [prefill tab](/docs/esign-rest-api/reference/envelopes/envelopedocumenttabs/create/#definition__tabs_prefilltabs), your request body might look like this: ``` { \"prefillTabs\": { \"textTabs\": [ { \"value\": \"a prefill text tab\", \"pageNumber\": \"1\", \"documentId\": \"1\", \"xPosition\": 316, \"yPosition\": 97 } ] } } ```
///
/// Thrown when fails to make API call
/// Task of ApiResponse (Tabs)
System.Threading.Tasks.Task> CreateDocumentTabsAsyncWithHttpInfo(string accountId, string envelopeId, string documentId, Tabs tabs = null);
///
/// Returns a URL to the edit view UI.
///
///
/// Returns a URL that allows you to embed the edit view of the DocuSign UI in your applications. This is a one-time use login token that allows the user to be placed into the DocuSign editing view. Upon sending completion, the user is returned to the return URL provided by the API application. Important: iFrames should not be used for embedded operations on mobile devices due to screen space issues. For iOS devices DocuSign recommends using a WebView.
///
/// Thrown when fails to make API call
/// Task of ViewUrl
System.Threading.Tasks.Task CreateEditViewAsync(string accountId, string envelopeId, EnvelopeViewRequest envelopeViewRequest = null);
///
/// Returns a URL to the edit view UI.
///
///
/// Returns a URL that allows you to embed the edit view of the DocuSign UI in your applications. This is a one-time use login token that allows the user to be placed into the DocuSign editing view. Upon sending completion, the user is returned to the return URL provided by the API application. Important: iFrames should not be used for embedded operations on mobile devices due to screen space issues. For iOS devices DocuSign recommends using a WebView.
///
/// Thrown when fails to make API call
/// Task of ApiResponse (ViewUrl)
System.Threading.Tasks.Task> CreateEditViewAsyncWithHttpInfo(string accountId, string envelopeId, EnvelopeViewRequest envelopeViewRequest = null);
///
/// Adds email setting overrides to an envelope.
///
///
/// Adds email override settings, changing the email address to reply to an email address, name, or the BCC for email archive information, for the envelope. Note that adding email settings will only affect email communications that occur after the addition was made. ### Important: The BCC Email address feature is designed to provide a copy of all email communications for external archiving purposes. DocuSign recommends that envelopes sent using the BCC for Email Archive feature, including the BCC Email Override option, include additional signer authentication options. To send a copy of the envelope to a recipient who does not need to sign, use a Carbon Copies or Certified Deliveries Recipient Type.
///
/// Thrown when fails to make API call
/// Task of EmailSettings
System.Threading.Tasks.Task CreateEmailSettingsAsync(string accountId, string envelopeId, EmailSettings emailSettings = null);
///
/// Adds email setting overrides to an envelope.
///
///
/// Adds email override settings, changing the email address to reply to an email address, name, or the BCC for email archive information, for the envelope. Note that adding email settings will only affect email communications that occur after the addition was made. ### Important: The BCC Email address feature is designed to provide a copy of all email communications for external archiving purposes. DocuSign recommends that envelopes sent using the BCC for Email Archive feature, including the BCC Email Override option, include additional signer authentication options. To send a copy of the envelope to a recipient who does not need to sign, use a Carbon Copies or Certified Deliveries Recipient Type.
///
/// Thrown when fails to make API call
/// Task of ApiResponse (EmailSettings)
System.Threading.Tasks.Task> CreateEmailSettingsAsyncWithHttpInfo(string accountId, string envelopeId, EmailSettings emailSettings = null);
///
/// Creates an envelope.
///
///
/// Creates an envelope. Using this function you can: * Create an envelope and send it. * Create an envelope from an existing template and send it. In either case, you can choose to save the envelope as a draft envelope instead of sending it by setting the request's `status` property to `created` instead of `sent`. ## Sending Envelopes Documents can be included with the Envelopes::create call itself or a template can include documents. Documents can be added by using a multi-part/form request or by using the `documentBase64` field of the [`document` object](#/definitions/document) ### Recipient Types An [`envelopeDefinition` object](#/definitions/envelopeDefinition) is used as the method's body. Envelope recipients can be defined in the envelope or in templates. The `envelopeDefinition` object's `recipients` field is an [`EnvelopeRecipients` resource object](#/definitions/EnvelopeRecipients). It includes arrays of the seven types of recipients defined by DocuSign: Recipient type | Object definition - -- -- -- -- -- -- - | - -- -- -- -- -- -- -- -- agent (can add name and email information for later recipients/signers) | [`agent`](#/definitions/agent) carbon copy (receives a copy of the documents) | [`carbonCopy`](#/definitions/carbonCopy) certified delivery (receives a copy of the documents and must acknowledge receipt) | [`certifiedDelivery`](#/definitions/certifiedDelivery) editor (can change recipients and document fields for later recipients/signers) | [`editor`](#/definitions/editor) in-person signer (\"hosts\" someone who signs in-person) | [`inPersonSigner`](#/definitions/inPersonSigner) intermediary (can add name and email information for some later recipients/signers.) | [`intermediary`](#/definitions/intermediary) signer (signs and/or updates document fields) | [`signer`](#/definitions/signer) Additional information about the different types of recipients is available from the [`EnvelopeRecipients` resource page](../../EnvelopeRecipients) and from the [Developer Center](https://www.docusign.com/developer-center/explore/features/recipients) ### Tabs Tabs (also referred to as `tags` and as `fields` in the web sending user interface), can be defined in the `envelopeDefinition`, in templates, by transforming PDF Form Fields, or by using Composite Templates (see below). Defining tabs: the `inPersonSigner`, and `signer` recipient objects include a `tabs` field. It is an [`EnvelopeTabs` resource object](#/definitions/EnvelopeTabs). It includes arrays of the 24 different tab types available. See the [`EnvelopeTabs` resource](../../EnvelopeTabs) for more information. ## Using Templates Envelopes use specific people or groups as recipients. Templates can specify a role, eg `account_manager.` When a template is used in an envelope, the roles must be replaced with specific people or groups. When you create an envelope using a `templateId`, the different recipient type objects within the [`EnvelopeRecipients` object](#/definitions/EnvelopeRecipients) are used to assign recipients to the template's roles via the `roleName` property. The recipient objects can also override settings that were specified in the template, and set values for tab fields that were defined in the template. ### Message Lock When a template is added or applied to an envelope and the template has a locked email subject and message, that subject and message are used for the envelope and cannot be changed even if another locked template is subsequently added or applied to the envelope. The field `messageLock` is used to lock the email subject and message. If an email subject or message is entered before adding or applying a template with `messageLock` **true**, the email subject and message is overwritten with the locked email subject and message from the template. ## Envelope Status The status of sent envelopes can be determined through the DocuSign webhook system or by polling. Webhooks are highly recommended: they provide your application with the quickest updates when an envelope's status changes. DocuSign limits polling to once every 15 minutes or less frequently. When a webhook is used, DocuSign calls your application, via the URL you provide, with a notification XML message. See the [Webhook recipe](https://www.docusign.com/developer-center/recipes/webhook-status) for examples and live demos of using webhooks. ## Webhook Options The two webhook options, *eventNotification* and *Connect* use the same notification mechanism and message formats. eventNotification is used to create a webhook for a specific envelope sent via the API. Connect webhooks can be used for any envelope sent from an account, from any user, from any client. ### eventNotification Webhooks The Envelopes::create method includes an optional [eventNotification object](#definition-eventNotification) that adds a webhook to the envelope. eventNotification webhooks are available for all DocuSign accounts with API access. ### Connect Webhooks Connect can be used to create a webhook for all envelopes sent by all users in an account, either through the API or via other DocuSign clients (web, mobile, etc). Connect configurations are independent of specific envelopes. A Connect configuration includes a filter that may be used to limit the webhook to specific users, envelope statuses, etc. Connect configurations may be created and managed using the [ConnectConfigurations resource](../../Connect/ConnectConfigurations). Configurations can also be created and managed from the Administration tool accessed by selecting \"Go to Admin\" from the menu next to your picture on the DocuSign web app. See the Integrations/Connect section of the Admin tool. For repeatability, and to minimize support questions, creating Connect configurations via the API is recommended, especially for ISVs. Connect is available for some DocuSign account types. Please contact DocuSign Sales for more information. ## Composite Templates The Composite Templates feature, like [compositing in film production](https://en.wikipedia.org/wiki/Compositing), enables you to *overlay* document, recipient, and tab definitions from multiple sources, including PDF Form Field definitions, templates defined on the server, and more. Each Composite Template consists of optional elements: server templates, inline templates, PDF Metadata templates, and documents. * The Composite Template ID is an optional element used to identify the composite template. It is used as a reference when adding document object information via a multi-part HTTP message. If used, the document content-disposition must include the `compositeTemplateId` to which the document should be added. If `compositeTemplateId` is not specified in the content-disposition, the document is applied based on the `documentId` only. If no document object is specified, the composite template inherits the first document. * Server Templates are server-side templates stored on the DocuSign platform. If supplied, they are overlaid into the envelope in the order of their Sequence value. * Inline Templates provide a container to add documents, recipients, tabs, and custom fields. If inline templates are supplied, they are overlaid into the envelope in the order of their Sequence value. * Document objects are optional structures that provide a container to pass in a document or form. If this object is not included, the composite template inherits the *first* document it finds from a server template or inline template, starting with the lowest sequence value. PDF Form objects are only transformed from the document object. DocuSign does not derive PDF form properties from server templates or inline templates. To instruct DocuSign to transform fields from the PDF form, set `transformPdfFields` to \"true\" for the document. See the Transform PDF Fields section for more information about process. * PDF Metadata Templates provide a container to embed design-time template information into a PDF document. DocuSign uses this information when processing the Envelope. This convention allows the document to carry the signing instructions with it, so that less information needs to be provided at run-time through an inline template or synchronized with an external structure like a server template. PDF Metadata templates are stored in the Metadata layer of a PDF in accordance with Acrobat's XMP specification. DocuSign will only find PDF Metadata templates inside documents passed in the Document object (see below). If supplied, the PDF metadata template will be overlaid into the envelope in the order of its Sequence value. ### Compositing the definitions Each Composite Template adds a new document and templates overlay into the envelope. For each Composite Template these rules are applied: * Templates are overlaid in the order of their Sequence value. * If Document is not passed into the Composite Template's `document` field, the *first* template's document (based on the template's Sequence value) is used. * Last in wins in all cases except for the document (i.e. envelope information, recipient information, secure field information). There is no special casing. For example, if you want higher security on a tab, then that needs to be specified in a later template (by sequence number) then where the tab is included. If you want higher security on a role recipient, then it needs to be in a later template then where that role recipient is specified. * Recipient matching is based on Recipient Role and Routing Order. If there are matches, the recipient information is merged together. A final pass is done on all Composite Templates, after all template overlays have been applied, to collapse recipients with the same email, username and routing order. This prevents having the same recipients at the same routing order. * If you specify in a template that a recipient is locked, once that recipient is overlaid the recipient attributes can no longer be changed. The only items that can be changed for the recipient in this case are the email, username, access code and IDCheckInformationInput. * Tab matching is based on Tab Labels, Tab Types and Documents. If a Tab Label matches but the Document is not supplied, the Tab is overlaid for all the Documents. For example, if you have a simple inline template with only one tab in it with a label and a value, the Signature, Initial, Company, Envelope ID, User Name tabs will only be matched and collapsed if they fall in the exact same X and Y locations. * roleName and tabLabel matching is case sensitive. * The defaultRecipient field enables you to specify which recipient the generated tabs from a PDF form are mapped to. You can also set PDF form generated tabs to a recipient other than the DefaultRecipient by specifying the mapping of the tab label that is created to one of the template recipients. * You can use tabLabel wild carding to map a series of tabs from the PDF form. To use this you must end a tab label with \"\\*\" and then the system matches tabs that start with the label. * If no DefaultRecipient is specified, tabs must be explicitly mapped to recipients in order to be generated from the form. Unmapped form objects will not be generated into their DocuSign equivalents. (In the case of Signature/Initials, the tabs will be disregarded entirely; in the case of pdf text fields, the field data will be flattened on the Envelope document, but there will not be a corresponding DocuSign data tab.) ### Including the Document Content for Composite Templates Document content can be supplied inline, using the `documentBase64` or can be included in a multi-part HTTP message. If a multi-part message is used and there are multiple Composite Templates, the document content-disposition can include the `compositeTemplateId` to which the document should be added. Using the `compositeTemplateId` sets which documents are associated with particular composite templates. An example of this usage is: ``` - -5cd3320a-5aac-4453-b3a4-cbb52a4cba5d Content-Type: application/pdf Content-Disposition: file; filename=\"eula.pdf\"; documentId=1; compositeTemplateId=\"1\" Content-Transfer-Encoding: base64 ``` ### PDF Form Field Transformation Only the following PDF Form FieldTypes will be transformed to DocuSign tabs: CheckBox, DateTime, ListBox, Numeric, Password, Radio, Signature, and Text Field Properties that will be transformed: Read Only, Required, Max Length, Positions, and Initial Data. When transforming a *PDF Form Digital Signature Field,* the following rules are used: If the PDF Field Name Contains | Then the DocuSign Tab Will be - -- -- -- | - -- -- -- - DocuSignSignHere or eSignSignHere | Signature DocuSignSignHereOptional or eSignSignHereOptional | Optional Signature DocuSignInitialHere or eSignInitialHere | Initials DocuSignInitialHereOptional or eSignInitialHereOptional | Optional Initials Any other PDF Form Digital Signature Field will be transformed to a DocuSign Signature tab When transforming *PDF Form Text Fields,* the following rules are used: If the PDF Field Name Contains | Then the DocuSign Tab Will be - -- -- -- | - -- -- -- - DocuSignSignHere or eSignSignHere | Signature DocuSignSignHereOptional or eSignSignHereOptional | Optional Signature DocuSignInitialHere or eSignInitialHere | Initials DocuSignInitialHereOptional or eSignInitialHereOptional | Optional Initials DocuSignEnvelopeID or eSignEnvelopeID | EnvelopeID DocuSignCompany or eSignCompany | Company DocuSignDateSigned or eSignDateSigned | Date Signed DocuSignTitle or eSignTitle | Title DocuSignFullName or eSignFullName | Full Name DocuSignSignerAttachmentOptional or eSignSignerAttachmentOptional | Optional Signer Attachment Any other PDF Form Text Field will be transformed to a DocuSign data (text) tab. PDF Form Field Names that include \"DocuSignIgnoreTransform\" or \"eSignIgnoreTransform\" will not be transformed. PDF Form Date fields will be transformed to Date Signed fields if their name includes DocuSignDateSigned or eSignDateSigned. ## Template Email Subject Merge Fields This feature enables you to insert 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 `roleName`, are added to the `emailSubject` 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. 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` 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 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 `roleName` 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. ## Branding an envelope The following rules are used to determine the `brandId` used in an envelope: * If a `brandId` is specified in the envelope/template and that brandId is available to the account, that brand is used in the envelope. * If more than one template is used in an envelope and more than one `brandId` is specified, the first `brandId` specified is used throughout the envelope. * In cases where no brand is specified and the sender belongs to a Group; if there is only one brand associated with the Group, then that brand is used in the envelope. Otherwise, the account's default signing brand is used. * For envelopes that do not meet any of the previous criteria, the account's default signing brand is used for the envelope. ## BCC Email address feature The BCC Email address feature is designed to provide a copy of all email communications for external archiving purposes. DocuSign recommends that envelopes sent using the BCC for Email Archive feature, including the BCC Email Override option, include additional signer authentication options. To send a copy of the envelope to a recipient who does not need to sign, don't use the BCC Email field. Use a Carbon Copy or Certified Delivery Recipient type. ## Merge Recipient Roles for Draft Envelopes When an envelope with multiple templates is sent, the recipients from the templates are merged according to the template roles, and empty recipients are removed. When creating an envelope with multiple templates, but not sending it (keeping it in a created state), duplicate recipients are not merged, which could cause leave duplicate recipients in the envelope. To prevent this, the query parameter `merge_roles_on_draft` should be added when posting a draft envelope (status=created) with multiple templates. Doing this will merge template roles and remove empty recipients. ###### Note: DocuSign recommends that the `merge_roles_on_draft` query parameter be used anytime you are creating an envelope with multiple templates and keeping it in draft (created) status.
///
/// Thrown when fails to make API call
/// Task of EnvelopeSummary
System.Threading.Tasks.Task CreateEnvelopeAsync(string accountId, EnvelopeDefinition envelopeDefinition = null, EnvelopesApi.CreateEnvelopeOptions options = null);
///
/// Creates an envelope.
///
///
/// Creates an envelope. Using this function you can: * Create an envelope and send it. * Create an envelope from an existing template and send it. In either case, you can choose to save the envelope as a draft envelope instead of sending it by setting the request's `status` property to `created` instead of `sent`. ## Sending Envelopes Documents can be included with the Envelopes::create call itself or a template can include documents. Documents can be added by using a multi-part/form request or by using the `documentBase64` field of the [`document` object](#/definitions/document) ### Recipient Types An [`envelopeDefinition` object](#/definitions/envelopeDefinition) is used as the method's body. Envelope recipients can be defined in the envelope or in templates. The `envelopeDefinition` object's `recipients` field is an [`EnvelopeRecipients` resource object](#/definitions/EnvelopeRecipients). It includes arrays of the seven types of recipients defined by DocuSign: Recipient type | Object definition - -- -- -- -- -- -- - | - -- -- -- -- -- -- -- -- agent (can add name and email information for later recipients/signers) | [`agent`](#/definitions/agent) carbon copy (receives a copy of the documents) | [`carbonCopy`](#/definitions/carbonCopy) certified delivery (receives a copy of the documents and must acknowledge receipt) | [`certifiedDelivery`](#/definitions/certifiedDelivery) editor (can change recipients and document fields for later recipients/signers) | [`editor`](#/definitions/editor) in-person signer (\"hosts\" someone who signs in-person) | [`inPersonSigner`](#/definitions/inPersonSigner) intermediary (can add name and email information for some later recipients/signers.) | [`intermediary`](#/definitions/intermediary) signer (signs and/or updates document fields) | [`signer`](#/definitions/signer) Additional information about the different types of recipients is available from the [`EnvelopeRecipients` resource page](../../EnvelopeRecipients) and from the [Developer Center](https://www.docusign.com/developer-center/explore/features/recipients) ### Tabs Tabs (also referred to as `tags` and as `fields` in the web sending user interface), can be defined in the `envelopeDefinition`, in templates, by transforming PDF Form Fields, or by using Composite Templates (see below). Defining tabs: the `inPersonSigner`, and `signer` recipient objects include a `tabs` field. It is an [`EnvelopeTabs` resource object](#/definitions/EnvelopeTabs). It includes arrays of the 24 different tab types available. See the [`EnvelopeTabs` resource](../../EnvelopeTabs) for more information. ## Using Templates Envelopes use specific people or groups as recipients. Templates can specify a role, eg `account_manager.` When a template is used in an envelope, the roles must be replaced with specific people or groups. When you create an envelope using a `templateId`, the different recipient type objects within the [`EnvelopeRecipients` object](#/definitions/EnvelopeRecipients) are used to assign recipients to the template's roles via the `roleName` property. The recipient objects can also override settings that were specified in the template, and set values for tab fields that were defined in the template. ### Message Lock When a template is added or applied to an envelope and the template has a locked email subject and message, that subject and message are used for the envelope and cannot be changed even if another locked template is subsequently added or applied to the envelope. The field `messageLock` is used to lock the email subject and message. If an email subject or message is entered before adding or applying a template with `messageLock` **true**, the email subject and message is overwritten with the locked email subject and message from the template. ## Envelope Status The status of sent envelopes can be determined through the DocuSign webhook system or by polling. Webhooks are highly recommended: they provide your application with the quickest updates when an envelope's status changes. DocuSign limits polling to once every 15 minutes or less frequently. When a webhook is used, DocuSign calls your application, via the URL you provide, with a notification XML message. See the [Webhook recipe](https://www.docusign.com/developer-center/recipes/webhook-status) for examples and live demos of using webhooks. ## Webhook Options The two webhook options, *eventNotification* and *Connect* use the same notification mechanism and message formats. eventNotification is used to create a webhook for a specific envelope sent via the API. Connect webhooks can be used for any envelope sent from an account, from any user, from any client. ### eventNotification Webhooks The Envelopes::create method includes an optional [eventNotification object](#definition-eventNotification) that adds a webhook to the envelope. eventNotification webhooks are available for all DocuSign accounts with API access. ### Connect Webhooks Connect can be used to create a webhook for all envelopes sent by all users in an account, either through the API or via other DocuSign clients (web, mobile, etc). Connect configurations are independent of specific envelopes. A Connect configuration includes a filter that may be used to limit the webhook to specific users, envelope statuses, etc. Connect configurations may be created and managed using the [ConnectConfigurations resource](../../Connect/ConnectConfigurations). Configurations can also be created and managed from the Administration tool accessed by selecting \"Go to Admin\" from the menu next to your picture on the DocuSign web app. See the Integrations/Connect section of the Admin tool. For repeatability, and to minimize support questions, creating Connect configurations via the API is recommended, especially for ISVs. Connect is available for some DocuSign account types. Please contact DocuSign Sales for more information. ## Composite Templates The Composite Templates feature, like [compositing in film production](https://en.wikipedia.org/wiki/Compositing), enables you to *overlay* document, recipient, and tab definitions from multiple sources, including PDF Form Field definitions, templates defined on the server, and more. Each Composite Template consists of optional elements: server templates, inline templates, PDF Metadata templates, and documents. * The Composite Template ID is an optional element used to identify the composite template. It is used as a reference when adding document object information via a multi-part HTTP message. If used, the document content-disposition must include the `compositeTemplateId` to which the document should be added. If `compositeTemplateId` is not specified in the content-disposition, the document is applied based on the `documentId` only. If no document object is specified, the composite template inherits the first document. * Server Templates are server-side templates stored on the DocuSign platform. If supplied, they are overlaid into the envelope in the order of their Sequence value. * Inline Templates provide a container to add documents, recipients, tabs, and custom fields. If inline templates are supplied, they are overlaid into the envelope in the order of their Sequence value. * Document objects are optional structures that provide a container to pass in a document or form. If this object is not included, the composite template inherits the *first* document it finds from a server template or inline template, starting with the lowest sequence value. PDF Form objects are only transformed from the document object. DocuSign does not derive PDF form properties from server templates or inline templates. To instruct DocuSign to transform fields from the PDF form, set `transformPdfFields` to \"true\" for the document. See the Transform PDF Fields section for more information about process. * PDF Metadata Templates provide a container to embed design-time template information into a PDF document. DocuSign uses this information when processing the Envelope. This convention allows the document to carry the signing instructions with it, so that less information needs to be provided at run-time through an inline template or synchronized with an external structure like a server template. PDF Metadata templates are stored in the Metadata layer of a PDF in accordance with Acrobat's XMP specification. DocuSign will only find PDF Metadata templates inside documents passed in the Document object (see below). If supplied, the PDF metadata template will be overlaid into the envelope in the order of its Sequence value. ### Compositing the definitions Each Composite Template adds a new document and templates overlay into the envelope. For each Composite Template these rules are applied: * Templates are overlaid in the order of their Sequence value. * If Document is not passed into the Composite Template's `document` field, the *first* template's document (based on the template's Sequence value) is used. * Last in wins in all cases except for the document (i.e. envelope information, recipient information, secure field information). There is no special casing. For example, if you want higher security on a tab, then that needs to be specified in a later template (by sequence number) then where the tab is included. If you want higher security on a role recipient, then it needs to be in a later template then where that role recipient is specified. * Recipient matching is based on Recipient Role and Routing Order. If there are matches, the recipient information is merged together. A final pass is done on all Composite Templates, after all template overlays have been applied, to collapse recipients with the same email, username and routing order. This prevents having the same recipients at the same routing order. * If you specify in a template that a recipient is locked, once that recipient is overlaid the recipient attributes can no longer be changed. The only items that can be changed for the recipient in this case are the email, username, access code and IDCheckInformationInput. * Tab matching is based on Tab Labels, Tab Types and Documents. If a Tab Label matches but the Document is not supplied, the Tab is overlaid for all the Documents. For example, if you have a simple inline template with only one tab in it with a label and a value, the Signature, Initial, Company, Envelope ID, User Name tabs will only be matched and collapsed if they fall in the exact same X and Y locations. * roleName and tabLabel matching is case sensitive. * The defaultRecipient field enables you to specify which recipient the generated tabs from a PDF form are mapped to. You can also set PDF form generated tabs to a recipient other than the DefaultRecipient by specifying the mapping of the tab label that is created to one of the template recipients. * You can use tabLabel wild carding to map a series of tabs from the PDF form. To use this you must end a tab label with \"\\*\" and then the system matches tabs that start with the label. * If no DefaultRecipient is specified, tabs must be explicitly mapped to recipients in order to be generated from the form. Unmapped form objects will not be generated into their DocuSign equivalents. (In the case of Signature/Initials, the tabs will be disregarded entirely; in the case of pdf text fields, the field data will be flattened on the Envelope document, but there will not be a corresponding DocuSign data tab.) ### Including the Document Content for Composite Templates Document content can be supplied inline, using the `documentBase64` or can be included in a multi-part HTTP message. If a multi-part message is used and there are multiple Composite Templates, the document content-disposition can include the `compositeTemplateId` to which the document should be added. Using the `compositeTemplateId` sets which documents are associated with particular composite templates. An example of this usage is: ``` - -5cd3320a-5aac-4453-b3a4-cbb52a4cba5d Content-Type: application/pdf Content-Disposition: file; filename=\"eula.pdf\"; documentId=1; compositeTemplateId=\"1\" Content-Transfer-Encoding: base64 ``` ### PDF Form Field Transformation Only the following PDF Form FieldTypes will be transformed to DocuSign tabs: CheckBox, DateTime, ListBox, Numeric, Password, Radio, Signature, and Text Field Properties that will be transformed: Read Only, Required, Max Length, Positions, and Initial Data. When transforming a *PDF Form Digital Signature Field,* the following rules are used: If the PDF Field Name Contains | Then the DocuSign Tab Will be - -- -- -- | - -- -- -- - DocuSignSignHere or eSignSignHere | Signature DocuSignSignHereOptional or eSignSignHereOptional | Optional Signature DocuSignInitialHere or eSignInitialHere | Initials DocuSignInitialHereOptional or eSignInitialHereOptional | Optional Initials Any other PDF Form Digital Signature Field will be transformed to a DocuSign Signature tab When transforming *PDF Form Text Fields,* the following rules are used: If the PDF Field Name Contains | Then the DocuSign Tab Will be - -- -- -- | - -- -- -- - DocuSignSignHere or eSignSignHere | Signature DocuSignSignHereOptional or eSignSignHereOptional | Optional Signature DocuSignInitialHere or eSignInitialHere | Initials DocuSignInitialHereOptional or eSignInitialHereOptional | Optional Initials DocuSignEnvelopeID or eSignEnvelopeID | EnvelopeID DocuSignCompany or eSignCompany | Company DocuSignDateSigned or eSignDateSigned | Date Signed DocuSignTitle or eSignTitle | Title DocuSignFullName or eSignFullName | Full Name DocuSignSignerAttachmentOptional or eSignSignerAttachmentOptional | Optional Signer Attachment Any other PDF Form Text Field will be transformed to a DocuSign data (text) tab. PDF Form Field Names that include \"DocuSignIgnoreTransform\" or \"eSignIgnoreTransform\" will not be transformed. PDF Form Date fields will be transformed to Date Signed fields if their name includes DocuSignDateSigned or eSignDateSigned. ## Template Email Subject Merge Fields This feature enables you to insert 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 `roleName`, are added to the `emailSubject` 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. 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` 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 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 `roleName` 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. ## Branding an envelope The following rules are used to determine the `brandId` used in an envelope: * If a `brandId` is specified in the envelope/template and that brandId is available to the account, that brand is used in the envelope. * If more than one template is used in an envelope and more than one `brandId` is specified, the first `brandId` specified is used throughout the envelope. * In cases where no brand is specified and the sender belongs to a Group; if there is only one brand associated with the Group, then that brand is used in the envelope. Otherwise, the account's default signing brand is used. * For envelopes that do not meet any of the previous criteria, the account's default signing brand is used for the envelope. ## BCC Email address feature The BCC Email address feature is designed to provide a copy of all email communications for external archiving purposes. DocuSign recommends that envelopes sent using the BCC for Email Archive feature, including the BCC Email Override option, include additional signer authentication options. To send a copy of the envelope to a recipient who does not need to sign, don't use the BCC Email field. Use a Carbon Copy or Certified Delivery Recipient type. ## Merge Recipient Roles for Draft Envelopes When an envelope with multiple templates is sent, the recipients from the templates are merged according to the template roles, and empty recipients are removed. When creating an envelope with multiple templates, but not sending it (keeping it in a created state), duplicate recipients are not merged, which could cause leave duplicate recipients in the envelope. To prevent this, the query parameter `merge_roles_on_draft` should be added when posting a draft envelope (status=created) with multiple templates. Doing this will merge template roles and remove empty recipients. ###### Note: DocuSign recommends that the `merge_roles_on_draft` query parameter be used anytime you are creating an envelope with multiple templates and keeping it in draft (created) status.
///
/// Thrown when fails to make API call
/// Task of ApiResponse (EnvelopeSummary)
System.Threading.Tasks.Task> CreateEnvelopeAsyncWithHttpInfo(string accountId, EnvelopeDefinition envelopeDefinition = null, EnvelopesApi.CreateEnvelopeOptions options = null);
///
/// Posts a list of comments for authorized user
///
///
///
///
/// Thrown when fails to make API call
/// Task of CommentHistoryResult
System.Threading.Tasks.Task CreateEnvelopeCommentsAsync(string accountId, string envelopeId, CommentsPublish commentsPublish = null);
///
/// Posts a list of comments for authorized user
///
///
///
///
/// Thrown when fails to make API call
/// Task of ApiResponse (CommentHistoryResult)
System.Threading.Tasks.Task> CreateEnvelopeCommentsAsyncWithHttpInfo(string accountId, string envelopeId, CommentsPublish commentsPublish = null);
///
/// Provides a URL to start a recipient view of the Envelope UI
///
///
/// This method returns a URL for an envelope 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](https://support.docusign.com/en/guides/ndse-user-guide-send-your-documents).
///
/// Thrown when fails to make API call
/// Task of ViewUrl
System.Threading.Tasks.Task CreateEnvelopeRecipientPreviewAsync(string accountId, string envelopeId, RecipientPreviewRequest recipientPreviewRequest = null);
///
/// Provides a URL to start a recipient view of the Envelope UI
///
///
/// This method returns a URL for an envelope 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](https://support.docusign.com/en/guides/ndse-user-guide-send-your-documents).
///
/// Thrown when fails to make API call
/// Task of ApiResponse (ViewUrl)
System.Threading.Tasks.Task> CreateEnvelopeRecipientPreviewAsyncWithHttpInfo(string accountId, string envelopeId, RecipientPreviewRequest recipientPreviewRequest = null);
///
/// Provides a URL to start a shared recipient view of the Envelope UI
///
///
/// Returns a URL that enables you to embed the DocuSign UI recipient view of a [shared envelope](https://support.docusign.com/en/guides/ndse-admin-guide-share-envelopes) in your applications. This is the view that a user sees of an envelope that a recipient on the same account has shared with them. Due to screen space issues, do not use an `<iframe>` for embedded operations on mobile devices. For iOS devices, DocuSign recommends using a WebView. ### Revoking the URL You can revoke this URL by making a DELETE HTTP request to the URL with no request body. ### Related topics - [Embedded signing and sending](/docs/esign-rest-api/esign101/concepts/embedding/) - [How to send an envelope via your app](/docs/esign-rest-api/how-to/embedded-sending/) - [How to embed the DocuSign UI in your app](/docs/esign-rest-api/how-to/embed-ui/)
///
/// Thrown when fails to make API call
/// Task of ViewUrl
System.Threading.Tasks.Task CreateEnvelopeRecipientSharedViewAsync(string accountId, string envelopeId, RecipientViewRequest recipientViewRequest = null);
///
/// Provides a URL to start a shared recipient view of the Envelope UI
///
///
/// Returns a URL that enables you to embed the DocuSign UI recipient view of a [shared envelope](https://support.docusign.com/en/guides/ndse-admin-guide-share-envelopes) in your applications. This is the view that a user sees of an envelope that a recipient on the same account has shared with them. Due to screen space issues, do not use an `<iframe>` for embedded operations on mobile devices. For iOS devices, DocuSign recommends using a WebView. ### Revoking the URL You can revoke this URL by making a DELETE HTTP request to the URL with no request body. ### Related topics - [Embedded signing and sending](/docs/esign-rest-api/esign101/concepts/embedding/) - [How to send an envelope via your app](/docs/esign-rest-api/how-to/embedded-sending/) - [How to embed the DocuSign UI in your app](/docs/esign-rest-api/how-to/embed-ui/)
///
/// Thrown when fails to make API call
/// Task of ApiResponse (ViewUrl)
System.Threading.Tasks.Task> CreateEnvelopeRecipientSharedViewAsyncWithHttpInfo(string accountId, string envelopeId, RecipientViewRequest recipientViewRequest = null);
///
/// Add envelope transfer rules to an account.
///
///
/// This method creates an envelope transfer rule. When you create an envelope transfer rule, you specify the following properties: - `eventType` - `fromGroups` - `toUser` - `toFolder` - `carbonCopyOriginalOwner` - `enabled` **Note:** Only Administrators can create envelope transfer rules. In addition, to use envelope transfer rules, the **Transfer Custody** feature must be enabled for your account.
///
/// Thrown when fails to make API call
/// Task of EnvelopeTransferRuleInformation
System.Threading.Tasks.Task CreateEnvelopeTransferRulesAsync(string accountId, EnvelopeTransferRuleRequest envelopeTransferRuleRequest = null);
///
/// Add envelope transfer rules to an account.
///
///
/// This method creates an envelope transfer rule. When you create an envelope transfer rule, you specify the following properties: - `eventType` - `fromGroups` - `toUser` - `toFolder` - `carbonCopyOriginalOwner` - `enabled` **Note:** Only Administrators can create envelope transfer rules. In addition, to use envelope transfer rules, the **Transfer Custody** feature must be enabled for your account.
///
/// Thrown when fails to make API call
/// Task of ApiResponse (EnvelopeTransferRuleInformation)
System.Threading.Tasks.Task> CreateEnvelopeTransferRulesAsyncWithHttpInfo(string accountId, EnvelopeTransferRuleRequest envelopeTransferRuleRequest = null);
///
/// Creates and adds a new workflow step definition for an envelope's workflow
///
///
///
///
/// Thrown when fails to make API call
/// Task of WorkflowStep
System.Threading.Tasks.Task CreateEnvelopeWorkflowStepDefinitionAsync(string accountId, string envelopeId, WorkflowStep workflowStep = null);
///
/// Creates and adds a new workflow step definition for an envelope's workflow
///
///
///
///
/// Thrown when fails to make API call
/// Task of ApiResponse (WorkflowStep)
System.Threading.Tasks.Task> CreateEnvelopeWorkflowStepDefinitionAsyncWithHttpInfo(string accountId, string envelopeId, WorkflowStep workflowStep = null);
///
/// Submits a batch of historical envelopes for republish to an adhoc config.
///
///
///
///
/// Thrown when fails to make API call
/// Task of EnvelopePublishTransaction
System.Threading.Tasks.Task CreateHistoricalEnvelopePublishTransactionAsync(string accountId, ConnectHistoricalEnvelopeRepublish connectHistoricalEnvelopeRepublish = null);
///
/// Submits a batch of historical envelopes for republish to an adhoc config.
///
///
///
///
/// Thrown when fails to make API call
/// Task of ApiResponse (EnvelopePublishTransaction)
System.Threading.Tasks.Task> CreateHistoricalEnvelopePublishTransactionAsyncWithHttpInfo(string accountId, ConnectHistoricalEnvelopeRepublish connectHistoricalEnvelopeRepublish = null);
///
/// Lock an envelope.
///
///
/// Locks the specified envelope, and sets the time until the lock expires, to prevent other users or recipients from accessing and changing the envelope. ###### Note: Users must have envelope locking capability enabled to use this function (userSetting `canLockEnvelopes` must be set to true for the user).
///
/// Thrown when fails to make API call
/// Task of LockInformation
System.Threading.Tasks.Task CreateLockAsync(string accountId, string envelopeId, LockRequest lockRequest = null);
///
/// Lock an envelope.
///
///
/// Locks the specified envelope, and sets the time until the lock expires, to prevent other users or recipients from accessing and changing the envelope. ###### Note: Users must have envelope locking capability enabled to use this function (userSetting `canLockEnvelopes` must be set to true for the user).
///
/// Thrown when fails to make API call
/// Task of ApiResponse (LockInformation)
System.Threading.Tasks.Task> CreateLockAsyncWithHttpInfo(string accountId, string envelopeId, LockRequest lockRequest = null);
///
/// Adds one or more recipients to an envelope.
///
///
/// Adds one or more recipients to an envelope. For an in process envelope, one that has been sent and has not been completed or voided, an email is sent to a new recipient when they are reached in the routing order. If the new recipient's routing order is before or the same as the envelope's next recipient, an email is only sent if the optional `resend_envelope` query string is set to **true**.
///
/// Thrown when fails to make API call
/// Task of Recipients
System.Threading.Tasks.Task CreateRecipientAsync(string accountId, string envelopeId, Recipients recipients = null, EnvelopesApi.CreateRecipientOptions options = null);
///
/// Adds one or more recipients to an envelope.
///
///
/// Adds one or more recipients to an envelope. For an in process envelope, one that has been sent and has not been completed or voided, an email is sent to a new recipient when they are reached in the routing order. If the new recipient's routing order is before or the same as the envelope's next recipient, an email is only sent if the optional `resend_envelope` query string is set to **true**.
///
/// Thrown when fails to make API call
/// Task of ApiResponse (Recipients)
System.Threading.Tasks.Task> CreateRecipientAsyncWithHttpInfo(string accountId, string envelopeId, Recipients recipients = null, EnvelopesApi.CreateRecipientOptions options = null);
///
/// Provides a link to access the Identity manual review related to a recipient.
///
///
/// This method returns the URL of the page that allows a sender to [manually review](https://support.docusign.com/en/guides/ndse-user-guide-send-documents-with-id-verification) the ID of a recipient.
///
/// Thrown when fails to make API call
/// Task of ViewUrl
System.Threading.Tasks.Task CreateRecipientManualReviewViewAsync(string accountId, string envelopeId, string recipientId);
///
/// Provides a link to access the Identity manual review related to a recipient.
///
///
/// This method returns the URL of the page that allows a sender to [manually review](https://support.docusign.com/en/guides/ndse-user-guide-send-documents-with-id-verification) the ID of a recipient.
///
/// Thrown when fails to make API call
/// Task of ApiResponse (ViewUrl)
System.Threading.Tasks.Task> CreateRecipientManualReviewViewAsyncWithHttpInfo(string accountId, string envelopeId, string recipientId);
///
/// Returns a link to access to the identity events stored in the proof service related to this recipient.
///
///
///
///
/// Thrown when fails to make API call
/// Task of IdEvidenceViewLink
System.Threading.Tasks.Task CreateRecipientProofFileLinkAsync(string accountId, string envelopeId, string recipientId);
///
/// Returns a link to access to the identity events stored in the proof service related to this recipient.
///
///
///
///
/// Thrown when fails to make API call
/// Task of ApiResponse (IdEvidenceViewLink)
System.Threading.Tasks.Task> CreateRecipientProofFileLinkAsyncWithHttpInfo(string accountId, string envelopeId, string recipientId);
///
/// Returns a resource token to get access to the identity events stored in the proof service related to this recipient.
///
///
/// Creates a resource token for a sender. This token allows a sender to return identification data for a recipient using the [ID Evidence API](/docs/idevidence-api/).
///
/// Thrown when fails to make API call
/// Task of IdEvidenceResourceToken
System.Threading.Tasks.Task CreateRecipientProofFileResourceTokenAsync(string accountId, string envelopeId, string recipientId, EnvelopesApi.CreateRecipientProofFileResourceTokenOptions options = null);
///
/// Returns a resource token to get access to the identity events stored in the proof service related to this recipient.
///
///
/// Creates a resource token for a sender. This token allows a sender to return identification data for a recipient using the [ID Evidence API](/docs/idevidence-api/).
///
/// Thrown when fails to make API call
/// Task of ApiResponse (IdEvidenceResourceToken)
System.Threading.Tasks.Task> CreateRecipientProofFileResourceTokenAsyncWithHttpInfo(string accountId, string envelopeId, string recipientId, EnvelopesApi.CreateRecipientProofFileResourceTokenOptions options = null);
///
/// Returns a URL to the recipient view UI.
///
///
/// Returns a URL that allows you to embed the recipient view of the DocuSign UI in your applications. This call cannot be used to view draft envelopes, since those envelopes have not been sent. Important: iFrames should not be used for embedded operations on mobile devices due to screen space issues. For iOS devices DocuSign recommends using a WebView. An entry is added into the Security Level section of the DocuSign Certificate of Completion that reflects the `securityDomain` and `authenticationMethod` properties used to verify the user identity.
///
/// Thrown when fails to make API call
/// Task of ViewUrl
System.Threading.Tasks.Task CreateRecipientViewAsync(string accountId, string envelopeId, RecipientViewRequest recipientViewRequest = null);
///
/// Returns a URL to the recipient view UI.
///
///
/// Returns a URL that allows you to embed the recipient view of the DocuSign UI in your applications. This call cannot be used to view draft envelopes, since those envelopes have not been sent. Important: iFrames should not be used for embedded operations on mobile devices due to screen space issues. For iOS devices DocuSign recommends using a WebView. An entry is added into the Security Level section of the DocuSign Certificate of Completion that reflects the `securityDomain` and `authenticationMethod` properties used to verify the user identity.
///
/// Thrown when fails to make API call
/// Task of ApiResponse (ViewUrl)
System.Threading.Tasks.Task> CreateRecipientViewAsyncWithHttpInfo(string accountId, string envelopeId, RecipientViewRequest recipientViewRequest = null);
///
/// Get Responsive HTML Preview for all documents in an envelope.
///
///
/// Creates a preview of the [responsive](/docs/esign-rest-api/esign101/concepts/responsive/), HTML versions of all of the documents in an envelope. 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.
///
/// Thrown when fails to make API call
/// Task of DocumentHtmlDefinitions
System.Threading.Tasks.Task CreateResponsiveHtmlPreviewAsync(string accountId, string envelopeId, DocumentHtmlDefinition documentHtmlDefinition = null);
///
/// Get Responsive HTML Preview for all documents in an envelope.
///
///
/// Creates a preview of the [responsive](/docs/esign-rest-api/esign101/concepts/responsive/), HTML versions of all of the documents in an envelope. 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.
///
/// Thrown when fails to make API call
/// Task of ApiResponse (DocumentHtmlDefinitions)
System.Threading.Tasks.Task> CreateResponsiveHtmlPreviewAsyncWithHttpInfo(string accountId, string envelopeId, DocumentHtmlDefinition documentHtmlDefinition = null);
///
/// Returns a URL to the sender view UI.
///
///
/// Returns a URL that allows you to embed the sender view of the DocuSign UI in your applications. This is a one-time use login token that allows the user to be placed into the DocuSign sending view. Upon sending completion, the user is returned to the return URL provided by the API application. Important: iFrames should not be used for embedded operations on mobile devices due to screen space issues. For iOS devices DocuSign recommends using a WebView.
///
/// Thrown when fails to make API call
/// Task of ViewUrl
System.Threading.Tasks.Task CreateSenderViewAsync(string accountId, string envelopeId, EnvelopeViewRequest envelopeViewRequest = null);
///
/// Returns a URL to the sender view UI.
///
///
/// Returns a URL that allows you to embed the sender view of the DocuSign UI in your applications. This is a one-time use login token that allows the user to be placed into the DocuSign sending view. Upon sending completion, the user is returned to the return URL provided by the API application. Important: iFrames should not be used for embedded operations on mobile devices due to screen space issues. For iOS devices DocuSign recommends using a WebView.
///
/// Thrown when fails to make API call
/// Task of ApiResponse (ViewUrl)
System.Threading.Tasks.Task> CreateSenderViewAsyncWithHttpInfo(string accountId, string envelopeId, EnvelopeViewRequest envelopeViewRequest = null);
///
/// Adds tabs for a recipient.
///
///
/// Adds one or more tabs for a recipient.
///
/// Thrown when fails to make API call
/// Task of Tabs
System.Threading.Tasks.Task CreateTabsAsync(string accountId, string envelopeId, string recipientId, Tabs tabs = null);
///
/// Adds tabs for a recipient.
///
///
/// Adds one or more tabs for a recipient.
///
/// Thrown when fails to make API call
/// Task of ApiResponse (Tabs)
System.Threading.Tasks.Task> CreateTabsAsyncWithHttpInfo(string accountId, string envelopeId, string recipientId, Tabs tabs = null);
///
/// Creates and adds a new workflow step definition for a template's workflow
///
///
///
///
/// Thrown when fails to make API call
/// Task of WorkflowStep
System.Threading.Tasks.Task CreateTemplateWorkflowStepDefinitionAsync(string accountId, string templateId, WorkflowStep workflowStep = null);
///
/// Creates and adds a new workflow step definition for a template's workflow
///
///
///
///
/// Thrown when fails to make API call
/// Task of ApiResponse (WorkflowStep)
System.Threading.Tasks.Task> CreateTemplateWorkflowStepDefinitionAsyncWithHttpInfo(string accountId, string templateId, WorkflowStep workflowStep = null);
///
/// Delete one or more attachments from a DRAFT envelope.
///
///
/// Deletes one or more attachments from a draft envelope.
///
/// Thrown when fails to make API call
/// Task of EnvelopeAttachmentsResult
System.Threading.Tasks.Task DeleteAttachmentsAsync(string accountId, string envelopeId, EnvelopeAttachmentsRequest envelopeAttachmentsRequest = null);
///
/// Delete one or more attachments from a DRAFT envelope.
///
///
/// Deletes one or more attachments from a draft envelope.
///
/// Thrown when fails to make API call
/// Task of ApiResponse (EnvelopeAttachmentsResult)
System.Threading.Tasks.Task> DeleteAttachmentsAsyncWithHttpInfo(string accountId, string envelopeId, EnvelopeAttachmentsRequest envelopeAttachmentsRequest = null);
///
/// Delete an existing ChunkedUpload.
///
///
/// Deletes a chunked upload that has been committed but not yet consumed. This method cannot be used to delete the following types of chunked uploads, which the system deletes automatically: - Chunked uploads that have been consumed by use in another API call. - Expired chunked uploads. **Note:** If you are aware of a chunked upload that can be discarded, the best practice is to explicitly delete it. If you wait for the system to automatically delete it after it expires, the chunked upload will continue to count against your quota.
///
/// Thrown when fails to make API call
/// Task of ChunkedUploadResponse
System.Threading.Tasks.Task DeleteChunkedUploadAsync(string accountId, string chunkedUploadId);
///
/// Delete an existing ChunkedUpload.
///
///
/// Deletes a chunked upload that has been committed but not yet consumed. This method cannot be used to delete the following types of chunked uploads, which the system deletes automatically: - Chunked uploads that have been consumed by use in another API call. - Expired chunked uploads. **Note:** If you are aware of a chunked upload that can be discarded, the best practice is to explicitly delete it. If you wait for the system to automatically delete it after it expires, the chunked upload will continue to count against your quota.
///
/// Thrown when fails to make API call
/// Task of ApiResponse (ChunkedUploadResponse)
System.Threading.Tasks.Task> DeleteChunkedUploadAsyncWithHttpInfo(string accountId, string chunkedUploadId);
///
/// Deletes envelope custom fields for draft and in-process envelopes.
///
///
/// Deletes envelope custom fields for draft and in-process envelopes.
///
/// Thrown when fails to make API call
/// Task of CustomFields
System.Threading.Tasks.Task DeleteCustomFieldsAsync(string accountId, string envelopeId, CustomFields customFields = null);
///
/// Deletes envelope custom fields for draft and in-process envelopes.
///
///
/// Deletes envelope custom fields for draft and in-process envelopes.
///
/// Thrown when fails to make API call
/// Task of ApiResponse (CustomFields)
System.Threading.Tasks.Task> DeleteCustomFieldsAsyncWithHttpInfo(string accountId, string envelopeId, CustomFields customFields = null);
///
/// Deletes custom document fields from an existing envelope document.
///
///
/// Deletes custom document fields from an existing envelope document.
///
/// Thrown when fails to make API call
/// Task of DocumentFieldsInformation
System.Threading.Tasks.Task DeleteDocumentFieldsAsync(string accountId, string envelopeId, string documentId, DocumentFieldsInformation documentFieldsInformation = null);
///
/// Deletes custom document fields from an existing envelope document.
///
///
/// Deletes custom document fields from an existing envelope document.
///
/// Thrown when fails to make API call
/// Task of ApiResponse (DocumentFieldsInformation)
System.Threading.Tasks.Task> DeleteDocumentFieldsAsyncWithHttpInfo(string accountId, string envelopeId, string documentId, DocumentFieldsInformation documentFieldsInformation = null);
///
/// Deletes a page from a document in an envelope.
///
///
/// Deletes a page from a document in an envelope based on the page number.
///
/// Thrown when fails to make API call
/// Task of void
System.Threading.Tasks.Task DeleteDocumentPageAsync(string accountId, string envelopeId, string documentId, string pageNumber);
///
/// Deletes a page from a document in an envelope.
///
///
/// Deletes a page from a document in an envelope based on the page number.
///
/// Thrown when fails to make API call
/// Task of ApiResponse
System.Threading.Tasks.Task> DeleteDocumentPageAsyncWithHttpInfo(string accountId, string envelopeId, string documentId, string pageNumber);
///
/// Deletes tabs from an envelope document
///
///
/// Deletes tabs from the document specified by `documentId` in the envelope specified by `envelopeId`.
///
/// Thrown when fails to make API call
/// Task of Tabs
System.Threading.Tasks.Task DeleteDocumentTabsAsync(string accountId, string envelopeId, string documentId, Tabs tabs = null);
///
/// Deletes tabs from an envelope document
///
///
/// Deletes tabs from the document specified by `documentId` in the envelope specified by `envelopeId`.
///
/// Thrown when fails to make API call
/// Task of ApiResponse (Tabs)
System.Threading.Tasks.Task> DeleteDocumentTabsAsyncWithHttpInfo(string accountId, string envelopeId, string documentId, Tabs tabs = null);
///
/// Deletes documents from a draft envelope.
///
///
/// Deletes one or more documents from an existing draft envelope.
///
/// Thrown when fails to make API call
/// Task of EnvelopeDocumentsResult
System.Threading.Tasks.Task DeleteDocumentsAsync(string accountId, string envelopeId, EnvelopeDefinition envelopeDefinition = null);
///
/// Deletes documents from a draft envelope.
///
///
/// Deletes one or more documents from an existing draft envelope.
///
/// Thrown when fails to make API call
/// Task of ApiResponse (EnvelopeDocumentsResult)
System.Threading.Tasks.Task> DeleteDocumentsAsyncWithHttpInfo(string accountId, string envelopeId, EnvelopeDefinition envelopeDefinition = null);
///
/// Deletes the email setting overrides for an envelope.
///
///
/// Deletes all existing email override settings for the envelope. If you want to delete an individual email override setting, use the PUT and set the value to an empty string. Note that deleting email settings will only affect email communications that occur after the deletion and the normal account email settings are used for future email communications.
///
/// Thrown when fails to make API call
/// Task of EmailSettings
System.Threading.Tasks.Task DeleteEmailSettingsAsync(string accountId, string envelopeId);
///
/// Deletes the email setting overrides for an envelope.
///
///
/// Deletes all existing email override settings for the envelope. If you want to delete an individual email override setting, use the PUT and set the value to an empty string. Note that deleting email settings will only affect email communications that occur after the deletion and the normal account email settings are used for future email communications.
///
/// Thrown when fails to make API call
/// Task of ApiResponse (EmailSettings)
System.Threading.Tasks.Task> DeleteEmailSettingsAsyncWithHttpInfo(string accountId, string envelopeId);
///
/// Revokes the correction view URL to the Envelope UI
///
///
/// Revokes the correction view URL to the Envelope UI.
///
/// Thrown when fails to make API call
/// Task of void
System.Threading.Tasks.Task DeleteEnvelopeCorrectViewAsync(string accountId, string envelopeId, CorrectViewRequest correctViewRequest = null);
///
/// Revokes the correction view URL to the Envelope UI
///
///
/// Revokes the correction view URL to the Envelope UI.
///
/// Thrown when fails to make API call
/// Task of ApiResponse
System.Threading.Tasks.Task> DeleteEnvelopeCorrectViewAsyncWithHttpInfo(string accountId, string envelopeId, CorrectViewRequest correctViewRequest = null);
///
/// Deletes the delayed routing rules for the specified envelope workflow step.
///
///
///
///
/// Thrown when fails to make API call
/// Task of void
System.Threading.Tasks.Task DeleteEnvelopeDelayedRoutingDefinitionAsync(string accountId, string envelopeId, string workflowStepId);
///
/// Deletes the delayed routing rules for the specified envelope workflow step.
///
///
///
///
/// Thrown when fails to make API call
/// Task of ApiResponse
System.Threading.Tasks.Task> DeleteEnvelopeDelayedRoutingDefinitionAsyncWithHttpInfo(string accountId, string envelopeId, string workflowStepId);
///
/// Deletes the scheduled sending rules for the envelope's workflow.
///
///
///
///
/// Thrown when fails to make API call
/// Task of void
System.Threading.Tasks.Task DeleteEnvelopeScheduledSendingDefinitionAsync(string accountId, string envelopeId);
///
/// Deletes the scheduled sending rules for the envelope's workflow.
///
///
///
///
/// Thrown when fails to make API call
/// Task of ApiResponse
System.Threading.Tasks.Task> DeleteEnvelopeScheduledSendingDefinitionAsyncWithHttpInfo(string accountId, string envelopeId);
///
/// Delete envelope transfer rules for an account.
///
///
/// This method deletes an envelope transfer rule. **Note:** Only Administrators can delete envelope transfer rules. In addition, to use envelope transfer rules, the **Transfer Custody** feature must be enabled for your account.
///
/// Thrown when fails to make API call
/// Task of void
System.Threading.Tasks.Task DeleteEnvelopeTransferRulesAsync(string accountId, string envelopeTransferRuleId);
///
/// Delete envelope transfer rules for an account.
///
///
/// This method deletes an envelope transfer rule. **Note:** Only Administrators can delete envelope transfer rules. In addition, to use envelope transfer rules, the **Transfer Custody** feature must be enabled for your account.
///
/// Thrown when fails to make API call
/// Task of ApiResponse
System.Threading.Tasks.Task> DeleteEnvelopeTransferRulesAsyncWithHttpInfo(string accountId, string envelopeTransferRuleId);
///
/// Delete the workflow definition for an envelope.
///
///
/// Deletes the specified envelope's workflow definition if it has one.
///
/// Thrown when fails to make API call
/// Task of void
System.Threading.Tasks.Task DeleteEnvelopeWorkflowDefinitionAsync(string accountId, string envelopeId);
///
/// Delete the workflow definition for an envelope.
///
///
/// Deletes the specified envelope's workflow definition if it has one.
///
/// Thrown when fails to make API call
/// Task of ApiResponse
System.Threading.Tasks.Task> DeleteEnvelopeWorkflowDefinitionAsyncWithHttpInfo(string accountId, string envelopeId);
///
/// Deletes the envelope workflow step definition for an envelope's workflow by step id.
///
///
///
///
/// Thrown when fails to make API call
/// Task of void
System.Threading.Tasks.Task DeleteEnvelopeWorkflowStepDefinitionAsync(string accountId, string envelopeId, string workflowStepId);
///
/// Deletes the envelope workflow step definition for an envelope's workflow by step id.
///
///
///
///
/// Thrown when fails to make API call
/// Task of ApiResponse
System.Threading.Tasks.Task> DeleteEnvelopeWorkflowStepDefinitionAsyncWithHttpInfo(string accountId, string envelopeId, string workflowStepId);
///
/// Deletes an envelope lock.
///
///
/// Deletes the lock from the specified envelope. The `X-DocuSign-Edit` header must be included in the request.
///
/// Thrown when fails to make API call
/// Task of LockInformation
System.Threading.Tasks.Task DeleteLockAsync(string accountId, string envelopeId);
///
/// Deletes an envelope lock.
///
///
/// Deletes the lock from the specified envelope. The `X-DocuSign-Edit` header must be included in the request.
///
/// Thrown when fails to make API call
/// Task of ApiResponse (LockInformation)
System.Threading.Tasks.Task> DeleteLockAsyncWithHttpInfo(string accountId, string envelopeId);
///
/// Deletes a recipient from an envelope.
///
///
/// Deletes the specified recipient file from the specified envelope. This cannot be used if the envelope has been sent.
///
/// Thrown when fails to make API call
/// Task of Recipients
System.Threading.Tasks.Task DeleteRecipientAsync(string accountId, string envelopeId, string recipientId);
///
/// Deletes a recipient from an envelope.
///
///
/// Deletes the specified recipient file from the specified envelope. This cannot be used if the envelope has been sent.
///
/// Thrown when fails to make API call
/// Task of ApiResponse (Recipients)
System.Threading.Tasks.Task> DeleteRecipientAsyncWithHttpInfo(string accountId, string envelopeId, string recipientId);
///
/// Deletes recipients from an envelope.
///
///
/// Deletes one or more recipients from a draft or sent envelope. Recipients to be deleted are listed in the request, with the `recipientId` being used as the key for deleting recipients. If the envelope is `In Process`, meaning that it has been sent and has not been completed or voided, recipients that have completed their actions cannot be deleted.
///
/// Thrown when fails to make API call
/// Task of Recipients
System.Threading.Tasks.Task DeleteRecipientsAsync(string accountId, string envelopeId, Recipients recipients = null);
///
/// Deletes recipients from an envelope.
///
///
/// Deletes one or more recipients from a draft or sent envelope. Recipients to be deleted are listed in the request, with the `recipientId` being used as the key for deleting recipients. If the envelope is `In Process`, meaning that it has been sent and has not been completed or voided, recipients that have completed their actions cannot be deleted.
///
/// Thrown when fails to make API call
/// Task of ApiResponse (Recipients)
System.Threading.Tasks.Task> DeleteRecipientsAsyncWithHttpInfo(string accountId, string envelopeId, Recipients recipients = null);
///
/// Deletes the tabs associated with a recipient.
///
///
/// Deletes one or more tabs associated with a recipient in a draft envelope.
///
/// Thrown when fails to make API call
/// Task of Tabs
System.Threading.Tasks.Task DeleteTabsAsync(string accountId, string envelopeId, string recipientId, Tabs tabs = null);
///
/// Deletes the tabs associated with a recipient.
///
///
/// Deletes one or more tabs associated with a recipient in a draft envelope.
///
/// Thrown when fails to make API call
/// Task of ApiResponse (Tabs)
System.Threading.Tasks.Task> DeleteTabsAsyncWithHttpInfo(string accountId, string envelopeId, string recipientId, Tabs tabs = null);
///
/// Deletes the delayed routing rules for the specified template workflow step.
///
///
///
///
/// Thrown when fails to make API call
/// Task of void
System.Threading.Tasks.Task DeleteTemplateDelayedRoutingDefinitionAsync(string accountId, string templateId, string workflowStepId);
///
/// Deletes the delayed routing rules for the specified template workflow step.
///
///
///
///
/// Thrown when fails to make API call
/// Task of ApiResponse
System.Threading.Tasks.Task> DeleteTemplateDelayedRoutingDefinitionAsyncWithHttpInfo(string accountId, string templateId, string workflowStepId);
///
/// Deletes the scheduled sending rules for the template's workflow.
///
///
///
///
/// Thrown when fails to make API call
/// Task of void
System.Threading.Tasks.Task DeleteTemplateScheduledSendingDefinitionAsync(string accountId, string templateId);
///
/// Deletes the scheduled sending rules for the template's workflow.
///
///
///
///
/// Thrown when fails to make API call
/// Task of ApiResponse
System.Threading.Tasks.Task> DeleteTemplateScheduledSendingDefinitionAsyncWithHttpInfo(string accountId, string templateId);
///
/// Delete the workflow definition for a template.
///
///
/// Deletes the specified template's workflow definition if it has one.
///
/// Thrown when fails to make API call
/// Task of void
System.Threading.Tasks.Task DeleteTemplateWorkflowDefinitionAsync(string accountId, string templateId);
///
/// Delete the workflow definition for a template.
///
///
/// Deletes the specified template's workflow definition if it has one.
///
/// Thrown when fails to make API call
/// Task of ApiResponse
System.Threading.Tasks.Task> DeleteTemplateWorkflowDefinitionAsyncWithHttpInfo(string accountId, string templateId);
///
/// Deletes the workflow step definition for an template's workflow by step id.
///
///
///
///
/// Thrown when fails to make API call
/// Task of void
System.Threading.Tasks.Task DeleteTemplateWorkflowStepDefinitionAsync(string accountId, string templateId, string workflowStepId);
///
/// Deletes the workflow step definition for an template's workflow by step id.
///
///
///
///
/// Thrown when fails to make API call
/// Task of ApiResponse
System.Threading.Tasks.Task> DeleteTemplateWorkflowStepDefinitionAsyncWithHttpInfo(string accountId, string templateId, string workflowStepId);
///
/// Deletes a template from a document in an existing envelope.
///
///
/// Deletes the specified template from a document in an existing envelope.
///
/// Thrown when fails to make API call
/// Task of void
System.Threading.Tasks.Task DeleteTemplatesFromDocumentAsync(string accountId, string envelopeId, string documentId, string templateId);
///
/// Deletes a template from a document in an existing envelope.
///
///
/// Deletes the specified template from a document in an existing envelope.
///
/// Thrown when fails to make API call
/// Task of ApiResponse
System.Threading.Tasks.Task> DeleteTemplatesFromDocumentAsyncWithHttpInfo(string accountId, string envelopeId, string documentId, string templateId);
///
/// Retrieves an attachment from the envelope.
///
///
/// Retrieves an attachment from an envelope.
///
/// Thrown when fails to make API call
/// Task of System.IO.Stream
System.Threading.Tasks.Task GetAttachmentAsync(string accountId, string envelopeId, string attachmentId);
///
/// Retrieves an attachment from the envelope.
///
///
/// Retrieves an attachment from an envelope.
///
/// Thrown when fails to make API call
/// Task of ApiResponse (System.IO.Stream)
System.Threading.Tasks.Task> GetAttachmentAsyncWithHttpInfo(string accountId, string envelopeId, string attachmentId);
///
/// Returns a list of attachments associated with the specified envelope
///
///
/// Returns a list of attachments associated with a specified envelope
///
/// Thrown when fails to make API call
/// Task of EnvelopeAttachmentsResult
System.Threading.Tasks.Task GetAttachmentsAsync(string accountId, string envelopeId);
///
/// Returns a list of attachments associated with the specified envelope
///
///
/// Returns a list of attachments associated with a specified envelope
///
/// Thrown when fails to make API call
/// Task of ApiResponse (EnvelopeAttachmentsResult)
System.Threading.Tasks.Task> GetAttachmentsAsyncWithHttpInfo(string accountId, string envelopeId);
///
/// Retrieves the current metadata of a ChunkedUpload.
///
///
/// Returns the details (but not the content) about a chunked upload. **Note:** You cannot obtain details about a chunked upload that has expired, been deleted, or consumed by other actions.
///
/// Thrown when fails to make API call
/// Task of ChunkedUploadResponse
System.Threading.Tasks.Task GetChunkedUploadAsync(string accountId, string chunkedUploadId, EnvelopesApi.GetChunkedUploadOptions options = null);
///
/// Retrieves the current metadata of a ChunkedUpload.
///
///
/// Returns the details (but not the content) about a chunked upload. **Note:** You cannot obtain details about a chunked upload that has expired, been deleted, or consumed by other actions.
///
/// Thrown when fails to make API call
/// Task of ApiResponse (ChunkedUploadResponse)
System.Threading.Tasks.Task> GetChunkedUploadAsyncWithHttpInfo(string accountId, string chunkedUploadId, EnvelopesApi.GetChunkedUploadOptions options = null);
///
/// Gets comment transcript for envelope and user
///
///
/// Retrieves a PDF file containing all of the comments that senders and recipients have added to the documents in an envelope. The response body of this method is the PDF file as a byte stream. **Note:** Comments are disabled by default. To use the comments feature, an account administrator must enable comments on the account (in the `accountSettingsInformation` object, set the `enableSigningExtensionComments` property to **true**).
///
/// Thrown when fails to make API call
/// Task of System.IO.Stream
System.Threading.Tasks.Task GetCommentsTranscriptAsync(string accountId, string envelopeId, EnvelopesApi.GetCommentsTranscriptOptions options = null);
///
/// Gets comment transcript for envelope and user
///
///
/// Retrieves a PDF file containing all of the comments that senders and recipients have added to the documents in an envelope. The response body of this method is the PDF file as a byte stream. **Note:** Comments are disabled by default. To use the comments feature, an account administrator must enable comments on the account (in the `accountSettingsInformation` object, set the `enableSigningExtensionComments` property to **true**).
///
/// Thrown when fails to make API call
/// Task of ApiResponse (System.IO.Stream)
System.Threading.Tasks.Task> GetCommentsTranscriptAsyncWithHttpInfo(string accountId, string envelopeId, EnvelopesApi.GetCommentsTranscriptOptions options = null);
///
/// Reserved: Gets the Electronic Record and Signature Disclosure associated with the account.
///
///
/// Reserved: Retrieves the Electronic Record and Signature Disclosure, with HTML formatting, associated with the account.
///
/// Thrown when fails to make API call
/// Task of ConsumerDisclosure
System.Threading.Tasks.Task GetConsumerDisclosureAsync(string accountId, string envelopeId, string recipientId, string langCode, EnvelopesApi.GetConsumerDisclosureOptions options = null);
///
/// Reserved: Gets the Electronic Record and Signature Disclosure associated with the account.
///
///
/// Reserved: Retrieves the Electronic Record and Signature Disclosure, with HTML formatting, associated with the account.
///
/// Thrown when fails to make API call
/// Task of ApiResponse (ConsumerDisclosure)
System.Threading.Tasks.Task> GetConsumerDisclosureAsyncWithHttpInfo(string accountId, string envelopeId, string recipientId, string langCode, EnvelopesApi.GetConsumerDisclosureOptions options = null);
///
/// Gets the Electronic Record and Signature Disclosure associated with the account.
///
///
/// Retrieves the Electronic Record and Signature Disclosure, with html formatting, associated with the account. You can use an optional query string to set the language for the disclosure.
///
/// Thrown when fails to make API call
/// Task of ConsumerDisclosure
System.Threading.Tasks.Task GetConsumerDisclosureDefaultAsync(string accountId, string envelopeId, string recipientId, EnvelopesApi.GetConsumerDisclosureDefaultOptions options = null);
///
/// Gets the Electronic Record and Signature Disclosure associated with the account.
///
///
/// Retrieves the Electronic Record and Signature Disclosure, with html formatting, associated with the account. You can use an optional query string to set the language for the disclosure.
///
/// Thrown when fails to make API call
/// Task of ApiResponse (ConsumerDisclosure)
System.Threading.Tasks.Task> GetConsumerDisclosureDefaultAsyncWithHttpInfo(string accountId, string envelopeId, string recipientId, EnvelopesApi.GetConsumerDisclosureDefaultOptions options = null);
///
/// Gets a document from an envelope.
///
///
/// Retrieves the specified document from the envelope. If the account has the Highlight Data Changes feature enabled, there is an option to request that any changes in the envelope be highlighted. You can also use this method to retrieve a PDF containing the combined content of all documents and the certificate. If the account has the Highlight Data Changes feature enabled, there is an option to request that any changes in the envelope be highlighted. To retrieve the combined content replace the `{documentId}` parameter in the endpoint with `combined`. /accounts/{accountId}/envelopes/{envelopeId}/documents/combined
///
/// Thrown when fails to make API call
/// Task of System.IO.Stream
System.Threading.Tasks.Task GetDocumentAsync(string accountId, string envelopeId, string documentId, EnvelopesApi.GetDocumentOptions options = null);
///
/// Gets a document from an envelope.
///
///
/// Retrieves the specified document from the envelope. If the account has the Highlight Data Changes feature enabled, there is an option to request that any changes in the envelope be highlighted. You can also use this method to retrieve a PDF containing the combined content of all documents and the certificate. If the account has the Highlight Data Changes feature enabled, there is an option to request that any changes in the envelope be highlighted. To retrieve the combined content replace the `{documentId}` parameter in the endpoint with `combined`. /accounts/{accountId}/envelopes/{envelopeId}/documents/combined
///
/// Thrown when fails to make API call
/// Task of ApiResponse (System.IO.Stream)
System.Threading.Tasks.Task> GetDocumentAsyncWithHttpInfo(string accountId, string envelopeId, string documentId, EnvelopesApi.GetDocumentOptions options = null);
///
/// Gets a page image from an envelope for display.
///
///
/// Retrieves a page image for display from the specified envelope.
///
/// Thrown when fails to make API call
/// Task of System.IO.Stream
System.Threading.Tasks.Task GetDocumentPageImageAsync(string accountId, string envelopeId, string documentId, string pageNumber, EnvelopesApi.GetDocumentPageImageOptions options = null);
///
/// Gets a page image from an envelope for display.
///
///
/// Retrieves a page image for display from the specified envelope.
///
/// Thrown when fails to make API call
/// Task of ApiResponse (System.IO.Stream)
System.Threading.Tasks.Task> GetDocumentPageImageAsyncWithHttpInfo(string accountId, string envelopeId, string documentId, string pageNumber, EnvelopesApi.GetDocumentPageImageOptions options = null);
///
/// Returns tabs on the document.
///
///
/// Returns the tabs on the document specified by `documentId` in the envelope specified by `envelopeId`.
///
/// Thrown when fails to make API call
/// Task of Tabs
System.Threading.Tasks.Task GetDocumentTabsAsync(string accountId, string envelopeId, string documentId, EnvelopesApi.GetDocumentTabsOptions options = null);
///
/// Returns tabs on the document.
///
///
/// Returns the tabs on the document specified by `documentId` in the envelope specified by `envelopeId`.
///
/// Thrown when fails to make API call
/// Task of ApiResponse (Tabs)
System.Threading.Tasks.Task> GetDocumentTabsAsyncWithHttpInfo(string accountId, string envelopeId, string documentId, EnvelopesApi.GetDocumentTabsOptions options = null);
///
/// Gets the email setting overrides for an envelope.
///
///
/// Retrieves the email override settings for the specified envelope.
///
/// Thrown when fails to make API call
/// Task of EmailSettings
System.Threading.Tasks.Task GetEmailSettingsAsync(string accountId, string envelopeId);
///
/// Gets the email setting overrides for an envelope.
///
///
/// Retrieves the email override settings for the specified envelope.
///
/// Thrown when fails to make API call
/// Task of ApiResponse (EmailSettings)
System.Threading.Tasks.Task> GetEmailSettingsAsyncWithHttpInfo(string accountId, string envelopeId);
///
/// Gets the status of a envelope.
///
///
/// Retrieves the overall status for the specified envelope.
///
/// Thrown when fails to make API call
/// Task of Envelope
System.Threading.Tasks.Task GetEnvelopeAsync(string accountId, string envelopeId, EnvelopesApi.GetEnvelopeOptions options = null);
///
/// Gets the status of a envelope.
///
///
/// Retrieves the overall status for the specified envelope.
///
/// Thrown when fails to make API call
/// Task of ApiResponse (Envelope)
System.Threading.Tasks.Task> GetEnvelopeAsyncWithHttpInfo(string accountId, string envelopeId, EnvelopesApi.GetEnvelopeOptions options = null);
///
/// Returns the delayed routing rules for an envelope's workflow step definition.
///
///
///
///
/// Thrown when fails to make API call
/// Task of DelayedRouting
System.Threading.Tasks.Task GetEnvelopeDelayedRoutingDefinitionAsync(string accountId, string envelopeId, string workflowStepId);
///
/// Returns the delayed routing rules for an envelope's workflow step definition.
///
///
///
///
/// Thrown when fails to make API call
/// Task of ApiResponse (DelayedRouting)
System.Threading.Tasks.Task> GetEnvelopeDelayedRoutingDefinitionAsyncWithHttpInfo(string accountId, string envelopeId, string workflowStepId);
///
/// Returns formfields for an envelope
///
///
///
///
/// Thrown when fails to make API call
/// Task of DocGenFormFieldResponse
System.Threading.Tasks.Task GetEnvelopeDocGenFormFieldsAsync(string accountId, string envelopeId);
///
/// Returns formfields for an envelope
///
///
///
///
/// Thrown when fails to make API call
/// Task of ApiResponse (DocGenFormFieldResponse)
System.Threading.Tasks.Task> GetEnvelopeDocGenFormFieldsAsyncWithHttpInfo(string accountId, string envelopeId);
///
/// Get the Original HTML Definition used to generate the Responsive HTML for a given document.
///
///
///
///
/// Thrown when fails to make API call
/// Task of DocumentHtmlDefinitionOriginals
System.Threading.Tasks.Task GetEnvelopeDocumentHtmlDefinitionsAsync(string accountId, string envelopeId, string documentId);
///
/// Get the Original HTML Definition used to generate the Responsive HTML for a given document.
///
///
///
///
/// Thrown when fails to make API call
/// Task of ApiResponse (DocumentHtmlDefinitionOriginals)
System.Threading.Tasks.Task> GetEnvelopeDocumentHtmlDefinitionsAsyncWithHttpInfo(string accountId, string envelopeId, string documentId);
///
/// Get the Original HTML Definition used to generate the Responsive HTML for the envelope.
///
///
///
///
/// Thrown when fails to make API call
/// Task of DocumentHtmlDefinitionOriginals
System.Threading.Tasks.Task GetEnvelopeHtmlDefinitionsAsync(string accountId, string envelopeId);
///
/// Get the Original HTML Definition used to generate the Responsive HTML for the envelope.
///
///
///
///
/// Thrown when fails to make API call
/// Task of ApiResponse (DocumentHtmlDefinitionOriginals)
System.Threading.Tasks.Task> GetEnvelopeHtmlDefinitionsAsyncWithHttpInfo(string accountId, string envelopeId);
///
/// Returns the scheduled sending rules for an envelope's workflow definition.
///
///
///
///
/// Thrown when fails to make API call
/// Task of ScheduledSending
System.Threading.Tasks.Task GetEnvelopeScheduledSendingDefinitionAsync(string accountId, string envelopeId);
///
/// Returns the scheduled sending rules for an envelope's workflow definition.
///
///
///
///
/// Thrown when fails to make API call
/// Task of ApiResponse (ScheduledSending)
System.Threading.Tasks.Task> GetEnvelopeScheduledSendingDefinitionAsyncWithHttpInfo(string accountId, string envelopeId);
///
/// Returns a list of envelope transfer rules in the specified account.
///
///
/// This method retrieves a list of envelope transfer rules associated with an account. **Note:** Only Administrators can create and use envelope transfer rules. In addition, to use envelope transfer rules, the **Transfer Custody** feature must be enabled for your account.
///
/// Thrown when fails to make API call
/// Task of EnvelopeTransferRuleInformation
System.Threading.Tasks.Task GetEnvelopeTransferRulesAsync(string accountId, EnvelopesApi.GetEnvelopeTransferRulesOptions options = null);
///
/// Returns a list of envelope transfer rules in the specified account.
///
///
/// This method retrieves a list of envelope transfer rules associated with an account. **Note:** Only Administrators can create and use envelope transfer rules. In addition, to use envelope transfer rules, the **Transfer Custody** feature must be enabled for your account.
///
/// Thrown when fails to make API call
/// Task of ApiResponse (EnvelopeTransferRuleInformation)
System.Threading.Tasks.Task> GetEnvelopeTransferRulesAsyncWithHttpInfo(string accountId, EnvelopesApi.GetEnvelopeTransferRulesOptions options = null);
///