accounts

package
v0.10.0 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Jun 13, 2021 License: BSD-3-Clause Imports: 7 Imported by: 0

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/reference/Accounts Usage example: 

import (
    "github.com/ICGGroup/esign"
    "github.com/ICGGroup/esign/v2.1/accounts"
    "github.com/ICGGroup/esign/v2.1/model"
)
...
accountsService := accounts.New(esignCredential)

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type BrandsCreateOp 

type BrandsCreateOp esign.Op

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 

type BrandsDeleteListOp esign.Op

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 

type BrandsDeleteLogoOp esign.Op

BrandsDeleteLogoOp implements DocuSign API SDK Accounts::deleteBrandLogoByType

func (*BrandsDeleteLogoOp) Do 

func (op *BrandsDeleteLogoOp) Do(ctx context.Context) error

Do executes the op. A nil context will return error.

type BrandsDeleteOp 

type BrandsDeleteOp esign.Op

BrandsDeleteOp implements DocuSign API SDK Accounts::deleteBrand

func (*BrandsDeleteOp) Do 

func (op *BrandsDeleteOp) Do(ctx context.Context) error

Do executes the op. A nil context will return error.

type BrandsGetExportFileOp 

type BrandsGetExportFileOp esign.Op

BrandsGetExportFileOp implements DocuSign API SDK Accounts::getBrandExportFile

func (*BrandsGetExportFileOp) Do 

func (op *BrandsGetExportFileOp) Do(ctx context.Context) (*esign.Download, error)

Do executes the op. A nil context will return error.

type BrandsGetLogoOp 

type BrandsGetLogoOp esign.Op

BrandsGetLogoOp implements DocuSign API SDK Accounts::getBrandLogoByType

func (*BrandsGetLogoOp) Do 

func (op *BrandsGetLogoOp) Do(ctx context.Context) (*esign.Download, error)

Do executes the op. A nil context will return error.

type BrandsGetOp 

type BrandsGetOp esign.Op

BrandsGetOp implements DocuSign API SDK Accounts::getBrand

func (*BrandsGetOp) Do 

func (op *BrandsGetOp) Do(ctx context.Context) (*model.Brand, error)

Do executes the op. A nil context will return error.

func (*BrandsGetOp) IncludeExternalReferences 

func (op *BrandsGetOp) IncludeExternalReferences() *BrandsGetOp

IncludeExternalReferences when **true**, the landing pages and links associated with the brand are included in the response.

func (*BrandsGetOp) IncludeLogos 

func (op *BrandsGetOp) IncludeLogos() *BrandsGetOp

IncludeLogos when **true**, the URIs for the logos associated with the brand are included in the response.

type BrandsGetResourceOp 

type BrandsGetResourceOp esign.Op

BrandsGetResourceOp implements DocuSign API SDK Accounts::getBrandResourcesByContentType

func (*BrandsGetResourceOp) Do 

func (op *BrandsGetResourceOp) Do(ctx context.Context) (*esign.Download, error)

Do executes the op. A nil context will return error.

func (*BrandsGetResourceOp) Langcode 

func (op *BrandsGetResourceOp) Langcode(val string) *BrandsGetResourceOp

Langcode is the ISO 3166-1 alpha-2 codes for the languages that the brand supports.

func (*BrandsGetResourceOp) ReturnMaster 

func (op *BrandsGetResourceOp) ReturnMaster() *BrandsGetResourceOp

ReturnMaster specifies which resource file data to return. When **true**, only the master resource file is returned. When **false**, only the elements that you modified are returned.

type BrandsListOp 

type BrandsListOp esign.Op

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 **true**, excludes distributor brand information from the response set.

func (*BrandsListOp) IncludeLogos 

func (op *BrandsListOp) IncludeLogos() *BrandsListOp

IncludeLogos when **true**, the URIs for the logos associated with the brand are included in the response.

type BrandsListResourcesOp 

type BrandsListResourcesOp esign.Op

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 

type BrandsUpdateLogoOp esign.Op

BrandsUpdateLogoOp implements DocuSign API SDK Accounts::updateBrandLogoByType

func (*BrandsUpdateLogoOp) Do 

func (op *BrandsUpdateLogoOp) Do(ctx context.Context) error

Do executes the op. A nil context will return error.

type BrandsUpdateOp 

type BrandsUpdateOp esign.Op

BrandsUpdateOp implements DocuSign API SDK Accounts::updateBrand

func (*BrandsUpdateOp) Do 

func (op *BrandsUpdateOp) Do(ctx context.Context) (*model.Brand, error)

Do executes the op. A nil context will return error.

type BrandsUpdateResourceOp 

type BrandsUpdateResourceOp esign.Op

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 

type ConsumerDisclosuresGetDefaultOp esign.Op

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 

type ConsumerDisclosuresGetOp esign.Op

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 

type ConsumerDisclosuresUpdateOp esign.Op

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 when set to **true**, the response includes metadata indicating which properties are editable.

type CreateOp 

type CreateOp esign.Op

CreateOp implements DocuSign API SDK Accounts::create

func (*CreateOp) Do 

func (op *CreateOp) Do(ctx context.Context) (*model.NewAccountSummary, error)

Do executes the op. A nil context will return error.

func (*CreateOp) PreviewBillingPlan 

func (op *CreateOp) PreviewBillingPlan() *CreateOp

PreviewBillingPlan when set to **true**, creates the account using a preview billing plan.

type CustomFieldsCreateOp 

type CustomFieldsCreateOp esign.Op

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 

type CustomFieldsDeleteOp esign.Op

CustomFieldsDeleteOp implements DocuSign API SDK Accounts::deleteCustomField

func (*CustomFieldsDeleteOp) ApplyToTemplates 

func (op *CustomFieldsDeleteOp) ApplyToTemplates() *CustomFieldsDeleteOp

ApplyToTemplates set the call query parameter apply_to_templates

func (*CustomFieldsDeleteOp) Do 

func (op *CustomFieldsDeleteOp) Do(ctx context.Context) error

Do executes the op. A nil context will return error.

type CustomFieldsListOp 

type CustomFieldsListOp esign.Op

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 

type CustomFieldsUpdateOp esign.Op

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 

type DeleteCaptiveRecipientOp esign.Op

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 DeleteOp 

type DeleteOp esign.Op

DeleteOp implements DocuSign API SDK Accounts::delete

func (*DeleteOp) Do 

func (op *DeleteOp) Do(ctx context.Context) error

Do executes the op. A nil context will return error.

type ENoteConfigurationsDeleteOp 

type ENoteConfigurationsDeleteOp esign.Op

ENoteConfigurationsDeleteOp implements DocuSign API SDK Accounts::deleteENoteConfiguration

func (*ENoteConfigurationsDeleteOp) Do 

func (op *ENoteConfigurationsDeleteOp) Do(ctx context.Context) error

Do executes the op. A nil context will return error.

type ENoteConfigurationsGetOp 

type ENoteConfigurationsGetOp esign.Op

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 

type ENoteConfigurationsUpdateOp esign.Op

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 

type GetBillingChargesOp esign.Op

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 

type GetOp esign.Op

GetOp implements DocuSign API SDK Accounts::GetAccountInformation

func (*GetOp) Do 

func (op *GetOp) Do(ctx context.Context) (*model.AccountInformation, error)

Do executes the op. A nil context will return error.

func (*GetOp) IncludeAccountSettings 

func (op *GetOp) IncludeAccountSettings() *GetOp

IncludeAccountSettings when set to **true**, includes account settings (defined by the [`accountSettings`](https://developers.docusign.com/esign-rest-api/reference/Accounts/Accounts/create/#account-settings) property) in the response. If you omit this parameter, the default behavior is **false**.

type GetProvisioningOp 

type GetProvisioningOp esign.Op

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 

type IdentityVerificationsListOp esign.Op

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 

type ListRecipientNamesByEmailOp esign.Op

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 

type ListSettingsOp esign.Op

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 

type ListSharedAccessOp esign.Op

ListSharedAccessOp implements DocuSign API SDK Accounts::listSharedAccess

func (*ListSharedAccessOp) Count 

func (op *ListSharedAccessOp) Count(val int) *ListSharedAccessOp

Count specifies the 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 this query parameter works in conjunction with `user_ids`. When you specify one of the following user statuses, the query limits the results to only users that match the specified status: - `ActivationRequired`: Membership Activation required - `ActivationSent`: Membership activation sent to user - `Active`: User Membership is active - `Closed`: User Membership is closed - `Disabled`: User Membership is disabled

func (*ListSharedAccessOp) FolderIds 

func (op *ListSharedAccessOp) FolderIds(val ...string) *ListSharedAccessOp

FolderIds is a comma-separated list of folder IDs for which to return shared item information. If `item_type` is set to `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 filter user names based on the specified string. The wild-card '*' (asterisk) can be used in 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 lists users who do not share items of `item_type` with the current user.

- `shared_to`: The response lists users in `user_list` who are sharing items to current user.

- `shared_from`: The response lists users in `user_list` who are sharing items from the current user.

- `shared_to_and_from`: The response lists users in `user_list` who are sharing items to and 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`, this specifies the number of responses to skip. Typically this value is a multiple of `count`. The default is 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 

type ListSupportedLanguagesOp esign.Op

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 

type ListUnsupportedFileTypesOp esign.Op

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 

type PasswordRulesGetForUserOp esign.Op

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 

type PasswordRulesGetOp esign.Op

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 

type PasswordRulesUpdateOp esign.Op

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 

type PaymentGatewayAccountsListOp esign.Op

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 

type PermissionProfilesCreateOp esign.Op

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 properties to return in the response. The only valid value for this request is `metadata`, which returns metadata indicating whether the properties associated with the account permission profile are editable.

type PermissionProfilesDeleteOp 

type PermissionProfilesDeleteOp esign.Op

PermissionProfilesDeleteOp implements DocuSign API SDK Accounts::deletePermissionProfile

func (*PermissionProfilesDeleteOp) Do 

func (op *PermissionProfilesDeleteOp) Do(ctx context.Context) error

Do executes the op. A nil context will return error.

type PermissionProfilesGetOp 

type PermissionProfilesGetOp esign.Op

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 properties to return in the response. The only valid value for this request is `metadata`, which returns metadata indicating whether the properties associated with the account permission profile are editable.

type PermissionProfilesListOp 

type PermissionProfilesListOp esign.Op

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 is a comma-separated list of additional properties to return in the response. Valid values are:

- `user_count`: The total number of users associated with the permission profile. - `closed_users`: Includes closed users in the `user_count`. - `account_management`: The account management settings. - `metadata`: Metadata indicating whether the properties associated with the account permission profile are editable.

Example: `user_count,closed_users`

type PermissionProfilesUpdateOp 

type PermissionProfilesUpdateOp esign.Op

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 properties to return in the response. The only valid value for this request is `metadata`, which returns metadata indicating whether the properties associated with the account permission profile are editable.

type SealProvidersListOp 

type SealProvidersListOp esign.Op

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 profiles for an account.

https://developers.docusign.com/esign-rest-api/reference/accounts/accountbrands/create

SDK Method Accounts::createBrand

func (*Service) BrandsDelete 

func (s *Service) BrandsDelete(brandID string) *BrandsDeleteOp

BrandsDelete deletes a brand.

https://developers.docusign.com/esign-rest-api/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/reference/accounts/accountbrands/deletelist

SDK Method Accounts::deleteBrands 

func (s *Service) BrandsDeleteLogo(brandID string, logoType string) *BrandsDeleteLogoOp

BrandsDeleteLogo deletes a brand logo.

https://developers.docusign.com/esign-rest-api/reference/accounts/accountbrands/deletelogo

SDK Method Accounts::deleteBrandLogoByType

func (*Service) BrandsGet 

func (s *Service) BrandsGet(brandID string) *BrandsGetOp

BrandsGet gets information about a brand.

https://developers.docusign.com/esign-rest-api/reference/accounts/accountbrands/get

SDK Method Accounts::getBrand

func (*Service) BrandsGetExportFile 

func (s *Service) BrandsGetExportFile(brandID string) *BrandsGetExportFileOp

BrandsGetExportFile export a brand.

https://developers.docusign.com/esign-rest-api/reference/accounts/accountbrands/getexportfile

SDK Method Accounts::getBrandExportFile 

func (s *Service) BrandsGetLogo(brandID string, logoType string) *BrandsGetLogoOp

BrandsGetLogo gets a brand logo.

https://developers.docusign.com/esign-rest-api/reference/accounts/accountbrands/getlogo

SDK Method Accounts::getBrandLogoByType

func (*Service) BrandsGetResource 

func (s *Service) BrandsGetResource(brandID string, resourceContentType string) *BrandsGetResourceOp

BrandsGetResource returns a branding resource file.

https://developers.docusign.com/esign-rest-api/reference/accounts/accountbrands/getresource

SDK Method Accounts::getBrandResourcesByContentType

func (*Service) BrandsList 

func (s *Service) BrandsList() *BrandsListOp

BrandsList gets a list of brands.

https://developers.docusign.com/esign-rest-api/reference/accounts/accountbrands/list

SDK Method Accounts::listBrands

func (*Service) BrandsListResources 

func (s *Service) BrandsListResources(brandID string) *BrandsListResourcesOp

BrandsListResources returns metadata about the branding resources for an account.

https://developers.docusign.com/esign-rest-api/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/reference/accounts/accountbrands/update

SDK Method Accounts::updateBrand 

func (s *Service) BrandsUpdateLogo(brandID string, logoType string, logoFileBytes []byte) *BrandsUpdateLogoOp

BrandsUpdateLogo updates a brand logo.

https://developers.docusign.com/esign-rest-api/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 updates a branding resource file. If media is an io.ReadCloser, Do() will close media.

https://developers.docusign.com/esign-rest-api/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/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.

https://developers.docusign.com/esign-rest-api/reference/accounts/accountconsumerdisclosures/getdefault

SDK Method Accounts::getConsumerDisclosureDefault

func (*Service) ConsumerDisclosuresUpdate 

func (s *Service) ConsumerDisclosuresUpdate(langCode string, envelopeConsumerDisclosures *model.ConsumerDisclosure) *ConsumerDisclosuresUpdateOp

ConsumerDisclosuresUpdate update Consumer Disclosure.

https://developers.docusign.com/esign-rest-api/reference/accounts/accountconsumerdisclosures/update

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/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/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/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/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/reference/accounts/accountcustomfields/update

SDK Method Accounts::updateCustomField

func (*Service) Delete 

func (s *Service) Delete() *DeleteOp

Delete deletes the specified account.

https://developers.docusign.com/esign-rest-api/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/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/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/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/reference/accounts/enoteconfigurations/update

SDK Method Accounts::updateENoteConfiguration

func (*Service) Get 

func (s *Service) Get() *GetOp

Get retrieves the account information for the specified account.

https://developers.docusign.com/esign-rest-api/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/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/reference/accounts/accounts/getprovisioning

SDK Method Accounts::getProvisioning

func (*Service) IdentityVerificationsList 

func (s *Service) IdentityVerificationsList() *IdentityVerificationsListOp

IdentityVerificationsList retrieves the list of identity verification workflows available to an account

https://developers.docusign.com/esign-rest-api/reference/accounts/identityverifications/list

SDK Method Accounts::getAccountIdentityVerification

func (*Service) ListRecipientNamesByEmail 

func (s *Service) ListRecipientNamesByEmail() *ListRecipientNamesByEmailOp

ListRecipientNamesByEmail gets recipient names associated with an email address.

https://developers.docusign.com/esign-rest-api/reference/accounts/accounts/listrecipientnamesbyemail

SDK Method Accounts::listRecipientNamesByEmail

func (*Service) ListSettings 

func (s *Service) ListSettings() *ListSettingsOp

ListSettings gets account settings information.

https://developers.docusign.com/esign-rest-api/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/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/reference/accounts/accounts/listsupportedlanguages

SDK Method Accounts::getSupportedLanguages

func (*Service) ListUnsupportedFileTypes 

func (s *Service) ListUnsupportedFileTypes() *ListUnsupportedFileTypesOp

ListUnsupportedFileTypes gets a list of unsupported file types.

https://developers.docusign.com/esign-rest-api/reference/accounts/accounts/listunsupportedfiletypes

SDK Method Accounts::listUnsupportedFileTypes

func (*Service) PasswordRulesGet 

func (s *Service) PasswordRulesGet() *PasswordRulesGetOp

PasswordRulesGet get the password rules

https://developers.docusign.com/esign-rest-api/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/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/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/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 for an account.

https://developers.docusign.com/esign-rest-api/reference/accounts/accountpermissionprofiles/create

SDK Method Accounts::createPermissionProfile

func (*Service) PermissionProfilesDelete 

func (s *Service) PermissionProfilesDelete(permissionProfileID string) *PermissionProfilesDeleteOp

PermissionProfilesDelete deletes a permission profile from an account.

https://developers.docusign.com/esign-rest-api/reference/accounts/accountpermissionprofiles/delete

SDK Method Accounts::deletePermissionProfile

func (*Service) PermissionProfilesGet 

func (s *Service) PermissionProfilesGet(permissionProfileID string) *PermissionProfilesGetOp

PermissionProfilesGet returns a permission profile for an account.

https://developers.docusign.com/esign-rest-api/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/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.

https://developers.docusign.com/esign-rest-api/reference/accounts/accountpermissionprofiles/update

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/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/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/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/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/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/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/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/reference/accounts/accountwatermarks/update

SDK Method Accounts::updateWatermark

type SignatureProvidersListOp 

type SignatureProvidersListOp esign.Op

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 

type TabSettingsGetOp esign.Op

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 

type TabSettingsUpdateOp esign.Op

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 

type UpdateSettingsOp esign.Op

UpdateSettingsOp implements DocuSign API SDK Accounts::updateSettings

func (*UpdateSettingsOp) Do 

func (op *UpdateSettingsOp) Do(ctx context.Context) error

Do executes the op. A nil context will return error.

type UpdateSharedAccessOp 

type UpdateSharedAccessOp esign.Op

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 set: - `envelopes`: Set envelope sharing between users. - `templates`: Set information about template sharing among users and groups. - `folders`: Get information about folder sharing among users and groups.

func (*UpdateSharedAccessOp) PreserveExistingSharedAccess 

func (op *UpdateSharedAccessOp) PreserveExistingSharedAccess(val string) *UpdateSharedAccessOp

PreserveExistingSharedAccess when **true**, preserve the existing shared access settings.

func (*UpdateSharedAccessOp) UserIds 

func (op *UpdateSharedAccessOp) UserIds(val ...string) *UpdateSharedAccessOp

UserIds is a comma-separated list of IDs for users whose shared item access is being set.

type WatermarksGetOp 

type WatermarksGetOp esign.Op

WatermarksGetOp implements DocuSign API SDK Accounts::getWatermark

func (*WatermarksGetOp) Do 

func (op *WatermarksGetOp) Do(ctx context.Context) (*model.Watermark, error)

Do executes the op. A nil context will return error.

type WatermarksPreviewOp 

type WatermarksPreviewOp esign.Op

WatermarksPreviewOp implements DocuSign API SDK Accounts::getWatermarkPreview

func (*WatermarksPreviewOp) Do 

func (op *WatermarksPreviewOp) Do(ctx context.Context) (*model.Watermark, error)

Do executes the op. A nil context will return error.

type WatermarksUpdateOp 

type WatermarksUpdateOp esign.Op

WatermarksUpdateOp implements DocuSign API SDK Accounts::updateWatermark

func (*WatermarksUpdateOp) Do 

func (op *WatermarksUpdateOp) Do(ctx context.Context) (*model.Watermark, error)

Do executes the op. A nil context will return error.

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.