Documentation

NotaryHost
in package

DocuSign

eSign

implements ModelInterface, ArrayAccess

NotaryHost 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
getAccessCode() : string|null: Gets access_code
getAccessCodeMetadata() : PropertyMetadata: Gets access_code_metadata
getAddAccessCodeToEmail() : string|null: Gets add_access_code_to_email
getAllowSystemOverrideForLockedRecipient() : string|null: Gets allow_system_override_for_locked_recipient
getAutoRespondedReason() : string|null: Gets auto_responded_reason
getBulkSendV2Recipient() : string|null: Gets bulk_send_v2_recipient
getClientUserId() : string|null: Gets client_user_id
getCompletedCount() : string|null: Gets completed_count
getCustomFields() : array<string|int, ?string>: Gets custom_fields
getDeclinedDateTime() : string|null: Gets declined_date_time
getDeclinedReason() : string|null: Gets declined_reason
getDeliveredDateTime() : string|null: Gets delivered_date_time
getDeliveryMethod() : string|null: Gets delivery_method
getDeliveryMethodMetadata() : PropertyMetadata: Gets delivery_method_metadata
getDesignatorId() : string|null: Gets designator_id
getDesignatorIdGuid() : string|null: Gets designator_id_guid
getDocumentVisibility() : array<string|int, DocumentVisibility>: Gets document_visibility
getEmail() : string|null: Gets email
getEmailMetadata() : PropertyMetadata: Gets email_metadata
getEmailNotification() : RecipientEmailNotification: Gets email_notification
getEmbeddedRecipientStartUrl() : string|null: Gets embedded_recipient_start_url
getErrorDetails() : ErrorDetails: Gets error_details
getFaxNumber() : string|null: Gets fax_number
getFaxNumberMetadata() : PropertyMetadata: Gets fax_number_metadata
getHostRecipientId() : string|null: Gets host_recipient_id
getIdCheckConfigurationName() : string|null: Gets id_check_configuration_name
getIdCheckConfigurationNameMetadata() : PropertyMetadata: Gets id_check_configuration_name_metadata
getIdCheckInformationInput() : IdCheckInformationInput: Gets id_check_information_input
getIdentityVerification() : RecipientIdentityVerification: Gets identity_verification
getInheritEmailNotificationConfiguration() : string|null: Gets inherit_email_notification_configuration
getLockedRecipientPhoneAuthEditable() : string|null: Gets locked_recipient_phone_auth_editable
getLockedRecipientSmsEditable() : string|null: Gets locked_recipient_sms_editable
getModelName() : string: The original name of the model.
getName() : string|null: Gets name
getNameMetadata() : PropertyMetadata: Gets name_metadata
getNote() : string|null: Gets note
getNoteMetadata() : PropertyMetadata: Gets note_metadata
getPhoneAuthentication() : RecipientPhoneAuthentication: Gets phone_authentication
getRecipientAttachments() : array<string|int, RecipientAttachment>: Gets recipient_attachments
getRecipientAuthenticationStatus() : AuthenticationStatus: Gets recipient_authentication_status
getRecipientFeatureMetadata() : array<string|int, FeatureAvailableMetadata>: Gets recipient_feature_metadata
getRecipientId() : string|null: Gets recipient_id
getRecipientIdGuid() : string|null: Gets recipient_id_guid
getRecipientType() : string|null: Gets recipient_type
getRecipientTypeMetadata() : PropertyMetadata: Gets recipient_type_metadata
getRequireIdLookup() : string|null: Gets require_id_lookup
getRequireIdLookupMetadata() : PropertyMetadata: Gets require_id_lookup_metadata
getRoleName() : string|null: Gets role_name
getRoutingOrder() : string|null: Gets routing_order
getRoutingOrderMetadata() : PropertyMetadata: Gets routing_order_metadata
getSentDateTime() : string|null: Gets sent_date_time
getSignedDateTime() : string|null: Gets signed_date_time
getSigningGroupId() : string|null: Gets signing_group_id
getSigningGroupIdMetadata() : PropertyMetadata: Gets signing_group_id_metadata
getSigningGroupName() : string|null: Gets signing_group_name
getSigningGroupUsers() : array<string|int, UserInfo>: Gets signing_group_users
getSmsAuthentication() : RecipientSMSAuthentication: Gets sms_authentication
getSocialAuthentications() : array<string|int, SocialAuthentication>: Gets social_authentications
getStatus() : string|null: Gets status
getStatusCode() : string|null: Gets status_code
getSuppressEmails() : string|null: Gets suppress_emails
getTabs() : Tabs: Gets tabs
getTemplateLocked() : string|null: Gets template_locked
getTemplateRequired() : string|null: Gets template_required
getters() : array<string|int, mixed>: Array of attributes to getter functions (for serialization of requests)
getTotalTabCount() : string|null: Gets total_tab_count
getUserId() : string|null: Gets user_id
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.
setAccessCode() : $this: Sets access_code
setAccessCodeMetadata() : $this: Sets access_code_metadata
setAddAccessCodeToEmail() : $this: Sets add_access_code_to_email
setAllowSystemOverrideForLockedRecipient() : $this: Sets allow_system_override_for_locked_recipient
setAutoRespondedReason() : $this: Sets auto_responded_reason
setBulkSendV2Recipient() : $this: Sets bulk_send_v2_recipient
setClientUserId() : $this: Sets client_user_id
setCompletedCount() : $this: Sets completed_count
setCustomFields() : $this: Sets custom_fields
setDeclinedDateTime() : $this: Sets declined_date_time
setDeclinedReason() : $this: Sets declined_reason
setDeliveredDateTime() : $this: Sets delivered_date_time
setDeliveryMethod() : $this: Sets delivery_method
setDeliveryMethodMetadata() : $this: Sets delivery_method_metadata
setDesignatorId() : $this: Sets designator_id
setDesignatorIdGuid() : $this: Sets designator_id_guid
setDocumentVisibility() : $this: Sets document_visibility
setEmail() : $this: Sets email
setEmailMetadata() : $this: Sets email_metadata
setEmailNotification() : $this: Sets email_notification
setEmbeddedRecipientStartUrl() : $this: Sets embedded_recipient_start_url
setErrorDetails() : $this: Sets error_details
setFaxNumber() : $this: Sets fax_number
setFaxNumberMetadata() : $this: Sets fax_number_metadata
setHostRecipientId() : $this: Sets host_recipient_id
setIdCheckConfigurationName() : $this: Sets id_check_configuration_name
setIdCheckConfigurationNameMetadata() : $this: Sets id_check_configuration_name_metadata
setIdCheckInformationInput() : $this: Sets id_check_information_input
setIdentityVerification() : $this: Sets identity_verification
setInheritEmailNotificationConfiguration() : $this: Sets inherit_email_notification_configuration
setLockedRecipientPhoneAuthEditable() : $this: Sets locked_recipient_phone_auth_editable
setLockedRecipientSmsEditable() : $this: Sets locked_recipient_sms_editable
setName() : $this: Sets name
setNameMetadata() : $this: Sets name_metadata
setNote() : $this: Sets note
setNoteMetadata() : $this: Sets note_metadata
setPhoneAuthentication() : $this: Sets phone_authentication
setRecipientAttachments() : $this: Sets recipient_attachments
setRecipientAuthenticationStatus() : $this: Sets recipient_authentication_status
setRecipientFeatureMetadata() : $this: Sets recipient_feature_metadata
setRecipientId() : $this: Sets recipient_id
setRecipientIdGuid() : $this: Sets recipient_id_guid
setRecipientType() : $this: Sets recipient_type
setRecipientTypeMetadata() : $this: Sets recipient_type_metadata
setRequireIdLookup() : $this: Sets require_id_lookup
setRequireIdLookupMetadata() : $this: Sets require_id_lookup_metadata
setRoleName() : $this: Sets role_name
setRoutingOrder() : $this: Sets routing_order
setRoutingOrderMetadata() : $this: Sets routing_order_metadata
setSentDateTime() : $this: Sets sent_date_time
setSignedDateTime() : $this: Sets signed_date_time
setSigningGroupId() : $this: Sets signing_group_id
setSigningGroupIdMetadata() : $this: Sets signing_group_id_metadata
setSigningGroupName() : $this: Sets signing_group_name
setSigningGroupUsers() : $this: Sets signing_group_users
setSmsAuthentication() : $this: Sets sms_authentication
setSocialAuthentications() : $this: Sets social_authentications
setStatus() : $this: Sets status
setStatusCode() : $this: Sets status_code
setSuppressEmails() : $this: Sets suppress_emails
setTabs() : $this: Sets tabs
setTemplateLocked() : $this: Sets template_locked
setTemplateRequired() : $this: Sets template_required
setters() : array<string|int, mixed>: Array of attributes to setter functions (for deserialization of responses)
setTotalTabCount() : $this: Sets total_tab_count
setUserId() : $this: Sets user_id
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
     = ['access_code' => 'accessCode', 'access_code_metadata' => 'accessCodeMetadata', 'add_access_code_to_email' => 'addAccessCodeToEmail', 'allow_system_override_for_locked_recipient' => 'allowSystemOverrideForLockedRecipient', 'auto_responded_reason' => 'autoRespondedReason', 'bulk_send_v2_recipient' => 'bulkSendV2Recipient', 'client_user_id' => 'clientUserId', 'completed_count' => 'completedCount', 'custom_fields' => 'customFields', 'declined_date_time' => 'declinedDateTime', 'declined_reason' => 'declinedReason', 'delivered_date_time' => 'deliveredDateTime', 'delivery_method' => 'deliveryMethod', 'delivery_method_metadata' => 'deliveryMethodMetadata', 'designator_id' => 'designatorId', 'designator_id_guid' => 'designatorIdGuid', 'document_visibility' => 'documentVisibility', 'email' => 'email', 'email_metadata' => 'emailMetadata', 'email_notification' => 'emailNotification', 'embedded_recipient_start_url' => 'embeddedRecipientStartURL', 'error_details' => 'errorDetails', 'fax_number' => 'faxNumber', 'fax_number_metadata' => 'faxNumberMetadata', 'host_recipient_id' => 'hostRecipientId', 'id_check_configuration_name' => 'idCheckConfigurationName', 'id_check_configuration_name_metadata' => 'idCheckConfigurationNameMetadata', 'id_check_information_input' => 'idCheckInformationInput', 'identity_verification' => 'identityVerification', 'inherit_email_notification_configuration' => 'inheritEmailNotificationConfiguration', 'locked_recipient_phone_auth_editable' => 'lockedRecipientPhoneAuthEditable', 'locked_recipient_sms_editable' => 'lockedRecipientSmsEditable', 'name' => 'name', 'name_metadata' => 'nameMetadata', 'note' => 'note', 'note_metadata' => 'noteMetadata', 'phone_authentication' => 'phoneAuthentication', 'recipient_attachments' => 'recipientAttachments', 'recipient_authentication_status' => 'recipientAuthenticationStatus', 'recipient_feature_metadata' => 'recipientFeatureMetadata', 'recipient_id' => 'recipientId', 'recipient_id_guid' => 'recipientIdGuid', 'recipient_type' => 'recipientType', 'recipient_type_metadata' => 'recipientTypeMetadata', 'require_id_lookup' => 'requireIdLookup', 'require_id_lookup_metadata' => 'requireIdLookupMetadata', 'role_name' => 'roleName', 'routing_order' => 'routingOrder', 'routing_order_metadata' => 'routingOrderMetadata', 'sent_date_time' => 'sentDateTime', 'signed_date_time' => 'signedDateTime', 'signing_group_id' => 'signingGroupId', 'signing_group_id_metadata' => 'signingGroupIdMetadata', 'signing_group_name' => 'signingGroupName', 'signing_group_users' => 'signingGroupUsers', 'sms_authentication' => 'smsAuthentication', 'social_authentications' => 'socialAuthentications', 'status' => 'status', 'status_code' => 'statusCode', 'suppress_emails' => 'suppressEmails', 'tabs' => 'tabs', 'template_locked' => 'templateLocked', 'template_required' => 'templateRequired', 'total_tab_count' => 'totalTabCount', 'user_id' => 'userId']

$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
     = ['access_code' => 'getAccessCode', 'access_code_metadata' => 'getAccessCodeMetadata', 'add_access_code_to_email' => 'getAddAccessCodeToEmail', 'allow_system_override_for_locked_recipient' => 'getAllowSystemOverrideForLockedRecipient', 'auto_responded_reason' => 'getAutoRespondedReason', 'bulk_send_v2_recipient' => 'getBulkSendV2Recipient', 'client_user_id' => 'getClientUserId', 'completed_count' => 'getCompletedCount', 'custom_fields' => 'getCustomFields', 'declined_date_time' => 'getDeclinedDateTime', 'declined_reason' => 'getDeclinedReason', 'delivered_date_time' => 'getDeliveredDateTime', 'delivery_method' => 'getDeliveryMethod', 'delivery_method_metadata' => 'getDeliveryMethodMetadata', 'designator_id' => 'getDesignatorId', 'designator_id_guid' => 'getDesignatorIdGuid', 'document_visibility' => 'getDocumentVisibility', 'email' => 'getEmail', 'email_metadata' => 'getEmailMetadata', 'email_notification' => 'getEmailNotification', 'embedded_recipient_start_url' => 'getEmbeddedRecipientStartUrl', 'error_details' => 'getErrorDetails', 'fax_number' => 'getFaxNumber', 'fax_number_metadata' => 'getFaxNumberMetadata', 'host_recipient_id' => 'getHostRecipientId', 'id_check_configuration_name' => 'getIdCheckConfigurationName', 'id_check_configuration_name_metadata' => 'getIdCheckConfigurationNameMetadata', 'id_check_information_input' => 'getIdCheckInformationInput', 'identity_verification' => 'getIdentityVerification', 'inherit_email_notification_configuration' => 'getInheritEmailNotificationConfiguration', 'locked_recipient_phone_auth_editable' => 'getLockedRecipientPhoneAuthEditable', 'locked_recipient_sms_editable' => 'getLockedRecipientSmsEditable', 'name' => 'getName', 'name_metadata' => 'getNameMetadata', 'note' => 'getNote', 'note_metadata' => 'getNoteMetadata', 'phone_authentication' => 'getPhoneAuthentication', 'recipient_attachments' => 'getRecipientAttachments', 'recipient_authentication_status' => 'getRecipientAuthenticationStatus', 'recipient_feature_metadata' => 'getRecipientFeatureMetadata', 'recipient_id' => 'getRecipientId', 'recipient_id_guid' => 'getRecipientIdGuid', 'recipient_type' => 'getRecipientType', 'recipient_type_metadata' => 'getRecipientTypeMetadata', 'require_id_lookup' => 'getRequireIdLookup', 'require_id_lookup_metadata' => 'getRequireIdLookupMetadata', 'role_name' => 'getRoleName', 'routing_order' => 'getRoutingOrder', 'routing_order_metadata' => 'getRoutingOrderMetadata', 'sent_date_time' => 'getSentDateTime', 'signed_date_time' => 'getSignedDateTime', 'signing_group_id' => 'getSigningGroupId', 'signing_group_id_metadata' => 'getSigningGroupIdMetadata', 'signing_group_name' => 'getSigningGroupName', 'signing_group_users' => 'getSigningGroupUsers', 'sms_authentication' => 'getSmsAuthentication', 'social_authentications' => 'getSocialAuthentications', 'status' => 'getStatus', 'status_code' => 'getStatusCode', 'suppress_emails' => 'getSuppressEmails', 'tabs' => 'getTabs', 'template_locked' => 'getTemplateLocked', 'template_required' => 'getTemplateRequired', 'total_tab_count' => 'getTotalTabCount', 'user_id' => 'getUserId']

$setters

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


    protected
    static    array<string|int, string>
    $setters
     = ['access_code' => 'setAccessCode', 'access_code_metadata' => 'setAccessCodeMetadata', 'add_access_code_to_email' => 'setAddAccessCodeToEmail', 'allow_system_override_for_locked_recipient' => 'setAllowSystemOverrideForLockedRecipient', 'auto_responded_reason' => 'setAutoRespondedReason', 'bulk_send_v2_recipient' => 'setBulkSendV2Recipient', 'client_user_id' => 'setClientUserId', 'completed_count' => 'setCompletedCount', 'custom_fields' => 'setCustomFields', 'declined_date_time' => 'setDeclinedDateTime', 'declined_reason' => 'setDeclinedReason', 'delivered_date_time' => 'setDeliveredDateTime', 'delivery_method' => 'setDeliveryMethod', 'delivery_method_metadata' => 'setDeliveryMethodMetadata', 'designator_id' => 'setDesignatorId', 'designator_id_guid' => 'setDesignatorIdGuid', 'document_visibility' => 'setDocumentVisibility', 'email' => 'setEmail', 'email_metadata' => 'setEmailMetadata', 'email_notification' => 'setEmailNotification', 'embedded_recipient_start_url' => 'setEmbeddedRecipientStartUrl', 'error_details' => 'setErrorDetails', 'fax_number' => 'setFaxNumber', 'fax_number_metadata' => 'setFaxNumberMetadata', 'host_recipient_id' => 'setHostRecipientId', 'id_check_configuration_name' => 'setIdCheckConfigurationName', 'id_check_configuration_name_metadata' => 'setIdCheckConfigurationNameMetadata', 'id_check_information_input' => 'setIdCheckInformationInput', 'identity_verification' => 'setIdentityVerification', 'inherit_email_notification_configuration' => 'setInheritEmailNotificationConfiguration', 'locked_recipient_phone_auth_editable' => 'setLockedRecipientPhoneAuthEditable', 'locked_recipient_sms_editable' => 'setLockedRecipientSmsEditable', 'name' => 'setName', 'name_metadata' => 'setNameMetadata', 'note' => 'setNote', 'note_metadata' => 'setNoteMetadata', 'phone_authentication' => 'setPhoneAuthentication', 'recipient_attachments' => 'setRecipientAttachments', 'recipient_authentication_status' => 'setRecipientAuthenticationStatus', 'recipient_feature_metadata' => 'setRecipientFeatureMetadata', 'recipient_id' => 'setRecipientId', 'recipient_id_guid' => 'setRecipientIdGuid', 'recipient_type' => 'setRecipientType', 'recipient_type_metadata' => 'setRecipientTypeMetadata', 'require_id_lookup' => 'setRequireIdLookup', 'require_id_lookup_metadata' => 'setRequireIdLookupMetadata', 'role_name' => 'setRoleName', 'routing_order' => 'setRoutingOrder', 'routing_order_metadata' => 'setRoutingOrderMetadata', 'sent_date_time' => 'setSentDateTime', 'signed_date_time' => 'setSignedDateTime', 'signing_group_id' => 'setSigningGroupId', 'signing_group_id_metadata' => 'setSigningGroupIdMetadata', 'signing_group_name' => 'setSigningGroupName', 'signing_group_users' => 'setSigningGroupUsers', 'sms_authentication' => 'setSmsAuthentication', 'social_authentications' => 'setSocialAuthentications', 'status' => 'setStatus', 'status_code' => 'setStatusCode', 'suppress_emails' => 'setSuppressEmails', 'tabs' => 'setTabs', 'template_locked' => 'setTemplateLocked', 'template_required' => 'setTemplateRequired', 'total_tab_count' => 'setTotalTabCount', 'user_id' => 'setUserId']

$swaggerFormats

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


    protected
    static    array<string|int, string>
    $swaggerFormats
     = ['access_code' => null, 'access_code_metadata' => null, 'add_access_code_to_email' => null, 'allow_system_override_for_locked_recipient' => null, 'auto_responded_reason' => null, 'bulk_send_v2_recipient' => null, 'client_user_id' => null, 'completed_count' => null, 'custom_fields' => null, 'declined_date_time' => null, 'declined_reason' => null, 'delivered_date_time' => null, 'delivery_method' => null, 'delivery_method_metadata' => null, 'designator_id' => null, 'designator_id_guid' => null, 'document_visibility' => null, 'email' => null, 'email_metadata' => null, 'email_notification' => null, 'embedded_recipient_start_url' => null, 'error_details' => null, 'fax_number' => null, 'fax_number_metadata' => null, 'host_recipient_id' => null, 'id_check_configuration_name' => null, 'id_check_configuration_name_metadata' => null, 'id_check_information_input' => null, 'identity_verification' => null, 'inherit_email_notification_configuration' => null, 'locked_recipient_phone_auth_editable' => null, 'locked_recipient_sms_editable' => null, 'name' => null, 'name_metadata' => null, 'note' => null, 'note_metadata' => null, 'phone_authentication' => null, 'recipient_attachments' => null, 'recipient_authentication_status' => null, 'recipient_feature_metadata' => null, 'recipient_id' => null, 'recipient_id_guid' => null, 'recipient_type' => null, 'recipient_type_metadata' => null, 'require_id_lookup' => null, 'require_id_lookup_metadata' => null, 'role_name' => null, 'routing_order' => null, 'routing_order_metadata' => null, 'sent_date_time' => null, 'signed_date_time' => null, 'signing_group_id' => null, 'signing_group_id_metadata' => null, 'signing_group_name' => null, 'signing_group_users' => null, 'sms_authentication' => null, 'social_authentications' => null, 'status' => null, 'status_code' => null, 'suppress_emails' => null, 'tabs' => null, 'template_locked' => null, 'template_required' => null, 'total_tab_count' => null, 'user_id' => null]

$swaggerModelName

The original name of the model.


    protected
    static    string
    $swaggerModelName
     = 'notaryHost'

$swaggerTypes

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


    protected
    static    array<string|int, string>
    $swaggerTypes
     = ['access_code' => '?string', 'access_code_metadata' => '\\DocuSign\\eSign\\Model\\PropertyMetadata', 'add_access_code_to_email' => '?string', 'allow_system_override_for_locked_recipient' => '?string', 'auto_responded_reason' => '?string', 'bulk_send_v2_recipient' => '?string', 'client_user_id' => '?string', 'completed_count' => '?string', 'custom_fields' => '?string[]', 'declined_date_time' => '?string', 'declined_reason' => '?string', 'delivered_date_time' => '?string', 'delivery_method' => '?string', 'delivery_method_metadata' => '\\DocuSign\\eSign\\Model\\PropertyMetadata', 'designator_id' => '?string', 'designator_id_guid' => '?string', 'document_visibility' => '\\DocuSign\\eSign\\Model\\DocumentVisibility[]', 'email' => '?string', 'email_metadata' => '\\DocuSign\\eSign\\Model\\PropertyMetadata', 'email_notification' => '\\DocuSign\\eSign\\Model\\RecipientEmailNotification', 'embedded_recipient_start_url' => '?string', 'error_details' => '\\DocuSign\\eSign\\Model\\ErrorDetails', 'fax_number' => '?string', 'fax_number_metadata' => '\\DocuSign\\eSign\\Model\\PropertyMetadata', 'host_recipient_id' => '?string', 'id_check_configuration_name' => '?string', 'id_check_configuration_name_metadata' => '\\DocuSign\\eSign\\Model\\PropertyMetadata', 'id_check_information_input' => '\\DocuSign\\eSign\\Model\\IdCheckInformationInput', 'identity_verification' => '\\DocuSign\\eSign\\Model\\RecipientIdentityVerification', 'inherit_email_notification_configuration' => '?string', 'locked_recipient_phone_auth_editable' => '?string', 'locked_recipient_sms_editable' => '?string', 'name' => '?string', 'name_metadata' => '\\DocuSign\\eSign\\Model\\PropertyMetadata', 'note' => '?string', 'note_metadata' => '\\DocuSign\\eSign\\Model\\PropertyMetadata', 'phone_authentication' => '\\DocuSign\\eSign\\Model\\RecipientPhoneAuthentication', 'recipient_attachments' => '\\DocuSign\\eSign\\Model\\RecipientAttachment[]', 'recipient_authentication_status' => '\\DocuSign\\eSign\\Model\\AuthenticationStatus', 'recipient_feature_metadata' => '\\DocuSign\\eSign\\Model\\FeatureAvailableMetadata[]', 'recipient_id' => '?string', 'recipient_id_guid' => '?string', 'recipient_type' => '?string', 'recipient_type_metadata' => '\\DocuSign\\eSign\\Model\\PropertyMetadata', 'require_id_lookup' => '?string', 'require_id_lookup_metadata' => '\\DocuSign\\eSign\\Model\\PropertyMetadata', 'role_name' => '?string', 'routing_order' => '?string', 'routing_order_metadata' => '\\DocuSign\\eSign\\Model\\PropertyMetadata', 'sent_date_time' => '?string', 'signed_date_time' => '?string', 'signing_group_id' => '?string', 'signing_group_id_metadata' => '\\DocuSign\\eSign\\Model\\PropertyMetadata', 'signing_group_name' => '?string', 'signing_group_users' => '\\DocuSign\\eSign\\Model\\UserInfo[]', 'sms_authentication' => '\\DocuSign\\eSign\\Model\\RecipientSMSAuthentication', 'social_authentications' => '\\DocuSign\\eSign\\Model\\SocialAuthentication[]', 'status' => '?string', 'status_code' => '?string', 'suppress_emails' => '?string', 'tabs' => '\\DocuSign\\eSign\\Model\\Tabs', 'template_locked' => '?string', 'template_required' => '?string', 'total_tab_count' => '?string', 'user_id' => '?string']

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

getAccessCode()

Gets access_code


    public
                getAccessCode() : string|null

Return values

string|null —

getAccessCodeMetadata()

Gets access_code_metadata


    public
                getAccessCodeMetadata() : PropertyMetadata

Return values

PropertyMetadata —

getAddAccessCodeToEmail()

Gets add_access_code_to_email


    public
                getAddAccessCodeToEmail() : string|null

Return values

string|null —

getAllowSystemOverrideForLockedRecipient()

Gets allow_system_override_for_locked_recipient


    public
                getAllowSystemOverrideForLockedRecipient() : string|null

Return values

string|null —

getAutoRespondedReason()

Gets auto_responded_reason


    public
                getAutoRespondedReason() : string|null

Return values

string|null —

getBulkSendV2Recipient()

Gets bulk_send_v2_recipient


    public
                getBulkSendV2Recipient() : string|null

Return values

string|null —

getClientUserId()

Gets client_user_id


    public
                getClientUserId() : string|null

Return values

string|null —

getCompletedCount()

Gets completed_count


    public
                getCompletedCount() : string|null

Return values

string|null —

getCustomFields()

Gets custom_fields


    public
                getCustomFields() : array<string|int, ?string>

Return values

array<string|int, ?string> —

getDeclinedDateTime()

Gets declined_date_time


    public
                getDeclinedDateTime() : string|null

Return values

string|null —

getDeclinedReason()

Gets declined_reason


    public
                getDeclinedReason() : string|null

Return values

string|null —

getDeliveredDateTime()

Gets delivered_date_time


    public
                getDeliveredDateTime() : string|null

Return values

string|null —

getDeliveryMethod()

Gets delivery_method


    public
                getDeliveryMethod() : string|null

Return values

string|null —

getDeliveryMethodMetadata()

Gets delivery_method_metadata


    public
                getDeliveryMethodMetadata() : PropertyMetadata

Return values

PropertyMetadata —

getDesignatorId()

Gets designator_id


    public
                getDesignatorId() : string|null

Return values

string|null —

getDesignatorIdGuid()

Gets designator_id_guid


    public
                getDesignatorIdGuid() : string|null

Return values

string|null —

getDocumentVisibility()

Gets document_visibility


    public
                getDocumentVisibility() : array<string|int, DocumentVisibility>

Return values

array<string|int, DocumentVisibility> —

getEmail()

Gets email


    public
                getEmail() : string|null

Return values

string|null —

getEmailMetadata()

Gets email_metadata


    public
                getEmailMetadata() : PropertyMetadata

Return values

PropertyMetadata —

getEmailNotification()

Gets email_notification


    public
                getEmailNotification() : RecipientEmailNotification

Return values

RecipientEmailNotification —

getEmbeddedRecipientStartUrl()

Gets embedded_recipient_start_url


    public
                getEmbeddedRecipientStartUrl() : string|null

Return values

string|null —

getErrorDetails()

Gets error_details


    public
                getErrorDetails() : ErrorDetails

Return values

ErrorDetails —

getFaxNumber()

Gets fax_number


    public
                getFaxNumber() : string|null

Return values

string|null —

getFaxNumberMetadata()

Gets fax_number_metadata


    public
                getFaxNumberMetadata() : PropertyMetadata

Return values

PropertyMetadata —

getHostRecipientId()

Gets host_recipient_id


    public
                getHostRecipientId() : string|null

Return values

string|null —

getIdCheckConfigurationName()

Gets id_check_configuration_name


    public
                getIdCheckConfigurationName() : string|null

Return values

string|null —

getIdCheckConfigurationNameMetadata()

Gets id_check_configuration_name_metadata


    public
                getIdCheckConfigurationNameMetadata() : PropertyMetadata

Return values

PropertyMetadata —

getIdCheckInformationInput()

Gets id_check_information_input


    public
                getIdCheckInformationInput() : IdCheckInformationInput

Return values

IdCheckInformationInput —

getIdentityVerification()

Gets identity_verification


    public
                getIdentityVerification() : RecipientIdentityVerification

Return values

RecipientIdentityVerification —

getInheritEmailNotificationConfiguration()

Gets inherit_email_notification_configuration


    public
                getInheritEmailNotificationConfiguration() : string|null

Return values

string|null —

getLockedRecipientPhoneAuthEditable()

Gets locked_recipient_phone_auth_editable


    public
                getLockedRecipientPhoneAuthEditable() : string|null

Return values

string|null —

getLockedRecipientSmsEditable()

Gets locked_recipient_sms_editable


    public
                getLockedRecipientSmsEditable() : string|null

Return values

string|null —

getModelName()

The original name of the model.


    public
                getModelName() : string

Return values

string —

getName()

Gets name


    public
                getName() : string|null

Return values

string|null —

getNameMetadata()

Gets name_metadata


    public
                getNameMetadata() : PropertyMetadata

Return values

PropertyMetadata —

getNote()

Gets note


    public
                getNote() : string|null

Return values

string|null —

getNoteMetadata()

Gets note_metadata


    public
                getNoteMetadata() : PropertyMetadata

Return values

PropertyMetadata —

getPhoneAuthentication()

Gets phone_authentication


    public
                getPhoneAuthentication() : RecipientPhoneAuthentication

Return values

RecipientPhoneAuthentication —

getRecipientAttachments()

Gets recipient_attachments


    public
                getRecipientAttachments() : array<string|int, RecipientAttachment>

Return values

array<string|int, RecipientAttachment> —

getRecipientAuthenticationStatus()

Gets recipient_authentication_status


    public
                getRecipientAuthenticationStatus() : AuthenticationStatus

Return values

AuthenticationStatus —

getRecipientFeatureMetadata()

Gets recipient_feature_metadata


    public
                getRecipientFeatureMetadata() : array<string|int, FeatureAvailableMetadata>

Return values

array<string|int, FeatureAvailableMetadata> —

getRecipientId()

Gets recipient_id


    public
                getRecipientId() : string|null

Return values

string|null —

getRecipientIdGuid()

Gets recipient_id_guid


    public
                getRecipientIdGuid() : string|null

Return values

string|null —

getRecipientType()

Gets recipient_type


    public
                getRecipientType() : string|null

Return values

string|null —

getRecipientTypeMetadata()

Gets recipient_type_metadata


    public
                getRecipientTypeMetadata() : PropertyMetadata

Return values

PropertyMetadata —

getRequireIdLookup()

Gets require_id_lookup


    public
                getRequireIdLookup() : string|null

Return values

string|null —

getRequireIdLookupMetadata()

Gets require_id_lookup_metadata


    public
                getRequireIdLookupMetadata() : PropertyMetadata

Return values

PropertyMetadata —

getRoleName()

Gets role_name


    public
                getRoleName() : string|null

Return values

string|null —

getRoutingOrder()

Gets routing_order


    public
                getRoutingOrder() : string|null

Return values

string|null —

getRoutingOrderMetadata()

Gets routing_order_metadata


    public
                getRoutingOrderMetadata() : PropertyMetadata

Return values

PropertyMetadata —

getSentDateTime()

Gets sent_date_time


    public
                getSentDateTime() : string|null

Return values

string|null —

getSignedDateTime()

Gets signed_date_time


    public
                getSignedDateTime() : string|null

Return values

string|null —

getSigningGroupId()

Gets signing_group_id


    public
                getSigningGroupId() : string|null

Return values

string|null —

getSigningGroupIdMetadata()

Gets signing_group_id_metadata


    public
                getSigningGroupIdMetadata() : PropertyMetadata

Return values

PropertyMetadata —

getSigningGroupName()

Gets signing_group_name


    public
                getSigningGroupName() : string|null

Return values

string|null —

getSigningGroupUsers()

Gets signing_group_users


    public
                getSigningGroupUsers() : array<string|int, UserInfo>

Return values

array<string|int, UserInfo> —

getSmsAuthentication()

Gets sms_authentication


    public
                getSmsAuthentication() : RecipientSMSAuthentication

Return values

RecipientSMSAuthentication —

getSocialAuthentications()

Gets social_authentications


    public
                getSocialAuthentications() : array<string|int, SocialAuthentication>

Return values

array<string|int, SocialAuthentication> —

getStatus()

Gets status


    public
                getStatus() : string|null

Return values

string|null —

getStatusCode()

Gets status_code


    public
                getStatusCode() : string|null

Return values

string|null —

getSuppressEmails()

Gets suppress_emails


    public
                getSuppressEmails() : string|null

Return values

string|null —

getTabs()

Gets tabs


    public
                getTabs() : Tabs

Return values

Tabs —

getTemplateLocked()

Gets template_locked


    public
                getTemplateLocked() : string|null

Return values

string|null —

getTemplateRequired()

Gets template_required


    public
                getTemplateRequired() : 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> —

getTotalTabCount()

Gets total_tab_count


    public
                getTotalTabCount() : string|null

Return values

string|null —

getUserId()

Gets user_id


    public
                getUserId() : 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 —

setAccessCode()

Sets access_code


    public
                setAccessCode(string|null $access_code) : $this

Parameters

$access_code : string|null: If a value is provided, the recipient must enter the value as the access code to view and sign the envelope. Maximum Length: 50 characters and it must conform to the account's access code format setting. If blank, but the signer accessCode property is set in the envelope, then that value is used. If blank and the signer accessCode property is not set, then the access code is not required.

Return values

$this —

setAccessCodeMetadata()

Sets access_code_metadata


    public
                setAccessCodeMetadata(PropertyMetadata $access_code_metadata) : $this

Parameters

$access_code_metadata : PropertyMetadata: Metadata that indicates whether the accessCode property is editable. This property is read-only.

Return values

$this —

setAddAccessCodeToEmail()

Sets add_access_code_to_email


    public
                setAddAccessCodeToEmail(string|null $add_access_code_to_email) : $this

Parameters

$add_access_code_to_email : string|null: This Optional attribute indicates that the access code will be added to the email sent to the recipient; this nullifies the Security measure of Access Code on the recipient.

Return values

$this —

setAllowSystemOverrideForLockedRecipient()

Sets allow_system_override_for_locked_recipient


    public
                setAllowSystemOverrideForLockedRecipient(string|null $allow_system_override_for_locked_recipient) : $this

Parameters

$allow_system_override_for_locked_recipient : string|null

Return values

$this —

setAutoRespondedReason()

Sets auto_responded_reason


    public
                setAutoRespondedReason(string|null $auto_responded_reason) : $this

Parameters

$auto_responded_reason : string|null

Return values

$this —

setBulkSendV2Recipient()

Sets bulk_send_v2_recipient


    public
                setBulkSendV2Recipient(string|null $bulk_send_v2_recipient) : $this

Parameters

$bulk_send_v2_recipient : string|null

Return values

$this —

setClientUserId()

Sets client_user_id


    public
                setClientUserId(string|null $client_user_id) : $this

Parameters

$client_user_id : string|null: Specifies whether the recipient is embedded or remote. If the clientUserId property is not null then the recipient is embedded. Note that if the ClientUserId property is set and either SignerMustHaveAccount or SignerMustLoginToSign property of the account settings is set to true, an error is generated on sending.ng. Maximum length: 100 characters.

Return values

$this —

setCompletedCount()

Sets completed_count


    public
                setCompletedCount(string|null $completed_count) : $this

Parameters

$completed_count : string|null

Return values

$this —

setCustomFields()

Sets custom_fields


    public
                setCustomFields(array<string|int, ?string> $custom_fields) : $this

Parameters

$custom_fields : array<string|int, ?string>: An optional array of strings that allows the sender to provide custom data about the recipient. This information is returned in the envelope status but otherwise not used by DocuSign. Each customField string can be a maximum of 100 characters.

Return values

$this —

setDeclinedDateTime()

Sets declined_date_time


    public
                setDeclinedDateTime(string|null $declined_date_time) : $this

Parameters

$declined_date_time : string|null: The date and time the recipient declined the document.

Return values

$this —

setDeclinedReason()

Sets declined_reason


    public
                setDeclinedReason(string|null $declined_reason) : $this

Parameters

$declined_reason : string|null: The reason the recipient declined the document.

Return values

$this —

setDeliveredDateTime()

Sets delivered_date_time


    public
                setDeliveredDateTime(string|null $delivered_date_time) : $this

Parameters

$delivered_date_time : string|null: Reserved: For DocuSign use only.

Return values

$this —

setDeliveryMethod()

Sets delivery_method


    public
                setDeliveryMethod(string|null $delivery_method) : $this

Parameters

$delivery_method : string|null: Reserved: For DocuSign use only.

Return values

$this —

setDeliveryMethodMetadata()

Sets delivery_method_metadata


    public
                setDeliveryMethodMetadata(PropertyMetadata $delivery_method_metadata) : $this

Parameters

$delivery_method_metadata : PropertyMetadata: Reserved for DocuSign.

Return values

$this —

setDesignatorId()

Sets designator_id


    public
                setDesignatorId(string|null $designator_id) : $this

Parameters

$designator_id : string|null

Return values

$this —

setDesignatorIdGuid()

Sets designator_id_guid


    public
                setDesignatorIdGuid(string|null $designator_id_guid) : $this

Parameters

$designator_id_guid : string|null

Return values

$this —

setDocumentVisibility()

Sets document_visibility


    public
                setDocumentVisibility(array<string|int, DocumentVisibility> $document_visibility) : $this

Parameters

$document_visibility : array<string|int, DocumentVisibility>

Return values

$this —

setEmail()

Sets email


    public
                setEmail(string|null $email) : $this

Parameters

$email : string|null

Return values

$this —

setEmailMetadata()

Sets email_metadata


    public
                setEmailMetadata(PropertyMetadata $email_metadata) : $this

Parameters

$email_metadata : PropertyMetadata: Metadata that indicates whether the email property is editable. This property is read-only.

Return values

$this —

setEmailNotification()

Sets email_notification


    public
                setEmailNotification(RecipientEmailNotification $email_notification) : $this

Parameters

$email_notification : RecipientEmailNotification: A complex type that contains information sets the language of the recipient's email information. IMPORTANT: If you enable email notification for one recipient, you must enable email notification for all recipients as it overrides the Envelope Subject and EmailBlurb property settings.

Return values

$this —

setEmbeddedRecipientStartUrl()

Sets embedded_recipient_start_url


    public
                setEmbeddedRecipientStartUrl(string|null $embedded_recipient_start_url) : $this

Parameters

$embedded_recipient_start_url : string|null: Specifies a sender provided valid URL string for redirecting an embedded recipient. When using this option, the embedded recipient still receives an email from DocuSign, just as a remote recipient would. When the document link in the email is clicked the recipient is redirected, through DocuSign, to the supplied URL to complete their actions. When routing to the URL, the sender's system (the server responding to the URL) must request a recipient token to launch a signing session. If set to SIGN_AT_DOCUSIGN, the recipient is directed to an embedded signing or viewing process directly at DocuSign. The signing or viewing action is initiated by the DocuSign system and the transaction activity and Certificate of Completion records will reflect this. In all other ways the process is identical to an embedded signing or viewing operation that is launched by any partner. It is important to remember that in a typical embedded workflow the authentication of an embedded recipient is the responsibility of the sending application, DocuSign expects that senders will follow their own process for establishing the recipient's identity. In this workflow the recipient goes through the sending application before the embedded signing or viewing process in initiated. However, when the sending application sets EmbeddedRecipientStartURL=SIGN_AT_DOCUSIGN, the recipient goes directly to the embedded signing or viewing process bypassing the sending application and any authentication steps the sending application would use. In this case, DocuSign recommends that you use one of the normal DocuSign authentication features (Access Code, Phone Authentication, SMS Authentication, etc.) to verify the identity of the recipient. If the clientUserId property is NOT set, and the embeddedRecipientStartURL is set, DocuSign will ignore the redirect URL and launch the standard signing process for the email recipient. Information can be appended to the embedded recipient start URL using merge fields. The available merge fields items are: envelopeId, recipientId, recipientName, recipientEmail, and customFields. The customFields property must be set fort the recipient or envelope. The merge fields are enclosed in double brackets. Example: http://senderHost/[[mergeField1]]/ beginSigningSession? [[mergeField2]]&[[mergeField3]]

Return values

$this —

setErrorDetails()

Sets error_details


    public
                setErrorDetails(ErrorDetails $error_details) : $this

Parameters

$error_details : ErrorDetails: Array or errors.

Return values

$this —

setFaxNumber()

Sets fax_number


    public
                setFaxNumber(string|null $fax_number) : $this

Parameters

$fax_number : string|null: Reserved:

Return values

$this —

setFaxNumberMetadata()

Sets fax_number_metadata


    public
                setFaxNumberMetadata(PropertyMetadata $fax_number_metadata) : $this

Parameters

$fax_number_metadata : PropertyMetadata: Reserved for DocuSign.

Return values

$this —

setHostRecipientId()

Sets host_recipient_id


    public
                setHostRecipientId(string|null $host_recipient_id) : $this

Parameters

$host_recipient_id : string|null

Return values

$this —

setIdCheckConfigurationName()

Sets id_check_configuration_name


    public
                setIdCheckConfigurationName(string|null $id_check_configuration_name) : $this

Parameters

$id_check_configuration_name : string|null: Specifies authentication check by name. The names used here must be the same as the authentication type names used by the account (these name can also be found in the web console sending interface in the Identify list for a recipient,) This overrides any default authentication setting. Example: Your account has ID Check and SMS Authentication available and in the web console Identify list these appear as 'ID Check $' and 'SMS Auth $'. To use ID check in an envelope, the idCheckConfigurationName should be 'ID Check '. If you wanted to use SMS, it would be 'SMS Auth $' and you would need to add you would need to add phone number information to the smsAuthentication node.

Return values

$this —

setIdCheckConfigurationNameMetadata()

Sets id_check_configuration_name_metadata


    public
                setIdCheckConfigurationNameMetadata(PropertyMetadata $id_check_configuration_name_metadata) : $this

Parameters

$id_check_configuration_name_metadata : PropertyMetadata: Metadata that indicates whether the idCheckConfigurationName property is editable. This property is read-only.

Return values

$this —

setIdCheckInformationInput()

Sets id_check_information_input


    public
                setIdCheckInformationInput(IdCheckInformationInput $id_check_information_input) : $this

Parameters

$id_check_information_input : IdCheckInformationInput: An object that contains input information related to a recipient ID check.

Return values

$this —

setIdentityVerification()

Sets identity_verification


    public
                setIdentityVerification(RecipientIdentityVerification $identity_verification) : $this

Parameters

$identity_verification : RecipientIdentityVerification: Specifies the ID Verification workflow applied on an envelope by workflow ID.
See the list method in the IdentityVerifications resource for more information on how to retrieve workflow IDs available for an account.
This can be used in addition to other recipient authentication methods.
Note that ID Verification and ID Check are two distinct methods. ID Verification checks recipients' identity by verifying their ID while ID Check relies on data available on public records (such as current and former address).

Return values

$this —

setInheritEmailNotificationConfiguration()

Sets inherit_email_notification_configuration


    public
                setInheritEmailNotificationConfiguration(string|null $inherit_email_notification_configuration) : $this

Parameters

$inherit_email_notification_configuration : string|null: When set to true and the envelope recipient creates a DocuSign account after signing, the Manage Account Email Notification settings are used as the default settings for the recipient's account.

Return values

$this —

setLockedRecipientPhoneAuthEditable()

Sets locked_recipient_phone_auth_editable


    public
                setLockedRecipientPhoneAuthEditable(string|null $locked_recipient_phone_auth_editable) : $this

Parameters

$locked_recipient_phone_auth_editable : string|null

Return values

$this —

setLockedRecipientSmsEditable()

Sets locked_recipient_sms_editable


    public
                setLockedRecipientSmsEditable(string|null $locked_recipient_sms_editable) : $this

Parameters

$locked_recipient_sms_editable : string|null

Return values

$this —

setName()

Sets name


    public
                setName(string|null $name) : $this

Parameters

$name : string|null

Return values

$this —

setNameMetadata()

Sets name_metadata


    public
                setNameMetadata(PropertyMetadata $name_metadata) : $this

Parameters

$name_metadata : PropertyMetadata: Metadata that indicates whether the name property is editable. This property is read-only.

Return values

$this —

setNote()

Sets note


    public
                setNote(string|null $note) : $this

Parameters

$note : string|null: Specifies a note that is unique to this recipient. This note is sent to the recipient via the signing email. The note displays in the signing UI near the upper left corner of the document on the signing screen. Maximum Length: 1000 characters.

Return values

$this —

setNoteMetadata()

Sets note_metadata


    public
                setNoteMetadata(PropertyMetadata $note_metadata) : $this

Parameters

$note_metadata : PropertyMetadata: Metadata that indicates whether the note property is editable. This property is read-only.

Return values

$this —

setPhoneAuthentication()

Sets phone_authentication


    public
                setPhoneAuthentication(RecipientPhoneAuthentication $phone_authentication) : $this

Parameters

$phone_authentication : RecipientPhoneAuthentication: When idCheckConfigurationName is set to Phone Auth $, you use this complex type to provide the recipient authentication method details. It contains the following elements: * recipMayProvideNumber: Boolean. When true, the recipient can use whatever phone number they choose. * senderProvidedNumbers: ArrayOfStrings. A list of phone numbers the recipient can use. * recordVoicePrint: Reserved for DocuSign. * validateRecipProvidedNumber: Reserved for DocuSign.

Return values

$this —

setRecipientAttachments()

Sets recipient_attachments


    public
                setRecipientAttachments(array<string|int, RecipientAttachment> $recipient_attachments) : $this

Parameters

$recipient_attachments : array<string|int, RecipientAttachment>: Reserved:

Return values

$this —

setRecipientAuthenticationStatus()

Sets recipient_authentication_status


    public
                setRecipientAuthenticationStatus(AuthenticationStatus $recipient_authentication_status) : $this

Parameters

$recipient_authentication_status : AuthenticationStatus: Information about the recipient's authentication status. This property is read-only.

Return values

$this —

setRecipientFeatureMetadata()

Sets recipient_feature_metadata


    public
                setRecipientFeatureMetadata(array<string|int, FeatureAvailableMetadata> $recipient_feature_metadata) : $this

Parameters

$recipient_feature_metadata : array<string|int, FeatureAvailableMetadata>

Return values

$this —

setRecipientId()

Sets recipient_id


    public
                setRecipientId(string|null $recipient_id) : $this

Parameters

$recipient_id : string|null: Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document.

Return values

$this —

setRecipientIdGuid()

Sets recipient_id_guid


    public
                setRecipientIdGuid(string|null $recipient_id_guid) : $this

Parameters

$recipient_id_guid : string|null

Return values

$this —

setRecipientType()

Sets recipient_type


    public
                setRecipientType(string|null $recipient_type) : $this

Parameters

$recipient_type : string|null

Return values

$this —

setRecipientTypeMetadata()

Sets recipient_type_metadata


    public
                setRecipientTypeMetadata(PropertyMetadata $recipient_type_metadata) : $this

Parameters

$recipient_type_metadata : PropertyMetadata: Metadata that indicates whether the recipientType property is editable. This property is read-only.

Return values

$this —

setRequireIdLookup()

Sets require_id_lookup


    public
                setRequireIdLookup(string|null $require_id_lookup) : $this

Parameters

$require_id_lookup : string|null: When set to true, the recipient is required to use the specified ID check method (including Phone and SMS authentication) to validate their identity.

Return values

$this —

setRequireIdLookupMetadata()

Sets require_id_lookup_metadata


    public
                setRequireIdLookupMetadata(PropertyMetadata $require_id_lookup_metadata) : $this

Parameters

$require_id_lookup_metadata : PropertyMetadata: Metadata that indicates whether the requireIdLookup property is editable. This property is read-only.

Return values

$this —

setRoleName()

Sets role_name


    public
                setRoleName(string|null $role_name) : $this

Parameters

$role_name : string|null: Optional element. Specifies the role name associated with the recipient.

This is required when working with template recipients.

Return values

$this —

setRoutingOrder()

Sets routing_order


    public
                setRoutingOrder(string|null $routing_order) : $this

Parameters

$routing_order : string|null: Specifies the routing order of the recipient in the envelope.

Return values

$this —

setRoutingOrderMetadata()

Sets routing_order_metadata


    public
                setRoutingOrderMetadata(PropertyMetadata $routing_order_metadata) : $this

Parameters

$routing_order_metadata : PropertyMetadata: Metadata that indicates whether the routingOrder property is editable. This property is read-only.

Return values

$this —

setSentDateTime()

Sets sent_date_time


    public
                setSentDateTime(string|null $sent_date_time) : $this

Parameters

$sent_date_time : string|null: The date and time the envelope was sent.

Return values

$this —

setSignedDateTime()

Sets signed_date_time


    public
                setSignedDateTime(string|null $signed_date_time) : $this

Parameters

$signed_date_time : string|null: Reserved: For DocuSign use only.

Return values

$this —

setSigningGroupId()

Sets signing_group_id


    public
                setSigningGroupId(string|null $signing_group_id) : $this

Parameters

$signing_group_id : string|null: When set to true and the feature is enabled in the sender's account, the signing recipient is required to draw signatures and initials at each signature/initial tab ( instead of adopting a signature/initial style or only drawing a signature/initial once).

Return values

$this —

setSigningGroupIdMetadata()

Sets signing_group_id_metadata


    public
                setSigningGroupIdMetadata(PropertyMetadata $signing_group_id_metadata) : $this

Parameters

$signing_group_id_metadata : PropertyMetadata: Metadata that indicates whether the signingGroupId property is editable. This property is read-only.

Return values

$this —

setSigningGroupName()

Sets signing_group_name


    public
                setSigningGroupName(string|null $signing_group_name) : $this

Parameters

$signing_group_name : string|null: The display name for the signing group. Maximum Length: 100 characters.

Return values

$this —

setSigningGroupUsers()

Sets signing_group_users


    public
                setSigningGroupUsers(array<string|int, UserInfo> $signing_group_users) : $this

Parameters

$signing_group_users : array<string|int, UserInfo>: A complex type that contains information about users in the signing group.

Return values

$this —

setSmsAuthentication()

Sets sms_authentication


    public
                setSmsAuthentication(RecipientSMSAuthentication $sms_authentication) : $this

Parameters

$sms_authentication : RecipientSMSAuthentication: When idCheckConfigurationName is set to SMS Auth $, you use this complex type to provide the recipient authentication method details. It contains the element senderProvidedNumbers, which is an array of phone numbers that the recipient can use for SMS text authentication.

Return values

$this —

setSocialAuthentications()

Sets social_authentications


    public
                setSocialAuthentications(array<string|int, SocialAuthentication> $social_authentications) : $this

Parameters

$social_authentications : array<string|int, SocialAuthentication>: Lists the social ID type that can be used for recipient authentication.

Return values

$this —

setStatus()

Sets status


    public
                setStatus(string|null $status) : $this

Parameters

$status : string|null: Indicates the envelope status. Valid values are: * sent - The envelope is sent to the recipients. * created - The envelope is saved as a draft and can be modified and sent later.

Return values

$this —

setStatusCode()

Sets status_code


    public
                setStatusCode(string|null $status_code) : $this

Parameters

$status_code : string|null

Return values

$this —

setSuppressEmails()

Sets suppress_emails


    public
                setSuppressEmails(string|null $suppress_emails) : $this

Parameters

$suppress_emails : string|null

Return values

$this —

setTabs()

Sets tabs


    public
                setTabs(Tabs $tabs) : $this

Parameters

$tabs : Tabs: A list of tabs, which are represented graphically as symbols on documents at the time of signing. Tabs show recipients where to sign, initial, or enter data. They may also display data to the recipients.

Return values

$this —

setTemplateLocked()

Sets template_locked


    public
                setTemplateLocked(string|null $template_locked) : $this

Parameters

$template_locked : string|null: When set to true, the sender cannot change any attributes of the recipient. Used only when working with template recipients.

Return values

$this —

setTemplateRequired()

Sets template_required


    public
                setTemplateRequired(string|null $template_required) : $this

Parameters

$template_required : string|null: When set to true, the sender may not remove the recipient. Used only when working with template recipients.

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

setTotalTabCount()

Sets total_tab_count


    public
                setTotalTabCount(string|null $total_tab_count) : $this

Parameters

$total_tab_count : string|null

Return values

$this —

setUserId()

Sets user_id


    public
                setUserId(string|null $user_id) : $this

Parameters

$user_id : string|null

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

NotaryHost 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

getAccessCode()

Return values

getAccessCodeMetadata()

Return values

getAddAccessCodeToEmail()

Return values

getAllowSystemOverrideForLockedRecipient()

Return values

getAutoRespondedReason()

Return values

getBulkSendV2Recipient()

Return values

getClientUserId()

Return values

getCompletedCount()

Return values

getCustomFields()

Return values

getDeclinedDateTime()

Return values

getDeclinedReason()

Return values

getDeliveredDateTime()

Return values

getDeliveryMethod()

Return values

getDeliveryMethodMetadata()

Return values

getDesignatorId()

Return values

getDesignatorIdGuid()

Return values

getDocumentVisibility()

Return values

getEmail()

Return values

getEmailMetadata()

Return values

getEmailNotification()

Return values

getEmbeddedRecipientStartUrl()

Return values

getErrorDetails()

Return values

getFaxNumber()

Return values

getFaxNumberMetadata()

Return values

getHostRecipientId()

Return values

getIdCheckConfigurationName()

Return values

getIdCheckConfigurationNameMetadata()

Return values

getIdCheckInformationInput()

Return values

getIdentityVerification()

Return values

NotaryHost
in package

DocuSign

eSign

implements ModelInterface, ArrayAccess