EnvelopesApi (com.docusign:docusign-esign-java 2.0.0 API)

java.lang.Object
- com.docusign.esign.api.EnvelopesApi

@Generated(value="class io.swagger.codegen.languages.JavaClientCodegen",
           date="2015-12-14T16:41:01.888-08:00")
public class EnvelopesApi
extends Object

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`class`	`EnvelopesApi.CreateEnvelopeOptions`
`class`	`EnvelopesApi.GetEnvelopeOptions`
`class`	`EnvelopesApi.ListStatusChangesOptions`
`class`	`EnvelopesApi.UpdateOptions`

Constructor Summary

Constructors
Constructor and Description

EnvelopesApi()

EnvelopesApi(ApiClient apiClient)

Constructors
Constructor and Description
`EnvelopesApi()`
`EnvelopesApi(ApiClient apiClient)`

Method Summary

Methods
Modifier and Type	Method and Description
`DocumentTemplateList`	`applyTemplate(String accountId, String envelopeId, DocumentTemplateList documentTemplateList)` Adds templates to an envelope.
`DocumentTemplateList`	`applyTemplateToDocument(String accountId, String envelopeId, String documentId, DocumentTemplateList documentTemplateList)` Adds templates to a document in an envelope.
`ViewUrl`	`createConsoleView(String accountId, ConsoleViewRequest consoleViewRequest)` Returns a URL to the authentication view UI.
`ViewUrl`	`createCorrectView(String accountId, String envelopeId, CorrectViewRequest correctViewRequest)` Returns a URL to the envelope correction UI.
`CustomFields`	`createCustomFields(String accountId, String envelopeId, CustomFields customFields)` Updates envelope custom fields for an envelope.
`DocumentFieldsInformation`	`createDocumentFields(String accountId, String envelopeId, String documentId, DocumentFieldsInformation documentFieldsInformation)` Creates custom document fields in an existing envelope document.
`ViewUrl`	`createEditView(String accountId, String envelopeId, ReturnUrlRequest returnUrlRequest)` Returns a URL to the edit view UI.
`EmailSettings`	`createEmailSettings(String accountId, String envelopeId, EmailSettings emailSettings)` Adds email setting overrides to an envelope.
`EnvelopeSummary`	`createEnvelope(String accountId, EnvelopeDefinition envelopeDefinition)` Creates an envelope.
`EnvelopeSummary`	`createEnvelope(String accountId, EnvelopeDefinition envelopeDefinition, EnvelopesApi.CreateEnvelopeOptions options)` Creates an envelope.
`LockInformation`	`createLock(String accountId, String envelopeId, LockRequest lockRequest)` Lock an envelope.
`Recipients`	`createRecipient(String accountId, String envelopeId, Recipients recipients)` Adds one or more recipients to an envelope.
`ViewUrl`	`createRecipientView(String accountId, String envelopeId, RecipientViewRequest recipientViewRequest)` Returns a URL to the recipient view UI.
`ViewUrl`	`createSenderView(String accountId, String envelopeId, ReturnUrlRequest returnUrlRequest)` Returns a URL to the sender view UI.
`Tabs`	`createTabs(String accountId, String envelopeId, String recipientId, Tabs tabs)` Adds tabs for a recipient.
`ViewUrl`	`createViewLink(String accountId, String envelopeId, ViewLinkRequest viewLinkRequest)` Reserved: Returns a URL to the secure link view UI.
`CustomFields`	`deleteCustomFields(String accountId, String envelopeId, CustomFields customFields)` Deletes envelope custom fields for draft and in-process envelopes.
`DocumentFieldsInformation`	`deleteDocumentFields(String accountId, String envelopeId, String documentId, DocumentFieldsInformation documentFieldsInformation)` Deletes custom document fields from an existing envelope document.
`void`	`deleteDocumentPage(String accountId, String envelopeId, String documentId, String pageNumber)` Deletes a page from a document in an envelope.
`EnvelopeDocumentsResult`	`deleteDocuments(String accountId, String envelopeId, EnvelopeDefinition envelopeDefinition)` Deletes documents from a draft envelope.
`EmailSettings`	`deleteEmailSettings(String accountId, String envelopeId)` Deletes the email setting overrides for an envelope.
`LockInformation`	`deleteLock(String accountId, String envelopeId)` Deletes an envelope lock.
`Recipients`	`deleteRecipient(String accountId, String envelopeId, String recipientId)` Deletes a recipient from an envelope.
`Recipients`	`deleteRecipients(String accountId, String envelopeId, Recipients recipients)` Deletes recipients from an envelope.
`Tabs`	`deleteTabs(String accountId, String envelopeId, String recipientId, Tabs tabs)` Deletes the tabs associated with a recipient.
`void`	`deleteTemplatesFromDocument(String accountId, String envelopeId, String documentId, String templateId)` Deletes a template from a document in an existing envelope.
`void`	`deleteViewLink(String accountId, String envelopeId)` Reserved: Expires a secure view link.
`ApiClient`	`getApiClient()`
`byte[]`	`getDocument(String accountId, String envelopeId, String documentId)` Gets a document from an envelope.
`EmailSettings`	`getEmailSettings(String accountId, String envelopeId)` Gets the email setting overrides for an envelope.
`Envelope`	`getEnvelope(String accountId, String envelopeId)` Gets the status of a envelope.
`Envelope`	`getEnvelope(String accountId, String envelopeId, EnvelopesApi.GetEnvelopeOptions options)` Gets the status of a envelope.
`LockInformation`	`getLock(String accountId, String envelopeId)` Gets envelope lock information.
`Notification`	`getNotificationSettings(String accountId, String envelopeId)` Gets envelope notification information.
`EnvelopeAuditEventResponse`	`listAuditEvents(String accountId, String envelopeId)` Gets the envelope audit events for an envelope.
`CustomFieldsEnvelope`	`listCustomFields(String accountId, String envelopeId)` Gets the custom field information for the specified envelope.
`DocumentFieldsInformation`	`listDocumentFields(String accountId, String envelopeId, String documentId)` Gets the custom document fields from an existing envelope document.
`EnvelopeDocumentsResult`	`listDocuments(String accountId, String envelopeId)` Gets a list of envelope documents.
`Recipients`	`listRecipients(String accountId, String envelopeId)` Gets the status of recipients for an envelope.
`EnvelopesInformation`	`listStatus(String accountId, EnvelopeIdsRequest envelopeIdsRequest)` Gets the envelope status for the specified envelopes.
`EnvelopesInformation`	`listStatusChanges(String accountId)` Gets status changes for one or more envelopes.
`EnvelopesInformation`	`listStatusChanges(String accountId, EnvelopesApi.ListStatusChangesOptions options)` Gets status changes for one or more envelopes.
`Tabs`	`listTabs(String accountId, String envelopeId, String recipientId)` Gets the tabs information for a signer or sign-in-person recipient in an envelope.
`TemplateInformation`	`listTemplates(String accountId, String envelopeId)` Get List of Templates used in an Envelope This returns a list of the templates, name and ID, used in an envelope.<br/><br/>Note: This only returns information for server side templates.
`TemplateInformation`	`listTemplatesForDocument(String accountId, String envelopeId, String documentId)` Gets the templates associated with a document in an existing envelope.
`void`	`setApiClient(ApiClient apiClient)`
`EnvelopeUpdateSummary`	`update(String accountId, String envelopeId, Envelope envelope)` Send Draft Envelope/Void Envelope/Move/Purge Envelope/Modify draft The Put Envelopes endpoint provides the following functionality:\n\n* Sends the specified single draft envelope.\nAdd {\"status\":\"sent\"} to the request body to send the envelope.\n\n* Voids the specified in-process envelope.\nAdd {\"status\":\"voided\", \"voidedReason\":\"The reason for voiding the envelope\"} to the request body to void the envelope.\n\n* Replaces the current email subject and message for a draft envelope.\nAdd {\"emailSubject\":\"subject\", \"emailBlurb\":\"message\"} to the request body to modify the subject and message.\n\n* Place the envelope documents and envelope metadata in a purge queue so that this information is removed from the DocuSign system.\nAdd {\"purgeState\":\"purge type\"} to the request body.\n\nAdditional information on purging documents\n\nThe purge request can only be used for completed envelopes that are not marked as the authoritative copy.
`EnvelopeUpdateSummary`	`update(String accountId, String envelopeId, Envelope envelope, EnvelopesApi.UpdateOptions options)` Send Draft Envelope/Void Envelope/Move/Purge Envelope/Modify draft The Put Envelopes endpoint provides the following functionality:\n\n* Sends the specified single draft envelope.\nAdd {\"status\":\"sent\"} to the request body to send the envelope.\n\n* Voids the specified in-process envelope.\nAdd {\"status\":\"voided\", \"voidedReason\":\"The reason for voiding the envelope\"} to the request body to void the envelope.\n\n* Replaces the current email subject and message for a draft envelope.\nAdd {\"emailSubject\":\"subject\", \"emailBlurb\":\"message\"} to the request body to modify the subject and message.\n\n* Place the envelope documents and envelope metadata in a purge queue so that this information is removed from the DocuSign system.\nAdd {\"purgeState\":\"purge type\"} to the request body.\n\nAdditional information on purging documents\n\nThe purge request can only be used for completed envelopes that are not marked as the authoritative copy.
`CustomFields`	`updateCustomFields(String accountId, String envelopeId, CustomFields customFields)` Updates envelope custom fields in an envelope.
`DocumentFieldsInformation`	`updateDocumentFields(String accountId, String envelopeId, String documentId, DocumentFieldsInformation documentFieldsInformation)` Updates existing custom document fields in an existing envelope document.
`EnvelopeDocumentsResult`	`updateDocuments(String accountId, String envelopeId, EnvelopeDefinition envelopeDefinition)` Adds one or more documents to an existing envelope document.
`EmailSettings`	`updateEmailSettings(String accountId, String envelopeId, EmailSettings emailSettings)` Updates the email setting overrides for an envelope.
`LockInformation`	`updateLock(String accountId, String envelopeId, LockRequest lockRequest)` Updates an envelope lock.
`RecipientsUpdateSummary`	`updateRecipients(String accountId, String envelopeId, Recipients recipients)` Updates recipients in a draft envelope or corrects recipient information for an in process envelope.
`Tabs`	`updateTabs(String accountId, String envelopeId, String recipientId, Tabs tabs)` Updates the tabs for a recipient.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - EnvelopesApi
```
public EnvelopesApi()
```
  - EnvelopesApi
```
public EnvelopesApi(ApiClient apiClient)
```
- Method Detail
  - getApiClient
```
public ApiClient getApiClient()
```
  - setApiClient
```
public void setApiClient(ApiClient apiClient)
```
  - listStatusChanges
```
public EnvelopesInformation listStatusChanges(String accountId)
                                       throws ApiException
```
    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.\n\n### 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.\n\nGetting 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.\n\n### Request Envelope Status Notes ###\n\nThe 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.\n\nTo 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.\n\nFor 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.\n\nClient applications should check that the statuses they are requesting make sense for a given status qualifier.
    
    Parameters:
    accountId - The external account number (int) or account ID Guid.
    
    Returns:
    EnvelopesInformation
    
    Throws:
    
    ApiException
  - listStatusChanges
```
public EnvelopesInformation listStatusChanges(String accountId,
                                     EnvelopesApi.ListStatusChangesOptions options)
                                       throws ApiException
```
    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.\n\n### 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.\n\nGetting 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.\n\n### Request Envelope Status Notes ###\n\nThe 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.\n\nTo 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.\n\nFor 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.\n\nClient applications should check that the statuses they are requesting make sense for a given status qualifier.
    
    Parameters:
    accountId - The external account number (int) or account ID Guid. EnvelopesApi.ListStatusChangesOptions Options for modifying the method behavior.
    
    Returns:
    EnvelopesInformation
    
    Throws:
    
    ApiException
  - createEnvelope
```
public EnvelopeSummary createEnvelope(String accountId,
                             EnvelopeDefinition envelopeDefinition)
                               throws ApiException
```
    Creates an envelope. Creates an envelope. \n\nUsing this function you can:\n* Create an envelope and send it.\n* Create an envelope from an existing template and send it.\n\nIn either case, you can choose to save the envelope as a draft envelope instead of sending it by setting the `status` property in the request to `created` instead of `sent`.\n\n### Send an Envelope or Create a Draft Envelope\n\nThis is a multi-part/form request.\n\nEnvelope Event Notification: `eventNotification` is an optional property that specifies a set of envelope and recipient status codes, a URL, and some other options. When the envelope or recipient status changes to one of the specified status codes, DocuSign sends a message containing the updated status to the specified URL.\n\n### Note: DocuSign Connect must be enabled to use `eventNotification`, but Connect does not need to be configured for the account since the configuration is done for each envelope.\n\n### Send an Envelope from a Template\n\nWhen you create an envelope using a `templateId`, the `recipients` structure is used to assign recipients to template roles via the `roleName` property, override recipient settings that have been specified in the template and set values for tab fields that were defined in the template.\n\nWhen a template is added or applied to an envelope and the template has a locked email subject and message, that subject and message is used for the envelope and cannot be changed even if another locked template is subsequently added or applied to the envelope. If an email subject or message is entered before adding or applying a locked template, the email subject and message is overwritten with the email subject and message from the locked template.\n\n**Composite Templates**:\n\nYou can add Composite Templates structure to the to create envelopes from a combination of DocuSign templates and PDF forms. The basic envelope remains the same, while the Composite Template adds new document and template overlays into the envelope. There can be any number of Composite Template structures in the envelope.\n\nEach Composite Template consists of server templates, inline templates, PDF Metadata templates, and documents.\n\n* Composite Template ID is an optional element used to identify the composite template. It is used as a reference when adding document object information. 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.\n* Server Templates are server-side templates stored on the DocuSign server. If supplied they are overlaid into the envelope in the order of their Sequence value.\n* Inline Templates provide the container to pass inline XML properties. Inline templates allow you to add documents and, for PDF documents, transform the PDF fields into DocuSign tabs. If inline templates are supplied, they are overlaid into the envelope in the order of their Sequence value.\n* 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 meta data template will be overlaid into the envelope in the order of their Sequence value.\n* Document objects are optional structures that provide a container to pass in a document or form. If this object is not passed, the composite template inherits the first document it finds from some other server template or inline template, starting with the lowest sequence value (discussed below).\n\nIf 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:\n\n```\n --5cd3320a-5aac-4453-b3a4-cbb52a4cba5d\n\n Content-Type: application/pdf\n\n Content-Disposition: file; filename=\"eula.pdf\"; documentId=1; compositeTemplateId=\"1\"\n\n Content-Transfer-Encoding: base64\n```\n\nAcrobat form objects are only extrapolated from the document object. DocuSign does not derive Acrobat form properties from server templates or inline templates. To instruct DocuSign to extrapolate objects from the Acrobat form, set `transformPdfFields` to \"true\" for the document. See the Transform PDF Fields section for more information about how fields are transformed into DocuSign tabs.\n\n*Sequence*\n\nEach type of template has a sequence property, which enables the templates to be over-laid in a particular order. This is significant because \"last-out\" wins in cases of the same property being specified in multiple places in the method schema.\n\n**Merge Recipient Roles for Draft Envelopes**\n\nWhen an envelope with multiple templates is sent, the recipients from the templates are merged according to 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.\n\nTo 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.\n\n### Note: DocuSign recommends that the merge roles query parameter be used anytime you are creating an envelope with multiple templates and keeping it in draft (created) status.\n\n**Template Email Subject Merge Fields**\n\nThis provides the ability to insert recipient name and email address merge fields into the email subject line when creating or sending from a template.\n\nThe 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.\n\nBoth 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.\n\nIf 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.\n\n* 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:\n\n [[<roleName>_UserName]]\n\n Example:\n\n `\"emailSubject\":\"[[Signer 1_UserName]], Please sign this NDA\",`\n\n* 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:\n\n [[<roleName>_Email]]\n\n Example:\n\n `\"emailSubject\":\"[[Signer 1_Email]], Please sign this NDA\",`\n\nIn both cases the <roleName> is the recipient’s `roleName` in the template.\n\nFor 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.\n\n*Rules for determining the `brandId` used in an envelope*\n\nThe following rules are used to determine the `brandId` used in an envelope:\n\n* If a `brandId` is specified in the envelope/template and that brandId is available to the account, that brand is used in the envelope.\n* 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.\n* 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.\n* For envelopes that do not meet any of the previous rules, the account's default signing brand is used in the envelope.\n\n### 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.
    
    Parameters:
    accountId - The external account number (int) or account ID Guid.
    
    Returns:
    EnvelopeSummary
    
    Throws:
    
    ApiException
  - createEnvelope
```
public EnvelopeSummary createEnvelope(String accountId,
                             EnvelopeDefinition envelopeDefinition,
                             EnvelopesApi.CreateEnvelopeOptions options)
                               throws ApiException
```
    Creates an envelope. Creates an envelope. \n\nUsing this function you can:\n* Create an envelope and send it.\n* Create an envelope from an existing template and send it.\n\nIn either case, you can choose to save the envelope as a draft envelope instead of sending it by setting the `status` property in the request to `created` instead of `sent`.\n\n### Send an Envelope or Create a Draft Envelope\n\nThis is a multi-part/form request.\n\nEnvelope Event Notification: `eventNotification` is an optional property that specifies a set of envelope and recipient status codes, a URL, and some other options. When the envelope or recipient status changes to one of the specified status codes, DocuSign sends a message containing the updated status to the specified URL.\n\n### Note: DocuSign Connect must be enabled to use `eventNotification`, but Connect does not need to be configured for the account since the configuration is done for each envelope.\n\n### Send an Envelope from a Template\n\nWhen you create an envelope using a `templateId`, the `recipients` structure is used to assign recipients to template roles via the `roleName` property, override recipient settings that have been specified in the template and set values for tab fields that were defined in the template.\n\nWhen a template is added or applied to an envelope and the template has a locked email subject and message, that subject and message is used for the envelope and cannot be changed even if another locked template is subsequently added or applied to the envelope. If an email subject or message is entered before adding or applying a locked template, the email subject and message is overwritten with the email subject and message from the locked template.\n\n**Composite Templates**:\n\nYou can add Composite Templates structure to the to create envelopes from a combination of DocuSign templates and PDF forms. The basic envelope remains the same, while the Composite Template adds new document and template overlays into the envelope. There can be any number of Composite Template structures in the envelope.\n\nEach Composite Template consists of server templates, inline templates, PDF Metadata templates, and documents.\n\n* Composite Template ID is an optional element used to identify the composite template. It is used as a reference when adding document object information. 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.\n* Server Templates are server-side templates stored on the DocuSign server. If supplied they are overlaid into the envelope in the order of their Sequence value.\n* Inline Templates provide the container to pass inline XML properties. Inline templates allow you to add documents and, for PDF documents, transform the PDF fields into DocuSign tabs. If inline templates are supplied, they are overlaid into the envelope in the order of their Sequence value.\n* 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 meta data template will be overlaid into the envelope in the order of their Sequence value.\n* Document objects are optional structures that provide a container to pass in a document or form. If this object is not passed, the composite template inherits the first document it finds from some other server template or inline template, starting with the lowest sequence value (discussed below).\n\nIf 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:\n\n```\n --5cd3320a-5aac-4453-b3a4-cbb52a4cba5d\n\n Content-Type: application/pdf\n\n Content-Disposition: file; filename=\"eula.pdf\"; documentId=1; compositeTemplateId=\"1\"\n\n Content-Transfer-Encoding: base64\n```\n\nAcrobat form objects are only extrapolated from the document object. DocuSign does not derive Acrobat form properties from server templates or inline templates. To instruct DocuSign to extrapolate objects from the Acrobat form, set `transformPdfFields` to \"true\" for the document. See the Transform PDF Fields section for more information about how fields are transformed into DocuSign tabs.\n\n*Sequence*\n\nEach type of template has a sequence property, which enables the templates to be over-laid in a particular order. This is significant because \"last-out\" wins in cases of the same property being specified in multiple places in the method schema.\n\n**Merge Recipient Roles for Draft Envelopes**\n\nWhen an envelope with multiple templates is sent, the recipients from the templates are merged according to 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.\n\nTo 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.\n\n### Note: DocuSign recommends that the merge roles query parameter be used anytime you are creating an envelope with multiple templates and keeping it in draft (created) status.\n\n**Template Email Subject Merge Fields**\n\nThis provides the ability to insert recipient name and email address merge fields into the email subject line when creating or sending from a template.\n\nThe 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.\n\nBoth 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.\n\nIf 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.\n\n* 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:\n\n [[<roleName>_UserName]]\n\n Example:\n\n `\"emailSubject\":\"[[Signer 1_UserName]], Please sign this NDA\",`\n\n* 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:\n\n [[<roleName>_Email]]\n\n Example:\n\n `\"emailSubject\":\"[[Signer 1_Email]], Please sign this NDA\",`\n\nIn both cases the <roleName> is the recipient’s `roleName` in the template.\n\nFor 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.\n\n*Rules for determining the `brandId` used in an envelope*\n\nThe following rules are used to determine the `brandId` used in an envelope:\n\n* If a `brandId` is specified in the envelope/template and that brandId is available to the account, that brand is used in the envelope.\n* 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.\n* 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.\n* For envelopes that do not meet any of the previous rules, the account's default signing brand is used in the envelope.\n\n### 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.
    
    Parameters:
    accountId - The external account number (int) or account ID Guid. EnvelopesApi.CreateEnvelopeOptions Options for modifying the method behavior.
    
    Returns:
    EnvelopeSummary
    
    Throws:
    
    ApiException
  - listStatus
```
public EnvelopesInformation listStatus(String accountId,
                              EnvelopeIdsRequest envelopeIdsRequest)
                                throws ApiException
```
    Gets the envelope status for the specified envelopes. Retrieves the envelope status for the specified envelopes.
    
    Parameters:
    accountId - The external account number (int) or account ID Guid. EnvelopesApi.ListStatusOptions Options for modifying the method behavior.
    
    Returns:
    EnvelopesInformation
    
    Throws:
    
    ApiException
  - getEnvelope
```
public Envelope getEnvelope(String accountId,
                   String envelopeId)
                     throws ApiException
```
    Gets the status of a envelope. Retrieves the overall status for the specified envelope.
    
    Parameters:
    accountId - The external account number (int) or account ID Guid.
    envelopeId - The envelopeId Guid of the envelope being accessed.
    
    Returns:
    Envelope
    
    Throws:
    
    ApiException
  - getEnvelope
```
public Envelope getEnvelope(String accountId,
                   String envelopeId,
                   EnvelopesApi.GetEnvelopeOptions options)
                     throws ApiException
```
    Gets the status of a envelope. Retrieves the overall status for the specified envelope.
    
    Parameters:
    accountId - The external account number (int) or account ID Guid.
    envelopeId - The envelopeId Guid of the envelope being accessed. EnvelopesApi.GetEnvelopeOptions Options for modifying the method behavior.
    
    Returns:
    Envelope
    
    Throws:
    
    ApiException
  - update
```
public EnvelopeUpdateSummary update(String accountId,
                           String envelopeId,
                           Envelope envelope)
                             throws ApiException
```
    Send Draft Envelope/Void Envelope/Move/Purge Envelope/Modify draft The Put Envelopes endpoint provides the following functionality:\n\n* Sends the specified single draft envelope.\nAdd {\"status\":\"sent\"} to the request body to send the envelope.\n\n* Voids the specified in-process envelope.\nAdd {\"status\":\"voided\", \"voidedReason\":\"The reason for voiding the envelope\"} to the request body to void the envelope.\n\n* Replaces the current email subject and message for a draft envelope.\nAdd {\"emailSubject\":\"subject\", \"emailBlurb\":\"message\"} to the request body to modify the subject and message.\n\n* Place the envelope documents and envelope metadata in a purge queue so that this information is removed from the DocuSign system.\nAdd {\"purgeState\":\"purge type\"} to the request body.\n\n*Additional information on purging documents*\n\nThe 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).\n\n### 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. \n### Note: You can set the Document Retention policy in the Classic DocuSign Experience by specifying the number of days to retain documents. \n### Note: Setting a Document Retention policy is the same as setting a schedule for purging documents.\n\nWhen 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.\n\nIf `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.
    
    Parameters:
    accountId - The external account number (int) or account ID Guid.
    envelopeId - The envelopeId Guid of the envelope being accessed.
    
    Returns:
    EnvelopeUpdateSummary
    
    Throws:
    
    ApiException
  - update
```
public EnvelopeUpdateSummary update(String accountId,
                           String envelopeId,
                           Envelope envelope,
                           EnvelopesApi.UpdateOptions options)
                             throws ApiException
```
    Send Draft Envelope/Void Envelope/Move/Purge Envelope/Modify draft The Put Envelopes endpoint provides the following functionality:\n\n* Sends the specified single draft envelope.\nAdd {\"status\":\"sent\"} to the request body to send the envelope.\n\n* Voids the specified in-process envelope.\nAdd {\"status\":\"voided\", \"voidedReason\":\"The reason for voiding the envelope\"} to the request body to void the envelope.\n\n* Replaces the current email subject and message for a draft envelope.\nAdd {\"emailSubject\":\"subject\", \"emailBlurb\":\"message\"} to the request body to modify the subject and message.\n\n* Place the envelope documents and envelope metadata in a purge queue so that this information is removed from the DocuSign system.\nAdd {\"purgeState\":\"purge type\"} to the request body.\n\n*Additional information on purging documents*\n\nThe 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).\n\n### 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. \n### Note: You can set the Document Retention policy in the Classic DocuSign Experience by specifying the number of days to retain documents. \n### Note: Setting a Document Retention policy is the same as setting a schedule for purging documents.\n\nWhen 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.\n\nIf `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.
    
    Parameters:
    accountId - The external account number (int) or account ID Guid.
    envelopeId - The envelopeId Guid of the envelope being accessed. EnvelopesApi.UpdateOptions Options for modifying the method behavior.
    
    Returns:
    EnvelopeUpdateSummary
    
    Throws:
    
    ApiException
  - listAuditEvents
```
public EnvelopeAuditEventResponse listAuditEvents(String accountId,
                                         String envelopeId)
                                           throws ApiException
```
    Gets the envelope audit events for an envelope. Gets the envelope audit events for the specified envelope.
    
    Parameters:
    accountId - The external account number (int) or account ID Guid.
    envelopeId - The envelopeId Guid of the envelope being accessed. EnvelopesApi.ListAuditEventsOptions Options for modifying the method behavior.
    
    Returns:
    EnvelopeAuditEventResponse
    
    Throws:
    
    ApiException
  - listCustomFields
```
public CustomFieldsEnvelope listCustomFields(String accountId,
                                    String envelopeId)
                                      throws ApiException
```
    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.\n\nThere 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.
    
    Parameters:
    accountId - The external account number (int) or account ID Guid.
    envelopeId - The envelopeId Guid of the envelope being accessed. EnvelopesApi.ListCustomFieldsOptions Options for modifying the method behavior.
    
    Returns:
    CustomFieldsEnvelope
    
    Throws:
    
    ApiException
  - updateCustomFields
```
public CustomFields updateCustomFields(String accountId,
                              String envelopeId,
                              CustomFields customFields)
                                throws ApiException
```
    Updates envelope custom fields in an envelope. Updates the envelope custom fields in draft and in-process envelopes.\n\nEach custom field used in an envelope must have a unique name.
    
    Parameters:
    accountId - The external account number (int) or account ID Guid.
    envelopeId - The envelopeId Guid of the envelope being accessed. EnvelopesApi.UpdateCustomFieldsOptions Options for modifying the method behavior.
    
    Returns:
    CustomFields
    
    Throws:
    
    ApiException
  - createCustomFields
```
public CustomFields createCustomFields(String accountId,
                              String envelopeId,
                              CustomFields customFields)
                                throws ApiException
```
    Updates envelope custom fields for an envelope. Updates the envelope custom fields for draft and in-process envelopes.\n\nEach custom field used in an envelope must have a unique name.
    
    Parameters:
    accountId - The external account number (int) or account ID Guid.
    envelopeId - The envelopeId Guid of the envelope being accessed. EnvelopesApi.CreateCustomFieldsOptions Options for modifying the method behavior.
    
    Returns:
    CustomFields
    
    Throws:
    
    ApiException
  - deleteCustomFields
```
public CustomFields deleteCustomFields(String accountId,
                              String envelopeId,
                              CustomFields customFields)
                                throws ApiException
```
    Deletes envelope custom fields for draft and in-process envelopes. Deletes envelope custom fields for draft and in-process envelopes.
    
    Parameters:
    accountId - The external account number (int) or account ID Guid.
    envelopeId - The envelopeId Guid of the envelope being accessed. EnvelopesApi.DeleteCustomFieldsOptions Options for modifying the method behavior.
    
    Returns:
    CustomFields
    
    Throws:
    
    ApiException
  - listDocuments
```
public EnvelopeDocumentsResult listDocuments(String accountId,
                                    String envelopeId)
                                      throws ApiException
```
    Gets a list of envelope documents. Retrieves a list of documents associated with the specified envelope.
    
    Parameters:
    accountId - The external account number (int) or account ID Guid.
    envelopeId - The envelopeId Guid of the envelope being accessed. EnvelopesApi.ListDocumentsOptions Options for modifying the method behavior.
    
    Returns:
    EnvelopeDocumentsResult
    
    Throws:
    
    ApiException
  - updateDocuments
```
public EnvelopeDocumentsResult updateDocuments(String accountId,
                                      String envelopeId,
                                      EnvelopeDefinition envelopeDefinition)
                                        throws ApiException
```
    Adds one or more documents to an existing envelope document. Adds one or more documents to an existing envelope document.
    
    Parameters:
    accountId - The external account number (int) or account ID Guid.
    envelopeId - The envelopeId Guid of the envelope being accessed. EnvelopesApi.UpdateDocumentsOptions Options for modifying the method behavior.
    
    Returns:
    EnvelopeDocumentsResult
    
    Throws:
    
    ApiException
  - deleteDocuments
```
public EnvelopeDocumentsResult deleteDocuments(String accountId,
                                      String envelopeId,
                                      EnvelopeDefinition envelopeDefinition)
                                        throws ApiException
```
    Deletes documents from a draft envelope. Deletes one or more documents from an existing draft envelope.
    
    Parameters:
    accountId - The external account number (int) or account ID Guid.
    envelopeId - The envelopeId Guid of the envelope being accessed. EnvelopesApi.DeleteDocumentsOptions Options for modifying the method behavior.
    
    Returns:
    EnvelopeDocumentsResult
    
    Throws:
    
    ApiException
  - getDocument
```
public byte[] getDocument(String accountId,
                 String envelopeId,
                 String documentId)
                   throws ApiException
```
    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.\n\nYou 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. \n\nTo retrieve the combined content replace the `{documentId}` parameter in the endpoint with `combined`.\n/accounts/{accountId}/envelopes/{envelopeId}/documents/combined
    
    Parameters:
    accountId - The external account number (int) or account ID Guid.
    envelopeId - The envelopeId Guid of the envelope being accessed.
    documentId - The ID of the document being accessed. EnvelopesApi.GetDocumentOptions Options for modifying the method behavior.
    
    Returns:
    byte[]
    
    Throws:
    
    ApiException
  - listDocumentFields
```
public DocumentFieldsInformation listDocumentFields(String accountId,
                                           String envelopeId,
                                           String documentId)
                                             throws ApiException
```
    Gets the custom document fields from an existing envelope document. Retrieves the custom document field information from an existing envelope document.
    
    Parameters:
    accountId - The external account number (int) or account ID Guid.
    envelopeId - The envelopeId Guid of the envelope being accessed.
    documentId - The ID of the document being accessed. EnvelopesApi.ListDocumentFieldsOptions Options for modifying the method behavior.
    
    Returns:
    DocumentFieldsInformation
    
    Throws:
    
    ApiException
  - updateDocumentFields
```
public DocumentFieldsInformation updateDocumentFields(String accountId,
                                             String envelopeId,
                                             String documentId,
                                             DocumentFieldsInformation documentFieldsInformation)
                                               throws ApiException
```
    Updates existing custom document fields in an existing envelope document. Updates existing custom document fields in an existing envelope document.
    
    Parameters:
    accountId - The external account number (int) or account ID Guid.
    envelopeId - The envelopeId Guid of the envelope being accessed.
    documentId - The ID of the document being accessed. EnvelopesApi.UpdateDocumentFieldsOptions Options for modifying the method behavior.
    
    Returns:
    DocumentFieldsInformation
    
    Throws:
    
    ApiException
  - createDocumentFields
```
public DocumentFieldsInformation createDocumentFields(String accountId,
                                             String envelopeId,
                                             String documentId,
                                             DocumentFieldsInformation documentFieldsInformation)
                                               throws ApiException
```
    Creates custom document fields in an existing envelope document. Creates custom document fields in an existing envelope document.
    
    Parameters:
    accountId - The external account number (int) or account ID Guid.
    envelopeId - The envelopeId Guid of the envelope being accessed.
    documentId - The ID of the document being accessed. EnvelopesApi.CreateDocumentFieldsOptions Options for modifying the method behavior.
    
    Returns:
    DocumentFieldsInformation
    
    Throws:
    
    ApiException
  - deleteDocumentFields
```
public DocumentFieldsInformation deleteDocumentFields(String accountId,
                                             String envelopeId,
                                             String documentId,
                                             DocumentFieldsInformation documentFieldsInformation)
                                               throws ApiException
```
    Deletes custom document fields from an existing envelope document. Deletes custom document fields from an existing envelope document.
    
    Parameters:
    accountId - The external account number (int) or account ID Guid.
    envelopeId - The envelopeId Guid of the envelope being accessed.
    documentId - The ID of the document being accessed. EnvelopesApi.DeleteDocumentFieldsOptions Options for modifying the method behavior.
    
    Returns:
    DocumentFieldsInformation
    
    Throws:
    
    ApiException
  - deleteDocumentPage
```
public void deleteDocumentPage(String accountId,
                      String envelopeId,
                      String documentId,
                      String pageNumber)
                        throws ApiException
```
    Deletes a page from a document in an envelope. Deletes a page from a document in an envelope based on the page number.
    
    Parameters:
    accountId - The external account number (int) or account ID Guid.
    envelopeId - The envelopeId Guid of the envelope being accessed.
    documentId - The ID of the document being accessed.
    pageNumber - The page number being accessed. EnvelopesApi.DeleteDocumentPageOptions Options for modifying the method behavior.
    
    Throws:
    
    ApiException
  - listTemplatesForDocument
```
public TemplateInformation listTemplatesForDocument(String accountId,
                                           String envelopeId,
                                           String documentId)
                                             throws ApiException
```
    Gets the templates associated with a document in an existing envelope. Retrieves the templates associated with a document in the specified envelope.
    
    Parameters:
    accountId - The external account number (int) or account ID Guid.
    envelopeId - The envelopeId Guid of the envelope being accessed.
    documentId - The ID of the document being accessed. EnvelopesApi.ListTemplatesForDocumentOptions Options for modifying the method behavior.
    
    Returns:
    TemplateInformation
    
    Throws:
    
    ApiException
  - applyTemplateToDocument
```
public DocumentTemplateList applyTemplateToDocument(String accountId,
                                           String envelopeId,
                                           String documentId,
                                           DocumentTemplateList documentTemplateList)
                                             throws ApiException
```
    Adds templates to a document in an envelope. Adds templates to a document in the specified envelope.
    
    Parameters:
    accountId - The external account number (int) or account ID Guid.
    envelopeId - The envelopeId Guid of the envelope being accessed.
    documentId - The ID of the document being accessed. EnvelopesApi.ApplyTemplateToDocumentOptions Options for modifying the method behavior.
    
    Returns:
    DocumentTemplateList
    
    Throws:
    
    ApiException
  - deleteTemplatesFromDocument
```
public void deleteTemplatesFromDocument(String accountId,
                               String envelopeId,
                               String documentId,
                               String templateId)
                                 throws ApiException
```
    Deletes a template from a document in an existing envelope. Deletes the specified template from a document in an existing envelope.
    
    Parameters:
    accountId - The external account number (int) or account ID Guid.
    envelopeId - The envelopeId Guid of the envelope being accessed.
    documentId - The ID of the document being accessed.
    templateId - The ID of the template being accessed. EnvelopesApi.DeleteTemplatesFromDocumentOptions Options for modifying the method behavior.
    
    Throws:
    
    ApiException
  - getEmailSettings
```
public EmailSettings getEmailSettings(String accountId,
                             String envelopeId)
                               throws ApiException
```
    Gets the email setting overrides for an envelope. Retrieves the email override settings for the specified envelope.
    
    Parameters:
    accountId - The external account number (int) or account ID Guid.
    envelopeId - The envelopeId Guid of the envelope being accessed. EnvelopesApi.GetEmailSettingsOptions Options for modifying the method behavior.
    
    Returns:
    EmailSettings
    
    Throws:
    
    ApiException
  - updateEmailSettings
```
public EmailSettings updateEmailSettings(String accountId,
                                String envelopeId,
                                EmailSettings emailSettings)
                                  throws ApiException
```
    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.\n\nThis can also be used to delete an individual email override setting by using an empty string for the value to be deleted.
    
    Parameters:
    accountId - The external account number (int) or account ID Guid.
    envelopeId - The envelopeId Guid of the envelope being accessed. EnvelopesApi.UpdateEmailSettingsOptions Options for modifying the method behavior.
    
    Returns:
    EmailSettings
    
    Throws:
    
    ApiException
  - createEmailSettings
```
public EmailSettings createEmailSettings(String accountId,
                                String envelopeId,
                                EmailSettings emailSettings)
                                  throws ApiException
```
    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.\n\n### 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.
    
    Parameters:
    accountId - The external account number (int) or account ID Guid.
    envelopeId - The envelopeId Guid of the envelope being accessed. EnvelopesApi.CreateEmailSettingsOptions Options for modifying the method behavior.
    
    Returns:
    EmailSettings
    
    Throws:
    
    ApiException
  - deleteEmailSettings
```
public EmailSettings deleteEmailSettings(String accountId,
                                String envelopeId)
                                  throws ApiException
```
    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.
    
    Parameters:
    accountId - The external account number (int) or account ID Guid.
    envelopeId - The envelopeId Guid of the envelope being accessed. EnvelopesApi.DeleteEmailSettingsOptions Options for modifying the method behavior.
    
    Returns:
    EmailSettings
    
    Throws:
    
    ApiException
  - getLock
```
public LockInformation getLock(String accountId,
                      String envelopeId)
                        throws ApiException
```
    Gets envelope lock information. Retrieves general information about the envelope lock.\n\nIf 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.
    
    Parameters:
    accountId - The external account number (int) or account ID Guid.
    envelopeId - The envelopeId Guid of the envelope being accessed. EnvelopesApi.GetLockOptions Options for modifying the method behavior.
    
    Returns:
    LockInformation
    
    Throws:
    
    ApiException
  - updateLock
```
public LockInformation updateLock(String accountId,
                         String envelopeId,
                         LockRequest lockRequest)
                           throws ApiException
```
    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.
    
    Parameters:
    accountId - The external account number (int) or account ID Guid.
    envelopeId - The envelopeId Guid of the envelope being accessed. EnvelopesApi.UpdateLockOptions Options for modifying the method behavior.
    
    Returns:
    LockInformation
    
    Throws:
    
    ApiException
  - createLock
```
public LockInformation createLock(String accountId,
                         String envelopeId,
                         LockRequest lockRequest)
                           throws ApiException
```
    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.\n\nNote: Users must have envelope locking capability enabled to use this function (userSetting `canLockEnvelopes` must be set to true for the user).
    
    Parameters:
    accountId - The external account number (int) or account ID Guid.
    envelopeId - The envelopeId Guid of the envelope being accessed. EnvelopesApi.CreateLockOptions Options for modifying the method behavior.
    
    Returns:
    LockInformation
    
    Throws:
    
    ApiException
  - deleteLock
```
public LockInformation deleteLock(String accountId,
                         String envelopeId)
                           throws ApiException
```
    Deletes an envelope lock. Deletes the lock from the specified envelope. The `X-DocuSign-Edit` header must be included in the request.
    
    Parameters:
    accountId - The external account number (int) or account ID Guid.
    envelopeId - The envelopeId Guid of the envelope being accessed. EnvelopesApi.DeleteLockOptions Options for modifying the method behavior.
    
    Returns:
    LockInformation
    
    Throws:
    
    ApiException
  - getNotificationSettings
```
public Notification getNotificationSettings(String accountId,
                                   String envelopeId)
                                     throws ApiException
```
    Gets envelope notification information. Retrieves the envelope notification, reminders and expirations, information for an existing envelope.
    
    Parameters:
    accountId - The external account number (int) or account ID Guid.
    envelopeId - The envelopeId Guid of the envelope being accessed. EnvelopesApi.GetNotificationSettingsOptions Options for modifying the method behavior.
    
    Returns:
    Notification
    
    Throws:
    
    ApiException
  - listRecipients
```
public Recipients listRecipients(String accountId,
                        String envelopeId)
                          throws ApiException
```
    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. \n\nThe `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.
    
    Parameters:
    accountId - The external account number (int) or account ID Guid.
    envelopeId - The envelopeId Guid of the envelope being accessed. EnvelopesApi.ListRecipientsOptions Options for modifying the method behavior.
    
    Returns:
    Recipients
    
    Throws:
    
    ApiException
  - updateRecipients
```
public RecipientsUpdateSummary updateRecipients(String accountId,
                                       String envelopeId,
                                       Recipients recipients)
                                         throws ApiException
```
    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. \n\nFor draft envelopes, you can edit the following properties: `email`, `userName`, `routingOrder`, `faxNumber`, `deliveryMethod`, `accessCode`, and `requireIdLookup`.\n\nOnce 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.\n\nIf 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).
    
    Parameters:
    accountId - The external account number (int) or account ID Guid.
    envelopeId - The envelopeId Guid of the envelope being accessed. EnvelopesApi.UpdateRecipientsOptions Options for modifying the method behavior.
    
    Returns:
    RecipientsUpdateSummary
    
    Throws:
    
    ApiException
  - createRecipient
```
public Recipients createRecipient(String accountId,
                         String envelopeId,
                         Recipients recipients)
                           throws ApiException
```
    Adds one or more recipients to an envelope. Adds one or more recipients to an envelope.\n\nFor 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**.
    
    Parameters:
    accountId - The external account number (int) or account ID Guid.
    envelopeId - The envelopeId Guid of the envelope being accessed. EnvelopesApi.CreateRecipientOptions Options for modifying the method behavior.
    
    Returns:
    Recipients
    
    Throws:
    
    ApiException
  - deleteRecipients
```
public Recipients deleteRecipients(String accountId,
                          String envelopeId,
                          Recipients recipients)
                            throws ApiException
```
    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.\n\nIf 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.
    
    Parameters:
    accountId - The external account number (int) or account ID Guid.
    envelopeId - The envelopeId Guid of the envelope being accessed. EnvelopesApi.DeleteRecipientsOptions Options for modifying the method behavior.
    
    Returns:
    Recipients
    
    Throws:
    
    ApiException
  - deleteRecipient
```
public Recipients deleteRecipient(String accountId,
                         String envelopeId,
                         String recipientId)
                           throws ApiException
```
    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.
    
    Parameters:
    accountId - The external account number (int) or account ID Guid.
    envelopeId - The envelopeId Guid of the envelope being accessed.
    recipientId - The ID of the recipient being accessed. EnvelopesApi.DeleteRecipientOptions Options for modifying the method behavior.
    
    Returns:
    Recipients
    
    Throws:
    
    ApiException
  - listTabs
```
public Tabs listTabs(String accountId,
            String envelopeId,
            String recipientId)
              throws ApiException
```
    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.
    
    Parameters:
    accountId - The external account number (int) or account ID Guid.
    envelopeId - The envelopeId Guid of the envelope being accessed.
    recipientId - The ID of the recipient being accessed. EnvelopesApi.ListTabsOptions Options for modifying the method behavior.
    
    Returns:
    Tabs
    
    Throws:
    
    ApiException
  - updateTabs
```
public Tabs updateTabs(String accountId,
              String envelopeId,
              String recipientId,
              Tabs tabs)
                throws ApiException
```
    Updates the tabs for a recipient. Updates one or more tabs for a recipient in a draft envelope.
    
    Parameters:
    accountId - The external account number (int) or account ID Guid.
    envelopeId - The envelopeId Guid of the envelope being accessed.
    recipientId - The ID of the recipient being accessed. EnvelopesApi.UpdateTabsOptions Options for modifying the method behavior.
    
    Returns:
    Tabs
    
    Throws:
    
    ApiException
  - createTabs
```
public Tabs createTabs(String accountId,
              String envelopeId,
              String recipientId,
              Tabs tabs)
                throws ApiException
```
    Adds tabs for a recipient. Adds one or more tabs for a recipient.
    
    Parameters:
    accountId - The external account number (int) or account ID Guid.
    envelopeId - The envelopeId Guid of the envelope being accessed.
    recipientId - The ID of the recipient being accessed. EnvelopesApi.CreateTabsOptions Options for modifying the method behavior.
    
    Returns:
    Tabs
    
    Throws:
    
    ApiException
  - deleteTabs
```
public Tabs deleteTabs(String accountId,
              String envelopeId,
              String recipientId,
              Tabs tabs)
                throws ApiException
```
    Deletes the tabs associated with a recipient. Deletes one or more tabs associated with a recipient in a draft envelope.
    
    Parameters:
    accountId - The external account number (int) or account ID Guid.
    envelopeId - The envelopeId Guid of the envelope being accessed.
    recipientId - The ID of the recipient being accessed. EnvelopesApi.DeleteTabsOptions Options for modifying the method behavior.
    
    Returns:
    Tabs
    
    Throws:
    
    ApiException
  - listTemplates
```
public TemplateInformation listTemplates(String accountId,
                                String envelopeId)
                                  throws ApiException
```
    Get List of Templates used in an Envelope This returns a list of the templates, name and ID, used in an envelope.<br/><br/>Note: This only returns information for server side templates.
    
    Parameters:
    accountId - The external account number (int) or account ID Guid.
    envelopeId - The envelopeId Guid of the envelope being accessed. EnvelopesApi.ListTemplatesOptions Options for modifying the method behavior.
    
    Returns:
    TemplateInformation
    
    Throws:
    
    ApiException
  - applyTemplate
```
public DocumentTemplateList applyTemplate(String accountId,
                                 String envelopeId,
                                 DocumentTemplateList documentTemplateList)
                                   throws ApiException
```
    Adds templates to an envelope. Adds templates to the specified envelope.
    
    Parameters:
    accountId - The external account number (int) or account ID Guid.
    envelopeId - The envelopeId Guid of the envelope being accessed. EnvelopesApi.ApplyTemplateOptions Options for modifying the method behavior.
    
    Returns:
    DocumentTemplateList
    
    Throws:
    
    ApiException
  - createCorrectView
```
public ViewUrl createCorrectView(String accountId,
                        String envelopeId,
                        CorrectViewRequest correctViewRequest)
                          throws ApiException
```
    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.\n\nImportant: iFrames should not be used for embedded operations on mobile devices due to screen space issues. For iOS devices DocuSign recommends using a WebView.
    
    Parameters:
    accountId - The external account number (int) or account ID Guid.
    envelopeId - The envelopeId Guid of the envelope being accessed. EnvelopesApi.CreateCorrectViewOptions Options for modifying the method behavior.
    
    Returns:
    ViewUrl
    
    Throws:
    
    ApiException
  - createEditView
```
public ViewUrl createEditView(String accountId,
                     String envelopeId,
                     ReturnUrlRequest returnUrlRequest)
                       throws ApiException
```
    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. \n\nUpon sending completion, the user is returned to the return URL provided by the API application.\n\nImportant: iFrames should not be used for embedded operations on mobile devices due to screen space issues. For iOS devices DocuSign recommends using a WebView.
    
    Parameters:
    accountId - The external account number (int) or account ID Guid.
    envelopeId - The envelopeId Guid of the envelope being accessed. EnvelopesApi.CreateEditViewOptions Options for modifying the method behavior.
    
    Returns:
    ViewUrl
    
    Throws:
    
    ApiException
  - createRecipientView
```
public ViewUrl createRecipientView(String accountId,
                          String envelopeId,
                          RecipientViewRequest recipientViewRequest)
                            throws ApiException
```
    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. \n\nImportant: iFrames should not be used for embedded operations on mobile devices due to screen space issues. For iOS devices DocuSign recommends using a WebView. \n\nAn 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.
    
    Parameters:
    accountId - The external account number (int) or account ID Guid.
    envelopeId - The envelopeId Guid of the envelope being accessed. EnvelopesApi.CreateRecipientViewOptions Options for modifying the method behavior.
    
    Returns:
    ViewUrl
    
    Throws:
    
    ApiException
  - createSenderView
```
public ViewUrl createSenderView(String accountId,
                       String envelopeId,
                       ReturnUrlRequest returnUrlRequest)
                         throws ApiException
```
    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. \n\nUpon sending completion, the user is returned to the return URL provided by the API application.\n\nImportant: iFrames should not be used for embedded operations on mobile devices due to screen space issues. For iOS devices DocuSign recommends using a WebView.
    
    Parameters:
    accountId - The external account number (int) or account ID Guid.
    envelopeId - The envelopeId Guid of the envelope being accessed. EnvelopesApi.CreateSenderViewOptions Options for modifying the method behavior.
    
    Returns:
    ViewUrl
    
    Throws:
    
    ApiException
  - createViewLink
```
public ViewUrl createViewLink(String accountId,
                     String envelopeId,
                     ViewLinkRequest viewLinkRequest)
                       throws ApiException
```
    Reserved: Returns a URL to the secure link view UI. Reserved: Returns a URL that allows you to embed the secure link view of the DocuSign UI in your applications.
    
    Parameters:
    accountId - The external account number (int) or account ID Guid.
    envelopeId - The envelopeId Guid of the envelope being accessed. EnvelopesApi.CreateViewLinkOptions Options for modifying the method behavior.
    
    Returns:
    ViewUrl
    
    Throws:
    
    ApiException
  - deleteViewLink
```
public void deleteViewLink(String accountId,
                  String envelopeId)
                    throws ApiException
```
    Reserved: Expires a secure view link. Reserved: Expires a secure view link
    
    Parameters:
    accountId - The external account number (int) or account ID Guid.
    envelopeId - The envelopeId Guid of the envelope being accessed. EnvelopesApi.DeleteViewLinkOptions Options for modifying the method behavior.
    
    Throws:
    
    ApiException
  - createConsoleView
```
public ViewUrl createConsoleView(String accountId,
                        ConsoleViewRequest consoleViewRequest)
                          throws ApiException
```
    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.
    
    Parameters:
    accountId - The external account number (int) or account ID Guid. EnvelopesApi.CreateConsoleViewOptions Options for modifying the method behavior.
    
    Returns:
    ViewUrl
    
    Throws:
    
    ApiException

Class EnvelopesApi

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

EnvelopesApi

EnvelopesApi

Method Detail

getApiClient

setApiClient

listStatusChanges

listStatusChanges

createEnvelope

createEnvelope

listStatus

getEnvelope

getEnvelope

update

update

listAuditEvents

listCustomFields

updateCustomFields

createCustomFields

deleteCustomFields

listDocuments

updateDocuments

deleteDocuments

getDocument

listDocumentFields

updateDocumentFields

createDocumentFields

deleteDocumentFields

deleteDocumentPage

listTemplatesForDocument

applyTemplateToDocument

deleteTemplatesFromDocument

getEmailSettings

updateEmailSettings

createEmailSettings

deleteEmailSettings

getLock

updateLock

createLock

deleteLock

getNotificationSettings

listRecipients

updateRecipients

createRecipient

deleteRecipients

deleteRecipient

listTabs

updateTabs

createTabs

deleteTabs

listTemplates

applyTemplate

createCorrectView

createEditView

createRecipientView

createSenderView

createViewLink

deleteViewLink

createConsoleView