| Package | Description |
|---|---|
| com.docusign.esign.api | |
| com.docusign.esign.client |
| Modifier and Type | Method and Description |
|---|---|
DocumentTemplateList |
EnvelopesApi.applyTemplate(String accountId,
String envelopeId,
DocumentTemplateList documentTemplateList)
Adds templates to an envelope.
|
DocumentTemplateList |
EnvelopesApi.applyTemplateToDocument(String accountId,
String envelopeId,
String documentId,
DocumentTemplateList documentTemplateList)
Adds templates to a document in an envelope.
|
TabMetadata |
CustomTabsApi.create(String accountId,
TabMetadata tabMetadata)
Creates a custom tab.
|
ViewUrl |
EnvelopesApi.createConsoleView(String accountId,
ConsoleViewRequest consoleViewRequest)
Returns a URL to the authentication view UI.
|
ViewUrl |
EnvelopesApi.createCorrectView(String accountId,
String envelopeId,
CorrectViewRequest correctViewRequest)
Returns a URL to the envelope correction UI.
|
CustomFields |
EnvelopesApi.createCustomFields(String accountId,
String envelopeId,
CustomFields customFields)
Updates envelope custom fields for an envelope.
|
CustomFields |
TemplatesApi.createCustomFields(String accountId,
String templateId,
TemplateCustomFields templateCustomFields)
Creates custom document fields in an existing template document.
|
DocumentFieldsInformation |
TemplatesApi.createDocumentFields(String accountId,
String templateId,
String documentId,
DocumentFieldsInformation documentFieldsInformation)
Creates custom document fields in an existing template document.
|
DocumentFieldsInformation |
EnvelopesApi.createDocumentFields(String accountId,
String envelopeId,
String documentId,
DocumentFieldsInformation documentFieldsInformation)
Creates custom document fields in an existing envelope document.
|
ViewUrl |
EnvelopesApi.createEditView(String accountId,
String envelopeId,
ReturnUrlRequest returnUrlRequest)
Returns a URL to the edit view UI.
|
EmailSettings |
EnvelopesApi.createEmailSettings(String accountId,
String envelopeId,
EmailSettings emailSettings)
Adds email setting overrides to an envelope.
|
EnvelopeSummary |
EnvelopesApi.createEnvelope(String accountId,
EnvelopeDefinition envelopeDefinition)
Creates an envelope.
|
EnvelopeSummary |
EnvelopesApi.createEnvelope(String accountId,
EnvelopeDefinition envelopeDefinition,
EnvelopesApi.CreateEnvelopeOptions options)
Creates an envelope.
|
LockInformation |
EnvelopesApi.createLock(String accountId,
String envelopeId,
LockRequest lockRequest)
Lock an envelope.
|
Recipients |
EnvelopesApi.createRecipient(String accountId,
String envelopeId,
Recipients recipients)
Adds one or more recipients to an envelope.
|
Recipients |
TemplatesApi.createRecipients(String accountId,
String templateId,
TemplateRecipients templateRecipients)
Adds tabs for a recipient.
|
ViewUrl |
EnvelopesApi.createRecipientView(String accountId,
String envelopeId,
RecipientViewRequest recipientViewRequest)
Returns a URL to the recipient view UI.
|
ViewUrl |
EnvelopesApi.createSenderView(String accountId,
String envelopeId,
ReturnUrlRequest returnUrlRequest)
Returns a URL to the sender view UI.
|
Tabs |
EnvelopesApi.createTabs(String accountId,
String envelopeId,
String recipientId,
Tabs tabs)
Adds tabs for a recipient.
|
Tabs |
TemplatesApi.createTabs(String accountId,
String templateId,
String recipientId,
TemplateTabs templateTabs)
Adds tabs for a recipient.
|
TemplateSummary |
TemplatesApi.createTemplate(String accountId,
EnvelopeTemplate envelopeTemplate)
Creates an envelope from a template.
|
ViewUrl |
EnvelopesApi.createViewLink(String accountId,
String envelopeId,
ViewLinkRequest viewLinkRequest)
Reserved: Returns a URL to the secure link view UI.
|
void |
CustomTabsApi.delete(String accountId,
String customTabId)
Deletes custom tab information.
|
CustomFields |
EnvelopesApi.deleteCustomFields(String accountId,
String envelopeId,
CustomFields customFields)
Deletes envelope custom fields for draft and in-process envelopes.
|
CustomFields |
TemplatesApi.deleteCustomFields(String accountId,
String templateId,
TemplateCustomFields templateCustomFields)
Deletes envelope custom fields in a template.
|
DocumentFieldsInformation |
TemplatesApi.deleteDocumentFields(String accountId,
String templateId,
String documentId,
DocumentFieldsInformation documentFieldsInformation)
Deletes custom document fields from an existing template document.
|
DocumentFieldsInformation |
EnvelopesApi.deleteDocumentFields(String accountId,
String envelopeId,
String documentId,
DocumentFieldsInformation documentFieldsInformation)
Deletes custom document fields from an existing envelope document.
|
void |
EnvelopesApi.deleteDocumentPage(String accountId,
String envelopeId,
String documentId,
String pageNumber)
Deletes a page from a document in an envelope.
|
void |
TemplatesApi.deleteDocumentPage(String accountId,
String templateId,
String documentId,
String pageNumber,
PageRequest pageRequest)
Deletes a page from a document in an template.
|
TemplateDocumentsResult |
TemplatesApi.deleteDocuments(String accountId,
String templateId,
EnvelopeDefinition envelopeDefinition)
Deletes documents from a template.
|
EnvelopeDocumentsResult |
EnvelopesApi.deleteDocuments(String accountId,
String envelopeId,
EnvelopeDefinition envelopeDefinition)
Deletes documents from a draft envelope.
|
EmailSettings |
EnvelopesApi.deleteEmailSettings(String accountId,
String envelopeId)
Deletes the email setting overrides for an envelope.
|
GroupInformation |
TemplatesApi.deleteGroupShare(String accountId,
String templateId,
String templatePart,
GroupInformation groupInformation)
Removes a member group's sharing permissions for a template.
|
LockInformation |
EnvelopesApi.deleteLock(String accountId,
String envelopeId)
Deletes an envelope lock.
|
Recipients |
EnvelopesApi.deleteRecipient(String accountId,
String envelopeId,
String recipientId)
Deletes a recipient from an envelope.
|
Recipients |
TemplatesApi.deleteRecipient(String accountId,
String templateId,
String recipientId,
TemplateRecipients templateRecipients)
Deletes the specified recipient file from a template.
|
Recipients |
EnvelopesApi.deleteRecipients(String accountId,
String envelopeId,
Recipients recipients)
Deletes recipients from an envelope.
|
Recipients |
TemplatesApi.deleteRecipients(String accountId,
String templateId,
TemplateRecipients templateRecipients)
Deletes recipients from a template.
|
void |
DiagnosticsApi.deleteRequestLogs()
Deletes the request log files.
|
Tabs |
EnvelopesApi.deleteTabs(String accountId,
String envelopeId,
String recipientId,
Tabs tabs)
Deletes the tabs associated with a recipient.
|
Tabs |
TemplatesApi.deleteTabs(String accountId,
String templateId,
String recipientId,
TemplateTabs templateTabs)
Deletes the tabs associated with a recipient in a template.
|
void |
EnvelopesApi.deleteTemplatesFromDocument(String accountId,
String envelopeId,
String documentId,
String templateId)
Deletes a template from a document in an existing envelope.
|
void |
EnvelopesApi.deleteViewLink(String accountId,
String envelopeId)
Reserved: Expires a secure view link.
|
EnvelopeTemplate |
TemplatesApi.get(String accountId,
String templateId)
Gets a list of templates for a specified account.
|
TabMetadata |
CustomTabsApi.get(String accountId,
String customTabId)
Gets custom tab information.
|
AccountInformation |
AccountsApi.getAccountInformation(String accountId)
Retrieves the account information for the specified account.
|
AccountInformation |
AccountsApi.getAccountInformation(String accountId,
AccountsApi.GetAccountInformationOptions options)
Retrieves the account information for the specified account.
|
byte[] |
TemplatesApi.getDocument(String accountId,
String templateId,
String documentId)
Gets PDF documents from a template.
|
byte[] |
EnvelopesApi.getDocument(String accountId,
String envelopeId,
String documentId)
Gets a document from an envelope.
|
byte[] |
EnvelopesApi.getDocument(String accountId,
String envelopeId,
String documentId,
EnvelopesApi.GetDocumentOptions options)
Gets a document from an envelope.
|
EmailSettings |
EnvelopesApi.getEmailSettings(String accountId,
String envelopeId)
Gets the email setting overrides for an envelope.
|
Envelope |
EnvelopesApi.getEnvelope(String accountId,
String envelopeId)
Gets the status of a envelope.
|
Envelope |
EnvelopesApi.getEnvelope(String accountId,
String envelopeId,
EnvelopesApi.GetEnvelopeOptions options)
Gets the status of a envelope.
|
LockInformation |
TemplatesApi.getLock(String accountId,
String templateId)
Gets template lock information.
|
LockInformation |
EnvelopesApi.getLock(String accountId,
String envelopeId)
Gets envelope lock information.
|
Notification |
TemplatesApi.getNotificationSettings(String accountId,
String templateId)
Gets template notification information.
|
Notification |
EnvelopesApi.getNotificationSettings(String accountId,
String envelopeId)
Gets envelope notification information.
|
byte[] |
DiagnosticsApi.getRequestLog(String requestLogId)
Gets a request logging log file.
|
DiagnosticsSettingsInformation |
DiagnosticsApi.getRequestLogSettings()
Gets the API request logging settings.
|
ResourceInformation |
DiagnosticsApi.getResources()
Lists resources for REST version specified
Retrieves the base resources available for the DocuSign REST APIs.\n\nYou do not need an integrator key to view the REST API versions and resources.\n\nExample: https://demo.docusign.net/restapi/v2 lists all of the base resources available in version 2 of the REST API on the DocuSign Demo system.\n\nTo view descriptions and samples of the service operations for all versions, remove the version number and add /help to the URL.\n\nExample: https://demo.docusign.net/restapi/help lists the REST API operations on the DocuSign Demo system with XML and JSON request and response samples.
|
ServiceInformation |
DiagnosticsApi.getService()
Retrieves the available REST API versions.
|
UserSettingsInformation |
UsersApi.getSettings(String accountId,
String userId)
Gets the user account settings for a specified user.
|
FoldersResponse |
FoldersApi.list(String accountId)
Gets a list of the folders for the account.
|
TabMetadataList |
CustomTabsApi.list(String accountId)
Gets a list of all account tabs.
|
TabMetadataList |
CustomTabsApi.list(String accountId,
CustomTabsApi.ListOptions options)
Gets a list of all account tabs.
|
EnvelopeAuditEventResponse |
EnvelopesApi.listAuditEvents(String accountId,
String envelopeId)
Gets the envelope audit events for an envelope.
|
CustomFields |
AccountsApi.listCustomFields(String accountId)
Gets a list of custom fields associated with the account.
|
CustomFields |
TemplatesApi.listCustomFields(String accountId,
String templateId)
Gets the custom document fields from a template.
|
CustomFieldsEnvelope |
EnvelopesApi.listCustomFields(String accountId,
String envelopeId)
Gets the custom field information for the specified envelope.
|
DocumentFieldsInformation |
TemplatesApi.listDocumentFields(String accountId,
String templateId,
String documentId)
Gets the custom document fields for a an existing template document.
|
DocumentFieldsInformation |
EnvelopesApi.listDocumentFields(String accountId,
String envelopeId,
String documentId)
Gets the custom document fields from an existing envelope document.
|
TemplateDocumentsResult |
TemplatesApi.listDocuments(String accountId,
String templateId)
Gets a list of documents associated with a template.
|
EnvelopeDocumentsResult |
EnvelopesApi.listDocuments(String accountId,
String envelopeId)
Gets a list of envelope documents.
|
FolderItemsResponse |
FoldersApi.listItems(String accountId,
String folderId)
Gets a list of the envelopes in the specified folder.
|
Recipients |
TemplatesApi.listRecipients(String accountId,
String templateId)
Gets recipient information from a template.
|
Recipients |
EnvelopesApi.listRecipients(String accountId,
String envelopeId)
Gets the status of recipients for an envelope.
|
Recipients |
EnvelopesApi.listRecipients(String accountId,
String envelopeId,
EnvelopesApi.ListRecipientsOptions options)
Gets the status of recipients for an envelope.
|
ApiRequestLogsResult |
DiagnosticsApi.listRequestLogs()
Gets the API request logging log files.
|
ApiRequestLogsResult |
DiagnosticsApi.listRequestLogs(DiagnosticsApi.ListRequestLogsOptions options)
Gets the API request logging log files.
|
AccountSettingsInformation |
AccountsApi.listSettings(String accountId)
Gets account settings information.
|
AccountSharedAccess |
AccountsApi.listSharedAccess(String accountId)
Reserved: Gets the shared item status for one or more users.
|
EnvelopesInformation |
EnvelopesApi.listStatus(String accountId,
EnvelopeIdsRequest envelopeIdsRequest)
Gets the envelope status for the specified envelopes.
|
EnvelopesInformation |
EnvelopesApi.listStatusChanges(String accountId)
Gets status changes for one or more envelopes.
|
EnvelopesInformation |
EnvelopesApi.listStatusChanges(String accountId,
EnvelopesApi.ListStatusChangesOptions options)
Gets status changes for one or more envelopes.
|
Tabs |
EnvelopesApi.listTabs(String accountId,
String envelopeId,
String recipientId)
Gets the tabs information for a signer or sign-in-person recipient in an envelope.
|
Tabs |
EnvelopesApi.listTabs(String accountId,
String envelopeId,
String recipientId,
EnvelopesApi.ListTabsOptions options)
Gets the tabs information for a signer or sign-in-person recipient in an envelope.
|
Tabs |
TemplatesApi.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 |
TemplatesApi.listTemplates(String accountId)
Gets the definition of a template.
|
TemplateInformation |
EnvelopesApi.listTemplates(String accountId,
String envelopeId)
Get List of Templates used in an Envelope
This returns a list of the server-side templates, their name and ID, used in an envelope.\n
|
TemplateInformation |
EnvelopesApi.listTemplatesForDocument(String accountId,
String envelopeId,
String documentId)
Gets the templates associated with a document in an existing envelope.
|
FileTypeList |
AccountsApi.listUnsupportedFileTypes(String accountId)
Gets a list of unsupported file types.
|
LoginInformation |
AuthenticationApi.login()
Gets login information for a specified user.
|
LoginInformation |
AuthenticationApi.login(AuthenticationApi.LoginOptions options)
Gets login information for a specified user.
|
FoldersResponse |
FoldersApi.moveEnvelopes(String accountId,
String folderId,
FoldersRequest foldersRequest)
Moves an envelope from its current folder to the specified folder.
|
FolderItemResponse |
FoldersApi.search(String accountId,
String searchFolderId)
Gets a list of envelopes in folders matching the specified criteria.
|
FolderItemResponse |
FoldersApi.search(String accountId,
String searchFolderId,
FoldersApi.SearchOptions options)
Gets a list of envelopes in folders matching the specified criteria.
|
ViewUrl |
DefaultApi.templateEditView(String accountId,
String templateId,
ReturnUrlRequest returnUrlRequest)
Provides a URL to start an edit view of the Template UI
|
EnvelopeUpdateSummary |
EnvelopesApi.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\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.
|
EnvelopeUpdateSummary |
EnvelopesApi.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\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.
|
TemplateUpdateSummary |
TemplatesApi.update(String accountId,
String templateId,
EnvelopeTemplate envelopeTemplate)
Updates an existing template.
|
TabMetadata |
CustomTabsApi.update(String accountId,
String customTabId,
TabMetadata tabMetadata)
Updates custom tab information.\n\n
Updates the information in a custom tab for the specified account.
|
CustomFields |
EnvelopesApi.updateCustomFields(String accountId,
String envelopeId,
CustomFields customFields)
Updates envelope custom fields in an envelope.
|
CustomFields |
TemplatesApi.updateCustomFields(String accountId,
String templateId,
TemplateCustomFields templateCustomFields)
Updates envelope custom fields in a template.
|
DocumentFieldsInformation |
TemplatesApi.updateDocumentFields(String accountId,
String templateId,
String documentId,
DocumentFieldsInformation documentFieldsInformation)
Updates existing custom document fields in an existing template document.
|
DocumentFieldsInformation |
EnvelopesApi.updateDocumentFields(String accountId,
String envelopeId,
String documentId,
DocumentFieldsInformation documentFieldsInformation)
Updates existing custom document fields in an existing envelope document.
|
TemplateDocumentsResult |
TemplatesApi.updateDocuments(String accountId,
String templateId,
EnvelopeDefinition envelopeDefinition)
Adds documents to a template document.
|
EnvelopeDocumentsResult |
EnvelopesApi.updateDocuments(String accountId,
String envelopeId,
EnvelopeDefinition envelopeDefinition)
Adds one or more documents to an existing envelope document.
|
EnvelopeDocumentsResult |
EnvelopesApi.updateDocuments(String accountId,
String envelopeId,
EnvelopeDefinition envelopeDefinition,
EnvelopesApi.UpdateDocumentsOptions options)
Adds one or more documents to an existing envelope document.
|
TemplateDocumentsResult |
TemplatesApi.updateDocuments(String accountId,
String templateId,
EnvelopeDefinition envelopeDefinition,
TemplatesApi.UpdateDocumentsOptions options)
Adds documents to a template document.
|
EmailSettings |
EnvelopesApi.updateEmailSettings(String accountId,
String envelopeId,
EmailSettings emailSettings)
Updates the email setting overrides for an envelope.
|
GroupInformation |
TemplatesApi.updateGroupShare(String accountId,
String templateId,
String templatePart,
GroupInformation groupInformation)
Shares a template with a group
Shares a template with the specified members group.
|
LockInformation |
EnvelopesApi.updateLock(String accountId,
String envelopeId,
LockRequest lockRequest)
Updates an envelope lock.
|
Notification |
TemplatesApi.updateNotificationSettings(String accountId,
String templateId,
TemplateNotificationRequest templateNotificationRequest)
Updates the notification structure for an existing template.
|
RecipientsUpdateSummary |
EnvelopesApi.updateRecipients(String accountId,
String envelopeId,
Recipients recipients)
Updates recipients in a draft envelope or corrects recipient information for an in process envelope.
|
RecipientsUpdateSummary |
TemplatesApi.updateRecipients(String accountId,
String templateId,
TemplateRecipients templateRecipients)
Updates recipients in a template.
|
DiagnosticsSettingsInformation |
DiagnosticsApi.updateRequestLogSettings(DiagnosticsSettingsInformation diagnosticsSettingsInformation)
Enables or disables API request logging for troubleshooting.
|
void |
AccountsApi.updateSettings(String accountId,
AccountSettingsInformation accountSettingsInformation)
Updates the account settings for an account.
|
Tabs |
EnvelopesApi.updateTabs(String accountId,
String envelopeId,
String recipientId,
Tabs tabs)
Updates the tabs for a recipient.\n\n
Updates one or more tabs for a recipient in a draft envelope.
|
Tabs |
TemplatesApi.updateTabs(String accountId,
String templateId,
String recipientId,
TemplateTabs templateTabs)
Updates the tabs for a recipient.
|
| Modifier and Type | Method and Description |
|---|---|
<T> T |
ApiClient.invokeAPI(String path,
String method,
List<Pair> queryParams,
Object body,
Map<String,String> headerParams,
Map<String,Object> formParams,
String accept,
String contentType,
String[] authNames,
com.sun.jersey.api.client.GenericType<T> returnType)
Invoke API by sending HTTP request with the given options.
|
Object |
ApiClient.serialize(Object obj,
String contentType,
Map<String,Object> formParams)
Serialize the given Java object into string according the given
Content-Type (only JSON is supported for now).
|
Copyright © 2016. All rights reserved.