Documentation

AccountUISettings
in package
implements ModelInterface, ArrayAccess

AccountUISettings Class Doc Comment

Tags
category

Class

description

An object that defines the options that are available to non-administrators in the UI.

author

Swagger Codegen team apihelp@docusign.com

license

The DocuSign PHP Client SDK is licensed under the MIT License.

link
https://github.com/swagger-api/swagger-codegen

Interfaces, Classes, Traits and Enums

ModelInterface
Interface abstracting model access.
ArrayAccess

Table of Contents

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
getAdminMessage()  : AdminMessage
Gets admin_message
getAllowUsersToEditSharedAccess()  : string|null
Gets allow_users_to_edit_shared_access
getAllowUsersToEditSharedAccessMetadata()  : SettingsMetadata
Gets allow_users_to_edit_shared_access_metadata
getAskAnAdmin()  : AskAnAdmin
Gets ask_an_admin
getClickwrapSchemaVersion()  : string|null
Gets clickwrap_schema_version
getClickwrapSchemaVersionMetadata()  : SettingsMetadata
Gets clickwrap_schema_version_metadata
getEnableAdminMessage()  : string|null
Gets enable_admin_message
getEnableAdminMessageMetadata()  : SettingsMetadata
Gets enable_admin_message_metadata
getEnableEasySignCanUseMultiTemplateApply()  : string|null
Gets enable_easy_sign_can_use_multi_template_apply
getEnableEasySignCanUseMultiTemplateApplyMetadata()  : SettingsMetadata
Gets enable_easy_sign_can_use_multi_template_apply_metadata
getEnableEasySignTemplateUpload()  : string|null
Gets enable_easy_sign_template_upload
getEnableEasySignTemplateUploadMetadata()  : SettingsMetadata
Gets enable_easy_sign_template_upload_metadata
getEnableEnvelopeCopyWithData()  : string|null
Gets enable_envelope_copy_with_data
getEnableEnvelopeCopyWithDataMetadata()  : SettingsMetadata
Gets enable_envelope_copy_with_data_metadata
getEnableLegacySendflowLink()  : string|null
Gets enable_legacy_sendflow_link
getEnableLegacySendflowLinkMetadata()  : SettingsMetadata
Gets enable_legacy_sendflow_link_metadata
getHasExternalLinkedAccounts()  : string|null
Gets has_external_linked_accounts
getHasExternalLinkedAccountsMetadata()  : SettingsMetadata
Gets has_external_linked_accounts_metadata
getHideSendAnEnvelope()  : string|null
Gets hide_send_an_envelope
getHideSendAnEnvelopeMetadata()  : SettingsMetadata
Gets hide_send_an_envelope_metadata
getHideUseATemplate()  : string|null
Gets hide_use_a_template
getHideUseATemplateInPrepare()  : string|null
Gets hide_use_a_template_in_prepare
getHideUseATemplateInPrepareMetadata()  : SettingsMetadata
Gets hide_use_a_template_in_prepare_metadata
getHideUseATemplateMetadata()  : SettingsMetadata
Gets hide_use_a_template_metadata
getModelName()  : string
The original name of the model.
getOrderBasedRecipientIdGeneration()  : string|null
Gets order_based_recipient_id_generation
getOrderBasedRecipientIdGenerationMetadata()  : SettingsMetadata
Gets order_based_recipient_id_generation_metadata
getRemoveEnvelopeForwarding()  : string|null
Gets remove_envelope_forwarding
getRemoveEnvelopeForwardingMetadata()  : SettingsMetadata
Gets remove_envelope_forwarding_metadata
getShouldRedactAccessCode()  : string|null
Gets should_redact_access_code
getShouldRedactAccessCodeMetadata()  : SettingsMetadata
Gets should_redact_access_code_metadata
getters()  : array<string|int, mixed>
Array of attributes to getter functions (for serialization of requests)
getUploadNewImageToSignOrInitial()  : string|null
Gets upload_new_image_to_sign_or_initial
getUploadNewImageToSignOrInitialMetadata()  : SettingsMetadata
Gets upload_new_image_to_sign_or_initial_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.
setAdminMessage()  : $this
Sets admin_message
setAllowUsersToEditSharedAccess()  : $this
Sets allow_users_to_edit_shared_access
setAllowUsersToEditSharedAccessMetadata()  : $this
Sets allow_users_to_edit_shared_access_metadata
setAskAnAdmin()  : $this
Sets ask_an_admin
setClickwrapSchemaVersion()  : $this
Sets clickwrap_schema_version
setClickwrapSchemaVersionMetadata()  : $this
Sets clickwrap_schema_version_metadata
setEnableAdminMessage()  : $this
Sets enable_admin_message
setEnableAdminMessageMetadata()  : $this
Sets enable_admin_message_metadata
setEnableEasySignCanUseMultiTemplateApply()  : $this
Sets enable_easy_sign_can_use_multi_template_apply
setEnableEasySignCanUseMultiTemplateApplyMetadata()  : $this
Sets enable_easy_sign_can_use_multi_template_apply_metadata
setEnableEasySignTemplateUpload()  : $this
Sets enable_easy_sign_template_upload
setEnableEasySignTemplateUploadMetadata()  : $this
Sets enable_easy_sign_template_upload_metadata
setEnableEnvelopeCopyWithData()  : $this
Sets enable_envelope_copy_with_data
setEnableEnvelopeCopyWithDataMetadata()  : $this
Sets enable_envelope_copy_with_data_metadata
setEnableLegacySendflowLink()  : $this
Sets enable_legacy_sendflow_link
setEnableLegacySendflowLinkMetadata()  : $this
Sets enable_legacy_sendflow_link_metadata
setHasExternalLinkedAccounts()  : $this
Sets has_external_linked_accounts
setHasExternalLinkedAccountsMetadata()  : $this
Sets has_external_linked_accounts_metadata
setHideSendAnEnvelope()  : $this
Sets hide_send_an_envelope
setHideSendAnEnvelopeMetadata()  : $this
Sets hide_send_an_envelope_metadata
setHideUseATemplate()  : $this
Sets hide_use_a_template
setHideUseATemplateInPrepare()  : $this
Sets hide_use_a_template_in_prepare
setHideUseATemplateInPrepareMetadata()  : $this
Sets hide_use_a_template_in_prepare_metadata
setHideUseATemplateMetadata()  : $this
Sets hide_use_a_template_metadata
setOrderBasedRecipientIdGeneration()  : $this
Sets order_based_recipient_id_generation
setOrderBasedRecipientIdGenerationMetadata()  : $this
Sets order_based_recipient_id_generation_metadata
setRemoveEnvelopeForwarding()  : $this
Sets remove_envelope_forwarding
setRemoveEnvelopeForwardingMetadata()  : $this
Sets remove_envelope_forwarding_metadata
setShouldRedactAccessCode()  : $this
Sets should_redact_access_code
setShouldRedactAccessCodeMetadata()  : $this
Sets should_redact_access_code_metadata
setters()  : array<string|int, mixed>
Array of attributes to setter functions (for deserialization of responses)
setUploadNewImageToSignOrInitial()  : $this
Sets upload_new_image_to_sign_or_initial
setUploadNewImageToSignOrInitialMetadata()  : $this
Sets upload_new_image_to_sign_or_initial_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

Constants

Properties

$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 = ['admin_message' => 'adminMessage', 'allow_users_to_edit_shared_access' => 'allowUsersToEditSharedAccess', 'allow_users_to_edit_shared_access_metadata' => 'allowUsersToEditSharedAccessMetadata', 'ask_an_admin' => 'askAnAdmin', 'clickwrap_schema_version' => 'clickwrapSchemaVersion', 'clickwrap_schema_version_metadata' => 'clickwrapSchemaVersionMetadata', 'enable_admin_message' => 'enableAdminMessage', 'enable_admin_message_metadata' => 'enableAdminMessageMetadata', 'enable_easy_sign_can_use_multi_template_apply' => 'enableEasySignCanUseMultiTemplateApply', 'enable_easy_sign_can_use_multi_template_apply_metadata' => 'enableEasySignCanUseMultiTemplateApplyMetadata', 'enable_easy_sign_template_upload' => 'enableEasySignTemplateUpload', 'enable_easy_sign_template_upload_metadata' => 'enableEasySignTemplateUploadMetadata', 'enable_envelope_copy_with_data' => 'enableEnvelopeCopyWithData', 'enable_envelope_copy_with_data_metadata' => 'enableEnvelopeCopyWithDataMetadata', 'enable_legacy_sendflow_link' => 'enableLegacySendflowLink', 'enable_legacy_sendflow_link_metadata' => 'enableLegacySendflowLinkMetadata', 'has_external_linked_accounts' => 'hasExternalLinkedAccounts', 'has_external_linked_accounts_metadata' => 'hasExternalLinkedAccountsMetadata', 'hide_send_an_envelope' => 'hideSendAnEnvelope', 'hide_send_an_envelope_metadata' => 'hideSendAnEnvelopeMetadata', 'hide_use_a_template' => 'hideUseATemplate', 'hide_use_a_template_in_prepare' => 'hideUseATemplateInPrepare', 'hide_use_a_template_in_prepare_metadata' => 'hideUseATemplateInPrepareMetadata', 'hide_use_a_template_metadata' => 'hideUseATemplateMetadata', 'order_based_recipient_id_generation' => 'orderBasedRecipientIdGeneration', 'order_based_recipient_id_generation_metadata' => 'orderBasedRecipientIdGenerationMetadata', 'remove_envelope_forwarding' => 'removeEnvelopeForwarding', 'remove_envelope_forwarding_metadata' => 'removeEnvelopeForwardingMetadata', 'should_redact_access_code' => 'shouldRedactAccessCode', 'should_redact_access_code_metadata' => 'shouldRedactAccessCodeMetadata', 'upload_new_image_to_sign_or_initial' => 'uploadNewImageToSignOrInitial', 'upload_new_image_to_sign_or_initial_metadata' => 'uploadNewImageToSignOrInitialMetadata']

$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 = ['admin_message' => 'getAdminMessage', 'allow_users_to_edit_shared_access' => 'getAllowUsersToEditSharedAccess', 'allow_users_to_edit_shared_access_metadata' => 'getAllowUsersToEditSharedAccessMetadata', 'ask_an_admin' => 'getAskAnAdmin', 'clickwrap_schema_version' => 'getClickwrapSchemaVersion', 'clickwrap_schema_version_metadata' => 'getClickwrapSchemaVersionMetadata', 'enable_admin_message' => 'getEnableAdminMessage', 'enable_admin_message_metadata' => 'getEnableAdminMessageMetadata', 'enable_easy_sign_can_use_multi_template_apply' => 'getEnableEasySignCanUseMultiTemplateApply', 'enable_easy_sign_can_use_multi_template_apply_metadata' => 'getEnableEasySignCanUseMultiTemplateApplyMetadata', 'enable_easy_sign_template_upload' => 'getEnableEasySignTemplateUpload', 'enable_easy_sign_template_upload_metadata' => 'getEnableEasySignTemplateUploadMetadata', 'enable_envelope_copy_with_data' => 'getEnableEnvelopeCopyWithData', 'enable_envelope_copy_with_data_metadata' => 'getEnableEnvelopeCopyWithDataMetadata', 'enable_legacy_sendflow_link' => 'getEnableLegacySendflowLink', 'enable_legacy_sendflow_link_metadata' => 'getEnableLegacySendflowLinkMetadata', 'has_external_linked_accounts' => 'getHasExternalLinkedAccounts', 'has_external_linked_accounts_metadata' => 'getHasExternalLinkedAccountsMetadata', 'hide_send_an_envelope' => 'getHideSendAnEnvelope', 'hide_send_an_envelope_metadata' => 'getHideSendAnEnvelopeMetadata', 'hide_use_a_template' => 'getHideUseATemplate', 'hide_use_a_template_in_prepare' => 'getHideUseATemplateInPrepare', 'hide_use_a_template_in_prepare_metadata' => 'getHideUseATemplateInPrepareMetadata', 'hide_use_a_template_metadata' => 'getHideUseATemplateMetadata', 'order_based_recipient_id_generation' => 'getOrderBasedRecipientIdGeneration', 'order_based_recipient_id_generation_metadata' => 'getOrderBasedRecipientIdGenerationMetadata', 'remove_envelope_forwarding' => 'getRemoveEnvelopeForwarding', 'remove_envelope_forwarding_metadata' => 'getRemoveEnvelopeForwardingMetadata', 'should_redact_access_code' => 'getShouldRedactAccessCode', 'should_redact_access_code_metadata' => 'getShouldRedactAccessCodeMetadata', 'upload_new_image_to_sign_or_initial' => 'getUploadNewImageToSignOrInitial', 'upload_new_image_to_sign_or_initial_metadata' => 'getUploadNewImageToSignOrInitialMetadata']

$setters

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

protected static array<string|int, string> $setters = ['admin_message' => 'setAdminMessage', 'allow_users_to_edit_shared_access' => 'setAllowUsersToEditSharedAccess', 'allow_users_to_edit_shared_access_metadata' => 'setAllowUsersToEditSharedAccessMetadata', 'ask_an_admin' => 'setAskAnAdmin', 'clickwrap_schema_version' => 'setClickwrapSchemaVersion', 'clickwrap_schema_version_metadata' => 'setClickwrapSchemaVersionMetadata', 'enable_admin_message' => 'setEnableAdminMessage', 'enable_admin_message_metadata' => 'setEnableAdminMessageMetadata', 'enable_easy_sign_can_use_multi_template_apply' => 'setEnableEasySignCanUseMultiTemplateApply', 'enable_easy_sign_can_use_multi_template_apply_metadata' => 'setEnableEasySignCanUseMultiTemplateApplyMetadata', 'enable_easy_sign_template_upload' => 'setEnableEasySignTemplateUpload', 'enable_easy_sign_template_upload_metadata' => 'setEnableEasySignTemplateUploadMetadata', 'enable_envelope_copy_with_data' => 'setEnableEnvelopeCopyWithData', 'enable_envelope_copy_with_data_metadata' => 'setEnableEnvelopeCopyWithDataMetadata', 'enable_legacy_sendflow_link' => 'setEnableLegacySendflowLink', 'enable_legacy_sendflow_link_metadata' => 'setEnableLegacySendflowLinkMetadata', 'has_external_linked_accounts' => 'setHasExternalLinkedAccounts', 'has_external_linked_accounts_metadata' => 'setHasExternalLinkedAccountsMetadata', 'hide_send_an_envelope' => 'setHideSendAnEnvelope', 'hide_send_an_envelope_metadata' => 'setHideSendAnEnvelopeMetadata', 'hide_use_a_template' => 'setHideUseATemplate', 'hide_use_a_template_in_prepare' => 'setHideUseATemplateInPrepare', 'hide_use_a_template_in_prepare_metadata' => 'setHideUseATemplateInPrepareMetadata', 'hide_use_a_template_metadata' => 'setHideUseATemplateMetadata', 'order_based_recipient_id_generation' => 'setOrderBasedRecipientIdGeneration', 'order_based_recipient_id_generation_metadata' => 'setOrderBasedRecipientIdGenerationMetadata', 'remove_envelope_forwarding' => 'setRemoveEnvelopeForwarding', 'remove_envelope_forwarding_metadata' => 'setRemoveEnvelopeForwardingMetadata', 'should_redact_access_code' => 'setShouldRedactAccessCode', 'should_redact_access_code_metadata' => 'setShouldRedactAccessCodeMetadata', 'upload_new_image_to_sign_or_initial' => 'setUploadNewImageToSignOrInitial', 'upload_new_image_to_sign_or_initial_metadata' => 'setUploadNewImageToSignOrInitialMetadata']

$swaggerFormats

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

protected static array<string|int, string> $swaggerFormats = ['admin_message' => null, 'allow_users_to_edit_shared_access' => null, 'allow_users_to_edit_shared_access_metadata' => null, 'ask_an_admin' => null, 'clickwrap_schema_version' => null, 'clickwrap_schema_version_metadata' => null, 'enable_admin_message' => null, 'enable_admin_message_metadata' => null, 'enable_easy_sign_can_use_multi_template_apply' => null, 'enable_easy_sign_can_use_multi_template_apply_metadata' => null, 'enable_easy_sign_template_upload' => null, 'enable_easy_sign_template_upload_metadata' => null, 'enable_envelope_copy_with_data' => null, 'enable_envelope_copy_with_data_metadata' => null, 'enable_legacy_sendflow_link' => null, 'enable_legacy_sendflow_link_metadata' => null, 'has_external_linked_accounts' => null, 'has_external_linked_accounts_metadata' => null, 'hide_send_an_envelope' => null, 'hide_send_an_envelope_metadata' => null, 'hide_use_a_template' => null, 'hide_use_a_template_in_prepare' => null, 'hide_use_a_template_in_prepare_metadata' => null, 'hide_use_a_template_metadata' => null, 'order_based_recipient_id_generation' => null, 'order_based_recipient_id_generation_metadata' => null, 'remove_envelope_forwarding' => null, 'remove_envelope_forwarding_metadata' => null, 'should_redact_access_code' => null, 'should_redact_access_code_metadata' => null, 'upload_new_image_to_sign_or_initial' => null, 'upload_new_image_to_sign_or_initial_metadata' => null]

$swaggerModelName

The original name of the model.

protected static string $swaggerModelName = 'accountUISettings'

$swaggerTypes

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

protected static array<string|int, string> $swaggerTypes = ['admin_message' => '\\DocuSign\\eSign\\Model\\AdminMessage', 'allow_users_to_edit_shared_access' => '?string', 'allow_users_to_edit_shared_access_metadata' => '\\DocuSign\\eSign\\Model\\SettingsMetadata', 'ask_an_admin' => '\\DocuSign\\eSign\\Model\\AskAnAdmin', 'clickwrap_schema_version' => '?string', 'clickwrap_schema_version_metadata' => '\\DocuSign\\eSign\\Model\\SettingsMetadata', 'enable_admin_message' => '?string', 'enable_admin_message_metadata' => '\\DocuSign\\eSign\\Model\\SettingsMetadata', 'enable_easy_sign_can_use_multi_template_apply' => '?string', 'enable_easy_sign_can_use_multi_template_apply_metadata' => '\\DocuSign\\eSign\\Model\\SettingsMetadata', 'enable_easy_sign_template_upload' => '?string', 'enable_easy_sign_template_upload_metadata' => '\\DocuSign\\eSign\\Model\\SettingsMetadata', 'enable_envelope_copy_with_data' => '?string', 'enable_envelope_copy_with_data_metadata' => '\\DocuSign\\eSign\\Model\\SettingsMetadata', 'enable_legacy_sendflow_link' => '?string', 'enable_legacy_sendflow_link_metadata' => '\\DocuSign\\eSign\\Model\\SettingsMetadata', 'has_external_linked_accounts' => '?string', 'has_external_linked_accounts_metadata' => '\\DocuSign\\eSign\\Model\\SettingsMetadata', 'hide_send_an_envelope' => '?string', 'hide_send_an_envelope_metadata' => '\\DocuSign\\eSign\\Model\\SettingsMetadata', 'hide_use_a_template' => '?string', 'hide_use_a_template_in_prepare' => '?string', 'hide_use_a_template_in_prepare_metadata' => '\\DocuSign\\eSign\\Model\\SettingsMetadata', 'hide_use_a_template_metadata' => '\\DocuSign\\eSign\\Model\\SettingsMetadata', 'order_based_recipient_id_generation' => '?string', 'order_based_recipient_id_generation_metadata' => '\\DocuSign\\eSign\\Model\\SettingsMetadata', 'remove_envelope_forwarding' => '?string', 'remove_envelope_forwarding_metadata' => '\\DocuSign\\eSign\\Model\\SettingsMetadata', 'should_redact_access_code' => '?string', 'should_redact_access_code_metadata' => '\\DocuSign\\eSign\\Model\\SettingsMetadata', 'upload_new_image_to_sign_or_initial' => '?string', 'upload_new_image_to_sign_or_initial_metadata' => '\\DocuSign\\eSign\\Model\\SettingsMetadata']

Methods

__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> —

getAllowUsersToEditSharedAccess()

Gets allow_users_to_edit_shared_access

public getAllowUsersToEditSharedAccess() : string|null
Return values
string|null —

getClickwrapSchemaVersion()

Gets clickwrap_schema_version

public getClickwrapSchemaVersion() : string|null
Return values
string|null —

getEnableAdminMessage()

Gets enable_admin_message

public getEnableAdminMessage() : string|null
Return values
string|null —

getEnableEasySignCanUseMultiTemplateApply()

Gets enable_easy_sign_can_use_multi_template_apply

public getEnableEasySignCanUseMultiTemplateApply() : string|null
Return values
string|null —

getEnableEasySignTemplateUpload()

Gets enable_easy_sign_template_upload

public getEnableEasySignTemplateUpload() : string|null
Return values
string|null —

getEnableEnvelopeCopyWithData()

Gets enable_envelope_copy_with_data

public getEnableEnvelopeCopyWithData() : string|null
Return values
string|null —

getEnableLegacySendflowLink()

Gets enable_legacy_sendflow_link

public getEnableLegacySendflowLink() : string|null
Return values
string|null —

getHasExternalLinkedAccounts()

Gets has_external_linked_accounts

public getHasExternalLinkedAccounts() : string|null
Return values
string|null —

getHideSendAnEnvelope()

Gets hide_send_an_envelope

public getHideSendAnEnvelope() : string|null
Return values
string|null —

getHideUseATemplate()

Gets hide_use_a_template

public getHideUseATemplate() : string|null
Return values
string|null —

getHideUseATemplateInPrepare()

Gets hide_use_a_template_in_prepare

public getHideUseATemplateInPrepare() : string|null
Return values
string|null —

getModelName()

The original name of the model.

public getModelName() : string
Return values
string —

getOrderBasedRecipientIdGeneration()

Gets order_based_recipient_id_generation

public getOrderBasedRecipientIdGeneration() : string|null
Return values
string|null —

getRemoveEnvelopeForwarding()

Gets remove_envelope_forwarding

public getRemoveEnvelopeForwarding() : string|null
Return values
string|null —

getShouldRedactAccessCode()

Gets should_redact_access_code

public getShouldRedactAccessCode() : string|null
Return values
string|null —

getters()

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

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

getUploadNewImageToSignOrInitial()

Gets upload_new_image_to_sign_or_initial

public getUploadNewImageToSignOrInitial() : string|null
Return values
string|null —

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 —

setAllowUsersToEditSharedAccess()

Sets allow_users_to_edit_shared_access

public setAllowUsersToEditSharedAccess(string|null $allow_users_to_edit_shared_access) : $this
Parameters
$allow_users_to_edit_shared_access : string|null
Return values
$this —

setAllowUsersToEditSharedAccessMetadata()

Sets allow_users_to_edit_shared_access_metadata

public setAllowUsersToEditSharedAccessMetadata(SettingsMetadata $allow_users_to_edit_shared_access_metadata) : $this
Parameters
$allow_users_to_edit_shared_access_metadata : SettingsMetadata
Return values
$this —

setClickwrapSchemaVersion()

Sets clickwrap_schema_version

public setClickwrapSchemaVersion(string|null $clickwrap_schema_version) : $this
Parameters
$clickwrap_schema_version : string|null
Return values
$this —

setClickwrapSchemaVersionMetadata()

Sets clickwrap_schema_version_metadata

public setClickwrapSchemaVersionMetadata(SettingsMetadata $clickwrap_schema_version_metadata) : $this
Parameters
$clickwrap_schema_version_metadata : SettingsMetadata
Return values
$this —

setEnableAdminMessage()

Sets enable_admin_message

public setEnableAdminMessage(string|null $enable_admin_message) : $this
Parameters
$enable_admin_message : string|null
Return values
$this —

setEnableAdminMessageMetadata()

Sets enable_admin_message_metadata

public setEnableAdminMessageMetadata(SettingsMetadata $enable_admin_message_metadata) : $this
Parameters
$enable_admin_message_metadata : SettingsMetadata
Return values
$this —

setEnableEasySignCanUseMultiTemplateApply()

Sets enable_easy_sign_can_use_multi_template_apply

public setEnableEasySignCanUseMultiTemplateApply(string|null $enable_easy_sign_can_use_multi_template_apply) : $this
Parameters
$enable_easy_sign_can_use_multi_template_apply : string|null
Return values
$this —

setEnableEasySignCanUseMultiTemplateApplyMetadata()

Sets enable_easy_sign_can_use_multi_template_apply_metadata

public setEnableEasySignCanUseMultiTemplateApplyMetadata(SettingsMetadata $enable_easy_sign_can_use_multi_template_apply_metadata) : $this
Parameters
$enable_easy_sign_can_use_multi_template_apply_metadata : SettingsMetadata
Return values
$this —

setEnableEasySignTemplateUpload()

Sets enable_easy_sign_template_upload

public setEnableEasySignTemplateUpload(string|null $enable_easy_sign_template_upload) : $this
Parameters
$enable_easy_sign_template_upload : string|null
Return values
$this —

setEnableEasySignTemplateUploadMetadata()

Sets enable_easy_sign_template_upload_metadata

public setEnableEasySignTemplateUploadMetadata(SettingsMetadata $enable_easy_sign_template_upload_metadata) : $this
Parameters
$enable_easy_sign_template_upload_metadata : SettingsMetadata
Return values
$this —

setEnableEnvelopeCopyWithData()

Sets enable_envelope_copy_with_data

public setEnableEnvelopeCopyWithData(string|null $enable_envelope_copy_with_data) : $this
Parameters
$enable_envelope_copy_with_data : string|null
Return values
$this —

setEnableEnvelopeCopyWithDataMetadata()

Sets enable_envelope_copy_with_data_metadata

public setEnableEnvelopeCopyWithDataMetadata(SettingsMetadata $enable_envelope_copy_with_data_metadata) : $this
Parameters
$enable_envelope_copy_with_data_metadata : SettingsMetadata
Return values
$this —

setEnableLegacySendflowLink()

Sets enable_legacy_sendflow_link

public setEnableLegacySendflowLink(string|null $enable_legacy_sendflow_link) : $this
Parameters
$enable_legacy_sendflow_link : string|null
Return values
$this —

setEnableLegacySendflowLinkMetadata()

Sets enable_legacy_sendflow_link_metadata

public setEnableLegacySendflowLinkMetadata(SettingsMetadata $enable_legacy_sendflow_link_metadata) : $this
Parameters
$enable_legacy_sendflow_link_metadata : SettingsMetadata
Return values
$this —

setHasExternalLinkedAccounts()

Sets has_external_linked_accounts

public setHasExternalLinkedAccounts(string|null $has_external_linked_accounts) : $this
Parameters
$has_external_linked_accounts : string|null
Return values
$this —

setHasExternalLinkedAccountsMetadata()

Sets has_external_linked_accounts_metadata

public setHasExternalLinkedAccountsMetadata(SettingsMetadata $has_external_linked_accounts_metadata) : $this
Parameters
$has_external_linked_accounts_metadata : SettingsMetadata
Return values
$this —

setHideSendAnEnvelope()

Sets hide_send_an_envelope

public setHideSendAnEnvelope(string|null $hide_send_an_envelope) : $this
Parameters
$hide_send_an_envelope : string|null
Return values
$this —

setHideSendAnEnvelopeMetadata()

Sets hide_send_an_envelope_metadata

public setHideSendAnEnvelopeMetadata(SettingsMetadata $hide_send_an_envelope_metadata) : $this
Parameters
$hide_send_an_envelope_metadata : SettingsMetadata
Return values
$this —

setHideUseATemplate()

Sets hide_use_a_template

public setHideUseATemplate(string|null $hide_use_a_template) : $this
Parameters
$hide_use_a_template : string|null
Return values
$this —

setHideUseATemplateInPrepare()

Sets hide_use_a_template_in_prepare

public setHideUseATemplateInPrepare(string|null $hide_use_a_template_in_prepare) : $this
Parameters
$hide_use_a_template_in_prepare : string|null
Return values
$this —

setHideUseATemplateInPrepareMetadata()

Sets hide_use_a_template_in_prepare_metadata

public setHideUseATemplateInPrepareMetadata(SettingsMetadata $hide_use_a_template_in_prepare_metadata) : $this
Parameters
$hide_use_a_template_in_prepare_metadata : SettingsMetadata
Return values
$this —

setHideUseATemplateMetadata()

Sets hide_use_a_template_metadata

public setHideUseATemplateMetadata(SettingsMetadata $hide_use_a_template_metadata) : $this
Parameters
$hide_use_a_template_metadata : SettingsMetadata
Return values
$this —

setOrderBasedRecipientIdGeneration()

Sets order_based_recipient_id_generation

public setOrderBasedRecipientIdGeneration(string|null $order_based_recipient_id_generation) : $this
Parameters
$order_based_recipient_id_generation : string|null
Return values
$this —

setOrderBasedRecipientIdGenerationMetadata()

Sets order_based_recipient_id_generation_metadata

public setOrderBasedRecipientIdGenerationMetadata(SettingsMetadata $order_based_recipient_id_generation_metadata) : $this
Parameters
$order_based_recipient_id_generation_metadata : SettingsMetadata
Return values
$this —

setRemoveEnvelopeForwarding()

Sets remove_envelope_forwarding

public setRemoveEnvelopeForwarding(string|null $remove_envelope_forwarding) : $this
Parameters
$remove_envelope_forwarding : string|null
Return values
$this —

setRemoveEnvelopeForwardingMetadata()

Sets remove_envelope_forwarding_metadata

public setRemoveEnvelopeForwardingMetadata(SettingsMetadata $remove_envelope_forwarding_metadata) : $this
Parameters
$remove_envelope_forwarding_metadata : SettingsMetadata
Return values
$this —

setShouldRedactAccessCode()

Sets should_redact_access_code

public setShouldRedactAccessCode(string|null $should_redact_access_code) : $this
Parameters
$should_redact_access_code : string|null
Return values
$this —

setShouldRedactAccessCodeMetadata()

Sets should_redact_access_code_metadata

public setShouldRedactAccessCodeMetadata(SettingsMetadata $should_redact_access_code_metadata) : $this
Parameters
$should_redact_access_code_metadata : SettingsMetadata
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> —

setUploadNewImageToSignOrInitial()

Sets upload_new_image_to_sign_or_initial

public setUploadNewImageToSignOrInitial(string|null $upload_new_image_to_sign_or_initial) : $this
Parameters
$upload_new_image_to_sign_or_initial : string|null
Return values
$this —

setUploadNewImageToSignOrInitialMetadata()

Sets upload_new_image_to_sign_or_initial_metadata

public setUploadNewImageToSignOrInitialMetadata(SettingsMetadata $upload_new_image_to_sign_or_initial_metadata) : $this
Parameters
$upload_new_image_to_sign_or_initial_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

Search results