docusign_esign 3.20.0 → 3.22.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (150) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +10 -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/connect_api.rb +51 -0
  6. data/lib/docusign_esign/api/envelopes_api.rb +132 -65
  7. data/lib/docusign_esign/api/folders_api.rb +8 -0
  8. data/lib/docusign_esign/api/templates_api.rb +0 -130
  9. data/lib/docusign_esign/client/api_client.rb +1 -1
  10. data/lib/docusign_esign/models/account_information.rb +2 -1
  11. data/lib/docusign_esign/models/account_role_settings.rb +2 -0
  12. data/lib/docusign_esign/models/account_settings_information.rb +205 -3
  13. data/lib/docusign_esign/models/account_shared_access.rb +1 -1
  14. data/lib/docusign_esign/models/account_signature.rb +1 -1
  15. data/lib/docusign_esign/models/account_ui_settings.rb +2 -0
  16. data/lib/docusign_esign/models/agent.rb +13 -3
  17. data/lib/docusign_esign/models/approve.rb +2 -1
  18. data/lib/docusign_esign/models/billing_charge.rb +1 -1
  19. data/lib/docusign_esign/models/brand.rb +1 -1
  20. data/lib/docusign_esign/models/bulk_envelope.rb +1 -1
  21. data/lib/docusign_esign/models/bulk_sending_copy.rb +13 -1
  22. data/lib/docusign_esign/models/bulk_sending_copy_recipient.rb +12 -2
  23. data/lib/docusign_esign/models/bulksending_copy_doc_gen_form_field.rb +194 -0
  24. data/lib/docusign_esign/models/captive_recipient.rb +1 -1
  25. data/lib/docusign_esign/models/carbon_copy.rb +13 -3
  26. data/lib/docusign_esign/models/certified_delivery.rb +13 -3
  27. data/lib/docusign_esign/models/checkbox.rb +2 -1
  28. data/lib/docusign_esign/models/cloud_storage_provider.rb +1 -1
  29. data/lib/docusign_esign/models/comment_thread.rb +2 -1
  30. data/lib/docusign_esign/models/commission_county.rb +2 -1
  31. data/lib/docusign_esign/models/commission_expiration.rb +2 -1
  32. data/lib/docusign_esign/models/commission_number.rb +2 -1
  33. data/lib/docusign_esign/models/commission_state.rb +2 -1
  34. data/lib/docusign_esign/models/company.rb +2 -1
  35. data/lib/docusign_esign/models/connect_custom_configuration.rb +11 -1
  36. data/lib/docusign_esign/models/connect_debug_log.rb +1 -1
  37. data/lib/docusign_esign/models/connect_historical_envelope_republish.rb +1 -0
  38. data/lib/docusign_esign/models/contact.rb +12 -2
  39. data/lib/docusign_esign/models/custom_field.rb +1 -1
  40. data/lib/docusign_esign/models/date.rb +2 -1
  41. data/lib/docusign_esign/models/date_signed.rb +2 -1
  42. data/lib/docusign_esign/models/decline.rb +2 -1
  43. data/lib/docusign_esign/models/delayed_routing.rb +1 -1
  44. data/lib/docusign_esign/models/doc_gen_form_field_request.rb +186 -0
  45. data/lib/docusign_esign/models/doc_gen_form_field_response.rb +196 -0
  46. data/lib/docusign_esign/models/doc_gen_form_fields.rb +218 -0
  47. data/lib/docusign_esign/models/document_template.rb +1 -1
  48. data/lib/docusign_esign/models/document_visibility.rb +1 -1
  49. data/lib/docusign_esign/models/draw.rb +2 -1
  50. data/lib/docusign_esign/models/editor.rb +13 -3
  51. data/lib/docusign_esign/models/email.rb +2 -1
  52. data/lib/docusign_esign/models/email_address.rb +2 -1
  53. data/lib/docusign_esign/models/envelope.rb +13 -3
  54. data/lib/docusign_esign/models/envelope_attachment.rb +1 -1
  55. data/lib/docusign_esign/models/envelope_definition.rb +13 -3
  56. data/lib/docusign_esign/models/envelope_document.rb +1 -1
  57. data/lib/docusign_esign/models/envelope_id.rb +2 -1
  58. data/lib/docusign_esign/models/envelope_publish_transaction.rb +1 -0
  59. data/lib/docusign_esign/models/envelope_summary.rb +1 -1
  60. data/lib/docusign_esign/models/envelope_template.rb +13 -3
  61. data/lib/docusign_esign/models/envelope_transaction_status.rb +1 -1
  62. data/lib/docusign_esign/models/envelope_update_summary.rb +1 -1
  63. data/lib/docusign_esign/models/event_notification.rb +11 -1
  64. data/lib/docusign_esign/models/external_folder.rb +1 -1
  65. data/lib/docusign_esign/models/favorite_templates_content_item.rb +1 -1
  66. data/lib/docusign_esign/models/favorite_templates_info.rb +1 -1
  67. data/lib/docusign_esign/models/first_name.rb +2 -1
  68. data/lib/docusign_esign/models/folder.rb +1 -1
  69. data/lib/docusign_esign/models/folder_item_v2.rb +1 -1
  70. data/lib/docusign_esign/models/folder_shared_item.rb +1 -1
  71. data/lib/docusign_esign/models/form_data_item.rb +12 -2
  72. data/lib/docusign_esign/models/formula_tab.rb +2 -1
  73. data/lib/docusign_esign/models/full_name.rb +2 -1
  74. data/lib/docusign_esign/models/group.rb +1 -1
  75. data/lib/docusign_esign/models/id_evidence_view_link.rb +3 -3
  76. data/lib/docusign_esign/models/in_person_signer.rb +13 -3
  77. data/lib/docusign_esign/models/initial_here.rb +3 -2
  78. data/lib/docusign_esign/models/inline_template.rb +2 -2
  79. data/lib/docusign_esign/models/intermediary.rb +13 -3
  80. data/lib/docusign_esign/models/jurisdiction_summary.rb +214 -0
  81. data/lib/docusign_esign/models/last_name.rb +2 -1
  82. data/lib/docusign_esign/models/list.rb +2 -1
  83. data/lib/docusign_esign/models/list_custom_field.rb +1 -1
  84. data/lib/docusign_esign/models/locale_policy_tab.rb +14 -4
  85. data/lib/docusign_esign/models/lock_information.rb +1 -1
  86. data/lib/docusign_esign/models/member_group_shared_item.rb +1 -1
  87. data/lib/docusign_esign/models/member_shared_items.rb +1 -1
  88. data/lib/docusign_esign/models/mobile_notifier_configuration.rb +1 -1
  89. data/lib/docusign_esign/models/name_value.rb +1 -1
  90. data/lib/docusign_esign/models/new_account_definition.rb +2 -2
  91. data/lib/docusign_esign/models/new_user.rb +1 -1
  92. data/lib/docusign_esign/models/notarize.rb +2 -1
  93. data/lib/docusign_esign/models/notary_contact_details.rb +196 -0
  94. data/lib/docusign_esign/models/notary_host.rb +13 -3
  95. data/lib/docusign_esign/models/notary_jurisdiction.rb +1 -1
  96. data/lib/docusign_esign/models/notary_recipient.rb +13 -3
  97. data/lib/docusign_esign/models/notary_seal.rb +2 -1
  98. data/lib/docusign_esign/models/note.rb +2 -1
  99. data/lib/docusign_esign/models/number.rb +2 -1
  100. data/lib/docusign_esign/models/numerical.rb +1346 -0
  101. data/lib/docusign_esign/models/page.rb +1 -1
  102. data/lib/docusign_esign/models/participant.rb +33 -1
  103. data/lib/docusign_esign/models/phone_number.rb +2 -1
  104. data/lib/docusign_esign/models/poly_line_overlay.rb +2 -1
  105. data/lib/docusign_esign/models/power_form.rb +1 -1
  106. data/lib/docusign_esign/models/radio.rb +13 -2
  107. data/lib/docusign_esign/models/recipient_identity_verification.rb +14 -4
  108. data/lib/docusign_esign/models/recipient_update_response.rb +1 -1
  109. data/lib/docusign_esign/models/recipients.rb +1 -1
  110. data/lib/docusign_esign/models/scheduled_sending.rb +1 -1
  111. data/lib/docusign_esign/models/seal_sign.rb +13 -3
  112. data/lib/docusign_esign/models/sender_company.rb +2 -1
  113. data/lib/docusign_esign/models/sender_name.rb +2 -1
  114. data/lib/docusign_esign/models/shared_item.rb +1 -1
  115. data/lib/docusign_esign/models/sign_here.rb +2 -1
  116. data/lib/docusign_esign/models/signer.rb +13 -3
  117. data/lib/docusign_esign/models/signer_attachment.rb +2 -1
  118. data/lib/docusign_esign/models/signing_group.rb +1 -1
  119. data/lib/docusign_esign/models/signing_group_user.rb +1 -1
  120. data/lib/docusign_esign/models/smart_section.rb +4 -3
  121. data/lib/docusign_esign/models/social_account_information.rb +1 -1
  122. data/lib/docusign_esign/models/ssn.rb +2 -1
  123. data/lib/docusign_esign/models/stamp.rb +1 -1
  124. data/lib/docusign_esign/models/tab_account_settings.rb +21 -21
  125. data/lib/docusign_esign/models/tab_group.rb +2 -1
  126. data/lib/docusign_esign/models/tab_metadata.rb +11 -1
  127. data/lib/docusign_esign/models/tabs.rb +13 -13
  128. data/lib/docusign_esign/models/template_recipients.rb +1 -1
  129. data/lib/docusign_esign/models/template_role.rb +12 -2
  130. data/lib/docusign_esign/models/template_shared_item.rb +1 -1
  131. data/lib/docusign_esign/models/template_summary.rb +1 -1
  132. data/lib/docusign_esign/models/template_tabs.rb +13 -13
  133. data/lib/docusign_esign/models/template_update_summary.rb +1 -1
  134. data/lib/docusign_esign/models/text.rb +2 -1
  135. data/lib/docusign_esign/models/text_custom_field.rb +1 -1
  136. data/lib/docusign_esign/models/title.rb +2 -1
  137. data/lib/docusign_esign/models/user_account_management_granular_information.rb +22 -1
  138. data/lib/docusign_esign/models/user_info.rb +12 -2
  139. data/lib/docusign_esign/models/user_information.rb +2 -2
  140. data/lib/docusign_esign/models/user_settings_information.rb +2 -0
  141. data/lib/docusign_esign/models/user_shared_item.rb +1 -1
  142. data/lib/docusign_esign/models/user_signature.rb +1 -1
  143. data/lib/docusign_esign/models/view.rb +2 -1
  144. data/lib/docusign_esign/models/witness.rb +13 -3
  145. data/lib/docusign_esign/models/workspace_user.rb +1 -1
  146. data/lib/docusign_esign/models/workspace_user_authorization.rb +1 -1
  147. data/lib/docusign_esign/models/zip.rb +2 -1
  148. data/lib/docusign_esign/version.rb +1 -1
  149. data/lib/docusign_esign.rb +7 -6
  150. metadata +9 -2
@@ -17,7 +17,7 @@ module DocuSign_eSign
17
17
  # The number of dots per inch used for the page image.
18
18
  attr_accessor :dpi
19
19
 
20
- # If an error occurs, this property describes the error.
20
+ # Array or errors.
21
21
  attr_accessor :error_details
22
22
 
23
23
  # Height of the tab in pixels.
@@ -16,6 +16,7 @@ module DocuSign_eSign
16
16
  # 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.
17
17
  attr_accessor :access_code
18
18
 
19
+ #
19
20
  attr_accessor :access_code_metadata
20
21
 
21
22
  # 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.
@@ -30,6 +31,9 @@ module DocuSign_eSign
30
31
  #
31
32
  attr_accessor :auto_responded_reason
32
33
 
34
+ #
35
+ attr_accessor :bulk_send_v2_recipient
36
+
33
37
  # 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.
34
38
  attr_accessor :client_user_id
35
39
 
@@ -54,6 +58,7 @@ module DocuSign_eSign
54
58
  # Reserved: For DocuSign use only.
55
59
  attr_accessor :delivery_method
56
60
 
61
+ #
57
62
  attr_accessor :delivery_method_metadata
58
63
 
59
64
  #
@@ -68,8 +73,10 @@ module DocuSign_eSign
68
73
  #
69
74
  attr_accessor :email
70
75
 
76
+ #
71
77
  attr_accessor :email_metadata
72
78
 
79
+ # 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.
73
80
  attr_accessor :email_notification
74
81
 
75
82
  #
@@ -78,30 +85,37 @@ module DocuSign_eSign
78
85
  # 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]]`
79
86
  attr_accessor :embedded_recipient_start_url
80
87
 
88
+ # Array or errors.
81
89
  attr_accessor :error_details
82
90
 
83
91
  # Reserved:
84
92
  attr_accessor :fax_number
85
93
 
94
+ #
86
95
  attr_accessor :fax_number_metadata
87
96
 
88
97
  # The user's first name. Maximum Length: 50 characters.
89
98
  attr_accessor :first_name
90
99
 
100
+ #
91
101
  attr_accessor :first_name_metadata
92
102
 
93
103
  #
94
104
  attr_accessor :full_name
95
105
 
106
+ #
96
107
  attr_accessor :full_name_metadata
97
108
 
98
109
  # 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.
99
110
  attr_accessor :id_check_configuration_name
100
111
 
112
+ #
101
113
  attr_accessor :id_check_configuration_name_metadata
102
114
 
115
+ #
103
116
  attr_accessor :id_check_information_input
104
117
 
118
+ #
105
119
  attr_accessor :identity_verification
106
120
 
107
121
  # 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.
@@ -110,6 +124,7 @@ module DocuSign_eSign
110
124
  #
111
125
  attr_accessor :last_name
112
126
 
127
+ #
113
128
  attr_accessor :last_name_metadata
114
129
 
115
130
  #
@@ -121,11 +136,13 @@ module DocuSign_eSign
121
136
  #
122
137
  attr_accessor :name
123
138
 
139
+ #
124
140
  attr_accessor :name_metadata
125
141
 
126
142
  # 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.
127
143
  attr_accessor :note
128
144
 
145
+ #
129
146
  attr_accessor :note_metadata
130
147
 
131
148
  #
@@ -134,13 +151,16 @@ module DocuSign_eSign
134
151
  #
135
152
  attr_accessor :participate_for_guid
136
153
 
154
+ #
137
155
  attr_accessor :phone_authentication
138
156
 
157
+ #
139
158
  attr_accessor :phone_number
140
159
 
141
160
  # Reserved:
142
161
  attr_accessor :recipient_attachments
143
162
 
163
+ #
144
164
  attr_accessor :recipient_authentication_status
145
165
 
146
166
  #
@@ -155,11 +175,13 @@ module DocuSign_eSign
155
175
  #
156
176
  attr_accessor :recipient_type
157
177
 
178
+ #
158
179
  attr_accessor :recipient_type_metadata
159
180
 
160
181
  # When set to **true**, the recipient is required to use the specified ID check method (including Phone and SMS authentication) to validate their identity.
161
182
  attr_accessor :require_id_lookup
162
183
 
184
+ #
163
185
  attr_accessor :require_id_lookup_metadata
164
186
 
165
187
  # Optional element. Specifies the role name associated with the recipient.<br/><br/>This is required when working with template recipients.
@@ -168,6 +190,7 @@ module DocuSign_eSign
168
190
  # Specifies the routing order of the recipient in the envelope.
169
191
  attr_accessor :routing_order
170
192
 
193
+ #
171
194
  attr_accessor :routing_order_metadata
172
195
 
173
196
  # The date and time the envelope was sent.
@@ -179,6 +202,7 @@ module DocuSign_eSign
179
202
  # 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).
180
203
  attr_accessor :signing_group_id
181
204
 
205
+ #
182
206
  attr_accessor :signing_group_id_metadata
183
207
 
184
208
  # The display name for the signing group. Maximum Length: 100 characters.
@@ -187,6 +211,7 @@ module DocuSign_eSign
187
211
  # A complex type that contains information about users in the signing group.
188
212
  attr_accessor :signing_group_users
189
213
 
214
+ #
190
215
  attr_accessor :sms_authentication
191
216
 
192
217
  # Lists the social ID type that can be used for recipient authentication.
@@ -222,6 +247,7 @@ module DocuSign_eSign
222
247
  :'additional_notifications' => :'additionalNotifications',
223
248
  :'allow_system_override_for_locked_recipient' => :'allowSystemOverrideForLockedRecipient',
224
249
  :'auto_responded_reason' => :'autoRespondedReason',
250
+ :'bulk_send_v2_recipient' => :'bulkSendV2Recipient',
225
251
  :'client_user_id' => :'clientUserId',
226
252
  :'completed_count' => :'completedCount',
227
253
  :'consent_details_list' => :'consentDetailsList',
@@ -302,6 +328,7 @@ module DocuSign_eSign
302
328
  :'additional_notifications' => :'Array<RecipientAdditionalNotification>',
303
329
  :'allow_system_override_for_locked_recipient' => :'String',
304
330
  :'auto_responded_reason' => :'String',
331
+ :'bulk_send_v2_recipient' => :'String',
305
332
  :'client_user_id' => :'String',
306
333
  :'completed_count' => :'String',
307
334
  :'consent_details_list' => :'Array<ConsentDetails>',
@@ -407,6 +434,10 @@ module DocuSign_eSign
407
434
  self.auto_responded_reason = attributes[:'autoRespondedReason']
408
435
  end
409
436
 
437
+ if attributes.has_key?(:'bulkSendV2Recipient')
438
+ self.bulk_send_v2_recipient = attributes[:'bulkSendV2Recipient']
439
+ end
440
+
410
441
  if attributes.has_key?(:'clientUserId')
411
442
  self.client_user_id = attributes[:'clientUserId']
412
443
  end
@@ -718,6 +749,7 @@ module DocuSign_eSign
718
749
  additional_notifications == o.additional_notifications &&
719
750
  allow_system_override_for_locked_recipient == o.allow_system_override_for_locked_recipient &&
720
751
  auto_responded_reason == o.auto_responded_reason &&
752
+ bulk_send_v2_recipient == o.bulk_send_v2_recipient &&
721
753
  client_user_id == o.client_user_id &&
722
754
  completed_count == o.completed_count &&
723
755
  consent_details_list == o.consent_details_list &&
@@ -797,7 +829,7 @@ module DocuSign_eSign
797
829
  # Calculates hash code according to all attributes.
798
830
  # @return [Fixnum] Hash code
799
831
  def hash
800
- [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, 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, participate_for, participate_for_guid, 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
832
+ [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, 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, participate_for, participate_for_guid, 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
801
833
  end
802
834
 
803
835
  # 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
  # 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.
@@ -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,7 +29,7 @@ module DocuSign_eSign
29
29
  #
30
30
  attr_accessor :envelopes
31
31
 
32
- # This object describes errors that occur. It is only valid for responses and ignored in requests.
32
+ # Array or errors.
33
33
  attr_accessor :error_details
34
34
 
35
35
  #
@@ -83,9 +83,10 @@ module DocuSign_eSign
83
83
  #
84
84
  attr_accessor :caption
85
85
 
86
+ #
86
87
  attr_accessor :caption_metadata
87
88
 
88
- # This object describes errors that occur. It is only valid for responses and ignored in requests.
89
+ # Array or errors.
89
90
  attr_accessor :error_details
90
91
 
91
92
  # 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.
@@ -118,6 +119,9 @@ module DocuSign_eSign
118
119
  # Metadata that indicates whether the `locked` property is editable.
119
120
  attr_accessor :locked_metadata
120
121
 
122
+ #
123
+ attr_accessor :merge_field_xml
124
+
121
125
  # Specifies the page number on which the tab is located.
122
126
  attr_accessor :page_number
123
127
 
@@ -216,6 +220,7 @@ module DocuSign_eSign
216
220
  :'italic_metadata' => :'italicMetadata',
217
221
  :'locked' => :'locked',
218
222
  :'locked_metadata' => :'lockedMetadata',
223
+ :'merge_field_xml' => :'mergeFieldXml',
219
224
  :'page_number' => :'pageNumber',
220
225
  :'page_number_metadata' => :'pageNumberMetadata',
221
226
  :'required' => :'required',
@@ -277,6 +282,7 @@ module DocuSign_eSign
277
282
  :'italic_metadata' => :'PropertyMetadata',
278
283
  :'locked' => :'String',
279
284
  :'locked_metadata' => :'PropertyMetadata',
285
+ :'merge_field_xml' => :'String',
280
286
  :'page_number' => :'String',
281
287
  :'page_number_metadata' => :'PropertyMetadata',
282
288
  :'required' => :'String',
@@ -448,6 +454,10 @@ module DocuSign_eSign
448
454
  self.locked_metadata = attributes[:'lockedMetadata']
449
455
  end
450
456
 
457
+ if attributes.has_key?(:'mergeFieldXml')
458
+ self.merge_field_xml = attributes[:'mergeFieldXml']
459
+ end
460
+
451
461
  if attributes.has_key?(:'pageNumber')
452
462
  self.page_number = attributes[:'pageNumber']
453
463
  end
@@ -582,6 +592,7 @@ module DocuSign_eSign
582
592
  italic_metadata == o.italic_metadata &&
583
593
  locked == o.locked &&
584
594
  locked_metadata == o.locked_metadata &&
595
+ merge_field_xml == o.merge_field_xml &&
585
596
  page_number == o.page_number &&
586
597
  page_number_metadata == o.page_number_metadata &&
587
598
  required == o.required &&
@@ -613,7 +624,7 @@ module DocuSign_eSign
613
624
  # Calculates hash code according to all attributes.
614
625
  # @return [Fixnum] Hash code
615
626
  def hash
616
- [anchor_allow_white_space_in_characters, anchor_allow_white_space_in_characters_metadata, anchor_case_sensitive, anchor_case_sensitive_metadata, anchor_horizontal_alignment, anchor_horizontal_alignment_metadata, anchor_ignore_if_not_present, anchor_ignore_if_not_present_metadata, anchor_match_whole_word, anchor_match_whole_word_metadata, anchor_string, anchor_string_metadata, anchor_tab_processor_version, anchor_tab_processor_version_metadata, anchor_units, anchor_units_metadata, anchor_x_offset, anchor_x_offset_metadata, anchor_y_offset, anchor_y_offset_metadata, bold, bold_metadata, caption, caption_metadata, error_details, font, font_color, font_color_metadata, font_metadata, font_size, font_size_metadata, italic, italic_metadata, locked, locked_metadata, page_number, page_number_metadata, required, required_metadata, selected, selected_metadata, status, status_metadata, tab_id, tab_id_metadata, tab_order, tab_order_metadata, underline, underline_metadata, value, value_metadata, x_position, x_position_metadata, y_position, y_position_metadata].hash
627
+ [anchor_allow_white_space_in_characters, anchor_allow_white_space_in_characters_metadata, anchor_case_sensitive, anchor_case_sensitive_metadata, anchor_horizontal_alignment, anchor_horizontal_alignment_metadata, anchor_ignore_if_not_present, anchor_ignore_if_not_present_metadata, anchor_match_whole_word, anchor_match_whole_word_metadata, anchor_string, anchor_string_metadata, anchor_tab_processor_version, anchor_tab_processor_version_metadata, anchor_units, anchor_units_metadata, anchor_x_offset, anchor_x_offset_metadata, anchor_y_offset, anchor_y_offset_metadata, bold, bold_metadata, caption, caption_metadata, error_details, font, font_color, font_color_metadata, font_metadata, font_size, font_size_metadata, italic, italic_metadata, locked, locked_metadata, merge_field_xml, page_number, page_number_metadata, required, required_metadata, selected, selected_metadata, status, status_metadata, tab_id, tab_id_metadata, tab_order, tab_order_metadata, underline, underline_metadata, value, value_metadata, x_position, x_position_metadata, y_position, y_position_metadata].hash
617
628
  end
618
629
 
619
630
  # Builds the object from hash
@@ -23,12 +23,16 @@ module DocuSign_eSign
23
23
  #
24
24
  attr_accessor :workflow_id_metadata
25
25
 
26
+ #
27
+ attr_accessor :workflow_label
28
+
26
29
  # Attribute mapping from ruby-style variable name to JSON key.
27
30
  def self.attribute_map
28
31
  {
29
32
  :'input_options' => :'inputOptions',
30
33
  :'workflow_id' => :'workflowId',
31
- :'workflow_id_metadata' => :'workflowIdMetadata'
34
+ :'workflow_id_metadata' => :'workflowIdMetadata',
35
+ :'workflow_label' => :'workflowLabel'
32
36
  }
33
37
  end
34
38
 
@@ -37,7 +41,8 @@ module DocuSign_eSign
37
41
  {
38
42
  :'input_options' => :'Array<RecipientIdentityInputOption>',
39
43
  :'workflow_id' => :'String',
40
- :'workflow_id_metadata' => :'PropertyMetadata'
44
+ :'workflow_id_metadata' => :'PropertyMetadata',
45
+ :'workflow_label' => :'String'
41
46
  }
42
47
  end
43
48
 
@@ -62,6 +67,10 @@ module DocuSign_eSign
62
67
  if attributes.has_key?(:'workflowIdMetadata')
63
68
  self.workflow_id_metadata = attributes[:'workflowIdMetadata']
64
69
  end
70
+
71
+ if attributes.has_key?(:'workflowLabel')
72
+ self.workflow_label = attributes[:'workflowLabel']
73
+ end
65
74
  end
66
75
 
67
76
  # Show invalid properties with the reasons. Usually used together with valid?
@@ -84,7 +93,8 @@ module DocuSign_eSign
84
93
  self.class == o.class &&
85
94
  input_options == o.input_options &&
86
95
  workflow_id == o.workflow_id &&
87
- workflow_id_metadata == o.workflow_id_metadata
96
+ workflow_id_metadata == o.workflow_id_metadata &&
97
+ workflow_label == o.workflow_label
88
98
  end
89
99
 
90
100
  # @see the `==` method
@@ -96,7 +106,7 @@ module DocuSign_eSign
96
106
  # Calculates hash code according to all attributes.
97
107
  # @return [Fixnum] Hash code
98
108
  def hash
99
- [input_options, workflow_id, workflow_id_metadata].hash
109
+ [input_options, workflow_id, workflow_id_metadata, workflow_label].hash
100
110
  end
101
111
 
102
112
  # Builds the object from hash
@@ -17,7 +17,7 @@ module DocuSign_eSign
17
17
  #
18
18
  attr_accessor :combined
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
  # Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document.
@@ -29,7 +29,7 @@ module DocuSign_eSign
29
29
  # A complex type defining the management and access rights of a recipient assigned assigned as an editor on the document.
30
30
  attr_accessor :editors
31
31
 
32
- # This object describes errors that occur. It is only valid for responses and ignored in requests.
32
+ # Array or errors.
33
33
  attr_accessor :error_details
34
34
 
35
35
  # Specifies a signer that is in the same physical location as a DocuSign user who will act as a Signing Host for the transaction. The recipient added is the Signing Host and new separate Signer Name field appears after Sign in person is selected.
@@ -22,7 +22,7 @@ module DocuSign_eSign
22
22
  # A list of envelope delay rules specified by the user indicating how and when the envelope should be scheduled for sending in the future. Currently only 1 rule may be specified.
23
23
  attr_accessor :rules
24
24
 
25
- # \\\"pending\\\" if the envelope has not yet been sent and the scheduled sending delay has not iniaited. \\\"started\\\" if the scheduled sending delay is in progress. \\\"completed\\\" if the scheduled sending delay has elapsed and the envelope has been sent.
25
+ # 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.
26
26
  attr_accessor :status
27
27
 
28
28
  # Attribute mapping from ruby-style variable name to JSON key.
@@ -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
 
@@ -62,13 +65,13 @@ module DocuSign_eSign
62
65
  #
63
66
  attr_accessor :document_visibility
64
67
 
65
- # Not applicable.
68
+ # 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.
66
69
  attr_accessor :email_notification
67
70
 
68
71
  # 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]]`
69
72
  attr_accessor :embedded_recipient_start_url
70
73
 
71
- # This object describes errors that occur. It is only valid for responses and ignored in requests.
74
+ # Array or errors.
72
75
  attr_accessor :error_details
73
76
 
74
77
  # Reserved:
@@ -193,6 +196,7 @@ module DocuSign_eSign
193
196
  :'add_access_code_to_email' => :'addAccessCodeToEmail',
194
197
  :'allow_system_override_for_locked_recipient' => :'allowSystemOverrideForLockedRecipient',
195
198
  :'auto_responded_reason' => :'autoRespondedReason',
199
+ :'bulk_send_v2_recipient' => :'bulkSendV2Recipient',
196
200
  :'client_user_id' => :'clientUserId',
197
201
  :'completed_count' => :'completedCount',
198
202
  :'custom_fields' => :'customFields',
@@ -256,6 +260,7 @@ module DocuSign_eSign
256
260
  :'add_access_code_to_email' => :'String',
257
261
  :'allow_system_override_for_locked_recipient' => :'String',
258
262
  :'auto_responded_reason' => :'String',
263
+ :'bulk_send_v2_recipient' => :'String',
259
264
  :'client_user_id' => :'String',
260
265
  :'completed_count' => :'String',
261
266
  :'custom_fields' => :'Array<String>',
@@ -339,6 +344,10 @@ module DocuSign_eSign
339
344
  self.auto_responded_reason = attributes[:'autoRespondedReason']
340
345
  end
341
346
 
347
+ if attributes.has_key?(:'bulkSendV2Recipient')
348
+ self.bulk_send_v2_recipient = attributes[:'bulkSendV2Recipient']
349
+ end
350
+
342
351
  if attributes.has_key?(:'clientUserId')
343
352
  self.client_user_id = attributes[:'clientUserId']
344
353
  end
@@ -583,6 +592,7 @@ module DocuSign_eSign
583
592
  add_access_code_to_email == o.add_access_code_to_email &&
584
593
  allow_system_override_for_locked_recipient == o.allow_system_override_for_locked_recipient &&
585
594
  auto_responded_reason == o.auto_responded_reason &&
595
+ bulk_send_v2_recipient == o.bulk_send_v2_recipient &&
586
596
  client_user_id == o.client_user_id &&
587
597
  completed_count == o.completed_count &&
588
598
  custom_fields == o.custom_fields &&
@@ -646,7 +656,7 @@ module DocuSign_eSign
646
656
  # Calculates hash code according to all attributes.
647
657
  # @return [Fixnum] Hash code
648
658
  def hash
649
- [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_notification, embedded_recipient_start_url, error_details, fax_number, fax_number_metadata, 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, note, note_metadata, phone_authentication, recipient_attachments, recipient_authentication_status, recipient_feature_metadata, recipient_id, recipient_id_guid, recipient_signature_providers, 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, sms_authentication, social_authentications, status, status_code, suppress_emails, tabs, template_locked, template_required, total_tab_count, user_id].hash
659
+ [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_notification, embedded_recipient_start_url, error_details, fax_number, fax_number_metadata, 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, note, note_metadata, phone_authentication, recipient_attachments, recipient_authentication_status, recipient_feature_metadata, recipient_id, recipient_id_guid, recipient_signature_providers, 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, sms_authentication, social_authentications, status, status_code, suppress_emails, tabs, template_locked, template_required, total_tab_count, user_id].hash
650
660
  end
651
661
 
652
662
  # Builds the object from hash
@@ -82,6 +82,7 @@ module DocuSign_eSign
82
82
  #
83
83
  attr_accessor :caption
84
84
 
85
+ #
85
86
  attr_accessor :caption_metadata
86
87
 
87
88
  # For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility.
@@ -108,7 +109,7 @@ module DocuSign_eSign
108
109
  # Metadata that indicates whether the `documentId` property is editable.
109
110
  attr_accessor :document_id_metadata
110
111
 
111
- # This object describes errors that occur. It is only valid for responses and ignored in requests.
112
+ # Array or errors.
112
113
  attr_accessor :error_details
113
114
 
114
115
  # 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.
@@ -82,6 +82,7 @@ module DocuSign_eSign
82
82
  #
83
83
  attr_accessor :caption
84
84
 
85
+ #
85
86
  attr_accessor :caption_metadata
86
87
 
87
88
  # For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility.
@@ -108,7 +109,7 @@ module DocuSign_eSign
108
109
  # Metadata that indicates whether the `documentId` property is editable.
109
110
  attr_accessor :document_id_metadata
110
111
 
111
- # This object describes errors that occur. It is only valid for responses and ignored in requests.
112
+ # Array or errors.
112
113
  attr_accessor :error_details
113
114
 
114
115
  # 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.
@@ -14,7 +14,7 @@ require 'date'
14
14
  module DocuSign_eSign
15
15
  # Information about the shared item.
16
16
  class SharedItem
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
  # When set to **true**, this custom tab is shared.
@@ -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
  #
@@ -44,6 +44,9 @@ module DocuSign_eSign
44
44
  # Contains a URI for an endpoint that allows you to easily retrieve bulk recipient information.
45
45
  attr_accessor :bulk_recipients_uri
46
46
 
47
+ #
48
+ attr_accessor :bulk_send_v2_recipient
49
+
47
50
  # When set to **true**, specifies that the signer can perform the signing ceremony offline.
48
51
  attr_accessor :can_sign_offline
49
52
 
@@ -101,7 +104,7 @@ module DocuSign_eSign
101
104
  # Metadata that indicates whether the `email` property is editable. This property is read-only.
102
105
  attr_accessor :email_metadata
103
106
 
104
- # 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`.
107
+ # 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.
105
108
  attr_accessor :email_notification
106
109
 
107
110
  #
@@ -110,7 +113,7 @@ module DocuSign_eSign
110
113
  # 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]]`
111
114
  attr_accessor :embedded_recipient_start_url
112
115
 
113
- # This object describes errors that occur. It is only valid for responses and ignored in requests.
116
+ # Array or errors.
114
117
  attr_accessor :error_details
115
118
 
116
119
  # 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.
@@ -318,6 +321,7 @@ module DocuSign_eSign
318
321
  :'auto_navigation' => :'autoNavigation',
319
322
  :'auto_responded_reason' => :'autoRespondedReason',
320
323
  :'bulk_recipients_uri' => :'bulkRecipientsUri',
324
+ :'bulk_send_v2_recipient' => :'bulkSendV2Recipient',
321
325
  :'can_sign_offline' => :'canSignOffline',
322
326
  :'client_user_id' => :'clientUserId',
323
327
  :'completed_count' => :'completedCount',
@@ -421,6 +425,7 @@ module DocuSign_eSign
421
425
  :'auto_navigation' => :'String',
422
426
  :'auto_responded_reason' => :'String',
423
427
  :'bulk_recipients_uri' => :'String',
428
+ :'bulk_send_v2_recipient' => :'String',
424
429
  :'can_sign_offline' => :'String',
425
430
  :'client_user_id' => :'String',
426
431
  :'completed_count' => :'String',
@@ -561,6 +566,10 @@ module DocuSign_eSign
561
566
  self.bulk_recipients_uri = attributes[:'bulkRecipientsUri']
562
567
  end
563
568
 
569
+ if attributes.has_key?(:'bulkSendV2Recipient')
570
+ self.bulk_send_v2_recipient = attributes[:'bulkSendV2Recipient']
571
+ end
572
+
564
573
  if attributes.has_key?(:'canSignOffline')
565
574
  self.can_sign_offline = attributes[:'canSignOffline']
566
575
  end
@@ -958,6 +967,7 @@ module DocuSign_eSign
958
967
  auto_navigation == o.auto_navigation &&
959
968
  auto_responded_reason == o.auto_responded_reason &&
960
969
  bulk_recipients_uri == o.bulk_recipients_uri &&
970
+ bulk_send_v2_recipient == o.bulk_send_v2_recipient &&
961
971
  can_sign_offline == o.can_sign_offline &&
962
972
  client_user_id == o.client_user_id &&
963
973
  completed_count == o.completed_count &&
@@ -1056,7 +1066,7 @@ module DocuSign_eSign
1056
1066
  # Calculates hash code according to all attributes.
1057
1067
  # @return [Fixnum] Hash code
1058
1068
  def hash
1059
- [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, locked_recipient_phone_auth_editable, locked_recipient_sms_editable, name, name_metadata, notary_id, notary_signer_email_sent, 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
1069
+ [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, locked_recipient_phone_auth_editable, locked_recipient_sms_editable, name, name_metadata, notary_id, notary_signer_email_sent, 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
1060
1070
  end
1061
1071
 
1062
1072
  # Builds the object from hash