AccountsApi
in package
AccountsApi Class Doc Comment
Tags
Table of Contents
- $apiClient : ApiClient
- API Client
- __construct() : void
- Constructor
- create() : NewAccountSummary
- Operation create
- createAccountSignatures() : AccountSignaturesInformation
- Operation createAccountSignatures
- createAccountSignaturesWithHttpInfo() : array<string|int, mixed>
- Operation createAccountSignaturesWithHttpInfo
- createBrand() : BrandsResponse
- Operation createBrand
- createBrandWithHttpInfo() : array<string|int, mixed>
- Operation createBrandWithHttpInfo
- createCustomField() : CustomFields
- Operation createCustomField
- createCustomFieldWithHttpInfo() : array<string|int, mixed>
- Operation createCustomFieldWithHttpInfo
- createPermissionProfile() : PermissionProfile
- Operation createPermissionProfile
- createPermissionProfileWithHttpInfo() : array<string|int, mixed>
- Operation createPermissionProfileWithHttpInfo
- createUserAuthorization() : UserAuthorization
- Operation createUserAuthorization
- createUserAuthorizations() : UserAuthorizationsResponse
- Operation createUserAuthorizations
- createUserAuthorizationsWithHttpInfo() : array<string|int, mixed>
- Operation createUserAuthorizationsWithHttpInfo
- createUserAuthorizationWithHttpInfo() : array<string|int, mixed>
- Operation createUserAuthorizationWithHttpInfo
- createWithHttpInfo() : array<string|int, mixed>
- Operation createWithHttpInfo
- delete() : mixed
- Operation delete
- deleteAccountSignature() : mixed
- Operation deleteAccountSignature
- deleteAccountSignatureImage() : AccountSignature
- Operation deleteAccountSignatureImage
- deleteAccountSignatureImageWithHttpInfo() : array<string|int, mixed>
- Operation deleteAccountSignatureImageWithHttpInfo
- deleteAccountSignatureWithHttpInfo() : array<string|int, mixed>
- Operation deleteAccountSignatureWithHttpInfo
- deleteBrand() : mixed
- Operation deleteBrand
- deleteBrandLogoByType() : mixed
- Operation deleteBrandLogoByType
- deleteBrandLogoByTypeWithHttpInfo() : array<string|int, mixed>
- Operation deleteBrandLogoByTypeWithHttpInfo
- deleteBrands() : BrandsResponse
- Operation deleteBrands
- deleteBrandsWithHttpInfo() : array<string|int, mixed>
- Operation deleteBrandsWithHttpInfo
- deleteBrandWithHttpInfo() : array<string|int, mixed>
- Operation deleteBrandWithHttpInfo
- deleteCaptiveRecipient() : CaptiveRecipientInformation
- Operation deleteCaptiveRecipient
- deleteCaptiveRecipientWithHttpInfo() : array<string|int, mixed>
- Operation deleteCaptiveRecipientWithHttpInfo
- deleteCustomField() : mixed
- Operation deleteCustomField
- deleteCustomFieldWithHttpInfo() : array<string|int, mixed>
- Operation deleteCustomFieldWithHttpInfo
- deleteENoteConfiguration() : mixed
- Operation deleteENoteConfiguration
- deleteENoteConfigurationWithHttpInfo() : array<string|int, mixed>
- Operation deleteENoteConfigurationWithHttpInfo
- deletePermissionProfile() : mixed
- Operation deletePermissionProfile
- deletePermissionProfileWithHttpInfo() : array<string|int, mixed>
- Operation deletePermissionProfileWithHttpInfo
- deleteUserAuthorization() : mixed
- Operation deleteUserAuthorization
- deleteUserAuthorizations() : UserAuthorizationsDeleteResponse
- Operation deleteUserAuthorizations
- deleteUserAuthorizationsWithHttpInfo() : array<string|int, mixed>
- Operation deleteUserAuthorizationsWithHttpInfo
- deleteUserAuthorizationWithHttpInfo() : array<string|int, mixed>
- Operation deleteUserAuthorizationWithHttpInfo
- deleteWithHttpInfo() : array<string|int, mixed>
- Operation deleteWithHttpInfo
- getAccountIdentityVerification() : AccountIdentityVerificationResponse
- Operation getAccountIdentityVerification
- getAccountIdentityVerificationWithHttpInfo() : array<string|int, mixed>
- Operation getAccountIdentityVerificationWithHttpInfo
- getAccountInformation() : AccountInformation
- Operation getAccountInformation
- getAccountInformationWithHttpInfo() : array<string|int, mixed>
- Operation getAccountInformationWithHttpInfo
- getAccountSignature() : AccountSignature
- Operation getAccountSignature
- getAccountSignatureImage() : SplFileObject
- Operation getAccountSignatureImage
- getAccountSignatureImageWithHttpInfo() : array<string|int, mixed>
- Operation getAccountSignatureImageWithHttpInfo
- getAccountSignatures() : AccountSignaturesInformation
- Operation getAccountSignatures
- getAccountSignaturesWithHttpInfo() : array<string|int, mixed>
- Operation getAccountSignaturesWithHttpInfo
- getAccountSignatureWithHttpInfo() : array<string|int, mixed>
- Operation getAccountSignatureWithHttpInfo
- getAccountTabSettings() : TabAccountSettings
- Operation getAccountTabSettings
- getAccountTabSettingsWithHttpInfo() : array<string|int, mixed>
- Operation getAccountTabSettingsWithHttpInfo
- getAgentUserAuthorizations() : UserAuthorizations
- Operation getAgentUserAuthorizations
- getAgentUserAuthorizationsWithHttpInfo() : array<string|int, mixed>
- Operation getAgentUserAuthorizationsWithHttpInfo
- getAllPaymentGatewayAccounts() : PaymentGatewayAccountsInfo
- Operation getAllPaymentGatewayAccounts
- getAllPaymentGatewayAccountsWithHttpInfo() : array<string|int, mixed>
- Operation getAllPaymentGatewayAccountsWithHttpInfo
- getApiClient() : ApiClient
- Get API client
- getBillingCharges() : BillingChargeResponse
- Operation getBillingCharges
- getBillingChargesWithHttpInfo() : array<string|int, mixed>
- Operation getBillingChargesWithHttpInfo
- getBrand() : Brand
- Operation getBrand
- getBrandExportFile() : mixed
- Operation getBrandExportFile
- getBrandExportFileWithHttpInfo() : array<string|int, mixed>
- Operation getBrandExportFileWithHttpInfo
- getBrandLogoByType() : SplFileObject
- Operation getBrandLogoByType
- getBrandLogoByTypeWithHttpInfo() : array<string|int, mixed>
- Operation getBrandLogoByTypeWithHttpInfo
- getBrandResources() : BrandResourcesList
- Operation getBrandResources
- getBrandResourcesByContentType() : mixed
- Operation getBrandResourcesByContentType
- getBrandResourcesByContentTypeWithHttpInfo() : array<string|int, mixed>
- Operation getBrandResourcesByContentTypeWithHttpInfo
- getBrandResourcesWithHttpInfo() : array<string|int, mixed>
- Operation getBrandResourcesWithHttpInfo
- getBrandWithHttpInfo() : array<string|int, mixed>
- Operation getBrandWithHttpInfo
- getConsumerDisclosure() : ConsumerDisclosure
- Operation getConsumerDisclosure
- getConsumerDisclosureDefault() : ConsumerDisclosure
- Operation getConsumerDisclosureDefault
- getConsumerDisclosureDefaultWithHttpInfo() : array<string|int, mixed>
- Operation getConsumerDisclosureDefaultWithHttpInfo
- getConsumerDisclosureWithHttpInfo() : array<string|int, mixed>
- Operation getConsumerDisclosureWithHttpInfo
- getENoteConfiguration() : ENoteConfiguration
- Operation getENoteConfiguration
- getENoteConfigurationWithHttpInfo() : array<string|int, mixed>
- Operation getENoteConfigurationWithHttpInfo
- getEnvelopePurgeConfiguration() : EnvelopePurgeConfiguration
- Operation getEnvelopePurgeConfiguration
- getEnvelopePurgeConfigurationWithHttpInfo() : array<string|int, mixed>
- Operation getEnvelopePurgeConfigurationWithHttpInfo
- getFavoriteTemplates() : FavoriteTemplatesInfo
- Operation getFavoriteTemplates
- getFavoriteTemplatesWithHttpInfo() : array<string|int, mixed>
- Operation getFavoriteTemplatesWithHttpInfo
- getNotificationDefaults() : NotificationDefaults
- Operation getNotificationDefaults
- getNotificationDefaultsWithHttpInfo() : array<string|int, mixed>
- Operation getNotificationDefaultsWithHttpInfo
- getPasswordRules() : AccountPasswordRules
- Operation getPasswordRules
- getPasswordRules_0() : UserPasswordRules
- Operation getPasswordRules_0
- getPasswordRules_0WithHttpInfo() : array<string|int, mixed>
- Operation getPasswordRules_0WithHttpInfo
- getPasswordRulesWithHttpInfo() : array<string|int, mixed>
- Operation getPasswordRulesWithHttpInfo
- getPermissionProfile() : PermissionProfile
- Operation getPermissionProfile
- getPermissionProfileWithHttpInfo() : array<string|int, mixed>
- Operation getPermissionProfileWithHttpInfo
- getPrincipalUserAuthorizations() : UserAuthorizations
- Operation getPrincipalUserAuthorizations
- getPrincipalUserAuthorizationsWithHttpInfo() : array<string|int, mixed>
- Operation getPrincipalUserAuthorizationsWithHttpInfo
- getProvisioning() : ProvisioningInformation
- Operation getProvisioning
- getProvisioningWithHttpInfo() : array<string|int, mixed>
- Operation getProvisioningWithHttpInfo
- getSupportedLanguages() : SupportedLanguages
- Operation getSupportedLanguages
- getSupportedLanguagesWithHttpInfo() : array<string|int, mixed>
- Operation getSupportedLanguagesWithHttpInfo
- getUserAuthorization() : UserAuthorization
- Operation getUserAuthorization
- getUserAuthorizationWithHttpInfo() : array<string|int, mixed>
- Operation getUserAuthorizationWithHttpInfo
- getWatermark() : Watermark
- Operation getWatermark
- getWatermarkPreview() : Watermark
- Operation getWatermarkPreview
- getWatermarkPreviewWithHttpInfo() : array<string|int, mixed>
- Operation getWatermarkPreviewWithHttpInfo
- getWatermarkWithHttpInfo() : array<string|int, mixed>
- Operation getWatermarkWithHttpInfo
- listBrands() : BrandsResponse
- Operation listBrands
- listBrandsWithHttpInfo() : array<string|int, mixed>
- Operation listBrandsWithHttpInfo
- listCustomFields() : CustomFields
- Operation listCustomFields
- listCustomFieldsWithHttpInfo() : array<string|int, mixed>
- Operation listCustomFieldsWithHttpInfo
- listPermissions() : PermissionProfileInformation
- Operation listPermissions
- listPermissionsWithHttpInfo() : array<string|int, mixed>
- Operation listPermissionsWithHttpInfo
- listRecipientNamesByEmail() : RecipientNamesResponse
- Operation listRecipientNamesByEmail
- listRecipientNamesByEmailWithHttpInfo() : array<string|int, mixed>
- Operation listRecipientNamesByEmailWithHttpInfo
- listSettings() : AccountSettingsInformation
- Operation listSettings
- listSettingsWithHttpInfo() : array<string|int, mixed>
- Operation listSettingsWithHttpInfo
- listSharedAccess() : AccountSharedAccess
- Operation listSharedAccess
- listSharedAccessWithHttpInfo() : array<string|int, mixed>
- Operation listSharedAccessWithHttpInfo
- listSignatureProviders() : AccountSignatureProviders
- Operation listSignatureProviders
- listSignatureProvidersWithHttpInfo() : array<string|int, mixed>
- Operation listSignatureProvidersWithHttpInfo
- listUnsupportedFileTypes() : FileTypeList
- Operation listUnsupportedFileTypes
- listUnsupportedFileTypesWithHttpInfo() : array<string|int, mixed>
- Operation listUnsupportedFileTypesWithHttpInfo
- setApiClient() : self
- Set the API client
- unFavoriteTemplate() : FavoriteTemplatesInfo
- Operation unFavoriteTemplate
- unFavoriteTemplateWithHttpInfo() : array<string|int, mixed>
- Operation unFavoriteTemplateWithHttpInfo
- updateAccountSignature() : AccountSignaturesInformation
- Operation updateAccountSignature
- updateAccountSignatureById() : AccountSignature
- Operation updateAccountSignatureById
- updateAccountSignatureByIdWithHttpInfo() : array<string|int, mixed>
- Operation updateAccountSignatureByIdWithHttpInfo
- updateAccountSignatureImage() : AccountSignature
- Operation updateAccountSignatureImage
- updateAccountSignatureImageWithHttpInfo() : array<string|int, mixed>
- Operation updateAccountSignatureImageWithHttpInfo
- updateAccountSignatureWithHttpInfo() : array<string|int, mixed>
- Operation updateAccountSignatureWithHttpInfo
- updateAccountTabSettings() : TabAccountSettings
- Operation updateAccountTabSettings
- updateAccountTabSettingsWithHttpInfo() : array<string|int, mixed>
- Operation updateAccountTabSettingsWithHttpInfo
- updateBrand() : Brand
- Operation updateBrand
- updateBrandLogoByType() : mixed
- Operation updateBrandLogoByType
- updateBrandLogoByTypeWithHttpInfo() : array<string|int, mixed>
- Operation updateBrandLogoByTypeWithHttpInfo
- updateBrandResourcesByContentType() : BrandResources
- Operation updateBrandResourcesByContentType
- updateBrandResourcesByContentTypeWithHttpInfo() : array<string|int, mixed>
- Operation updateBrandResourcesByContentTypeWithHttpInfo
- updateBrandWithHttpInfo() : array<string|int, mixed>
- Operation updateBrandWithHttpInfo
- updateConsumerDisclosure() : ConsumerDisclosure
- Operation updateConsumerDisclosure
- updateConsumerDisclosureWithHttpInfo() : array<string|int, mixed>
- Operation updateConsumerDisclosureWithHttpInfo
- updateCustomField() : CustomFields
- Operation updateCustomField
- updateCustomFieldWithHttpInfo() : array<string|int, mixed>
- Operation updateCustomFieldWithHttpInfo
- updateENoteConfiguration() : ENoteConfiguration
- Operation updateENoteConfiguration
- updateENoteConfigurationWithHttpInfo() : array<string|int, mixed>
- Operation updateENoteConfigurationWithHttpInfo
- updateEnvelopePurgeConfiguration() : EnvelopePurgeConfiguration
- Operation updateEnvelopePurgeConfiguration
- updateEnvelopePurgeConfigurationWithHttpInfo() : array<string|int, mixed>
- Operation updateEnvelopePurgeConfigurationWithHttpInfo
- updateFavoriteTemplate() : FavoriteTemplatesInfo
- Operation updateFavoriteTemplate
- updateFavoriteTemplateWithHttpInfo() : array<string|int, mixed>
- Operation updateFavoriteTemplateWithHttpInfo
- updateNotificationDefaults() : NotificationDefaults
- Operation updateNotificationDefaults
- updateNotificationDefaultsWithHttpInfo() : array<string|int, mixed>
- Operation updateNotificationDefaultsWithHttpInfo
- updatePasswordRules() : AccountPasswordRules
- Operation updatePasswordRules
- updatePasswordRulesWithHttpInfo() : array<string|int, mixed>
- Operation updatePasswordRulesWithHttpInfo
- updatePermissionProfile() : PermissionProfile
- Operation updatePermissionProfile
- updatePermissionProfileWithHttpInfo() : array<string|int, mixed>
- Operation updatePermissionProfileWithHttpInfo
- updateResourcePath() : string
- Update $resourcePath with $
- updateSettings() : mixed
- Operation updateSettings
- updateSettingsWithHttpInfo() : array<string|int, mixed>
- Operation updateSettingsWithHttpInfo
- updateSharedAccess() : AccountSharedAccess
- Operation updateSharedAccess
- updateSharedAccessWithHttpInfo() : array<string|int, mixed>
- Operation updateSharedAccessWithHttpInfo
- updateUserAuthorization() : UserAuthorization
- Operation updateUserAuthorization
- updateUserAuthorizationWithHttpInfo() : array<string|int, mixed>
- Operation updateUserAuthorizationWithHttpInfo
- updateWatermark() : Watermark
- Operation updateWatermark
- updateWatermarkWithHttpInfo() : array<string|int, mixed>
- Operation updateWatermarkWithHttpInfo
Properties
$apiClient
API Client
protected
ApiClient
$apiClient
instance of the ApiClient
Methods
__construct()
Constructor
public
__construct([ApiClient|null $apiClient = null ]) : void
Parameters
- $apiClient : ApiClient|null = null
-
The api client to use
Return values
void —create()
Operation create
public
create([NewAccountDefinition $new_account_definition = null ][, CreateOptions $options = null ]) : NewAccountSummary
Creates new accounts.
Parameters
- $new_account_definition : NewAccountDefinition = null
-
(optional)
- $options : CreateOptions = null
-
for modifying the behavior of the function. (optional)
Tags
Return values
NewAccountSummary —createAccountSignatures()
Operation createAccountSignatures
public
createAccountSignatures(string|null $account_id[, AccountSignaturesInformation $account_signatures_information = null ][, CreateAccountSignaturesOptions $options = null ]) : AccountSignaturesInformation
Adds/updates one or more account signatures. This request may include images in multi-part format.
Parameters
- $account_id : string|null
-
The external account number (int) or account ID Guid.
- $account_signatures_information : AccountSignaturesInformation = null
-
(optional)
- $options : CreateAccountSignaturesOptions = null
-
for modifying the behavior of the function. (optional)
Tags
Return values
AccountSignaturesInformation —createAccountSignaturesWithHttpInfo()
Operation createAccountSignaturesWithHttpInfo
public
createAccountSignaturesWithHttpInfo(string|null $account_id[, AccountSignaturesInformation $account_signatures_information = null ][, CreateAccountSignaturesOptions $options = null ]) : array<string|int, mixed>
Adds/updates one or more account signatures. This request may include images in multi-part format.
Parameters
- $account_id : string|null
-
The external account number (int) or account ID Guid.
- $account_signatures_information : AccountSignaturesInformation = null
-
(optional)
- $options : CreateAccountSignaturesOptions = null
-
for modifying the behavior of the function. (optional)
Tags
Return values
array<string|int, mixed> —of \DocuSign\eSign\Model\AccountSignaturesInformation, HTTP status code, HTTP response headers (array of strings)
createBrand()
Operation createBrand
public
createBrand(string|null $account_id[, Brand $brand = null ]) : BrandsResponse
Creates one or more brand profile files for the account.
Parameters
- $account_id : string|null
-
The external account number (int) or account ID GUID.
- $brand : Brand = null
-
(optional)
Tags
Return values
BrandsResponse —createBrandWithHttpInfo()
Operation createBrandWithHttpInfo
public
createBrandWithHttpInfo(string|null $account_id[, Brand $brand = null ]) : array<string|int, mixed>
Creates one or more brand profile files for the account.
Parameters
- $account_id : string|null
-
The external account number (int) or account ID GUID.
- $brand : Brand = null
-
(optional)
Tags
Return values
array<string|int, mixed> —of \DocuSign\eSign\Model\BrandsResponse, HTTP status code, HTTP response headers (array of strings)
createCustomField()
Operation createCustomField
public
createCustomField(string|null $account_id[, CustomField $custom_field = null ][, CreateCustomFieldOptions $options = null ]) : CustomFields
Creates an acount custom field.
Parameters
- $account_id : string|null
-
The external account number (int) or account ID Guid.
- $custom_field : CustomField = null
-
(optional)
- $options : CreateCustomFieldOptions = null
-
for modifying the behavior of the function. (optional)
Tags
Return values
CustomFields —createCustomFieldWithHttpInfo()
Operation createCustomFieldWithHttpInfo
public
createCustomFieldWithHttpInfo(string|null $account_id[, CustomField $custom_field = null ][, CreateCustomFieldOptions $options = null ]) : array<string|int, mixed>
Creates an acount custom field.
Parameters
- $account_id : string|null
-
The external account number (int) or account ID Guid.
- $custom_field : CustomField = null
-
(optional)
- $options : CreateCustomFieldOptions = null
-
for modifying the behavior of the function. (optional)
Tags
Return values
array<string|int, mixed> —of \DocuSign\eSign\Model\CustomFields, HTTP status code, HTTP response headers (array of strings)
createPermissionProfile()
Operation createPermissionProfile
public
createPermissionProfile(string|null $account_id[, PermissionProfile $permission_profile = null ][, CreatePermissionProfileOptions $options = null ]) : PermissionProfile
Creates a new permission profile in the specified account.
Parameters
- $account_id : string|null
-
The external account number (int) or account ID Guid.
- $permission_profile : PermissionProfile = null
-
(optional)
- $options : CreatePermissionProfileOptions = null
-
for modifying the behavior of the function. (optional)
Tags
Return values
PermissionProfile —createPermissionProfileWithHttpInfo()
Operation createPermissionProfileWithHttpInfo
public
createPermissionProfileWithHttpInfo(string|null $account_id[, PermissionProfile $permission_profile = null ][, CreatePermissionProfileOptions $options = null ]) : array<string|int, mixed>
Creates a new permission profile in the specified account.
Parameters
- $account_id : string|null
-
The external account number (int) or account ID Guid.
- $permission_profile : PermissionProfile = null
-
(optional)
- $options : CreatePermissionProfileOptions = null
-
for modifying the behavior of the function. (optional)
Tags
Return values
array<string|int, mixed> —of \DocuSign\eSign\Model\PermissionProfile, HTTP status code, HTTP response headers (array of strings)
createUserAuthorization()
Operation createUserAuthorization
public
createUserAuthorization(string|null $account_id, string|null $user_id[, UserAuthorizationCreateRequest $user_authorization_create_request = null ]) : UserAuthorization
Creates the user authorization
Parameters
- $account_id : string|null
-
The external account number (int) or account ID Guid.
- $user_id : string|null
-
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.
- $user_authorization_create_request : UserAuthorizationCreateRequest = null
-
(optional)
Tags
Return values
UserAuthorization —createUserAuthorizations()
Operation createUserAuthorizations
public
createUserAuthorizations(string|null $account_id, string|null $user_id[, UserAuthorizationsRequest $user_authorizations_request = null ]) : UserAuthorizationsResponse
Creates ot updates user authorizations
Parameters
- $account_id : string|null
-
The external account number (int) or account ID Guid.
- $user_id : string|null
-
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.
- $user_authorizations_request : UserAuthorizationsRequest = null
-
(optional)
Tags
Return values
UserAuthorizationsResponse —createUserAuthorizationsWithHttpInfo()
Operation createUserAuthorizationsWithHttpInfo
public
createUserAuthorizationsWithHttpInfo(string|null $account_id, string|null $user_id[, UserAuthorizationsRequest $user_authorizations_request = null ]) : array<string|int, mixed>
Creates ot updates user authorizations
Parameters
- $account_id : string|null
-
The external account number (int) or account ID Guid.
- $user_id : string|null
-
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.
- $user_authorizations_request : UserAuthorizationsRequest = null
-
(optional)
Tags
Return values
array<string|int, mixed> —of \DocuSign\eSign\Model\UserAuthorizationsResponse, HTTP status code, HTTP response headers (array of strings)
createUserAuthorizationWithHttpInfo()
Operation createUserAuthorizationWithHttpInfo
public
createUserAuthorizationWithHttpInfo(string|null $account_id, string|null $user_id[, UserAuthorizationCreateRequest $user_authorization_create_request = null ]) : array<string|int, mixed>
Creates the user authorization
Parameters
- $account_id : string|null
-
The external account number (int) or account ID Guid.
- $user_id : string|null
-
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.
- $user_authorization_create_request : UserAuthorizationCreateRequest = null
-
(optional)
Tags
Return values
array<string|int, mixed> —of \DocuSign\eSign\Model\UserAuthorization, HTTP status code, HTTP response headers (array of strings)
createWithHttpInfo()
Operation createWithHttpInfo
public
createWithHttpInfo([NewAccountDefinition $new_account_definition = null ][, CreateOptions $options = null ]) : array<string|int, mixed>
Creates new accounts.
Parameters
- $new_account_definition : NewAccountDefinition = null
-
(optional)
- $options : CreateOptions = null
-
for modifying the behavior of the function. (optional)
Tags
Return values
array<string|int, mixed> —of \DocuSign\eSign\Model\NewAccountSummary, HTTP status code, HTTP response headers (array of strings)
delete()
Operation delete
public
delete(string|null $account_id[, DeleteOptions $options = null ]) : mixed
Deletes the specified account.
Parameters
- $account_id : string|null
-
The external account number (int) or account ID Guid.
- $options : DeleteOptions = null
-
for modifying the behavior of the function. (optional)
Tags
Return values
mixed —deleteAccountSignature()
Operation deleteAccountSignature
public
deleteAccountSignature(string|null $account_id, string|null $signature_id) : mixed
Close the specified signature by Id.
Parameters
- $account_id : string|null
-
The external account number (int) or account ID Guid.
- $signature_id : string|null
-
The ID of the signature being accessed.
Tags
Return values
mixed —deleteAccountSignatureImage()
Operation deleteAccountSignatureImage
public
deleteAccountSignatureImage(string|null $account_id, string|null $image_type, string|null $signature_id) : AccountSignature
Deletes a signature, initials, or stamps image.
Parameters
- $account_id : string|null
-
The external account number (int) or account ID Guid.
- $image_type : string|null
-
One of signature_image or initials_image.
- $signature_id : string|null
-
The ID of the signature being accessed.
Tags
Return values
AccountSignature —deleteAccountSignatureImageWithHttpInfo()
Operation deleteAccountSignatureImageWithHttpInfo
public
deleteAccountSignatureImageWithHttpInfo(string|null $account_id, string|null $image_type, string|null $signature_id) : array<string|int, mixed>
Deletes a signature, initials, or stamps image.
Parameters
- $account_id : string|null
-
The external account number (int) or account ID Guid.
- $image_type : string|null
-
One of signature_image or initials_image.
- $signature_id : string|null
-
The ID of the signature being accessed.
Tags
Return values
array<string|int, mixed> —of \DocuSign\eSign\Model\AccountSignature, HTTP status code, HTTP response headers (array of strings)
deleteAccountSignatureWithHttpInfo()
Operation deleteAccountSignatureWithHttpInfo
public
deleteAccountSignatureWithHttpInfo(string|null $account_id, string|null $signature_id) : array<string|int, mixed>
Close the specified signature by Id.
Parameters
- $account_id : string|null
-
The external account number (int) or account ID Guid.
- $signature_id : string|null
-
The ID of the signature being accessed.
Tags
Return values
array<string|int, mixed> —of null, HTTP status code, HTTP response headers (array of strings)
deleteBrand()
Operation deleteBrand
public
deleteBrand(string|null $account_id, string|null $brand_id) : mixed
Removes a brand.
Parameters
- $account_id : string|null
-
The external account number (int) or account ID Guid.
- $brand_id : string|null
-
The unique identifier of a brand.
Tags
Return values
mixed —deleteBrandLogoByType()
Operation deleteBrandLogoByType
public
deleteBrandLogoByType(string|null $account_id, string|null $brand_id, string|null $logo_type) : mixed
Delete one branding logo.
Parameters
- $account_id : string|null
-
The external account number (int) or account ID Guid.
- $brand_id : string|null
-
The unique identifier of a brand.
- $logo_type : string|null
-
One of Primary, Secondary or Email.
Tags
Return values
mixed —deleteBrandLogoByTypeWithHttpInfo()
Operation deleteBrandLogoByTypeWithHttpInfo
public
deleteBrandLogoByTypeWithHttpInfo(string|null $account_id, string|null $brand_id, string|null $logo_type) : array<string|int, mixed>
Delete one branding logo.
Parameters
- $account_id : string|null
-
The external account number (int) or account ID Guid.
- $brand_id : string|null
-
The unique identifier of a brand.
- $logo_type : string|null
-
One of Primary, Secondary or Email.
Tags
Return values
array<string|int, mixed> —of null, HTTP status code, HTTP response headers (array of strings)
deleteBrands()
Operation deleteBrands
public
deleteBrands(string|null $account_id[, BrandsRequest $brands_request = null ]) : BrandsResponse
Deletes one or more brand profiles.
Parameters
- $account_id : string|null
-
The external account number (int) or account ID Guid.
- $brands_request : BrandsRequest = null
-
(optional)
Tags
Return values
BrandsResponse —deleteBrandsWithHttpInfo()
Operation deleteBrandsWithHttpInfo
public
deleteBrandsWithHttpInfo(string|null $account_id[, BrandsRequest $brands_request = null ]) : array<string|int, mixed>
Deletes one or more brand profiles.
Parameters
- $account_id : string|null
-
The external account number (int) or account ID Guid.
- $brands_request : BrandsRequest = null
-
(optional)
Tags
Return values
array<string|int, mixed> —of \DocuSign\eSign\Model\BrandsResponse, HTTP status code, HTTP response headers (array of strings)
deleteBrandWithHttpInfo()
Operation deleteBrandWithHttpInfo
public
deleteBrandWithHttpInfo(string|null $account_id, string|null $brand_id) : array<string|int, mixed>
Removes a brand.
Parameters
- $account_id : string|null
-
The external account number (int) or account ID Guid.
- $brand_id : string|null
-
The unique identifier of a brand.
Tags
Return values
array<string|int, mixed> —of null, HTTP status code, HTTP response headers (array of strings)
deleteCaptiveRecipient()
Operation deleteCaptiveRecipient
public
deleteCaptiveRecipient(string|null $account_id, string|null $recipient_part[, CaptiveRecipientInformation $captive_recipient_information = null ]) : CaptiveRecipientInformation
Deletes the signature for one or more captive recipient records.
Parameters
- $account_id : string|null
-
The external account number (int) or account ID Guid.
- $recipient_part : string|null
- $captive_recipient_information : CaptiveRecipientInformation = null
-
(optional)
Tags
Return values
CaptiveRecipientInformation —deleteCaptiveRecipientWithHttpInfo()
Operation deleteCaptiveRecipientWithHttpInfo
public
deleteCaptiveRecipientWithHttpInfo(string|null $account_id, string|null $recipient_part[, CaptiveRecipientInformation $captive_recipient_information = null ]) : array<string|int, mixed>
Deletes the signature for one or more captive recipient records.
Parameters
- $account_id : string|null
-
The external account number (int) or account ID Guid.
- $recipient_part : string|null
- $captive_recipient_information : CaptiveRecipientInformation = null
-
(optional)
Tags
Return values
array<string|int, mixed> —of \DocuSign\eSign\Model\CaptiveRecipientInformation, HTTP status code, HTTP response headers (array of strings)
deleteCustomField()
Operation deleteCustomField
public
deleteCustomField(string|null $account_id, string|null $custom_field_id[, DeleteCustomFieldOptions $options = null ]) : mixed
Delete an existing account custom field.
Parameters
- $account_id : string|null
-
The external account number (int) or account ID Guid.
- $custom_field_id : string|null
- $options : DeleteCustomFieldOptions = null
-
for modifying the behavior of the function. (optional)
Tags
Return values
mixed —deleteCustomFieldWithHttpInfo()
Operation deleteCustomFieldWithHttpInfo
public
deleteCustomFieldWithHttpInfo(string|null $account_id, string|null $custom_field_id[, DeleteCustomFieldOptions $options = null ]) : array<string|int, mixed>
Delete an existing account custom field.
Parameters
- $account_id : string|null
-
The external account number (int) or account ID Guid.
- $custom_field_id : string|null
- $options : DeleteCustomFieldOptions = null
-
for modifying the behavior of the function. (optional)
Tags
Return values
array<string|int, mixed> —of null, HTTP status code, HTTP response headers (array of strings)
deleteENoteConfiguration()
Operation deleteENoteConfiguration
public
deleteENoteConfiguration(string|null $account_id) : mixed
Deletes configuration information for the eNote eOriginal integration.
Parameters
- $account_id : string|null
-
The external account number (int) or account ID Guid.
Tags
Return values
mixed —deleteENoteConfigurationWithHttpInfo()
Operation deleteENoteConfigurationWithHttpInfo
public
deleteENoteConfigurationWithHttpInfo(string|null $account_id) : array<string|int, mixed>
Deletes configuration information for the eNote eOriginal integration.
Parameters
- $account_id : string|null
-
The external account number (int) or account ID Guid.
Tags
Return values
array<string|int, mixed> —of null, HTTP status code, HTTP response headers (array of strings)
deletePermissionProfile()
Operation deletePermissionProfile
public
deletePermissionProfile(string|null $account_id, string|null $permission_profile_id[, DeletePermissionProfileOptions $options = null ]) : mixed
Deletes a permissions profile within the specified account.
Parameters
- $account_id : string|null
-
The external account number (int) or account ID Guid.
- $permission_profile_id : string|null
- $options : DeletePermissionProfileOptions = null
-
for modifying the behavior of the function. (optional)
Tags
Return values
mixed —deletePermissionProfileWithHttpInfo()
Operation deletePermissionProfileWithHttpInfo
public
deletePermissionProfileWithHttpInfo(string|null $account_id, string|null $permission_profile_id[, DeletePermissionProfileOptions $options = null ]) : array<string|int, mixed>
Deletes a permissions profile within the specified account.
Parameters
- $account_id : string|null
-
The external account number (int) or account ID Guid.
- $permission_profile_id : string|null
- $options : DeletePermissionProfileOptions = null
-
for modifying the behavior of the function. (optional)
Tags
Return values
array<string|int, mixed> —of null, HTTP status code, HTTP response headers (array of strings)
deleteUserAuthorization()
Operation deleteUserAuthorization
public
deleteUserAuthorization(string|null $account_id, string|null $authorization_id, string|null $user_id) : mixed
Deletes the user authorization
Parameters
- $account_id : string|null
-
The external account number (int) or account ID Guid.
- $authorization_id : string|null
- $user_id : string|null
-
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.
Tags
Return values
mixed —deleteUserAuthorizations()
Operation deleteUserAuthorizations
public
deleteUserAuthorizations(string|null $account_id, string|null $user_id[, UserAuthorizationsDeleteRequest $user_authorizations_delete_request = null ]) : UserAuthorizationsDeleteResponse
Creates ot updates user authorizations
Parameters
- $account_id : string|null
-
The external account number (int) or account ID Guid.
- $user_id : string|null
-
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.
- $user_authorizations_delete_request : UserAuthorizationsDeleteRequest = null
-
(optional)
Tags
Return values
UserAuthorizationsDeleteResponse —deleteUserAuthorizationsWithHttpInfo()
Operation deleteUserAuthorizationsWithHttpInfo
public
deleteUserAuthorizationsWithHttpInfo(string|null $account_id, string|null $user_id[, UserAuthorizationsDeleteRequest $user_authorizations_delete_request = null ]) : array<string|int, mixed>
Creates ot updates user authorizations
Parameters
- $account_id : string|null
-
The external account number (int) or account ID Guid.
- $user_id : string|null
-
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.
- $user_authorizations_delete_request : UserAuthorizationsDeleteRequest = null
-
(optional)
Tags
Return values
array<string|int, mixed> —of \DocuSign\eSign\Model\UserAuthorizationsDeleteResponse, HTTP status code, HTTP response headers (array of strings)
deleteUserAuthorizationWithHttpInfo()
Operation deleteUserAuthorizationWithHttpInfo
public
deleteUserAuthorizationWithHttpInfo(string|null $account_id, string|null $authorization_id, string|null $user_id) : array<string|int, mixed>
Deletes the user authorization
Parameters
- $account_id : string|null
-
The external account number (int) or account ID Guid.
- $authorization_id : string|null
- $user_id : string|null
-
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.
Tags
Return values
array<string|int, mixed> —of null, HTTP status code, HTTP response headers (array of strings)
deleteWithHttpInfo()
Operation deleteWithHttpInfo
public
deleteWithHttpInfo(string|null $account_id[, DeleteOptions $options = null ]) : array<string|int, mixed>
Deletes the specified account.
Parameters
- $account_id : string|null
-
The external account number (int) or account ID Guid.
- $options : DeleteOptions = null
-
for modifying the behavior of the function. (optional)
Tags
Return values
array<string|int, mixed> —of null, HTTP status code, HTTP response headers (array of strings)
getAccountIdentityVerification()
Operation getAccountIdentityVerification
public
getAccountIdentityVerification(string|null $account_id[, GetAccountIdentityVerificationOptions $options = null ]) : AccountIdentityVerificationResponse
Get the list of identity verification options for an account
Parameters
- $account_id : string|null
-
The external account number (int) or account ID Guid.
- $options : GetAccountIdentityVerificationOptions = null
-
for modifying the behavior of the function. (optional)
Tags
Return values
AccountIdentityVerificationResponse —getAccountIdentityVerificationWithHttpInfo()
Operation getAccountIdentityVerificationWithHttpInfo
public
getAccountIdentityVerificationWithHttpInfo(string|null $account_id[, GetAccountIdentityVerificationOptions $options = null ]) : array<string|int, mixed>
Get the list of identity verification options for an account
Parameters
- $account_id : string|null
-
The external account number (int) or account ID Guid.
- $options : GetAccountIdentityVerificationOptions = null
-
for modifying the behavior of the function. (optional)
Tags
Return values
array<string|int, mixed> —of \DocuSign\eSign\Model\AccountIdentityVerificationResponse, HTTP status code, HTTP response headers (array of strings)
getAccountInformation()
Operation getAccountInformation
public
getAccountInformation(string|null $account_id[, GetAccountInformationOptions $options = null ]) : AccountInformation
Retrieves the account information for the specified account.
Parameters
- $account_id : string|null
-
The external account number (int) or account ID Guid.
- $options : GetAccountInformationOptions = null
-
for modifying the behavior of the function. (optional)
Tags
Return values
AccountInformation —getAccountInformationWithHttpInfo()
Operation getAccountInformationWithHttpInfo
public
getAccountInformationWithHttpInfo(string|null $account_id[, GetAccountInformationOptions $options = null ]) : array<string|int, mixed>
Retrieves the account information for the specified account.
Parameters
- $account_id : string|null
-
The external account number (int) or account ID Guid.
- $options : GetAccountInformationOptions = null
-
for modifying the behavior of the function. (optional)
Tags
Return values
array<string|int, mixed> —of \DocuSign\eSign\Model\AccountInformation, HTTP status code, HTTP response headers (array of strings)
getAccountSignature()
Operation getAccountSignature
public
getAccountSignature(string|null $account_id, string|null $signature_id) : AccountSignature
Returns information about a single signature by specifed signatureId.
Parameters
- $account_id : string|null
-
The external account number (int) or account ID Guid.
- $signature_id : string|null
-
The ID of the signature being accessed.
Tags
Return values
AccountSignature —getAccountSignatureImage()
Operation getAccountSignatureImage
public
getAccountSignatureImage(string|null $account_id, string|null $image_type, string|null $signature_id[, GetAccountSignatureImageOptions $options = null ]) : SplFileObject
Returns a signature, initials, or stamps image.
Parameters
- $account_id : string|null
-
The external account number (int) or account ID Guid.
- $image_type : string|null
-
One of signature_image or initials_image.
- $signature_id : string|null
-
The ID of the signature being accessed.
- $options : GetAccountSignatureImageOptions = null
-
for modifying the behavior of the function. (optional)
Tags
Return values
SplFileObject —getAccountSignatureImageWithHttpInfo()
Operation getAccountSignatureImageWithHttpInfo
public
getAccountSignatureImageWithHttpInfo(string|null $account_id, string|null $image_type, string|null $signature_id[, GetAccountSignatureImageOptions $options = null ]) : array<string|int, mixed>
Returns a signature, initials, or stamps image.
Parameters
- $account_id : string|null
-
The external account number (int) or account ID Guid.
- $image_type : string|null
-
One of signature_image or initials_image.
- $signature_id : string|null
-
The ID of the signature being accessed.
- $options : GetAccountSignatureImageOptions = null
-
for modifying the behavior of the function. (optional)
Tags
Return values
array<string|int, mixed> —of \SplFileObject, HTTP status code, HTTP response headers (array of strings)
getAccountSignatures()
Operation getAccountSignatures
public
getAccountSignatures(string|null $account_id[, GetAccountSignaturesOptions $options = null ]) : AccountSignaturesInformation
Returns the managed signature definitions for the account
Parameters
- $account_id : string|null
-
The external account number (int) or account ID Guid.
- $options : GetAccountSignaturesOptions = null
-
for modifying the behavior of the function. (optional)
Tags
Return values
AccountSignaturesInformation —getAccountSignaturesWithHttpInfo()
Operation getAccountSignaturesWithHttpInfo
public
getAccountSignaturesWithHttpInfo(string|null $account_id[, GetAccountSignaturesOptions $options = null ]) : array<string|int, mixed>
Returns the managed signature definitions for the account
Parameters
- $account_id : string|null
-
The external account number (int) or account ID Guid.
- $options : GetAccountSignaturesOptions = null
-
for modifying the behavior of the function. (optional)
Tags
Return values
array<string|int, mixed> —of \DocuSign\eSign\Model\AccountSignaturesInformation, HTTP status code, HTTP response headers (array of strings)
getAccountSignatureWithHttpInfo()
Operation getAccountSignatureWithHttpInfo
public
getAccountSignatureWithHttpInfo(string|null $account_id, string|null $signature_id) : array<string|int, mixed>
Returns information about a single signature by specifed signatureId.
Parameters
- $account_id : string|null
-
The external account number (int) or account ID Guid.
- $signature_id : string|null
-
The ID of the signature being accessed.
Tags
Return values
array<string|int, mixed> —of \DocuSign\eSign\Model\AccountSignature, HTTP status code, HTTP response headers (array of strings)
getAccountTabSettings()
Operation getAccountTabSettings
public
getAccountTabSettings(string|null $account_id) : TabAccountSettings
Returns tab settings list for specified account
Parameters
- $account_id : string|null
-
The external account number (int) or account ID Guid.
Tags
Return values
TabAccountSettings —getAccountTabSettingsWithHttpInfo()
Operation getAccountTabSettingsWithHttpInfo
public
getAccountTabSettingsWithHttpInfo(string|null $account_id) : array<string|int, mixed>
Returns tab settings list for specified account
Parameters
- $account_id : string|null
-
The external account number (int) or account ID Guid.
Tags
Return values
array<string|int, mixed> —of \DocuSign\eSign\Model\TabAccountSettings, HTTP status code, HTTP response headers (array of strings)
getAgentUserAuthorizations()
Operation getAgentUserAuthorizations
public
getAgentUserAuthorizations(string|null $account_id, string|null $user_id[, GetAgentUserAuthorizationsOptions $options = null ]) : UserAuthorizations
Returns the agent user authorizations
Parameters
- $account_id : string|null
-
The external account number (int) or account ID Guid.
- $user_id : string|null
-
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 : GetAgentUserAuthorizationsOptions = null
-
for modifying the behavior of the function. (optional)
Tags
Return values
UserAuthorizations —getAgentUserAuthorizationsWithHttpInfo()
Operation getAgentUserAuthorizationsWithHttpInfo
public
getAgentUserAuthorizationsWithHttpInfo(string|null $account_id, string|null $user_id[, GetAgentUserAuthorizationsOptions $options = null ]) : array<string|int, mixed>
Returns the agent user authorizations
Parameters
- $account_id : string|null
-
The external account number (int) or account ID Guid.
- $user_id : string|null
-
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 : GetAgentUserAuthorizationsOptions = null
-
for modifying the behavior of the function. (optional)
Tags
Return values
array<string|int, mixed> —of \DocuSign\eSign\Model\UserAuthorizations, HTTP status code, HTTP response headers (array of strings)
getAllPaymentGatewayAccounts()
Operation getAllPaymentGatewayAccounts
public
getAllPaymentGatewayAccounts(string|null $account_id) : PaymentGatewayAccountsInfo
Get all payment gateway account for the provided accountId
Parameters
- $account_id : string|null
-
The external account number (int) or account ID Guid.
Tags
Return values
PaymentGatewayAccountsInfo —getAllPaymentGatewayAccountsWithHttpInfo()
Operation getAllPaymentGatewayAccountsWithHttpInfo
public
getAllPaymentGatewayAccountsWithHttpInfo(string|null $account_id) : array<string|int, mixed>
Get all payment gateway account for the provided accountId
Parameters
- $account_id : string|null
-
The external account number (int) or account ID Guid.
Tags
Return values
array<string|int, mixed> —of \DocuSign\eSign\Model\PaymentGatewayAccountsInfo, HTTP status code, HTTP response headers (array of strings)
getApiClient()
Get API client
public
getApiClient() : ApiClient
Return values
ApiClient —get the API client
getBillingCharges()
Operation getBillingCharges
public
getBillingCharges(string|null $account_id[, GetBillingChargesOptions $options = null ]) : BillingChargeResponse
Gets list of recurring and usage charges for the account.
Parameters
- $account_id : string|null
-
The external account number (int) or account ID Guid.
- $options : GetBillingChargesOptions = null
-
for modifying the behavior of the function. (optional)
Tags
Return values
BillingChargeResponse —getBillingChargesWithHttpInfo()
Operation getBillingChargesWithHttpInfo
public
getBillingChargesWithHttpInfo(string|null $account_id[, GetBillingChargesOptions $options = null ]) : array<string|int, mixed>
Gets list of recurring and usage charges for the account.
Parameters
- $account_id : string|null
-
The external account number (int) or account ID Guid.
- $options : GetBillingChargesOptions = null
-
for modifying the behavior of the function. (optional)
Tags
Return values
array<string|int, mixed> —of \DocuSign\eSign\Model\BillingChargeResponse, HTTP status code, HTTP response headers (array of strings)
getBrand()
Operation getBrand
public
getBrand(string|null $account_id, string|null $brand_id[, GetBrandOptions $options = null ]) : Brand
Get information for a specific brand.
Parameters
- $account_id : string|null
-
The external account number (int) or account ID Guid.
- $brand_id : string|null
-
The unique identifier of a brand.
- $options : GetBrandOptions = null
-
for modifying the behavior of the function. (optional)
Tags
Return values
Brand —getBrandExportFile()
Operation getBrandExportFile
public
getBrandExportFile(string|null $account_id, string|null $brand_id) : mixed
Export a specific brand.
Parameters
- $account_id : string|null
-
The external account number (int) or account ID Guid.
- $brand_id : string|null
-
The unique identifier of a brand.
Tags
Return values
mixed —getBrandExportFileWithHttpInfo()
Operation getBrandExportFileWithHttpInfo
public
getBrandExportFileWithHttpInfo(string|null $account_id, string|null $brand_id) : array<string|int, mixed>
Export a specific brand.
Parameters
- $account_id : string|null
-
The external account number (int) or account ID Guid.
- $brand_id : string|null
-
The unique identifier of a brand.
Tags
Return values
array<string|int, mixed> —of null, HTTP status code, HTTP response headers (array of strings)
getBrandLogoByType()
Operation getBrandLogoByType
public
getBrandLogoByType(string|null $account_id, string|null $brand_id, string|null $logo_type) : SplFileObject
Obtains the specified image for a brand.
Parameters
- $account_id : string|null
-
The external account number (int) or account ID Guid.
- $brand_id : string|null
-
The unique identifier of a brand.
- $logo_type : string|null
-
One of Primary, Secondary or Email.
Tags
Return values
SplFileObject —getBrandLogoByTypeWithHttpInfo()
Operation getBrandLogoByTypeWithHttpInfo
public
getBrandLogoByTypeWithHttpInfo(string|null $account_id, string|null $brand_id, string|null $logo_type) : array<string|int, mixed>
Obtains the specified image for a brand.
Parameters
- $account_id : string|null
-
The external account number (int) or account ID Guid.
- $brand_id : string|null
-
The unique identifier of a brand.
- $logo_type : string|null
-
One of Primary, Secondary or Email.
Tags
Return values
array<string|int, mixed> —of \SplFileObject, HTTP status code, HTTP response headers (array of strings)
getBrandResources()
Operation getBrandResources
public
getBrandResources(string|null $account_id, string|null $brand_id) : BrandResourcesList
Returns the specified account's list of branding resources (metadata).
Parameters
- $account_id : string|null
-
The external account number (int) or account ID Guid.
- $brand_id : string|null
-
The unique identifier of a brand.
Tags
Return values
BrandResourcesList —getBrandResourcesByContentType()
Operation getBrandResourcesByContentType
public
getBrandResourcesByContentType(string|null $account_id, string|null $brand_id, string|null $resource_content_type[, GetBrandResourcesByContentTypeOptions $options = null ]) : mixed
Returns the specified branding resource file.
Parameters
- $account_id : string|null
-
The external account number (int) or account ID Guid.
- $brand_id : string|null
-
The unique identifier of a brand.
- $resource_content_type : string|null
- $options : GetBrandResourcesByContentTypeOptions = null
-
for modifying the behavior of the function. (optional)
Tags
Return values
mixed —getBrandResourcesByContentTypeWithHttpInfo()
Operation getBrandResourcesByContentTypeWithHttpInfo
public
getBrandResourcesByContentTypeWithHttpInfo(string|null $account_id, string|null $brand_id, string|null $resource_content_type[, GetBrandResourcesByContentTypeOptions $options = null ]) : array<string|int, mixed>
Returns the specified branding resource file.
Parameters
- $account_id : string|null
-
The external account number (int) or account ID Guid.
- $brand_id : string|null
-
The unique identifier of a brand.
- $resource_content_type : string|null
- $options : GetBrandResourcesByContentTypeOptions = null
-
for modifying the behavior of the function. (optional)
Tags
Return values
array<string|int, mixed> —of null, HTTP status code, HTTP response headers (array of strings)
getBrandResourcesWithHttpInfo()
Operation getBrandResourcesWithHttpInfo
public
getBrandResourcesWithHttpInfo(string|null $account_id, string|null $brand_id) : array<string|int, mixed>
Returns the specified account's list of branding resources (metadata).
Parameters
- $account_id : string|null
-
The external account number (int) or account ID Guid.
- $brand_id : string|null
-
The unique identifier of a brand.
Tags
Return values
array<string|int, mixed> —of \DocuSign\eSign\Model\BrandResourcesList, HTTP status code, HTTP response headers (array of strings)
getBrandWithHttpInfo()
Operation getBrandWithHttpInfo
public
getBrandWithHttpInfo(string|null $account_id, string|null $brand_id[, GetBrandOptions $options = null ]) : array<string|int, mixed>
Get information for a specific brand.
Parameters
- $account_id : string|null
-
The external account number (int) or account ID Guid.
- $brand_id : string|null
-
The unique identifier of a brand.
- $options : GetBrandOptions = null
-
for modifying the behavior of the function. (optional)
Tags
Return values
array<string|int, mixed> —of \DocuSign\eSign\Model\Brand, HTTP status code, HTTP response headers (array of strings)
getConsumerDisclosure()
Operation getConsumerDisclosure
public
getConsumerDisclosure(string|null $account_id, string|null $lang_code) : ConsumerDisclosure
Gets the Electronic Record and Signature Disclosure.
Parameters
- $account_id : string|null
-
The external account number (int) or account ID Guid.
- $lang_code : string|null
-
The simple type enumeration the language used in the response. The supported languages, with the language value shown in parenthesis, are:Arabic (ar), Armenian (hy), Bulgarian (bg), Czech (cs), Chinese Simplified (zh_CN), Chinese Traditional (zh_TW), Croatian (hr), Danish (da), Dutch (nl), English US (en), English UK (en_GB), Estonian (et), Farsi (fa), Finnish (fi), French (fr), French Canada (fr_CA), German (de), Greek (el), Hebrew (he), Hindi (hi), Hungarian (hu), Bahasa Indonesia (id), Italian (it), Japanese (ja), Korean (ko), Latvian (lv), Lithuanian (lt), Bahasa Melayu (ms), Norwegian (no), Polish (pl), Portuguese (pt), Portuguese Brazil (pt_BR), Romanian (ro), Russian (ru), Serbian (sr), Slovak (sk), Slovenian (sl), Spanish (es),Spanish Latin America (es_MX), Swedish (sv), Thai (th), Turkish (tr), Ukrainian (uk) and Vietnamese (vi). Additionally, the value can be set to �browser� to automatically detect the browser language being used by the viewer and display the disclosure in that language.
Tags
Return values
ConsumerDisclosure —getConsumerDisclosureDefault()
Operation getConsumerDisclosureDefault
public
getConsumerDisclosureDefault(string|null $account_id[, GetConsumerDisclosureDefaultOptions $options = null ]) : ConsumerDisclosure
Gets the Electronic Record and Signature Disclosure for the account.
Parameters
- $account_id : string|null
-
The external account number (int) or account ID Guid.
- $options : GetConsumerDisclosureDefaultOptions = null
-
for modifying the behavior of the function. (optional)
Tags
Return values
ConsumerDisclosure —getConsumerDisclosureDefaultWithHttpInfo()
Operation getConsumerDisclosureDefaultWithHttpInfo
public
getConsumerDisclosureDefaultWithHttpInfo(string|null $account_id[, GetConsumerDisclosureDefaultOptions $options = null ]) : array<string|int, mixed>
Gets the Electronic Record and Signature Disclosure for the account.
Parameters
- $account_id : string|null
-
The external account number (int) or account ID Guid.
- $options : GetConsumerDisclosureDefaultOptions = null
-
for modifying the behavior of the function. (optional)
Tags
Return values
array<string|int, mixed> —of \DocuSign\eSign\Model\ConsumerDisclosure, HTTP status code, HTTP response headers (array of strings)
getConsumerDisclosureWithHttpInfo()
Operation getConsumerDisclosureWithHttpInfo
public
getConsumerDisclosureWithHttpInfo(string|null $account_id, string|null $lang_code) : array<string|int, mixed>
Gets the Electronic Record and Signature Disclosure.
Parameters
- $account_id : string|null
-
The external account number (int) or account ID Guid.
- $lang_code : string|null
-
The simple type enumeration the language used in the response. The supported languages, with the language value shown in parenthesis, are:Arabic (ar), Armenian (hy), Bulgarian (bg), Czech (cs), Chinese Simplified (zh_CN), Chinese Traditional (zh_TW), Croatian (hr), Danish (da), Dutch (nl), English US (en), English UK (en_GB), Estonian (et), Farsi (fa), Finnish (fi), French (fr), French Canada (fr_CA), German (de), Greek (el), Hebrew (he), Hindi (hi), Hungarian (hu), Bahasa Indonesia (id), Italian (it), Japanese (ja), Korean (ko), Latvian (lv), Lithuanian (lt), Bahasa Melayu (ms), Norwegian (no), Polish (pl), Portuguese (pt), Portuguese Brazil (pt_BR), Romanian (ro), Russian (ru), Serbian (sr), Slovak (sk), Slovenian (sl), Spanish (es),Spanish Latin America (es_MX), Swedish (sv), Thai (th), Turkish (tr), Ukrainian (uk) and Vietnamese (vi). Additionally, the value can be set to �browser� to automatically detect the browser language being used by the viewer and display the disclosure in that language.
Tags
Return values
array<string|int, mixed> —of \DocuSign\eSign\Model\ConsumerDisclosure, HTTP status code, HTTP response headers (array of strings)
getENoteConfiguration()
Operation getENoteConfiguration
public
getENoteConfiguration(string|null $account_id) : ENoteConfiguration
Returns the configuration information for the eNote eOriginal integration.
Parameters
- $account_id : string|null
-
The external account number (int) or account ID Guid.
Tags
Return values
ENoteConfiguration —getENoteConfigurationWithHttpInfo()
Operation getENoteConfigurationWithHttpInfo
public
getENoteConfigurationWithHttpInfo(string|null $account_id) : array<string|int, mixed>
Returns the configuration information for the eNote eOriginal integration.
Parameters
- $account_id : string|null
-
The external account number (int) or account ID Guid.
Tags
Return values
array<string|int, mixed> —of \DocuSign\eSign\Model\ENoteConfiguration, HTTP status code, HTTP response headers (array of strings)
getEnvelopePurgeConfiguration()
Operation getEnvelopePurgeConfiguration
public
getEnvelopePurgeConfiguration(string|null $account_id) : EnvelopePurgeConfiguration
Select envelope purge configuration.
Parameters
- $account_id : string|null
-
The external account number (int) or account ID Guid.
Tags
Return values
EnvelopePurgeConfiguration —getEnvelopePurgeConfigurationWithHttpInfo()
Operation getEnvelopePurgeConfigurationWithHttpInfo
public
getEnvelopePurgeConfigurationWithHttpInfo(string|null $account_id) : array<string|int, mixed>
Select envelope purge configuration.
Parameters
- $account_id : string|null
-
The external account number (int) or account ID Guid.
Tags
Return values
array<string|int, mixed> —of \DocuSign\eSign\Model\EnvelopePurgeConfiguration, HTTP status code, HTTP response headers (array of strings)
getFavoriteTemplates()
Operation getFavoriteTemplates
public
getFavoriteTemplates(string|null $account_id) : FavoriteTemplatesInfo
Retrieves the list of favorited templates for this caller
Parameters
- $account_id : string|null
-
The external account number (int) or account ID Guid.
Tags
Return values
FavoriteTemplatesInfo —getFavoriteTemplatesWithHttpInfo()
Operation getFavoriteTemplatesWithHttpInfo
public
getFavoriteTemplatesWithHttpInfo(string|null $account_id) : array<string|int, mixed>
Retrieves the list of favorited templates for this caller
Parameters
- $account_id : string|null
-
The external account number (int) or account ID Guid.
Tags
Return values
array<string|int, mixed> —of \DocuSign\eSign\Model\FavoriteTemplatesInfo, HTTP status code, HTTP response headers (array of strings)
getNotificationDefaults()
Operation getNotificationDefaults
public
getNotificationDefaults(string|null $account_id) : NotificationDefaults
Returns default user level settings for a specified account
Parameters
- $account_id : string|null
-
The external account number (int) or account ID Guid.
Tags
Return values
NotificationDefaults —getNotificationDefaultsWithHttpInfo()
Operation getNotificationDefaultsWithHttpInfo
public
getNotificationDefaultsWithHttpInfo(string|null $account_id) : array<string|int, mixed>
Returns default user level settings for a specified account
Parameters
- $account_id : string|null
-
The external account number (int) or account ID Guid.
Tags
Return values
array<string|int, mixed> —of \DocuSign\eSign\Model\NotificationDefaults, HTTP status code, HTTP response headers (array of strings)
getPasswordRules()
Operation getPasswordRules
public
getPasswordRules(string|null $account_id) : AccountPasswordRules
Get the password rules
Parameters
- $account_id : string|null
-
The external account number (int) or account ID Guid.
Tags
Return values
AccountPasswordRules —getPasswordRules_0()
Operation getPasswordRules_0
public
getPasswordRules_0() : UserPasswordRules
Get membership account password rules
Tags
Return values
UserPasswordRules —getPasswordRules_0WithHttpInfo()
Operation getPasswordRules_0WithHttpInfo
public
getPasswordRules_0WithHttpInfo() : array<string|int, mixed>
Get membership account password rules
Tags
Return values
array<string|int, mixed> —of \DocuSign\eSign\Model\UserPasswordRules, HTTP status code, HTTP response headers (array of strings)
getPasswordRulesWithHttpInfo()
Operation getPasswordRulesWithHttpInfo
public
getPasswordRulesWithHttpInfo(string|null $account_id) : array<string|int, mixed>
Get the password rules
Parameters
- $account_id : string|null
-
The external account number (int) or account ID Guid.
Tags
Return values
array<string|int, mixed> —of \DocuSign\eSign\Model\AccountPasswordRules, HTTP status code, HTTP response headers (array of strings)
getPermissionProfile()
Operation getPermissionProfile
public
getPermissionProfile(string|null $account_id, string|null $permission_profile_id[, GetPermissionProfileOptions $options = null ]) : PermissionProfile
Returns a permissions profile in the specified account.
Parameters
- $account_id : string|null
-
The external account number (int) or account ID Guid.
- $permission_profile_id : string|null
- $options : GetPermissionProfileOptions = null
-
for modifying the behavior of the function. (optional)
Tags
Return values
PermissionProfile —getPermissionProfileWithHttpInfo()
Operation getPermissionProfileWithHttpInfo
public
getPermissionProfileWithHttpInfo(string|null $account_id, string|null $permission_profile_id[, GetPermissionProfileOptions $options = null ]) : array<string|int, mixed>
Returns a permissions profile in the specified account.
Parameters
- $account_id : string|null
-
The external account number (int) or account ID Guid.
- $permission_profile_id : string|null
- $options : GetPermissionProfileOptions = null
-
for modifying the behavior of the function. (optional)
Tags
Return values
array<string|int, mixed> —of \DocuSign\eSign\Model\PermissionProfile, HTTP status code, HTTP response headers (array of strings)
getPrincipalUserAuthorizations()
Operation getPrincipalUserAuthorizations
public
getPrincipalUserAuthorizations(string|null $account_id, string|null $user_id[, GetPrincipalUserAuthorizationsOptions $options = null ]) : UserAuthorizations
Returns the principal user authorizations
Parameters
- $account_id : string|null
-
The external account number (int) or account ID Guid.
- $user_id : string|null
-
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 : GetPrincipalUserAuthorizationsOptions = null
-
for modifying the behavior of the function. (optional)
Tags
Return values
UserAuthorizations —getPrincipalUserAuthorizationsWithHttpInfo()
Operation getPrincipalUserAuthorizationsWithHttpInfo
public
getPrincipalUserAuthorizationsWithHttpInfo(string|null $account_id, string|null $user_id[, GetPrincipalUserAuthorizationsOptions $options = null ]) : array<string|int, mixed>
Returns the principal user authorizations
Parameters
- $account_id : string|null
-
The external account number (int) or account ID Guid.
- $user_id : string|null
-
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 : GetPrincipalUserAuthorizationsOptions = null
-
for modifying the behavior of the function. (optional)
Tags
Return values
array<string|int, mixed> —of \DocuSign\eSign\Model\UserAuthorizations, HTTP status code, HTTP response headers (array of strings)
getProvisioning()
Operation getProvisioning
public
getProvisioning() : ProvisioningInformation
Retrieves the account provisioning information for the account.
Tags
Return values
ProvisioningInformation —getProvisioningWithHttpInfo()
Operation getProvisioningWithHttpInfo
public
getProvisioningWithHttpInfo() : array<string|int, mixed>
Retrieves the account provisioning information for the account.
Tags
Return values
array<string|int, mixed> —of \DocuSign\eSign\Model\ProvisioningInformation, HTTP status code, HTTP response headers (array of strings)
getSupportedLanguages()
Operation getSupportedLanguages
public
getSupportedLanguages(string|null $account_id) : SupportedLanguages
Gets list of supported languages for recipient language setting.
Parameters
- $account_id : string|null
-
The external account number (int) or account ID Guid.
Tags
Return values
SupportedLanguages —getSupportedLanguagesWithHttpInfo()
Operation getSupportedLanguagesWithHttpInfo
public
getSupportedLanguagesWithHttpInfo(string|null $account_id) : array<string|int, mixed>
Gets list of supported languages for recipient language setting.
Parameters
- $account_id : string|null
-
The external account number (int) or account ID Guid.
Tags
Return values
array<string|int, mixed> —of \DocuSign\eSign\Model\SupportedLanguages, HTTP status code, HTTP response headers (array of strings)
getUserAuthorization()
Operation getUserAuthorization
public
getUserAuthorization(string|null $account_id, string|null $authorization_id, string|null $user_id) : UserAuthorization
Returns the user authorization for a given authorization id
Parameters
- $account_id : string|null
-
The external account number (int) or account ID Guid.
- $authorization_id : string|null
- $user_id : string|null
-
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.
Tags
Return values
UserAuthorization —getUserAuthorizationWithHttpInfo()
Operation getUserAuthorizationWithHttpInfo
public
getUserAuthorizationWithHttpInfo(string|null $account_id, string|null $authorization_id, string|null $user_id) : array<string|int, mixed>
Returns the user authorization for a given authorization id
Parameters
- $account_id : string|null
-
The external account number (int) or account ID Guid.
- $authorization_id : string|null
- $user_id : string|null
-
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.
Tags
Return values
array<string|int, mixed> —of \DocuSign\eSign\Model\UserAuthorization, HTTP status code, HTTP response headers (array of strings)
getWatermark()
Operation getWatermark
public
getWatermark(string|null $account_id) : Watermark
Get watermark information.
Parameters
- $account_id : string|null
-
The external account number (int) or account ID Guid.
Tags
Return values
Watermark —getWatermarkPreview()
Operation getWatermarkPreview
public
getWatermarkPreview(string|null $account_id[, Watermark $watermark = null ]) : Watermark
Get watermark preview.
Parameters
- $account_id : string|null
-
The external account number (int) or account ID Guid.
- $watermark : Watermark = null
-
(optional)
Tags
Return values
Watermark —getWatermarkPreviewWithHttpInfo()
Operation getWatermarkPreviewWithHttpInfo
public
getWatermarkPreviewWithHttpInfo(string|null $account_id[, Watermark $watermark = null ]) : array<string|int, mixed>
Get watermark preview.
Parameters
- $account_id : string|null
-
The external account number (int) or account ID Guid.
- $watermark : Watermark = null
-
(optional)
Tags
Return values
array<string|int, mixed> —of \DocuSign\eSign\Model\Watermark, HTTP status code, HTTP response headers (array of strings)
getWatermarkWithHttpInfo()
Operation getWatermarkWithHttpInfo
public
getWatermarkWithHttpInfo(string|null $account_id) : array<string|int, mixed>
Get watermark information.
Parameters
- $account_id : string|null
-
The external account number (int) or account ID Guid.
Tags
Return values
array<string|int, mixed> —of \DocuSign\eSign\Model\Watermark, HTTP status code, HTTP response headers (array of strings)
listBrands()
Operation listBrands
public
listBrands(string|null $account_id[, ListBrandsOptions $options = null ]) : BrandsResponse
Gets a list of brand profiles.
Parameters
- $account_id : string|null
-
The external account number (int) or account ID Guid.
- $options : ListBrandsOptions = null
-
for modifying the behavior of the function. (optional)
Tags
Return values
BrandsResponse —listBrandsWithHttpInfo()
Operation listBrandsWithHttpInfo
public
listBrandsWithHttpInfo(string|null $account_id[, ListBrandsOptions $options = null ]) : array<string|int, mixed>
Gets a list of brand profiles.
Parameters
- $account_id : string|null
-
The external account number (int) or account ID Guid.
- $options : ListBrandsOptions = null
-
for modifying the behavior of the function. (optional)
Tags
Return values
array<string|int, mixed> —of \DocuSign\eSign\Model\BrandsResponse, HTTP status code, HTTP response headers (array of strings)
listCustomFields()
Operation listCustomFields
public
listCustomFields(string|null $account_id) : CustomFields
Gets a list of custom fields associated with the account.
Parameters
- $account_id : string|null
-
The external account number (int) or account ID Guid.
Tags
Return values
CustomFields —listCustomFieldsWithHttpInfo()
Operation listCustomFieldsWithHttpInfo
public
listCustomFieldsWithHttpInfo(string|null $account_id) : array<string|int, mixed>
Gets a list of custom fields associated with the account.
Parameters
- $account_id : string|null
-
The external account number (int) or account ID Guid.
Tags
Return values
array<string|int, mixed> —of \DocuSign\eSign\Model\CustomFields, HTTP status code, HTTP response headers (array of strings)
listPermissions()
Operation listPermissions
public
listPermissions(string|null $account_id[, ListPermissionsOptions $options = null ]) : PermissionProfileInformation
Gets a list of permission profiles.
Parameters
- $account_id : string|null
-
The external account number (int) or account ID Guid.
- $options : ListPermissionsOptions = null
-
for modifying the behavior of the function. (optional)
Tags
Return values
PermissionProfileInformation —listPermissionsWithHttpInfo()
Operation listPermissionsWithHttpInfo
public
listPermissionsWithHttpInfo(string|null $account_id[, ListPermissionsOptions $options = null ]) : array<string|int, mixed>
Gets a list of permission profiles.
Parameters
- $account_id : string|null
-
The external account number (int) or account ID Guid.
- $options : ListPermissionsOptions = null
-
for modifying the behavior of the function. (optional)
Tags
Return values
array<string|int, mixed> —of \DocuSign\eSign\Model\PermissionProfileInformation, HTTP status code, HTTP response headers (array of strings)
listRecipientNamesByEmail()
Operation listRecipientNamesByEmail
public
listRecipientNamesByEmail(string|null $account_id[, ListRecipientNamesByEmailOptions $options = null ]) : RecipientNamesResponse
Gets recipient names associated with an email address.
Parameters
- $account_id : string|null
-
The external account number (int) or account ID Guid.
- $options : ListRecipientNamesByEmailOptions = null
-
for modifying the behavior of the function. (optional)
Tags
Return values
RecipientNamesResponse —listRecipientNamesByEmailWithHttpInfo()
Operation listRecipientNamesByEmailWithHttpInfo
public
listRecipientNamesByEmailWithHttpInfo(string|null $account_id[, ListRecipientNamesByEmailOptions $options = null ]) : array<string|int, mixed>
Gets recipient names associated with an email address.
Parameters
- $account_id : string|null
-
The external account number (int) or account ID Guid.
- $options : ListRecipientNamesByEmailOptions = null
-
for modifying the behavior of the function. (optional)
Tags
Return values
array<string|int, mixed> —of \DocuSign\eSign\Model\RecipientNamesResponse, HTTP status code, HTTP response headers (array of strings)
listSettings()
Operation listSettings
public
listSettings(string|null $account_id) : AccountSettingsInformation
Gets account settings information.
Parameters
- $account_id : string|null
-
The external account number (int) or account ID Guid.
Tags
Return values
AccountSettingsInformation —listSettingsWithHttpInfo()
Operation listSettingsWithHttpInfo
public
listSettingsWithHttpInfo(string|null $account_id) : array<string|int, mixed>
Gets account settings information.
Parameters
- $account_id : string|null
-
The external account number (int) or account ID Guid.
Tags
Return values
array<string|int, mixed> —of \DocuSign\eSign\Model\AccountSettingsInformation, HTTP status code, HTTP response headers (array of strings)
listSharedAccess()
Operation listSharedAccess
public
listSharedAccess(string|null $account_id[, ListSharedAccessOptions $options = null ]) : AccountSharedAccess
Reserved: Gets the shared item status for one or more users.
Parameters
- $account_id : string|null
-
The external account number (int) or account ID Guid.
- $options : ListSharedAccessOptions = null
-
for modifying the behavior of the function. (optional)
Tags
Return values
AccountSharedAccess —listSharedAccessWithHttpInfo()
Operation listSharedAccessWithHttpInfo
public
listSharedAccessWithHttpInfo(string|null $account_id[, ListSharedAccessOptions $options = null ]) : array<string|int, mixed>
Reserved: Gets the shared item status for one or more users.
Parameters
- $account_id : string|null
-
The external account number (int) or account ID Guid.
- $options : ListSharedAccessOptions = null
-
for modifying the behavior of the function. (optional)
Tags
Return values
array<string|int, mixed> —of \DocuSign\eSign\Model\AccountSharedAccess, HTTP status code, HTTP response headers (array of strings)
listSignatureProviders()
Operation listSignatureProviders
public
listSignatureProviders(string|null $account_id) : AccountSignatureProviders
Returns Account available signature providers for specified account.
Parameters
- $account_id : string|null
-
The external account number (int) or account ID Guid.
Tags
Return values
AccountSignatureProviders —listSignatureProvidersWithHttpInfo()
Operation listSignatureProvidersWithHttpInfo
public
listSignatureProvidersWithHttpInfo(string|null $account_id) : array<string|int, mixed>
Returns Account available signature providers for specified account.
Parameters
- $account_id : string|null
-
The external account number (int) or account ID Guid.
Tags
Return values
array<string|int, mixed> —of \DocuSign\eSign\Model\AccountSignatureProviders, HTTP status code, HTTP response headers (array of strings)
listUnsupportedFileTypes()
Operation listUnsupportedFileTypes
public
listUnsupportedFileTypes(string|null $account_id) : FileTypeList
Gets a list of unsupported file types.
Parameters
- $account_id : string|null
-
The external account number (int) or account ID Guid.
Tags
Return values
FileTypeList —listUnsupportedFileTypesWithHttpInfo()
Operation listUnsupportedFileTypesWithHttpInfo
public
listUnsupportedFileTypesWithHttpInfo(string|null $account_id) : array<string|int, mixed>
Gets a list of unsupported file types.
Parameters
- $account_id : string|null
-
The external account number (int) or account ID Guid.
Tags
Return values
array<string|int, mixed> —of \DocuSign\eSign\Model\FileTypeList, HTTP status code, HTTP response headers (array of strings)
setApiClient()
Set the API client
public
setApiClient(ApiClient $apiClient) : self
Parameters
- $apiClient : ApiClient
-
set the API client
Return values
self —unFavoriteTemplate()
Operation unFavoriteTemplate
public
unFavoriteTemplate(string|null $account_id[, FavoriteTemplatesInfo $favorite_templates_info = null ]) : FavoriteTemplatesInfo
Unfavorite a template
Parameters
- $account_id : string|null
-
The external account number (int) or account ID Guid.
- $favorite_templates_info : FavoriteTemplatesInfo = null
-
(optional)
Tags
Return values
FavoriteTemplatesInfo —unFavoriteTemplateWithHttpInfo()
Operation unFavoriteTemplateWithHttpInfo
public
unFavoriteTemplateWithHttpInfo(string|null $account_id[, FavoriteTemplatesInfo $favorite_templates_info = null ]) : array<string|int, mixed>
Unfavorite a template
Parameters
- $account_id : string|null
-
The external account number (int) or account ID Guid.
- $favorite_templates_info : FavoriteTemplatesInfo = null
-
(optional)
Tags
Return values
array<string|int, mixed> —of \DocuSign\eSign\Model\FavoriteTemplatesInfo, HTTP status code, HTTP response headers (array of strings)
updateAccountSignature()
Operation updateAccountSignature
public
updateAccountSignature(string|null $account_id[, AccountSignaturesInformation $account_signatures_information = null ]) : AccountSignaturesInformation
Updates a account signature.
Parameters
- $account_id : string|null
-
The external account number (int) or account ID Guid.
- $account_signatures_information : AccountSignaturesInformation = null
-
(optional)
Tags
Return values
AccountSignaturesInformation —updateAccountSignatureById()
Operation updateAccountSignatureById
public
updateAccountSignatureById(string|null $account_id, string|null $signature_id[, AccountSignatureDefinition $account_signature_definition = null ][, UpdateAccountSignatureByIdOptions $options = null ]) : AccountSignature
Updates a account signature.
Parameters
- $account_id : string|null
-
The external account number (int) or account ID Guid.
- $signature_id : string|null
-
The ID of the signature being accessed.
- $account_signature_definition : AccountSignatureDefinition = null
-
(optional)
- $options : UpdateAccountSignatureByIdOptions = null
-
for modifying the behavior of the function. (optional)
Tags
Return values
AccountSignature —updateAccountSignatureByIdWithHttpInfo()
Operation updateAccountSignatureByIdWithHttpInfo
public
updateAccountSignatureByIdWithHttpInfo(string|null $account_id, string|null $signature_id[, AccountSignatureDefinition $account_signature_definition = null ][, UpdateAccountSignatureByIdOptions $options = null ]) : array<string|int, mixed>
Updates a account signature.
Parameters
- $account_id : string|null
-
The external account number (int) or account ID Guid.
- $signature_id : string|null
-
The ID of the signature being accessed.
- $account_signature_definition : AccountSignatureDefinition = null
-
(optional)
- $options : UpdateAccountSignatureByIdOptions = null
-
for modifying the behavior of the function. (optional)
Tags
Return values
array<string|int, mixed> —of \DocuSign\eSign\Model\AccountSignature, HTTP status code, HTTP response headers (array of strings)
updateAccountSignatureImage()
Operation updateAccountSignatureImage
public
updateAccountSignatureImage(string|null $account_id, string|null $image_type, string|null $signature_id[, UpdateAccountSignatureImageOptions $options = null ]) : AccountSignature
Sets a signature, initials, or stamps image.
Parameters
- $account_id : string|null
-
The external account number (int) or account ID Guid.
- $image_type : string|null
-
One of signature_image or initials_image.
- $signature_id : string|null
-
The ID of the signature being accessed.
- $options : UpdateAccountSignatureImageOptions = null
-
for modifying the behavior of the function. (optional)
Tags
Return values
AccountSignature —updateAccountSignatureImageWithHttpInfo()
Operation updateAccountSignatureImageWithHttpInfo
public
updateAccountSignatureImageWithHttpInfo(string|null $account_id, string|null $image_type, string|null $signature_id[, UpdateAccountSignatureImageOptions $options = null ]) : array<string|int, mixed>
Sets a signature, initials, or stamps image.
Parameters
- $account_id : string|null
-
The external account number (int) or account ID Guid.
- $image_type : string|null
-
One of signature_image or initials_image.
- $signature_id : string|null
-
The ID of the signature being accessed.
- $options : UpdateAccountSignatureImageOptions = null
-
for modifying the behavior of the function. (optional)
Tags
Return values
array<string|int, mixed> —of \DocuSign\eSign\Model\AccountSignature, HTTP status code, HTTP response headers (array of strings)
updateAccountSignatureWithHttpInfo()
Operation updateAccountSignatureWithHttpInfo
public
updateAccountSignatureWithHttpInfo(string|null $account_id[, AccountSignaturesInformation $account_signatures_information = null ]) : array<string|int, mixed>
Updates a account signature.
Parameters
- $account_id : string|null
-
The external account number (int) or account ID Guid.
- $account_signatures_information : AccountSignaturesInformation = null
-
(optional)
Tags
Return values
array<string|int, mixed> —of \DocuSign\eSign\Model\AccountSignaturesInformation, HTTP status code, HTTP response headers (array of strings)
updateAccountTabSettings()
Operation updateAccountTabSettings
public
updateAccountTabSettings(string|null $account_id[, TabAccountSettings $tab_account_settings = null ]) : TabAccountSettings
Modifies tab settings for specified account
Parameters
- $account_id : string|null
-
The external account number (int) or account ID Guid.
- $tab_account_settings : TabAccountSettings = null
-
(optional)
Tags
Return values
TabAccountSettings —updateAccountTabSettingsWithHttpInfo()
Operation updateAccountTabSettingsWithHttpInfo
public
updateAccountTabSettingsWithHttpInfo(string|null $account_id[, TabAccountSettings $tab_account_settings = null ]) : array<string|int, mixed>
Modifies tab settings for specified account
Parameters
- $account_id : string|null
-
The external account number (int) or account ID Guid.
- $tab_account_settings : TabAccountSettings = null
-
(optional)
Tags
Return values
array<string|int, mixed> —of \DocuSign\eSign\Model\TabAccountSettings, HTTP status code, HTTP response headers (array of strings)
updateBrand()
Operation updateBrand
public
updateBrand(string|null $account_id, string|null $brand_id[, Brand $brand = null ][, UpdateBrandOptions $options = null ]) : Brand
Updates an existing brand.
Parameters
- $account_id : string|null
-
The external account number (int) or account ID Guid.
- $brand_id : string|null
-
The unique identifier of a brand.
- $brand : Brand = null
-
(optional)
- $options : UpdateBrandOptions = null
-
for modifying the behavior of the function. (optional)
Tags
Return values
Brand —updateBrandLogoByType()
Operation updateBrandLogoByType
public
updateBrandLogoByType(string|null $account_id, string|null $brand_id, string|null $logo_type, string|null $logo_file_bytes) : mixed
Put one branding logo.
Parameters
- $account_id : string|null
-
The external account number (int) or account ID GUID.
- $brand_id : string|null
-
The ID of the brand.
- $logo_type : string|null
-
The type of logo. Valid values are: - `primary` - `secondary` - `email`
- $logo_file_bytes : string|null
-
Brand logo binary Stream. Supported formats: JPG, GIF, PNG. Maximum file size: 300 KB. Recommended dimensions: 296 x 76 pixels (larger images will be resized). Changes may take up to one hour to display in all places (required)
Tags
Return values
mixed —updateBrandLogoByTypeWithHttpInfo()
Operation updateBrandLogoByTypeWithHttpInfo
public
updateBrandLogoByTypeWithHttpInfo(string|null $account_id, string|null $brand_id, string|null $logo_type, string|null $logo_file_bytes) : array<string|int, mixed>
Put one branding logo.
Parameters
- $account_id : string|null
-
The external account number (int) or account ID GUID.
- $brand_id : string|null
-
The ID of the brand.
- $logo_type : string|null
-
The type of logo. Valid values are: - `primary` - `secondary` - `email`
- $logo_file_bytes : string|null
-
Brand logo binary Stream. Supported formats: JPG, GIF, PNG. Maximum file size: 300 KB. Recommended dimensions: 296 x 76 pixels (larger images will be resized). Changes may take up to one hour to display in all places (required)
Tags
Return values
array<string|int, mixed> —of null, HTTP status code, HTTP response headers (array of strings)
updateBrandResourcesByContentType()
Operation updateBrandResourcesByContentType
public
updateBrandResourcesByContentType(string|null $account_id, string|null $brand_id, string|null $resource_content_type, SplFileObject $file_xml) : BrandResources
Uploads a branding resource file.
Parameters
- $account_id : string|null
-
The external account number (int) or account ID GUID.
- $brand_id : string|null
-
The ID of the brand.
- $resource_content_type : string|null
-
The type of brand resource file that you are updating. Valid values are: - `sending` - `signing` - `email` - `signing_captive`
- $file_xml : SplFileObject
-
Brand resource XML file. (required)
Tags
Return values
BrandResources —updateBrandResourcesByContentTypeWithHttpInfo()
Operation updateBrandResourcesByContentTypeWithHttpInfo
public
updateBrandResourcesByContentTypeWithHttpInfo(string|null $account_id, string|null $brand_id, string|null $resource_content_type, SplFileObject $file_xml) : array<string|int, mixed>
Uploads a branding resource file.
Parameters
- $account_id : string|null
-
The external account number (int) or account ID GUID.
- $brand_id : string|null
-
The ID of the brand.
- $resource_content_type : string|null
-
The type of brand resource file that you are updating. Valid values are: - `sending` - `signing` - `email` - `signing_captive`
- $file_xml : SplFileObject
-
Brand resource XML file. (required)
Tags
Return values
array<string|int, mixed> —of \DocuSign\eSign\Model\BrandResources, HTTP status code, HTTP response headers (array of strings)
updateBrandWithHttpInfo()
Operation updateBrandWithHttpInfo
public
updateBrandWithHttpInfo(string|null $account_id, string|null $brand_id[, Brand $brand = null ][, UpdateBrandOptions $options = null ]) : array<string|int, mixed>
Updates an existing brand.
Parameters
- $account_id : string|null
-
The external account number (int) or account ID Guid.
- $brand_id : string|null
-
The unique identifier of a brand.
- $brand : Brand = null
-
(optional)
- $options : UpdateBrandOptions = null
-
for modifying the behavior of the function. (optional)
Tags
Return values
array<string|int, mixed> —of \DocuSign\eSign\Model\Brand, HTTP status code, HTTP response headers (array of strings)
updateConsumerDisclosure()
Operation updateConsumerDisclosure
public
updateConsumerDisclosure(string|null $account_id, string|null $lang_code[, ConsumerDisclosure $consumer_disclosure = null ][, UpdateConsumerDisclosureOptions $options = null ]) : ConsumerDisclosure
Update Consumer Disclosure.
Parameters
- $account_id : string|null
-
The external account number (int) or account ID Guid.
- $lang_code : string|null
-
The simple type enumeration the language used in the response. The supported languages, with the language value shown in parenthesis, are:Arabic (ar), Armenian (hy), Bulgarian (bg), Czech (cs), Chinese Simplified (zh_CN), Chinese Traditional (zh_TW), Croatian (hr), Danish (da), Dutch (nl), English US (en), English UK (en_GB), Estonian (et), Farsi (fa), Finnish (fi), French (fr), French Canada (fr_CA), German (de), Greek (el), Hebrew (he), Hindi (hi), Hungarian (hu), Bahasa Indonesia (id), Italian (it), Japanese (ja), Korean (ko), Latvian (lv), Lithuanian (lt), Bahasa Melayu (ms), Norwegian (no), Polish (pl), Portuguese (pt), Portuguese Brazil (pt_BR), Romanian (ro), Russian (ru), Serbian (sr), Slovak (sk), Slovenian (sl), Spanish (es),Spanish Latin America (es_MX), Swedish (sv), Thai (th), Turkish (tr), Ukrainian (uk) and Vietnamese (vi). Additionally, the value can be set to �browser� to automatically detect the browser language being used by the viewer and display the disclosure in that language.
- $consumer_disclosure : ConsumerDisclosure = null
-
(optional)
- $options : UpdateConsumerDisclosureOptions = null
-
for modifying the behavior of the function. (optional)
Tags
Return values
ConsumerDisclosure —updateConsumerDisclosureWithHttpInfo()
Operation updateConsumerDisclosureWithHttpInfo
public
updateConsumerDisclosureWithHttpInfo(string|null $account_id, string|null $lang_code[, ConsumerDisclosure $consumer_disclosure = null ][, UpdateConsumerDisclosureOptions $options = null ]) : array<string|int, mixed>
Update Consumer Disclosure.
Parameters
- $account_id : string|null
-
The external account number (int) or account ID Guid.
- $lang_code : string|null
-
The simple type enumeration the language used in the response. The supported languages, with the language value shown in parenthesis, are:Arabic (ar), Armenian (hy), Bulgarian (bg), Czech (cs), Chinese Simplified (zh_CN), Chinese Traditional (zh_TW), Croatian (hr), Danish (da), Dutch (nl), English US (en), English UK (en_GB), Estonian (et), Farsi (fa), Finnish (fi), French (fr), French Canada (fr_CA), German (de), Greek (el), Hebrew (he), Hindi (hi), Hungarian (hu), Bahasa Indonesia (id), Italian (it), Japanese (ja), Korean (ko), Latvian (lv), Lithuanian (lt), Bahasa Melayu (ms), Norwegian (no), Polish (pl), Portuguese (pt), Portuguese Brazil (pt_BR), Romanian (ro), Russian (ru), Serbian (sr), Slovak (sk), Slovenian (sl), Spanish (es),Spanish Latin America (es_MX), Swedish (sv), Thai (th), Turkish (tr), Ukrainian (uk) and Vietnamese (vi). Additionally, the value can be set to �browser� to automatically detect the browser language being used by the viewer and display the disclosure in that language.
- $consumer_disclosure : ConsumerDisclosure = null
-
(optional)
- $options : UpdateConsumerDisclosureOptions = null
-
for modifying the behavior of the function. (optional)
Tags
Return values
array<string|int, mixed> —of \DocuSign\eSign\Model\ConsumerDisclosure, HTTP status code, HTTP response headers (array of strings)
updateCustomField()
Operation updateCustomField
public
updateCustomField(string|null $account_id, string|null $custom_field_id[, CustomField $custom_field = null ][, UpdateCustomFieldOptions $options = null ]) : CustomFields
Updates an existing account custom field.
Parameters
- $account_id : string|null
-
The external account number (int) or account ID Guid.
- $custom_field_id : string|null
- $custom_field : CustomField = null
-
(optional)
- $options : UpdateCustomFieldOptions = null
-
for modifying the behavior of the function. (optional)
Tags
Return values
CustomFields —updateCustomFieldWithHttpInfo()
Operation updateCustomFieldWithHttpInfo
public
updateCustomFieldWithHttpInfo(string|null $account_id, string|null $custom_field_id[, CustomField $custom_field = null ][, UpdateCustomFieldOptions $options = null ]) : array<string|int, mixed>
Updates an existing account custom field.
Parameters
- $account_id : string|null
-
The external account number (int) or account ID Guid.
- $custom_field_id : string|null
- $custom_field : CustomField = null
-
(optional)
- $options : UpdateCustomFieldOptions = null
-
for modifying the behavior of the function. (optional)
Tags
Return values
array<string|int, mixed> —of \DocuSign\eSign\Model\CustomFields, HTTP status code, HTTP response headers (array of strings)
updateENoteConfiguration()
Operation updateENoteConfiguration
public
updateENoteConfiguration(string|null $account_id[, ENoteConfiguration $e_note_configuration = null ]) : ENoteConfiguration
Updates configuration information for the eNote eOriginal integration.
Parameters
- $account_id : string|null
-
The external account number (int) or account ID Guid.
- $e_note_configuration : ENoteConfiguration = null
-
(optional)
Tags
Return values
ENoteConfiguration —updateENoteConfigurationWithHttpInfo()
Operation updateENoteConfigurationWithHttpInfo
public
updateENoteConfigurationWithHttpInfo(string|null $account_id[, ENoteConfiguration $e_note_configuration = null ]) : array<string|int, mixed>
Updates configuration information for the eNote eOriginal integration.
Parameters
- $account_id : string|null
-
The external account number (int) or account ID Guid.
- $e_note_configuration : ENoteConfiguration = null
-
(optional)
Tags
Return values
array<string|int, mixed> —of \DocuSign\eSign\Model\ENoteConfiguration, HTTP status code, HTTP response headers (array of strings)
updateEnvelopePurgeConfiguration()
Operation updateEnvelopePurgeConfiguration
public
updateEnvelopePurgeConfiguration(string|null $account_id[, EnvelopePurgeConfiguration $envelope_purge_configuration = null ]) : EnvelopePurgeConfiguration
Updates envelope purge configuration.
Parameters
- $account_id : string|null
-
The external account number (int) or account ID Guid.
- $envelope_purge_configuration : EnvelopePurgeConfiguration = null
-
(optional)
Tags
Return values
EnvelopePurgeConfiguration —updateEnvelopePurgeConfigurationWithHttpInfo()
Operation updateEnvelopePurgeConfigurationWithHttpInfo
public
updateEnvelopePurgeConfigurationWithHttpInfo(string|null $account_id[, EnvelopePurgeConfiguration $envelope_purge_configuration = null ]) : array<string|int, mixed>
Updates envelope purge configuration.
Parameters
- $account_id : string|null
-
The external account number (int) or account ID Guid.
- $envelope_purge_configuration : EnvelopePurgeConfiguration = null
-
(optional)
Tags
Return values
array<string|int, mixed> —of \DocuSign\eSign\Model\EnvelopePurgeConfiguration, HTTP status code, HTTP response headers (array of strings)
updateFavoriteTemplate()
Operation updateFavoriteTemplate
public
updateFavoriteTemplate(string|null $account_id[, FavoriteTemplatesInfo $favorite_templates_info = null ]) : FavoriteTemplatesInfo
Favorites a template
Parameters
- $account_id : string|null
-
The external account number (int) or account ID Guid.
- $favorite_templates_info : FavoriteTemplatesInfo = null
-
(optional)
Tags
Return values
FavoriteTemplatesInfo —updateFavoriteTemplateWithHttpInfo()
Operation updateFavoriteTemplateWithHttpInfo
public
updateFavoriteTemplateWithHttpInfo(string|null $account_id[, FavoriteTemplatesInfo $favorite_templates_info = null ]) : array<string|int, mixed>
Favorites a template
Parameters
- $account_id : string|null
-
The external account number (int) or account ID Guid.
- $favorite_templates_info : FavoriteTemplatesInfo = null
-
(optional)
Tags
Return values
array<string|int, mixed> —of \DocuSign\eSign\Model\FavoriteTemplatesInfo, HTTP status code, HTTP response headers (array of strings)
updateNotificationDefaults()
Operation updateNotificationDefaults
public
updateNotificationDefaults(string|null $account_id[, NotificationDefaults $notification_defaults = null ]) : NotificationDefaults
Updates default user level settings for a specified account
Parameters
- $account_id : string|null
-
The external account number (int) or account ID Guid.
- $notification_defaults : NotificationDefaults = null
-
(optional)
Tags
Return values
NotificationDefaults —updateNotificationDefaultsWithHttpInfo()
Operation updateNotificationDefaultsWithHttpInfo
public
updateNotificationDefaultsWithHttpInfo(string|null $account_id[, NotificationDefaults $notification_defaults = null ]) : array<string|int, mixed>
Updates default user level settings for a specified account
Parameters
- $account_id : string|null
-
The external account number (int) or account ID Guid.
- $notification_defaults : NotificationDefaults = null
-
(optional)
Tags
Return values
array<string|int, mixed> —of \DocuSign\eSign\Model\NotificationDefaults, HTTP status code, HTTP response headers (array of strings)
updatePasswordRules()
Operation updatePasswordRules
public
updatePasswordRules(string|null $account_id[, AccountPasswordRules $account_password_rules = null ]) : AccountPasswordRules
Update the password rules
Parameters
- $account_id : string|null
-
The external account number (int) or account ID Guid.
- $account_password_rules : AccountPasswordRules = null
-
(optional)
Tags
Return values
AccountPasswordRules —updatePasswordRulesWithHttpInfo()
Operation updatePasswordRulesWithHttpInfo
public
updatePasswordRulesWithHttpInfo(string|null $account_id[, AccountPasswordRules $account_password_rules = null ]) : array<string|int, mixed>
Update the password rules
Parameters
- $account_id : string|null
-
The external account number (int) or account ID Guid.
- $account_password_rules : AccountPasswordRules = null
-
(optional)
Tags
Return values
array<string|int, mixed> —of \DocuSign\eSign\Model\AccountPasswordRules, HTTP status code, HTTP response headers (array of strings)
updatePermissionProfile()
Operation updatePermissionProfile
public
updatePermissionProfile(string|null $account_id, string|null $permission_profile_id[, PermissionProfile $permission_profile = null ][, UpdatePermissionProfileOptions $options = null ]) : PermissionProfile
Updates a permission profile within the specified account.
Parameters
- $account_id : string|null
-
The external account number (int) or account ID Guid.
- $permission_profile_id : string|null
- $permission_profile : PermissionProfile = null
-
(optional)
- $options : UpdatePermissionProfileOptions = null
-
for modifying the behavior of the function. (optional)
Tags
Return values
PermissionProfile —updatePermissionProfileWithHttpInfo()
Operation updatePermissionProfileWithHttpInfo
public
updatePermissionProfileWithHttpInfo(string|null $account_id, string|null $permission_profile_id[, PermissionProfile $permission_profile = null ][, UpdatePermissionProfileOptions $options = null ]) : array<string|int, mixed>
Updates a permission profile within the specified account.
Parameters
- $account_id : string|null
-
The external account number (int) or account ID Guid.
- $permission_profile_id : string|null
- $permission_profile : PermissionProfile = null
-
(optional)
- $options : UpdatePermissionProfileOptions = null
-
for modifying the behavior of the function. (optional)
Tags
Return values
array<string|int, mixed> —of \DocuSign\eSign\Model\PermissionProfile, HTTP status code, HTTP response headers (array of strings)
updateResourcePath()
Update $resourcePath with $
public
updateResourcePath(string $resourcePath, string $baseName, string $paramName) : string
Parameters
- $resourcePath : string
-
the resource path to use
- $baseName : string
-
the base name param
- $paramName : string
-
the parameter name
Return values
string —updateSettings()
Operation updateSettings
public
updateSettings(string|null $account_id[, AccountSettingsInformation $account_settings_information = null ]) : mixed
Updates the account settings for an account.
Parameters
- $account_id : string|null
-
The external account number (int) or account ID Guid.
- $account_settings_information : AccountSettingsInformation = null
-
(optional)
Tags
Return values
mixed —updateSettingsWithHttpInfo()
Operation updateSettingsWithHttpInfo
public
updateSettingsWithHttpInfo(string|null $account_id[, AccountSettingsInformation $account_settings_information = null ]) : array<string|int, mixed>
Updates the account settings for an account.
Parameters
- $account_id : string|null
-
The external account number (int) or account ID Guid.
- $account_settings_information : AccountSettingsInformation = null
-
(optional)
Tags
Return values
array<string|int, mixed> —of null, HTTP status code, HTTP response headers (array of strings)
updateSharedAccess()
Operation updateSharedAccess
public
updateSharedAccess(string|null $account_id[, AccountSharedAccess $account_shared_access = null ][, UpdateSharedAccessOptions $options = null ]) : AccountSharedAccess
Reserved: Sets the shared access information for users.
Parameters
- $account_id : string|null
-
The external account number (int) or account ID Guid.
- $account_shared_access : AccountSharedAccess = null
-
(optional)
- $options : UpdateSharedAccessOptions = null
-
for modifying the behavior of the function. (optional)
Tags
Return values
AccountSharedAccess —updateSharedAccessWithHttpInfo()
Operation updateSharedAccessWithHttpInfo
public
updateSharedAccessWithHttpInfo(string|null $account_id[, AccountSharedAccess $account_shared_access = null ][, UpdateSharedAccessOptions $options = null ]) : array<string|int, mixed>
Reserved: Sets the shared access information for users.
Parameters
- $account_id : string|null
-
The external account number (int) or account ID Guid.
- $account_shared_access : AccountSharedAccess = null
-
(optional)
- $options : UpdateSharedAccessOptions = null
-
for modifying the behavior of the function. (optional)
Tags
Return values
array<string|int, mixed> —of \DocuSign\eSign\Model\AccountSharedAccess, HTTP status code, HTTP response headers (array of strings)
updateUserAuthorization()
Operation updateUserAuthorization
public
updateUserAuthorization(string|null $account_id, string|null $authorization_id, string|null $user_id[, UserAuthorizationUpdateRequest $user_authorization_update_request = null ]) : UserAuthorization
Updates the user authorization
Parameters
- $account_id : string|null
-
The external account number (int) or account ID Guid.
- $authorization_id : string|null
- $user_id : string|null
-
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.
- $user_authorization_update_request : UserAuthorizationUpdateRequest = null
-
(optional)
Tags
Return values
UserAuthorization —updateUserAuthorizationWithHttpInfo()
Operation updateUserAuthorizationWithHttpInfo
public
updateUserAuthorizationWithHttpInfo(string|null $account_id, string|null $authorization_id, string|null $user_id[, UserAuthorizationUpdateRequest $user_authorization_update_request = null ]) : array<string|int, mixed>
Updates the user authorization
Parameters
- $account_id : string|null
-
The external account number (int) or account ID Guid.
- $authorization_id : string|null
- $user_id : string|null
-
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.
- $user_authorization_update_request : UserAuthorizationUpdateRequest = null
-
(optional)
Tags
Return values
array<string|int, mixed> —of \DocuSign\eSign\Model\UserAuthorization, HTTP status code, HTTP response headers (array of strings)
updateWatermark()
Operation updateWatermark
public
updateWatermark(string|null $account_id[, Watermark $watermark = null ]) : Watermark
Update watermark information.
Parameters
- $account_id : string|null
-
The external account number (int) or account ID Guid.
- $watermark : Watermark = null
-
(optional)
Tags
Return values
Watermark —updateWatermarkWithHttpInfo()
Operation updateWatermarkWithHttpInfo
public
updateWatermarkWithHttpInfo(string|null $account_id[, Watermark $watermark = null ]) : array<string|int, mixed>
Update watermark information.
Parameters
- $account_id : string|null
-
The external account number (int) or account ID Guid.
- $watermark : Watermark = null
-
(optional)
Tags
Return values
array<string|int, mixed> —of \DocuSign\eSign\Model\Watermark, HTTP status code, HTTP response headers (array of strings)