Class: DocuSign_eSign::CarbonCopy
- Inherits:
-
Object
- Object
- DocuSign_eSign::CarbonCopy
- Defined in:
- lib/docusign_esign/models/carbon_copy.rb
Instance Attribute Summary collapse
-
#access_code ⇒ Object
If a value is provided, the recipient must enter the value as the access code to view and sign the envelope.
-
#access_code_metadata ⇒ Object
Returns the value of attribute access_code_metadata.
-
#add_access_code_to_email ⇒ Object
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.
-
#agent_can_edit_email ⇒ Object
Returns the value of attribute agent_can_edit_email.
-
#agent_can_edit_name ⇒ Object
Returns the value of attribute agent_can_edit_name.
-
#client_user_id ⇒ Object
Specifies whether the recipient is embedded or remote.
-
#completed_count ⇒ Object
Returns the value of attribute completed_count.
-
#custom_fields ⇒ Object
An optional array of strings that allows the sender to provide custom data about the recipient.
-
#declined_date_time ⇒ Object
The date and time the recipient declined the document.
-
#declined_reason ⇒ Object
The reason the recipient declined the document.
-
#delivered_date_time ⇒ Object
Reserved: For DocuSign use only.
-
#delivery_method ⇒ Object
Reserved: For DocuSign use only.
-
#delivery_method_metadata ⇒ Object
Returns the value of attribute delivery_method_metadata.
-
#document_visibility ⇒ Object
Returns the value of attribute document_visibility.
-
#email ⇒ Object
Email id of the recipient.
-
#email_metadata ⇒ Object
Returns the value of attribute email_metadata.
-
#email_notification ⇒ Object
Returns the value of attribute email_notification.
-
#embedded_recipient_start_url ⇒ Object
Specifies a sender provided valid URL string for redirecting an embedded recipient.
-
#error_details ⇒ Object
Returns the value of attribute error_details.
-
#excluded_documents ⇒ Object
Specifies the documents that are not visible to this recipient.
-
#fax_number ⇒ Object
Reserved:.
-
#fax_number_metadata ⇒ Object
Returns the value of attribute fax_number_metadata.
-
#first_name ⇒ Object
The user’s first name.
-
#first_name_metadata ⇒ Object
Returns the value of attribute first_name_metadata.
-
#full_name ⇒ Object
Returns the value of attribute full_name.
-
#full_name_metadata ⇒ Object
Returns the value of attribute full_name_metadata.
-
#id_check_configuration_name ⇒ Object
Specifies authentication check by name.
-
#id_check_configuration_name_metadata ⇒ Object
Returns the value of attribute id_check_configuration_name_metadata.
-
#id_check_information_input ⇒ Object
Returns the value of attribute id_check_information_input.
-
#inherit_email_notification_configuration ⇒ Object
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 ⇒ Object
Returns the value of attribute last_name.
-
#last_name_metadata ⇒ Object
Returns the value of attribute last_name_metadata.
-
#locked_recipient_phone_auth_editable ⇒ Object
Returns the value of attribute locked_recipient_phone_auth_editable.
-
#locked_recipient_sms_editable ⇒ Object
Returns the value of attribute locked_recipient_sms_editable.
-
#name ⇒ Object
legal name of the recipient.
-
#name_metadata ⇒ Object
Returns the value of attribute name_metadata.
-
#note ⇒ Object
Specifies a note that is unique to this recipient.
-
#note_metadata ⇒ Object
Returns the value of attribute note_metadata.
-
#phone_authentication ⇒ Object
Returns the value of attribute phone_authentication.
-
#recipient_attachments ⇒ Object
Reserved:.
-
#recipient_authentication_status ⇒ Object
Returns the value of attribute recipient_authentication_status.
-
#recipient_feature_metadata ⇒ Object
Returns the value of attribute recipient_feature_metadata.
-
#recipient_id ⇒ Object
Unique for the recipient.
-
#recipient_id_guid ⇒ Object
Returns the value of attribute recipient_id_guid.
-
#recipient_type ⇒ Object
Returns the value of attribute recipient_type.
-
#recipient_type_metadata ⇒ Object
Returns the value of attribute recipient_type_metadata.
-
#require_id_lookup ⇒ Object
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 ⇒ Object
Returns the value of attribute require_id_lookup_metadata.
-
#role_name ⇒ Object
Optional element.
-
#routing_order ⇒ Object
Specifies the routing order of the recipient in the envelope.
-
#routing_order_metadata ⇒ Object
Returns the value of attribute routing_order_metadata.
-
#sent_date_time ⇒ Object
The date and time the envelope was sent.
-
#signed_date_time ⇒ Object
Reserved: For DocuSign use only.
-
#signing_group_id ⇒ Object
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 ⇒ Object
Returns the value of attribute signing_group_id_metadata.
-
#signing_group_name ⇒ Object
The display name for the signing group.
-
#signing_group_users ⇒ Object
A complex type that contains information about users in the signing group.
-
#sms_authentication ⇒ Object
Returns the value of attribute sms_authentication.
-
#social_authentications ⇒ Object
Lists the social ID type that can be used for recipient authentication.
-
#status ⇒ Object
Indicates the envelope status.
-
#status_code ⇒ Object
Returns the value of attribute status_code.
-
#suppress_emails ⇒ Object
Returns the value of attribute suppress_emails.
-
#tabs ⇒ Object
Returns the value of attribute tabs.
-
#template_locked ⇒ Object
When set to true, the sender cannot change any attributes of the recipient.
-
#template_required ⇒ Object
When set to true, the sender may not remove the recipient.
-
#total_tab_count ⇒ Object
Returns the value of attribute total_tab_count.
-
#user_id ⇒ Object
Returns the value of attribute user_id.
Class Method Summary collapse
-
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
-
.swagger_types ⇒ Object
Attribute type mapping.
Instance Method Summary collapse
-
#==(o) ⇒ Object
Checks equality by comparing each attribute.
-
#_deserialize(type, value) ⇒ Object
Deserializes the data based on type.
-
#_to_hash(value) ⇒ Hash
Outputs non-array value in the form of hash For object, use to_hash.
-
#build_from_hash(attributes) ⇒ Object
Builds the object from hash.
- #eql?(o) ⇒ Boolean
-
#hash ⇒ Fixnum
Calculates hash code according to all attributes.
-
#initialize(attributes = {}) ⇒ CarbonCopy
constructor
Initializes the object.
-
#list_invalid_properties ⇒ Object
Show invalid properties with the reasons.
-
#to_body ⇒ Hash
to_body is an alias to to_hash (backward compatibility).
-
#to_hash ⇒ Hash
Returns the object in the form of hash.
-
#to_s ⇒ String
Returns the string representation of the object.
-
#valid? ⇒ Boolean
Check to see if the all the properties in the model are valid.
Constructor Details
#initialize(attributes = {}) ⇒ CarbonCopy
Initializes the object
346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 |
# File 'lib/docusign_esign/models/carbon_copy.rb', line 346 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. = attributes[:'accessCodeMetadata'] end if attributes.has_key?(:'addAccessCodeToEmail') self.add_access_code_to_email = attributes[:'addAccessCodeToEmail'] 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?(:'clientUserId') self.client_user_id = attributes[:'clientUserId'] end if attributes.has_key?(:'completedCount') self.completed_count = attributes[:'completedCount'] 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. = attributes[:'deliveryMethodMetadata'] 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. = attributes[:'emailMetadata'] end if attributes.has_key?(:'emailNotification') self.email_notification = attributes[:'emailNotification'] end if attributes.has_key?(:'embeddedRecipientStartURL') self. = 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. = attributes[:'faxNumberMetadata'] end if attributes.has_key?(:'firstName') self.first_name = attributes[:'firstName'] end if attributes.has_key?(:'firstNameMetadata') self. = attributes[:'firstNameMetadata'] end if attributes.has_key?(:'fullName') self.full_name = attributes[:'fullName'] end if attributes.has_key?(:'fullNameMetadata') self. = attributes[:'fullNameMetadata'] end if attributes.has_key?(:'idCheckConfigurationName') self.id_check_configuration_name = attributes[:'idCheckConfigurationName'] end if attributes.has_key?(:'idCheckConfigurationNameMetadata') self. = attributes[:'idCheckConfigurationNameMetadata'] end if attributes.has_key?(:'idCheckInformationInput') self.id_check_information_input = attributes[:'idCheckInformationInput'] 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. = 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. = attributes[:'nameMetadata'] end if attributes.has_key?(:'note') self.note = attributes[:'note'] end if attributes.has_key?(:'noteMetadata') self. = attributes[:'noteMetadata'] end if attributes.has_key?(:'phoneAuthentication') self.phone_authentication = attributes[:'phoneAuthentication'] end if attributes.has_key?(:'recipientAttachments') if (value = attributes[:'recipientAttachments']).is_a?(Array) self. = 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. = 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. = attributes[:'recipientTypeMetadata'] end if attributes.has_key?(:'requireIdLookup') self.require_id_lookup = attributes[:'requireIdLookup'] end if attributes.has_key?(:'requireIdLookupMetadata') self. = 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. = 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. = 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. = 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?(:'tabs') self.tabs = attributes[:'tabs'] 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 |
Instance Attribute Details
#access_code ⇒ Object
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.
18 19 20 |
# File 'lib/docusign_esign/models/carbon_copy.rb', line 18 def access_code @access_code end |
#access_code_metadata ⇒ Object
Returns the value of attribute access_code_metadata.
20 21 22 |
# File 'lib/docusign_esign/models/carbon_copy.rb', line 20 def @access_code_metadata end |
#add_access_code_to_email ⇒ Object
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.
23 24 25 |
# File 'lib/docusign_esign/models/carbon_copy.rb', line 23 def add_access_code_to_email @add_access_code_to_email end |
#agent_can_edit_email ⇒ Object
Returns the value of attribute agent_can_edit_email.
26 27 28 |
# File 'lib/docusign_esign/models/carbon_copy.rb', line 26 def agent_can_edit_email @agent_can_edit_email end |
#agent_can_edit_name ⇒ Object
Returns the value of attribute agent_can_edit_name.
29 30 31 |
# File 'lib/docusign_esign/models/carbon_copy.rb', line 29 def agent_can_edit_name @agent_can_edit_name end |
#client_user_id ⇒ Object
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.
32 33 34 |
# File 'lib/docusign_esign/models/carbon_copy.rb', line 32 def client_user_id @client_user_id end |
#completed_count ⇒ Object
Returns the value of attribute completed_count.
35 36 37 |
# File 'lib/docusign_esign/models/carbon_copy.rb', line 35 def completed_count @completed_count end |
#custom_fields ⇒ Object
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.
38 39 40 |
# File 'lib/docusign_esign/models/carbon_copy.rb', line 38 def custom_fields @custom_fields end |
#declined_date_time ⇒ Object
The date and time the recipient declined the document.
41 42 43 |
# File 'lib/docusign_esign/models/carbon_copy.rb', line 41 def declined_date_time @declined_date_time end |
#declined_reason ⇒ Object
The reason the recipient declined the document.
44 45 46 |
# File 'lib/docusign_esign/models/carbon_copy.rb', line 44 def declined_reason @declined_reason end |
#delivered_date_time ⇒ Object
Reserved: For DocuSign use only.
47 48 49 |
# File 'lib/docusign_esign/models/carbon_copy.rb', line 47 def delivered_date_time @delivered_date_time end |
#delivery_method ⇒ Object
Reserved: For DocuSign use only.
50 51 52 |
# File 'lib/docusign_esign/models/carbon_copy.rb', line 50 def delivery_method @delivery_method end |
#delivery_method_metadata ⇒ Object
Returns the value of attribute delivery_method_metadata.
52 53 54 |
# File 'lib/docusign_esign/models/carbon_copy.rb', line 52 def @delivery_method_metadata end |
#document_visibility ⇒ Object
Returns the value of attribute document_visibility.
55 56 57 |
# File 'lib/docusign_esign/models/carbon_copy.rb', line 55 def document_visibility @document_visibility end |
#email ⇒ Object
Email id of the recipient. Notification of the document to sign is sent to this email id. Maximum length: 100 characters.
58 59 60 |
# File 'lib/docusign_esign/models/carbon_copy.rb', line 58 def email @email end |
#email_metadata ⇒ Object
Returns the value of attribute email_metadata.
60 61 62 |
# File 'lib/docusign_esign/models/carbon_copy.rb', line 60 def @email_metadata end |
#email_notification ⇒ Object
Returns the value of attribute email_notification.
62 63 64 |
# File 'lib/docusign_esign/models/carbon_copy.rb', line 62 def email_notification @email_notification end |
#embedded_recipient_start_url ⇒ Object
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]]&[]`
65 66 67 |
# File 'lib/docusign_esign/models/carbon_copy.rb', line 65 def @embedded_recipient_start_url end |
#error_details ⇒ Object
Returns the value of attribute error_details.
67 68 69 |
# File 'lib/docusign_esign/models/carbon_copy.rb', line 67 def error_details @error_details end |
#excluded_documents ⇒ Object
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.
70 71 72 |
# File 'lib/docusign_esign/models/carbon_copy.rb', line 70 def excluded_documents @excluded_documents end |
#fax_number ⇒ Object
Reserved:
73 74 75 |
# File 'lib/docusign_esign/models/carbon_copy.rb', line 73 def fax_number @fax_number end |
#fax_number_metadata ⇒ Object
Returns the value of attribute fax_number_metadata.
75 76 77 |
# File 'lib/docusign_esign/models/carbon_copy.rb', line 75 def @fax_number_metadata end |
#first_name ⇒ Object
The user’s first name. Maximum Length: 50 characters.
78 79 80 |
# File 'lib/docusign_esign/models/carbon_copy.rb', line 78 def first_name @first_name end |
#first_name_metadata ⇒ Object
Returns the value of attribute first_name_metadata.
80 81 82 |
# File 'lib/docusign_esign/models/carbon_copy.rb', line 80 def @first_name_metadata end |
#full_name ⇒ Object
Returns the value of attribute full_name.
83 84 85 |
# File 'lib/docusign_esign/models/carbon_copy.rb', line 83 def full_name @full_name end |
#full_name_metadata ⇒ Object
Returns the value of attribute full_name_metadata.
85 86 87 |
# File 'lib/docusign_esign/models/carbon_copy.rb', line 85 def @full_name_metadata end |
#id_check_configuration_name ⇒ Object
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.
88 89 90 |
# File 'lib/docusign_esign/models/carbon_copy.rb', line 88 def id_check_configuration_name @id_check_configuration_name end |
#id_check_configuration_name_metadata ⇒ Object
Returns the value of attribute id_check_configuration_name_metadata.
90 91 92 |
# File 'lib/docusign_esign/models/carbon_copy.rb', line 90 def @id_check_configuration_name_metadata end |
#id_check_information_input ⇒ Object
Returns the value of attribute id_check_information_input.
92 93 94 |
# File 'lib/docusign_esign/models/carbon_copy.rb', line 92 def id_check_information_input @id_check_information_input end |
#inherit_email_notification_configuration ⇒ Object
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.
95 96 97 |
# File 'lib/docusign_esign/models/carbon_copy.rb', line 95 def inherit_email_notification_configuration @inherit_email_notification_configuration end |
#last_name ⇒ Object
Returns the value of attribute last_name.
98 99 100 |
# File 'lib/docusign_esign/models/carbon_copy.rb', line 98 def last_name @last_name end |
#last_name_metadata ⇒ Object
Returns the value of attribute last_name_metadata.
100 101 102 |
# File 'lib/docusign_esign/models/carbon_copy.rb', line 100 def @last_name_metadata end |
#locked_recipient_phone_auth_editable ⇒ Object
Returns the value of attribute locked_recipient_phone_auth_editable.
103 104 105 |
# File 'lib/docusign_esign/models/carbon_copy.rb', line 103 def locked_recipient_phone_auth_editable @locked_recipient_phone_auth_editable end |
#locked_recipient_sms_editable ⇒ Object
Returns the value of attribute locked_recipient_sms_editable.
106 107 108 |
# File 'lib/docusign_esign/models/carbon_copy.rb', line 106 def locked_recipient_sms_editable @locked_recipient_sms_editable end |
#name ⇒ Object
legal name of the recipient. Maximum Length: 100 characters.
109 110 111 |
# File 'lib/docusign_esign/models/carbon_copy.rb', line 109 def name @name end |
#name_metadata ⇒ Object
Returns the value of attribute name_metadata.
111 112 113 |
# File 'lib/docusign_esign/models/carbon_copy.rb', line 111 def @name_metadata end |
#note ⇒ Object
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.
114 115 116 |
# File 'lib/docusign_esign/models/carbon_copy.rb', line 114 def note @note end |
#note_metadata ⇒ Object
Returns the value of attribute note_metadata.
116 117 118 |
# File 'lib/docusign_esign/models/carbon_copy.rb', line 116 def @note_metadata end |
#phone_authentication ⇒ Object
Returns the value of attribute phone_authentication.
118 119 120 |
# File 'lib/docusign_esign/models/carbon_copy.rb', line 118 def phone_authentication @phone_authentication end |
#recipient_attachments ⇒ Object
Reserved:
121 122 123 |
# File 'lib/docusign_esign/models/carbon_copy.rb', line 121 def @recipient_attachments end |
#recipient_authentication_status ⇒ Object
Returns the value of attribute recipient_authentication_status.
123 124 125 |
# File 'lib/docusign_esign/models/carbon_copy.rb', line 123 def recipient_authentication_status @recipient_authentication_status end |
#recipient_feature_metadata ⇒ Object
Returns the value of attribute recipient_feature_metadata.
126 127 128 |
# File 'lib/docusign_esign/models/carbon_copy.rb', line 126 def @recipient_feature_metadata end |
#recipient_id ⇒ Object
Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document.
129 130 131 |
# File 'lib/docusign_esign/models/carbon_copy.rb', line 129 def recipient_id @recipient_id end |
#recipient_id_guid ⇒ Object
Returns the value of attribute recipient_id_guid.
132 133 134 |
# File 'lib/docusign_esign/models/carbon_copy.rb', line 132 def recipient_id_guid @recipient_id_guid end |
#recipient_type ⇒ Object
Returns the value of attribute recipient_type.
135 136 137 |
# File 'lib/docusign_esign/models/carbon_copy.rb', line 135 def recipient_type @recipient_type end |
#recipient_type_metadata ⇒ Object
Returns the value of attribute recipient_type_metadata.
137 138 139 |
# File 'lib/docusign_esign/models/carbon_copy.rb', line 137 def @recipient_type_metadata end |
#require_id_lookup ⇒ Object
When set to true, the recipient is required to use the specified ID check method (including Phone and SMS authentication) to validate their identity.
140 141 142 |
# File 'lib/docusign_esign/models/carbon_copy.rb', line 140 def require_id_lookup @require_id_lookup end |
#require_id_lookup_metadata ⇒ Object
Returns the value of attribute require_id_lookup_metadata.
142 143 144 |
# File 'lib/docusign_esign/models/carbon_copy.rb', line 142 def @require_id_lookup_metadata end |
#role_name ⇒ Object
Optional element. Specifies the role name associated with the recipient.<br/><br/>This is required when working with template recipients.
145 146 147 |
# File 'lib/docusign_esign/models/carbon_copy.rb', line 145 def role_name @role_name end |
#routing_order ⇒ Object
Specifies the routing order of the recipient in the envelope.
148 149 150 |
# File 'lib/docusign_esign/models/carbon_copy.rb', line 148 def routing_order @routing_order end |
#routing_order_metadata ⇒ Object
Returns the value of attribute routing_order_metadata.
150 151 152 |
# File 'lib/docusign_esign/models/carbon_copy.rb', line 150 def @routing_order_metadata end |
#sent_date_time ⇒ Object
The date and time the envelope was sent.
153 154 155 |
# File 'lib/docusign_esign/models/carbon_copy.rb', line 153 def sent_date_time @sent_date_time end |
#signed_date_time ⇒ Object
Reserved: For DocuSign use only.
156 157 158 |
# File 'lib/docusign_esign/models/carbon_copy.rb', line 156 def signed_date_time @signed_date_time end |
#signing_group_id ⇒ Object
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).
159 160 161 |
# File 'lib/docusign_esign/models/carbon_copy.rb', line 159 def signing_group_id @signing_group_id end |
#signing_group_id_metadata ⇒ Object
Returns the value of attribute signing_group_id_metadata.
161 162 163 |
# File 'lib/docusign_esign/models/carbon_copy.rb', line 161 def @signing_group_id_metadata end |
#signing_group_name ⇒ Object
The display name for the signing group. Maximum Length: 100 characters.
164 165 166 |
# File 'lib/docusign_esign/models/carbon_copy.rb', line 164 def signing_group_name @signing_group_name end |
#signing_group_users ⇒ Object
A complex type that contains information about users in the signing group.
167 168 169 |
# File 'lib/docusign_esign/models/carbon_copy.rb', line 167 def signing_group_users @signing_group_users end |
#sms_authentication ⇒ Object
Returns the value of attribute sms_authentication.
169 170 171 |
# File 'lib/docusign_esign/models/carbon_copy.rb', line 169 def sms_authentication @sms_authentication end |
#social_authentications ⇒ Object
Lists the social ID type that can be used for recipient authentication.
172 173 174 |
# File 'lib/docusign_esign/models/carbon_copy.rb', line 172 def @social_authentications end |
#status ⇒ Object
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.
175 176 177 |
# File 'lib/docusign_esign/models/carbon_copy.rb', line 175 def status @status end |
#status_code ⇒ Object
Returns the value of attribute status_code.
178 179 180 |
# File 'lib/docusign_esign/models/carbon_copy.rb', line 178 def status_code @status_code end |
#suppress_emails ⇒ Object
Returns the value of attribute suppress_emails.
181 182 183 |
# File 'lib/docusign_esign/models/carbon_copy.rb', line 181 def suppress_emails @suppress_emails end |
#tabs ⇒ Object
Returns the value of attribute tabs.
183 184 185 |
# File 'lib/docusign_esign/models/carbon_copy.rb', line 183 def tabs @tabs end |
#template_locked ⇒ Object
When set to true, the sender cannot change any attributes of the recipient. Used only when working with template recipients.
186 187 188 |
# File 'lib/docusign_esign/models/carbon_copy.rb', line 186 def template_locked @template_locked end |
#template_required ⇒ Object
When set to true, the sender may not remove the recipient. Used only when working with template recipients.
189 190 191 |
# File 'lib/docusign_esign/models/carbon_copy.rb', line 189 def template_required @template_required end |
#total_tab_count ⇒ Object
Returns the value of attribute total_tab_count.
192 193 194 |
# File 'lib/docusign_esign/models/carbon_copy.rb', line 192 def total_tab_count @total_tab_count end |
#user_id ⇒ Object
Returns the value of attribute user_id.
195 196 197 |
# File 'lib/docusign_esign/models/carbon_copy.rb', line 195 def user_id @user_id end |
Class Method Details
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 |
# File 'lib/docusign_esign/models/carbon_copy.rb', line 199 def self.attribute_map { :'access_code' => :'accessCode', :'access_code_metadata' => :'accessCodeMetadata', :'add_access_code_to_email' => :'addAccessCodeToEmail', :'agent_can_edit_email' => :'agentCanEditEmail', :'agent_can_edit_name' => :'agentCanEditName', :'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', :'document_visibility' => :'documentVisibility', :'email' => :'email', :'email_metadata' => :'emailMetadata', :'email_notification' => :'emailNotification', :'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', :'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', :'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' } end |
.swagger_types ⇒ Object
Attribute type mapping.
272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 |
# File 'lib/docusign_esign/models/carbon_copy.rb', line 272 def self.swagger_types { :'access_code' => :'String', :'access_code_metadata' => :'PropertyMetadata', :'add_access_code_to_email' => :'String', :'agent_can_edit_email' => :'String', :'agent_can_edit_name' => :'String', :'client_user_id' => :'String', :'completed_count' => :'String', :'custom_fields' => :'Array<String>', :'declined_date_time' => :'String', :'declined_reason' => :'String', :'delivered_date_time' => :'String', :'delivery_method' => :'String', :'delivery_method_metadata' => :'PropertyMetadata', :'document_visibility' => :'Array<DocumentVisibility>', :'email' => :'String', :'email_metadata' => :'PropertyMetadata', :'email_notification' => :'RecipientEmailNotification', :'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', :'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', :'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', :'tabs' => :'Tabs', :'template_locked' => :'String', :'template_required' => :'String', :'total_tab_count' => :'String', :'user_id' => :'String' } end |
Instance Method Details
#==(o) ⇒ Object
Checks equality by comparing each attribute.
651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 |
# File 'lib/docusign_esign/models/carbon_copy.rb', line 651 def ==(o) return true if self.equal?(o) self.class == o.class && access_code == o.access_code && == o. && add_access_code_to_email == o.add_access_code_to_email && agent_can_edit_email == o.agent_can_edit_email && agent_can_edit_name == o.agent_can_edit_name && client_user_id == o.client_user_id && completed_count == o.completed_count && 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 && == o. && document_visibility == o.document_visibility && email == o.email && == o. && email_notification == o.email_notification && == o. && error_details == o.error_details && excluded_documents == o.excluded_documents && fax_number == o.fax_number && == o. && first_name == o.first_name && == o. && full_name == o.full_name && == o. && id_check_configuration_name == o.id_check_configuration_name && == o. && id_check_information_input == o.id_check_information_input && inherit_email_notification_configuration == o.inherit_email_notification_configuration && last_name == o.last_name && == o. && locked_recipient_phone_auth_editable == o.locked_recipient_phone_auth_editable && locked_recipient_sms_editable == o.locked_recipient_sms_editable && name == o.name && == o. && note == o.note && == o. && phone_authentication == o.phone_authentication && == o. && recipient_authentication_status == o.recipient_authentication_status && == o. && recipient_id == o.recipient_id && recipient_id_guid == o.recipient_id_guid && recipient_type == o.recipient_type && == o. && require_id_lookup == o.require_id_lookup && == o. && role_name == o.role_name && routing_order == o.routing_order && == o. && sent_date_time == o.sent_date_time && signed_date_time == o.signed_date_time && signing_group_id == o.signing_group_id && == o. && signing_group_name == o.signing_group_name && signing_group_users == o.signing_group_users && sms_authentication == o.sms_authentication && == o. && status == o.status && status_code == o.status_code && suppress_emails == o.suppress_emails && tabs == o.tabs && 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) ⇒ Object
Deserializes the data based on type
759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 |
# File 'lib/docusign_esign/models/carbon_copy.rb', line 759 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) ⇒ Hash
Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value
825 826 827 828 829 830 831 832 833 834 835 836 837 |
# File 'lib/docusign_esign/models/carbon_copy.rb', line 825 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) ⇒ Object
Builds the object from hash
738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 |
# File 'lib/docusign_esign/models/carbon_copy.rb', line 738 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 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) ⇒ Boolean
725 726 727 |
# File 'lib/docusign_esign/models/carbon_copy.rb', line 725 def eql?(o) self == o end |
#hash ⇒ Fixnum
Calculates hash code according to all attributes.
731 732 733 |
# File 'lib/docusign_esign/models/carbon_copy.rb', line 731 def hash [access_code, , add_access_code_to_email, agent_can_edit_email, agent_can_edit_name, client_user_id, completed_count, custom_fields, declined_date_time, declined_reason, delivered_date_time, delivery_method, , document_visibility, email, , email_notification, , error_details, excluded_documents, fax_number, , first_name, , full_name, , id_check_configuration_name, , id_check_information_input, inherit_email_notification_configuration, last_name, , locked_recipient_phone_auth_editable, locked_recipient_sms_editable, name, , note, , phone_authentication, , recipient_authentication_status, , recipient_id, recipient_id_guid, recipient_type, , require_id_lookup, , role_name, routing_order, , sent_date_time, signed_date_time, signing_group_id, , signing_group_name, signing_group_users, sms_authentication, , status, status_code, suppress_emails, tabs, template_locked, template_required, total_tab_count, user_id].hash end |
#list_invalid_properties ⇒ Object
Show invalid properties with the reasons. Usually used together with valid?
638 639 640 641 |
# File 'lib/docusign_esign/models/carbon_copy.rb', line 638 def list_invalid_properties invalid_properties = Array.new return invalid_properties end |
#to_body ⇒ Hash
to_body is an alias to to_hash (backward compatibility)
805 806 807 |
# File 'lib/docusign_esign/models/carbon_copy.rb', line 805 def to_body to_hash end |
#to_hash ⇒ Hash
Returns the object in the form of hash
811 812 813 814 815 816 817 818 819 |
# File 'lib/docusign_esign/models/carbon_copy.rb', line 811 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 ⇒ String
Returns the string representation of the object
799 800 801 |
# File 'lib/docusign_esign/models/carbon_copy.rb', line 799 def to_s to_hash.to_s end |
#valid? ⇒ Boolean
Check to see if the all the properties in the model are valid
645 646 647 |
# File 'lib/docusign_esign/models/carbon_copy.rb', line 645 def valid? return true end |