public class TemplatesApi extends Object
| Modifier and Type | Class and Description |
|---|---|
class |
TemplatesApi.CreateRecipientsOptions |
class |
TemplatesApi.GetDocumentOptions |
class |
TemplatesApi.GetDocumentPageImageOptions |
class |
TemplatesApi.GetOptions |
class |
TemplatesApi.ListBulkRecipientsOptions |
class |
TemplatesApi.ListRecipientsOptions |
class |
TemplatesApi.ListTabsOptions |
class |
TemplatesApi.ListTemplatesOptions |
class |
TemplatesApi.UpdateDocumentOptions |
class |
TemplatesApi.UpdateDocumentsOptions |
class |
TemplatesApi.UpdateRecipientsOptions |
| Constructor and Description |
|---|
TemplatesApi() |
TemplatesApi(ApiClient apiClient) |
| 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.
|
ViewUrl |
createEditView(String accountId,
String templateId,
ReturnUrlRequest returnUrlRequest)
Provides a URL to start an edit view of the Template UI
|
LockInformation |
createLock(String accountId,
String templateId,
LockRequest lockRequest)
Lock a template.
|
Recipients |
createRecipients(String accountId,
String templateId,
TemplateRecipients templateRecipients)
Adds tabs for a recipient.
|
Recipients |
createRecipients(String accountId,
String templateId,
TemplateRecipients templateRecipients,
TemplatesApi.CreateRecipientsOptions options)
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.
|
BulkRecipientsUpdateResponse |
deleteBulkRecipients(String accountId,
String templateId,
String recipientId)
Deletes the bulk recipient list on 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.
|
LockInformation |
deleteLock(String accountId,
String templateId,
LockRequest lockRequest)
Deletes a template lock.
|
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.
|
EnvelopeTemplate |
get(String accountId,
String templateId,
TemplatesApi.GetOptions options)
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.
|
byte[] |
getDocument(String accountId,
String templateId,
String documentId,
TemplatesApi.GetDocumentOptions options)
Gets PDF documents from a template.
|
byte[] |
getDocumentPageImage(String accountId,
String templateId,
String documentId,
String pageNumber)
Gets a page image from a template for display.
|
byte[] |
getDocumentPageImage(String accountId,
String templateId,
String documentId,
String pageNumber,
TemplatesApi.GetDocumentPageImageOptions options)
Gets a page image from a template for display.
|
LockInformation |
getLock(String accountId,
String templateId)
Gets template lock information.
|
Notification |
getNotificationSettings(String accountId,
String templateId)
Gets template notification information.
|
BulkRecipientsResponse |
listBulkRecipients(String accountId,
String templateId,
String recipientId)
Gets the bulk recipient file from a template.
|
BulkRecipientsResponse |
listBulkRecipients(String accountId,
String templateId,
String recipientId,
TemplatesApi.ListBulkRecipientsOptions options)
Gets the bulk recipient file from a template.
|
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.
|
Recipients |
listRecipients(String accountId,
String templateId,
TemplatesApi.ListRecipientsOptions options)
Gets recipient information from a template.
|
Tabs |
listTabs(String accountId,
String templateId,
String recipientId)
Gets the tabs information for a signer or sign-in-person recipient in a template.
|
Tabs |
listTabs(String accountId,
String templateId,
String recipientId,
TemplatesApi.ListTabsOptions options)
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.
|
EnvelopeTemplateResults |
listTemplates(String accountId,
TemplatesApi.ListTemplatesOptions options)
Gets the definition of a template.
|
void |
rotateDocumentPage(String accountId,
String templateId,
String documentId,
String pageNumber,
PageRequest pageRequest)
Rotates page image from a template for display.
|
void |
setApiClient(ApiClient apiClient) |
TemplateUpdateSummary |
update(String accountId,
String templateId,
EnvelopeTemplate envelopeTemplate)
Updates an existing template.
|
BulkRecipientsSummaryResponse |
updateBulkRecipients(String accountId,
String templateId,
String recipientId,
BulkRecipientsRequest bulkRecipientsRequest)
Adds or replaces the bulk recipients list in a template.
|
CustomFields |
updateCustomFields(String accountId,
String templateId,
TemplateCustomFields templateCustomFields)
Updates envelope custom fields in a template.
|
EnvelopeDocument |
updateDocument(String accountId,
String templateId,
String documentId,
EnvelopeDefinition envelopeDefinition)
Adds a document to a template document.
|
EnvelopeDocument |
updateDocument(String accountId,
String templateId,
String documentId,
EnvelopeDefinition envelopeDefinition,
TemplatesApi.UpdateDocumentOptions options)
Adds a document to a template document.
|
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.
|
LockInformation |
updateLock(String accountId,
String templateId,
LockRequest lockRequest)
Updates a template lock.
|
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.
|
RecipientsUpdateSummary |
updateRecipients(String accountId,
String templateId,
TemplateRecipients templateRecipients,
TemplatesApi.UpdateRecipientsOptions options)
Updates recipients in a template.
|
Tabs |
updateTabs(String accountId,
String templateId,
String recipientId,
TemplateTabs templateTabs)
Updates the tabs for a recipient.
|
public TemplatesApi()
public TemplatesApi(ApiClient apiClient)
public ApiClient getApiClient()
public void setApiClient(ApiClient apiClient)
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.
accountId - The external account number (int) or account ID Guid.ApiExceptionpublic EnvelopeTemplateResults listTemplates(String accountId, TemplatesApi.ListTemplatesOptions options) 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.
accountId - The external account number (int) or account ID Guid.TemplatesApi.ListTemplatesOptions - Options for modifying the method behavior.ApiExceptionpublic 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.
accountId - The external account number (int) or account ID Guid.TemplatesApi.CreateTemplateOptions - Options for modifying the method behavior.ApiExceptionpublic EnvelopeTemplate get(String accountId, String templateId) throws ApiException
Gets a list of templates for a specified account. Retrieves the definition of the specified template.
accountId - The external account number (int) or account ID Guid.templateId - The ID of the template being accessed.ApiExceptionpublic EnvelopeTemplate get(String accountId, String templateId, TemplatesApi.GetOptions options) throws ApiException
Gets a list of templates for a specified account. Retrieves the definition of the specified template.
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.ApiExceptionpublic TemplateUpdateSummary update(String accountId, String templateId, EnvelopeTemplate envelopeTemplate) throws ApiException
Updates an existing template. Updates an existing template.
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.ApiExceptionpublic 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.
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.ApiExceptionpublic 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.
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.ApiExceptionpublic 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.
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.ApiExceptionpublic CustomFields deleteCustomFields(String accountId, String templateId, TemplateCustomFields templateCustomFields) throws ApiException
Deletes envelope custom fields in a template. Deletes envelope custom fields in a template.
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.ApiExceptionpublic 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.
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.ApiExceptionpublic 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.
accountId - The external account number (int) or account ID Guid.templateId - The ID of the template being accessed.ApiExceptionpublic 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.
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.ApiExceptionpublic TemplateDocumentsResult deleteDocuments(String accountId, String templateId, EnvelopeDefinition envelopeDefinition) throws ApiException
Deletes documents from a template. Deletes one or more documents from an existing template.
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.ApiExceptionpublic 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.
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.ApiExceptionpublic byte[] getDocument(String accountId, String templateId, String documentId, TemplatesApi.GetDocumentOptions options) 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.
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.ApiExceptionpublic EnvelopeDocument updateDocument(String accountId, String templateId, String documentId, EnvelopeDefinition envelopeDefinition) throws ApiException
Adds a document to a template document. Adds the specified document to an existing template document.
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.ApiExceptionpublic EnvelopeDocument updateDocument(String accountId, String templateId, String documentId, EnvelopeDefinition envelopeDefinition, TemplatesApi.UpdateDocumentOptions options) throws ApiException
Adds a document to a template document. Adds the specified document to an existing template document.
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.UpdateDocumentOptions - Options for modifying the method behavior.ApiExceptionpublic 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.
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.ApiExceptionpublic 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.
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.ApiExceptionpublic 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.
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.ApiExceptionpublic 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.
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.ApiExceptionpublic 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.
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.ApiExceptionpublic byte[] getDocumentPageImage(String accountId, String templateId, String documentId, String pageNumber) throws ApiException
Gets a page image from a template for display. Retrieves a page image for display from the specified template.
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.ApiExceptionpublic byte[] getDocumentPageImage(String accountId, String templateId, String documentId, String pageNumber, TemplatesApi.GetDocumentPageImageOptions options) throws ApiException
Gets a page image from a template for display. Retrieves a page image for display from the specified template.
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.GetDocumentPageImageOptions - Options for modifying the method behavior.ApiExceptionpublic void rotateDocumentPage(String accountId, String templateId, String documentId, String pageNumber, PageRequest pageRequest) throws ApiException
Rotates page image from a template for display. Rotates page image from a template for display. The page image can be rotated to the left or right.
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.RotateDocumentPageOptions - Options for modifying the method behavior.ApiExceptionpublic 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.
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.ApiExceptionpublic LockInformation updateLock(String accountId, String templateId, LockRequest lockRequest) throws ApiException
Updates a template lock. Updates the lock duration time or update the lockedByApp property information for the specified template. The user and integrator key must match the user specified by the lockByUser property and integrator key information and the X-DocuSign-Edit header must be included or an error will be generated.
accountId - The external account number (int) or account ID Guid.templateId - The ID of the template being accessed.TemplatesApi.UpdateLockOptions - Options for modifying the method behavior.ApiExceptionpublic LockInformation createLock(String accountId, String templateId, LockRequest lockRequest) throws ApiException
Lock a template. Locks the specified template, and sets the time until the lock expires, to prevent other users or recipients from accessing and changing the template.\n\n###### Note: Users must have envelope locking capability enabled to use this function (the userSetting property canLockEnvelopes must be set to true for the user).
accountId - The external account number (int) or account ID Guid.templateId - The ID of the template being accessed.TemplatesApi.CreateLockOptions - Options for modifying the method behavior.ApiExceptionpublic LockInformation deleteLock(String accountId, String templateId, LockRequest lockRequest) throws ApiException
Deletes a template lock. Deletes the lock from the specified template. The X-DocuSign-Edit header must be included in the request.
accountId - The external account number (int) or account ID Guid.templateId - The ID of the template being accessed.TemplatesApi.DeleteLockOptions - Options for modifying the method behavior.ApiExceptionpublic Notification getNotificationSettings(String accountId, String templateId) throws ApiException
Gets template notification information. Retrieves the envelope notification, reminders and expirations, information for an existing template.
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.ApiExceptionpublic 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.
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.ApiExceptionpublic Recipients listRecipients(String accountId, String templateId) throws ApiException
Gets recipient information from a template. Retrieves the information for all recipients in the specified template.
accountId - The external account number (int) or account ID Guid.templateId - The ID of the template being accessed.ApiExceptionpublic Recipients listRecipients(String accountId, String templateId, TemplatesApi.ListRecipientsOptions options) throws ApiException
Gets recipient information from a template. Retrieves the information for all recipients in the specified template.
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.ApiExceptionpublic 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.
accountId - The external account number (int) or account ID Guid.templateId - The ID of the template being accessed.ApiExceptionpublic RecipientsUpdateSummary updateRecipients(String accountId, String templateId, TemplateRecipients templateRecipients, TemplatesApi.UpdateRecipientsOptions options) 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.
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.ApiExceptionpublic Recipients createRecipients(String accountId, String templateId, TemplateRecipients templateRecipients) throws ApiException
Adds tabs for a recipient. Adds one or more recipients to a template.
accountId - The external account number (int) or account ID Guid.templateId - The ID of the template being accessed.ApiExceptionpublic Recipients createRecipients(String accountId, String templateId, TemplateRecipients templateRecipients, TemplatesApi.CreateRecipientsOptions options) throws ApiException
Adds tabs for a recipient. Adds one or more recipients to a template.
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.ApiExceptionpublic 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.
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.ApiExceptionpublic 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.
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.ApiExceptionpublic BulkRecipientsResponse listBulkRecipients(String accountId, String templateId, String recipientId) throws ApiException
Gets the bulk recipient file from a template. Retrieves the bulk recipient file information from a template that has a bulk recipient.
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.ApiExceptionpublic BulkRecipientsResponse listBulkRecipients(String accountId, String templateId, String recipientId, TemplatesApi.ListBulkRecipientsOptions options) throws ApiException
Gets the bulk recipient file from a template. Retrieves the bulk recipient file information from a template that has a bulk recipient.
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.ListBulkRecipientsOptions - Options for modifying the method behavior.ApiExceptionpublic BulkRecipientsSummaryResponse updateBulkRecipients(String accountId, String templateId, String recipientId, BulkRecipientsRequest bulkRecipientsRequest) throws ApiException
Adds or replaces the bulk recipients list in a template. Updates the bulk recipients in a template using a file upload. The Content-Type supported for uploading a bulk recipient file is CSV (text/csv).\n\nThe REST API does not support modifying individual rows or values in the bulk recipients file. It only allows the entire file to be added or replaced with a new file.
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.UpdateBulkRecipientsOptions - Options for modifying the method behavior.ApiExceptionpublic BulkRecipientsUpdateResponse deleteBulkRecipients(String accountId, String templateId, String recipientId) throws ApiException
Deletes the bulk recipient list on a template. Deletes the bulk recipient list on a template.
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.DeleteBulkRecipientsOptions - Options for modifying the method behavior.ApiExceptionpublic Tabs listTabs(String accountId, String templateId, String recipientId) 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.
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.ApiExceptionpublic Tabs listTabs(String accountId, String templateId, String recipientId, TemplatesApi.ListTabsOptions options) 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.
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.ApiExceptionpublic 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.
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.ApiExceptionpublic 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.
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.ApiExceptionpublic 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.
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.ApiExceptionpublic ViewUrl createEditView(String accountId, String templateId, ReturnUrlRequest returnUrlRequest) throws ApiException
Provides a URL to start an edit view of the Template UI
accountId - The external account number (int) or account ID Guid.templateId - The ID of the template being accessed.TemplatesApi.CreateEditViewOptions - Options for modifying the method behavior.ApiExceptionpublic 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.
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.ApiExceptionpublic 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.
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.ApiExceptionCopyright © 2017. All Rights Reserved.