| 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.
|
CompleteSignHashResponse |
TrustServiceProvidersApi.completeSignHash(CompleteSignRequest completeSignRequest)
Complete Sign Hash
|
NewAccountSummary |
AccountsApi.create(NewAccountDefinition newAccountDefinition)
Creates new accounts.
|
NewAccountSummary |
AccountsApi.create(NewAccountDefinition newAccountDefinition,
AccountsApi.CreateOptions options)
Creates new accounts.
|
NewUsersSummary |
UsersApi.create(String accountId,
NewUsersDefinition newUsersDefinition)
Adds news user to the specified account.
|
TabMetadata |
CustomTabsApi.create(String accountId,
TabMetadata tabMetadata)
Creates a custom tab.
|
BrandsResponse |
AccountsApi.createBrand(String accountId,
Brand brand)
Creates one or more brand profile files for the account.
|
ChunkedUploadResponse |
EnvelopesApi.createChunkedUpload(String accountId,
ChunkedUploadRequest chunkedUploadRequest)
Initiate a new ChunkedUpload.
|
ConnectCustomConfiguration |
ConnectApi.createConfiguration(String accountId,
ConnectCustomConfiguration connectCustomConfiguration)
Creates a connect configuration for the specified account.
|
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 |
AccountsApi.createCustomField(String accountId,
CustomField customField)
Creates an acount custom field.
|
CustomFields |
AccountsApi.createCustomField(String accountId,
CustomField customField,
AccountsApi.CreateCustomFieldOptions options)
Creates an acount custom field.
|
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 |
EnvelopesApi.createDocumentFields(String accountId,
String envelopeId,
String documentId,
DocumentFieldsInformation documentFieldsInformation)
Creates custom document fields in an existing envelope document.
|
DocumentFieldsInformation |
TemplatesApi.createDocumentFields(String accountId,
String templateId,
String documentId,
DocumentFieldsInformation documentFieldsInformation)
Creates custom document fields in an existing template document.
|
DocumentHtmlDefinitions |
EnvelopesApi.createDocumentResponsiveHtmlPreview(String accountId,
String envelopeId,
String documentId,
DocumentHtmlDefinition documentHtmlDefinition)
Get Responsive HTML Preview for a document in an envelope.
|
ViewUrl |
EnvelopesApi.createEditView(String accountId,
String envelopeId,
ReturnUrlRequest returnUrlRequest)
Returns a URL to the edit view UI.
|
ViewUrl |
TemplatesApi.createEditView(String accountId,
String templateId,
ReturnUrlRequest returnUrlRequest)
Provides a URL to start an edit view of the Template 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.
|
ViewUrl |
EnvelopesApi.createEnvelopeRecipientSharedView(String accountId,
String envelopeId,
RecipientViewRequest recipientViewRequest)
Provides a URL to start a shared recipient view of the Envelope UI
|
GroupInformation |
GroupsApi.createGroups(String accountId,
GroupInformation groupInformation)
Creates one or more groups for the account.
|
SigningGroupInformation |
SigningGroupsApi.createList(String accountId,
SigningGroupInformation signingGroupInformation)
Creates a signing group.
|
LockInformation |
EnvelopesApi.createLock(String accountId,
String envelopeId,
LockRequest lockRequest)
Lock an envelope.
|
LockInformation |
TemplatesApi.createLock(String accountId,
String templateId,
LockRequest lockRequest)
Lock a template.
|
PermissionProfile |
AccountsApi.createPermissionProfile(String accountId,
PermissionProfile permissionProfile)
Creates a new permission profile in the specified account.
|
PermissionProfile |
AccountsApi.createPermissionProfile(String accountId,
PermissionProfile permissionProfile,
AccountsApi.CreatePermissionProfileOptions options)
Creates a new permission profile in the specified account.
|
PowerForm |
PowerFormsApi.createPowerForm(String accountId,
PowerForm powerForm)
Creates a new PowerForm.
|
CloudStorageProviders |
CloudStorageApi.createProvider(String accountId,
String userId,
CloudStorageProviders cloudStorageProviders)
Configures the redirect URL information for one or more cloud storage providers for the specified user.
|
Recipients |
EnvelopesApi.createRecipient(String accountId,
String envelopeId,
Recipients recipients)
Adds one or more recipients to an envelope.
|
Recipients |
EnvelopesApi.createRecipient(String accountId,
String envelopeId,
Recipients recipients,
EnvelopesApi.CreateRecipientOptions options)
Adds one or more recipients to an envelope.
|
Recipients |
TemplatesApi.createRecipients(String accountId,
String templateId,
TemplateRecipients templateRecipients)
Adds tabs for a recipient.
|
Recipients |
TemplatesApi.createRecipients(String accountId,
String templateId,
TemplateRecipients templateRecipients,
TemplatesApi.CreateRecipientsOptions options)
Adds tabs for a recipient.
|
ViewUrl |
EnvelopesApi.createRecipientView(String accountId,
String envelopeId,
RecipientViewRequest recipientViewRequest)
Returns a URL to the recipient view UI.
|
DocumentHtmlDefinitions |
EnvelopesApi.createResponsiveHtmlPreview(String accountId,
String envelopeId,
DocumentHtmlDefinition documentHtmlDefinition)
Get Responsive HTML Preview for all documents in an envelope.
|
ViewUrl |
EnvelopesApi.createSenderView(String accountId,
String envelopeId,
ReturnUrlRequest returnUrlRequest)
Returns a URL to the sender view UI.
|
UserSignaturesInformation |
UsersApi.createSignatures(String accountId,
String userId,
UserSignaturesInformation userSignaturesInformation)
Adds user Signature and initials images to a Signature.
|
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.
|
DocumentHtmlDefinitions |
TemplatesApi.createTemplateDocumentResponsiveHtmlPreview(String accountId,
String templateId,
String documentId,
DocumentHtmlDefinition documentHtmlDefinition)
Post Responsive HTML Preview for a document in a template.
|
DocumentHtmlDefinitions |
TemplatesApi.createTemplateResponsiveHtmlPreview(String accountId,
String templateId,
DocumentHtmlDefinition documentHtmlDefinition)
Get Responsive HTML Preview for all documents in a template.
|
ViewUrl |
EnvelopesApi.createViewLink(String accountId,
String envelopeId,
ViewLinkRequest viewLinkRequest)
Reserved: Returns a URL to the secure link view UI.
|
Workspace |
WorkspacesApi.createWorkspace(String accountId,
Workspace workspace)
Create a Workspace
Creates a new workspace.
|
WorkspaceItem |
WorkspacesApi.createWorkspaceFile(String accountId,
String workspaceId,
String folderId)
Creates a workspace file.
|
void |
AccountsApi.delete(String accountId)
Deletes the specified account.
|
void |
CustomTabsApi.delete(String accountId,
String customTabId)
Deletes custom tab information.
|
UsersResponse |
UsersApi.delete(String accountId,
UserInfoList userInfoList)
Removes users account privileges.
|
UsersResponse |
UsersApi.delete(String accountId,
UserInfoList userInfoList,
UsersApi.DeleteOptions options)
Removes users account privileges.
|
EnvelopeAttachmentsResult |
EnvelopesApi.deleteAttachments(String accountId,
String envelopeId,
EnvelopeAttachmentsRequest envelopeAttachmentsRequest)
Delete one or more attachments from a DRAFT envelope.
|
void |
AccountsApi.deleteBrand(String accountId,
String brandId)
Removes a brand.
|
void |
AccountsApi.deleteBrandLogoByType(String accountId,
String brandId,
String logoType)
Delete one branding logo.
|
BrandsResponse |
AccountsApi.deleteBrands(String accountId,
BrandsRequest brandsRequest)
Deletes one or more brand profiles.
|
BrandsResponse |
GroupsApi.deleteBrands(String accountId,
String groupId,
BrandsRequest brandsRequest)
Deletes brand information from the requested group.
|
BulkRecipientsUpdateResponse |
TemplatesApi.deleteBulkRecipients(String accountId,
String templateId,
String recipientId)
Deletes the bulk recipient list on a template.
|
CaptiveRecipientInformation |
AccountsApi.deleteCaptiveRecipient(String accountId,
String recipientPart,
CaptiveRecipientInformation captiveRecipientInformation)
Deletes the signature for one or more captive recipient records.
|
ChunkedUploadResponse |
EnvelopesApi.deleteChunkedUpload(String accountId,
String chunkedUploadId)
Delete an existing ChunkedUpload.
|
void |
ConnectApi.deleteConfiguration(String accountId,
String connectId)
Deletes the specified connect configuration.
|
ContactUpdateResponse |
UsersApi.deleteContacts(String accountId,
ContactModRequest contactModRequest)
Delete contacts associated with an account for the DocuSign service.
|
ContactUpdateResponse |
UsersApi.deleteContactWithId(String accountId,
String contactId)
Replaces a particular contact associated with an account for the DocuSign service.
|
void |
AccountsApi.deleteCustomField(String accountId,
String customFieldId)
Delete an existing account custom field.
|
void |
AccountsApi.deleteCustomField(String accountId,
String customFieldId,
AccountsApi.DeleteCustomFieldOptions options)
Delete an existing account custom field.
|
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.
|
CustomSettingsInformation |
UsersApi.deleteCustomSettings(String accountId,
String userId,
CustomSettingsInformation customSettingsInformation)
Deletes custom user settings for a specified user.
|
DocumentFieldsInformation |
EnvelopesApi.deleteDocumentFields(String accountId,
String envelopeId,
String documentId,
DocumentFieldsInformation documentFieldsInformation)
Deletes custom document fields from an existing envelope document.
|
DocumentFieldsInformation |
TemplatesApi.deleteDocumentFields(String accountId,
String templateId,
String documentId,
DocumentFieldsInformation documentFieldsInformation)
Deletes custom document fields from an existing template 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.
|
EnvelopeDocumentsResult |
EnvelopesApi.deleteDocuments(String accountId,
String envelopeId,
EnvelopeDefinition envelopeDefinition)
Deletes documents from a draft envelope.
|
TemplateDocumentsResult |
TemplatesApi.deleteDocuments(String accountId,
String templateId,
EnvelopeDefinition envelopeDefinition)
Deletes documents from a template.
|
EmailSettings |
EnvelopesApi.deleteEmailSettings(String accountId,
String envelopeId)
Deletes the email setting overrides for an envelope.
|
void |
AccountsApi.deleteENoteConfiguration(String accountId)
Deletes configuration information for the eNote eOriginal integration.
|
void |
ConnectApi.deleteEventFailureLog(String accountId,
String failureId)
Deletes a Connect failure log entry.
|
void |
ConnectApi.deleteEventLog(String accountId,
String logId)
Deletes a specified Connect log entry.
|
void |
ConnectApi.deleteEventLogs(String accountId)
Gets a list of Connect log entries.
|
GroupInformation |
GroupsApi.deleteGroups(String accountId,
GroupInformation groupInformation)
Deletes an existing user group.
|
GroupInformation |
TemplatesApi.deleteGroupShare(String accountId,
String templateId,
String templatePart,
GroupInformation groupInformation)
Removes a member group's sharing permissions for a template.
|
UsersResponse |
GroupsApi.deleteGroupUsers(String accountId,
String groupId,
UserInfoList userInfoList)
Deletes one or more users from a gro
Deletes one or more users from a group.
|
SigningGroupInformation |
SigningGroupsApi.deleteList(String accountId,
SigningGroupInformation signingGroupInformation)
Deletes one or more signing groups.
|
LockInformation |
EnvelopesApi.deleteLock(String accountId,
String envelopeId)
Deletes an envelope lock.
|
LockInformation |
TemplatesApi.deleteLock(String accountId,
String templateId,
LockRequest lockRequest)
Deletes a template lock.
|
MobileNotifierConfigurationInformation |
ConnectApi.deleteMobileNotifiers(String accountId,
MobileNotifierConfigurationInformation mobileNotifierConfigurationInformation)
Reserved
Reserved:
|
void |
AccountsApi.deletePermissionProfile(String accountId,
String permissionProfileId)
Deletes a permissions profile within the specified account.
|
void |
PowerFormsApi.deletePowerForm(String accountId,
String powerFormId)
Delete a PowerForm.
|
PowerFormsResponse |
PowerFormsApi.deletePowerForms(String accountId,
PowerFormsRequest powerFormsRequest)
Deletes one or more PowerForms
|
void |
UsersApi.deleteProfileImage(String accountId,
String userId)
Deletes the user profile image for the specified user.
|
CloudStorageProviders |
CloudStorageApi.deleteProvider(String accountId,
String userId,
String serviceId)
Deletes the user authentication information for the specified cloud storage provider.
|
CloudStorageProviders |
CloudStorageApi.deleteProviders(String accountId,
String userId,
CloudStorageProviders cloudStorageProviders)
Deletes the user authentication information for one or more cloud storage providers.
|
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.
|
BulkRecipientsUpdateResponse |
BulkEnvelopesApi.deleteRecipients(String accountId,
String envelopeId,
String recipientId)
Deletes the bulk recipient file 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.
|
void |
UsersApi.deleteSignature(String accountId,
String userId,
String signatureId)
Removes removes signature information for the specified user.
|
UserSignature |
UsersApi.deleteSignatureImage(String accountId,
String userId,
String signatureId,
String imageType)
Deletes the user initials image or the user signature image for the specified user.
|
void |
AuthenticationApi.deleteSocialLogin(String accountId,
String userId,
SocialAccountInformation socialAccountInformation)
Deletes user's social account.
|
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.
|
SigningGroupUsers |
SigningGroupsApi.deleteUsers(String accountId,
String signingGroupId,
SigningGroupUsers signingGroupUsers)
Deletes one or more members from a signing group.
|
void |
EnvelopesApi.deleteViewLink(String accountId,
String envelopeId)
Reserved: Expires a secure view link.
|
Workspace |
WorkspacesApi.deleteWorkspace(String accountId,
String workspaceId)
Delete Workspace
Deletes an existing workspace (logically).
|
void |
WorkspacesApi.deleteWorkspaceFolderItems(String accountId,
String workspaceId,
String folderId,
WorkspaceItemList workspaceItemList)
Deletes workspace one or more specific files/folders from the given folder or root.
|
BulkEnvelopeStatus |
BulkEnvelopesApi.get(String accountId,
String batchId)
Gets the status of a specified bulk send operation.
|
TabMetadata |
CustomTabsApi.get(String accountId,
String customTabId)
Gets custom tab information.
|
SigningGroup |
SigningGroupsApi.get(String accountId,
String signingGroupId)
Gets information about a signing group.
|
EnvelopeTemplate |
TemplatesApi.get(String accountId,
String templateId)
Gets a list of templates for a specified account.
|
BulkEnvelopeStatus |
BulkEnvelopesApi.get(String accountId,
String batchId,
BulkEnvelopesApi.GetOptions options)
Gets the status of a specified bulk send operation.
|
EnvelopeTemplate |
TemplatesApi.get(String accountId,
String templateId,
TemplatesApi.GetOptions options)
Gets a list of templates for a specified account.
|
AccountIdentityVerificationResponse |
AccountsApi.getAccountIdentityVerification(String accountId)
Get the list of identity verification options for an account
|
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.
|
AccountPasswordRules |
AccountsApi.getAccountPasswordRules(String accountId)
Get the password rules
|
void |
OrganizationsApi.getAccountSettingsExport(String organizationId,
String resultId)
Retrieves an account settings comparison.
|
TabAccountSettings |
AccountsApi.getAccountTabSettings(String accountId)
Returns tab settings list for specified account
|
PaymentGatewayAccountsInfo |
AccountsApi.getAllPaymentGatewayAccounts(String accountId)
Get all payment gateway account for the provided accountId
|
void |
EnvelopesApi.getAttachment(String accountId,
String envelopeId,
String attachmentId)
Retrieves an attachment from the envelope.
|
EnvelopeAttachmentsResult |
EnvelopesApi.getAttachments(String accountId,
String envelopeId)
Returns a list of attachments associated with the specified envelope
|
BillingChargeResponse |
AccountsApi.getBillingCharges(String accountId)
Gets list of recurring and usage charges for the account.
|
BillingChargeResponse |
AccountsApi.getBillingCharges(String accountId,
AccountsApi.GetBillingChargesOptions options)
Gets list of recurring and usage charges for the account.
|
BillingPlanResponse |
BillingApi.getBillingPlan(String billingPlanId)
Get the billing plan details.
|
Brand |
AccountsApi.getBrand(String accountId,
String brandId)
Get information for a specific brand.
|
Brand |
AccountsApi.getBrand(String accountId,
String brandId,
AccountsApi.GetBrandOptions options)
Get information for a specific brand.
|
void |
AccountsApi.getBrandExportFile(String accountId,
String brandId)
Export a specific brand.
|
byte[] |
AccountsApi.getBrandLogoByType(String accountId,
String brandId,
String logoType)
Obtains the specified image for a brand.
|
BrandResourcesList |
AccountsApi.getBrandResources(String accountId,
String brandId)
Returns the specified account's list of branding resources (metadata).
|
void |
AccountsApi.getBrandResourcesByContentType(String accountId,
String brandId,
String resourceContentType)
Returns the specified branding resource file.
|
void |
AccountsApi.getBrandResourcesByContentType(String accountId,
String brandId,
String resourceContentType,
AccountsApi.GetBrandResourcesByContentTypeOptions options)
Returns the specified branding resource file.
|
BrandsResponse |
GroupsApi.getBrands(String accountId,
String groupId)
Gets group brand ID Information.
|
ChunkedUploadResponse |
EnvelopesApi.getChunkedUpload(String accountId,
String chunkedUploadId)
Retrieves the current metadata of a ChunkedUpload.
|
ChunkedUploadResponse |
EnvelopesApi.getChunkedUpload(String accountId,
String chunkedUploadId,
EnvelopesApi.GetChunkedUploadOptions options)
Retrieves the current metadata of a ChunkedUpload.
|
byte[] |
EnvelopesApi.getCommentsTranscript(String accountId,
String envelopeId)
Gets comment transcript for envelope and user
|
byte[] |
EnvelopesApi.getCommentsTranscript(String accountId,
String envelopeId,
EnvelopesApi.GetCommentsTranscriptOptions options)
Gets comment transcript for envelope and user
|
ConnectConfigResults |
ConnectApi.getConfiguration(String accountId,
String connectId)
Get a Connect Configuration Information
Retrieves the information for the specified DocuSign Connect configuration.
|
ConsumerDisclosure |
AccountsApi.getConsumerDisclosure(String accountId,
String langCode)
Gets the Electronic Record and Signature Disclosure.
|
ConsumerDisclosure |
EnvelopesApi.getConsumerDisclosure(String accountId,
String envelopeId,
String recipientId,
String langCode)
Reserved: Gets the Electronic Record and Signature Disclosure associated with the account.
|
ConsumerDisclosure |
EnvelopesApi.getConsumerDisclosure(String accountId,
String envelopeId,
String recipientId,
String langCode,
EnvelopesApi.GetConsumerDisclosureOptions options)
Reserved: Gets the Electronic Record and Signature Disclosure associated with the account.
|
ConsumerDisclosure |
AccountsApi.getConsumerDisclosureDefault(String accountId)
Gets the Electronic Record and Signature Disclosure for the account.
|
ConsumerDisclosure |
AccountsApi.getConsumerDisclosureDefault(String accountId,
AccountsApi.GetConsumerDisclosureDefaultOptions options)
Gets the Electronic Record and Signature Disclosure for the account.
|
ConsumerDisclosure |
EnvelopesApi.getConsumerDisclosureDefault(String accountId,
String envelopeId,
String recipientId)
Gets the Electronic Record and Signature Disclosure associated with the account.
|
ConsumerDisclosure |
EnvelopesApi.getConsumerDisclosureDefault(String accountId,
String envelopeId,
String recipientId,
EnvelopesApi.GetConsumerDisclosureDefaultOptions options)
Gets the Electronic Record and Signature Disclosure associated with the account.
|
ContactGetResponse |
UsersApi.getContactById(String accountId,
String contactId)
Gets a particular contact associated with the user's account.
|
CreditCardInformation |
BillingApi.getCreditCardInfo(String accountId)
Get metadata for a given credit card.
|
byte[] |
EnvelopesApi.getDocument(String accountId,
String envelopeId,
String documentId)
Gets a document from an envelope.
|
byte[] |
TemplatesApi.getDocument(String accountId,
String templateId,
String documentId)
Gets PDF documents from a template.
|
byte[] |
EnvelopesApi.getDocument(String accountId,
String envelopeId,
String documentId,
EnvelopesApi.GetDocumentOptions options)
Gets a document from an envelope.
|
byte[] |
TemplatesApi.getDocument(String accountId,
String templateId,
String documentId,
TemplatesApi.GetDocumentOptions options)
Gets PDF documents from a template.
|
byte[] |
EnvelopesApi.getDocumentPageImage(String accountId,
String envelopeId,
String documentId,
String pageNumber)
Gets a page image from an envelope for display.
|
byte[] |
TemplatesApi.getDocumentPageImage(String accountId,
String templateId,
String documentId,
String pageNumber)
Gets a page image from a template for display.
|
byte[] |
EnvelopesApi.getDocumentPageImage(String accountId,
String envelopeId,
String documentId,
String pageNumber,
EnvelopesApi.GetDocumentPageImageOptions options)
Gets a page image from an envelope for display.
|
byte[] |
TemplatesApi.getDocumentPageImage(String accountId,
String templateId,
String documentId,
String pageNumber,
TemplatesApi.GetDocumentPageImageOptions options)
Gets a page image from a template for display.
|
Tabs |
EnvelopesApi.getDocumentTabs(String accountId,
String envelopeId,
String documentId)
Returns tabs on the document.
|
Tabs |
TemplatesApi.getDocumentTabs(String accountId,
String templateId,
String documentId)
Returns tabs on the document.
|
Tabs |
EnvelopesApi.getDocumentTabs(String accountId,
String envelopeId,
String documentId,
EnvelopesApi.GetDocumentTabsOptions options)
Returns tabs on the document.
|
Tabs |
TemplatesApi.getDocumentTabs(String accountId,
String templateId,
String documentId,
TemplatesApi.GetDocumentTabsOptions options)
Returns tabs on the document.
|
EmailSettings |
EnvelopesApi.getEmailSettings(String accountId,
String envelopeId)
Gets the email setting overrides for an envelope.
|
ENoteConfiguration |
AccountsApi.getENoteConfiguration(String accountId)
Returns the configuration information for the eNote eOriginal integration.
|
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.
|
DocumentHtmlDefinitionOriginals |
EnvelopesApi.getEnvelopeDocumentHtmlDefinitions(String accountId,
String envelopeId,
String documentId)
Get the Original HTML Definition used to generate the Responsive HTML for a given document.
|
DocumentHtmlDefinitionOriginals |
EnvelopesApi.getEnvelopeHtmlDefinitions(String accountId,
String envelopeId)
Get the Original HTML Definition used to generate the Responsive HTML for the envelope.
|
ConnectLog |
ConnectApi.getEventLog(String accountId,
String logId)
Get the specified Connect log entry.
|
ConnectLog |
ConnectApi.getEventLog(String accountId,
String logId,
ConnectApi.GetEventLogOptions options)
Get the specified Connect log entry.
|
EnvelopeFormData |
EnvelopesApi.getFormData(String accountId,
String envelopeId)
Returns envelope form data for an existing envelope.
|
UserInformation |
UsersApi.getInformation(String accountId,
String userId)
Gets the user information for a specified user.
|
UserInformation |
UsersApi.getInformation(String accountId,
String userId,
UsersApi.GetInformationOptions options)
Gets the user information for a specified user.
|
BillingInvoice |
BillingApi.getInvoice(String accountId,
String invoiceId)
Retrieves a billing invoice.
|
LockInformation |
EnvelopesApi.getLock(String accountId,
String envelopeId)
Gets envelope lock information.
|
LockInformation |
TemplatesApi.getLock(String accountId,
String templateId)
Gets template lock information.
|
Notification |
EnvelopesApi.getNotificationSettings(String accountId,
String envelopeId)
Gets envelope notification information.
|
Notification |
TemplatesApi.getNotificationSettings(String accountId,
String templateId)
Gets template notification information.
|
OauthAccess |
AuthenticationApi.getOAuthToken()
Creates an authorization token.
|
PageImages |
EnvelopesApi.getPages(String accountId,
String envelopeId,
String documentId)
Returns document page image(s) based on input.
|
PageImages |
TemplatesApi.getPages(String accountId,
String templateId,
String documentId)
Returns document page image(s) based on input.
|
PageImages |
EnvelopesApi.getPages(String accountId,
String envelopeId,
String documentId,
EnvelopesApi.GetPagesOptions options)
Returns document page image(s) based on input.
|
PageImages |
TemplatesApi.getPages(String accountId,
String templateId,
String documentId,
TemplatesApi.GetPagesOptions options)
Returns document page image(s) based on input.
|
Tabs |
EnvelopesApi.getPageTabs(String accountId,
String envelopeId,
String documentId,
String pageNumber)
Returns tabs on the specified page.
|
Tabs |
TemplatesApi.getPageTabs(String accountId,
String templateId,
String documentId,
String pageNumber)
Returns tabs on the specified page.
|
UserPasswordRules |
AccountsApi.getPasswordRules()
Get membership account password rules
|
BillingPaymentItem |
BillingApi.getPayment(String accountId,
String paymentId)
Gets billing payment information for a specific payment.
|
PermissionProfile |
AccountsApi.getPermissionProfile(String accountId,
String permissionProfileId)
Returns a permissions profile in the specified account.
|
PermissionProfile |
AccountsApi.getPermissionProfile(String accountId,
String permissionProfileId,
AccountsApi.GetPermissionProfileOptions options)
Returns a permissions profile in the specified account.
|
AccountBillingPlanResponse |
BillingApi.getPlan(String accountId)
Get Account Billing Plan
Retrieves the billing plan information for the specified account, including the current billing plan, successor plans, billing address, and billing credit card.
|
AccountBillingPlanResponse |
BillingApi.getPlan(String accountId,
BillingApi.GetPlanOptions options)
Get Account Billing Plan
Retrieves the billing plan information for the specified account, including the current billing plan, successor plans, billing address, and billing credit card.
|
PowerForm |
PowerFormsApi.getPowerForm(String accountId,
String powerFormId)
Returns a single PowerForm.
|
PowerFormsFormDataResponse |
PowerFormsApi.getPowerFormData(String accountId,
String powerFormId)
Returns the form data associated with the usage of a PowerForm.
|
PowerFormsFormDataResponse |
PowerFormsApi.getPowerFormData(String accountId,
String powerFormId,
PowerFormsApi.GetPowerFormDataOptions options)
Returns the form data associated with the usage of a PowerForm.
|
UserProfile |
UsersApi.getProfile(String accountId,
String userId)
Retrieves the user profile for a specified user.
|
byte[] |
UsersApi.getProfileImage(String accountId,
String userId)
Retrieves the user profile image for the specified user.
|
byte[] |
UsersApi.getProfileImage(String accountId,
String userId,
UsersApi.GetProfileImageOptions options)
Retrieves the user profile image for the specified user.
|
CloudStorageProviders |
CloudStorageApi.getProvider(String accountId,
String userId,
String serviceId)
Gets the specified Cloud Storage Provider configuration for the User.
|
CloudStorageProviders |
CloudStorageApi.getProvider(String accountId,
String userId,
String serviceId,
CloudStorageApi.GetProviderOptions options)
Gets the specified Cloud Storage Provider configuration for the User.
|
ProvisioningInformation |
AccountsApi.getProvisioning()
Retrieves the account provisioning information for the account.
|
DocumentVisibilityList |
EnvelopesApi.getRecipientDocumentVisibility(String accountId,
String envelopeId,
String recipientId)
Returns document visibility for the recipients
|
byte[] |
EnvelopesApi.getRecipientInitialsImage(String accountId,
String envelopeId,
String recipientId)
Gets the initials image for a user.
|
byte[] |
EnvelopesApi.getRecipientInitialsImage(String accountId,
String envelopeId,
String recipientId,
EnvelopesApi.GetRecipientInitialsImageOptions options)
Gets the initials image for a user.
|
BulkRecipientsResponse |
BulkEnvelopesApi.getRecipients(String accountId,
String envelopeId,
String recipientId)
Gets the bulk recipient file from an envelope.
|
BulkRecipientsResponse |
BulkEnvelopesApi.getRecipients(String accountId,
String envelopeId,
String recipientId,
BulkEnvelopesApi.GetRecipientsOptions options)
Gets the bulk recipient file from an envelope.
|
UserSignature |
EnvelopesApi.getRecipientSignature(String accountId,
String envelopeId,
String recipientId)
Gets signature information for a signer or sign-in-person recipient.
|
byte[] |
EnvelopesApi.getRecipientSignatureImage(String accountId,
String envelopeId,
String recipientId)
Retrieve signature image information for a signer/sign-in-person recipient.
|
byte[] |
EnvelopesApi.getRecipientSignatureImage(String accountId,
String envelopeId,
String recipientId,
EnvelopesApi.GetRecipientSignatureImageOptions options)
Retrieve signature image information for a signer/sign-in-person recipient.
|
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.
|
AccountSeals |
TrustServiceProvidersApi.getSealProviders(String accountId)
Returns Account available seals for specified account.
|
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.
|
UserSignature |
UsersApi.getSignature(String accountId,
String userId,
String signatureId)
Gets the user signature information for the specified user.
|
byte[] |
UsersApi.getSignatureImage(String accountId,
String userId,
String signatureId,
String imageType)
Retrieves the user initials image or the user signature image for the specified user.
|
byte[] |
UsersApi.getSignatureImage(String accountId,
String userId,
String signatureId,
String imageType,
UsersApi.GetSignatureImageOptions options)
Retrieves the user initials image or the user signature image for the specified user.
|
SupportedLanguages |
AccountsApi.getSupportedLanguages(String accountId)
Gets list of supported languages for recipient language setting.
|
DocumentVisibilityList |
EnvelopesApi.getTemplateRecipientDocumentVisibility(String accountId,
String templateId,
String recipientId)
Returns document visibility for the recipients
|
UserInfoResponse |
TrustServiceProvidersApi.getUserInfo()
Get User Info To Sign Document
|
void |
OrganizationsApi.getUserListExport(String organizationId,
String resultId)
Retrieves an attachment from the envelope.
|
Watermark |
AccountsApi.getWatermark(String accountId)
Get watermark information.
|
Watermark |
AccountsApi.getWatermarkPreview(String accountId,
Watermark watermark)
Get watermark preview.
|
Workspace |
WorkspacesApi.getWorkspace(String accountId,
String workspaceId)
Get Workspace
Retrives properties about a workspace given a unique workspaceId.
|
void |
WorkspacesApi.getWorkspaceFile(String accountId,
String workspaceId,
String folderId,
String fileId)
Get Workspace File
Retrieves a workspace file (the binary).
|
void |
WorkspacesApi.getWorkspaceFile(String accountId,
String workspaceId,
String folderId,
String fileId,
WorkspacesApi.GetWorkspaceFileOptions options)
Get Workspace File
Retrieves a workspace file (the binary).
|
void |
TrustServiceProvidersApi.healthCheck(TspHealthCheckRequest tspHealthCheckRequest)
Report status from the TSP to DocuSign
|
BulkEnvelopesResponse |
BulkEnvelopesApi.list(String accountId)
Gets status information about bulk recipient batches.
|
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.
|
SigningGroupInformation |
SigningGroupsApi.list(String accountId)
Gets a list of the Signing Groups in an account.
|
UserInformationList |
UsersApi.list(String accountId)
Retrieves the list of users for the specified account.
|
BulkEnvelopesResponse |
BulkEnvelopesApi.list(String accountId,
BulkEnvelopesApi.ListOptions options)
Gets status information about bulk recipient batches.
|
TabMetadataList |
CustomTabsApi.list(String accountId,
CustomTabsApi.ListOptions options)
Gets a list of all account tabs.
|
FoldersResponse |
FoldersApi.list(String accountId,
FoldersApi.ListOptions options)
Gets a list of the folders for the account.
|
SigningGroupInformation |
SigningGroupsApi.list(String accountId,
SigningGroupsApi.ListOptions options)
Gets a list of the Signing Groups in an account.
|
ExternalFolder |
CloudStorageApi.list(String accountId,
String userId,
String serviceId,
String folderId)
Gets a list of all the items from the specified cloud storage provider.
|
ExternalFolder |
CloudStorageApi.list(String accountId,
String userId,
String serviceId,
String folderId,
CloudStorageApi.ListOptions options)
Gets a list of all the items from the specified cloud storage provider.
|
UserInformationList |
UsersApi.list(String accountId,
UsersApi.ListOptions options)
Retrieves the list of users for the specified account.
|
EnvelopeAuditEventResponse |
EnvelopesApi.listAuditEvents(String accountId,
String envelopeId)
Gets the envelope audit events for an envelope.
|
BillingPlansResponse |
BillingApi.listBillingPlans()
Gets the list of available billing plans.
|
BrandsResponse |
AccountsApi.listBrands(String accountId)
Gets a list of brand profiles.
|
BrandsResponse |
AccountsApi.listBrands(String accountId,
AccountsApi.ListBrandsOptions options)
Gets a list of brand profiles.
|
BulkRecipientsResponse |
TemplatesApi.listBulkRecipients(String accountId,
String templateId,
String recipientId)
Gets the bulk recipient file from a template.
|
BulkRecipientsResponse |
TemplatesApi.listBulkRecipients(String accountId,
String templateId,
String recipientId,
TemplatesApi.ListBulkRecipientsOptions options)
Gets the bulk recipient file from a template.
|
ConnectConfigResults |
ConnectApi.listConfigurations(String accountId)
Get Connect Configuration Information
Retrieves all the DocuSign Custom Connect definitions for the specified account.
|
CustomFields |
AccountsApi.listCustomFields(String accountId)
Gets a list of custom fields associated with the account.
|
CustomFieldsEnvelope |
EnvelopesApi.listCustomFields(String accountId,
String envelopeId)
Gets the custom field information for the specified envelope.
|
CustomFields |
TemplatesApi.listCustomFields(String accountId,
String templateId)
Gets the custom document fields from a template.
|
CustomSettingsInformation |
UsersApi.listCustomSettings(String accountId,
String userId)
Retrieves the custom user settings for a specified user.
|
DocumentFieldsInformation |
EnvelopesApi.listDocumentFields(String accountId,
String envelopeId,
String documentId)
Gets the custom document fields from an existing envelope document.
|
DocumentFieldsInformation |
TemplatesApi.listDocumentFields(String accountId,
String templateId,
String documentId)
Gets the custom document fields for a an existing template document.
|
DocumentHtmlDefinitionOriginals |
EnvelopesApi.listDocumentResponsiveHtmlPreview(String accountId,
String envelopeId,
String documentId)
Get the Original HTML Definition used to generate the Responsive HTML for a given document.
|
EnvelopeDocumentsResult |
EnvelopesApi.listDocuments(String accountId,
String envelopeId)
Gets a list of envelope documents.
|
TemplateDocumentsResult |
TemplatesApi.listDocuments(String accountId,
String templateId)
Gets a list of documents associated with a template.
|
ConnectLogs |
ConnectApi.listEventFailureLogs(String accountId)
Gets the Connect failure log information.
|
ConnectLogs |
ConnectApi.listEventFailureLogs(String accountId,
ConnectApi.ListEventFailureLogsOptions options)
Gets the Connect failure log information.
|
ConnectLogs |
ConnectApi.listEventLogs(String accountId)
Gets the Connect log.
|
ConnectLogs |
ConnectApi.listEventLogs(String accountId,
ConnectApi.ListEventLogsOptions options)
Gets the Connect log.
|
ExternalFolder |
CloudStorageApi.listFolders(String accountId,
String userId,
String serviceId)
Retrieves a list of all the items in a specified folder from the specified cloud storage provider.
|
ExternalFolder |
CloudStorageApi.listFolders(String accountId,
String userId,
String serviceId,
CloudStorageApi.ListFoldersOptions options)
Retrieves a list of all the items in a specified folder from the specified cloud storage provider.
|
GroupInformation |
GroupsApi.listGroups(String accountId)
Gets information about groups associated with the account.
|
GroupInformation |
GroupsApi.listGroups(String accountId,
GroupsApi.ListGroupsOptions options)
Gets information about groups associated with the account.
|
UsersResponse |
GroupsApi.listGroupUsers(String accountId,
String groupId)
Gets a list of users in a group.
|
UsersResponse |
GroupsApi.listGroupUsers(String accountId,
String groupId,
GroupsApi.ListGroupUsersOptions options)
Gets a list of users in a group.
|
BillingInvoicesResponse |
BillingApi.listInvoices(String accountId)
Get a List of Billing Invoices
Retrieves a list of invoices for the account.
|
BillingInvoicesResponse |
BillingApi.listInvoices(String accountId,
BillingApi.ListInvoicesOptions options)
Get a List of Billing Invoices
Retrieves a list of invoices for the account.
|
BillingInvoicesSummary |
BillingApi.listInvoicesPastDue(String accountId)
Get a list of past due invoices.
|
FolderItemsResponse |
FoldersApi.listItems(String accountId,
String folderId)
Gets a list of the envelopes in the specified folder.
|
FolderItemsResponse |
FoldersApi.listItems(String accountId,
String folderId,
FoldersApi.ListItemsOptions options)
Gets a list of the envelopes in the specified folder.
|
MobileNotifierConfigurationInformation |
ConnectApi.listMobileNotifiers(String accountId)
Reserved
Reserved:
|
NotaryJournalList |
NotaryApi.listNotaryJournals()
Get notary jurisdictions for a user
|
NotaryJournalList |
NotaryApi.listNotaryJournals(NotaryApi.ListNotaryJournalsOptions options)
Get notary jurisdictions for a user
|
BillingPaymentsResponse |
BillingApi.listPayments(String accountId)
Gets payment information for one or more payments.
|
BillingPaymentsResponse |
BillingApi.listPayments(String accountId,
BillingApi.ListPaymentsOptions options)
Gets payment information for one or more payments.
|
PermissionProfileInformation |
AccountsApi.listPermissions(String accountId)
Gets a list of permission profiles.
|
PermissionProfileInformation |
AccountsApi.listPermissions(String accountId,
AccountsApi.ListPermissionsOptions options)
Gets a list of permission profiles.
|
PowerFormsResponse |
PowerFormsApi.listPowerForms(String accountId)
Returns the list of PowerForms available to the user.
|
PowerFormsResponse |
PowerFormsApi.listPowerForms(String accountId,
PowerFormsApi.ListPowerFormsOptions options)
Returns the list of PowerForms available to the user.
|
PowerFormSendersResponse |
PowerFormsApi.listPowerFormSenders(String accountId)
Returns the list of PowerForms available to the user.
|
PowerFormSendersResponse |
PowerFormsApi.listPowerFormSenders(String accountId,
PowerFormsApi.ListPowerFormSendersOptions options)
Returns the list of PowerForms available to the user.
|
CloudStorageProviders |
CloudStorageApi.listProviders(String accountId,
String userId)
Get the Cloud Storage Provider configuration for the specified user.
|
CloudStorageProviders |
CloudStorageApi.listProviders(String accountId,
String userId,
CloudStorageApi.ListProvidersOptions options)
Get the Cloud Storage Provider configuration for the specified user.
|
RecipientNamesResponse |
AccountsApi.listRecipientNamesByEmail(String accountId)
Gets recipient names associated with an email address.
|
RecipientNamesResponse |
AccountsApi.listRecipientNamesByEmail(String accountId,
AccountsApi.ListRecipientNamesByEmailOptions options)
Gets recipient names associated with an email address.
|
Recipients |
EnvelopesApi.listRecipients(String accountId,
String envelopeId)
Gets the status of recipients for an envelope.
|
Recipients |
TemplatesApi.listRecipients(String accountId,
String templateId)
Gets recipient information from a template.
|
Recipients |
EnvelopesApi.listRecipients(String accountId,
String envelopeId,
EnvelopesApi.ListRecipientsOptions options)
Gets the status of recipients for an envelope.
|
Recipients |
TemplatesApi.listRecipients(String accountId,
String templateId,
TemplatesApi.ListRecipientsOptions options)
Gets recipient information from a template.
|
ApiRequestLogsResult |
DiagnosticsApi.listRequestLogs()
Gets the API request logging log files.
|
ApiRequestLogsResult |
DiagnosticsApi.listRequestLogs(DiagnosticsApi.ListRequestLogsOptions options)
Gets the API request logging log files.
|
DocumentHtmlDefinitionOriginals |
EnvelopesApi.listResponsiveHtmlPreview(String accountId,
String envelopeId)
Get the Original HTML Definition used to generate the Responsive HTML for the envelope.
|
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.
|
AccountSharedAccess |
AccountsApi.listSharedAccess(String accountId,
AccountsApi.ListSharedAccessOptions options)
Reserved: Gets the shared item status for one or more users.
|
AccountSignatureProviders |
AccountsApi.listSignatureProviders(String accountId)
Returns Account available signature providers for specified account.
|
UserSignaturesInformation |
UsersApi.listSignatures(String accountId,
String userId)
Retrieves a list of user signature definitions for a specified user.
|
UserSignaturesInformation |
UsersApi.listSignatures(String accountId,
String userId,
UsersApi.ListSignaturesOptions options)
Retrieves a list of user signature definitions for a specified user.
|
UserSocialIdResult |
AuthenticationApi.listSocialLogins(String accountId,
String userId)
Gets a list of a user's social accounts.
|
EnvelopesInformation |
EnvelopesApi.listStatus(String accountId,
EnvelopeIdsRequest envelopeIdsRequest)
Gets the envelope status for the specified envelopes.
|
EnvelopesInformation |
EnvelopesApi.listStatus(String accountId,
EnvelopeIdsRequest envelopeIdsRequest,
EnvelopesApi.ListStatusOptions options)
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 |
TemplatesApi.listTabs(String accountId,
String templateId,
String recipientId)
Gets the tabs information for a signer or sign-in-person recipient in a template.
|
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,
TemplatesApi.ListTabsOptions options)
Gets the tabs information for a signer or sign-in-person recipient in a template.
|
DocumentHtmlDefinitionOriginals |
TemplatesApi.listTemplateDocumentResponsiveHtmlPreview(String accountId,
String templateId,
String documentId)
Get the Original HTML Definition used to generate the Responsive HTML for a given document in a template.
|
DocumentHtmlDefinitionOriginals |
TemplatesApi.listTemplateResponsiveHtmlPreview(String accountId,
String templateId)
Get the Original HTML Definition used to generate the Responsive HTML for the 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.
|
TemplateInformation |
EnvelopesApi.listTemplates(String accountId,
String envelopeId,
EnvelopesApi.ListTemplatesOptions options)
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.
|
EnvelopeTemplateResults |
TemplatesApi.listTemplates(String accountId,
TemplatesApi.ListTemplatesOptions options)
Gets the definition of a template.
|
TemplateInformation |
EnvelopesApi.listTemplatesForDocument(String accountId,
String envelopeId,
String documentId)
Gets the templates associated with a document in an existing envelope.
|
TemplateInformation |
EnvelopesApi.listTemplatesForDocument(String accountId,
String envelopeId,
String documentId,
EnvelopesApi.ListTemplatesForDocumentOptions options)
Gets the templates associated with a document in an existing envelope.
|
ResourceInformation |
ConnectApi.listTests(String accountId,
String connectId)
Test connect configuration.
|
FileTypeList |
AccountsApi.listUnsupportedFileTypes(String accountId)
Gets a list of unsupported file types.
|
IntegratedUserInfoList |
ConnectApi.listUsers(String accountId,
String connectId)
Returns users from the configured Connect service.
|
SigningGroupUsers |
SigningGroupsApi.listUsers(String accountId,
String signingGroupId)
Gets a list of members in a Signing Group.
|
IntegratedUserInfoList |
ConnectApi.listUsers(String accountId,
String connectId,
ConnectApi.ListUsersOptions options)
Returns users from the configured Connect service.
|
PageImages |
WorkspacesApi.listWorkspaceFilePages(String accountId,
String workspaceId,
String folderId,
String fileId)
List File Pages
Retrieves a workspace file as rasterized pages.
|
PageImages |
WorkspacesApi.listWorkspaceFilePages(String accountId,
String workspaceId,
String folderId,
String fileId,
WorkspacesApi.ListWorkspaceFilePagesOptions options)
List File Pages
Retrieves a workspace file as rasterized pages.
|
WorkspaceFolderContents |
WorkspacesApi.listWorkspaceFolderItems(String accountId,
String workspaceId,
String folderId)
List Workspace Folder Contents
Retrieves workspace folder contents, which can include sub folders and files.
|
WorkspaceFolderContents |
WorkspacesApi.listWorkspaceFolderItems(String accountId,
String workspaceId,
String folderId,
WorkspacesApi.ListWorkspaceFolderItemsOptions options)
List Workspace Folder Contents
Retrieves workspace folder contents, which can include sub folders and files.
|
WorkspaceList |
WorkspacesApi.listWorkspaces(String accountId)
List Workspaces
Gets information about the Workspaces that have been created.
|
LoginInformation |
AuthenticationApi.login()
Gets login information for a specified user.
|
LoginInformation |
AuthenticationApi.login(AuthenticationApi.LoginOptions options)
Gets login information for a specified user.
|
BillingPaymentResponse |
BillingApi.makePayment(String accountId,
BillingPaymentRequest billingPaymentRequest)
Posts a payment to a past due invoice.
|
FoldersResponse |
FoldersApi.moveEnvelopes(String accountId,
String folderId,
FoldersRequest foldersRequest)
Moves an envelope from its current folder to the specified folder.
|
ContactUpdateResponse |
UsersApi.postContacts(String accountId,
ContactModRequest contactModRequest)
Imports multiple new contacts into the contacts collection from CSV, JSON, or XML (based on content type).
|
void |
BillingApi.purchaseEnvelopes(String accountId,
PurchasedEnvelopesInformation purchasedEnvelopesInformation)
Reserverd: Purchase additional envelopes.
|
EnvelopeAttachmentsResult |
EnvelopesApi.putAttachment(String accountId,
String envelopeId,
String attachmentId,
Attachment attachment)
Add an attachment to a DRAFT or IN-PROCESS envelope.
|
EnvelopeAttachmentsResult |
EnvelopesApi.putAttachments(String accountId,
String envelopeId,
EnvelopeAttachmentsRequest envelopeAttachmentsRequest)
Add one or more attachments to a DRAFT or IN-PROCESS envelope.
|
ContactUpdateResponse |
UsersApi.putContacts(String accountId,
ContactModRequest contactModRequest)
Replaces contacts associated with an account for the DocuSign service.
|
ConnectFailureResults |
ConnectApi.retryEventForEnvelope(String accountId,
String envelopeId)
Republishes Connect information for the specified envelope.
|
ConnectFailureResults |
ConnectApi.retryEventForEnvelopes(String accountId,
ConnectFailureFilter connectFailureFilter)
Republishes Connect information for multiple envelopes.
|
void |
AuthenticationApi.revokeOAuthToken()
Revokes an authorization token.
|
void |
EnvelopesApi.rotateDocumentPage(String accountId,
String envelopeId,
String documentId,
String pageNumber,
PageRequest pageRequest)
Rotates page image from an envelope for display.
|
void |
TemplatesApi.rotateDocumentPage(String accountId,
String templateId,
String documentId,
String pageNumber,
PageRequest pageRequest)
Rotates page image from a template for display.
|
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.
|
SignHashSessionInfoResponse |
TrustServiceProvidersApi.signHashSessionInfo(SignSessionInfoRequest signSessionInfoRequest)
Get Signature Session Info To Sign Document Hash
|
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: * Sends the specified single draft envelope.
|
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: * Sends the specified single draft envelope.
|
TemplateUpdateSummary |
TemplatesApi.update(String accountId,
String templateId,
EnvelopeTemplate envelopeTemplate)
Updates an existing template.
|
SigningGroup |
SigningGroupsApi.update(String accountId,
String signingGroupId,
SigningGroup signingGroup)
Updates a signing group.
|
TabMetadata |
CustomTabsApi.update(String accountId,
String customTabId,
TabMetadata tabMetadata)
Updates custom tab information.
|
AccountPasswordRules |
AccountsApi.updateAccountPasswordRules(String accountId,
AccountPasswordRules accountPasswordRules)
Update the password rules
|
TabAccountSettings |
AccountsApi.updateAccountTabSettings(String accountId,
TabAccountSettings tabAccountSettings)
Modifies tab settings for specified account
|
Brand |
AccountsApi.updateBrand(String accountId,
String brandId,
Brand brand)
Updates an existing brand.
|
void |
AccountsApi.updateBrandLogoByType(String accountId,
String brandId,
String logoType)
Put one branding logo.
|
BrandResources |
AccountsApi.updateBrandResourcesByContentType(String accountId,
String brandId,
String resourceContentType)
Uploads a branding resource file.
|
BrandsResponse |
GroupsApi.updateBrands(String accountId,
String groupId,
BrandsRequest brandsRequest)
Adds group brand ID information to a group.
|
BulkRecipientsSummaryResponse |
TemplatesApi.updateBulkRecipients(String accountId,
String templateId,
String recipientId,
BulkRecipientsRequest bulkRecipientsRequest)
Adds or replaces the bulk recipients list in a template.
|
ChunkedUploadResponse |
EnvelopesApi.updateChunkedUpload(String accountId,
String chunkedUploadId)
Integrity-Check and Commit a ChunkedUpload, readying it for use elsewhere.
|
ChunkedUploadResponse |
EnvelopesApi.updateChunkedUpload(String accountId,
String chunkedUploadId,
EnvelopesApi.UpdateChunkedUploadOptions options)
Integrity-Check and Commit a ChunkedUpload, readying it for use elsewhere.
|
ChunkedUploadResponse |
EnvelopesApi.updateChunkedUploadPart(String accountId,
String chunkedUploadId,
String chunkedUploadPartSeq,
ChunkedUploadRequest chunkedUploadRequest)
Add a chunk, a chunk 'part', to an existing ChunkedUpload.
|
ConnectCustomConfiguration |
ConnectApi.updateConfiguration(String accountId,
ConnectCustomConfiguration connectCustomConfiguration)
Updates a specified Connect configuration.
|
ConsumerDisclosure |
AccountsApi.updateConsumerDisclosure(String accountId,
String langCode,
ConsumerDisclosure consumerDisclosure)
Update Consumer Disclosure.
|
ConsumerDisclosure |
AccountsApi.updateConsumerDisclosure(String accountId,
String langCode,
ConsumerDisclosure consumerDisclosure,
AccountsApi.UpdateConsumerDisclosureOptions options)
Update Consumer Disclosure.
|
CustomFields |
AccountsApi.updateCustomField(String accountId,
String customFieldId,
CustomField customField)
Updates an existing account custom field.
|
CustomFields |
AccountsApi.updateCustomField(String accountId,
String customFieldId,
CustomField customField,
AccountsApi.UpdateCustomFieldOptions options)
Updates an existing account custom field.
|
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.
|
CustomSettingsInformation |
UsersApi.updateCustomSettings(String accountId,
String userId,
CustomSettingsInformation customSettingsInformation)
Adds or updates custom user settings for the specified user.
|
void |
EnvelopesApi.updateDocument(String accountId,
String envelopeId,
String documentId)
Adds a document to an existing draft envelope.
|
EnvelopeDocument |
TemplatesApi.updateDocument(String accountId,
String templateId,
String documentId,
EnvelopeDefinition envelopeDefinition)
Adds a document to a template document.
|
EnvelopeDocument |
TemplatesApi.updateDocument(String accountId,
String templateId,
String documentId,
EnvelopeDefinition envelopeDefinition,
TemplatesApi.UpdateDocumentOptions options)
Adds a document to a template document.
|
void |
EnvelopesApi.updateDocument(String accountId,
String envelopeId,
String documentId,
EnvelopesApi.UpdateDocumentOptions options)
Adds a document to an existing draft envelope.
|
DocumentFieldsInformation |
EnvelopesApi.updateDocumentFields(String accountId,
String envelopeId,
String documentId,
DocumentFieldsInformation documentFieldsInformation)
Updates existing custom document fields in an existing envelope document.
|
DocumentFieldsInformation |
TemplatesApi.updateDocumentFields(String accountId,
String templateId,
String documentId,
DocumentFieldsInformation documentFieldsInformation)
Updates existing custom document fields in an existing template document.
|
EnvelopeDocumentsResult |
EnvelopesApi.updateDocuments(String accountId,
String envelopeId,
EnvelopeDefinition envelopeDefinition)
Adds one or more documents to 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,
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.
|
ENoteConfiguration |
AccountsApi.updateENoteConfiguration(String accountId,
ENoteConfiguration eNoteConfiguration)
Updates configuration information for the eNote eOriginal integration.
|
GroupInformation |
GroupsApi.updateGroups(String accountId,
GroupInformation groupInformation)
Updates the group information for a group.
|
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.
|
UsersResponse |
GroupsApi.updateGroupUsers(String accountId,
String groupId,
UserInfoList userInfoList)
Adds one or more users to an existing group.
|
SigningGroupInformation |
SigningGroupsApi.updateList(String accountId,
SigningGroupInformation signingGroupInformation)
Updates signing group names.
|
LockInformation |
EnvelopesApi.updateLock(String accountId,
String envelopeId,
LockRequest lockRequest)
Updates an envelope lock.
|
LockInformation |
TemplatesApi.updateLock(String accountId,
String templateId,
LockRequest lockRequest)
Updates a template lock.
|
MobileNotifierConfigurationInformation |
ConnectApi.updateMobileNotifiers(String accountId,
MobileNotifierConfigurationInformation mobileNotifierConfigurationInformation)
Reserved
Reserved:
|
Notification |
EnvelopesApi.updateNotificationSettings(String accountId,
String envelopeId,
EnvelopeNotificationRequest envelopeNotificationRequest)
Sets envelope notification (Reminders/Expirations) structure for an existing envelope.
|
Notification |
TemplatesApi.updateNotificationSettings(String accountId,
String templateId,
TemplateNotificationRequest templateNotificationRequest)
Updates the notification structure for an existing template.
|
void |
AuthenticationApi.updatePassword(String loginPart,
UserPasswordInformation userPasswordInformation)
Updates the password for a specified user.
|
PermissionProfile |
AccountsApi.updatePermissionProfile(String accountId,
String permissionProfileId,
PermissionProfile permissionProfile)
Updates a permission profile within the specified account.
|
PermissionProfile |
AccountsApi.updatePermissionProfile(String accountId,
String permissionProfileId,
PermissionProfile permissionProfile,
AccountsApi.UpdatePermissionProfileOptions options)
Updates a permission profile within the specified account.
|
BillingPlanUpdateResponse |
BillingApi.updatePlan(String accountId,
BillingPlanInformation billingPlanInformation)
Updates the account billing plan.
|
BillingPlanUpdateResponse |
BillingApi.updatePlan(String accountId,
BillingPlanInformation billingPlanInformation,
BillingApi.UpdatePlanOptions options)
Updates the account billing plan.
|
PowerForm |
PowerFormsApi.updatePowerForm(String accountId,
String powerFormId,
PowerForm powerForm)
Creates a new PowerForm.
|
void |
UsersApi.updateProfile(String accountId,
String userId,
UserProfile userProfile)
Updates the user profile information for the specified user.
|
void |
UsersApi.updateProfileImage(String accountId,
String userId)
Updates the user profile image for a specified user.
|
DocumentVisibilityList |
EnvelopesApi.updateRecipientDocumentVisibility(String accountId,
String envelopeId,
String recipientId,
DocumentVisibilityList documentVisibilityList)
Updates document visibility for the recipients
|
void |
EnvelopesApi.updateRecipientInitialsImage(String accountId,
String envelopeId,
String recipientId)
Sets the initials image for an accountless signer.
|
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 |
EnvelopesApi.updateRecipients(String accountId,
String envelopeId,
Recipients recipients,
EnvelopesApi.UpdateRecipientsOptions options)
Updates recipients in a draft envelope or corrects recipient information for an in process envelope.
|
BulkRecipientsSummaryResponse |
BulkEnvelopesApi.updateRecipients(String accountId,
String envelopeId,
String recipientId,
BulkRecipientsRequest bulkRecipientsRequest)
Adds or replaces envelope bulk recipients.
|
RecipientsUpdateSummary |
TemplatesApi.updateRecipients(String accountId,
String templateId,
TemplateRecipients templateRecipients)
Updates recipients in a template.
|
RecipientsUpdateSummary |
TemplatesApi.updateRecipients(String accountId,
String templateId,
TemplateRecipients templateRecipients,
TemplatesApi.UpdateRecipientsOptions options)
Updates recipients in a template.
|
DocumentVisibilityList |
EnvelopesApi.updateRecipientsDocumentVisibility(String accountId,
String envelopeId,
DocumentVisibilityList documentVisibilityList)
Updates document visibility for the recipients
|
void |
EnvelopesApi.updateRecipientSignatureImage(String accountId,
String envelopeId,
String recipientId)
Sets the signature image for an accountless signer.
|
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.
|
void |
UsersApi.updateSettings(String accountId,
String userId,
UserSettingsInformation userSettingsInformation)
Updates the user account settings for a specified user.
|
AccountSharedAccess |
AccountsApi.updateSharedAccess(String accountId,
AccountSharedAccess accountSharedAccess)
Reserved: Sets the shared access information for users.
|
AccountSharedAccess |
AccountsApi.updateSharedAccess(String accountId,
AccountSharedAccess accountSharedAccess,
AccountsApi.UpdateSharedAccessOptions options)
Reserved: Sets the shared access information for users.
|
UserSignature |
UsersApi.updateSignature(String accountId,
String userId,
String signatureId,
UserSignatureDefinition userSignatureDefinition)
Updates the user signature for a specified user.
|
UserSignature |
UsersApi.updateSignature(String accountId,
String userId,
String signatureId,
UserSignatureDefinition userSignatureDefinition,
UsersApi.UpdateSignatureOptions options)
Updates the user signature for a specified user.
|
UserSignature |
UsersApi.updateSignatureImage(String accountId,
String userId,
String signatureId,
String imageType)
Updates the user signature image or user initials image for the specified user.
|
UserSignaturesInformation |
UsersApi.updateSignatures(String accountId,
String userId,
UserSignaturesInformation userSignaturesInformation)
Adds/updates a user signature.
|
void |
AuthenticationApi.updateSocialLogin(String accountId,
String userId,
SocialAccountInformation socialAccountInformation)
Adds social account for a user.
|
Tabs |
EnvelopesApi.updateTabs(String accountId,
String envelopeId,
String recipientId,
Tabs tabs)
Updates the tabs for a recipient.
|
Tabs |
TemplatesApi.updateTabs(String accountId,
String templateId,
String recipientId,
TemplateTabs templateTabs)
Updates the tabs for a recipient.
|
TemplateDocumentVisibilityList |
EnvelopesApi.updateTemplateRecipientDocumentVisibility(String accountId,
String templateId,
String recipientId,
TemplateDocumentVisibilityList templateDocumentVisibilityList)
Updates document visibility for the recipients
|
TemplateDocumentVisibilityList |
EnvelopesApi.updateTemplateRecipientsDocumentVisibility(String accountId,
String templateId,
TemplateDocumentVisibilityList templateDocumentVisibilityList)
Updates document visibility for the recipients
|
UpdateTransactionResponse |
TrustServiceProvidersApi.updateTransaction(UpdateTransactionRequest updateTransactionRequest)
Report an error from the tsp to docusign
|
UserInformation |
UsersApi.updateUser(String accountId,
String userId,
UserInformation userInformation)
Updates the specified user information.
|
SigningGroupUsers |
SigningGroupsApi.updateUsers(String accountId,
String signingGroupId,
SigningGroupUsers signingGroupUsers)
Adds members to a signing group.
|
UserInformationList |
UsersApi.updateUsers(String accountId,
UserInformationList userInformationList)
Change one or more user in the specified account.
|
Watermark |
AccountsApi.updateWatermark(String accountId,
Watermark watermark)
Update watermark information.
|
Workspace |
WorkspacesApi.updateWorkspace(String accountId,
String workspaceId,
Workspace workspace)
Update Workspace
Updates information about a specific workspace.
|
WorkspaceItem |
WorkspacesApi.updateWorkspaceFile(String accountId,
String workspaceId,
String folderId,
String fileId)
Update Workspace File Metadata
Updates workspace item metadata for one or more specific files/folders.
|
| Modifier and Type | Method and Description |
|---|---|
void |
ApiClient.configureJWTAuthorizationFlow(String publicKeyFilename,
String privateKeyFilename,
String oAuthBasePath,
String clientId,
String userId,
long expiresIn)
Deprecated.
As of release 2.7.0, replaced by
#requestJWTUserToken() and #requestJWTApplicationToken() |
OAuth.OAuthToken |
ApiClient.generateAccessToken(String clientId,
String clientSecret,
String code) |
OAuth.UserInfo |
ApiClient.getUserInfo(String accessToken) |
<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.
|
OAuth.OAuthToken |
ApiClient.requestJWTApplicationToken(String clientId,
List<String> scopes,
byte[] rsaPrivateKey,
long expiresIn)
RESERVED FOR PARTNERS Request JWT Application Token
Configures the current instance of ApiClient with a fresh OAuth JWT access token from DocuSign
|
OAuth.OAuthToken |
ApiClient.requestJWTUserToken(String clientId,
String userId,
List<String> scopes,
byte[] rsaPrivateKey,
long expiresIn)
Configures the current instance of ApiClient with a fresh OAuth JWT access token from DocuSign
|
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 © 2018. All rights reserved.