Documentation

UserSettingsInformation
in package

DocuSign

eSign

implements ModelInterface, ArrayAccess

UserSettingsInformation Class Doc Comment

Interfaces, Classes, Traits and Enums

ModelInterface: Interface abstracting model access.
ArrayAccess

DISCRIMINATOR = null
$attributeMap : array<string|int, string>: Array of attributes where the key is the local name, and the value is the original name
$container : array<string|int, mixed>: Associative array for storing property values
$getters : array<string|int, string>: Array of attributes to getter functions (for serialization of requests)
$setters : array<string|int, string>: Array of attributes to setter functions (for deserialization of responses)
$swaggerFormats : array<string|int, string>: Array of property to format mappings. Used for (de)serialization
$swaggerModelName : string: The original name of the model.
$swaggerTypes : array<string|int, string>: Array of property to type mappings. Used for (de)serialization
__construct() : mixed: Constructor
__toString() : string: Gets the string presentation of the object
attributeMap() : array<string|int, mixed>: Array of attributes where the key is the local name, and the value is the original name
getAccountManagementGranular() : UserAccountManagementGranularInformation: Gets account_management_granular
getAdminOnly() : string|null: Gets admin_only
getAdminOnlyMetadata() : SettingsMetadata: Gets admin_only_metadata
getAllowAutoTagging() : string|null: Gets allow_auto_tagging
getAllowEnvelopeTransferTo() : string|null: Gets allow_envelope_transfer_to
getAllowEnvelopeTransferToMetadata() : SettingsMetadata: Gets allow_envelope_transfer_to_metadata
getAllowEsealRecipients() : string|null: Gets allow_eseal_recipients
getAllowEsealRecipientsMetadata() : SettingsMetadata: Gets allow_eseal_recipients_metadata
getAllowPowerFormsAdminToAccessAllPowerFormEnvelope() : string|null: Gets allow_power_forms_admin_to_access_all_power_form_envelope
getAllowPowerFormsAdminToAccessAllPowerFormEnvelopeMetadata() : SettingsMetadata: Gets allow_power_forms_admin_to_access_all_power_form_envelope_metadata
getAllowRecipientLanguageSelection() : string|null: Gets allow_recipient_language_selection
getAllowRecipientLanguageSelectionMetadata() : SettingsMetadata: Gets allow_recipient_language_selection_metadata
getAllowSendOnBehalfOf() : string|null: Gets allow_send_on_behalf_of
getAllowSendOnBehalfOfMetadata() : SettingsMetadata: Gets allow_send_on_behalf_of_metadata
getAllowSupplementalDocuments() : string|null: Gets allow_supplemental_documents
getAllowSupplementalDocumentsMetadata() : SettingsMetadata: Gets allow_supplemental_documents_metadata
getAnchorTagVersionedPlacementEnabled() : string|null: Gets anchor_tag_versioned_placement_enabled
getApiAccountWideAccess() : string|null: Gets api_account_wide_access
getApiAccountWideAccessMetadata() : SettingsMetadata: Gets api_account_wide_access_metadata
getApiCanExportAc() : string|null: Gets api_can_export_ac
getApiCanExportAcMetadata() : SettingsMetadata: Gets api_can_export_ac_metadata
getBulkSend() : string|null: Gets bulk_send
getBulkSendMetadata() : SettingsMetadata: Gets bulk_send_metadata
getCanChargeAccount() : string|null: Gets can_charge_account
getCanChargeAccountMetadata() : SettingsMetadata: Gets can_charge_account_metadata
getCanEditSharedAddressbook() : string|null: Gets can_edit_shared_addressbook
getCanEditSharedAddressbookMetadata() : SettingsMetadata: Gets can_edit_shared_addressbook_metadata
getCanLockEnvelopes() : string|null: Gets can_lock_envelopes
getCanLockEnvelopesMetadata() : SettingsMetadata: Gets can_lock_envelopes_metadata
getCanManageAccount() : string|null: Gets can_manage_account
getCanManageAccountMetadata() : SettingsMetadata: Gets can_manage_account_metadata
getCanManageDistributor() : string|null: Gets can_manage_distributor
getCanManageDistributorMetadata() : SettingsMetadata: Gets can_manage_distributor_metadata
getCanManageTemplates() : string|null: Gets can_manage_templates
getCanManageTemplatesMetadata() : SettingsMetadata: Gets can_manage_templates_metadata
getCanSendApiRequests() : string|null: Gets can_send_api_requests
getCanSendApiRequestsMetadata() : SettingsMetadata: Gets can_send_api_requests_metadata
getCanSendEnvelope() : string|null: Gets can_send_envelope
getCanSendEnvelopeMetadata() : SettingsMetadata: Gets can_send_envelope_metadata
getCanSendEnvelopesViaSms() : string|null: Gets can_send_envelopes_via_sms
getCanSendEnvelopesViaSmsMetadata() : SettingsMetadata: Gets can_send_envelopes_via_sms_metadata
getCanSignEnvelope() : string|null: Gets can_sign_envelope
getCanSignEnvelopeMetadata() : SettingsMetadata: Gets can_sign_envelope_metadata
getCanUseScratchpad() : string|null: Gets can_use_scratchpad
getCanUseScratchpadMetadata() : SettingsMetadata: Gets can_use_scratchpad_metadata
getCanUseSmartContracts() : string|null: Gets can_use_smart_contracts
getCanUseSmartContractsMetadata() : SettingsMetadata: Gets can_use_smart_contracts_metadata
getDisableDocumentUpload() : string|null: Gets disable_document_upload
getDisableDocumentUploadMetadata() : SettingsMetadata: Gets disable_document_upload_metadata
getDisableOtherActions() : string|null: Gets disable_other_actions
getDisableOtherActionsMetadata() : SettingsMetadata: Gets disable_other_actions_metadata
getEnableDsPro() : string|null: Gets enable_ds_pro
getEnableDsProMetadata() : SettingsMetadata: Gets enable_ds_pro_metadata
getEnableKeyTermsSuggestionsByDocumentType() : string|null: Gets enable_key_terms_suggestions_by_document_type
getEnableKeyTermsSuggestionsByDocumentTypeMetadata() : SettingsMetadata: Gets enable_key_terms_suggestions_by_document_type_metadata
getEnableSequentialSigningApi() : string|null: Gets enable_sequential_signing_api
getEnableSequentialSigningApiMetadata() : SettingsMetadata: Gets enable_sequential_signing_api_metadata
getEnableSequentialSigningUi() : string|null: Gets enable_sequential_signing_ui
getEnableSequentialSigningUiMetadata() : SettingsMetadata: Gets enable_sequential_signing_ui_metadata
getEnableSignerAttachments() : string|null: Gets enable_signer_attachments
getEnableSignerAttachmentsMetadata() : SettingsMetadata: Gets enable_signer_attachments_metadata
getEnableSignOnPaperOverride() : string|null: Gets enable_sign_on_paper_override
getEnableSignOnPaperOverrideMetadata() : SettingsMetadata: Gets enable_sign_on_paper_override_metadata
getEnableTransactionPoint() : string|null: Gets enable_transaction_point
getEnableTransactionPointMetadata() : SettingsMetadata: Gets enable_transaction_point_metadata
getEnableVaulting() : string|null: Gets enable_vaulting
getEnableVaultingMetadata() : SettingsMetadata: Gets enable_vaulting_metadata
getExpressSendOnly() : string|null: Gets express_send_only
getLocale() : string|null: Gets locale
getLocaleMetadata() : SettingsMetadata: Gets locale_metadata
getLocalePolicy() : LocalePolicy: Gets locale_policy
getManageClickwrapsMode() : string|null: Gets manage_clickwraps_mode
getManageClickwrapsModeMetadata() : SettingsMetadata: Gets manage_clickwraps_mode_metadata
getModelName() : string: The original name of the model.
getModifiedBy() : string|null: Gets modified_by
getModifiedByMetadata() : SettingsMetadata: Gets modified_by_metadata
getModifiedDate() : string|null: Gets modified_date
getModifiedDateMetadata() : SettingsMetadata: Gets modified_date_metadata
getModifiedPage() : string|null: Gets modified_page
getModifiedPageMetadata() : SettingsMetadata: Gets modified_page_metadata
getNewSendUi() : string|null: Gets new_send_ui
getNewSendUiMetadata() : SettingsMetadata: Gets new_send_ui_metadata
getPowerFormMode() : string|null: Gets power_form_mode
getPowerFormModeMetadata() : SettingsMetadata: Gets power_form_mode_metadata
getRecipientViewedNotification() : string|null: Gets recipient_viewed_notification
getRecipientViewedNotificationMetadata() : SettingsMetadata: Gets recipient_viewed_notification_metadata
getSealIdentifiers() : array<string|int, SealIdentifier>: Gets seal_identifiers
getSelfSignedRecipientEmailDocument() : string|null: Gets self_signed_recipient_email_document
getSelfSignedRecipientEmailDocumentMetadata() : SettingsMetadata: Gets self_signed_recipient_email_document_metadata
getSenderEmailNotifications() : SenderEmailNotifications: Gets sender_email_notifications
getSignerEmailNotifications() : SignerEmailNotifications: Gets signer_email_notifications
getSupplementalDocumentIncludeInDownload() : string|null: Gets supplemental_document_include_in_download
getSupplementalDocumentsMustAccept() : string|null: Gets supplemental_documents_must_accept
getSupplementalDocumentsMustAcceptMetadata() : SettingsMetadata: Gets supplemental_documents_must_accept_metadata
getSupplementalDocumentsMustRead() : string|null: Gets supplemental_documents_must_read
getSupplementalDocumentsMustReadMetadata() : SettingsMetadata: Gets supplemental_documents_must_read_metadata
getSupplementalDocumentsMustView() : string|null: Gets supplemental_documents_must_view
getSupplementalDocumentsMustViewMetadata() : SettingsMetadata: Gets supplemental_documents_must_view_metadata
getTemplateActiveCreation() : string|null: Gets template_active_creation
getTemplateActiveCreationMetadata() : SettingsMetadata: Gets template_active_creation_metadata
getTemplateApplyNotify() : string|null: Gets template_apply_notify
getTemplateApplyNotifyMetadata() : SettingsMetadata: Gets template_apply_notify_metadata
getTemplateAutoMatching() : string|null: Gets template_auto_matching
getTemplateAutoMatchingMetadata() : SettingsMetadata: Gets template_auto_matching_metadata
getTemplateMatchingSensitivity() : string|null: Gets template_matching_sensitivity
getTemplateMatchingSensitivityMetadata() : SettingsMetadata: Gets template_matching_sensitivity_metadata
getTemplatePageLevelMatching() : string|null: Gets template_page_level_matching
getTemplatePageLevelMatchingMetadata() : SettingsMetadata: Gets template_page_level_matching_metadata
getters() : array<string|int, mixed>: Array of attributes to getter functions (for serialization of requests)
getTimezoneDst() : string|null: Gets timezone_dst
getTimezoneDstMetadata() : SettingsMetadata: Gets timezone_dst_metadata
getTimezoneMask() : string|null: Gets timezone_mask
getTimezoneMaskMetadata() : SettingsMetadata: Gets timezone_mask_metadata
getTimezoneOffset() : string|null: Gets timezone_offset
getTimezoneOffsetMetadata() : SettingsMetadata: Gets timezone_offset_metadata
getTimezoneSendingPref() : string|null: Gets timezone_sending_pref
getTimezoneSendingPrefMetadata() : SettingsMetadata: Gets timezone_sending_pref_metadata
getTimezoneSigningPref() : string|null: Gets timezone_signing_pref
getTimezoneSigningPrefMetadata() : SettingsMetadata: Gets timezone_signing_pref_metadata
getTransactionPointSiteNameUrl() : string|null: Gets transaction_point_site_name_url
getTransactionPointSiteNameUrlMetadata() : SettingsMetadata: Gets transaction_point_site_name_url_metadata
getTransactionPointUserName() : string|null: Gets transaction_point_user_name
getTransactionPointUserNameMetadata() : SettingsMetadata: Gets transaction_point_user_name_metadata
getVaultingMode() : string|null: Gets vaulting_mode
getVaultingModeMetadata() : SettingsMetadata: Gets vaulting_mode_metadata
getWebForms() : string|null: Gets web_forms
getWebFormsMetadata() : SettingsMetadata: Gets web_forms_metadata
listInvalidProperties() : array<string|int, mixed>: Show all the invalid properties with reasons.
offsetExists() : bool: Returns true if offset exists. False otherwise.
offsetGet() : mixed: Gets offset.
offsetSet() : void: Sets value based on offset.
offsetUnset() : void: Unsets offset.
setAccountManagementGranular() : $this: Sets account_management_granular
setAdminOnly() : $this: Sets admin_only
setAdminOnlyMetadata() : $this: Sets admin_only_metadata
setAllowAutoTagging() : $this: Sets allow_auto_tagging
setAllowEnvelopeTransferTo() : $this: Sets allow_envelope_transfer_to
setAllowEnvelopeTransferToMetadata() : $this: Sets allow_envelope_transfer_to_metadata
setAllowEsealRecipients() : $this: Sets allow_eseal_recipients
setAllowEsealRecipientsMetadata() : $this: Sets allow_eseal_recipients_metadata
setAllowPowerFormsAdminToAccessAllPowerFormEnvelope() : $this: Sets allow_power_forms_admin_to_access_all_power_form_envelope
setAllowPowerFormsAdminToAccessAllPowerFormEnvelopeMetadata() : $this: Sets allow_power_forms_admin_to_access_all_power_form_envelope_metadata
setAllowRecipientLanguageSelection() : $this: Sets allow_recipient_language_selection
setAllowRecipientLanguageSelectionMetadata() : $this: Sets allow_recipient_language_selection_metadata
setAllowSendOnBehalfOf() : $this: Sets allow_send_on_behalf_of
setAllowSendOnBehalfOfMetadata() : $this: Sets allow_send_on_behalf_of_metadata
setAllowSupplementalDocuments() : $this: Sets allow_supplemental_documents
setAllowSupplementalDocumentsMetadata() : $this: Sets allow_supplemental_documents_metadata
setAnchorTagVersionedPlacementEnabled() : $this: Sets anchor_tag_versioned_placement_enabled
setApiAccountWideAccess() : $this: Sets api_account_wide_access
setApiAccountWideAccessMetadata() : $this: Sets api_account_wide_access_metadata
setApiCanExportAc() : $this: Sets api_can_export_ac
setApiCanExportAcMetadata() : $this: Sets api_can_export_ac_metadata
setBulkSend() : $this: Sets bulk_send
setBulkSendMetadata() : $this: Sets bulk_send_metadata
setCanChargeAccount() : $this: Sets can_charge_account
setCanChargeAccountMetadata() : $this: Sets can_charge_account_metadata
setCanEditSharedAddressbook() : $this: Sets can_edit_shared_addressbook
setCanEditSharedAddressbookMetadata() : $this: Sets can_edit_shared_addressbook_metadata
setCanLockEnvelopes() : $this: Sets can_lock_envelopes
setCanLockEnvelopesMetadata() : $this: Sets can_lock_envelopes_metadata
setCanManageAccount() : $this: Sets can_manage_account
setCanManageAccountMetadata() : $this: Sets can_manage_account_metadata
setCanManageDistributor() : $this: Sets can_manage_distributor
setCanManageDistributorMetadata() : $this: Sets can_manage_distributor_metadata
setCanManageTemplates() : $this: Sets can_manage_templates
setCanManageTemplatesMetadata() : $this: Sets can_manage_templates_metadata
setCanSendApiRequests() : $this: Sets can_send_api_requests
setCanSendApiRequestsMetadata() : $this: Sets can_send_api_requests_metadata
setCanSendEnvelope() : $this: Sets can_send_envelope
setCanSendEnvelopeMetadata() : $this: Sets can_send_envelope_metadata
setCanSendEnvelopesViaSms() : $this: Sets can_send_envelopes_via_sms
setCanSendEnvelopesViaSmsMetadata() : $this: Sets can_send_envelopes_via_sms_metadata
setCanSignEnvelope() : $this: Sets can_sign_envelope
setCanSignEnvelopeMetadata() : $this: Sets can_sign_envelope_metadata
setCanUseScratchpad() : $this: Sets can_use_scratchpad
setCanUseScratchpadMetadata() : $this: Sets can_use_scratchpad_metadata
setCanUseSmartContracts() : $this: Sets can_use_smart_contracts
setCanUseSmartContractsMetadata() : $this: Sets can_use_smart_contracts_metadata
setDisableDocumentUpload() : $this: Sets disable_document_upload
setDisableDocumentUploadMetadata() : $this: Sets disable_document_upload_metadata
setDisableOtherActions() : $this: Sets disable_other_actions
setDisableOtherActionsMetadata() : $this: Sets disable_other_actions_metadata
setEnableDsPro() : $this: Sets enable_ds_pro
setEnableDsProMetadata() : $this: Sets enable_ds_pro_metadata
setEnableKeyTermsSuggestionsByDocumentType() : $this: Sets enable_key_terms_suggestions_by_document_type
setEnableKeyTermsSuggestionsByDocumentTypeMetadata() : $this: Sets enable_key_terms_suggestions_by_document_type_metadata
setEnableSequentialSigningApi() : $this: Sets enable_sequential_signing_api
setEnableSequentialSigningApiMetadata() : $this: Sets enable_sequential_signing_api_metadata
setEnableSequentialSigningUi() : $this: Sets enable_sequential_signing_ui
setEnableSequentialSigningUiMetadata() : $this: Sets enable_sequential_signing_ui_metadata
setEnableSignerAttachments() : $this: Sets enable_signer_attachments
setEnableSignerAttachmentsMetadata() : $this: Sets enable_signer_attachments_metadata
setEnableSignOnPaperOverride() : $this: Sets enable_sign_on_paper_override
setEnableSignOnPaperOverrideMetadata() : $this: Sets enable_sign_on_paper_override_metadata
setEnableTransactionPoint() : $this: Sets enable_transaction_point
setEnableTransactionPointMetadata() : $this: Sets enable_transaction_point_metadata
setEnableVaulting() : $this: Sets enable_vaulting
setEnableVaultingMetadata() : $this: Sets enable_vaulting_metadata
setExpressSendOnly() : $this: Sets express_send_only
setLocale() : $this: Sets locale
setLocaleMetadata() : $this: Sets locale_metadata
setLocalePolicy() : $this: Sets locale_policy
setManageClickwrapsMode() : $this: Sets manage_clickwraps_mode
setManageClickwrapsModeMetadata() : $this: Sets manage_clickwraps_mode_metadata
setModifiedBy() : $this: Sets modified_by
setModifiedByMetadata() : $this: Sets modified_by_metadata
setModifiedDate() : $this: Sets modified_date
setModifiedDateMetadata() : $this: Sets modified_date_metadata
setModifiedPage() : $this: Sets modified_page
setModifiedPageMetadata() : $this: Sets modified_page_metadata
setNewSendUi() : $this: Sets new_send_ui
setNewSendUiMetadata() : $this: Sets new_send_ui_metadata
setPowerFormMode() : $this: Sets power_form_mode
setPowerFormModeMetadata() : $this: Sets power_form_mode_metadata
setRecipientViewedNotification() : $this: Sets recipient_viewed_notification
setRecipientViewedNotificationMetadata() : $this: Sets recipient_viewed_notification_metadata
setSealIdentifiers() : $this: Sets seal_identifiers
setSelfSignedRecipientEmailDocument() : $this: Sets self_signed_recipient_email_document
setSelfSignedRecipientEmailDocumentMetadata() : $this: Sets self_signed_recipient_email_document_metadata
setSenderEmailNotifications() : $this: Sets sender_email_notifications
setSignerEmailNotifications() : $this: Sets signer_email_notifications
setSupplementalDocumentIncludeInDownload() : $this: Sets supplemental_document_include_in_download
setSupplementalDocumentsMustAccept() : $this: Sets supplemental_documents_must_accept
setSupplementalDocumentsMustAcceptMetadata() : $this: Sets supplemental_documents_must_accept_metadata
setSupplementalDocumentsMustRead() : $this: Sets supplemental_documents_must_read
setSupplementalDocumentsMustReadMetadata() : $this: Sets supplemental_documents_must_read_metadata
setSupplementalDocumentsMustView() : $this: Sets supplemental_documents_must_view
setSupplementalDocumentsMustViewMetadata() : $this: Sets supplemental_documents_must_view_metadata
setTemplateActiveCreation() : $this: Sets template_active_creation
setTemplateActiveCreationMetadata() : $this: Sets template_active_creation_metadata
setTemplateApplyNotify() : $this: Sets template_apply_notify
setTemplateApplyNotifyMetadata() : $this: Sets template_apply_notify_metadata
setTemplateAutoMatching() : $this: Sets template_auto_matching
setTemplateAutoMatchingMetadata() : $this: Sets template_auto_matching_metadata
setTemplateMatchingSensitivity() : $this: Sets template_matching_sensitivity
setTemplateMatchingSensitivityMetadata() : $this: Sets template_matching_sensitivity_metadata
setTemplatePageLevelMatching() : $this: Sets template_page_level_matching
setTemplatePageLevelMatchingMetadata() : $this: Sets template_page_level_matching_metadata
setters() : array<string|int, mixed>: Array of attributes to setter functions (for deserialization of responses)
setTimezoneDst() : $this: Sets timezone_dst
setTimezoneDstMetadata() : $this: Sets timezone_dst_metadata
setTimezoneMask() : $this: Sets timezone_mask
setTimezoneMaskMetadata() : $this: Sets timezone_mask_metadata
setTimezoneOffset() : $this: Sets timezone_offset
setTimezoneOffsetMetadata() : $this: Sets timezone_offset_metadata
setTimezoneSendingPref() : $this: Sets timezone_sending_pref
setTimezoneSendingPrefMetadata() : $this: Sets timezone_sending_pref_metadata
setTimezoneSigningPref() : $this: Sets timezone_signing_pref
setTimezoneSigningPrefMetadata() : $this: Sets timezone_signing_pref_metadata
setTransactionPointSiteNameUrl() : $this: Sets transaction_point_site_name_url
setTransactionPointSiteNameUrlMetadata() : $this: Sets transaction_point_site_name_url_metadata
setTransactionPointUserName() : $this: Sets transaction_point_user_name
setTransactionPointUserNameMetadata() : $this: Sets transaction_point_user_name_metadata
setVaultingMode() : $this: Sets vaulting_mode
setVaultingModeMetadata() : $this: Sets vaulting_mode_metadata
setWebForms() : $this: Sets web_forms
setWebFormsMetadata() : $this: Sets web_forms_metadata
swaggerFormats() : array<string|int, mixed>: Array of property to format mappings. Used for (de)serialization
swaggerTypes() : array<string|int, mixed>: Array of property to type mappings. Used for (de)serialization
valid() : bool: Validate all the properties in the model return true if all passed

DISCRIMINATOR


    public
        mixed
    DISCRIMINATOR
    = null

$attributeMap

Array of attributes where the key is the local name, and the value is the original name


    protected
    static    array<string|int, string>
    $attributeMap
     = ['account_management_granular' => 'accountManagementGranular', 'admin_only' => 'adminOnly', 'admin_only_metadata' => 'adminOnlyMetadata', 'allow_auto_tagging' => 'allowAutoTagging', 'allow_envelope_transfer_to' => 'allowEnvelopeTransferTo', 'allow_envelope_transfer_to_metadata' => 'allowEnvelopeTransferToMetadata', 'allow_eseal_recipients' => 'allowEsealRecipients', 'allow_eseal_recipients_metadata' => 'allowEsealRecipientsMetadata', 'allow_power_forms_admin_to_access_all_power_form_envelope' => 'allowPowerFormsAdminToAccessAllPowerFormEnvelope', 'allow_power_forms_admin_to_access_all_power_form_envelope_metadata' => 'allowPowerFormsAdminToAccessAllPowerFormEnvelopeMetadata', 'allow_recipient_language_selection' => 'allowRecipientLanguageSelection', 'allow_recipient_language_selection_metadata' => 'allowRecipientLanguageSelectionMetadata', 'allow_send_on_behalf_of' => 'allowSendOnBehalfOf', 'allow_send_on_behalf_of_metadata' => 'allowSendOnBehalfOfMetadata', 'allow_supplemental_documents' => 'allowSupplementalDocuments', 'allow_supplemental_documents_metadata' => 'allowSupplementalDocumentsMetadata', 'anchor_tag_versioned_placement_enabled' => 'anchorTagVersionedPlacementEnabled', 'api_account_wide_access' => 'apiAccountWideAccess', 'api_account_wide_access_metadata' => 'apiAccountWideAccessMetadata', 'api_can_export_ac' => 'apiCanExportAC', 'api_can_export_ac_metadata' => 'apiCanExportACMetadata', 'bulk_send' => 'bulkSend', 'bulk_send_metadata' => 'bulkSendMetadata', 'can_charge_account' => 'canChargeAccount', 'can_charge_account_metadata' => 'canChargeAccountMetadata', 'can_edit_shared_addressbook' => 'canEditSharedAddressbook', 'can_edit_shared_addressbook_metadata' => 'canEditSharedAddressbookMetadata', 'can_lock_envelopes' => 'canLockEnvelopes', 'can_lock_envelopes_metadata' => 'canLockEnvelopesMetadata', 'can_manage_account' => 'canManageAccount', 'can_manage_account_metadata' => 'canManageAccountMetadata', 'can_manage_distributor' => 'canManageDistributor', 'can_manage_distributor_metadata' => 'canManageDistributorMetadata', 'can_manage_templates' => 'canManageTemplates', 'can_manage_templates_metadata' => 'canManageTemplatesMetadata', 'can_send_api_requests' => 'canSendAPIRequests', 'can_send_api_requests_metadata' => 'canSendAPIRequestsMetadata', 'can_send_envelope' => 'canSendEnvelope', 'can_send_envelope_metadata' => 'canSendEnvelopeMetadata', 'can_send_envelopes_via_sms' => 'canSendEnvelopesViaSMS', 'can_send_envelopes_via_sms_metadata' => 'canSendEnvelopesViaSMSMetadata', 'can_sign_envelope' => 'canSignEnvelope', 'can_sign_envelope_metadata' => 'canSignEnvelopeMetadata', 'can_use_scratchpad' => 'canUseScratchpad', 'can_use_scratchpad_metadata' => 'canUseScratchpadMetadata', 'can_use_smart_contracts' => 'canUseSmartContracts', 'can_use_smart_contracts_metadata' => 'canUseSmartContractsMetadata', 'disable_document_upload' => 'disableDocumentUpload', 'disable_document_upload_metadata' => 'disableDocumentUploadMetadata', 'disable_other_actions' => 'disableOtherActions', 'disable_other_actions_metadata' => 'disableOtherActionsMetadata', 'enable_ds_pro' => 'enableDSPro', 'enable_ds_pro_metadata' => 'enableDSProMetadata', 'enable_key_terms_suggestions_by_document_type' => 'enableKeyTermsSuggestionsByDocumentType', 'enable_key_terms_suggestions_by_document_type_metadata' => 'enableKeyTermsSuggestionsByDocumentTypeMetadata', 'enable_sequential_signing_api' => 'enableSequentialSigningAPI', 'enable_sequential_signing_api_metadata' => 'enableSequentialSigningAPIMetadata', 'enable_sequential_signing_ui' => 'enableSequentialSigningUI', 'enable_sequential_signing_ui_metadata' => 'enableSequentialSigningUIMetadata', 'enable_signer_attachments' => 'enableSignerAttachments', 'enable_signer_attachments_metadata' => 'enableSignerAttachmentsMetadata', 'enable_sign_on_paper_override' => 'enableSignOnPaperOverride', 'enable_sign_on_paper_override_metadata' => 'enableSignOnPaperOverrideMetadata', 'enable_transaction_point' => 'enableTransactionPoint', 'enable_transaction_point_metadata' => 'enableTransactionPointMetadata', 'enable_vaulting' => 'enableVaulting', 'enable_vaulting_metadata' => 'enableVaultingMetadata', 'express_send_only' => 'expressSendOnly', 'locale' => 'locale', 'locale_metadata' => 'localeMetadata', 'locale_policy' => 'localePolicy', 'manage_clickwraps_mode' => 'manageClickwrapsMode', 'manage_clickwraps_mode_metadata' => 'manageClickwrapsModeMetadata', 'modified_by' => 'modifiedBy', 'modified_by_metadata' => 'modifiedByMetadata', 'modified_date' => 'modifiedDate', 'modified_date_metadata' => 'modifiedDateMetadata', 'modified_page' => 'modifiedPage', 'modified_page_metadata' => 'modifiedPageMetadata', 'new_send_ui' => 'newSendUI', 'new_send_ui_metadata' => 'newSendUIMetadata', 'power_form_mode' => 'powerFormMode', 'power_form_mode_metadata' => 'powerFormModeMetadata', 'recipient_viewed_notification' => 'recipientViewedNotification', 'recipient_viewed_notification_metadata' => 'recipientViewedNotificationMetadata', 'seal_identifiers' => 'sealIdentifiers', 'self_signed_recipient_email_document' => 'selfSignedRecipientEmailDocument', 'self_signed_recipient_email_document_metadata' => 'selfSignedRecipientEmailDocumentMetadata', 'sender_email_notifications' => 'senderEmailNotifications', 'signer_email_notifications' => 'signerEmailNotifications', 'supplemental_document_include_in_download' => 'supplementalDocumentIncludeInDownload', 'supplemental_documents_must_accept' => 'supplementalDocumentsMustAccept', 'supplemental_documents_must_accept_metadata' => 'supplementalDocumentsMustAcceptMetadata', 'supplemental_documents_must_read' => 'supplementalDocumentsMustRead', 'supplemental_documents_must_read_metadata' => 'supplementalDocumentsMustReadMetadata', 'supplemental_documents_must_view' => 'supplementalDocumentsMustView', 'supplemental_documents_must_view_metadata' => 'supplementalDocumentsMustViewMetadata', 'template_active_creation' => 'templateActiveCreation', 'template_active_creation_metadata' => 'templateActiveCreationMetadata', 'template_apply_notify' => 'templateApplyNotify', 'template_apply_notify_metadata' => 'templateApplyNotifyMetadata', 'template_auto_matching' => 'templateAutoMatching', 'template_auto_matching_metadata' => 'templateAutoMatchingMetadata', 'template_matching_sensitivity' => 'templateMatchingSensitivity', 'template_matching_sensitivity_metadata' => 'templateMatchingSensitivityMetadata', 'template_page_level_matching' => 'templatePageLevelMatching', 'template_page_level_matching_metadata' => 'templatePageLevelMatchingMetadata', 'timezone_dst' => 'timezoneDST', 'timezone_dst_metadata' => 'timezoneDSTMetadata', 'timezone_mask' => 'timezoneMask', 'timezone_mask_metadata' => 'timezoneMaskMetadata', 'timezone_offset' => 'timezoneOffset', 'timezone_offset_metadata' => 'timezoneOffsetMetadata', 'timezone_sending_pref' => 'timezoneSendingPref', 'timezone_sending_pref_metadata' => 'timezoneSendingPrefMetadata', 'timezone_signing_pref' => 'timezoneSigningPref', 'timezone_signing_pref_metadata' => 'timezoneSigningPrefMetadata', 'transaction_point_site_name_url' => 'transactionPointSiteNameURL', 'transaction_point_site_name_url_metadata' => 'transactionPointSiteNameURLMetadata', 'transaction_point_user_name' => 'transactionPointUserName', 'transaction_point_user_name_metadata' => 'transactionPointUserNameMetadata', 'vaulting_mode' => 'vaultingMode', 'vaulting_mode_metadata' => 'vaultingModeMetadata', 'web_forms' => 'webForms', 'web_forms_metadata' => 'webFormsMetadata']

$container

Associative array for storing property values


    protected
        array<string|int, mixed>
    $container
     = []

$getters

Array of attributes to getter functions (for serialization of requests)


    protected
    static    array<string|int, string>
    $getters
     = ['account_management_granular' => 'getAccountManagementGranular', 'admin_only' => 'getAdminOnly', 'admin_only_metadata' => 'getAdminOnlyMetadata', 'allow_auto_tagging' => 'getAllowAutoTagging', 'allow_envelope_transfer_to' => 'getAllowEnvelopeTransferTo', 'allow_envelope_transfer_to_metadata' => 'getAllowEnvelopeTransferToMetadata', 'allow_eseal_recipients' => 'getAllowEsealRecipients', 'allow_eseal_recipients_metadata' => 'getAllowEsealRecipientsMetadata', 'allow_power_forms_admin_to_access_all_power_form_envelope' => 'getAllowPowerFormsAdminToAccessAllPowerFormEnvelope', 'allow_power_forms_admin_to_access_all_power_form_envelope_metadata' => 'getAllowPowerFormsAdminToAccessAllPowerFormEnvelopeMetadata', 'allow_recipient_language_selection' => 'getAllowRecipientLanguageSelection', 'allow_recipient_language_selection_metadata' => 'getAllowRecipientLanguageSelectionMetadata', 'allow_send_on_behalf_of' => 'getAllowSendOnBehalfOf', 'allow_send_on_behalf_of_metadata' => 'getAllowSendOnBehalfOfMetadata', 'allow_supplemental_documents' => 'getAllowSupplementalDocuments', 'allow_supplemental_documents_metadata' => 'getAllowSupplementalDocumentsMetadata', 'anchor_tag_versioned_placement_enabled' => 'getAnchorTagVersionedPlacementEnabled', 'api_account_wide_access' => 'getApiAccountWideAccess', 'api_account_wide_access_metadata' => 'getApiAccountWideAccessMetadata', 'api_can_export_ac' => 'getApiCanExportAc', 'api_can_export_ac_metadata' => 'getApiCanExportAcMetadata', 'bulk_send' => 'getBulkSend', 'bulk_send_metadata' => 'getBulkSendMetadata', 'can_charge_account' => 'getCanChargeAccount', 'can_charge_account_metadata' => 'getCanChargeAccountMetadata', 'can_edit_shared_addressbook' => 'getCanEditSharedAddressbook', 'can_edit_shared_addressbook_metadata' => 'getCanEditSharedAddressbookMetadata', 'can_lock_envelopes' => 'getCanLockEnvelopes', 'can_lock_envelopes_metadata' => 'getCanLockEnvelopesMetadata', 'can_manage_account' => 'getCanManageAccount', 'can_manage_account_metadata' => 'getCanManageAccountMetadata', 'can_manage_distributor' => 'getCanManageDistributor', 'can_manage_distributor_metadata' => 'getCanManageDistributorMetadata', 'can_manage_templates' => 'getCanManageTemplates', 'can_manage_templates_metadata' => 'getCanManageTemplatesMetadata', 'can_send_api_requests' => 'getCanSendApiRequests', 'can_send_api_requests_metadata' => 'getCanSendApiRequestsMetadata', 'can_send_envelope' => 'getCanSendEnvelope', 'can_send_envelope_metadata' => 'getCanSendEnvelopeMetadata', 'can_send_envelopes_via_sms' => 'getCanSendEnvelopesViaSms', 'can_send_envelopes_via_sms_metadata' => 'getCanSendEnvelopesViaSmsMetadata', 'can_sign_envelope' => 'getCanSignEnvelope', 'can_sign_envelope_metadata' => 'getCanSignEnvelopeMetadata', 'can_use_scratchpad' => 'getCanUseScratchpad', 'can_use_scratchpad_metadata' => 'getCanUseScratchpadMetadata', 'can_use_smart_contracts' => 'getCanUseSmartContracts', 'can_use_smart_contracts_metadata' => 'getCanUseSmartContractsMetadata', 'disable_document_upload' => 'getDisableDocumentUpload', 'disable_document_upload_metadata' => 'getDisableDocumentUploadMetadata', 'disable_other_actions' => 'getDisableOtherActions', 'disable_other_actions_metadata' => 'getDisableOtherActionsMetadata', 'enable_ds_pro' => 'getEnableDsPro', 'enable_ds_pro_metadata' => 'getEnableDsProMetadata', 'enable_key_terms_suggestions_by_document_type' => 'getEnableKeyTermsSuggestionsByDocumentType', 'enable_key_terms_suggestions_by_document_type_metadata' => 'getEnableKeyTermsSuggestionsByDocumentTypeMetadata', 'enable_sequential_signing_api' => 'getEnableSequentialSigningApi', 'enable_sequential_signing_api_metadata' => 'getEnableSequentialSigningApiMetadata', 'enable_sequential_signing_ui' => 'getEnableSequentialSigningUi', 'enable_sequential_signing_ui_metadata' => 'getEnableSequentialSigningUiMetadata', 'enable_signer_attachments' => 'getEnableSignerAttachments', 'enable_signer_attachments_metadata' => 'getEnableSignerAttachmentsMetadata', 'enable_sign_on_paper_override' => 'getEnableSignOnPaperOverride', 'enable_sign_on_paper_override_metadata' => 'getEnableSignOnPaperOverrideMetadata', 'enable_transaction_point' => 'getEnableTransactionPoint', 'enable_transaction_point_metadata' => 'getEnableTransactionPointMetadata', 'enable_vaulting' => 'getEnableVaulting', 'enable_vaulting_metadata' => 'getEnableVaultingMetadata', 'express_send_only' => 'getExpressSendOnly', 'locale' => 'getLocale', 'locale_metadata' => 'getLocaleMetadata', 'locale_policy' => 'getLocalePolicy', 'manage_clickwraps_mode' => 'getManageClickwrapsMode', 'manage_clickwraps_mode_metadata' => 'getManageClickwrapsModeMetadata', 'modified_by' => 'getModifiedBy', 'modified_by_metadata' => 'getModifiedByMetadata', 'modified_date' => 'getModifiedDate', 'modified_date_metadata' => 'getModifiedDateMetadata', 'modified_page' => 'getModifiedPage', 'modified_page_metadata' => 'getModifiedPageMetadata', 'new_send_ui' => 'getNewSendUi', 'new_send_ui_metadata' => 'getNewSendUiMetadata', 'power_form_mode' => 'getPowerFormMode', 'power_form_mode_metadata' => 'getPowerFormModeMetadata', 'recipient_viewed_notification' => 'getRecipientViewedNotification', 'recipient_viewed_notification_metadata' => 'getRecipientViewedNotificationMetadata', 'seal_identifiers' => 'getSealIdentifiers', 'self_signed_recipient_email_document' => 'getSelfSignedRecipientEmailDocument', 'self_signed_recipient_email_document_metadata' => 'getSelfSignedRecipientEmailDocumentMetadata', 'sender_email_notifications' => 'getSenderEmailNotifications', 'signer_email_notifications' => 'getSignerEmailNotifications', 'supplemental_document_include_in_download' => 'getSupplementalDocumentIncludeInDownload', 'supplemental_documents_must_accept' => 'getSupplementalDocumentsMustAccept', 'supplemental_documents_must_accept_metadata' => 'getSupplementalDocumentsMustAcceptMetadata', 'supplemental_documents_must_read' => 'getSupplementalDocumentsMustRead', 'supplemental_documents_must_read_metadata' => 'getSupplementalDocumentsMustReadMetadata', 'supplemental_documents_must_view' => 'getSupplementalDocumentsMustView', 'supplemental_documents_must_view_metadata' => 'getSupplementalDocumentsMustViewMetadata', 'template_active_creation' => 'getTemplateActiveCreation', 'template_active_creation_metadata' => 'getTemplateActiveCreationMetadata', 'template_apply_notify' => 'getTemplateApplyNotify', 'template_apply_notify_metadata' => 'getTemplateApplyNotifyMetadata', 'template_auto_matching' => 'getTemplateAutoMatching', 'template_auto_matching_metadata' => 'getTemplateAutoMatchingMetadata', 'template_matching_sensitivity' => 'getTemplateMatchingSensitivity', 'template_matching_sensitivity_metadata' => 'getTemplateMatchingSensitivityMetadata', 'template_page_level_matching' => 'getTemplatePageLevelMatching', 'template_page_level_matching_metadata' => 'getTemplatePageLevelMatchingMetadata', 'timezone_dst' => 'getTimezoneDst', 'timezone_dst_metadata' => 'getTimezoneDstMetadata', 'timezone_mask' => 'getTimezoneMask', 'timezone_mask_metadata' => 'getTimezoneMaskMetadata', 'timezone_offset' => 'getTimezoneOffset', 'timezone_offset_metadata' => 'getTimezoneOffsetMetadata', 'timezone_sending_pref' => 'getTimezoneSendingPref', 'timezone_sending_pref_metadata' => 'getTimezoneSendingPrefMetadata', 'timezone_signing_pref' => 'getTimezoneSigningPref', 'timezone_signing_pref_metadata' => 'getTimezoneSigningPrefMetadata', 'transaction_point_site_name_url' => 'getTransactionPointSiteNameUrl', 'transaction_point_site_name_url_metadata' => 'getTransactionPointSiteNameUrlMetadata', 'transaction_point_user_name' => 'getTransactionPointUserName', 'transaction_point_user_name_metadata' => 'getTransactionPointUserNameMetadata', 'vaulting_mode' => 'getVaultingMode', 'vaulting_mode_metadata' => 'getVaultingModeMetadata', 'web_forms' => 'getWebForms', 'web_forms_metadata' => 'getWebFormsMetadata']

$setters

Array of attributes to setter functions (for deserialization of responses)


    protected
    static    array<string|int, string>
    $setters
     = ['account_management_granular' => 'setAccountManagementGranular', 'admin_only' => 'setAdminOnly', 'admin_only_metadata' => 'setAdminOnlyMetadata', 'allow_auto_tagging' => 'setAllowAutoTagging', 'allow_envelope_transfer_to' => 'setAllowEnvelopeTransferTo', 'allow_envelope_transfer_to_metadata' => 'setAllowEnvelopeTransferToMetadata', 'allow_eseal_recipients' => 'setAllowEsealRecipients', 'allow_eseal_recipients_metadata' => 'setAllowEsealRecipientsMetadata', 'allow_power_forms_admin_to_access_all_power_form_envelope' => 'setAllowPowerFormsAdminToAccessAllPowerFormEnvelope', 'allow_power_forms_admin_to_access_all_power_form_envelope_metadata' => 'setAllowPowerFormsAdminToAccessAllPowerFormEnvelopeMetadata', 'allow_recipient_language_selection' => 'setAllowRecipientLanguageSelection', 'allow_recipient_language_selection_metadata' => 'setAllowRecipientLanguageSelectionMetadata', 'allow_send_on_behalf_of' => 'setAllowSendOnBehalfOf', 'allow_send_on_behalf_of_metadata' => 'setAllowSendOnBehalfOfMetadata', 'allow_supplemental_documents' => 'setAllowSupplementalDocuments', 'allow_supplemental_documents_metadata' => 'setAllowSupplementalDocumentsMetadata', 'anchor_tag_versioned_placement_enabled' => 'setAnchorTagVersionedPlacementEnabled', 'api_account_wide_access' => 'setApiAccountWideAccess', 'api_account_wide_access_metadata' => 'setApiAccountWideAccessMetadata', 'api_can_export_ac' => 'setApiCanExportAc', 'api_can_export_ac_metadata' => 'setApiCanExportAcMetadata', 'bulk_send' => 'setBulkSend', 'bulk_send_metadata' => 'setBulkSendMetadata', 'can_charge_account' => 'setCanChargeAccount', 'can_charge_account_metadata' => 'setCanChargeAccountMetadata', 'can_edit_shared_addressbook' => 'setCanEditSharedAddressbook', 'can_edit_shared_addressbook_metadata' => 'setCanEditSharedAddressbookMetadata', 'can_lock_envelopes' => 'setCanLockEnvelopes', 'can_lock_envelopes_metadata' => 'setCanLockEnvelopesMetadata', 'can_manage_account' => 'setCanManageAccount', 'can_manage_account_metadata' => 'setCanManageAccountMetadata', 'can_manage_distributor' => 'setCanManageDistributor', 'can_manage_distributor_metadata' => 'setCanManageDistributorMetadata', 'can_manage_templates' => 'setCanManageTemplates', 'can_manage_templates_metadata' => 'setCanManageTemplatesMetadata', 'can_send_api_requests' => 'setCanSendApiRequests', 'can_send_api_requests_metadata' => 'setCanSendApiRequestsMetadata', 'can_send_envelope' => 'setCanSendEnvelope', 'can_send_envelope_metadata' => 'setCanSendEnvelopeMetadata', 'can_send_envelopes_via_sms' => 'setCanSendEnvelopesViaSms', 'can_send_envelopes_via_sms_metadata' => 'setCanSendEnvelopesViaSmsMetadata', 'can_sign_envelope' => 'setCanSignEnvelope', 'can_sign_envelope_metadata' => 'setCanSignEnvelopeMetadata', 'can_use_scratchpad' => 'setCanUseScratchpad', 'can_use_scratchpad_metadata' => 'setCanUseScratchpadMetadata', 'can_use_smart_contracts' => 'setCanUseSmartContracts', 'can_use_smart_contracts_metadata' => 'setCanUseSmartContractsMetadata', 'disable_document_upload' => 'setDisableDocumentUpload', 'disable_document_upload_metadata' => 'setDisableDocumentUploadMetadata', 'disable_other_actions' => 'setDisableOtherActions', 'disable_other_actions_metadata' => 'setDisableOtherActionsMetadata', 'enable_ds_pro' => 'setEnableDsPro', 'enable_ds_pro_metadata' => 'setEnableDsProMetadata', 'enable_key_terms_suggestions_by_document_type' => 'setEnableKeyTermsSuggestionsByDocumentType', 'enable_key_terms_suggestions_by_document_type_metadata' => 'setEnableKeyTermsSuggestionsByDocumentTypeMetadata', 'enable_sequential_signing_api' => 'setEnableSequentialSigningApi', 'enable_sequential_signing_api_metadata' => 'setEnableSequentialSigningApiMetadata', 'enable_sequential_signing_ui' => 'setEnableSequentialSigningUi', 'enable_sequential_signing_ui_metadata' => 'setEnableSequentialSigningUiMetadata', 'enable_signer_attachments' => 'setEnableSignerAttachments', 'enable_signer_attachments_metadata' => 'setEnableSignerAttachmentsMetadata', 'enable_sign_on_paper_override' => 'setEnableSignOnPaperOverride', 'enable_sign_on_paper_override_metadata' => 'setEnableSignOnPaperOverrideMetadata', 'enable_transaction_point' => 'setEnableTransactionPoint', 'enable_transaction_point_metadata' => 'setEnableTransactionPointMetadata', 'enable_vaulting' => 'setEnableVaulting', 'enable_vaulting_metadata' => 'setEnableVaultingMetadata', 'express_send_only' => 'setExpressSendOnly', 'locale' => 'setLocale', 'locale_metadata' => 'setLocaleMetadata', 'locale_policy' => 'setLocalePolicy', 'manage_clickwraps_mode' => 'setManageClickwrapsMode', 'manage_clickwraps_mode_metadata' => 'setManageClickwrapsModeMetadata', 'modified_by' => 'setModifiedBy', 'modified_by_metadata' => 'setModifiedByMetadata', 'modified_date' => 'setModifiedDate', 'modified_date_metadata' => 'setModifiedDateMetadata', 'modified_page' => 'setModifiedPage', 'modified_page_metadata' => 'setModifiedPageMetadata', 'new_send_ui' => 'setNewSendUi', 'new_send_ui_metadata' => 'setNewSendUiMetadata', 'power_form_mode' => 'setPowerFormMode', 'power_form_mode_metadata' => 'setPowerFormModeMetadata', 'recipient_viewed_notification' => 'setRecipientViewedNotification', 'recipient_viewed_notification_metadata' => 'setRecipientViewedNotificationMetadata', 'seal_identifiers' => 'setSealIdentifiers', 'self_signed_recipient_email_document' => 'setSelfSignedRecipientEmailDocument', 'self_signed_recipient_email_document_metadata' => 'setSelfSignedRecipientEmailDocumentMetadata', 'sender_email_notifications' => 'setSenderEmailNotifications', 'signer_email_notifications' => 'setSignerEmailNotifications', 'supplemental_document_include_in_download' => 'setSupplementalDocumentIncludeInDownload', 'supplemental_documents_must_accept' => 'setSupplementalDocumentsMustAccept', 'supplemental_documents_must_accept_metadata' => 'setSupplementalDocumentsMustAcceptMetadata', 'supplemental_documents_must_read' => 'setSupplementalDocumentsMustRead', 'supplemental_documents_must_read_metadata' => 'setSupplementalDocumentsMustReadMetadata', 'supplemental_documents_must_view' => 'setSupplementalDocumentsMustView', 'supplemental_documents_must_view_metadata' => 'setSupplementalDocumentsMustViewMetadata', 'template_active_creation' => 'setTemplateActiveCreation', 'template_active_creation_metadata' => 'setTemplateActiveCreationMetadata', 'template_apply_notify' => 'setTemplateApplyNotify', 'template_apply_notify_metadata' => 'setTemplateApplyNotifyMetadata', 'template_auto_matching' => 'setTemplateAutoMatching', 'template_auto_matching_metadata' => 'setTemplateAutoMatchingMetadata', 'template_matching_sensitivity' => 'setTemplateMatchingSensitivity', 'template_matching_sensitivity_metadata' => 'setTemplateMatchingSensitivityMetadata', 'template_page_level_matching' => 'setTemplatePageLevelMatching', 'template_page_level_matching_metadata' => 'setTemplatePageLevelMatchingMetadata', 'timezone_dst' => 'setTimezoneDst', 'timezone_dst_metadata' => 'setTimezoneDstMetadata', 'timezone_mask' => 'setTimezoneMask', 'timezone_mask_metadata' => 'setTimezoneMaskMetadata', 'timezone_offset' => 'setTimezoneOffset', 'timezone_offset_metadata' => 'setTimezoneOffsetMetadata', 'timezone_sending_pref' => 'setTimezoneSendingPref', 'timezone_sending_pref_metadata' => 'setTimezoneSendingPrefMetadata', 'timezone_signing_pref' => 'setTimezoneSigningPref', 'timezone_signing_pref_metadata' => 'setTimezoneSigningPrefMetadata', 'transaction_point_site_name_url' => 'setTransactionPointSiteNameUrl', 'transaction_point_site_name_url_metadata' => 'setTransactionPointSiteNameUrlMetadata', 'transaction_point_user_name' => 'setTransactionPointUserName', 'transaction_point_user_name_metadata' => 'setTransactionPointUserNameMetadata', 'vaulting_mode' => 'setVaultingMode', 'vaulting_mode_metadata' => 'setVaultingModeMetadata', 'web_forms' => 'setWebForms', 'web_forms_metadata' => 'setWebFormsMetadata']

$swaggerFormats

Array of property to format mappings. Used for (de)serialization


    protected
    static    array<string|int, string>
    $swaggerFormats
     = ['account_management_granular' => null, 'admin_only' => null, 'admin_only_metadata' => null, 'allow_auto_tagging' => null, 'allow_envelope_transfer_to' => null, 'allow_envelope_transfer_to_metadata' => null, 'allow_eseal_recipients' => null, 'allow_eseal_recipients_metadata' => null, 'allow_power_forms_admin_to_access_all_power_form_envelope' => null, 'allow_power_forms_admin_to_access_all_power_form_envelope_metadata' => null, 'allow_recipient_language_selection' => null, 'allow_recipient_language_selection_metadata' => null, 'allow_send_on_behalf_of' => null, 'allow_send_on_behalf_of_metadata' => null, 'allow_supplemental_documents' => null, 'allow_supplemental_documents_metadata' => null, 'anchor_tag_versioned_placement_enabled' => null, 'api_account_wide_access' => null, 'api_account_wide_access_metadata' => null, 'api_can_export_ac' => null, 'api_can_export_ac_metadata' => null, 'bulk_send' => null, 'bulk_send_metadata' => null, 'can_charge_account' => null, 'can_charge_account_metadata' => null, 'can_edit_shared_addressbook' => null, 'can_edit_shared_addressbook_metadata' => null, 'can_lock_envelopes' => null, 'can_lock_envelopes_metadata' => null, 'can_manage_account' => null, 'can_manage_account_metadata' => null, 'can_manage_distributor' => null, 'can_manage_distributor_metadata' => null, 'can_manage_templates' => null, 'can_manage_templates_metadata' => null, 'can_send_api_requests' => null, 'can_send_api_requests_metadata' => null, 'can_send_envelope' => null, 'can_send_envelope_metadata' => null, 'can_send_envelopes_via_sms' => null, 'can_send_envelopes_via_sms_metadata' => null, 'can_sign_envelope' => null, 'can_sign_envelope_metadata' => null, 'can_use_scratchpad' => null, 'can_use_scratchpad_metadata' => null, 'can_use_smart_contracts' => null, 'can_use_smart_contracts_metadata' => null, 'disable_document_upload' => null, 'disable_document_upload_metadata' => null, 'disable_other_actions' => null, 'disable_other_actions_metadata' => null, 'enable_ds_pro' => null, 'enable_ds_pro_metadata' => null, 'enable_key_terms_suggestions_by_document_type' => null, 'enable_key_terms_suggestions_by_document_type_metadata' => null, 'enable_sequential_signing_api' => null, 'enable_sequential_signing_api_metadata' => null, 'enable_sequential_signing_ui' => null, 'enable_sequential_signing_ui_metadata' => null, 'enable_signer_attachments' => null, 'enable_signer_attachments_metadata' => null, 'enable_sign_on_paper_override' => null, 'enable_sign_on_paper_override_metadata' => null, 'enable_transaction_point' => null, 'enable_transaction_point_metadata' => null, 'enable_vaulting' => null, 'enable_vaulting_metadata' => null, 'express_send_only' => null, 'locale' => null, 'locale_metadata' => null, 'locale_policy' => null, 'manage_clickwraps_mode' => null, 'manage_clickwraps_mode_metadata' => null, 'modified_by' => null, 'modified_by_metadata' => null, 'modified_date' => null, 'modified_date_metadata' => null, 'modified_page' => null, 'modified_page_metadata' => null, 'new_send_ui' => null, 'new_send_ui_metadata' => null, 'power_form_mode' => null, 'power_form_mode_metadata' => null, 'recipient_viewed_notification' => null, 'recipient_viewed_notification_metadata' => null, 'seal_identifiers' => null, 'self_signed_recipient_email_document' => null, 'self_signed_recipient_email_document_metadata' => null, 'sender_email_notifications' => null, 'signer_email_notifications' => null, 'supplemental_document_include_in_download' => null, 'supplemental_documents_must_accept' => null, 'supplemental_documents_must_accept_metadata' => null, 'supplemental_documents_must_read' => null, 'supplemental_documents_must_read_metadata' => null, 'supplemental_documents_must_view' => null, 'supplemental_documents_must_view_metadata' => null, 'template_active_creation' => null, 'template_active_creation_metadata' => null, 'template_apply_notify' => null, 'template_apply_notify_metadata' => null, 'template_auto_matching' => null, 'template_auto_matching_metadata' => null, 'template_matching_sensitivity' => null, 'template_matching_sensitivity_metadata' => null, 'template_page_level_matching' => null, 'template_page_level_matching_metadata' => null, 'timezone_dst' => null, 'timezone_dst_metadata' => null, 'timezone_mask' => null, 'timezone_mask_metadata' => null, 'timezone_offset' => null, 'timezone_offset_metadata' => null, 'timezone_sending_pref' => null, 'timezone_sending_pref_metadata' => null, 'timezone_signing_pref' => null, 'timezone_signing_pref_metadata' => null, 'transaction_point_site_name_url' => null, 'transaction_point_site_name_url_metadata' => null, 'transaction_point_user_name' => null, 'transaction_point_user_name_metadata' => null, 'vaulting_mode' => null, 'vaulting_mode_metadata' => null, 'web_forms' => null, 'web_forms_metadata' => null]

$swaggerModelName

The original name of the model.


    protected
    static    string
    $swaggerModelName
     = 'userSettingsInformation'

$swaggerTypes

Array of property to type mappings. Used for (de)serialization


    protected
    static    array<string|int, string>
    $swaggerTypes
     = ['account_management_granular' => '\\DocuSign\\eSign\\Model\\UserAccountManagementGranularInformation', 'admin_only' => '?string', 'admin_only_metadata' => '\\DocuSign\\eSign\\Model\\SettingsMetadata', 'allow_auto_tagging' => '?string', 'allow_envelope_transfer_to' => '?string', 'allow_envelope_transfer_to_metadata' => '\\DocuSign\\eSign\\Model\\SettingsMetadata', 'allow_eseal_recipients' => '?string', 'allow_eseal_recipients_metadata' => '\\DocuSign\\eSign\\Model\\SettingsMetadata', 'allow_power_forms_admin_to_access_all_power_form_envelope' => '?string', 'allow_power_forms_admin_to_access_all_power_form_envelope_metadata' => '\\DocuSign\\eSign\\Model\\SettingsMetadata', 'allow_recipient_language_selection' => '?string', 'allow_recipient_language_selection_metadata' => '\\DocuSign\\eSign\\Model\\SettingsMetadata', 'allow_send_on_behalf_of' => '?string', 'allow_send_on_behalf_of_metadata' => '\\DocuSign\\eSign\\Model\\SettingsMetadata', 'allow_supplemental_documents' => '?string', 'allow_supplemental_documents_metadata' => '\\DocuSign\\eSign\\Model\\SettingsMetadata', 'anchor_tag_versioned_placement_enabled' => '?string', 'api_account_wide_access' => '?string', 'api_account_wide_access_metadata' => '\\DocuSign\\eSign\\Model\\SettingsMetadata', 'api_can_export_ac' => '?string', 'api_can_export_ac_metadata' => '\\DocuSign\\eSign\\Model\\SettingsMetadata', 'bulk_send' => '?string', 'bulk_send_metadata' => '\\DocuSign\\eSign\\Model\\SettingsMetadata', 'can_charge_account' => '?string', 'can_charge_account_metadata' => '\\DocuSign\\eSign\\Model\\SettingsMetadata', 'can_edit_shared_addressbook' => '?string', 'can_edit_shared_addressbook_metadata' => '\\DocuSign\\eSign\\Model\\SettingsMetadata', 'can_lock_envelopes' => '?string', 'can_lock_envelopes_metadata' => '\\DocuSign\\eSign\\Model\\SettingsMetadata', 'can_manage_account' => '?string', 'can_manage_account_metadata' => '\\DocuSign\\eSign\\Model\\SettingsMetadata', 'can_manage_distributor' => '?string', 'can_manage_distributor_metadata' => '\\DocuSign\\eSign\\Model\\SettingsMetadata', 'can_manage_templates' => '?string', 'can_manage_templates_metadata' => '\\DocuSign\\eSign\\Model\\SettingsMetadata', 'can_send_api_requests' => '?string', 'can_send_api_requests_metadata' => '\\DocuSign\\eSign\\Model\\SettingsMetadata', 'can_send_envelope' => '?string', 'can_send_envelope_metadata' => '\\DocuSign\\eSign\\Model\\SettingsMetadata', 'can_send_envelopes_via_sms' => '?string', 'can_send_envelopes_via_sms_metadata' => '\\DocuSign\\eSign\\Model\\SettingsMetadata', 'can_sign_envelope' => '?string', 'can_sign_envelope_metadata' => '\\DocuSign\\eSign\\Model\\SettingsMetadata', 'can_use_scratchpad' => '?string', 'can_use_scratchpad_metadata' => '\\DocuSign\\eSign\\Model\\SettingsMetadata', 'can_use_smart_contracts' => '?string', 'can_use_smart_contracts_metadata' => '\\DocuSign\\eSign\\Model\\SettingsMetadata', 'disable_document_upload' => '?string', 'disable_document_upload_metadata' => '\\DocuSign\\eSign\\Model\\SettingsMetadata', 'disable_other_actions' => '?string', 'disable_other_actions_metadata' => '\\DocuSign\\eSign\\Model\\SettingsMetadata', 'enable_ds_pro' => '?string', 'enable_ds_pro_metadata' => '\\DocuSign\\eSign\\Model\\SettingsMetadata', 'enable_key_terms_suggestions_by_document_type' => '?string', 'enable_key_terms_suggestions_by_document_type_metadata' => '\\DocuSign\\eSign\\Model\\SettingsMetadata', 'enable_sequential_signing_api' => '?string', 'enable_sequential_signing_api_metadata' => '\\DocuSign\\eSign\\Model\\SettingsMetadata', 'enable_sequential_signing_ui' => '?string', 'enable_sequential_signing_ui_metadata' => '\\DocuSign\\eSign\\Model\\SettingsMetadata', 'enable_signer_attachments' => '?string', 'enable_signer_attachments_metadata' => '\\DocuSign\\eSign\\Model\\SettingsMetadata', 'enable_sign_on_paper_override' => '?string', 'enable_sign_on_paper_override_metadata' => '\\DocuSign\\eSign\\Model\\SettingsMetadata', 'enable_transaction_point' => '?string', 'enable_transaction_point_metadata' => '\\DocuSign\\eSign\\Model\\SettingsMetadata', 'enable_vaulting' => '?string', 'enable_vaulting_metadata' => '\\DocuSign\\eSign\\Model\\SettingsMetadata', 'express_send_only' => '?string', 'locale' => '?string', 'locale_metadata' => '\\DocuSign\\eSign\\Model\\SettingsMetadata', 'locale_policy' => '\\DocuSign\\eSign\\Model\\LocalePolicy', 'manage_clickwraps_mode' => '?string', 'manage_clickwraps_mode_metadata' => '\\DocuSign\\eSign\\Model\\SettingsMetadata', 'modified_by' => '?string', 'modified_by_metadata' => '\\DocuSign\\eSign\\Model\\SettingsMetadata', 'modified_date' => '?string', 'modified_date_metadata' => '\\DocuSign\\eSign\\Model\\SettingsMetadata', 'modified_page' => '?string', 'modified_page_metadata' => '\\DocuSign\\eSign\\Model\\SettingsMetadata', 'new_send_ui' => '?string', 'new_send_ui_metadata' => '\\DocuSign\\eSign\\Model\\SettingsMetadata', 'power_form_mode' => '?string', 'power_form_mode_metadata' => '\\DocuSign\\eSign\\Model\\SettingsMetadata', 'recipient_viewed_notification' => '?string', 'recipient_viewed_notification_metadata' => '\\DocuSign\\eSign\\Model\\SettingsMetadata', 'seal_identifiers' => '\\DocuSign\\eSign\\Model\\SealIdentifier[]', 'self_signed_recipient_email_document' => '?string', 'self_signed_recipient_email_document_metadata' => '\\DocuSign\\eSign\\Model\\SettingsMetadata', 'sender_email_notifications' => '\\DocuSign\\eSign\\Model\\SenderEmailNotifications', 'signer_email_notifications' => '\\DocuSign\\eSign\\Model\\SignerEmailNotifications', 'supplemental_document_include_in_download' => '?string', 'supplemental_documents_must_accept' => '?string', 'supplemental_documents_must_accept_metadata' => '\\DocuSign\\eSign\\Model\\SettingsMetadata', 'supplemental_documents_must_read' => '?string', 'supplemental_documents_must_read_metadata' => '\\DocuSign\\eSign\\Model\\SettingsMetadata', 'supplemental_documents_must_view' => '?string', 'supplemental_documents_must_view_metadata' => '\\DocuSign\\eSign\\Model\\SettingsMetadata', 'template_active_creation' => '?string', 'template_active_creation_metadata' => '\\DocuSign\\eSign\\Model\\SettingsMetadata', 'template_apply_notify' => '?string', 'template_apply_notify_metadata' => '\\DocuSign\\eSign\\Model\\SettingsMetadata', 'template_auto_matching' => '?string', 'template_auto_matching_metadata' => '\\DocuSign\\eSign\\Model\\SettingsMetadata', 'template_matching_sensitivity' => '?string', 'template_matching_sensitivity_metadata' => '\\DocuSign\\eSign\\Model\\SettingsMetadata', 'template_page_level_matching' => '?string', 'template_page_level_matching_metadata' => '\\DocuSign\\eSign\\Model\\SettingsMetadata', 'timezone_dst' => '?string', 'timezone_dst_metadata' => '\\DocuSign\\eSign\\Model\\SettingsMetadata', 'timezone_mask' => '?string', 'timezone_mask_metadata' => '\\DocuSign\\eSign\\Model\\SettingsMetadata', 'timezone_offset' => '?string', 'timezone_offset_metadata' => '\\DocuSign\\eSign\\Model\\SettingsMetadata', 'timezone_sending_pref' => '?string', 'timezone_sending_pref_metadata' => '\\DocuSign\\eSign\\Model\\SettingsMetadata', 'timezone_signing_pref' => '?string', 'timezone_signing_pref_metadata' => '\\DocuSign\\eSign\\Model\\SettingsMetadata', 'transaction_point_site_name_url' => '?string', 'transaction_point_site_name_url_metadata' => '\\DocuSign\\eSign\\Model\\SettingsMetadata', 'transaction_point_user_name' => '?string', 'transaction_point_user_name_metadata' => '\\DocuSign\\eSign\\Model\\SettingsMetadata', 'vaulting_mode' => '?string', 'vaulting_mode_metadata' => '\\DocuSign\\eSign\\Model\\SettingsMetadata', 'web_forms' => '?string', 'web_forms_metadata' => '\\DocuSign\\eSign\\Model\\SettingsMetadata']

__construct()

Constructor


    public
                __construct([array<string|int, mixed> $data = null ]) : mixed

Parameters

$data : array<string|int, mixed> = null: Associated array of property values initializing the model

Return values

mixed —

__toString()

Gets the string presentation of the object


    public
                __toString() : string

Return values

string —

attributeMap()

Array of attributes where the key is the local name, and the value is the original name


    public
            static    attributeMap() : array<string|int, mixed>

Return values

array<string|int, mixed> —

getAccountManagementGranular()

Gets account_management_granular


    public
                getAccountManagementGranular() : UserAccountManagementGranularInformation

Return values

UserAccountManagementGranularInformation —

getAdminOnly()

Gets admin_only


    public
                getAdminOnly() : string|null

Return values

string|null —

getAdminOnlyMetadata()

Gets admin_only_metadata


    public
                getAdminOnlyMetadata() : SettingsMetadata

Return values

SettingsMetadata —

getAllowAutoTagging()

Gets allow_auto_tagging


    public
                getAllowAutoTagging() : string|null

Return values

string|null —

getAllowEnvelopeTransferTo()

Gets allow_envelope_transfer_to


    public
                getAllowEnvelopeTransferTo() : string|null

Return values

string|null —

getAllowEnvelopeTransferToMetadata()

Gets allow_envelope_transfer_to_metadata


    public
                getAllowEnvelopeTransferToMetadata() : SettingsMetadata

Return values

SettingsMetadata —

getAllowEsealRecipients()

Gets allow_eseal_recipients


    public
                getAllowEsealRecipients() : string|null

Return values

string|null —

getAllowEsealRecipientsMetadata()

Gets allow_eseal_recipients_metadata


    public
                getAllowEsealRecipientsMetadata() : SettingsMetadata

Return values

SettingsMetadata —

getAllowPowerFormsAdminToAccessAllPowerFormEnvelope()

Gets allow_power_forms_admin_to_access_all_power_form_envelope


    public
                getAllowPowerFormsAdminToAccessAllPowerFormEnvelope() : string|null

Return values

string|null —

getAllowPowerFormsAdminToAccessAllPowerFormEnvelopeMetadata()

Gets allow_power_forms_admin_to_access_all_power_form_envelope_metadata


    public
                getAllowPowerFormsAdminToAccessAllPowerFormEnvelopeMetadata() : SettingsMetadata

Return values

SettingsMetadata —

getAllowRecipientLanguageSelection()

Gets allow_recipient_language_selection


    public
                getAllowRecipientLanguageSelection() : string|null

Return values

string|null —

getAllowRecipientLanguageSelectionMetadata()

Gets allow_recipient_language_selection_metadata


    public
                getAllowRecipientLanguageSelectionMetadata() : SettingsMetadata

Return values

SettingsMetadata —

getAllowSendOnBehalfOf()

Gets allow_send_on_behalf_of


    public
                getAllowSendOnBehalfOf() : string|null

Return values

string|null —

getAllowSendOnBehalfOfMetadata()

Gets allow_send_on_behalf_of_metadata


    public
                getAllowSendOnBehalfOfMetadata() : SettingsMetadata

Return values

SettingsMetadata —

getAllowSupplementalDocuments()

Gets allow_supplemental_documents


    public
                getAllowSupplementalDocuments() : string|null

Return values

string|null —

getAllowSupplementalDocumentsMetadata()

Gets allow_supplemental_documents_metadata


    public
                getAllowSupplementalDocumentsMetadata() : SettingsMetadata

Return values

SettingsMetadata —

getAnchorTagVersionedPlacementEnabled()

Gets anchor_tag_versioned_placement_enabled


    public
                getAnchorTagVersionedPlacementEnabled() : string|null

Return values

string|null —

getApiAccountWideAccess()

Gets api_account_wide_access


    public
                getApiAccountWideAccess() : string|null

Return values

string|null —

getApiAccountWideAccessMetadata()

Gets api_account_wide_access_metadata


    public
                getApiAccountWideAccessMetadata() : SettingsMetadata

Return values

SettingsMetadata —

getApiCanExportAc()

Gets api_can_export_ac


    public
                getApiCanExportAc() : string|null

Return values

string|null —

getApiCanExportAcMetadata()

Gets api_can_export_ac_metadata


    public
                getApiCanExportAcMetadata() : SettingsMetadata

Return values

SettingsMetadata —

getBulkSend()

Gets bulk_send


    public
                getBulkSend() : string|null

Return values

string|null —

getBulkSendMetadata()

Gets bulk_send_metadata


    public
                getBulkSendMetadata() : SettingsMetadata

Return values

SettingsMetadata —

getCanChargeAccount()

Gets can_charge_account


    public
                getCanChargeAccount() : string|null

Return values

string|null —

getCanChargeAccountMetadata()

Gets can_charge_account_metadata


    public
                getCanChargeAccountMetadata() : SettingsMetadata

Return values

SettingsMetadata —

getCanEditSharedAddressbook()

Gets can_edit_shared_addressbook


    public
                getCanEditSharedAddressbook() : string|null

Return values

string|null —

getCanEditSharedAddressbookMetadata()

Gets can_edit_shared_addressbook_metadata


    public
                getCanEditSharedAddressbookMetadata() : SettingsMetadata

Return values

SettingsMetadata —

getCanLockEnvelopes()

Gets can_lock_envelopes


    public
                getCanLockEnvelopes() : string|null

Return values

string|null —

getCanLockEnvelopesMetadata()

Gets can_lock_envelopes_metadata


    public
                getCanLockEnvelopesMetadata() : SettingsMetadata

Return values

SettingsMetadata —

getCanManageAccount()

Gets can_manage_account


    public
                getCanManageAccount() : string|null

Return values

string|null —

getCanManageAccountMetadata()

Gets can_manage_account_metadata


    public
                getCanManageAccountMetadata() : SettingsMetadata

Return values

SettingsMetadata —

getCanManageDistributor()

Gets can_manage_distributor


    public
                getCanManageDistributor() : string|null

Return values

string|null —

getCanManageDistributorMetadata()

Gets can_manage_distributor_metadata


    public
                getCanManageDistributorMetadata() : SettingsMetadata

Return values

SettingsMetadata —

getCanManageTemplates()

Gets can_manage_templates


    public
                getCanManageTemplates() : string|null

Return values

string|null —

getCanManageTemplatesMetadata()

Gets can_manage_templates_metadata


    public
                getCanManageTemplatesMetadata() : SettingsMetadata

Return values

SettingsMetadata —

getCanSendApiRequests()

Gets can_send_api_requests


    public
                getCanSendApiRequests() : string|null

Return values

string|null —

getCanSendApiRequestsMetadata()

Gets can_send_api_requests_metadata


    public
                getCanSendApiRequestsMetadata() : SettingsMetadata

Return values

SettingsMetadata —

getCanSendEnvelope()

Gets can_send_envelope


    public
                getCanSendEnvelope() : string|null

Return values

string|null —

getCanSendEnvelopeMetadata()

Gets can_send_envelope_metadata


    public
                getCanSendEnvelopeMetadata() : SettingsMetadata

Return values

SettingsMetadata —

getCanSendEnvelopesViaSms()

Gets can_send_envelopes_via_sms


    public
                getCanSendEnvelopesViaSms() : string|null

Return values

string|null —

getCanSendEnvelopesViaSmsMetadata()

Gets can_send_envelopes_via_sms_metadata


    public
                getCanSendEnvelopesViaSmsMetadata() : SettingsMetadata

Return values

SettingsMetadata —

getCanSignEnvelope()

Gets can_sign_envelope


    public
                getCanSignEnvelope() : string|null

Return values

string|null —

getCanSignEnvelopeMetadata()

Gets can_sign_envelope_metadata


    public
                getCanSignEnvelopeMetadata() : SettingsMetadata

Return values

SettingsMetadata —

getCanUseScratchpad()

Gets can_use_scratchpad


    public
                getCanUseScratchpad() : string|null

Return values

string|null —

getCanUseScratchpadMetadata()

Gets can_use_scratchpad_metadata


    public
                getCanUseScratchpadMetadata() : SettingsMetadata

Return values

SettingsMetadata —

getCanUseSmartContracts()

Gets can_use_smart_contracts


    public
                getCanUseSmartContracts() : string|null

Return values

string|null —

getCanUseSmartContractsMetadata()

Gets can_use_smart_contracts_metadata


    public
                getCanUseSmartContractsMetadata() : SettingsMetadata

Return values

SettingsMetadata —

getDisableDocumentUpload()

Gets disable_document_upload


    public
                getDisableDocumentUpload() : string|null

Return values

string|null —

getDisableDocumentUploadMetadata()

Gets disable_document_upload_metadata


    public
                getDisableDocumentUploadMetadata() : SettingsMetadata

Return values

SettingsMetadata —

getDisableOtherActions()

Gets disable_other_actions


    public
                getDisableOtherActions() : string|null

Return values

string|null —

getDisableOtherActionsMetadata()

Gets disable_other_actions_metadata


    public
                getDisableOtherActionsMetadata() : SettingsMetadata

Return values

SettingsMetadata —

getEnableDsPro()

Gets enable_ds_pro


    public
                getEnableDsPro() : string|null

Return values

string|null —

getEnableDsProMetadata()

Gets enable_ds_pro_metadata


    public
                getEnableDsProMetadata() : SettingsMetadata

Return values

SettingsMetadata —

getEnableKeyTermsSuggestionsByDocumentType()

Gets enable_key_terms_suggestions_by_document_type


    public
                getEnableKeyTermsSuggestionsByDocumentType() : string|null

Return values

string|null —

getEnableKeyTermsSuggestionsByDocumentTypeMetadata()

Gets enable_key_terms_suggestions_by_document_type_metadata


    public
                getEnableKeyTermsSuggestionsByDocumentTypeMetadata() : SettingsMetadata

Return values

SettingsMetadata —

getEnableSequentialSigningApi()

Gets enable_sequential_signing_api


    public
                getEnableSequentialSigningApi() : string|null

Return values

string|null —

getEnableSequentialSigningApiMetadata()

Gets enable_sequential_signing_api_metadata


    public
                getEnableSequentialSigningApiMetadata() : SettingsMetadata

Return values

SettingsMetadata —

getEnableSequentialSigningUi()

Gets enable_sequential_signing_ui


    public
                getEnableSequentialSigningUi() : string|null

Return values

string|null —

getEnableSequentialSigningUiMetadata()

Gets enable_sequential_signing_ui_metadata


    public
                getEnableSequentialSigningUiMetadata() : SettingsMetadata

Return values

SettingsMetadata —

getEnableSignerAttachments()

Gets enable_signer_attachments


    public
                getEnableSignerAttachments() : string|null

Return values

string|null —

getEnableSignerAttachmentsMetadata()

Gets enable_signer_attachments_metadata


    public
                getEnableSignerAttachmentsMetadata() : SettingsMetadata

Return values

SettingsMetadata —

getEnableSignOnPaperOverride()

Gets enable_sign_on_paper_override


    public
                getEnableSignOnPaperOverride() : string|null

Return values

string|null —

getEnableSignOnPaperOverrideMetadata()

Gets enable_sign_on_paper_override_metadata


    public
                getEnableSignOnPaperOverrideMetadata() : SettingsMetadata

Return values

SettingsMetadata —

getEnableTransactionPoint()

Gets enable_transaction_point


    public
                getEnableTransactionPoint() : string|null

Return values

string|null —

getEnableTransactionPointMetadata()

Gets enable_transaction_point_metadata


    public
                getEnableTransactionPointMetadata() : SettingsMetadata

Return values

SettingsMetadata —

getEnableVaulting()

Gets enable_vaulting


    public
                getEnableVaulting() : string|null

Return values

string|null —

getEnableVaultingMetadata()

Gets enable_vaulting_metadata


    public
                getEnableVaultingMetadata() : SettingsMetadata

Return values

SettingsMetadata —

getExpressSendOnly()

Gets express_send_only


    public
                getExpressSendOnly() : string|null

Return values

string|null —

getLocale()

Gets locale


    public
                getLocale() : string|null

Return values

string|null —

getLocaleMetadata()

Gets locale_metadata


    public
                getLocaleMetadata() : SettingsMetadata

Return values

SettingsMetadata —

getLocalePolicy()

Gets locale_policy


    public
                getLocalePolicy() : LocalePolicy

Return values

LocalePolicy —

getManageClickwrapsMode()

Gets manage_clickwraps_mode


    public
                getManageClickwrapsMode() : string|null

Return values

string|null —

getManageClickwrapsModeMetadata()

Gets manage_clickwraps_mode_metadata


    public
                getManageClickwrapsModeMetadata() : SettingsMetadata

Return values

SettingsMetadata —

getModelName()

The original name of the model.


    public
                getModelName() : string

Return values

string —

getModifiedBy()

Gets modified_by


    public
                getModifiedBy() : string|null

Return values

string|null —

getModifiedByMetadata()

Gets modified_by_metadata


    public
                getModifiedByMetadata() : SettingsMetadata

Return values

SettingsMetadata —

getModifiedDate()

Gets modified_date


    public
                getModifiedDate() : string|null

Return values

string|null —

getModifiedDateMetadata()

Gets modified_date_metadata


    public
                getModifiedDateMetadata() : SettingsMetadata

Return values

SettingsMetadata —

getModifiedPage()

Gets modified_page


    public
                getModifiedPage() : string|null

Return values

string|null —

getModifiedPageMetadata()

Gets modified_page_metadata


    public
                getModifiedPageMetadata() : SettingsMetadata

Return values

SettingsMetadata —

getNewSendUi()

Gets new_send_ui


    public
                getNewSendUi() : string|null

Return values

string|null —

getNewSendUiMetadata()

Gets new_send_ui_metadata


    public
                getNewSendUiMetadata() : SettingsMetadata

Return values

SettingsMetadata —

getPowerFormMode()

Gets power_form_mode


    public
                getPowerFormMode() : string|null

Return values

string|null —

getPowerFormModeMetadata()

Gets power_form_mode_metadata


    public
                getPowerFormModeMetadata() : SettingsMetadata

Return values

SettingsMetadata —

getRecipientViewedNotification()

Gets recipient_viewed_notification


    public
                getRecipientViewedNotification() : string|null

Return values

string|null —

getRecipientViewedNotificationMetadata()

Gets recipient_viewed_notification_metadata


    public
                getRecipientViewedNotificationMetadata() : SettingsMetadata

Return values

SettingsMetadata —

getSealIdentifiers()

Gets seal_identifiers


    public
                getSealIdentifiers() : array<string|int, SealIdentifier>

Return values

array<string|int, SealIdentifier> —

getSelfSignedRecipientEmailDocument()

Gets self_signed_recipient_email_document


    public
                getSelfSignedRecipientEmailDocument() : string|null

Return values

string|null —

getSelfSignedRecipientEmailDocumentMetadata()

Gets self_signed_recipient_email_document_metadata


    public
                getSelfSignedRecipientEmailDocumentMetadata() : SettingsMetadata

Return values

SettingsMetadata —

getSenderEmailNotifications()

Gets sender_email_notifications


    public
                getSenderEmailNotifications() : SenderEmailNotifications

Return values

SenderEmailNotifications —

getSignerEmailNotifications()

Gets signer_email_notifications


    public
                getSignerEmailNotifications() : SignerEmailNotifications

Return values

SignerEmailNotifications —

getSupplementalDocumentIncludeInDownload()

Gets supplemental_document_include_in_download


    public
                getSupplementalDocumentIncludeInDownload() : string|null

Return values

string|null —

getSupplementalDocumentsMustAccept()

Gets supplemental_documents_must_accept


    public
                getSupplementalDocumentsMustAccept() : string|null

Return values

string|null —

getSupplementalDocumentsMustAcceptMetadata()

Gets supplemental_documents_must_accept_metadata


    public
                getSupplementalDocumentsMustAcceptMetadata() : SettingsMetadata

Return values

SettingsMetadata —

getSupplementalDocumentsMustRead()

Gets supplemental_documents_must_read


    public
                getSupplementalDocumentsMustRead() : string|null

Return values

string|null —

getSupplementalDocumentsMustReadMetadata()

Gets supplemental_documents_must_read_metadata


    public
                getSupplementalDocumentsMustReadMetadata() : SettingsMetadata

Return values

SettingsMetadata —

getSupplementalDocumentsMustView()

Gets supplemental_documents_must_view


    public
                getSupplementalDocumentsMustView() : string|null

Return values

string|null —

getSupplementalDocumentsMustViewMetadata()

Gets supplemental_documents_must_view_metadata


    public
                getSupplementalDocumentsMustViewMetadata() : SettingsMetadata

Return values

SettingsMetadata —

getTemplateActiveCreation()

Gets template_active_creation


    public
                getTemplateActiveCreation() : string|null

Return values

string|null —

getTemplateActiveCreationMetadata()

Gets template_active_creation_metadata


    public
                getTemplateActiveCreationMetadata() : SettingsMetadata

Return values

SettingsMetadata —

getTemplateApplyNotify()

Gets template_apply_notify


    public
                getTemplateApplyNotify() : string|null

Return values

string|null —

getTemplateApplyNotifyMetadata()

Gets template_apply_notify_metadata


    public
                getTemplateApplyNotifyMetadata() : SettingsMetadata

Return values

SettingsMetadata —

getTemplateAutoMatching()

Gets template_auto_matching


    public
                getTemplateAutoMatching() : string|null

Return values

string|null —

getTemplateAutoMatchingMetadata()

Gets template_auto_matching_metadata


    public
                getTemplateAutoMatchingMetadata() : SettingsMetadata

Return values

SettingsMetadata —

getTemplateMatchingSensitivity()

Gets template_matching_sensitivity


    public
                getTemplateMatchingSensitivity() : string|null

Return values

string|null —

getTemplateMatchingSensitivityMetadata()

Gets template_matching_sensitivity_metadata


    public
                getTemplateMatchingSensitivityMetadata() : SettingsMetadata

Return values

SettingsMetadata —

getTemplatePageLevelMatching()

Gets template_page_level_matching


    public
                getTemplatePageLevelMatching() : string|null

Return values

string|null —

getTemplatePageLevelMatchingMetadata()

Gets template_page_level_matching_metadata


    public
                getTemplatePageLevelMatchingMetadata() : SettingsMetadata

Return values

SettingsMetadata —

getters()

Array of attributes to getter functions (for serialization of requests)


    public
            static    getters() : array<string|int, mixed>

Return values

array<string|int, mixed> —

getTimezoneDst()

Gets timezone_dst


    public
                getTimezoneDst() : string|null

Return values

string|null —

getTimezoneDstMetadata()

Gets timezone_dst_metadata


    public
                getTimezoneDstMetadata() : SettingsMetadata

Return values

SettingsMetadata —

getTimezoneMask()

Gets timezone_mask


    public
                getTimezoneMask() : string|null

Return values

string|null —

getTimezoneMaskMetadata()

Gets timezone_mask_metadata


    public
                getTimezoneMaskMetadata() : SettingsMetadata

Return values

SettingsMetadata —

getTimezoneOffset()

Gets timezone_offset


    public
                getTimezoneOffset() : string|null

Return values

string|null —

getTimezoneOffsetMetadata()

Gets timezone_offset_metadata


    public
                getTimezoneOffsetMetadata() : SettingsMetadata

Return values

SettingsMetadata —

getTimezoneSendingPref()

Gets timezone_sending_pref


    public
                getTimezoneSendingPref() : string|null

Return values

string|null —

getTimezoneSendingPrefMetadata()

Gets timezone_sending_pref_metadata


    public
                getTimezoneSendingPrefMetadata() : SettingsMetadata

Return values

SettingsMetadata —

getTimezoneSigningPref()

Gets timezone_signing_pref


    public
                getTimezoneSigningPref() : string|null

Return values

string|null —

getTimezoneSigningPrefMetadata()

Gets timezone_signing_pref_metadata


    public
                getTimezoneSigningPrefMetadata() : SettingsMetadata

Return values

SettingsMetadata —

getTransactionPointSiteNameUrl()

Gets transaction_point_site_name_url


    public
                getTransactionPointSiteNameUrl() : string|null

Return values

string|null —

getTransactionPointSiteNameUrlMetadata()

Gets transaction_point_site_name_url_metadata


    public
                getTransactionPointSiteNameUrlMetadata() : SettingsMetadata

Return values

SettingsMetadata —

getTransactionPointUserName()

Gets transaction_point_user_name


    public
                getTransactionPointUserName() : string|null

Return values

string|null —

getTransactionPointUserNameMetadata()

Gets transaction_point_user_name_metadata


    public
                getTransactionPointUserNameMetadata() : SettingsMetadata

Return values

SettingsMetadata —

getVaultingMode()

Gets vaulting_mode


    public
                getVaultingMode() : string|null

Return values

string|null —

getVaultingModeMetadata()

Gets vaulting_mode_metadata


    public
                getVaultingModeMetadata() : SettingsMetadata

Return values

SettingsMetadata —

getWebForms()

Gets web_forms


    public
                getWebForms() : string|null

Return values

string|null —

getWebFormsMetadata()

Gets web_forms_metadata


    public
                getWebFormsMetadata() : SettingsMetadata

Return values

SettingsMetadata —

listInvalidProperties()

Show all the invalid properties with reasons.


    public
                listInvalidProperties() : array<string|int, mixed>

Return values

array<string|int, mixed> —

invalid properties with reasons

offsetExists()

Returns true if offset exists. False otherwise.


    public
                offsetExists(int $offset) : bool

Parameters

$offset : int: Offset

Return values

bool —

offsetGet()

Gets offset.


    public
                offsetGet(int $offset) : mixed

Parameters

$offset : int: Offset

Return values

mixed —

offsetSet()

Sets value based on offset.


    public
                offsetSet(int $offset, mixed $value) : void

Parameters

$offset : int: Offset
$value : mixed: Value to be set

Return values

void —

offsetUnset()

Unsets offset.


    public
                offsetUnset(int $offset) : void

Parameters

$offset : int: Offset

Return values

void —

setAccountManagementGranular()

Sets account_management_granular


    public
                setAccountManagementGranular(UserAccountManagementGranularInformation $account_management_granular) : $this

Parameters

$account_management_granular : UserAccountManagementGranularInformation: Describes which account management capabilities a user has.

Return values

$this —

setAdminOnly()

Sets admin_only


    public
                setAdminOnly(string|null $admin_only) : $this

Parameters

$admin_only : string|null

Return values

$this —

setAdminOnlyMetadata()

Sets admin_only_metadata


    public
                setAdminOnlyMetadata(SettingsMetadata $admin_only_metadata) : $this

Parameters

$admin_only_metadata : SettingsMetadata: Reserved for DocuSign.

Return values

$this —

setAllowAutoTagging()

Sets allow_auto_tagging


    public
                setAllowAutoTagging(string|null $allow_auto_tagging) : $this

Parameters

$allow_auto_tagging : string|null

Return values

$this —

setAllowEnvelopeTransferTo()

Sets allow_envelope_transfer_to


    public
                setAllowEnvelopeTransferTo(string|null $allow_envelope_transfer_to) : $this

Parameters

$allow_envelope_transfer_to : string|null

Return values

$this —

setAllowEnvelopeTransferToMetadata()

Sets allow_envelope_transfer_to_metadata


    public
                setAllowEnvelopeTransferToMetadata(SettingsMetadata $allow_envelope_transfer_to_metadata) : $this

Parameters

$allow_envelope_transfer_to_metadata : SettingsMetadata: Reserved for DocuSign.

Return values

$this —

setAllowEsealRecipients()

Sets allow_eseal_recipients


    public
                setAllowEsealRecipients(string|null $allow_eseal_recipients) : $this

Parameters

$allow_eseal_recipients : string|null

Return values

$this —

setAllowEsealRecipientsMetadata()

Sets allow_eseal_recipients_metadata


    public
                setAllowEsealRecipientsMetadata(SettingsMetadata $allow_eseal_recipients_metadata) : $this

Parameters

$allow_eseal_recipients_metadata : SettingsMetadata: Metadata about the allowEsealRecipientsMetadata property.

Return values

$this —

setAllowPowerFormsAdminToAccessAllPowerFormEnvelope()

Sets allow_power_forms_admin_to_access_all_power_form_envelope


    public
                setAllowPowerFormsAdminToAccessAllPowerFormEnvelope(string|null $allow_power_forms_admin_to_access_all_power_form_envelope) : $this

Parameters

$allow_power_forms_admin_to_access_all_power_form_envelope : string|null

Return values

$this —

setAllowPowerFormsAdminToAccessAllPowerFormEnvelopeMetadata()

Sets allow_power_forms_admin_to_access_all_power_form_envelope_metadata


    public
                setAllowPowerFormsAdminToAccessAllPowerFormEnvelopeMetadata(SettingsMetadata $allow_power_forms_admin_to_access_all_power_form_envelope_metadata) : $this

Parameters

$allow_power_forms_admin_to_access_all_power_form_envelope_metadata : SettingsMetadata: Metadata about the allowPowerFormsAdminToAccessAllPowerFormEnvelopeMetadata property.

Return values

$this —

setAllowRecipientLanguageSelection()

Sets allow_recipient_language_selection


    public
                setAllowRecipientLanguageSelection(string|null $allow_recipient_language_selection) : $this

Parameters

$allow_recipient_language_selection : string|null

Return values

$this —

setAllowRecipientLanguageSelectionMetadata()

Sets allow_recipient_language_selection_metadata


    public
                setAllowRecipientLanguageSelectionMetadata(SettingsMetadata $allow_recipient_language_selection_metadata) : $this

Parameters

$allow_recipient_language_selection_metadata : SettingsMetadata: Metadata for allowRecipientLanguageSelection.

Return values

$this —

setAllowSendOnBehalfOf()

Sets allow_send_on_behalf_of


    public
                setAllowSendOnBehalfOf(string|null $allow_send_on_behalf_of) : $this

Parameters

$allow_send_on_behalf_of : string|null

Return values

$this —

setAllowSendOnBehalfOfMetadata()

Sets allow_send_on_behalf_of_metadata


    public
                setAllowSendOnBehalfOfMetadata(SettingsMetadata $allow_send_on_behalf_of_metadata) : $this

Parameters

$allow_send_on_behalf_of_metadata : SettingsMetadata: Metadata for allowSendOnBehalfOf.

Return values

$this —

setAllowSupplementalDocuments()

Sets allow_supplemental_documents


    public
                setAllowSupplementalDocuments(string|null $allow_supplemental_documents) : $this

Parameters

$allow_supplemental_documents : string|null

Return values

$this —

setAllowSupplementalDocumentsMetadata()

Sets allow_supplemental_documents_metadata


    public
                setAllowSupplementalDocumentsMetadata(SettingsMetadata $allow_supplemental_documents_metadata) : $this

Parameters

$allow_supplemental_documents_metadata : SettingsMetadata: Metadata that indicates whether the allowSupplementalDocuments property is editable.

Return values

$this —

setAnchorTagVersionedPlacementEnabled()

Sets anchor_tag_versioned_placement_enabled


    public
                setAnchorTagVersionedPlacementEnabled(string|null $anchor_tag_versioned_placement_enabled) : $this

Parameters

$anchor_tag_versioned_placement_enabled : string|null

Return values

$this —

setApiAccountWideAccess()

Sets api_account_wide_access


    public
                setApiAccountWideAccess(string|null $api_account_wide_access) : $this

Parameters

$api_account_wide_access : string|null

Return values

$this —

setApiAccountWideAccessMetadata()

Sets api_account_wide_access_metadata


    public
                setApiAccountWideAccessMetadata(SettingsMetadata $api_account_wide_access_metadata) : $this

Parameters

$api_account_wide_access_metadata : SettingsMetadata: Metadata for apiAccountWideAccess.

Return values

$this —

setApiCanExportAc()

Sets api_can_export_ac


    public
                setApiCanExportAc(string|null $api_can_export_ac) : $this

Parameters

$api_can_export_ac : string|null

Return values

$this —

setApiCanExportAcMetadata()

Sets api_can_export_ac_metadata


    public
                setApiCanExportAcMetadata(SettingsMetadata $api_can_export_ac_metadata) : $this

Parameters

$api_can_export_ac_metadata : SettingsMetadata: Metadata about the apiCanExportACMetadata property.

Return values

$this —

setBulkSend()

Sets bulk_send


    public
                setBulkSend(string|null $bulk_send) : $this

Parameters

$bulk_send : string|null

Return values

$this —

setBulkSendMetadata()

Sets bulk_send_metadata


    public
                setBulkSendMetadata(SettingsMetadata $bulk_send_metadata) : $this

Parameters

$bulk_send_metadata : SettingsMetadata: Metadata that indicates whether the bulkSend property is editable.

Return values

$this —

setCanChargeAccount()

Sets can_charge_account


    public
                setCanChargeAccount(string|null $can_charge_account) : $this

Parameters

$can_charge_account : string|null

Return values

$this —

setCanChargeAccountMetadata()

Sets can_charge_account_metadata


    public
                setCanChargeAccountMetadata(SettingsMetadata $can_charge_account_metadata) : $this

Parameters

$can_charge_account_metadata : SettingsMetadata: Reserved for DocuSign.

Return values

$this —

setCanEditSharedAddressbook()

Sets can_edit_shared_addressbook


    public
                setCanEditSharedAddressbook(string|null $can_edit_shared_addressbook) : $this

Parameters

$can_edit_shared_addressbook : string|null

Return values

$this —

setCanEditSharedAddressbookMetadata()

Sets can_edit_shared_addressbook_metadata


    public
                setCanEditSharedAddressbookMetadata(SettingsMetadata $can_edit_shared_addressbook_metadata) : $this

Parameters

$can_edit_shared_addressbook_metadata : SettingsMetadata: Metadata about the canEditSharedAddressbookMetadata property.

Return values

$this —

setCanLockEnvelopes()

Sets can_lock_envelopes


    public
                setCanLockEnvelopes(string|null $can_lock_envelopes) : $this

Parameters

$can_lock_envelopes : string|null

Return values

$this —

setCanLockEnvelopesMetadata()

Sets can_lock_envelopes_metadata


    public
                setCanLockEnvelopesMetadata(SettingsMetadata $can_lock_envelopes_metadata) : $this

Parameters

$can_lock_envelopes_metadata : SettingsMetadata: Metadata about the canLockEnvelopes property.

Return values

$this —

setCanManageAccount()

Sets can_manage_account


    public
                setCanManageAccount(string|null $can_manage_account) : $this

Parameters

$can_manage_account : string|null

Return values

$this —

setCanManageAccountMetadata()

Sets can_manage_account_metadata


    public
                setCanManageAccountMetadata(SettingsMetadata $can_manage_account_metadata) : $this

Parameters

$can_manage_account_metadata : SettingsMetadata: Metadata about the canManageAccountMetadata property.

Return values

$this —

setCanManageDistributor()

Sets can_manage_distributor


    public
                setCanManageDistributor(string|null $can_manage_distributor) : $this

Parameters

$can_manage_distributor : string|null

Return values

$this —

setCanManageDistributorMetadata()

Sets can_manage_distributor_metadata


    public
                setCanManageDistributorMetadata(SettingsMetadata $can_manage_distributor_metadata) : $this

Parameters

$can_manage_distributor_metadata : SettingsMetadata: Metadata about the canManageDistributor property.

Return values

$this —

setCanManageTemplates()

Sets can_manage_templates


    public
                setCanManageTemplates(string|null $can_manage_templates) : $this

Parameters

$can_manage_templates : string|null

Return values

$this —

setCanManageTemplatesMetadata()

Sets can_manage_templates_metadata


    public
                setCanManageTemplatesMetadata(SettingsMetadata $can_manage_templates_metadata) : $this

Parameters

$can_manage_templates_metadata : SettingsMetadata: Metadata about the canManageTemplates property.

Return values

$this —

setCanSendApiRequests()

Sets can_send_api_requests


    public
                setCanSendApiRequests(string|null $can_send_api_requests) : $this

Parameters

$can_send_api_requests : string|null

Return values

$this —

setCanSendApiRequestsMetadata()

Sets can_send_api_requests_metadata


    public
                setCanSendApiRequestsMetadata(SettingsMetadata $can_send_api_requests_metadata) : $this

Parameters

$can_send_api_requests_metadata : SettingsMetadata: Metadata about the canSendAPIRequests property.

Return values

$this —

setCanSendEnvelope()

Sets can_send_envelope


    public
                setCanSendEnvelope(string|null $can_send_envelope) : $this

Parameters

$can_send_envelope : string|null

Return values

$this —

setCanSendEnvelopeMetadata()

Sets can_send_envelope_metadata


    public
                setCanSendEnvelopeMetadata(SettingsMetadata $can_send_envelope_metadata) : $this

Parameters

$can_send_envelope_metadata : SettingsMetadata: Metadata about the canSendEnvelope property.

Return values

$this —

setCanSendEnvelopesViaSms()

Sets can_send_envelopes_via_sms


    public
                setCanSendEnvelopesViaSms(string|null $can_send_envelopes_via_sms) : $this

Parameters

$can_send_envelopes_via_sms : string|null

Return values

$this —

setCanSendEnvelopesViaSmsMetadata()

Sets can_send_envelopes_via_sms_metadata


    public
                setCanSendEnvelopesViaSmsMetadata(SettingsMetadata $can_send_envelopes_via_sms_metadata) : $this

Parameters

$can_send_envelopes_via_sms_metadata : SettingsMetadata

Return values

$this —

setCanSignEnvelope()

Sets can_sign_envelope


    public
                setCanSignEnvelope(string|null $can_sign_envelope) : $this

Parameters

$can_sign_envelope : string|null

Return values

$this —

setCanSignEnvelopeMetadata()

Sets can_sign_envelope_metadata


    public
                setCanSignEnvelopeMetadata(SettingsMetadata $can_sign_envelope_metadata) : $this

Parameters

$can_sign_envelope_metadata : SettingsMetadata: Metadata about the canSignEnvelope property.

Return values

$this —

setCanUseScratchpad()

Sets can_use_scratchpad


    public
                setCanUseScratchpad(string|null $can_use_scratchpad) : $this

Parameters

$can_use_scratchpad : string|null

Return values

$this —

setCanUseScratchpadMetadata()

Sets can_use_scratchpad_metadata


    public
                setCanUseScratchpadMetadata(SettingsMetadata $can_use_scratchpad_metadata) : $this

Parameters

$can_use_scratchpad_metadata : SettingsMetadata: Metadata about the canUseScratchpad property.

Return values

$this —

setCanUseSmartContracts()

Sets can_use_smart_contracts


    public
                setCanUseSmartContracts(string|null $can_use_smart_contracts) : $this

Parameters

$can_use_smart_contracts : string|null

Return values

$this —

setCanUseSmartContractsMetadata()

Sets can_use_smart_contracts_metadata


    public
                setCanUseSmartContractsMetadata(SettingsMetadata $can_use_smart_contracts_metadata) : $this

Parameters

$can_use_smart_contracts_metadata : SettingsMetadata: Reserved for DocuSign.

Return values

$this —

setDisableDocumentUpload()

Sets disable_document_upload


    public
                setDisableDocumentUpload(string|null $disable_document_upload) : $this

Parameters

$disable_document_upload : string|null

Return values

$this —

setDisableDocumentUploadMetadata()

Sets disable_document_upload_metadata


    public
                setDisableDocumentUploadMetadata(SettingsMetadata $disable_document_upload_metadata) : $this

Parameters

$disable_document_upload_metadata : SettingsMetadata: Metadata that indicates whether the disableDocumentUpload property is editable.

Return values

$this —

setDisableOtherActions()

Sets disable_other_actions


    public
                setDisableOtherActions(string|null $disable_other_actions) : $this

Parameters

$disable_other_actions : string|null

Return values

$this —

setDisableOtherActionsMetadata()

Sets disable_other_actions_metadata


    public
                setDisableOtherActionsMetadata(SettingsMetadata $disable_other_actions_metadata) : $this

Parameters

$disable_other_actions_metadata : SettingsMetadata: Metadata that indicates whether the disableOtherActions property is editable.

Return values

$this —

setEnableDsPro()

Sets enable_ds_pro


    public
                setEnableDsPro(string|null $enable_ds_pro) : $this

Parameters

$enable_ds_pro : string|null

Return values

$this —

setEnableDsProMetadata()

Sets enable_ds_pro_metadata


    public
                setEnableDsProMetadata(SettingsMetadata $enable_ds_pro_metadata) : $this

Parameters

$enable_ds_pro_metadata : SettingsMetadata: Metadata that indicates whether the enableDSPro property is editable.

Return values

$this —

setEnableKeyTermsSuggestionsByDocumentType()

Sets enable_key_terms_suggestions_by_document_type


    public
                setEnableKeyTermsSuggestionsByDocumentType(string|null $enable_key_terms_suggestions_by_document_type) : $this

Parameters

$enable_key_terms_suggestions_by_document_type : string|null

Return values

$this —

setEnableKeyTermsSuggestionsByDocumentTypeMetadata()

Sets enable_key_terms_suggestions_by_document_type_metadata


    public
                setEnableKeyTermsSuggestionsByDocumentTypeMetadata(SettingsMetadata $enable_key_terms_suggestions_by_document_type_metadata) : $this

Parameters

$enable_key_terms_suggestions_by_document_type_metadata : SettingsMetadata

Return values

$this —

setEnableSequentialSigningApi()

Sets enable_sequential_signing_api


    public
                setEnableSequentialSigningApi(string|null $enable_sequential_signing_api) : $this

Parameters

$enable_sequential_signing_api : string|null

Return values

$this —

setEnableSequentialSigningApiMetadata()

Sets enable_sequential_signing_api_metadata


    public
                setEnableSequentialSigningApiMetadata(SettingsMetadata $enable_sequential_signing_api_metadata) : $this

Parameters

$enable_sequential_signing_api_metadata : SettingsMetadata: Metadata that indicates whether the enableSequentialSigningAPI property is editable.

Return values

$this —

setEnableSequentialSigningUi()

Sets enable_sequential_signing_ui


    public
                setEnableSequentialSigningUi(string|null $enable_sequential_signing_ui) : $this

Parameters

$enable_sequential_signing_ui : string|null

Return values

$this —

setEnableSequentialSigningUiMetadata()

Sets enable_sequential_signing_ui_metadata


    public
                setEnableSequentialSigningUiMetadata(SettingsMetadata $enable_sequential_signing_ui_metadata) : $this

Parameters

$enable_sequential_signing_ui_metadata : SettingsMetadata: Metadata that indicates whether the enableSequentialSigningUI property is editable.

Return values

$this —

setEnableSignerAttachments()

Sets enable_signer_attachments


    public
                setEnableSignerAttachments(string|null $enable_signer_attachments) : $this

Parameters

$enable_signer_attachments : string|null

Return values

$this —

setEnableSignerAttachmentsMetadata()

Sets enable_signer_attachments_metadata


    public
                setEnableSignerAttachmentsMetadata(SettingsMetadata $enable_signer_attachments_metadata) : $this

Parameters

$enable_signer_attachments_metadata : SettingsMetadata: Metadata that indicates whether the enableSignerAttachments property is editable.

Return values

$this —

setEnableSignOnPaperOverride()

Sets enable_sign_on_paper_override


    public
                setEnableSignOnPaperOverride(string|null $enable_sign_on_paper_override) : $this

Parameters

$enable_sign_on_paper_override : string|null

Return values

$this —

setEnableSignOnPaperOverrideMetadata()

Sets enable_sign_on_paper_override_metadata


    public
                setEnableSignOnPaperOverrideMetadata(SettingsMetadata $enable_sign_on_paper_override_metadata) : $this

Parameters

$enable_sign_on_paper_override_metadata : SettingsMetadata: Metadata that indicates whether the enableSignOnPaperOverride property is editable.

Return values

$this —

setEnableTransactionPoint()

Sets enable_transaction_point


    public
                setEnableTransactionPoint(string|null $enable_transaction_point) : $this

Parameters

$enable_transaction_point : string|null

Return values

$this —

setEnableTransactionPointMetadata()

Sets enable_transaction_point_metadata


    public
                setEnableTransactionPointMetadata(SettingsMetadata $enable_transaction_point_metadata) : $this

Parameters

$enable_transaction_point_metadata : SettingsMetadata: Reserved for DocuSign.

Return values

$this —

setEnableVaulting()

Sets enable_vaulting


    public
                setEnableVaulting(string|null $enable_vaulting) : $this

Parameters

$enable_vaulting : string|null

Return values

$this —

setEnableVaultingMetadata()

Sets enable_vaulting_metadata


    public
                setEnableVaultingMetadata(SettingsMetadata $enable_vaulting_metadata) : $this

Parameters

$enable_vaulting_metadata : SettingsMetadata: Metadata that indicates whether the enableVaulting property is editable.

Return values

$this —

setExpressSendOnly()

Sets express_send_only


    public
                setExpressSendOnly(string|null $express_send_only) : $this

Parameters

$express_send_only : string|null

Return values

$this —

setLocale()

Sets locale


    public
                setLocale(string|null $locale) : $this

Parameters

$locale : string|null

Return values

$this —

setLocaleMetadata()

Sets locale_metadata


    public
                setLocaleMetadata(SettingsMetadata $locale_metadata) : $this

Parameters

$locale_metadata : SettingsMetadata: Metadata about the locale property.

Return values

$this —

setLocalePolicy()

Sets locale_policy


    public
                setLocalePolicy(LocalePolicy $locale_policy) : $this

Parameters

$locale_policy : LocalePolicy: Reserved for DocuSign.

Return values

$this —

setManageClickwrapsMode()

Sets manage_clickwraps_mode


    public
                setManageClickwrapsMode(string|null $manage_clickwraps_mode) : $this

Parameters

$manage_clickwraps_mode : string|null

Return values

$this —

setManageClickwrapsModeMetadata()

Sets manage_clickwraps_mode_metadata


    public
                setManageClickwrapsModeMetadata(SettingsMetadata $manage_clickwraps_mode_metadata) : $this

Parameters

$manage_clickwraps_mode_metadata : SettingsMetadata: Metadata about the manageClickwrapsMode property.

Return values

$this —

setModifiedBy()

Sets modified_by


    public
                setModifiedBy(string|null $modified_by) : $this

Parameters

$modified_by : string|null

Return values

$this —

setModifiedByMetadata()

Sets modified_by_metadata


    public
                setModifiedByMetadata(SettingsMetadata $modified_by_metadata) : $this

Parameters

$modified_by_metadata : SettingsMetadata: Metadata about the modifiedBy property.

Return values

$this —

setModifiedDate()

Sets modified_date


    public
                setModifiedDate(string|null $modified_date) : $this

Parameters

$modified_date : string|null

Return values

$this —

setModifiedDateMetadata()

Sets modified_date_metadata


    public
                setModifiedDateMetadata(SettingsMetadata $modified_date_metadata) : $this

Parameters

$modified_date_metadata : SettingsMetadata: Metadata about the modifiedDate property.

Return values

$this —

setModifiedPage()

Sets modified_page


    public
                setModifiedPage(string|null $modified_page) : $this

Parameters

$modified_page : string|null

Return values

$this —

setModifiedPageMetadata()

Sets modified_page_metadata


    public
                setModifiedPageMetadata(SettingsMetadata $modified_page_metadata) : $this

Parameters

$modified_page_metadata : SettingsMetadata: Metadata about the modifiedPage property.

Return values

$this —

setNewSendUi()

Sets new_send_ui


    public
                setNewSendUi(string|null $new_send_ui) : $this

Parameters

$new_send_ui : string|null

Return values

$this —

setNewSendUiMetadata()

Sets new_send_ui_metadata


    public
                setNewSendUiMetadata(SettingsMetadata $new_send_ui_metadata) : $this

Parameters

$new_send_ui_metadata : SettingsMetadata: Metadata about the newSendUI property.

Return values

$this —

setPowerFormMode()

Sets power_form_mode


    public
                setPowerFormMode(string|null $power_form_mode) : $this

Parameters

$power_form_mode : string|null

Return values

$this —

setPowerFormModeMetadata()

Sets power_form_mode_metadata


    public
                setPowerFormModeMetadata(SettingsMetadata $power_form_mode_metadata) : $this

Parameters

$power_form_mode_metadata : SettingsMetadata: Metadata about the powerFormMode property.

Return values

$this —

setRecipientViewedNotification()

Sets recipient_viewed_notification


    public
                setRecipientViewedNotification(string|null $recipient_viewed_notification) : $this

Parameters

$recipient_viewed_notification : string|null

Return values

$this —

setRecipientViewedNotificationMetadata()

Sets recipient_viewed_notification_metadata


    public
                setRecipientViewedNotificationMetadata(SettingsMetadata $recipient_viewed_notification_metadata) : $this

Parameters

$recipient_viewed_notification_metadata : SettingsMetadata: Metadata about the recipientViewedNotification property.

Return values

$this —

setSealIdentifiers()

Sets seal_identifiers


    public
                setSealIdentifiers(array<string|int, SealIdentifier> $seal_identifiers) : $this

Parameters

$seal_identifiers : array<string|int, SealIdentifier>

Return values

$this —

setSelfSignedRecipientEmailDocument()

Sets self_signed_recipient_email_document


    public
                setSelfSignedRecipientEmailDocument(string|null $self_signed_recipient_email_document) : $this

Parameters

$self_signed_recipient_email_document : string|null

Return values

$this —

setSelfSignedRecipientEmailDocumentMetadata()

Sets self_signed_recipient_email_document_metadata


    public
                setSelfSignedRecipientEmailDocumentMetadata(SettingsMetadata $self_signed_recipient_email_document_metadata) : $this

Parameters

$self_signed_recipient_email_document_metadata : SettingsMetadata: Metadata that indicates whether the selfSignedRecipientEmailDocument property is editable.

Return values

$this —

setSenderEmailNotifications()

Sets sender_email_notifications


    public
                setSenderEmailNotifications(SenderEmailNotifications $sender_email_notifications) : $this

Parameters

$sender_email_notifications : SenderEmailNotifications: 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

Return values

$this —

setSignerEmailNotifications()

Sets signer_email_notifications


    public
                setSignerEmailNotifications(SignerEmailNotifications $signer_email_notifications) : $this

Parameters

$signer_email_notifications : SignerEmailNotifications: 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.

Return values

$this —

setSupplementalDocumentIncludeInDownload()

Sets supplemental_document_include_in_download


    public
                setSupplementalDocumentIncludeInDownload(string|null $supplemental_document_include_in_download) : $this

Parameters

$supplemental_document_include_in_download : string|null

Return values

$this —

setSupplementalDocumentsMustAccept()

Sets supplemental_documents_must_accept


    public
                setSupplementalDocumentsMustAccept(string|null $supplemental_documents_must_accept) : $this

Parameters

$supplemental_documents_must_accept : string|null

Return values

$this —

setSupplementalDocumentsMustAcceptMetadata()

Sets supplemental_documents_must_accept_metadata


    public
                setSupplementalDocumentsMustAcceptMetadata(SettingsMetadata $supplemental_documents_must_accept_metadata) : $this

Parameters

$supplemental_documents_must_accept_metadata : SettingsMetadata: Metadata that indicates whether the supplementalDocumentsMustAccept property is editable.

Return values

$this —

setSupplementalDocumentsMustRead()

Sets supplemental_documents_must_read


    public
                setSupplementalDocumentsMustRead(string|null $supplemental_documents_must_read) : $this

Parameters

$supplemental_documents_must_read : string|null

Return values

$this —

setSupplementalDocumentsMustReadMetadata()

Sets supplemental_documents_must_read_metadata


    public
                setSupplementalDocumentsMustReadMetadata(SettingsMetadata $supplemental_documents_must_read_metadata) : $this

Parameters

$supplemental_documents_must_read_metadata : SettingsMetadata: Metadata that indicates whether the supplementalDocumentsMustRead property is editable.

Return values

$this —

setSupplementalDocumentsMustView()

Sets supplemental_documents_must_view


    public
                setSupplementalDocumentsMustView(string|null $supplemental_documents_must_view) : $this

Parameters

$supplemental_documents_must_view : string|null

Return values

$this —

setSupplementalDocumentsMustViewMetadata()

Sets supplemental_documents_must_view_metadata


    public
                setSupplementalDocumentsMustViewMetadata(SettingsMetadata $supplemental_documents_must_view_metadata) : $this

Parameters

$supplemental_documents_must_view_metadata : SettingsMetadata: Metadata that indicates whether the supplementalDocumentsMustView property is editable.

Return values

$this —

setTemplateActiveCreation()

Sets template_active_creation


    public
                setTemplateActiveCreation(string|null $template_active_creation) : $this

Parameters

$template_active_creation : string|null

Return values

$this —

setTemplateActiveCreationMetadata()

Sets template_active_creation_metadata


    public
                setTemplateActiveCreationMetadata(SettingsMetadata $template_active_creation_metadata) : $this

Parameters

$template_active_creation_metadata : SettingsMetadata: Metadata about the templateActiveCreation property.

Return values

$this —

setTemplateApplyNotify()

Sets template_apply_notify


    public
                setTemplateApplyNotify(string|null $template_apply_notify) : $this

Parameters

$template_apply_notify : string|null

Return values

$this —

setTemplateApplyNotifyMetadata()

Sets template_apply_notify_metadata


    public
                setTemplateApplyNotifyMetadata(SettingsMetadata $template_apply_notify_metadata) : $this

Parameters

$template_apply_notify_metadata : SettingsMetadata: Metadata about the templateApplyNotify property.

Return values

$this —

setTemplateAutoMatching()

Sets template_auto_matching


    public
                setTemplateAutoMatching(string|null $template_auto_matching) : $this

Parameters

$template_auto_matching : string|null

Return values

$this —

setTemplateAutoMatchingMetadata()

Sets template_auto_matching_metadata


    public
                setTemplateAutoMatchingMetadata(SettingsMetadata $template_auto_matching_metadata) : $this

Parameters

$template_auto_matching_metadata : SettingsMetadata: Metadata about the templateAutoMatching property.

Return values

$this —

setTemplateMatchingSensitivity()

Sets template_matching_sensitivity


    public
                setTemplateMatchingSensitivity(string|null $template_matching_sensitivity) : $this

Parameters

$template_matching_sensitivity : string|null

Return values

$this —

setTemplateMatchingSensitivityMetadata()

Sets template_matching_sensitivity_metadata


    public
                setTemplateMatchingSensitivityMetadata(SettingsMetadata $template_matching_sensitivity_metadata) : $this

Parameters

$template_matching_sensitivity_metadata : SettingsMetadata: Metadata about the tempalteMatchingSensitivity property.

Return values

$this —

setTemplatePageLevelMatching()

Sets template_page_level_matching


    public
                setTemplatePageLevelMatching(string|null $template_page_level_matching) : $this

Parameters

$template_page_level_matching : string|null

Return values

$this —

setTemplatePageLevelMatchingMetadata()

Sets template_page_level_matching_metadata


    public
                setTemplatePageLevelMatchingMetadata(SettingsMetadata $template_page_level_matching_metadata) : $this

Parameters

$template_page_level_matching_metadata : SettingsMetadata: Metadata about the templatePageLevelMatching property.

Return values

$this —

setters()

Array of attributes to setter functions (for deserialization of responses)


    public
            static    setters() : array<string|int, mixed>

Return values

array<string|int, mixed> —

setTimezoneDst()

Sets timezone_dst


    public
                setTimezoneDst(string|null $timezone_dst) : $this

Parameters

$timezone_dst : string|null

Return values

$this —

setTimezoneDstMetadata()

Sets timezone_dst_metadata


    public
                setTimezoneDstMetadata(SettingsMetadata $timezone_dst_metadata) : $this

Parameters

$timezone_dst_metadata : SettingsMetadata: Metadata about the timezoneDST property.

Return values

$this —

setTimezoneMask()

Sets timezone_mask


    public
                setTimezoneMask(string|null $timezone_mask) : $this

Parameters

$timezone_mask : string|null

Return values

$this —

setTimezoneMaskMetadata()

Sets timezone_mask_metadata


    public
                setTimezoneMaskMetadata(SettingsMetadata $timezone_mask_metadata) : $this

Parameters

$timezone_mask_metadata : SettingsMetadata: Metadata about the timezoneMask property.

Return values

$this —

setTimezoneOffset()

Sets timezone_offset


    public
                setTimezoneOffset(string|null $timezone_offset) : $this

Parameters

$timezone_offset : string|null

Return values

$this —

setTimezoneOffsetMetadata()

Sets timezone_offset_metadata


    public
                setTimezoneOffsetMetadata(SettingsMetadata $timezone_offset_metadata) : $this

Parameters

$timezone_offset_metadata : SettingsMetadata: Metadata about the timezoneOffset property.

Return values

$this —

setTimezoneSendingPref()

Sets timezone_sending_pref


    public
                setTimezoneSendingPref(string|null $timezone_sending_pref) : $this

Parameters

$timezone_sending_pref : string|null

Return values

$this —

setTimezoneSendingPrefMetadata()

Sets timezone_sending_pref_metadata


    public
                setTimezoneSendingPrefMetadata(SettingsMetadata $timezone_sending_pref_metadata) : $this

Parameters

$timezone_sending_pref_metadata : SettingsMetadata: Reserved for DocuSign.

Return values

$this —

setTimezoneSigningPref()

Sets timezone_signing_pref


    public
                setTimezoneSigningPref(string|null $timezone_signing_pref) : $this

Parameters

$timezone_signing_pref : string|null

Return values

$this —

setTimezoneSigningPrefMetadata()

Sets timezone_signing_pref_metadata


    public
                setTimezoneSigningPrefMetadata(SettingsMetadata $timezone_signing_pref_metadata) : $this

Parameters

$timezone_signing_pref_metadata : SettingsMetadata: Reserved for DocuSign.

Return values

$this —

setTransactionPointSiteNameUrl()

Sets transaction_point_site_name_url


    public
                setTransactionPointSiteNameUrl(string|null $transaction_point_site_name_url) : $this

Parameters

$transaction_point_site_name_url : string|null

Return values

$this —

setTransactionPointSiteNameUrlMetadata()

Sets transaction_point_site_name_url_metadata


    public
                setTransactionPointSiteNameUrlMetadata(SettingsMetadata $transaction_point_site_name_url_metadata) : $this

Parameters

$transaction_point_site_name_url_metadata : SettingsMetadata: Reserved for DocuSign.

Return values

$this —

setTransactionPointUserName()

Sets transaction_point_user_name


    public
                setTransactionPointUserName(string|null $transaction_point_user_name) : $this

Parameters

$transaction_point_user_name : string|null

Return values

$this —

setTransactionPointUserNameMetadata()

Sets transaction_point_user_name_metadata


    public
                setTransactionPointUserNameMetadata(SettingsMetadata $transaction_point_user_name_metadata) : $this

Parameters

$transaction_point_user_name_metadata : SettingsMetadata: Reserved for DocuSign.

Return values

$this —

setVaultingMode()

Sets vaulting_mode


    public
                setVaultingMode(string|null $vaulting_mode) : $this

Parameters

$vaulting_mode : string|null

Return values

$this —

setVaultingModeMetadata()

Sets vaulting_mode_metadata


    public
                setVaultingModeMetadata(SettingsMetadata $vaulting_mode_metadata) : $this

Parameters

$vaulting_mode_metadata : SettingsMetadata: Metadata about the vaultingMode property.

Return values

$this —

setWebForms()

Sets web_forms


    public
                setWebForms(string|null $web_forms) : $this

Parameters

$web_forms : string|null

Return values

$this —

setWebFormsMetadata()

Sets web_forms_metadata


    public
                setWebFormsMetadata(SettingsMetadata $web_forms_metadata) : $this

Parameters

$web_forms_metadata : SettingsMetadata

Return values

$this —

swaggerFormats()

Array of property to format mappings. Used for (de)serialization


    public
            static    swaggerFormats() : array<string|int, mixed>

Return values

array<string|int, mixed> —

swaggerTypes()

Array of property to type mappings. Used for (de)serialization


    public
            static    swaggerTypes() : array<string|int, mixed>

Return values

array<string|int, mixed> —

valid()

Validate all the properties in the model return true if all passed


    public
                valid() : bool

Return values

bool —

True if all properties are valid

UserSettingsInformation in package DocuSign eSign implements ModelInterface, ArrayAccess

Tags

Interfaces, Classes, Traits and Enums

Table of Contents

Constants

DISCRIMINATOR

Properties

$attributeMap

$container

$getters

$setters

$swaggerFormats

$swaggerModelName

$swaggerTypes

Methods

__construct()

Parameters

Return values

__toString()

Return values

attributeMap()

Return values

getAccountManagementGranular()

Return values

getAdminOnly()

Return values

getAdminOnlyMetadata()

Return values

getAllowAutoTagging()

Return values

getAllowEnvelopeTransferTo()

Return values

getAllowEnvelopeTransferToMetadata()

Return values

getAllowEsealRecipients()

Return values

getAllowEsealRecipientsMetadata()

Return values

getAllowPowerFormsAdminToAccessAllPowerFormEnvelope()

Return values

getAllowPowerFormsAdminToAccessAllPowerFormEnvelopeMetadata()

Return values

getAllowRecipientLanguageSelection()

Return values

getAllowRecipientLanguageSelectionMetadata()

Return values

getAllowSendOnBehalfOf()

Return values

getAllowSendOnBehalfOfMetadata()

Return values

getAllowSupplementalDocuments()

Return values

getAllowSupplementalDocumentsMetadata()

Return values

getAnchorTagVersionedPlacementEnabled()

Return values

getApiAccountWideAccess()

Return values

getApiAccountWideAccessMetadata()

Return values

getApiCanExportAc()

Return values

getApiCanExportAcMetadata()

Return values

getBulkSend()

Return values

getBulkSendMetadata()

Return values

getCanChargeAccount()

Return values

getCanChargeAccountMetadata()

Return values

getCanEditSharedAddressbook()

Return values

getCanEditSharedAddressbookMetadata()

Return values

getCanLockEnvelopes()

Return values

getCanLockEnvelopesMetadata()

Return values

UserSettingsInformation
in package

DocuSign

eSign

implements ModelInterface, ArrayAccess