Docusign CSharp Docs
|
Represents a collection of functions to interact with the API endpoints More...
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 | DeleteOptions |
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... | |
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 | GetAccountIdentityVerificationOptions |
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... | |
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< NewAccountSummary > | CreateWithHttpInfo (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... | |
async System.Threading.Tasks.Task< NewAccountSummary > | CreateAsync (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... | |
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 `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... | |
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< AccountSignaturesInformation > | CreateAccountSignaturesWithHttpInfo (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< AccountSignaturesInformation > | CreateAccountSignaturesAsync (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 `canSelfBrandSend` and `canSelfBrandSig`) must be set to true for the account to use this call. An error is returned if `brandId` property for a brand profile is already set for the account. To upload a new version of an existing brand profile, you must delete the profile and then upload the newer version. When brand profile files are being uploaded, they must be combined into one zip file and the `Content-Type` must be `application/zip`. More... | |
ApiResponse< BrandsResponse > | CreateBrandWithHttpInfo (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 `canSelfBrandSend` and `canSelfBrandSig`) must be set to true for the account to use this call. An error is returned if `brandId` property for a brand profile is already set for the account. To upload a new version of an existing brand profile, you must delete the profile and then upload the newer version. When brand profile files are being uploaded, they must be combined into one zip file and the `Content-Type` must be `application/zip`. More... | |
async System.Threading.Tasks.Task< BrandsResponse > | CreateBrandAsync (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 `canSelfBrandSend` and `canSelfBrandSig`) must be set to true for the account to use this call. An error is returned if `brandId` property for a brand profile is already set for the account. To upload a new version of an existing brand profile, you must delete the profile and then upload the newer version. When brand profile files are being uploaded, they must be combined into one zip file and the `Content-Type` must be `application/zip`. 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 `canSelfBrandSend` and `canSelfBrandSig`) must be set to true for the account to use this call. An error is returned if `brandId` property for a brand profile is already set for the account. To upload a new version of an existing brand profile, you must delete the profile and then upload the newer version. When brand profile files are being uploaded, they must be combined into one zip file and the `Content-Type` must be `application/zip`. 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< CustomFields > | CreateCustomFieldWithHttpInfo (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< CustomFields > | CreateCustomFieldAsync (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< PermissionProfile > | CreatePermissionProfileWithHttpInfo (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< PermissionProfile > | CreatePermissionProfileAsync (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< UserAuthorization > | CreateUserAuthorizationWithHttpInfo (string accountId, string userId, UserAuthorizationCreateRequest userAuthorizationCreateRequest=null) |
Creates the user authorization More... | |
async System.Threading.Tasks.Task< UserAuthorization > | CreateUserAuthorizationAsync (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< UserAuthorizationsResponse > | CreateUserAuthorizationsWithHttpInfo (string accountId, string userId, UserAuthorizationsRequest userAuthorizationsRequest=null) |
Creates ot updates user authorizations More... | |
async System.Threading.Tasks.Task< UserAuthorizationsResponse > | CreateUserAuthorizationsAsync (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, AccountsApi.DeleteOptions options=null) |
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, AccountsApi.DeleteOptions options=null) |
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, AccountsApi.DeleteOptions options=null) |
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, AccountsApi.DeleteOptions options=null) |
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< AccountSignature > | DeleteAccountSignatureImageWithHttpInfo (string accountId, string signatureId, string imageType) |
Deletes a signature, initials, or stamps image. More... | |
async System.Threading.Tasks.Task< AccountSignature > | DeleteAccountSignatureImageAsync (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 (`canSelfBrandSend` , `canSelfBrandSign`, 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 (`canSelfBrandSend` , `canSelfBrandSign`, 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 (`canSelfBrandSend` , `canSelfBrandSign`, 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 (`canSelfBrandSend` , `canSelfBrandSign`, 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 (`canSelfBrandSend` , `canSelfBrandSign`, 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 (`canSelfBrandSend` , `canSelfBrandSign`, 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 (`canSelfBrandSend` , `canSelfBrandSign`, 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 (`canSelfBrandSend` , `canSelfBrandSign`, 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 `canSelfBrandSend` and `canSelfBrandSend`) must be set to true to use this call. More... | |
ApiResponse< BrandsResponse > | DeleteBrandsWithHttpInfo (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 `canSelfBrandSend` and `canSelfBrandSend`) must be set to true to use this call. More... | |
async System.Threading.Tasks.Task< BrandsResponse > | DeleteBrandsAsync (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 `canSelfBrandSend` and `canSelfBrandSend`) 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 `canSelfBrandSend` and `canSelfBrandSend`) 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< CaptiveRecipientInformation > | DeleteCaptiveRecipientWithHttpInfo (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< CaptiveRecipientInformation > | DeleteCaptiveRecipientAsync (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 `move_users_to` 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 `move_users_to` 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 `move_users_to` 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 `move_users_to` 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< UserAuthorizationsDeleteResponse > | DeleteUserAuthorizationsWithHttpInfo (string accountId, string userId, UserAuthorizationsDeleteRequest userAuthorizationsDeleteRequest=null) |
Creates ot updates user authorizations More... | |
async System.Threading.Tasks.Task< UserAuthorizationsDeleteResponse > | DeleteUserAuthorizationsAsync (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, AccountsApi.GetAccountIdentityVerificationOptions options=null) |
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< AccountIdentityVerificationResponse > | GetAccountIdentityVerificationWithHttpInfo (string accountId, AccountsApi.GetAccountIdentityVerificationOptions options=null) |
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< AccountIdentityVerificationResponse > | GetAccountIdentityVerificationAsync (string accountId, AccountsApi.GetAccountIdentityVerificationOptions options=null) |
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, AccountsApi.GetAccountIdentityVerificationOptions options=null) |
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 `canUpgrade` property contains is a Boolean that indicates whether the account can be upgraded through the API. More... | |
ApiResponse< AccountInformation > | GetAccountInformationWithHttpInfo (string accountId, AccountsApi.GetAccountInformationOptions options=null) |
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... | |
async System.Threading.Tasks.Task< AccountInformation > | GetAccountInformationAsync (string accountId, AccountsApi.GetAccountInformationOptions options=null) |
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... | |
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 `canUpgrade` 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< AccountSignature > | GetAccountSignatureWithHttpInfo (string accountId, string signatureId) |
Returns information about a single signature by specifed signatureId. More... | |
async System.Threading.Tasks.Task< AccountSignature > | GetAccountSignatureAsync (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< AccountSignaturesInformation > | GetAccountSignaturesWithHttpInfo (string accountId, AccountsApi.GetAccountSignaturesOptions options=null) |
Returns the managed signature definitions for the account More... | |
async System.Threading.Tasks.Task< AccountSignaturesInformation > | GetAccountSignaturesAsync (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< TabAccountSettings > | GetAccountTabSettingsWithHttpInfo (string accountId) |
Returns tab settings list for specified account This method returns information about the tab types and tab functionality that is currently enabled for an account. More... | |
async System.Threading.Tasks.Task< TabAccountSettings > | GetAccountTabSettingsAsync (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< UserAuthorizations > | GetAgentUserAuthorizationsWithHttpInfo (string accountId, string userId, AccountsApi.GetAgentUserAuthorizationsOptions options=null) |
Returns the agent user authorizations More... | |
async System.Threading.Tasks.Task< UserAuthorizations > | GetAgentUserAuthorizationsAsync (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< PaymentGatewayAccountsInfo > | GetAllPaymentGatewayAccountsWithHttpInfo (string accountId) |
Get all payment gateway account for the provided accountId This method returns a list of payment gateway accounts and basic information about them. More... | |
async System.Threading.Tasks.Task< PaymentGatewayAccountsInfo > | GetAllPaymentGatewayAccountsAsync (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< BillingChargeResponse > | GetBillingChargesWithHttpInfo (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< BillingChargeResponse > | GetBillingChargesAsync (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 (`canSelfBrandSend` , `canSelfBrandSign`, or both of these account settings must be true). More... | |
ApiResponse< Brand > | GetBrandWithHttpInfo (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 (`canSelfBrandSend` , `canSelfBrandSign`, or both of these account settings must be true). More... | |
async System.Threading.Tasks.Task< Brand > | GetBrandAsync (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 (`canSelfBrandSend` , `canSelfBrandSign`, 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 (`canSelfBrandSend` , `canSelfBrandSign`, 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 (`canSelfBrandSend` , `canSelfBrandSign`, 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 (`canSelfBrandSend` , `canSelfBrandSign`, 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 (`canSelfBrandSend` , `canSelfBrandSign`, 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 (`canSelfBrandSend` , `canSelfBrandSign`, 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 (`canSelfBrandSend` , `canSelfBrandSign`, 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 (`canSelfBrandSend` , `canSelfBrandSign`, 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 (`canSelfBrandSend` , `canSelfBrandSign`, 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 (`canSelfBrandSend` , `canSelfBrandSign`, or both of these account settings must be true). More... | |
BrandResourcesList | GetBrandResources (string accountId, string brandId) |
Returns the specified account's list of branding resources (metadata). This method returns metadata about the branding resources that are associated with an account. Note: Branding for either signing or sending must be enabled for the account (`canSelfBrandSend` , `canSelfBrandSign`, or both of these account settings must be true). More... | |
ApiResponse< BrandResourcesList > | GetBrandResourcesWithHttpInfo (string accountId, string brandId) |
Returns the specified account's list of branding resources (metadata). This method returns metadata about the branding resources that are associated with an account. Note: Branding for either signing or sending must be enabled for the account (`canSelfBrandSend` , `canSelfBrandSign`, or both of these account settings must be true). More... | |
async System.Threading.Tasks.Task< BrandResourcesList > | GetBrandResourcesAsync (string accountId, string brandId) |
Returns the specified account's list of branding resources (metadata). This method returns metadata about the branding resources that are associated with an account. Note: Branding for either signing or sending must be enabled for the account (`canSelfBrandSend` , `canSelfBrandSign`, or both of these account settings must be true). More... | |
async System.Threading.Tasks.Task< ApiResponse< BrandResourcesList > > | GetBrandResourcesAsyncWithHttpInfo (string accountId, string brandId) |
Returns the specified account's list of branding resources (metadata). This method returns metadata about the branding resources that are associated with an account. Note: Branding for either signing or sending must be enabled for the account (`canSelfBrandSend` , `canSelfBrandSign`, or both of these account settings must be true). 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 (`canSelfBrandSend` , `canSelfBrandSign`, 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 (`canSelfBrandSend` , `canSelfBrandSign`, 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 (`canSelfBrandSend` , `canSelfBrandSign`, 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 (`canSelfBrandSend` , `canSelfBrandSign`, 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< ConsumerDisclosure > | GetConsumerDisclosureWithHttpInfo (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< ConsumerDisclosure > | GetConsumerDisclosureAsync (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< ConsumerDisclosure > | GetConsumerDisclosureDefaultWithHttpInfo (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< ConsumerDisclosure > | GetConsumerDisclosureDefaultAsync (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< ENoteConfiguration > | GetENoteConfigurationWithHttpInfo (string accountId) |
Returns the configuration information for the eNote eOriginal integration. More... | |
async System.Threading.Tasks.Task< ENoteConfiguration > | GetENoteConfigurationAsync (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 (`retentionDays`). This method retrieves the current envelope purge configuration for your account. Note: To use this method, you must be an account administrator. More... | |
ApiResponse< EnvelopePurgeConfiguration > | GetEnvelopePurgeConfigurationWithHttpInfo (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 (`retentionDays`). 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< EnvelopePurgeConfiguration > | GetEnvelopePurgeConfigurationAsync (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 (`retentionDays`). 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 (`retentionDays`). 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< FavoriteTemplatesInfo > | GetFavoriteTemplatesWithHttpInfo (string accountId) |
Retrieves the list of favorited templates for this caller More... | |
async System.Threading.Tasks.Task< FavoriteTemplatesInfo > | GetFavoriteTemplatesAsync (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< NotificationDefaults > | GetNotificationDefaultsWithHttpInfo (string accountId) |
Returns default user level settings for a specified account This method returns the default settings for the email notifications that signers and senders receive about envelopes. More... | |
async System.Threading.Tasks.Task< NotificationDefaults > | GetNotificationDefaultsAsync (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< AccountPasswordRules > | GetPasswordRulesWithHttpInfo (string accountId) |
Get the password rules This method retrieves the password rules for an account. More... | |
async System.Threading.Tasks.Task< AccountPasswordRules > | GetPasswordRulesAsync (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< UserPasswordRules > | GetPasswordRules_0WithHttpInfo () |
Get membership account password rules More... | |
async System.Threading.Tasks.Task< UserPasswordRules > | GetPasswordRules_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< PermissionProfile > | GetPermissionProfileWithHttpInfo (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< PermissionProfile > | GetPermissionProfileAsync (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< UserAuthorizations > | GetPrincipalUserAuthorizationsWithHttpInfo (string accountId, string userId, AccountsApi.GetPrincipalUserAuthorizationsOptions options=null) |
Returns the principal user authorizations More... | |
async System.Threading.Tasks.Task< UserAuthorizations > | GetPrincipalUserAuthorizationsAsync (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< ProvisioningInformation > | GetProvisioningWithHttpInfo () |
Retrieves the account provisioning information for the account. Retrieves the account provisioning information for the account. More... | |
async System.Threading.Tasks.Task< ProvisioningInformation > | GetProvisioningAsync () |
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's email notification, this setting affects elements such as the standard introductory text describing the request to sign. It also determines the language used for buttons and tabs in both the email notification and the signing experience. Note: Setting a language for a recipient affects only the DocuSign standard text. Any custom text that you enter for the `emailBody` and `emailSubject` of the notification is not translated, and appears exactly as you enter it. For more information, see Set Recipient Language and Specify Custom Email Messages. More... | |
ApiResponse< SupportedLanguages > | GetSupportedLanguagesWithHttpInfo (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's email notification, this setting affects elements such as the standard introductory text describing the request to sign. It also determines the language used for buttons and tabs in both the email notification and the signing experience. Note: Setting a language for a recipient affects only the DocuSign standard text. Any custom text that you enter for the `emailBody` and `emailSubject` of the notification is not translated, and appears exactly as you enter it. For more information, see Set Recipient Language and Specify Custom Email Messages. More... | |
async System.Threading.Tasks.Task< SupportedLanguages > | GetSupportedLanguagesAsync (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's email notification, this setting affects elements such as the standard introductory text describing the request to sign. It also determines the language used for buttons and tabs in both the email notification and the signing experience. Note: Setting a language for a recipient affects only the DocuSign standard text. Any custom text that you enter for the `emailBody` and `emailSubject` of the notification is not translated, and appears exactly as you enter it. For more information, see Set Recipient Language and Specify Custom Email Messages. 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's email notification, this setting affects elements such as the standard introductory text describing the request to sign. It also determines the language used for buttons and tabs in both the email notification and the signing experience. Note: Setting a language for a recipient affects only the DocuSign standard text. Any custom text that you enter for the `emailBody` and `emailSubject` of the notification is not translated, and appears exactly as you enter it. For more information, see Set Recipient Language and Specify Custom Email Messages. More... | |
UserAuthorization | GetUserAuthorization (string accountId, string userId, string authorizationId) |
Returns the user authorization for a given authorization id More... | |
ApiResponse< UserAuthorization > | GetUserAuthorizationWithHttpInfo (string accountId, string userId, string authorizationId) |
Returns the user authorization for a given authorization id More... | |
async System.Threading.Tasks.Task< UserAuthorization > | GetUserAuthorizationAsync (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< Watermark > | GetWatermarkWithHttpInfo (string accountId) |
Get watermark information. More... | |
async System.Threading.Tasks.Task< Watermark > | GetWatermarkAsync (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< Watermark > | GetWatermarkPreviewWithHttpInfo (string accountId, Watermark watermark=null) |
Get watermark preview. More... | |
async System.Threading.Tasks.Task< Watermark > | GetWatermarkPreviewAsync (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 `canSelfBrandSend` and `canSelfBrandSend`) must be set to true for the account to use this call. More... | |
ApiResponse< BrandsResponse > | ListBrandsWithHttpInfo (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 `canSelfBrandSend` and `canSelfBrandSend`) must be set to true for the account to use this call. More... | |
async System.Threading.Tasks.Task< BrandsResponse > | ListBrandsAsync (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 `canSelfBrandSend` and `canSelfBrandSend`) 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 `canSelfBrandSend` and `canSelfBrandSend`) 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< CustomFields > | ListCustomFieldsWithHttpInfo (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< CustomFields > | ListCustomFieldsAsync (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< PermissionProfileInformation > | ListPermissionsWithHttpInfo (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< PermissionProfileInformation > | ListPermissionsAsync (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< RecipientNamesResponse > | ListRecipientNamesByEmailWithHttpInfo (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< RecipientNamesResponse > | ListRecipientNamesByEmailAsync (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< AccountSettingsInformation > | ListSettingsWithHttpInfo (string accountId) |
Gets account settings information. Retrieves the account settings information for the specified account. More... | |
async System.Threading.Tasks.Task< AccountSettingsInformation > | ListSettingsAsync (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=shared_from. More... | |
ApiResponse< AccountSharedAccess > | ListSharedAccessWithHttpInfo (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=shared_from. More... | |
async System.Threading.Tasks.Task< AccountSharedAccess > | ListSharedAccessAsync (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=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=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< AccountSignatureProviders > | ListSignatureProvidersWithHttpInfo (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< AccountSignatureProviders > | ListSignatureProvidersAsync (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< FileTypeList > | ListUnsupportedFileTypesWithHttpInfo (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< FileTypeList > | ListUnsupportedFileTypesAsync (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< FavoriteTemplatesInfo > | UnFavoriteTemplateWithHttpInfo (string accountId, FavoriteTemplatesInfo favoriteTemplatesInfo=null) |
Unfavorite a template More... | |
async System.Threading.Tasks.Task< FavoriteTemplatesInfo > | UnFavoriteTemplateAsync (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< AccountSignaturesInformation > | UpdateAccountSignatureWithHttpInfo (string accountId, AccountSignaturesInformation accountSignaturesInformation=null) |
Updates a account signature. More... | |
async System.Threading.Tasks.Task< AccountSignaturesInformation > | UpdateAccountSignatureAsync (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< AccountSignature > | UpdateAccountSignatureByIdWithHttpInfo (string accountId, string signatureId, AccountSignatureDefinition accountSignatureDefinition=null, AccountsApi.UpdateAccountSignatureByIdOptions options=null) |
Updates a account signature. More... | |
async System.Threading.Tasks.Task< AccountSignature > | UpdateAccountSignatureByIdAsync (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< AccountSignature > | UpdateAccountSignatureImageWithHttpInfo (string accountId, string signatureId, string imageType, AccountsApi.UpdateAccountSignatureImageOptions options=null) |
Sets a signature, initials, or stamps image. More... | |
async System.Threading.Tasks.Task< AccountSignature > | UpdateAccountSignatureImageAsync (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< TabAccountSettings > | UpdateAccountTabSettingsWithHttpInfo (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< TabAccountSettings > | UpdateAccountTabSettingsAsync (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 (`canSelfBrandSend` , `canSelfBrandSign`, or both of these account settings must be true). More... | |
ApiResponse< Brand > | UpdateBrandWithHttpInfo (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 (`canSelfBrandSend` , `canSelfBrandSign`, or both of these account settings must be true). More... | |
async System.Threading.Tasks.Task< Brand > | UpdateBrandAsync (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 (`canSelfBrandSend` , `canSelfBrandSign`, 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 (`canSelfBrandSend` , `canSelfBrandSign`, 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 `Content-Disposition` header. Example: `Content-Disposition: form-data; name="file"; filename="logo.jpg"` Note: Branding for either signing or sending must be enabled for the account (`canSelfBrandSend` , `canSelfBrandSign`, or both of these account settings must be true). 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 `Content-Disposition` header. Example: `Content-Disposition: form-data; name="file"; filename="logo.jpg"` Note: Branding for either signing or sending must be enabled for the account (`canSelfBrandSend` , `canSelfBrandSign`, or both of these account settings must be true). 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 `Content-Disposition` header. Example: `Content-Disposition: form-data; name="file"; filename="logo.jpg"` Note: Branding for either signing or sending must be enabled for the account (`canSelfBrandSend` , `canSelfBrandSign`, or both of these account settings must be true). 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 `Content-Disposition` header. Example: `Content-Disposition: form-data; name="file"; filename="logo.jpg"` Note: Branding for either signing or sending must be enabled for the account (`canSelfBrandSend` , `canSelfBrandSign`, or both of these account settings must be true). 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 `Content-Disposition` header. Example: `Content-Disposition: form-data; name="file"; filename="DocuSign_SigningResource_4328673.xml"` Note: Branding for either signing or sending must be enabled for the account (`canSelfBrandSend` , `canSelfBrandSign`, or both of these account settings must be true). Important: Customizing resource files is an advanced branding configuration option which can significantly impact your account, and should be done only by someone with expertise in XML and HTML. The master resource files are subject to change without notice. If you customize your resource files, after each release, DocuSign recommends you review any changes and update your custom files as needed. When you upload a modified resource file, only the elements that differ from the master resource file are saved as your resource file. Similarly, when you download your resource files, only the modified elements are included in the file. More... | |
ApiResponse< BrandResources > | UpdateBrandResourcesByContentTypeWithHttpInfo (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 `Content-Disposition` header. Example: `Content-Disposition: form-data; name="file"; filename="DocuSign_SigningResource_4328673.xml"` Note: Branding for either signing or sending must be enabled for the account (`canSelfBrandSend` , `canSelfBrandSign`, or both of these account settings must be true). Important: Customizing resource files is an advanced branding configuration option which can significantly impact your account, and should be done only by someone with expertise in XML and HTML. The master resource files are subject to change without notice. If you customize your resource files, after each release, DocuSign recommends you review any changes and update your custom files as needed. When you upload a modified resource file, only the elements that differ from the master resource file are saved as your resource file. Similarly, when you download your resource files, only the modified elements are included in the file. More... | |
async System.Threading.Tasks.Task< BrandResources > | UpdateBrandResourcesByContentTypeAsync (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 `Content-Disposition` header. Example: `Content-Disposition: form-data; name="file"; filename="DocuSign_SigningResource_4328673.xml"` Note: Branding for either signing or sending must be enabled for the account (`canSelfBrandSend` , `canSelfBrandSign`, or both of these account settings must be true). Important: Customizing resource files is an advanced branding configuration option which can significantly impact your account, and should be done only by someone with expertise in XML and HTML. The master resource files are subject to change without notice. If you customize your resource files, after each release, DocuSign recommends you review any changes and update your custom files as needed. When you upload a modified resource file, only the elements that differ from the master resource file are saved as your resource file. Similarly, when you download your resource files, only the modified elements are included in the file. 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 `Content-Disposition` header. Example: `Content-Disposition: form-data; name="file"; filename="DocuSign_SigningResource_4328673.xml"` Note: Branding for either signing or sending must be enabled for the account (`canSelfBrandSend` , `canSelfBrandSign`, or both of these account settings must be true). Important: Customizing resource files is an advanced branding configuration option which can significantly impact your account, and should be done only by someone with expertise in XML and HTML. The master resource files are subject to change without notice. If you customize your resource files, after each release, DocuSign recommends you review any changes and update your custom files as needed. When you upload a modified resource file, only the elements that differ from the master resource file are saved as your resource file. Similarly, when you download your resource files, only the modified elements are included in the file. 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 `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... | |
ApiResponse< ConsumerDisclosure > | UpdateConsumerDisclosureWithHttpInfo (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 `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... | |
async System.Threading.Tasks.Task< ConsumerDisclosure > | UpdateConsumerDisclosureAsync (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 `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... | |
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 `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... | |
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< CustomFields > | UpdateCustomFieldWithHttpInfo (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< CustomFields > | UpdateCustomFieldAsync (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< ENoteConfiguration > | UpdateENoteConfigurationWithHttpInfo (string accountId, ENoteConfiguration eNoteConfiguration=null) |
Updates configuration information for the eNote eOriginal integration. More... | |
async System.Threading.Tasks.Task< ENoteConfiguration > | UpdateENoteConfigurationAsync (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 (`retentionDays`). This method sets the envelope purge configuration for your account. Note: To use this method, you must be an account administrator. For more information, see Purge Envelopes. More... | |
ApiResponse< EnvelopePurgeConfiguration > | UpdateEnvelopePurgeConfigurationWithHttpInfo (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 (`retentionDays`). This method sets the envelope purge configuration for your account. Note: To use this method, you must be an account administrator. For more information, see Purge Envelopes. More... | |
async System.Threading.Tasks.Task< EnvelopePurgeConfiguration > | UpdateEnvelopePurgeConfigurationAsync (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 (`retentionDays`). This method sets the envelope purge configuration for your account. Note: To use this method, you must be an account administrator. For more information, see Purge Envelopes. 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 (`retentionDays`). This method sets the envelope purge configuration for your account. Note: To use this method, you must be an account administrator. For more information, see Purge Envelopes. More... | |
FavoriteTemplatesInfo | UpdateFavoriteTemplate (string accountId, FavoriteTemplatesInfo favoriteTemplatesInfo=null) |
Favorites a template More... | |
ApiResponse< FavoriteTemplatesInfo > | UpdateFavoriteTemplateWithHttpInfo (string accountId, FavoriteTemplatesInfo favoriteTemplatesInfo=null) |
Favorites a template More... | |
async System.Threading.Tasks.Task< FavoriteTemplatesInfo > | UpdateFavoriteTemplateAsync (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< NotificationDefaults > | UpdateNotificationDefaultsWithHttpInfo (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< NotificationDefaults > | UpdateNotificationDefaultsAsync (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< AccountPasswordRules > | UpdatePasswordRulesWithHttpInfo (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< AccountPasswordRules > | UpdatePasswordRulesAsync (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< PermissionProfile > | UpdatePermissionProfileWithHttpInfo (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< PermissionProfile > | UpdatePermissionProfileAsync (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< AccountSharedAccess > | UpdateSharedAccessWithHttpInfo (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< AccountSharedAccess > | UpdateSharedAccessAsync (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< UserAuthorization > | UpdateUserAuthorizationWithHttpInfo (string accountId, string userId, string authorizationId, UserAuthorizationUpdateRequest userAuthorizationUpdateRequest=null) |
Updates the user authorization More... | |
async System.Threading.Tasks.Task< UserAuthorization > | UpdateUserAuthorizationAsync (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< Watermark > | UpdateWatermarkWithHttpInfo (string accountId, Watermark watermark=null) |
Update watermark information. More... | |
async System.Threading.Tasks.Task< Watermark > | UpdateWatermarkAsync (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< NewAccountSummary > | CreateWithHttpInfo (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< AccountSignaturesInformation > | CreateAccountSignaturesWithHttpInfo (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< CustomFields > | CreateCustomFieldWithHttpInfo (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< PermissionProfile > | CreatePermissionProfileWithHttpInfo (string accountId, PermissionProfile permissionProfile=null, AccountsApi.CreatePermissionProfileOptions options=null) |
Creates a new permission profile in the specified account. More... | |
void | Delete (string accountId, AccountsApi.DeleteOptions options=null) |
Deletes the specified account. More... | |
ApiResponse< Object > | DeleteWithHttpInfo (string accountId, AccountsApi.DeleteOptions options=null) |
Deletes 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... | |
AccountIdentityVerificationResponse | GetAccountIdentityVerification (string accountId, AccountsApi.GetAccountIdentityVerificationOptions options=null) |
Get the list of identity verification options for an account More... | |
ApiResponse< AccountIdentityVerificationResponse > | GetAccountIdentityVerificationWithHttpInfo (string accountId, AccountsApi.GetAccountIdentityVerificationOptions options=null) |
Get the list of identity verification options for an account More... | |
AccountInformation | GetAccountInformation (string accountId, AccountsApi.GetAccountInformationOptions options=null) |
Retrieves the account information for the specified account. More... | |
ApiResponse< AccountInformation > | GetAccountInformationWithHttpInfo (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< AccountSignaturesInformation > | GetAccountSignaturesWithHttpInfo (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< UserAuthorizations > | GetAgentUserAuthorizationsWithHttpInfo (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< BillingChargeResponse > | GetBillingChargesWithHttpInfo (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< Brand > | GetBrandWithHttpInfo (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< ConsumerDisclosure > | GetConsumerDisclosureDefaultWithHttpInfo (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< PermissionProfile > | GetPermissionProfileWithHttpInfo (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< UserAuthorizations > | GetPrincipalUserAuthorizationsWithHttpInfo (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< BrandsResponse > | ListBrandsWithHttpInfo (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< PermissionProfileInformation > | ListPermissionsWithHttpInfo (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< RecipientNamesResponse > | ListRecipientNamesByEmailWithHttpInfo (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< AccountSharedAccess > | ListSharedAccessWithHttpInfo (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< AccountSignature > | UpdateAccountSignatureByIdWithHttpInfo (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< AccountSignature > | UpdateAccountSignatureImageWithHttpInfo (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< Brand > | UpdateBrandWithHttpInfo (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< ConsumerDisclosure > | UpdateConsumerDisclosureWithHttpInfo (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< CustomFields > | UpdateCustomFieldWithHttpInfo (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< PermissionProfile > | UpdatePermissionProfileWithHttpInfo (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< AccountSharedAccess > | UpdateSharedAccessWithHttpInfo (string accountId, AccountSharedAccess accountSharedAccess=null, AccountsApi.UpdateSharedAccessOptions options=null) |
Reserved: Sets the shared access information for users. More... | |
System.Threading.Tasks.Task< NewAccountSummary > | CreateAsync (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< AccountSignaturesInformation > | CreateAccountSignaturesAsync (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< CustomFields > | CreateCustomFieldAsync (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< PermissionProfile > | CreatePermissionProfileAsync (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 | DeleteAsync (string accountId, AccountsApi.DeleteOptions options=null) |
Deletes the specified account. More... | |
System.Threading.Tasks.Task< ApiResponse< Object > > | DeleteAsyncWithHttpInfo (string accountId, AccountsApi.DeleteOptions options=null) |
Deletes 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< AccountIdentityVerificationResponse > | GetAccountIdentityVerificationAsync (string accountId, AccountsApi.GetAccountIdentityVerificationOptions options=null) |
Get the list of identity verification options for an account More... | |
System.Threading.Tasks.Task< ApiResponse< AccountIdentityVerificationResponse > > | GetAccountIdentityVerificationAsyncWithHttpInfo (string accountId, AccountsApi.GetAccountIdentityVerificationOptions options=null) |
Get the list of identity verification options for an account More... | |
System.Threading.Tasks.Task< AccountInformation > | GetAccountInformationAsync (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< AccountSignaturesInformation > | GetAccountSignaturesAsync (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< UserAuthorizations > | GetAgentUserAuthorizationsAsync (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< BillingChargeResponse > | GetBillingChargesAsync (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< Brand > | GetBrandAsync (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< ConsumerDisclosure > | GetConsumerDisclosureDefaultAsync (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< PermissionProfile > | GetPermissionProfileAsync (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< UserAuthorizations > | GetPrincipalUserAuthorizationsAsync (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< BrandsResponse > | ListBrandsAsync (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< PermissionProfileInformation > | ListPermissionsAsync (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< RecipientNamesResponse > | ListRecipientNamesByEmailAsync (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< AccountSharedAccess > | ListSharedAccessAsync (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< AccountSignature > | UpdateAccountSignatureByIdAsync (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< AccountSignature > | UpdateAccountSignatureImageAsync (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< Brand > | UpdateBrandAsync (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< ConsumerDisclosure > | UpdateConsumerDisclosureAsync (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< CustomFields > | UpdateCustomFieldAsync (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< PermissionProfile > | UpdatePermissionProfileAsync (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< AccountSharedAccess > | UpdateSharedAccessAsync (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... | |
Represents a collection of functions to interact with the API endpoints
|
inline |
Initializes a new instance of the AccountsApi class using AplClient object
aplClient | An instance of AplClient |
|
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 `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.
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
newAccountDefinition | (optional) |
options | Options for modifying the behavior of the function. |
|
inline |
Adds/updates one or more account signatures. This request may include images in multi-part format.
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
accountSignaturesInformation | (optional) |
options | Options for modifying the behavior of the function. |
|
inline |
Adds/updates one or more account signatures. This request may include images in multi-part format.
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
accountSignaturesInformation | (optional) |
options | Options for modifying the behavior of the function. |
|
inline |
Adds/updates one or more account signatures. This request may include images in multi-part format.
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
accountSignaturesInformation | (optional) |
options | Options for modifying the behavior of the function. |
|
inline |
Adds/updates one or more account signatures. This request may include images in multi-part format.
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
accountSignaturesInformation | (optional) |
options | Options for modifying the behavior of the function. |
|
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 `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.
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
newAccountDefinition | (optional) |
options | Options for modifying the behavior of the function. |
|
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 `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.
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
newAccountDefinition | (optional) |
options | Options for modifying the behavior of the function. |
|
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 `canSelfBrandSend` and `canSelfBrandSig`) must be set to true for the account to use this call. An error is returned if `brandId` property for a brand profile is already set for the account. To upload a new version of an existing brand profile, you must delete the profile and then upload the newer version. When brand profile files are being uploaded, they must be combined into one zip file and the `Content-Type` must be `application/zip`.
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID GUID. |
brand | (optional) |
Implements DocuSign.eSign.Api.IAccountsApi.
|
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 `canSelfBrandSend` and `canSelfBrandSig`) must be set to true for the account to use this call. An error is returned if `brandId` property for a brand profile is already set for the account. To upload a new version of an existing brand profile, you must delete the profile and then upload the newer version. When brand profile files are being uploaded, they must be combined into one zip file and the `Content-Type` must be `application/zip`.
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID GUID. |
brand | (optional) |
Implements DocuSign.eSign.Api.IAccountsApi.
|
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 `canSelfBrandSend` and `canSelfBrandSig`) must be set to true for the account to use this call. An error is returned if `brandId` property for a brand profile is already set for the account. To upload a new version of an existing brand profile, you must delete the profile and then upload the newer version. When brand profile files are being uploaded, they must be combined into one zip file and the `Content-Type` must be `application/zip`.
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID GUID. |
brand | (optional) |
Implements DocuSign.eSign.Api.IAccountsApi.
|
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 `canSelfBrandSend` and `canSelfBrandSig`) must be set to true for the account to use this call. An error is returned if `brandId` property for a brand profile is already set for the account. To upload a new version of an existing brand profile, you must delete the profile and then upload the newer version. When brand profile files are being uploaded, they must be combined into one zip file and the `Content-Type` must be `application/zip`.
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID GUID. |
brand | (optional) |
Implements DocuSign.eSign.Api.IAccountsApi.
|
inline |
Creates an acount custom field. This method creates a custom field and makes it available for all new envelopes associated with an account.
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
customField | (optional) |
options | Options for modifying the behavior of the function. |
|
inline |
Creates an acount custom field. This method creates a custom field and makes it available for all new envelopes associated with an account.
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
customField | (optional) |
options | Options for modifying the behavior of the function. |
|
inline |
Creates an acount custom field. This method creates a custom field and makes it available for all new envelopes associated with an account.
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
customField | (optional) |
options | Options for modifying the behavior of the function. |
|
inline |
Creates an acount custom field. This method creates a custom field and makes it available for all new envelopes associated with an account.
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
customField | (optional) |
options | Options for modifying the behavior of the function. |
|
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
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
permissionProfile | (optional) |
options | Options for modifying the behavior of the function. |
|
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
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
permissionProfile | (optional) |
options | Options for modifying the behavior of the function. |
|
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
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
permissionProfile | (optional) |
options | Options for modifying the behavior of the function. |
|
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
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
permissionProfile | (optional) |
options | Options for modifying the behavior of the function. |
|
inline |
Creates the user authorization
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
userId | The 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) |
Implements DocuSign.eSign.Api.IAccountsApi.
|
inline |
Creates the user authorization
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
userId | The 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) |
Implements DocuSign.eSign.Api.IAccountsApi.
|
inline |
Creates the user authorization
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
userId | The 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) |
Implements DocuSign.eSign.Api.IAccountsApi.
|
inline |
Creates ot updates user authorizations
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
userId | The 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) |
Implements DocuSign.eSign.Api.IAccountsApi.
|
inline |
Creates ot updates user authorizations
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
userId | The 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) |
Implements DocuSign.eSign.Api.IAccountsApi.
|
inline |
Creates ot updates user authorizations
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
userId | The 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) |
Implements DocuSign.eSign.Api.IAccountsApi.
|
inline |
Creates ot updates user authorizations
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
userId | The 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) |
Implements DocuSign.eSign.Api.IAccountsApi.
|
inline |
Creates the user authorization
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
userId | The 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) |
Implements DocuSign.eSign.Api.IAccountsApi.
|
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 `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.
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
newAccountDefinition | (optional) |
options | Options for modifying the behavior of the function. |
|
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.
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
options | Options for modifying the behavior of the function. |
|
inline |
Close the specified signature by Id.
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
signatureId | The ID of the signature being accessed. |
Implements DocuSign.eSign.Api.IAccountsApi.
|
inline |
Close the specified signature by Id.
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
signatureId | The ID of the signature being accessed. |
Implements DocuSign.eSign.Api.IAccountsApi.
|
inline |
Close the specified signature by Id.
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
signatureId | The ID of the signature being accessed. |
Implements DocuSign.eSign.Api.IAccountsApi.
|
inline |
Deletes a signature, initials, or stamps image.
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
signatureId | The ID of the signature being accessed. |
imageType | One of signature_image or initials_image. |
Implements DocuSign.eSign.Api.IAccountsApi.
|
inline |
Deletes a signature, initials, or stamps image.
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
signatureId | The ID of the signature being accessed. |
imageType | One of signature_image or initials_image. |
Implements DocuSign.eSign.Api.IAccountsApi.
|
inline |
Deletes a signature, initials, or stamps image.
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
signatureId | The ID of the signature being accessed. |
imageType | One of signature_image or initials_image. |
Implements DocuSign.eSign.Api.IAccountsApi.
|
inline |
Deletes a signature, initials, or stamps image.
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
signatureId | The ID of the signature being accessed. |
imageType | One of signature_image or initials_image. |
Implements DocuSign.eSign.Api.IAccountsApi.
|
inline |
Close the specified signature by Id.
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
signatureId | The ID of the signature being accessed. |
Implements DocuSign.eSign.Api.IAccountsApi.
|
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.
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
options | Options for modifying the behavior of the function. |
|
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.
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
options | Options for modifying the behavior of the function. |
|
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 (`canSelfBrandSend` , `canSelfBrandSign`, or both of these account settings must be true).
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
brandId | The unique identifier of a brand. |
Implements DocuSign.eSign.Api.IAccountsApi.
|
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 (`canSelfBrandSend` , `canSelfBrandSign`, or both of these account settings must be true).
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
brandId | The unique identifier of a brand. |
Implements DocuSign.eSign.Api.IAccountsApi.
|
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 (`canSelfBrandSend` , `canSelfBrandSign`, or both of these account settings must be true).
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
brandId | The unique identifier of a brand. |
Implements DocuSign.eSign.Api.IAccountsApi.
|
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 (`canSelfBrandSend` , `canSelfBrandSign`, or both of these account settings must be true).
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
brandId | The unique identifier of a brand. |
logoType | One of Primary, Secondary or Email. |
Implements DocuSign.eSign.Api.IAccountsApi.
|
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 (`canSelfBrandSend` , `canSelfBrandSign`, or both of these account settings must be true).
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
brandId | The unique identifier of a brand. |
logoType | One of Primary, Secondary or Email. |
Implements DocuSign.eSign.Api.IAccountsApi.
|
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 (`canSelfBrandSend` , `canSelfBrandSign`, or both of these account settings must be true).
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
brandId | The unique identifier of a brand. |
logoType | One of Primary, Secondary or Email. |
Implements DocuSign.eSign.Api.IAccountsApi.
|
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 (`canSelfBrandSend` , `canSelfBrandSign`, or both of these account settings must be true).
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
brandId | The unique identifier of a brand. |
logoType | One of Primary, Secondary or Email. |
Implements DocuSign.eSign.Api.IAccountsApi.
|
inline |
Deletes one or more brand profiles. Deletes one or more brand profiles from an account. The Account Branding feature (accountSettings properties `canSelfBrandSend` and `canSelfBrandSend`) must be set to true to use this call.
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
brandsRequest | (optional) |
Implements DocuSign.eSign.Api.IAccountsApi.
|
inline |
Deletes one or more brand profiles. Deletes one or more brand profiles from an account. The Account Branding feature (accountSettings properties `canSelfBrandSend` and `canSelfBrandSend`) must be set to true to use this call.
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
brandsRequest | (optional) |
Implements DocuSign.eSign.Api.IAccountsApi.
|
inline |
Deletes one or more brand profiles. Deletes one or more brand profiles from an account. The Account Branding feature (accountSettings properties `canSelfBrandSend` and `canSelfBrandSend`) must be set to true to use this call.
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
brandsRequest | (optional) |
Implements DocuSign.eSign.Api.IAccountsApi.
|
inline |
Deletes one or more brand profiles. Deletes one or more brand profiles from an account. The Account Branding feature (accountSettings properties `canSelfBrandSend` and `canSelfBrandSend`) must be set to true to use this call.
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
brandsRequest | (optional) |
Implements DocuSign.eSign.Api.IAccountsApi.
|
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 (`canSelfBrandSend` , `canSelfBrandSign`, or both of these account settings must be true).
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
brandId | The unique identifier of a brand. |
Implements DocuSign.eSign.Api.IAccountsApi.
|
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.
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
recipientPart | |
captiveRecipientInformation | (optional) |
Implements DocuSign.eSign.Api.IAccountsApi.
|
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.
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
recipientPart | |
captiveRecipientInformation | (optional) |
Implements DocuSign.eSign.Api.IAccountsApi.
|
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.
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
recipientPart | |
captiveRecipientInformation | (optional) |
Implements DocuSign.eSign.Api.IAccountsApi.
|
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.
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
recipientPart | |
captiveRecipientInformation | (optional) |
Implements DocuSign.eSign.Api.IAccountsApi.
|
inline |
Delete an existing account custom field. This method deletes an existing account custom field.
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
customFieldId | |
options | Options for modifying the behavior of the function. |
|
inline |
Delete an existing account custom field. This method deletes an existing account custom field.
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
customFieldId | |
options | Options for modifying the behavior of the function. |
|
inline |
Delete an existing account custom field. This method deletes an existing account custom field.
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
customFieldId | |
options | Options for modifying the behavior of the function. |
|
inline |
Delete an existing account custom field. This method deletes an existing account custom field.
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
customFieldId | |
options | Options for modifying the behavior of the function. |
|
inline |
Deletes configuration information for the eNote eOriginal integration.
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
Implements DocuSign.eSign.Api.IAccountsApi.
|
inline |
Deletes configuration information for the eNote eOriginal integration.
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
Implements DocuSign.eSign.Api.IAccountsApi.
|
inline |
Deletes configuration information for the eNote eOriginal integration.
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
Implements DocuSign.eSign.Api.IAccountsApi.
|
inline |
Deletes configuration information for the eNote eOriginal integration.
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
Implements DocuSign.eSign.Api.IAccountsApi.
|
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 `move_users_to` query parameter. ### Related topics - How to delete a permission profile
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
permissionProfileId | |
options | Options for modifying the behavior of the function. |
|
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 `move_users_to` query parameter. ### Related topics - How to delete a permission profile
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
permissionProfileId | |
options | Options for modifying the behavior of the function. |
|
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 `move_users_to` query parameter. ### Related topics - How to delete a permission profile
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
permissionProfileId | |
options | Options for modifying the behavior of the function. |
|
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 `move_users_to` query parameter. ### Related topics - How to delete a permission profile
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
permissionProfileId | |
options | Options for modifying the behavior of the function. |
|
inline |
Deletes the user authorization
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
userId | The 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 |
Implements DocuSign.eSign.Api.IAccountsApi.
|
inline |
Deletes the user authorization
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
userId | The 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 |
Implements DocuSign.eSign.Api.IAccountsApi.
|
inline |
Deletes the user authorization
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
userId | The 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 |
Implements DocuSign.eSign.Api.IAccountsApi.
|
inline |
Creates ot updates user authorizations
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
userId | The 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) |
Implements DocuSign.eSign.Api.IAccountsApi.
|
inline |
Creates ot updates user authorizations
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
userId | The 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) |
Implements DocuSign.eSign.Api.IAccountsApi.
|
inline |
Creates ot updates user authorizations
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
userId | The 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) |
Implements DocuSign.eSign.Api.IAccountsApi.
|
inline |
Creates ot updates user authorizations
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
userId | The 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) |
Implements DocuSign.eSign.Api.IAccountsApi.
|
inline |
Deletes the user authorization
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
userId | The 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 |
Implements DocuSign.eSign.Api.IAccountsApi.
|
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.
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
options | Options for modifying the behavior of the function. |
|
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
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
options | Options for modifying the behavior of the function. |
|
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
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
options | Options for modifying the behavior of the function. |
|
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
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
options | Options for modifying the behavior of the function. |
|
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
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
options | Options for modifying the behavior of the function. |
|
inline |
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.
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
options | Options for modifying the behavior of the function. |
|
inline |
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.
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
options | Options for modifying the behavior of the function. |
|
inline |
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.
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
options | Options for modifying the behavior of the function. |
|
inline |
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.
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
options | Options for modifying the behavior of the function. |
|
inline |
Returns information about a single signature by specifed signatureId.
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
signatureId | The ID of the signature being accessed. |
Implements DocuSign.eSign.Api.IAccountsApi.
|
inline |
Returns information about a single signature by specifed signatureId.
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
signatureId | The ID of the signature being accessed. |
Implements DocuSign.eSign.Api.IAccountsApi.
|
inline |
Returns information about a single signature by specifed signatureId.
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
signatureId | The ID of the signature being accessed. |
Implements DocuSign.eSign.Api.IAccountsApi.
|
inline |
Returns a signature, initials, or stamps image.
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
signatureId | The ID of the signature being accessed. |
imageType | One of signature_image or initials_image. |
options | Options for modifying the behavior of the function. |
|
inline |
Returns a signature, initials, or stamps image.
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
signatureId | The ID of the signature being accessed. |
imageType | One of signature_image or initials_image. |
options | Options for modifying the behavior of the function. |
|
inline |
Returns a signature, initials, or stamps image.
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
signatureId | The ID of the signature being accessed. |
imageType | One of signature_image or initials_image. |
options | Options for modifying the behavior of the function. |
|
inline |
Returns a signature, initials, or stamps image.
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
signatureId | The ID of the signature being accessed. |
imageType | One of signature_image or initials_image. |
options | Options for modifying the behavior of the function. |
|
inline |
Returns the managed signature definitions for the account
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
options | Options for modifying the behavior of the function. |
|
inline |
Returns the managed signature definitions for the account
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
options | Options for modifying the behavior of the function. |
|
inline |
Returns the managed signature definitions for the account
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
options | Options for modifying the behavior of the function. |
|
inline |
Returns the managed signature definitions for the account
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
options | Options for modifying the behavior of the function. |
|
inline |
Returns information about a single signature by specifed signatureId.
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
signatureId | The ID of the signature being accessed. |
Implements DocuSign.eSign.Api.IAccountsApi.
|
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.
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
Implements DocuSign.eSign.Api.IAccountsApi.
|
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.
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
Implements DocuSign.eSign.Api.IAccountsApi.
|
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.
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
Implements DocuSign.eSign.Api.IAccountsApi.
|
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.
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
Implements DocuSign.eSign.Api.IAccountsApi.
|
inline |
Returns the agent user authorizations
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
userId | The 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. |
options | Options for modifying the behavior of the function. |
|
inline |
Returns the agent user authorizations
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
userId | The 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. |
options | Options for modifying the behavior of the function. |
|
inline |
Returns the agent user authorizations
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
userId | The 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. |
options | Options for modifying the behavior of the function. |
|
inline |
Returns the agent user authorizations
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
userId | The 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. |
options | Options for modifying the behavior of the function. |
|
inline |
Get all payment gateway account for the provided accountId This method returns a list of payment gateway accounts and basic information about them.
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
Implements DocuSign.eSign.Api.IAccountsApi.
|
inline |
Get all payment gateway account for the provided accountId This method returns a list of payment gateway accounts and basic information about them.
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
Implements DocuSign.eSign.Api.IAccountsApi.
|
inline |
Get all payment gateway account for the provided accountId This method returns a list of payment gateway accounts and basic information about them.
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
Implements DocuSign.eSign.Api.IAccountsApi.
|
inline |
Get all payment gateway account for the provided accountId This method returns a list of payment gateway accounts and basic information about them.
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
Implements DocuSign.eSign.Api.IAccountsApi.
|
inline |
|
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
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
options | Options for modifying the behavior of the function. |
|
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
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
options | Options for modifying the behavior of the function. |
|
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
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
options | Options for modifying the behavior of the function. |
|
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
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
options | Options for modifying the behavior of the function. |
|
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 (`canSelfBrandSend` , `canSelfBrandSign`, or both of these account settings must be true).
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
brandId | The unique identifier of a brand. |
options | Options for modifying the behavior of the function. |
|
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 (`canSelfBrandSend` , `canSelfBrandSign`, or both of these account settings must be true).
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
brandId | The unique identifier of a brand. |
options | Options for modifying the behavior of the function. |
|
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 (`canSelfBrandSend` , `canSelfBrandSign`, or both of these account settings must be true).
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
brandId | The unique identifier of a brand. |
options | Options for modifying the behavior of the function. |
|
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 (`canSelfBrandSend` , `canSelfBrandSign`, or both of these account settings must be true).
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
brandId | The unique identifier of a brand. |
Implements DocuSign.eSign.Api.IAccountsApi.
|
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 (`canSelfBrandSend` , `canSelfBrandSign`, or both of these account settings must be true).
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
brandId | The unique identifier of a brand. |
Implements DocuSign.eSign.Api.IAccountsApi.
|
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 (`canSelfBrandSend` , `canSelfBrandSign`, or both of these account settings must be true).
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
brandId | The unique identifier of a brand. |
Implements DocuSign.eSign.Api.IAccountsApi.
|
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 (`canSelfBrandSend` , `canSelfBrandSign`, or both of these account settings must be true).
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
brandId | The unique identifier of a brand. |
Implements DocuSign.eSign.Api.IAccountsApi.
|
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 (`canSelfBrandSend` , `canSelfBrandSign`, or both of these account settings must be true).
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
brandId | The unique identifier of a brand. |
logoType | One of Primary, Secondary or Email. |
Implements DocuSign.eSign.Api.IAccountsApi.
|
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 (`canSelfBrandSend` , `canSelfBrandSign`, or both of these account settings must be true).
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
brandId | The unique identifier of a brand. |
logoType | One of Primary, Secondary or Email. |
Implements DocuSign.eSign.Api.IAccountsApi.
|
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 (`canSelfBrandSend` , `canSelfBrandSign`, or both of these account settings must be true).
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
brandId | The unique identifier of a brand. |
logoType | One of Primary, Secondary or Email. |
Implements DocuSign.eSign.Api.IAccountsApi.
|
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 (`canSelfBrandSend` , `canSelfBrandSign`, or both of these account settings must be true).
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
brandId | The unique identifier of a brand. |
logoType | One of Primary, Secondary or Email. |
Implements DocuSign.eSign.Api.IAccountsApi.
|
inline |
Returns the specified account's list of branding resources (metadata). This method returns metadata about the branding resources that are associated with an account. Note: Branding for either signing or sending must be enabled for the account (`canSelfBrandSend` , `canSelfBrandSign`, or both of these account settings must be true).
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
brandId | The unique identifier of a brand. |
Implements DocuSign.eSign.Api.IAccountsApi.
|
inline |
Returns the specified account's list of branding resources (metadata). This method returns metadata about the branding resources that are associated with an account. Note: Branding for either signing or sending must be enabled for the account (`canSelfBrandSend` , `canSelfBrandSign`, or both of these account settings must be true).
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
brandId | The unique identifier of a brand. |
Implements DocuSign.eSign.Api.IAccountsApi.
|
inline |
Returns the specified account's list of branding resources (metadata). This method returns metadata about the branding resources that are associated with an account. Note: Branding for either signing or sending must be enabled for the account (`canSelfBrandSend` , `canSelfBrandSign`, or both of these account settings must be true).
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
brandId | The unique identifier of a brand. |
Implements DocuSign.eSign.Api.IAccountsApi.
|
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 (`canSelfBrandSend` , `canSelfBrandSign`, or both of these account settings must be true).
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
brandId | The unique identifier of a brand. |
resourceContentType | |
options | Options for modifying the behavior of the function. |
|
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 (`canSelfBrandSend` , `canSelfBrandSign`, or both of these account settings must be true).
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
brandId | The unique identifier of a brand. |
resourceContentType | |
options | Options for modifying the behavior of the function. |
|
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 (`canSelfBrandSend` , `canSelfBrandSign`, or both of these account settings must be true).
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
brandId | The unique identifier of a brand. |
resourceContentType | |
options | Options for modifying the behavior of the function. |
|
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 (`canSelfBrandSend` , `canSelfBrandSign`, or both of these account settings must be true).
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
brandId | The unique identifier of a brand. |
resourceContentType | |
options | Options for modifying the behavior of the function. |
|
inline |
Returns the specified account's list of branding resources (metadata). This method returns metadata about the branding resources that are associated with an account. Note: Branding for either signing or sending must be enabled for the account (`canSelfBrandSend` , `canSelfBrandSign`, or both of these account settings must be true).
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
brandId | The unique identifier of a brand. |
Implements DocuSign.eSign.Api.IAccountsApi.
|
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 (`canSelfBrandSend` , `canSelfBrandSign`, or both of these account settings must be true).
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
brandId | The unique identifier of a brand. |
options | Options for modifying the behavior of the function. |
|
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.
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
langCode | The simple type enumeration the language used in the response. The supported languages, with the language value shown in parenthesis, are:Arabic (ar), Armenian (hy), Bulgarian (bg), Czech (cs), Chinese Simplified (zh_CN), Chinese Traditional (zh_TW), Croatian (hr), Danish (da), Dutch (nl), English US (en), English UK (en_GB), Estonian (et), Farsi (fa), Finnish (fi), French (fr), French Canada (fr_CA), German (de), Greek (el), Hebrew (he), Hindi (hi), Hungarian (hu), Bahasa Indonesia (id), Italian (it), Japanese (ja), Korean (ko), Latvian (lv), Lithuanian (lt), Bahasa Melayu (ms), Norwegian (no), Polish (pl), Portuguese (pt), Portuguese Brazil (pt_BR), Romanian (ro), Russian (ru), Serbian (sr), Slovak (sk), Slovenian (sl), Spanish (es),Spanish Latin America (es_MX), Swedish (sv), Thai (th), Turkish (tr), Ukrainian (uk) and Vietnamese (vi). Additionally, the value can be set to �browser� to automatically detect the browser language being used by the viewer and display the disclosure in that language. |
Implements DocuSign.eSign.Api.IAccountsApi.
|
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.
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
langCode | The simple type enumeration the language used in the response. The supported languages, with the language value shown in parenthesis, are:Arabic (ar), Armenian (hy), Bulgarian (bg), Czech (cs), Chinese Simplified (zh_CN), Chinese Traditional (zh_TW), Croatian (hr), Danish (da), Dutch (nl), English US (en), English UK (en_GB), Estonian (et), Farsi (fa), Finnish (fi), French (fr), French Canada (fr_CA), German (de), Greek (el), Hebrew (he), Hindi (hi), Hungarian (hu), Bahasa Indonesia (id), Italian (it), Japanese (ja), Korean (ko), Latvian (lv), Lithuanian (lt), Bahasa Melayu (ms), Norwegian (no), Polish (pl), Portuguese (pt), Portuguese Brazil (pt_BR), Romanian (ro), Russian (ru), Serbian (sr), Slovak (sk), Slovenian (sl), Spanish (es),Spanish Latin America (es_MX), Swedish (sv), Thai (th), Turkish (tr), Ukrainian (uk) and Vietnamese (vi). Additionally, the value can be set to �browser� to automatically detect the browser language being used by the viewer and display the disclosure in that language. |
Implements DocuSign.eSign.Api.IAccountsApi.
|
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.
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
langCode | The simple type enumeration the language used in the response. The supported languages, with the language value shown in parenthesis, are:Arabic (ar), Armenian (hy), Bulgarian (bg), Czech (cs), Chinese Simplified (zh_CN), Chinese Traditional (zh_TW), Croatian (hr), Danish (da), Dutch (nl), English US (en), English UK (en_GB), Estonian (et), Farsi (fa), Finnish (fi), French (fr), French Canada (fr_CA), German (de), Greek (el), Hebrew (he), Hindi (hi), Hungarian (hu), Bahasa Indonesia (id), Italian (it), Japanese (ja), Korean (ko), Latvian (lv), Lithuanian (lt), Bahasa Melayu (ms), Norwegian (no), Polish (pl), Portuguese (pt), Portuguese Brazil (pt_BR), Romanian (ro), Russian (ru), Serbian (sr), Slovak (sk), Slovenian (sl), Spanish (es),Spanish Latin America (es_MX), Swedish (sv), Thai (th), Turkish (tr), Ukrainian (uk) and Vietnamese (vi). Additionally, the value can be set to �browser� to automatically detect the browser language being used by the viewer and display the disclosure in that language. |
Implements DocuSign.eSign.Api.IAccountsApi.
|
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.
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
options | Options for modifying the behavior of the function. |
|
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.
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
options | Options for modifying the behavior of the function. |
|
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.
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
options | Options for modifying the behavior of the function. |
|
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.
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
options | Options for modifying the behavior of the function. |
|
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.
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
langCode | The simple type enumeration the language used in the response. The supported languages, with the language value shown in parenthesis, are:Arabic (ar), Armenian (hy), Bulgarian (bg), Czech (cs), Chinese Simplified (zh_CN), Chinese Traditional (zh_TW), Croatian (hr), Danish (da), Dutch (nl), English US (en), English UK (en_GB), Estonian (et), Farsi (fa), Finnish (fi), French (fr), French Canada (fr_CA), German (de), Greek (el), Hebrew (he), Hindi (hi), Hungarian (hu), Bahasa Indonesia (id), Italian (it), Japanese (ja), Korean (ko), Latvian (lv), Lithuanian (lt), Bahasa Melayu (ms), Norwegian (no), Polish (pl), Portuguese (pt), Portuguese Brazil (pt_BR), Romanian (ro), Russian (ru), Serbian (sr), Slovak (sk), Slovenian (sl), Spanish (es),Spanish Latin America (es_MX), Swedish (sv), Thai (th), Turkish (tr), Ukrainian (uk) and Vietnamese (vi). Additionally, the value can be set to �browser� to automatically detect the browser language being used by the viewer and display the disclosure in that language. |
Implements DocuSign.eSign.Api.IAccountsApi.
|
inline |
Returns the configuration information for the eNote eOriginal integration.
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
Implements DocuSign.eSign.Api.IAccountsApi.
|
inline |
Returns the configuration information for the eNote eOriginal integration.
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
Implements DocuSign.eSign.Api.IAccountsApi.
|
inline |
Returns the configuration information for the eNote eOriginal integration.
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
Implements DocuSign.eSign.Api.IAccountsApi.
|
inline |
Returns the configuration information for the eNote eOriginal integration.
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
Implements DocuSign.eSign.Api.IAccountsApi.
|
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 (`retentionDays`). This method retrieves the current envelope purge configuration for your account. Note: To use this method, you must be an account administrator.
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
Implements DocuSign.eSign.Api.IAccountsApi.
|
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 (`retentionDays`). This method retrieves the current envelope purge configuration for your account. Note: To use this method, you must be an account administrator.
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
Implements DocuSign.eSign.Api.IAccountsApi.
|
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 (`retentionDays`). This method retrieves the current envelope purge configuration for your account. Note: To use this method, you must be an account administrator.
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
Implements DocuSign.eSign.Api.IAccountsApi.
|
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 (`retentionDays`). This method retrieves the current envelope purge configuration for your account. Note: To use this method, you must be an account administrator.
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
Implements DocuSign.eSign.Api.IAccountsApi.
|
inline |
Retrieves the list of favorited templates for this caller
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
Implements DocuSign.eSign.Api.IAccountsApi.
|
inline |
Retrieves the list of favorited templates for this caller
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
Implements DocuSign.eSign.Api.IAccountsApi.
|
inline |
Retrieves the list of favorited templates for this caller
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
Implements DocuSign.eSign.Api.IAccountsApi.
|
inline |
Retrieves the list of favorited templates for this caller
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
Implements DocuSign.eSign.Api.IAccountsApi.
|
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.
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
Implements DocuSign.eSign.Api.IAccountsApi.
|
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.
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
Implements DocuSign.eSign.Api.IAccountsApi.
|
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.
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
Implements DocuSign.eSign.Api.IAccountsApi.
|
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.
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
Implements DocuSign.eSign.Api.IAccountsApi.
|
inline |
Get the password rules This method retrieves the password rules for an account.
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
Implements DocuSign.eSign.Api.IAccountsApi.
|
inline |
Get membership account password rules
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
Implements DocuSign.eSign.Api.IAccountsApi.
|
inline |
Get membership account password rules
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
Implements DocuSign.eSign.Api.IAccountsApi.
|
inline |
Get membership account password rules
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
Implements DocuSign.eSign.Api.IAccountsApi.
|
inline |
Get membership account password rules
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
Implements DocuSign.eSign.Api.IAccountsApi.
|
inline |
Get the password rules This method retrieves the password rules for an account.
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
Implements DocuSign.eSign.Api.IAccountsApi.
|
inline |
Get the password rules This method retrieves the password rules for an account.
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
Implements DocuSign.eSign.Api.IAccountsApi.
|
inline |
Get the password rules This method retrieves the password rules for an account.
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
Implements DocuSign.eSign.Api.IAccountsApi.
|
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
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
permissionProfileId | |
options | Options for modifying the behavior of the function. |
|
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
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
permissionProfileId | |
options | Options for modifying the behavior of the function. |
|
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
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
permissionProfileId | |
options | Options for modifying the behavior of the function. |
|
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
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
permissionProfileId | |
options | Options for modifying the behavior of the function. |
|
inline |
Returns the principal user authorizations
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
userId | The 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. |
options | Options for modifying the behavior of the function. |
|
inline |
Returns the principal user authorizations
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
userId | The 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. |
options | Options for modifying the behavior of the function. |
|
inline |
Returns the principal user authorizations
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
userId | The 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. |
options | Options for modifying the behavior of the function. |
|
inline |
Returns the principal user authorizations
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
userId | The 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. |
options | Options for modifying the behavior of the function. |
|
inline |
Retrieves the account provisioning information for the account. Retrieves the account provisioning information for the account.
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
Implements DocuSign.eSign.Api.IAccountsApi.
|
inline |
Retrieves the account provisioning information for the account. Retrieves the account provisioning information for the account.
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
Implements DocuSign.eSign.Api.IAccountsApi.
|
inline |
Retrieves the account provisioning information for the account. Retrieves the account provisioning information for the account.
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
Implements DocuSign.eSign.Api.IAccountsApi.
|
inline |
Retrieves the account provisioning information for the account. Retrieves the account provisioning information for the account.
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
Implements DocuSign.eSign.Api.IAccountsApi.
|
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's email notification, this setting affects elements such as the standard introductory text describing the request to sign. It also determines the language used for buttons and tabs in both the email notification and the signing experience. Note: Setting a language for a recipient affects only the DocuSign standard text. Any custom text that you enter for the `emailBody` and `emailSubject` of the notification is not translated, and appears exactly as you enter it. For more information, see Set Recipient Language and Specify Custom Email Messages.
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
Implements DocuSign.eSign.Api.IAccountsApi.
|
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's email notification, this setting affects elements such as the standard introductory text describing the request to sign. It also determines the language used for buttons and tabs in both the email notification and the signing experience. Note: Setting a language for a recipient affects only the DocuSign standard text. Any custom text that you enter for the `emailBody` and `emailSubject` of the notification is not translated, and appears exactly as you enter it. For more information, see Set Recipient Language and Specify Custom Email Messages.
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
Implements DocuSign.eSign.Api.IAccountsApi.
|
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's email notification, this setting affects elements such as the standard introductory text describing the request to sign. It also determines the language used for buttons and tabs in both the email notification and the signing experience. Note: Setting a language for a recipient affects only the DocuSign standard text. Any custom text that you enter for the `emailBody` and `emailSubject` of the notification is not translated, and appears exactly as you enter it. For more information, see Set Recipient Language and Specify Custom Email Messages.
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
Implements DocuSign.eSign.Api.IAccountsApi.
|
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's email notification, this setting affects elements such as the standard introductory text describing the request to sign. It also determines the language used for buttons and tabs in both the email notification and the signing experience. Note: Setting a language for a recipient affects only the DocuSign standard text. Any custom text that you enter for the `emailBody` and `emailSubject` of the notification is not translated, and appears exactly as you enter it. For more information, see Set Recipient Language and Specify Custom Email Messages.
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
Implements DocuSign.eSign.Api.IAccountsApi.
|
inline |
Returns the user authorization for a given authorization id
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
userId | The 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 |
Implements DocuSign.eSign.Api.IAccountsApi.
|
inline |
Returns the user authorization for a given authorization id
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
userId | The 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 |
Implements DocuSign.eSign.Api.IAccountsApi.
|
inline |
Returns the user authorization for a given authorization id
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
userId | The 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 |
Implements DocuSign.eSign.Api.IAccountsApi.
|
inline |
Returns the user authorization for a given authorization id
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
userId | The 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 |
Implements DocuSign.eSign.Api.IAccountsApi.
|
inline |
Get watermark information.
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
Implements DocuSign.eSign.Api.IAccountsApi.
|
inline |
Get watermark information.
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
Implements DocuSign.eSign.Api.IAccountsApi.
|
inline |
Get watermark information.
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
Implements DocuSign.eSign.Api.IAccountsApi.
|
inline |
Get watermark preview.
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
watermark | (optional) |
Implements DocuSign.eSign.Api.IAccountsApi.
|
inline |
Get watermark preview.
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
watermark | (optional) |
Implements DocuSign.eSign.Api.IAccountsApi.
|
inline |
Get watermark preview.
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
watermark | (optional) |
Implements DocuSign.eSign.Api.IAccountsApi.
|
inline |
Get watermark preview.
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
watermark | (optional) |
Implements DocuSign.eSign.Api.IAccountsApi.
|
inline |
Get watermark information.
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
Implements DocuSign.eSign.Api.IAccountsApi.
|
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 `canSelfBrandSend` and `canSelfBrandSend`) must be set to true for the account to use this call.
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
options | Options for modifying the behavior of the function. |
|
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 `canSelfBrandSend` and `canSelfBrandSend`) must be set to true for the account to use this call.
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
options | Options for modifying the behavior of the function. |
|
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 `canSelfBrandSend` and `canSelfBrandSend`) must be set to true for the account to use this call.
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
options | Options for modifying the behavior of the function. |
|
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 `canSelfBrandSend` and `canSelfBrandSend`) must be set to true for the account to use this call.
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
options | Options for modifying the behavior of the function. |
|
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.
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
Implements DocuSign.eSign.Api.IAccountsApi.
|
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.
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
Implements DocuSign.eSign.Api.IAccountsApi.
|
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.
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
Implements DocuSign.eSign.Api.IAccountsApi.
|
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.
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
Implements DocuSign.eSign.Api.IAccountsApi.
|
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.
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
options | Options for modifying the behavior of the function. |
|
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.
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
options | Options for modifying the behavior of the function. |
|
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.
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
options | Options for modifying the behavior of the function. |
|
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.
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
options | Options for modifying the behavior of the function. |
|
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.
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
options | Options for modifying the behavior of the function. |
|
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.
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
options | Options for modifying the behavior of the function. |
|
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.
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
options | Options for modifying the behavior of the function. |
|
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.
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
options | Options for modifying the behavior of the function. |
|
inline |
Gets account settings information. Retrieves the account settings information for the specified account.
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
Implements DocuSign.eSign.Api.IAccountsApi.
|
inline |
Gets account settings information. Retrieves the account settings information for the specified account.
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
Implements DocuSign.eSign.Api.IAccountsApi.
|
inline |
Gets account settings information. Retrieves the account settings information for the specified account.
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
Implements DocuSign.eSign.Api.IAccountsApi.
|
inline |
Gets account settings information. Retrieves the account settings information for the specified account.
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
Implements DocuSign.eSign.Api.IAccountsApi.
|
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=shared_from.
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
options | Options for modifying the behavior of the function. |
|
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=shared_from.
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
options | Options for modifying the behavior of the function. |
|
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=shared_from.
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
options | Options for modifying the behavior of the function. |
|
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=shared_from.
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
options | Options for modifying the behavior of the function. |
|
inline |
Returns Account available signature providers for specified account. Returns a list of signature providers that the specified account can use.
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
Implements DocuSign.eSign.Api.IAccountsApi.
|
inline |
Returns Account available signature providers for specified account. Returns a list of signature providers that the specified account can use.
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
Implements DocuSign.eSign.Api.IAccountsApi.
|
inline |
Returns Account available signature providers for specified account. Returns a list of signature providers that the specified account can use.
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
Implements DocuSign.eSign.Api.IAccountsApi.
|
inline |
Returns Account available signature providers for specified account. Returns a list of signature providers that the specified account can use.
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
Implements DocuSign.eSign.Api.IAccountsApi.
|
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.
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
Implements DocuSign.eSign.Api.IAccountsApi.
|
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.
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
Implements DocuSign.eSign.Api.IAccountsApi.
|
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.
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
Implements DocuSign.eSign.Api.IAccountsApi.
|
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.
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
Implements DocuSign.eSign.Api.IAccountsApi.
|
inline |
Unfavorite a template
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
favoriteTemplatesInfo | (optional) |
Implements DocuSign.eSign.Api.IAccountsApi.
|
inline |
Unfavorite a template
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
favoriteTemplatesInfo | (optional) |
Implements DocuSign.eSign.Api.IAccountsApi.
|
inline |
Unfavorite a template
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
favoriteTemplatesInfo | (optional) |
Implements DocuSign.eSign.Api.IAccountsApi.
|
inline |
Unfavorite a template
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
favoriteTemplatesInfo | (optional) |
Implements DocuSign.eSign.Api.IAccountsApi.
|
inline |
Updates a account signature.
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
accountSignaturesInformation | (optional) |
Implements DocuSign.eSign.Api.IAccountsApi.
|
inline |
Updates a account signature.
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
accountSignaturesInformation | (optional) |
Implements DocuSign.eSign.Api.IAccountsApi.
|
inline |
Updates a account signature.
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
accountSignaturesInformation | (optional) |
Implements DocuSign.eSign.Api.IAccountsApi.
|
inline |
Updates a account signature.
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
signatureId | The ID of the signature being accessed. |
accountSignatureDefinition | (optional) |
options | Options for modifying the behavior of the function. |
|
inline |
Updates a account signature.
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
signatureId | The ID of the signature being accessed. |
accountSignatureDefinition | (optional) |
options | Options for modifying the behavior of the function. |
|
inline |
Updates a account signature.
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
signatureId | The ID of the signature being accessed. |
accountSignatureDefinition | (optional) |
options | Options for modifying the behavior of the function. |
|
inline |
Updates a account signature.
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
signatureId | The ID of the signature being accessed. |
accountSignatureDefinition | (optional) |
options | Options for modifying the behavior of the function. |
|
inline |
Sets a signature, initials, or stamps image.
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
signatureId | The ID of the signature being accessed. |
imageType | One of signature_image or initials_image. |
options | Options for modifying the behavior of the function. |
|
inline |
Sets a signature, initials, or stamps image.
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
signatureId | The ID of the signature being accessed. |
imageType | One of signature_image or initials_image. |
options | Options for modifying the behavior of the function. |
|
inline |
Sets a signature, initials, or stamps image.
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
signatureId | The ID of the signature being accessed. |
imageType | One of signature_image or initials_image. |
options | Options for modifying the behavior of the function. |
|
inline |
Sets a signature, initials, or stamps image.
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
signatureId | The ID of the signature being accessed. |
imageType | One of signature_image or initials_image. |
options | Options for modifying the behavior of the function. |
|
inline |
Updates a account signature.
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
accountSignaturesInformation | (optional) |
Implements DocuSign.eSign.Api.IAccountsApi.
|
inline |
Modifies tab settings for specified account This method modifies the tab types and tab functionality that is enabled for an account.
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
tabAccountSettings | (optional) |
Implements DocuSign.eSign.Api.IAccountsApi.
|
inline |
Modifies tab settings for specified account This method modifies the tab types and tab functionality that is enabled for an account.
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
tabAccountSettings | (optional) |
Implements DocuSign.eSign.Api.IAccountsApi.
|
inline |
Modifies tab settings for specified account This method modifies the tab types and tab functionality that is enabled for an account.
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
tabAccountSettings | (optional) |
Implements DocuSign.eSign.Api.IAccountsApi.
|
inline |
Modifies tab settings for specified account This method modifies the tab types and tab functionality that is enabled for an account.
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
tabAccountSettings | (optional) |
Implements DocuSign.eSign.Api.IAccountsApi.
|
inline |
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).
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
brandId | The unique identifier of a brand. |
brand | (optional) |
options | Options for modifying the behavior of the function. |
|
inline |
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).
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
brandId | The unique identifier of a brand. |
brand | (optional) |
options | Options for modifying the behavior of the function. |
|
inline |
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).
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
brandId | The unique identifier of a brand. |
brand | (optional) |
options | Options for modifying the behavior of the function. |
|
inline |
Put one branding logo. This method updates a single brand logo. You pass in the new version of the resource in the `Content-Disposition` header. Example: `Content-Disposition: form-data; name="file"; filename="logo.jpg"` Note: Branding for either signing or sending must be enabled for the account (`canSelfBrandSend` , `canSelfBrandSign`, or both of these account settings must be true).
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID GUID. |
brandId | The ID of the brand. |
logoType | The type of logo. Valid values are: - `primary` - `secondary` - `email` |
logoFileBytes | Brand logo binary Stream. Supported formats: JPG, GIF, PNG. Maximum file size: 300 KB. Recommended dimensions: 296 x 76 pixels (larger images will be resized). Changes may take up to one hour to display in all places |
Implements DocuSign.eSign.Api.IAccountsApi.
|
inline |
Put one branding logo. This method updates a single brand logo. You pass in the new version of the resource in the `Content-Disposition` header. Example: `Content-Disposition: form-data; name="file"; filename="logo.jpg"` Note: Branding for either signing or sending must be enabled for the account (`canSelfBrandSend` , `canSelfBrandSign`, or both of these account settings must be true).
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID GUID. |
brandId | The ID of the brand. |
logoType | The type of logo. Valid values are: - `primary` - `secondary` - `email` |
logoFileBytes | Brand logo binary Stream. Supported formats: JPG, GIF, PNG. Maximum file size: 300 KB. Recommended dimensions: 296 x 76 pixels (larger images will be resized). Changes may take up to one hour to display in all places |
Implements DocuSign.eSign.Api.IAccountsApi.
|
inline |
Put one branding logo. This method updates a single brand logo. You pass in the new version of the resource in the `Content-Disposition` header. Example: `Content-Disposition: form-data; name="file"; filename="logo.jpg"` Note: Branding for either signing or sending must be enabled for the account (`canSelfBrandSend` , `canSelfBrandSign`, or both of these account settings must be true).
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID GUID. |
brandId | The ID of the brand. |
logoType | The type of logo. Valid values are: - `primary` - `secondary` - `email` |
logoFileBytes | Brand logo binary Stream. Supported formats: JPG, GIF, PNG. Maximum file size: 300 KB. Recommended dimensions: 296 x 76 pixels (larger images will be resized). Changes may take up to one hour to display in all places |
Implements DocuSign.eSign.Api.IAccountsApi.
|
inline |
Put one branding logo. This method updates a single brand logo. You pass in the new version of the resource in the `Content-Disposition` header. Example: `Content-Disposition: form-data; name="file"; filename="logo.jpg"` Note: Branding for either signing or sending must be enabled for the account (`canSelfBrandSend` , `canSelfBrandSign`, or both of these account settings must be true).
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID GUID. |
brandId | The ID of the brand. |
logoType | The type of logo. Valid values are: - `primary` - `secondary` - `email` |
logoFileBytes | Brand logo binary Stream. Supported formats: JPG, GIF, PNG. Maximum file size: 300 KB. Recommended dimensions: 296 x 76 pixels (larger images will be resized). Changes may take up to one hour to display in all places |
Implements DocuSign.eSign.Api.IAccountsApi.
|
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 `Content-Disposition` header. Example: `Content-Disposition: form-data; name="file"; filename="DocuSign_SigningResource_4328673.xml"` Note: Branding for either signing or sending must be enabled for the account (`canSelfBrandSend` , `canSelfBrandSign`, or both of these account settings must be true). Important: Customizing resource files is an advanced branding configuration option which can significantly impact your account, and should be done only by someone with expertise in XML and HTML. The master resource files are subject to change without notice. If you customize your resource files, after each release, DocuSign recommends you review any changes and update your custom files as needed. When you upload a modified resource file, only the elements that differ from the master resource file are saved as your resource file. Similarly, when you download your resource files, only the modified elements are included in the file.
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID GUID. |
brandId | The ID of the brand. |
resourceContentType | The type of brand resource file that you are updating. Valid values are: - `sending` - `signing` - `email` - `signing_captive` |
fileXml | Brand resource XML file. |
Implements DocuSign.eSign.Api.IAccountsApi.
|
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 `Content-Disposition` header. Example: `Content-Disposition: form-data; name="file"; filename="DocuSign_SigningResource_4328673.xml"` Note: Branding for either signing or sending must be enabled for the account (`canSelfBrandSend` , `canSelfBrandSign`, or both of these account settings must be true). Important: Customizing resource files is an advanced branding configuration option which can significantly impact your account, and should be done only by someone with expertise in XML and HTML. The master resource files are subject to change without notice. If you customize your resource files, after each release, DocuSign recommends you review any changes and update your custom files as needed. When you upload a modified resource file, only the elements that differ from the master resource file are saved as your resource file. Similarly, when you download your resource files, only the modified elements are included in the file.
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID GUID. |
brandId | The ID of the brand. |
resourceContentType | The type of brand resource file that you are updating. Valid values are: - `sending` - `signing` - `email` - `signing_captive` |
fileXml | Brand resource XML file. |
Implements DocuSign.eSign.Api.IAccountsApi.
|
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 `Content-Disposition` header. Example: `Content-Disposition: form-data; name="file"; filename="DocuSign_SigningResource_4328673.xml"` Note: Branding for either signing or sending must be enabled for the account (`canSelfBrandSend` , `canSelfBrandSign`, or both of these account settings must be true). Important: Customizing resource files is an advanced branding configuration option which can significantly impact your account, and should be done only by someone with expertise in XML and HTML. The master resource files are subject to change without notice. If you customize your resource files, after each release, DocuSign recommends you review any changes and update your custom files as needed. When you upload a modified resource file, only the elements that differ from the master resource file are saved as your resource file. Similarly, when you download your resource files, only the modified elements are included in the file.
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID GUID. |
brandId | The ID of the brand. |
resourceContentType | The type of brand resource file that you are updating. Valid values are: - `sending` - `signing` - `email` - `signing_captive` |
fileXml | Brand resource XML file. |
Implements DocuSign.eSign.Api.IAccountsApi.
|
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 `Content-Disposition` header. Example: `Content-Disposition: form-data; name="file"; filename="DocuSign_SigningResource_4328673.xml"` Note: Branding for either signing or sending must be enabled for the account (`canSelfBrandSend` , `canSelfBrandSign`, or both of these account settings must be true). Important: Customizing resource files is an advanced branding configuration option which can significantly impact your account, and should be done only by someone with expertise in XML and HTML. The master resource files are subject to change without notice. If you customize your resource files, after each release, DocuSign recommends you review any changes and update your custom files as needed. When you upload a modified resource file, only the elements that differ from the master resource file are saved as your resource file. Similarly, when you download your resource files, only the modified elements are included in the file.
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID GUID. |
brandId | The ID of the brand. |
resourceContentType | The type of brand resource file that you are updating. Valid values are: - `sending` - `signing` - `email` - `signing_captive` |
fileXml | Brand resource XML file. |
Implements DocuSign.eSign.Api.IAccountsApi.
|
inline |
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).
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
brandId | The unique identifier of a brand. |
brand | (optional) |
options | Options for modifying the behavior of the function. |
|
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 `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.
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
langCode | The simple type enumeration the language used in the response. The supported languages, with the language value shown in parenthesis, are:Arabic (ar), Armenian (hy), Bulgarian (bg), Czech (cs), Chinese Simplified (zh_CN), Chinese Traditional (zh_TW), Croatian (hr), Danish (da), Dutch (nl), English US (en), English UK (en_GB), Estonian (et), Farsi (fa), Finnish (fi), French (fr), French Canada (fr_CA), German (de), Greek (el), Hebrew (he), Hindi (hi), Hungarian (hu), Bahasa Indonesia (id), Italian (it), Japanese (ja), Korean (ko), Latvian (lv), Lithuanian (lt), Bahasa Melayu (ms), Norwegian (no), Polish (pl), Portuguese (pt), Portuguese Brazil (pt_BR), Romanian (ro), Russian (ru), Serbian (sr), Slovak (sk), Slovenian (sl), Spanish (es),Spanish Latin America (es_MX), Swedish (sv), Thai (th), Turkish (tr), Ukrainian (uk) and Vietnamese (vi). Additionally, the value can be set to �browser� to automatically detect the browser language being used by the viewer and display the disclosure in that language. |
consumerDisclosure | (optional) |
options | Options for modifying the behavior of the function. |
|
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 `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.
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
langCode | The simple type enumeration the language used in the response. The supported languages, with the language value shown in parenthesis, are:Arabic (ar), Armenian (hy), Bulgarian (bg), Czech (cs), Chinese Simplified (zh_CN), Chinese Traditional (zh_TW), Croatian (hr), Danish (da), Dutch (nl), English US (en), English UK (en_GB), Estonian (et), Farsi (fa), Finnish (fi), French (fr), French Canada (fr_CA), German (de), Greek (el), Hebrew (he), Hindi (hi), Hungarian (hu), Bahasa Indonesia (id), Italian (it), Japanese (ja), Korean (ko), Latvian (lv), Lithuanian (lt), Bahasa Melayu (ms), Norwegian (no), Polish (pl), Portuguese (pt), Portuguese Brazil (pt_BR), Romanian (ro), Russian (ru), Serbian (sr), Slovak (sk), Slovenian (sl), Spanish (es),Spanish Latin America (es_MX), Swedish (sv), Thai (th), Turkish (tr), Ukrainian (uk) and Vietnamese (vi). Additionally, the value can be set to �browser� to automatically detect the browser language being used by the viewer and display the disclosure in that language. |
consumerDisclosure | (optional) |
options | Options for modifying the behavior of the function. |
|
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 `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.
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
langCode | The simple type enumeration the language used in the response. The supported languages, with the language value shown in parenthesis, are:Arabic (ar), Armenian (hy), Bulgarian (bg), Czech (cs), Chinese Simplified (zh_CN), Chinese Traditional (zh_TW), Croatian (hr), Danish (da), Dutch (nl), English US (en), English UK (en_GB), Estonian (et), Farsi (fa), Finnish (fi), French (fr), French Canada (fr_CA), German (de), Greek (el), Hebrew (he), Hindi (hi), Hungarian (hu), Bahasa Indonesia (id), Italian (it), Japanese (ja), Korean (ko), Latvian (lv), Lithuanian (lt), Bahasa Melayu (ms), Norwegian (no), Polish (pl), Portuguese (pt), Portuguese Brazil (pt_BR), Romanian (ro), Russian (ru), Serbian (sr), Slovak (sk), Slovenian (sl), Spanish (es),Spanish Latin America (es_MX), Swedish (sv), Thai (th), Turkish (tr), Ukrainian (uk) and Vietnamese (vi). Additionally, the value can be set to �browser� to automatically detect the browser language being used by the viewer and display the disclosure in that language. |
consumerDisclosure | (optional) |
options | Options for modifying the behavior of the function. |
|
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 `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.
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
langCode | The simple type enumeration the language used in the response. The supported languages, with the language value shown in parenthesis, are:Arabic (ar), Armenian (hy), Bulgarian (bg), Czech (cs), Chinese Simplified (zh_CN), Chinese Traditional (zh_TW), Croatian (hr), Danish (da), Dutch (nl), English US (en), English UK (en_GB), Estonian (et), Farsi (fa), Finnish (fi), French (fr), French Canada (fr_CA), German (de), Greek (el), Hebrew (he), Hindi (hi), Hungarian (hu), Bahasa Indonesia (id), Italian (it), Japanese (ja), Korean (ko), Latvian (lv), Lithuanian (lt), Bahasa Melayu (ms), Norwegian (no), Polish (pl), Portuguese (pt), Portuguese Brazil (pt_BR), Romanian (ro), Russian (ru), Serbian (sr), Slovak (sk), Slovenian (sl), Spanish (es),Spanish Latin America (es_MX), Swedish (sv), Thai (th), Turkish (tr), Ukrainian (uk) and Vietnamese (vi). Additionally, the value can be set to �browser� to automatically detect the browser language being used by the viewer and display the disclosure in that language. |
consumerDisclosure | (optional) |
options | Options for modifying the behavior of the function. |
|
inline |
Updates an existing account custom field. This method updates an existing account custom field.
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
customFieldId | |
customField | (optional) |
options | Options for modifying the behavior of the function. |
|
inline |
Updates an existing account custom field. This method updates an existing account custom field.
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
customFieldId | |
customField | (optional) |
options | Options for modifying the behavior of the function. |
|
inline |
Updates an existing account custom field. This method updates an existing account custom field.
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
customFieldId | |
customField | (optional) |
options | Options for modifying the behavior of the function. |
|
inline |
Updates an existing account custom field. This method updates an existing account custom field.
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
customFieldId | |
customField | (optional) |
options | Options for modifying the behavior of the function. |
|
inline |
Updates configuration information for the eNote eOriginal integration.
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
eNoteConfiguration | (optional) |
Implements DocuSign.eSign.Api.IAccountsApi.
|
inline |
Updates configuration information for the eNote eOriginal integration.
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
eNoteConfiguration | (optional) |
Implements DocuSign.eSign.Api.IAccountsApi.
|
inline |
Updates configuration information for the eNote eOriginal integration.
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
eNoteConfiguration | (optional) |
Implements DocuSign.eSign.Api.IAccountsApi.
|
inline |
Updates configuration information for the eNote eOriginal integration.
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
eNoteConfiguration | (optional) |
Implements DocuSign.eSign.Api.IAccountsApi.
|
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 (`retentionDays`). This method sets the envelope purge configuration for your account. Note: To use this method, you must be an account administrator. For more information, see Purge Envelopes.
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
envelopePurgeConfiguration | (optional) |
Implements DocuSign.eSign.Api.IAccountsApi.
|
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 (`retentionDays`). This method sets the envelope purge configuration for your account. Note: To use this method, you must be an account administrator. For more information, see Purge Envelopes.
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
envelopePurgeConfiguration | (optional) |
Implements DocuSign.eSign.Api.IAccountsApi.
|
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 (`retentionDays`). This method sets the envelope purge configuration for your account. Note: To use this method, you must be an account administrator. For more information, see Purge Envelopes.
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
envelopePurgeConfiguration | (optional) |
Implements DocuSign.eSign.Api.IAccountsApi.
|
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 (`retentionDays`). This method sets the envelope purge configuration for your account. Note: To use this method, you must be an account administrator. For more information, see Purge Envelopes.
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
envelopePurgeConfiguration | (optional) |
Implements DocuSign.eSign.Api.IAccountsApi.
|
inline |
Favorites a template
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
favoriteTemplatesInfo | (optional) |
Implements DocuSign.eSign.Api.IAccountsApi.
|
inline |
Favorites a template
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
favoriteTemplatesInfo | (optional) |
Implements DocuSign.eSign.Api.IAccountsApi.
|
inline |
Favorites a template
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
favoriteTemplatesInfo | (optional) |
Implements DocuSign.eSign.Api.IAccountsApi.
|
inline |
Favorites a template
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
favoriteTemplatesInfo | (optional) |
Implements DocuSign.eSign.Api.IAccountsApi.
|
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.
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
notificationDefaults | (optional) |
Implements DocuSign.eSign.Api.IAccountsApi.
|
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.
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
notificationDefaults | (optional) |
Implements DocuSign.eSign.Api.IAccountsApi.
|
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.
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
notificationDefaults | (optional) |
Implements DocuSign.eSign.Api.IAccountsApi.
|
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.
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
notificationDefaults | (optional) |
Implements DocuSign.eSign.Api.IAccountsApi.
|
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.
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
accountPasswordRules | (optional) |
Implements DocuSign.eSign.Api.IAccountsApi.
|
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.
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
accountPasswordRules | (optional) |
Implements DocuSign.eSign.Api.IAccountsApi.
|
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.
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
accountPasswordRules | (optional) |
Implements DocuSign.eSign.Api.IAccountsApi.
|
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.
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
accountPasswordRules | (optional) |
Implements DocuSign.eSign.Api.IAccountsApi.
|
inline |
Updates a permission profile within the specified account. This method updates an account permission profile. ### Related topics - How to update individual permission settings
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
permissionProfileId | |
permissionProfile | (optional) |
options | Options for modifying the behavior of the function. |
|
inline |
Updates a permission profile within the specified account. This method updates an account permission profile. ### Related topics - How to update individual permission settings
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
permissionProfileId | |
permissionProfile | (optional) |
options | Options for modifying the behavior of the function. |
|
inline |
Updates a permission profile within the specified account. This method updates an account permission profile. ### Related topics - How to update individual permission settings
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
permissionProfileId | |
permissionProfile | (optional) |
options | Options for modifying the behavior of the function. |
|
inline |
Updates a permission profile within the specified account. This method updates an account permission profile. ### Related topics - How to update individual permission settings
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
permissionProfileId | |
permissionProfile | (optional) |
options | Options for modifying the behavior of the function. |
|
inline |
Updates the account settings for an account. Updates the account settings for the specified account.
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
accountSettingsInformation | (optional) |
Implements DocuSign.eSign.Api.IAccountsApi.
|
inline |
Updates the account settings for an account. Updates the account settings for the specified account.
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
accountSettingsInformation | (optional) |
Implements DocuSign.eSign.Api.IAccountsApi.
|
inline |
Updates the account settings for an account. Updates the account settings for the specified account.
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
accountSettingsInformation | (optional) |
Implements DocuSign.eSign.Api.IAccountsApi.
|
inline |
Updates the account settings for an account. Updates the account settings for the specified account.
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
accountSettingsInformation | (optional) |
Implements DocuSign.eSign.Api.IAccountsApi.
|
inline |
Reserved: Sets the shared access information for users. Reserved: Sets the shared access information for one or more users.
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
accountSharedAccess | (optional) |
options | Options for modifying the behavior of the function. |
|
inline |
Reserved: Sets the shared access information for users. Reserved: Sets the shared access information for one or more users.
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
accountSharedAccess | (optional) |
options | Options for modifying the behavior of the function. |
|
inline |
Reserved: Sets the shared access information for users. Reserved: Sets the shared access information for one or more users.
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
accountSharedAccess | (optional) |
options | Options for modifying the behavior of the function. |
|
inline |
Reserved: Sets the shared access information for users. Reserved: Sets the shared access information for one or more users.
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
accountSharedAccess | (optional) |
options | Options for modifying the behavior of the function. |
|
inline |
Updates the user authorization
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
userId | The 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) |
Implements DocuSign.eSign.Api.IAccountsApi.
|
inline |
Updates the user authorization
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
userId | The 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) |
Implements DocuSign.eSign.Api.IAccountsApi.
|
inline |
Updates the user authorization
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
userId | The 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) |
Implements DocuSign.eSign.Api.IAccountsApi.
|
inline |
Updates the user authorization
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
userId | The 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) |
Implements DocuSign.eSign.Api.IAccountsApi.
|
inline |
Update watermark information.
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
watermark | (optional) |
Implements DocuSign.eSign.Api.IAccountsApi.
|
inline |
Update watermark information.
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
watermark | (optional) |
Implements DocuSign.eSign.Api.IAccountsApi.
|
inline |
Update watermark information.
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
watermark | (optional) |
Implements DocuSign.eSign.Api.IAccountsApi.
|
inline |
Update watermark information.
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
watermark | (optional) |
Implements DocuSign.eSign.Api.IAccountsApi.
|
getset |
Gets or sets the ApiClient object
An instance of the ApiClient
|
getset |
Provides a factory method hook for the creation of exceptions.