DocuSign CSharp Docs
|
Represents a collection of functions to interact with the API endpoints More...
Public Member Functions | |
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... | |
BrandsResponse | CreateBrand (string accountId, Brand brand=null) |
Creates one or more brand profile files for the account. More... | |
ApiResponse< BrandsResponse > | CreateBrandWithHttpInfo (string accountId, Brand brand=null) |
Creates one or more brand profile files for the account. 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... | |
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... | |
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... | |
void | Delete (string accountId) |
Deletes the specified account. More... | |
ApiResponse< Object > | DeleteWithHttpInfo (string accountId) |
Deletes the specified account. 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... | |
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... | |
void | DeleteBrand (string accountId, string brandId) |
Removes a brand. More... | |
ApiResponse< Object > | DeleteBrandWithHttpInfo (string accountId, string brandId) |
Removes a brand. More... | |
void | DeleteBrandLogoByType (string accountId, string brandId, string logoType) |
Delete one branding logo. More... | |
ApiResponse< Object > | DeleteBrandLogoByTypeWithHttpInfo (string accountId, string brandId, string logoType) |
Delete one branding logo. More... | |
BrandsResponse | DeleteBrands (string accountId, BrandsRequest brandsRequest=null) |
Deletes one or more brand profiles. More... | |
ApiResponse< BrandsResponse > | DeleteBrandsWithHttpInfo (string accountId, BrandsRequest brandsRequest=null) |
Deletes one or more brand profiles. More... | |
CaptiveRecipientInformation | DeleteCaptiveRecipient (string accountId, string recipientPart, CaptiveRecipientInformation captiveRecipientInformation=null) |
Deletes the signature for one or more captive recipient records. More... | |
ApiResponse< CaptiveRecipientInformation > | DeleteCaptiveRecipientWithHttpInfo (string accountId, string recipientPart, CaptiveRecipientInformation captiveRecipientInformation=null) |
Deletes the signature for one or more captive recipient records. 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 | 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... | |
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... | |
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... | |
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... | |
AccountIdentityVerificationResponse | GetAccountIdentityVerification (string accountId) |
Get the list of identity verification options for an account More... | |
ApiResponse< AccountIdentityVerificationResponse > | GetAccountIdentityVerificationWithHttpInfo (string accountId) |
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... | |
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... | |
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... | |
TabAccountSettings | GetAccountTabSettings (string accountId) |
Returns tab settings list for specified account More... | |
ApiResponse< TabAccountSettings > | GetAccountTabSettingsWithHttpInfo (string accountId) |
Returns tab settings list for specified 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... | |
PaymentGatewayAccountsInfo | GetAllPaymentGatewayAccounts (string accountId) |
Get all payment gateway account for the provided accountId More... | |
ApiResponse< PaymentGatewayAccountsInfo > | GetAllPaymentGatewayAccountsWithHttpInfo (string accountId) |
Get all payment gateway account for the provided accountId 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 | GetBrandExportFile (string accountId, string brandId) |
Export a specific brand. More... | |
ApiResponse< Object > | GetBrandExportFileWithHttpInfo (string accountId, string brandId) |
Export a specific brand. More... | |
System.IO.Stream | GetBrandLogoByType (string accountId, string brandId, string logoType) |
Obtains the specified image for a brand. More... | |
ApiResponse< System.IO.Stream > | GetBrandLogoByTypeWithHttpInfo (string accountId, string brandId, string logoType) |
Obtains the specified image for a brand. More... | |
BrandResourcesList | GetBrandResources (string accountId, string brandId) |
Returns the specified account's list of branding resources (metadata). More... | |
ApiResponse< BrandResourcesList > | GetBrandResourcesWithHttpInfo (string accountId, string brandId) |
Returns the specified account's list of branding resources (metadata). 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 | GetConsumerDisclosure (string accountId, string langCode) |
Gets the Electronic Record and Signature Disclosure. More... | |
ApiResponse< ConsumerDisclosure > | GetConsumerDisclosureWithHttpInfo (string accountId, string langCode) |
Gets the Electronic Record and Signature Disclosure. 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... | |
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... | |
EnvelopePurgeConfiguration | GetEnvelopePurgeConfiguration (string accountId) |
Select envelope purge configuration. More... | |
ApiResponse< EnvelopePurgeConfiguration > | GetEnvelopePurgeConfigurationWithHttpInfo (string accountId) |
Select envelope purge configuration. 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... | |
NotificationDefaults | GetNotificationDefaults (string accountId) |
Returns default user level settings for a specified account More... | |
ApiResponse< NotificationDefaults > | GetNotificationDefaultsWithHttpInfo (string accountId) |
Returns default user level settings for a specified account More... | |
AccountPasswordRules | GetPasswordRules (string accountId) |
Get the password rules More... | |
ApiResponse< AccountPasswordRules > | GetPasswordRulesWithHttpInfo (string accountId) |
Get the password rules More... | |
UserPasswordRules | GetPasswordRules_0 () |
Get membership account password rules More... | |
ApiResponse< UserPasswordRules > | GetPasswordRules_0WithHttpInfo () |
Get membership account password rules 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... | |
ProvisioningInformation | GetProvisioning () |
Retrieves the account provisioning information for the account. More... | |
ApiResponse< ProvisioningInformation > | GetProvisioningWithHttpInfo () |
Retrieves the account provisioning information for the account. More... | |
SupportedLanguages | GetSupportedLanguages (string accountId) |
Gets list of supported languages for recipient language setting. More... | |
ApiResponse< SupportedLanguages > | GetSupportedLanguagesWithHttpInfo (string accountId) |
Gets list of supported languages for recipient language setting. 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... | |
Watermark | GetWatermark (string accountId) |
Get watermark information. More... | |
ApiResponse< Watermark > | GetWatermarkWithHttpInfo (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... | |
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... | |
CustomFields | ListCustomFields (string accountId) |
Gets a list of custom fields associated with the account. More... | |
ApiResponse< CustomFields > | ListCustomFieldsWithHttpInfo (string accountId) |
Gets a list of custom fields associated with the account. 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... | |
AccountSettingsInformation | ListSettings (string accountId) |
Gets account settings information. More... | |
ApiResponse< AccountSettingsInformation > | ListSettingsWithHttpInfo (string accountId) |
Gets account settings information. 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... | |
AccountSignatureProviders | ListSignatureProviders (string accountId) |
Returns Account available signature providers for specified account. More... | |
ApiResponse< AccountSignatureProviders > | ListSignatureProvidersWithHttpInfo (string accountId) |
Returns Account available signature providers for specified account. More... | |
FileTypeList | ListUnsupportedFileTypes (string accountId) |
Gets a list of unsupported file types. More... | |
ApiResponse< FileTypeList > | ListUnsupportedFileTypesWithHttpInfo (string accountId) |
Gets a list of unsupported file types. More... | |
FavoriteTemplatesInfo | UnFavoriteTemplate (string accountId, FavoriteTemplatesInfo favoriteTemplatesInfo=null) |
Unfavorite a template More... | |
ApiResponse< FavoriteTemplatesInfo > | UnFavoriteTemplateWithHttpInfo (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... | |
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... | |
TabAccountSettings | UpdateAccountTabSettings (string accountId, TabAccountSettings tabAccountSettings=null) |
Modifies tab settings for specified account More... | |
ApiResponse< TabAccountSettings > | UpdateAccountTabSettingsWithHttpInfo (string accountId, TabAccountSettings tabAccountSettings=null) |
Modifies tab settings for specified account 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... | |
void | UpdateBrandLogoByType (string accountId, string brandId, string logoType, byte[] logoFileBytes) |
Put one branding logo. More... | |
ApiResponse< Object > | UpdateBrandLogoByTypeWithHttpInfo (string accountId, string brandId, string logoType, byte[] logoFileBytes) |
Put one branding logo. More... | |
BrandResources | UpdateBrandResourcesByContentType (string accountId, string brandId, string resourceContentType, byte[] fileXml) |
Uploads a branding resource file. More... | |
ApiResponse< BrandResources > | UpdateBrandResourcesByContentTypeWithHttpInfo (string accountId, string brandId, string resourceContentType, byte[] fileXml) |
Uploads a branding resource file. 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... | |
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... | |
EnvelopePurgeConfiguration | UpdateEnvelopePurgeConfiguration (string accountId, EnvelopePurgeConfiguration envelopePurgeConfiguration=null) |
Updates envelope purge configuration. More... | |
ApiResponse< EnvelopePurgeConfiguration > | UpdateEnvelopePurgeConfigurationWithHttpInfo (string accountId, EnvelopePurgeConfiguration envelopePurgeConfiguration=null) |
Updates envelope purge configuration. More... | |
FavoriteTemplatesInfo | UpdateFavoriteTemplate (string accountId, FavoriteTemplatesInfo favoriteTemplatesInfo=null) |
Favorites a template More... | |
ApiResponse< FavoriteTemplatesInfo > | UpdateFavoriteTemplateWithHttpInfo (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 More... | |
ApiResponse< NotificationDefaults > | UpdateNotificationDefaultsWithHttpInfo (string accountId, NotificationDefaults notificationDefaults=null) |
Updates default user level settings for a specified account More... | |
AccountPasswordRules | UpdatePasswordRules (string accountId, AccountPasswordRules accountPasswordRules=null) |
Update the password rules More... | |
ApiResponse< AccountPasswordRules > | UpdatePasswordRulesWithHttpInfo (string accountId, AccountPasswordRules accountPasswordRules=null) |
Update the password rules 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... | |
void | UpdateSettings (string accountId, AccountSettingsInformation accountSettingsInformation=null) |
Updates the account settings for an account. More... | |
ApiResponse< Object > | UpdateSettingsWithHttpInfo (string accountId, AccountSettingsInformation accountSettingsInformation=null) |
Updates the account settings for an 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... | |
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... | |
Watermark | UpdateWatermark (string accountId, Watermark watermark=null) |
Update watermark information. More... | |
ApiResponse< Watermark > | UpdateWatermarkWithHttpInfo (string accountId, Watermark watermark=null) |
Update watermark information. 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< BrandsResponse > | CreateBrandAsync (string accountId, Brand brand=null) |
Creates one or more brand profile files for the account. More... | |
System.Threading.Tasks.Task< ApiResponse< BrandsResponse > > | CreateBrandAsyncWithHttpInfo (string accountId, Brand brand=null) |
Creates one or more brand profile files for the account. 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< UserAuthorization > | CreateUserAuthorizationAsync (string accountId, string userId, UserAuthorizationCreateRequest userAuthorizationCreateRequest=null) |
Creates the user authorization More... | |
System.Threading.Tasks.Task< ApiResponse< UserAuthorization > > | CreateUserAuthorizationAsyncWithHttpInfo (string accountId, string userId, UserAuthorizationCreateRequest userAuthorizationCreateRequest=null) |
Creates the user authorization More... | |
System.Threading.Tasks.Task< UserAuthorizationsResponse > | CreateUserAuthorizationsAsync (string accountId, string userId, UserAuthorizationsRequest userAuthorizationsRequest=null) |
Creates ot updates user authorizations More... | |
System.Threading.Tasks.Task< ApiResponse< UserAuthorizationsResponse > > | CreateUserAuthorizationsAsyncWithHttpInfo (string accountId, string userId, UserAuthorizationsRequest userAuthorizationsRequest=null) |
Creates ot updates user authorizations More... | |
System.Threading.Tasks.Task | DeleteAsync (string accountId) |
Deletes the specified account. More... | |
System.Threading.Tasks.Task< ApiResponse< Object > > | DeleteAsyncWithHttpInfo (string accountId) |
Deletes the specified account. More... | |
System.Threading.Tasks.Task | DeleteAccountSignatureAsync (string accountId, string signatureId) |
Close the specified signature by Id. More... | |
System.Threading.Tasks.Task< ApiResponse< Object > > | DeleteAccountSignatureAsyncWithHttpInfo (string accountId, string signatureId) |
Close the specified signature by Id. More... | |
System.Threading.Tasks.Task< AccountSignature > | DeleteAccountSignatureImageAsync (string accountId, string signatureId, string imageType) |
Deletes a signature, initials, or stamps image. More... | |
System.Threading.Tasks.Task< ApiResponse< AccountSignature > > | DeleteAccountSignatureImageAsyncWithHttpInfo (string accountId, string signatureId, string imageType) |
Deletes a signature, initials, or stamps image. More... | |
System.Threading.Tasks.Task | DeleteBrandAsync (string accountId, string brandId) |
Removes a brand. More... | |
System.Threading.Tasks.Task< ApiResponse< Object > > | DeleteBrandAsyncWithHttpInfo (string accountId, string brandId) |
Removes a brand. More... | |
System.Threading.Tasks.Task | DeleteBrandLogoByTypeAsync (string accountId, string brandId, string logoType) |
Delete one branding logo. More... | |
System.Threading.Tasks.Task< ApiResponse< Object > > | DeleteBrandLogoByTypeAsyncWithHttpInfo (string accountId, string brandId, string logoType) |
Delete one branding logo. More... | |
System.Threading.Tasks.Task< BrandsResponse > | DeleteBrandsAsync (string accountId, BrandsRequest brandsRequest=null) |
Deletes one or more brand profiles. More... | |
System.Threading.Tasks.Task< ApiResponse< BrandsResponse > > | DeleteBrandsAsyncWithHttpInfo (string accountId, BrandsRequest brandsRequest=null) |
Deletes one or more brand profiles. More... | |
System.Threading.Tasks.Task< CaptiveRecipientInformation > | DeleteCaptiveRecipientAsync (string accountId, string recipientPart, CaptiveRecipientInformation captiveRecipientInformation=null) |
Deletes the signature for one or more captive recipient records. More... | |
System.Threading.Tasks.Task< ApiResponse< CaptiveRecipientInformation > > | DeleteCaptiveRecipientAsyncWithHttpInfo (string accountId, string recipientPart, CaptiveRecipientInformation captiveRecipientInformation=null) |
Deletes the signature for one or more captive recipient records. 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 | DeleteENoteConfigurationAsync (string accountId) |
Deletes configuration information for the eNote eOriginal integration. More... | |
System.Threading.Tasks.Task< ApiResponse< Object > > | DeleteENoteConfigurationAsyncWithHttpInfo (string accountId) |
Deletes configuration information for the eNote eOriginal integration. 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 | DeleteUserAuthorizationAsync (string accountId, string userId, string authorizationId) |
Deletes the user authorization More... | |
System.Threading.Tasks.Task< ApiResponse< Object > > | DeleteUserAuthorizationAsyncWithHttpInfo (string accountId, string userId, string authorizationId) |
Deletes the user authorization More... | |
System.Threading.Tasks.Task< UserAuthorizationsDeleteResponse > | DeleteUserAuthorizationsAsync (string accountId, string userId, UserAuthorizationsDeleteRequest userAuthorizationsDeleteRequest=null) |
Creates ot updates user authorizations More... | |
System.Threading.Tasks.Task< ApiResponse< UserAuthorizationsDeleteResponse > > | DeleteUserAuthorizationsAsyncWithHttpInfo (string accountId, string userId, UserAuthorizationsDeleteRequest userAuthorizationsDeleteRequest=null) |
Creates ot updates user authorizations More... | |
System.Threading.Tasks.Task< AccountIdentityVerificationResponse > | GetAccountIdentityVerificationAsync (string accountId) |
Get the list of identity verification options for an account More... | |
System.Threading.Tasks.Task< ApiResponse< AccountIdentityVerificationResponse > > | GetAccountIdentityVerificationAsyncWithHttpInfo (string accountId) |
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< AccountSignature > | GetAccountSignatureAsync (string accountId, string signatureId) |
Returns information about a single signature by specifed signatureId. More... | |
System.Threading.Tasks.Task< ApiResponse< AccountSignature > > | GetAccountSignatureAsyncWithHttpInfo (string accountId, string signatureId) |
Returns information about a single signature by specifed signatureId. 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< TabAccountSettings > | GetAccountTabSettingsAsync (string accountId) |
Returns tab settings list for specified account More... | |
System.Threading.Tasks.Task< ApiResponse< TabAccountSettings > > | GetAccountTabSettingsAsyncWithHttpInfo (string accountId) |
Returns tab settings list for specified 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< PaymentGatewayAccountsInfo > | GetAllPaymentGatewayAccountsAsync (string accountId) |
Get all payment gateway account for the provided accountId More... | |
System.Threading.Tasks.Task< ApiResponse< PaymentGatewayAccountsInfo > > | GetAllPaymentGatewayAccountsAsyncWithHttpInfo (string accountId) |
Get all payment gateway account for the provided accountId 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 | GetBrandExportFileAsync (string accountId, string brandId) |
Export a specific brand. More... | |
System.Threading.Tasks.Task< ApiResponse< Object > > | GetBrandExportFileAsyncWithHttpInfo (string accountId, string brandId) |
Export a specific brand. More... | |
System.Threading.Tasks.Task< System.IO.Stream > | GetBrandLogoByTypeAsync (string accountId, string brandId, string logoType) |
Obtains the specified image for a brand. More... | |
System.Threading.Tasks.Task< ApiResponse< System.IO.Stream > > | GetBrandLogoByTypeAsyncWithHttpInfo (string accountId, string brandId, string logoType) |
Obtains the specified image for a brand. More... | |
System.Threading.Tasks.Task< BrandResourcesList > | GetBrandResourcesAsync (string accountId, string brandId) |
Returns the specified account's list of branding resources (metadata). More... | |
System.Threading.Tasks.Task< ApiResponse< BrandResourcesList > > | GetBrandResourcesAsyncWithHttpInfo (string accountId, string brandId) |
Returns the specified account's list of branding resources (metadata). 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 > | GetConsumerDisclosureAsync (string accountId, string langCode) |
Gets the Electronic Record and Signature Disclosure. More... | |
System.Threading.Tasks.Task< ApiResponse< ConsumerDisclosure > > | GetConsumerDisclosureAsyncWithHttpInfo (string accountId, string langCode) |
Gets the Electronic Record and Signature Disclosure. 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< ENoteConfiguration > | GetENoteConfigurationAsync (string accountId) |
Returns the configuration information for the eNote eOriginal integration. More... | |
System.Threading.Tasks.Task< ApiResponse< ENoteConfiguration > > | GetENoteConfigurationAsyncWithHttpInfo (string accountId) |
Returns the configuration information for the eNote eOriginal integration. More... | |
System.Threading.Tasks.Task< EnvelopePurgeConfiguration > | GetEnvelopePurgeConfigurationAsync (string accountId) |
Select envelope purge configuration. More... | |
System.Threading.Tasks.Task< ApiResponse< EnvelopePurgeConfiguration > > | GetEnvelopePurgeConfigurationAsyncWithHttpInfo (string accountId) |
Select envelope purge configuration. More... | |
System.Threading.Tasks.Task< FavoriteTemplatesInfo > | GetFavoriteTemplatesAsync (string accountId) |
Retrieves the list of favorited templates for this caller More... | |
System.Threading.Tasks.Task< ApiResponse< FavoriteTemplatesInfo > > | GetFavoriteTemplatesAsyncWithHttpInfo (string accountId) |
Retrieves the list of favorited templates for this caller More... | |
System.Threading.Tasks.Task< NotificationDefaults > | GetNotificationDefaultsAsync (string accountId) |
Returns default user level settings for a specified account More... | |
System.Threading.Tasks.Task< ApiResponse< NotificationDefaults > > | GetNotificationDefaultsAsyncWithHttpInfo (string accountId) |
Returns default user level settings for a specified account More... | |
System.Threading.Tasks.Task< AccountPasswordRules > | GetPasswordRulesAsync (string accountId) |
Get the password rules More... | |
System.Threading.Tasks.Task< ApiResponse< AccountPasswordRules > > | GetPasswordRulesAsyncWithHttpInfo (string accountId) |
Get the password rules More... | |
System.Threading.Tasks.Task< UserPasswordRules > | GetPasswordRules_0Async () |
Get membership account password rules More... | |
System.Threading.Tasks.Task< ApiResponse< UserPasswordRules > > | GetPasswordRules_0AsyncWithHttpInfo () |
Get membership account password rules 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< ProvisioningInformation > | GetProvisioningAsync () |
Retrieves the account provisioning information for the account. More... | |
System.Threading.Tasks.Task< ApiResponse< ProvisioningInformation > > | GetProvisioningAsyncWithHttpInfo () |
Retrieves the account provisioning information for the account. More... | |
System.Threading.Tasks.Task< SupportedLanguages > | GetSupportedLanguagesAsync (string accountId) |
Gets list of supported languages for recipient language setting. More... | |
System.Threading.Tasks.Task< ApiResponse< SupportedLanguages > > | GetSupportedLanguagesAsyncWithHttpInfo (string accountId) |
Gets list of supported languages for recipient language setting. More... | |
System.Threading.Tasks.Task< UserAuthorization > | GetUserAuthorizationAsync (string accountId, string userId, string authorizationId) |
Returns the user authorization for a given authorization id More... | |
System.Threading.Tasks.Task< ApiResponse< UserAuthorization > > | GetUserAuthorizationAsyncWithHttpInfo (string accountId, string userId, string authorizationId) |
Returns the user authorization for a given authorization id More... | |
System.Threading.Tasks.Task< Watermark > | GetWatermarkAsync (string accountId) |
Get watermark information. More... | |
System.Threading.Tasks.Task< ApiResponse< Watermark > > | GetWatermarkAsyncWithHttpInfo (string accountId) |
Get watermark information. More... | |
System.Threading.Tasks.Task< Watermark > | GetWatermarkPreviewAsync (string accountId, Watermark watermark=null) |
Get watermark preview. More... | |
System.Threading.Tasks.Task< ApiResponse< Watermark > > | GetWatermarkPreviewAsyncWithHttpInfo (string accountId, Watermark watermark=null) |
Get watermark preview. 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< CustomFields > | ListCustomFieldsAsync (string accountId) |
Gets a list of custom fields associated with the account. More... | |
System.Threading.Tasks.Task< ApiResponse< CustomFields > > | ListCustomFieldsAsyncWithHttpInfo (string accountId) |
Gets a list of custom fields associated with the account. 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< AccountSettingsInformation > | ListSettingsAsync (string accountId) |
Gets account settings information. More... | |
System.Threading.Tasks.Task< ApiResponse< AccountSettingsInformation > > | ListSettingsAsyncWithHttpInfo (string accountId) |
Gets account settings information. 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< AccountSignatureProviders > | ListSignatureProvidersAsync (string accountId) |
Returns Account available signature providers for specified account. More... | |
System.Threading.Tasks.Task< ApiResponse< AccountSignatureProviders > > | ListSignatureProvidersAsyncWithHttpInfo (string accountId) |
Returns Account available signature providers for specified account. More... | |
System.Threading.Tasks.Task< FileTypeList > | ListUnsupportedFileTypesAsync (string accountId) |
Gets a list of unsupported file types. More... | |
System.Threading.Tasks.Task< ApiResponse< FileTypeList > > | ListUnsupportedFileTypesAsyncWithHttpInfo (string accountId) |
Gets a list of unsupported file types. More... | |
System.Threading.Tasks.Task< FavoriteTemplatesInfo > | UnFavoriteTemplateAsync (string accountId, FavoriteTemplatesInfo favoriteTemplatesInfo=null) |
Unfavorite a template More... | |
System.Threading.Tasks.Task< ApiResponse< FavoriteTemplatesInfo > > | UnFavoriteTemplateAsyncWithHttpInfo (string accountId, FavoriteTemplatesInfo favoriteTemplatesInfo=null) |
Unfavorite a template More... | |
System.Threading.Tasks.Task< AccountSignaturesInformation > | UpdateAccountSignatureAsync (string accountId, AccountSignaturesInformation accountSignaturesInformation=null) |
Updates a account signature. More... | |
System.Threading.Tasks.Task< ApiResponse< AccountSignaturesInformation > > | UpdateAccountSignatureAsyncWithHttpInfo (string accountId, AccountSignaturesInformation accountSignaturesInformation=null) |
Updates a account signature. 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< TabAccountSettings > | UpdateAccountTabSettingsAsync (string accountId, TabAccountSettings tabAccountSettings=null) |
Modifies tab settings for specified account More... | |
System.Threading.Tasks.Task< ApiResponse< TabAccountSettings > > | UpdateAccountTabSettingsAsyncWithHttpInfo (string accountId, TabAccountSettings tabAccountSettings=null) |
Modifies tab settings for specified account 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 | UpdateBrandLogoByTypeAsync (string accountId, string brandId, string logoType, byte[] logoFileBytes) |
Put one branding logo. More... | |
System.Threading.Tasks.Task< ApiResponse< Object > > | UpdateBrandLogoByTypeAsyncWithHttpInfo (string accountId, string brandId, string logoType, byte[] logoFileBytes) |
Put one branding logo. More... | |
System.Threading.Tasks.Task< BrandResources > | UpdateBrandResourcesByContentTypeAsync (string accountId, string brandId, string resourceContentType, byte[] fileXml) |
Uploads a branding resource file. More... | |
System.Threading.Tasks.Task< ApiResponse< BrandResources > > | UpdateBrandResourcesByContentTypeAsyncWithHttpInfo (string accountId, string brandId, string resourceContentType, byte[] fileXml) |
Uploads a branding resource file. 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< ENoteConfiguration > | UpdateENoteConfigurationAsync (string accountId, ENoteConfiguration eNoteConfiguration=null) |
Updates configuration information for the eNote eOriginal integration. More... | |
System.Threading.Tasks.Task< ApiResponse< ENoteConfiguration > > | UpdateENoteConfigurationAsyncWithHttpInfo (string accountId, ENoteConfiguration eNoteConfiguration=null) |
Updates configuration information for the eNote eOriginal integration. More... | |
System.Threading.Tasks.Task< EnvelopePurgeConfiguration > | UpdateEnvelopePurgeConfigurationAsync (string accountId, EnvelopePurgeConfiguration envelopePurgeConfiguration=null) |
Updates envelope purge configuration. More... | |
System.Threading.Tasks.Task< ApiResponse< EnvelopePurgeConfiguration > > | UpdateEnvelopePurgeConfigurationAsyncWithHttpInfo (string accountId, EnvelopePurgeConfiguration envelopePurgeConfiguration=null) |
Updates envelope purge configuration. More... | |
System.Threading.Tasks.Task< FavoriteTemplatesInfo > | UpdateFavoriteTemplateAsync (string accountId, FavoriteTemplatesInfo favoriteTemplatesInfo=null) |
Favorites a template More... | |
System.Threading.Tasks.Task< ApiResponse< FavoriteTemplatesInfo > > | UpdateFavoriteTemplateAsyncWithHttpInfo (string accountId, FavoriteTemplatesInfo favoriteTemplatesInfo=null) |
Favorites a template More... | |
System.Threading.Tasks.Task< NotificationDefaults > | UpdateNotificationDefaultsAsync (string accountId, NotificationDefaults notificationDefaults=null) |
Updates default user level settings for a specified account More... | |
System.Threading.Tasks.Task< ApiResponse< NotificationDefaults > > | UpdateNotificationDefaultsAsyncWithHttpInfo (string accountId, NotificationDefaults notificationDefaults=null) |
Updates default user level settings for a specified account More... | |
System.Threading.Tasks.Task< AccountPasswordRules > | UpdatePasswordRulesAsync (string accountId, AccountPasswordRules accountPasswordRules=null) |
Update the password rules More... | |
System.Threading.Tasks.Task< ApiResponse< AccountPasswordRules > > | UpdatePasswordRulesAsyncWithHttpInfo (string accountId, AccountPasswordRules accountPasswordRules=null) |
Update the password rules 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 | UpdateSettingsAsync (string accountId, AccountSettingsInformation accountSettingsInformation=null) |
Updates the account settings for an account. More... | |
System.Threading.Tasks.Task< ApiResponse< Object > > | UpdateSettingsAsyncWithHttpInfo (string accountId, AccountSettingsInformation accountSettingsInformation=null) |
Updates the account settings for an 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... | |
System.Threading.Tasks.Task< UserAuthorization > | UpdateUserAuthorizationAsync (string accountId, string userId, string authorizationId, UserAuthorizationUpdateRequest userAuthorizationUpdateRequest=null) |
Updates the user authorization More... | |
System.Threading.Tasks.Task< ApiResponse< UserAuthorization > > | UpdateUserAuthorizationAsyncWithHttpInfo (string accountId, string userId, string authorizationId, UserAuthorizationUpdateRequest userAuthorizationUpdateRequest=null) |
Updates the user authorization More... | |
System.Threading.Tasks.Task< Watermark > | UpdateWatermarkAsync (string accountId, Watermark watermark=null) |
Update watermark information. More... | |
System.Threading.Tasks.Task< ApiResponse< Watermark > > | UpdateWatermarkAsyncWithHttpInfo (string accountId, Watermark watermark=null) |
Update watermark information. More... | |
Public Member Functions inherited from DocuSign.eSign.Client.IApiAccessor | |
String | GetBasePath () |
Gets the base path of the API client. More... | |
Additional Inherited Members | |
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
NewAccountSummary DocuSign.eSign.Api.IAccountsApi.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.
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
newAccountDefinition | (optional) |
options | Options for modifying the behavior of the function. |
AccountSignaturesInformation DocuSign.eSign.Api.IAccountsApi.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.
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. |
System.Threading.Tasks.Task<AccountSignaturesInformation> DocuSign.eSign.Api.IAccountsApi.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.
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. |
System.Threading.Tasks.Task<ApiResponse<AccountSignaturesInformation> > DocuSign.eSign.Api.IAccountsApi.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.
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. |
ApiResponse<AccountSignaturesInformation> DocuSign.eSign.Api.IAccountsApi.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.
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. |
System.Threading.Tasks.Task<NewAccountSummary> DocuSign.eSign.Api.IAccountsApi.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.
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
newAccountDefinition | (optional) |
options | Options for modifying the behavior of the function. |
System.Threading.Tasks.Task<ApiResponse<NewAccountSummary> > DocuSign.eSign.Api.IAccountsApi.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.
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
newAccountDefinition | (optional) |
options | Options for modifying the behavior of the function. |
BrandsResponse DocuSign.eSign.Api.IAccountsApi.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`.
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID GUID. |
brand | (optional) |
Implemented in DocuSign.eSign.Api.AccountsApi.
System.Threading.Tasks.Task<BrandsResponse> DocuSign.eSign.Api.IAccountsApi.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`.
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID GUID. |
brand | (optional) |
Implemented in DocuSign.eSign.Api.AccountsApi.
System.Threading.Tasks.Task<ApiResponse<BrandsResponse> > DocuSign.eSign.Api.IAccountsApi.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`.
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID GUID. |
brand | (optional) |
Implemented in DocuSign.eSign.Api.AccountsApi.
ApiResponse<BrandsResponse> DocuSign.eSign.Api.IAccountsApi.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`.
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID GUID. |
brand | (optional) |
Implemented in DocuSign.eSign.Api.AccountsApi.
CustomFields DocuSign.eSign.Api.IAccountsApi.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.
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. |
System.Threading.Tasks.Task<CustomFields> DocuSign.eSign.Api.IAccountsApi.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.
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. |
System.Threading.Tasks.Task<ApiResponse<CustomFields> > DocuSign.eSign.Api.IAccountsApi.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.
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. |
ApiResponse<CustomFields> DocuSign.eSign.Api.IAccountsApi.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.
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. |
PermissionProfile DocuSign.eSign.Api.IAccountsApi.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
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. |
System.Threading.Tasks.Task<PermissionProfile> DocuSign.eSign.Api.IAccountsApi.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
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. |
System.Threading.Tasks.Task<ApiResponse<PermissionProfile> > DocuSign.eSign.Api.IAccountsApi.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
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. |
ApiResponse<PermissionProfile> DocuSign.eSign.Api.IAccountsApi.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
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. |
UserAuthorization DocuSign.eSign.Api.IAccountsApi.CreateUserAuthorization | ( | string | accountId, |
string | userId, | ||
UserAuthorizationCreateRequest | userAuthorizationCreateRequest = null |
||
) |
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) |
Implemented in DocuSign.eSign.Api.AccountsApi.
System.Threading.Tasks.Task<UserAuthorization> DocuSign.eSign.Api.IAccountsApi.CreateUserAuthorizationAsync | ( | string | accountId, |
string | userId, | ||
UserAuthorizationCreateRequest | userAuthorizationCreateRequest = null |
||
) |
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) |
Implemented in DocuSign.eSign.Api.AccountsApi.
System.Threading.Tasks.Task<ApiResponse<UserAuthorization> > DocuSign.eSign.Api.IAccountsApi.CreateUserAuthorizationAsyncWithHttpInfo | ( | string | accountId, |
string | userId, | ||
UserAuthorizationCreateRequest | userAuthorizationCreateRequest = null |
||
) |
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) |
Implemented in DocuSign.eSign.Api.AccountsApi.
UserAuthorizationsResponse DocuSign.eSign.Api.IAccountsApi.CreateUserAuthorizations | ( | string | accountId, |
string | userId, | ||
UserAuthorizationsRequest | userAuthorizationsRequest = null |
||
) |
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) |
Implemented in DocuSign.eSign.Api.AccountsApi.
System.Threading.Tasks.Task<UserAuthorizationsResponse> DocuSign.eSign.Api.IAccountsApi.CreateUserAuthorizationsAsync | ( | string | accountId, |
string | userId, | ||
UserAuthorizationsRequest | userAuthorizationsRequest = null |
||
) |
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) |
Implemented in DocuSign.eSign.Api.AccountsApi.
System.Threading.Tasks.Task<ApiResponse<UserAuthorizationsResponse> > DocuSign.eSign.Api.IAccountsApi.CreateUserAuthorizationsAsyncWithHttpInfo | ( | string | accountId, |
string | userId, | ||
UserAuthorizationsRequest | userAuthorizationsRequest = null |
||
) |
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) |
Implemented in DocuSign.eSign.Api.AccountsApi.
ApiResponse<UserAuthorizationsResponse> DocuSign.eSign.Api.IAccountsApi.CreateUserAuthorizationsWithHttpInfo | ( | string | accountId, |
string | userId, | ||
UserAuthorizationsRequest | userAuthorizationsRequest = null |
||
) |
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) |
Implemented in DocuSign.eSign.Api.AccountsApi.
ApiResponse<UserAuthorization> DocuSign.eSign.Api.IAccountsApi.CreateUserAuthorizationWithHttpInfo | ( | string | accountId, |
string | userId, | ||
UserAuthorizationCreateRequest | userAuthorizationCreateRequest = null |
||
) |
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) |
Implemented in DocuSign.eSign.Api.AccountsApi.
ApiResponse<NewAccountSummary> DocuSign.eSign.Api.IAccountsApi.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.
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
newAccountDefinition | (optional) |
options | Options for modifying the behavior of the function. |
void DocuSign.eSign.Api.IAccountsApi.Delete | ( | string | accountId | ) |
Deletes the specified account.
This closes the specified account. You must be an account admin to close your account. Once closed, an account must be reopened by DocuSign.
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
Implemented in DocuSign.eSign.Api.AccountsApi.
void DocuSign.eSign.Api.IAccountsApi.DeleteAccountSignature | ( | string | accountId, |
string | signatureId | ||
) |
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. |
Implemented in DocuSign.eSign.Api.AccountsApi.
System.Threading.Tasks.Task DocuSign.eSign.Api.IAccountsApi.DeleteAccountSignatureAsync | ( | string | accountId, |
string | signatureId | ||
) |
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. |
Implemented in DocuSign.eSign.Api.AccountsApi.
System.Threading.Tasks.Task<ApiResponse<Object> > DocuSign.eSign.Api.IAccountsApi.DeleteAccountSignatureAsyncWithHttpInfo | ( | string | accountId, |
string | signatureId | ||
) |
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. |
Implemented in DocuSign.eSign.Api.AccountsApi.
AccountSignature DocuSign.eSign.Api.IAccountsApi.DeleteAccountSignatureImage | ( | string | accountId, |
string | signatureId, | ||
string | imageType | ||
) |
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. |
Implemented in DocuSign.eSign.Api.AccountsApi.
System.Threading.Tasks.Task<AccountSignature> DocuSign.eSign.Api.IAccountsApi.DeleteAccountSignatureImageAsync | ( | string | accountId, |
string | signatureId, | ||
string | imageType | ||
) |
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. |
Implemented in DocuSign.eSign.Api.AccountsApi.
System.Threading.Tasks.Task<ApiResponse<AccountSignature> > DocuSign.eSign.Api.IAccountsApi.DeleteAccountSignatureImageAsyncWithHttpInfo | ( | string | accountId, |
string | signatureId, | ||
string | imageType | ||
) |
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. |
Implemented in DocuSign.eSign.Api.AccountsApi.
ApiResponse<AccountSignature> DocuSign.eSign.Api.IAccountsApi.DeleteAccountSignatureImageWithHttpInfo | ( | string | accountId, |
string | signatureId, | ||
string | imageType | ||
) |
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. |
Implemented in DocuSign.eSign.Api.AccountsApi.
ApiResponse<Object> DocuSign.eSign.Api.IAccountsApi.DeleteAccountSignatureWithHttpInfo | ( | string | accountId, |
string | signatureId | ||
) |
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. |
Implemented in DocuSign.eSign.Api.AccountsApi.
System.Threading.Tasks.Task DocuSign.eSign.Api.IAccountsApi.DeleteAsync | ( | string | accountId | ) |
Deletes the specified account.
This closes the specified account. You must be an account admin to close your account. Once closed, an account must be reopened by DocuSign.
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
Implemented in DocuSign.eSign.Api.AccountsApi.
System.Threading.Tasks.Task<ApiResponse<Object> > DocuSign.eSign.Api.IAccountsApi.DeleteAsyncWithHttpInfo | ( | string | accountId | ) |
Deletes the specified account.
This closes the specified account. You must be an account admin to close your account. Once closed, an account must be reopened by DocuSign.
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
Implemented in DocuSign.eSign.Api.AccountsApi.
void DocuSign.eSign.Api.IAccountsApi.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).
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. |
Implemented in DocuSign.eSign.Api.AccountsApi.
System.Threading.Tasks.Task DocuSign.eSign.Api.IAccountsApi.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).
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. |
Implemented in DocuSign.eSign.Api.AccountsApi.
System.Threading.Tasks.Task<ApiResponse<Object> > DocuSign.eSign.Api.IAccountsApi.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).
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. |
Implemented in DocuSign.eSign.Api.AccountsApi.
void DocuSign.eSign.Api.IAccountsApi.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).
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. |
Implemented in DocuSign.eSign.Api.AccountsApi.
System.Threading.Tasks.Task DocuSign.eSign.Api.IAccountsApi.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).
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. |
Implemented in DocuSign.eSign.Api.AccountsApi.
System.Threading.Tasks.Task<ApiResponse<Object> > DocuSign.eSign.Api.IAccountsApi.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).
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. |
Implemented in DocuSign.eSign.Api.AccountsApi.
ApiResponse<Object> DocuSign.eSign.Api.IAccountsApi.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).
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. |
Implemented in DocuSign.eSign.Api.AccountsApi.
BrandsResponse DocuSign.eSign.Api.IAccountsApi.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.
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
brandsRequest | (optional) |
Implemented in DocuSign.eSign.Api.AccountsApi.
System.Threading.Tasks.Task<BrandsResponse> DocuSign.eSign.Api.IAccountsApi.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.
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
brandsRequest | (optional) |
Implemented in DocuSign.eSign.Api.AccountsApi.
System.Threading.Tasks.Task<ApiResponse<BrandsResponse> > DocuSign.eSign.Api.IAccountsApi.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.
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
brandsRequest | (optional) |
Implemented in DocuSign.eSign.Api.AccountsApi.
ApiResponse<BrandsResponse> DocuSign.eSign.Api.IAccountsApi.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.
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
brandsRequest | (optional) |
Implemented in DocuSign.eSign.Api.AccountsApi.
ApiResponse<Object> DocuSign.eSign.Api.IAccountsApi.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).
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. |
Implemented in DocuSign.eSign.Api.AccountsApi.
CaptiveRecipientInformation DocuSign.eSign.Api.IAccountsApi.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.
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
recipientPart | |
captiveRecipientInformation | (optional) |
Implemented in DocuSign.eSign.Api.AccountsApi.
System.Threading.Tasks.Task<CaptiveRecipientInformation> DocuSign.eSign.Api.IAccountsApi.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.
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
recipientPart | |
captiveRecipientInformation | (optional) |
Implemented in DocuSign.eSign.Api.AccountsApi.
System.Threading.Tasks.Task<ApiResponse<CaptiveRecipientInformation> > DocuSign.eSign.Api.IAccountsApi.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.
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
recipientPart | |
captiveRecipientInformation | (optional) |
Implemented in DocuSign.eSign.Api.AccountsApi.
ApiResponse<CaptiveRecipientInformation> DocuSign.eSign.Api.IAccountsApi.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.
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
recipientPart | |
captiveRecipientInformation | (optional) |
Implemented in DocuSign.eSign.Api.AccountsApi.
void DocuSign.eSign.Api.IAccountsApi.DeleteCustomField | ( | string | accountId, |
string | customFieldId, | ||
AccountsApi.DeleteCustomFieldOptions | options = null |
||
) |
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. |
System.Threading.Tasks.Task DocuSign.eSign.Api.IAccountsApi.DeleteCustomFieldAsync | ( | string | accountId, |
string | customFieldId, | ||
AccountsApi.DeleteCustomFieldOptions | options = null |
||
) |
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. |
System.Threading.Tasks.Task<ApiResponse<Object> > DocuSign.eSign.Api.IAccountsApi.DeleteCustomFieldAsyncWithHttpInfo | ( | string | accountId, |
string | customFieldId, | ||
AccountsApi.DeleteCustomFieldOptions | options = null |
||
) |
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. |
ApiResponse<Object> DocuSign.eSign.Api.IAccountsApi.DeleteCustomFieldWithHttpInfo | ( | string | accountId, |
string | customFieldId, | ||
AccountsApi.DeleteCustomFieldOptions | options = null |
||
) |
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. |
void DocuSign.eSign.Api.IAccountsApi.DeleteENoteConfiguration | ( | string | accountId | ) |
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. |
Implemented in DocuSign.eSign.Api.AccountsApi.
System.Threading.Tasks.Task DocuSign.eSign.Api.IAccountsApi.DeleteENoteConfigurationAsync | ( | string | accountId | ) |
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. |
Implemented in DocuSign.eSign.Api.AccountsApi.
System.Threading.Tasks.Task<ApiResponse<Object> > DocuSign.eSign.Api.IAccountsApi.DeleteENoteConfigurationAsyncWithHttpInfo | ( | string | accountId | ) |
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. |
Implemented in DocuSign.eSign.Api.AccountsApi.
ApiResponse<Object> DocuSign.eSign.Api.IAccountsApi.DeleteENoteConfigurationWithHttpInfo | ( | string | accountId | ) |
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. |
Implemented in DocuSign.eSign.Api.AccountsApi.
void DocuSign.eSign.Api.IAccountsApi.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
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. |
System.Threading.Tasks.Task DocuSign.eSign.Api.IAccountsApi.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
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. |
System.Threading.Tasks.Task<ApiResponse<Object> > DocuSign.eSign.Api.IAccountsApi.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
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. |
ApiResponse<Object> DocuSign.eSign.Api.IAccountsApi.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
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. |
void DocuSign.eSign.Api.IAccountsApi.DeleteUserAuthorization | ( | string | accountId, |
string | userId, | ||
string | authorizationId | ||
) |
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 |
Implemented in DocuSign.eSign.Api.AccountsApi.
System.Threading.Tasks.Task DocuSign.eSign.Api.IAccountsApi.DeleteUserAuthorizationAsync | ( | string | accountId, |
string | userId, | ||
string | authorizationId | ||
) |
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 |
Implemented in DocuSign.eSign.Api.AccountsApi.
System.Threading.Tasks.Task<ApiResponse<Object> > DocuSign.eSign.Api.IAccountsApi.DeleteUserAuthorizationAsyncWithHttpInfo | ( | string | accountId, |
string | userId, | ||
string | authorizationId | ||
) |
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 |
Implemented in DocuSign.eSign.Api.AccountsApi.
UserAuthorizationsDeleteResponse DocuSign.eSign.Api.IAccountsApi.DeleteUserAuthorizations | ( | string | accountId, |
string | userId, | ||
UserAuthorizationsDeleteRequest | userAuthorizationsDeleteRequest = null |
||
) |
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) |
Implemented in DocuSign.eSign.Api.AccountsApi.
System.Threading.Tasks.Task<UserAuthorizationsDeleteResponse> DocuSign.eSign.Api.IAccountsApi.DeleteUserAuthorizationsAsync | ( | string | accountId, |
string | userId, | ||
UserAuthorizationsDeleteRequest | userAuthorizationsDeleteRequest = null |
||
) |
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) |
Implemented in DocuSign.eSign.Api.AccountsApi.
System.Threading.Tasks.Task<ApiResponse<UserAuthorizationsDeleteResponse> > DocuSign.eSign.Api.IAccountsApi.DeleteUserAuthorizationsAsyncWithHttpInfo | ( | string | accountId, |
string | userId, | ||
UserAuthorizationsDeleteRequest | userAuthorizationsDeleteRequest = null |
||
) |
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) |
Implemented in DocuSign.eSign.Api.AccountsApi.
ApiResponse<UserAuthorizationsDeleteResponse> DocuSign.eSign.Api.IAccountsApi.DeleteUserAuthorizationsWithHttpInfo | ( | string | accountId, |
string | userId, | ||
UserAuthorizationsDeleteRequest | userAuthorizationsDeleteRequest = null |
||
) |
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) |
Implemented in DocuSign.eSign.Api.AccountsApi.
ApiResponse<Object> DocuSign.eSign.Api.IAccountsApi.DeleteUserAuthorizationWithHttpInfo | ( | string | accountId, |
string | userId, | ||
string | authorizationId | ||
) |
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 |
Implemented in DocuSign.eSign.Api.AccountsApi.
ApiResponse<Object> DocuSign.eSign.Api.IAccountsApi.DeleteWithHttpInfo | ( | string | accountId | ) |
Deletes the specified account.
This closes the specified account. You must be an account admin to close your account. Once closed, an account must be reopened by DocuSign.
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
Implemented in DocuSign.eSign.Api.AccountsApi.
AccountIdentityVerificationResponse DocuSign.eSign.Api.IAccountsApi.GetAccountIdentityVerification | ( | string | accountId | ) |
Get the list of identity verification options for an account
This method returns a list of Identity Verification workflows that are available to an account. Note: To use this method, you must either be an account administrator or a sender. ### Related topics - How to require ID Verification (IDV) for a recipient
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
Implemented in DocuSign.eSign.Api.AccountsApi.
System.Threading.Tasks.Task<AccountIdentityVerificationResponse> DocuSign.eSign.Api.IAccountsApi.GetAccountIdentityVerificationAsync | ( | string | accountId | ) |
Get the list of identity verification options for an account
This method returns a list of Identity Verification workflows that are available to an account. Note: To use this method, you must either be an account administrator or a sender. ### Related topics - How to require ID Verification (IDV) for a recipient
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
Implemented in DocuSign.eSign.Api.AccountsApi.
System.Threading.Tasks.Task<ApiResponse<AccountIdentityVerificationResponse> > DocuSign.eSign.Api.IAccountsApi.GetAccountIdentityVerificationAsyncWithHttpInfo | ( | string | accountId | ) |
Get the list of identity verification options for an account
This method returns a list of Identity Verification workflows that are available to an account. Note: To use this method, you must either be an account administrator or a sender. ### Related topics - How to require ID Verification (IDV) for a recipient
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
Implemented in DocuSign.eSign.Api.AccountsApi.
ApiResponse<AccountIdentityVerificationResponse> DocuSign.eSign.Api.IAccountsApi.GetAccountIdentityVerificationWithHttpInfo | ( | string | accountId | ) |
Get the list of identity verification options for an account
This method returns a list of Identity Verification workflows that are available to an account. 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. |
Implemented in DocuSign.eSign.Api.AccountsApi.
AccountInformation DocuSign.eSign.Api.IAccountsApi.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.
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. |
System.Threading.Tasks.Task<AccountInformation> DocuSign.eSign.Api.IAccountsApi.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.
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. |
System.Threading.Tasks.Task<ApiResponse<AccountInformation> > DocuSign.eSign.Api.IAccountsApi.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.
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. |
ApiResponse<AccountInformation> DocuSign.eSign.Api.IAccountsApi.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.
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. |
AccountSignature DocuSign.eSign.Api.IAccountsApi.GetAccountSignature | ( | string | accountId, |
string | signatureId | ||
) |
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. |
Implemented in DocuSign.eSign.Api.AccountsApi.
System.Threading.Tasks.Task<AccountSignature> DocuSign.eSign.Api.IAccountsApi.GetAccountSignatureAsync | ( | string | accountId, |
string | signatureId | ||
) |
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. |
Implemented in DocuSign.eSign.Api.AccountsApi.
System.Threading.Tasks.Task<ApiResponse<AccountSignature> > DocuSign.eSign.Api.IAccountsApi.GetAccountSignatureAsyncWithHttpInfo | ( | string | accountId, |
string | signatureId | ||
) |
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. |
Implemented in DocuSign.eSign.Api.AccountsApi.
System.IO.Stream DocuSign.eSign.Api.IAccountsApi.GetAccountSignatureImage | ( | string | accountId, |
string | signatureId, | ||
string | imageType, | ||
AccountsApi.GetAccountSignatureImageOptions | options = null |
||
) |
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. |
System.Threading.Tasks.Task<System.IO.Stream> DocuSign.eSign.Api.IAccountsApi.GetAccountSignatureImageAsync | ( | string | accountId, |
string | signatureId, | ||
string | imageType, | ||
AccountsApi.GetAccountSignatureImageOptions | options = null |
||
) |
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. |
System.Threading.Tasks.Task<ApiResponse<System.IO.Stream> > DocuSign.eSign.Api.IAccountsApi.GetAccountSignatureImageAsyncWithHttpInfo | ( | string | accountId, |
string | signatureId, | ||
string | imageType, | ||
AccountsApi.GetAccountSignatureImageOptions | options = null |
||
) |
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. |
ApiResponse<System.IO.Stream> DocuSign.eSign.Api.IAccountsApi.GetAccountSignatureImageWithHttpInfo | ( | string | accountId, |
string | signatureId, | ||
string | imageType, | ||
AccountsApi.GetAccountSignatureImageOptions | options = null |
||
) |
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. |
AccountSignaturesInformation DocuSign.eSign.Api.IAccountsApi.GetAccountSignatures | ( | string | accountId, |
AccountsApi.GetAccountSignaturesOptions | options = null |
||
) |
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. |
System.Threading.Tasks.Task<AccountSignaturesInformation> DocuSign.eSign.Api.IAccountsApi.GetAccountSignaturesAsync | ( | string | accountId, |
AccountsApi.GetAccountSignaturesOptions | options = null |
||
) |
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. |
System.Threading.Tasks.Task<ApiResponse<AccountSignaturesInformation> > DocuSign.eSign.Api.IAccountsApi.GetAccountSignaturesAsyncWithHttpInfo | ( | string | accountId, |
AccountsApi.GetAccountSignaturesOptions | options = null |
||
) |
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. |
ApiResponse<AccountSignaturesInformation> DocuSign.eSign.Api.IAccountsApi.GetAccountSignaturesWithHttpInfo | ( | string | accountId, |
AccountsApi.GetAccountSignaturesOptions | options = null |
||
) |
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. |
ApiResponse<AccountSignature> DocuSign.eSign.Api.IAccountsApi.GetAccountSignatureWithHttpInfo | ( | string | accountId, |
string | signatureId | ||
) |
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. |
Implemented in DocuSign.eSign.Api.AccountsApi.
TabAccountSettings DocuSign.eSign.Api.IAccountsApi.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.
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
Implemented in DocuSign.eSign.Api.AccountsApi.
System.Threading.Tasks.Task<TabAccountSettings> DocuSign.eSign.Api.IAccountsApi.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.
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
Implemented in DocuSign.eSign.Api.AccountsApi.
System.Threading.Tasks.Task<ApiResponse<TabAccountSettings> > DocuSign.eSign.Api.IAccountsApi.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.
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
Implemented in DocuSign.eSign.Api.AccountsApi.
ApiResponse<TabAccountSettings> DocuSign.eSign.Api.IAccountsApi.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.
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
Implemented in DocuSign.eSign.Api.AccountsApi.
UserAuthorizations DocuSign.eSign.Api.IAccountsApi.GetAgentUserAuthorizations | ( | string | accountId, |
string | userId, | ||
AccountsApi.GetAgentUserAuthorizationsOptions | options = null |
||
) |
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. |
System.Threading.Tasks.Task<UserAuthorizations> DocuSign.eSign.Api.IAccountsApi.GetAgentUserAuthorizationsAsync | ( | string | accountId, |
string | userId, | ||
AccountsApi.GetAgentUserAuthorizationsOptions | options = null |
||
) |
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. |
System.Threading.Tasks.Task<ApiResponse<UserAuthorizations> > DocuSign.eSign.Api.IAccountsApi.GetAgentUserAuthorizationsAsyncWithHttpInfo | ( | string | accountId, |
string | userId, | ||
AccountsApi.GetAgentUserAuthorizationsOptions | options = null |
||
) |
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. |
ApiResponse<UserAuthorizations> DocuSign.eSign.Api.IAccountsApi.GetAgentUserAuthorizationsWithHttpInfo | ( | string | accountId, |
string | userId, | ||
AccountsApi.GetAgentUserAuthorizationsOptions | options = null |
||
) |
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. |
PaymentGatewayAccountsInfo DocuSign.eSign.Api.IAccountsApi.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.
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
Implemented in DocuSign.eSign.Api.AccountsApi.
System.Threading.Tasks.Task<PaymentGatewayAccountsInfo> DocuSign.eSign.Api.IAccountsApi.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.
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
Implemented in DocuSign.eSign.Api.AccountsApi.
System.Threading.Tasks.Task<ApiResponse<PaymentGatewayAccountsInfo> > DocuSign.eSign.Api.IAccountsApi.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.
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
Implemented in DocuSign.eSign.Api.AccountsApi.
ApiResponse<PaymentGatewayAccountsInfo> DocuSign.eSign.Api.IAccountsApi.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.
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
Implemented in DocuSign.eSign.Api.AccountsApi.
BillingChargeResponse DocuSign.eSign.Api.IAccountsApi.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
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. |
System.Threading.Tasks.Task<BillingChargeResponse> DocuSign.eSign.Api.IAccountsApi.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
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. |
System.Threading.Tasks.Task<ApiResponse<BillingChargeResponse> > DocuSign.eSign.Api.IAccountsApi.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
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. |
ApiResponse<BillingChargeResponse> DocuSign.eSign.Api.IAccountsApi.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
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. |
Brand DocuSign.eSign.Api.IAccountsApi.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).
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. |
System.Threading.Tasks.Task<Brand> DocuSign.eSign.Api.IAccountsApi.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).
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. |
System.Threading.Tasks.Task<ApiResponse<Brand> > DocuSign.eSign.Api.IAccountsApi.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).
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. |
void DocuSign.eSign.Api.IAccountsApi.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).
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. |
Implemented in DocuSign.eSign.Api.AccountsApi.
System.Threading.Tasks.Task DocuSign.eSign.Api.IAccountsApi.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).
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. |
Implemented in DocuSign.eSign.Api.AccountsApi.
System.Threading.Tasks.Task<ApiResponse<Object> > DocuSign.eSign.Api.IAccountsApi.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).
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. |
Implemented in DocuSign.eSign.Api.AccountsApi.
ApiResponse<Object> DocuSign.eSign.Api.IAccountsApi.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).
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. |
Implemented in DocuSign.eSign.Api.AccountsApi.
System.IO.Stream DocuSign.eSign.Api.IAccountsApi.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).
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. |
Implemented in DocuSign.eSign.Api.AccountsApi.
System.Threading.Tasks.Task<System.IO.Stream> DocuSign.eSign.Api.IAccountsApi.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).
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. |
Implemented in DocuSign.eSign.Api.AccountsApi.
System.Threading.Tasks.Task<ApiResponse<System.IO.Stream> > DocuSign.eSign.Api.IAccountsApi.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).
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. |
Implemented in DocuSign.eSign.Api.AccountsApi.
ApiResponse<System.IO.Stream> DocuSign.eSign.Api.IAccountsApi.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).
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. |
Implemented in DocuSign.eSign.Api.AccountsApi.
BrandResourcesList DocuSign.eSign.Api.IAccountsApi.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).
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. |
Implemented in DocuSign.eSign.Api.AccountsApi.
System.Threading.Tasks.Task<BrandResourcesList> DocuSign.eSign.Api.IAccountsApi.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).
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. |
Implemented in DocuSign.eSign.Api.AccountsApi.
System.Threading.Tasks.Task<ApiResponse<BrandResourcesList> > DocuSign.eSign.Api.IAccountsApi.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).
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. |
Implemented in DocuSign.eSign.Api.AccountsApi.
void DocuSign.eSign.Api.IAccountsApi.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).
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. |
System.Threading.Tasks.Task DocuSign.eSign.Api.IAccountsApi.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).
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. |
System.Threading.Tasks.Task<ApiResponse<Object> > DocuSign.eSign.Api.IAccountsApi.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).
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. |
ApiResponse<Object> DocuSign.eSign.Api.IAccountsApi.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).
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. |
ApiResponse<BrandResourcesList> DocuSign.eSign.Api.IAccountsApi.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).
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. |
Implemented in DocuSign.eSign.Api.AccountsApi.
ApiResponse<Brand> DocuSign.eSign.Api.IAccountsApi.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).
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. |
ConsumerDisclosure DocuSign.eSign.Api.IAccountsApi.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.
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), 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. |
Implemented in DocuSign.eSign.Api.AccountsApi.
System.Threading.Tasks.Task<ConsumerDisclosure> DocuSign.eSign.Api.IAccountsApi.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.
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), 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. |
Implemented in DocuSign.eSign.Api.AccountsApi.
System.Threading.Tasks.Task<ApiResponse<ConsumerDisclosure> > DocuSign.eSign.Api.IAccountsApi.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.
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), 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. |
Implemented in DocuSign.eSign.Api.AccountsApi.
ConsumerDisclosure DocuSign.eSign.Api.IAccountsApi.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.
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. |
System.Threading.Tasks.Task<ConsumerDisclosure> DocuSign.eSign.Api.IAccountsApi.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.
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. |
System.Threading.Tasks.Task<ApiResponse<ConsumerDisclosure> > DocuSign.eSign.Api.IAccountsApi.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.
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. |
ApiResponse<ConsumerDisclosure> DocuSign.eSign.Api.IAccountsApi.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.
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. |
ApiResponse<ConsumerDisclosure> DocuSign.eSign.Api.IAccountsApi.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.
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), 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. |
Implemented in DocuSign.eSign.Api.AccountsApi.
ENoteConfiguration DocuSign.eSign.Api.IAccountsApi.GetENoteConfiguration | ( | string | accountId | ) |
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. |
Implemented in DocuSign.eSign.Api.AccountsApi.
System.Threading.Tasks.Task<ENoteConfiguration> DocuSign.eSign.Api.IAccountsApi.GetENoteConfigurationAsync | ( | string | accountId | ) |
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. |
Implemented in DocuSign.eSign.Api.AccountsApi.
System.Threading.Tasks.Task<ApiResponse<ENoteConfiguration> > DocuSign.eSign.Api.IAccountsApi.GetENoteConfigurationAsyncWithHttpInfo | ( | string | accountId | ) |
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. |
Implemented in DocuSign.eSign.Api.AccountsApi.
ApiResponse<ENoteConfiguration> DocuSign.eSign.Api.IAccountsApi.GetENoteConfigurationWithHttpInfo | ( | string | accountId | ) |
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. |
Implemented in DocuSign.eSign.Api.AccountsApi.
EnvelopePurgeConfiguration DocuSign.eSign.Api.IAccountsApi.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.
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
Implemented in DocuSign.eSign.Api.AccountsApi.
System.Threading.Tasks.Task<EnvelopePurgeConfiguration> DocuSign.eSign.Api.IAccountsApi.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.
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
Implemented in DocuSign.eSign.Api.AccountsApi.
System.Threading.Tasks.Task<ApiResponse<EnvelopePurgeConfiguration> > DocuSign.eSign.Api.IAccountsApi.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.
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
Implemented in DocuSign.eSign.Api.AccountsApi.
ApiResponse<EnvelopePurgeConfiguration> DocuSign.eSign.Api.IAccountsApi.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.
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
Implemented in DocuSign.eSign.Api.AccountsApi.
FavoriteTemplatesInfo DocuSign.eSign.Api.IAccountsApi.GetFavoriteTemplates | ( | string | accountId | ) |
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. |
Implemented in DocuSign.eSign.Api.AccountsApi.
System.Threading.Tasks.Task<FavoriteTemplatesInfo> DocuSign.eSign.Api.IAccountsApi.GetFavoriteTemplatesAsync | ( | string | accountId | ) |
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. |
Implemented in DocuSign.eSign.Api.AccountsApi.
System.Threading.Tasks.Task<ApiResponse<FavoriteTemplatesInfo> > DocuSign.eSign.Api.IAccountsApi.GetFavoriteTemplatesAsyncWithHttpInfo | ( | string | accountId | ) |
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. |
Implemented in DocuSign.eSign.Api.AccountsApi.
ApiResponse<FavoriteTemplatesInfo> DocuSign.eSign.Api.IAccountsApi.GetFavoriteTemplatesWithHttpInfo | ( | string | accountId | ) |
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. |
Implemented in DocuSign.eSign.Api.AccountsApi.
NotificationDefaults DocuSign.eSign.Api.IAccountsApi.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.
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
Implemented in DocuSign.eSign.Api.AccountsApi.
System.Threading.Tasks.Task<NotificationDefaults> DocuSign.eSign.Api.IAccountsApi.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.
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
Implemented in DocuSign.eSign.Api.AccountsApi.
System.Threading.Tasks.Task<ApiResponse<NotificationDefaults> > DocuSign.eSign.Api.IAccountsApi.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.
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
Implemented in DocuSign.eSign.Api.AccountsApi.
ApiResponse<NotificationDefaults> DocuSign.eSign.Api.IAccountsApi.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.
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
Implemented in DocuSign.eSign.Api.AccountsApi.
AccountPasswordRules DocuSign.eSign.Api.IAccountsApi.GetPasswordRules | ( | string | accountId | ) |
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. |
Implemented in DocuSign.eSign.Api.AccountsApi.
UserPasswordRules DocuSign.eSign.Api.IAccountsApi.GetPasswordRules_0 | ( | ) |
Get membership account password rules
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
Implemented in DocuSign.eSign.Api.AccountsApi.
System.Threading.Tasks.Task<UserPasswordRules> DocuSign.eSign.Api.IAccountsApi.GetPasswordRules_0Async | ( | ) |
Get membership account password rules
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
Implemented in DocuSign.eSign.Api.AccountsApi.
System.Threading.Tasks.Task<ApiResponse<UserPasswordRules> > DocuSign.eSign.Api.IAccountsApi.GetPasswordRules_0AsyncWithHttpInfo | ( | ) |
Get membership account password rules
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
Implemented in DocuSign.eSign.Api.AccountsApi.
ApiResponse<UserPasswordRules> DocuSign.eSign.Api.IAccountsApi.GetPasswordRules_0WithHttpInfo | ( | ) |
Get membership account password rules
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
Implemented in DocuSign.eSign.Api.AccountsApi.
System.Threading.Tasks.Task<AccountPasswordRules> DocuSign.eSign.Api.IAccountsApi.GetPasswordRulesAsync | ( | string | accountId | ) |
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. |
Implemented in DocuSign.eSign.Api.AccountsApi.
System.Threading.Tasks.Task<ApiResponse<AccountPasswordRules> > DocuSign.eSign.Api.IAccountsApi.GetPasswordRulesAsyncWithHttpInfo | ( | string | accountId | ) |
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. |
Implemented in DocuSign.eSign.Api.AccountsApi.
ApiResponse<AccountPasswordRules> DocuSign.eSign.Api.IAccountsApi.GetPasswordRulesWithHttpInfo | ( | string | accountId | ) |
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. |
Implemented in DocuSign.eSign.Api.AccountsApi.
PermissionProfile DocuSign.eSign.Api.IAccountsApi.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
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. |
System.Threading.Tasks.Task<PermissionProfile> DocuSign.eSign.Api.IAccountsApi.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
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. |
System.Threading.Tasks.Task<ApiResponse<PermissionProfile> > DocuSign.eSign.Api.IAccountsApi.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
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. |
ApiResponse<PermissionProfile> DocuSign.eSign.Api.IAccountsApi.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
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. |
UserAuthorizations DocuSign.eSign.Api.IAccountsApi.GetPrincipalUserAuthorizations | ( | string | accountId, |
string | userId, | ||
AccountsApi.GetPrincipalUserAuthorizationsOptions | options = null |
||
) |
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. |
System.Threading.Tasks.Task<UserAuthorizations> DocuSign.eSign.Api.IAccountsApi.GetPrincipalUserAuthorizationsAsync | ( | string | accountId, |
string | userId, | ||
AccountsApi.GetPrincipalUserAuthorizationsOptions | options = null |
||
) |
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. |
System.Threading.Tasks.Task<ApiResponse<UserAuthorizations> > DocuSign.eSign.Api.IAccountsApi.GetPrincipalUserAuthorizationsAsyncWithHttpInfo | ( | string | accountId, |
string | userId, | ||
AccountsApi.GetPrincipalUserAuthorizationsOptions | options = null |
||
) |
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. |
ApiResponse<UserAuthorizations> DocuSign.eSign.Api.IAccountsApi.GetPrincipalUserAuthorizationsWithHttpInfo | ( | string | accountId, |
string | userId, | ||
AccountsApi.GetPrincipalUserAuthorizationsOptions | options = null |
||
) |
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. |
ProvisioningInformation DocuSign.eSign.Api.IAccountsApi.GetProvisioning | ( | ) |
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 |
Implemented in DocuSign.eSign.Api.AccountsApi.
System.Threading.Tasks.Task<ProvisioningInformation> DocuSign.eSign.Api.IAccountsApi.GetProvisioningAsync | ( | ) |
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 |
Implemented in DocuSign.eSign.Api.AccountsApi.
System.Threading.Tasks.Task<ApiResponse<ProvisioningInformation> > DocuSign.eSign.Api.IAccountsApi.GetProvisioningAsyncWithHttpInfo | ( | ) |
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 |
Implemented in DocuSign.eSign.Api.AccountsApi.
ApiResponse<ProvisioningInformation> DocuSign.eSign.Api.IAccountsApi.GetProvisioningWithHttpInfo | ( | ) |
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 |
Implemented in DocuSign.eSign.Api.AccountsApi.
SupportedLanguages DocuSign.eSign.Api.IAccountsApi.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.
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
Implemented in DocuSign.eSign.Api.AccountsApi.
System.Threading.Tasks.Task<SupportedLanguages> DocuSign.eSign.Api.IAccountsApi.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.
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
Implemented in DocuSign.eSign.Api.AccountsApi.
System.Threading.Tasks.Task<ApiResponse<SupportedLanguages> > DocuSign.eSign.Api.IAccountsApi.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.
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
Implemented in DocuSign.eSign.Api.AccountsApi.
ApiResponse<SupportedLanguages> DocuSign.eSign.Api.IAccountsApi.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.
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
Implemented in DocuSign.eSign.Api.AccountsApi.
UserAuthorization DocuSign.eSign.Api.IAccountsApi.GetUserAuthorization | ( | string | accountId, |
string | userId, | ||
string | authorizationId | ||
) |
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 |
Implemented in DocuSign.eSign.Api.AccountsApi.
System.Threading.Tasks.Task<UserAuthorization> DocuSign.eSign.Api.IAccountsApi.GetUserAuthorizationAsync | ( | string | accountId, |
string | userId, | ||
string | authorizationId | ||
) |
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 |
Implemented in DocuSign.eSign.Api.AccountsApi.
System.Threading.Tasks.Task<ApiResponse<UserAuthorization> > DocuSign.eSign.Api.IAccountsApi.GetUserAuthorizationAsyncWithHttpInfo | ( | string | accountId, |
string | userId, | ||
string | authorizationId | ||
) |
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 |
Implemented in DocuSign.eSign.Api.AccountsApi.
ApiResponse<UserAuthorization> DocuSign.eSign.Api.IAccountsApi.GetUserAuthorizationWithHttpInfo | ( | string | accountId, |
string | userId, | ||
string | authorizationId | ||
) |
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 |
Implemented in DocuSign.eSign.Api.AccountsApi.
Watermark DocuSign.eSign.Api.IAccountsApi.GetWatermark | ( | string | accountId | ) |
Get watermark information.
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
Implemented in DocuSign.eSign.Api.AccountsApi.
System.Threading.Tasks.Task<Watermark> DocuSign.eSign.Api.IAccountsApi.GetWatermarkAsync | ( | string | accountId | ) |
Get watermark information.
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
Implemented in DocuSign.eSign.Api.AccountsApi.
System.Threading.Tasks.Task<ApiResponse<Watermark> > DocuSign.eSign.Api.IAccountsApi.GetWatermarkAsyncWithHttpInfo | ( | string | accountId | ) |
Get watermark information.
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
Implemented in DocuSign.eSign.Api.AccountsApi.
Watermark DocuSign.eSign.Api.IAccountsApi.GetWatermarkPreview | ( | string | accountId, |
Watermark | watermark = null |
||
) |
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) |
Implemented in DocuSign.eSign.Api.AccountsApi.
System.Threading.Tasks.Task<Watermark> DocuSign.eSign.Api.IAccountsApi.GetWatermarkPreviewAsync | ( | string | accountId, |
Watermark | watermark = null |
||
) |
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) |
Implemented in DocuSign.eSign.Api.AccountsApi.
System.Threading.Tasks.Task<ApiResponse<Watermark> > DocuSign.eSign.Api.IAccountsApi.GetWatermarkPreviewAsyncWithHttpInfo | ( | string | accountId, |
Watermark | watermark = null |
||
) |
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) |
Implemented in DocuSign.eSign.Api.AccountsApi.
ApiResponse<Watermark> DocuSign.eSign.Api.IAccountsApi.GetWatermarkPreviewWithHttpInfo | ( | string | accountId, |
Watermark | watermark = null |
||
) |
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) |
Implemented in DocuSign.eSign.Api.AccountsApi.
ApiResponse<Watermark> DocuSign.eSign.Api.IAccountsApi.GetWatermarkWithHttpInfo | ( | string | accountId | ) |
Get watermark information.
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
Implemented in DocuSign.eSign.Api.AccountsApi.
BrandsResponse DocuSign.eSign.Api.IAccountsApi.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.
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. |
System.Threading.Tasks.Task<BrandsResponse> DocuSign.eSign.Api.IAccountsApi.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.
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. |
System.Threading.Tasks.Task<ApiResponse<BrandsResponse> > DocuSign.eSign.Api.IAccountsApi.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.
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. |
ApiResponse<BrandsResponse> DocuSign.eSign.Api.IAccountsApi.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.
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. |
CustomFields DocuSign.eSign.Api.IAccountsApi.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.
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
Implemented in DocuSign.eSign.Api.AccountsApi.
System.Threading.Tasks.Task<CustomFields> DocuSign.eSign.Api.IAccountsApi.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.
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
Implemented in DocuSign.eSign.Api.AccountsApi.
System.Threading.Tasks.Task<ApiResponse<CustomFields> > DocuSign.eSign.Api.IAccountsApi.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.
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
Implemented in DocuSign.eSign.Api.AccountsApi.
ApiResponse<CustomFields> DocuSign.eSign.Api.IAccountsApi.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.
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
Implemented in DocuSign.eSign.Api.AccountsApi.
PermissionProfileInformation DocuSign.eSign.Api.IAccountsApi.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.
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. |
System.Threading.Tasks.Task<PermissionProfileInformation> DocuSign.eSign.Api.IAccountsApi.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.
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. |
System.Threading.Tasks.Task<ApiResponse<PermissionProfileInformation> > DocuSign.eSign.Api.IAccountsApi.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.
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. |
ApiResponse<PermissionProfileInformation> DocuSign.eSign.Api.IAccountsApi.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.
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. |
RecipientNamesResponse DocuSign.eSign.Api.IAccountsApi.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.
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. |
System.Threading.Tasks.Task<RecipientNamesResponse> DocuSign.eSign.Api.IAccountsApi.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.
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. |
System.Threading.Tasks.Task<ApiResponse<RecipientNamesResponse> > DocuSign.eSign.Api.IAccountsApi.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.
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. |
ApiResponse<RecipientNamesResponse> DocuSign.eSign.Api.IAccountsApi.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.
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. |
AccountSettingsInformation DocuSign.eSign.Api.IAccountsApi.ListSettings | ( | string | accountId | ) |
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. |
Implemented in DocuSign.eSign.Api.AccountsApi.
System.Threading.Tasks.Task<AccountSettingsInformation> DocuSign.eSign.Api.IAccountsApi.ListSettingsAsync | ( | string | accountId | ) |
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. |
Implemented in DocuSign.eSign.Api.AccountsApi.
System.Threading.Tasks.Task<ApiResponse<AccountSettingsInformation> > DocuSign.eSign.Api.IAccountsApi.ListSettingsAsyncWithHttpInfo | ( | string | accountId | ) |
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. |
Implemented in DocuSign.eSign.Api.AccountsApi.
ApiResponse<AccountSettingsInformation> DocuSign.eSign.Api.IAccountsApi.ListSettingsWithHttpInfo | ( | string | accountId | ) |
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. |
Implemented in DocuSign.eSign.Api.AccountsApi.
AccountSharedAccess DocuSign.eSign.Api.IAccountsApi.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.
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. |
System.Threading.Tasks.Task<AccountSharedAccess> DocuSign.eSign.Api.IAccountsApi.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.
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. |
System.Threading.Tasks.Task<ApiResponse<AccountSharedAccess> > DocuSign.eSign.Api.IAccountsApi.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.
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. |
ApiResponse<AccountSharedAccess> DocuSign.eSign.Api.IAccountsApi.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.
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. |
AccountSignatureProviders DocuSign.eSign.Api.IAccountsApi.ListSignatureProviders | ( | string | accountId | ) |
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. |
Implemented in DocuSign.eSign.Api.AccountsApi.
System.Threading.Tasks.Task<AccountSignatureProviders> DocuSign.eSign.Api.IAccountsApi.ListSignatureProvidersAsync | ( | string | accountId | ) |
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. |
Implemented in DocuSign.eSign.Api.AccountsApi.
System.Threading.Tasks.Task<ApiResponse<AccountSignatureProviders> > DocuSign.eSign.Api.IAccountsApi.ListSignatureProvidersAsyncWithHttpInfo | ( | string | accountId | ) |
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. |
Implemented in DocuSign.eSign.Api.AccountsApi.
ApiResponse<AccountSignatureProviders> DocuSign.eSign.Api.IAccountsApi.ListSignatureProvidersWithHttpInfo | ( | string | accountId | ) |
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. |
Implemented in DocuSign.eSign.Api.AccountsApi.
FileTypeList DocuSign.eSign.Api.IAccountsApi.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.
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
Implemented in DocuSign.eSign.Api.AccountsApi.
System.Threading.Tasks.Task<FileTypeList> DocuSign.eSign.Api.IAccountsApi.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.
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
Implemented in DocuSign.eSign.Api.AccountsApi.
System.Threading.Tasks.Task<ApiResponse<FileTypeList> > DocuSign.eSign.Api.IAccountsApi.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.
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
Implemented in DocuSign.eSign.Api.AccountsApi.
ApiResponse<FileTypeList> DocuSign.eSign.Api.IAccountsApi.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.
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
Implemented in DocuSign.eSign.Api.AccountsApi.
FavoriteTemplatesInfo DocuSign.eSign.Api.IAccountsApi.UnFavoriteTemplate | ( | string | accountId, |
FavoriteTemplatesInfo | favoriteTemplatesInfo = null |
||
) |
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) |
Implemented in DocuSign.eSign.Api.AccountsApi.
System.Threading.Tasks.Task<FavoriteTemplatesInfo> DocuSign.eSign.Api.IAccountsApi.UnFavoriteTemplateAsync | ( | string | accountId, |
FavoriteTemplatesInfo | favoriteTemplatesInfo = null |
||
) |
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) |
Implemented in DocuSign.eSign.Api.AccountsApi.
System.Threading.Tasks.Task<ApiResponse<FavoriteTemplatesInfo> > DocuSign.eSign.Api.IAccountsApi.UnFavoriteTemplateAsyncWithHttpInfo | ( | string | accountId, |
FavoriteTemplatesInfo | favoriteTemplatesInfo = null |
||
) |
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) |
Implemented in DocuSign.eSign.Api.AccountsApi.
ApiResponse<FavoriteTemplatesInfo> DocuSign.eSign.Api.IAccountsApi.UnFavoriteTemplateWithHttpInfo | ( | string | accountId, |
FavoriteTemplatesInfo | favoriteTemplatesInfo = null |
||
) |
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) |
Implemented in DocuSign.eSign.Api.AccountsApi.
AccountSignaturesInformation DocuSign.eSign.Api.IAccountsApi.UpdateAccountSignature | ( | string | accountId, |
AccountSignaturesInformation | accountSignaturesInformation = null |
||
) |
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) |
Implemented in DocuSign.eSign.Api.AccountsApi.
System.Threading.Tasks.Task<AccountSignaturesInformation> DocuSign.eSign.Api.IAccountsApi.UpdateAccountSignatureAsync | ( | string | accountId, |
AccountSignaturesInformation | accountSignaturesInformation = null |
||
) |
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) |
Implemented in DocuSign.eSign.Api.AccountsApi.
System.Threading.Tasks.Task<ApiResponse<AccountSignaturesInformation> > DocuSign.eSign.Api.IAccountsApi.UpdateAccountSignatureAsyncWithHttpInfo | ( | string | accountId, |
AccountSignaturesInformation | accountSignaturesInformation = null |
||
) |
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) |
Implemented in DocuSign.eSign.Api.AccountsApi.
AccountSignature DocuSign.eSign.Api.IAccountsApi.UpdateAccountSignatureById | ( | string | accountId, |
string | signatureId, | ||
AccountSignatureDefinition | accountSignatureDefinition = null , |
||
AccountsApi.UpdateAccountSignatureByIdOptions | options = null |
||
) |
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. |
System.Threading.Tasks.Task<AccountSignature> DocuSign.eSign.Api.IAccountsApi.UpdateAccountSignatureByIdAsync | ( | string | accountId, |
string | signatureId, | ||
AccountSignatureDefinition | accountSignatureDefinition = null , |
||
AccountsApi.UpdateAccountSignatureByIdOptions | options = null |
||
) |
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. |
System.Threading.Tasks.Task<ApiResponse<AccountSignature> > DocuSign.eSign.Api.IAccountsApi.UpdateAccountSignatureByIdAsyncWithHttpInfo | ( | string | accountId, |
string | signatureId, | ||
AccountSignatureDefinition | accountSignatureDefinition = null , |
||
AccountsApi.UpdateAccountSignatureByIdOptions | options = null |
||
) |
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. |
ApiResponse<AccountSignature> DocuSign.eSign.Api.IAccountsApi.UpdateAccountSignatureByIdWithHttpInfo | ( | string | accountId, |
string | signatureId, | ||
AccountSignatureDefinition | accountSignatureDefinition = null , |
||
AccountsApi.UpdateAccountSignatureByIdOptions | options = null |
||
) |
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. |
AccountSignature DocuSign.eSign.Api.IAccountsApi.UpdateAccountSignatureImage | ( | string | accountId, |
string | signatureId, | ||
string | imageType, | ||
AccountsApi.UpdateAccountSignatureImageOptions | options = null |
||
) |
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. |
System.Threading.Tasks.Task<AccountSignature> DocuSign.eSign.Api.IAccountsApi.UpdateAccountSignatureImageAsync | ( | string | accountId, |
string | signatureId, | ||
string | imageType, | ||
AccountsApi.UpdateAccountSignatureImageOptions | options = null |
||
) |
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. |
System.Threading.Tasks.Task<ApiResponse<AccountSignature> > DocuSign.eSign.Api.IAccountsApi.UpdateAccountSignatureImageAsyncWithHttpInfo | ( | string | accountId, |
string | signatureId, | ||
string | imageType, | ||
AccountsApi.UpdateAccountSignatureImageOptions | options = null |
||
) |
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. |
ApiResponse<AccountSignature> DocuSign.eSign.Api.IAccountsApi.UpdateAccountSignatureImageWithHttpInfo | ( | string | accountId, |
string | signatureId, | ||
string | imageType, | ||
AccountsApi.UpdateAccountSignatureImageOptions | options = null |
||
) |
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. |
ApiResponse<AccountSignaturesInformation> DocuSign.eSign.Api.IAccountsApi.UpdateAccountSignatureWithHttpInfo | ( | string | accountId, |
AccountSignaturesInformation | accountSignaturesInformation = null |
||
) |
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) |
Implemented in DocuSign.eSign.Api.AccountsApi.
TabAccountSettings DocuSign.eSign.Api.IAccountsApi.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.
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
tabAccountSettings | (optional) |
Implemented in DocuSign.eSign.Api.AccountsApi.
System.Threading.Tasks.Task<TabAccountSettings> DocuSign.eSign.Api.IAccountsApi.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.
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
tabAccountSettings | (optional) |
Implemented in DocuSign.eSign.Api.AccountsApi.
System.Threading.Tasks.Task<ApiResponse<TabAccountSettings> > DocuSign.eSign.Api.IAccountsApi.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.
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
tabAccountSettings | (optional) |
Implemented in DocuSign.eSign.Api.AccountsApi.
ApiResponse<TabAccountSettings> DocuSign.eSign.Api.IAccountsApi.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.
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
tabAccountSettings | (optional) |
Implemented in DocuSign.eSign.Api.AccountsApi.
Brand DocuSign.eSign.Api.IAccountsApi.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).
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. |
System.Threading.Tasks.Task<Brand> DocuSign.eSign.Api.IAccountsApi.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).
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. |
System.Threading.Tasks.Task<ApiResponse<Brand> > DocuSign.eSign.Api.IAccountsApi.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).
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. |
void DocuSign.eSign.Api.IAccountsApi.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).
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 |
Implemented in DocuSign.eSign.Api.AccountsApi.
System.Threading.Tasks.Task DocuSign.eSign.Api.IAccountsApi.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).
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 |
Implemented in DocuSign.eSign.Api.AccountsApi.
System.Threading.Tasks.Task<ApiResponse<Object> > DocuSign.eSign.Api.IAccountsApi.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).
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 |
Implemented in DocuSign.eSign.Api.AccountsApi.
ApiResponse<Object> DocuSign.eSign.Api.IAccountsApi.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).
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 |
Implemented in DocuSign.eSign.Api.AccountsApi.
BrandResources DocuSign.eSign.Api.IAccountsApi.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.
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. |
Implemented in DocuSign.eSign.Api.AccountsApi.
System.Threading.Tasks.Task<BrandResources> DocuSign.eSign.Api.IAccountsApi.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.
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. |
Implemented in DocuSign.eSign.Api.AccountsApi.
System.Threading.Tasks.Task<ApiResponse<BrandResources> > DocuSign.eSign.Api.IAccountsApi.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.
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. |
Implemented in DocuSign.eSign.Api.AccountsApi.
ApiResponse<BrandResources> DocuSign.eSign.Api.IAccountsApi.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.
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. |
Implemented in DocuSign.eSign.Api.AccountsApi.
ApiResponse<Brand> DocuSign.eSign.Api.IAccountsApi.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).
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. |
ConsumerDisclosure DocuSign.eSign.Api.IAccountsApi.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.
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), 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. |
System.Threading.Tasks.Task<ConsumerDisclosure> DocuSign.eSign.Api.IAccountsApi.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.
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), 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. |
System.Threading.Tasks.Task<ApiResponse<ConsumerDisclosure> > DocuSign.eSign.Api.IAccountsApi.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.
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), 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. |
ApiResponse<ConsumerDisclosure> DocuSign.eSign.Api.IAccountsApi.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.
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), 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. |
CustomFields DocuSign.eSign.Api.IAccountsApi.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.
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. |
System.Threading.Tasks.Task<CustomFields> DocuSign.eSign.Api.IAccountsApi.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.
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. |
System.Threading.Tasks.Task<ApiResponse<CustomFields> > DocuSign.eSign.Api.IAccountsApi.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.
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. |
ApiResponse<CustomFields> DocuSign.eSign.Api.IAccountsApi.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.
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. |
ENoteConfiguration DocuSign.eSign.Api.IAccountsApi.UpdateENoteConfiguration | ( | string | accountId, |
ENoteConfiguration | eNoteConfiguration = null |
||
) |
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) |
Implemented in DocuSign.eSign.Api.AccountsApi.
System.Threading.Tasks.Task<ENoteConfiguration> DocuSign.eSign.Api.IAccountsApi.UpdateENoteConfigurationAsync | ( | string | accountId, |
ENoteConfiguration | eNoteConfiguration = null |
||
) |
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) |
Implemented in DocuSign.eSign.Api.AccountsApi.
System.Threading.Tasks.Task<ApiResponse<ENoteConfiguration> > DocuSign.eSign.Api.IAccountsApi.UpdateENoteConfigurationAsyncWithHttpInfo | ( | string | accountId, |
ENoteConfiguration | eNoteConfiguration = null |
||
) |
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) |
Implemented in DocuSign.eSign.Api.AccountsApi.
ApiResponse<ENoteConfiguration> DocuSign.eSign.Api.IAccountsApi.UpdateENoteConfigurationWithHttpInfo | ( | string | accountId, |
ENoteConfiguration | eNoteConfiguration = null |
||
) |
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) |
Implemented in DocuSign.eSign.Api.AccountsApi.
EnvelopePurgeConfiguration DocuSign.eSign.Api.IAccountsApi.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.
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
envelopePurgeConfiguration | (optional) |
Implemented in DocuSign.eSign.Api.AccountsApi.
System.Threading.Tasks.Task<EnvelopePurgeConfiguration> DocuSign.eSign.Api.IAccountsApi.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.
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
envelopePurgeConfiguration | (optional) |
Implemented in DocuSign.eSign.Api.AccountsApi.
System.Threading.Tasks.Task<ApiResponse<EnvelopePurgeConfiguration> > DocuSign.eSign.Api.IAccountsApi.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.
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
envelopePurgeConfiguration | (optional) |
Implemented in DocuSign.eSign.Api.AccountsApi.
ApiResponse<EnvelopePurgeConfiguration> DocuSign.eSign.Api.IAccountsApi.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.
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
envelopePurgeConfiguration | (optional) |
Implemented in DocuSign.eSign.Api.AccountsApi.
FavoriteTemplatesInfo DocuSign.eSign.Api.IAccountsApi.UpdateFavoriteTemplate | ( | string | accountId, |
FavoriteTemplatesInfo | favoriteTemplatesInfo = null |
||
) |
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) |
Implemented in DocuSign.eSign.Api.AccountsApi.
System.Threading.Tasks.Task<FavoriteTemplatesInfo> DocuSign.eSign.Api.IAccountsApi.UpdateFavoriteTemplateAsync | ( | string | accountId, |
FavoriteTemplatesInfo | favoriteTemplatesInfo = null |
||
) |
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) |
Implemented in DocuSign.eSign.Api.AccountsApi.
System.Threading.Tasks.Task<ApiResponse<FavoriteTemplatesInfo> > DocuSign.eSign.Api.IAccountsApi.UpdateFavoriteTemplateAsyncWithHttpInfo | ( | string | accountId, |
FavoriteTemplatesInfo | favoriteTemplatesInfo = null |
||
) |
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) |
Implemented in DocuSign.eSign.Api.AccountsApi.
ApiResponse<FavoriteTemplatesInfo> DocuSign.eSign.Api.IAccountsApi.UpdateFavoriteTemplateWithHttpInfo | ( | string | accountId, |
FavoriteTemplatesInfo | favoriteTemplatesInfo = null |
||
) |
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) |
Implemented in DocuSign.eSign.Api.AccountsApi.
NotificationDefaults DocuSign.eSign.Api.IAccountsApi.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.
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
notificationDefaults | (optional) |
Implemented in DocuSign.eSign.Api.AccountsApi.
System.Threading.Tasks.Task<NotificationDefaults> DocuSign.eSign.Api.IAccountsApi.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.
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
notificationDefaults | (optional) |
Implemented in DocuSign.eSign.Api.AccountsApi.
System.Threading.Tasks.Task<ApiResponse<NotificationDefaults> > DocuSign.eSign.Api.IAccountsApi.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.
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
notificationDefaults | (optional) |
Implemented in DocuSign.eSign.Api.AccountsApi.
ApiResponse<NotificationDefaults> DocuSign.eSign.Api.IAccountsApi.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.
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
notificationDefaults | (optional) |
Implemented in DocuSign.eSign.Api.AccountsApi.
AccountPasswordRules DocuSign.eSign.Api.IAccountsApi.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.
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
accountPasswordRules | (optional) |
Implemented in DocuSign.eSign.Api.AccountsApi.
System.Threading.Tasks.Task<AccountPasswordRules> DocuSign.eSign.Api.IAccountsApi.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.
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
accountPasswordRules | (optional) |
Implemented in DocuSign.eSign.Api.AccountsApi.
System.Threading.Tasks.Task<ApiResponse<AccountPasswordRules> > DocuSign.eSign.Api.IAccountsApi.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.
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
accountPasswordRules | (optional) |
Implemented in DocuSign.eSign.Api.AccountsApi.
ApiResponse<AccountPasswordRules> DocuSign.eSign.Api.IAccountsApi.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.
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
accountPasswordRules | (optional) |
Implemented in DocuSign.eSign.Api.AccountsApi.
PermissionProfile DocuSign.eSign.Api.IAccountsApi.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
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. |
System.Threading.Tasks.Task<PermissionProfile> DocuSign.eSign.Api.IAccountsApi.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
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. |
System.Threading.Tasks.Task<ApiResponse<PermissionProfile> > DocuSign.eSign.Api.IAccountsApi.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
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. |
ApiResponse<PermissionProfile> DocuSign.eSign.Api.IAccountsApi.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
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. |
void DocuSign.eSign.Api.IAccountsApi.UpdateSettings | ( | string | accountId, |
AccountSettingsInformation | accountSettingsInformation = null |
||
) |
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) |
Implemented in DocuSign.eSign.Api.AccountsApi.
System.Threading.Tasks.Task DocuSign.eSign.Api.IAccountsApi.UpdateSettingsAsync | ( | string | accountId, |
AccountSettingsInformation | accountSettingsInformation = null |
||
) |
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) |
Implemented in DocuSign.eSign.Api.AccountsApi.
System.Threading.Tasks.Task<ApiResponse<Object> > DocuSign.eSign.Api.IAccountsApi.UpdateSettingsAsyncWithHttpInfo | ( | string | accountId, |
AccountSettingsInformation | accountSettingsInformation = null |
||
) |
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) |
Implemented in DocuSign.eSign.Api.AccountsApi.
ApiResponse<Object> DocuSign.eSign.Api.IAccountsApi.UpdateSettingsWithHttpInfo | ( | string | accountId, |
AccountSettingsInformation | accountSettingsInformation = null |
||
) |
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) |
Implemented in DocuSign.eSign.Api.AccountsApi.
AccountSharedAccess DocuSign.eSign.Api.IAccountsApi.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.
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. |
System.Threading.Tasks.Task<AccountSharedAccess> DocuSign.eSign.Api.IAccountsApi.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.
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. |
System.Threading.Tasks.Task<ApiResponse<AccountSharedAccess> > DocuSign.eSign.Api.IAccountsApi.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.
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. |
ApiResponse<AccountSharedAccess> DocuSign.eSign.Api.IAccountsApi.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.
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. |
UserAuthorization DocuSign.eSign.Api.IAccountsApi.UpdateUserAuthorization | ( | string | accountId, |
string | userId, | ||
string | authorizationId, | ||
UserAuthorizationUpdateRequest | userAuthorizationUpdateRequest = null |
||
) |
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) |
Implemented in DocuSign.eSign.Api.AccountsApi.
System.Threading.Tasks.Task<UserAuthorization> DocuSign.eSign.Api.IAccountsApi.UpdateUserAuthorizationAsync | ( | string | accountId, |
string | userId, | ||
string | authorizationId, | ||
UserAuthorizationUpdateRequest | userAuthorizationUpdateRequest = null |
||
) |
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) |
Implemented in DocuSign.eSign.Api.AccountsApi.
System.Threading.Tasks.Task<ApiResponse<UserAuthorization> > DocuSign.eSign.Api.IAccountsApi.UpdateUserAuthorizationAsyncWithHttpInfo | ( | string | accountId, |
string | userId, | ||
string | authorizationId, | ||
UserAuthorizationUpdateRequest | userAuthorizationUpdateRequest = null |
||
) |
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) |
Implemented in DocuSign.eSign.Api.AccountsApi.
ApiResponse<UserAuthorization> DocuSign.eSign.Api.IAccountsApi.UpdateUserAuthorizationWithHttpInfo | ( | string | accountId, |
string | userId, | ||
string | authorizationId, | ||
UserAuthorizationUpdateRequest | userAuthorizationUpdateRequest = null |
||
) |
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) |
Implemented in DocuSign.eSign.Api.AccountsApi.
Watermark DocuSign.eSign.Api.IAccountsApi.UpdateWatermark | ( | string | accountId, |
Watermark | watermark = null |
||
) |
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) |
Implemented in DocuSign.eSign.Api.AccountsApi.
System.Threading.Tasks.Task<Watermark> DocuSign.eSign.Api.IAccountsApi.UpdateWatermarkAsync | ( | string | accountId, |
Watermark | watermark = null |
||
) |
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) |
Implemented in DocuSign.eSign.Api.AccountsApi.
System.Threading.Tasks.Task<ApiResponse<Watermark> > DocuSign.eSign.Api.IAccountsApi.UpdateWatermarkAsyncWithHttpInfo | ( | string | accountId, |
Watermark | watermark = null |
||
) |
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) |
Implemented in DocuSign.eSign.Api.AccountsApi.
ApiResponse<Watermark> DocuSign.eSign.Api.IAccountsApi.UpdateWatermarkWithHttpInfo | ( | string | accountId, |
Watermark | watermark = null |
||
) |
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) |
Implemented in DocuSign.eSign.Api.AccountsApi.