com.docusign.esign.api

Class AccountsApi

java.lang.Object

com.docusign.esign.api.AccountsApi

public class AccountsApi
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	AccountsApi.CreateCustomFieldOptions
class	AccountsApi.CreateOptions
class	AccountsApi.CreatePermissionProfileOptions
class	AccountsApi.DeleteCustomFieldOptions
class	AccountsApi.DeletePermissionProfileOptions
class	AccountsApi.GetAccountInformationOptions
class	AccountsApi.GetBillingChargesOptions
class	AccountsApi.GetBrandOptions
class	AccountsApi.GetBrandResourcesByContentTypeOptions
class	AccountsApi.GetConsumerDisclosureDefaultOptions
class	AccountsApi.GetPermissionProfileOptions
class	AccountsApi.ListBrandsOptions
class	AccountsApi.ListPermissionsOptions
class	AccountsApi.ListRecipientNamesByEmailOptions
class	AccountsApi.ListSharedAccessOptions
class	AccountsApi.UpdateConsumerDisclosureOptions
class	AccountsApi.UpdateCustomFieldOptions
class	AccountsApi.UpdatePermissionProfileOptions
class	AccountsApi.UpdateSharedAccessOptions

Constructor Summary

Constructors

Constructor and Description
AccountsApi()
AccountsApi(ApiClient apiClient)

Method Summary

Methods

Modifier and Type	Method and Description
NewAccountSummary	create(NewAccountDefinition newAccountDefinition) Creates new accounts.
NewAccountSummary	create(NewAccountDefinition newAccountDefinition, AccountsApi.CreateOptions options) Creates new accounts.
BrandsResponse	createBrand(String accountId, Brand brand) Creates one or more brand profile files for the account.
CustomFields	createCustomField(String accountId, CustomField customField) Creates an acount custom field.
CustomFields	createCustomField(String accountId, CustomField customField, AccountsApi.CreateCustomFieldOptions options) Creates an acount custom field.
PermissionProfile	createPermissionProfile(String accountId, PermissionProfile permissionProfile) Creates a new permission profile in the specified account.
PermissionProfile	createPermissionProfile(String accountId, PermissionProfile permissionProfile, AccountsApi.CreatePermissionProfileOptions options) Creates a new permission profile in the specified account.
void	delete(String accountId) Deletes the specified account.
void	deleteBrand(String accountId, String brandId) Removes a brand.
void	deleteBrandLogoByType(String accountId, String brandId, String logoType) Delete one branding logo.
BrandsResponse	deleteBrands(String accountId, BrandsRequest brandsRequest) Deletes one or more brand profiles.
CaptiveRecipientInformation	deleteCaptiveRecipient(String accountId, String recipientPart, CaptiveRecipientInformation captiveRecipientInformation) Deletes the signature for one or more captive recipient records.
void	deleteCustomField(String accountId, String customFieldId) Delete an existing account custom field.
void	deleteCustomField(String accountId, String customFieldId, AccountsApi.DeleteCustomFieldOptions options) Delete an existing account custom field.
void	deleteENoteConfiguration(String accountId) Deletes configuration information for the eNote eOriginal integration.
void	deletePermissionProfile(String accountId, String permissionProfileId) Deletes a permissions profile within the specified account.
void	deletePermissionProfile(String accountId, String permissionProfileId, AccountsApi.DeletePermissionProfileOptions options) Deletes a permissions profile within the specified account.
AccountIdentityVerificationResponse	getAccountIdentityVerification(String accountId) Get the list of identity verification options for an account
AccountInformation	getAccountInformation(String accountId) Retrieves the account information for the specified account.
AccountInformation	getAccountInformation(String accountId, AccountsApi.GetAccountInformationOptions options) Retrieves the account information for the specified account.
TabAccountSettings	getAccountTabSettings(String accountId) Returns tab settings list for specified account
PaymentGatewayAccountsInfo	getAllPaymentGatewayAccounts(String accountId) Get all payment gateway account for the provided accountId
ApiClient	getApiClient()
BillingChargeResponse	getBillingCharges(String accountId) Gets list of recurring and usage charges for the account.
BillingChargeResponse	getBillingCharges(String accountId, AccountsApi.GetBillingChargesOptions options) Gets list of recurring and usage charges for the account.
Brand	getBrand(String accountId, String brandId) Get information for a specific brand.
Brand	getBrand(String accountId, String brandId, AccountsApi.GetBrandOptions options) Get information for a specific brand.
void	getBrandExportFile(String accountId, String brandId) Export a specific brand.
byte[]	getBrandLogoByType(String accountId, String brandId, String logoType) Obtains the specified image for a brand.
BrandResourcesList	getBrandResources(String accountId, String brandId) Returns the specified account's list of branding resources (metadata).
void	getBrandResourcesByContentType(String accountId, String brandId, String resourceContentType) Returns the specified branding resource file.
void	getBrandResourcesByContentType(String accountId, String brandId, String resourceContentType, AccountsApi.GetBrandResourcesByContentTypeOptions options) Returns the specified branding resource file.
ConsumerDisclosure	getConsumerDisclosure(String accountId, String langCode) Gets the Electronic Record and Signature Disclosure.
ConsumerDisclosure	getConsumerDisclosureDefault(String accountId) Gets the Electronic Record and Signature Disclosure for the account.
ConsumerDisclosure	getConsumerDisclosureDefault(String accountId, AccountsApi.GetConsumerDisclosureDefaultOptions options) Gets the Electronic Record and Signature Disclosure for the account.
ENoteConfiguration	getENoteConfiguration(String accountId) Returns the configuration information for the eNote eOriginal integration.
EnvelopePurgeConfiguration	getEnvelopePurgeConfiguration(String accountId) Select envelope purge configuration.
FavoriteTemplatesInfo	getFavoriteTemplates(String accountId) Retrieves the list of favorited templates for this caller
NotificationDefaults	getNotificationDefaults(String accountId) Returns default user level settings for a specified account
UserPasswordRules	getPasswordRules_0() Get membership account password rules
AccountPasswordRules	getPasswordRules(String accountId) Get the password rules
PermissionProfile	getPermissionProfile(String accountId, String permissionProfileId) Returns a permissions profile in the specified account.
PermissionProfile	getPermissionProfile(String accountId, String permissionProfileId, AccountsApi.GetPermissionProfileOptions options) Returns a permissions profile in the specified account.
ProvisioningInformation	getProvisioning() Retrieves the account provisioning information for the account.
SupportedLanguages	getSupportedLanguages(String accountId) Gets list of supported languages for recipient language setting.
Watermark	getWatermark(String accountId) Get watermark information.
Watermark	getWatermarkPreview(String accountId, Watermark watermark) Get watermark preview.
BrandsResponse	listBrands(String accountId) Gets a list of brand profiles.
BrandsResponse	listBrands(String accountId, AccountsApi.ListBrandsOptions options) Gets a list of brand profiles.
CustomFields	listCustomFields(String accountId) Gets a list of custom fields associated with the account.
PermissionProfileInformation	listPermissions(String accountId) Gets a list of permission profiles.
PermissionProfileInformation	listPermissions(String accountId, AccountsApi.ListPermissionsOptions options) Gets a list of permission profiles.
RecipientNamesResponse	listRecipientNamesByEmail(String accountId) Gets recipient names associated with an email address.
RecipientNamesResponse	listRecipientNamesByEmail(String accountId, AccountsApi.ListRecipientNamesByEmailOptions options) Gets recipient names associated with an email address.
AccountSettingsInformation	listSettings(String accountId) Gets account settings information.
AccountSharedAccess	listSharedAccess(String accountId) Reserved: Gets the shared item status for one or more users.
AccountSharedAccess	listSharedAccess(String accountId, AccountsApi.ListSharedAccessOptions options) Reserved: Gets the shared item status for one or more users.
AccountSignatureProviders	listSignatureProviders(String accountId) Returns Account available signature providers for specified account.
FileTypeList	listUnsupportedFileTypes(String accountId) Gets a list of unsupported file types.
void	setApiClient(ApiClient apiClient)
FavoriteTemplatesInfo	unFavoriteTemplate(String accountId, FavoriteTemplatesInfo favoriteTemplatesInfo) Unfavorite a template
TabAccountSettings	updateAccountTabSettings(String accountId, TabAccountSettings tabAccountSettings) Modifies tab settings for specified account
Brand	updateBrand(String accountId, String brandId, Brand brand) Updates an existing brand.
void	updateBrandLogoByType(String accountId, String brandId, String logoType, byte[] logoFileBytes) Put one branding logo.
BrandResources	updateBrandResourcesByContentType(String accountId, String brandId, String resourceContentType) Uploads a branding resource file.
ConsumerDisclosure	updateConsumerDisclosure(String accountId, String langCode, ConsumerDisclosure consumerDisclosure) Update Consumer Disclosure.
ConsumerDisclosure	updateConsumerDisclosure(String accountId, String langCode, ConsumerDisclosure consumerDisclosure, AccountsApi.UpdateConsumerDisclosureOptions options) Update Consumer Disclosure.
CustomFields	updateCustomField(String accountId, String customFieldId, CustomField customField) Updates an existing account custom field.
CustomFields	updateCustomField(String accountId, String customFieldId, CustomField customField, AccountsApi.UpdateCustomFieldOptions options) Updates an existing account custom field.
ENoteConfiguration	updateENoteConfiguration(String accountId, ENoteConfiguration eNoteConfiguration) Updates configuration information for the eNote eOriginal integration.
EnvelopePurgeConfiguration	updateEnvelopePurgeConfiguration(String accountId, EnvelopePurgeConfiguration envelopePurgeConfiguration) Updates envelope purge configuration.
FavoriteTemplatesInfo	updateFavoriteTemplate(String accountId, FavoriteTemplatesInfo favoriteTemplatesInfo) Favorites a template
NotificationDefaults	updateNotificationDefaults(String accountId, NotificationDefaults notificationDefaults) Updates default user level settings for a specified account
AccountPasswordRules	updatePasswordRules(String accountId, AccountPasswordRules accountPasswordRules) Update the password rules
PermissionProfile	updatePermissionProfile(String accountId, String permissionProfileId, PermissionProfile permissionProfile) Updates a permission profile within the specified account.
PermissionProfile	updatePermissionProfile(String accountId, String permissionProfileId, PermissionProfile permissionProfile, AccountsApi.UpdatePermissionProfileOptions options) Updates a permission profile within the specified account.
void	updateSettings(String accountId, AccountSettingsInformation accountSettingsInformation) Updates the account settings for an account.
AccountSharedAccess	updateSharedAccess(String accountId, AccountSharedAccess accountSharedAccess) Reserved: Sets the shared access information for users.
AccountSharedAccess	updateSharedAccess(String accountId, AccountSharedAccess accountSharedAccess, AccountsApi.UpdateSharedAccessOptions options) Reserved: Sets the shared access information for users.
Watermark	updateWatermark(String accountId, Watermark watermark) Update watermark information.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

AccountsApi

public AccountsApi()

AccountsApi

public AccountsApi(ApiClient apiClient)

Method Detail

getApiClient

public ApiClient getApiClient()

setApiClient

public void setApiClient(ApiClient apiClient)

create

public NewAccountSummary create(NewAccountDefinition newAccountDefinition)
                         throws ApiException

Creates new accounts. Creates new DocuSign service accounts. This is used to create multiple DocuSign accounts with one call. It uses the same information and formats as the normal a [Accounts:create](accounts_create) call with the information included within a `newAccountRequests` element. A maximum of 100 new accounts can be created at one time. Note that the structure of the XML request is slightly different than the JSON request, in that the new account information is included in a `newAccountDefinition` property inside the `newAccountRequests` element. Response The response returns the new account ID, password and the default user information for each newly created account. A 201 code is returned if the call succeeded. While the call may have succeed, some of the individual account requests may have failed. In the case of failures to create the account, an `errorDetails` node is added in the response to each specific request that failed.

Parameters:

newAccountDefinition - (optional)

Returns:

NewAccountSummary

Throws:

ApiException

create

public NewAccountSummary create(NewAccountDefinition newAccountDefinition,
                       AccountsApi.CreateOptions options)
                         throws ApiException

Creates new accounts. Creates new DocuSign service accounts. This is used to create multiple DocuSign accounts with one call. It uses the same information and formats as the normal a [Accounts:create](accounts_create) call with the information included within a `newAccountRequests` element. A maximum of 100 new accounts can be created at one time. Note that the structure of the XML request is slightly different than the JSON request, in that the new account information is included in a `newAccountDefinition` property inside the `newAccountRequests` element. Response The response returns the new account ID, password and the default user information for each newly created account. A 201 code is returned if the call succeeded. While the call may have succeed, some of the individual account requests may have failed. In the case of failures to create the account, an `errorDetails` node is added in the response to each specific request that failed.

Parameters:

newAccountDefinition - (optional)

options - for modifying the method behavior.

Returns:

NewAccountSummary

Throws:

ApiException - if fails to make API call

createBrand

public BrandsResponse createBrand(String accountId,
                         Brand brand)
                           throws ApiException

Creates one or more brand profile files for the account. Creates one or more brand profile files for the account. The Account Branding feature (accountSettings properties `canSelfBrandSend` and `canSelfBrandSig`) must be set to **true** for the account to use this call. An error is returned if `brandId` property for a brand profile is already set for the account. To upload a new version of an existing brand profile, you must delete the profile and then upload the newer version. When brand profile files are being uploaded, they must be combined into one zip file and the `Content-Type` must be `application/zip`.

Parameters:

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

brand - (optional)

Returns:

BrandsResponse

Throws:

ApiException - if fails to make API call

createCustomField

public CustomFields createCustomField(String accountId,
                             CustomField customField)
                               throws ApiException

Creates an acount custom field.

Parameters:

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

customField - (optional)

Returns:

CustomFields

Throws:

ApiException

createCustomField

public CustomFields createCustomField(String accountId,
                             CustomField customField,
                             AccountsApi.CreateCustomFieldOptions options)
                               throws ApiException

Creates an acount custom field.

Parameters:

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

customField - (optional)

options - for modifying the method behavior.

Returns:

CustomFields

Throws:

ApiException - if fails to make API call

createPermissionProfile

public PermissionProfile createPermissionProfile(String accountId,
                                        PermissionProfile permissionProfile)
                                          throws ApiException

Creates a new permission profile in the specified account.

Parameters:

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

permissionProfile - (optional)

Returns:

PermissionProfile

Throws:

ApiException

createPermissionProfile

public PermissionProfile createPermissionProfile(String accountId,
                                        PermissionProfile permissionProfile,
                                        AccountsApi.CreatePermissionProfileOptions options)
                                          throws ApiException

Creates a new permission profile in the specified account.

Parameters:

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

permissionProfile - (optional)

options - for modifying the method behavior.

Returns:

PermissionProfile

Throws:

ApiException - if fails to make API call

delete

public void delete(String accountId)
            throws ApiException

Deletes the specified account. This closes the specified account. You must be an account admin to close your account. Once closed, an account must be reopened by DocuSign.

Parameters:

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

Throws:

ApiException - if fails to make API call

deleteBrand

public void deleteBrand(String accountId,
               String brandId)
                 throws ApiException

Removes a brand.

Parameters:

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

brandId - The unique identifier of a brand. (required)

Throws:

ApiException - if fails to make API call

deleteBrandLogoByType

public void deleteBrandLogoByType(String accountId,
                         String brandId,
                         String logoType)
                           throws ApiException

Delete one branding logo.

Parameters:

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

brandId - The unique identifier of a brand. (required)

logoType - One of **Primary**, **Secondary** or **Email**. (required)

Throws:

ApiException - if fails to make API call

deleteBrands

public BrandsResponse deleteBrands(String accountId,
                          BrandsRequest brandsRequest)
                            throws ApiException

Deletes one or more brand profiles. Deletes one or more brand profiles from an account. The Account Branding feature (accountSettings properties `canSelfBrandSend` and `canSelfBrandSend`) must be set to **true** to use this call.

Parameters:

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

brandsRequest - (optional)

Returns:

BrandsResponse

Throws:

ApiException - if fails to make API call

deleteCaptiveRecipient

public CaptiveRecipientInformation deleteCaptiveRecipient(String accountId,
                                                 String recipientPart,
                                                 CaptiveRecipientInformation captiveRecipientInformation)
                                                   throws ApiException

Deletes the signature for one or more captive recipient records. Deletes the signature for one or more captive recipient records; it is primarily used for testing. This provides a way to reset the signature associated with a client user ID so that a new signature can be created the next time the client user ID is used.

Parameters:

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

recipientPart - (required)

captiveRecipientInformation - (optional)

Returns:

CaptiveRecipientInformation

Throws:

ApiException - if fails to make API call

deleteCustomField

public void deleteCustomField(String accountId,
                     String customFieldId)
                       throws ApiException

Delete an existing account custom field.

Parameters:

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

customFieldId - (required)

Throws:

ApiException

deleteCustomField

public void deleteCustomField(String accountId,
                     String customFieldId,
                     AccountsApi.DeleteCustomFieldOptions options)
                       throws ApiException

Delete an existing account custom field.

Parameters:

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

customFieldId - (required)

options - for modifying the method behavior.

Throws:

ApiException - if fails to make API call

deleteENoteConfiguration

public void deleteENoteConfiguration(String accountId)
                              throws ApiException

Deletes configuration information for the eNote eOriginal integration.

Parameters:

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

Throws:

ApiException - if fails to make API call

deletePermissionProfile

public void deletePermissionProfile(String accountId,
                           String permissionProfileId)
                             throws ApiException

Deletes a permissions profile within the specified account.

Parameters:

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

permissionProfileId - (required)

Throws:

ApiException

deletePermissionProfile

public void deletePermissionProfile(String accountId,
                           String permissionProfileId,
                           AccountsApi.DeletePermissionProfileOptions options)
                             throws ApiException

Deletes a permissions profile within the specified account.

Parameters:

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

permissionProfileId - (required)

options - for modifying the method behavior.

Throws:

ApiException - if fails to make API call

getAccountIdentityVerification

public AccountIdentityVerificationResponse getAccountIdentityVerification(String accountId)
                                                                   throws ApiException

Get the list of identity verification options for an account

Parameters:

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

Returns:

AccountIdentityVerificationResponse

Throws:

ApiException - if fails to make API call

getAccountInformation

public AccountInformation getAccountInformation(String accountId)
                                         throws ApiException

Retrieves the account information for the specified account. Retrieves the account information for the specified account. **Response** The `canUpgrade` property contains is a Boolean that indicates whether the account can be upgraded through the API.

Parameters:

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

Returns:

AccountInformation

Throws:

ApiException

getAccountInformation

public AccountInformation getAccountInformation(String accountId,
                                       AccountsApi.GetAccountInformationOptions options)
                                         throws ApiException

Retrieves the account information for the specified account. Retrieves the account information for the specified account. **Response** The `canUpgrade` property contains is a Boolean that indicates whether the account can be upgraded through the API.

Parameters:

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

options - for modifying the method behavior.

Returns:

AccountInformation

Throws:

ApiException - if fails to make API call

getAccountTabSettings

public TabAccountSettings getAccountTabSettings(String accountId)
                                         throws ApiException

Returns tab settings list for specified account

Parameters:

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

Returns:

TabAccountSettings

Throws:

ApiException - if fails to make API call

getAllPaymentGatewayAccounts

public PaymentGatewayAccountsInfo getAllPaymentGatewayAccounts(String accountId)
                                                        throws ApiException

Get all payment gateway account for the provided accountId

Parameters:

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

Returns:

PaymentGatewayAccountsInfo

Throws:

ApiException - if fails to make API call

getBillingCharges

public BillingChargeResponse getBillingCharges(String accountId)
                                        throws ApiException

Gets list of recurring and usage charges for the account. Retrieves the list of recurring and usage charges for the account. This can be used to determine the charge structure and usage of charge plan items. Privileges required: account administrator

Parameters:

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

Returns:

BillingChargeResponse

Throws:

ApiException

getBillingCharges

public BillingChargeResponse getBillingCharges(String accountId,
                                      AccountsApi.GetBillingChargesOptions options)
                                        throws ApiException

Gets list of recurring and usage charges for the account. Retrieves the list of recurring and usage charges for the account. This can be used to determine the charge structure and usage of charge plan items. Privileges required: account administrator

Parameters:

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

options - for modifying the method behavior.

Returns:

BillingChargeResponse

Throws:

ApiException - if fails to make API call

getBrand

public Brand getBrand(String accountId,
             String brandId)
               throws ApiException

Get information for a specific brand.

Parameters:

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

brandId - The unique identifier of a brand. (required)

Returns:

Brand

Throws:

ApiException

getBrand

public Brand getBrand(String accountId,
             String brandId,
             AccountsApi.GetBrandOptions options)
               throws ApiException

Get information for a specific brand.

Parameters:

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

brandId - The unique identifier of a brand. (required)

options - for modifying the method behavior.

Returns:

Brand

Throws:

ApiException - if fails to make API call

getBrandExportFile

public void getBrandExportFile(String accountId,
                      String brandId)
                        throws ApiException

Export a specific brand.

Parameters:

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

brandId - The unique identifier of a brand. (required)

Throws:

ApiException - if fails to make API call

getBrandLogoByType

public byte[] getBrandLogoByType(String accountId,
                        String brandId,
                        String logoType)
                          throws ApiException

Obtains the specified image for a brand.

Parameters:

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

brandId - The unique identifier of a brand. (required)

logoType - One of **Primary**, **Secondary** or **Email**. (required)

Returns:

byte[]

Throws:

ApiException - if fails to make API call

getBrandResources

public BrandResourcesList getBrandResources(String accountId,
                                   String brandId)
                                     throws ApiException

Returns the specified account's list of branding resources (metadata).

Parameters:

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

brandId - The unique identifier of a brand. (required)

Returns:

BrandResourcesList

Throws:

ApiException - if fails to make API call

getBrandResourcesByContentType

public void getBrandResourcesByContentType(String accountId,
                                  String brandId,
                                  String resourceContentType)
                                    throws ApiException

Returns the specified branding resource file.

Parameters:

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

brandId - The unique identifier of a brand. (required)

resourceContentType - (required)

Throws:

ApiException

getBrandResourcesByContentType

public void getBrandResourcesByContentType(String accountId,
                                  String brandId,
                                  String resourceContentType,
                                  AccountsApi.GetBrandResourcesByContentTypeOptions options)
                                    throws ApiException

Returns the specified branding resource file.

Parameters:

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

brandId - The unique identifier of a brand. (required)

resourceContentType - (required)

options - for modifying the method behavior.

Throws:

ApiException - if fails to make API call

getConsumerDisclosure

public ConsumerDisclosure getConsumerDisclosure(String accountId,
                                       String langCode)
                                         throws ApiException

Gets the Electronic Record and Signature Disclosure. Retrieves the Electronic Record and Signature Disclosure, with HTML formatting, for the requested envelope recipient. This might be different than the current account disclosure depending on account settings, such as branding, and when the account disclosure was last updated. An optional query string can be included to return the language for the disclosure.

Parameters:

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

langCode - The simple type enumeration the language used in the response. The supported languages, with the language value shown in parenthesis, are:Arabic (ar), Armenian (hy), Bulgarian (bg), Czech (cs), Chinese Simplified (zh_CN), Chinese Traditional (zh_TW), Croatian (hr), Danish (da), Dutch (nl), English US (en), English UK (en_GB), Estonian (et), Farsi (fa), Finnish (fi), French (fr), French Canada (fr_CA), German (de), Greek (el), Hebrew (he), Hindi (hi), Hungarian (hu), Bahasa Indonesia (id), Italian (it), Japanese (ja), Korean (ko), Latvian (lv), Lithuanian (lt), Bahasa Melayu (ms), Norwegian (no), Polish (pl), Portuguese (pt), Portuguese Brazil (pt_BR), Romanian (ro), Russian (ru), Serbian (sr), Slovak (sk), Slovenian (sl), Spanish (es),Spanish Latin America (es_MX), Swedish (sv), Thai (th), Turkish (tr), Ukrainian (uk) and Vietnamese (vi). Additionally, the value can be set to �browser� to automatically detect the browser language being used by the viewer and display the disclosure in that language. (required)

Returns:

ConsumerDisclosure

Throws:

ApiException - if fails to make API call

getConsumerDisclosureDefault

public ConsumerDisclosure getConsumerDisclosureDefault(String accountId)
                                                throws ApiException

Gets the Electronic Record and Signature Disclosure for the account. Retrieves the Electronic Record and Signature Disclosure, with HTML formatting, associated with the account. You can use an optional query string to set the language for the disclosure.

Parameters:

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

Returns:

ConsumerDisclosure

Throws:

ApiException

getConsumerDisclosureDefault

public ConsumerDisclosure getConsumerDisclosureDefault(String accountId,
                                              AccountsApi.GetConsumerDisclosureDefaultOptions options)
                                                throws ApiException

Gets the Electronic Record and Signature Disclosure for the account. Retrieves the Electronic Record and Signature Disclosure, with HTML formatting, associated with the account. You can use an optional query string to set the language for the disclosure.

Parameters:

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

options - for modifying the method behavior.

Returns:

ConsumerDisclosure

Throws:

ApiException - if fails to make API call

getENoteConfiguration

public ENoteConfiguration getENoteConfiguration(String accountId)
                                         throws ApiException

Returns the configuration information for the eNote eOriginal integration.

Parameters:

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

Returns:

ENoteConfiguration

Throws:

ApiException - if fails to make API call

getEnvelopePurgeConfiguration

public EnvelopePurgeConfiguration getEnvelopePurgeConfiguration(String accountId)
                                                         throws ApiException

Select envelope purge configuration.

Parameters:

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

Returns:

EnvelopePurgeConfiguration

Throws:

ApiException - if fails to make API call

getFavoriteTemplates

public FavoriteTemplatesInfo getFavoriteTemplates(String accountId)
                                           throws ApiException

Retrieves the list of favorited templates for this caller

Parameters:

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

Returns:

FavoriteTemplatesInfo

Throws:

ApiException - if fails to make API call

getNotificationDefaults

public NotificationDefaults getNotificationDefaults(String accountId)
                                             throws ApiException

Returns default user level settings for a specified account

Parameters:

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

Returns:

NotificationDefaults

Throws:

ApiException - if fails to make API call

getPasswordRules

public AccountPasswordRules getPasswordRules(String accountId)
                                      throws ApiException

Get the password rules

Parameters:

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

Returns:

AccountPasswordRules

Throws:

ApiException - if fails to make API call

getPasswordRules_0

public UserPasswordRules getPasswordRules_0()
                                     throws ApiException

Get membership account password rules

Returns:

UserPasswordRules

Throws:

ApiException - if fails to make API call

getPermissionProfile

public PermissionProfile getPermissionProfile(String accountId,
                                     String permissionProfileId)
                                       throws ApiException

Returns a permissions profile in the specified account.

Parameters:

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

permissionProfileId - (required)

Returns:

PermissionProfile

Throws:

ApiException

getPermissionProfile

public PermissionProfile getPermissionProfile(String accountId,
                                     String permissionProfileId,
                                     AccountsApi.GetPermissionProfileOptions options)
                                       throws ApiException

Returns a permissions profile in the specified account.

Parameters:

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

permissionProfileId - (required)

options - for modifying the method behavior.

Returns:

PermissionProfile

Throws:

ApiException - if fails to make API call

getProvisioning

public ProvisioningInformation getProvisioning()
                                        throws ApiException

Retrieves the account provisioning information for the account. Retrieves the account provisioning information for the account.

Returns:

ProvisioningInformation

Throws:

ApiException - if fails to make API call

getSupportedLanguages

public SupportedLanguages getSupportedLanguages(String accountId)
                                         throws ApiException

Gets list of supported languages for recipient language setting.

Parameters:

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

Returns:

SupportedLanguages

Throws:

ApiException - if fails to make API call

getWatermark

public Watermark getWatermark(String accountId)
                       throws ApiException

Get watermark information.

Parameters:

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

Returns:

Watermark

Throws:

ApiException - if fails to make API call

getWatermarkPreview

public Watermark getWatermarkPreview(String accountId,
                            Watermark watermark)
                              throws ApiException

Get watermark preview.

Parameters:

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

watermark - (optional)

Returns:

Watermark

Throws:

ApiException - if fails to make API call

listBrands

public BrandsResponse listBrands(String accountId)
                          throws ApiException

Gets a list of brand profiles. Retrieves the list of brand profiles associated with the account and the default brand profiles. The Account Branding feature (accountSettings properties `canSelfBrandSend` and `canSelfBrandSend`) must be set to **true** for the account to use this call.

Parameters:

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

Returns:

BrandsResponse

Throws:

ApiException

listBrands

public BrandsResponse listBrands(String accountId,
                        AccountsApi.ListBrandsOptions options)
                          throws ApiException

Gets a list of brand profiles. Retrieves the list of brand profiles associated with the account and the default brand profiles. The Account Branding feature (accountSettings properties `canSelfBrandSend` and `canSelfBrandSend`) must be set to **true** for the account to use this call.

Parameters:

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

options - for modifying the method behavior.

Returns:

BrandsResponse

Throws:

ApiException - if fails to make API call

listCustomFields

public CustomFields listCustomFields(String accountId)
                              throws ApiException

Gets a list of custom fields associated with the account. Retrieves a list of envelope custom fields associated with the account. You can use these fields in the envelopes for your account to record information about the envelope, help search for envelopes and track information. The envelope custom fields are shown in the Envelope Settings section when a user is creating an envelope in the DocuSign member console. The envelope custom fields are not seen by the envelope recipients. There are two types of envelope custom fields, text, and list. A text custom field lets the sender enter the value for the field. The list custom field lets the sender select the value of the field from a list you provide.

Parameters:

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

Returns:

CustomFields

Throws:

ApiException - if fails to make API call

listPermissions

public PermissionProfileInformation listPermissions(String accountId)
                                             throws ApiException

Gets a list of permission profiles. Retrieves a list of Permission Profiles. Permission Profiles are a standard set of user permissions that you can apply to individual users or users in a Group. This makes it easier to manage user permissions for a large number of users, without having to change permissions on a user-by-user basis. Currently, Permission Profiles can only be created and modified in the DocuSign console.

Parameters:

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

Returns:

PermissionProfileInformation

Throws:

ApiException

listPermissions

public PermissionProfileInformation listPermissions(String accountId,
                                           AccountsApi.ListPermissionsOptions options)
                                             throws ApiException

Gets a list of permission profiles. Retrieves a list of Permission Profiles. Permission Profiles are a standard set of user permissions that you can apply to individual users or users in a Group. This makes it easier to manage user permissions for a large number of users, without having to change permissions on a user-by-user basis. Currently, Permission Profiles can only be created and modified in the DocuSign console.

Parameters:

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

options - for modifying the method behavior.

Returns:

PermissionProfileInformation

Throws:

ApiException - if fails to make API call

listRecipientNamesByEmail

public RecipientNamesResponse listRecipientNamesByEmail(String accountId)
                                                 throws ApiException

Gets recipient names associated with an email address. Retrieves a list of recipients in the specified account that are associated with a email address supplied in the query string.

Parameters:

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

Returns:

RecipientNamesResponse

Throws:

ApiException

listRecipientNamesByEmail

public RecipientNamesResponse listRecipientNamesByEmail(String accountId,
                                               AccountsApi.ListRecipientNamesByEmailOptions options)
                                                 throws ApiException

Gets recipient names associated with an email address. Retrieves a list of recipients in the specified account that are associated with a email address supplied in the query string.

Parameters:

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

options - for modifying the method behavior.

Returns:

RecipientNamesResponse

Throws:

ApiException - if fails to make API call

listSettings

public AccountSettingsInformation listSettings(String accountId)
                                        throws ApiException

Gets account settings information. Retrieves the account settings information for the specified account.

Parameters:

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

Returns:

AccountSettingsInformation

Throws:

ApiException - if fails to make API call

listSharedAccess

public AccountSharedAccess listSharedAccess(String accountId)
                                     throws ApiException

Reserved: Gets the shared item status for one or more users. Reserved: Retrieves shared item status for one or more users and types of items. Users with account administration privileges can retrieve shared access information for all account users. Users without account administrator privileges can only retrieve shared access information for themselves and the returned information is limited to the retrieving the status of all members of the account that are sharing their folders to the user. This is equivalent to setting the shared=shared_from.

Parameters:

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

Returns:

AccountSharedAccess

Throws:

ApiException

listSharedAccess

public AccountSharedAccess listSharedAccess(String accountId,
                                   AccountsApi.ListSharedAccessOptions options)
                                     throws ApiException

Reserved: Gets the shared item status for one or more users. Reserved: Retrieves shared item status for one or more users and types of items. Users with account administration privileges can retrieve shared access information for all account users. Users without account administrator privileges can only retrieve shared access information for themselves and the returned information is limited to the retrieving the status of all members of the account that are sharing their folders to the user. This is equivalent to setting the shared=shared_from.

Parameters:

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

options - for modifying the method behavior.

Returns:

AccountSharedAccess

Throws:

ApiException - if fails to make API call

listSignatureProviders

public AccountSignatureProviders listSignatureProviders(String accountId)
                                                 throws ApiException

Returns Account available signature providers for specified account.

Parameters:

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

Returns:

AccountSignatureProviders

Throws:

ApiException - if fails to make API call

listUnsupportedFileTypes

public FileTypeList listUnsupportedFileTypes(String accountId)
                                      throws ApiException

Gets a list of unsupported file types. Retrieves a list of file types (mime-types and file-extensions) that are not supported for upload through the DocuSign system.

Parameters:

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

Returns:

FileTypeList

Throws:

ApiException - if fails to make API call

unFavoriteTemplate

public FavoriteTemplatesInfo unFavoriteTemplate(String accountId,
                                       FavoriteTemplatesInfo favoriteTemplatesInfo)
                                         throws ApiException

Unfavorite a template

Parameters:

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

favoriteTemplatesInfo - (optional)

Returns:

FavoriteTemplatesInfo

Throws:

ApiException - if fails to make API call

updateAccountTabSettings

public TabAccountSettings updateAccountTabSettings(String accountId,
                                          TabAccountSettings tabAccountSettings)
                                            throws ApiException

Modifies tab settings for specified account

Parameters:

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

tabAccountSettings - (optional)

Returns:

TabAccountSettings

Throws:

ApiException - if fails to make API call

updateBrand

public Brand updateBrand(String accountId,
                String brandId,
                Brand brand)
                  throws ApiException

Updates an existing brand.

Parameters:

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

brandId - The unique identifier of a brand. (required)

brand - (optional)

Returns:

Brand

Throws:

ApiException - if fails to make API call

updateBrandLogoByType

public void updateBrandLogoByType(String accountId,
                         String brandId,
                         String logoType,
                         byte[] logoFileBytes)
                           throws ApiException

Put one branding logo.

Parameters:

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

brandId - The id of the brand. (required)

logoType - The type of logo. Valid values are: - `primary` - `secondary` - `email` (required)

logoFileBytes - Brand logo binary Stream. Supported formats: JPG, GIF, PNG. Maximum file size: 300 KB. Recommended dimensions: 296 x 76 pixels (larger images will be resized). Changes may take up to one hour to display in all places (required)

Throws:

ApiException - if fails to make API call

updateBrandResourcesByContentType

public BrandResources updateBrandResourcesByContentType(String accountId,
                                               String brandId,
                                               String resourceContentType)
                                                 throws ApiException

Uploads a branding resource file.

Parameters:

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

brandId - The unique identifier of a brand. (required)

resourceContentType - (required)

Returns:

BrandResources

Throws:

ApiException - if fails to make API call

updateConsumerDisclosure

public ConsumerDisclosure updateConsumerDisclosure(String accountId,
                                          String langCode,
                                          ConsumerDisclosure consumerDisclosure)
                                            throws ApiException

Update Consumer Disclosure.

Parameters:

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

langCode - The simple type enumeration the language used in the response. The supported languages, with the language value shown in parenthesis, are:Arabic (ar), Armenian (hy), Bulgarian (bg), Czech (cs), Chinese Simplified (zh_CN), Chinese Traditional (zh_TW), Croatian (hr), Danish (da), Dutch (nl), English US (en), English UK (en_GB), Estonian (et), Farsi (fa), Finnish (fi), French (fr), French Canada (fr_CA), German (de), Greek (el), Hebrew (he), Hindi (hi), Hungarian (hu), Bahasa Indonesia (id), Italian (it), Japanese (ja), Korean (ko), Latvian (lv), Lithuanian (lt), Bahasa Melayu (ms), Norwegian (no), Polish (pl), Portuguese (pt), Portuguese Brazil (pt_BR), Romanian (ro), Russian (ru), Serbian (sr), Slovak (sk), Slovenian (sl), Spanish (es),Spanish Latin America (es_MX), Swedish (sv), Thai (th), Turkish (tr), Ukrainian (uk) and Vietnamese (vi). Additionally, the value can be set to �browser� to automatically detect the browser language being used by the viewer and display the disclosure in that language. (required)

consumerDisclosure - (optional)

Returns:

ConsumerDisclosure

Throws:

ApiException

updateConsumerDisclosure

public ConsumerDisclosure updateConsumerDisclosure(String accountId,
                                          String langCode,
                                          ConsumerDisclosure consumerDisclosure,
                                          AccountsApi.UpdateConsumerDisclosureOptions options)
                                            throws ApiException

Update Consumer Disclosure.

Parameters:

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

langCode - The simple type enumeration the language used in the response. The supported languages, with the language value shown in parenthesis, are:Arabic (ar), Armenian (hy), Bulgarian (bg), Czech (cs), Chinese Simplified (zh_CN), Chinese Traditional (zh_TW), Croatian (hr), Danish (da), Dutch (nl), English US (en), English UK (en_GB), Estonian (et), Farsi (fa), Finnish (fi), French (fr), French Canada (fr_CA), German (de), Greek (el), Hebrew (he), Hindi (hi), Hungarian (hu), Bahasa Indonesia (id), Italian (it), Japanese (ja), Korean (ko), Latvian (lv), Lithuanian (lt), Bahasa Melayu (ms), Norwegian (no), Polish (pl), Portuguese (pt), Portuguese Brazil (pt_BR), Romanian (ro), Russian (ru), Serbian (sr), Slovak (sk), Slovenian (sl), Spanish (es),Spanish Latin America (es_MX), Swedish (sv), Thai (th), Turkish (tr), Ukrainian (uk) and Vietnamese (vi). Additionally, the value can be set to �browser� to automatically detect the browser language being used by the viewer and display the disclosure in that language. (required)

consumerDisclosure - (optional)

options - for modifying the method behavior.

Returns:

ConsumerDisclosure

Throws:

ApiException - if fails to make API call

updateCustomField

public CustomFields updateCustomField(String accountId,
                             String customFieldId,
                             CustomField customField)
                               throws ApiException

Updates an existing account custom field.

Parameters:

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

customFieldId - (required)

customField - (optional)

Returns:

CustomFields

Throws:

ApiException

updateCustomField

public CustomFields updateCustomField(String accountId,
                             String customFieldId,
                             CustomField customField,
                             AccountsApi.UpdateCustomFieldOptions options)
                               throws ApiException

Updates an existing account custom field.

Parameters:

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

customFieldId - (required)

customField - (optional)

options - for modifying the method behavior.

Returns:

CustomFields

Throws:

ApiException - if fails to make API call

updateENoteConfiguration

public ENoteConfiguration updateENoteConfiguration(String accountId,
                                          ENoteConfiguration eNoteConfiguration)
                                            throws ApiException

Updates configuration information for the eNote eOriginal integration.

Parameters:

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

eNoteConfiguration - (optional)

Returns:

ENoteConfiguration

Throws:

ApiException - if fails to make API call

updateEnvelopePurgeConfiguration

public EnvelopePurgeConfiguration updateEnvelopePurgeConfiguration(String accountId,
                                                          EnvelopePurgeConfiguration envelopePurgeConfiguration)
                                                            throws ApiException

Updates envelope purge configuration.

Parameters:

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

envelopePurgeConfiguration - (optional)

Returns:

EnvelopePurgeConfiguration

Throws:

ApiException - if fails to make API call

updateFavoriteTemplate

public FavoriteTemplatesInfo updateFavoriteTemplate(String accountId,
                                           FavoriteTemplatesInfo favoriteTemplatesInfo)
                                             throws ApiException

Favorites a template

Parameters:

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

favoriteTemplatesInfo - (optional)

Returns:

FavoriteTemplatesInfo

Throws:

ApiException - if fails to make API call

updateNotificationDefaults

public NotificationDefaults updateNotificationDefaults(String accountId,
                                              NotificationDefaults notificationDefaults)
                                                throws ApiException

Updates default user level settings for a specified account

Parameters:

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

notificationDefaults - (optional)

Returns:

NotificationDefaults

Throws:

ApiException - if fails to make API call

updatePasswordRules

public AccountPasswordRules updatePasswordRules(String accountId,
                                       AccountPasswordRules accountPasswordRules)
                                         throws ApiException

Update the password rules

Parameters:

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

accountPasswordRules - (optional)

Returns:

AccountPasswordRules

Throws:

ApiException - if fails to make API call

updatePermissionProfile

public PermissionProfile updatePermissionProfile(String accountId,
                                        String permissionProfileId,
                                        PermissionProfile permissionProfile)
                                          throws ApiException

Updates a permission profile within the specified account.

Parameters:

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

permissionProfileId - (required)

permissionProfile - (optional)

Returns:

PermissionProfile

Throws:

ApiException

updatePermissionProfile

public PermissionProfile updatePermissionProfile(String accountId,
                                        String permissionProfileId,
                                        PermissionProfile permissionProfile,
                                        AccountsApi.UpdatePermissionProfileOptions options)
                                          throws ApiException

Updates a permission profile within the specified account.

Parameters:

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

permissionProfileId - (required)

permissionProfile - (optional)

options - for modifying the method behavior.

Returns:

PermissionProfile

Throws:

ApiException - if fails to make API call

updateSettings

public void updateSettings(String accountId,
                  AccountSettingsInformation accountSettingsInformation)
                    throws ApiException

Updates the account settings for an account. Updates the account settings for the specified account.

Parameters:

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

accountSettingsInformation - (optional)

Throws:

ApiException - if fails to make API call

updateSharedAccess

public AccountSharedAccess updateSharedAccess(String accountId,
                                     AccountSharedAccess accountSharedAccess)
                                       throws ApiException

Reserved: Sets the shared access information for users. Reserved: Sets the shared access information for one or more users.

Parameters:

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

accountSharedAccess - (optional)

Returns:

AccountSharedAccess

Throws:

ApiException

updateSharedAccess

public AccountSharedAccess updateSharedAccess(String accountId,
                                     AccountSharedAccess accountSharedAccess,
                                     AccountsApi.UpdateSharedAccessOptions options)
                                       throws ApiException

Reserved: Sets the shared access information for users. Reserved: Sets the shared access information for one or more users.

Parameters:

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

accountSharedAccess - (optional)

options - for modifying the method behavior.

Returns:

AccountSharedAccess

Throws:

ApiException - if fails to make API call

updateWatermark

public Watermark updateWatermark(String accountId,
                        Watermark watermark)
                          throws ApiException

Update watermark information.

Parameters:

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

watermark - (optional)

Returns:

Watermark

Throws:

ApiException - if fails to make API call