com.docusign.esign.api

Class AccountsApi

java.lang.Object

com.docusign.esign.api.AccountsApi

public class AccountsApi
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	AccountsApi.GetAccountInformationOptions

Constructor Summary

Constructors

Constructor and Description
AccountsApi()
AccountsApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method and Description
AccountInformation	getAccountInformation(String accountId) Retrieves the account information for the specified account.
AccountInformation	getAccountInformation(String accountId, AccountsApi.GetAccountInformationOptions options) Retrieves the account information for the specified account.
ApiClient	getApiClient()
CustomFields	listCustomFields(String accountId) Gets a list of custom fields associated with the account.
AccountSettingsInformation	listSettings(String accountId) Gets account settings information.
AccountSharedAccess	listSharedAccess(String accountId) Reserved: Gets the shared item status for one or more users.
FileTypeList	listUnsupportedFileTypes(String accountId) Gets a list of unsupported file types.
void	setApiClient(ApiClient apiClient)
void	updateSettings(String accountId, AccountSettingsInformation accountSettingsInformation) Updates the account settings for an account.

Methods inherited from class java.lang.Object

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

Constructor Detail

AccountsApi

public AccountsApi()

AccountsApi

public AccountsApi(ApiClient apiClient)

Method Detail

getApiClient

public ApiClient getApiClient()

setApiClient

public void setApiClient(ApiClient apiClient)

getAccountInformation

public AccountInformation getAccountInformation(String accountId)
                                         throws ApiException

Retrieves the account information for the specified account. Retrieves the account information for the specified account.\n\n**Response**\nThe `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.

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.\n\n**Response**\nThe `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. AccountsApi.GetAccountInformationOptions Options for modifying the method behavior.

Returns:

AccountInformation

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.\n\nThere 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. AccountsApi.ListCustomFieldsOptions Options for modifying the method behavior.

Returns:

CustomFields

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. AccountsApi.ListSettingsOptions Options for modifying the method behavior.

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.\n\nUsers 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. AccountsApi.ListSharedAccessOptions Options for modifying the method behavior.

Returns:

AccountSharedAccess

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. AccountsApi.ListUnsupportedFileTypesOptions Options for modifying the method behavior.

Returns:

FileTypeList

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. AccountsApi.UpdateSettingsOptions Options for modifying the method behavior.

Throws:

ApiException - if fails to make API call