DocuSign CSharp Docs
Classes | Public Member Functions | Properties | List of all members
DocuSign.eSign.Api.AccountsApi Class Reference

Represents a collection of functions to interact with the API endpoints More...

Inheritance diagram for DocuSign.eSign.Api.AccountsApi:
DocuSign.eSign.Api.IAccountsApi DocuSign.eSign.Client.IApiAccessor

Classes

class  CreateAccountSignaturesOptions
 Adds/updates one or more account signatures. This request may include images in multi-part format. More...
 
class  CreateCustomFieldOptions
 Creates an acount custom field. This method creates a custom field and makes it available for all new envelopes associated with an account. More...
 
class  CreateOptions
 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. More...
 
class  CreatePermissionProfileOptions
 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 More...
 
class  DeleteCustomFieldOptions
 Delete an existing account custom field. This method deletes an existing account custom field. More...
 
class  DeletePermissionProfileOptions
 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 More...
 
class  GetAccountInformationOptions
 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. More...
 
class  GetAccountSignatureImageOptions
 Returns a signature, initials, or stamps image. More...
 
class  GetAccountSignaturesOptions
 Returns the managed signature definitions for the account More...
 
class  GetAgentUserAuthorizationsOptions
 Returns the agent user authorizations More...
 
class  GetBillingChargesOptions
 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 More...
 
class  GetBrandOptions
 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). More...
 
class  GetBrandResourcesByContentTypeOptions
 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). More...
 
class  GetConsumerDisclosureDefaultOptions
 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. More...
 
class  GetPermissionProfileOptions
 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 More...
 
class  GetPrincipalUserAuthorizationsOptions
 Returns the principal user authorizations More...
 
class  ListBrandsOptions
 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. More...
 
class  ListPermissionsOptions
 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. More...
 
class  ListRecipientNamesByEmailOptions
 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. More...
 
class  ListSharedAccessOptions
 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. More...
 
class  UpdateAccountSignatureByIdOptions
 Updates a account signature. More...
 
class  UpdateAccountSignatureImageOptions
 Sets a signature, initials, or stamps image. More...
 
class  UpdateBrandOptions
 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). More...
 
class  UpdateConsumerDisclosureOptions
 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. More...
 
class  UpdateCustomFieldOptions
 Updates an existing account custom field. This method updates an existing account custom field. More...
 
class  UpdatePermissionProfileOptions
 Updates a permission profile within the specified account. This method updates an account permission profile. ### Related topics - How to update individual permission settings More...
 
class  UpdateSharedAccessOptions
 Reserved: Sets the shared access information for users. Reserved: Sets the shared access information for one or more users. More...
 

Public Member Functions

 AccountsApi (DocuSignClient aplClient)
 Initializes a new instance of the AccountsApi class using AplClient object More...
 
String GetBasePath ()
 Gets the base path of the API client. More...
 
NewAccountSummary Create (NewAccountDefinition newAccountDefinition=null, AccountsApi.CreateOptions options=null)
 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. More...
 
ApiResponse< NewAccountSummaryCreateWithHttpInfo (NewAccountDefinition newAccountDefinition=null, AccountsApi.CreateOptions options=null)
 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 &#x60;newAccountRequests&#x60; 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 &#x60;newAccountDefinition&#x60; property inside the &#x60;newAccountRequests&#x60; 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 &#x60;errorDetails&#x60; node is added in the response to each specific request that failed. More...
 
async System.Threading.Tasks.Task< NewAccountSummaryCreateAsync (NewAccountDefinition newAccountDefinition=null, AccountsApi.CreateOptions options=null)
 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 &#x60;newAccountRequests&#x60; 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 &#x60;newAccountDefinition&#x60; property inside the &#x60;newAccountRequests&#x60; 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 &#x60;errorDetails&#x60; node is added in the response to each specific request that failed. More...
 
async System.Threading.Tasks.Task< ApiResponse< NewAccountSummary > > CreateAsyncWithHttpInfo (NewAccountDefinition newAccountDefinition=null, AccountsApi.CreateOptions options=null)
 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 &#x60;newAccountRequests&#x60; 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 &#x60;newAccountDefinition&#x60; property inside the &#x60;newAccountRequests&#x60; 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 &#x60;errorDetails&#x60; node is added in the response to each specific request that failed. More...
 
AccountSignaturesInformation CreateAccountSignatures (string accountId, AccountSignaturesInformation accountSignaturesInformation=null, AccountsApi.CreateAccountSignaturesOptions options=null)
 Adds/updates one or more account signatures. This request may include images in multi-part format. More...
 
ApiResponse< AccountSignaturesInformationCreateAccountSignaturesWithHttpInfo (string accountId, AccountSignaturesInformation accountSignaturesInformation=null, AccountsApi.CreateAccountSignaturesOptions options=null)
 Adds/updates one or more account signatures. This request may include images in multi-part format. More...
 
async System.Threading.Tasks.Task< AccountSignaturesInformationCreateAccountSignaturesAsync (string accountId, AccountSignaturesInformation accountSignaturesInformation=null, AccountsApi.CreateAccountSignaturesOptions options=null)
 Adds/updates one or more account signatures. This request may include images in multi-part format. More...
 
async System.Threading.Tasks.Task< ApiResponse< AccountSignaturesInformation > > CreateAccountSignaturesAsyncWithHttpInfo (string accountId, AccountSignaturesInformation accountSignaturesInformation=null, AccountsApi.CreateAccountSignaturesOptions options=null)
 Adds/updates one or more account signatures. This request may include images in multi-part format. More...
 
BrandsResponse CreateBrand (string accountId, Brand brand=null)
 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 &#x60;canSelfBrandSend&#x60; and &#x60;canSelfBrandSig&#x60;) must be set to true for the account to use this call. An error is returned if &#x60;brandId&#x60; 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 &#x60;Content-Type&#x60; must be &#x60;application/zip&#x60;. More...
 
ApiResponse< BrandsResponseCreateBrandWithHttpInfo (string accountId, Brand brand=null)
 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 &#x60;canSelfBrandSend&#x60; and &#x60;canSelfBrandSig&#x60;) must be set to true for the account to use this call. An error is returned if &#x60;brandId&#x60; 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 &#x60;Content-Type&#x60; must be &#x60;application/zip&#x60;. More...
 
async System.Threading.Tasks.Task< BrandsResponseCreateBrandAsync (string accountId, Brand brand=null)
 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 &#x60;canSelfBrandSend&#x60; and &#x60;canSelfBrandSig&#x60;) must be set to true for the account to use this call. An error is returned if &#x60;brandId&#x60; 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 &#x60;Content-Type&#x60; must be &#x60;application/zip&#x60;. More...
 
async System.Threading.Tasks.Task< ApiResponse< BrandsResponse > > CreateBrandAsyncWithHttpInfo (string accountId, Brand brand=null)
 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 &#x60;canSelfBrandSend&#x60; and &#x60;canSelfBrandSig&#x60;) must be set to true for the account to use this call. An error is returned if &#x60;brandId&#x60; 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 &#x60;Content-Type&#x60; must be &#x60;application/zip&#x60;. More...
 
CustomFields CreateCustomField (string accountId, CustomField customField=null, AccountsApi.CreateCustomFieldOptions options=null)
 Creates an acount custom field. This method creates a custom field and makes it available for all new envelopes associated with an account. More...
 
ApiResponse< CustomFieldsCreateCustomFieldWithHttpInfo (string accountId, CustomField customField=null, AccountsApi.CreateCustomFieldOptions options=null)
 Creates an acount custom field. This method creates a custom field and makes it available for all new envelopes associated with an account. More...
 
async System.Threading.Tasks.Task< CustomFieldsCreateCustomFieldAsync (string accountId, CustomField customField=null, AccountsApi.CreateCustomFieldOptions options=null)
 Creates an acount custom field. This method creates a custom field and makes it available for all new envelopes associated with an account. More...
 
async System.Threading.Tasks.Task< ApiResponse< CustomFields > > CreateCustomFieldAsyncWithHttpInfo (string accountId, CustomField customField=null, AccountsApi.CreateCustomFieldOptions options=null)
 Creates an acount custom field. This method creates a custom field and makes it available for all new envelopes associated with an account. More...
 
PermissionProfile CreatePermissionProfile (string accountId, PermissionProfile permissionProfile=null, AccountsApi.CreatePermissionProfileOptions options=null)
 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 More...
 
ApiResponse< PermissionProfileCreatePermissionProfileWithHttpInfo (string accountId, PermissionProfile permissionProfile=null, AccountsApi.CreatePermissionProfileOptions options=null)
 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 More...
 
async System.Threading.Tasks.Task< PermissionProfileCreatePermissionProfileAsync (string accountId, PermissionProfile permissionProfile=null, AccountsApi.CreatePermissionProfileOptions options=null)
 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 More...
 
async System.Threading.Tasks.Task< ApiResponse< PermissionProfile > > CreatePermissionProfileAsyncWithHttpInfo (string accountId, PermissionProfile permissionProfile=null, AccountsApi.CreatePermissionProfileOptions options=null)
 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 More...
 
UserAuthorization CreateUserAuthorization (string accountId, string userId, UserAuthorizationCreateRequest userAuthorizationCreateRequest=null)
 Creates the user authorization More...
 
ApiResponse< UserAuthorizationCreateUserAuthorizationWithHttpInfo (string accountId, string userId, UserAuthorizationCreateRequest userAuthorizationCreateRequest=null)
 Creates the user authorization More...
 
async System.Threading.Tasks.Task< UserAuthorizationCreateUserAuthorizationAsync (string accountId, string userId, UserAuthorizationCreateRequest userAuthorizationCreateRequest=null)
 Creates the user authorization More...
 
async System.Threading.Tasks.Task< ApiResponse< UserAuthorization > > CreateUserAuthorizationAsyncWithHttpInfo (string accountId, string userId, UserAuthorizationCreateRequest userAuthorizationCreateRequest=null)
 Creates the user authorization More...
 
UserAuthorizationsResponse CreateUserAuthorizations (string accountId, string userId, UserAuthorizationsRequest userAuthorizationsRequest=null)
 Creates ot updates user authorizations More...
 
ApiResponse< UserAuthorizationsResponseCreateUserAuthorizationsWithHttpInfo (string accountId, string userId, UserAuthorizationsRequest userAuthorizationsRequest=null)
 Creates ot updates user authorizations More...
 
async System.Threading.Tasks.Task< UserAuthorizationsResponseCreateUserAuthorizationsAsync (string accountId, string userId, UserAuthorizationsRequest userAuthorizationsRequest=null)
 Creates ot updates user authorizations More...
 
async System.Threading.Tasks.Task< ApiResponse< UserAuthorizationsResponse > > CreateUserAuthorizationsAsyncWithHttpInfo (string accountId, string userId, UserAuthorizationsRequest userAuthorizationsRequest=null)
 Creates ot updates user authorizations More...
 
void Delete (string accountId)
 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. More...
 
ApiResponse< Object > DeleteWithHttpInfo (string accountId)
 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. More...
 
async System.Threading.Tasks.Task DeleteAsync (string accountId)
 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. More...
 
async System.Threading.Tasks.Task< ApiResponse< Object > > DeleteAsyncWithHttpInfo (string accountId)
 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. More...
 
void DeleteAccountSignature (string accountId, string signatureId)
 Close the specified signature by Id. More...
 
ApiResponse< Object > DeleteAccountSignatureWithHttpInfo (string accountId, string signatureId)
 Close the specified signature by Id. More...
 
async System.Threading.Tasks.Task DeleteAccountSignatureAsync (string accountId, string signatureId)
 Close the specified signature by Id. More...
 
async System.Threading.Tasks.Task< ApiResponse< Object > > DeleteAccountSignatureAsyncWithHttpInfo (string accountId, string signatureId)
 Close the specified signature by Id. More...
 
AccountSignature DeleteAccountSignatureImage (string accountId, string signatureId, string imageType)
 Deletes a signature, initials, or stamps image. More...
 
ApiResponse< AccountSignatureDeleteAccountSignatureImageWithHttpInfo (string accountId, string signatureId, string imageType)
 Deletes a signature, initials, or stamps image. More...
 
async System.Threading.Tasks.Task< AccountSignatureDeleteAccountSignatureImageAsync (string accountId, string signatureId, string imageType)
 Deletes a signature, initials, or stamps image. More...
 
async System.Threading.Tasks.Task< ApiResponse< AccountSignature > > DeleteAccountSignatureImageAsyncWithHttpInfo (string accountId, string signatureId, string imageType)
 Deletes a signature, initials, or stamps image. More...
 
void DeleteBrand (string accountId, string brandId)
 Removes a brand. This method deletes a brand from an account. Note: Branding for either signing or sending must be enabled for the account (&#x60;canSelfBrandSend&#x60; , &#x60;canSelfBrandSign&#x60;, or both of these account settings must be true). More...
 
ApiResponse< Object > DeleteBrandWithHttpInfo (string accountId, string brandId)
 Removes a brand. This method deletes a brand from an account. Note: Branding for either signing or sending must be enabled for the account (&#x60;canSelfBrandSend&#x60; , &#x60;canSelfBrandSign&#x60;, or both of these account settings must be true). More...
 
async System.Threading.Tasks.Task DeleteBrandAsync (string accountId, string brandId)
 Removes a brand. This method deletes a brand from an account. Note: Branding for either signing or sending must be enabled for the account (&#x60;canSelfBrandSend&#x60; , &#x60;canSelfBrandSign&#x60;, or both of these account settings must be true). More...
 
async System.Threading.Tasks.Task< ApiResponse< Object > > DeleteBrandAsyncWithHttpInfo (string accountId, string brandId)
 Removes a brand. This method deletes a brand from an account. Note: Branding for either signing or sending must be enabled for the account (&#x60;canSelfBrandSend&#x60; , &#x60;canSelfBrandSign&#x60;, or both of these account settings must be true). More...
 
void DeleteBrandLogoByType (string accountId, string brandId, string logoType)
 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 (&#x60;canSelfBrandSend&#x60; , &#x60;canSelfBrandSign&#x60;, or both of these account settings must be true). More...
 
ApiResponse< Object > DeleteBrandLogoByTypeWithHttpInfo (string accountId, string brandId, string logoType)
 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 (&#x60;canSelfBrandSend&#x60; , &#x60;canSelfBrandSign&#x60;, or both of these account settings must be true). More...
 
async System.Threading.Tasks.Task DeleteBrandLogoByTypeAsync (string accountId, string brandId, string logoType)
 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 (&#x60;canSelfBrandSend&#x60; , &#x60;canSelfBrandSign&#x60;, or both of these account settings must be true). More...
 
async System.Threading.Tasks.Task< ApiResponse< Object > > DeleteBrandLogoByTypeAsyncWithHttpInfo (string accountId, string brandId, string logoType)
 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 (&#x60;canSelfBrandSend&#x60; , &#x60;canSelfBrandSign&#x60;, or both of these account settings must be true). More...
 
BrandsResponse DeleteBrands (string accountId, BrandsRequest brandsRequest=null)
 Deletes one or more brand profiles. Deletes one or more brand profiles from an account. The Account Branding feature (accountSettings properties &#x60;canSelfBrandSend&#x60; and &#x60;canSelfBrandSend&#x60;) must be set to true to use this call. More...
 
ApiResponse< BrandsResponseDeleteBrandsWithHttpInfo (string accountId, BrandsRequest brandsRequest=null)
 Deletes one or more brand profiles. Deletes one or more brand profiles from an account. The Account Branding feature (accountSettings properties &#x60;canSelfBrandSend&#x60; and &#x60;canSelfBrandSend&#x60;) must be set to true to use this call. More...
 
async System.Threading.Tasks.Task< BrandsResponseDeleteBrandsAsync (string accountId, BrandsRequest brandsRequest=null)
 Deletes one or more brand profiles. Deletes one or more brand profiles from an account. The Account Branding feature (accountSettings properties &#x60;canSelfBrandSend&#x60; and &#x60;canSelfBrandSend&#x60;) must be set to true to use this call. More...
 
async System.Threading.Tasks.Task< ApiResponse< BrandsResponse > > DeleteBrandsAsyncWithHttpInfo (string accountId, BrandsRequest brandsRequest=null)
 Deletes one or more brand profiles. Deletes one or more brand profiles from an account. The Account Branding feature (accountSettings properties &#x60;canSelfBrandSend&#x60; and &#x60;canSelfBrandSend&#x60;) must be set to true to use this call. More...
 
CaptiveRecipientInformation DeleteCaptiveRecipient (string accountId, string recipientPart, CaptiveRecipientInformation captiveRecipientInformation=null)
 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. More...
 
ApiResponse< CaptiveRecipientInformationDeleteCaptiveRecipientWithHttpInfo (string accountId, string recipientPart, CaptiveRecipientInformation captiveRecipientInformation=null)
 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. More...
 
async System.Threading.Tasks.Task< CaptiveRecipientInformationDeleteCaptiveRecipientAsync (string accountId, string recipientPart, CaptiveRecipientInformation captiveRecipientInformation=null)
 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. More...
 
async System.Threading.Tasks.Task< ApiResponse< CaptiveRecipientInformation > > DeleteCaptiveRecipientAsyncWithHttpInfo (string accountId, string recipientPart, CaptiveRecipientInformation captiveRecipientInformation=null)
 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. More...
 
void DeleteCustomField (string accountId, string customFieldId, AccountsApi.DeleteCustomFieldOptions options=null)
 Delete an existing account custom field. This method deletes an existing account custom field. More...
 
ApiResponse< Object > DeleteCustomFieldWithHttpInfo (string accountId, string customFieldId, AccountsApi.DeleteCustomFieldOptions options=null)
 Delete an existing account custom field. This method deletes an existing account custom field. More...
 
async System.Threading.Tasks.Task DeleteCustomFieldAsync (string accountId, string customFieldId, AccountsApi.DeleteCustomFieldOptions options=null)
 Delete an existing account custom field. This method deletes an existing account custom field. More...
 
async System.Threading.Tasks.Task< ApiResponse< Object > > DeleteCustomFieldAsyncWithHttpInfo (string accountId, string customFieldId, AccountsApi.DeleteCustomFieldOptions options=null)
 Delete an existing account custom field. This method deletes an existing account custom field. More...
 
void DeleteENoteConfiguration (string accountId)
 Deletes configuration information for the eNote eOriginal integration. More...
 
ApiResponse< Object > DeleteENoteConfigurationWithHttpInfo (string accountId)
 Deletes configuration information for the eNote eOriginal integration. More...
 
async System.Threading.Tasks.Task DeleteENoteConfigurationAsync (string accountId)
 Deletes configuration information for the eNote eOriginal integration. More...
 
async System.Threading.Tasks.Task< ApiResponse< Object > > DeleteENoteConfigurationAsyncWithHttpInfo (string accountId)
 Deletes configuration information for the eNote eOriginal integration. More...
 
void DeletePermissionProfile (string accountId, string permissionProfileId, AccountsApi.DeletePermissionProfileOptions options=null)
 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 &#x60;move_users_to&#x60; query parameter. ### Related topics - How to delete a permission profile More...
 
ApiResponse< Object > DeletePermissionProfileWithHttpInfo (string accountId, string permissionProfileId, AccountsApi.DeletePermissionProfileOptions options=null)
 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 &#x60;move_users_to&#x60; query parameter. ### Related topics - How to delete a permission profile More...
 
async System.Threading.Tasks.Task DeletePermissionProfileAsync (string accountId, string permissionProfileId, AccountsApi.DeletePermissionProfileOptions options=null)
 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 &#x60;move_users_to&#x60; query parameter. ### Related topics - How to delete a permission profile More...
 
async System.Threading.Tasks.Task< ApiResponse< Object > > DeletePermissionProfileAsyncWithHttpInfo (string accountId, string permissionProfileId, AccountsApi.DeletePermissionProfileOptions options=null)
 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 &#x60;move_users_to&#x60; query parameter. ### Related topics - How to delete a permission profile More...
 
void DeleteUserAuthorization (string accountId, string userId, string authorizationId)
 Deletes the user authorization More...
 
ApiResponse< Object > DeleteUserAuthorizationWithHttpInfo (string accountId, string userId, string authorizationId)
 Deletes the user authorization More...
 
async System.Threading.Tasks.Task DeleteUserAuthorizationAsync (string accountId, string userId, string authorizationId)
 Deletes the user authorization More...
 
async System.Threading.Tasks.Task< ApiResponse< Object > > DeleteUserAuthorizationAsyncWithHttpInfo (string accountId, string userId, string authorizationId)
 Deletes the user authorization More...
 
UserAuthorizationsDeleteResponse DeleteUserAuthorizations (string accountId, string userId, UserAuthorizationsDeleteRequest userAuthorizationsDeleteRequest=null)
 Creates ot updates user authorizations More...
 
ApiResponse< UserAuthorizationsDeleteResponseDeleteUserAuthorizationsWithHttpInfo (string accountId, string userId, UserAuthorizationsDeleteRequest userAuthorizationsDeleteRequest=null)
 Creates ot updates user authorizations More...
 
async System.Threading.Tasks.Task< UserAuthorizationsDeleteResponseDeleteUserAuthorizationsAsync (string accountId, string userId, UserAuthorizationsDeleteRequest userAuthorizationsDeleteRequest=null)
 Creates ot updates user authorizations More...
 
async System.Threading.Tasks.Task< ApiResponse< UserAuthorizationsDeleteResponse > > DeleteUserAuthorizationsAsyncWithHttpInfo (string accountId, string userId, UserAuthorizationsDeleteRequest userAuthorizationsDeleteRequest=null)
 Creates ot updates user authorizations More...
 
AccountIdentityVerificationResponse GetAccountIdentityVerification (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. 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 More...
 
ApiResponse< AccountIdentityVerificationResponseGetAccountIdentityVerificationWithHttpInfo (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. 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 More...
 
async System.Threading.Tasks.Task< AccountIdentityVerificationResponseGetAccountIdentityVerificationAsync (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. 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 More...
 
async System.Threading.Tasks.Task< ApiResponse< AccountIdentityVerificationResponse > > GetAccountIdentityVerificationAsyncWithHttpInfo (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. 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 More...
 
AccountInformation GetAccountInformation (string accountId, AccountsApi.GetAccountInformationOptions options=null)
 Retrieves the account information for the specified account. Retrieves the account information for the specified account. Response The &#x60;canUpgrade&#x60; property contains is a Boolean that indicates whether the account can be upgraded through the API. More...
 
ApiResponse< AccountInformationGetAccountInformationWithHttpInfo (string accountId, AccountsApi.GetAccountInformationOptions options=null)
 Retrieves the account information for the specified account. Retrieves the account information for the specified account. Response The &#x60;canUpgrade&#x60; property contains is a Boolean that indicates whether the account can be upgraded through the API. More...
 
async System.Threading.Tasks.Task< AccountInformationGetAccountInformationAsync (string accountId, AccountsApi.GetAccountInformationOptions options=null)
 Retrieves the account information for the specified account. Retrieves the account information for the specified account. Response The &#x60;canUpgrade&#x60; property contains is a Boolean that indicates whether the account can be upgraded through the API. More...
 
async System.Threading.Tasks.Task< ApiResponse< AccountInformation > > GetAccountInformationAsyncWithHttpInfo (string accountId, AccountsApi.GetAccountInformationOptions options=null)
 Retrieves the account information for the specified account. Retrieves the account information for the specified account. Response The &#x60;canUpgrade&#x60; property contains is a Boolean that indicates whether the account can be upgraded through the API. More...
 
AccountSignature GetAccountSignature (string accountId, string signatureId)
 Returns information about a single signature by specifed signatureId. More...
 
ApiResponse< AccountSignatureGetAccountSignatureWithHttpInfo (string accountId, string signatureId)
 Returns information about a single signature by specifed signatureId. More...
 
async System.Threading.Tasks.Task< AccountSignatureGetAccountSignatureAsync (string accountId, string signatureId)
 Returns information about a single signature by specifed signatureId. More...
 
async System.Threading.Tasks.Task< ApiResponse< AccountSignature > > GetAccountSignatureAsyncWithHttpInfo (string accountId, string signatureId)
 Returns information about a single signature by specifed signatureId. More...
 
System.IO.Stream GetAccountSignatureImage (string accountId, string signatureId, string imageType, AccountsApi.GetAccountSignatureImageOptions options=null)
 Returns a signature, initials, or stamps image. More...
 
ApiResponse< System.IO.Stream > GetAccountSignatureImageWithHttpInfo (string accountId, string signatureId, string imageType, AccountsApi.GetAccountSignatureImageOptions options=null)
 Returns a signature, initials, or stamps image. More...
 
async System.Threading.Tasks.Task< System.IO.Stream > GetAccountSignatureImageAsync (string accountId, string signatureId, string imageType, AccountsApi.GetAccountSignatureImageOptions options=null)
 Returns a signature, initials, or stamps image. More...
 
async System.Threading.Tasks.Task< ApiResponse< System.IO.Stream > > GetAccountSignatureImageAsyncWithHttpInfo (string accountId, string signatureId, string imageType, AccountsApi.GetAccountSignatureImageOptions options=null)
 Returns a signature, initials, or stamps image. More...
 
AccountSignaturesInformation GetAccountSignatures (string accountId, AccountsApi.GetAccountSignaturesOptions options=null)
 Returns the managed signature definitions for the account More...
 
ApiResponse< AccountSignaturesInformationGetAccountSignaturesWithHttpInfo (string accountId, AccountsApi.GetAccountSignaturesOptions options=null)
 Returns the managed signature definitions for the account More...
 
async System.Threading.Tasks.Task< AccountSignaturesInformationGetAccountSignaturesAsync (string accountId, AccountsApi.GetAccountSignaturesOptions options=null)
 Returns the managed signature definitions for the account More...
 
async System.Threading.Tasks.Task< ApiResponse< AccountSignaturesInformation > > GetAccountSignaturesAsyncWithHttpInfo (string accountId, AccountsApi.GetAccountSignaturesOptions options=null)
 Returns the managed signature definitions for the account More...
 
TabAccountSettings GetAccountTabSettings (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. More...
 
ApiResponse< TabAccountSettingsGetAccountTabSettingsWithHttpInfo (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. More...
 
async System.Threading.Tasks.Task< TabAccountSettingsGetAccountTabSettingsAsync (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. More...
 
async System.Threading.Tasks.Task< ApiResponse< TabAccountSettings > > GetAccountTabSettingsAsyncWithHttpInfo (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. More...
 
UserAuthorizations GetAgentUserAuthorizations (string accountId, string userId, AccountsApi.GetAgentUserAuthorizationsOptions options=null)
 Returns the agent user authorizations More...
 
ApiResponse< UserAuthorizationsGetAgentUserAuthorizationsWithHttpInfo (string accountId, string userId, AccountsApi.GetAgentUserAuthorizationsOptions options=null)
 Returns the agent user authorizations More...
 
async System.Threading.Tasks.Task< UserAuthorizationsGetAgentUserAuthorizationsAsync (string accountId, string userId, AccountsApi.GetAgentUserAuthorizationsOptions options=null)
 Returns the agent user authorizations More...
 
async System.Threading.Tasks.Task< ApiResponse< UserAuthorizations > > GetAgentUserAuthorizationsAsyncWithHttpInfo (string accountId, string userId, AccountsApi.GetAgentUserAuthorizationsOptions options=null)
 Returns the agent user authorizations More...
 
PaymentGatewayAccountsInfo GetAllPaymentGatewayAccounts (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. More...
 
ApiResponse< PaymentGatewayAccountsInfoGetAllPaymentGatewayAccountsWithHttpInfo (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. More...
 
async System.Threading.Tasks.Task< PaymentGatewayAccountsInfoGetAllPaymentGatewayAccountsAsync (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. More...
 
async System.Threading.Tasks.Task< ApiResponse< PaymentGatewayAccountsInfo > > GetAllPaymentGatewayAccountsAsyncWithHttpInfo (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. More...
 
BillingChargeResponse GetBillingCharges (string accountId, AccountsApi.GetBillingChargesOptions options=null)
 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 More...
 
ApiResponse< BillingChargeResponseGetBillingChargesWithHttpInfo (string accountId, AccountsApi.GetBillingChargesOptions options=null)
 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 More...
 
async System.Threading.Tasks.Task< BillingChargeResponseGetBillingChargesAsync (string accountId, AccountsApi.GetBillingChargesOptions options=null)
 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 More...
 
async System.Threading.Tasks.Task< ApiResponse< BillingChargeResponse > > GetBillingChargesAsyncWithHttpInfo (string accountId, AccountsApi.GetBillingChargesOptions options=null)
 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 More...
 
Brand GetBrand (string accountId, string brandId, AccountsApi.GetBrandOptions options=null)
 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 (&#x60;canSelfBrandSend&#x60; , &#x60;canSelfBrandSign&#x60;, or both of these account settings must be true). More...
 
ApiResponse< BrandGetBrandWithHttpInfo (string accountId, string brandId, AccountsApi.GetBrandOptions options=null)
 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 (&#x60;canSelfBrandSend&#x60; , &#x60;canSelfBrandSign&#x60;, or both of these account settings must be true). More...
 
async System.Threading.Tasks.Task< BrandGetBrandAsync (string accountId, string brandId, AccountsApi.GetBrandOptions options=null)
 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 (&#x60;canSelfBrandSend&#x60; , &#x60;canSelfBrandSign&#x60;, or both of these account settings must be true). More...
 
async System.Threading.Tasks.Task< ApiResponse< Brand > > GetBrandAsyncWithHttpInfo (string accountId, string brandId, AccountsApi.GetBrandOptions options=null)
 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 (&#x60;canSelfBrandSend&#x60; , &#x60;canSelfBrandSign&#x60;, or both of these account settings must be true). More...
 
void GetBrandExportFile (string accountId, string brandId)
 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 (&#x60;canSelfBrandSend&#x60; , &#x60;canSelfBrandSign&#x60;, or both of these account settings must be true). More...
 
ApiResponse< Object > GetBrandExportFileWithHttpInfo (string accountId, string brandId)
 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 (&#x60;canSelfBrandSend&#x60; , &#x60;canSelfBrandSign&#x60;, or both of these account settings must be true). More...
 
async System.Threading.Tasks.Task GetBrandExportFileAsync (string accountId, string brandId)
 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 (&#x60;canSelfBrandSend&#x60; , &#x60;canSelfBrandSign&#x60;, or both of these account settings must be true). More...
 
async System.Threading.Tasks.Task< ApiResponse< Object > > GetBrandExportFileAsyncWithHttpInfo (string accountId, string brandId)
 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 (&#x60;canSelfBrandSend&#x60; , &#x60;canSelfBrandSign&#x60;, or both of these account settings must be true). More...
 
System.IO.Stream GetBrandLogoByType (string accountId, string brandId, string logoType)
 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 (&#x60;canSelfBrandSend&#x60; , &#x60;canSelfBrandSign&#x60;, or both of these account settings must be true). More...
 
ApiResponse< System.IO.Stream > GetBrandLogoByTypeWithHttpInfo (string accountId, string brandId, string logoType)
 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 (&#x60;canSelfBrandSend&#x60; , &#x60;canSelfBrandSign&#x60;, or both of these account settings must be true). More...
 
async System.Threading.Tasks.Task< System.IO.Stream > GetBrandLogoByTypeAsync (string accountId, string brandId, string logoType)
 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 (&#x60;canSelfBrandSend&#x60; , &#x60;canSelfBrandSign&#x60;, or both of these account settings must be true). More...
 
async System.Threading.Tasks.Task< ApiResponse< System.IO.Stream > > GetBrandLogoByTypeAsyncWithHttpInfo (string accountId, string brandId, string logoType)
 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 (&#x60;canSelfBrandSend&#x60; , &#x60;canSelfBrandSign&#x60;, or both of these account settings must be true). More...
 
BrandResourcesList GetBrandResources (string accountId, string brandId)
 Returns the specified account&#39;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 (&#x60;canSelfBrandSend&#x60; , &#x60;canSelfBrandSign&#x60;, or both of these account settings must be true). More...
 
ApiResponse< BrandResourcesListGetBrandResourcesWithHttpInfo (string accountId, string brandId)
 Returns the specified account&#39;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 (&#x60;canSelfBrandSend&#x60; , &#x60;canSelfBrandSign&#x60;, or both of these account settings must be true). More...
 
async System.Threading.Tasks.Task< BrandResourcesListGetBrandResourcesAsync (string accountId, string brandId)
 Returns the specified account&#39;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 (&#x60;canSelfBrandSend&#x60; , &#x60;canSelfBrandSign&#x60;, or both of these account settings must be true). More...
 
async System.Threading.Tasks.Task< ApiResponse< BrandResourcesList > > GetBrandResourcesAsyncWithHttpInfo (string accountId, string brandId)
 Returns the specified account&#39;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 (&#x60;canSelfBrandSend&#x60; , &#x60;canSelfBrandSign&#x60;, or both of these account settings must be true). More...
 
void GetBrandResourcesByContentType (string accountId, string brandId, string resourceContentType, AccountsApi.GetBrandResourcesByContentTypeOptions options=null)
 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 (&#x60;canSelfBrandSend&#x60; , &#x60;canSelfBrandSign&#x60;, or both of these account settings must be true). More...
 
ApiResponse< Object > GetBrandResourcesByContentTypeWithHttpInfo (string accountId, string brandId, string resourceContentType, AccountsApi.GetBrandResourcesByContentTypeOptions options=null)
 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 (&#x60;canSelfBrandSend&#x60; , &#x60;canSelfBrandSign&#x60;, or both of these account settings must be true). More...
 
async System.Threading.Tasks.Task GetBrandResourcesByContentTypeAsync (string accountId, string brandId, string resourceContentType, AccountsApi.GetBrandResourcesByContentTypeOptions options=null)
 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 (&#x60;canSelfBrandSend&#x60; , &#x60;canSelfBrandSign&#x60;, or both of these account settings must be true). More...
 
async System.Threading.Tasks.Task< ApiResponse< Object > > GetBrandResourcesByContentTypeAsyncWithHttpInfo (string accountId, string brandId, string resourceContentType, AccountsApi.GetBrandResourcesByContentTypeOptions options=null)
 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 (&#x60;canSelfBrandSend&#x60; , &#x60;canSelfBrandSign&#x60;, or both of these account settings must be true). More...
 
ConsumerDisclosure GetConsumerDisclosure (string accountId, string langCode)
 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. More...
 
ApiResponse< ConsumerDisclosureGetConsumerDisclosureWithHttpInfo (string accountId, string langCode)
 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. More...
 
async System.Threading.Tasks.Task< ConsumerDisclosureGetConsumerDisclosureAsync (string accountId, string langCode)
 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. More...
 
async System.Threading.Tasks.Task< ApiResponse< ConsumerDisclosure > > GetConsumerDisclosureAsyncWithHttpInfo (string accountId, string langCode)
 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. More...
 
ConsumerDisclosure GetConsumerDisclosureDefault (string accountId, AccountsApi.GetConsumerDisclosureDefaultOptions options=null)
 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. More...
 
ApiResponse< ConsumerDisclosureGetConsumerDisclosureDefaultWithHttpInfo (string accountId, AccountsApi.GetConsumerDisclosureDefaultOptions options=null)
 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. More...
 
async System.Threading.Tasks.Task< ConsumerDisclosureGetConsumerDisclosureDefaultAsync (string accountId, AccountsApi.GetConsumerDisclosureDefaultOptions options=null)
 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. More...
 
async System.Threading.Tasks.Task< ApiResponse< ConsumerDisclosure > > GetConsumerDisclosureDefaultAsyncWithHttpInfo (string accountId, AccountsApi.GetConsumerDisclosureDefaultOptions options=null)
 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. More...
 
ENoteConfiguration GetENoteConfiguration (string accountId)
 Returns the configuration information for the eNote eOriginal integration. More...
 
ApiResponse< ENoteConfigurationGetENoteConfigurationWithHttpInfo (string accountId)
 Returns the configuration information for the eNote eOriginal integration. More...
 
async System.Threading.Tasks.Task< ENoteConfigurationGetENoteConfigurationAsync (string accountId)
 Returns the configuration information for the eNote eOriginal integration. More...
 
async System.Threading.Tasks.Task< ApiResponse< ENoteConfiguration > > GetENoteConfigurationAsyncWithHttpInfo (string accountId)
 Returns the configuration information for the eNote eOriginal integration. More...
 
EnvelopePurgeConfiguration GetEnvelopePurgeConfiguration (string accountId)
 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 (&#x60;retentionDays&#x60;). This method retrieves the current envelope purge configuration for your account. Note: To use this method, you must be an account administrator. More...
 
ApiResponse< EnvelopePurgeConfigurationGetEnvelopePurgeConfigurationWithHttpInfo (string accountId)
 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 (&#x60;retentionDays&#x60;). This method retrieves the current envelope purge configuration for your account. Note: To use this method, you must be an account administrator. More...
 
async System.Threading.Tasks.Task< EnvelopePurgeConfigurationGetEnvelopePurgeConfigurationAsync (string accountId)
 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 (&#x60;retentionDays&#x60;). This method retrieves the current envelope purge configuration for your account. Note: To use this method, you must be an account administrator. More...
 
async System.Threading.Tasks.Task< ApiResponse< EnvelopePurgeConfiguration > > GetEnvelopePurgeConfigurationAsyncWithHttpInfo (string accountId)
 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 (&#x60;retentionDays&#x60;). This method retrieves the current envelope purge configuration for your account. Note: To use this method, you must be an account administrator. More...
 
FavoriteTemplatesInfo GetFavoriteTemplates (string accountId)
 Retrieves the list of favorited templates for this caller More...
 
ApiResponse< FavoriteTemplatesInfoGetFavoriteTemplatesWithHttpInfo (string accountId)
 Retrieves the list of favorited templates for this caller More...
 
async System.Threading.Tasks.Task< FavoriteTemplatesInfoGetFavoriteTemplatesAsync (string accountId)
 Retrieves the list of favorited templates for this caller More...
 
async System.Threading.Tasks.Task< ApiResponse< FavoriteTemplatesInfo > > GetFavoriteTemplatesAsyncWithHttpInfo (string accountId)
 Retrieves the list of favorited templates for this caller More...
 
NotificationDefaults GetNotificationDefaults (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. More...
 
ApiResponse< NotificationDefaultsGetNotificationDefaultsWithHttpInfo (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. More...
 
async System.Threading.Tasks.Task< NotificationDefaultsGetNotificationDefaultsAsync (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. More...
 
async System.Threading.Tasks.Task< ApiResponse< NotificationDefaults > > GetNotificationDefaultsAsyncWithHttpInfo (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. More...
 
AccountPasswordRules GetPasswordRules (string accountId)
 Get the password rules This method retrieves the password rules for an account. More...
 
ApiResponse< AccountPasswordRulesGetPasswordRulesWithHttpInfo (string accountId)
 Get the password rules This method retrieves the password rules for an account. More...
 
async System.Threading.Tasks.Task< AccountPasswordRulesGetPasswordRulesAsync (string accountId)
 Get the password rules This method retrieves the password rules for an account. More...
 
async System.Threading.Tasks.Task< ApiResponse< AccountPasswordRules > > GetPasswordRulesAsyncWithHttpInfo (string accountId)
 Get the password rules This method retrieves the password rules for an account. More...
 
UserPasswordRules GetPasswordRules_0 ()
 Get membership account password rules More...
 
ApiResponse< UserPasswordRulesGetPasswordRules_0WithHttpInfo ()
 Get membership account password rules More...
 
async System.Threading.Tasks.Task< UserPasswordRulesGetPasswordRules_0Async ()
 Get membership account password rules More...
 
async System.Threading.Tasks.Task< ApiResponse< UserPasswordRules > > GetPasswordRules_0AsyncWithHttpInfo ()
 Get membership account password rules More...
 
PermissionProfile GetPermissionProfile (string accountId, string permissionProfileId, AccountsApi.GetPermissionProfileOptions options=null)
 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 More...
 
ApiResponse< PermissionProfileGetPermissionProfileWithHttpInfo (string accountId, string permissionProfileId, AccountsApi.GetPermissionProfileOptions options=null)
 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 More...
 
async System.Threading.Tasks.Task< PermissionProfileGetPermissionProfileAsync (string accountId, string permissionProfileId, AccountsApi.GetPermissionProfileOptions options=null)
 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 More...
 
async System.Threading.Tasks.Task< ApiResponse< PermissionProfile > > GetPermissionProfileAsyncWithHttpInfo (string accountId, string permissionProfileId, AccountsApi.GetPermissionProfileOptions options=null)
 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 More...
 
UserAuthorizations GetPrincipalUserAuthorizations (string accountId, string userId, AccountsApi.GetPrincipalUserAuthorizationsOptions options=null)
 Returns the principal user authorizations More...
 
ApiResponse< UserAuthorizationsGetPrincipalUserAuthorizationsWithHttpInfo (string accountId, string userId, AccountsApi.GetPrincipalUserAuthorizationsOptions options=null)
 Returns the principal user authorizations More...
 
async System.Threading.Tasks.Task< UserAuthorizationsGetPrincipalUserAuthorizationsAsync (string accountId, string userId, AccountsApi.GetPrincipalUserAuthorizationsOptions options=null)
 Returns the principal user authorizations More...
 
async System.Threading.Tasks.Task< ApiResponse< UserAuthorizations > > GetPrincipalUserAuthorizationsAsyncWithHttpInfo (string accountId, string userId, AccountsApi.GetPrincipalUserAuthorizationsOptions options=null)
 Returns the principal user authorizations More...
 
ProvisioningInformation GetProvisioning ()
 Retrieves the account provisioning information for the account. Retrieves the account provisioning information for the account. More...
 
ApiResponse< ProvisioningInformationGetProvisioningWithHttpInfo ()
 Retrieves the account provisioning information for the account. Retrieves the account provisioning information for the account. More...
 
async System.Threading.Tasks.Task< ProvisioningInformationGetProvisioningAsync ()
 Retrieves the account provisioning information for the account. Retrieves the account provisioning information for the account. More...
 
async System.Threading.Tasks.Task< ApiResponse< ProvisioningInformation > > GetProvisioningAsyncWithHttpInfo ()
 Retrieves the account provisioning information for the account. Retrieves the account provisioning information for the account. More...
 
SupportedLanguages GetSupportedLanguages (string accountId)
 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&#39;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 &#x60;emailBody&#x60; and &#x60;emailSubject&#x60; 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. More...
 
ApiResponse< SupportedLanguagesGetSupportedLanguagesWithHttpInfo (string accountId)
 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&#39;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 &#x60;emailBody&#x60; and &#x60;emailSubject&#x60; 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. More...
 
async System.Threading.Tasks.Task< SupportedLanguagesGetSupportedLanguagesAsync (string accountId)
 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&#39;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 &#x60;emailBody&#x60; and &#x60;emailSubject&#x60; 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. More...
 
async System.Threading.Tasks.Task< ApiResponse< SupportedLanguages > > GetSupportedLanguagesAsyncWithHttpInfo (string accountId)
 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&#39;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 &#x60;emailBody&#x60; and &#x60;emailSubject&#x60; 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. More...
 
UserAuthorization GetUserAuthorization (string accountId, string userId, string authorizationId)
 Returns the user authorization for a given authorization id More...
 
ApiResponse< UserAuthorizationGetUserAuthorizationWithHttpInfo (string accountId, string userId, string authorizationId)
 Returns the user authorization for a given authorization id More...
 
async System.Threading.Tasks.Task< UserAuthorizationGetUserAuthorizationAsync (string accountId, string userId, string authorizationId)
 Returns the user authorization for a given authorization id More...
 
async System.Threading.Tasks.Task< ApiResponse< UserAuthorization > > GetUserAuthorizationAsyncWithHttpInfo (string accountId, string userId, string authorizationId)
 Returns the user authorization for a given authorization id More...
 
Watermark GetWatermark (string accountId)
 Get watermark information. More...
 
ApiResponse< WatermarkGetWatermarkWithHttpInfo (string accountId)
 Get watermark information. More...
 
async System.Threading.Tasks.Task< WatermarkGetWatermarkAsync (string accountId)
 Get watermark information. More...
 
async System.Threading.Tasks.Task< ApiResponse< Watermark > > GetWatermarkAsyncWithHttpInfo (string accountId)
 Get watermark information. More...
 
Watermark GetWatermarkPreview (string accountId, Watermark watermark=null)
 Get watermark preview. More...
 
ApiResponse< WatermarkGetWatermarkPreviewWithHttpInfo (string accountId, Watermark watermark=null)
 Get watermark preview. More...
 
async System.Threading.Tasks.Task< WatermarkGetWatermarkPreviewAsync (string accountId, Watermark watermark=null)
 Get watermark preview. More...
 
async System.Threading.Tasks.Task< ApiResponse< Watermark > > GetWatermarkPreviewAsyncWithHttpInfo (string accountId, Watermark watermark=null)
 Get watermark preview. More...
 
BrandsResponse ListBrands (string accountId, AccountsApi.ListBrandsOptions options=null)
 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 &#x60;canSelfBrandSend&#x60; and &#x60;canSelfBrandSend&#x60;) must be set to true for the account to use this call. More...
 
ApiResponse< BrandsResponseListBrandsWithHttpInfo (string accountId, AccountsApi.ListBrandsOptions options=null)
 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 &#x60;canSelfBrandSend&#x60; and &#x60;canSelfBrandSend&#x60;) must be set to true for the account to use this call. More...
 
async System.Threading.Tasks.Task< BrandsResponseListBrandsAsync (string accountId, AccountsApi.ListBrandsOptions options=null)
 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 &#x60;canSelfBrandSend&#x60; and &#x60;canSelfBrandSend&#x60;) must be set to true for the account to use this call. More...
 
async System.Threading.Tasks.Task< ApiResponse< BrandsResponse > > ListBrandsAsyncWithHttpInfo (string accountId, AccountsApi.ListBrandsOptions options=null)
 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 &#x60;canSelfBrandSend&#x60; and &#x60;canSelfBrandSend&#x60;) must be set to true for the account to use this call. More...
 
CustomFields ListCustomFields (string accountId)
 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. More...
 
ApiResponse< CustomFieldsListCustomFieldsWithHttpInfo (string accountId)
 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. More...
 
async System.Threading.Tasks.Task< CustomFieldsListCustomFieldsAsync (string accountId)
 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. More...
 
async System.Threading.Tasks.Task< ApiResponse< CustomFields > > ListCustomFieldsAsyncWithHttpInfo (string accountId)
 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. More...
 
PermissionProfileInformation ListPermissions (string accountId, AccountsApi.ListPermissionsOptions options=null)
 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. More...
 
ApiResponse< PermissionProfileInformationListPermissionsWithHttpInfo (string accountId, AccountsApi.ListPermissionsOptions options=null)
 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. More...
 
async System.Threading.Tasks.Task< PermissionProfileInformationListPermissionsAsync (string accountId, AccountsApi.ListPermissionsOptions options=null)
 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. More...
 
async System.Threading.Tasks.Task< ApiResponse< PermissionProfileInformation > > ListPermissionsAsyncWithHttpInfo (string accountId, AccountsApi.ListPermissionsOptions options=null)
 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. More...
 
RecipientNamesResponse ListRecipientNamesByEmail (string accountId, AccountsApi.ListRecipientNamesByEmailOptions options=null)
 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. More...
 
ApiResponse< RecipientNamesResponseListRecipientNamesByEmailWithHttpInfo (string accountId, AccountsApi.ListRecipientNamesByEmailOptions options=null)
 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. More...
 
async System.Threading.Tasks.Task< RecipientNamesResponseListRecipientNamesByEmailAsync (string accountId, AccountsApi.ListRecipientNamesByEmailOptions options=null)
 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. More...
 
async System.Threading.Tasks.Task< ApiResponse< RecipientNamesResponse > > ListRecipientNamesByEmailAsyncWithHttpInfo (string accountId, AccountsApi.ListRecipientNamesByEmailOptions options=null)
 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. More...
 
AccountSettingsInformation ListSettings (string accountId)
 Gets account settings information. Retrieves the account settings information for the specified account. More...
 
ApiResponse< AccountSettingsInformationListSettingsWithHttpInfo (string accountId)
 Gets account settings information. Retrieves the account settings information for the specified account. More...
 
async System.Threading.Tasks.Task< AccountSettingsInformationListSettingsAsync (string accountId)
 Gets account settings information. Retrieves the account settings information for the specified account. More...
 
async System.Threading.Tasks.Task< ApiResponse< AccountSettingsInformation > > ListSettingsAsyncWithHttpInfo (string accountId)
 Gets account settings information. Retrieves the account settings information for the specified account. More...
 
AccountSharedAccess ListSharedAccess (string accountId, AccountsApi.ListSharedAccessOptions options=null)
 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&#x3D;shared_from. More...
 
ApiResponse< AccountSharedAccessListSharedAccessWithHttpInfo (string accountId, AccountsApi.ListSharedAccessOptions options=null)
 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&#x3D;shared_from. More...
 
async System.Threading.Tasks.Task< AccountSharedAccessListSharedAccessAsync (string accountId, AccountsApi.ListSharedAccessOptions options=null)
 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&#x3D;shared_from. More...
 
async System.Threading.Tasks.Task< ApiResponse< AccountSharedAccess > > ListSharedAccessAsyncWithHttpInfo (string accountId, AccountsApi.ListSharedAccessOptions options=null)
 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&#x3D;shared_from. More...
 
AccountSignatureProviders ListSignatureProviders (string accountId)
 Returns Account available signature providers for specified account. Returns a list of signature providers that the specified account can use. More...
 
ApiResponse< AccountSignatureProvidersListSignatureProvidersWithHttpInfo (string accountId)
 Returns Account available signature providers for specified account. Returns a list of signature providers that the specified account can use. More...
 
async System.Threading.Tasks.Task< AccountSignatureProvidersListSignatureProvidersAsync (string accountId)
 Returns Account available signature providers for specified account. Returns a list of signature providers that the specified account can use. More...
 
async System.Threading.Tasks.Task< ApiResponse< AccountSignatureProviders > > ListSignatureProvidersAsyncWithHttpInfo (string accountId)
 Returns Account available signature providers for specified account. Returns a list of signature providers that the specified account can use. More...
 
FileTypeList ListUnsupportedFileTypes (string accountId)
 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. More...
 
ApiResponse< FileTypeListListUnsupportedFileTypesWithHttpInfo (string accountId)
 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. More...
 
async System.Threading.Tasks.Task< FileTypeListListUnsupportedFileTypesAsync (string accountId)
 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. More...
 
async System.Threading.Tasks.Task< ApiResponse< FileTypeList > > ListUnsupportedFileTypesAsyncWithHttpInfo (string accountId)
 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. More...
 
FavoriteTemplatesInfo UnFavoriteTemplate (string accountId, FavoriteTemplatesInfo favoriteTemplatesInfo=null)
 Unfavorite a template More...
 
ApiResponse< FavoriteTemplatesInfoUnFavoriteTemplateWithHttpInfo (string accountId, FavoriteTemplatesInfo favoriteTemplatesInfo=null)
 Unfavorite a template More...
 
async System.Threading.Tasks.Task< FavoriteTemplatesInfoUnFavoriteTemplateAsync (string accountId, FavoriteTemplatesInfo favoriteTemplatesInfo=null)
 Unfavorite a template More...
 
async System.Threading.Tasks.Task< ApiResponse< FavoriteTemplatesInfo > > UnFavoriteTemplateAsyncWithHttpInfo (string accountId, FavoriteTemplatesInfo favoriteTemplatesInfo=null)
 Unfavorite a template More...
 
AccountSignaturesInformation UpdateAccountSignature (string accountId, AccountSignaturesInformation accountSignaturesInformation=null)
 Updates a account signature. More...
 
ApiResponse< AccountSignaturesInformationUpdateAccountSignatureWithHttpInfo (string accountId, AccountSignaturesInformation accountSignaturesInformation=null)
 Updates a account signature. More...
 
async System.Threading.Tasks.Task< AccountSignaturesInformationUpdateAccountSignatureAsync (string accountId, AccountSignaturesInformation accountSignaturesInformation=null)
 Updates a account signature. More...
 
async System.Threading.Tasks.Task< ApiResponse< AccountSignaturesInformation > > UpdateAccountSignatureAsyncWithHttpInfo (string accountId, AccountSignaturesInformation accountSignaturesInformation=null)
 Updates a account signature. More...
 
AccountSignature UpdateAccountSignatureById (string accountId, string signatureId, AccountSignatureDefinition accountSignatureDefinition=null, AccountsApi.UpdateAccountSignatureByIdOptions options=null)
 Updates a account signature. More...
 
ApiResponse< AccountSignatureUpdateAccountSignatureByIdWithHttpInfo (string accountId, string signatureId, AccountSignatureDefinition accountSignatureDefinition=null, AccountsApi.UpdateAccountSignatureByIdOptions options=null)
 Updates a account signature. More...
 
async System.Threading.Tasks.Task< AccountSignatureUpdateAccountSignatureByIdAsync (string accountId, string signatureId, AccountSignatureDefinition accountSignatureDefinition=null, AccountsApi.UpdateAccountSignatureByIdOptions options=null)
 Updates a account signature. More...
 
async System.Threading.Tasks.Task< ApiResponse< AccountSignature > > UpdateAccountSignatureByIdAsyncWithHttpInfo (string accountId, string signatureId, AccountSignatureDefinition accountSignatureDefinition=null, AccountsApi.UpdateAccountSignatureByIdOptions options=null)
 Updates a account signature. More...
 
AccountSignature UpdateAccountSignatureImage (string accountId, string signatureId, string imageType, AccountsApi.UpdateAccountSignatureImageOptions options=null)
 Sets a signature, initials, or stamps image. More...
 
ApiResponse< AccountSignatureUpdateAccountSignatureImageWithHttpInfo (string accountId, string signatureId, string imageType, AccountsApi.UpdateAccountSignatureImageOptions options=null)
 Sets a signature, initials, or stamps image. More...
 
async System.Threading.Tasks.Task< AccountSignatureUpdateAccountSignatureImageAsync (string accountId, string signatureId, string imageType, AccountsApi.UpdateAccountSignatureImageOptions options=null)
 Sets a signature, initials, or stamps image. More...
 
async System.Threading.Tasks.Task< ApiResponse< AccountSignature > > UpdateAccountSignatureImageAsyncWithHttpInfo (string accountId, string signatureId, string imageType, AccountsApi.UpdateAccountSignatureImageOptions options=null)
 Sets a signature, initials, or stamps image. More...
 
TabAccountSettings UpdateAccountTabSettings (string accountId, TabAccountSettings tabAccountSettings=null)
 Modifies tab settings for specified account This method modifies the tab types and tab functionality that is enabled for an account. More...
 
ApiResponse< TabAccountSettingsUpdateAccountTabSettingsWithHttpInfo (string accountId, TabAccountSettings tabAccountSettings=null)
 Modifies tab settings for specified account This method modifies the tab types and tab functionality that is enabled for an account. More...
 
async System.Threading.Tasks.Task< TabAccountSettingsUpdateAccountTabSettingsAsync (string accountId, TabAccountSettings tabAccountSettings=null)
 Modifies tab settings for specified account This method modifies the tab types and tab functionality that is enabled for an account. More...
 
async System.Threading.Tasks.Task< ApiResponse< TabAccountSettings > > UpdateAccountTabSettingsAsyncWithHttpInfo (string accountId, TabAccountSettings tabAccountSettings=null)
 Modifies tab settings for specified account This method modifies the tab types and tab functionality that is enabled for an account. More...
 
Brand UpdateBrand (string accountId, string brandId, Brand brand=null, AccountsApi.UpdateBrandOptions options=null)
 Updates an existing brand. This method updates an account brand. Note: Branding for either signing or sending must be enabled for the account (&#x60;canSelfBrandSend&#x60; , &#x60;canSelfBrandSign&#x60;, or both of these account settings must be true). More...
 
ApiResponse< BrandUpdateBrandWithHttpInfo (string accountId, string brandId, Brand brand=null, AccountsApi.UpdateBrandOptions options=null)
 Updates an existing brand. This method updates an account brand. Note: Branding for either signing or sending must be enabled for the account (&#x60;canSelfBrandSend&#x60; , &#x60;canSelfBrandSign&#x60;, or both of these account settings must be true). More...
 
async System.Threading.Tasks.Task< BrandUpdateBrandAsync (string accountId, string brandId, Brand brand=null, AccountsApi.UpdateBrandOptions options=null)
 Updates an existing brand. This method updates an account brand. Note: Branding for either signing or sending must be enabled for the account (&#x60;canSelfBrandSend&#x60; , &#x60;canSelfBrandSign&#x60;, or both of these account settings must be true). More...
 
async System.Threading.Tasks.Task< ApiResponse< Brand > > UpdateBrandAsyncWithHttpInfo (string accountId, string brandId, Brand brand=null, AccountsApi.UpdateBrandOptions options=null)
 Updates an existing brand. This method updates an account brand. Note: Branding for either signing or sending must be enabled for the account (&#x60;canSelfBrandSend&#x60; , &#x60;canSelfBrandSign&#x60;, or both of these account settings must be true). More...
 
void UpdateBrandLogoByType (string accountId, string brandId, string logoType, byte[] logoFileBytes)
 Put one branding logo. This method updates a single brand logo. You pass in the new version of the resource in the &#x60;Content-Disposition&#x60; header. Example: &#x60;Content-Disposition: form-data; name&#x3D;&quot;file&quot;; filename&#x3D;&quot;logo.jpg&quot;&#x60; Note: Branding for either signing or sending must be enabled for the account (&#x60;canSelfBrandSend&#x60; , &#x60;canSelfBrandSign&#x60;, or both of these account settings must be true). More...
 
ApiResponse< Object > UpdateBrandLogoByTypeWithHttpInfo (string accountId, string brandId, string logoType, byte[] logoFileBytes)
 Put one branding logo. This method updates a single brand logo. You pass in the new version of the resource in the &#x60;Content-Disposition&#x60; header. Example: &#x60;Content-Disposition: form-data; name&#x3D;&quot;file&quot;; filename&#x3D;&quot;logo.jpg&quot;&#x60; Note: Branding for either signing or sending must be enabled for the account (&#x60;canSelfBrandSend&#x60; , &#x60;canSelfBrandSign&#x60;, or both of these account settings must be true). More...
 
async System.Threading.Tasks.Task UpdateBrandLogoByTypeAsync (string accountId, string brandId, string logoType, byte[] logoFileBytes)
 Put one branding logo. This method updates a single brand logo. You pass in the new version of the resource in the &#x60;Content-Disposition&#x60; header. Example: &#x60;Content-Disposition: form-data; name&#x3D;&quot;file&quot;; filename&#x3D;&quot;logo.jpg&quot;&#x60; Note: Branding for either signing or sending must be enabled for the account (&#x60;canSelfBrandSend&#x60; , &#x60;canSelfBrandSign&#x60;, or both of these account settings must be true). More...
 
async System.Threading.Tasks.Task< ApiResponse< Object > > UpdateBrandLogoByTypeAsyncWithHttpInfo (string accountId, string brandId, string logoType, byte[] logoFileBytes)
 Put one branding logo. This method updates a single brand logo. You pass in the new version of the resource in the &#x60;Content-Disposition&#x60; header. Example: &#x60;Content-Disposition: form-data; name&#x3D;&quot;file&quot;; filename&#x3D;&quot;logo.jpg&quot;&#x60; Note: Branding for either signing or sending must be enabled for the account (&#x60;canSelfBrandSend&#x60; , &#x60;canSelfBrandSign&#x60;, or both of these account settings must be true). More...
 
BrandResources UpdateBrandResourcesByContentType (string accountId, string brandId, string resourceContentType, byte[] fileXml)
 Uploads a branding resource file. This method updates a branding resource file. You pass in the new version of the resource file in the &#x60;Content-Disposition&#x60; header. Example: &#x60;Content-Disposition: form-data; name&#x3D;&quot;file&quot;; filename&#x3D;&quot;DocuSign_SigningResource_4328673.xml&quot;&#x60; Note: Branding for either signing or sending must be enabled for the account (&#x60;canSelfBrandSend&#x60; , &#x60;canSelfBrandSign&#x60;, 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. More...
 
ApiResponse< BrandResourcesUpdateBrandResourcesByContentTypeWithHttpInfo (string accountId, string brandId, string resourceContentType, byte[] fileXml)
 Uploads a branding resource file. This method updates a branding resource file. You pass in the new version of the resource file in the &#x60;Content-Disposition&#x60; header. Example: &#x60;Content-Disposition: form-data; name&#x3D;&quot;file&quot;; filename&#x3D;&quot;DocuSign_SigningResource_4328673.xml&quot;&#x60; Note: Branding for either signing or sending must be enabled for the account (&#x60;canSelfBrandSend&#x60; , &#x60;canSelfBrandSign&#x60;, 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. More...
 
async System.Threading.Tasks.Task< BrandResourcesUpdateBrandResourcesByContentTypeAsync (string accountId, string brandId, string resourceContentType, byte[] fileXml)
 Uploads a branding resource file. This method updates a branding resource file. You pass in the new version of the resource file in the &#x60;Content-Disposition&#x60; header. Example: &#x60;Content-Disposition: form-data; name&#x3D;&quot;file&quot;; filename&#x3D;&quot;DocuSign_SigningResource_4328673.xml&quot;&#x60; Note: Branding for either signing or sending must be enabled for the account (&#x60;canSelfBrandSend&#x60; , &#x60;canSelfBrandSign&#x60;, 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. More...
 
async System.Threading.Tasks.Task< ApiResponse< BrandResources > > UpdateBrandResourcesByContentTypeAsyncWithHttpInfo (string accountId, string brandId, string resourceContentType, byte[] fileXml)
 Uploads a branding resource file. This method updates a branding resource file. You pass in the new version of the resource file in the &#x60;Content-Disposition&#x60; header. Example: &#x60;Content-Disposition: form-data; name&#x3D;&quot;file&quot;; filename&#x3D;&quot;DocuSign_SigningResource_4328673.xml&quot;&#x60; Note: Branding for either signing or sending must be enabled for the account (&#x60;canSelfBrandSend&#x60; , &#x60;canSelfBrandSign&#x60;, 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. More...
 
ConsumerDisclosure UpdateConsumerDisclosure (string accountId, string langCode, ConsumerDisclosure consumerDisclosure=null, AccountsApi.UpdateConsumerDisclosureOptions options=null)
 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 &#x60;langCode&#x60; 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: - &#x60;accountEsignId&#x60;: This property is read-only. - &#x60;custom&#x60;: The default value is false. Editing this property causes the default disclosure to switch to a custom disclosure. - &#x60;esignAgreement&#x60;: This property is read-only. - &#x60;esignText&#x60;: You cannot edit this property when &#x60;custom&#x60; is set to false. The API returns a 200 OK HTTP response, but does not update the &#x60;esignText&#x60;. - 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 &#x60;custom&#x60; property to true and customize the value for the &#x60;eSignText&#x60; property. You can also edit all of the other properties except for the following ones: - &#x60;accountEsignId&#x60;: This property is read-only. - &#x60;esignAgreement&#x60;: 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 &#x60;langCode&#x60; 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: - &#x60;accountEsignId&#x60;: This property is read-only. - &#x60;esignAgreement&#x60;: 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. More...
 
ApiResponse< ConsumerDisclosureUpdateConsumerDisclosureWithHttpInfo (string accountId, string langCode, ConsumerDisclosure consumerDisclosure=null, AccountsApi.UpdateConsumerDisclosureOptions options=null)
 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 &#x60;langCode&#x60; 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: - &#x60;accountEsignId&#x60;: This property is read-only. - &#x60;custom&#x60;: The default value is false. Editing this property causes the default disclosure to switch to a custom disclosure. - &#x60;esignAgreement&#x60;: This property is read-only. - &#x60;esignText&#x60;: You cannot edit this property when &#x60;custom&#x60; is set to false. The API returns a 200 OK HTTP response, but does not update the &#x60;esignText&#x60;. - 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 &#x60;custom&#x60; property to true and customize the value for the &#x60;eSignText&#x60; property. You can also edit all of the other properties except for the following ones: - &#x60;accountEsignId&#x60;: This property is read-only. - &#x60;esignAgreement&#x60;: 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 &#x60;langCode&#x60; 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: - &#x60;accountEsignId&#x60;: This property is read-only. - &#x60;esignAgreement&#x60;: 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. More...
 
async System.Threading.Tasks.Task< ConsumerDisclosureUpdateConsumerDisclosureAsync (string accountId, string langCode, ConsumerDisclosure consumerDisclosure=null, AccountsApi.UpdateConsumerDisclosureOptions options=null)
 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 &#x60;langCode&#x60; 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: - &#x60;accountEsignId&#x60;: This property is read-only. - &#x60;custom&#x60;: The default value is false. Editing this property causes the default disclosure to switch to a custom disclosure. - &#x60;esignAgreement&#x60;: This property is read-only. - &#x60;esignText&#x60;: You cannot edit this property when &#x60;custom&#x60; is set to false. The API returns a 200 OK HTTP response, but does not update the &#x60;esignText&#x60;. - 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 &#x60;custom&#x60; property to true and customize the value for the &#x60;eSignText&#x60; property. You can also edit all of the other properties except for the following ones: - &#x60;accountEsignId&#x60;: This property is read-only. - &#x60;esignAgreement&#x60;: 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 &#x60;langCode&#x60; 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: - &#x60;accountEsignId&#x60;: This property is read-only. - &#x60;esignAgreement&#x60;: 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. More...
 
async System.Threading.Tasks.Task< ApiResponse< ConsumerDisclosure > > UpdateConsumerDisclosureAsyncWithHttpInfo (string accountId, string langCode, ConsumerDisclosure consumerDisclosure=null, AccountsApi.UpdateConsumerDisclosureOptions options=null)
 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 &#x60;langCode&#x60; 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: - &#x60;accountEsignId&#x60;: This property is read-only. - &#x60;custom&#x60;: The default value is false. Editing this property causes the default disclosure to switch to a custom disclosure. - &#x60;esignAgreement&#x60;: This property is read-only. - &#x60;esignText&#x60;: You cannot edit this property when &#x60;custom&#x60; is set to false. The API returns a 200 OK HTTP response, but does not update the &#x60;esignText&#x60;. - 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 &#x60;custom&#x60; property to true and customize the value for the &#x60;eSignText&#x60; property. You can also edit all of the other properties except for the following ones: - &#x60;accountEsignId&#x60;: This property is read-only. - &#x60;esignAgreement&#x60;: 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 &#x60;langCode&#x60; 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: - &#x60;accountEsignId&#x60;: This property is read-only. - &#x60;esignAgreement&#x60;: 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. More...
 
CustomFields UpdateCustomField (string accountId, string customFieldId, CustomField customField=null, AccountsApi.UpdateCustomFieldOptions options=null)
 Updates an existing account custom field. This method updates an existing account custom field. More...
 
ApiResponse< CustomFieldsUpdateCustomFieldWithHttpInfo (string accountId, string customFieldId, CustomField customField=null, AccountsApi.UpdateCustomFieldOptions options=null)
 Updates an existing account custom field. This method updates an existing account custom field. More...
 
async System.Threading.Tasks.Task< CustomFieldsUpdateCustomFieldAsync (string accountId, string customFieldId, CustomField customField=null, AccountsApi.UpdateCustomFieldOptions options=null)
 Updates an existing account custom field. This method updates an existing account custom field. More...
 
async System.Threading.Tasks.Task< ApiResponse< CustomFields > > UpdateCustomFieldAsyncWithHttpInfo (string accountId, string customFieldId, CustomField customField=null, AccountsApi.UpdateCustomFieldOptions options=null)
 Updates an existing account custom field. This method updates an existing account custom field. More...
 
ENoteConfiguration UpdateENoteConfiguration (string accountId, ENoteConfiguration eNoteConfiguration=null)
 Updates configuration information for the eNote eOriginal integration. More...
 
ApiResponse< ENoteConfigurationUpdateENoteConfigurationWithHttpInfo (string accountId, ENoteConfiguration eNoteConfiguration=null)
 Updates configuration information for the eNote eOriginal integration. More...
 
async System.Threading.Tasks.Task< ENoteConfigurationUpdateENoteConfigurationAsync (string accountId, ENoteConfiguration eNoteConfiguration=null)
 Updates configuration information for the eNote eOriginal integration. More...
 
async System.Threading.Tasks.Task< ApiResponse< ENoteConfiguration > > UpdateENoteConfigurationAsyncWithHttpInfo (string accountId, ENoteConfiguration eNoteConfiguration=null)
 Updates configuration information for the eNote eOriginal integration. More...
 
EnvelopePurgeConfiguration UpdateEnvelopePurgeConfiguration (string accountId, EnvelopePurgeConfiguration envelopePurgeConfiguration=null)
 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 (&#x60;retentionDays&#x60;). 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. More...
 
ApiResponse< EnvelopePurgeConfigurationUpdateEnvelopePurgeConfigurationWithHttpInfo (string accountId, EnvelopePurgeConfiguration envelopePurgeConfiguration=null)
 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 (&#x60;retentionDays&#x60;). 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. More...
 
async System.Threading.Tasks.Task< EnvelopePurgeConfigurationUpdateEnvelopePurgeConfigurationAsync (string accountId, EnvelopePurgeConfiguration envelopePurgeConfiguration=null)
 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 (&#x60;retentionDays&#x60;). 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. More...
 
async System.Threading.Tasks.Task< ApiResponse< EnvelopePurgeConfiguration > > UpdateEnvelopePurgeConfigurationAsyncWithHttpInfo (string accountId, EnvelopePurgeConfiguration envelopePurgeConfiguration=null)
 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 (&#x60;retentionDays&#x60;). 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. More...
 
FavoriteTemplatesInfo UpdateFavoriteTemplate (string accountId, FavoriteTemplatesInfo favoriteTemplatesInfo=null)
 Favorites a template More...
 
ApiResponse< FavoriteTemplatesInfoUpdateFavoriteTemplateWithHttpInfo (string accountId, FavoriteTemplatesInfo favoriteTemplatesInfo=null)
 Favorites a template More...
 
async System.Threading.Tasks.Task< FavoriteTemplatesInfoUpdateFavoriteTemplateAsync (string accountId, FavoriteTemplatesInfo favoriteTemplatesInfo=null)
 Favorites a template More...
 
async System.Threading.Tasks.Task< ApiResponse< FavoriteTemplatesInfo > > UpdateFavoriteTemplateAsyncWithHttpInfo (string accountId, FavoriteTemplatesInfo favoriteTemplatesInfo=null)
 Favorites a template More...
 
NotificationDefaults UpdateNotificationDefaults (string accountId, NotificationDefaults notificationDefaults=null)
 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. More...
 
ApiResponse< NotificationDefaultsUpdateNotificationDefaultsWithHttpInfo (string accountId, NotificationDefaults notificationDefaults=null)
 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. More...
 
async System.Threading.Tasks.Task< NotificationDefaultsUpdateNotificationDefaultsAsync (string accountId, NotificationDefaults notificationDefaults=null)
 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. More...
 
async System.Threading.Tasks.Task< ApiResponse< NotificationDefaults > > UpdateNotificationDefaultsAsyncWithHttpInfo (string accountId, NotificationDefaults notificationDefaults=null)
 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. More...
 
AccountPasswordRules UpdatePasswordRules (string accountId, AccountPasswordRules accountPasswordRules=null)
 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. More...
 
ApiResponse< AccountPasswordRulesUpdatePasswordRulesWithHttpInfo (string accountId, AccountPasswordRules accountPasswordRules=null)
 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. More...
 
async System.Threading.Tasks.Task< AccountPasswordRulesUpdatePasswordRulesAsync (string accountId, AccountPasswordRules accountPasswordRules=null)
 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. More...
 
async System.Threading.Tasks.Task< ApiResponse< AccountPasswordRules > > UpdatePasswordRulesAsyncWithHttpInfo (string accountId, AccountPasswordRules accountPasswordRules=null)
 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. More...
 
PermissionProfile UpdatePermissionProfile (string accountId, string permissionProfileId, PermissionProfile permissionProfile=null, AccountsApi.UpdatePermissionProfileOptions options=null)
 Updates a permission profile within the specified account. This method updates an account permission profile. ### Related topics - How to update individual permission settings More...
 
ApiResponse< PermissionProfileUpdatePermissionProfileWithHttpInfo (string accountId, string permissionProfileId, PermissionProfile permissionProfile=null, AccountsApi.UpdatePermissionProfileOptions options=null)
 Updates a permission profile within the specified account. This method updates an account permission profile. ### Related topics - How to update individual permission settings More...
 
async System.Threading.Tasks.Task< PermissionProfileUpdatePermissionProfileAsync (string accountId, string permissionProfileId, PermissionProfile permissionProfile=null, AccountsApi.UpdatePermissionProfileOptions options=null)
 Updates a permission profile within the specified account. This method updates an account permission profile. ### Related topics - How to update individual permission settings More...
 
async System.Threading.Tasks.Task< ApiResponse< PermissionProfile > > UpdatePermissionProfileAsyncWithHttpInfo (string accountId, string permissionProfileId, PermissionProfile permissionProfile=null, AccountsApi.UpdatePermissionProfileOptions options=null)
 Updates a permission profile within the specified account. This method updates an account permission profile. ### Related topics - How to update individual permission settings More...
 
void UpdateSettings (string accountId, AccountSettingsInformation accountSettingsInformation=null)
 Updates the account settings for an account. Updates the account settings for the specified account. More...
 
ApiResponse< Object > UpdateSettingsWithHttpInfo (string accountId, AccountSettingsInformation accountSettingsInformation=null)
 Updates the account settings for an account. Updates the account settings for the specified account. More...
 
async System.Threading.Tasks.Task UpdateSettingsAsync (string accountId, AccountSettingsInformation accountSettingsInformation=null)
 Updates the account settings for an account. Updates the account settings for the specified account. More...
 
async System.Threading.Tasks.Task< ApiResponse< Object > > UpdateSettingsAsyncWithHttpInfo (string accountId, AccountSettingsInformation accountSettingsInformation=null)
 Updates the account settings for an account. Updates the account settings for the specified account. More...
 
AccountSharedAccess UpdateSharedAccess (string accountId, AccountSharedAccess accountSharedAccess=null, AccountsApi.UpdateSharedAccessOptions options=null)
 Reserved: Sets the shared access information for users. Reserved: Sets the shared access information for one or more users. More...
 
ApiResponse< AccountSharedAccessUpdateSharedAccessWithHttpInfo (string accountId, AccountSharedAccess accountSharedAccess=null, AccountsApi.UpdateSharedAccessOptions options=null)
 Reserved: Sets the shared access information for users. Reserved: Sets the shared access information for one or more users. More...
 
async System.Threading.Tasks.Task< AccountSharedAccessUpdateSharedAccessAsync (string accountId, AccountSharedAccess accountSharedAccess=null, AccountsApi.UpdateSharedAccessOptions options=null)
 Reserved: Sets the shared access information for users. Reserved: Sets the shared access information for one or more users. More...
 
async System.Threading.Tasks.Task< ApiResponse< AccountSharedAccess > > UpdateSharedAccessAsyncWithHttpInfo (string accountId, AccountSharedAccess accountSharedAccess=null, AccountsApi.UpdateSharedAccessOptions options=null)
 Reserved: Sets the shared access information for users. Reserved: Sets the shared access information for one or more users. More...
 
UserAuthorization UpdateUserAuthorization (string accountId, string userId, string authorizationId, UserAuthorizationUpdateRequest userAuthorizationUpdateRequest=null)
 Updates the user authorization More...
 
ApiResponse< UserAuthorizationUpdateUserAuthorizationWithHttpInfo (string accountId, string userId, string authorizationId, UserAuthorizationUpdateRequest userAuthorizationUpdateRequest=null)
 Updates the user authorization More...
 
async System.Threading.Tasks.Task< UserAuthorizationUpdateUserAuthorizationAsync (string accountId, string userId, string authorizationId, UserAuthorizationUpdateRequest userAuthorizationUpdateRequest=null)
 Updates the user authorization More...
 
async System.Threading.Tasks.Task< ApiResponse< UserAuthorization > > UpdateUserAuthorizationAsyncWithHttpInfo (string accountId, string userId, string authorizationId, UserAuthorizationUpdateRequest userAuthorizationUpdateRequest=null)
 Updates the user authorization More...
 
Watermark UpdateWatermark (string accountId, Watermark watermark=null)
 Update watermark information. More...
 
ApiResponse< WatermarkUpdateWatermarkWithHttpInfo (string accountId, Watermark watermark=null)
 Update watermark information. More...
 
async System.Threading.Tasks.Task< WatermarkUpdateWatermarkAsync (string accountId, Watermark watermark=null)
 Update watermark information. More...
 
async System.Threading.Tasks.Task< ApiResponse< Watermark > > UpdateWatermarkAsyncWithHttpInfo (string accountId, Watermark watermark=null)
 Update watermark information. More...
 
- Public Member Functions inherited from DocuSign.eSign.Api.IAccountsApi
NewAccountSummary Create (NewAccountDefinition newAccountDefinition=null, AccountsApi.CreateOptions options=null)
 Creates new accounts. More...
 
ApiResponse< NewAccountSummaryCreateWithHttpInfo (NewAccountDefinition newAccountDefinition=null, AccountsApi.CreateOptions options=null)
 Creates new accounts. More...
 
AccountSignaturesInformation CreateAccountSignatures (string accountId, AccountSignaturesInformation accountSignaturesInformation=null, AccountsApi.CreateAccountSignaturesOptions options=null)
 Adds/updates one or more account signatures. This request may include images in multi-part format. More...
 
ApiResponse< AccountSignaturesInformationCreateAccountSignaturesWithHttpInfo (string accountId, AccountSignaturesInformation accountSignaturesInformation=null, AccountsApi.CreateAccountSignaturesOptions options=null)
 Adds/updates one or more account signatures. This request may include images in multi-part format. More...
 
CustomFields CreateCustomField (string accountId, CustomField customField=null, AccountsApi.CreateCustomFieldOptions options=null)
 Creates an acount custom field. More...
 
ApiResponse< CustomFieldsCreateCustomFieldWithHttpInfo (string accountId, CustomField customField=null, AccountsApi.CreateCustomFieldOptions options=null)
 Creates an acount custom field. More...
 
PermissionProfile CreatePermissionProfile (string accountId, PermissionProfile permissionProfile=null, AccountsApi.CreatePermissionProfileOptions options=null)
 Creates a new permission profile in the specified account. More...
 
ApiResponse< PermissionProfileCreatePermissionProfileWithHttpInfo (string accountId, PermissionProfile permissionProfile=null, AccountsApi.CreatePermissionProfileOptions options=null)
 Creates a new permission profile in the specified account. More...
 
void DeleteCustomField (string accountId, string customFieldId, AccountsApi.DeleteCustomFieldOptions options=null)
 Delete an existing account custom field. More...
 
ApiResponse< Object > DeleteCustomFieldWithHttpInfo (string accountId, string customFieldId, AccountsApi.DeleteCustomFieldOptions options=null)
 Delete an existing account custom field. More...
 
void DeletePermissionProfile (string accountId, string permissionProfileId, AccountsApi.DeletePermissionProfileOptions options=null)
 Deletes a permissions profile within the specified account. More...
 
ApiResponse< Object > DeletePermissionProfileWithHttpInfo (string accountId, string permissionProfileId, AccountsApi.DeletePermissionProfileOptions options=null)
 Deletes a permissions profile within the specified account. More...
 
AccountInformation GetAccountInformation (string accountId, AccountsApi.GetAccountInformationOptions options=null)
 Retrieves the account information for the specified account. More...
 
ApiResponse< AccountInformationGetAccountInformationWithHttpInfo (string accountId, AccountsApi.GetAccountInformationOptions options=null)
 Retrieves the account information for the specified account. More...
 
System.IO.Stream GetAccountSignatureImage (string accountId, string signatureId, string imageType, AccountsApi.GetAccountSignatureImageOptions options=null)
 Returns a signature, initials, or stamps image. More...
 
ApiResponse< System.IO.Stream > GetAccountSignatureImageWithHttpInfo (string accountId, string signatureId, string imageType, AccountsApi.GetAccountSignatureImageOptions options=null)
 Returns a signature, initials, or stamps image. More...
 
AccountSignaturesInformation GetAccountSignatures (string accountId, AccountsApi.GetAccountSignaturesOptions options=null)
 Returns the managed signature definitions for the account More...
 
ApiResponse< AccountSignaturesInformationGetAccountSignaturesWithHttpInfo (string accountId, AccountsApi.GetAccountSignaturesOptions options=null)
 Returns the managed signature definitions for the account More...
 
UserAuthorizations GetAgentUserAuthorizations (string accountId, string userId, AccountsApi.GetAgentUserAuthorizationsOptions options=null)
 Returns the agent user authorizations More...
 
ApiResponse< UserAuthorizationsGetAgentUserAuthorizationsWithHttpInfo (string accountId, string userId, AccountsApi.GetAgentUserAuthorizationsOptions options=null)
 Returns the agent user authorizations More...
 
BillingChargeResponse GetBillingCharges (string accountId, AccountsApi.GetBillingChargesOptions options=null)
 Gets list of recurring and usage charges for the account. More...
 
ApiResponse< BillingChargeResponseGetBillingChargesWithHttpInfo (string accountId, AccountsApi.GetBillingChargesOptions options=null)
 Gets list of recurring and usage charges for the account. More...
 
Brand GetBrand (string accountId, string brandId, AccountsApi.GetBrandOptions options=null)
 Get information for a specific brand. More...
 
ApiResponse< BrandGetBrandWithHttpInfo (string accountId, string brandId, AccountsApi.GetBrandOptions options=null)
 Get information for a specific brand. More...
 
void GetBrandResourcesByContentType (string accountId, string brandId, string resourceContentType, AccountsApi.GetBrandResourcesByContentTypeOptions options=null)
 Returns the specified branding resource file. More...
 
ApiResponse< Object > GetBrandResourcesByContentTypeWithHttpInfo (string accountId, string brandId, string resourceContentType, AccountsApi.GetBrandResourcesByContentTypeOptions options=null)
 Returns the specified branding resource file. More...
 
ConsumerDisclosure GetConsumerDisclosureDefault (string accountId, AccountsApi.GetConsumerDisclosureDefaultOptions options=null)
 Gets the Electronic Record and Signature Disclosure for the account. More...
 
ApiResponse< ConsumerDisclosureGetConsumerDisclosureDefaultWithHttpInfo (string accountId, AccountsApi.GetConsumerDisclosureDefaultOptions options=null)
 Gets the Electronic Record and Signature Disclosure for the account. More...
 
PermissionProfile GetPermissionProfile (string accountId, string permissionProfileId, AccountsApi.GetPermissionProfileOptions options=null)
 Returns a permissions profile in the specified account. More...
 
ApiResponse< PermissionProfileGetPermissionProfileWithHttpInfo (string accountId, string permissionProfileId, AccountsApi.GetPermissionProfileOptions options=null)
 Returns a permissions profile in the specified account. More...
 
UserAuthorizations GetPrincipalUserAuthorizations (string accountId, string userId, AccountsApi.GetPrincipalUserAuthorizationsOptions options=null)
 Returns the principal user authorizations More...
 
ApiResponse< UserAuthorizationsGetPrincipalUserAuthorizationsWithHttpInfo (string accountId, string userId, AccountsApi.GetPrincipalUserAuthorizationsOptions options=null)
 Returns the principal user authorizations More...
 
BrandsResponse ListBrands (string accountId, AccountsApi.ListBrandsOptions options=null)
 Gets a list of brand profiles. More...
 
ApiResponse< BrandsResponseListBrandsWithHttpInfo (string accountId, AccountsApi.ListBrandsOptions options=null)
 Gets a list of brand profiles. More...
 
PermissionProfileInformation ListPermissions (string accountId, AccountsApi.ListPermissionsOptions options=null)
 Gets a list of permission profiles. More...
 
ApiResponse< PermissionProfileInformationListPermissionsWithHttpInfo (string accountId, AccountsApi.ListPermissionsOptions options=null)
 Gets a list of permission profiles. More...
 
RecipientNamesResponse ListRecipientNamesByEmail (string accountId, AccountsApi.ListRecipientNamesByEmailOptions options=null)
 Gets recipient names associated with an email address. More...
 
ApiResponse< RecipientNamesResponseListRecipientNamesByEmailWithHttpInfo (string accountId, AccountsApi.ListRecipientNamesByEmailOptions options=null)
 Gets recipient names associated with an email address. More...
 
AccountSharedAccess ListSharedAccess (string accountId, AccountsApi.ListSharedAccessOptions options=null)
 Reserved: Gets the shared item status for one or more users. More...
 
ApiResponse< AccountSharedAccessListSharedAccessWithHttpInfo (string accountId, AccountsApi.ListSharedAccessOptions options=null)
 Reserved: Gets the shared item status for one or more users. More...
 
AccountSignature UpdateAccountSignatureById (string accountId, string signatureId, AccountSignatureDefinition accountSignatureDefinition=null, AccountsApi.UpdateAccountSignatureByIdOptions options=null)
 Updates a account signature. More...
 
ApiResponse< AccountSignatureUpdateAccountSignatureByIdWithHttpInfo (string accountId, string signatureId, AccountSignatureDefinition accountSignatureDefinition=null, AccountsApi.UpdateAccountSignatureByIdOptions options=null)
 Updates a account signature. More...
 
AccountSignature UpdateAccountSignatureImage (string accountId, string signatureId, string imageType, AccountsApi.UpdateAccountSignatureImageOptions options=null)
 Sets a signature, initials, or stamps image. More...
 
ApiResponse< AccountSignatureUpdateAccountSignatureImageWithHttpInfo (string accountId, string signatureId, string imageType, AccountsApi.UpdateAccountSignatureImageOptions options=null)
 Sets a signature, initials, or stamps image. More...
 
Brand UpdateBrand (string accountId, string brandId, Brand brand=null, AccountsApi.UpdateBrandOptions options=null)
 Updates an existing brand. More...
 
ApiResponse< BrandUpdateBrandWithHttpInfo (string accountId, string brandId, Brand brand=null, AccountsApi.UpdateBrandOptions options=null)
 Updates an existing brand. More...
 
ConsumerDisclosure UpdateConsumerDisclosure (string accountId, string langCode, ConsumerDisclosure consumerDisclosure=null, AccountsApi.UpdateConsumerDisclosureOptions options=null)
 Update Consumer Disclosure. More...
 
ApiResponse< ConsumerDisclosureUpdateConsumerDisclosureWithHttpInfo (string accountId, string langCode, ConsumerDisclosure consumerDisclosure=null, AccountsApi.UpdateConsumerDisclosureOptions options=null)
 Update Consumer Disclosure. More...
 
CustomFields UpdateCustomField (string accountId, string customFieldId, CustomField customField=null, AccountsApi.UpdateCustomFieldOptions options=null)
 Updates an existing account custom field. More...
 
ApiResponse< CustomFieldsUpdateCustomFieldWithHttpInfo (string accountId, string customFieldId, CustomField customField=null, AccountsApi.UpdateCustomFieldOptions options=null)
 Updates an existing account custom field. More...
 
PermissionProfile UpdatePermissionProfile (string accountId, string permissionProfileId, PermissionProfile permissionProfile=null, AccountsApi.UpdatePermissionProfileOptions options=null)
 Updates a permission profile within the specified account. More...
 
ApiResponse< PermissionProfileUpdatePermissionProfileWithHttpInfo (string accountId, string permissionProfileId, PermissionProfile permissionProfile=null, AccountsApi.UpdatePermissionProfileOptions options=null)
 Updates a permission profile within the specified account. More...
 
AccountSharedAccess UpdateSharedAccess (string accountId, AccountSharedAccess accountSharedAccess=null, AccountsApi.UpdateSharedAccessOptions options=null)
 Reserved: Sets the shared access information for users. More...
 
ApiResponse< AccountSharedAccessUpdateSharedAccessWithHttpInfo (string accountId, AccountSharedAccess accountSharedAccess=null, AccountsApi.UpdateSharedAccessOptions options=null)
 Reserved: Sets the shared access information for users. More...
 
System.Threading.Tasks.Task< NewAccountSummaryCreateAsync (NewAccountDefinition newAccountDefinition=null, AccountsApi.CreateOptions options=null)
 Creates new accounts. More...
 
System.Threading.Tasks.Task< ApiResponse< NewAccountSummary > > CreateAsyncWithHttpInfo (NewAccountDefinition newAccountDefinition=null, AccountsApi.CreateOptions options=null)
 Creates new accounts. More...
 
System.Threading.Tasks.Task< AccountSignaturesInformationCreateAccountSignaturesAsync (string accountId, AccountSignaturesInformation accountSignaturesInformation=null, AccountsApi.CreateAccountSignaturesOptions options=null)
 Adds/updates one or more account signatures. This request may include images in multi-part format. More...
 
System.Threading.Tasks.Task< ApiResponse< AccountSignaturesInformation > > CreateAccountSignaturesAsyncWithHttpInfo (string accountId, AccountSignaturesInformation accountSignaturesInformation=null, AccountsApi.CreateAccountSignaturesOptions options=null)
 Adds/updates one or more account signatures. This request may include images in multi-part format. More...
 
System.Threading.Tasks.Task< CustomFieldsCreateCustomFieldAsync (string accountId, CustomField customField=null, AccountsApi.CreateCustomFieldOptions options=null)
 Creates an acount custom field. More...
 
System.Threading.Tasks.Task< ApiResponse< CustomFields > > CreateCustomFieldAsyncWithHttpInfo (string accountId, CustomField customField=null, AccountsApi.CreateCustomFieldOptions options=null)
 Creates an acount custom field. More...
 
System.Threading.Tasks.Task< PermissionProfileCreatePermissionProfileAsync (string accountId, PermissionProfile permissionProfile=null, AccountsApi.CreatePermissionProfileOptions options=null)
 Creates a new permission profile in the specified account. More...
 
System.Threading.Tasks.Task< ApiResponse< PermissionProfile > > CreatePermissionProfileAsyncWithHttpInfo (string accountId, PermissionProfile permissionProfile=null, AccountsApi.CreatePermissionProfileOptions options=null)
 Creates a new permission profile in the specified account. More...
 
System.Threading.Tasks.Task DeleteCustomFieldAsync (string accountId, string customFieldId, AccountsApi.DeleteCustomFieldOptions options=null)
 Delete an existing account custom field. More...
 
System.Threading.Tasks.Task< ApiResponse< Object > > DeleteCustomFieldAsyncWithHttpInfo (string accountId, string customFieldId, AccountsApi.DeleteCustomFieldOptions options=null)
 Delete an existing account custom field. More...
 
System.Threading.Tasks.Task DeletePermissionProfileAsync (string accountId, string permissionProfileId, AccountsApi.DeletePermissionProfileOptions options=null)
 Deletes a permissions profile within the specified account. More...
 
System.Threading.Tasks.Task< ApiResponse< Object > > DeletePermissionProfileAsyncWithHttpInfo (string accountId, string permissionProfileId, AccountsApi.DeletePermissionProfileOptions options=null)
 Deletes a permissions profile within the specified account. More...
 
System.Threading.Tasks.Task< AccountInformationGetAccountInformationAsync (string accountId, AccountsApi.GetAccountInformationOptions options=null)
 Retrieves the account information for the specified account. More...
 
System.Threading.Tasks.Task< ApiResponse< AccountInformation > > GetAccountInformationAsyncWithHttpInfo (string accountId, AccountsApi.GetAccountInformationOptions options=null)
 Retrieves the account information for the specified account. More...
 
System.Threading.Tasks.Task< System.IO.Stream > GetAccountSignatureImageAsync (string accountId, string signatureId, string imageType, AccountsApi.GetAccountSignatureImageOptions options=null)
 Returns a signature, initials, or stamps image. More...
 
System.Threading.Tasks.Task< ApiResponse< System.IO.Stream > > GetAccountSignatureImageAsyncWithHttpInfo (string accountId, string signatureId, string imageType, AccountsApi.GetAccountSignatureImageOptions options=null)
 Returns a signature, initials, or stamps image. More...
 
System.Threading.Tasks.Task< AccountSignaturesInformationGetAccountSignaturesAsync (string accountId, AccountsApi.GetAccountSignaturesOptions options=null)
 Returns the managed signature definitions for the account More...
 
System.Threading.Tasks.Task< ApiResponse< AccountSignaturesInformation > > GetAccountSignaturesAsyncWithHttpInfo (string accountId, AccountsApi.GetAccountSignaturesOptions options=null)
 Returns the managed signature definitions for the account More...
 
System.Threading.Tasks.Task< UserAuthorizationsGetAgentUserAuthorizationsAsync (string accountId, string userId, AccountsApi.GetAgentUserAuthorizationsOptions options=null)
 Returns the agent user authorizations More...
 
System.Threading.Tasks.Task< ApiResponse< UserAuthorizations > > GetAgentUserAuthorizationsAsyncWithHttpInfo (string accountId, string userId, AccountsApi.GetAgentUserAuthorizationsOptions options=null)
 Returns the agent user authorizations More...
 
System.Threading.Tasks.Task< BillingChargeResponseGetBillingChargesAsync (string accountId, AccountsApi.GetBillingChargesOptions options=null)
 Gets list of recurring and usage charges for the account. More...
 
System.Threading.Tasks.Task< ApiResponse< BillingChargeResponse > > GetBillingChargesAsyncWithHttpInfo (string accountId, AccountsApi.GetBillingChargesOptions options=null)
 Gets list of recurring and usage charges for the account. More...
 
System.Threading.Tasks.Task< BrandGetBrandAsync (string accountId, string brandId, AccountsApi.GetBrandOptions options=null)
 Get information for a specific brand. More...
 
System.Threading.Tasks.Task< ApiResponse< Brand > > GetBrandAsyncWithHttpInfo (string accountId, string brandId, AccountsApi.GetBrandOptions options=null)
 Get information for a specific brand. More...
 
System.Threading.Tasks.Task GetBrandResourcesByContentTypeAsync (string accountId, string brandId, string resourceContentType, AccountsApi.GetBrandResourcesByContentTypeOptions options=null)
 Returns the specified branding resource file. More...
 
System.Threading.Tasks.Task< ApiResponse< Object > > GetBrandResourcesByContentTypeAsyncWithHttpInfo (string accountId, string brandId, string resourceContentType, AccountsApi.GetBrandResourcesByContentTypeOptions options=null)
 Returns the specified branding resource file. More...
 
System.Threading.Tasks.Task< ConsumerDisclosureGetConsumerDisclosureDefaultAsync (string accountId, AccountsApi.GetConsumerDisclosureDefaultOptions options=null)
 Gets the Electronic Record and Signature Disclosure for the account. More...
 
System.Threading.Tasks.Task< ApiResponse< ConsumerDisclosure > > GetConsumerDisclosureDefaultAsyncWithHttpInfo (string accountId, AccountsApi.GetConsumerDisclosureDefaultOptions options=null)
 Gets the Electronic Record and Signature Disclosure for the account. More...
 
System.Threading.Tasks.Task< PermissionProfileGetPermissionProfileAsync (string accountId, string permissionProfileId, AccountsApi.GetPermissionProfileOptions options=null)
 Returns a permissions profile in the specified account. More...
 
System.Threading.Tasks.Task< ApiResponse< PermissionProfile > > GetPermissionProfileAsyncWithHttpInfo (string accountId, string permissionProfileId, AccountsApi.GetPermissionProfileOptions options=null)
 Returns a permissions profile in the specified account. More...
 
System.Threading.Tasks.Task< UserAuthorizationsGetPrincipalUserAuthorizationsAsync (string accountId, string userId, AccountsApi.GetPrincipalUserAuthorizationsOptions options=null)
 Returns the principal user authorizations More...
 
System.Threading.Tasks.Task< ApiResponse< UserAuthorizations > > GetPrincipalUserAuthorizationsAsyncWithHttpInfo (string accountId, string userId, AccountsApi.GetPrincipalUserAuthorizationsOptions options=null)
 Returns the principal user authorizations More...
 
System.Threading.Tasks.Task< BrandsResponseListBrandsAsync (string accountId, AccountsApi.ListBrandsOptions options=null)
 Gets a list of brand profiles. More...
 
System.Threading.Tasks.Task< ApiResponse< BrandsResponse > > ListBrandsAsyncWithHttpInfo (string accountId, AccountsApi.ListBrandsOptions options=null)
 Gets a list of brand profiles. More...
 
System.Threading.Tasks.Task< PermissionProfileInformationListPermissionsAsync (string accountId, AccountsApi.ListPermissionsOptions options=null)
 Gets a list of permission profiles. More...
 
System.Threading.Tasks.Task< ApiResponse< PermissionProfileInformation > > ListPermissionsAsyncWithHttpInfo (string accountId, AccountsApi.ListPermissionsOptions options=null)
 Gets a list of permission profiles. More...
 
System.Threading.Tasks.Task< RecipientNamesResponseListRecipientNamesByEmailAsync (string accountId, AccountsApi.ListRecipientNamesByEmailOptions options=null)
 Gets recipient names associated with an email address. More...
 
System.Threading.Tasks.Task< ApiResponse< RecipientNamesResponse > > ListRecipientNamesByEmailAsyncWithHttpInfo (string accountId, AccountsApi.ListRecipientNamesByEmailOptions options=null)
 Gets recipient names associated with an email address. More...
 
System.Threading.Tasks.Task< AccountSharedAccessListSharedAccessAsync (string accountId, AccountsApi.ListSharedAccessOptions options=null)
 Reserved: Gets the shared item status for one or more users. More...
 
System.Threading.Tasks.Task< ApiResponse< AccountSharedAccess > > ListSharedAccessAsyncWithHttpInfo (string accountId, AccountsApi.ListSharedAccessOptions options=null)
 Reserved: Gets the shared item status for one or more users. More...
 
System.Threading.Tasks.Task< AccountSignatureUpdateAccountSignatureByIdAsync (string accountId, string signatureId, AccountSignatureDefinition accountSignatureDefinition=null, AccountsApi.UpdateAccountSignatureByIdOptions options=null)
 Updates a account signature. More...
 
System.Threading.Tasks.Task< ApiResponse< AccountSignature > > UpdateAccountSignatureByIdAsyncWithHttpInfo (string accountId, string signatureId, AccountSignatureDefinition accountSignatureDefinition=null, AccountsApi.UpdateAccountSignatureByIdOptions options=null)
 Updates a account signature. More...
 
System.Threading.Tasks.Task< AccountSignatureUpdateAccountSignatureImageAsync (string accountId, string signatureId, string imageType, AccountsApi.UpdateAccountSignatureImageOptions options=null)
 Sets a signature, initials, or stamps image. More...
 
System.Threading.Tasks.Task< ApiResponse< AccountSignature > > UpdateAccountSignatureImageAsyncWithHttpInfo (string accountId, string signatureId, string imageType, AccountsApi.UpdateAccountSignatureImageOptions options=null)
 Sets a signature, initials, or stamps image. More...
 
System.Threading.Tasks.Task< BrandUpdateBrandAsync (string accountId, string brandId, Brand brand=null, AccountsApi.UpdateBrandOptions options=null)
 Updates an existing brand. More...
 
System.Threading.Tasks.Task< ApiResponse< Brand > > UpdateBrandAsyncWithHttpInfo (string accountId, string brandId, Brand brand=null, AccountsApi.UpdateBrandOptions options=null)
 Updates an existing brand. More...
 
System.Threading.Tasks.Task< ConsumerDisclosureUpdateConsumerDisclosureAsync (string accountId, string langCode, ConsumerDisclosure consumerDisclosure=null, AccountsApi.UpdateConsumerDisclosureOptions options=null)
 Update Consumer Disclosure. More...
 
System.Threading.Tasks.Task< ApiResponse< ConsumerDisclosure > > UpdateConsumerDisclosureAsyncWithHttpInfo (string accountId, string langCode, ConsumerDisclosure consumerDisclosure=null, AccountsApi.UpdateConsumerDisclosureOptions options=null)
 Update Consumer Disclosure. More...
 
System.Threading.Tasks.Task< CustomFieldsUpdateCustomFieldAsync (string accountId, string customFieldId, CustomField customField=null, AccountsApi.UpdateCustomFieldOptions options=null)
 Updates an existing account custom field. More...
 
System.Threading.Tasks.Task< ApiResponse< CustomFields > > UpdateCustomFieldAsyncWithHttpInfo (string accountId, string customFieldId, CustomField customField=null, AccountsApi.UpdateCustomFieldOptions options=null)
 Updates an existing account custom field. More...
 
System.Threading.Tasks.Task< PermissionProfileUpdatePermissionProfileAsync (string accountId, string permissionProfileId, PermissionProfile permissionProfile=null, AccountsApi.UpdatePermissionProfileOptions options=null)
 Updates a permission profile within the specified account. More...
 
System.Threading.Tasks.Task< ApiResponse< PermissionProfile > > UpdatePermissionProfileAsyncWithHttpInfo (string accountId, string permissionProfileId, PermissionProfile permissionProfile=null, AccountsApi.UpdatePermissionProfileOptions options=null)
 Updates a permission profile within the specified account. More...
 
System.Threading.Tasks.Task< AccountSharedAccessUpdateSharedAccessAsync (string accountId, AccountSharedAccess accountSharedAccess=null, AccountsApi.UpdateSharedAccessOptions options=null)
 Reserved: Sets the shared access information for users. More...
 
System.Threading.Tasks.Task< ApiResponse< AccountSharedAccess > > UpdateSharedAccessAsyncWithHttpInfo (string accountId, AccountSharedAccess accountSharedAccess=null, AccountsApi.UpdateSharedAccessOptions options=null)
 Reserved: Sets the shared access information for users. More...
 

Properties

DocuSignClient ApiClient [get, set]
 Gets or sets the ApiClient object More...
 
DocuSign.eSign.Client.ExceptionFactory ExceptionFactory [get, set]
 Provides a factory method hook for the creation of exceptions. More...
 
- Properties inherited from DocuSign.eSign.Client.IApiAccessor
DocuSignClient ApiClient [get, set]
 Gets or sets the ApiClient object More...
 
ExceptionFactory ExceptionFactory [get, set]
 Provides a factory method hook for the creation of exceptions. More...
 

Detailed Description

Represents a collection of functions to interact with the API endpoints

Constructor & Destructor Documentation

◆ AccountsApi()

DocuSign.eSign.Api.AccountsApi.AccountsApi ( DocuSignClient  aplClient)
inline

Initializes a new instance of the AccountsApi class using AplClient object

Parameters
aplClientAn instance of AplClient
Returns

Member Function Documentation

◆ Create()

NewAccountSummary DocuSign.eSign.Api.AccountsApi.Create ( NewAccountDefinition  newAccountDefinition = null,
AccountsApi.CreateOptions  options = null 
)
inline

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 &#x60;newAccountRequests&#x60; 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 &#x60;newAccountDefinition&#x60; property inside the &#x60;newAccountRequests&#x60; 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 &#x60;errorDetails&#x60; node is added in the response to each specific request that failed.

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
newAccountDefinition(optional)
optionsOptions for modifying the behavior of the function.
Returns
NewAccountSummary

◆ CreateAccountSignatures()

AccountSignaturesInformation DocuSign.eSign.Api.AccountsApi.CreateAccountSignatures ( string  accountId,
AccountSignaturesInformation  accountSignaturesInformation = null,
AccountsApi.CreateAccountSignaturesOptions  options = null 
)
inline

Adds/updates one or more account signatures. This request may include images in multi-part format.

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
accountSignaturesInformation(optional)
optionsOptions for modifying the behavior of the function.
Returns
AccountSignaturesInformation

◆ CreateAccountSignaturesAsync()

async System.Threading.Tasks.Task<AccountSignaturesInformation> DocuSign.eSign.Api.AccountsApi.CreateAccountSignaturesAsync ( string  accountId,
AccountSignaturesInformation  accountSignaturesInformation = null,
AccountsApi.CreateAccountSignaturesOptions  options = null 
)
inline

Adds/updates one or more account signatures. This request may include images in multi-part format.

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
accountSignaturesInformation(optional)
optionsOptions for modifying the behavior of the function.
Returns
Task of AccountSignaturesInformation

◆ CreateAccountSignaturesAsyncWithHttpInfo()

async System.Threading.Tasks.Task<ApiResponse<AccountSignaturesInformation> > DocuSign.eSign.Api.AccountsApi.CreateAccountSignaturesAsyncWithHttpInfo ( string  accountId,
AccountSignaturesInformation  accountSignaturesInformation = null,
AccountsApi.CreateAccountSignaturesOptions  options = null 
)
inline

Adds/updates one or more account signatures. This request may include images in multi-part format.

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
accountSignaturesInformation(optional)
optionsOptions for modifying the behavior of the function.
Returns
Task of ApiResponse (AccountSignaturesInformation)

◆ CreateAccountSignaturesWithHttpInfo()

ApiResponse<AccountSignaturesInformation> DocuSign.eSign.Api.AccountsApi.CreateAccountSignaturesWithHttpInfo ( string  accountId,
AccountSignaturesInformation  accountSignaturesInformation = null,
AccountsApi.CreateAccountSignaturesOptions  options = null 
)
inline

Adds/updates one or more account signatures. This request may include images in multi-part format.

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
accountSignaturesInformation(optional)
optionsOptions for modifying the behavior of the function.
Returns
ApiResponse of AccountSignaturesInformation

◆ CreateAsync()

async System.Threading.Tasks.Task<NewAccountSummary> DocuSign.eSign.Api.AccountsApi.CreateAsync ( NewAccountDefinition  newAccountDefinition = null,
AccountsApi.CreateOptions  options = null 
)
inline

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 &#x60;newAccountRequests&#x60; 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 &#x60;newAccountDefinition&#x60; property inside the &#x60;newAccountRequests&#x60; 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 &#x60;errorDetails&#x60; node is added in the response to each specific request that failed.

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
newAccountDefinition(optional)
optionsOptions for modifying the behavior of the function.
Returns
Task of NewAccountSummary

◆ CreateAsyncWithHttpInfo()

async System.Threading.Tasks.Task<ApiResponse<NewAccountSummary> > DocuSign.eSign.Api.AccountsApi.CreateAsyncWithHttpInfo ( NewAccountDefinition  newAccountDefinition = null,
AccountsApi.CreateOptions  options = null 
)
inline

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 &#x60;newAccountRequests&#x60; 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 &#x60;newAccountDefinition&#x60; property inside the &#x60;newAccountRequests&#x60; 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 &#x60;errorDetails&#x60; node is added in the response to each specific request that failed.

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
newAccountDefinition(optional)
optionsOptions for modifying the behavior of the function.
Returns
Task of ApiResponse (NewAccountSummary)

◆ CreateBrand()

BrandsResponse DocuSign.eSign.Api.AccountsApi.CreateBrand ( string  accountId,
Brand  brand = null 
)
inline

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 &#x60;canSelfBrandSend&#x60; and &#x60;canSelfBrandSig&#x60;) must be set to true for the account to use this call. An error is returned if &#x60;brandId&#x60; 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 &#x60;Content-Type&#x60; must be &#x60;application/zip&#x60;.

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID GUID.
brand(optional)
Returns
BrandsResponse

Implements DocuSign.eSign.Api.IAccountsApi.

◆ CreateBrandAsync()

async System.Threading.Tasks.Task<BrandsResponse> DocuSign.eSign.Api.AccountsApi.CreateBrandAsync ( string  accountId,
Brand  brand = null 
)
inline

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 &#x60;canSelfBrandSend&#x60; and &#x60;canSelfBrandSig&#x60;) must be set to true for the account to use this call. An error is returned if &#x60;brandId&#x60; 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 &#x60;Content-Type&#x60; must be &#x60;application/zip&#x60;.

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID GUID.
brand(optional)
Returns
Task of BrandsResponse

Implements DocuSign.eSign.Api.IAccountsApi.

◆ CreateBrandAsyncWithHttpInfo()

async System.Threading.Tasks.Task<ApiResponse<BrandsResponse> > DocuSign.eSign.Api.AccountsApi.CreateBrandAsyncWithHttpInfo ( string  accountId,
Brand  brand = null 
)
inline

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 &#x60;canSelfBrandSend&#x60; and &#x60;canSelfBrandSig&#x60;) must be set to true for the account to use this call. An error is returned if &#x60;brandId&#x60; 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 &#x60;Content-Type&#x60; must be &#x60;application/zip&#x60;.

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID GUID.
brand(optional)
Returns
Task of ApiResponse (BrandsResponse)

Implements DocuSign.eSign.Api.IAccountsApi.

◆ CreateBrandWithHttpInfo()

ApiResponse<BrandsResponse> DocuSign.eSign.Api.AccountsApi.CreateBrandWithHttpInfo ( string  accountId,
Brand  brand = null 
)
inline

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 &#x60;canSelfBrandSend&#x60; and &#x60;canSelfBrandSig&#x60;) must be set to true for the account to use this call. An error is returned if &#x60;brandId&#x60; 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 &#x60;Content-Type&#x60; must be &#x60;application/zip&#x60;.

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID GUID.
brand(optional)
Returns
ApiResponse of BrandsResponse

Implements DocuSign.eSign.Api.IAccountsApi.

◆ CreateCustomField()

CustomFields DocuSign.eSign.Api.AccountsApi.CreateCustomField ( string  accountId,
CustomField  customField = null,
AccountsApi.CreateCustomFieldOptions  options = null 
)
inline

Creates an acount custom field. This method creates a custom field and makes it available for all new envelopes associated with an account.

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
customField(optional)
optionsOptions for modifying the behavior of the function.
Returns
CustomFields

◆ CreateCustomFieldAsync()

async System.Threading.Tasks.Task<CustomFields> DocuSign.eSign.Api.AccountsApi.CreateCustomFieldAsync ( string  accountId,
CustomField  customField = null,
AccountsApi.CreateCustomFieldOptions  options = null 
)
inline

Creates an acount custom field. This method creates a custom field and makes it available for all new envelopes associated with an account.

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
customField(optional)
optionsOptions for modifying the behavior of the function.
Returns
Task of CustomFields

◆ CreateCustomFieldAsyncWithHttpInfo()

async System.Threading.Tasks.Task<ApiResponse<CustomFields> > DocuSign.eSign.Api.AccountsApi.CreateCustomFieldAsyncWithHttpInfo ( string  accountId,
CustomField  customField = null,
AccountsApi.CreateCustomFieldOptions  options = null 
)
inline

Creates an acount custom field. This method creates a custom field and makes it available for all new envelopes associated with an account.

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
customField(optional)
optionsOptions for modifying the behavior of the function.
Returns
Task of ApiResponse (CustomFields)

◆ CreateCustomFieldWithHttpInfo()

ApiResponse<CustomFields> DocuSign.eSign.Api.AccountsApi.CreateCustomFieldWithHttpInfo ( string  accountId,
CustomField  customField = null,
AccountsApi.CreateCustomFieldOptions  options = null 
)
inline

Creates an acount custom field. This method creates a custom field and makes it available for all new envelopes associated with an account.

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
customField(optional)
optionsOptions for modifying the behavior of the function.
Returns
ApiResponse of CustomFields

◆ CreatePermissionProfile()

PermissionProfile DocuSign.eSign.Api.AccountsApi.CreatePermissionProfile ( string  accountId,
PermissionProfile  permissionProfile = null,
AccountsApi.CreatePermissionProfileOptions  options = null 
)
inline

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

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
permissionProfile(optional)
optionsOptions for modifying the behavior of the function.
Returns
PermissionProfile

◆ CreatePermissionProfileAsync()

async System.Threading.Tasks.Task<PermissionProfile> DocuSign.eSign.Api.AccountsApi.CreatePermissionProfileAsync ( string  accountId,
PermissionProfile  permissionProfile = null,
AccountsApi.CreatePermissionProfileOptions  options = null 
)
inline

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

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
permissionProfile(optional)
optionsOptions for modifying the behavior of the function.
Returns
Task of PermissionProfile

◆ CreatePermissionProfileAsyncWithHttpInfo()

async System.Threading.Tasks.Task<ApiResponse<PermissionProfile> > DocuSign.eSign.Api.AccountsApi.CreatePermissionProfileAsyncWithHttpInfo ( string  accountId,
PermissionProfile  permissionProfile = null,
AccountsApi.CreatePermissionProfileOptions  options = null 
)
inline

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

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
permissionProfile(optional)
optionsOptions for modifying the behavior of the function.
Returns
Task of ApiResponse (PermissionProfile)

◆ CreatePermissionProfileWithHttpInfo()

ApiResponse<PermissionProfile> DocuSign.eSign.Api.AccountsApi.CreatePermissionProfileWithHttpInfo ( string  accountId,
PermissionProfile  permissionProfile = null,
AccountsApi.CreatePermissionProfileOptions  options = null 
)
inline

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

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
permissionProfile(optional)
optionsOptions for modifying the behavior of the function.
Returns
ApiResponse of PermissionProfile

◆ CreateUserAuthorization()

UserAuthorization DocuSign.eSign.Api.AccountsApi.CreateUserAuthorization ( string  accountId,
string  userId,
UserAuthorizationCreateRequest  userAuthorizationCreateRequest = null 
)
inline

Creates the user authorization

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
userIdThe user ID of the user being accessed. Generally this is the user ID of the authenticated user, but if the authenticated user is an Admin on the account, this may be another user the Admin user is accessing.
userAuthorizationCreateRequest(optional)
Returns
UserAuthorization

Implements DocuSign.eSign.Api.IAccountsApi.

◆ CreateUserAuthorizationAsync()

async System.Threading.Tasks.Task<UserAuthorization> DocuSign.eSign.Api.AccountsApi.CreateUserAuthorizationAsync ( string  accountId,
string  userId,
UserAuthorizationCreateRequest  userAuthorizationCreateRequest = null 
)
inline

Creates the user authorization

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
userIdThe user ID of the user being accessed. Generally this is the user ID of the authenticated user, but if the authenticated user is an Admin on the account, this may be another user the Admin user is accessing.
userAuthorizationCreateRequest(optional)
Returns
Task of UserAuthorization

Implements DocuSign.eSign.Api.IAccountsApi.

◆ CreateUserAuthorizationAsyncWithHttpInfo()

async System.Threading.Tasks.Task<ApiResponse<UserAuthorization> > DocuSign.eSign.Api.AccountsApi.CreateUserAuthorizationAsyncWithHttpInfo ( string  accountId,
string  userId,
UserAuthorizationCreateRequest  userAuthorizationCreateRequest = null 
)
inline

Creates the user authorization

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
userIdThe user ID of the user being accessed. Generally this is the user ID of the authenticated user, but if the authenticated user is an Admin on the account, this may be another user the Admin user is accessing.
userAuthorizationCreateRequest(optional)
Returns
Task of ApiResponse (UserAuthorization)

Implements DocuSign.eSign.Api.IAccountsApi.

◆ CreateUserAuthorizations()

UserAuthorizationsResponse DocuSign.eSign.Api.AccountsApi.CreateUserAuthorizations ( string  accountId,
string  userId,
UserAuthorizationsRequest  userAuthorizationsRequest = null 
)
inline

Creates ot updates user authorizations

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
userIdThe user ID of the user being accessed. Generally this is the user ID of the authenticated user, but if the authenticated user is an Admin on the account, this may be another user the Admin user is accessing.
userAuthorizationsRequest(optional)
Returns
UserAuthorizationsResponse

Implements DocuSign.eSign.Api.IAccountsApi.

◆ CreateUserAuthorizationsAsync()

async System.Threading.Tasks.Task<UserAuthorizationsResponse> DocuSign.eSign.Api.AccountsApi.CreateUserAuthorizationsAsync ( string  accountId,
string  userId,
UserAuthorizationsRequest  userAuthorizationsRequest = null 
)
inline

Creates ot updates user authorizations

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
userIdThe user ID of the user being accessed. Generally this is the user ID of the authenticated user, but if the authenticated user is an Admin on the account, this may be another user the Admin user is accessing.
userAuthorizationsRequest(optional)
Returns
Task of UserAuthorizationsResponse

Implements DocuSign.eSign.Api.IAccountsApi.

◆ CreateUserAuthorizationsAsyncWithHttpInfo()

async System.Threading.Tasks.Task<ApiResponse<UserAuthorizationsResponse> > DocuSign.eSign.Api.AccountsApi.CreateUserAuthorizationsAsyncWithHttpInfo ( string  accountId,
string  userId,
UserAuthorizationsRequest  userAuthorizationsRequest = null 
)
inline

Creates ot updates user authorizations

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
userIdThe user ID of the user being accessed. Generally this is the user ID of the authenticated user, but if the authenticated user is an Admin on the account, this may be another user the Admin user is accessing.
userAuthorizationsRequest(optional)
Returns
Task of ApiResponse (UserAuthorizationsResponse)

Implements DocuSign.eSign.Api.IAccountsApi.

◆ CreateUserAuthorizationsWithHttpInfo()

ApiResponse<UserAuthorizationsResponse> DocuSign.eSign.Api.AccountsApi.CreateUserAuthorizationsWithHttpInfo ( string  accountId,
string  userId,
UserAuthorizationsRequest  userAuthorizationsRequest = null 
)
inline

Creates ot updates user authorizations

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
userIdThe user ID of the user being accessed. Generally this is the user ID of the authenticated user, but if the authenticated user is an Admin on the account, this may be another user the Admin user is accessing.
userAuthorizationsRequest(optional)
Returns
ApiResponse of UserAuthorizationsResponse

Implements DocuSign.eSign.Api.IAccountsApi.

◆ CreateUserAuthorizationWithHttpInfo()

ApiResponse<UserAuthorization> DocuSign.eSign.Api.AccountsApi.CreateUserAuthorizationWithHttpInfo ( string  accountId,
string  userId,
UserAuthorizationCreateRequest  userAuthorizationCreateRequest = null 
)
inline

Creates the user authorization

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
userIdThe user ID of the user being accessed. Generally this is the user ID of the authenticated user, but if the authenticated user is an Admin on the account, this may be another user the Admin user is accessing.
userAuthorizationCreateRequest(optional)
Returns
ApiResponse of UserAuthorization

Implements DocuSign.eSign.Api.IAccountsApi.

◆ CreateWithHttpInfo()

ApiResponse<NewAccountSummary> DocuSign.eSign.Api.AccountsApi.CreateWithHttpInfo ( NewAccountDefinition  newAccountDefinition = null,
AccountsApi.CreateOptions  options = null 
)
inline

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 &#x60;newAccountRequests&#x60; 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 &#x60;newAccountDefinition&#x60; property inside the &#x60;newAccountRequests&#x60; 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 &#x60;errorDetails&#x60; node is added in the response to each specific request that failed.

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
newAccountDefinition(optional)
optionsOptions for modifying the behavior of the function.
Returns
ApiResponse of NewAccountSummary

◆ Delete()

void DocuSign.eSign.Api.AccountsApi.Delete ( string  accountId)
inline

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.

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
Returns

Implements DocuSign.eSign.Api.IAccountsApi.

◆ DeleteAccountSignature()

void DocuSign.eSign.Api.AccountsApi.DeleteAccountSignature ( string  accountId,
string  signatureId 
)
inline

Close the specified signature by Id.

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
signatureIdThe ID of the signature being accessed.
Returns

Implements DocuSign.eSign.Api.IAccountsApi.

◆ DeleteAccountSignatureAsync()

async System.Threading.Tasks.Task DocuSign.eSign.Api.AccountsApi.DeleteAccountSignatureAsync ( string  accountId,
string  signatureId 
)
inline

Close the specified signature by Id.

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
signatureIdThe ID of the signature being accessed.
Returns
Task of void

Implements DocuSign.eSign.Api.IAccountsApi.

◆ DeleteAccountSignatureAsyncWithHttpInfo()

async System.Threading.Tasks.Task<ApiResponse<Object> > DocuSign.eSign.Api.AccountsApi.DeleteAccountSignatureAsyncWithHttpInfo ( string  accountId,
string  signatureId 
)
inline

Close the specified signature by Id.

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
signatureIdThe ID of the signature being accessed.
Returns
Task of ApiResponse

Implements DocuSign.eSign.Api.IAccountsApi.

◆ DeleteAccountSignatureImage()

AccountSignature DocuSign.eSign.Api.AccountsApi.DeleteAccountSignatureImage ( string  accountId,
string  signatureId,
string  imageType 
)
inline

Deletes a signature, initials, or stamps image.

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
signatureIdThe ID of the signature being accessed.
imageTypeOne of signature_image or initials_image.
Returns
AccountSignature

Implements DocuSign.eSign.Api.IAccountsApi.

◆ DeleteAccountSignatureImageAsync()

async System.Threading.Tasks.Task<AccountSignature> DocuSign.eSign.Api.AccountsApi.DeleteAccountSignatureImageAsync ( string  accountId,
string  signatureId,
string  imageType 
)
inline

Deletes a signature, initials, or stamps image.

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
signatureIdThe ID of the signature being accessed.
imageTypeOne of signature_image or initials_image.
Returns
Task of AccountSignature

Implements DocuSign.eSign.Api.IAccountsApi.

◆ DeleteAccountSignatureImageAsyncWithHttpInfo()

async System.Threading.Tasks.Task<ApiResponse<AccountSignature> > DocuSign.eSign.Api.AccountsApi.DeleteAccountSignatureImageAsyncWithHttpInfo ( string  accountId,
string  signatureId,
string  imageType 
)
inline

Deletes a signature, initials, or stamps image.

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
signatureIdThe ID of the signature being accessed.
imageTypeOne of signature_image or initials_image.
Returns
Task of ApiResponse (AccountSignature)

Implements DocuSign.eSign.Api.IAccountsApi.

◆ DeleteAccountSignatureImageWithHttpInfo()

ApiResponse<AccountSignature> DocuSign.eSign.Api.AccountsApi.DeleteAccountSignatureImageWithHttpInfo ( string  accountId,
string  signatureId,
string  imageType 
)
inline

Deletes a signature, initials, or stamps image.

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
signatureIdThe ID of the signature being accessed.
imageTypeOne of signature_image or initials_image.
Returns
ApiResponse of AccountSignature

Implements DocuSign.eSign.Api.IAccountsApi.

◆ DeleteAccountSignatureWithHttpInfo()

ApiResponse<Object> DocuSign.eSign.Api.AccountsApi.DeleteAccountSignatureWithHttpInfo ( string  accountId,
string  signatureId 
)
inline

Close the specified signature by Id.

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
signatureIdThe ID of the signature being accessed.
Returns
ApiResponse of Object(void)

Implements DocuSign.eSign.Api.IAccountsApi.

◆ DeleteAsync()

async System.Threading.Tasks.Task DocuSign.eSign.Api.AccountsApi.DeleteAsync ( string  accountId)
inline

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.

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
Returns
Task of void

Implements DocuSign.eSign.Api.IAccountsApi.

◆ DeleteAsyncWithHttpInfo()

async System.Threading.Tasks.Task<ApiResponse<Object> > DocuSign.eSign.Api.AccountsApi.DeleteAsyncWithHttpInfo ( string  accountId)
inline

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.

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
Returns
Task of ApiResponse

Implements DocuSign.eSign.Api.IAccountsApi.

◆ DeleteBrand()

void DocuSign.eSign.Api.AccountsApi.DeleteBrand ( string  accountId,
string  brandId 
)
inline

Removes a brand. This method deletes a brand from an account. Note: Branding for either signing or sending must be enabled for the account (&#x60;canSelfBrandSend&#x60; , &#x60;canSelfBrandSign&#x60;, or both of these account settings must be true).

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
brandIdThe unique identifier of a brand.
Returns

Implements DocuSign.eSign.Api.IAccountsApi.

◆ DeleteBrandAsync()

async System.Threading.Tasks.Task DocuSign.eSign.Api.AccountsApi.DeleteBrandAsync ( string  accountId,
string  brandId 
)
inline

Removes a brand. This method deletes a brand from an account. Note: Branding for either signing or sending must be enabled for the account (&#x60;canSelfBrandSend&#x60; , &#x60;canSelfBrandSign&#x60;, or both of these account settings must be true).

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
brandIdThe unique identifier of a brand.
Returns
Task of void

Implements DocuSign.eSign.Api.IAccountsApi.

◆ DeleteBrandAsyncWithHttpInfo()

async System.Threading.Tasks.Task<ApiResponse<Object> > DocuSign.eSign.Api.AccountsApi.DeleteBrandAsyncWithHttpInfo ( string  accountId,
string  brandId 
)
inline

Removes a brand. This method deletes a brand from an account. Note: Branding for either signing or sending must be enabled for the account (&#x60;canSelfBrandSend&#x60; , &#x60;canSelfBrandSign&#x60;, or both of these account settings must be true).

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
brandIdThe unique identifier of a brand.
Returns
Task of ApiResponse

Implements DocuSign.eSign.Api.IAccountsApi.

◆ DeleteBrandLogoByType()

void DocuSign.eSign.Api.AccountsApi.DeleteBrandLogoByType ( string  accountId,
string  brandId,
string  logoType 
)
inline

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 (&#x60;canSelfBrandSend&#x60; , &#x60;canSelfBrandSign&#x60;, or both of these account settings must be true).

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
brandIdThe unique identifier of a brand.
logoTypeOne of Primary, Secondary or Email.
Returns

Implements DocuSign.eSign.Api.IAccountsApi.

◆ DeleteBrandLogoByTypeAsync()

async System.Threading.Tasks.Task DocuSign.eSign.Api.AccountsApi.DeleteBrandLogoByTypeAsync ( string  accountId,
string  brandId,
string  logoType 
)
inline

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 (&#x60;canSelfBrandSend&#x60; , &#x60;canSelfBrandSign&#x60;, or both of these account settings must be true).

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
brandIdThe unique identifier of a brand.
logoTypeOne of Primary, Secondary or Email.
Returns
Task of void

Implements DocuSign.eSign.Api.IAccountsApi.

◆ DeleteBrandLogoByTypeAsyncWithHttpInfo()

async System.Threading.Tasks.Task<ApiResponse<Object> > DocuSign.eSign.Api.AccountsApi.DeleteBrandLogoByTypeAsyncWithHttpInfo ( string  accountId,
string  brandId,
string  logoType 
)
inline

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 (&#x60;canSelfBrandSend&#x60; , &#x60;canSelfBrandSign&#x60;, or both of these account settings must be true).

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
brandIdThe unique identifier of a brand.
logoTypeOne of Primary, Secondary or Email.
Returns
Task of ApiResponse

Implements DocuSign.eSign.Api.IAccountsApi.

◆ DeleteBrandLogoByTypeWithHttpInfo()

ApiResponse<Object> DocuSign.eSign.Api.AccountsApi.DeleteBrandLogoByTypeWithHttpInfo ( string  accountId,
string  brandId,
string  logoType 
)
inline

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 (&#x60;canSelfBrandSend&#x60; , &#x60;canSelfBrandSign&#x60;, or both of these account settings must be true).

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
brandIdThe unique identifier of a brand.
logoTypeOne of Primary, Secondary or Email.
Returns
ApiResponse of Object(void)

Implements DocuSign.eSign.Api.IAccountsApi.

◆ DeleteBrands()

BrandsResponse DocuSign.eSign.Api.AccountsApi.DeleteBrands ( string  accountId,
BrandsRequest  brandsRequest = null 
)
inline

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

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
brandsRequest(optional)
Returns
BrandsResponse

Implements DocuSign.eSign.Api.IAccountsApi.

◆ DeleteBrandsAsync()

async System.Threading.Tasks.Task<BrandsResponse> DocuSign.eSign.Api.AccountsApi.DeleteBrandsAsync ( string  accountId,
BrandsRequest  brandsRequest = null 
)
inline

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

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
brandsRequest(optional)
Returns
Task of BrandsResponse

Implements DocuSign.eSign.Api.IAccountsApi.

◆ DeleteBrandsAsyncWithHttpInfo()

async System.Threading.Tasks.Task<ApiResponse<BrandsResponse> > DocuSign.eSign.Api.AccountsApi.DeleteBrandsAsyncWithHttpInfo ( string  accountId,
BrandsRequest  brandsRequest = null 
)
inline

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

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
brandsRequest(optional)
Returns
Task of ApiResponse (BrandsResponse)

Implements DocuSign.eSign.Api.IAccountsApi.

◆ DeleteBrandsWithHttpInfo()

ApiResponse<BrandsResponse> DocuSign.eSign.Api.AccountsApi.DeleteBrandsWithHttpInfo ( string  accountId,
BrandsRequest  brandsRequest = null 
)
inline

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

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
brandsRequest(optional)
Returns
ApiResponse of BrandsResponse

Implements DocuSign.eSign.Api.IAccountsApi.

◆ DeleteBrandWithHttpInfo()

ApiResponse<Object> DocuSign.eSign.Api.AccountsApi.DeleteBrandWithHttpInfo ( string  accountId,
string  brandId 
)
inline

Removes a brand. This method deletes a brand from an account. Note: Branding for either signing or sending must be enabled for the account (&#x60;canSelfBrandSend&#x60; , &#x60;canSelfBrandSign&#x60;, or both of these account settings must be true).

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
brandIdThe unique identifier of a brand.
Returns
ApiResponse of Object(void)

Implements DocuSign.eSign.Api.IAccountsApi.

◆ DeleteCaptiveRecipient()

CaptiveRecipientInformation DocuSign.eSign.Api.AccountsApi.DeleteCaptiveRecipient ( string  accountId,
string  recipientPart,
CaptiveRecipientInformation  captiveRecipientInformation = null 
)
inline

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.

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
recipientPart
captiveRecipientInformation(optional)
Returns
CaptiveRecipientInformation

Implements DocuSign.eSign.Api.IAccountsApi.

◆ DeleteCaptiveRecipientAsync()

async System.Threading.Tasks.Task<CaptiveRecipientInformation> DocuSign.eSign.Api.AccountsApi.DeleteCaptiveRecipientAsync ( string  accountId,
string  recipientPart,
CaptiveRecipientInformation  captiveRecipientInformation = null 
)
inline

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.

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
recipientPart
captiveRecipientInformation(optional)
Returns
Task of CaptiveRecipientInformation

Implements DocuSign.eSign.Api.IAccountsApi.

◆ DeleteCaptiveRecipientAsyncWithHttpInfo()

async System.Threading.Tasks.Task<ApiResponse<CaptiveRecipientInformation> > DocuSign.eSign.Api.AccountsApi.DeleteCaptiveRecipientAsyncWithHttpInfo ( string  accountId,
string  recipientPart,
CaptiveRecipientInformation  captiveRecipientInformation = null 
)
inline

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.

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
recipientPart
captiveRecipientInformation(optional)
Returns
Task of ApiResponse (CaptiveRecipientInformation)

Implements DocuSign.eSign.Api.IAccountsApi.

◆ DeleteCaptiveRecipientWithHttpInfo()

ApiResponse<CaptiveRecipientInformation> DocuSign.eSign.Api.AccountsApi.DeleteCaptiveRecipientWithHttpInfo ( string  accountId,
string  recipientPart,
CaptiveRecipientInformation  captiveRecipientInformation = null 
)
inline

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.

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
recipientPart
captiveRecipientInformation(optional)
Returns
ApiResponse of CaptiveRecipientInformation

Implements DocuSign.eSign.Api.IAccountsApi.

◆ DeleteCustomField()

void DocuSign.eSign.Api.AccountsApi.DeleteCustomField ( string  accountId,
string  customFieldId,
AccountsApi.DeleteCustomFieldOptions  options = null 
)
inline

Delete an existing account custom field. This method deletes an existing account custom field.

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
customFieldId
optionsOptions for modifying the behavior of the function.
Returns

◆ DeleteCustomFieldAsync()

async System.Threading.Tasks.Task DocuSign.eSign.Api.AccountsApi.DeleteCustomFieldAsync ( string  accountId,
string  customFieldId,
AccountsApi.DeleteCustomFieldOptions  options = null 
)
inline

Delete an existing account custom field. This method deletes an existing account custom field.

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
customFieldId
optionsOptions for modifying the behavior of the function.
Returns
Task of void

◆ DeleteCustomFieldAsyncWithHttpInfo()

async System.Threading.Tasks.Task<ApiResponse<Object> > DocuSign.eSign.Api.AccountsApi.DeleteCustomFieldAsyncWithHttpInfo ( string  accountId,
string  customFieldId,
AccountsApi.DeleteCustomFieldOptions  options = null 
)
inline

Delete an existing account custom field. This method deletes an existing account custom field.

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
customFieldId
optionsOptions for modifying the behavior of the function.
Returns
Task of ApiResponse

◆ DeleteCustomFieldWithHttpInfo()

ApiResponse<Object> DocuSign.eSign.Api.AccountsApi.DeleteCustomFieldWithHttpInfo ( string  accountId,
string  customFieldId,
AccountsApi.DeleteCustomFieldOptions  options = null 
)
inline

Delete an existing account custom field. This method deletes an existing account custom field.

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
customFieldId
optionsOptions for modifying the behavior of the function.
Returns
ApiResponse of Object(void)

◆ DeleteENoteConfiguration()

void DocuSign.eSign.Api.AccountsApi.DeleteENoteConfiguration ( string  accountId)
inline

Deletes configuration information for the eNote eOriginal integration.

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
Returns

Implements DocuSign.eSign.Api.IAccountsApi.

◆ DeleteENoteConfigurationAsync()

async System.Threading.Tasks.Task DocuSign.eSign.Api.AccountsApi.DeleteENoteConfigurationAsync ( string  accountId)
inline

Deletes configuration information for the eNote eOriginal integration.

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
Returns
Task of void

Implements DocuSign.eSign.Api.IAccountsApi.

◆ DeleteENoteConfigurationAsyncWithHttpInfo()

async System.Threading.Tasks.Task<ApiResponse<Object> > DocuSign.eSign.Api.AccountsApi.DeleteENoteConfigurationAsyncWithHttpInfo ( string  accountId)
inline

Deletes configuration information for the eNote eOriginal integration.

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
Returns
Task of ApiResponse

Implements DocuSign.eSign.Api.IAccountsApi.

◆ DeleteENoteConfigurationWithHttpInfo()

ApiResponse<Object> DocuSign.eSign.Api.AccountsApi.DeleteENoteConfigurationWithHttpInfo ( string  accountId)
inline

Deletes configuration information for the eNote eOriginal integration.

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
Returns
ApiResponse of Object(void)

Implements DocuSign.eSign.Api.IAccountsApi.

◆ DeletePermissionProfile()

void DocuSign.eSign.Api.AccountsApi.DeletePermissionProfile ( string  accountId,
string  permissionProfileId,
AccountsApi.DeletePermissionProfileOptions  options = null 
)
inline

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 &#x60;move_users_to&#x60; query parameter. ### Related topics - How to delete a permission profile

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
permissionProfileId
optionsOptions for modifying the behavior of the function.
Returns

◆ DeletePermissionProfileAsync()

async System.Threading.Tasks.Task DocuSign.eSign.Api.AccountsApi.DeletePermissionProfileAsync ( string  accountId,
string  permissionProfileId,
AccountsApi.DeletePermissionProfileOptions  options = null 
)
inline

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 &#x60;move_users_to&#x60; query parameter. ### Related topics - How to delete a permission profile

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
permissionProfileId
optionsOptions for modifying the behavior of the function.
Returns
Task of void

◆ DeletePermissionProfileAsyncWithHttpInfo()

async System.Threading.Tasks.Task<ApiResponse<Object> > DocuSign.eSign.Api.AccountsApi.DeletePermissionProfileAsyncWithHttpInfo ( string  accountId,
string  permissionProfileId,
AccountsApi.DeletePermissionProfileOptions  options = null 
)
inline

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 &#x60;move_users_to&#x60; query parameter. ### Related topics - How to delete a permission profile

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
permissionProfileId
optionsOptions for modifying the behavior of the function.
Returns
Task of ApiResponse

◆ DeletePermissionProfileWithHttpInfo()

ApiResponse<Object> DocuSign.eSign.Api.AccountsApi.DeletePermissionProfileWithHttpInfo ( string  accountId,
string  permissionProfileId,
AccountsApi.DeletePermissionProfileOptions  options = null 
)
inline

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 &#x60;move_users_to&#x60; query parameter. ### Related topics - How to delete a permission profile

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
permissionProfileId
optionsOptions for modifying the behavior of the function.
Returns
ApiResponse of Object(void)

◆ DeleteUserAuthorization()

void DocuSign.eSign.Api.AccountsApi.DeleteUserAuthorization ( string  accountId,
string  userId,
string  authorizationId 
)
inline

Deletes the user authorization

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
userIdThe user ID of the user being accessed. Generally this is the user ID of the authenticated user, but if the authenticated user is an Admin on the account, this may be another user the Admin user is accessing.
authorizationId
Returns

Implements DocuSign.eSign.Api.IAccountsApi.

◆ DeleteUserAuthorizationAsync()

async System.Threading.Tasks.Task DocuSign.eSign.Api.AccountsApi.DeleteUserAuthorizationAsync ( string  accountId,
string  userId,
string  authorizationId 
)
inline

Deletes the user authorization

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
userIdThe user ID of the user being accessed. Generally this is the user ID of the authenticated user, but if the authenticated user is an Admin on the account, this may be another user the Admin user is accessing.
authorizationId
Returns
Task of void

Implements DocuSign.eSign.Api.IAccountsApi.

◆ DeleteUserAuthorizationAsyncWithHttpInfo()

async System.Threading.Tasks.Task<ApiResponse<Object> > DocuSign.eSign.Api.AccountsApi.DeleteUserAuthorizationAsyncWithHttpInfo ( string  accountId,
string  userId,
string  authorizationId 
)
inline

Deletes the user authorization

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
userIdThe user ID of the user being accessed. Generally this is the user ID of the authenticated user, but if the authenticated user is an Admin on the account, this may be another user the Admin user is accessing.
authorizationId
Returns
Task of ApiResponse

Implements DocuSign.eSign.Api.IAccountsApi.

◆ DeleteUserAuthorizations()

UserAuthorizationsDeleteResponse DocuSign.eSign.Api.AccountsApi.DeleteUserAuthorizations ( string  accountId,
string  userId,
UserAuthorizationsDeleteRequest  userAuthorizationsDeleteRequest = null 
)
inline

Creates ot updates user authorizations

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
userIdThe user ID of the user being accessed. Generally this is the user ID of the authenticated user, but if the authenticated user is an Admin on the account, this may be another user the Admin user is accessing.
userAuthorizationsDeleteRequest(optional)
Returns
UserAuthorizationsDeleteResponse

Implements DocuSign.eSign.Api.IAccountsApi.

◆ DeleteUserAuthorizationsAsync()

async System.Threading.Tasks.Task<UserAuthorizationsDeleteResponse> DocuSign.eSign.Api.AccountsApi.DeleteUserAuthorizationsAsync ( string  accountId,
string  userId,
UserAuthorizationsDeleteRequest  userAuthorizationsDeleteRequest = null 
)
inline

Creates ot updates user authorizations

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
userIdThe user ID of the user being accessed. Generally this is the user ID of the authenticated user, but if the authenticated user is an Admin on the account, this may be another user the Admin user is accessing.
userAuthorizationsDeleteRequest(optional)
Returns
Task of UserAuthorizationsDeleteResponse

Implements DocuSign.eSign.Api.IAccountsApi.

◆ DeleteUserAuthorizationsAsyncWithHttpInfo()

async System.Threading.Tasks.Task<ApiResponse<UserAuthorizationsDeleteResponse> > DocuSign.eSign.Api.AccountsApi.DeleteUserAuthorizationsAsyncWithHttpInfo ( string  accountId,
string  userId,
UserAuthorizationsDeleteRequest  userAuthorizationsDeleteRequest = null 
)
inline

Creates ot updates user authorizations

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
userIdThe user ID of the user being accessed. Generally this is the user ID of the authenticated user, but if the authenticated user is an Admin on the account, this may be another user the Admin user is accessing.
userAuthorizationsDeleteRequest(optional)
Returns
Task of ApiResponse (UserAuthorizationsDeleteResponse)

Implements DocuSign.eSign.Api.IAccountsApi.

◆ DeleteUserAuthorizationsWithHttpInfo()

ApiResponse<UserAuthorizationsDeleteResponse> DocuSign.eSign.Api.AccountsApi.DeleteUserAuthorizationsWithHttpInfo ( string  accountId,
string  userId,
UserAuthorizationsDeleteRequest  userAuthorizationsDeleteRequest = null 
)
inline

Creates ot updates user authorizations

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
userIdThe user ID of the user being accessed. Generally this is the user ID of the authenticated user, but if the authenticated user is an Admin on the account, this may be another user the Admin user is accessing.
userAuthorizationsDeleteRequest(optional)
Returns
ApiResponse of UserAuthorizationsDeleteResponse

Implements DocuSign.eSign.Api.IAccountsApi.

◆ DeleteUserAuthorizationWithHttpInfo()

ApiResponse<Object> DocuSign.eSign.Api.AccountsApi.DeleteUserAuthorizationWithHttpInfo ( string  accountId,
string  userId,
string  authorizationId 
)
inline

Deletes the user authorization

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
userIdThe user ID of the user being accessed. Generally this is the user ID of the authenticated user, but if the authenticated user is an Admin on the account, this may be another user the Admin user is accessing.
authorizationId
Returns
ApiResponse of Object(void)

Implements DocuSign.eSign.Api.IAccountsApi.

◆ DeleteWithHttpInfo()

ApiResponse<Object> DocuSign.eSign.Api.AccountsApi.DeleteWithHttpInfo ( string  accountId)
inline

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.

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
Returns
ApiResponse of Object(void)

Implements DocuSign.eSign.Api.IAccountsApi.

◆ GetAccountIdentityVerification()

AccountIdentityVerificationResponse DocuSign.eSign.Api.AccountsApi.GetAccountIdentityVerification ( string  accountId)
inline

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

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
Returns
AccountIdentityVerificationResponse

Implements DocuSign.eSign.Api.IAccountsApi.

◆ GetAccountIdentityVerificationAsync()

async System.Threading.Tasks.Task<AccountIdentityVerificationResponse> DocuSign.eSign.Api.AccountsApi.GetAccountIdentityVerificationAsync ( string  accountId)
inline

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

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
Returns
Task of AccountIdentityVerificationResponse

Implements DocuSign.eSign.Api.IAccountsApi.

◆ GetAccountIdentityVerificationAsyncWithHttpInfo()

async System.Threading.Tasks.Task<ApiResponse<AccountIdentityVerificationResponse> > DocuSign.eSign.Api.AccountsApi.GetAccountIdentityVerificationAsyncWithHttpInfo ( string  accountId)
inline

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

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
Returns
Task of ApiResponse (AccountIdentityVerificationResponse)

Implements DocuSign.eSign.Api.IAccountsApi.

◆ GetAccountIdentityVerificationWithHttpInfo()

ApiResponse<AccountIdentityVerificationResponse> DocuSign.eSign.Api.AccountsApi.GetAccountIdentityVerificationWithHttpInfo ( string  accountId)
inline

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

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
Returns
ApiResponse of AccountIdentityVerificationResponse

Implements DocuSign.eSign.Api.IAccountsApi.

◆ GetAccountInformation()

AccountInformation DocuSign.eSign.Api.AccountsApi.GetAccountInformation ( string  accountId,
AccountsApi.GetAccountInformationOptions  options = null 
)
inline

Retrieves the account information for the specified account. Retrieves the account information for the specified account. Response The &#x60;canUpgrade&#x60; property contains is a Boolean that indicates whether the account can be upgraded through the API.

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
optionsOptions for modifying the behavior of the function.
Returns
AccountInformation

◆ GetAccountInformationAsync()

async System.Threading.Tasks.Task<AccountInformation> DocuSign.eSign.Api.AccountsApi.GetAccountInformationAsync ( string  accountId,
AccountsApi.GetAccountInformationOptions  options = null 
)
inline

Retrieves the account information for the specified account. Retrieves the account information for the specified account. Response The &#x60;canUpgrade&#x60; property contains is a Boolean that indicates whether the account can be upgraded through the API.

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
optionsOptions for modifying the behavior of the function.
Returns
Task of AccountInformation

◆ GetAccountInformationAsyncWithHttpInfo()

async System.Threading.Tasks.Task<ApiResponse<AccountInformation> > DocuSign.eSign.Api.AccountsApi.GetAccountInformationAsyncWithHttpInfo ( string  accountId,
AccountsApi.GetAccountInformationOptions  options = null 
)
inline

Retrieves the account information for the specified account. Retrieves the account information for the specified account. Response The &#x60;canUpgrade&#x60; property contains is a Boolean that indicates whether the account can be upgraded through the API.

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
optionsOptions for modifying the behavior of the function.
Returns
Task of ApiResponse (AccountInformation)

◆ GetAccountInformationWithHttpInfo()

ApiResponse<AccountInformation> DocuSign.eSign.Api.AccountsApi.GetAccountInformationWithHttpInfo ( string  accountId,
AccountsApi.GetAccountInformationOptions  options = null 
)
inline

Retrieves the account information for the specified account. Retrieves the account information for the specified account. Response The &#x60;canUpgrade&#x60; property contains is a Boolean that indicates whether the account can be upgraded through the API.

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
optionsOptions for modifying the behavior of the function.
Returns
ApiResponse of AccountInformation

◆ GetAccountSignature()

AccountSignature DocuSign.eSign.Api.AccountsApi.GetAccountSignature ( string  accountId,
string  signatureId 
)
inline

Returns information about a single signature by specifed signatureId.

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
signatureIdThe ID of the signature being accessed.
Returns
AccountSignature

Implements DocuSign.eSign.Api.IAccountsApi.

◆ GetAccountSignatureAsync()

async System.Threading.Tasks.Task<AccountSignature> DocuSign.eSign.Api.AccountsApi.GetAccountSignatureAsync ( string  accountId,
string  signatureId 
)
inline

Returns information about a single signature by specifed signatureId.

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
signatureIdThe ID of the signature being accessed.
Returns
Task of AccountSignature

Implements DocuSign.eSign.Api.IAccountsApi.

◆ GetAccountSignatureAsyncWithHttpInfo()

async System.Threading.Tasks.Task<ApiResponse<AccountSignature> > DocuSign.eSign.Api.AccountsApi.GetAccountSignatureAsyncWithHttpInfo ( string  accountId,
string  signatureId 
)
inline

Returns information about a single signature by specifed signatureId.

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
signatureIdThe ID of the signature being accessed.
Returns
Task of ApiResponse (AccountSignature)

Implements DocuSign.eSign.Api.IAccountsApi.

◆ GetAccountSignatureImage()

System.IO.Stream DocuSign.eSign.Api.AccountsApi.GetAccountSignatureImage ( string  accountId,
string  signatureId,
string  imageType,
AccountsApi.GetAccountSignatureImageOptions  options = null 
)
inline

Returns a signature, initials, or stamps image.

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
signatureIdThe ID of the signature being accessed.
imageTypeOne of signature_image or initials_image.
optionsOptions for modifying the behavior of the function.
Returns
System.IO.Stream

◆ GetAccountSignatureImageAsync()

async System.Threading.Tasks.Task<System.IO.Stream> DocuSign.eSign.Api.AccountsApi.GetAccountSignatureImageAsync ( string  accountId,
string  signatureId,
string  imageType,
AccountsApi.GetAccountSignatureImageOptions  options = null 
)
inline

Returns a signature, initials, or stamps image.

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
signatureIdThe ID of the signature being accessed.
imageTypeOne of signature_image or initials_image.
optionsOptions for modifying the behavior of the function.
Returns
Task of System.IO.Stream

◆ GetAccountSignatureImageAsyncWithHttpInfo()

async System.Threading.Tasks.Task<ApiResponse<System.IO.Stream> > DocuSign.eSign.Api.AccountsApi.GetAccountSignatureImageAsyncWithHttpInfo ( string  accountId,
string  signatureId,
string  imageType,
AccountsApi.GetAccountSignatureImageOptions  options = null 
)
inline

Returns a signature, initials, or stamps image.

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
signatureIdThe ID of the signature being accessed.
imageTypeOne of signature_image or initials_image.
optionsOptions for modifying the behavior of the function.
Returns
Task of ApiResponse (System.IO.Stream)

◆ GetAccountSignatureImageWithHttpInfo()

ApiResponse<System.IO.Stream> DocuSign.eSign.Api.AccountsApi.GetAccountSignatureImageWithHttpInfo ( string  accountId,
string  signatureId,
string  imageType,
AccountsApi.GetAccountSignatureImageOptions  options = null 
)
inline

Returns a signature, initials, or stamps image.

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
signatureIdThe ID of the signature being accessed.
imageTypeOne of signature_image or initials_image.
optionsOptions for modifying the behavior of the function.
Returns
ApiResponse of System.IO.Stream

◆ GetAccountSignatures()

AccountSignaturesInformation DocuSign.eSign.Api.AccountsApi.GetAccountSignatures ( string  accountId,
AccountsApi.GetAccountSignaturesOptions  options = null 
)
inline

Returns the managed signature definitions for the account

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
optionsOptions for modifying the behavior of the function.
Returns
AccountSignaturesInformation

◆ GetAccountSignaturesAsync()

async System.Threading.Tasks.Task<AccountSignaturesInformation> DocuSign.eSign.Api.AccountsApi.GetAccountSignaturesAsync ( string  accountId,
AccountsApi.GetAccountSignaturesOptions  options = null 
)
inline

Returns the managed signature definitions for the account

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
optionsOptions for modifying the behavior of the function.
Returns
Task of AccountSignaturesInformation

◆ GetAccountSignaturesAsyncWithHttpInfo()

async System.Threading.Tasks.Task<ApiResponse<AccountSignaturesInformation> > DocuSign.eSign.Api.AccountsApi.GetAccountSignaturesAsyncWithHttpInfo ( string  accountId,
AccountsApi.GetAccountSignaturesOptions  options = null 
)
inline

Returns the managed signature definitions for the account

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
optionsOptions for modifying the behavior of the function.
Returns
Task of ApiResponse (AccountSignaturesInformation)

◆ GetAccountSignaturesWithHttpInfo()

ApiResponse<AccountSignaturesInformation> DocuSign.eSign.Api.AccountsApi.GetAccountSignaturesWithHttpInfo ( string  accountId,
AccountsApi.GetAccountSignaturesOptions  options = null 
)
inline

Returns the managed signature definitions for the account

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
optionsOptions for modifying the behavior of the function.
Returns
ApiResponse of AccountSignaturesInformation

◆ GetAccountSignatureWithHttpInfo()

ApiResponse<AccountSignature> DocuSign.eSign.Api.AccountsApi.GetAccountSignatureWithHttpInfo ( string  accountId,
string  signatureId 
)
inline

Returns information about a single signature by specifed signatureId.

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
signatureIdThe ID of the signature being accessed.
Returns
ApiResponse of AccountSignature

Implements DocuSign.eSign.Api.IAccountsApi.

◆ GetAccountTabSettings()

TabAccountSettings DocuSign.eSign.Api.AccountsApi.GetAccountTabSettings ( string  accountId)
inline

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.

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
Returns
TabAccountSettings

Implements DocuSign.eSign.Api.IAccountsApi.

◆ GetAccountTabSettingsAsync()

async System.Threading.Tasks.Task<TabAccountSettings> DocuSign.eSign.Api.AccountsApi.GetAccountTabSettingsAsync ( string  accountId)
inline

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.

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
Returns
Task of TabAccountSettings

Implements DocuSign.eSign.Api.IAccountsApi.

◆ GetAccountTabSettingsAsyncWithHttpInfo()

async System.Threading.Tasks.Task<ApiResponse<TabAccountSettings> > DocuSign.eSign.Api.AccountsApi.GetAccountTabSettingsAsyncWithHttpInfo ( string  accountId)
inline

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.

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
Returns
Task of ApiResponse (TabAccountSettings)

Implements DocuSign.eSign.Api.IAccountsApi.

◆ GetAccountTabSettingsWithHttpInfo()

ApiResponse<TabAccountSettings> DocuSign.eSign.Api.AccountsApi.GetAccountTabSettingsWithHttpInfo ( string  accountId)
inline

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.

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
Returns
ApiResponse of TabAccountSettings

Implements DocuSign.eSign.Api.IAccountsApi.

◆ GetAgentUserAuthorizations()

UserAuthorizations DocuSign.eSign.Api.AccountsApi.GetAgentUserAuthorizations ( string  accountId,
string  userId,
AccountsApi.GetAgentUserAuthorizationsOptions  options = null 
)
inline

Returns the agent user authorizations

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
userIdThe user ID of the user being accessed. Generally this is the user ID of the authenticated user, but if the authenticated user is an Admin on the account, this may be another user the Admin user is accessing.
optionsOptions for modifying the behavior of the function.
Returns
UserAuthorizations

◆ GetAgentUserAuthorizationsAsync()

async System.Threading.Tasks.Task<UserAuthorizations> DocuSign.eSign.Api.AccountsApi.GetAgentUserAuthorizationsAsync ( string  accountId,
string  userId,
AccountsApi.GetAgentUserAuthorizationsOptions  options = null 
)
inline

Returns the agent user authorizations

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
userIdThe user ID of the user being accessed. Generally this is the user ID of the authenticated user, but if the authenticated user is an Admin on the account, this may be another user the Admin user is accessing.
optionsOptions for modifying the behavior of the function.
Returns
Task of UserAuthorizations

◆ GetAgentUserAuthorizationsAsyncWithHttpInfo()

async System.Threading.Tasks.Task<ApiResponse<UserAuthorizations> > DocuSign.eSign.Api.AccountsApi.GetAgentUserAuthorizationsAsyncWithHttpInfo ( string  accountId,
string  userId,
AccountsApi.GetAgentUserAuthorizationsOptions  options = null 
)
inline

Returns the agent user authorizations

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
userIdThe user ID of the user being accessed. Generally this is the user ID of the authenticated user, but if the authenticated user is an Admin on the account, this may be another user the Admin user is accessing.
optionsOptions for modifying the behavior of the function.
Returns
Task of ApiResponse (UserAuthorizations)

◆ GetAgentUserAuthorizationsWithHttpInfo()

ApiResponse<UserAuthorizations> DocuSign.eSign.Api.AccountsApi.GetAgentUserAuthorizationsWithHttpInfo ( string  accountId,
string  userId,
AccountsApi.GetAgentUserAuthorizationsOptions  options = null 
)
inline

Returns the agent user authorizations

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
userIdThe user ID of the user being accessed. Generally this is the user ID of the authenticated user, but if the authenticated user is an Admin on the account, this may be another user the Admin user is accessing.
optionsOptions for modifying the behavior of the function.
Returns
ApiResponse of UserAuthorizations

◆ GetAllPaymentGatewayAccounts()

PaymentGatewayAccountsInfo DocuSign.eSign.Api.AccountsApi.GetAllPaymentGatewayAccounts ( string  accountId)
inline

Get all payment gateway account for the provided accountId This method returns a list of payment gateway accounts and basic information about them.

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
Returns
PaymentGatewayAccountsInfo

Implements DocuSign.eSign.Api.IAccountsApi.

◆ GetAllPaymentGatewayAccountsAsync()

async System.Threading.Tasks.Task<PaymentGatewayAccountsInfo> DocuSign.eSign.Api.AccountsApi.GetAllPaymentGatewayAccountsAsync ( string  accountId)
inline

Get all payment gateway account for the provided accountId This method returns a list of payment gateway accounts and basic information about them.

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
Returns
Task of PaymentGatewayAccountsInfo

Implements DocuSign.eSign.Api.IAccountsApi.

◆ GetAllPaymentGatewayAccountsAsyncWithHttpInfo()

async System.Threading.Tasks.Task<ApiResponse<PaymentGatewayAccountsInfo> > DocuSign.eSign.Api.AccountsApi.GetAllPaymentGatewayAccountsAsyncWithHttpInfo ( string  accountId)
inline

Get all payment gateway account for the provided accountId This method returns a list of payment gateway accounts and basic information about them.

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
Returns
Task of ApiResponse (PaymentGatewayAccountsInfo)

Implements DocuSign.eSign.Api.IAccountsApi.

◆ GetAllPaymentGatewayAccountsWithHttpInfo()

ApiResponse<PaymentGatewayAccountsInfo> DocuSign.eSign.Api.AccountsApi.GetAllPaymentGatewayAccountsWithHttpInfo ( string  accountId)
inline

Get all payment gateway account for the provided accountId This method returns a list of payment gateway accounts and basic information about them.

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
Returns
ApiResponse of PaymentGatewayAccountsInfo

Implements DocuSign.eSign.Api.IAccountsApi.

◆ GetBasePath()

String DocuSign.eSign.Api.AccountsApi.GetBasePath ( )
inline

Gets the base path of the API client.

The base path

Implements DocuSign.eSign.Client.IApiAccessor.

◆ GetBillingCharges()

BillingChargeResponse DocuSign.eSign.Api.AccountsApi.GetBillingCharges ( string  accountId,
AccountsApi.GetBillingChargesOptions  options = null 
)
inline

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

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
optionsOptions for modifying the behavior of the function.
Returns
BillingChargeResponse

◆ GetBillingChargesAsync()

async System.Threading.Tasks.Task<BillingChargeResponse> DocuSign.eSign.Api.AccountsApi.GetBillingChargesAsync ( string  accountId,
AccountsApi.GetBillingChargesOptions  options = null 
)
inline

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

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
optionsOptions for modifying the behavior of the function.
Returns
Task of BillingChargeResponse

◆ GetBillingChargesAsyncWithHttpInfo()

async System.Threading.Tasks.Task<ApiResponse<BillingChargeResponse> > DocuSign.eSign.Api.AccountsApi.GetBillingChargesAsyncWithHttpInfo ( string  accountId,
AccountsApi.GetBillingChargesOptions  options = null 
)
inline

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

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
optionsOptions for modifying the behavior of the function.
Returns
Task of ApiResponse (BillingChargeResponse)

◆ GetBillingChargesWithHttpInfo()

ApiResponse<BillingChargeResponse> DocuSign.eSign.Api.AccountsApi.GetBillingChargesWithHttpInfo ( string  accountId,
AccountsApi.GetBillingChargesOptions  options = null 
)
inline

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

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
optionsOptions for modifying the behavior of the function.
Returns
ApiResponse of BillingChargeResponse

◆ GetBrand()

Brand DocuSign.eSign.Api.AccountsApi.GetBrand ( string  accountId,
string  brandId,
AccountsApi.GetBrandOptions  options = null 
)
inline

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 (&#x60;canSelfBrandSend&#x60; , &#x60;canSelfBrandSign&#x60;, or both of these account settings must be true).

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
brandIdThe unique identifier of a brand.
optionsOptions for modifying the behavior of the function.
Returns
Brand

◆ GetBrandAsync()

async System.Threading.Tasks.Task<Brand> DocuSign.eSign.Api.AccountsApi.GetBrandAsync ( string  accountId,
string  brandId,
AccountsApi.GetBrandOptions  options = null 
)
inline

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 (&#x60;canSelfBrandSend&#x60; , &#x60;canSelfBrandSign&#x60;, or both of these account settings must be true).

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
brandIdThe unique identifier of a brand.
optionsOptions for modifying the behavior of the function.
Returns
Task of Brand

◆ GetBrandAsyncWithHttpInfo()

async System.Threading.Tasks.Task<ApiResponse<Brand> > DocuSign.eSign.Api.AccountsApi.GetBrandAsyncWithHttpInfo ( string  accountId,
string  brandId,
AccountsApi.GetBrandOptions  options = null 
)
inline

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 (&#x60;canSelfBrandSend&#x60; , &#x60;canSelfBrandSign&#x60;, or both of these account settings must be true).

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
brandIdThe unique identifier of a brand.
optionsOptions for modifying the behavior of the function.
Returns
Task of ApiResponse (Brand)

◆ GetBrandExportFile()

void DocuSign.eSign.Api.AccountsApi.GetBrandExportFile ( string  accountId,
string  brandId 
)
inline

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 (&#x60;canSelfBrandSend&#x60; , &#x60;canSelfBrandSign&#x60;, or both of these account settings must be true).

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
brandIdThe unique identifier of a brand.
Returns

Implements DocuSign.eSign.Api.IAccountsApi.

◆ GetBrandExportFileAsync()

async System.Threading.Tasks.Task DocuSign.eSign.Api.AccountsApi.GetBrandExportFileAsync ( string  accountId,
string  brandId 
)
inline

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 (&#x60;canSelfBrandSend&#x60; , &#x60;canSelfBrandSign&#x60;, or both of these account settings must be true).

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
brandIdThe unique identifier of a brand.
Returns
Task of void

Implements DocuSign.eSign.Api.IAccountsApi.

◆ GetBrandExportFileAsyncWithHttpInfo()

async System.Threading.Tasks.Task<ApiResponse<Object> > DocuSign.eSign.Api.AccountsApi.GetBrandExportFileAsyncWithHttpInfo ( string  accountId,
string  brandId 
)
inline

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 (&#x60;canSelfBrandSend&#x60; , &#x60;canSelfBrandSign&#x60;, or both of these account settings must be true).

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
brandIdThe unique identifier of a brand.
Returns
Task of ApiResponse

Implements DocuSign.eSign.Api.IAccountsApi.

◆ GetBrandExportFileWithHttpInfo()

ApiResponse<Object> DocuSign.eSign.Api.AccountsApi.GetBrandExportFileWithHttpInfo ( string  accountId,
string  brandId 
)
inline

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 (&#x60;canSelfBrandSend&#x60; , &#x60;canSelfBrandSign&#x60;, or both of these account settings must be true).

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
brandIdThe unique identifier of a brand.
Returns
ApiResponse of Object(void)

Implements DocuSign.eSign.Api.IAccountsApi.

◆ GetBrandLogoByType()

System.IO.Stream DocuSign.eSign.Api.AccountsApi.GetBrandLogoByType ( string  accountId,
string  brandId,
string  logoType 
)
inline

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 (&#x60;canSelfBrandSend&#x60; , &#x60;canSelfBrandSign&#x60;, or both of these account settings must be true).

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
brandIdThe unique identifier of a brand.
logoTypeOne of Primary, Secondary or Email.
Returns
System.IO.Stream

Implements DocuSign.eSign.Api.IAccountsApi.

◆ GetBrandLogoByTypeAsync()

async System.Threading.Tasks.Task<System.IO.Stream> DocuSign.eSign.Api.AccountsApi.GetBrandLogoByTypeAsync ( string  accountId,
string  brandId,
string  logoType 
)
inline

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 (&#x60;canSelfBrandSend&#x60; , &#x60;canSelfBrandSign&#x60;, or both of these account settings must be true).

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
brandIdThe unique identifier of a brand.
logoTypeOne of Primary, Secondary or Email.
Returns
Task of System.IO.Stream

Implements DocuSign.eSign.Api.IAccountsApi.

◆ GetBrandLogoByTypeAsyncWithHttpInfo()

async System.Threading.Tasks.Task<ApiResponse<System.IO.Stream> > DocuSign.eSign.Api.AccountsApi.GetBrandLogoByTypeAsyncWithHttpInfo ( string  accountId,
string  brandId,
string  logoType 
)
inline

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 (&#x60;canSelfBrandSend&#x60; , &#x60;canSelfBrandSign&#x60;, or both of these account settings must be true).

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
brandIdThe unique identifier of a brand.
logoTypeOne of Primary, Secondary or Email.
Returns
Task of ApiResponse (System.IO.Stream)

Implements DocuSign.eSign.Api.IAccountsApi.

◆ GetBrandLogoByTypeWithHttpInfo()

ApiResponse<System.IO.Stream> DocuSign.eSign.Api.AccountsApi.GetBrandLogoByTypeWithHttpInfo ( string  accountId,
string  brandId,
string  logoType 
)
inline

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 (&#x60;canSelfBrandSend&#x60; , &#x60;canSelfBrandSign&#x60;, or both of these account settings must be true).

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
brandIdThe unique identifier of a brand.
logoTypeOne of Primary, Secondary or Email.
Returns
ApiResponse of System.IO.Stream

Implements DocuSign.eSign.Api.IAccountsApi.

◆ GetBrandResources()

BrandResourcesList DocuSign.eSign.Api.AccountsApi.GetBrandResources ( string  accountId,
string  brandId 
)
inline

Returns the specified account&#39;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 (&#x60;canSelfBrandSend&#x60; , &#x60;canSelfBrandSign&#x60;, or both of these account settings must be true).

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
brandIdThe unique identifier of a brand.
Returns
BrandResourcesList

Implements DocuSign.eSign.Api.IAccountsApi.

◆ GetBrandResourcesAsync()

async System.Threading.Tasks.Task<BrandResourcesList> DocuSign.eSign.Api.AccountsApi.GetBrandResourcesAsync ( string  accountId,
string  brandId 
)
inline

Returns the specified account&#39;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 (&#x60;canSelfBrandSend&#x60; , &#x60;canSelfBrandSign&#x60;, or both of these account settings must be true).

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
brandIdThe unique identifier of a brand.
Returns
Task of BrandResourcesList

Implements DocuSign.eSign.Api.IAccountsApi.

◆ GetBrandResourcesAsyncWithHttpInfo()

async System.Threading.Tasks.Task<ApiResponse<BrandResourcesList> > DocuSign.eSign.Api.AccountsApi.GetBrandResourcesAsyncWithHttpInfo ( string  accountId,
string  brandId 
)
inline

Returns the specified account&#39;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 (&#x60;canSelfBrandSend&#x60; , &#x60;canSelfBrandSign&#x60;, or both of these account settings must be true).

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
brandIdThe unique identifier of a brand.
Returns
Task of ApiResponse (BrandResourcesList)

Implements DocuSign.eSign.Api.IAccountsApi.

◆ GetBrandResourcesByContentType()

void DocuSign.eSign.Api.AccountsApi.GetBrandResourcesByContentType ( string  accountId,
string  brandId,
string  resourceContentType,
AccountsApi.GetBrandResourcesByContentTypeOptions  options = null 
)
inline

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 (&#x60;canSelfBrandSend&#x60; , &#x60;canSelfBrandSign&#x60;, or both of these account settings must be true).

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
brandIdThe unique identifier of a brand.
resourceContentType
optionsOptions for modifying the behavior of the function.
Returns

◆ GetBrandResourcesByContentTypeAsync()

async System.Threading.Tasks.Task DocuSign.eSign.Api.AccountsApi.GetBrandResourcesByContentTypeAsync ( string  accountId,
string  brandId,
string  resourceContentType,
AccountsApi.GetBrandResourcesByContentTypeOptions  options = null 
)
inline

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 (&#x60;canSelfBrandSend&#x60; , &#x60;canSelfBrandSign&#x60;, or both of these account settings must be true).

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
brandIdThe unique identifier of a brand.
resourceContentType
optionsOptions for modifying the behavior of the function.
Returns
Task of void

◆ GetBrandResourcesByContentTypeAsyncWithHttpInfo()

async System.Threading.Tasks.Task<ApiResponse<Object> > DocuSign.eSign.Api.AccountsApi.GetBrandResourcesByContentTypeAsyncWithHttpInfo ( string  accountId,
string  brandId,
string  resourceContentType,
AccountsApi.GetBrandResourcesByContentTypeOptions  options = null 
)
inline

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 (&#x60;canSelfBrandSend&#x60; , &#x60;canSelfBrandSign&#x60;, or both of these account settings must be true).

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
brandIdThe unique identifier of a brand.
resourceContentType
optionsOptions for modifying the behavior of the function.
Returns
Task of ApiResponse

◆ GetBrandResourcesByContentTypeWithHttpInfo()

ApiResponse<Object> DocuSign.eSign.Api.AccountsApi.GetBrandResourcesByContentTypeWithHttpInfo ( string  accountId,
string  brandId,
string  resourceContentType,
AccountsApi.GetBrandResourcesByContentTypeOptions  options = null 
)
inline

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 (&#x60;canSelfBrandSend&#x60; , &#x60;canSelfBrandSign&#x60;, or both of these account settings must be true).

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
brandIdThe unique identifier of a brand.
resourceContentType
optionsOptions for modifying the behavior of the function.
Returns
ApiResponse of Object(void)

◆ GetBrandResourcesWithHttpInfo()

ApiResponse<BrandResourcesList> DocuSign.eSign.Api.AccountsApi.GetBrandResourcesWithHttpInfo ( string  accountId,
string  brandId 
)
inline

Returns the specified account&#39;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 (&#x60;canSelfBrandSend&#x60; , &#x60;canSelfBrandSign&#x60;, or both of these account settings must be true).

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
brandIdThe unique identifier of a brand.
Returns
ApiResponse of BrandResourcesList

Implements DocuSign.eSign.Api.IAccountsApi.

◆ GetBrandWithHttpInfo()

ApiResponse<Brand> DocuSign.eSign.Api.AccountsApi.GetBrandWithHttpInfo ( string  accountId,
string  brandId,
AccountsApi.GetBrandOptions  options = null 
)
inline

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 (&#x60;canSelfBrandSend&#x60; , &#x60;canSelfBrandSign&#x60;, or both of these account settings must be true).

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
brandIdThe unique identifier of a brand.
optionsOptions for modifying the behavior of the function.
Returns
ApiResponse of Brand

◆ GetConsumerDisclosure()

ConsumerDisclosure DocuSign.eSign.Api.AccountsApi.GetConsumerDisclosure ( string  accountId,
string  langCode 
)
inline

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.

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
langCodeThe simple type enumeration the language used in the response. The supported languages, with the language value shown in parenthesis, are:Arabic (ar), Armenian (hy), 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.
Returns
ConsumerDisclosure

Implements DocuSign.eSign.Api.IAccountsApi.

◆ GetConsumerDisclosureAsync()

async System.Threading.Tasks.Task<ConsumerDisclosure> DocuSign.eSign.Api.AccountsApi.GetConsumerDisclosureAsync ( string  accountId,
string  langCode 
)
inline

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.

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
langCodeThe simple type enumeration the language used in the response. The supported languages, with the language value shown in parenthesis, are:Arabic (ar), Armenian (hy), 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.
Returns
Task of ConsumerDisclosure

Implements DocuSign.eSign.Api.IAccountsApi.

◆ GetConsumerDisclosureAsyncWithHttpInfo()

async System.Threading.Tasks.Task<ApiResponse<ConsumerDisclosure> > DocuSign.eSign.Api.AccountsApi.GetConsumerDisclosureAsyncWithHttpInfo ( string  accountId,
string  langCode 
)
inline

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.

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
langCodeThe simple type enumeration the language used in the response. The supported languages, with the language value shown in parenthesis, are:Arabic (ar), Armenian (hy), 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.
Returns
Task of ApiResponse (ConsumerDisclosure)

Implements DocuSign.eSign.Api.IAccountsApi.

◆ GetConsumerDisclosureDefault()

ConsumerDisclosure DocuSign.eSign.Api.AccountsApi.GetConsumerDisclosureDefault ( string  accountId,
AccountsApi.GetConsumerDisclosureDefaultOptions  options = null 
)
inline

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.

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
optionsOptions for modifying the behavior of the function.
Returns
ConsumerDisclosure

◆ GetConsumerDisclosureDefaultAsync()

async System.Threading.Tasks.Task<ConsumerDisclosure> DocuSign.eSign.Api.AccountsApi.GetConsumerDisclosureDefaultAsync ( string  accountId,
AccountsApi.GetConsumerDisclosureDefaultOptions  options = null 
)
inline

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.

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
optionsOptions for modifying the behavior of the function.
Returns
Task of ConsumerDisclosure

◆ GetConsumerDisclosureDefaultAsyncWithHttpInfo()

async System.Threading.Tasks.Task<ApiResponse<ConsumerDisclosure> > DocuSign.eSign.Api.AccountsApi.GetConsumerDisclosureDefaultAsyncWithHttpInfo ( string  accountId,
AccountsApi.GetConsumerDisclosureDefaultOptions  options = null 
)
inline

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.

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
optionsOptions for modifying the behavior of the function.
Returns
Task of ApiResponse (ConsumerDisclosure)

◆ GetConsumerDisclosureDefaultWithHttpInfo()

ApiResponse<ConsumerDisclosure> DocuSign.eSign.Api.AccountsApi.GetConsumerDisclosureDefaultWithHttpInfo ( string  accountId,
AccountsApi.GetConsumerDisclosureDefaultOptions  options = null 
)
inline

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.

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
optionsOptions for modifying the behavior of the function.
Returns
ApiResponse of ConsumerDisclosure

◆ GetConsumerDisclosureWithHttpInfo()

ApiResponse<ConsumerDisclosure> DocuSign.eSign.Api.AccountsApi.GetConsumerDisclosureWithHttpInfo ( string  accountId,
string  langCode 
)
inline

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.

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
langCodeThe simple type enumeration the language used in the response. The supported languages, with the language value shown in parenthesis, are:Arabic (ar), Armenian (hy), 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.
Returns
ApiResponse of ConsumerDisclosure

Implements DocuSign.eSign.Api.IAccountsApi.

◆ GetENoteConfiguration()

ENoteConfiguration DocuSign.eSign.Api.AccountsApi.GetENoteConfiguration ( string  accountId)
inline

Returns the configuration information for the eNote eOriginal integration.

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
Returns
ENoteConfiguration

Implements DocuSign.eSign.Api.IAccountsApi.

◆ GetENoteConfigurationAsync()

async System.Threading.Tasks.Task<ENoteConfiguration> DocuSign.eSign.Api.AccountsApi.GetENoteConfigurationAsync ( string  accountId)
inline

Returns the configuration information for the eNote eOriginal integration.

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
Returns
Task of ENoteConfiguration

Implements DocuSign.eSign.Api.IAccountsApi.

◆ GetENoteConfigurationAsyncWithHttpInfo()

async System.Threading.Tasks.Task<ApiResponse<ENoteConfiguration> > DocuSign.eSign.Api.AccountsApi.GetENoteConfigurationAsyncWithHttpInfo ( string  accountId)
inline

Returns the configuration information for the eNote eOriginal integration.

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
Returns
Task of ApiResponse (ENoteConfiguration)

Implements DocuSign.eSign.Api.IAccountsApi.

◆ GetENoteConfigurationWithHttpInfo()

ApiResponse<ENoteConfiguration> DocuSign.eSign.Api.AccountsApi.GetENoteConfigurationWithHttpInfo ( string  accountId)
inline

Returns the configuration information for the eNote eOriginal integration.

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
Returns
ApiResponse of ENoteConfiguration

Implements DocuSign.eSign.Api.IAccountsApi.

◆ GetEnvelopePurgeConfiguration()

EnvelopePurgeConfiguration DocuSign.eSign.Api.AccountsApi.GetEnvelopePurgeConfiguration ( string  accountId)
inline

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 (&#x60;retentionDays&#x60;). This method retrieves the current envelope purge configuration for your account. Note: To use this method, you must be an account administrator.

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
Returns
EnvelopePurgeConfiguration

Implements DocuSign.eSign.Api.IAccountsApi.

◆ GetEnvelopePurgeConfigurationAsync()

async System.Threading.Tasks.Task<EnvelopePurgeConfiguration> DocuSign.eSign.Api.AccountsApi.GetEnvelopePurgeConfigurationAsync ( string  accountId)
inline

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 (&#x60;retentionDays&#x60;). This method retrieves the current envelope purge configuration for your account. Note: To use this method, you must be an account administrator.

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
Returns
Task of EnvelopePurgeConfiguration

Implements DocuSign.eSign.Api.IAccountsApi.

◆ GetEnvelopePurgeConfigurationAsyncWithHttpInfo()

async System.Threading.Tasks.Task<ApiResponse<EnvelopePurgeConfiguration> > DocuSign.eSign.Api.AccountsApi.GetEnvelopePurgeConfigurationAsyncWithHttpInfo ( string  accountId)
inline

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 (&#x60;retentionDays&#x60;). This method retrieves the current envelope purge configuration for your account. Note: To use this method, you must be an account administrator.

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
Returns
Task of ApiResponse (EnvelopePurgeConfiguration)

Implements DocuSign.eSign.Api.IAccountsApi.

◆ GetEnvelopePurgeConfigurationWithHttpInfo()

ApiResponse<EnvelopePurgeConfiguration> DocuSign.eSign.Api.AccountsApi.GetEnvelopePurgeConfigurationWithHttpInfo ( string  accountId)
inline

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 (&#x60;retentionDays&#x60;). This method retrieves the current envelope purge configuration for your account. Note: To use this method, you must be an account administrator.

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
Returns
ApiResponse of EnvelopePurgeConfiguration

Implements DocuSign.eSign.Api.IAccountsApi.

◆ GetFavoriteTemplates()

FavoriteTemplatesInfo DocuSign.eSign.Api.AccountsApi.GetFavoriteTemplates ( string  accountId)
inline

Retrieves the list of favorited templates for this caller

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
Returns
FavoriteTemplatesInfo

Implements DocuSign.eSign.Api.IAccountsApi.

◆ GetFavoriteTemplatesAsync()

async System.Threading.Tasks.Task<FavoriteTemplatesInfo> DocuSign.eSign.Api.AccountsApi.GetFavoriteTemplatesAsync ( string  accountId)
inline

Retrieves the list of favorited templates for this caller

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
Returns
Task of FavoriteTemplatesInfo

Implements DocuSign.eSign.Api.IAccountsApi.

◆ GetFavoriteTemplatesAsyncWithHttpInfo()

async System.Threading.Tasks.Task<ApiResponse<FavoriteTemplatesInfo> > DocuSign.eSign.Api.AccountsApi.GetFavoriteTemplatesAsyncWithHttpInfo ( string  accountId)
inline

Retrieves the list of favorited templates for this caller

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
Returns
Task of ApiResponse (FavoriteTemplatesInfo)

Implements DocuSign.eSign.Api.IAccountsApi.

◆ GetFavoriteTemplatesWithHttpInfo()

ApiResponse<FavoriteTemplatesInfo> DocuSign.eSign.Api.AccountsApi.GetFavoriteTemplatesWithHttpInfo ( string  accountId)
inline

Retrieves the list of favorited templates for this caller

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
Returns
ApiResponse of FavoriteTemplatesInfo

Implements DocuSign.eSign.Api.IAccountsApi.

◆ GetNotificationDefaults()

NotificationDefaults DocuSign.eSign.Api.AccountsApi.GetNotificationDefaults ( string  accountId)
inline

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.

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
Returns
NotificationDefaults

Implements DocuSign.eSign.Api.IAccountsApi.

◆ GetNotificationDefaultsAsync()

async System.Threading.Tasks.Task<NotificationDefaults> DocuSign.eSign.Api.AccountsApi.GetNotificationDefaultsAsync ( string  accountId)
inline

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.

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
Returns
Task of NotificationDefaults

Implements DocuSign.eSign.Api.IAccountsApi.

◆ GetNotificationDefaultsAsyncWithHttpInfo()

async System.Threading.Tasks.Task<ApiResponse<NotificationDefaults> > DocuSign.eSign.Api.AccountsApi.GetNotificationDefaultsAsyncWithHttpInfo ( string  accountId)
inline

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.

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
Returns
Task of ApiResponse (NotificationDefaults)

Implements DocuSign.eSign.Api.IAccountsApi.

◆ GetNotificationDefaultsWithHttpInfo()

ApiResponse<NotificationDefaults> DocuSign.eSign.Api.AccountsApi.GetNotificationDefaultsWithHttpInfo ( string  accountId)
inline

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.

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
Returns
ApiResponse of NotificationDefaults

Implements DocuSign.eSign.Api.IAccountsApi.

◆ GetPasswordRules()

AccountPasswordRules DocuSign.eSign.Api.AccountsApi.GetPasswordRules ( string  accountId)
inline

Get the password rules This method retrieves the password rules for an account.

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
Returns
AccountPasswordRules

Implements DocuSign.eSign.Api.IAccountsApi.

◆ GetPasswordRules_0()

UserPasswordRules DocuSign.eSign.Api.AccountsApi.GetPasswordRules_0 ( )
inline

Get membership account password rules

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Returns
UserPasswordRules

Implements DocuSign.eSign.Api.IAccountsApi.

◆ GetPasswordRules_0Async()

async System.Threading.Tasks.Task<UserPasswordRules> DocuSign.eSign.Api.AccountsApi.GetPasswordRules_0Async ( )
inline

Get membership account password rules

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Returns
Task of UserPasswordRules

Implements DocuSign.eSign.Api.IAccountsApi.

◆ GetPasswordRules_0AsyncWithHttpInfo()

async System.Threading.Tasks.Task<ApiResponse<UserPasswordRules> > DocuSign.eSign.Api.AccountsApi.GetPasswordRules_0AsyncWithHttpInfo ( )
inline

Get membership account password rules

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Returns
Task of ApiResponse (UserPasswordRules)

Implements DocuSign.eSign.Api.IAccountsApi.

◆ GetPasswordRules_0WithHttpInfo()

ApiResponse<UserPasswordRules> DocuSign.eSign.Api.AccountsApi.GetPasswordRules_0WithHttpInfo ( )
inline

Get membership account password rules

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Returns
ApiResponse of UserPasswordRules

Implements DocuSign.eSign.Api.IAccountsApi.

◆ GetPasswordRulesAsync()

async System.Threading.Tasks.Task<AccountPasswordRules> DocuSign.eSign.Api.AccountsApi.GetPasswordRulesAsync ( string  accountId)
inline

Get the password rules This method retrieves the password rules for an account.

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
Returns
Task of AccountPasswordRules

Implements DocuSign.eSign.Api.IAccountsApi.

◆ GetPasswordRulesAsyncWithHttpInfo()

async System.Threading.Tasks.Task<ApiResponse<AccountPasswordRules> > DocuSign.eSign.Api.AccountsApi.GetPasswordRulesAsyncWithHttpInfo ( string  accountId)
inline

Get the password rules This method retrieves the password rules for an account.

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
Returns
Task of ApiResponse (AccountPasswordRules)

Implements DocuSign.eSign.Api.IAccountsApi.

◆ GetPasswordRulesWithHttpInfo()

ApiResponse<AccountPasswordRules> DocuSign.eSign.Api.AccountsApi.GetPasswordRulesWithHttpInfo ( string  accountId)
inline

Get the password rules This method retrieves the password rules for an account.

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
Returns
ApiResponse of AccountPasswordRules

Implements DocuSign.eSign.Api.IAccountsApi.

◆ GetPermissionProfile()

PermissionProfile DocuSign.eSign.Api.AccountsApi.GetPermissionProfile ( string  accountId,
string  permissionProfileId,
AccountsApi.GetPermissionProfileOptions  options = null 
)
inline

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

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
permissionProfileId
optionsOptions for modifying the behavior of the function.
Returns
PermissionProfile

◆ GetPermissionProfileAsync()

async System.Threading.Tasks.Task<PermissionProfile> DocuSign.eSign.Api.AccountsApi.GetPermissionProfileAsync ( string  accountId,
string  permissionProfileId,
AccountsApi.GetPermissionProfileOptions  options = null 
)
inline

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

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
permissionProfileId
optionsOptions for modifying the behavior of the function.
Returns
Task of PermissionProfile

◆ GetPermissionProfileAsyncWithHttpInfo()

async System.Threading.Tasks.Task<ApiResponse<PermissionProfile> > DocuSign.eSign.Api.AccountsApi.GetPermissionProfileAsyncWithHttpInfo ( string  accountId,
string  permissionProfileId,
AccountsApi.GetPermissionProfileOptions  options = null 
)
inline

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

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
permissionProfileId
optionsOptions for modifying the behavior of the function.
Returns
Task of ApiResponse (PermissionProfile)

◆ GetPermissionProfileWithHttpInfo()

ApiResponse<PermissionProfile> DocuSign.eSign.Api.AccountsApi.GetPermissionProfileWithHttpInfo ( string  accountId,
string  permissionProfileId,
AccountsApi.GetPermissionProfileOptions  options = null 
)
inline

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

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
permissionProfileId
optionsOptions for modifying the behavior of the function.
Returns
ApiResponse of PermissionProfile

◆ GetPrincipalUserAuthorizations()

UserAuthorizations DocuSign.eSign.Api.AccountsApi.GetPrincipalUserAuthorizations ( string  accountId,
string  userId,
AccountsApi.GetPrincipalUserAuthorizationsOptions  options = null 
)
inline

Returns the principal user authorizations

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
userIdThe user ID of the user being accessed. Generally this is the user ID of the authenticated user, but if the authenticated user is an Admin on the account, this may be another user the Admin user is accessing.
optionsOptions for modifying the behavior of the function.
Returns
UserAuthorizations

◆ GetPrincipalUserAuthorizationsAsync()

async System.Threading.Tasks.Task<UserAuthorizations> DocuSign.eSign.Api.AccountsApi.GetPrincipalUserAuthorizationsAsync ( string  accountId,
string  userId,
AccountsApi.GetPrincipalUserAuthorizationsOptions  options = null 
)
inline

Returns the principal user authorizations

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
userIdThe user ID of the user being accessed. Generally this is the user ID of the authenticated user, but if the authenticated user is an Admin on the account, this may be another user the Admin user is accessing.
optionsOptions for modifying the behavior of the function.
Returns
Task of UserAuthorizations

◆ GetPrincipalUserAuthorizationsAsyncWithHttpInfo()

async System.Threading.Tasks.Task<ApiResponse<UserAuthorizations> > DocuSign.eSign.Api.AccountsApi.GetPrincipalUserAuthorizationsAsyncWithHttpInfo ( string  accountId,
string  userId,
AccountsApi.GetPrincipalUserAuthorizationsOptions  options = null 
)
inline

Returns the principal user authorizations

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
userIdThe user ID of the user being accessed. Generally this is the user ID of the authenticated user, but if the authenticated user is an Admin on the account, this may be another user the Admin user is accessing.
optionsOptions for modifying the behavior of the function.
Returns
Task of ApiResponse (UserAuthorizations)

◆ GetPrincipalUserAuthorizationsWithHttpInfo()

ApiResponse<UserAuthorizations> DocuSign.eSign.Api.AccountsApi.GetPrincipalUserAuthorizationsWithHttpInfo ( string  accountId,
string  userId,
AccountsApi.GetPrincipalUserAuthorizationsOptions  options = null 
)
inline

Returns the principal user authorizations

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
userIdThe user ID of the user being accessed. Generally this is the user ID of the authenticated user, but if the authenticated user is an Admin on the account, this may be another user the Admin user is accessing.
optionsOptions for modifying the behavior of the function.
Returns
ApiResponse of UserAuthorizations

◆ GetProvisioning()

ProvisioningInformation DocuSign.eSign.Api.AccountsApi.GetProvisioning ( )
inline

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

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Returns
ProvisioningInformation

Implements DocuSign.eSign.Api.IAccountsApi.

◆ GetProvisioningAsync()

async System.Threading.Tasks.Task<ProvisioningInformation> DocuSign.eSign.Api.AccountsApi.GetProvisioningAsync ( )
inline

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

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Returns
Task of ProvisioningInformation

Implements DocuSign.eSign.Api.IAccountsApi.

◆ GetProvisioningAsyncWithHttpInfo()

async System.Threading.Tasks.Task<ApiResponse<ProvisioningInformation> > DocuSign.eSign.Api.AccountsApi.GetProvisioningAsyncWithHttpInfo ( )
inline

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

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Returns
Task of ApiResponse (ProvisioningInformation)

Implements DocuSign.eSign.Api.IAccountsApi.

◆ GetProvisioningWithHttpInfo()

ApiResponse<ProvisioningInformation> DocuSign.eSign.Api.AccountsApi.GetProvisioningWithHttpInfo ( )
inline

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

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Returns
ApiResponse of ProvisioningInformation

Implements DocuSign.eSign.Api.IAccountsApi.

◆ GetSupportedLanguages()

SupportedLanguages DocuSign.eSign.Api.AccountsApi.GetSupportedLanguages ( string  accountId)
inline

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&#39;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 &#x60;emailBody&#x60; and &#x60;emailSubject&#x60; 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.

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
Returns
SupportedLanguages

Implements DocuSign.eSign.Api.IAccountsApi.

◆ GetSupportedLanguagesAsync()

async System.Threading.Tasks.Task<SupportedLanguages> DocuSign.eSign.Api.AccountsApi.GetSupportedLanguagesAsync ( string  accountId)
inline

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&#39;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 &#x60;emailBody&#x60; and &#x60;emailSubject&#x60; 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.

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
Returns
Task of SupportedLanguages

Implements DocuSign.eSign.Api.IAccountsApi.

◆ GetSupportedLanguagesAsyncWithHttpInfo()

async System.Threading.Tasks.Task<ApiResponse<SupportedLanguages> > DocuSign.eSign.Api.AccountsApi.GetSupportedLanguagesAsyncWithHttpInfo ( string  accountId)
inline

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&#39;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 &#x60;emailBody&#x60; and &#x60;emailSubject&#x60; 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.

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
Returns
Task of ApiResponse (SupportedLanguages)

Implements DocuSign.eSign.Api.IAccountsApi.

◆ GetSupportedLanguagesWithHttpInfo()

ApiResponse<SupportedLanguages> DocuSign.eSign.Api.AccountsApi.GetSupportedLanguagesWithHttpInfo ( string  accountId)
inline

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&#39;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 &#x60;emailBody&#x60; and &#x60;emailSubject&#x60; 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.

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
Returns
ApiResponse of SupportedLanguages

Implements DocuSign.eSign.Api.IAccountsApi.

◆ GetUserAuthorization()

UserAuthorization DocuSign.eSign.Api.AccountsApi.GetUserAuthorization ( string  accountId,
string  userId,
string  authorizationId 
)
inline

Returns the user authorization for a given authorization id

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
userIdThe user ID of the user being accessed. Generally this is the user ID of the authenticated user, but if the authenticated user is an Admin on the account, this may be another user the Admin user is accessing.
authorizationId
Returns
UserAuthorization

Implements DocuSign.eSign.Api.IAccountsApi.

◆ GetUserAuthorizationAsync()

async System.Threading.Tasks.Task<UserAuthorization> DocuSign.eSign.Api.AccountsApi.GetUserAuthorizationAsync ( string  accountId,
string  userId,
string  authorizationId 
)
inline

Returns the user authorization for a given authorization id

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
userIdThe user ID of the user being accessed. Generally this is the user ID of the authenticated user, but if the authenticated user is an Admin on the account, this may be another user the Admin user is accessing.
authorizationId
Returns
Task of UserAuthorization

Implements DocuSign.eSign.Api.IAccountsApi.

◆ GetUserAuthorizationAsyncWithHttpInfo()

async System.Threading.Tasks.Task<ApiResponse<UserAuthorization> > DocuSign.eSign.Api.AccountsApi.GetUserAuthorizationAsyncWithHttpInfo ( string  accountId,
string  userId,
string  authorizationId 
)
inline

Returns the user authorization for a given authorization id

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
userIdThe user ID of the user being accessed. Generally this is the user ID of the authenticated user, but if the authenticated user is an Admin on the account, this may be another user the Admin user is accessing.
authorizationId
Returns
Task of ApiResponse (UserAuthorization)

Implements DocuSign.eSign.Api.IAccountsApi.

◆ GetUserAuthorizationWithHttpInfo()

ApiResponse<UserAuthorization> DocuSign.eSign.Api.AccountsApi.GetUserAuthorizationWithHttpInfo ( string  accountId,
string  userId,
string  authorizationId 
)
inline

Returns the user authorization for a given authorization id

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
userIdThe user ID of the user being accessed. Generally this is the user ID of the authenticated user, but if the authenticated user is an Admin on the account, this may be another user the Admin user is accessing.
authorizationId
Returns
ApiResponse of UserAuthorization

Implements DocuSign.eSign.Api.IAccountsApi.

◆ GetWatermark()

Watermark DocuSign.eSign.Api.AccountsApi.GetWatermark ( string  accountId)
inline

Get watermark information.

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
Returns
Watermark

Implements DocuSign.eSign.Api.IAccountsApi.

◆ GetWatermarkAsync()

async System.Threading.Tasks.Task<Watermark> DocuSign.eSign.Api.AccountsApi.GetWatermarkAsync ( string  accountId)
inline

Get watermark information.

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
Returns
Task of Watermark

Implements DocuSign.eSign.Api.IAccountsApi.

◆ GetWatermarkAsyncWithHttpInfo()

async System.Threading.Tasks.Task<ApiResponse<Watermark> > DocuSign.eSign.Api.AccountsApi.GetWatermarkAsyncWithHttpInfo ( string  accountId)
inline

Get watermark information.

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
Returns
Task of ApiResponse (Watermark)

Implements DocuSign.eSign.Api.IAccountsApi.

◆ GetWatermarkPreview()

Watermark DocuSign.eSign.Api.AccountsApi.GetWatermarkPreview ( string  accountId,
Watermark  watermark = null 
)
inline

Get watermark preview.

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
watermark(optional)
Returns
Watermark

Implements DocuSign.eSign.Api.IAccountsApi.

◆ GetWatermarkPreviewAsync()

async System.Threading.Tasks.Task<Watermark> DocuSign.eSign.Api.AccountsApi.GetWatermarkPreviewAsync ( string  accountId,
Watermark  watermark = null 
)
inline

Get watermark preview.

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
watermark(optional)
Returns
Task of Watermark

Implements DocuSign.eSign.Api.IAccountsApi.

◆ GetWatermarkPreviewAsyncWithHttpInfo()

async System.Threading.Tasks.Task<ApiResponse<Watermark> > DocuSign.eSign.Api.AccountsApi.GetWatermarkPreviewAsyncWithHttpInfo ( string  accountId,
Watermark  watermark = null 
)
inline

Get watermark preview.

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
watermark(optional)
Returns
Task of ApiResponse (Watermark)

Implements DocuSign.eSign.Api.IAccountsApi.

◆ GetWatermarkPreviewWithHttpInfo()

ApiResponse<Watermark> DocuSign.eSign.Api.AccountsApi.GetWatermarkPreviewWithHttpInfo ( string  accountId,
Watermark  watermark = null 
)
inline

Get watermark preview.

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
watermark(optional)
Returns
ApiResponse of Watermark

Implements DocuSign.eSign.Api.IAccountsApi.

◆ GetWatermarkWithHttpInfo()

ApiResponse<Watermark> DocuSign.eSign.Api.AccountsApi.GetWatermarkWithHttpInfo ( string  accountId)
inline

Get watermark information.

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
Returns
ApiResponse of Watermark

Implements DocuSign.eSign.Api.IAccountsApi.

◆ ListBrands()

BrandsResponse DocuSign.eSign.Api.AccountsApi.ListBrands ( string  accountId,
AccountsApi.ListBrandsOptions  options = null 
)
inline

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 &#x60;canSelfBrandSend&#x60; and &#x60;canSelfBrandSend&#x60;) must be set to true for the account to use this call.

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
optionsOptions for modifying the behavior of the function.
Returns
BrandsResponse

◆ ListBrandsAsync()

async System.Threading.Tasks.Task<BrandsResponse> DocuSign.eSign.Api.AccountsApi.ListBrandsAsync ( string  accountId,
AccountsApi.ListBrandsOptions  options = null 
)
inline

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 &#x60;canSelfBrandSend&#x60; and &#x60;canSelfBrandSend&#x60;) must be set to true for the account to use this call.

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
optionsOptions for modifying the behavior of the function.
Returns
Task of BrandsResponse

◆ ListBrandsAsyncWithHttpInfo()

async System.Threading.Tasks.Task<ApiResponse<BrandsResponse> > DocuSign.eSign.Api.AccountsApi.ListBrandsAsyncWithHttpInfo ( string  accountId,
AccountsApi.ListBrandsOptions  options = null 
)
inline

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 &#x60;canSelfBrandSend&#x60; and &#x60;canSelfBrandSend&#x60;) must be set to true for the account to use this call.

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
optionsOptions for modifying the behavior of the function.
Returns
Task of ApiResponse (BrandsResponse)

◆ ListBrandsWithHttpInfo()

ApiResponse<BrandsResponse> DocuSign.eSign.Api.AccountsApi.ListBrandsWithHttpInfo ( string  accountId,
AccountsApi.ListBrandsOptions  options = null 
)
inline

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 &#x60;canSelfBrandSend&#x60; and &#x60;canSelfBrandSend&#x60;) must be set to true for the account to use this call.

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
optionsOptions for modifying the behavior of the function.
Returns
ApiResponse of BrandsResponse

◆ ListCustomFields()

CustomFields DocuSign.eSign.Api.AccountsApi.ListCustomFields ( string  accountId)
inline

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.

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
Returns
CustomFields

Implements DocuSign.eSign.Api.IAccountsApi.

◆ ListCustomFieldsAsync()

async System.Threading.Tasks.Task<CustomFields> DocuSign.eSign.Api.AccountsApi.ListCustomFieldsAsync ( string  accountId)
inline

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.

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
Returns
Task of CustomFields

Implements DocuSign.eSign.Api.IAccountsApi.

◆ ListCustomFieldsAsyncWithHttpInfo()

async System.Threading.Tasks.Task<ApiResponse<CustomFields> > DocuSign.eSign.Api.AccountsApi.ListCustomFieldsAsyncWithHttpInfo ( string  accountId)
inline

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.

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
Returns
Task of ApiResponse (CustomFields)

Implements DocuSign.eSign.Api.IAccountsApi.

◆ ListCustomFieldsWithHttpInfo()

ApiResponse<CustomFields> DocuSign.eSign.Api.AccountsApi.ListCustomFieldsWithHttpInfo ( string  accountId)
inline

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.

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
Returns
ApiResponse of CustomFields

Implements DocuSign.eSign.Api.IAccountsApi.

◆ ListPermissions()

PermissionProfileInformation DocuSign.eSign.Api.AccountsApi.ListPermissions ( string  accountId,
AccountsApi.ListPermissionsOptions  options = null 
)
inline

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.

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
optionsOptions for modifying the behavior of the function.
Returns
PermissionProfileInformation

◆ ListPermissionsAsync()

async System.Threading.Tasks.Task<PermissionProfileInformation> DocuSign.eSign.Api.AccountsApi.ListPermissionsAsync ( string  accountId,
AccountsApi.ListPermissionsOptions  options = null 
)
inline

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.

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
optionsOptions for modifying the behavior of the function.
Returns
Task of PermissionProfileInformation

◆ ListPermissionsAsyncWithHttpInfo()

async System.Threading.Tasks.Task<ApiResponse<PermissionProfileInformation> > DocuSign.eSign.Api.AccountsApi.ListPermissionsAsyncWithHttpInfo ( string  accountId,
AccountsApi.ListPermissionsOptions  options = null 
)
inline

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.

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
optionsOptions for modifying the behavior of the function.
Returns
Task of ApiResponse (PermissionProfileInformation)

◆ ListPermissionsWithHttpInfo()

ApiResponse<PermissionProfileInformation> DocuSign.eSign.Api.AccountsApi.ListPermissionsWithHttpInfo ( string  accountId,
AccountsApi.ListPermissionsOptions  options = null 
)
inline

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.

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
optionsOptions for modifying the behavior of the function.
Returns
ApiResponse of PermissionProfileInformation

◆ ListRecipientNamesByEmail()

RecipientNamesResponse DocuSign.eSign.Api.AccountsApi.ListRecipientNamesByEmail ( string  accountId,
AccountsApi.ListRecipientNamesByEmailOptions  options = null 
)
inline

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.

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
optionsOptions for modifying the behavior of the function.
Returns
RecipientNamesResponse

◆ ListRecipientNamesByEmailAsync()

async System.Threading.Tasks.Task<RecipientNamesResponse> DocuSign.eSign.Api.AccountsApi.ListRecipientNamesByEmailAsync ( string  accountId,
AccountsApi.ListRecipientNamesByEmailOptions  options = null 
)
inline

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.

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
optionsOptions for modifying the behavior of the function.
Returns
Task of RecipientNamesResponse

◆ ListRecipientNamesByEmailAsyncWithHttpInfo()

async System.Threading.Tasks.Task<ApiResponse<RecipientNamesResponse> > DocuSign.eSign.Api.AccountsApi.ListRecipientNamesByEmailAsyncWithHttpInfo ( string  accountId,
AccountsApi.ListRecipientNamesByEmailOptions  options = null 
)
inline

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.

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
optionsOptions for modifying the behavior of the function.
Returns
Task of ApiResponse (RecipientNamesResponse)

◆ ListRecipientNamesByEmailWithHttpInfo()

ApiResponse<RecipientNamesResponse> DocuSign.eSign.Api.AccountsApi.ListRecipientNamesByEmailWithHttpInfo ( string  accountId,
AccountsApi.ListRecipientNamesByEmailOptions  options = null 
)
inline

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.

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
optionsOptions for modifying the behavior of the function.
Returns
ApiResponse of RecipientNamesResponse

◆ ListSettings()

AccountSettingsInformation DocuSign.eSign.Api.AccountsApi.ListSettings ( string  accountId)
inline

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

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
Returns
AccountSettingsInformation

Implements DocuSign.eSign.Api.IAccountsApi.

◆ ListSettingsAsync()

async System.Threading.Tasks.Task<AccountSettingsInformation> DocuSign.eSign.Api.AccountsApi.ListSettingsAsync ( string  accountId)
inline

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

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
Returns
Task of AccountSettingsInformation

Implements DocuSign.eSign.Api.IAccountsApi.

◆ ListSettingsAsyncWithHttpInfo()

async System.Threading.Tasks.Task<ApiResponse<AccountSettingsInformation> > DocuSign.eSign.Api.AccountsApi.ListSettingsAsyncWithHttpInfo ( string  accountId)
inline

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

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
Returns
Task of ApiResponse (AccountSettingsInformation)

Implements DocuSign.eSign.Api.IAccountsApi.

◆ ListSettingsWithHttpInfo()

ApiResponse<AccountSettingsInformation> DocuSign.eSign.Api.AccountsApi.ListSettingsWithHttpInfo ( string  accountId)
inline

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

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
Returns
ApiResponse of AccountSettingsInformation

Implements DocuSign.eSign.Api.IAccountsApi.

◆ ListSharedAccess()

AccountSharedAccess DocuSign.eSign.Api.AccountsApi.ListSharedAccess ( string  accountId,
AccountsApi.ListSharedAccessOptions  options = null 
)
inline

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&#x3D;shared_from.

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
optionsOptions for modifying the behavior of the function.
Returns
AccountSharedAccess

◆ ListSharedAccessAsync()

async System.Threading.Tasks.Task<AccountSharedAccess> DocuSign.eSign.Api.AccountsApi.ListSharedAccessAsync ( string  accountId,
AccountsApi.ListSharedAccessOptions  options = null 
)
inline

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&#x3D;shared_from.

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
optionsOptions for modifying the behavior of the function.
Returns
Task of AccountSharedAccess

◆ ListSharedAccessAsyncWithHttpInfo()

async System.Threading.Tasks.Task<ApiResponse<AccountSharedAccess> > DocuSign.eSign.Api.AccountsApi.ListSharedAccessAsyncWithHttpInfo ( string  accountId,
AccountsApi.ListSharedAccessOptions  options = null 
)
inline

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&#x3D;shared_from.

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
optionsOptions for modifying the behavior of the function.
Returns
Task of ApiResponse (AccountSharedAccess)

◆ ListSharedAccessWithHttpInfo()

ApiResponse<AccountSharedAccess> DocuSign.eSign.Api.AccountsApi.ListSharedAccessWithHttpInfo ( string  accountId,
AccountsApi.ListSharedAccessOptions  options = null 
)
inline

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&#x3D;shared_from.

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
optionsOptions for modifying the behavior of the function.
Returns
ApiResponse of AccountSharedAccess

◆ ListSignatureProviders()

AccountSignatureProviders DocuSign.eSign.Api.AccountsApi.ListSignatureProviders ( string  accountId)
inline

Returns Account available signature providers for specified account. Returns a list of signature providers that the specified account can use.

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
Returns
AccountSignatureProviders

Implements DocuSign.eSign.Api.IAccountsApi.

◆ ListSignatureProvidersAsync()

async System.Threading.Tasks.Task<AccountSignatureProviders> DocuSign.eSign.Api.AccountsApi.ListSignatureProvidersAsync ( string  accountId)
inline

Returns Account available signature providers for specified account. Returns a list of signature providers that the specified account can use.

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
Returns
Task of AccountSignatureProviders

Implements DocuSign.eSign.Api.IAccountsApi.

◆ ListSignatureProvidersAsyncWithHttpInfo()

async System.Threading.Tasks.Task<ApiResponse<AccountSignatureProviders> > DocuSign.eSign.Api.AccountsApi.ListSignatureProvidersAsyncWithHttpInfo ( string  accountId)
inline

Returns Account available signature providers for specified account. Returns a list of signature providers that the specified account can use.

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
Returns
Task of ApiResponse (AccountSignatureProviders)

Implements DocuSign.eSign.Api.IAccountsApi.

◆ ListSignatureProvidersWithHttpInfo()

ApiResponse<AccountSignatureProviders> DocuSign.eSign.Api.AccountsApi.ListSignatureProvidersWithHttpInfo ( string  accountId)
inline

Returns Account available signature providers for specified account. Returns a list of signature providers that the specified account can use.

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
Returns
ApiResponse of AccountSignatureProviders

Implements DocuSign.eSign.Api.IAccountsApi.

◆ ListUnsupportedFileTypes()

FileTypeList DocuSign.eSign.Api.AccountsApi.ListUnsupportedFileTypes ( string  accountId)
inline

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.

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
Returns
FileTypeList

Implements DocuSign.eSign.Api.IAccountsApi.

◆ ListUnsupportedFileTypesAsync()

async System.Threading.Tasks.Task<FileTypeList> DocuSign.eSign.Api.AccountsApi.ListUnsupportedFileTypesAsync ( string  accountId)
inline

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.

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
Returns
Task of FileTypeList

Implements DocuSign.eSign.Api.IAccountsApi.

◆ ListUnsupportedFileTypesAsyncWithHttpInfo()

async System.Threading.Tasks.Task<ApiResponse<FileTypeList> > DocuSign.eSign.Api.AccountsApi.ListUnsupportedFileTypesAsyncWithHttpInfo ( string  accountId)
inline

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.

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
Returns
Task of ApiResponse (FileTypeList)

Implements DocuSign.eSign.Api.IAccountsApi.

◆ ListUnsupportedFileTypesWithHttpInfo()

ApiResponse<FileTypeList> DocuSign.eSign.Api.AccountsApi.ListUnsupportedFileTypesWithHttpInfo ( string  accountId)
inline

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.

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
Returns
ApiResponse of FileTypeList

Implements DocuSign.eSign.Api.IAccountsApi.

◆ UnFavoriteTemplate()

FavoriteTemplatesInfo DocuSign.eSign.Api.AccountsApi.UnFavoriteTemplate ( string  accountId,
FavoriteTemplatesInfo  favoriteTemplatesInfo = null 
)
inline

Unfavorite a template

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
favoriteTemplatesInfo(optional)
Returns
FavoriteTemplatesInfo

Implements DocuSign.eSign.Api.IAccountsApi.

◆ UnFavoriteTemplateAsync()

async System.Threading.Tasks.Task<FavoriteTemplatesInfo> DocuSign.eSign.Api.AccountsApi.UnFavoriteTemplateAsync ( string  accountId,
FavoriteTemplatesInfo  favoriteTemplatesInfo = null 
)
inline

Unfavorite a template

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
favoriteTemplatesInfo(optional)
Returns
Task of FavoriteTemplatesInfo

Implements DocuSign.eSign.Api.IAccountsApi.

◆ UnFavoriteTemplateAsyncWithHttpInfo()

async System.Threading.Tasks.Task<ApiResponse<FavoriteTemplatesInfo> > DocuSign.eSign.Api.AccountsApi.UnFavoriteTemplateAsyncWithHttpInfo ( string  accountId,
FavoriteTemplatesInfo  favoriteTemplatesInfo = null 
)
inline

Unfavorite a template

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
favoriteTemplatesInfo(optional)
Returns
Task of ApiResponse (FavoriteTemplatesInfo)

Implements DocuSign.eSign.Api.IAccountsApi.

◆ UnFavoriteTemplateWithHttpInfo()

ApiResponse<FavoriteTemplatesInfo> DocuSign.eSign.Api.AccountsApi.UnFavoriteTemplateWithHttpInfo ( string  accountId,
FavoriteTemplatesInfo  favoriteTemplatesInfo = null 
)
inline

Unfavorite a template

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
favoriteTemplatesInfo(optional)
Returns
ApiResponse of FavoriteTemplatesInfo

Implements DocuSign.eSign.Api.IAccountsApi.

◆ UpdateAccountSignature()

AccountSignaturesInformation DocuSign.eSign.Api.AccountsApi.UpdateAccountSignature ( string  accountId,
AccountSignaturesInformation  accountSignaturesInformation = null 
)
inline

Updates a account signature.

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
accountSignaturesInformation(optional)
Returns
AccountSignaturesInformation

Implements DocuSign.eSign.Api.IAccountsApi.

◆ UpdateAccountSignatureAsync()

async System.Threading.Tasks.Task<AccountSignaturesInformation> DocuSign.eSign.Api.AccountsApi.UpdateAccountSignatureAsync ( string  accountId,
AccountSignaturesInformation  accountSignaturesInformation = null 
)
inline

Updates a account signature.

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
accountSignaturesInformation(optional)
Returns
Task of AccountSignaturesInformation

Implements DocuSign.eSign.Api.IAccountsApi.

◆ UpdateAccountSignatureAsyncWithHttpInfo()

async System.Threading.Tasks.Task<ApiResponse<AccountSignaturesInformation> > DocuSign.eSign.Api.AccountsApi.UpdateAccountSignatureAsyncWithHttpInfo ( string  accountId,
AccountSignaturesInformation  accountSignaturesInformation = null 
)
inline

Updates a account signature.

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
accountSignaturesInformation(optional)
Returns
Task of ApiResponse (AccountSignaturesInformation)

Implements DocuSign.eSign.Api.IAccountsApi.

◆ UpdateAccountSignatureById()

AccountSignature DocuSign.eSign.Api.AccountsApi.UpdateAccountSignatureById ( string  accountId,
string  signatureId,
AccountSignatureDefinition  accountSignatureDefinition = null,
AccountsApi.UpdateAccountSignatureByIdOptions  options = null 
)
inline

Updates a account signature.

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
signatureIdThe ID of the signature being accessed.
accountSignatureDefinition(optional)
optionsOptions for modifying the behavior of the function.
Returns
AccountSignature

◆ UpdateAccountSignatureByIdAsync()

async System.Threading.Tasks.Task<AccountSignature> DocuSign.eSign.Api.AccountsApi.UpdateAccountSignatureByIdAsync ( string  accountId,
string  signatureId,
AccountSignatureDefinition  accountSignatureDefinition = null,
AccountsApi.UpdateAccountSignatureByIdOptions  options = null 
)
inline

Updates a account signature.

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
signatureIdThe ID of the signature being accessed.
accountSignatureDefinition(optional)
optionsOptions for modifying the behavior of the function.
Returns
Task of AccountSignature

◆ UpdateAccountSignatureByIdAsyncWithHttpInfo()

async System.Threading.Tasks.Task<ApiResponse<AccountSignature> > DocuSign.eSign.Api.AccountsApi.UpdateAccountSignatureByIdAsyncWithHttpInfo ( string  accountId,
string  signatureId,
AccountSignatureDefinition  accountSignatureDefinition = null,
AccountsApi.UpdateAccountSignatureByIdOptions  options = null 
)
inline

Updates a account signature.

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
signatureIdThe ID of the signature being accessed.
accountSignatureDefinition(optional)
optionsOptions for modifying the behavior of the function.
Returns
Task of ApiResponse (AccountSignature)

◆ UpdateAccountSignatureByIdWithHttpInfo()

ApiResponse<AccountSignature> DocuSign.eSign.Api.AccountsApi.UpdateAccountSignatureByIdWithHttpInfo ( string  accountId,
string  signatureId,
AccountSignatureDefinition  accountSignatureDefinition = null,
AccountsApi.UpdateAccountSignatureByIdOptions  options = null 
)
inline

Updates a account signature.

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
signatureIdThe ID of the signature being accessed.
accountSignatureDefinition(optional)
optionsOptions for modifying the behavior of the function.
Returns
ApiResponse of AccountSignature

◆ UpdateAccountSignatureImage()

AccountSignature DocuSign.eSign.Api.AccountsApi.UpdateAccountSignatureImage ( string  accountId,
string  signatureId,
string  imageType,
AccountsApi.UpdateAccountSignatureImageOptions  options = null 
)
inline

Sets a signature, initials, or stamps image.

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
signatureIdThe ID of the signature being accessed.
imageTypeOne of signature_image or initials_image.
optionsOptions for modifying the behavior of the function.
Returns
AccountSignature

◆ UpdateAccountSignatureImageAsync()

async System.Threading.Tasks.Task<AccountSignature> DocuSign.eSign.Api.AccountsApi.UpdateAccountSignatureImageAsync ( string  accountId,
string  signatureId,
string  imageType,
AccountsApi.UpdateAccountSignatureImageOptions  options = null 
)
inline

Sets a signature, initials, or stamps image.

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
signatureIdThe ID of the signature being accessed.
imageTypeOne of signature_image or initials_image.
optionsOptions for modifying the behavior of the function.
Returns
Task of AccountSignature

◆ UpdateAccountSignatureImageAsyncWithHttpInfo()

async System.Threading.Tasks.Task<ApiResponse<AccountSignature> > DocuSign.eSign.Api.AccountsApi.UpdateAccountSignatureImageAsyncWithHttpInfo ( string  accountId,
string  signatureId,
string  imageType,
AccountsApi.UpdateAccountSignatureImageOptions  options = null 
)
inline

Sets a signature, initials, or stamps image.

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
signatureIdThe ID of the signature being accessed.
imageTypeOne of signature_image or initials_image.
optionsOptions for modifying the behavior of the function.
Returns
Task of ApiResponse (AccountSignature)

◆ UpdateAccountSignatureImageWithHttpInfo()

ApiResponse<AccountSignature> DocuSign.eSign.Api.AccountsApi.UpdateAccountSignatureImageWithHttpInfo ( string  accountId,
string  signatureId,
string  imageType,
AccountsApi.UpdateAccountSignatureImageOptions  options = null 
)
inline

Sets a signature, initials, or stamps image.

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
signatureIdThe ID of the signature being accessed.
imageTypeOne of signature_image or initials_image.
optionsOptions for modifying the behavior of the function.
Returns
ApiResponse of AccountSignature

◆ UpdateAccountSignatureWithHttpInfo()

ApiResponse<AccountSignaturesInformation> DocuSign.eSign.Api.AccountsApi.UpdateAccountSignatureWithHttpInfo ( string  accountId,
AccountSignaturesInformation  accountSignaturesInformation = null 
)
inline

Updates a account signature.

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
accountSignaturesInformation(optional)
Returns
ApiResponse of AccountSignaturesInformation

Implements DocuSign.eSign.Api.IAccountsApi.

◆ UpdateAccountTabSettings()

TabAccountSettings DocuSign.eSign.Api.AccountsApi.UpdateAccountTabSettings ( string  accountId,
TabAccountSettings  tabAccountSettings = null 
)
inline

Modifies tab settings for specified account This method modifies the tab types and tab functionality that is enabled for an account.

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
tabAccountSettings(optional)
Returns
TabAccountSettings

Implements DocuSign.eSign.Api.IAccountsApi.

◆ UpdateAccountTabSettingsAsync()

async System.Threading.Tasks.Task<TabAccountSettings> DocuSign.eSign.Api.AccountsApi.UpdateAccountTabSettingsAsync ( string  accountId,
TabAccountSettings  tabAccountSettings = null 
)
inline

Modifies tab settings for specified account This method modifies the tab types and tab functionality that is enabled for an account.

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
tabAccountSettings(optional)
Returns
Task of TabAccountSettings

Implements DocuSign.eSign.Api.IAccountsApi.

◆ UpdateAccountTabSettingsAsyncWithHttpInfo()

async System.Threading.Tasks.Task<ApiResponse<TabAccountSettings> > DocuSign.eSign.Api.AccountsApi.UpdateAccountTabSettingsAsyncWithHttpInfo ( string  accountId,
TabAccountSettings  tabAccountSettings = null 
)
inline

Modifies tab settings for specified account This method modifies the tab types and tab functionality that is enabled for an account.

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
tabAccountSettings(optional)
Returns
Task of ApiResponse (TabAccountSettings)

Implements DocuSign.eSign.Api.IAccountsApi.

◆ UpdateAccountTabSettingsWithHttpInfo()

ApiResponse<TabAccountSettings> DocuSign.eSign.Api.AccountsApi.UpdateAccountTabSettingsWithHttpInfo ( string  accountId,
TabAccountSettings  tabAccountSettings = null 
)
inline

Modifies tab settings for specified account This method modifies the tab types and tab functionality that is enabled for an account.

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
tabAccountSettings(optional)
Returns
ApiResponse of TabAccountSettings

Implements DocuSign.eSign.Api.IAccountsApi.

◆ UpdateBrand()

Brand DocuSign.eSign.Api.AccountsApi.UpdateBrand ( string  accountId,
string  brandId,
Brand  brand = null,
AccountsApi.UpdateBrandOptions  options = null 
)
inline

Updates an existing brand. This method updates an account brand. Note: Branding for either signing or sending must be enabled for the account (&#x60;canSelfBrandSend&#x60; , &#x60;canSelfBrandSign&#x60;, or both of these account settings must be true).

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
brandIdThe unique identifier of a brand.
brand(optional)
optionsOptions for modifying the behavior of the function.
Returns
Brand

◆ UpdateBrandAsync()

async System.Threading.Tasks.Task<Brand> DocuSign.eSign.Api.AccountsApi.UpdateBrandAsync ( string  accountId,
string  brandId,
Brand  brand = null,
AccountsApi.UpdateBrandOptions  options = null 
)
inline

Updates an existing brand. This method updates an account brand. Note: Branding for either signing or sending must be enabled for the account (&#x60;canSelfBrandSend&#x60; , &#x60;canSelfBrandSign&#x60;, or both of these account settings must be true).

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
brandIdThe unique identifier of a brand.
brand(optional)
optionsOptions for modifying the behavior of the function.
Returns
Task of Brand

◆ UpdateBrandAsyncWithHttpInfo()

async System.Threading.Tasks.Task<ApiResponse<Brand> > DocuSign.eSign.Api.AccountsApi.UpdateBrandAsyncWithHttpInfo ( string  accountId,
string  brandId,
Brand  brand = null,
AccountsApi.UpdateBrandOptions  options = null 
)
inline

Updates an existing brand. This method updates an account brand. Note: Branding for either signing or sending must be enabled for the account (&#x60;canSelfBrandSend&#x60; , &#x60;canSelfBrandSign&#x60;, or both of these account settings must be true).

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
brandIdThe unique identifier of a brand.
brand(optional)
optionsOptions for modifying the behavior of the function.
Returns
Task of ApiResponse (Brand)

◆ UpdateBrandLogoByType()

void DocuSign.eSign.Api.AccountsApi.UpdateBrandLogoByType ( string  accountId,
string  brandId,
string  logoType,
byte []  logoFileBytes 
)
inline

Put one branding logo. This method updates a single brand logo. You pass in the new version of the resource in the &#x60;Content-Disposition&#x60; header. Example: &#x60;Content-Disposition: form-data; name&#x3D;&quot;file&quot;; filename&#x3D;&quot;logo.jpg&quot;&#x60; Note: Branding for either signing or sending must be enabled for the account (&#x60;canSelfBrandSend&#x60; , &#x60;canSelfBrandSign&#x60;, or both of these account settings must be true).

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID GUID.
brandIdThe ID of the brand.
logoTypeThe type of logo. Valid values are: - &#x60;primary&#x60; - &#x60;secondary&#x60; - &#x60;email&#x60;
logoFileBytesBrand 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
Returns

Implements DocuSign.eSign.Api.IAccountsApi.

◆ UpdateBrandLogoByTypeAsync()

async System.Threading.Tasks.Task DocuSign.eSign.Api.AccountsApi.UpdateBrandLogoByTypeAsync ( string  accountId,
string  brandId,
string  logoType,
byte []  logoFileBytes 
)
inline

Put one branding logo. This method updates a single brand logo. You pass in the new version of the resource in the &#x60;Content-Disposition&#x60; header. Example: &#x60;Content-Disposition: form-data; name&#x3D;&quot;file&quot;; filename&#x3D;&quot;logo.jpg&quot;&#x60; Note: Branding for either signing or sending must be enabled for the account (&#x60;canSelfBrandSend&#x60; , &#x60;canSelfBrandSign&#x60;, or both of these account settings must be true).

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID GUID.
brandIdThe ID of the brand.
logoTypeThe type of logo. Valid values are: - &#x60;primary&#x60; - &#x60;secondary&#x60; - &#x60;email&#x60;
logoFileBytesBrand 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
Returns
Task of void

Implements DocuSign.eSign.Api.IAccountsApi.

◆ UpdateBrandLogoByTypeAsyncWithHttpInfo()

async System.Threading.Tasks.Task<ApiResponse<Object> > DocuSign.eSign.Api.AccountsApi.UpdateBrandLogoByTypeAsyncWithHttpInfo ( string  accountId,
string  brandId,
string  logoType,
byte []  logoFileBytes 
)
inline

Put one branding logo. This method updates a single brand logo. You pass in the new version of the resource in the &#x60;Content-Disposition&#x60; header. Example: &#x60;Content-Disposition: form-data; name&#x3D;&quot;file&quot;; filename&#x3D;&quot;logo.jpg&quot;&#x60; Note: Branding for either signing or sending must be enabled for the account (&#x60;canSelfBrandSend&#x60; , &#x60;canSelfBrandSign&#x60;, or both of these account settings must be true).

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID GUID.
brandIdThe ID of the brand.
logoTypeThe type of logo. Valid values are: - &#x60;primary&#x60; - &#x60;secondary&#x60; - &#x60;email&#x60;
logoFileBytesBrand 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
Returns
Task of ApiResponse

Implements DocuSign.eSign.Api.IAccountsApi.

◆ UpdateBrandLogoByTypeWithHttpInfo()

ApiResponse<Object> DocuSign.eSign.Api.AccountsApi.UpdateBrandLogoByTypeWithHttpInfo ( string  accountId,
string  brandId,
string  logoType,
byte []  logoFileBytes 
)
inline

Put one branding logo. This method updates a single brand logo. You pass in the new version of the resource in the &#x60;Content-Disposition&#x60; header. Example: &#x60;Content-Disposition: form-data; name&#x3D;&quot;file&quot;; filename&#x3D;&quot;logo.jpg&quot;&#x60; Note: Branding for either signing or sending must be enabled for the account (&#x60;canSelfBrandSend&#x60; , &#x60;canSelfBrandSign&#x60;, or both of these account settings must be true).

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID GUID.
brandIdThe ID of the brand.
logoTypeThe type of logo. Valid values are: - &#x60;primary&#x60; - &#x60;secondary&#x60; - &#x60;email&#x60;
logoFileBytesBrand 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
Returns
ApiResponse of Object(void)

Implements DocuSign.eSign.Api.IAccountsApi.

◆ UpdateBrandResourcesByContentType()

BrandResources DocuSign.eSign.Api.AccountsApi.UpdateBrandResourcesByContentType ( string  accountId,
string  brandId,
string  resourceContentType,
byte []  fileXml 
)
inline

Uploads a branding resource file. This method updates a branding resource file. You pass in the new version of the resource file in the &#x60;Content-Disposition&#x60; header. Example: &#x60;Content-Disposition: form-data; name&#x3D;&quot;file&quot;; filename&#x3D;&quot;DocuSign_SigningResource_4328673.xml&quot;&#x60; Note: Branding for either signing or sending must be enabled for the account (&#x60;canSelfBrandSend&#x60; , &#x60;canSelfBrandSign&#x60;, 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.

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID GUID.
brandIdThe ID of the brand.
resourceContentTypeThe type of brand resource file that you are updating. Valid values are: - &#x60;sending&#x60; - &#x60;signing&#x60; - &#x60;email&#x60; - &#x60;signing_captive&#x60;
fileXmlBrand resource XML file.
Returns
BrandResources

Implements DocuSign.eSign.Api.IAccountsApi.

◆ UpdateBrandResourcesByContentTypeAsync()

async System.Threading.Tasks.Task<BrandResources> DocuSign.eSign.Api.AccountsApi.UpdateBrandResourcesByContentTypeAsync ( string  accountId,
string  brandId,
string  resourceContentType,
byte []  fileXml 
)
inline

Uploads a branding resource file. This method updates a branding resource file. You pass in the new version of the resource file in the &#x60;Content-Disposition&#x60; header. Example: &#x60;Content-Disposition: form-data; name&#x3D;&quot;file&quot;; filename&#x3D;&quot;DocuSign_SigningResource_4328673.xml&quot;&#x60; Note: Branding for either signing or sending must be enabled for the account (&#x60;canSelfBrandSend&#x60; , &#x60;canSelfBrandSign&#x60;, 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.

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID GUID.
brandIdThe ID of the brand.
resourceContentTypeThe type of brand resource file that you are updating. Valid values are: - &#x60;sending&#x60; - &#x60;signing&#x60; - &#x60;email&#x60; - &#x60;signing_captive&#x60;
fileXmlBrand resource XML file.
Returns
Task of BrandResources

Implements DocuSign.eSign.Api.IAccountsApi.

◆ UpdateBrandResourcesByContentTypeAsyncWithHttpInfo()

async System.Threading.Tasks.Task<ApiResponse<BrandResources> > DocuSign.eSign.Api.AccountsApi.UpdateBrandResourcesByContentTypeAsyncWithHttpInfo ( string  accountId,
string  brandId,
string  resourceContentType,
byte []  fileXml 
)
inline

Uploads a branding resource file. This method updates a branding resource file. You pass in the new version of the resource file in the &#x60;Content-Disposition&#x60; header. Example: &#x60;Content-Disposition: form-data; name&#x3D;&quot;file&quot;; filename&#x3D;&quot;DocuSign_SigningResource_4328673.xml&quot;&#x60; Note: Branding for either signing or sending must be enabled for the account (&#x60;canSelfBrandSend&#x60; , &#x60;canSelfBrandSign&#x60;, 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.

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID GUID.
brandIdThe ID of the brand.
resourceContentTypeThe type of brand resource file that you are updating. Valid values are: - &#x60;sending&#x60; - &#x60;signing&#x60; - &#x60;email&#x60; - &#x60;signing_captive&#x60;
fileXmlBrand resource XML file.
Returns
Task of ApiResponse (BrandResources)

Implements DocuSign.eSign.Api.IAccountsApi.

◆ UpdateBrandResourcesByContentTypeWithHttpInfo()

ApiResponse<BrandResources> DocuSign.eSign.Api.AccountsApi.UpdateBrandResourcesByContentTypeWithHttpInfo ( string  accountId,
string  brandId,
string  resourceContentType,
byte []  fileXml 
)
inline

Uploads a branding resource file. This method updates a branding resource file. You pass in the new version of the resource file in the &#x60;Content-Disposition&#x60; header. Example: &#x60;Content-Disposition: form-data; name&#x3D;&quot;file&quot;; filename&#x3D;&quot;DocuSign_SigningResource_4328673.xml&quot;&#x60; Note: Branding for either signing or sending must be enabled for the account (&#x60;canSelfBrandSend&#x60; , &#x60;canSelfBrandSign&#x60;, 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.

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID GUID.
brandIdThe ID of the brand.
resourceContentTypeThe type of brand resource file that you are updating. Valid values are: - &#x60;sending&#x60; - &#x60;signing&#x60; - &#x60;email&#x60; - &#x60;signing_captive&#x60;
fileXmlBrand resource XML file.
Returns
ApiResponse of BrandResources

Implements DocuSign.eSign.Api.IAccountsApi.

◆ UpdateBrandWithHttpInfo()

ApiResponse<Brand> DocuSign.eSign.Api.AccountsApi.UpdateBrandWithHttpInfo ( string  accountId,
string  brandId,
Brand  brand = null,
AccountsApi.UpdateBrandOptions  options = null 
)
inline

Updates an existing brand. This method updates an account brand. Note: Branding for either signing or sending must be enabled for the account (&#x60;canSelfBrandSend&#x60; , &#x60;canSelfBrandSign&#x60;, or both of these account settings must be true).

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
brandIdThe unique identifier of a brand.
brand(optional)
optionsOptions for modifying the behavior of the function.
Returns
ApiResponse of Brand

◆ UpdateConsumerDisclosure()

ConsumerDisclosure DocuSign.eSign.Api.AccountsApi.UpdateConsumerDisclosure ( string  accountId,
string  langCode,
ConsumerDisclosure  consumerDisclosure = null,
AccountsApi.UpdateConsumerDisclosureOptions  options = null 
)
inline

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 &#x60;langCode&#x60; 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: - &#x60;accountEsignId&#x60;: This property is read-only. - &#x60;custom&#x60;: The default value is false. Editing this property causes the default disclosure to switch to a custom disclosure. - &#x60;esignAgreement&#x60;: This property is read-only. - &#x60;esignText&#x60;: You cannot edit this property when &#x60;custom&#x60; is set to false. The API returns a 200 OK HTTP response, but does not update the &#x60;esignText&#x60;. - 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 &#x60;custom&#x60; property to true and customize the value for the &#x60;eSignText&#x60; property. You can also edit all of the other properties except for the following ones: - &#x60;accountEsignId&#x60;: This property is read-only. - &#x60;esignAgreement&#x60;: 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 &#x60;langCode&#x60; 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: - &#x60;accountEsignId&#x60;: This property is read-only. - &#x60;esignAgreement&#x60;: 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.

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
langCodeThe simple type enumeration the language used in the response. The supported languages, with the language value shown in parenthesis, are:Arabic (ar), Armenian (hy), 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.
consumerDisclosure(optional)
optionsOptions for modifying the behavior of the function.
Returns
ConsumerDisclosure

◆ UpdateConsumerDisclosureAsync()

async System.Threading.Tasks.Task<ConsumerDisclosure> DocuSign.eSign.Api.AccountsApi.UpdateConsumerDisclosureAsync ( string  accountId,
string  langCode,
ConsumerDisclosure  consumerDisclosure = null,
AccountsApi.UpdateConsumerDisclosureOptions  options = null 
)
inline

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 &#x60;langCode&#x60; 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: - &#x60;accountEsignId&#x60;: This property is read-only. - &#x60;custom&#x60;: The default value is false. Editing this property causes the default disclosure to switch to a custom disclosure. - &#x60;esignAgreement&#x60;: This property is read-only. - &#x60;esignText&#x60;: You cannot edit this property when &#x60;custom&#x60; is set to false. The API returns a 200 OK HTTP response, but does not update the &#x60;esignText&#x60;. - 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 &#x60;custom&#x60; property to true and customize the value for the &#x60;eSignText&#x60; property. You can also edit all of the other properties except for the following ones: - &#x60;accountEsignId&#x60;: This property is read-only. - &#x60;esignAgreement&#x60;: 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 &#x60;langCode&#x60; 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: - &#x60;accountEsignId&#x60;: This property is read-only. - &#x60;esignAgreement&#x60;: 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.

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
langCodeThe simple type enumeration the language used in the response. The supported languages, with the language value shown in parenthesis, are:Arabic (ar), Armenian (hy), 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.
consumerDisclosure(optional)
optionsOptions for modifying the behavior of the function.
Returns
Task of ConsumerDisclosure

◆ UpdateConsumerDisclosureAsyncWithHttpInfo()

async System.Threading.Tasks.Task<ApiResponse<ConsumerDisclosure> > DocuSign.eSign.Api.AccountsApi.UpdateConsumerDisclosureAsyncWithHttpInfo ( string  accountId,
string  langCode,
ConsumerDisclosure  consumerDisclosure = null,
AccountsApi.UpdateConsumerDisclosureOptions  options = null 
)
inline

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 &#x60;langCode&#x60; 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: - &#x60;accountEsignId&#x60;: This property is read-only. - &#x60;custom&#x60;: The default value is false. Editing this property causes the default disclosure to switch to a custom disclosure. - &#x60;esignAgreement&#x60;: This property is read-only. - &#x60;esignText&#x60;: You cannot edit this property when &#x60;custom&#x60; is set to false. The API returns a 200 OK HTTP response, but does not update the &#x60;esignText&#x60;. - 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 &#x60;custom&#x60; property to true and customize the value for the &#x60;eSignText&#x60; property. You can also edit all of the other properties except for the following ones: - &#x60;accountEsignId&#x60;: This property is read-only. - &#x60;esignAgreement&#x60;: 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 &#x60;langCode&#x60; 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: - &#x60;accountEsignId&#x60;: This property is read-only. - &#x60;esignAgreement&#x60;: 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.

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
langCodeThe simple type enumeration the language used in the response. The supported languages, with the language value shown in parenthesis, are:Arabic (ar), Armenian (hy), 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.
consumerDisclosure(optional)
optionsOptions for modifying the behavior of the function.
Returns
Task of ApiResponse (ConsumerDisclosure)

◆ UpdateConsumerDisclosureWithHttpInfo()

ApiResponse<ConsumerDisclosure> DocuSign.eSign.Api.AccountsApi.UpdateConsumerDisclosureWithHttpInfo ( string  accountId,
string  langCode,
ConsumerDisclosure  consumerDisclosure = null,
AccountsApi.UpdateConsumerDisclosureOptions  options = null 
)
inline

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 &#x60;langCode&#x60; 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: - &#x60;accountEsignId&#x60;: This property is read-only. - &#x60;custom&#x60;: The default value is false. Editing this property causes the default disclosure to switch to a custom disclosure. - &#x60;esignAgreement&#x60;: This property is read-only. - &#x60;esignText&#x60;: You cannot edit this property when &#x60;custom&#x60; is set to false. The API returns a 200 OK HTTP response, but does not update the &#x60;esignText&#x60;. - 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 &#x60;custom&#x60; property to true and customize the value for the &#x60;eSignText&#x60; property. You can also edit all of the other properties except for the following ones: - &#x60;accountEsignId&#x60;: This property is read-only. - &#x60;esignAgreement&#x60;: 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 &#x60;langCode&#x60; 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: - &#x60;accountEsignId&#x60;: This property is read-only. - &#x60;esignAgreement&#x60;: 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.

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
langCodeThe simple type enumeration the language used in the response. The supported languages, with the language value shown in parenthesis, are:Arabic (ar), Armenian (hy), 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.
consumerDisclosure(optional)
optionsOptions for modifying the behavior of the function.
Returns
ApiResponse of ConsumerDisclosure

◆ UpdateCustomField()

CustomFields DocuSign.eSign.Api.AccountsApi.UpdateCustomField ( string  accountId,
string  customFieldId,
CustomField  customField = null,
AccountsApi.UpdateCustomFieldOptions  options = null 
)
inline

Updates an existing account custom field. This method updates an existing account custom field.

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
customFieldId
customField(optional)
optionsOptions for modifying the behavior of the function.
Returns
CustomFields

◆ UpdateCustomFieldAsync()

async System.Threading.Tasks.Task<CustomFields> DocuSign.eSign.Api.AccountsApi.UpdateCustomFieldAsync ( string  accountId,
string  customFieldId,
CustomField  customField = null,
AccountsApi.UpdateCustomFieldOptions  options = null 
)
inline

Updates an existing account custom field. This method updates an existing account custom field.

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
customFieldId
customField(optional)
optionsOptions for modifying the behavior of the function.
Returns
Task of CustomFields

◆ UpdateCustomFieldAsyncWithHttpInfo()

async System.Threading.Tasks.Task<ApiResponse<CustomFields> > DocuSign.eSign.Api.AccountsApi.UpdateCustomFieldAsyncWithHttpInfo ( string  accountId,
string  customFieldId,
CustomField  customField = null,
AccountsApi.UpdateCustomFieldOptions  options = null 
)
inline

Updates an existing account custom field. This method updates an existing account custom field.

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
customFieldId
customField(optional)
optionsOptions for modifying the behavior of the function.
Returns
Task of ApiResponse (CustomFields)

◆ UpdateCustomFieldWithHttpInfo()

ApiResponse<CustomFields> DocuSign.eSign.Api.AccountsApi.UpdateCustomFieldWithHttpInfo ( string  accountId,
string  customFieldId,
CustomField  customField = null,
AccountsApi.UpdateCustomFieldOptions  options = null 
)
inline

Updates an existing account custom field. This method updates an existing account custom field.

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
customFieldId
customField(optional)
optionsOptions for modifying the behavior of the function.
Returns
ApiResponse of CustomFields

◆ UpdateENoteConfiguration()

ENoteConfiguration DocuSign.eSign.Api.AccountsApi.UpdateENoteConfiguration ( string  accountId,
ENoteConfiguration  eNoteConfiguration = null 
)
inline

Updates configuration information for the eNote eOriginal integration.

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
eNoteConfiguration(optional)
Returns
ENoteConfiguration

Implements DocuSign.eSign.Api.IAccountsApi.

◆ UpdateENoteConfigurationAsync()

async System.Threading.Tasks.Task<ENoteConfiguration> DocuSign.eSign.Api.AccountsApi.UpdateENoteConfigurationAsync ( string  accountId,
ENoteConfiguration  eNoteConfiguration = null 
)
inline

Updates configuration information for the eNote eOriginal integration.

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
eNoteConfiguration(optional)
Returns
Task of ENoteConfiguration

Implements DocuSign.eSign.Api.IAccountsApi.

◆ UpdateENoteConfigurationAsyncWithHttpInfo()

async System.Threading.Tasks.Task<ApiResponse<ENoteConfiguration> > DocuSign.eSign.Api.AccountsApi.UpdateENoteConfigurationAsyncWithHttpInfo ( string  accountId,
ENoteConfiguration  eNoteConfiguration = null 
)
inline

Updates configuration information for the eNote eOriginal integration.

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
eNoteConfiguration(optional)
Returns
Task of ApiResponse (ENoteConfiguration)

Implements DocuSign.eSign.Api.IAccountsApi.

◆ UpdateENoteConfigurationWithHttpInfo()

ApiResponse<ENoteConfiguration> DocuSign.eSign.Api.AccountsApi.UpdateENoteConfigurationWithHttpInfo ( string  accountId,
ENoteConfiguration  eNoteConfiguration = null 
)
inline

Updates configuration information for the eNote eOriginal integration.

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
eNoteConfiguration(optional)
Returns
ApiResponse of ENoteConfiguration

Implements DocuSign.eSign.Api.IAccountsApi.

◆ UpdateEnvelopePurgeConfiguration()

EnvelopePurgeConfiguration DocuSign.eSign.Api.AccountsApi.UpdateEnvelopePurgeConfiguration ( string  accountId,
EnvelopePurgeConfiguration  envelopePurgeConfiguration = null 
)
inline

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 (&#x60;retentionDays&#x60;). 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.

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
envelopePurgeConfiguration(optional)
Returns
EnvelopePurgeConfiguration

Implements DocuSign.eSign.Api.IAccountsApi.

◆ UpdateEnvelopePurgeConfigurationAsync()

async System.Threading.Tasks.Task<EnvelopePurgeConfiguration> DocuSign.eSign.Api.AccountsApi.UpdateEnvelopePurgeConfigurationAsync ( string  accountId,
EnvelopePurgeConfiguration  envelopePurgeConfiguration = null 
)
inline

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 (&#x60;retentionDays&#x60;). 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.

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
envelopePurgeConfiguration(optional)
Returns
Task of EnvelopePurgeConfiguration

Implements DocuSign.eSign.Api.IAccountsApi.

◆ UpdateEnvelopePurgeConfigurationAsyncWithHttpInfo()

async System.Threading.Tasks.Task<ApiResponse<EnvelopePurgeConfiguration> > DocuSign.eSign.Api.AccountsApi.UpdateEnvelopePurgeConfigurationAsyncWithHttpInfo ( string  accountId,
EnvelopePurgeConfiguration  envelopePurgeConfiguration = null 
)
inline

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 (&#x60;retentionDays&#x60;). 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.

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
envelopePurgeConfiguration(optional)
Returns
Task of ApiResponse (EnvelopePurgeConfiguration)

Implements DocuSign.eSign.Api.IAccountsApi.

◆ UpdateEnvelopePurgeConfigurationWithHttpInfo()

ApiResponse<EnvelopePurgeConfiguration> DocuSign.eSign.Api.AccountsApi.UpdateEnvelopePurgeConfigurationWithHttpInfo ( string  accountId,
EnvelopePurgeConfiguration  envelopePurgeConfiguration = null 
)
inline

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 (&#x60;retentionDays&#x60;). 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.

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
envelopePurgeConfiguration(optional)
Returns
ApiResponse of EnvelopePurgeConfiguration

Implements DocuSign.eSign.Api.IAccountsApi.

◆ UpdateFavoriteTemplate()

FavoriteTemplatesInfo DocuSign.eSign.Api.AccountsApi.UpdateFavoriteTemplate ( string  accountId,
FavoriteTemplatesInfo  favoriteTemplatesInfo = null 
)
inline

Favorites a template

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
favoriteTemplatesInfo(optional)
Returns
FavoriteTemplatesInfo

Implements DocuSign.eSign.Api.IAccountsApi.

◆ UpdateFavoriteTemplateAsync()

async System.Threading.Tasks.Task<FavoriteTemplatesInfo> DocuSign.eSign.Api.AccountsApi.UpdateFavoriteTemplateAsync ( string  accountId,
FavoriteTemplatesInfo  favoriteTemplatesInfo = null 
)
inline

Favorites a template

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
favoriteTemplatesInfo(optional)
Returns
Task of FavoriteTemplatesInfo

Implements DocuSign.eSign.Api.IAccountsApi.

◆ UpdateFavoriteTemplateAsyncWithHttpInfo()

async System.Threading.Tasks.Task<ApiResponse<FavoriteTemplatesInfo> > DocuSign.eSign.Api.AccountsApi.UpdateFavoriteTemplateAsyncWithHttpInfo ( string  accountId,
FavoriteTemplatesInfo  favoriteTemplatesInfo = null 
)
inline

Favorites a template

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
favoriteTemplatesInfo(optional)
Returns
Task of ApiResponse (FavoriteTemplatesInfo)

Implements DocuSign.eSign.Api.IAccountsApi.

◆ UpdateFavoriteTemplateWithHttpInfo()

ApiResponse<FavoriteTemplatesInfo> DocuSign.eSign.Api.AccountsApi.UpdateFavoriteTemplateWithHttpInfo ( string  accountId,
FavoriteTemplatesInfo  favoriteTemplatesInfo = null 
)
inline

Favorites a template

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
favoriteTemplatesInfo(optional)
Returns
ApiResponse of FavoriteTemplatesInfo

Implements DocuSign.eSign.Api.IAccountsApi.

◆ UpdateNotificationDefaults()

NotificationDefaults DocuSign.eSign.Api.AccountsApi.UpdateNotificationDefaults ( string  accountId,
NotificationDefaults  notificationDefaults = null 
)
inline

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.

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
notificationDefaults(optional)
Returns
NotificationDefaults

Implements DocuSign.eSign.Api.IAccountsApi.

◆ UpdateNotificationDefaultsAsync()

async System.Threading.Tasks.Task<NotificationDefaults> DocuSign.eSign.Api.AccountsApi.UpdateNotificationDefaultsAsync ( string  accountId,
NotificationDefaults  notificationDefaults = null 
)
inline

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.

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
notificationDefaults(optional)
Returns
Task of NotificationDefaults

Implements DocuSign.eSign.Api.IAccountsApi.

◆ UpdateNotificationDefaultsAsyncWithHttpInfo()

async System.Threading.Tasks.Task<ApiResponse<NotificationDefaults> > DocuSign.eSign.Api.AccountsApi.UpdateNotificationDefaultsAsyncWithHttpInfo ( string  accountId,
NotificationDefaults  notificationDefaults = null 
)
inline

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.

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
notificationDefaults(optional)
Returns
Task of ApiResponse (NotificationDefaults)

Implements DocuSign.eSign.Api.IAccountsApi.

◆ UpdateNotificationDefaultsWithHttpInfo()

ApiResponse<NotificationDefaults> DocuSign.eSign.Api.AccountsApi.UpdateNotificationDefaultsWithHttpInfo ( string  accountId,
NotificationDefaults  notificationDefaults = null 
)
inline

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.

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
notificationDefaults(optional)
Returns
ApiResponse of NotificationDefaults

Implements DocuSign.eSign.Api.IAccountsApi.

◆ UpdatePasswordRules()

AccountPasswordRules DocuSign.eSign.Api.AccountsApi.UpdatePasswordRules ( string  accountId,
AccountPasswordRules  accountPasswordRules = null 
)
inline

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.

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
accountPasswordRules(optional)
Returns
AccountPasswordRules

Implements DocuSign.eSign.Api.IAccountsApi.

◆ UpdatePasswordRulesAsync()

async System.Threading.Tasks.Task<AccountPasswordRules> DocuSign.eSign.Api.AccountsApi.UpdatePasswordRulesAsync ( string  accountId,
AccountPasswordRules  accountPasswordRules = null 
)
inline

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.

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
accountPasswordRules(optional)
Returns
Task of AccountPasswordRules

Implements DocuSign.eSign.Api.IAccountsApi.

◆ UpdatePasswordRulesAsyncWithHttpInfo()

async System.Threading.Tasks.Task<ApiResponse<AccountPasswordRules> > DocuSign.eSign.Api.AccountsApi.UpdatePasswordRulesAsyncWithHttpInfo ( string  accountId,
AccountPasswordRules  accountPasswordRules = null 
)
inline

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.

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
accountPasswordRules(optional)
Returns
Task of ApiResponse (AccountPasswordRules)

Implements DocuSign.eSign.Api.IAccountsApi.

◆ UpdatePasswordRulesWithHttpInfo()

ApiResponse<AccountPasswordRules> DocuSign.eSign.Api.AccountsApi.UpdatePasswordRulesWithHttpInfo ( string  accountId,
AccountPasswordRules  accountPasswordRules = null 
)
inline

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.

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
accountPasswordRules(optional)
Returns
ApiResponse of AccountPasswordRules

Implements DocuSign.eSign.Api.IAccountsApi.

◆ UpdatePermissionProfile()

PermissionProfile DocuSign.eSign.Api.AccountsApi.UpdatePermissionProfile ( string  accountId,
string  permissionProfileId,
PermissionProfile  permissionProfile = null,
AccountsApi.UpdatePermissionProfileOptions  options = null 
)
inline

Updates a permission profile within the specified account. This method updates an account permission profile. ### Related topics - How to update individual permission settings

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
permissionProfileId
permissionProfile(optional)
optionsOptions for modifying the behavior of the function.
Returns
PermissionProfile

◆ UpdatePermissionProfileAsync()

async System.Threading.Tasks.Task<PermissionProfile> DocuSign.eSign.Api.AccountsApi.UpdatePermissionProfileAsync ( string  accountId,
string  permissionProfileId,
PermissionProfile  permissionProfile = null,
AccountsApi.UpdatePermissionProfileOptions  options = null 
)
inline

Updates a permission profile within the specified account. This method updates an account permission profile. ### Related topics - How to update individual permission settings

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
permissionProfileId
permissionProfile(optional)
optionsOptions for modifying the behavior of the function.
Returns
Task of PermissionProfile

◆ UpdatePermissionProfileAsyncWithHttpInfo()

async System.Threading.Tasks.Task<ApiResponse<PermissionProfile> > DocuSign.eSign.Api.AccountsApi.UpdatePermissionProfileAsyncWithHttpInfo ( string  accountId,
string  permissionProfileId,
PermissionProfile  permissionProfile = null,
AccountsApi.UpdatePermissionProfileOptions  options = null 
)
inline

Updates a permission profile within the specified account. This method updates an account permission profile. ### Related topics - How to update individual permission settings

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
permissionProfileId
permissionProfile(optional)
optionsOptions for modifying the behavior of the function.
Returns
Task of ApiResponse (PermissionProfile)

◆ UpdatePermissionProfileWithHttpInfo()

ApiResponse<PermissionProfile> DocuSign.eSign.Api.AccountsApi.UpdatePermissionProfileWithHttpInfo ( string  accountId,
string  permissionProfileId,
PermissionProfile  permissionProfile = null,
AccountsApi.UpdatePermissionProfileOptions  options = null 
)
inline

Updates a permission profile within the specified account. This method updates an account permission profile. ### Related topics - How to update individual permission settings

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
permissionProfileId
permissionProfile(optional)
optionsOptions for modifying the behavior of the function.
Returns
ApiResponse of PermissionProfile

◆ UpdateSettings()

void DocuSign.eSign.Api.AccountsApi.UpdateSettings ( string  accountId,
AccountSettingsInformation  accountSettingsInformation = null 
)
inline

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

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
accountSettingsInformation(optional)
Returns

Implements DocuSign.eSign.Api.IAccountsApi.

◆ UpdateSettingsAsync()

async System.Threading.Tasks.Task DocuSign.eSign.Api.AccountsApi.UpdateSettingsAsync ( string  accountId,
AccountSettingsInformation  accountSettingsInformation = null 
)
inline

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

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
accountSettingsInformation(optional)
Returns
Task of void

Implements DocuSign.eSign.Api.IAccountsApi.

◆ UpdateSettingsAsyncWithHttpInfo()

async System.Threading.Tasks.Task<ApiResponse<Object> > DocuSign.eSign.Api.AccountsApi.UpdateSettingsAsyncWithHttpInfo ( string  accountId,
AccountSettingsInformation  accountSettingsInformation = null 
)
inline

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

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
accountSettingsInformation(optional)
Returns
Task of ApiResponse

Implements DocuSign.eSign.Api.IAccountsApi.

◆ UpdateSettingsWithHttpInfo()

ApiResponse<Object> DocuSign.eSign.Api.AccountsApi.UpdateSettingsWithHttpInfo ( string  accountId,
AccountSettingsInformation  accountSettingsInformation = null 
)
inline

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

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
accountSettingsInformation(optional)
Returns
ApiResponse of Object(void)

Implements DocuSign.eSign.Api.IAccountsApi.

◆ UpdateSharedAccess()

AccountSharedAccess DocuSign.eSign.Api.AccountsApi.UpdateSharedAccess ( string  accountId,
AccountSharedAccess  accountSharedAccess = null,
AccountsApi.UpdateSharedAccessOptions  options = null 
)
inline

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

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
accountSharedAccess(optional)
optionsOptions for modifying the behavior of the function.
Returns
AccountSharedAccess

◆ UpdateSharedAccessAsync()

async System.Threading.Tasks.Task<AccountSharedAccess> DocuSign.eSign.Api.AccountsApi.UpdateSharedAccessAsync ( string  accountId,
AccountSharedAccess  accountSharedAccess = null,
AccountsApi.UpdateSharedAccessOptions  options = null 
)
inline

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

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
accountSharedAccess(optional)
optionsOptions for modifying the behavior of the function.
Returns
Task of AccountSharedAccess

◆ UpdateSharedAccessAsyncWithHttpInfo()

async System.Threading.Tasks.Task<ApiResponse<AccountSharedAccess> > DocuSign.eSign.Api.AccountsApi.UpdateSharedAccessAsyncWithHttpInfo ( string  accountId,
AccountSharedAccess  accountSharedAccess = null,
AccountsApi.UpdateSharedAccessOptions  options = null 
)
inline

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

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
accountSharedAccess(optional)
optionsOptions for modifying the behavior of the function.
Returns
Task of ApiResponse (AccountSharedAccess)

◆ UpdateSharedAccessWithHttpInfo()

ApiResponse<AccountSharedAccess> DocuSign.eSign.Api.AccountsApi.UpdateSharedAccessWithHttpInfo ( string  accountId,
AccountSharedAccess  accountSharedAccess = null,
AccountsApi.UpdateSharedAccessOptions  options = null 
)
inline

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

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
accountSharedAccess(optional)
optionsOptions for modifying the behavior of the function.
Returns
ApiResponse of AccountSharedAccess

◆ UpdateUserAuthorization()

UserAuthorization DocuSign.eSign.Api.AccountsApi.UpdateUserAuthorization ( string  accountId,
string  userId,
string  authorizationId,
UserAuthorizationUpdateRequest  userAuthorizationUpdateRequest = null 
)
inline

Updates the user authorization

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
userIdThe user ID of the user being accessed. Generally this is the user ID of the authenticated user, but if the authenticated user is an Admin on the account, this may be another user the Admin user is accessing.
authorizationId
userAuthorizationUpdateRequest(optional)
Returns
UserAuthorization

Implements DocuSign.eSign.Api.IAccountsApi.

◆ UpdateUserAuthorizationAsync()

async System.Threading.Tasks.Task<UserAuthorization> DocuSign.eSign.Api.AccountsApi.UpdateUserAuthorizationAsync ( string  accountId,
string  userId,
string  authorizationId,
UserAuthorizationUpdateRequest  userAuthorizationUpdateRequest = null 
)
inline

Updates the user authorization

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
userIdThe user ID of the user being accessed. Generally this is the user ID of the authenticated user, but if the authenticated user is an Admin on the account, this may be another user the Admin user is accessing.
authorizationId
userAuthorizationUpdateRequest(optional)
Returns
Task of UserAuthorization

Implements DocuSign.eSign.Api.IAccountsApi.

◆ UpdateUserAuthorizationAsyncWithHttpInfo()

async System.Threading.Tasks.Task<ApiResponse<UserAuthorization> > DocuSign.eSign.Api.AccountsApi.UpdateUserAuthorizationAsyncWithHttpInfo ( string  accountId,
string  userId,
string  authorizationId,
UserAuthorizationUpdateRequest  userAuthorizationUpdateRequest = null 
)
inline

Updates the user authorization

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
userIdThe user ID of the user being accessed. Generally this is the user ID of the authenticated user, but if the authenticated user is an Admin on the account, this may be another user the Admin user is accessing.
authorizationId
userAuthorizationUpdateRequest(optional)
Returns
Task of ApiResponse (UserAuthorization)

Implements DocuSign.eSign.Api.IAccountsApi.

◆ UpdateUserAuthorizationWithHttpInfo()

ApiResponse<UserAuthorization> DocuSign.eSign.Api.AccountsApi.UpdateUserAuthorizationWithHttpInfo ( string  accountId,
string  userId,
string  authorizationId,
UserAuthorizationUpdateRequest  userAuthorizationUpdateRequest = null 
)
inline

Updates the user authorization

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
userIdThe user ID of the user being accessed. Generally this is the user ID of the authenticated user, but if the authenticated user is an Admin on the account, this may be another user the Admin user is accessing.
authorizationId
userAuthorizationUpdateRequest(optional)
Returns
ApiResponse of UserAuthorization

Implements DocuSign.eSign.Api.IAccountsApi.

◆ UpdateWatermark()

Watermark DocuSign.eSign.Api.AccountsApi.UpdateWatermark ( string  accountId,
Watermark  watermark = null 
)
inline

Update watermark information.

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
watermark(optional)
Returns
Watermark

Implements DocuSign.eSign.Api.IAccountsApi.

◆ UpdateWatermarkAsync()

async System.Threading.Tasks.Task<Watermark> DocuSign.eSign.Api.AccountsApi.UpdateWatermarkAsync ( string  accountId,
Watermark  watermark = null 
)
inline

Update watermark information.

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
watermark(optional)
Returns
Task of Watermark

Implements DocuSign.eSign.Api.IAccountsApi.

◆ UpdateWatermarkAsyncWithHttpInfo()

async System.Threading.Tasks.Task<ApiResponse<Watermark> > DocuSign.eSign.Api.AccountsApi.UpdateWatermarkAsyncWithHttpInfo ( string  accountId,
Watermark  watermark = null 
)
inline

Update watermark information.

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
watermark(optional)
Returns
Task of ApiResponse (Watermark)

Implements DocuSign.eSign.Api.IAccountsApi.

◆ UpdateWatermarkWithHttpInfo()

ApiResponse<Watermark> DocuSign.eSign.Api.AccountsApi.UpdateWatermarkWithHttpInfo ( string  accountId,
Watermark  watermark = null 
)
inline

Update watermark information.

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
watermark(optional)
Returns
ApiResponse of Watermark

Implements DocuSign.eSign.Api.IAccountsApi.

Property Documentation

◆ ApiClient

DocuSignClient DocuSign.eSign.Api.AccountsApi.ApiClient
getset

Gets or sets the ApiClient object

An instance of the ApiClient

◆ ExceptionFactory

DocuSign.eSign.Client.ExceptionFactory DocuSign.eSign.Api.AccountsApi.ExceptionFactory
getset

Provides a factory method hook for the creation of exceptions.


The documentation for this class was generated from the following file: