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 Accounts 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 multiple members of a family.
Service Api documentation may be found at: https://developers.docusign.com/docs/esign-rest-api/reference/Accounts Usage example:
import ( "github.com/jfcote87/esign" "github.com/jfcote87/esign/v2.1/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 FavoriteTemplatesGetFavoriteTemplatesOp
- type FavoriteTemplatesUnFavoriteTemplateOp
- type FavoriteTemplatesUpdateFavoriteTemplateOp
- type GetBillingChargesOp
- type GetEnvelopePurgeConfigurationOp
- type GetNotificationDefaultsOp
- 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 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, consumerDisclosure *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(eNoteConfiguration *model.ENoteConfiguration) *ENoteConfigurationsUpdateOp
- func (s *Service) FavoriteTemplatesGetFavoriteTemplates() *FavoriteTemplatesGetFavoriteTemplatesOp
- func (s *Service) FavoriteTemplatesUnFavoriteTemplate(favoriteTemplatesInfo *model.FavoriteTemplatesInfo) *FavoriteTemplatesUnFavoriteTemplateOp
- func (s *Service) FavoriteTemplatesUpdateFavoriteTemplate(favoriteTemplatesInfo *model.FavoriteTemplatesInfo) *FavoriteTemplatesUpdateFavoriteTemplateOp
- func (s *Service) Get() *GetOp
- func (s *Service) GetBillingCharges() *GetBillingChargesOp
- func (s *Service) GetEnvelopePurgeConfiguration() *GetEnvelopePurgeConfigurationOp
- func (s *Service) GetNotificationDefaults() *GetNotificationDefaultsOp
- 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) PermissionProfilesCreate(permissionProfile *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, permissionProfile *model.PermissionProfile) *PermissionProfilesUpdateOp
- func (s *Service) SealProvidersList() *SealProvidersListOp
- func (s *Service) SignatureProvidersList() *SignatureProvidersListOp
- func (s *Service) SignaturesCreateAccountSignatures(accountSignaturesInformation *model.AccountSignaturesInformation) *SignaturesCreateAccountSignaturesOp
- func (s *Service) SignaturesDeleteAccountSignature(signatureID string) *SignaturesDeleteAccountSignatureOp
- func (s *Service) SignaturesDeleteAccountSignatureImage(imageType string, signatureID string) *SignaturesDeleteAccountSignatureImageOp
- func (s *Service) SignaturesGetAccountSignature(signatureID string) *SignaturesGetAccountSignatureOp
- func (s *Service) SignaturesGetAccountSignatureImage(imageType string, signatureID string) *SignaturesGetAccountSignatureImageOp
- func (s *Service) SignaturesGetAccountSignatures() *SignaturesGetAccountSignaturesOp
- func (s *Service) SignaturesUpdateAccountSignature(accountSignaturesInformation *model.AccountSignaturesInformation) *SignaturesUpdateAccountSignatureOp
- func (s *Service) SignaturesUpdateAccountSignatureByID(signatureID string, ...) *SignaturesUpdateAccountSignatureByIDOp
- func (s *Service) SignaturesUpdateAccountSignatureImage(imageType string, signatureID string, media io.Reader, mimeType string) *SignaturesUpdateAccountSignatureImageOp
- func (s *Service) TabSettingsGet() *TabSettingsGetOp
- func (s *Service) TabSettingsUpdate(tabAccountSettings *model.TabAccountSettings) *TabSettingsUpdateOp
- func (s *Service) UpdateEnvelopePurgeConfiguration(envelopePurgeConfiguration *model.EnvelopePurgeConfiguration) *UpdateEnvelopePurgeConfigurationOp
- func (s *Service) UpdateNotificationDefaults(notificationDefaults *model.NotificationDefaults) *UpdateNotificationDefaultsOp
- 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(watermark *model.Watermark) *WatermarksPreviewOp
- func (s *Service) WatermarksUpdate(watermark *model.Watermark) *WatermarksUpdateOp
- type SignatureProvidersListOp
- type SignaturesCreateAccountSignaturesOp
- type SignaturesDeleteAccountSignatureImageOp
- type SignaturesDeleteAccountSignatureOp
- type SignaturesGetAccountSignatureImageOp
- type SignaturesGetAccountSignatureOp
- type SignaturesGetAccountSignaturesOp
- func (op *SignaturesGetAccountSignaturesOp) Do(ctx context.Context) (*model.AccountSignaturesInformation, error)
- func (op *SignaturesGetAccountSignaturesOp) StampFormat(val string) *SignaturesGetAccountSignaturesOp
- func (op *SignaturesGetAccountSignaturesOp) StampName(val string) *SignaturesGetAccountSignaturesOp
- func (op *SignaturesGetAccountSignaturesOp) StampType(val string) *SignaturesGetAccountSignaturesOp
- type SignaturesUpdateAccountSignatureByIDOp
- type SignaturesUpdateAccountSignatureImageOp
- type SignaturesUpdateAccountSignatureOp
- type TabSettingsGetOp
- type TabSettingsUpdateOp
- type UpdateEnvelopePurgeConfigurationOp
- type UpdateNotificationDefaultsOp
- type UpdateSettingsOp
- type UpdateSharedAccessOp
- func (op *UpdateSharedAccessOp) Do(ctx context.Context) (*model.AccountSharedAccess, error)
- func (op *UpdateSharedAccessOp) ItemType(val string) *UpdateSharedAccessOp
- func (op *UpdateSharedAccessOp) PreserveExistingSharedAccess(val string) *UpdateSharedAccessOp
- func (op *UpdateSharedAccessOp) UserIds(val ...string) *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 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 ¶
BrandsGetResourceOp implements DocuSign API SDK Accounts::getBrandResourcesByContentType
func (*BrandsGetResourceOp) Do ¶
func (op *BrandsGetResourceOp) Do(ctx context.Context) 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 ¶
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,** 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
func (*BrandsUpdateOp) ReplaceBrand ¶ added in v0.10.0
func (op *BrandsUpdateOp) ReplaceBrand(val string) *BrandsUpdateOp
ReplaceBrand set the call query parameter replace_brand
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 is the code for the signer language version of the disclosure that you want to retrieve. The following languages are supported:
- 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 Canadian (`fr_CA`) - German (`de`) - Greek (`el`) - Hebrew (`he`) - Hindi (`hi`) - Hungarian (`hu`) - Bahasa Indonesian (`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`) - Vietnamese (`vi`)
Additionally, you can automatically detect the browser language being used by the viewer and display the disclosure in that language by setting the value to `browser`.
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 (Optional) When true, the response includes metadata indicating which properties are editable.
type CustomFieldsCreateOp ¶
CustomFieldsCreateOp implements DocuSign API SDK Accounts::createCustomField
func (*CustomFieldsCreateOp) ApplyToTemplates ¶
func (op *CustomFieldsCreateOp) ApplyToTemplates() *CustomFieldsCreateOp
ApplyToTemplates (Optional) When **true,** the new custom field is applied to all of the templates on the account.
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 FavoriteTemplatesGetFavoriteTemplatesOp ¶ added in v0.10.0
FavoriteTemplatesGetFavoriteTemplatesOp implements DocuSign API SDK Accounts::getFavoriteTemplates
func (*FavoriteTemplatesGetFavoriteTemplatesOp) Do ¶ added in v0.10.0
func (op *FavoriteTemplatesGetFavoriteTemplatesOp) Do(ctx context.Context) (*model.FavoriteTemplatesInfo, error)
Do executes the op. A nil context will return error.
type FavoriteTemplatesUnFavoriteTemplateOp ¶ added in v0.10.0
FavoriteTemplatesUnFavoriteTemplateOp implements DocuSign API SDK Accounts::unFavoriteTemplate
func (*FavoriteTemplatesUnFavoriteTemplateOp) Do ¶ added in v0.10.0
func (op *FavoriteTemplatesUnFavoriteTemplateOp) Do(ctx context.Context) (*model.FavoriteTemplatesInfo, error)
Do executes the op. A nil context will return error.
type FavoriteTemplatesUpdateFavoriteTemplateOp ¶ added in v0.10.0
FavoriteTemplatesUpdateFavoriteTemplateOp implements DocuSign API SDK Accounts::updateFavoriteTemplate
func (*FavoriteTemplatesUpdateFavoriteTemplateOp) Do ¶ added in v0.10.0
func (op *FavoriteTemplatesUpdateFavoriteTemplateOp) Do(ctx context.Context) (*model.FavoriteTemplatesInfo, 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 GetEnvelopePurgeConfigurationOp ¶ added in v0.10.0
GetEnvelopePurgeConfigurationOp implements DocuSign API SDK Accounts::getEnvelopePurgeConfiguration
func (*GetEnvelopePurgeConfigurationOp) Do ¶ added in v0.10.0
func (op *GetEnvelopePurgeConfigurationOp) Do(ctx context.Context) (*model.EnvelopePurgeConfiguration, error)
Do executes the op. A nil context will return error.
type GetNotificationDefaultsOp ¶ added in v0.10.0
GetNotificationDefaultsOp implements DocuSign API SDK Accounts::getNotificationDefaults
func (*GetNotificationDefaultsOp) Do ¶ added in v0.10.0
func (op *GetNotificationDefaultsOp) Do(ctx context.Context) (*model.NotificationDefaults, error)
Do executes the op. A nil context will return error.
type GetOp ¶
GetOp implements DocuSign API SDK Accounts::GetAccountInformation
func (*GetOp) IncludeAccountSettings ¶
IncludeAccountSettings when **true,** includes account settings in the response. If you omit this parameter, the default behavior is **false.**
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 which you want to retrieve recipient names.
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 is the maximum number of results to return.
Use `start_position` to specify the number of results to skip.
Default: `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. Valid values:
- `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 is the zero-based index of the result from which to start returning results.
Use with `count` to limit the number of results.
The default value 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 ¶
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 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 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 ¶
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.
func (*PermissionProfilesDeleteOp) MoveUsersTo ¶ added in v0.10.0
func (op *PermissionProfilesDeleteOp) MoveUsersTo(val string) *PermissionProfilesDeleteOp
MoveUsersTo set the call query parameter move_users_to
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 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 ¶
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 ¶
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 ¶
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 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/docs/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/docs/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/docs/esign-rest-api/reference/accounts/accountbrands/deletelist
SDK Method Accounts::deleteBrands
func (*Service) BrandsDeleteLogo ¶
func (s *Service) BrandsDeleteLogo(brandID string, logoType string) *BrandsDeleteLogoOp
BrandsDeleteLogo deletes a brand logo.
https://developers.docusign.com/docs/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/docs/esign-rest-api/reference/accounts/accountbrands/get
SDK Method Accounts::getBrand
func (*Service) BrandsGetExportFile ¶
func (s *Service) BrandsGetExportFile(brandID string) *BrandsGetExportFileOp
BrandsGetExportFile exports a brand.
https://developers.docusign.com/docs/esign-rest-api/reference/accounts/accountbrands/getexportfile
SDK Method Accounts::getBrandExportFile
func (*Service) BrandsGetLogo ¶
func (s *Service) BrandsGetLogo(brandID string, logoType string) *BrandsGetLogoOp
BrandsGetLogo gets a brand logo.
https://developers.docusign.com/docs/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/docs/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/docs/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/docs/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/docs/esign-rest-api/reference/accounts/accountbrands/update
SDK Method Accounts::updateBrand
func (*Service) BrandsUpdateLogo ¶
func (s *Service) BrandsUpdateLogo(brandID string, logoType string, logoFileBytes []byte) *BrandsUpdateLogoOp
BrandsUpdateLogo updates a brand logo.
https://developers.docusign.com/docs/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/docs/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 for an account.
SDK Method Accounts::getConsumerDisclosure
func (*Service) ConsumerDisclosuresGetDefault ¶
func (s *Service) ConsumerDisclosuresGetDefault() *ConsumerDisclosuresGetDefaultOp
ConsumerDisclosuresGetDefault gets the default Electronic Record and Signature Disclosure for an account.
SDK Method Accounts::getConsumerDisclosureDefault
func (*Service) ConsumerDisclosuresUpdate ¶
func (s *Service) ConsumerDisclosuresUpdate(langCode string, consumerDisclosure *model.ConsumerDisclosure) *ConsumerDisclosuresUpdateOp
ConsumerDisclosuresUpdate updates the Electronic Record and Signature Disclosure for an account.
SDK Method Accounts::updateConsumerDisclosure
func (*Service) Create ¶
func (s *Service) Create(newAccountDefinition *model.NewAccountDefinition) *CreateOp
Create creates new accounts.
https://developers.docusign.com/docs/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 account custom field.
https://developers.docusign.com/docs/esign-rest-api/reference/accounts/accountcustomfields/create
SDK Method Accounts::createCustomField
func (*Service) CustomFieldsDelete ¶
func (s *Service) CustomFieldsDelete(customFieldID string) *CustomFieldsDeleteOp
CustomFieldsDelete deletes an account custom field.
https://developers.docusign.com/docs/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.
https://developers.docusign.com/docs/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 account custom field.
https://developers.docusign.com/docs/esign-rest-api/reference/accounts/accountcustomfields/update
SDK Method Accounts::updateCustomField
func (*Service) Delete ¶
Delete deletes the specified account.
https://developers.docusign.com/docs/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.
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/docs/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/docs/esign-rest-api/reference/accounts/enoteconfigurations/get
SDK Method Accounts::getENoteConfiguration
func (*Service) ENoteConfigurationsUpdate ¶
func (s *Service) ENoteConfigurationsUpdate(eNoteConfiguration *model.ENoteConfiguration) *ENoteConfigurationsUpdateOp
ENoteConfigurationsUpdate updates configuration information for the eNote eOriginal integration.
https://developers.docusign.com/docs/esign-rest-api/reference/accounts/enoteconfigurations/update
SDK Method Accounts::updateENoteConfiguration
func (*Service) FavoriteTemplatesGetFavoriteTemplates ¶ added in v0.10.0
func (s *Service) FavoriteTemplatesGetFavoriteTemplates() *FavoriteTemplatesGetFavoriteTemplatesOp
FavoriteTemplatesGetFavoriteTemplates retrieves the list of favorited templates for this caller.
SDK Method Accounts::getFavoriteTemplates
func (*Service) FavoriteTemplatesUnFavoriteTemplate ¶ added in v0.10.0
func (s *Service) FavoriteTemplatesUnFavoriteTemplate(favoriteTemplatesInfo *model.FavoriteTemplatesInfo) *FavoriteTemplatesUnFavoriteTemplateOp
FavoriteTemplatesUnFavoriteTemplate unfavorites a template.
SDK Method Accounts::unFavoriteTemplate
func (*Service) FavoriteTemplatesUpdateFavoriteTemplate ¶ added in v0.10.0
func (s *Service) FavoriteTemplatesUpdateFavoriteTemplate(favoriteTemplatesInfo *model.FavoriteTemplatesInfo) *FavoriteTemplatesUpdateFavoriteTemplateOp
FavoriteTemplatesUpdateFavoriteTemplate sets a template as a favorite.
SDK Method Accounts::updateFavoriteTemplate
func (*Service) Get ¶
Get retrieves the account information for the specified account.
https://developers.docusign.com/docs/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/docs/esign-rest-api/reference/accounts/accounts/getbillingcharges
SDK Method Accounts::getBillingCharges
func (*Service) GetEnvelopePurgeConfiguration ¶ added in v0.10.0
func (s *Service) GetEnvelopePurgeConfiguration() *GetEnvelopePurgeConfigurationOp
GetEnvelopePurgeConfiguration gets the envelope purge configuration for an account.
SDK Method Accounts::getEnvelopePurgeConfiguration
func (*Service) GetNotificationDefaults ¶ added in v0.10.0
func (s *Service) GetNotificationDefaults() *GetNotificationDefaultsOp
GetNotificationDefaults gets envelope notification defaults.
SDK Method Accounts::getNotificationDefaults
func (*Service) GetProvisioning ¶
func (s *Service) GetProvisioning() *GetProvisioningOp
GetProvisioning retrieves the account provisioning information for the account.
https://developers.docusign.com/docs/esign-rest-api/reference/accounts/accounts/getprovisioning
SDK Method Accounts::getProvisioning
func (*Service) IdentityVerificationsList ¶
func (s *Service) IdentityVerificationsList() *IdentityVerificationsListOp
IdentityVerificationsList retrieves the Identity Verification workflows available to an account.
https://developers.docusign.com/docs/esign-rest-api/reference/accounts/identityverifications/list
SDK Method Accounts::getAccountIdentityVerification
func (*Service) ListRecipientNamesByEmail ¶
func (s *Service) ListRecipientNamesByEmail() *ListRecipientNamesByEmailOp
ListRecipientNamesByEmail gets the 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/docs/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/docs/esign-rest-api/reference/accounts/accounts/listsharedaccess
SDK Method Accounts::listSharedAccess
func (*Service) ListSupportedLanguages ¶
func (s *Service) ListSupportedLanguages() *ListSupportedLanguagesOp
ListSupportedLanguages gets the supported languages for envelope recipients.
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 gets the password rules for an account.
https://developers.docusign.com/docs/esign-rest-api/reference/accounts/accountpasswordrules/get
SDK Method Accounts::getAccountPasswordRules
func (*Service) PasswordRulesGetForUser ¶
func (s *Service) PasswordRulesGetForUser() *PasswordRulesGetForUserOp
PasswordRulesGetForUser gets membership account password rules.
SDK Method Accounts::getPasswordRules
func (*Service) PasswordRulesUpdate ¶
func (s *Service) PasswordRulesUpdate(accountPasswordRules *model.AccountPasswordRules) *PasswordRulesUpdateOp
PasswordRulesUpdate updates the password rules for an account.
https://developers.docusign.com/docs/esign-rest-api/reference/accounts/accountpasswordrules/update
SDK Method Accounts::updateAccountPasswordRules
func (*Service) PermissionProfilesCreate ¶
func (s *Service) PermissionProfilesCreate(permissionProfile *model.PermissionProfile) *PermissionProfilesCreateOp
PermissionProfilesCreate creates a new permission profile for an account.
SDK Method Accounts::createPermissionProfile
func (*Service) PermissionProfilesDelete ¶
func (s *Service) PermissionProfilesDelete(permissionProfileID string) *PermissionProfilesDeleteOp
PermissionProfilesDelete deletes a permission profile from an account.
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/docs/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.
SDK Method Accounts::listPermissions
func (*Service) PermissionProfilesUpdate ¶
func (s *Service) PermissionProfilesUpdate(permissionProfileID string, permissionProfile *model.PermissionProfile) *PermissionProfilesUpdateOp
PermissionProfilesUpdate updates a permission profile.
SDK Method Accounts::updatePermissionProfile
func (*Service) SealProvidersList ¶
func (s *Service) SealProvidersList() *SealProvidersListOp
SealProvidersList returns available seals for specified account.
https://developers.docusign.com/docs/esign-rest-api/reference/accounts/accountsealproviders/list
SDK Method Accounts::getSealProviders
func (*Service) SignatureProvidersList ¶
func (s *Service) SignatureProvidersList() *SignatureProvidersListOp
SignatureProvidersList gets the available signature providers for an account.
SDK Method Accounts::listSignatureProviders
func (*Service) SignaturesCreateAccountSignatures ¶ added in v0.10.0
func (s *Service) SignaturesCreateAccountSignatures(accountSignaturesInformation *model.AccountSignaturesInformation) *SignaturesCreateAccountSignaturesOp
SignaturesCreateAccountSignatures adds or updates one or more account signatures. This request may include images in multi-part format.
SDK Method Accounts::createAccountSignatures
func (*Service) SignaturesDeleteAccountSignature ¶ added in v0.10.0
func (s *Service) SignaturesDeleteAccountSignature(signatureID string) *SignaturesDeleteAccountSignatureOp
SignaturesDeleteAccountSignature close the specified signature by ID.
SDK Method Accounts::deleteAccountSignature
func (*Service) SignaturesDeleteAccountSignatureImage ¶ added in v0.10.0
func (s *Service) SignaturesDeleteAccountSignatureImage(imageType string, signatureID string) *SignaturesDeleteAccountSignatureImageOp
SignaturesDeleteAccountSignatureImage deletes a signature image, initials, or stamp.
SDK Method Accounts::deleteAccountSignatureImage
func (*Service) SignaturesGetAccountSignature ¶ added in v0.10.0
func (s *Service) SignaturesGetAccountSignature(signatureID string) *SignaturesGetAccountSignatureOp
SignaturesGetAccountSignature returns information about the specified signature.
SDK Method Accounts::getAccountSignature
func (*Service) SignaturesGetAccountSignatureImage ¶ added in v0.10.0
func (s *Service) SignaturesGetAccountSignatureImage(imageType string, signatureID string) *SignaturesGetAccountSignatureImageOp
SignaturesGetAccountSignatureImage returns a signature image, initials, or stamp.
SDK Method Accounts::getAccountSignatureImage
func (*Service) SignaturesGetAccountSignatures ¶ added in v0.10.0
func (s *Service) SignaturesGetAccountSignatures() *SignaturesGetAccountSignaturesOp
SignaturesGetAccountSignatures returns the managed signature definitions for the account
SDK Method Accounts::getAccountSignatures
func (*Service) SignaturesUpdateAccountSignature ¶ added in v0.10.0
func (s *Service) SignaturesUpdateAccountSignature(accountSignaturesInformation *model.AccountSignaturesInformation) *SignaturesUpdateAccountSignatureOp
SignaturesUpdateAccountSignature updates an account signature.
SDK Method Accounts::updateAccountSignature
func (*Service) SignaturesUpdateAccountSignatureByID ¶ added in v0.10.0
func (s *Service) SignaturesUpdateAccountSignatureByID(signatureID string, accountSignatureDefinition *model.AccountSignatureDefinition) *SignaturesUpdateAccountSignatureByIDOp
SignaturesUpdateAccountSignatureByID updates an account signature.
SDK Method Accounts::updateAccountSignatureById
func (*Service) SignaturesUpdateAccountSignatureImage ¶ added in v0.10.0
func (s *Service) SignaturesUpdateAccountSignatureImage(imageType string, signatureID string, media io.Reader, mimeType string) *SignaturesUpdateAccountSignatureImageOp
SignaturesUpdateAccountSignatureImage sets a signature image, initials, or stamp. If media is an io.ReadCloser, Do() will close media.
SDK Method Accounts::updateAccountSignatureImage
func (*Service) TabSettingsGet ¶
func (s *Service) TabSettingsGet() *TabSettingsGetOp
TabSettingsGet returns tab settings list for specified account
https://developers.docusign.com/docs/esign-rest-api/reference/accounts/accounttabsettings/get
SDK Method Accounts::getAccountTabSettings
func (*Service) TabSettingsUpdate ¶
func (s *Service) TabSettingsUpdate(tabAccountSettings *model.TabAccountSettings) *TabSettingsUpdateOp
TabSettingsUpdate modifies tab settings for specified account
https://developers.docusign.com/docs/esign-rest-api/reference/accounts/accounttabsettings/update
SDK Method Accounts::updateAccountTabSettings
func (*Service) UpdateEnvelopePurgeConfiguration ¶ added in v0.10.0
func (s *Service) UpdateEnvelopePurgeConfiguration(envelopePurgeConfiguration *model.EnvelopePurgeConfiguration) *UpdateEnvelopePurgeConfigurationOp
UpdateEnvelopePurgeConfiguration sets the envelope purge configuration for an account.
SDK Method Accounts::updateEnvelopePurgeConfiguration
func (*Service) UpdateNotificationDefaults ¶ added in v0.10.0
func (s *Service) UpdateNotificationDefaults(notificationDefaults *model.NotificationDefaults) *UpdateNotificationDefaultsOp
UpdateNotificationDefaults updates envelope notification default settings.
SDK Method Accounts::updateNotificationDefaults
func (*Service) UpdateSettings ¶
func (s *Service) UpdateSettings(accountSettingsInformation *model.AccountSettingsInformation) *UpdateSettingsOp
UpdateSettings updates the account settings for an account.
https://developers.docusign.com/docs/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/docs/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/docs/esign-rest-api/reference/accounts/accountwatermarks/get
SDK Method Accounts::getWatermark
func (*Service) WatermarksPreview ¶
func (s *Service) WatermarksPreview(watermark *model.Watermark) *WatermarksPreviewOp
WatermarksPreview get watermark preview.
https://developers.docusign.com/docs/esign-rest-api/reference/accounts/accountwatermarks/preview
SDK Method Accounts::getWatermarkPreview
func (*Service) WatermarksUpdate ¶
func (s *Service) WatermarksUpdate(watermark *model.Watermark) *WatermarksUpdateOp
WatermarksUpdate update watermark information.
https://developers.docusign.com/docs/esign-rest-api/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 SignaturesCreateAccountSignaturesOp ¶ added in v0.10.0
SignaturesCreateAccountSignaturesOp implements DocuSign API SDK Accounts::createAccountSignatures
func (*SignaturesCreateAccountSignaturesOp) DecodeOnly ¶ added in v0.10.0
func (op *SignaturesCreateAccountSignaturesOp) DecodeOnly(val string) *SignaturesCreateAccountSignaturesOp
DecodeOnly set the call query parameter decode_only
func (*SignaturesCreateAccountSignaturesOp) Do ¶ added in v0.10.0
func (op *SignaturesCreateAccountSignaturesOp) Do(ctx context.Context) (*model.AccountSignaturesInformation, error)
Do executes the op. A nil context will return error.
type SignaturesDeleteAccountSignatureImageOp ¶ added in v0.10.0
SignaturesDeleteAccountSignatureImageOp implements DocuSign API SDK Accounts::deleteAccountSignatureImage
func (*SignaturesDeleteAccountSignatureImageOp) Do ¶ added in v0.10.0
func (op *SignaturesDeleteAccountSignatureImageOp) Do(ctx context.Context) (*model.AccountSignature, error)
Do executes the op. A nil context will return error.
type SignaturesDeleteAccountSignatureOp ¶ added in v0.10.0
SignaturesDeleteAccountSignatureOp implements DocuSign API SDK Accounts::deleteAccountSignature
type SignaturesGetAccountSignatureImageOp ¶ added in v0.10.0
SignaturesGetAccountSignatureImageOp implements DocuSign API SDK Accounts::getAccountSignatureImage
func (*SignaturesGetAccountSignatureImageOp) Do ¶ added in v0.10.0
Do executes the op. A nil context will return error.
func (*SignaturesGetAccountSignatureImageOp) IncludeChrome ¶ added in v0.10.0
func (op *SignaturesGetAccountSignatureImageOp) IncludeChrome(val string) *SignaturesGetAccountSignatureImageOp
IncludeChrome when **true,** the chrome (or frame containing the added line and identifier) is included with the signature image.
type SignaturesGetAccountSignatureOp ¶ added in v0.10.0
SignaturesGetAccountSignatureOp implements DocuSign API SDK Accounts::getAccountSignature
func (*SignaturesGetAccountSignatureOp) Do ¶ added in v0.10.0
func (op *SignaturesGetAccountSignatureOp) Do(ctx context.Context) (*model.AccountSignature, error)
Do executes the op. A nil context will return error.
type SignaturesGetAccountSignaturesOp ¶ added in v0.10.0
SignaturesGetAccountSignaturesOp implements DocuSign API SDK Accounts::getAccountSignatures
func (*SignaturesGetAccountSignaturesOp) Do ¶ added in v0.10.0
func (op *SignaturesGetAccountSignaturesOp) Do(ctx context.Context) (*model.AccountSignaturesInformation, error)
Do executes the op. A nil context will return error.
func (*SignaturesGetAccountSignaturesOp) StampFormat ¶ added in v0.10.0
func (op *SignaturesGetAccountSignaturesOp) StampFormat(val string) *SignaturesGetAccountSignaturesOp
StampFormat set the call query parameter stamp_format
func (*SignaturesGetAccountSignaturesOp) StampName ¶ added in v0.10.0
func (op *SignaturesGetAccountSignaturesOp) StampName(val string) *SignaturesGetAccountSignaturesOp
StampName set the call query parameter stamp_name
func (*SignaturesGetAccountSignaturesOp) StampType ¶ added in v0.10.0
func (op *SignaturesGetAccountSignaturesOp) StampType(val string) *SignaturesGetAccountSignaturesOp
StampType set the call query parameter stamp_type
type SignaturesUpdateAccountSignatureByIDOp ¶ added in v0.10.0
SignaturesUpdateAccountSignatureByIDOp implements DocuSign API SDK Accounts::updateAccountSignatureById
func (*SignaturesUpdateAccountSignatureByIDOp) CloseExistingSignature ¶ added in v0.10.0
func (op *SignaturesUpdateAccountSignatureByIDOp) CloseExistingSignature(val string) *SignaturesUpdateAccountSignatureByIDOp
CloseExistingSignature when **true,** closes the current signature.
func (*SignaturesUpdateAccountSignatureByIDOp) Do ¶ added in v0.10.0
func (op *SignaturesUpdateAccountSignatureByIDOp) Do(ctx context.Context) (*model.AccountSignature, error)
Do executes the op. A nil context will return error.
type SignaturesUpdateAccountSignatureImageOp ¶ added in v0.10.0
SignaturesUpdateAccountSignatureImageOp implements DocuSign API SDK Accounts::updateAccountSignatureImage
func (*SignaturesUpdateAccountSignatureImageOp) Do ¶ added in v0.10.0
func (op *SignaturesUpdateAccountSignatureImageOp) Do(ctx context.Context) (*model.AccountSignature, error)
Do executes the op. A nil context will return error.
func (*SignaturesUpdateAccountSignatureImageOp) TransparentPng ¶ added in v0.10.0
func (op *SignaturesUpdateAccountSignatureImageOp) TransparentPng(val string) *SignaturesUpdateAccountSignatureImageOp
TransparentPng set the call query parameter transparent_png
type SignaturesUpdateAccountSignatureOp ¶ added in v0.10.0
SignaturesUpdateAccountSignatureOp implements DocuSign API SDK Accounts::updateAccountSignature
func (*SignaturesUpdateAccountSignatureOp) Do ¶ added in v0.10.0
func (op *SignaturesUpdateAccountSignatureOp) Do(ctx context.Context) (*model.AccountSignaturesInformation, 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 UpdateEnvelopePurgeConfigurationOp ¶ added in v0.10.0
UpdateEnvelopePurgeConfigurationOp implements DocuSign API SDK Accounts::updateEnvelopePurgeConfiguration
func (*UpdateEnvelopePurgeConfigurationOp) Do ¶ added in v0.10.0
func (op *UpdateEnvelopePurgeConfigurationOp) Do(ctx context.Context) (*model.EnvelopePurgeConfiguration, error)
Do executes the op. A nil context will return error.
type UpdateNotificationDefaultsOp ¶ added in v0.10.0
UpdateNotificationDefaultsOp implements DocuSign API SDK Accounts::updateNotificationDefaults
func (*UpdateNotificationDefaultsOp) Do ¶ added in v0.10.0
func (op *UpdateNotificationDefaultsOp) Do(ctx context.Context) (*model.NotificationDefaults, 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 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 ¶
WatermarksGetOp implements DocuSign API SDK Accounts::getWatermark
type WatermarksPreviewOp ¶
WatermarksPreviewOp implements DocuSign API SDK Accounts::getWatermarkPreview