class DocuSign_eSign::CertifiedDelivery

Contains information about a certified delivery recipient. Certified delivery recipients must receive the completed documents for the envelope to be completed. However, they don't need to sign, initial, date or add information to any of the documents.

Attributes

access_code[RW]

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.

access_code_metadata[RW]

Metadata that indicates whether the `accessCode` property is editable. This property is read-only.

add_access_code_to_email[RW]

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.

additional_notifications[RW]
agent_can_edit_email[RW]
agent_can_edit_name[RW]
allow_system_override_for_locked_recipient[RW]
auto_responded_reason[RW]
bulk_send_v2_recipient[RW]
client_user_id[RW]

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.

completed_count[RW]
custom_fields[RW]

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.

declined_date_time[RW]

The date and time the recipient declined the document.

declined_reason[RW]

The reason the recipient declined the document.

delivered_date_time[RW]

Reserved: For DocuSign use only.

delivery_method[RW]

Reserved: For DocuSign use only.

delivery_method_metadata[RW]

Reserved for DocuSign.

designator_id[RW]
designator_id_guid[RW]
document_visibility[RW]
email[RW]
email_metadata[RW]

Metadata that indicates whether the `email` property is editable. This property is read-only.

email_notification[RW]

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.

email_recipient_post_signing_url[RW]
embedded_recipient_start_url[RW]

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: `senderHost/[[mergeField1]]/ beginSigningSession? [[mergeField2]]&[]`

error_details[RW]

Array or errors.

excluded_documents[RW]

Specifies the documents that are not visible to this recipient. Document Visibility must be enabled for the account and the `enforceSignerVisibility` property must be set to *true* for the envelope to use this. When enforce signer visibility is enabled, documents with tabs can only be viewed by signers that have a tab on that document. Recipients that have an administrative role (Agent, Editor, or Intermediaries) or informational role (Certified Deliveries or Carbon Copies) can always see all the documents in an envelope, unless they are specifically excluded using this setting when an envelope is sent. Documents that do not have tabs are always visible to all recipients, unless they are specifically excluded using this setting when an envelope is sent.

fax_number[RW]

Reserved:

fax_number_metadata[RW]

Reserved for DocuSign.

first_name[RW]

The user's first name. Maximum Length: 50 characters.

first_name_metadata[RW]

Metadata that indicates whether the `firstName` property is editable. This property is read-only.

full_name[RW]
full_name_metadata[RW]

Reserved for DocuSign.

id_check_configuration_name[RW]

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.

id_check_configuration_name_metadata[RW]

Metadata that indicates whether the `idCheckConfigurationName` property is editable. This property is read-only.

id_check_information_input[RW]

An object that contains input information related to a recipient ID check.

identity_verification[RW]

Specifies the ID Verification workflow applied on an envelope by workflow ID. <br/>See the [list](/docs/esign-rest-api/reference/accounts/identityverifications/list/) method in the [IdentityVerifications](/docs/esign-rest-api/reference/accounts/identityverifications/) resource for more information on how to retrieve workflow IDs available for an account. <br/>This can be used in addition to other [recipient authentication](support.docusign.com/en/guides/ndse-user-guide-recipient-authentication) methods. <br/>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).

inherit_email_notification_configuration[RW]

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.

last_name[RW]
last_name_metadata[RW]

Metadata that indicates whether the `lastName` property is editable. This property is read-only.

locked_recipient_phone_auth_editable[RW]
locked_recipient_sms_editable[RW]
name[RW]
name_metadata[RW]

Metadata that indicates whether the `name` property is editable. This property is read-only.

note[RW]

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.

note_metadata[RW]

Metadata that indicates whether the `note` property is editable. This property is read-only.

phone_authentication[RW]

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.

phone_number[RW]

Describes the recipient phone number.

proof_file[RW]

The proof file of the recipient.

recipient_attachments[RW]

Reserved:

recipient_authentication_status[RW]

Information about the recipient's authentication status. This property is read-only.

recipient_feature_metadata[RW]
recipient_id[RW]

Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document.

recipient_id_guid[RW]
recipient_type[RW]
recipient_type_metadata[RW]

Metadata that indicates whether the `recipientType` property is editable. This property is read-only.

require_id_lookup[RW]

When set to *true*, the recipient is required to use the specified ID check method (including Phone and SMS authentication) to validate their identity.

require_id_lookup_metadata[RW]

Metadata that indicates whether the `requireIdLookup` property is editable. This property is read-only.

role_name[RW]

Optional element. Specifies the role name associated with the recipient.<br/><br/>This is required when working with template recipients.

routing_order[RW]

Specifies the routing order of the recipient in the envelope.

routing_order_metadata[RW]

Metadata that indicates whether the `routingOrder` property is editable. This property is read-only.

sent_date_time[RW]

The date and time the envelope was sent.

signed_date_time[RW]

Reserved: For DocuSign use only.

signing_group_id[RW]

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).

signing_group_id_metadata[RW]

Metadata that indicates whether the `signingGroupId` property is editable. This property is read-only.

signing_group_name[RW]

The display name for the signing group. Maximum Length: 100 characters.

signing_group_users[RW]

A complex type that contains information about users in the signing group.

sms_authentication[RW]

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.

social_authentications[RW]

Lists the social ID type that can be used for recipient authentication.

status[RW]

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.

status_code[RW]
suppress_emails[RW]
template_locked[RW]

When set to *true*, the sender cannot change any attributes of the recipient. Used only when working with template recipients.

template_required[RW]

When set to *true*, the sender may not remove the recipient. Used only when working with template recipients.

total_tab_count[RW]
user_id[RW]

Public Class Methods

attribute_map() click to toggle source

Attribute mapping from ruby-style variable name to JSON key.

# File lib/docusign_esign/models/certified_delivery.rb, line 249
def self.attribute_map
  {
    :'access_code' => :'accessCode',
    :'access_code_metadata' => :'accessCodeMetadata',
    :'add_access_code_to_email' => :'addAccessCodeToEmail',
    :'additional_notifications' => :'additionalNotifications',
    :'agent_can_edit_email' => :'agentCanEditEmail',
    :'agent_can_edit_name' => :'agentCanEditName',
    :'allow_system_override_for_locked_recipient' => :'allowSystemOverrideForLockedRecipient',
    :'auto_responded_reason' => :'autoRespondedReason',
    :'bulk_send_v2_recipient' => :'bulkSendV2Recipient',
    :'client_user_id' => :'clientUserId',
    :'completed_count' => :'completedCount',
    :'consent_details_list' => :'consentDetailsList',
    :'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',
    :'email_recipient_post_signing_url' => :'emailRecipientPostSigningURL',
    :'embedded_recipient_start_url' => :'embeddedRecipientStartURL',
    :'error_details' => :'errorDetails',
    :'excluded_documents' => :'excludedDocuments',
    :'fax_number' => :'faxNumber',
    :'fax_number_metadata' => :'faxNumberMetadata',
    :'first_name' => :'firstName',
    :'first_name_metadata' => :'firstNameMetadata',
    :'full_name' => :'fullName',
    :'full_name_metadata' => :'fullNameMetadata',
    :'id_check_configuration_name' => :'idCheckConfigurationName',
    :'id_check_configuration_name_metadata' => :'idCheckConfigurationNameMetadata',
    :'id_check_information_input' => :'idCheckInformationInput',
    :'identity_verification' => :'identityVerification',
    :'inherit_email_notification_configuration' => :'inheritEmailNotificationConfiguration',
    :'last_name' => :'lastName',
    :'last_name_metadata' => :'lastNameMetadata',
    :'locked_recipient_phone_auth_editable' => :'lockedRecipientPhoneAuthEditable',
    :'locked_recipient_sms_editable' => :'lockedRecipientSmsEditable',
    :'name' => :'name',
    :'name_metadata' => :'nameMetadata',
    :'note' => :'note',
    :'note_metadata' => :'noteMetadata',
    :'phone_authentication' => :'phoneAuthentication',
    :'phone_number' => :'phoneNumber',
    :'proof_file' => :'proofFile',
    :'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',
    :'template_locked' => :'templateLocked',
    :'template_required' => :'templateRequired',
    :'total_tab_count' => :'totalTabCount',
    :'user_id' => :'userId'
  }
end
new(attributes = {}) click to toggle source

Initializes the object @param [Hash] attributes Model attributes in the form of hash

# File lib/docusign_esign/models/certified_delivery.rb, line 416
def initialize(attributes = {})
  return unless attributes.is_a?(Hash)

  # convert string to symbol for hash key
  attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }

  if attributes.has_key?(:'accessCode')
    self.access_code = attributes[:'accessCode']
  end

  if attributes.has_key?(:'accessCodeMetadata')
    self.access_code_metadata = attributes[:'accessCodeMetadata']
  end

  if attributes.has_key?(:'addAccessCodeToEmail')
    self.add_access_code_to_email = attributes[:'addAccessCodeToEmail']
  end

  if attributes.has_key?(:'additionalNotifications')
    if (value = attributes[:'additionalNotifications']).is_a?(Array)
      self.additional_notifications = value
    end
  end

  if attributes.has_key?(:'agentCanEditEmail')
    self.agent_can_edit_email = attributes[:'agentCanEditEmail']
  end

  if attributes.has_key?(:'agentCanEditName')
    self.agent_can_edit_name = attributes[:'agentCanEditName']
  end

  if attributes.has_key?(:'allowSystemOverrideForLockedRecipient')
    self.allow_system_override_for_locked_recipient = attributes[:'allowSystemOverrideForLockedRecipient']
  end

  if attributes.has_key?(:'autoRespondedReason')
    self.auto_responded_reason = attributes[:'autoRespondedReason']
  end

  if attributes.has_key?(:'bulkSendV2Recipient')
    self.bulk_send_v2_recipient = attributes[:'bulkSendV2Recipient']
  end

  if attributes.has_key?(:'clientUserId')
    self.client_user_id = attributes[:'clientUserId']
  end

  if attributes.has_key?(:'completedCount')
    self.completed_count = attributes[:'completedCount']
  end

  if attributes.has_key?(:'consentDetailsList')
    if (value = attributes[:'consentDetailsList']).is_a?(Array)
      self.consent_details_list = value
    end
  end

  if attributes.has_key?(:'customFields')
    if (value = attributes[:'customFields']).is_a?(Array)
      self.custom_fields = value
    end
  end

  if attributes.has_key?(:'declinedDateTime')
    self.declined_date_time = attributes[:'declinedDateTime']
  end

  if attributes.has_key?(:'declinedReason')
    self.declined_reason = attributes[:'declinedReason']
  end

  if attributes.has_key?(:'deliveredDateTime')
    self.delivered_date_time = attributes[:'deliveredDateTime']
  end

  if attributes.has_key?(:'deliveryMethod')
    self.delivery_method = attributes[:'deliveryMethod']
  end

  if attributes.has_key?(:'deliveryMethodMetadata')
    self.delivery_method_metadata = attributes[:'deliveryMethodMetadata']
  end

  if attributes.has_key?(:'designatorId')
    self.designator_id = attributes[:'designatorId']
  end

  if attributes.has_key?(:'designatorIdGuid')
    self.designator_id_guid = attributes[:'designatorIdGuid']
  end

  if attributes.has_key?(:'documentVisibility')
    if (value = attributes[:'documentVisibility']).is_a?(Array)
      self.document_visibility = value
    end
  end

  if attributes.has_key?(:'email')
    self.email = attributes[:'email']
  end

  if attributes.has_key?(:'emailMetadata')
    self.email_metadata = attributes[:'emailMetadata']
  end

  if attributes.has_key?(:'emailNotification')
    self.email_notification = attributes[:'emailNotification']
  end

  if attributes.has_key?(:'emailRecipientPostSigningURL')
    self.email_recipient_post_signing_url = attributes[:'emailRecipientPostSigningURL']
  end

  if attributes.has_key?(:'embeddedRecipientStartURL')
    self.embedded_recipient_start_url = attributes[:'embeddedRecipientStartURL']
  end

  if attributes.has_key?(:'errorDetails')
    self.error_details = attributes[:'errorDetails']
  end

  if attributes.has_key?(:'excludedDocuments')
    if (value = attributes[:'excludedDocuments']).is_a?(Array)
      self.excluded_documents = value
    end
  end

  if attributes.has_key?(:'faxNumber')
    self.fax_number = attributes[:'faxNumber']
  end

  if attributes.has_key?(:'faxNumberMetadata')
    self.fax_number_metadata = attributes[:'faxNumberMetadata']
  end

  if attributes.has_key?(:'firstName')
    self.first_name = attributes[:'firstName']
  end

  if attributes.has_key?(:'firstNameMetadata')
    self.first_name_metadata = attributes[:'firstNameMetadata']
  end

  if attributes.has_key?(:'fullName')
    self.full_name = attributes[:'fullName']
  end

  if attributes.has_key?(:'fullNameMetadata')
    self.full_name_metadata = attributes[:'fullNameMetadata']
  end

  if attributes.has_key?(:'idCheckConfigurationName')
    self.id_check_configuration_name = attributes[:'idCheckConfigurationName']
  end

  if attributes.has_key?(:'idCheckConfigurationNameMetadata')
    self.id_check_configuration_name_metadata = attributes[:'idCheckConfigurationNameMetadata']
  end

  if attributes.has_key?(:'idCheckInformationInput')
    self.id_check_information_input = attributes[:'idCheckInformationInput']
  end

  if attributes.has_key?(:'identityVerification')
    self.identity_verification = attributes[:'identityVerification']
  end

  if attributes.has_key?(:'inheritEmailNotificationConfiguration')
    self.inherit_email_notification_configuration = attributes[:'inheritEmailNotificationConfiguration']
  end

  if attributes.has_key?(:'lastName')
    self.last_name = attributes[:'lastName']
  end

  if attributes.has_key?(:'lastNameMetadata')
    self.last_name_metadata = attributes[:'lastNameMetadata']
  end

  if attributes.has_key?(:'lockedRecipientPhoneAuthEditable')
    self.locked_recipient_phone_auth_editable = attributes[:'lockedRecipientPhoneAuthEditable']
  end

  if attributes.has_key?(:'lockedRecipientSmsEditable')
    self.locked_recipient_sms_editable = attributes[:'lockedRecipientSmsEditable']
  end

  if attributes.has_key?(:'name')
    self.name = attributes[:'name']
  end

  if attributes.has_key?(:'nameMetadata')
    self.name_metadata = attributes[:'nameMetadata']
  end

  if attributes.has_key?(:'note')
    self.note = attributes[:'note']
  end

  if attributes.has_key?(:'noteMetadata')
    self.note_metadata = attributes[:'noteMetadata']
  end

  if attributes.has_key?(:'phoneAuthentication')
    self.phone_authentication = attributes[:'phoneAuthentication']
  end

  if attributes.has_key?(:'phoneNumber')
    self.phone_number = attributes[:'phoneNumber']
  end

  if attributes.has_key?(:'proofFile')
    self.proof_file = attributes[:'proofFile']
  end

  if attributes.has_key?(:'recipientAttachments')
    if (value = attributes[:'recipientAttachments']).is_a?(Array)
      self.recipient_attachments = value
    end
  end

  if attributes.has_key?(:'recipientAuthenticationStatus')
    self.recipient_authentication_status = attributes[:'recipientAuthenticationStatus']
  end

  if attributes.has_key?(:'recipientFeatureMetadata')
    if (value = attributes[:'recipientFeatureMetadata']).is_a?(Array)
      self.recipient_feature_metadata = value
    end
  end

  if attributes.has_key?(:'recipientId')
    self.recipient_id = attributes[:'recipientId']
  end

  if attributes.has_key?(:'recipientIdGuid')
    self.recipient_id_guid = attributes[:'recipientIdGuid']
  end

  if attributes.has_key?(:'recipientType')
    self.recipient_type = attributes[:'recipientType']
  end

  if attributes.has_key?(:'recipientTypeMetadata')
    self.recipient_type_metadata = attributes[:'recipientTypeMetadata']
  end

  if attributes.has_key?(:'requireIdLookup')
    self.require_id_lookup = attributes[:'requireIdLookup']
  end

  if attributes.has_key?(:'requireIdLookupMetadata')
    self.require_id_lookup_metadata = attributes[:'requireIdLookupMetadata']
  end

  if attributes.has_key?(:'roleName')
    self.role_name = attributes[:'roleName']
  end

  if attributes.has_key?(:'routingOrder')
    self.routing_order = attributes[:'routingOrder']
  end

  if attributes.has_key?(:'routingOrderMetadata')
    self.routing_order_metadata = attributes[:'routingOrderMetadata']
  end

  if attributes.has_key?(:'sentDateTime')
    self.sent_date_time = attributes[:'sentDateTime']
  end

  if attributes.has_key?(:'signedDateTime')
    self.signed_date_time = attributes[:'signedDateTime']
  end

  if attributes.has_key?(:'signingGroupId')
    self.signing_group_id = attributes[:'signingGroupId']
  end

  if attributes.has_key?(:'signingGroupIdMetadata')
    self.signing_group_id_metadata = attributes[:'signingGroupIdMetadata']
  end

  if attributes.has_key?(:'signingGroupName')
    self.signing_group_name = attributes[:'signingGroupName']
  end

  if attributes.has_key?(:'signingGroupUsers')
    if (value = attributes[:'signingGroupUsers']).is_a?(Array)
      self.signing_group_users = value
    end
  end

  if attributes.has_key?(:'smsAuthentication')
    self.sms_authentication = attributes[:'smsAuthentication']
  end

  if attributes.has_key?(:'socialAuthentications')
    if (value = attributes[:'socialAuthentications']).is_a?(Array)
      self.social_authentications = value
    end
  end

  if attributes.has_key?(:'status')
    self.status = attributes[:'status']
  end

  if attributes.has_key?(:'statusCode')
    self.status_code = attributes[:'statusCode']
  end

  if attributes.has_key?(:'suppressEmails')
    self.suppress_emails = attributes[:'suppressEmails']
  end

  if attributes.has_key?(:'templateLocked')
    self.template_locked = attributes[:'templateLocked']
  end

  if attributes.has_key?(:'templateRequired')
    self.template_required = attributes[:'templateRequired']
  end

  if attributes.has_key?(:'totalTabCount')
    self.total_tab_count = attributes[:'totalTabCount']
  end

  if attributes.has_key?(:'userId')
    self.user_id = attributes[:'userId']
  end
end
swagger_types() click to toggle source

Attribute type mapping.

# File lib/docusign_esign/models/certified_delivery.rb, line 332
def self.swagger_types
  {
    :'access_code' => :'String',
    :'access_code_metadata' => :'PropertyMetadata',
    :'add_access_code_to_email' => :'String',
    :'additional_notifications' => :'Array<RecipientAdditionalNotification>',
    :'agent_can_edit_email' => :'String',
    :'agent_can_edit_name' => :'String',
    :'allow_system_override_for_locked_recipient' => :'String',
    :'auto_responded_reason' => :'String',
    :'bulk_send_v2_recipient' => :'String',
    :'client_user_id' => :'String',
    :'completed_count' => :'String',
    :'consent_details_list' => :'Array<ConsentDetails>',
    :'custom_fields' => :'Array<String>',
    :'declined_date_time' => :'String',
    :'declined_reason' => :'String',
    :'delivered_date_time' => :'String',
    :'delivery_method' => :'String',
    :'delivery_method_metadata' => :'PropertyMetadata',
    :'designator_id' => :'String',
    :'designator_id_guid' => :'String',
    :'document_visibility' => :'Array<DocumentVisibility>',
    :'email' => :'String',
    :'email_metadata' => :'PropertyMetadata',
    :'email_notification' => :'RecipientEmailNotification',
    :'email_recipient_post_signing_url' => :'String',
    :'embedded_recipient_start_url' => :'String',
    :'error_details' => :'ErrorDetails',
    :'excluded_documents' => :'Array<String>',
    :'fax_number' => :'String',
    :'fax_number_metadata' => :'PropertyMetadata',
    :'first_name' => :'String',
    :'first_name_metadata' => :'PropertyMetadata',
    :'full_name' => :'String',
    :'full_name_metadata' => :'PropertyMetadata',
    :'id_check_configuration_name' => :'String',
    :'id_check_configuration_name_metadata' => :'PropertyMetadata',
    :'id_check_information_input' => :'IdCheckInformationInput',
    :'identity_verification' => :'RecipientIdentityVerification',
    :'inherit_email_notification_configuration' => :'String',
    :'last_name' => :'String',
    :'last_name_metadata' => :'PropertyMetadata',
    :'locked_recipient_phone_auth_editable' => :'String',
    :'locked_recipient_sms_editable' => :'String',
    :'name' => :'String',
    :'name_metadata' => :'PropertyMetadata',
    :'note' => :'String',
    :'note_metadata' => :'PropertyMetadata',
    :'phone_authentication' => :'RecipientPhoneAuthentication',
    :'phone_number' => :'RecipientPhoneNumber',
    :'proof_file' => :'RecipientProofFile',
    :'recipient_attachments' => :'Array<RecipientAttachment>',
    :'recipient_authentication_status' => :'AuthenticationStatus',
    :'recipient_feature_metadata' => :'Array<FeatureAvailableMetadata>',
    :'recipient_id' => :'String',
    :'recipient_id_guid' => :'String',
    :'recipient_type' => :'String',
    :'recipient_type_metadata' => :'PropertyMetadata',
    :'require_id_lookup' => :'String',
    :'require_id_lookup_metadata' => :'PropertyMetadata',
    :'role_name' => :'String',
    :'routing_order' => :'String',
    :'routing_order_metadata' => :'PropertyMetadata',
    :'sent_date_time' => :'String',
    :'signed_date_time' => :'String',
    :'signing_group_id' => :'String',
    :'signing_group_id_metadata' => :'PropertyMetadata',
    :'signing_group_name' => :'String',
    :'signing_group_users' => :'Array<UserInfo>',
    :'sms_authentication' => :'RecipientSMSAuthentication',
    :'social_authentications' => :'Array<SocialAuthentication>',
    :'status' => :'String',
    :'status_code' => :'String',
    :'suppress_emails' => :'String',
    :'template_locked' => :'String',
    :'template_required' => :'String',
    :'total_tab_count' => :'String',
    :'user_id' => :'String'
  }
end

Public Instance Methods

==(o) click to toggle source

Checks equality by comparing each attribute. @param [Object] Object to be compared

# File lib/docusign_esign/models/certified_delivery.rb, line 764
def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      access_code == o.access_code &&
      access_code_metadata == o.access_code_metadata &&
      add_access_code_to_email == o.add_access_code_to_email &&
      additional_notifications == o.additional_notifications &&
      agent_can_edit_email == o.agent_can_edit_email &&
      agent_can_edit_name == o.agent_can_edit_name &&
      allow_system_override_for_locked_recipient == o.allow_system_override_for_locked_recipient &&
      auto_responded_reason == o.auto_responded_reason &&
      bulk_send_v2_recipient == o.bulk_send_v2_recipient &&
      client_user_id == o.client_user_id &&
      completed_count == o.completed_count &&
      consent_details_list == o.consent_details_list &&
      custom_fields == o.custom_fields &&
      declined_date_time == o.declined_date_time &&
      declined_reason == o.declined_reason &&
      delivered_date_time == o.delivered_date_time &&
      delivery_method == o.delivery_method &&
      delivery_method_metadata == o.delivery_method_metadata &&
      designator_id == o.designator_id &&
      designator_id_guid == o.designator_id_guid &&
      document_visibility == o.document_visibility &&
      email == o.email &&
      email_metadata == o.email_metadata &&
      email_notification == o.email_notification &&
      email_recipient_post_signing_url == o.email_recipient_post_signing_url &&
      embedded_recipient_start_url == o.embedded_recipient_start_url &&
      error_details == o.error_details &&
      excluded_documents == o.excluded_documents &&
      fax_number == o.fax_number &&
      fax_number_metadata == o.fax_number_metadata &&
      first_name == o.first_name &&
      first_name_metadata == o.first_name_metadata &&
      full_name == o.full_name &&
      full_name_metadata == o.full_name_metadata &&
      id_check_configuration_name == o.id_check_configuration_name &&
      id_check_configuration_name_metadata == o.id_check_configuration_name_metadata &&
      id_check_information_input == o.id_check_information_input &&
      identity_verification == o.identity_verification &&
      inherit_email_notification_configuration == o.inherit_email_notification_configuration &&
      last_name == o.last_name &&
      last_name_metadata == o.last_name_metadata &&
      locked_recipient_phone_auth_editable == o.locked_recipient_phone_auth_editable &&
      locked_recipient_sms_editable == o.locked_recipient_sms_editable &&
      name == o.name &&
      name_metadata == o.name_metadata &&
      note == o.note &&
      note_metadata == o.note_metadata &&
      phone_authentication == o.phone_authentication &&
      phone_number == o.phone_number &&
      proof_file == o.proof_file &&
      recipient_attachments == o.recipient_attachments &&
      recipient_authentication_status == o.recipient_authentication_status &&
      recipient_feature_metadata == o.recipient_feature_metadata &&
      recipient_id == o.recipient_id &&
      recipient_id_guid == o.recipient_id_guid &&
      recipient_type == o.recipient_type &&
      recipient_type_metadata == o.recipient_type_metadata &&
      require_id_lookup == o.require_id_lookup &&
      require_id_lookup_metadata == o.require_id_lookup_metadata &&
      role_name == o.role_name &&
      routing_order == o.routing_order &&
      routing_order_metadata == o.routing_order_metadata &&
      sent_date_time == o.sent_date_time &&
      signed_date_time == o.signed_date_time &&
      signing_group_id == o.signing_group_id &&
      signing_group_id_metadata == o.signing_group_id_metadata &&
      signing_group_name == o.signing_group_name &&
      signing_group_users == o.signing_group_users &&
      sms_authentication == o.sms_authentication &&
      social_authentications == o.social_authentications &&
      status == o.status &&
      status_code == o.status_code &&
      suppress_emails == o.suppress_emails &&
      template_locked == o.template_locked &&
      template_required == o.template_required &&
      total_tab_count == o.total_tab_count &&
      user_id == o.user_id
end
_deserialize(type, value) click to toggle source

Deserializes the data based on type @param string type Data type @param string value Value to be deserialized @return [Object] Deserialized data

# File lib/docusign_esign/models/certified_delivery.rb, line 882
def _deserialize(type, value)
  case type.to_sym
  when :DateTime
    DateTime.parse(value)
  when :Date
    Date.parse(value)
  when :String
    value.to_s
  when :Integer
    value.to_i
  when :Float
    value.to_f
  when :BOOLEAN
    if value.to_s =~ /\A(true|t|yes|y|1)\z/i
      true
    else
      false
    end
  when :Object
    # generic object (usually a Hash), return directly
    value
  when /\AArray<(?<inner_type>.+)>\z/
    inner_type = Regexp.last_match[:inner_type]
    value.map { |v| _deserialize(inner_type, v) }
  when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
    k_type = Regexp.last_match[:k_type]
    v_type = Regexp.last_match[:v_type]
    {}.tap do |hash|
      value.each do |k, v|
        hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
      end
    end
  else # model
    temp_model = DocuSign_eSign.const_get(type).new
    temp_model.build_from_hash(value)
  end
end
_to_hash(value) click to toggle source

Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value @param [Object] value Any valid value @return [Hash] Returns the value in the form of hash

# File lib/docusign_esign/models/certified_delivery.rb, line 948
def _to_hash(value)
  if value.is_a?(Array)
    value.compact.map { |v| _to_hash(v) }
  elsif value.is_a?(Hash)
    {}.tap do |hash|
      value.each { |k, v| hash[k] = _to_hash(v) }
    end
  elsif value.respond_to? :to_hash
    value.to_hash
  else
    value
  end
end
build_from_hash(attributes) click to toggle source

Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself

# File lib/docusign_esign/models/certified_delivery.rb, line 861
def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.swagger_types.each_pair do |key, type|
    if type =~ /\AArray<(.*)>/i
      # check to ensure the input is an array given that the attribute
      # is documented as an array but the input is not
      if attributes[self.class.attribute_map[key]].is_a?(Array)
        self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
      end
    elsif !attributes[self.class.attribute_map[key]].nil?
      self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
    end # or else data not found in attributes(hash), not an issue as the data can be optional
  end

  self
end
eql?(o) click to toggle source

@see the `==` method @param [Object] Object to be compared

# File lib/docusign_esign/models/certified_delivery.rb, line 848
def eql?(o)
  self == o
end
hash() click to toggle source

Calculates hash code according to all attributes. @return [Fixnum] Hash code

# File lib/docusign_esign/models/certified_delivery.rb, line 854
def hash
  [access_code, access_code_metadata, add_access_code_to_email, additional_notifications, agent_can_edit_email, agent_can_edit_name, allow_system_override_for_locked_recipient, auto_responded_reason, bulk_send_v2_recipient, client_user_id, completed_count, consent_details_list, custom_fields, declined_date_time, declined_reason, delivered_date_time, delivery_method, delivery_method_metadata, designator_id, designator_id_guid, document_visibility, email, email_metadata, email_notification, email_recipient_post_signing_url, embedded_recipient_start_url, error_details, excluded_documents, fax_number, fax_number_metadata, first_name, first_name_metadata, full_name, full_name_metadata, id_check_configuration_name, id_check_configuration_name_metadata, id_check_information_input, identity_verification, inherit_email_notification_configuration, last_name, last_name_metadata, locked_recipient_phone_auth_editable, locked_recipient_sms_editable, name, name_metadata, note, note_metadata, phone_authentication, phone_number, proof_file, recipient_attachments, recipient_authentication_status, recipient_feature_metadata, recipient_id, recipient_id_guid, recipient_type, recipient_type_metadata, require_id_lookup, require_id_lookup_metadata, role_name, routing_order, routing_order_metadata, sent_date_time, signed_date_time, signing_group_id, signing_group_id_metadata, signing_group_name, signing_group_users, sms_authentication, social_authentications, status, status_code, suppress_emails, template_locked, template_required, total_tab_count, user_id].hash
end
list_invalid_properties() click to toggle source

Show invalid properties with the reasons. Usually used together with valid? @return Array for valid properties with the reasons

# File lib/docusign_esign/models/certified_delivery.rb, line 751
def list_invalid_properties
  invalid_properties = Array.new
  invalid_properties
end
to_body() click to toggle source

to_body is an alias to to_hash (backward compatibility) @return [Hash] Returns the object in the form of hash

# File lib/docusign_esign/models/certified_delivery.rb, line 928
def to_body
  to_hash
end
to_hash() click to toggle source

Returns the object in the form of hash @return [Hash] Returns the object in the form of hash

# File lib/docusign_esign/models/certified_delivery.rb, line 934
def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    next if value.nil?
    hash[param] = _to_hash(value)
  end
  hash
end
to_s() click to toggle source

Returns the string representation of the object @return [String] String presentation of the object

# File lib/docusign_esign/models/certified_delivery.rb, line 922
def to_s
  to_hash.to_s
end
valid?() click to toggle source

Check to see if the all the properties in the model are valid @return true if the model is valid

# File lib/docusign_esign/models/certified_delivery.rb, line 758
def valid?
  true
end