Documentation ¶
Overview ¶
Package accounts implements the DocuSign SDK category Accounts.
Use the Account category for various account management tasks including:
* Programmatically creating and deleting accounts. * Getting information about an account and its capabilities. * Branding the account with custom colors, message text, and more. * Account charges.
The Account category also includes end points for * Listing the recipient names associated with an email address that was used by the account. For example, a single email address is often shared by mulitple members of a family.
Service Api documentation may be found at: https://developers.docusign.com/esign-rest-api/v2/reference/Accounts Usage example:
import ( "github.com/jfcote87/esign" "github.com/jfcote87/esign/v2/accounts" "github.com/jfcote87/esign/v2/model" ) ... accountsService := accounts.New(esignCredential)
Index ¶
- type BrandsCreateOp
- type BrandsDeleteListOp
- type BrandsDeleteLogoOp
- type BrandsDeleteOp
- type BrandsGetExportFileOp
- type BrandsGetLogoOp
- type BrandsGetOp
- type BrandsGetResourceOp
- type BrandsListOp
- type BrandsListResourcesOp
- type BrandsUpdateLogoOp
- type BrandsUpdateOp
- type BrandsUpdateResourceOp
- type ConsumerDisclosuresGetDefaultOp
- type ConsumerDisclosuresGetOp
- type ConsumerDisclosuresUpdateOp
- type CreateOp
- type CustomFieldsCreateOp
- type CustomFieldsDeleteOp
- type CustomFieldsListOp
- type CustomFieldsUpdateOp
- type DeleteCaptiveRecipientOp
- type DeleteOp
- type ENoteConfigurationsDeleteOp
- type ENoteConfigurationsGetOp
- type ENoteConfigurationsUpdateOp
- type GetBillingChargesOp
- type GetOp
- type GetProvisioningOp
- type IdentityVerificationsListOp
- type ListRecipientNamesByEmailOp
- type ListSettingsOp
- type ListSharedAccessOp
- func (op *ListSharedAccessOp) Count(val int) *ListSharedAccessOp
- func (op *ListSharedAccessOp) Do(ctx context.Context) (*model.AccountSharedAccess, error)
- func (op *ListSharedAccessOp) EnvelopesNotSharedUserStatus(val string) *ListSharedAccessOp
- func (op *ListSharedAccessOp) FolderIds(val ...string) *ListSharedAccessOp
- func (op *ListSharedAccessOp) ItemType(val string) *ListSharedAccessOp
- func (op *ListSharedAccessOp) SearchText(val string) *ListSharedAccessOp
- func (op *ListSharedAccessOp) Shared(val string) *ListSharedAccessOp
- func (op *ListSharedAccessOp) StartPosition(val int) *ListSharedAccessOp
- func (op *ListSharedAccessOp) UserIds(val ...string) *ListSharedAccessOp
- type ListSupportedLanguagesOp
- type ListUnsupportedFileTypesOp
- type PasswordRulesGetForUserOp
- type PasswordRulesGetOp
- type PasswordRulesUpdateOp
- type PaymentGatewayAccountsListOp
- type PermissionProfilesCreateOp
- type PermissionProfilesDeleteOp
- type PermissionProfilesGetOp
- type PermissionProfilesListOp
- type PermissionProfilesUpdateOp
- type SealProvidersListOp
- type Service
- func (s *Service) BrandsCreate(brand *model.Brand) *BrandsCreateOp
- func (s *Service) BrandsDelete(brandID string) *BrandsDeleteOp
- func (s *Service) BrandsDeleteList(brandsRequest *model.BrandsRequest) *BrandsDeleteListOp
- func (s *Service) BrandsDeleteLogo(brandID string, logoType string) *BrandsDeleteLogoOp
- func (s *Service) BrandsGet(brandID string) *BrandsGetOp
- func (s *Service) BrandsGetExportFile(brandID string) *BrandsGetExportFileOp
- func (s *Service) BrandsGetLogo(brandID string, logoType string) *BrandsGetLogoOp
- func (s *Service) BrandsGetResource(brandID string, resourceContentType string) *BrandsGetResourceOp
- func (s *Service) BrandsList() *BrandsListOp
- func (s *Service) BrandsListResources(brandID string) *BrandsListResourcesOp
- func (s *Service) BrandsUpdate(brandID string, brand *model.Brand) *BrandsUpdateOp
- func (s *Service) BrandsUpdateLogo(brandID string, logoType string, logoFileBytes []byte) *BrandsUpdateLogoOp
- func (s *Service) BrandsUpdateResource(brandID string, resourceContentType string, media io.Reader, mimeType string) *BrandsUpdateResourceOp
- func (s *Service) ConsumerDisclosuresGet(langCode string) *ConsumerDisclosuresGetOp
- func (s *Service) ConsumerDisclosuresGetDefault() *ConsumerDisclosuresGetDefaultOp
- func (s *Service) ConsumerDisclosuresUpdate(langCode string, envelopeConsumerDisclosures *model.ConsumerDisclosure) *ConsumerDisclosuresUpdateOp
- func (s *Service) Create(newAccountDefinition *model.NewAccountDefinition) *CreateOp
- func (s *Service) CustomFieldsCreate(customField *model.CustomField) *CustomFieldsCreateOp
- func (s *Service) CustomFieldsDelete(customFieldID string) *CustomFieldsDeleteOp
- func (s *Service) CustomFieldsList() *CustomFieldsListOp
- func (s *Service) CustomFieldsUpdate(customFieldID string, customField *model.CustomField) *CustomFieldsUpdateOp
- func (s *Service) Delete() *DeleteOp
- func (s *Service) DeleteCaptiveRecipient(recipientPart string, ...) *DeleteCaptiveRecipientOp
- func (s *Service) ENoteConfigurationsDelete() *ENoteConfigurationsDeleteOp
- func (s *Service) ENoteConfigurationsGet() *ENoteConfigurationsGetOp
- func (s *Service) ENoteConfigurationsUpdate(eNoteConfigurations *model.ENoteConfiguration) *ENoteConfigurationsUpdateOp
- func (s *Service) Get() *GetOp
- func (s *Service) GetBillingCharges() *GetBillingChargesOp
- func (s *Service) GetProvisioning() *GetProvisioningOp
- func (s *Service) IdentityVerificationsList() *IdentityVerificationsListOp
- func (s *Service) ListRecipientNamesByEmail() *ListRecipientNamesByEmailOp
- func (s *Service) ListSettings() *ListSettingsOp
- func (s *Service) ListSharedAccess() *ListSharedAccessOp
- func (s *Service) ListSupportedLanguages() *ListSupportedLanguagesOp
- func (s *Service) ListUnsupportedFileTypes() *ListUnsupportedFileTypesOp
- func (s *Service) PasswordRulesGet() *PasswordRulesGetOp
- func (s *Service) PasswordRulesGetForUser() *PasswordRulesGetForUserOp
- func (s *Service) PasswordRulesUpdate(accountPasswordRules *model.AccountPasswordRules) *PasswordRulesUpdateOp
- func (s *Service) PaymentGatewayAccountsList() *PaymentGatewayAccountsListOp
- func (s *Service) PermissionProfilesCreate(accountPermissionProfiles *model.PermissionProfile) *PermissionProfilesCreateOp
- func (s *Service) PermissionProfilesDelete(permissionProfileID string) *PermissionProfilesDeleteOp
- func (s *Service) PermissionProfilesGet(permissionProfileID string) *PermissionProfilesGetOp
- func (s *Service) PermissionProfilesList() *PermissionProfilesListOp
- func (s *Service) PermissionProfilesUpdate(permissionProfileID string, accountPermissionProfiles *model.PermissionProfile) *PermissionProfilesUpdateOp
- func (s *Service) SealProvidersList() *SealProvidersListOp
- func (s *Service) SignatureProvidersList() *SignatureProvidersListOp
- func (s *Service) TabSettingsGet() *TabSettingsGetOp
- func (s *Service) TabSettingsUpdate(accountTabSettings *model.TabAccountSettings) *TabSettingsUpdateOp
- func (s *Service) UpdateSettings(accountSettingsInformation *model.AccountSettingsInformation) *UpdateSettingsOp
- func (s *Service) UpdateSharedAccess(accountSharedAccess *model.AccountSharedAccess) *UpdateSharedAccessOp
- func (s *Service) WatermarksGet() *WatermarksGetOp
- func (s *Service) WatermarksPreview(accountWatermarks *model.Watermark) *WatermarksPreviewOp
- func (s *Service) WatermarksUpdate(accountWatermarks *model.Watermark) *WatermarksUpdateOp
- type SignatureProvidersListOp
- type TabSettingsGetOp
- type TabSettingsUpdateOp
- type UpdateSettingsOp
- type UpdateSharedAccessOp
- type WatermarksGetOp
- type WatermarksPreviewOp
- type WatermarksUpdateOp
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type BrandsCreateOp ¶
BrandsCreateOp implements DocuSign API SDK Accounts::createBrand
func (*BrandsCreateOp) Do ¶
func (op *BrandsCreateOp) Do(ctx context.Context) (*model.BrandsResponse, error)
Do executes the op. A nil context will return error.
type BrandsDeleteListOp ¶
BrandsDeleteListOp implements DocuSign API SDK Accounts::deleteBrands
func (*BrandsDeleteListOp) Do ¶
func (op *BrandsDeleteListOp) Do(ctx context.Context) (*model.BrandsResponse, error)
Do executes the op. A nil context will return error.
type BrandsDeleteLogoOp ¶
BrandsDeleteLogoOp implements DocuSign API SDK Accounts::deleteBrandLogoByType
type BrandsDeleteOp ¶
BrandsDeleteOp implements DocuSign API SDK Accounts::deleteBrand
type BrandsGetExportFileOp ¶
BrandsGetExportFileOp implements DocuSign API SDK Accounts::getBrandExportFile
type BrandsGetLogoOp ¶
BrandsGetLogoOp implements DocuSign API SDK Accounts::getBrandLogoByType
type BrandsGetOp ¶
BrandsGetOp implements DocuSign API SDK Accounts::getBrand
func (*BrandsGetOp) IncludeExternalReferences ¶
func (op *BrandsGetOp) IncludeExternalReferences() *BrandsGetOp
IncludeExternalReferences set the call query parameter include_external_references
func (*BrandsGetOp) IncludeLogos ¶
func (op *BrandsGetOp) IncludeLogos() *BrandsGetOp
IncludeLogos set the call query parameter include_logos
type BrandsGetResourceOp ¶
BrandsGetResourceOp implements DocuSign API SDK Accounts::getBrandResourcesByContentType
func (*BrandsGetResourceOp) Langcode ¶
func (op *BrandsGetResourceOp) Langcode(val string) *BrandsGetResourceOp
Langcode set the call query parameter langcode
func (*BrandsGetResourceOp) ReturnMaster ¶
func (op *BrandsGetResourceOp) ReturnMaster() *BrandsGetResourceOp
ReturnMaster set the call query parameter return_master
type BrandsListOp ¶
BrandsListOp implements DocuSign API SDK Accounts::listBrands
func (*BrandsListOp) Do ¶
func (op *BrandsListOp) Do(ctx context.Context) (*model.BrandsResponse, error)
Do executes the op. A nil context will return error.
func (*BrandsListOp) ExcludeDistributorBrand ¶
func (op *BrandsListOp) ExcludeDistributorBrand() *BrandsListOp
ExcludeDistributorBrand when set to **true**, excludes distributor brand information from the response set.
func (*BrandsListOp) IncludeLogos ¶
func (op *BrandsListOp) IncludeLogos() *BrandsListOp
IncludeLogos when set to **true**, returns the logos associated with the brand.
type BrandsListResourcesOp ¶
BrandsListResourcesOp implements DocuSign API SDK Accounts::getBrandResources
func (*BrandsListResourcesOp) Do ¶
func (op *BrandsListResourcesOp) Do(ctx context.Context) (*model.BrandResourcesList, error)
Do executes the op. A nil context will return error.
type BrandsUpdateLogoOp ¶
BrandsUpdateLogoOp implements DocuSign API SDK Accounts::updateBrandLogoByType
type BrandsUpdateOp ¶
BrandsUpdateOp implements DocuSign API SDK Accounts::updateBrand
type BrandsUpdateResourceOp ¶
BrandsUpdateResourceOp implements DocuSign API SDK Accounts::updateBrandResourcesByContentType
func (*BrandsUpdateResourceOp) Do ¶
func (op *BrandsUpdateResourceOp) Do(ctx context.Context) (*model.BrandResources, error)
Do executes the op. A nil context will return error.
type ConsumerDisclosuresGetDefaultOp ¶
ConsumerDisclosuresGetDefaultOp implements DocuSign API SDK Accounts::getConsumerDisclosureDefault
func (*ConsumerDisclosuresGetDefaultOp) Do ¶
func (op *ConsumerDisclosuresGetDefaultOp) Do(ctx context.Context) (*model.ConsumerDisclosure, error)
Do executes the op. A nil context will return error.
func (*ConsumerDisclosuresGetDefaultOp) LangCode ¶
func (op *ConsumerDisclosuresGetDefaultOp) LangCode(val string) *ConsumerDisclosuresGetDefaultOp
LangCode specifies the language used in the response. The supported languages, with the language value shown in parenthesis, are: Arabic (ar), 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.
type ConsumerDisclosuresGetOp ¶
ConsumerDisclosuresGetOp implements DocuSign API SDK Accounts::getConsumerDisclosure
func (*ConsumerDisclosuresGetOp) Do ¶
func (op *ConsumerDisclosuresGetOp) Do(ctx context.Context) (*model.ConsumerDisclosure, error)
Do executes the op. A nil context will return error.
type ConsumerDisclosuresUpdateOp ¶
ConsumerDisclosuresUpdateOp implements DocuSign API SDK Accounts::updateConsumerDisclosure
func (*ConsumerDisclosuresUpdateOp) Do ¶
func (op *ConsumerDisclosuresUpdateOp) Do(ctx context.Context) (*model.ConsumerDisclosure, error)
Do executes the op. A nil context will return error.
func (*ConsumerDisclosuresUpdateOp) IncludeMetadata ¶
func (op *ConsumerDisclosuresUpdateOp) IncludeMetadata(val string) *ConsumerDisclosuresUpdateOp
IncludeMetadata reserved for DocuSign.
type CreateOp ¶
CreateOp implements DocuSign API SDK Accounts::create
func (*CreateOp) PreviewBillingPlan ¶
PreviewBillingPlan when set to **true**, creates the account using a preview billing plan.
type CustomFieldsCreateOp ¶
CustomFieldsCreateOp implements DocuSign API SDK Accounts::createCustomField
func (*CustomFieldsCreateOp) ApplyToTemplates ¶
func (op *CustomFieldsCreateOp) ApplyToTemplates() *CustomFieldsCreateOp
ApplyToTemplates set the call query parameter apply_to_templates
func (*CustomFieldsCreateOp) Do ¶
func (op *CustomFieldsCreateOp) Do(ctx context.Context) (*model.CustomFields, error)
Do executes the op. A nil context will return error.
type CustomFieldsDeleteOp ¶
CustomFieldsDeleteOp implements DocuSign API SDK Accounts::deleteCustomField
func (*CustomFieldsDeleteOp) ApplyToTemplates ¶
func (op *CustomFieldsDeleteOp) ApplyToTemplates() *CustomFieldsDeleteOp
ApplyToTemplates set the call query parameter apply_to_templates
type CustomFieldsListOp ¶
CustomFieldsListOp implements DocuSign API SDK Accounts::listCustomFields
func (*CustomFieldsListOp) Do ¶
func (op *CustomFieldsListOp) Do(ctx context.Context) (*model.CustomFields, error)
Do executes the op. A nil context will return error.
type CustomFieldsUpdateOp ¶
CustomFieldsUpdateOp implements DocuSign API SDK Accounts::updateCustomField
func (*CustomFieldsUpdateOp) ApplyToTemplates ¶
func (op *CustomFieldsUpdateOp) ApplyToTemplates() *CustomFieldsUpdateOp
ApplyToTemplates set the call query parameter apply_to_templates
func (*CustomFieldsUpdateOp) Do ¶
func (op *CustomFieldsUpdateOp) Do(ctx context.Context) (*model.CustomFields, error)
Do executes the op. A nil context will return error.
type DeleteCaptiveRecipientOp ¶
DeleteCaptiveRecipientOp implements DocuSign API SDK Accounts::deleteCaptiveRecipient
func (*DeleteCaptiveRecipientOp) Do ¶
func (op *DeleteCaptiveRecipientOp) Do(ctx context.Context) (*model.CaptiveRecipientInformation, error)
Do executes the op. A nil context will return error.
type ENoteConfigurationsDeleteOp ¶
ENoteConfigurationsDeleteOp implements DocuSign API SDK Accounts::deleteENoteConfiguration
type ENoteConfigurationsGetOp ¶
ENoteConfigurationsGetOp implements DocuSign API SDK Accounts::getENoteConfiguration
func (*ENoteConfigurationsGetOp) Do ¶
func (op *ENoteConfigurationsGetOp) Do(ctx context.Context) (*model.ENoteConfiguration, error)
Do executes the op. A nil context will return error.
type ENoteConfigurationsUpdateOp ¶
ENoteConfigurationsUpdateOp implements DocuSign API SDK Accounts::updateENoteConfiguration
func (*ENoteConfigurationsUpdateOp) Do ¶
func (op *ENoteConfigurationsUpdateOp) Do(ctx context.Context) (*model.ENoteConfiguration, error)
Do executes the op. A nil context will return error.
type GetBillingChargesOp ¶
GetBillingChargesOp implements DocuSign API SDK Accounts::getBillingCharges
func (*GetBillingChargesOp) Do ¶
func (op *GetBillingChargesOp) Do(ctx context.Context) (*model.BillingChargeResponse, error)
Do executes the op. A nil context will return error.
func (*GetBillingChargesOp) IncludeCharges ¶
func (op *GetBillingChargesOp) IncludeCharges(val string) *GetBillingChargesOp
IncludeCharges specifies which billing charges to return. Valid values are:
* envelopes * seats
type GetOp ¶
GetOp implements DocuSign API SDK Accounts::GetAccountInformation
func (*GetOp) IncludeAccountSettings ¶
IncludeAccountSettings when set to **true**, includes the account settings for the account in the response.
type GetProvisioningOp ¶
GetProvisioningOp implements DocuSign API SDK Accounts::getProvisioning
func (*GetProvisioningOp) Do ¶
func (op *GetProvisioningOp) Do(ctx context.Context) (*model.ProvisioningInformation, error)
Do executes the op. A nil context will return error.
type IdentityVerificationsListOp ¶
IdentityVerificationsListOp implements DocuSign API SDK Accounts::getAccountIdentityVerification
func (*IdentityVerificationsListOp) Do ¶
func (op *IdentityVerificationsListOp) Do(ctx context.Context) (*model.AccountIdentityVerificationResponse, error)
Do executes the op. A nil context will return error.
type ListRecipientNamesByEmailOp ¶
ListRecipientNamesByEmailOp implements DocuSign API SDK Accounts::listRecipientNamesByEmail
func (*ListRecipientNamesByEmailOp) Do ¶
func (op *ListRecipientNamesByEmailOp) Do(ctx context.Context) (*model.RecipientNamesResponse, error)
Do executes the op. A nil context will return error.
func (*ListRecipientNamesByEmailOp) Email ¶
func (op *ListRecipientNamesByEmailOp) Email(val string) *ListRecipientNamesByEmailOp
Email is the email address for the user
type ListSettingsOp ¶
ListSettingsOp implements DocuSign API SDK Accounts::listSettings
func (*ListSettingsOp) Do ¶
func (op *ListSettingsOp) Do(ctx context.Context) (*model.AccountSettingsInformation, error)
Do executes the op. A nil context will return error.
type ListSharedAccessOp ¶
ListSharedAccessOp implements DocuSign API SDK Accounts::listSharedAccess
func (*ListSharedAccessOp) Count ¶
func (op *ListSharedAccessOp) Count(val int) *ListSharedAccessOp
Count specifies maximum number of results included in the response. If no value is specified, this defaults to 1000.
func (*ListSharedAccessOp) Do ¶
func (op *ListSharedAccessOp) Do(ctx context.Context) (*model.AccountSharedAccess, error)
Do executes the op. A nil context will return error.
func (*ListSharedAccessOp) EnvelopesNotSharedUserStatus ¶
func (op *ListSharedAccessOp) EnvelopesNotSharedUserStatus(val string) *ListSharedAccessOp
EnvelopesNotSharedUserStatus set the call query parameter envelopes_not_shared_user_status
func (*ListSharedAccessOp) FolderIds ¶
func (op *ListSharedAccessOp) FolderIds(val ...string) *ListSharedAccessOp
FolderIds is a comma separated list of folder IDs for which the shared item information is being requested.
If `item_type` is `folders`, at least one folder ID is required.
func (*ListSharedAccessOp) ItemType ¶
func (op *ListSharedAccessOp) ItemType(val string) *ListSharedAccessOp
ItemType specifies the type of shared item being requested. The possible values are:
- `envelopes`: Get information about envelope sharing between users. - `templates`: Get information about template sharing among users and groups. - `folders`: Get information about folder sharing among users and groups.
func (*ListSharedAccessOp) SearchText ¶
func (op *ListSharedAccessOp) SearchText(val string) *ListSharedAccessOp
SearchText this can be used to filter user names in the response. The wild-card '*' (asterisk) can be used around the string.
func (*ListSharedAccessOp) Shared ¶
func (op *ListSharedAccessOp) Shared(val string) *ListSharedAccessOp
Shared is a comma-separated list of sharing filters that specifies which users appear in the response.
- `not_shared`: The response contains users who do not share items of `item_type` with the current user.
- `shared_to`: The response contains users in `user_list` who are sharing items to current user.
- `shared_from`: The response contains users in `user_list` who are sharing items from the current user.
- `shared_to_and_from`: The response contains users in `user_list` who are sharing items to and sharing items from the current user.
If the current user does not have administrative privileges, only the `shared_to` option is valid.
func (*ListSharedAccessOp) StartPosition ¶
func (op *ListSharedAccessOp) StartPosition(val int) *ListSharedAccessOp
StartPosition if the number of responses is greater than `count`, the number of responses to skip. Typically this value is a multiple of `count`. Default: 0.
func (*ListSharedAccessOp) UserIds ¶
func (op *ListSharedAccessOp) UserIds(val ...string) *ListSharedAccessOp
UserIds is a comma-separated list of user IDs for whom the shared item information is being requested.
type ListSupportedLanguagesOp ¶
ListSupportedLanguagesOp implements DocuSign API SDK Accounts::getSupportedLanguages
func (*ListSupportedLanguagesOp) Do ¶
func (op *ListSupportedLanguagesOp) Do(ctx context.Context) (*model.SupportedLanguages, error)
Do executes the op. A nil context will return error.
type ListUnsupportedFileTypesOp ¶
ListUnsupportedFileTypesOp implements DocuSign API SDK Accounts::listUnsupportedFileTypes
func (*ListUnsupportedFileTypesOp) Do ¶
func (op *ListUnsupportedFileTypesOp) Do(ctx context.Context) (*model.FileTypeList, error)
Do executes the op. A nil context will return error.
type PasswordRulesGetForUserOp ¶
PasswordRulesGetForUserOp implements DocuSign API SDK Accounts::getPasswordRules
func (*PasswordRulesGetForUserOp) Do ¶
func (op *PasswordRulesGetForUserOp) Do(ctx context.Context) (*model.UserPasswordRules, error)
Do executes the op. A nil context will return error.
type PasswordRulesGetOp ¶
PasswordRulesGetOp implements DocuSign API SDK Accounts::getAccountPasswordRules
func (*PasswordRulesGetOp) Do ¶
func (op *PasswordRulesGetOp) Do(ctx context.Context) (*model.AccountPasswordRules, error)
Do executes the op. A nil context will return error.
type PasswordRulesUpdateOp ¶
PasswordRulesUpdateOp implements DocuSign API SDK Accounts::updateAccountPasswordRules
func (*PasswordRulesUpdateOp) Do ¶
func (op *PasswordRulesUpdateOp) Do(ctx context.Context) (*model.AccountPasswordRules, error)
Do executes the op. A nil context will return error.
type PaymentGatewayAccountsListOp ¶
PaymentGatewayAccountsListOp implements DocuSign API SDK Accounts::getAllPaymentGatewayAccounts
func (*PaymentGatewayAccountsListOp) Do ¶
func (op *PaymentGatewayAccountsListOp) Do(ctx context.Context) (*model.PaymentGatewayAccountsInfo, error)
Do executes the op. A nil context will return error.
type PermissionProfilesCreateOp ¶
PermissionProfilesCreateOp implements DocuSign API SDK Accounts::createPermissionProfile
func (*PermissionProfilesCreateOp) Do ¶
func (op *PermissionProfilesCreateOp) Do(ctx context.Context) (*model.PermissionProfile, error)
Do executes the op. A nil context will return error.
func (*PermissionProfilesCreateOp) Include ¶
func (op *PermissionProfilesCreateOp) Include(val ...string) *PermissionProfilesCreateOp
Include is a comma-separated list of additional template attributes to include in the response. Valid values are: recipients, folders, documents, custom_fields, and notifications.
type PermissionProfilesDeleteOp ¶
PermissionProfilesDeleteOp implements DocuSign API SDK Accounts::deletePermissionProfile
type PermissionProfilesGetOp ¶
PermissionProfilesGetOp implements DocuSign API SDK Accounts::getPermissionProfile
func (*PermissionProfilesGetOp) Do ¶
func (op *PermissionProfilesGetOp) Do(ctx context.Context) (*model.PermissionProfile, error)
Do executes the op. A nil context will return error.
func (*PermissionProfilesGetOp) Include ¶
func (op *PermissionProfilesGetOp) Include(val ...string) *PermissionProfilesGetOp
Include is a comma-separated list of additional template attributes to include in the response. Valid values are: recipients, folders, documents, custom_fields, and notifications.
type PermissionProfilesListOp ¶
PermissionProfilesListOp implements DocuSign API SDK Accounts::listPermissions
func (*PermissionProfilesListOp) Do ¶
func (op *PermissionProfilesListOp) Do(ctx context.Context) (*model.PermissionProfileInformation, error)
Do executes the op. A nil context will return error.
func (*PermissionProfilesListOp) Include ¶
func (op *PermissionProfilesListOp) Include(val string) *PermissionProfilesListOp
Include reserved for DocuSign.
type PermissionProfilesUpdateOp ¶
PermissionProfilesUpdateOp implements DocuSign API SDK Accounts::updatePermissionProfile
func (*PermissionProfilesUpdateOp) Do ¶
func (op *PermissionProfilesUpdateOp) Do(ctx context.Context) (*model.PermissionProfile, error)
Do executes the op. A nil context will return error.
func (*PermissionProfilesUpdateOp) Include ¶
func (op *PermissionProfilesUpdateOp) Include(val ...string) *PermissionProfilesUpdateOp
Include is a comma-separated list of additional template attributes to include in the response. Valid values are: recipients, folders, documents, custom_fields, and notifications.
type SealProvidersListOp ¶
SealProvidersListOp implements DocuSign API SDK Accounts::getSealProviders
func (*SealProvidersListOp) Do ¶
func (op *SealProvidersListOp) Do(ctx context.Context) (*model.AccountSeals, error)
Do executes the op. A nil context will return error.
type Service ¶
type Service struct {
// contains filtered or unexported fields
}
Service implements DocuSign Accounts Category API operations
func New ¶
func New(cred esign.Credential) *Service
New initializes a accounts service using cred to authorize ops.
func (*Service) BrandsCreate ¶
func (s *Service) BrandsCreate(brand *model.Brand) *BrandsCreateOp
BrandsCreate creates one or more brand profile files for the account.
https://developers.docusign.com/esign-rest-api/v2/reference/accounts/accountbrands/create
SDK Method Accounts::createBrand
func (*Service) BrandsDelete ¶
func (s *Service) BrandsDelete(brandID string) *BrandsDeleteOp
BrandsDelete removes a brand.
https://developers.docusign.com/esign-rest-api/v2/reference/accounts/accountbrands/delete
SDK Method Accounts::deleteBrand
func (*Service) BrandsDeleteList ¶
func (s *Service) BrandsDeleteList(brandsRequest *model.BrandsRequest) *BrandsDeleteListOp
BrandsDeleteList deletes one or more brand profiles.
https://developers.docusign.com/esign-rest-api/v2/reference/accounts/accountbrands/deletelist
SDK Method Accounts::deleteBrands
func (*Service) BrandsDeleteLogo ¶
func (s *Service) BrandsDeleteLogo(brandID string, logoType string) *BrandsDeleteLogoOp
BrandsDeleteLogo delete one branding logo.
https://developers.docusign.com/esign-rest-api/v2/reference/accounts/accountbrands/deletelogo
SDK Method Accounts::deleteBrandLogoByType
func (*Service) BrandsGet ¶
func (s *Service) BrandsGet(brandID string) *BrandsGetOp
BrandsGet get information for a specific brand.
https://developers.docusign.com/esign-rest-api/v2/reference/accounts/accountbrands/get
SDK Method Accounts::getBrand
func (*Service) BrandsGetExportFile ¶
func (s *Service) BrandsGetExportFile(brandID string) *BrandsGetExportFileOp
BrandsGetExportFile export a specific brand.
https://developers.docusign.com/esign-rest-api/v2/reference/accounts/accountbrands/getexportfile
SDK Method Accounts::getBrandExportFile
func (*Service) BrandsGetLogo ¶
func (s *Service) BrandsGetLogo(brandID string, logoType string) *BrandsGetLogoOp
BrandsGetLogo obtains the specified image for a brand.
https://developers.docusign.com/esign-rest-api/v2/reference/accounts/accountbrands/getlogo
SDK Method Accounts::getBrandLogoByType
func (*Service) BrandsGetResource ¶
func (s *Service) BrandsGetResource(brandID string, resourceContentType string) *BrandsGetResourceOp
BrandsGetResource returns the specified branding resource file.
https://developers.docusign.com/esign-rest-api/v2/reference/accounts/accountbrands/getresource
SDK Method Accounts::getBrandResourcesByContentType
func (*Service) BrandsList ¶
func (s *Service) BrandsList() *BrandsListOp
BrandsList gets a list of brand profiles.
https://developers.docusign.com/esign-rest-api/v2/reference/accounts/accountbrands/list
SDK Method Accounts::listBrands
func (*Service) BrandsListResources ¶
func (s *Service) BrandsListResources(brandID string) *BrandsListResourcesOp
BrandsListResources returns the specified account's list of branding resources (metadata).
https://developers.docusign.com/esign-rest-api/v2/reference/accounts/accountbrands/listresources
SDK Method Accounts::getBrandResources
func (*Service) BrandsUpdate ¶
func (s *Service) BrandsUpdate(brandID string, brand *model.Brand) *BrandsUpdateOp
BrandsUpdate updates an existing brand.
https://developers.docusign.com/esign-rest-api/v2/reference/accounts/accountbrands/update
SDK Method Accounts::updateBrand
func (*Service) BrandsUpdateLogo ¶
func (s *Service) BrandsUpdateLogo(brandID string, logoType string, logoFileBytes []byte) *BrandsUpdateLogoOp
BrandsUpdateLogo put one branding logo.
https://developers.docusign.com/esign-rest-api/v2/reference/accounts/accountbrands/updatelogo
SDK Method Accounts::updateBrandLogoByType
func (*Service) BrandsUpdateResource ¶
func (s *Service) BrandsUpdateResource(brandID string, resourceContentType string, media io.Reader, mimeType string) *BrandsUpdateResourceOp
BrandsUpdateResource uploads a branding resource file. If media is an io.ReadCloser, Do() will close media.
https://developers.docusign.com/esign-rest-api/v2/reference/accounts/accountbrands/updateresource
SDK Method Accounts::updateBrandResourcesByContentType
func (*Service) ConsumerDisclosuresGet ¶
func (s *Service) ConsumerDisclosuresGet(langCode string) *ConsumerDisclosuresGetOp
ConsumerDisclosuresGet gets the Electronic Record and Signature Disclosure.
https://developers.docusign.com/esign-rest-api/v2/reference/accounts/accountconsumerdisclosures/get
SDK Method Accounts::getConsumerDisclosure
func (*Service) ConsumerDisclosuresGetDefault ¶
func (s *Service) ConsumerDisclosuresGetDefault() *ConsumerDisclosuresGetDefaultOp
ConsumerDisclosuresGetDefault gets the Electronic Record and Signature Disclosure for the account.
SDK Method Accounts::getConsumerDisclosureDefault
func (*Service) ConsumerDisclosuresUpdate ¶
func (s *Service) ConsumerDisclosuresUpdate(langCode string, envelopeConsumerDisclosures *model.ConsumerDisclosure) *ConsumerDisclosuresUpdateOp
ConsumerDisclosuresUpdate update Consumer Disclosure.
SDK Method Accounts::updateConsumerDisclosure
func (*Service) Create ¶
func (s *Service) Create(newAccountDefinition *model.NewAccountDefinition) *CreateOp
Create creates new accounts.
https://developers.docusign.com/esign-rest-api/v2/reference/accounts/accounts/create
SDK Method Accounts::create
func (*Service) CustomFieldsCreate ¶
func (s *Service) CustomFieldsCreate(customField *model.CustomField) *CustomFieldsCreateOp
CustomFieldsCreate creates an acount custom field.
https://developers.docusign.com/esign-rest-api/v2/reference/accounts/accountcustomfields/create
SDK Method Accounts::createCustomField
func (*Service) CustomFieldsDelete ¶
func (s *Service) CustomFieldsDelete(customFieldID string) *CustomFieldsDeleteOp
CustomFieldsDelete delete an existing account custom field.
https://developers.docusign.com/esign-rest-api/v2/reference/accounts/accountcustomfields/delete
SDK Method Accounts::deleteCustomField
func (*Service) CustomFieldsList ¶
func (s *Service) CustomFieldsList() *CustomFieldsListOp
CustomFieldsList gets a list of custom fields associated with the account.
https://developers.docusign.com/esign-rest-api/v2/reference/accounts/accountcustomfields/list
SDK Method Accounts::listCustomFields
func (*Service) CustomFieldsUpdate ¶
func (s *Service) CustomFieldsUpdate(customFieldID string, customField *model.CustomField) *CustomFieldsUpdateOp
CustomFieldsUpdate updates an existing account custom field.
https://developers.docusign.com/esign-rest-api/v2/reference/accounts/accountcustomfields/update
SDK Method Accounts::updateCustomField
func (*Service) Delete ¶
Delete deletes the specified account.
https://developers.docusign.com/esign-rest-api/v2/reference/accounts/accounts/delete
SDK Method Accounts::delete
func (*Service) DeleteCaptiveRecipient ¶
func (s *Service) DeleteCaptiveRecipient(recipientPart string, captiveRecipientInformation *model.CaptiveRecipientInformation) *DeleteCaptiveRecipientOp
DeleteCaptiveRecipient deletes the signature for one or more captive recipient records.
https://developers.docusign.com/esign-rest-api/v2/reference/accounts/accounts/deletecaptiverecipient
SDK Method Accounts::deleteCaptiveRecipient
func (*Service) ENoteConfigurationsDelete ¶
func (s *Service) ENoteConfigurationsDelete() *ENoteConfigurationsDeleteOp
ENoteConfigurationsDelete deletes configuration information for the eNote eOriginal integration.
https://developers.docusign.com/esign-rest-api/v2/reference/accounts/enoteconfigurations/delete
SDK Method Accounts::deleteENoteConfiguration
func (*Service) ENoteConfigurationsGet ¶
func (s *Service) ENoteConfigurationsGet() *ENoteConfigurationsGetOp
ENoteConfigurationsGet returns the configuration information for the eNote eOriginal integration.
https://developers.docusign.com/esign-rest-api/v2/reference/accounts/enoteconfigurations/get
SDK Method Accounts::getENoteConfiguration
func (*Service) ENoteConfigurationsUpdate ¶
func (s *Service) ENoteConfigurationsUpdate(eNoteConfigurations *model.ENoteConfiguration) *ENoteConfigurationsUpdateOp
ENoteConfigurationsUpdate updates configuration information for the eNote eOriginal integration.
https://developers.docusign.com/esign-rest-api/v2/reference/accounts/enoteconfigurations/update
SDK Method Accounts::updateENoteConfiguration
func (*Service) Get ¶
Get retrieves the account information for the specified account.
https://developers.docusign.com/esign-rest-api/v2/reference/accounts/accounts/get
SDK Method Accounts::GetAccountInformation
func (*Service) GetBillingCharges ¶
func (s *Service) GetBillingCharges() *GetBillingChargesOp
GetBillingCharges gets list of recurring and usage charges for the account.
https://developers.docusign.com/esign-rest-api/v2/reference/accounts/accounts/getbillingcharges
SDK Method Accounts::getBillingCharges
func (*Service) GetProvisioning ¶
func (s *Service) GetProvisioning() *GetProvisioningOp
GetProvisioning retrieves the account provisioning information for the account.
https://developers.docusign.com/esign-rest-api/v2/reference/accounts/accounts/getprovisioning
SDK Method Accounts::getProvisioning
func (*Service) IdentityVerificationsList ¶
func (s *Service) IdentityVerificationsList() *IdentityVerificationsListOp
IdentityVerificationsList is SDK Method Accounts::getAccountIdentityVerification
https://developers.docusign.com/esign/restapi/Accounts/IdentityVerifications/list
func (*Service) ListRecipientNamesByEmail ¶
func (s *Service) ListRecipientNamesByEmail() *ListRecipientNamesByEmailOp
ListRecipientNamesByEmail gets recipient names associated with an email address.
SDK Method Accounts::listRecipientNamesByEmail
func (*Service) ListSettings ¶
func (s *Service) ListSettings() *ListSettingsOp
ListSettings gets account settings information.
https://developers.docusign.com/esign-rest-api/v2/reference/accounts/accounts/listsettings
SDK Method Accounts::listSettings
func (*Service) ListSharedAccess ¶
func (s *Service) ListSharedAccess() *ListSharedAccessOp
ListSharedAccess reserved: Gets the shared item status for one or more users.
https://developers.docusign.com/esign-rest-api/v2/reference/accounts/accounts/listsharedaccess
SDK Method Accounts::listSharedAccess
func (*Service) ListSupportedLanguages ¶
func (s *Service) ListSupportedLanguages() *ListSupportedLanguagesOp
ListSupportedLanguages list supported languages for the recipient language setting
https://developers.docusign.com/esign-rest-api/v2/reference/accounts/accounts/listsupportedlanguages
SDK Method Accounts::getSupportedLanguages
func (*Service) ListUnsupportedFileTypes ¶
func (s *Service) ListUnsupportedFileTypes() *ListUnsupportedFileTypesOp
ListUnsupportedFileTypes gets a list of unsupported file types.
SDK Method Accounts::listUnsupportedFileTypes
func (*Service) PasswordRulesGet ¶
func (s *Service) PasswordRulesGet() *PasswordRulesGetOp
PasswordRulesGet get the password rules
https://developers.docusign.com/esign-rest-api/v2/reference/accounts/accountpasswordrules/get
SDK Method Accounts::getAccountPasswordRules
func (*Service) PasswordRulesGetForUser ¶
func (s *Service) PasswordRulesGetForUser() *PasswordRulesGetForUserOp
PasswordRulesGetForUser get membership account password rules
https://developers.docusign.com/esign-rest-api/v2/reference/accounts/accountpasswordrules/getforuser
SDK Method Accounts::getPasswordRules
func (*Service) PasswordRulesUpdate ¶
func (s *Service) PasswordRulesUpdate(accountPasswordRules *model.AccountPasswordRules) *PasswordRulesUpdateOp
PasswordRulesUpdate update the password rules
https://developers.docusign.com/esign-rest-api/v2/reference/accounts/accountpasswordrules/update
SDK Method Accounts::updateAccountPasswordRules
func (*Service) PaymentGatewayAccountsList ¶
func (s *Service) PaymentGatewayAccountsList() *PaymentGatewayAccountsListOp
PaymentGatewayAccountsList list payment gateway account information
https://developers.docusign.com/esign-rest-api/v2/reference/accounts/paymentgatewayaccounts/list
SDK Method Accounts::getAllPaymentGatewayAccounts
func (*Service) PermissionProfilesCreate ¶
func (s *Service) PermissionProfilesCreate(accountPermissionProfiles *model.PermissionProfile) *PermissionProfilesCreateOp
PermissionProfilesCreate creates a new permission profile in the specified account.
SDK Method Accounts::createPermissionProfile
func (*Service) PermissionProfilesDelete ¶
func (s *Service) PermissionProfilesDelete(permissionProfileID string) *PermissionProfilesDeleteOp
PermissionProfilesDelete deletes a permissions profile within the specified account.
SDK Method Accounts::deletePermissionProfile
func (*Service) PermissionProfilesGet ¶
func (s *Service) PermissionProfilesGet(permissionProfileID string) *PermissionProfilesGetOp
PermissionProfilesGet returns a permissions profile in the specified account.
https://developers.docusign.com/esign-rest-api/v2/reference/accounts/accountpermissionprofiles/get
SDK Method Accounts::getPermissionProfile
func (*Service) PermissionProfilesList ¶
func (s *Service) PermissionProfilesList() *PermissionProfilesListOp
PermissionProfilesList gets a list of permission profiles.
https://developers.docusign.com/esign-rest-api/v2/reference/accounts/accountpermissionprofiles/list
SDK Method Accounts::listPermissions
func (*Service) PermissionProfilesUpdate ¶
func (s *Service) PermissionProfilesUpdate(permissionProfileID string, accountPermissionProfiles *model.PermissionProfile) *PermissionProfilesUpdateOp
PermissionProfilesUpdate updates a permission profile within the specified account.
SDK Method Accounts::updatePermissionProfile
func (*Service) SealProvidersList ¶
func (s *Service) SealProvidersList() *SealProvidersListOp
SealProvidersList is SDK Method Accounts::getSealProviders
https://developers.docusign.com/esign/restapi/Accounts/AccountSealProviders/list
func (*Service) SignatureProvidersList ¶
func (s *Service) SignatureProvidersList() *SignatureProvidersListOp
SignatureProvidersList returns Account available signature providers for specified account.
https://developers.docusign.com/esign-rest-api/v2/reference/accounts/accountsignatureproviders/list
SDK Method Accounts::listSignatureProviders
func (*Service) TabSettingsGet ¶
func (s *Service) TabSettingsGet() *TabSettingsGetOp
TabSettingsGet returns tab settings list for specified account
https://developers.docusign.com/esign-rest-api/v2/reference/accounts/accounttabsettings/get
SDK Method Accounts::getAccountTabSettings
func (*Service) TabSettingsUpdate ¶
func (s *Service) TabSettingsUpdate(accountTabSettings *model.TabAccountSettings) *TabSettingsUpdateOp
TabSettingsUpdate modifies tab settings for specified account
https://developers.docusign.com/esign-rest-api/v2/reference/accounts/accounttabsettings/update
SDK Method Accounts::updateAccountTabSettings
func (*Service) UpdateSettings ¶
func (s *Service) UpdateSettings(accountSettingsInformation *model.AccountSettingsInformation) *UpdateSettingsOp
UpdateSettings updates the account settings for an account.
https://developers.docusign.com/esign-rest-api/v2/reference/accounts/accounts/updatesettings
SDK Method Accounts::updateSettings
func (*Service) UpdateSharedAccess ¶
func (s *Service) UpdateSharedAccess(accountSharedAccess *model.AccountSharedAccess) *UpdateSharedAccessOp
UpdateSharedAccess reserved: Sets the shared access information for users.
https://developers.docusign.com/esign-rest-api/v2/reference/accounts/accounts/updatesharedaccess
SDK Method Accounts::updateSharedAccess
func (*Service) WatermarksGet ¶
func (s *Service) WatermarksGet() *WatermarksGetOp
WatermarksGet get watermark information.
https://developers.docusign.com/esign-rest-api/v2/reference/accounts/accountwatermarks/get
SDK Method Accounts::getWatermark
func (*Service) WatermarksPreview ¶
func (s *Service) WatermarksPreview(accountWatermarks *model.Watermark) *WatermarksPreviewOp
WatermarksPreview get watermark preview.
https://developers.docusign.com/esign-rest-api/v2/reference/accounts/accountwatermarks/preview
SDK Method Accounts::getWatermarkPreview
func (*Service) WatermarksUpdate ¶
func (s *Service) WatermarksUpdate(accountWatermarks *model.Watermark) *WatermarksUpdateOp
WatermarksUpdate update watermark information.
https://developers.docusign.com/esign-rest-api/v2/reference/accounts/accountwatermarks/update
SDK Method Accounts::updateWatermark
type SignatureProvidersListOp ¶
SignatureProvidersListOp implements DocuSign API SDK Accounts::listSignatureProviders
func (*SignatureProvidersListOp) Do ¶
func (op *SignatureProvidersListOp) Do(ctx context.Context) (*model.AccountSignatureProviders, error)
Do executes the op. A nil context will return error.
type TabSettingsGetOp ¶
TabSettingsGetOp implements DocuSign API SDK Accounts::getAccountTabSettings
func (*TabSettingsGetOp) Do ¶
func (op *TabSettingsGetOp) Do(ctx context.Context) (*model.TabAccountSettings, error)
Do executes the op. A nil context will return error.
type TabSettingsUpdateOp ¶
TabSettingsUpdateOp implements DocuSign API SDK Accounts::updateAccountTabSettings
func (*TabSettingsUpdateOp) Do ¶
func (op *TabSettingsUpdateOp) Do(ctx context.Context) (*model.TabAccountSettings, error)
Do executes the op. A nil context will return error.
type UpdateSettingsOp ¶
UpdateSettingsOp implements DocuSign API SDK Accounts::updateSettings
type UpdateSharedAccessOp ¶
UpdateSharedAccessOp implements DocuSign API SDK Accounts::updateSharedAccess
func (*UpdateSharedAccessOp) Do ¶
func (op *UpdateSharedAccessOp) Do(ctx context.Context) (*model.AccountSharedAccess, error)
Do executes the op. A nil context will return error.
func (*UpdateSharedAccessOp) ItemType ¶
func (op *UpdateSharedAccessOp) ItemType(val string) *UpdateSharedAccessOp
ItemType specifies the type of shared item being requested. The possible values are:
- `envelopes`: Get information about envelope sharing between users. - `templates`: Get information about template sharing among users and groups. - `folders`: Get information about folder sharing among users and groups.
func (*UpdateSharedAccessOp) UserIds ¶
func (op *UpdateSharedAccessOp) UserIds(val ...string) *UpdateSharedAccessOp
UserIds is a comma-separated list of user IDs whose shared item information is being set.
type WatermarksGetOp ¶
WatermarksGetOp implements DocuSign API SDK Accounts::getWatermark
type WatermarksPreviewOp ¶
WatermarksPreviewOp implements DocuSign API SDK Accounts::getWatermarkPreview