Package com.docusign.esign.api
Class AccountsApi
- java.lang.Object
-
- com.docusign.esign.api.AccountsApi
-
public class AccountsApi extends Object
AccountsApi class.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description classAccountsApi.CreateAccountSignaturesOptionsCreateAccountSignaturesOptions Class.classAccountsApi.CreateCustomFieldOptionsCreateCustomFieldOptions Class.classAccountsApi.CreateOptionsCreateOptions Class.classAccountsApi.CreatePermissionProfileOptionsCreatePermissionProfileOptions Class.classAccountsApi.DeleteCustomFieldOptionsDeleteCustomFieldOptions Class.classAccountsApi.DeletePermissionProfileOptionsDeletePermissionProfileOptions Class.classAccountsApi.GetAccountInformationOptionsGetAccountInformationOptions Class.classAccountsApi.GetAccountSignatureImageOptionsGetAccountSignatureImageOptions Class.classAccountsApi.GetAccountSignaturesOptionsGetAccountSignaturesOptions Class.classAccountsApi.GetBillingChargesOptionsGetBillingChargesOptions Class.classAccountsApi.GetBrandOptionsGetBrandOptions Class.classAccountsApi.GetBrandResourcesByContentTypeOptionsGetBrandResourcesByContentTypeOptions Class.classAccountsApi.GetConsumerDisclosureDefaultOptionsGetConsumerDisclosureDefaultOptions Class.classAccountsApi.GetPermissionProfileOptionsGetPermissionProfileOptions Class.classAccountsApi.ListBrandsOptionsListBrandsOptions Class.classAccountsApi.ListPermissionsOptionsListPermissionsOptions Class.classAccountsApi.ListRecipientNamesByEmailOptionsListRecipientNamesByEmailOptions Class.classAccountsApi.ListSharedAccessOptionsListSharedAccessOptions Class.classAccountsApi.UpdateAccountSignatureByIdOptionsUpdateAccountSignatureByIdOptions Class.classAccountsApi.UpdateAccountSignatureImageOptionsUpdateAccountSignatureImageOptions Class.classAccountsApi.UpdateBrandOptionsUpdateBrandOptions Class.classAccountsApi.UpdateConsumerDisclosureOptionsUpdateConsumerDisclosureOptions Class.classAccountsApi.UpdateCustomFieldOptionsUpdateCustomFieldOptions Class.classAccountsApi.UpdatePermissionProfileOptionsUpdatePermissionProfileOptions Class.classAccountsApi.UpdateSharedAccessOptionsUpdateSharedAccessOptions Class.
-
Constructor Summary
Constructors Constructor Description AccountsApi()AccountsApi.AccountsApi(ApiClient apiClient)AccountsApi.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description NewAccountSummarycreate(NewAccountDefinition newAccountDefinition)Creates new accounts..NewAccountSummarycreate(NewAccountDefinition newAccountDefinition, AccountsApi.CreateOptions options)Creates new accounts..AccountSignaturesInformationcreateAccountSignatures(String accountId, AccountSignaturesInformation accountSignaturesInformation)Adds/updates one or more account signatures.AccountSignaturesInformationcreateAccountSignatures(String accountId, AccountSignaturesInformation accountSignaturesInformation, AccountsApi.CreateAccountSignaturesOptions options)Adds/updates one or more account signatures.ApiResponse<AccountSignaturesInformation>createAccountSignaturesWithHttpInfo(String accountId, AccountSignaturesInformation accountSignaturesInformation, AccountsApi.CreateAccountSignaturesOptions options)Adds/updates one or more account signatures.BrandsResponsecreateBrand(String accountId, Brand brand)Creates one or more brand profile files for the account..ApiResponse<BrandsResponse>createBrandWithHttpInfo(String accountId, Brand brand)Creates one or more brand profile files for the account.CustomFieldscreateCustomField(String accountId, CustomField customField)Creates an acount custom field..CustomFieldscreateCustomField(String accountId, CustomField customField, AccountsApi.CreateCustomFieldOptions options)Creates an acount custom field..ApiResponse<CustomFields>createCustomFieldWithHttpInfo(String accountId, CustomField customField, AccountsApi.CreateCustomFieldOptions options)Creates an acount custom field.PermissionProfilecreatePermissionProfile(String accountId, PermissionProfile permissionProfile)Creates a new permission profile in the specified account..PermissionProfilecreatePermissionProfile(String accountId, PermissionProfile permissionProfile, AccountsApi.CreatePermissionProfileOptions options)Creates a new permission profile in the specified account..ApiResponse<PermissionProfile>createPermissionProfileWithHttpInfo(String accountId, PermissionProfile permissionProfile, AccountsApi.CreatePermissionProfileOptions options)Creates a new permission profile in the specified account.ApiResponse<NewAccountSummary>createWithHttpInfo(NewAccountDefinition newAccountDefinition, AccountsApi.CreateOptions options)Creates new accounts.voiddelete(String accountId)Deletes the specified account..voiddeleteAccountSignature(String accountId, String signatureId)Close the specified signature by Id..AccountSignaturedeleteAccountSignatureImage(String accountId, String signatureId, String imageType)Deletes a signature, initials, or stamps image..ApiResponse<AccountSignature>deleteAccountSignatureImageWithHttpInfo(String accountId, String signatureId, String imageType)Deletes a signature, initials, or stamps image.ApiResponse<Object>deleteAccountSignatureWithHttpInfo(String accountId, String signatureId)Close the specified signature by Id.voiddeleteBrand(String accountId, String brandId)Removes a brand..voiddeleteBrandLogoByType(String accountId, String brandId, String logoType)Delete one branding logo..ApiResponse<Object>deleteBrandLogoByTypeWithHttpInfo(String accountId, String brandId, String logoType)Delete one branding logo.BrandsResponsedeleteBrands(String accountId, BrandsRequest brandsRequest)Deletes one or more brand profiles..ApiResponse<BrandsResponse>deleteBrandsWithHttpInfo(String accountId, BrandsRequest brandsRequest)Deletes one or more brand profiles.ApiResponse<Object>deleteBrandWithHttpInfo(String accountId, String brandId)Removes a brand.CaptiveRecipientInformationdeleteCaptiveRecipient(String accountId, String recipientPart, CaptiveRecipientInformation captiveRecipientInformation)Deletes the signature for one or more captive recipient records..ApiResponse<CaptiveRecipientInformation>deleteCaptiveRecipientWithHttpInfo(String accountId, String recipientPart, CaptiveRecipientInformation captiveRecipientInformation)Deletes the signature for one or more captive recipient records.voiddeleteCustomField(String accountId, String customFieldId)Delete an existing account custom field..voiddeleteCustomField(String accountId, String customFieldId, AccountsApi.DeleteCustomFieldOptions options)Delete an existing account custom field..ApiResponse<Object>deleteCustomFieldWithHttpInfo(String accountId, String customFieldId, AccountsApi.DeleteCustomFieldOptions options)Delete an existing account custom field.voiddeleteENoteConfiguration(String accountId)Deletes configuration information for the eNote eOriginal integration..ApiResponse<Object>deleteENoteConfigurationWithHttpInfo(String accountId)Deletes configuration information for the eNote eOriginal integration.voiddeletePermissionProfile(String accountId, String permissionProfileId)Deletes a permissions profile within the specified account..voiddeletePermissionProfile(String accountId, String permissionProfileId, AccountsApi.DeletePermissionProfileOptions options)Deletes a permissions profile within the specified account..ApiResponse<Object>deletePermissionProfileWithHttpInfo(String accountId, String permissionProfileId, AccountsApi.DeletePermissionProfileOptions options)Deletes a permissions profile within the specified account.ApiResponse<Object>deleteWithHttpInfo(String accountId)Deletes the specified account.AccountIdentityVerificationResponsegetAccountIdentityVerification(String accountId)Get the list of identity verification options for an account.ApiResponse<AccountIdentityVerificationResponse>getAccountIdentityVerificationWithHttpInfo(String accountId)Get the list of identity verification options for an account This method returns a list of Identity Verification workflows that are available to an account.AccountInformationgetAccountInformation(String accountId)Retrieves the account information for the specified account..AccountInformationgetAccountInformation(String accountId, AccountsApi.GetAccountInformationOptions options)Retrieves the account information for the specified account..ApiResponse<AccountInformation>getAccountInformationWithHttpInfo(String accountId, AccountsApi.GetAccountInformationOptions options)Retrieves the account information for the specified account.AccountSignaturegetAccountSignature(String accountId, String signatureId)Returns information about a single signature by specifed signatureId..byte[]getAccountSignatureImage(String accountId, String signatureId, String imageType)Returns a signature, initials, or stamps image..byte[]getAccountSignatureImage(String accountId, String signatureId, String imageType, AccountsApi.GetAccountSignatureImageOptions options)Returns a signature, initials, or stamps image..ApiResponse<byte[]>getAccountSignatureImageWithHttpInfo(String accountId, String signatureId, String imageType, AccountsApi.GetAccountSignatureImageOptions options)Returns a signature, initials, or stamps image.AccountSignaturesInformationgetAccountSignatures(String accountId)Returns the managed signature definitions for the account.AccountSignaturesInformationgetAccountSignatures(String accountId, AccountsApi.GetAccountSignaturesOptions options)Returns the managed signature definitions for the account.ApiResponse<AccountSignaturesInformation>getAccountSignaturesWithHttpInfo(String accountId, AccountsApi.GetAccountSignaturesOptions options)Returns the managed signature definitions for the accountApiResponse<AccountSignature>getAccountSignatureWithHttpInfo(String accountId, String signatureId)Returns information about a single signature by specifed signatureId.TabAccountSettingsgetAccountTabSettings(String accountId)Returns tab settings list for specified account.ApiResponse<TabAccountSettings>getAccountTabSettingsWithHttpInfo(String accountId)Returns tab settings list for specified account This method returns information about the tab types and tab functionality that is currently enabled for an account.PaymentGatewayAccountsInfogetAllPaymentGatewayAccounts(String accountId)Get all payment gateway account for the provided accountId.ApiResponse<PaymentGatewayAccountsInfo>getAllPaymentGatewayAccountsWithHttpInfo(String accountId)Get all payment gateway account for the provided accountId This method returns a list of payment gateway accounts and basic information about them.ApiClientgetApiClient()getApiClient Method.BillingChargeResponsegetBillingCharges(String accountId)Gets list of recurring and usage charges for the account..BillingChargeResponsegetBillingCharges(String accountId, AccountsApi.GetBillingChargesOptions options)Gets list of recurring and usage charges for the account..ApiResponse<BillingChargeResponse>getBillingChargesWithHttpInfo(String accountId, AccountsApi.GetBillingChargesOptions options)Gets list of recurring and usage charges for the account.BrandgetBrand(String accountId, String brandId)Get information for a specific brand..BrandgetBrand(String accountId, String brandId, AccountsApi.GetBrandOptions options)Get information for a specific brand..voidgetBrandExportFile(String accountId, String brandId)Export a specific brand..ApiResponse<Object>getBrandExportFileWithHttpInfo(String accountId, String brandId)Export a specific brand.byte[]getBrandLogoByType(String accountId, String brandId, String logoType)Obtains the specified image for a brand..ApiResponse<byte[]>getBrandLogoByTypeWithHttpInfo(String accountId, String brandId, String logoType)Obtains the specified image for a brand.BrandResourcesListgetBrandResources(String accountId, String brandId)Returns the specified account's list of branding resources (metadata)..voidgetBrandResourcesByContentType(String accountId, String brandId, String resourceContentType)Returns the specified branding resource file..voidgetBrandResourcesByContentType(String accountId, String brandId, String resourceContentType, AccountsApi.GetBrandResourcesByContentTypeOptions options)Returns the specified branding resource file..ApiResponse<Object>getBrandResourcesByContentTypeWithHttpInfo(String accountId, String brandId, String resourceContentType, AccountsApi.GetBrandResourcesByContentTypeOptions options)Returns the specified branding resource file.ApiResponse<BrandResourcesList>getBrandResourcesWithHttpInfo(String accountId, String brandId)Returns the specified account's list of branding resources (metadata).ApiResponse<Brand>getBrandWithHttpInfo(String accountId, String brandId, AccountsApi.GetBrandOptions options)Get information for a specific brand.ConsumerDisclosuregetConsumerDisclosure(String accountId, String langCode)Gets the Electronic Record and Signature Disclosure..ConsumerDisclosuregetConsumerDisclosureDefault(String accountId)Gets the Electronic Record and Signature Disclosure for the account..ConsumerDisclosuregetConsumerDisclosureDefault(String accountId, AccountsApi.GetConsumerDisclosureDefaultOptions options)Gets the Electronic Record and Signature Disclosure for the account..ApiResponse<ConsumerDisclosure>getConsumerDisclosureDefaultWithHttpInfo(String accountId, AccountsApi.GetConsumerDisclosureDefaultOptions options)Gets the Electronic Record and Signature Disclosure for the account.ApiResponse<ConsumerDisclosure>getConsumerDisclosureWithHttpInfo(String accountId, String langCode)Gets the Electronic Record and Signature Disclosure.ENoteConfigurationgetENoteConfiguration(String accountId)Returns the configuration information for the eNote eOriginal integration..ApiResponse<ENoteConfiguration>getENoteConfigurationWithHttpInfo(String accountId)Returns the configuration information for the eNote eOriginal integration.EnvelopePurgeConfigurationgetEnvelopePurgeConfiguration(String accountId)Select envelope purge configuration..ApiResponse<EnvelopePurgeConfiguration>getEnvelopePurgeConfigurationWithHttpInfo(String accountId)Select envelope purge configuration.FavoriteTemplatesInfogetFavoriteTemplates(String accountId)Retrieves the list of favorited templates for this caller.ApiResponse<FavoriteTemplatesInfo>getFavoriteTemplatesWithHttpInfo(String accountId)Retrieves the list of favorited templates for this callerNotificationDefaultsgetNotificationDefaults(String accountId)Returns default user level settings for a specified account.ApiResponse<NotificationDefaults>getNotificationDefaultsWithHttpInfo(String accountId)Returns default user level settings for a specified account This method returns the default settings for the email notifications that signers and senders receive about envelopes.AccountPasswordRulesgetPasswordRules(String accountId)Get the password rules.UserPasswordRulesgetPasswordRules_0()Get membership account password rules.ApiResponse<UserPasswordRules>getPasswordRules_0WithHttpInfo()Get membership account password rulesApiResponse<AccountPasswordRules>getPasswordRulesWithHttpInfo(String accountId)Get the password rules This method retrieves the password rules for an account.PermissionProfilegetPermissionProfile(String accountId, String permissionProfileId)Returns a permissions profile in the specified account..PermissionProfilegetPermissionProfile(String accountId, String permissionProfileId, AccountsApi.GetPermissionProfileOptions options)Returns a permissions profile in the specified account..ApiResponse<PermissionProfile>getPermissionProfileWithHttpInfo(String accountId, String permissionProfileId, AccountsApi.GetPermissionProfileOptions options)Returns a permissions profile in the specified account.ProvisioningInformationgetProvisioning()Retrieves the account provisioning information for the account..ApiResponse<ProvisioningInformation>getProvisioningWithHttpInfo()Retrieves the account provisioning information for the account.SupportedLanguagesgetSupportedLanguages(String accountId)Gets list of supported languages for recipient language setting..ApiResponse<SupportedLanguages>getSupportedLanguagesWithHttpInfo(String accountId)Gets list of supported languages for recipient language setting.WatermarkgetWatermark(String accountId)Get watermark information..WatermarkgetWatermarkPreview(String accountId, Watermark watermark)Get watermark preview..ApiResponse<Watermark>getWatermarkPreviewWithHttpInfo(String accountId, Watermark watermark)Get watermark preview.ApiResponse<Watermark>getWatermarkWithHttpInfo(String accountId)Get watermark information.BrandsResponselistBrands(String accountId)Gets a list of brand profiles..BrandsResponselistBrands(String accountId, AccountsApi.ListBrandsOptions options)Gets a list of brand profiles..ApiResponse<BrandsResponse>listBrandsWithHttpInfo(String accountId, AccountsApi.ListBrandsOptions options)Gets a list of brand profiles.CustomFieldslistCustomFields(String accountId)Gets a list of custom fields associated with the account..ApiResponse<CustomFields>listCustomFieldsWithHttpInfo(String accountId)Gets a list of custom fields associated with the account.PermissionProfileInformationlistPermissions(String accountId)Gets a list of permission profiles..PermissionProfileInformationlistPermissions(String accountId, AccountsApi.ListPermissionsOptions options)Gets a list of permission profiles..ApiResponse<PermissionProfileInformation>listPermissionsWithHttpInfo(String accountId, AccountsApi.ListPermissionsOptions options)Gets a list of permission profiles.RecipientNamesResponselistRecipientNamesByEmail(String accountId)Gets recipient names associated with an email address..RecipientNamesResponselistRecipientNamesByEmail(String accountId, AccountsApi.ListRecipientNamesByEmailOptions options)Gets recipient names associated with an email address..ApiResponse<RecipientNamesResponse>listRecipientNamesByEmailWithHttpInfo(String accountId, AccountsApi.ListRecipientNamesByEmailOptions options)Gets recipient names associated with an email address.AccountSettingsInformationlistSettings(String accountId)Gets account settings information..ApiResponse<AccountSettingsInformation>listSettingsWithHttpInfo(String accountId)Gets account settings information.AccountSharedAccesslistSharedAccess(String accountId)Reserved: Gets the shared item status for one or more users..AccountSharedAccesslistSharedAccess(String accountId, AccountsApi.ListSharedAccessOptions options)Reserved: Gets the shared item status for one or more users..ApiResponse<AccountSharedAccess>listSharedAccessWithHttpInfo(String accountId, AccountsApi.ListSharedAccessOptions options)Reserved: Gets the shared item status for one or more users.AccountSignatureProviderslistSignatureProviders(String accountId)Returns Account available signature providers for specified account..ApiResponse<AccountSignatureProviders>listSignatureProvidersWithHttpInfo(String accountId)Returns Account available signature providers for specified account.FileTypeListlistUnsupportedFileTypes(String accountId)Gets a list of unsupported file types..ApiResponse<FileTypeList>listUnsupportedFileTypesWithHttpInfo(String accountId)Gets a list of unsupported file types.voidsetApiClient(ApiClient apiClient)setApiClient Method.FavoriteTemplatesInfounFavoriteTemplate(String accountId, FavoriteTemplatesInfo favoriteTemplatesInfo)Unfavorite a template.ApiResponse<FavoriteTemplatesInfo>unFavoriteTemplateWithHttpInfo(String accountId, FavoriteTemplatesInfo favoriteTemplatesInfo)Unfavorite a templateAccountSignaturesInformationupdateAccountSignature(String accountId, AccountSignaturesInformation accountSignaturesInformation)Updates a account signature..AccountSignatureupdateAccountSignatureById(String accountId, String signatureId, AccountSignatureDefinition accountSignatureDefinition)Updates a account signature..AccountSignatureupdateAccountSignatureById(String accountId, String signatureId, AccountSignatureDefinition accountSignatureDefinition, AccountsApi.UpdateAccountSignatureByIdOptions options)Updates a account signature..ApiResponse<AccountSignature>updateAccountSignatureByIdWithHttpInfo(String accountId, String signatureId, AccountSignatureDefinition accountSignatureDefinition, AccountsApi.UpdateAccountSignatureByIdOptions options)Updates a account signature.AccountSignatureupdateAccountSignatureImage(String accountId, String signatureId, String imageType)Sets a signature, initials, or stamps image..AccountSignatureupdateAccountSignatureImage(String accountId, String signatureId, String imageType, AccountsApi.UpdateAccountSignatureImageOptions options)Sets a signature, initials, or stamps image..ApiResponse<AccountSignature>updateAccountSignatureImageWithHttpInfo(String accountId, String signatureId, String imageType, AccountsApi.UpdateAccountSignatureImageOptions options)Sets a signature, initials, or stamps image.ApiResponse<AccountSignaturesInformation>updateAccountSignatureWithHttpInfo(String accountId, AccountSignaturesInformation accountSignaturesInformation)Updates a account signature.TabAccountSettingsupdateAccountTabSettings(String accountId, TabAccountSettings tabAccountSettings)Modifies tab settings for specified account.ApiResponse<TabAccountSettings>updateAccountTabSettingsWithHttpInfo(String accountId, TabAccountSettings tabAccountSettings)Modifies tab settings for specified account This method modifies the tab types and tab functionality that is enabled for an account.BrandupdateBrand(String accountId, String brandId, Brand brand)Updates an existing brand..BrandupdateBrand(String accountId, String brandId, Brand brand, AccountsApi.UpdateBrandOptions options)Updates an existing brand..voidupdateBrandLogoByType(String accountId, String brandId, String logoType, byte[] logoFileBytes)Put one branding logo..ApiResponse<Object>updateBrandLogoByTypeWithHttpInfo(String accountId, String brandId, String logoType, byte[] logoFileBytes)Put one branding logo.BrandResourcesupdateBrandResourcesByContentType(String accountId, String brandId, String resourceContentType, byte[] fileXml)Uploads a branding resource file..ApiResponse<BrandResources>updateBrandResourcesByContentTypeWithHttpInfo(String accountId, String brandId, String resourceContentType, byte[] fileXml)Uploads a branding resource file.ApiResponse<Brand>updateBrandWithHttpInfo(String accountId, String brandId, Brand brand, AccountsApi.UpdateBrandOptions options)Updates an existing brand.ConsumerDisclosureupdateConsumerDisclosure(String accountId, String langCode, ConsumerDisclosure consumerDisclosure)Update Consumer Disclosure..ConsumerDisclosureupdateConsumerDisclosure(String accountId, String langCode, ConsumerDisclosure consumerDisclosure, AccountsApi.UpdateConsumerDisclosureOptions options)Update Consumer Disclosure..ApiResponse<ConsumerDisclosure>updateConsumerDisclosureWithHttpInfo(String accountId, String langCode, ConsumerDisclosure consumerDisclosure, AccountsApi.UpdateConsumerDisclosureOptions options)Update Consumer Disclosure.CustomFieldsupdateCustomField(String accountId, String customFieldId, CustomField customField)Updates an existing account custom field..CustomFieldsupdateCustomField(String accountId, String customFieldId, CustomField customField, AccountsApi.UpdateCustomFieldOptions options)Updates an existing account custom field..ApiResponse<CustomFields>updateCustomFieldWithHttpInfo(String accountId, String customFieldId, CustomField customField, AccountsApi.UpdateCustomFieldOptions options)Updates an existing account custom field.ENoteConfigurationupdateENoteConfiguration(String accountId, ENoteConfiguration eNoteConfiguration)Updates configuration information for the eNote eOriginal integration..ApiResponse<ENoteConfiguration>updateENoteConfigurationWithHttpInfo(String accountId, ENoteConfiguration eNoteConfiguration)Updates configuration information for the eNote eOriginal integration.EnvelopePurgeConfigurationupdateEnvelopePurgeConfiguration(String accountId, EnvelopePurgeConfiguration envelopePurgeConfiguration)Updates envelope purge configuration..ApiResponse<EnvelopePurgeConfiguration>updateEnvelopePurgeConfigurationWithHttpInfo(String accountId, EnvelopePurgeConfiguration envelopePurgeConfiguration)Updates envelope purge configuration.FavoriteTemplatesInfoupdateFavoriteTemplate(String accountId, FavoriteTemplatesInfo favoriteTemplatesInfo)Favorites a template.ApiResponse<FavoriteTemplatesInfo>updateFavoriteTemplateWithHttpInfo(String accountId, FavoriteTemplatesInfo favoriteTemplatesInfo)Favorites a templateNotificationDefaultsupdateNotificationDefaults(String accountId, NotificationDefaults notificationDefaults)Updates default user level settings for a specified account.ApiResponse<NotificationDefaults>updateNotificationDefaultsWithHttpInfo(String accountId, NotificationDefaults notificationDefaults)Updates default user level settings for a specified account This method changes the default settings for the email notifications that signers and senders receive about envelopes.AccountPasswordRulesupdatePasswordRules(String accountId, AccountPasswordRules accountPasswordRules)Update the password rules.ApiResponse<AccountPasswordRules>updatePasswordRulesWithHttpInfo(String accountId, AccountPasswordRules accountPasswordRules)Update the password rules This method updates the password rules for an account.PermissionProfileupdatePermissionProfile(String accountId, String permissionProfileId, PermissionProfile permissionProfile)Updates a permission profile within the specified account..PermissionProfileupdatePermissionProfile(String accountId, String permissionProfileId, PermissionProfile permissionProfile, AccountsApi.UpdatePermissionProfileOptions options)Updates a permission profile within the specified account..ApiResponse<PermissionProfile>updatePermissionProfileWithHttpInfo(String accountId, String permissionProfileId, PermissionProfile permissionProfile, AccountsApi.UpdatePermissionProfileOptions options)Updates a permission profile within the specified account.voidupdateSettings(String accountId, AccountSettingsInformation accountSettingsInformation)Updates the account settings for an account..ApiResponse<Object>updateSettingsWithHttpInfo(String accountId, AccountSettingsInformation accountSettingsInformation)Updates the account settings for an account.AccountSharedAccessupdateSharedAccess(String accountId, AccountSharedAccess accountSharedAccess)Reserved: Sets the shared access information for users..AccountSharedAccessupdateSharedAccess(String accountId, AccountSharedAccess accountSharedAccess, AccountsApi.UpdateSharedAccessOptions options)Reserved: Sets the shared access information for users..ApiResponse<AccountSharedAccess>updateSharedAccessWithHttpInfo(String accountId, AccountSharedAccess accountSharedAccess, AccountsApi.UpdateSharedAccessOptions options)Reserved: Sets the shared access information for users.WatermarkupdateWatermark(String accountId, Watermark watermark)Update watermark information..ApiResponse<Watermark>updateWatermarkWithHttpInfo(String accountId, Watermark watermark)Update watermark information.
-
-
-
Constructor Detail
-
AccountsApi
public AccountsApi()
AccountsApi.
-
AccountsApi
public AccountsApi(ApiClient apiClient)
AccountsApi.
-
-
Method Detail
-
getApiClient
public ApiClient getApiClient()
getApiClient Method.- Returns:
- ApiClient
-
setApiClient
public void setApiClient(ApiClient apiClient)
setApiClient Method.
-
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
-
createWithHttpInfo
public ApiResponse<NewAccountSummary> createWithHttpInfo(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
-
createAccountSignatures
public AccountSignaturesInformation createAccountSignatures(String accountId, AccountSignaturesInformation accountSignaturesInformation) throws ApiException
Adds/updates one or more account signatures. This request may include images in multi-part format..- Parameters:
accountId- The external account number (int) or account ID Guid. (required)accountSignaturesInformation- (optional)- Returns:
- AccountSignaturesInformation
- Throws:
ApiException
-
createAccountSignatures
public AccountSignaturesInformation createAccountSignatures(String accountId, AccountSignaturesInformation accountSignaturesInformation, AccountsApi.CreateAccountSignaturesOptions options) throws ApiException
Adds/updates one or more account signatures. This request may include images in multi-part format..- Parameters:
accountId- The external account number (int) or account ID Guid. (required)accountSignaturesInformation- (optional)options- for modifying the method behavior.- Returns:
- AccountSignaturesInformation
- Throws:
ApiException- if fails to make API call
-
createAccountSignaturesWithHttpInfo
public ApiResponse<AccountSignaturesInformation> createAccountSignaturesWithHttpInfo(String accountId, AccountSignaturesInformation accountSignaturesInformation, AccountsApi.CreateAccountSignaturesOptions options) throws ApiException
Adds/updates one or more account signatures. This request may include images in multi-part format.- Parameters:
accountId- The external account number (int) or account ID Guid. (required)accountSignaturesInformation- (optional)options- for modifying the method behavior.- Returns:
- AccountSignaturesInformation
- 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
-
createBrandWithHttpInfo
public ApiResponse<BrandsResponse> createBrandWithHttpInfo(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.. This method creates a custom field and makes it available for all new envelopes associated with an account.- 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.. This method creates a custom field and makes it available for all new envelopes associated with an account.- 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
-
createCustomFieldWithHttpInfo
public ApiResponse<CustomFields> createCustomFieldWithHttpInfo(String accountId, CustomField customField, AccountsApi.CreateCustomFieldOptions options) throws ApiException
Creates an acount custom field. This method creates a custom field and makes it available for all new envelopes associated with an account.- 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.. This method creates a new permission profile for an account. ### Related topics - [How to create a permission profile](/docs/esign-rest-api/how-to/permission-profile-creating/)- 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.. This method creates a new permission profile for an account. ### Related topics - [How to create a permission profile](/docs/esign-rest-api/how-to/permission-profile-creating/)- 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
-
createPermissionProfileWithHttpInfo
public ApiResponse<PermissionProfile> createPermissionProfileWithHttpInfo(String accountId, PermissionProfile permissionProfile, AccountsApi.CreatePermissionProfileOptions options) throws ApiException
Creates a new permission profile in the specified account. This method creates a new permission profile for an account. ### Related topics - [How to create a permission profile](/docs/esign-rest-api/how-to/permission-profile-creating/)- 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
-
deleteWithHttpInfo
public ApiResponse<Object> deleteWithHttpInfo(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
-
deleteAccountSignature
public void deleteAccountSignature(String accountId, String signatureId) throws ApiException
Close the specified signature by Id..- Parameters:
accountId- The external account number (int) or account ID Guid. (required)signatureId- The ID of the signature being accessed. (required)- Throws:
ApiException- if fails to make API call
-
deleteAccountSignatureWithHttpInfo
public ApiResponse<Object> deleteAccountSignatureWithHttpInfo(String accountId, String signatureId) throws ApiException
Close the specified signature by Id.- Parameters:
accountId- The external account number (int) or account ID Guid. (required)signatureId- The ID of the signature being accessed. (required)- Throws:
ApiException- if fails to make API call
-
deleteAccountSignatureImage
public AccountSignature deleteAccountSignatureImage(String accountId, String signatureId, String imageType) throws ApiException
Deletes a signature, initials, or stamps image..- Parameters:
accountId- The external account number (int) or account ID Guid. (required)signatureId- The ID of the signature being accessed. (required)imageType- One of **signature_image** or **initials_image**. (required)- Returns:
- AccountSignature
- Throws:
ApiException- if fails to make API call
-
deleteAccountSignatureImageWithHttpInfo
public ApiResponse<AccountSignature> deleteAccountSignatureImageWithHttpInfo(String accountId, String signatureId, String imageType) throws ApiException
Deletes a signature, initials, or stamps image.- Parameters:
accountId- The external account number (int) or account ID Guid. (required)signatureId- The ID of the signature being accessed. (required)imageType- One of **signature_image** or **initials_image**. (required)- Returns:
- AccountSignature
- Throws:
ApiException- if fails to make API call
-
deleteBrand
public void deleteBrand(String accountId, String brandId) throws ApiException
Removes a brand.. This method deletes a brand from an account. **Note:** Branding for either signing or sending must be enabled for the account (`canSelfBrandSend` , `canSelfBrandSign`, or both of these account settings must be **true**).- 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
-
deleteBrandWithHttpInfo
public ApiResponse<Object> deleteBrandWithHttpInfo(String accountId, String brandId) throws ApiException
Removes a brand. This method deletes a brand from an account. **Note:** Branding for either signing or sending must be enabled for the account (`canSelfBrandSend` , `canSelfBrandSign`, or both of these account settings must be **true**).- 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.. This method deletes a single logo from an account brand. **Note:** Branding for either signing or sending must be enabled for the account (`canSelfBrandSend` , `canSelfBrandSign`, or both of these account settings must be **true**).- 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
-
deleteBrandLogoByTypeWithHttpInfo
public ApiResponse<Object> deleteBrandLogoByTypeWithHttpInfo(String accountId, String brandId, String logoType) throws ApiException
Delete one branding logo. This method deletes a single logo from an account brand. **Note:** Branding for either signing or sending must be enabled for the account (`canSelfBrandSend` , `canSelfBrandSign`, or both of these account settings must be **true**).- 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
-
deleteBrandsWithHttpInfo
public ApiResponse<BrandsResponse> deleteBrandsWithHttpInfo(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
-
deleteCaptiveRecipientWithHttpInfo
public ApiResponse<CaptiveRecipientInformation> deleteCaptiveRecipientWithHttpInfo(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.. This method deletes 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.. This method deletes 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
-
deleteCustomFieldWithHttpInfo
public ApiResponse<Object> deleteCustomFieldWithHttpInfo(String accountId, String customFieldId, AccountsApi.DeleteCustomFieldOptions options) throws ApiException
Delete an existing account custom field. This method deletes 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
-
deleteENoteConfigurationWithHttpInfo
public ApiResponse<Object> deleteENoteConfigurationWithHttpInfo(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.. This method deletes a permission profile from an account. To delete a permission profile, it must not have any users associated with it. When you use this method to delete a permission profile, you can reassign the users associated with it to a new permission profile at the same time by using the `move_users_to` query parameter. ### Related topics - [How to delete a permission profile](/docs/esign-rest-api/how-to/permission-profile-deleting/)- 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.. This method deletes a permission profile from an account. To delete a permission profile, it must not have any users associated with it. When you use this method to delete a permission profile, you can reassign the users associated with it to a new permission profile at the same time by using the `move_users_to` query parameter. ### Related topics - [How to delete a permission profile](/docs/esign-rest-api/how-to/permission-profile-deleting/)- 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
-
deletePermissionProfileWithHttpInfo
public ApiResponse<Object> deletePermissionProfileWithHttpInfo(String accountId, String permissionProfileId, AccountsApi.DeletePermissionProfileOptions options) throws ApiException
Deletes a permissions profile within the specified account. This method deletes a permission profile from an account. To delete a permission profile, it must not have any users associated with it. When you use this method to delete a permission profile, you can reassign the users associated with it to a new permission profile at the same time by using the `move_users_to` query parameter. ### Related topics - [How to delete a permission profile](/docs/esign-rest-api/how-to/permission-profile-deleting/)- 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. This method returns a list of Identity Verification workflows that are available to an account. **Note:** To use this method, you must either be an account administrator or a sender. ### Related topics - [How to require ID Verification (IDV) for a recipient](/docs/esign-rest-api/how-to/id-verification/)- Parameters:
accountId- The external account number (int) or account ID Guid. (required)- Returns:
- AccountIdentityVerificationResponse
- Throws:
ApiException- if fails to make API call
-
getAccountIdentityVerificationWithHttpInfo
public ApiResponse<AccountIdentityVerificationResponse> getAccountIdentityVerificationWithHttpInfo(String accountId) throws ApiException
Get the list of identity verification options for an account This method returns a list of Identity Verification workflows that are available to an account. **Note:** To use this method, you must either be an account administrator or a sender. ### Related topics - [How to require ID Verification (IDV) for a recipient](/docs/esign-rest-api/how-to/id-verification/)- 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
-
getAccountInformationWithHttpInfo
public ApiResponse<AccountInformation> getAccountInformationWithHttpInfo(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
-
getAccountSignature
public AccountSignature getAccountSignature(String accountId, String signatureId) throws ApiException
Returns information about a single signature by specifed signatureId..- Parameters:
accountId- The external account number (int) or account ID Guid. (required)signatureId- The ID of the signature being accessed. (required)- Returns:
- AccountSignature
- Throws:
ApiException- if fails to make API call
-
getAccountSignatureWithHttpInfo
public ApiResponse<AccountSignature> getAccountSignatureWithHttpInfo(String accountId, String signatureId) throws ApiException
Returns information about a single signature by specifed signatureId.- Parameters:
accountId- The external account number (int) or account ID Guid. (required)signatureId- The ID of the signature being accessed. (required)- Returns:
- AccountSignature
- Throws:
ApiException- if fails to make API call
-
getAccountSignatureImage
public byte[] getAccountSignatureImage(String accountId, String signatureId, String imageType) throws ApiException
Returns a signature, initials, or stamps image..- Parameters:
accountId- The external account number (int) or account ID Guid. (required)signatureId- The ID of the signature being accessed. (required)imageType- One of **signature_image** or **initials_image**. (required)- Returns:
- byte[]
- Throws:
ApiException
-
getAccountSignatureImage
public byte[] getAccountSignatureImage(String accountId, String signatureId, String imageType, AccountsApi.GetAccountSignatureImageOptions options) throws ApiException
Returns a signature, initials, or stamps image..- Parameters:
accountId- The external account number (int) or account ID Guid. (required)signatureId- The ID of the signature being accessed. (required)imageType- One of **signature_image** or **initials_image**. (required)options- for modifying the method behavior.- Returns:
- byte[]
- Throws:
ApiException- if fails to make API call
-
getAccountSignatureImageWithHttpInfo
public ApiResponse<byte[]> getAccountSignatureImageWithHttpInfo(String accountId, String signatureId, String imageType, AccountsApi.GetAccountSignatureImageOptions options) throws ApiException
Returns a signature, initials, or stamps image.- Parameters:
accountId- The external account number (int) or account ID Guid. (required)signatureId- The ID of the signature being accessed. (required)imageType- One of **signature_image** or **initials_image**. (required)options- for modifying the method behavior.- Returns:
- byte[]
- Throws:
ApiException- if fails to make API call
-
getAccountSignatures
public AccountSignaturesInformation getAccountSignatures(String accountId) throws ApiException
Returns the managed signature definitions for the account.- Parameters:
accountId- The external account number (int) or account ID Guid. (required)- Returns:
- AccountSignaturesInformation
- Throws:
ApiException
-
getAccountSignatures
public AccountSignaturesInformation getAccountSignatures(String accountId, AccountsApi.GetAccountSignaturesOptions options) throws ApiException
Returns the managed signature definitions for the account.- Parameters:
accountId- The external account number (int) or account ID Guid. (required)options- for modifying the method behavior.- Returns:
- AccountSignaturesInformation
- Throws:
ApiException- if fails to make API call
-
getAccountSignaturesWithHttpInfo
public ApiResponse<AccountSignaturesInformation> getAccountSignaturesWithHttpInfo(String accountId, AccountsApi.GetAccountSignaturesOptions options) throws ApiException
Returns the managed signature definitions for the account- Parameters:
accountId- The external account number (int) or account ID Guid. (required)options- for modifying the method behavior.- Returns:
- AccountSignaturesInformation
- Throws:
ApiException- if fails to make API call
-
getAccountTabSettings
public TabAccountSettings getAccountTabSettings(String accountId) throws ApiException
Returns tab settings list for specified account. This method returns information about the tab types and tab functionality that is currently enabled for an account.- Parameters:
accountId- The external account number (int) or account ID Guid. (required)- Returns:
- TabAccountSettings
- Throws:
ApiException- if fails to make API call
-
getAccountTabSettingsWithHttpInfo
public ApiResponse<TabAccountSettings> getAccountTabSettingsWithHttpInfo(String accountId) throws ApiException
Returns tab settings list for specified account This method returns information about the tab types and tab functionality that is currently enabled for an 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. This method returns a list of payment gateway accounts and basic information about them.- Parameters:
accountId- The external account number (int) or account ID Guid. (required)- Returns:
- PaymentGatewayAccountsInfo
- Throws:
ApiException- if fails to make API call
-
getAllPaymentGatewayAccountsWithHttpInfo
public ApiResponse<PaymentGatewayAccountsInfo> getAllPaymentGatewayAccountsWithHttpInfo(String accountId) throws ApiException
Get all payment gateway account for the provided accountId This method returns a list of payment gateway accounts and basic information about them.- 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
-
getBillingChargesWithHttpInfo
public ApiResponse<BillingChargeResponse> getBillingChargesWithHttpInfo(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.. This method returns details about an account brand. **Note:** Branding for either signing or sending must be enabled for the account (`canSelfBrandSend` , `canSelfBrandSign`, or both of these account settings must be **true**).- 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.. This method returns details about an account brand. **Note:** Branding for either signing or sending must be enabled for the account (`canSelfBrandSend` , `canSelfBrandSign`, or both of these account settings must be **true**).- 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
-
getBrandWithHttpInfo
public ApiResponse<Brand> getBrandWithHttpInfo(String accountId, String brandId, AccountsApi.GetBrandOptions options) throws ApiException
Get information for a specific brand. This method returns details about an account brand. **Note:** Branding for either signing or sending must be enabled for the account (`canSelfBrandSend` , `canSelfBrandSign`, or both of these account settings must be **true**).- 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.. This method exports information about a brand to an XML file. **Note:** Branding for either signing or sending must be enabled for the account (`canSelfBrandSend` , `canSelfBrandSign`, or both of these account settings must be **true**).- 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
-
getBrandExportFileWithHttpInfo
public ApiResponse<Object> getBrandExportFileWithHttpInfo(String accountId, String brandId) throws ApiException
Export a specific brand. This method exports information about a brand to an XML file. **Note:** Branding for either signing or sending must be enabled for the account (`canSelfBrandSend` , `canSelfBrandSign`, or both of these account settings must be **true**).- 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.. This method returns a specific logo that is used in a brand. **Note:** Branding for either signing or sending must be enabled for the account (`canSelfBrandSend` , `canSelfBrandSign`, or both of these account settings must be **true**).- 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
-
getBrandLogoByTypeWithHttpInfo
public ApiResponse<byte[]> getBrandLogoByTypeWithHttpInfo(String accountId, String brandId, String logoType) throws ApiException
Obtains the specified image for a brand. This method returns a specific logo that is used in a brand. **Note:** Branding for either signing or sending must be enabled for the account (`canSelfBrandSend` , `canSelfBrandSign`, or both of these account settings must be **true**).- 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).. This method returns metadata about the branding resources that are associated with an account. **Note:** Branding for either signing or sending must be enabled for the account (`canSelfBrandSend` , `canSelfBrandSign`, or both of these account settings must be **true**).- 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
-
getBrandResourcesWithHttpInfo
public ApiResponse<BrandResourcesList> getBrandResourcesWithHttpInfo(String accountId, String brandId) throws ApiException
Returns the specified account's list of branding resources (metadata). This method returns metadata about the branding resources that are associated with an account. **Note:** Branding for either signing or sending must be enabled for the account (`canSelfBrandSend` , `canSelfBrandSign`, or both of these account settings must be **true**).- 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.. This method returns a specific branding resource file. A brand uses a set of brand resource files to control the sending, signing, email message, and captive (embedded) signing experiences. You can modify the default email messages and formats in these files and upload them to your brand to customize the user experience. **Important:** When you upload a modified resource file, only the elements that differ from the master resource file are saved as your resource file. Similarly, when you download your resource files, only the modified elements are included in the file. **Note:** Branding for either signing or sending must be enabled for the account (`canSelfBrandSend` , `canSelfBrandSign`, or both of these account settings must be **true**).- 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.. This method returns a specific branding resource file. A brand uses a set of brand resource files to control the sending, signing, email message, and captive (embedded) signing experiences. You can modify the default email messages and formats in these files and upload them to your brand to customize the user experience. **Important:** When you upload a modified resource file, only the elements that differ from the master resource file are saved as your resource file. Similarly, when you download your resource files, only the modified elements are included in the file. **Note:** Branding for either signing or sending must be enabled for the account (`canSelfBrandSend` , `canSelfBrandSign`, or both of these account settings must be **true**).- 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
-
getBrandResourcesByContentTypeWithHttpInfo
public ApiResponse<Object> getBrandResourcesByContentTypeWithHttpInfo(String accountId, String brandId, String resourceContentType, AccountsApi.GetBrandResourcesByContentTypeOptions options) throws ApiException
Returns the specified branding resource file. This method returns a specific branding resource file. A brand uses a set of brand resource files to control the sending, signing, email message, and captive (embedded) signing experiences. You can modify the default email messages and formats in these files and upload them to your brand to customize the user experience. **Important:** When you upload a modified resource file, only the elements that differ from the master resource file are saved as your resource file. Similarly, when you download your resource files, only the modified elements are included in the file. **Note:** Branding for either signing or sending must be enabled for the account (`canSelfBrandSend` , `canSelfBrandSign`, or both of these account settings must be **true**).- 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
-
getConsumerDisclosureWithHttpInfo
public ApiResponse<ConsumerDisclosure> getConsumerDisclosureWithHttpInfo(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
-
getConsumerDisclosureDefaultWithHttpInfo
public ApiResponse<ConsumerDisclosure> getConsumerDisclosureDefaultWithHttpInfo(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
-
getENoteConfigurationWithHttpInfo
public ApiResponse<ENoteConfiguration> getENoteConfigurationWithHttpInfo(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.. An envelope purge configuration enables account administrators to permanently remove documents and their field data from completed and voided envelopes after a specified retention period (`retentionDays`). This method retrieves the current envelope purge configuration for your account. **Note:** To use this method, you must be an account administrator.- Parameters:
accountId- The external account number (int) or account ID Guid. (required)- Returns:
- EnvelopePurgeConfiguration
- Throws:
ApiException- if fails to make API call
-
getEnvelopePurgeConfigurationWithHttpInfo
public ApiResponse<EnvelopePurgeConfiguration> getEnvelopePurgeConfigurationWithHttpInfo(String accountId) throws ApiException
Select envelope purge configuration. An envelope purge configuration enables account administrators to permanently remove documents and their field data from completed and voided envelopes after a specified retention period (`retentionDays`). This method retrieves the current envelope purge configuration for your account. **Note:** To use this method, you must be an account administrator.- 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
-
getFavoriteTemplatesWithHttpInfo
public ApiResponse<FavoriteTemplatesInfo> getFavoriteTemplatesWithHttpInfo(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. This method returns the default settings for the email notifications that signers and senders receive about envelopes.- Parameters:
accountId- The external account number (int) or account ID Guid. (required)- Returns:
- NotificationDefaults
- Throws:
ApiException- if fails to make API call
-
getNotificationDefaultsWithHttpInfo
public ApiResponse<NotificationDefaults> getNotificationDefaultsWithHttpInfo(String accountId) throws ApiException
Returns default user level settings for a specified account This method returns the default settings for the email notifications that signers and senders receive about envelopes.- 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. This method retrieves the password rules for an account.- Parameters:
accountId- The external account number (int) or account ID Guid. (required)- Returns:
- AccountPasswordRules
- Throws:
ApiException- if fails to make API call
-
getPasswordRulesWithHttpInfo
public ApiResponse<AccountPasswordRules> getPasswordRulesWithHttpInfo(String accountId) throws ApiException
Get the password rules This method retrieves the password rules for an account.- 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
-
getPasswordRules_0WithHttpInfo
public ApiResponse<UserPasswordRules> getPasswordRules_0WithHttpInfo() 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.. This method returns information about a specific permission profile that is associated with an account. ### Related topics - [How to set a permission profile](/docs/esign-rest-api/how-to/permission-profile-setting/)- 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.. This method returns information about a specific permission profile that is associated with an account. ### Related topics - [How to set a permission profile](/docs/esign-rest-api/how-to/permission-profile-setting/)- 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
-
getPermissionProfileWithHttpInfo
public ApiResponse<PermissionProfile> getPermissionProfileWithHttpInfo(String accountId, String permissionProfileId, AccountsApi.GetPermissionProfileOptions options) throws ApiException
Returns a permissions profile in the specified account. This method returns information about a specific permission profile that is associated with an account. ### Related topics - [How to set a permission profile](/docs/esign-rest-api/how-to/permission-profile-setting/)- 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
-
getProvisioningWithHttpInfo
public ApiResponse<ProvisioningInformation> getProvisioningWithHttpInfo() 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.. Retrieves a list of supported languages that you can set for an individual recipient when creating an envelope, as well as their simple type enumeration values. These are the languages that you can set for the standard email format and signing view for each recipient. For example, in the recipient's email notification, this setting affects elements such as the standard introductory text describing the request to sign. It also determines the language used for buttons and tabs in both the email notification and the signing experience. **Note:** Setting a language for a recipient affects only the DocuSign standard text. Any custom text that you enter for the `emailBody` and `emailSubject` of the notification is not translated, and appears exactly as you enter it. For more information, see [Set Recipient Language and Specify Custom Email Messages](https://support.docusign.com/en/guides/ndse-user-guide-recipient-language).- Parameters:
accountId- The external account number (int) or account ID Guid. (required)- Returns:
- SupportedLanguages
- Throws:
ApiException- if fails to make API call
-
getSupportedLanguagesWithHttpInfo
public ApiResponse<SupportedLanguages> getSupportedLanguagesWithHttpInfo(String accountId) throws ApiException
Gets list of supported languages for recipient language setting. Retrieves a list of supported languages that you can set for an individual recipient when creating an envelope, as well as their simple type enumeration values. These are the languages that you can set for the standard email format and signing view for each recipient. For example, in the recipient's email notification, this setting affects elements such as the standard introductory text describing the request to sign. It also determines the language used for buttons and tabs in both the email notification and the signing experience. **Note:** Setting a language for a recipient affects only the DocuSign standard text. Any custom text that you enter for the `emailBody` and `emailSubject` of the notification is not translated, and appears exactly as you enter it. For more information, see [Set Recipient Language and Specify Custom Email Messages](https://support.docusign.com/en/guides/ndse-user-guide-recipient-language).- 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
-
getWatermarkWithHttpInfo
public ApiResponse<Watermark> getWatermarkWithHttpInfo(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
-
getWatermarkPreviewWithHttpInfo
public ApiResponse<Watermark> getWatermarkPreviewWithHttpInfo(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
-
listBrandsWithHttpInfo
public ApiResponse<BrandsResponse> listBrandsWithHttpInfo(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
-
listCustomFieldsWithHttpInfo
public ApiResponse<CustomFields> listCustomFieldsWithHttpInfo(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
-
listPermissionsWithHttpInfo
public ApiResponse<PermissionProfileInformation> listPermissionsWithHttpInfo(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
-
listRecipientNamesByEmailWithHttpInfo
public ApiResponse<RecipientNamesResponse> listRecipientNamesByEmailWithHttpInfo(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
-
listSettingsWithHttpInfo
public ApiResponse<AccountSettingsInformation> listSettingsWithHttpInfo(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
-
listSharedAccessWithHttpInfo
public ApiResponse<AccountSharedAccess> listSharedAccessWithHttpInfo(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.. Returns a list of signature providers that the specified account can use.- Parameters:
accountId- The external account number (int) or account ID Guid. (required)- Returns:
- AccountSignatureProviders
- Throws:
ApiException- if fails to make API call
-
listSignatureProvidersWithHttpInfo
public ApiResponse<AccountSignatureProviders> listSignatureProvidersWithHttpInfo(String accountId) throws ApiException
Returns Account available signature providers for specified account. Returns a list of signature providers that the specified account can use.- 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
-
listUnsupportedFileTypesWithHttpInfo
public ApiResponse<FileTypeList> listUnsupportedFileTypesWithHttpInfo(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
-
unFavoriteTemplateWithHttpInfo
public ApiResponse<FavoriteTemplatesInfo> unFavoriteTemplateWithHttpInfo(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
-
updateAccountSignature
public AccountSignaturesInformation updateAccountSignature(String accountId, AccountSignaturesInformation accountSignaturesInformation) throws ApiException
Updates a account signature..- Parameters:
accountId- The external account number (int) or account ID Guid. (required)accountSignaturesInformation- (optional)- Returns:
- AccountSignaturesInformation
- Throws:
ApiException- if fails to make API call
-
updateAccountSignatureWithHttpInfo
public ApiResponse<AccountSignaturesInformation> updateAccountSignatureWithHttpInfo(String accountId, AccountSignaturesInformation accountSignaturesInformation) throws ApiException
Updates a account signature.- Parameters:
accountId- The external account number (int) or account ID Guid. (required)accountSignaturesInformation- (optional)- Returns:
- AccountSignaturesInformation
- Throws:
ApiException- if fails to make API call
-
updateAccountSignatureById
public AccountSignature updateAccountSignatureById(String accountId, String signatureId, AccountSignatureDefinition accountSignatureDefinition) throws ApiException
Updates a account signature..- Parameters:
accountId- The external account number (int) or account ID Guid. (required)signatureId- The ID of the signature being accessed. (required)accountSignatureDefinition- (optional)- Returns:
- AccountSignature
- Throws:
ApiException
-
updateAccountSignatureById
public AccountSignature updateAccountSignatureById(String accountId, String signatureId, AccountSignatureDefinition accountSignatureDefinition, AccountsApi.UpdateAccountSignatureByIdOptions options) throws ApiException
Updates a account signature..- Parameters:
accountId- The external account number (int) or account ID Guid. (required)signatureId- The ID of the signature being accessed. (required)accountSignatureDefinition- (optional)options- for modifying the method behavior.- Returns:
- AccountSignature
- Throws:
ApiException- if fails to make API call
-
updateAccountSignatureByIdWithHttpInfo
public ApiResponse<AccountSignature> updateAccountSignatureByIdWithHttpInfo(String accountId, String signatureId, AccountSignatureDefinition accountSignatureDefinition, AccountsApi.UpdateAccountSignatureByIdOptions options) throws ApiException
Updates a account signature.- Parameters:
accountId- The external account number (int) or account ID Guid. (required)signatureId- The ID of the signature being accessed. (required)accountSignatureDefinition- (optional)options- for modifying the method behavior.- Returns:
- AccountSignature
- Throws:
ApiException- if fails to make API call
-
updateAccountSignatureImage
public AccountSignature updateAccountSignatureImage(String accountId, String signatureId, String imageType) throws ApiException
Sets a signature, initials, or stamps image..- Parameters:
accountId- The external account number (int) or account ID Guid. (required)signatureId- The ID of the signature being accessed. (required)imageType- One of **signature_image** or **initials_image**. (required)- Returns:
- AccountSignature
- Throws:
ApiException
-
updateAccountSignatureImage
public AccountSignature updateAccountSignatureImage(String accountId, String signatureId, String imageType, AccountsApi.UpdateAccountSignatureImageOptions options) throws ApiException
Sets a signature, initials, or stamps image..- Parameters:
accountId- The external account number (int) or account ID Guid. (required)signatureId- The ID of the signature being accessed. (required)imageType- One of **signature_image** or **initials_image**. (required)options- for modifying the method behavior.- Returns:
- AccountSignature
- Throws:
ApiException- if fails to make API call
-
updateAccountSignatureImageWithHttpInfo
public ApiResponse<AccountSignature> updateAccountSignatureImageWithHttpInfo(String accountId, String signatureId, String imageType, AccountsApi.UpdateAccountSignatureImageOptions options) throws ApiException
Sets a signature, initials, or stamps image.- Parameters:
accountId- The external account number (int) or account ID Guid. (required)signatureId- The ID of the signature being accessed. (required)imageType- One of **signature_image** or **initials_image**. (required)options- for modifying the method behavior.- Returns:
- AccountSignature
- Throws:
ApiException- if fails to make API call
-
updateAccountTabSettings
public TabAccountSettings updateAccountTabSettings(String accountId, TabAccountSettings tabAccountSettings) throws ApiException
Modifies tab settings for specified account. This method modifies the tab types and tab functionality that is enabled for an 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
-
updateAccountTabSettingsWithHttpInfo
public ApiResponse<TabAccountSettings> updateAccountTabSettingsWithHttpInfo(String accountId, TabAccountSettings tabAccountSettings) throws ApiException
Modifies tab settings for specified account This method modifies the tab types and tab functionality that is enabled for an 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.. This method updates an account brand. **Note:** Branding for either signing or sending must be enabled for the account (`canSelfBrandSend` , `canSelfBrandSign`, or both of these account settings must be **true**).- 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
-
updateBrand
public Brand updateBrand(String accountId, String brandId, Brand brand, AccountsApi.UpdateBrandOptions options) throws ApiException
Updates an existing brand.. This method updates an account brand. **Note:** Branding for either signing or sending must be enabled for the account (`canSelfBrandSend` , `canSelfBrandSign`, or both of these account settings must be **true**).- Parameters:
accountId- The external account number (int) or account ID Guid. (required)brandId- The unique identifier of a brand. (required)brand- (optional)options- for modifying the method behavior.- Returns:
- Brand
- Throws:
ApiException- if fails to make API call
-
updateBrandWithHttpInfo
public ApiResponse<Brand> updateBrandWithHttpInfo(String accountId, String brandId, Brand brand, AccountsApi.UpdateBrandOptions options) throws ApiException
Updates an existing brand. This method updates an account brand. **Note:** Branding for either signing or sending must be enabled for the account (`canSelfBrandSend` , `canSelfBrandSign`, or both of these account settings must be **true**).- Parameters:
accountId- The external account number (int) or account ID Guid. (required)brandId- The unique identifier of a brand. (required)brand- (optional)options- for modifying the method behavior.- 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.. This method updates a single brand logo. You pass in the new version of the resource in the `Content-Disposition` header. Example: `Content-Disposition: form-data; name=\"file\"; filename=\"logo.jpg\"` **Note:** Branding for either signing or sending must be enabled for the account (`canSelfBrandSend` , `canSelfBrandSign`, or both of these account settings must be **true**).- 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
-
updateBrandLogoByTypeWithHttpInfo
public ApiResponse<Object> updateBrandLogoByTypeWithHttpInfo(String accountId, String brandId, String logoType, byte[] logoFileBytes) throws ApiException
Put one branding logo. This method updates a single brand logo. You pass in the new version of the resource in the `Content-Disposition` header. Example: `Content-Disposition: form-data; name=\"file\"; filename=\"logo.jpg\"` **Note:** Branding for either signing or sending must be enabled for the account (`canSelfBrandSend` , `canSelfBrandSign`, or both of these account settings must be **true**).- 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, byte[] fileXml) throws ApiException
Uploads a branding resource file.. This method updates a branding resource file. You pass in the new version of the resource file in the `Content-Disposition` header. Example: `Content-Disposition: form-data; name=\"file\"; filename=\"DocuSign_SigningResource_4328673.xml\"` **Note:** Branding for either signing or sending must be enabled for the account (`canSelfBrandSend` , `canSelfBrandSign`, or both of these account settings must be **true**). **Important:** Customizing resource files is an advanced branding configuration option which can significantly impact your account, and should be done only by someone with expertise in XML and HTML. The master resource files are subject to change without notice. If you customize your resource files, after each release, DocuSign recommends you review any changes and update your custom files as needed. When you upload a modified resource file, only the elements that differ from the master resource file are saved as your resource file. Similarly, when you download your resource files, only the modified elements are included in the file.- Parameters:
accountId- The external account number (int) or account ID GUID. (required)brandId- The ID of the brand. (required)resourceContentType- The type of brand resource file that you are updating. Valid values are: - `sending` - `signing` - `email` - `signing_captive` (required)fileXml- Brand resource XML file. (required)- Returns:
- BrandResources
- Throws:
ApiException- if fails to make API call
-
updateBrandResourcesByContentTypeWithHttpInfo
public ApiResponse<BrandResources> updateBrandResourcesByContentTypeWithHttpInfo(String accountId, String brandId, String resourceContentType, byte[] fileXml) throws ApiException
Uploads a branding resource file. This method updates a branding resource file. You pass in the new version of the resource file in the `Content-Disposition` header. Example: `Content-Disposition: form-data; name=\"file\"; filename=\"DocuSign_SigningResource_4328673.xml\"` **Note:** Branding for either signing or sending must be enabled for the account (`canSelfBrandSend` , `canSelfBrandSign`, or both of these account settings must be **true**). **Important:** Customizing resource files is an advanced branding configuration option which can significantly impact your account, and should be done only by someone with expertise in XML and HTML. The master resource files are subject to change without notice. If you customize your resource files, after each release, DocuSign recommends you review any changes and update your custom files as needed. When you upload a modified resource file, only the elements that differ from the master resource file are saved as your resource file. Similarly, when you download your resource files, only the modified elements are included in the file.- Parameters:
accountId- The external account number (int) or account ID GUID. (required)brandId- The ID of the brand. (required)resourceContentType- The type of brand resource file that you are updating. Valid values are: - `sending` - `signing` - `email` - `signing_captive` (required)fileXml- Brand resource XML file. (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.. Account administrators can use this method to perform the following tasks: - Customize values in the default disclosure. - Switch to a custom disclosure that uses your own text and HTML formatting. - Change values in your existing consumer disclosure. To specify the signer language version of the disclosure that you are updating, use the optional `langCode` query parameter. **Note:** Only account administrators can use this method. Each time you change the disclosure content, all unsigned recipients of outstanding documents will be required to accept a new version. ## Updating the default disclosure When you update the default disclosure, you can edit all properties except for the following ones: - `accountEsignId`: This property is read-only. - `custom`: The default value is **false.** Editing this property causes the default disclosure to switch to a custom disclosure. - `esignAgreement`: This property is read-only. - `esignText`: You cannot edit this property when `custom` is set to **false.** The API returns a 200 OK HTTP response, but does not update the `esignText`. - Metadata properties: These properties are read-only. **Note:** The text of the default disclosure is always in English. ## Switching to a custom disclosure To switch to a custom disclosure, set the `custom` property to **true** and customize the value for the `eSignText` property. You can also edit all of the other properties except for the following ones: - `accountEsignId`: This property is read-only. - `esignAgreement`: This property is read-only. - Metadata properties: These properties are read-only. **Note:** When you use a custom disclosure, you can create versions of it in different signer languages and se the `langCode` parameter to specify the signer language version that you are updating. **Important:** When you switch from a default to a custom disclosure, note the following information: - You will not be able to return to using the default disclosure. - Only the disclosure for the currently selected signer language is saved. DocuSign will not automatically translate your custom disclosure. You must create a disclosure for each language that your signers use. ## Updating a custom disclosure When you update a custom disclosure, you can update all of the properties except for the following ones: - `accountEsignId`: This property is read-only. - `esignAgreement`: This property is read-only. - Metadata properties: These properties are read-only. **Important:** Only the disclosure for the currently selected signer language is saved. DocuSign will not automatically translate your custom disclosure. You must create a disclosure for each language that your signers use.- 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.. Account administrators can use this method to perform the following tasks: - Customize values in the default disclosure. - Switch to a custom disclosure that uses your own text and HTML formatting. - Change values in your existing consumer disclosure. To specify the signer language version of the disclosure that you are updating, use the optional `langCode` query parameter. **Note:** Only account administrators can use this method. Each time you change the disclosure content, all unsigned recipients of outstanding documents will be required to accept a new version. ## Updating the default disclosure When you update the default disclosure, you can edit all properties except for the following ones: - `accountEsignId`: This property is read-only. - `custom`: The default value is **false.** Editing this property causes the default disclosure to switch to a custom disclosure. - `esignAgreement`: This property is read-only. - `esignText`: You cannot edit this property when `custom` is set to **false.** The API returns a 200 OK HTTP response, but does not update the `esignText`. - Metadata properties: These properties are read-only. **Note:** The text of the default disclosure is always in English. ## Switching to a custom disclosure To switch to a custom disclosure, set the `custom` property to **true** and customize the value for the `eSignText` property. You can also edit all of the other properties except for the following ones: - `accountEsignId`: This property is read-only. - `esignAgreement`: This property is read-only. - Metadata properties: These properties are read-only. **Note:** When you use a custom disclosure, you can create versions of it in different signer languages and se the `langCode` parameter to specify the signer language version that you are updating. **Important:** When you switch from a default to a custom disclosure, note the following information: - You will not be able to return to using the default disclosure. - Only the disclosure for the currently selected signer language is saved. DocuSign will not automatically translate your custom disclosure. You must create a disclosure for each language that your signers use. ## Updating a custom disclosure When you update a custom disclosure, you can update all of the properties except for the following ones: - `accountEsignId`: This property is read-only. - `esignAgreement`: This property is read-only. - Metadata properties: These properties are read-only. **Important:** Only the disclosure for the currently selected signer language is saved. DocuSign will not automatically translate your custom disclosure. You must create a disclosure for each language that your signers use.- 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
-
updateConsumerDisclosureWithHttpInfo
public ApiResponse<ConsumerDisclosure> updateConsumerDisclosureWithHttpInfo(String accountId, String langCode, ConsumerDisclosure consumerDisclosure, AccountsApi.UpdateConsumerDisclosureOptions options) throws ApiException
Update Consumer Disclosure. Account administrators can use this method to perform the following tasks: - Customize values in the default disclosure. - Switch to a custom disclosure that uses your own text and HTML formatting. - Change values in your existing consumer disclosure. To specify the signer language version of the disclosure that you are updating, use the optional `langCode` query parameter. **Note:** Only account administrators can use this method. Each time you change the disclosure content, all unsigned recipients of outstanding documents will be required to accept a new version. ## Updating the default disclosure When you update the default disclosure, you can edit all properties except for the following ones: - `accountEsignId`: This property is read-only. - `custom`: The default value is **false.** Editing this property causes the default disclosure to switch to a custom disclosure. - `esignAgreement`: This property is read-only. - `esignText`: You cannot edit this property when `custom` is set to **false.** The API returns a 200 OK HTTP response, but does not update the `esignText`. - Metadata properties: These properties are read-only. **Note:** The text of the default disclosure is always in English. ## Switching to a custom disclosure To switch to a custom disclosure, set the `custom` property to **true** and customize the value for the `eSignText` property. You can also edit all of the other properties except for the following ones: - `accountEsignId`: This property is read-only. - `esignAgreement`: This property is read-only. - Metadata properties: These properties are read-only. **Note:** When you use a custom disclosure, you can create versions of it in different signer languages and se the `langCode` parameter to specify the signer language version that you are updating. **Important:** When you switch from a default to a custom disclosure, note the following information: - You will not be able to return to using the default disclosure. - Only the disclosure for the currently selected signer language is saved. DocuSign will not automatically translate your custom disclosure. You must create a disclosure for each language that your signers use. ## Updating a custom disclosure When you update a custom disclosure, you can update all of the properties except for the following ones: - `accountEsignId`: This property is read-only. - `esignAgreement`: This property is read-only. - Metadata properties: These properties are read-only. **Important:** Only the disclosure for the currently selected signer language is saved. DocuSign will not automatically translate your custom disclosure. You must create a disclosure for each language that your signers use.- 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.. This method 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.. This method 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
-
updateCustomFieldWithHttpInfo
public ApiResponse<CustomFields> updateCustomFieldWithHttpInfo(String accountId, String customFieldId, CustomField customField, AccountsApi.UpdateCustomFieldOptions options) throws ApiException
Updates an existing account custom field. This method 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
-
updateENoteConfigurationWithHttpInfo
public ApiResponse<ENoteConfiguration> updateENoteConfigurationWithHttpInfo(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.. An envelope purge configuration enables account administrators to permanently remove documents and their field data from completed and voided envelopes after a specified retention period (`retentionDays`). This method sets the envelope purge configuration for your account. **Note:** To use this method, you must be an account administrator. For more information, see [Purge Envelopes](https://support.docusign.com/en/guides/ndse-user-guide-purge-envelopes).- Parameters:
accountId- The external account number (int) or account ID Guid. (required)envelopePurgeConfiguration- (optional)- Returns:
- EnvelopePurgeConfiguration
- Throws:
ApiException- if fails to make API call
-
updateEnvelopePurgeConfigurationWithHttpInfo
public ApiResponse<EnvelopePurgeConfiguration> updateEnvelopePurgeConfigurationWithHttpInfo(String accountId, EnvelopePurgeConfiguration envelopePurgeConfiguration) throws ApiException
Updates envelope purge configuration. An envelope purge configuration enables account administrators to permanently remove documents and their field data from completed and voided envelopes after a specified retention period (`retentionDays`). This method sets the envelope purge configuration for your account. **Note:** To use this method, you must be an account administrator. For more information, see [Purge Envelopes](https://support.docusign.com/en/guides/ndse-user-guide-purge-envelopes).- 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
-
updateFavoriteTemplateWithHttpInfo
public ApiResponse<FavoriteTemplatesInfo> updateFavoriteTemplateWithHttpInfo(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. This method changes the default settings for the email notifications that signers and senders receive about envelopes.- Parameters:
accountId- The external account number (int) or account ID Guid. (required)notificationDefaults- (optional)- Returns:
- NotificationDefaults
- Throws:
ApiException- if fails to make API call
-
updateNotificationDefaultsWithHttpInfo
public ApiResponse<NotificationDefaults> updateNotificationDefaultsWithHttpInfo(String accountId, NotificationDefaults notificationDefaults) throws ApiException
Updates default user level settings for a specified account This method changes the default settings for the email notifications that signers and senders receive about envelopes.- 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. This method updates the password rules for an account. **Note:** To update the password rules for an account, you must be an account administrator.- Parameters:
accountId- The external account number (int) or account ID Guid. (required)accountPasswordRules- (optional)- Returns:
- AccountPasswordRules
- Throws:
ApiException- if fails to make API call
-
updatePasswordRulesWithHttpInfo
public ApiResponse<AccountPasswordRules> updatePasswordRulesWithHttpInfo(String accountId, AccountPasswordRules accountPasswordRules) throws ApiException
Update the password rules This method updates the password rules for an account. **Note:** To update the password rules for an account, you must be an account administrator.- 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.. This method updates an account permission profile. ### Related topics - [How to update individual permission settings](/docs/esign-rest-api/how-to/permission-profile-updating/)- 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.. This method updates an account permission profile. ### Related topics - [How to update individual permission settings](/docs/esign-rest-api/how-to/permission-profile-updating/)- 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
-
updatePermissionProfileWithHttpInfo
public ApiResponse<PermissionProfile> updatePermissionProfileWithHttpInfo(String accountId, String permissionProfileId, PermissionProfile permissionProfile, AccountsApi.UpdatePermissionProfileOptions options) throws ApiException
Updates a permission profile within the specified account. This method updates an account permission profile. ### Related topics - [How to update individual permission settings](/docs/esign-rest-api/how-to/permission-profile-updating/)- 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
-
updateSettingsWithHttpInfo
public ApiResponse<Object> updateSettingsWithHttpInfo(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
-
updateSharedAccessWithHttpInfo
public ApiResponse<AccountSharedAccess> updateSharedAccessWithHttpInfo(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
-
updateWatermarkWithHttpInfo
public ApiResponse<Watermark> updateWatermarkWithHttpInfo(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
-
-