com.docusign.esign.api

Class TemplatesApi

java.lang.Object

com.docusign.esign.api.TemplatesApi

public class TemplatesApi
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	TemplatesApi.UpdateDocumentsOptions

Constructor Summary

Constructors

Constructor and Description
TemplatesApi()
TemplatesApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method and Description
CustomFields	createCustomFields(String accountId, String templateId, TemplateCustomFields templateCustomFields) Creates custom document fields in an existing template document.
DocumentFieldsInformation	createDocumentFields(String accountId, String templateId, String documentId, DocumentFieldsInformation documentFieldsInformation) Creates custom document fields in an existing template document.
Recipients	createRecipients(String accountId, String templateId, TemplateRecipients templateRecipients) Adds tabs for a recipient.
Tabs	createTabs(String accountId, String templateId, String recipientId, TemplateTabs templateTabs) Adds tabs for a recipient.
TemplateSummary	createTemplate(String accountId, EnvelopeTemplate envelopeTemplate) Creates an envelope from a template.
CustomFields	deleteCustomFields(String accountId, String templateId, TemplateCustomFields templateCustomFields) Deletes envelope custom fields in a template.
DocumentFieldsInformation	deleteDocumentFields(String accountId, String templateId, String documentId, DocumentFieldsInformation documentFieldsInformation) Deletes custom document fields from an existing template document.
void	deleteDocumentPage(String accountId, String templateId, String documentId, String pageNumber, PageRequest pageRequest) Deletes a page from a document in an template.
TemplateDocumentsResult	deleteDocuments(String accountId, String templateId, EnvelopeDefinition envelopeDefinition) Deletes documents from a template.
GroupInformation	deleteGroupShare(String accountId, String templateId, String templatePart, GroupInformation groupInformation) Removes a member group's sharing permissions for a template.
Recipients	deleteRecipient(String accountId, String templateId, String recipientId, TemplateRecipients templateRecipients) Deletes the specified recipient file from a template.
Recipients	deleteRecipients(String accountId, String templateId, TemplateRecipients templateRecipients) Deletes recipients from a template.
Tabs	deleteTabs(String accountId, String templateId, String recipientId, TemplateTabs templateTabs) Deletes the tabs associated with a recipient in a template.
EnvelopeTemplate	get(String accountId, String templateId) Gets a list of templates for a specified account.
ApiClient	getApiClient()
byte[]	getDocument(String accountId, String templateId, String documentId) Gets PDF documents from a template.
LockInformation	getLock(String accountId, String templateId) Gets template lock information.
Notification	getNotificationSettings(String accountId, String templateId) Gets template notification information.
CustomFields	listCustomFields(String accountId, String templateId) Gets the custom document fields from a template.
DocumentFieldsInformation	listDocumentFields(String accountId, String templateId, String documentId) Gets the custom document fields for a an existing template document.
TemplateDocumentsResult	listDocuments(String accountId, String templateId) Gets a list of documents associated with a template.
Recipients	listRecipients(String accountId, String templateId) Gets recipient information from a template.
Tabs	listTabs(String accountId, String templateId, String recipientId, Tabs tabs) Gets the tabs information for a signer or sign-in-person recipient in a template.
EnvelopeTemplateResults	listTemplates(String accountId) Gets the definition of a template.
void	setApiClient(ApiClient apiClient)
TemplateUpdateSummary	update(String accountId, String templateId, EnvelopeTemplate envelopeTemplate) Updates an existing template.
CustomFields	updateCustomFields(String accountId, String templateId, TemplateCustomFields templateCustomFields) Updates envelope custom fields in a template.
DocumentFieldsInformation	updateDocumentFields(String accountId, String templateId, String documentId, DocumentFieldsInformation documentFieldsInformation) Updates existing custom document fields in an existing template document.
TemplateDocumentsResult	updateDocuments(String accountId, String templateId, EnvelopeDefinition envelopeDefinition) Adds documents to a template document.
TemplateDocumentsResult	updateDocuments(String accountId, String templateId, EnvelopeDefinition envelopeDefinition, TemplatesApi.UpdateDocumentsOptions options) Adds documents to a template document.
GroupInformation	updateGroupShare(String accountId, String templateId, String templatePart, GroupInformation groupInformation) Shares a template with a group Shares a template with the specified members group.
Notification	updateNotificationSettings(String accountId, String templateId, TemplateNotificationRequest templateNotificationRequest) Updates the notification structure for an existing template.
RecipientsUpdateSummary	updateRecipients(String accountId, String templateId, TemplateRecipients templateRecipients) Updates recipients in a template.
Tabs	updateTabs(String accountId, String templateId, String recipientId, TemplateTabs templateTabs) 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

TemplatesApi

public TemplatesApi()

TemplatesApi

public TemplatesApi(ApiClient apiClient)

Method Detail

getApiClient

public ApiClient getApiClient()

setApiClient

public void setApiClient(ApiClient apiClient)

createCustomFields

public CustomFields createCustomFields(String accountId,
                                       String templateId,
                                       TemplateCustomFields templateCustomFields)
                                throws ApiException

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

Parameters:

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

templateId - The ID of the template being accessed. TemplatesApi.CreateCustomFieldsOptions Options for modifying the method behavior.

Returns:

CustomFields

Throws:

ApiException - if fails to make API call

createDocumentFields

public DocumentFieldsInformation createDocumentFields(String accountId,
                                                      String templateId,
                                                      String documentId,
                                                      DocumentFieldsInformation documentFieldsInformation)
                                               throws ApiException

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

Parameters:

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

templateId - The ID of the template being accessed.

documentId - The ID of the document being accessed. TemplatesApi.CreateDocumentFieldsOptions Options for modifying the method behavior.

Returns:

DocumentFieldsInformation

Throws:

ApiException - if fails to make API call

createRecipients

public Recipients createRecipients(String accountId,
                                   String templateId,
                                   TemplateRecipients templateRecipients)
                            throws ApiException

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

Parameters:

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

templateId - The ID of the template being accessed. TemplatesApi.CreateRecipientsOptions Options for modifying the method behavior.

Returns:

Recipients

Throws:

ApiException - if fails to make API call

createTabs

public Tabs createTabs(String accountId,
                       String templateId,
                       String recipientId,
                       TemplateTabs templateTabs)
                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.

templateId - The ID of the template being accessed.

recipientId - The ID of the recipient being accessed. TemplatesApi.CreateTabsOptions Options for modifying the method behavior.

Returns:

Tabs

Throws:

ApiException - if fails to make API call

createTemplate

public TemplateSummary createTemplate(String accountId,
                                      EnvelopeTemplate envelopeTemplate)
                               throws ApiException

Creates an envelope from a template. Creates a template definition using a multipart request.\n\n###Template Email Subject Merge Fields\n\nCall this endpoint to insert a 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 role name, are added to the `emailSubject` property when the template is created or when the template is used to create an envelope. After a template sender adds the name and email information for the recipient and sends the envelope, the recipient information is automatically merged into the appropriate fields in the email subject line.\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###### Note: If merging the recipient information into the subject line causes the subject line to exceed 100 characters, then any characters over the 100 character limit are not included in the subject line. For cases where the recipient name or email is expected to be long, you should consider placing the merge field at the start of the email subject.\n\nTo add a recipient’s name in the subject line add the following text in the `emailSubject` property when creating the template or when sending an envelope from a template:\n\n[[<roleName>_UserName]]\n\nExample:\n\n`\"emailSubject\":\"[[Signer 1_UserName]], Please sign this NDA\",`\n\nTo add a recipient’s email address in the subject line add the following text in the `emailSubject` property when creating the template or when sending an envelope from a template:\n\n[[<roleName>_Email]]\n\nExample:\n\n`\"emailSubject\":\"[[Signer 1_Email]], Please sign this NDA\",`\n\n\nIn both cases the <roleName> is the recipient's contents of the `roleName` property 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.

Parameters:

accountId - The external account number (int) or account ID Guid. TemplatesApi.CreateTemplateOptions Options for modifying the method behavior.

Returns:

TemplateSummary

Throws:

ApiException - if fails to make API call

deleteCustomFields

public CustomFields deleteCustomFields(String accountId,
                                       String templateId,
                                       TemplateCustomFields templateCustomFields)
                                throws ApiException

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

Parameters:

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

templateId - The ID of the template being accessed. TemplatesApi.DeleteCustomFieldsOptions Options for modifying the method behavior.

Returns:

CustomFields

Throws:

ApiException - if fails to make API call

deleteDocumentFields

public DocumentFieldsInformation deleteDocumentFields(String accountId,
                                                      String templateId,
                                                      String documentId,
                                                      DocumentFieldsInformation documentFieldsInformation)
                                               throws ApiException

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

Parameters:

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

templateId - The ID of the template being accessed.

documentId - The ID of the document being accessed. TemplatesApi.DeleteDocumentFieldsOptions Options for modifying the method behavior.

Returns:

DocumentFieldsInformation

Throws:

ApiException - if fails to make API call

deleteDocumentPage

public void deleteDocumentPage(String accountId,
                               String templateId,
                               String documentId,
                               String pageNumber,
                               PageRequest pageRequest)
                        throws ApiException

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

Parameters:

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

templateId - The ID of the template being accessed.

documentId - The ID of the document being accessed.

pageNumber - The page number being accessed. TemplatesApi.DeleteDocumentPageOptions Options for modifying the method behavior.

Throws:

ApiException - if fails to make API call

deleteDocuments

public TemplateDocumentsResult deleteDocuments(String accountId,
                                               String templateId,
                                               EnvelopeDefinition envelopeDefinition)
                                        throws ApiException

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

Parameters:

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

templateId - The ID of the template being accessed. TemplatesApi.DeleteDocumentsOptions Options for modifying the method behavior.

Returns:

TemplateDocumentsResult

Throws:

ApiException - if fails to make API call

deleteGroupShare

public GroupInformation deleteGroupShare(String accountId,
                                         String templateId,
                                         String templatePart,
                                         GroupInformation groupInformation)
                                  throws ApiException

Removes a member group's sharing permissions for a template. Removes a member group's sharing permissions for a specified template.

Parameters:

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

templateId - The ID of the template being accessed.

templatePart - Currently, the only defined part is **groups**. TemplatesApi.DeleteGroupShareOptions Options for modifying the method behavior.

Returns:

GroupInformation

Throws:

ApiException - if fails to make API call

deleteRecipient

public Recipients deleteRecipient(String accountId,
                                  String templateId,
                                  String recipientId,
                                  TemplateRecipients templateRecipients)
                           throws ApiException

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

Parameters:

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

templateId - The ID of the template being accessed.

recipientId - The ID of the recipient being accessed. TemplatesApi.DeleteRecipientOptions Options for modifying the method behavior.

Returns:

Recipients

Throws:

ApiException - if fails to make API call

deleteRecipients

public Recipients deleteRecipients(String accountId,
                                   String templateId,
                                   TemplateRecipients templateRecipients)
                            throws ApiException

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

Parameters:

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

templateId - The ID of the template being accessed. TemplatesApi.DeleteRecipientsOptions Options for modifying the method behavior.

Returns:

Recipients

Throws:

ApiException - if fails to make API call

deleteTabs

public Tabs deleteTabs(String accountId,
                       String templateId,
                       String recipientId,
                       TemplateTabs templateTabs)
                throws ApiException

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

Parameters:

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

templateId - The ID of the template being accessed.

recipientId - The ID of the recipient being accessed. TemplatesApi.DeleteTabsOptions Options for modifying the method behavior.

Returns:

Tabs

Throws:

ApiException - if fails to make API call

get

public EnvelopeTemplate get(String accountId,
                            String templateId)
                     throws ApiException

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

Parameters:

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

templateId - The ID of the template being accessed. TemplatesApi.GetOptions Options for modifying the method behavior.

Returns:

EnvelopeTemplate

Throws:

ApiException - if fails to make API call

getDocument

public byte[] getDocument(String accountId,
                          String templateId,
                          String documentId)
                   throws ApiException

Gets PDF documents from a template. Retrieves one or more PDF documents from the specified template.\n\nYou can specify the ID of the document to retrieve or can specify `combined` to retrieve all documents in the template as one pdf.

Parameters:

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

templateId - The ID of the template being accessed.

documentId - The ID of the document being accessed. TemplatesApi.GetDocumentOptions Options for modifying the method behavior.

Returns:

byte[]

Throws:

ApiException - if fails to make API call

getLock

public LockInformation getLock(String accountId,
                               String templateId)
                        throws ApiException

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

Parameters:

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

templateId - The ID of the template being accessed. TemplatesApi.GetLockOptions Options for modifying the method behavior.

Returns:

LockInformation

Throws:

ApiException - if fails to make API call

getNotificationSettings

public Notification getNotificationSettings(String accountId,
                                            String templateId)
                                     throws ApiException

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

Parameters:

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

templateId - The ID of the template being accessed. TemplatesApi.GetNotificationSettingsOptions Options for modifying the method behavior.

Returns:

Notification

Throws:

ApiException - if fails to make API call

listCustomFields

public CustomFields listCustomFields(String accountId,
                                     String templateId)
                              throws ApiException

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

Parameters:

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

templateId - The ID of the template being accessed. TemplatesApi.ListCustomFieldsOptions Options for modifying the method behavior.

Returns:

CustomFields

Throws:

ApiException - if fails to make API call

listDocumentFields

public DocumentFieldsInformation listDocumentFields(String accountId,
                                                    String templateId,
                                                    String documentId)
                                             throws ApiException

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

Parameters:

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

templateId - The ID of the template being accessed.

documentId - The ID of the document being accessed. TemplatesApi.ListDocumentFieldsOptions Options for modifying the method behavior.

Returns:

DocumentFieldsInformation

Throws:

ApiException - if fails to make API call

listDocuments

public TemplateDocumentsResult listDocuments(String accountId,
                                             String templateId)
                                      throws ApiException

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

Parameters:

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

templateId - The ID of the template being accessed. TemplatesApi.ListDocumentsOptions Options for modifying the method behavior.

Returns:

TemplateDocumentsResult

Throws:

ApiException - if fails to make API call

listRecipients

public Recipients listRecipients(String accountId,
                                 String templateId)
                          throws ApiException

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

Parameters:

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

templateId - The ID of the template being accessed. TemplatesApi.ListRecipientsOptions Options for modifying the method behavior.

Returns:

Recipients

Throws:

ApiException - if fails to make API call

listTabs

public Tabs listTabs(String accountId,
                     String templateId,
                     String recipientId,
                     Tabs tabs)
              throws ApiException

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

Parameters:

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

templateId - The ID of the template being accessed.

recipientId - The ID of the recipient being accessed. TemplatesApi.ListTabsOptions Options for modifying the method behavior.

Returns:

Tabs

Throws:

ApiException - if fails to make API call

listTemplates

public EnvelopeTemplateResults listTemplates(String accountId)
                                      throws ApiException

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

Parameters:

accountId - The external account number (int) or account ID Guid. TemplatesApi.ListTemplatesOptions Options for modifying the method behavior.

Returns:

EnvelopeTemplateResults

Throws:

ApiException - if fails to make API call

update

public TemplateUpdateSummary update(String accountId,
                                    String templateId,
                                    EnvelopeTemplate envelopeTemplate)
                             throws ApiException

Updates an existing template. Updates an existing template.

Parameters:

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

templateId - The ID of the template being accessed. TemplatesApi.UpdateOptions Options for modifying the method behavior.

Returns:

TemplateUpdateSummary

Throws:

ApiException - if fails to make API call

updateCustomFields

public CustomFields updateCustomFields(String accountId,
                                       String templateId,
                                       TemplateCustomFields templateCustomFields)
                                throws ApiException

Updates envelope custom fields in a template. Updates the custom fields in a template.\n\nEach custom field used in a template must have a unique name.

Parameters:

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

templateId - The ID of the template being accessed. TemplatesApi.UpdateCustomFieldsOptions Options for modifying the method behavior.

Returns:

CustomFields

Throws:

ApiException - if fails to make API call

updateDocumentFields

public DocumentFieldsInformation updateDocumentFields(String accountId,
                                                      String templateId,
                                                      String documentId,
                                                      DocumentFieldsInformation documentFieldsInformation)
                                               throws ApiException

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

Parameters:

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

templateId - The ID of the template being accessed.

documentId - The ID of the document being accessed. TemplatesApi.UpdateDocumentFieldsOptions Options for modifying the method behavior.

Returns:

DocumentFieldsInformation

Throws:

ApiException - if fails to make API call

updateDocuments

public TemplateDocumentsResult updateDocuments(String accountId,
                                               String templateId,
                                               EnvelopeDefinition envelopeDefinition)
                                        throws ApiException

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

Parameters:

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

templateId - The ID of the template being accessed.

Returns:

TemplateDocumentsResult

Throws:

ApiException

updateDocuments

public TemplateDocumentsResult updateDocuments(String accountId,
                                               String templateId,
                                               EnvelopeDefinition envelopeDefinition,
                                               TemplatesApi.UpdateDocumentsOptions options)
                                        throws ApiException

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

Parameters:

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

templateId - The ID of the template being accessed. TemplatesApi.UpdateDocumentsOptions Options for modifying the method behavior.

Returns:

TemplateDocumentsResult

Throws:

ApiException - if fails to make API call

updateGroupShare

public GroupInformation updateGroupShare(String accountId,
                                         String templateId,
                                         String templatePart,
                                         GroupInformation groupInformation)
                                  throws ApiException

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

Parameters:

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

templateId - The ID of the template being accessed.

templatePart - Currently, the only defined part is **groups**. TemplatesApi.UpdateGroupShareOptions Options for modifying the method behavior.

Returns:

GroupInformation

Throws:

ApiException - if fails to make API call

updateNotificationSettings

public Notification updateNotificationSettings(String accountId,
                                               String templateId,
                                               TemplateNotificationRequest templateNotificationRequest)
                                        throws ApiException

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

Parameters:

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

templateId - The ID of the template being accessed. TemplatesApi.UpdateNotificationSettingsOptions Options for modifying the method behavior.

Returns:

Notification

Throws:

ApiException - if fails to make API call

updateRecipients

public RecipientsUpdateSummary updateRecipients(String accountId,
                                                String templateId,
                                                TemplateRecipients templateRecipients)
                                         throws ApiException

Updates recipients in a template. Updates recipients in a template. \n\nYou can edit the following properties: `email`, `userName`, `routingOrder`, `faxNumber`, `deliveryMethod`, `accessCode`, and `requireIdLookup`.

Parameters:

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

templateId - The ID of the template being accessed. TemplatesApi.UpdateRecipientsOptions Options for modifying the method behavior.

Returns:

RecipientsUpdateSummary

Throws:

ApiException - if fails to make API call

updateTabs

public Tabs updateTabs(String accountId,
                       String templateId,
                       String recipientId,
                       TemplateTabs templateTabs)
                throws ApiException

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

Parameters:

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

templateId - The ID of the template being accessed.

recipientId - The ID of the recipient being accessed. TemplatesApi.UpdateTabsOptions Options for modifying the method behavior.

Returns:

Tabs

Throws:

ApiException - if fails to make API call