docusign_esign 3.21.0 → 3.22.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (141) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +5 -0
  3. data/lib/docusign_esign/api/accounts_api.rb +4 -4
  4. data/lib/docusign_esign/api/billing_api.rb +2 -2
  5. data/lib/docusign_esign/api/envelopes_api.rb +123 -3
  6. data/lib/docusign_esign/api/templates_api.rb +0 -57
  7. data/lib/docusign_esign/client/api_client.rb +1 -1
  8. data/lib/docusign_esign/models/account_information.rb +2 -1
  9. data/lib/docusign_esign/models/account_role_settings.rb +2 -0
  10. data/lib/docusign_esign/models/account_settings_information.rb +103 -15
  11. data/lib/docusign_esign/models/account_shared_access.rb +1 -1
  12. data/lib/docusign_esign/models/account_signature.rb +1 -1
  13. data/lib/docusign_esign/models/account_ui_settings.rb +2 -0
  14. data/lib/docusign_esign/models/agent.rb +13 -3
  15. data/lib/docusign_esign/models/approve.rb +2 -1
  16. data/lib/docusign_esign/models/billing_charge.rb +1 -1
  17. data/lib/docusign_esign/models/brand.rb +1 -1
  18. data/lib/docusign_esign/models/bulk_envelope.rb +1 -1
  19. data/lib/docusign_esign/models/bulk_sending_copy_recipient.rb +2 -1
  20. data/lib/docusign_esign/models/bulksending_copy_doc_gen_form_field.rb +7 -7
  21. data/lib/docusign_esign/models/captive_recipient.rb +1 -1
  22. data/lib/docusign_esign/models/carbon_copy.rb +13 -3
  23. data/lib/docusign_esign/models/certified_delivery.rb +13 -3
  24. data/lib/docusign_esign/models/checkbox.rb +2 -1
  25. data/lib/docusign_esign/models/cloud_storage_provider.rb +1 -1
  26. data/lib/docusign_esign/models/comment_thread.rb +2 -1
  27. data/lib/docusign_esign/models/commission_county.rb +2 -1
  28. data/lib/docusign_esign/models/commission_expiration.rb +2 -1
  29. data/lib/docusign_esign/models/commission_number.rb +2 -1
  30. data/lib/docusign_esign/models/commission_state.rb +2 -1
  31. data/lib/docusign_esign/models/company.rb +2 -1
  32. data/lib/docusign_esign/models/connect_debug_log.rb +1 -1
  33. data/lib/docusign_esign/models/connect_historical_envelope_republish.rb +1 -0
  34. data/lib/docusign_esign/models/contact.rb +2 -1
  35. data/lib/docusign_esign/models/custom_field.rb +1 -1
  36. data/lib/docusign_esign/models/date.rb +2 -1
  37. data/lib/docusign_esign/models/date_signed.rb +2 -1
  38. data/lib/docusign_esign/models/decline.rb +2 -1
  39. data/lib/docusign_esign/models/delayed_routing.rb +1 -1
  40. data/lib/docusign_esign/models/delegation_info.rb +12 -12
  41. data/lib/docusign_esign/models/doc_gen_form_field_request.rb +186 -0
  42. data/lib/docusign_esign/models/doc_gen_form_field_response.rb +196 -0
  43. data/lib/docusign_esign/models/doc_gen_form_fields.rb +218 -0
  44. data/lib/docusign_esign/models/document_template.rb +1 -1
  45. data/lib/docusign_esign/models/document_visibility.rb +1 -1
  46. data/lib/docusign_esign/models/draw.rb +2 -1
  47. data/lib/docusign_esign/models/editor.rb +13 -3
  48. data/lib/docusign_esign/models/email.rb +2 -1
  49. data/lib/docusign_esign/models/email_address.rb +2 -1
  50. data/lib/docusign_esign/models/envelope.rb +2 -2
  51. data/lib/docusign_esign/models/envelope_attachment.rb +1 -1
  52. data/lib/docusign_esign/models/envelope_definition.rb +2 -2
  53. data/lib/docusign_esign/models/envelope_document.rb +1 -1
  54. data/lib/docusign_esign/models/envelope_id.rb +2 -1
  55. data/lib/docusign_esign/models/envelope_publish_transaction.rb +1 -0
  56. data/lib/docusign_esign/models/envelope_summary.rb +1 -1
  57. data/lib/docusign_esign/models/envelope_template.rb +2 -2
  58. data/lib/docusign_esign/models/envelope_transaction_status.rb +1 -1
  59. data/lib/docusign_esign/models/envelope_update_summary.rb +1 -1
  60. data/lib/docusign_esign/models/external_folder.rb +1 -1
  61. data/lib/docusign_esign/models/favorite_templates_content_item.rb +1 -1
  62. data/lib/docusign_esign/models/favorite_templates_info.rb +1 -1
  63. data/lib/docusign_esign/models/first_name.rb +2 -1
  64. data/lib/docusign_esign/models/folder.rb +1 -1
  65. data/lib/docusign_esign/models/folder_item_v2.rb +1 -1
  66. data/lib/docusign_esign/models/folder_shared_item.rb +1 -1
  67. data/lib/docusign_esign/models/form_data_item.rb +12 -2
  68. data/lib/docusign_esign/models/formula_tab.rb +2 -1
  69. data/lib/docusign_esign/models/full_name.rb +2 -1
  70. data/lib/docusign_esign/models/group.rb +1 -1
  71. data/lib/docusign_esign/models/in_person_signer.rb +13 -3
  72. data/lib/docusign_esign/models/initial_here.rb +3 -2
  73. data/lib/docusign_esign/models/inline_template.rb +2 -2
  74. data/lib/docusign_esign/models/intermediary.rb +13 -3
  75. data/lib/docusign_esign/models/last_name.rb +2 -1
  76. data/lib/docusign_esign/models/list.rb +2 -1
  77. data/lib/docusign_esign/models/list_custom_field.rb +1 -1
  78. data/lib/docusign_esign/models/lock_information.rb +1 -1
  79. data/lib/docusign_esign/models/member_group_shared_item.rb +1 -1
  80. data/lib/docusign_esign/models/member_shared_items.rb +1 -1
  81. data/lib/docusign_esign/models/mobile_notifier_configuration.rb +1 -1
  82. data/lib/docusign_esign/models/name_value.rb +1 -1
  83. data/lib/docusign_esign/models/new_account_definition.rb +2 -2
  84. data/lib/docusign_esign/models/new_user.rb +1 -1
  85. data/lib/docusign_esign/models/notarize.rb +2 -1
  86. data/lib/docusign_esign/models/notary_host.rb +13 -3
  87. data/lib/docusign_esign/models/notary_jurisdiction.rb +1 -1
  88. data/lib/docusign_esign/models/notary_recipient.rb +13 -3
  89. data/lib/docusign_esign/models/notary_seal.rb +2 -1
  90. data/lib/docusign_esign/models/note.rb +2 -1
  91. data/lib/docusign_esign/models/number.rb +2 -1
  92. data/lib/docusign_esign/models/numerical.rb +68 -1
  93. data/lib/docusign_esign/models/page.rb +1 -1
  94. data/lib/docusign_esign/models/participant.rb +33 -1
  95. data/lib/docusign_esign/models/phone_number.rb +2 -1
  96. data/lib/docusign_esign/models/poly_line_overlay.rb +2 -1
  97. data/lib/docusign_esign/models/power_form.rb +1 -1
  98. data/lib/docusign_esign/models/radio.rb +13 -2
  99. data/lib/docusign_esign/models/recipient_form_data.rb +12 -12
  100. data/lib/docusign_esign/models/recipient_update_response.rb +1 -1
  101. data/lib/docusign_esign/models/recipients.rb +1 -1
  102. data/lib/docusign_esign/models/scheduled_sending.rb +1 -1
  103. data/lib/docusign_esign/models/seal_sign.rb +13 -3
  104. data/lib/docusign_esign/models/sender_company.rb +2 -1
  105. data/lib/docusign_esign/models/sender_name.rb +2 -1
  106. data/lib/docusign_esign/models/shared_item.rb +1 -1
  107. data/lib/docusign_esign/models/sign_here.rb +2 -1
  108. data/lib/docusign_esign/models/signer.rb +13 -3
  109. data/lib/docusign_esign/models/signer_attachment.rb +2 -1
  110. data/lib/docusign_esign/models/signing_group.rb +1 -1
  111. data/lib/docusign_esign/models/signing_group_user.rb +1 -1
  112. data/lib/docusign_esign/models/smart_section.rb +4 -3
  113. data/lib/docusign_esign/models/social_account_information.rb +1 -1
  114. data/lib/docusign_esign/models/ssn.rb +2 -1
  115. data/lib/docusign_esign/models/stamp.rb +1 -1
  116. data/lib/docusign_esign/models/tab_account_settings.rb +21 -21
  117. data/lib/docusign_esign/models/tab_group.rb +2 -1
  118. data/lib/docusign_esign/models/tabs.rb +1 -13
  119. data/lib/docusign_esign/models/template_recipients.rb +1 -1
  120. data/lib/docusign_esign/models/template_role.rb +1 -1
  121. data/lib/docusign_esign/models/template_shared_item.rb +1 -1
  122. data/lib/docusign_esign/models/template_summary.rb +1 -1
  123. data/lib/docusign_esign/models/template_tabs.rb +1 -13
  124. data/lib/docusign_esign/models/template_update_summary.rb +1 -1
  125. data/lib/docusign_esign/models/text.rb +2 -1
  126. data/lib/docusign_esign/models/text_custom_field.rb +1 -1
  127. data/lib/docusign_esign/models/title.rb +2 -1
  128. data/lib/docusign_esign/models/user_account_management_granular_information.rb +2 -0
  129. data/lib/docusign_esign/models/user_info.rb +12 -2
  130. data/lib/docusign_esign/models/user_information.rb +2 -2
  131. data/lib/docusign_esign/models/user_settings_information.rb +2 -0
  132. data/lib/docusign_esign/models/user_shared_item.rb +1 -1
  133. data/lib/docusign_esign/models/user_signature.rb +1 -1
  134. data/lib/docusign_esign/models/view.rb +2 -1
  135. data/lib/docusign_esign/models/witness.rb +13 -3
  136. data/lib/docusign_esign/models/workspace_user.rb +1 -1
  137. data/lib/docusign_esign/models/workspace_user_authorization.rb +1 -1
  138. data/lib/docusign_esign/models/zip.rb +2 -1
  139. data/lib/docusign_esign/version.rb +1 -1
  140. data/lib/docusign_esign.rb +3 -2
  141. metadata +5 -2
@@ -32,6 +32,9 @@ module DocuSign_eSign
32
32
  #
33
33
  attr_accessor :auto_responded_reason
34
34
 
35
+ #
36
+ attr_accessor :bulk_send_v2_recipient
37
+
35
38
  # 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.
36
39
  attr_accessor :client_user_id
37
40
 
@@ -74,7 +77,7 @@ module DocuSign_eSign
74
77
  # Metadata that indicates whether the `email` property is editable. This property is read-only.
75
78
  attr_accessor :email_metadata
76
79
 
77
- # An optional complex type that sets a specific email subject and body for this recipient's notification email. **Note:** You can set the `emailNotification` property separately for each recipient. If you set the value only for certain recipients, the other recipients will inherit the this value from the top-level `emailSubject` and `emailBlurb`.
80
+ # 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.
78
81
  attr_accessor :email_notification
79
82
 
80
83
  #
@@ -83,7 +86,7 @@ module DocuSign_eSign
83
86
  # 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]]`
84
87
  attr_accessor :embedded_recipient_start_url
85
88
 
86
- # This object describes errors that occur. It is only valid for responses and ignored in requests.
89
+ # Array or errors.
87
90
  attr_accessor :error_details
88
91
 
89
92
  # 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.
@@ -242,6 +245,7 @@ module DocuSign_eSign
242
245
  :'additional_notifications' => :'additionalNotifications',
243
246
  :'allow_system_override_for_locked_recipient' => :'allowSystemOverrideForLockedRecipient',
244
247
  :'auto_responded_reason' => :'autoRespondedReason',
248
+ :'bulk_send_v2_recipient' => :'bulkSendV2Recipient',
245
249
  :'client_user_id' => :'clientUserId',
246
250
  :'completed_count' => :'completedCount',
247
251
  :'consent_details_list' => :'consentDetailsList',
@@ -321,6 +325,7 @@ module DocuSign_eSign
321
325
  :'additional_notifications' => :'Array<RecipientAdditionalNotification>',
322
326
  :'allow_system_override_for_locked_recipient' => :'String',
323
327
  :'auto_responded_reason' => :'String',
328
+ :'bulk_send_v2_recipient' => :'String',
324
329
  :'client_user_id' => :'String',
325
330
  :'completed_count' => :'String',
326
331
  :'consent_details_list' => :'Array<ConsentDetails>',
@@ -425,6 +430,10 @@ module DocuSign_eSign
425
430
  self.auto_responded_reason = attributes[:'autoRespondedReason']
426
431
  end
427
432
 
433
+ if attributes.has_key?(:'bulkSendV2Recipient')
434
+ self.bulk_send_v2_recipient = attributes[:'bulkSendV2Recipient']
435
+ end
436
+
428
437
  if attributes.has_key?(:'clientUserId')
429
438
  self.client_user_id = attributes[:'clientUserId']
430
439
  end
@@ -734,6 +743,7 @@ module DocuSign_eSign
734
743
  additional_notifications == o.additional_notifications &&
735
744
  allow_system_override_for_locked_recipient == o.allow_system_override_for_locked_recipient &&
736
745
  auto_responded_reason == o.auto_responded_reason &&
746
+ bulk_send_v2_recipient == o.bulk_send_v2_recipient &&
737
747
  client_user_id == o.client_user_id &&
738
748
  completed_count == o.completed_count &&
739
749
  consent_details_list == o.consent_details_list &&
@@ -812,7 +822,7 @@ module DocuSign_eSign
812
822
  # Calculates hash code according to all attributes.
813
823
  # @return [Fixnum] Hash code
814
824
  def hash
815
- [access_code, access_code_metadata, add_access_code_to_email, additional_notifications, allow_system_override_for_locked_recipient, auto_responded_reason, 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, 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
825
+ [access_code, access_code_metadata, add_access_code_to_email, additional_notifications, 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, 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
816
826
  end
817
827
 
818
828
  # Builds the object from hash
@@ -83,6 +83,7 @@ module DocuSign_eSign
83
83
  #
84
84
  attr_accessor :caption
85
85
 
86
+ #
86
87
  attr_accessor :caption_metadata
87
88
 
88
89
  # For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility.
@@ -109,7 +110,7 @@ module DocuSign_eSign
109
110
  # Metadata that indicates whether the `documentId` property is editable.
110
111
  attr_accessor :document_id_metadata
111
112
 
112
- # This object describes errors that occur. It is only valid for responses and ignored in requests.
113
+ # Array or errors.
113
114
  attr_accessor :error_details
114
115
 
115
116
  # The font to be used for the tab value. Supported Fonts: Arial, Arial, ArialNarrow, Calibri, CourierNew, Garamond, Georgia, Helvetica, LucidaConsole, Tahoma, TimesNewRoman, Trebuchet, Verdana, MSGothic, MSMincho, Default.
@@ -83,6 +83,7 @@ module DocuSign_eSign
83
83
  #
84
84
  attr_accessor :caption
85
85
 
86
+ #
86
87
  attr_accessor :caption_metadata
87
88
 
88
89
  # For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility.
@@ -109,7 +110,7 @@ module DocuSign_eSign
109
110
  # Metadata that indicates whether the `documentId` property is editable.
110
111
  attr_accessor :document_id_metadata
111
112
 
112
- # This object describes errors that occur. It is only valid for responses and ignored in requests.
113
+ # Array or errors.
113
114
  attr_accessor :error_details
114
115
 
115
116
  # The font to be used for the tab value. Supported Fonts: Arial, Arial, ArialNarrow, Calibri, CourierNew, Garamond, Georgia, Helvetica, LucidaConsole, Tahoma, TimesNewRoman, Trebuchet, Verdana, MSGothic, MSMincho, Default.
@@ -17,7 +17,7 @@ module DocuSign_eSign
17
17
  # If merge field's are being used, specifies the type of the merge field. The only supported value is **salesforce**.
18
18
  attr_accessor :configuration_type
19
19
 
20
- # This object describes errors that occur. It is only valid for responses and ignored in requests.
20
+ # Array or errors.
21
21
  attr_accessor :error_details
22
22
 
23
23
  # An ID used to specify a custom field.
@@ -13,7 +13,7 @@ require 'date'
13
13
 
14
14
  module DocuSign_eSign
15
15
  class LockInformation
16
- # This object describes errors that occur. It is only valid for responses and ignored in requests.
16
+ # Array or errors.
17
17
  attr_accessor :error_details
18
18
 
19
19
  # Sets the time, in seconds, until the lock expires when there is no activity on the envelope. If no value is entered, then the default value of 300 seconds is used. The maximum value is 1,800 seconds. The lock duration can be extended.
@@ -14,7 +14,7 @@ require 'date'
14
14
  module DocuSign_eSign
15
15
  # Information about items shared among groups.
16
16
  class MemberGroupSharedItem
17
- # This object describes errors that occur. It is only valid for responses and ignored in requests.
17
+ # Array or errors.
18
18
  attr_accessor :error_details
19
19
 
20
20
  # The group sharing the item.
@@ -17,7 +17,7 @@ module DocuSign_eSign
17
17
  #
18
18
  attr_accessor :envelopes
19
19
 
20
- # This object describes errors that occur. It is only valid for responses and ignored in requests.
20
+ # Array or errors.
21
21
  attr_accessor :error_details
22
22
 
23
23
  #
@@ -16,7 +16,7 @@ module DocuSign_eSign
16
16
  #
17
17
  attr_accessor :device_id
18
18
 
19
- # This object describes errors that occur. It is only valid for responses and ignored in requests.
19
+ # Array or errors.
20
20
  attr_accessor :error_details
21
21
 
22
22
  #
@@ -14,7 +14,7 @@ require 'date'
14
14
  module DocuSign_eSign
15
15
  # A name-value pair that describes an item and provides a value for the item.
16
16
  class NameValue
17
- # This object describes errors that occur. It is only valid for responses and ignored in requests.
17
+ # Array or errors.
18
18
  attr_accessor :error_details
19
19
 
20
20
  # The name or key of a name/value pair.
@@ -16,7 +16,7 @@ module DocuSign_eSign
16
16
  # The account name for the new account.
17
17
  attr_accessor :account_name
18
18
 
19
- # The list of account settings accountsettings that determine the features available for the account. Note that some features are determined by the plan used to create the account and cannot be overridden.
19
+ # The list of account settings. These determine the features available for the account. Note that some features are determined by the plan used to create the account, and cannot be overridden.
20
20
  attr_accessor :account_settings
21
21
 
22
22
  # A complex type that contains the following information for the new account: `Street1`, `Street2`, `City`, `State`, `Zip`, `Phone`, and `Fax`.
@@ -61,7 +61,7 @@ module DocuSign_eSign
61
61
  # A complex type that contains properties for entering referral and discount information.
62
62
  attr_accessor :referral_information
63
63
 
64
- # Contains properties that map a DocuSign user to a social account such as Facebook or Yahoo.
64
+ # Contains properties that map a DocuSign user to a social account (Facebook, Yahoo, etc.)
65
65
  attr_accessor :social_account_information
66
66
 
67
67
  #
@@ -23,7 +23,7 @@ module DocuSign_eSign
23
23
  #
24
24
  attr_accessor :email
25
25
 
26
- # This object describes errors that occur. It is only valid for responses and ignored in requests.
26
+ # Array or errors.
27
27
  attr_accessor :error_details
28
28
 
29
29
  #
@@ -77,6 +77,7 @@ module DocuSign_eSign
77
77
  #
78
78
  attr_accessor :caption
79
79
 
80
+ #
80
81
  attr_accessor :caption_metadata
81
82
 
82
83
  # For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility.
@@ -103,7 +104,7 @@ module DocuSign_eSign
103
104
  # Metadata that indicates whether the `documentId` property is editable.
104
105
  attr_accessor :document_id_metadata
105
106
 
106
- # This object describes errors that occur. It is only valid for responses and ignored in requests.
107
+ # Array or errors.
107
108
  attr_accessor :error_details
108
109
 
109
110
  #
@@ -29,6 +29,9 @@ module DocuSign_eSign
29
29
  #
30
30
  attr_accessor :auto_responded_reason
31
31
 
32
+ #
33
+ attr_accessor :bulk_send_v2_recipient
34
+
32
35
  # 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.
33
36
  attr_accessor :client_user_id
34
37
 
@@ -68,13 +71,13 @@ module DocuSign_eSign
68
71
  # Metadata that indicates whether the `email` property is editable. This property is read-only.
69
72
  attr_accessor :email_metadata
70
73
 
71
- # An optional complex type that sets a specific email subject and body for this recipient's notification email. **Note:** You can set the `emailNotification` property separately for each recipient. If you set the value only for certain recipients, the other recipients will inherit the this value from the top-level `emailSubject` and `emailBlurb`.
74
+ # 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.
72
75
  attr_accessor :email_notification
73
76
 
74
77
  # 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]]`
75
78
  attr_accessor :embedded_recipient_start_url
76
79
 
77
- # This object describes errors that occur. It is only valid for responses and ignored in requests.
80
+ # Array or errors.
78
81
  attr_accessor :error_details
79
82
 
80
83
  # Reserved:
@@ -214,6 +217,7 @@ module DocuSign_eSign
214
217
  :'add_access_code_to_email' => :'addAccessCodeToEmail',
215
218
  :'allow_system_override_for_locked_recipient' => :'allowSystemOverrideForLockedRecipient',
216
219
  :'auto_responded_reason' => :'autoRespondedReason',
220
+ :'bulk_send_v2_recipient' => :'bulkSendV2Recipient',
217
221
  :'client_user_id' => :'clientUserId',
218
222
  :'completed_count' => :'completedCount',
219
223
  :'custom_fields' => :'customFields',
@@ -284,6 +288,7 @@ module DocuSign_eSign
284
288
  :'add_access_code_to_email' => :'String',
285
289
  :'allow_system_override_for_locked_recipient' => :'String',
286
290
  :'auto_responded_reason' => :'String',
291
+ :'bulk_send_v2_recipient' => :'String',
287
292
  :'client_user_id' => :'String',
288
293
  :'completed_count' => :'String',
289
294
  :'custom_fields' => :'Array<String>',
@@ -374,6 +379,10 @@ module DocuSign_eSign
374
379
  self.auto_responded_reason = attributes[:'autoRespondedReason']
375
380
  end
376
381
 
382
+ if attributes.has_key?(:'bulkSendV2Recipient')
383
+ self.bulk_send_v2_recipient = attributes[:'bulkSendV2Recipient']
384
+ end
385
+
377
386
  if attributes.has_key?(:'clientUserId')
378
387
  self.client_user_id = attributes[:'clientUserId']
379
388
  end
@@ -646,6 +655,7 @@ module DocuSign_eSign
646
655
  add_access_code_to_email == o.add_access_code_to_email &&
647
656
  allow_system_override_for_locked_recipient == o.allow_system_override_for_locked_recipient &&
648
657
  auto_responded_reason == o.auto_responded_reason &&
658
+ bulk_send_v2_recipient == o.bulk_send_v2_recipient &&
649
659
  client_user_id == o.client_user_id &&
650
660
  completed_count == o.completed_count &&
651
661
  custom_fields == o.custom_fields &&
@@ -716,7 +726,7 @@ module DocuSign_eSign
716
726
  # Calculates hash code according to all attributes.
717
727
  # @return [Fixnum] Hash code
718
728
  def hash
719
- [access_code, access_code_metadata, add_access_code_to_email, allow_system_override_for_locked_recipient, auto_responded_reason, client_user_id, completed_count, 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, embedded_recipient_start_url, error_details, fax_number, fax_number_metadata, host_recipient_id, id_check_configuration_name, id_check_configuration_name_metadata, id_check_information_input, identity_verification, inherit_email_notification_configuration, locked_recipient_phone_auth_editable, locked_recipient_sms_editable, name, name_metadata, note, note_metadata, phone_authentication, 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, tabs, template_locked, template_required, total_tab_count, user_id].hash
729
+ [access_code, access_code_metadata, add_access_code_to_email, allow_system_override_for_locked_recipient, auto_responded_reason, bulk_send_v2_recipient, client_user_id, completed_count, 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, embedded_recipient_start_url, error_details, fax_number, fax_number_metadata, host_recipient_id, id_check_configuration_name, id_check_configuration_name_metadata, id_check_information_input, identity_verification, inherit_email_notification_configuration, locked_recipient_phone_auth_editable, locked_recipient_sms_editable, name, name_metadata, note, note_metadata, phone_authentication, 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, tabs, template_locked, template_required, total_tab_count, user_id].hash
720
730
  end
721
731
 
722
732
  # Builds the object from hash
@@ -23,7 +23,7 @@ module DocuSign_eSign
23
23
  #
24
24
  attr_accessor :county
25
25
 
26
- # This object describes errors that occur. It is only valid for responses and ignored in requests.
26
+ # Array or errors.
27
27
  attr_accessor :error_details
28
28
 
29
29
  # Description of the jurisdiction for this notary. This is a read-only property.
@@ -43,6 +43,9 @@ module DocuSign_eSign
43
43
  # Contains a URI for an endpoint that allows you to easily retrieve bulk recipient information.
44
44
  attr_accessor :bulk_recipients_uri
45
45
 
46
+ #
47
+ attr_accessor :bulk_send_v2_recipient
48
+
46
49
  # When set to **true**, specifies that the signer can perform the signing ceremony offline.
47
50
  attr_accessor :can_sign_offline
48
51
 
@@ -100,7 +103,7 @@ module DocuSign_eSign
100
103
  # Metadata that indicates whether the `email` property is editable. This property is read-only.
101
104
  attr_accessor :email_metadata
102
105
 
103
- # An optional complex type that sets a specific email subject and body for this recipient's notification email. **Note:** You can set the `emailNotification` property separately for each recipient. If you set the value only for certain recipients, the other recipients will inherit the this value from the top-level `emailSubject` and `emailBlurb`.
106
+ # 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.
104
107
  attr_accessor :email_notification
105
108
 
106
109
  #
@@ -109,7 +112,7 @@ module DocuSign_eSign
109
112
  # 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]]`
110
113
  attr_accessor :embedded_recipient_start_url
111
114
 
112
- # This object describes errors that occur. It is only valid for responses and ignored in requests.
115
+ # Array or errors.
113
116
  attr_accessor :error_details
114
117
 
115
118
  # 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.
@@ -329,6 +332,7 @@ module DocuSign_eSign
329
332
  :'auto_navigation' => :'autoNavigation',
330
333
  :'auto_responded_reason' => :'autoRespondedReason',
331
334
  :'bulk_recipients_uri' => :'bulkRecipientsUri',
335
+ :'bulk_send_v2_recipient' => :'bulkSendV2Recipient',
332
336
  :'can_sign_offline' => :'canSignOffline',
333
337
  :'client_user_id' => :'clientUserId',
334
338
  :'completed_count' => :'completedCount',
@@ -436,6 +440,7 @@ module DocuSign_eSign
436
440
  :'auto_navigation' => :'String',
437
441
  :'auto_responded_reason' => :'String',
438
442
  :'bulk_recipients_uri' => :'String',
443
+ :'bulk_send_v2_recipient' => :'String',
439
444
  :'can_sign_offline' => :'String',
440
445
  :'client_user_id' => :'String',
441
446
  :'completed_count' => :'String',
@@ -580,6 +585,10 @@ module DocuSign_eSign
580
585
  self.bulk_recipients_uri = attributes[:'bulkRecipientsUri']
581
586
  end
582
587
 
588
+ if attributes.has_key?(:'bulkSendV2Recipient')
589
+ self.bulk_send_v2_recipient = attributes[:'bulkSendV2Recipient']
590
+ end
591
+
583
592
  if attributes.has_key?(:'canSignOffline')
584
593
  self.can_sign_offline = attributes[:'canSignOffline']
585
594
  end
@@ -995,6 +1004,7 @@ module DocuSign_eSign
995
1004
  auto_navigation == o.auto_navigation &&
996
1005
  auto_responded_reason == o.auto_responded_reason &&
997
1006
  bulk_recipients_uri == o.bulk_recipients_uri &&
1007
+ bulk_send_v2_recipient == o.bulk_send_v2_recipient &&
998
1008
  can_sign_offline == o.can_sign_offline &&
999
1009
  client_user_id == o.client_user_id &&
1000
1010
  completed_count == o.completed_count &&
@@ -1097,7 +1107,7 @@ module DocuSign_eSign
1097
1107
  # Calculates hash code according to all attributes.
1098
1108
  # @return [Fixnum] Hash code
1099
1109
  def hash
1100
- [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_navigation, auto_responded_reason, bulk_recipients_uri, can_sign_offline, client_user_id, completed_count, consent_details_list, creation_reason, custom_fields, declined_date_time, declined_reason, default_recipient, delegated_by, delegated_to, 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, is_bulk_recipient, is_bulk_recipient_metadata, last_name, last_name_metadata, live_oak_start_url, locked_recipient_phone_auth_editable, locked_recipient_sms_editable, name, name_metadata, notary_id, notary_signer_email_sent, notary_signers, notary_source_type, notary_type, note, note_metadata, offline_attributes, phone_authentication, phone_number, proof_file, recipient_attachments, recipient_authentication_status, recipient_feature_metadata, recipient_id, recipient_id_guid, recipient_signature_providers, recipient_supplies_tabs, recipient_type, recipient_type_metadata, require_id_lookup, require_id_lookup_metadata, require_signer_certificate, require_sign_on_paper, require_upload_signature, role_name, routing_order, routing_order_metadata, sent_date_time, signature_info, signed_date_time, sign_in_each_location, sign_in_each_location_metadata, signing_group_id, signing_group_id_metadata, signing_group_name, signing_group_users, sms_authentication, social_authentications, status, status_code, suppress_emails, tabs, template_locked, template_required, total_tab_count, user_id].hash
1110
+ [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_navigation, auto_responded_reason, bulk_recipients_uri, bulk_send_v2_recipient, can_sign_offline, client_user_id, completed_count, consent_details_list, creation_reason, custom_fields, declined_date_time, declined_reason, default_recipient, delegated_by, delegated_to, 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, is_bulk_recipient, is_bulk_recipient_metadata, last_name, last_name_metadata, live_oak_start_url, locked_recipient_phone_auth_editable, locked_recipient_sms_editable, name, name_metadata, notary_id, notary_signer_email_sent, notary_signers, notary_source_type, notary_type, note, note_metadata, offline_attributes, phone_authentication, phone_number, proof_file, recipient_attachments, recipient_authentication_status, recipient_feature_metadata, recipient_id, recipient_id_guid, recipient_signature_providers, recipient_supplies_tabs, recipient_type, recipient_type_metadata, require_id_lookup, require_id_lookup_metadata, require_signer_certificate, require_sign_on_paper, require_upload_signature, role_name, routing_order, routing_order_metadata, sent_date_time, signature_info, signed_date_time, sign_in_each_location, sign_in_each_location_metadata, signing_group_id, signing_group_id_metadata, signing_group_name, signing_group_users, sms_authentication, social_authentications, status, status_code, suppress_emails, tabs, template_locked, template_required, total_tab_count, user_id].hash
1101
1111
  end
1102
1112
 
1103
1113
  # Builds the object from hash
@@ -77,6 +77,7 @@ module DocuSign_eSign
77
77
  #
78
78
  attr_accessor :caption
79
79
 
80
+ #
80
81
  attr_accessor :caption_metadata
81
82
 
82
83
  # For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility.
@@ -103,7 +104,7 @@ module DocuSign_eSign
103
104
  # Metadata that indicates whether the `documentId` property is editable.
104
105
  attr_accessor :document_id_metadata
105
106
 
106
- # This object describes errors that occur. It is only valid for responses and ignored in requests.
107
+ # Array or errors.
107
108
  attr_accessor :error_details
108
109
 
109
110
  #
@@ -83,6 +83,7 @@ module DocuSign_eSign
83
83
  #
84
84
  attr_accessor :caption
85
85
 
86
+ #
86
87
  attr_accessor :caption_metadata
87
88
 
88
89
  # For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility.
@@ -109,7 +110,7 @@ module DocuSign_eSign
109
110
  # Metadata that indicates whether the `documentId` property is editable.
110
111
  attr_accessor :document_id_metadata
111
112
 
112
- # This object describes errors that occur. It is only valid for responses and ignored in requests.
113
+ # Array or errors.
113
114
  attr_accessor :error_details
114
115
 
115
116
  # The font to be used for the tab value. Supported Fonts: Arial, Arial, ArialNarrow, Calibri, CourierNew, Garamond, Georgia, Helvetica, LucidaConsole, Tahoma, TimesNewRoman, Trebuchet, Verdana, MSGothic, MSMincho, Default.
@@ -83,6 +83,7 @@ module DocuSign_eSign
83
83
  #
84
84
  attr_accessor :caption
85
85
 
86
+ #
86
87
  attr_accessor :caption_metadata
87
88
 
88
89
  # When set to **true**, the field appears normally while the recipient is adding or modifying the information in the field, but the data is not visible (the characters are hidden by asterisks) to any other signer or the sender. When an envelope is completed the information is available to the sender through the Form Data link in the DocuSign Console. This setting applies only to text boxes and does not affect list boxes, radio buttons, or check boxes.
@@ -121,7 +122,7 @@ module DocuSign_eSign
121
122
  # Metadata that indicates whether the `documentId` property is editable.
122
123
  attr_accessor :document_id_metadata
123
124
 
124
- # This object describes errors that occur. It is only valid for responses and ignored in requests.
125
+ # Array or errors.
125
126
  attr_accessor :error_details
126
127
 
127
128
  # The font to be used for the tab value. Supported Fonts: Arial, Arial, ArialNarrow, Calibri, CourierNew, Garamond, Georgia, Helvetica, LucidaConsole, Tahoma, TimesNewRoman, Trebuchet, Verdana, MSGothic, MSMincho, Default.