module:model/UserSettingsInformation

module:model/UserSettingsInformation

new module:model/UserSettingsInformation()

Source:

Constructs a new UserSettingsInformation.
Properties that configure the settings for a user. Some elements of this object have a metadata property, which includes the following: - rights: The calling users permissions to edit this setting (can be editable or read_only) - uiHint: Internally used to build UIs (can be available or hidden) - options: The values supported for this setting (not all settings have this element)

Members

(inner) accountAgreementsAccessType :String

Source:
Type:
  • String

(inner) accountAgreementsAccessTypeMetadata :module:model/SettingsMetadata

Source:
Type:

(inner) accountManagementGranular :module:model/UserAccountManagementGranularInformation

Source:

Describes which account management capabilities a user has.

Type:

(inner) adminOnly :String

Source:
Type:
  • String

(inner) adminOnlyMetadata :module:model/SettingsMetadata

Source:

Reserved for DocuSign.

Type:

(inner) allowAccessToAllAccountAgreements :String

Source:
Type:
  • String

(inner) allowAccessToAllAccountAgreementsMetadata :module:model/SettingsMetadata

Source:
Type:

(inner) allowAutoTagging :String

Source:
Type:
  • String

(inner) allowedOrchestrationAccess :String

Source:
Type:
  • String

(inner) allowedOrchestrationAccessMetadata :module:model/SettingsMetadata

Source:
Type:

(inner) allowEnvelopeTransferTo :String

Source:
Type:
  • String

(inner) allowEnvelopeTransferToMetadata :module:model/SettingsMetadata

Source:

Reserved for DocuSign.

Type:

(inner) allowEsealRecipients :String

Source:
Type:
  • String

(inner) allowEsealRecipientsMetadata :module:model/SettingsMetadata

Source:

Metadata about the allowEsealRecipientsMetadata property.

Type:

(inner) allowPowerFormsAdminToAccessAllPowerFormEnvelope :String

Source:
Type:
  • String

(inner) allowPowerFormsAdminToAccessAllPowerFormEnvelopeMetadata :module:model/SettingsMetadata

Source:

Metadata about the allowPowerFormsAdminToAccessAllPowerFormEnvelopeMetadata property.

Type:

(inner) allowRecipientLanguageSelection :String

Source:
Type:
  • String

(inner) allowRecipientLanguageSelectionMetadata :module:model/SettingsMetadata

Source:

Metadata for allowRecipientLanguageSelection.

Type:

(inner) allowSendOnBehalfOf :String

Source:
Type:
  • String

(inner) allowSendOnBehalfOfMetadata :module:model/SettingsMetadata

Source:

Metadata for allowSendOnBehalfOf.

Type:

(inner) allowSupplementalDocuments :String

Source:
Type:
  • String

(inner) allowSupplementalDocumentsMetadata :module:model/SettingsMetadata

Source:

Metadata that indicates whether the allowSupplementalDocuments property is editable.

Type:

(inner) allowTransactions :String

Source:
Type:
  • String

(inner) allowTransactionsMetadata :module:model/SettingsMetadata

Source:
Type:

(inner) anchorTagVersionedPlacementEnabled :String

Source:
Type:
  • String

(inner) apiAccountWideAccess :String

Source:
Type:
  • String

(inner) apiAccountWideAccessMetadata :module:model/SettingsMetadata

Source:

Metadata for apiAccountWideAccess.

Type:

(inner) apiCanExportAC :String

Source:
Type:
  • String

(inner) apiCanExportACMetadata :module:model/SettingsMetadata

Source:

Metadata about the apiCanExportACMetadata property.

Type:

(inner) bulkSend :String

Source:
Type:
  • String

(inner) bulkSendMetadata :module:model/SettingsMetadata

Source:

Metadata that indicates whether the bulkSend property is editable.

Type:

(inner) canBulkUploadAgreements :String

Source:
Type:
  • String

(inner) canBulkUploadAgreementsMetadata :module:model/SettingsMetadata

Source:
Type:

(inner) canChargeAccount :String

Source:
Type:
  • String

(inner) canChargeAccountMetadata :module:model/SettingsMetadata

Source:

Reserved for DocuSign.

Type:

(inner) canCreateTransaction :String

Source:
Type:
  • String

(inner) canCreateTransactionMetadata :module:model/SettingsMetadata

Source:
Type:

(inner) canDeleteDocumentsInTransaction :String

Source:
Type:
  • String

(inner) canDeleteDocumentsInTransactionMetadata :module:model/SettingsMetadata

Source:
Type:

(inner) canDeleteTransaction :String

Source:
Type:
  • String

(inner) canDeleteTransactionMetadata :module:model/SettingsMetadata

Source:
Type:

(inner) canEditSharedAddressbook :String

Source:
Type:
  • String

(inner) canEditSharedAddressbookMetadata :module:model/SettingsMetadata

Source:

Metadata about the canEditSharedAddressbookMetadata property.

Type:

(inner) canLockEnvelopes :String

Source:
Type:
  • String

(inner) canLockEnvelopesMetadata :module:model/SettingsMetadata

Source:

Metadata about the canLockEnvelopes property.

Type:

(inner) canManageAccount :String

Source:
Type:
  • String

(inner) canManageAccountMetadata :module:model/SettingsMetadata

Source:

Metadata about the canManageAccountMetadata property.

Type:

(inner) canManageAgreementParties :String

Source:
Type:
  • String

(inner) canManageAgreementPartiesMetadata :module:model/SettingsMetadata

Source:
Type:

(inner) canManageDistributor :String

Source:
Type:
  • String

(inner) canManageDistributorMetadata :module:model/SettingsMetadata

Source:

Metadata about the canManageDistributor property.

Type:

(inner) canManageTemplates :String

Source:
Type:
  • String

(inner) canManageTemplatesMetadata :module:model/SettingsMetadata

Source:

Metadata about the canManageTemplates property.

Type:

(inner) canSendAPIRequests :String

Source:
Type:
  • String

(inner) canSendAPIRequestsMetadata :module:model/SettingsMetadata

Source:

Metadata about the canSendAPIRequests property.

Type:

(inner) canSendEnvelope :String

Source:
Type:
  • String

(inner) canSendEnvelopeMetadata :module:model/SettingsMetadata

Source:

Metadata about the canSendEnvelope property.

Type:

(inner) canSendEnvelopesViaSMS :String

Source:
Type:
  • String

(inner) canSendEnvelopesViaSMSMetadata :module:model/SettingsMetadata

Source:
Type:

(inner) canSignEnvelope :String

Source:
Type:
  • String

(inner) canSignEnvelopeMetadata :module:model/SettingsMetadata

Source:

Metadata about the canSignEnvelope property.

Type:

(inner) canUseScratchpad :String

Source:
Type:
  • String

(inner) canUseScratchpadMetadata :module:model/SettingsMetadata

Source:

Metadata about the canUseScratchpad property.

Type:

(inner) canUseSmartContracts :String

Source:
Type:
  • String

(inner) canUseSmartContractsMetadata :module:model/SettingsMetadata

Source:

Reserved for DocuSign.

Type:

(inner) disableDocumentUpload :String

Source:
Type:
  • String

(inner) disableDocumentUploadMetadata :module:model/SettingsMetadata

Source:

Metadata that indicates whether the disableDocumentUpload property is editable.

Type:

(inner) disableOtherActions :String

Source:
Type:
  • String

(inner) disableOtherActionsMetadata :module:model/SettingsMetadata

Source:

Metadata that indicates whether the disableOtherActions property is editable.

Type:

(inner) enableDSPro :String

Source:
Type:
  • String

(inner) enableDSProMetadata :module:model/SettingsMetadata

Source:

Metadata that indicates whether the enableDSPro property is editable.

Type:

(inner) enableKeyTermsSuggestionsByDocumentType :String

Source:
Type:
  • String

(inner) enableKeyTermsSuggestionsByDocumentTypeMetadata :module:model/SettingsMetadata

Source:
Type:

(inner) enableSequentialSigningAPI :String

Source:
Type:
  • String

(inner) enableSequentialSigningAPIMetadata :module:model/SettingsMetadata

Source:

Metadata that indicates whether the enableSequentialSigningAPI property is editable.

Type:

(inner) enableSequentialSigningUI :String

Source:
Type:
  • String

(inner) enableSequentialSigningUIMetadata :module:model/SettingsMetadata

Source:

Metadata that indicates whether the enableSequentialSigningUI property is editable.

Type:

(inner) enableSignerAttachments :String

Source:
Type:
  • String

(inner) enableSignerAttachmentsMetadata :module:model/SettingsMetadata

Source:

Metadata that indicates whether the enableSignerAttachments property is editable.

Type:

(inner) enableSignOnPaperOverride :String

Source:
Type:
  • String

(inner) enableSignOnPaperOverrideMetadata :module:model/SettingsMetadata

Source:

Metadata that indicates whether the enableSignOnPaperOverride property is editable.

Type:

(inner) enableTransactionPoint :String

Source:
Type:
  • String

(inner) enableTransactionPointMetadata :module:model/SettingsMetadata

Source:

Reserved for DocuSign.

Type:

(inner) enableVaulting :String

Source:
Type:
  • String

(inner) enableVaultingMetadata :module:model/SettingsMetadata

Source:

Metadata that indicates whether the enableVaulting property is editable.

Type:

(inner) expressSendOnly :String

Source:
Type:
  • String

(inner) locale :String

Source:
Type:
  • String

(inner) localeMetadata :module:model/SettingsMetadata

Source:

Metadata about the locale property.

Type:

(inner) localePolicy :module:model/LocalePolicy

Source:

Reserved for DocuSign.

Type:

(inner) manageClickwrapsMode :String

Source:
Type:
  • String

(inner) manageClickwrapsModeMetadata :module:model/SettingsMetadata

Source:

Metadata about the manageClickwrapsMode property.

Type:

(inner) modifiedBy :String

Source:
Type:
  • String

(inner) modifiedByMetadata :module:model/SettingsMetadata

Source:

Metadata about the modifiedBy property.

Type:

(inner) modifiedDate :String

Source:
Type:
  • String

(inner) modifiedDateMetadata :module:model/SettingsMetadata

Source:

Metadata about the modifiedDate property.

Type:

(inner) modifiedPage :String

Source:
Type:
  • String

(inner) modifiedPageMetadata :module:model/SettingsMetadata

Source:

Metadata about the modifiedPage property.

Type:

(inner) newSendUI :String

Source:
Type:
  • String

(inner) newSendUIMetadata :module:model/SettingsMetadata

Source:

Metadata about the newSendUI property.

Type:

(inner) powerFormMode :String

Source:
Type:
  • String

(inner) powerFormModeMetadata :module:model/SettingsMetadata

Source:

Metadata about the powerFormMode property.

Type:

(inner) recipientViewedNotification :String

Source:
Type:
  • String

(inner) recipientViewedNotificationMetadata :module:model/SettingsMetadata

Source:

Metadata about the recipientViewedNotification property.

Type:

(inner) sealIdentifiers :Array.<module:model/SealIdentifier>

Source:
Type:

(inner) selfSignedRecipientEmailDocument :String

Source:
Type:
  • String

(inner) selfSignedRecipientEmailDocumentMetadata :module:model/SettingsMetadata

Source:

Metadata that indicates whether the selfSignedRecipientEmailDocument property is editable.

Type:

(inner) senderEmailNotifications :module:model/SenderEmailNotifications

Source:

An array of email notifications that sets the email the user receives when they are a sender. When the specific email notification is set to true, the user will receive those types of email notifications from DocuSign. The user inherits the default account sender email notification settings when the user is created. The email notifications are: * envelopeComplete * changedSigner * senderEnvelopeDeclined * withdrawnConsent * recipientViewed * deliveryFailed

Type:

(inner) signerEmailNotifications :module:model/SignerEmailNotifications

Source:

An array of email notifications that specifies the email the user receives when they are a recipient. When the specific email notification is set to true, the user receives those types of email notifications from DocuSign. The user inherits the default account email notification settings when the user is created.

Type:

(inner) supplementalDocumentIncludeInDownload :String

Source:
Type:
  • String

(inner) supplementalDocumentsMustAccept :String

Source:
Type:
  • String

(inner) supplementalDocumentsMustAcceptMetadata :module:model/SettingsMetadata

Source:

Metadata that indicates whether the supplementalDocumentsMustAccept property is editable.

Type:

(inner) supplementalDocumentsMustRead :String

Source:
Type:
  • String

(inner) supplementalDocumentsMustReadMetadata :module:model/SettingsMetadata

Source:

Metadata that indicates whether the supplementalDocumentsMustRead property is editable.

Type:

(inner) supplementalDocumentsMustView :String

Source:
Type:
  • String

(inner) supplementalDocumentsMustViewMetadata :module:model/SettingsMetadata

Source:

Metadata that indicates whether the supplementalDocumentsMustView property is editable.

Type:

(inner) templateActiveCreation :String

Source:
Type:
  • String

(inner) templateActiveCreationMetadata :module:model/SettingsMetadata

Source:

Metadata about the templateActiveCreation property.

Type:

(inner) templateApplyNotify :String

Source:
Type:
  • String

(inner) templateApplyNotifyMetadata :module:model/SettingsMetadata

Source:

Metadata about the templateApplyNotify property.

Type:

(inner) templateAutoMatching :String

Source:
Type:
  • String

(inner) templateAutoMatchingMetadata :module:model/SettingsMetadata

Source:

Metadata about the templateAutoMatching property.

Type:

(inner) templateMatchingSensitivity :String

Source:
Type:
  • String

(inner) templateMatchingSensitivityMetadata :module:model/SettingsMetadata

Source:

Metadata about the tempalteMatchingSensitivity property.

Type:

(inner) templatePageLevelMatching :String

Source:
Type:
  • String

(inner) templatePageLevelMatchingMetadata :module:model/SettingsMetadata

Source:

Metadata about the templatePageLevelMatching property.

Type:

(inner) timezoneDST :String

Source:
Type:
  • String

(inner) timezoneDSTMetadata :module:model/SettingsMetadata

Source:

Metadata about the timezoneDST property.

Type:

(inner) timezoneMask :String

Source:
Type:
  • String

(inner) timezoneMaskMetadata :module:model/SettingsMetadata

Source:

Metadata about the timezoneMask property.

Type:

(inner) timezoneOffset :String

Source:
Type:
  • String

(inner) timezoneOffsetMetadata :module:model/SettingsMetadata

Source:

Metadata about the timezoneOffset property.

Type:

(inner) timezoneSendingPref :String

Source:
Type:
  • String

(inner) timezoneSendingPrefMetadata :module:model/SettingsMetadata

Source:

Reserved for DocuSign.

Type:

(inner) timezoneSigningPref :String

Source:
Type:
  • String

(inner) timezoneSigningPrefMetadata :module:model/SettingsMetadata

Source:

Reserved for DocuSign.

Type:

(inner) transactionPointSiteNameURL :String

Source:
Type:
  • String

(inner) transactionPointSiteNameURLMetadata :module:model/SettingsMetadata

Source:

Reserved for DocuSign.

Type:

(inner) transactionPointUserName :String

Source:
Type:
  • String

(inner) transactionPointUserNameMetadata :module:model/SettingsMetadata

Source:

Reserved for DocuSign.

Type:

(inner) vaultingMode :String

Source:
Type:
  • String

(inner) vaultingModeMetadata :module:model/SettingsMetadata

Source:

Metadata about the vaultingMode property.

Type:

(inner) webForms :String

Source:
Type:
  • String

(inner) webFormsMetadata :module:model/SettingsMetadata

Source:
Type:

Methods

(static) constructFromObject(data, obj) → {module:model/UserSettingsInformation}

Source:

Constructs a UserSettingsInformation from a plain JavaScript object, optionally creating a new instance.
Copies all relevant properties from data to obj if supplied or a new instance if not.

Parameters:
Name Type Description
data Object

The plain JavaScript object bearing properties of interest.
obj module:model/UserSettingsInformation

Optional instance to populate.
Returns:

The populated UserSettingsInformation instance.

Type
module:model/UserSettingsInformation