Current section

Files

Jump to
docusign lib docusign model user_settings_information.ex
Raw

lib/docusign/model/user_settings_information.ex

# NOTE: This file is auto generated by OpenAPI Generator 6.2.1 (https://openapi-generator.tech).
# Do not edit this file manually.
defmodule DocuSign.Model.UserSettingsInformation do
@moduledoc """
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)
"""
@derive [Poison.Encoder]
defstruct [
:accountManagementGranular,
:adminOnly,
:adminOnlyMetadata,
:allowAutoTagging,
:allowEnvelopeTransferTo,
:allowEnvelopeTransferToMetadata,
:allowEsealRecipients,
:allowEsealRecipientsMetadata,
:allowPowerFormsAdminToAccessAllPowerFormEnvelope,
:allowPowerFormsAdminToAccessAllPowerFormEnvelopeMetadata,
:allowRecipientLanguageSelection,
:allowRecipientLanguageSelectionMetadata,
:allowSendOnBehalfOf,
:allowSendOnBehalfOfMetadata,
:allowSupplementalDocuments,
:allowSupplementalDocumentsMetadata,
:anchorTagVersionedPlacementEnabled,
:apiAccountWideAccess,
:apiAccountWideAccessMetadata,
:apiCanExportAC,
:apiCanExportACMetadata,
:bulkSend,
:bulkSendMetadata,
:canChargeAccount,
:canChargeAccountMetadata,
:canEditSharedAddressbook,
:canEditSharedAddressbookMetadata,
:canLockEnvelopes,
:canLockEnvelopesMetadata,
:canManageAccount,
:canManageAccountMetadata,
:canManageDistributor,
:canManageDistributorMetadata,
:canManageTemplates,
:canManageTemplatesMetadata,
:canSendAPIRequests,
:canSendAPIRequestsMetadata,
:canSendEnvelope,
:canSendEnvelopeMetadata,
:canSendEnvelopesViaSMS,
:canSendEnvelopesViaSMSMetadata,
:canSignEnvelope,
:canSignEnvelopeMetadata,
:canUseScratchpad,
:canUseScratchpadMetadata,
:canUseSmartContracts,
:canUseSmartContractsMetadata,
:disableDocumentUpload,
:disableDocumentUploadMetadata,
:disableOtherActions,
:disableOtherActionsMetadata,
:enableDSPro,
:enableDSProMetadata,
:enableKeyTermsSuggestionsByDocumentType,
:enableKeyTermsSuggestionsByDocumentTypeMetadata,
:enableSequentialSigningAPI,
:enableSequentialSigningAPIMetadata,
:enableSequentialSigningUI,
:enableSequentialSigningUIMetadata,
:enableSignerAttachments,
:enableSignerAttachmentsMetadata,
:enableSignOnPaperOverride,
:enableSignOnPaperOverrideMetadata,
:enableTransactionPoint,
:enableTransactionPointMetadata,
:enableVaulting,
:enableVaultingMetadata,
:expressSendOnly,
:locale,
:localeMetadata,
:localePolicy,
:manageClickwrapsMode,
:manageClickwrapsModeMetadata,
:modifiedBy,
:modifiedByMetadata,
:modifiedDate,
:modifiedDateMetadata,
:modifiedPage,
:modifiedPageMetadata,
:newSendUI,
:newSendUIMetadata,
:powerFormMode,
:powerFormModeMetadata,
:recipientViewedNotification,
:recipientViewedNotificationMetadata,
:sealIdentifiers,
:selfSignedRecipientEmailDocument,
:selfSignedRecipientEmailDocumentMetadata,
:senderEmailNotifications,
:signerEmailNotifications,
:supplementalDocumentIncludeInDownload,
:supplementalDocumentsMustAccept,
:supplementalDocumentsMustAcceptMetadata,
:supplementalDocumentsMustRead,
:supplementalDocumentsMustReadMetadata,
:supplementalDocumentsMustView,
:supplementalDocumentsMustViewMetadata,
:templateActiveCreation,
:templateActiveCreationMetadata,
:templateApplyNotify,
:templateApplyNotifyMetadata,
:templateAutoMatching,
:templateAutoMatchingMetadata,
:templateMatchingSensitivity,
:templateMatchingSensitivityMetadata,
:templatePageLevelMatching,
:templatePageLevelMatchingMetadata,
:timezoneDST,
:timezoneDSTMetadata,
:timezoneMask,
:timezoneMaskMetadata,
:timezoneOffset,
:timezoneOffsetMetadata,
:timezoneSendingPref,
:timezoneSendingPrefMetadata,
:timezoneSigningPref,
:timezoneSigningPrefMetadata,
:transactionPointSiteNameURL,
:transactionPointSiteNameURLMetadata,
:transactionPointUserName,
:transactionPointUserNameMetadata,
:vaultingMode,
:vaultingModeMetadata,
:webForms,
:webFormsMetadata
]
@type t :: %__MODULE__{
:accountManagementGranular =>
DocuSign.Model.UserAccountManagementGranularInformation.t() | nil,
:adminOnly => String.t() | nil,
:adminOnlyMetadata => DocuSign.Model.SettingsMetadata.t() | nil,
:allowAutoTagging => String.t() | nil,
:allowEnvelopeTransferTo => String.t() | nil,
:allowEnvelopeTransferToMetadata => DocuSign.Model.SettingsMetadata.t() | nil,
:allowEsealRecipients => String.t() | nil,
:allowEsealRecipientsMetadata => DocuSign.Model.SettingsMetadata.t() | nil,
:allowPowerFormsAdminToAccessAllPowerFormEnvelope => String.t() | nil,
:allowPowerFormsAdminToAccessAllPowerFormEnvelopeMetadata =>
DocuSign.Model.SettingsMetadata.t() | nil,
:allowRecipientLanguageSelection => String.t() | nil,
:allowRecipientLanguageSelectionMetadata => DocuSign.Model.SettingsMetadata.t() | nil,
:allowSendOnBehalfOf => String.t() | nil,
:allowSendOnBehalfOfMetadata => DocuSign.Model.SettingsMetadata.t() | nil,
:allowSupplementalDocuments => String.t() | nil,
:allowSupplementalDocumentsMetadata => DocuSign.Model.SettingsMetadata.t() | nil,
:anchorTagVersionedPlacementEnabled => String.t() | nil,
:apiAccountWideAccess => String.t() | nil,
:apiAccountWideAccessMetadata => DocuSign.Model.SettingsMetadata.t() | nil,
:apiCanExportAC => String.t() | nil,
:apiCanExportACMetadata => DocuSign.Model.SettingsMetadata.t() | nil,
:bulkSend => String.t() | nil,
:bulkSendMetadata => DocuSign.Model.SettingsMetadata.t() | nil,
:canChargeAccount => String.t() | nil,
:canChargeAccountMetadata => DocuSign.Model.SettingsMetadata.t() | nil,
:canEditSharedAddressbook => String.t() | nil,
:canEditSharedAddressbookMetadata => DocuSign.Model.SettingsMetadata.t() | nil,
:canLockEnvelopes => String.t() | nil,
:canLockEnvelopesMetadata => DocuSign.Model.SettingsMetadata.t() | nil,
:canManageAccount => String.t() | nil,
:canManageAccountMetadata => DocuSign.Model.SettingsMetadata.t() | nil,
:canManageDistributor => String.t() | nil,
:canManageDistributorMetadata => DocuSign.Model.SettingsMetadata.t() | nil,
:canManageTemplates => String.t() | nil,
:canManageTemplatesMetadata => DocuSign.Model.SettingsMetadata.t() | nil,
:canSendAPIRequests => String.t() | nil,
:canSendAPIRequestsMetadata => DocuSign.Model.SettingsMetadata.t() | nil,
:canSendEnvelope => String.t() | nil,
:canSendEnvelopeMetadata => DocuSign.Model.SettingsMetadata.t() | nil,
:canSendEnvelopesViaSMS => String.t() | nil,
:canSendEnvelopesViaSMSMetadata => DocuSign.Model.SettingsMetadata.t() | nil,
:canSignEnvelope => String.t() | nil,
:canSignEnvelopeMetadata => DocuSign.Model.SettingsMetadata.t() | nil,
:canUseScratchpad => String.t() | nil,
:canUseScratchpadMetadata => DocuSign.Model.SettingsMetadata.t() | nil,
:canUseSmartContracts => String.t() | nil,
:canUseSmartContractsMetadata => DocuSign.Model.SettingsMetadata.t() | nil,
:disableDocumentUpload => String.t() | nil,
:disableDocumentUploadMetadata => DocuSign.Model.SettingsMetadata.t() | nil,
:disableOtherActions => String.t() | nil,
:disableOtherActionsMetadata => DocuSign.Model.SettingsMetadata.t() | nil,
:enableDSPro => String.t() | nil,
:enableDSProMetadata => DocuSign.Model.SettingsMetadata.t() | nil,
:enableKeyTermsSuggestionsByDocumentType => String.t() | nil,
:enableKeyTermsSuggestionsByDocumentTypeMetadata =>
DocuSign.Model.SettingsMetadata.t() | nil,
:enableSequentialSigningAPI => String.t() | nil,
:enableSequentialSigningAPIMetadata => DocuSign.Model.SettingsMetadata.t() | nil,
:enableSequentialSigningUI => String.t() | nil,
:enableSequentialSigningUIMetadata => DocuSign.Model.SettingsMetadata.t() | nil,
:enableSignerAttachments => String.t() | nil,
:enableSignerAttachmentsMetadata => DocuSign.Model.SettingsMetadata.t() | nil,
:enableSignOnPaperOverride => String.t() | nil,
:enableSignOnPaperOverrideMetadata => DocuSign.Model.SettingsMetadata.t() | nil,
:enableTransactionPoint => String.t() | nil,
:enableTransactionPointMetadata => DocuSign.Model.SettingsMetadata.t() | nil,
:enableVaulting => String.t() | nil,
:enableVaultingMetadata => DocuSign.Model.SettingsMetadata.t() | nil,
:expressSendOnly => String.t() | nil,
:locale => String.t() | nil,
:localeMetadata => DocuSign.Model.SettingsMetadata.t() | nil,
:localePolicy => DocuSign.Model.LocalePolicy.t() | nil,
:manageClickwrapsMode => String.t() | nil,
:manageClickwrapsModeMetadata => DocuSign.Model.SettingsMetadata.t() | nil,
:modifiedBy => String.t() | nil,
:modifiedByMetadata => DocuSign.Model.SettingsMetadata.t() | nil,
:modifiedDate => String.t() | nil,
:modifiedDateMetadata => DocuSign.Model.SettingsMetadata.t() | nil,
:modifiedPage => String.t() | nil,
:modifiedPageMetadata => DocuSign.Model.SettingsMetadata.t() | nil,
:newSendUI => String.t() | nil,
:newSendUIMetadata => DocuSign.Model.SettingsMetadata.t() | nil,
:powerFormMode => String.t() | nil,
:powerFormModeMetadata => DocuSign.Model.SettingsMetadata.t() | nil,
:recipientViewedNotification => String.t() | nil,
:recipientViewedNotificationMetadata => DocuSign.Model.SettingsMetadata.t() | nil,
:sealIdentifiers => [DocuSign.Model.SealIdentifier.t()] | nil,
:selfSignedRecipientEmailDocument => String.t() | nil,
:selfSignedRecipientEmailDocumentMetadata => DocuSign.Model.SettingsMetadata.t() | nil,
:senderEmailNotifications => DocuSign.Model.SenderEmailNotifications.t() | nil,
:signerEmailNotifications => DocuSign.Model.SignerEmailNotifications.t() | nil,
:supplementalDocumentIncludeInDownload => String.t() | nil,
:supplementalDocumentsMustAccept => String.t() | nil,
:supplementalDocumentsMustAcceptMetadata => DocuSign.Model.SettingsMetadata.t() | nil,
:supplementalDocumentsMustRead => String.t() | nil,
:supplementalDocumentsMustReadMetadata => DocuSign.Model.SettingsMetadata.t() | nil,
:supplementalDocumentsMustView => String.t() | nil,
:supplementalDocumentsMustViewMetadata => DocuSign.Model.SettingsMetadata.t() | nil,
:templateActiveCreation => String.t() | nil,
:templateActiveCreationMetadata => DocuSign.Model.SettingsMetadata.t() | nil,
:templateApplyNotify => String.t() | nil,
:templateApplyNotifyMetadata => DocuSign.Model.SettingsMetadata.t() | nil,
:templateAutoMatching => String.t() | nil,
:templateAutoMatchingMetadata => DocuSign.Model.SettingsMetadata.t() | nil,
:templateMatchingSensitivity => String.t() | nil,
:templateMatchingSensitivityMetadata => DocuSign.Model.SettingsMetadata.t() | nil,
:templatePageLevelMatching => String.t() | nil,
:templatePageLevelMatchingMetadata => DocuSign.Model.SettingsMetadata.t() | nil,
:timezoneDST => String.t() | nil,
:timezoneDSTMetadata => DocuSign.Model.SettingsMetadata.t() | nil,
:timezoneMask => String.t() | nil,
:timezoneMaskMetadata => DocuSign.Model.SettingsMetadata.t() | nil,
:timezoneOffset => String.t() | nil,
:timezoneOffsetMetadata => DocuSign.Model.SettingsMetadata.t() | nil,
:timezoneSendingPref => String.t() | nil,
:timezoneSendingPrefMetadata => DocuSign.Model.SettingsMetadata.t() | nil,
:timezoneSigningPref => String.t() | nil,
:timezoneSigningPrefMetadata => DocuSign.Model.SettingsMetadata.t() | nil,
:transactionPointSiteNameURL => String.t() | nil,
:transactionPointSiteNameURLMetadata => DocuSign.Model.SettingsMetadata.t() | nil,
:transactionPointUserName => String.t() | nil,
:transactionPointUserNameMetadata => DocuSign.Model.SettingsMetadata.t() | nil,
:vaultingMode => String.t() | nil,
:vaultingModeMetadata => DocuSign.Model.SettingsMetadata.t() | nil,
:webForms => String.t() | nil,
:webFormsMetadata => DocuSign.Model.SettingsMetadata.t() | nil
}
end
defimpl Poison.Decoder, for: DocuSign.Model.UserSettingsInformation do
import DocuSign.Deserializer
def decode(value, options) do
value
|> deserialize(
:accountManagementGranular,
:struct,
DocuSign.Model.UserAccountManagementGranularInformation,
options
)
|> deserialize(:adminOnlyMetadata, :struct, DocuSign.Model.SettingsMetadata, options)
|> deserialize(
:allowEnvelopeTransferToMetadata,
:struct,
DocuSign.Model.SettingsMetadata,
options
)
|> deserialize(
:allowEsealRecipientsMetadata,
:struct,
DocuSign.Model.SettingsMetadata,
options
)
|> deserialize(
:allowPowerFormsAdminToAccessAllPowerFormEnvelopeMetadata,
:struct,
DocuSign.Model.SettingsMetadata,
options
)
|> deserialize(
:allowRecipientLanguageSelectionMetadata,
:struct,
DocuSign.Model.SettingsMetadata,
options
)
|> deserialize(
:allowSendOnBehalfOfMetadata,
:struct,
DocuSign.Model.SettingsMetadata,
options
)
|> deserialize(
:allowSupplementalDocumentsMetadata,
:struct,
DocuSign.Model.SettingsMetadata,
options
)
|> deserialize(
:apiAccountWideAccessMetadata,
:struct,
DocuSign.Model.SettingsMetadata,
options
)
|> deserialize(:apiCanExportACMetadata, :struct, DocuSign.Model.SettingsMetadata, options)
|> deserialize(:bulkSendMetadata, :struct, DocuSign.Model.SettingsMetadata, options)
|> deserialize(:canChargeAccountMetadata, :struct, DocuSign.Model.SettingsMetadata, options)
|> deserialize(
:canEditSharedAddressbookMetadata,
:struct,
DocuSign.Model.SettingsMetadata,
options
)
|> deserialize(:canLockEnvelopesMetadata, :struct, DocuSign.Model.SettingsMetadata, options)
|> deserialize(:canManageAccountMetadata, :struct, DocuSign.Model.SettingsMetadata, options)
|> deserialize(
:canManageDistributorMetadata,
:struct,
DocuSign.Model.SettingsMetadata,
options
)
|> deserialize(:canManageTemplatesMetadata, :struct, DocuSign.Model.SettingsMetadata, options)
|> deserialize(:canSendAPIRequestsMetadata, :struct, DocuSign.Model.SettingsMetadata, options)
|> deserialize(:canSendEnvelopeMetadata, :struct, DocuSign.Model.SettingsMetadata, options)
|> deserialize(
:canSendEnvelopesViaSMSMetadata,
:struct,
DocuSign.Model.SettingsMetadata,
options
)
|> deserialize(:canSignEnvelopeMetadata, :struct, DocuSign.Model.SettingsMetadata, options)
|> deserialize(:canUseScratchpadMetadata, :struct, DocuSign.Model.SettingsMetadata, options)
|> deserialize(
:canUseSmartContractsMetadata,
:struct,
DocuSign.Model.SettingsMetadata,
options
)
|> deserialize(
:disableDocumentUploadMetadata,
:struct,
DocuSign.Model.SettingsMetadata,
options
)
|> deserialize(
:disableOtherActionsMetadata,
:struct,
DocuSign.Model.SettingsMetadata,
options
)
|> deserialize(:enableDSProMetadata, :struct, DocuSign.Model.SettingsMetadata, options)
|> deserialize(
:enableKeyTermsSuggestionsByDocumentTypeMetadata,
:struct,
DocuSign.Model.SettingsMetadata,
options
)
|> deserialize(
:enableSequentialSigningAPIMetadata,
:struct,
DocuSign.Model.SettingsMetadata,
options
)
|> deserialize(
:enableSequentialSigningUIMetadata,
:struct,
DocuSign.Model.SettingsMetadata,
options
)
|> deserialize(
:enableSignerAttachmentsMetadata,
:struct,
DocuSign.Model.SettingsMetadata,
options
)
|> deserialize(
:enableSignOnPaperOverrideMetadata,
:struct,
DocuSign.Model.SettingsMetadata,
options
)
|> deserialize(
:enableTransactionPointMetadata,
:struct,
DocuSign.Model.SettingsMetadata,
options
)
|> deserialize(:enableVaultingMetadata, :struct, DocuSign.Model.SettingsMetadata, options)
|> deserialize(:localeMetadata, :struct, DocuSign.Model.SettingsMetadata, options)
|> deserialize(:localePolicy, :struct, DocuSign.Model.LocalePolicy, options)
|> deserialize(
:manageClickwrapsModeMetadata,
:struct,
DocuSign.Model.SettingsMetadata,
options
)
|> deserialize(:modifiedByMetadata, :struct, DocuSign.Model.SettingsMetadata, options)
|> deserialize(:modifiedDateMetadata, :struct, DocuSign.Model.SettingsMetadata, options)
|> deserialize(:modifiedPageMetadata, :struct, DocuSign.Model.SettingsMetadata, options)
|> deserialize(:newSendUIMetadata, :struct, DocuSign.Model.SettingsMetadata, options)
|> deserialize(:powerFormModeMetadata, :struct, DocuSign.Model.SettingsMetadata, options)
|> deserialize(
:recipientViewedNotificationMetadata,
:struct,
DocuSign.Model.SettingsMetadata,
options
)
|> deserialize(:sealIdentifiers, :list, DocuSign.Model.SealIdentifier, options)
|> deserialize(
:selfSignedRecipientEmailDocumentMetadata,
:struct,
DocuSign.Model.SettingsMetadata,
options
)
|> deserialize(
:senderEmailNotifications,
:struct,
DocuSign.Model.SenderEmailNotifications,
options
)
|> deserialize(
:signerEmailNotifications,
:struct,
DocuSign.Model.SignerEmailNotifications,
options
)
|> deserialize(
:supplementalDocumentsMustAcceptMetadata,
:struct,
DocuSign.Model.SettingsMetadata,
options
)
|> deserialize(
:supplementalDocumentsMustReadMetadata,
:struct,
DocuSign.Model.SettingsMetadata,
options
)
|> deserialize(
:supplementalDocumentsMustViewMetadata,
:struct,
DocuSign.Model.SettingsMetadata,
options
)
|> deserialize(
:templateActiveCreationMetadata,
:struct,
DocuSign.Model.SettingsMetadata,
options
)
|> deserialize(
:templateApplyNotifyMetadata,
:struct,
DocuSign.Model.SettingsMetadata,
options
)
|> deserialize(
:templateAutoMatchingMetadata,
:struct,
DocuSign.Model.SettingsMetadata,
options
)
|> deserialize(
:templateMatchingSensitivityMetadata,
:struct,
DocuSign.Model.SettingsMetadata,
options
)
|> deserialize(
:templatePageLevelMatchingMetadata,
:struct,
DocuSign.Model.SettingsMetadata,
options
)
|> deserialize(:timezoneDSTMetadata, :struct, DocuSign.Model.SettingsMetadata, options)
|> deserialize(:timezoneMaskMetadata, :struct, DocuSign.Model.SettingsMetadata, options)
|> deserialize(:timezoneOffsetMetadata, :struct, DocuSign.Model.SettingsMetadata, options)
|> deserialize(
:timezoneSendingPrefMetadata,
:struct,
DocuSign.Model.SettingsMetadata,
options
)
|> deserialize(
:timezoneSigningPrefMetadata,
:struct,
DocuSign.Model.SettingsMetadata,
options
)
|> deserialize(
:transactionPointSiteNameURLMetadata,
:struct,
DocuSign.Model.SettingsMetadata,
options
)
|> deserialize(
:transactionPointUserNameMetadata,
:struct,
DocuSign.Model.SettingsMetadata,
options
)
|> deserialize(:vaultingModeMetadata, :struct, DocuSign.Model.SettingsMetadata, options)
|> deserialize(:webFormsMetadata, :struct, DocuSign.Model.SettingsMetadata, options)
end
end