Package com.docusign.esign.api

Class AccountsApi

  • public class AccountsApi
extends java.lang.Object
    AccountsApi class.

    • 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

      • createAccountSignatures

        public AccountSignaturesInformation createAccountSignatures​(java.lang.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​(java.lang.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​(java.lang.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​(java.lang.String accountId,
                                      CustomField customField)
                               throws ApiException
        Creates an acount custom field..
        Parameters:
        accountId - The external account number (int) or account ID Guid. (required)
        customField - (optional)
        Returns:
        CustomFields
        Throws:
        ApiException

      • createCustomField

        public CustomFields createCustomField​(java.lang.String accountId,
                                      CustomField customField,
                                      AccountsApi.CreateCustomFieldOptions options)
                               throws ApiException
        Creates an acount custom field..
        Parameters:
        accountId - The external account number (int) or account ID Guid. (required)
        customField - (optional)
        options - for modifying the method behavior.
        Returns:
        CustomFields
        Throws:
        ApiException - if fails to make API call

      • createPermissionProfile

        public PermissionProfile createPermissionProfile​(java.lang.String accountId,
                                                 PermissionProfile permissionProfile)
                                          throws ApiException
        Creates a new permission profile in the specified account..
        Parameters:
        accountId - The external account number (int) or account ID Guid. (required)
        permissionProfile - (optional)
        Returns:
        PermissionProfile
        Throws:
        ApiException

      • createPermissionProfile

        public PermissionProfile createPermissionProfile​(java.lang.String accountId,
                                                 PermissionProfile permissionProfile,
                                                 AccountsApi.CreatePermissionProfileOptions options)
                                          throws ApiException
        Creates a new permission profile in the specified account..
        Parameters:
        accountId - The external account number (int) or account ID Guid. (required)
        permissionProfile - (optional)
        options - for modifying the method behavior.
        Returns:
        PermissionProfile
        Throws:
        ApiException - if fails to make API call

      • delete

        public void delete​(java.lang.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​(java.lang.String accountId,
                                   java.lang.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​(java.lang.String accountId,
                                                    java.lang.String signatureId,
                                                    java.lang.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​(java.lang.String accountId,
                        java.lang.String brandId)
                 throws ApiException
        Removes a brand..
        Parameters:
        accountId - The external account number (int) or account ID Guid. (required)
        brandId - The unique identifier of a brand. (required)
        Throws:
        ApiException - if fails to make API call

      • deleteBrandLogoByType

        public void deleteBrandLogoByType​(java.lang.String accountId,
                                  java.lang.String brandId,
                                  java.lang.String logoType)
                           throws ApiException
        Delete one branding logo..
        Parameters:
        accountId - The external account number (int) or account ID Guid. (required)
        brandId - The unique identifier of a brand. (required)
        logoType - One of **Primary**, **Secondary** or **Email**. (required)
        Throws:
        ApiException - if fails to make API call

      • deleteBrands

        public BrandsResponse deleteBrands​(java.lang.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​(java.lang.String accountId,
                                                          java.lang.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​(java.lang.String accountId,
                              java.lang.String customFieldId)
                       throws ApiException
        Delete an existing account custom field..
        Parameters:
        accountId - The external account number (int) or account ID Guid. (required)
        customFieldId - (required)
        Throws:
        ApiException

      • deleteCustomField

        public void deleteCustomField​(java.lang.String accountId,
                              java.lang.String customFieldId,
                              AccountsApi.DeleteCustomFieldOptions options)
                       throws ApiException
        Delete an existing account custom field..
        Parameters:
        accountId - The external account number (int) or account ID Guid. (required)
        customFieldId - (required)
        options - for modifying the method behavior.
        Throws:
        ApiException - if fails to make API call

      • deleteENoteConfiguration

        public void deleteENoteConfiguration​(java.lang.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​(java.lang.String accountId,
                                    java.lang.String permissionProfileId)
                             throws ApiException
        Deletes a permissions profile within the specified account..
        Parameters:
        accountId - The external account number (int) or account ID Guid. (required)
        permissionProfileId - (required)
        Throws:
        ApiException

      • deletePermissionProfile

        public void deletePermissionProfile​(java.lang.String accountId,
                                    java.lang.String permissionProfileId,
                                    AccountsApi.DeletePermissionProfileOptions options)
                             throws ApiException
        Deletes a permissions profile within the specified account..
        Parameters:
        accountId - The external account number (int) or account ID Guid. (required)
        permissionProfileId - (required)
        options - for modifying the method behavior.
        Throws:
        ApiException - if fails to make API call

      • getAccountIdentityVerification

        public AccountIdentityVerificationResponse getAccountIdentityVerification​(java.lang.String accountId)
                                                                   throws ApiException
        Get the list of identity verification options for an account.
        Parameters:
        accountId - The external account number (int) or account ID Guid. (required)
        Returns:
        AccountIdentityVerificationResponse
        Throws:
        ApiException - if fails to make API call

      • getAccountInformation

        public AccountInformation getAccountInformation​(java.lang.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​(java.lang.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​(java.lang.String accountId,
                                            java.lang.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​(java.lang.String accountId,
                                       java.lang.String signatureId,
                                       java.lang.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​(java.lang.String accountId,
                                       java.lang.String signatureId,
                                       java.lang.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​(java.lang.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​(java.lang.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​(java.lang.String accountId)
                                         throws ApiException
        Returns tab settings list for specified account.
        Parameters:
        accountId - The external account number (int) or account ID Guid. (required)
        Returns:
        TabAccountSettings
        Throws:
        ApiException - if fails to make API call

      • getAllPaymentGatewayAccounts

        public PaymentGatewayAccountsInfo getAllPaymentGatewayAccounts​(java.lang.String accountId)
                                                        throws ApiException
        Get all payment gateway account for the provided accountId.
        Parameters:
        accountId - The external account number (int) or account ID Guid. (required)
        Returns:
        PaymentGatewayAccountsInfo
        Throws:
        ApiException - if fails to make API call

      • getBillingCharges

        public BillingChargeResponse getBillingCharges​(java.lang.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​(java.lang.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​(java.lang.String accountId,
                      java.lang.String brandId)
               throws ApiException
        Get information for a specific brand..
        Parameters:
        accountId - The external account number (int) or account ID Guid. (required)
        brandId - The unique identifier of a brand. (required)
        Returns:
        Brand
        Throws:
        ApiException

      • getBrand

        public Brand getBrand​(java.lang.String accountId,
                      java.lang.String brandId,
                      AccountsApi.GetBrandOptions options)
               throws ApiException
        Get information for a specific brand..
        Parameters:
        accountId - The external account number (int) or account ID Guid. (required)
        brandId - The unique identifier of a brand. (required)
        options - for modifying the method behavior.
        Returns:
        Brand
        Throws:
        ApiException - if fails to make API call

      • getBrandExportFile

        public void getBrandExportFile​(java.lang.String accountId,
                               java.lang.String brandId)
                        throws ApiException
        Export a specific brand..
        Parameters:
        accountId - The external account number (int) or account ID Guid. (required)
        brandId - The unique identifier of a brand. (required)
        Throws:
        ApiException - if fails to make API call

      • getBrandLogoByType

        public byte[] getBrandLogoByType​(java.lang.String accountId,
                                 java.lang.String brandId,
                                 java.lang.String logoType)
                          throws ApiException
        Obtains the specified image for a brand..
        Parameters:
        accountId - The external account number (int) or account ID Guid. (required)
        brandId - The unique identifier of a brand. (required)
        logoType - One of **Primary**, **Secondary** or **Email**. (required)
        Returns:
        byte[]
        Throws:
        ApiException - if fails to make API call

      • getBrandResources

        public BrandResourcesList getBrandResources​(java.lang.String accountId,
                                            java.lang.String brandId)
                                     throws ApiException
        Returns the specified account's list of branding resources (metadata)..
        Parameters:
        accountId - The external account number (int) or account ID Guid. (required)
        brandId - The unique identifier of a brand. (required)
        Returns:
        BrandResourcesList
        Throws:
        ApiException - if fails to make API call

      • getBrandResourcesByContentType

        public void getBrandResourcesByContentType​(java.lang.String accountId,
                                           java.lang.String brandId,
                                           java.lang.String resourceContentType)
                                    throws ApiException
        Returns the specified branding resource file..
        Parameters:
        accountId - The external account number (int) or account ID Guid. (required)
        brandId - The unique identifier of a brand. (required)
        resourceContentType - (required)
        Throws:
        ApiException

      • getBrandResourcesByContentType

        public void getBrandResourcesByContentType​(java.lang.String accountId,
                                           java.lang.String brandId,
                                           java.lang.String resourceContentType,
                                           AccountsApi.GetBrandResourcesByContentTypeOptions options)
                                    throws ApiException
        Returns the specified branding resource file..
        Parameters:
        accountId - The external account number (int) or account ID Guid. (required)
        brandId - The unique identifier of a brand. (required)
        resourceContentType - (required)
        options - for modifying the method behavior.
        Throws:
        ApiException - if fails to make API call

      • getConsumerDisclosure

        public ConsumerDisclosure getConsumerDisclosure​(java.lang.String accountId,
                                                java.lang.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​(java.lang.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​(java.lang.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​(java.lang.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​(java.lang.String accountId)
                                                         throws ApiException
        Select envelope purge configuration..
        Parameters:
        accountId - The external account number (int) or account ID Guid. (required)
        Returns:
        EnvelopePurgeConfiguration
        Throws:
        ApiException - if fails to make API call

      • getFavoriteTemplates

        public FavoriteTemplatesInfo getFavoriteTemplates​(java.lang.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​(java.lang.String accountId)
                                             throws ApiException
        Returns default user level settings for a specified account.
        Parameters:
        accountId - The external account number (int) or account ID Guid. (required)
        Returns:
        NotificationDefaults
        Throws:
        ApiException - if fails to make API call

      • getPasswordRules

        public AccountPasswordRules getPasswordRules​(java.lang.String accountId)
                                      throws ApiException
        Get the password rules.
        Parameters:
        accountId - The external account number (int) or account ID Guid. (required)
        Returns:
        AccountPasswordRules
        Throws:
        ApiException - if fails to make API call

      • getPermissionProfile

        public PermissionProfile getPermissionProfile​(java.lang.String accountId,
                                              java.lang.String permissionProfileId)
                                       throws ApiException
        Returns a permissions profile in the specified account..
        Parameters:
        accountId - The external account number (int) or account ID Guid. (required)
        permissionProfileId - (required)
        Returns:
        PermissionProfile
        Throws:
        ApiException

      • getPermissionProfile

        public PermissionProfile getPermissionProfile​(java.lang.String accountId,
                                              java.lang.String permissionProfileId,
                                              AccountsApi.GetPermissionProfileOptions options)
                                       throws ApiException
        Returns a permissions profile in the specified account..
        Parameters:
        accountId - The external account number (int) or account ID Guid. (required)
        permissionProfileId - (required)
        options - for modifying the method behavior.
        Returns:
        PermissionProfile
        Throws:
        ApiException - if fails to make API call

      • getProvisioning

        public ProvisioningInformation getProvisioning()
                                        throws ApiException
        Retrieves the account provisioning information for the account.. Retrieves the account provisioning information for the account.
        Returns:
        ProvisioningInformation
        Throws:
        ApiException - if fails to make API call

      • getReservedDomainExistence

        public ReservedDomainExistence getReservedDomainExistence​(java.lang.String accountId)
                                                   throws ApiException
        Returns whether or not the specified email domain is reserved/claimed..
        Parameters:
        accountId - The external account number (int) or account ID Guid. (required)
        Returns:
        ReservedDomainExistence
        Throws:
        ApiException

      • getReservedDomainExistence

        public ReservedDomainExistence getReservedDomainExistence​(java.lang.String accountId,
                                                          AccountsApi.GetReservedDomainExistenceOptions options)
                                                   throws ApiException
        Returns whether or not the specified email domain is reserved/claimed..
        Parameters:
        accountId - The external account number (int) or account ID Guid. (required)
        options - for modifying the method behavior.
        Returns:
        ReservedDomainExistence
        Throws:
        ApiException - if fails to make API call

      • getSupportedLanguages

        public SupportedLanguages getSupportedLanguages​(java.lang.String accountId)
                                         throws ApiException
        Gets list of supported languages for recipient language setting..
        Parameters:
        accountId - The external account number (int) or account ID Guid. (required)
        Returns:
        SupportedLanguages
        Throws:
        ApiException - if fails to make API call

      • getWatermark

        public Watermark getWatermark​(java.lang.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​(java.lang.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​(java.lang.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​(java.lang.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​(java.lang.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​(java.lang.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​(java.lang.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​(java.lang.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​(java.lang.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​(java.lang.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​(java.lang.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​(java.lang.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​(java.lang.String accountId)
                                                 throws ApiException
        Returns Account available signature providers for specified account..
        Parameters:
        accountId - The external account number (int) or account ID Guid. (required)
        Returns:
        AccountSignatureProviders
        Throws:
        ApiException - if fails to make API call

      • listUnsupportedFileTypes

        public FileTypeList listUnsupportedFileTypes​(java.lang.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​(java.lang.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​(java.lang.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​(java.lang.String accountId,
                                                   java.lang.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​(java.lang.String accountId,
                                                   java.lang.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​(java.lang.String accountId,
                                                    java.lang.String signatureId,
                                                    java.lang.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​(java.lang.String accountId,
                                                    java.lang.String signatureId,
                                                    java.lang.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​(java.lang.String accountId,
                                                   TabAccountSettings tabAccountSettings)
                                            throws ApiException
        Modifies tab settings for specified account.
        Parameters:
        accountId - The external account number (int) or account ID Guid. (required)
        tabAccountSettings - (optional)
        Returns:
        TabAccountSettings
        Throws:
        ApiException - if fails to make API call

      • updateBrand

        public Brand updateBrand​(java.lang.String accountId,
                         java.lang.String brandId,
                         Brand brand)
                  throws ApiException
        Updates an existing brand..
        Parameters:
        accountId - The external account number (int) or account ID Guid. (required)
        brandId - The unique identifier of a brand. (required)
        brand - (optional)
        Returns:
        Brand
        Throws:
        ApiException - if fails to make API call

      • updateBrandLogoByType

        public void updateBrandLogoByType​(java.lang.String accountId,
                                  java.lang.String brandId,
                                  java.lang.String logoType,
                                  byte[] logoFileBytes)
                           throws ApiException
        Put one branding logo..
        Parameters:
        accountId - The external account number (int) or account ID GUID. (required)
        brandId - The ID of the brand. (required)
        logoType - The type of logo. Valid values are: - `primary` - `secondary` - `email` (required)
        logoFileBytes - Brand logo binary Stream. Supported formats: JPG, GIF, PNG. Maximum file size: 300 KB. Recommended dimensions: 296 x 76 pixels (larger images will be resized). Changes may take up to one hour to display in all places (required)
        Throws:
        ApiException - if fails to make API call

      • updateBrandResourcesByContentType

        public BrandResources updateBrandResourcesByContentType​(java.lang.String accountId,
                                                        java.lang.String brandId,
                                                        java.lang.String resourceContentType,
                                                        byte[] fileXml)
                                                 throws ApiException
        Uploads a branding resource 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​(java.lang.String accountId,
                                                   java.lang.String langCode,
                                                   ConsumerDisclosure consumerDisclosure)
                                            throws ApiException
        Update Consumer Disclosure..
        Parameters:
        accountId - The external account number (int) or account ID Guid. (required)
        langCode - The simple type enumeration the language used in the response. The supported languages, with the language value shown in parenthesis, are:Arabic (ar), Armenian (hy), Bulgarian (bg), Czech (cs), Chinese Simplified (zh_CN), Chinese Traditional (zh_TW), Croatian (hr), Danish (da), Dutch (nl), English US (en), English UK (en_GB), Estonian (et), Farsi (fa), Finnish (fi), French (fr), French Canada (fr_CA), German (de), Greek (el), Hebrew (he), Hindi (hi), Hungarian (hu), Bahasa Indonesia (id), Italian (it), Japanese (ja), Korean (ko), Latvian (lv), Lithuanian (lt), Bahasa Melayu (ms), Norwegian (no), Polish (pl), Portuguese (pt), Portuguese Brazil (pt_BR), Romanian (ro), Russian (ru), Serbian (sr), Slovak (sk), Slovenian (sl), Spanish (es),Spanish Latin America (es_MX), Swedish (sv), Thai (th), Turkish (tr), Ukrainian (uk) and Vietnamese (vi). Additionally, the value can be set to �browser� to automatically detect the browser language being used by the viewer and display the disclosure in that language. (required)
        consumerDisclosure - (optional)
        Returns:
        ConsumerDisclosure
        Throws:
        ApiException

      • updateConsumerDisclosure

        public ConsumerDisclosure updateConsumerDisclosure​(java.lang.String accountId,
                                                   java.lang.String langCode,
                                                   ConsumerDisclosure consumerDisclosure,
                                                   AccountsApi.UpdateConsumerDisclosureOptions options)
                                            throws ApiException
        Update Consumer Disclosure..
        Parameters:
        accountId - The external account number (int) or account ID Guid. (required)
        langCode - The simple type enumeration the language used in the response. The supported languages, with the language value shown in parenthesis, are:Arabic (ar), Armenian (hy), Bulgarian (bg), Czech (cs), Chinese Simplified (zh_CN), Chinese Traditional (zh_TW), Croatian (hr), Danish (da), Dutch (nl), English US (en), English UK (en_GB), Estonian (et), Farsi (fa), Finnish (fi), French (fr), French Canada (fr_CA), German (de), Greek (el), Hebrew (he), Hindi (hi), Hungarian (hu), Bahasa Indonesia (id), Italian (it), Japanese (ja), Korean (ko), Latvian (lv), Lithuanian (lt), Bahasa Melayu (ms), Norwegian (no), Polish (pl), Portuguese (pt), Portuguese Brazil (pt_BR), Romanian (ro), Russian (ru), Serbian (sr), Slovak (sk), Slovenian (sl), Spanish (es),Spanish Latin America (es_MX), Swedish (sv), Thai (th), Turkish (tr), Ukrainian (uk) and Vietnamese (vi). Additionally, the value can be set to �browser� to automatically detect the browser language being used by the viewer and display the disclosure in that language. (required)
        consumerDisclosure - (optional)
        options - for modifying the method behavior.
        Returns:
        ConsumerDisclosure
        Throws:
        ApiException - if fails to make API call

      • updateCustomField

        public CustomFields updateCustomField​(java.lang.String accountId,
                                      java.lang.String customFieldId,
                                      CustomField customField)
                               throws ApiException
        Updates an existing account custom field..
        Parameters:
        accountId - The external account number (int) or account ID Guid. (required)
        customFieldId - (required)
        customField - (optional)
        Returns:
        CustomFields
        Throws:
        ApiException

      • updateCustomField

        public CustomFields updateCustomField​(java.lang.String accountId,
                                      java.lang.String customFieldId,
                                      CustomField customField,
                                      AccountsApi.UpdateCustomFieldOptions options)
                               throws ApiException
        Updates an existing account custom field..
        Parameters:
        accountId - The external account number (int) or account ID Guid. (required)
        customFieldId - (required)
        customField - (optional)
        options - for modifying the method behavior.
        Returns:
        CustomFields
        Throws:
        ApiException - if fails to make API call

      • updateENoteConfiguration

        public ENoteConfiguration updateENoteConfiguration​(java.lang.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​(java.lang.String accountId,
                                                                   EnvelopePurgeConfiguration envelopePurgeConfiguration)
                                                            throws ApiException
        Updates envelope purge configuration..
        Parameters:
        accountId - The external account number (int) or account ID Guid. (required)
        envelopePurgeConfiguration - (optional)
        Returns:
        EnvelopePurgeConfiguration
        Throws:
        ApiException - if fails to make API call

      • updateFavoriteTemplate

        public FavoriteTemplatesInfo updateFavoriteTemplate​(java.lang.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​(java.lang.String accountId,
                                                       NotificationDefaults notificationDefaults)
                                                throws ApiException
        Updates default user level settings for a specified account.
        Parameters:
        accountId - The external account number (int) or account ID Guid. (required)
        notificationDefaults - (optional)
        Returns:
        NotificationDefaults
        Throws:
        ApiException - if fails to make API call

      • updatePasswordRules

        public AccountPasswordRules updatePasswordRules​(java.lang.String accountId,
                                                AccountPasswordRules accountPasswordRules)
                                         throws ApiException
        Update the password rules.
        Parameters:
        accountId - The external account number (int) or account ID Guid. (required)
        accountPasswordRules - (optional)
        Returns:
        AccountPasswordRules
        Throws:
        ApiException - if fails to make API call

      • updatePermissionProfile

        public PermissionProfile updatePermissionProfile​(java.lang.String accountId,
                                                 java.lang.String permissionProfileId,
                                                 PermissionProfile permissionProfile)
                                          throws ApiException
        Updates a permission profile within the specified account..
        Parameters:
        accountId - The external account number (int) or account ID Guid. (required)
        permissionProfileId - (required)
        permissionProfile - (optional)
        Returns:
        PermissionProfile
        Throws:
        ApiException

      • updatePermissionProfile

        public PermissionProfile updatePermissionProfile​(java.lang.String accountId,
                                                 java.lang.String permissionProfileId,
                                                 PermissionProfile permissionProfile,
                                                 AccountsApi.UpdatePermissionProfileOptions options)
                                          throws ApiException
        Updates a permission profile within the specified account..
        Parameters:
        accountId - The external account number (int) or account ID Guid. (required)
        permissionProfileId - (required)
        permissionProfile - (optional)
        options - for modifying the method behavior.
        Returns:
        PermissionProfile
        Throws:
        ApiException - if fails to make API call

      • updateSettings

        public void updateSettings​(java.lang.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​(java.lang.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​(java.lang.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​(java.lang.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