docusign_esign 3.21.0 → 3.23.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (153) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +10 -0
  3. data/lib/docusign_esign/api/accounts_api.rb +511 -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/authorization_user.rb +214 -0
  17. data/lib/docusign_esign/models/billing_charge.rb +1 -1
  18. data/lib/docusign_esign/models/brand.rb +1 -1
  19. data/lib/docusign_esign/models/bulk_envelope.rb +1 -1
  20. data/lib/docusign_esign/models/bulk_sending_copy_recipient.rb +2 -1
  21. data/lib/docusign_esign/models/bulksending_copy_doc_gen_form_field.rb +7 -7
  22. data/lib/docusign_esign/models/captive_recipient.rb +1 -1
  23. data/lib/docusign_esign/models/carbon_copy.rb +13 -3
  24. data/lib/docusign_esign/models/certified_delivery.rb +13 -3
  25. data/lib/docusign_esign/models/checkbox.rb +2 -1
  26. data/lib/docusign_esign/models/cloud_storage_provider.rb +1 -1
  27. data/lib/docusign_esign/models/comment_thread.rb +2 -1
  28. data/lib/docusign_esign/models/commission_county.rb +2 -1
  29. data/lib/docusign_esign/models/commission_expiration.rb +2 -1
  30. data/lib/docusign_esign/models/commission_number.rb +2 -1
  31. data/lib/docusign_esign/models/commission_state.rb +2 -1
  32. data/lib/docusign_esign/models/company.rb +2 -1
  33. data/lib/docusign_esign/models/connect_debug_log.rb +1 -1
  34. data/lib/docusign_esign/models/connect_historical_envelope_republish.rb +1 -0
  35. data/lib/docusign_esign/models/contact.rb +2 -1
  36. data/lib/docusign_esign/models/custom_field.rb +1 -1
  37. data/lib/docusign_esign/models/date.rb +2 -1
  38. data/lib/docusign_esign/models/date_signed.rb +2 -1
  39. data/lib/docusign_esign/models/decline.rb +2 -1
  40. data/lib/docusign_esign/models/delayed_routing.rb +1 -1
  41. data/lib/docusign_esign/models/delegation_info.rb +12 -12
  42. data/lib/docusign_esign/models/doc_gen_form_field_request.rb +186 -0
  43. data/lib/docusign_esign/models/doc_gen_form_field_response.rb +196 -0
  44. data/lib/docusign_esign/models/doc_gen_form_fields.rb +218 -0
  45. data/lib/docusign_esign/models/document_template.rb +1 -1
  46. data/lib/docusign_esign/models/document_visibility.rb +1 -1
  47. data/lib/docusign_esign/models/draw.rb +2 -1
  48. data/lib/docusign_esign/models/editor.rb +13 -3
  49. data/lib/docusign_esign/models/email.rb +2 -1
  50. data/lib/docusign_esign/models/email_address.rb +2 -1
  51. data/lib/docusign_esign/models/envelope.rb +2 -2
  52. data/lib/docusign_esign/models/envelope_attachment.rb +1 -1
  53. data/lib/docusign_esign/models/envelope_definition.rb +2 -2
  54. data/lib/docusign_esign/models/envelope_document.rb +1 -1
  55. data/lib/docusign_esign/models/envelope_id.rb +2 -1
  56. data/lib/docusign_esign/models/envelope_publish_transaction.rb +1 -0
  57. data/lib/docusign_esign/models/envelope_summary.rb +1 -1
  58. data/lib/docusign_esign/models/envelope_template.rb +2 -2
  59. data/lib/docusign_esign/models/envelope_transaction_status.rb +1 -1
  60. data/lib/docusign_esign/models/envelope_update_summary.rb +1 -1
  61. data/lib/docusign_esign/models/external_folder.rb +1 -1
  62. data/lib/docusign_esign/models/favorite_templates_content_item.rb +1 -1
  63. data/lib/docusign_esign/models/favorite_templates_info.rb +1 -1
  64. data/lib/docusign_esign/models/first_name.rb +2 -1
  65. data/lib/docusign_esign/models/folder.rb +1 -1
  66. data/lib/docusign_esign/models/folder_item_v2.rb +1 -1
  67. data/lib/docusign_esign/models/folder_shared_item.rb +1 -1
  68. data/lib/docusign_esign/models/form_data_item.rb +12 -2
  69. data/lib/docusign_esign/models/formula_tab.rb +2 -1
  70. data/lib/docusign_esign/models/full_name.rb +2 -1
  71. data/lib/docusign_esign/models/group.rb +1 -1
  72. data/lib/docusign_esign/models/in_person_signer.rb +13 -3
  73. data/lib/docusign_esign/models/initial_here.rb +3 -2
  74. data/lib/docusign_esign/models/inline_template.rb +2 -2
  75. data/lib/docusign_esign/models/intermediary.rb +13 -3
  76. data/lib/docusign_esign/models/last_name.rb +2 -1
  77. data/lib/docusign_esign/models/list.rb +2 -1
  78. data/lib/docusign_esign/models/list_custom_field.rb +1 -1
  79. data/lib/docusign_esign/models/lock_information.rb +1 -1
  80. data/lib/docusign_esign/models/member_group_shared_item.rb +1 -1
  81. data/lib/docusign_esign/models/member_shared_items.rb +1 -1
  82. data/lib/docusign_esign/models/mobile_notifier_configuration.rb +1 -1
  83. data/lib/docusign_esign/models/name_value.rb +1 -1
  84. data/lib/docusign_esign/models/new_account_definition.rb +2 -2
  85. data/lib/docusign_esign/models/new_user.rb +1 -1
  86. data/lib/docusign_esign/models/notarize.rb +2 -1
  87. data/lib/docusign_esign/models/notary_host.rb +13 -3
  88. data/lib/docusign_esign/models/notary_jurisdiction.rb +1 -1
  89. data/lib/docusign_esign/models/notary_recipient.rb +13 -3
  90. data/lib/docusign_esign/models/notary_seal.rb +2 -1
  91. data/lib/docusign_esign/models/note.rb +2 -1
  92. data/lib/docusign_esign/models/number.rb +2 -1
  93. data/lib/docusign_esign/models/numerical.rb +68 -1
  94. data/lib/docusign_esign/models/page.rb +1 -1
  95. data/lib/docusign_esign/models/participant.rb +33 -1
  96. data/lib/docusign_esign/models/phone_number.rb +2 -1
  97. data/lib/docusign_esign/models/poly_line_overlay.rb +2 -1
  98. data/lib/docusign_esign/models/power_form.rb +1 -1
  99. data/lib/docusign_esign/models/radio.rb +13 -2
  100. data/lib/docusign_esign/models/recipient_form_data.rb +12 -12
  101. data/lib/docusign_esign/models/recipient_update_response.rb +1 -1
  102. data/lib/docusign_esign/models/recipients.rb +1 -1
  103. data/lib/docusign_esign/models/scheduled_sending.rb +1 -1
  104. data/lib/docusign_esign/models/seal_sign.rb +13 -3
  105. data/lib/docusign_esign/models/sender_company.rb +2 -1
  106. data/lib/docusign_esign/models/sender_name.rb +2 -1
  107. data/lib/docusign_esign/models/shared_item.rb +1 -1
  108. data/lib/docusign_esign/models/sign_here.rb +2 -1
  109. data/lib/docusign_esign/models/signer.rb +13 -3
  110. data/lib/docusign_esign/models/signer_attachment.rb +2 -1
  111. data/lib/docusign_esign/models/signing_group.rb +1 -1
  112. data/lib/docusign_esign/models/signing_group_user.rb +1 -1
  113. data/lib/docusign_esign/models/smart_section.rb +4 -3
  114. data/lib/docusign_esign/models/social_account_information.rb +1 -1
  115. data/lib/docusign_esign/models/ssn.rb +2 -1
  116. data/lib/docusign_esign/models/stamp.rb +1 -1
  117. data/lib/docusign_esign/models/tab_account_settings.rb +21 -21
  118. data/lib/docusign_esign/models/tab_group.rb +2 -1
  119. data/lib/docusign_esign/models/tabs.rb +1 -13
  120. data/lib/docusign_esign/models/template_recipients.rb +1 -1
  121. data/lib/docusign_esign/models/template_role.rb +1 -1
  122. data/lib/docusign_esign/models/template_shared_item.rb +1 -1
  123. data/lib/docusign_esign/models/template_summary.rb +1 -1
  124. data/lib/docusign_esign/models/template_tabs.rb +1 -13
  125. data/lib/docusign_esign/models/template_update_summary.rb +1 -1
  126. data/lib/docusign_esign/models/text.rb +2 -1
  127. data/lib/docusign_esign/models/text_custom_field.rb +1 -1
  128. data/lib/docusign_esign/models/title.rb +2 -1
  129. data/lib/docusign_esign/models/user_account_management_granular_information.rb +2 -0
  130. data/lib/docusign_esign/models/user_authorization.rb +274 -0
  131. data/lib/docusign_esign/models/user_authorization_create_request.rb +214 -0
  132. data/lib/docusign_esign/models/user_authorization_create_request_with_id.rb +224 -0
  133. data/lib/docusign_esign/models/user_authorization_id_with_status.rb +204 -0
  134. data/lib/docusign_esign/models/user_authorization_update_request.rb +194 -0
  135. data/lib/docusign_esign/models/user_authorization_with_status.rb +204 -0
  136. data/lib/docusign_esign/models/user_authorizations.rb +246 -0
  137. data/lib/docusign_esign/models/user_authorizations_delete_request.rb +186 -0
  138. data/lib/docusign_esign/models/user_authorizations_delete_response.rb +186 -0
  139. data/lib/docusign_esign/models/user_authorizations_request.rb +186 -0
  140. data/lib/docusign_esign/models/user_authorizations_response.rb +186 -0
  141. data/lib/docusign_esign/models/user_info.rb +12 -2
  142. data/lib/docusign_esign/models/user_information.rb +2 -2
  143. data/lib/docusign_esign/models/user_settings_information.rb +2 -0
  144. data/lib/docusign_esign/models/user_shared_item.rb +1 -1
  145. data/lib/docusign_esign/models/user_signature.rb +1 -1
  146. data/lib/docusign_esign/models/view.rb +2 -1
  147. data/lib/docusign_esign/models/witness.rb +13 -3
  148. data/lib/docusign_esign/models/workspace_user.rb +1 -1
  149. data/lib/docusign_esign/models/workspace_user_authorization.rb +1 -1
  150. data/lib/docusign_esign/models/zip.rb +2 -1
  151. data/lib/docusign_esign/version.rb +1 -1
  152. data/lib/docusign_esign.rb +15 -2
  153. metadata +17 -2
@@ -16,93 +16,112 @@ module DocuSign_eSign
16
16
  #
17
17
  attr_accessor :anchor_allow_white_space_in_characters
18
18
 
19
+ #
19
20
  attr_accessor :anchor_allow_white_space_in_characters_metadata
20
21
 
21
22
  # When set to **true**, the anchor string does not consider case when matching strings in the document. The default value is **true**.
22
23
  attr_accessor :anchor_case_sensitive
23
24
 
25
+ #
24
26
  attr_accessor :anchor_case_sensitive_metadata
25
27
 
26
28
  # Specifies the alignment of anchor tabs with anchor strings. Possible values are **left** or **right**. The default value is **left**.
27
29
  attr_accessor :anchor_horizontal_alignment
28
30
 
31
+ #
29
32
  attr_accessor :anchor_horizontal_alignment_metadata
30
33
 
31
34
  # When set to **true**, this tab is ignored if anchorString is not found in the document.
32
35
  attr_accessor :anchor_ignore_if_not_present
33
36
 
37
+ #
34
38
  attr_accessor :anchor_ignore_if_not_present_metadata
35
39
 
36
40
  # When set to **true**, the anchor string in this tab matches whole words only (strings embedded in other strings are ignored.) The default value is **true**.
37
41
  attr_accessor :anchor_match_whole_word
38
42
 
43
+ #
39
44
  attr_accessor :anchor_match_whole_word_metadata
40
45
 
41
46
  # Anchor text information for a radio button.
42
47
  attr_accessor :anchor_string
43
48
 
49
+ #
44
50
  attr_accessor :anchor_string_metadata
45
51
 
46
52
  #
47
53
  attr_accessor :anchor_tab_processor_version
48
54
 
55
+ #
49
56
  attr_accessor :anchor_tab_processor_version_metadata
50
57
 
51
58
  # Specifies units of the X and Y offset. Units could be pixels, millimeters, centimeters, or inches.
52
59
  attr_accessor :anchor_units
53
60
 
61
+ #
54
62
  attr_accessor :anchor_units_metadata
55
63
 
56
64
  # Specifies the X axis location of the tab, in anchorUnits, relative to the anchorString.
57
65
  attr_accessor :anchor_x_offset
58
66
 
67
+ #
59
68
  attr_accessor :anchor_x_offset_metadata
60
69
 
61
70
  # Specifies the Y axis location of the tab, in anchorUnits, relative to the anchorString.
62
71
  attr_accessor :anchor_y_offset
63
72
 
73
+ #
64
74
  attr_accessor :anchor_y_offset_metadata
65
75
 
66
76
  # When set to **true**, the information in the tab is bold.
67
77
  attr_accessor :bold
68
78
 
79
+ #
69
80
  attr_accessor :bold_metadata
70
81
 
71
82
  #
72
83
  attr_accessor :caption
73
84
 
85
+ #
74
86
  attr_accessor :caption_metadata
75
87
 
76
88
  # 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.
77
89
  attr_accessor :conceal_value_on_document
78
90
 
91
+ #
79
92
  attr_accessor :conceal_value_on_document_metadata
80
93
 
81
94
  # For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility.
82
95
  attr_accessor :conditional_parent_label
83
96
 
97
+ #
84
98
  attr_accessor :conditional_parent_label_metadata
85
99
 
86
100
  # For conditional fields, this is the value of the parent tab that controls the tab's visibility. If the parent tab is a Checkbox, Radio button, Optional Signature, or Optional Initial use \"on\" as the value to show that the parent tab is active.
87
101
  attr_accessor :conditional_parent_value
88
102
 
103
+ #
89
104
  attr_accessor :conditional_parent_value_metadata
90
105
 
91
106
  # The DocuSign generated custom tab ID for the custom tab to be applied. This can only be used when adding new tabs for a recipient. When used, the new tab inherits all the custom tab properties.
92
107
  attr_accessor :custom_tab_id
93
108
 
109
+ #
94
110
  attr_accessor :custom_tab_id_metadata
95
111
 
96
112
  # When set to **true**, disables the auto sizing of single line text boxes in the signing screen when the signer enters data. If disabled users will only be able enter as much data as the text box can hold. By default this is false. This property only affects single line text boxes.
97
113
  attr_accessor :disable_auto_size
98
114
 
115
+ #
99
116
  attr_accessor :disable_auto_size_metadata
100
117
 
101
118
  # Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute.
102
119
  attr_accessor :document_id
103
120
 
121
+ #
104
122
  attr_accessor :document_id_metadata
105
123
 
124
+ # Array or errors.
106
125
  attr_accessor :error_details
107
126
 
108
127
  # 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.
@@ -111,55 +130,67 @@ module DocuSign_eSign
111
130
  # The font color used for the information in the tab. Possible values are: Black, BrightBlue, BrightRed, DarkGreen, DarkRed, Gold, Green, NavyBlue, Purple, or White.
112
131
  attr_accessor :font_color
113
132
 
133
+ #
114
134
  attr_accessor :font_color_metadata
115
135
 
136
+ #
116
137
  attr_accessor :font_metadata
117
138
 
118
139
  # The font size used for the information in the tab. Possible values are: Size7, Size8, Size9, Size10, Size11, Size12, Size14, Size16, Size18, Size20, Size22, Size24, Size26, Size28, Size36, Size48, or Size72.
119
140
  attr_accessor :font_size
120
141
 
142
+ #
121
143
  attr_accessor :font_size_metadata
122
144
 
123
145
  #
124
146
  attr_accessor :form_order
125
147
 
148
+ #
126
149
  attr_accessor :form_order_metadata
127
150
 
128
151
  #
129
152
  attr_accessor :form_page_label
130
153
 
154
+ #
131
155
  attr_accessor :form_page_label_metadata
132
156
 
133
157
  #
134
158
  attr_accessor :form_page_number
135
159
 
160
+ #
136
161
  attr_accessor :form_page_number_metadata
137
162
 
138
163
  # Height of the tab in pixels.
139
164
  attr_accessor :height
140
165
 
166
+ #
141
167
  attr_accessor :height_metadata
142
168
 
143
169
  # When set to **true**, the information in the tab is italic.
144
170
  attr_accessor :italic
145
171
 
172
+ #
146
173
  attr_accessor :italic_metadata
147
174
 
175
+ #
148
176
  attr_accessor :locale_policy
149
177
 
150
178
  # When set to **true**, the signer cannot change the data of the custom tab.
151
179
  attr_accessor :locked
152
180
 
181
+ #
153
182
  attr_accessor :locked_metadata
154
183
 
155
184
  # An optional value that describes the maximum length of the property when the property is a string.
156
185
  attr_accessor :max_length
157
186
 
187
+ #
158
188
  attr_accessor :max_length_metadata
159
189
 
160
190
  #
161
191
  attr_accessor :max_numerical_value
162
192
 
193
+ #
163
194
  attr_accessor :merge_field
164
195
 
165
196
  #
@@ -171,19 +202,25 @@ module DocuSign_eSign
171
202
  #
172
203
  attr_accessor :name
173
204
 
205
+ #
174
206
  attr_accessor :name_metadata
175
207
 
176
208
  #
177
209
  attr_accessor :numerical_value
178
210
 
211
+ #
212
+ attr_accessor :original_numerical_value
213
+
179
214
  # The initial value of the tab when it was sent to the recipient.
180
215
  attr_accessor :original_value
181
216
 
217
+ #
182
218
  attr_accessor :original_value_metadata
183
219
 
184
220
  # Specifies the page number on which the tab is located.
185
221
  attr_accessor :page_number
186
222
 
223
+ #
187
224
  attr_accessor :page_number_metadata
188
225
 
189
226
  # Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document.
@@ -192,40 +229,49 @@ module DocuSign_eSign
192
229
  #
193
230
  attr_accessor :recipient_id_guid
194
231
 
232
+ #
195
233
  attr_accessor :recipient_id_guid_metadata
196
234
 
235
+ #
197
236
  attr_accessor :recipient_id_metadata
198
237
 
199
238
  # When set to **true** and shared is true, information must be entered in this field to complete the envelope.
200
239
  attr_accessor :require_all
201
240
 
241
+ #
202
242
  attr_accessor :require_all_metadata
203
243
 
204
244
  # When set to **true**, the signer is required to fill out this tab
205
245
  attr_accessor :required
206
246
 
247
+ #
207
248
  attr_accessor :required_metadata
208
249
 
209
250
  # Optional element for field markup. When set to **true**, the signer is required to initial when they modify a shared field.
210
251
  attr_accessor :require_initial_on_shared_change
211
252
 
253
+ #
212
254
  attr_accessor :require_initial_on_shared_change_metadata
213
255
 
214
256
  # When set to **true**, the sender must populate the tab before an envelope can be sent using the template. This value tab can only be changed by modifying (PUT) the template. Tabs with a `senderRequired` value of true cannot be deleted from an envelope.
215
257
  attr_accessor :sender_required
216
258
 
259
+ #
217
260
  attr_accessor :sender_required_metadata
218
261
 
219
262
  # When set to **true**, this custom tab is shared.
220
263
  attr_accessor :shared
221
264
 
265
+ #
222
266
  attr_accessor :shared_metadata
223
267
 
224
268
  #
225
269
  attr_accessor :share_to_recipients
226
270
 
271
+ #
227
272
  attr_accessor :share_to_recipients_metadata
228
273
 
274
+ #
229
275
  attr_accessor :smart_contract_information
230
276
 
231
277
  #
@@ -234,51 +280,61 @@ module DocuSign_eSign
234
280
  # 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.
235
281
  attr_accessor :status
236
282
 
283
+ #
237
284
  attr_accessor :status_metadata
238
285
 
239
286
  #
240
287
  attr_accessor :tab_group_labels
241
288
 
289
+ #
242
290
  attr_accessor :tab_group_labels_metadata
243
291
 
244
292
  # The unique identifier for the tab. The tabid can be retrieved with the [ML:GET call].
245
293
  attr_accessor :tab_id
246
294
 
295
+ #
247
296
  attr_accessor :tab_id_metadata
248
297
 
249
298
  # The label string associated with the tab.
250
299
  attr_accessor :tab_label
251
300
 
301
+ #
252
302
  attr_accessor :tab_label_metadata
253
303
 
254
304
  #
255
305
  attr_accessor :tab_order
256
306
 
307
+ #
257
308
  attr_accessor :tab_order_metadata
258
309
 
259
310
  #
260
311
  attr_accessor :tab_type
261
312
 
313
+ #
262
314
  attr_accessor :tab_type_metadata
263
315
 
264
316
  # When set to **true**, the sender cannot change any attributes of the recipient. Used only when working with template recipients.
265
317
  attr_accessor :template_locked
266
318
 
319
+ #
267
320
  attr_accessor :template_locked_metadata
268
321
 
269
322
  # When set to **true**, the sender may not remove the recipient. Used only when working with template recipients.
270
323
  attr_accessor :template_required
271
324
 
325
+ #
272
326
  attr_accessor :template_required_metadata
273
327
 
274
328
  #
275
329
  attr_accessor :tooltip
276
330
 
331
+ #
277
332
  attr_accessor :tool_tip_metadata
278
333
 
279
334
  # When set to **true**, the information in the tab is underlined.
280
335
  attr_accessor :underline
281
336
 
337
+ #
282
338
  attr_accessor :underline_metadata
283
339
 
284
340
  #
@@ -287,21 +343,25 @@ module DocuSign_eSign
287
343
  # Specifies the value of the tab.
288
344
  attr_accessor :value
289
345
 
346
+ #
290
347
  attr_accessor :value_metadata
291
348
 
292
349
  # Width of the tab in pixels.
293
350
  attr_accessor :width
294
351
 
352
+ #
295
353
  attr_accessor :width_metadata
296
354
 
297
355
  # This indicates the horizontal offset of the object on the page. DocuSign uses 72 DPI when determining position.
298
356
  attr_accessor :x_position
299
357
 
358
+ #
300
359
  attr_accessor :x_position_metadata
301
360
 
302
361
  # This indicates the vertical offset of the object on the page. DocuSign uses 72 DPI when determining position.
303
362
  attr_accessor :y_position
304
363
 
364
+ #
305
365
  attr_accessor :y_position_metadata
306
366
 
307
367
  # Attribute mapping from ruby-style variable name to JSON key.
@@ -372,6 +432,7 @@ module DocuSign_eSign
372
432
  :'name' => :'name',
373
433
  :'name_metadata' => :'nameMetadata',
374
434
  :'numerical_value' => :'numericalValue',
435
+ :'original_numerical_value' => :'originalNumericalValue',
375
436
  :'original_value' => :'originalValue',
376
437
  :'original_value_metadata' => :'originalValueMetadata',
377
438
  :'page_number' => :'pageNumber',
@@ -494,6 +555,7 @@ module DocuSign_eSign
494
555
  :'name' => :'String',
495
556
  :'name_metadata' => :'PropertyMetadata',
496
557
  :'numerical_value' => :'String',
558
+ :'original_numerical_value' => :'String',
497
559
  :'original_value' => :'String',
498
560
  :'original_value_metadata' => :'PropertyMetadata',
499
561
  :'page_number' => :'String',
@@ -816,6 +878,10 @@ module DocuSign_eSign
816
878
  self.numerical_value = attributes[:'numericalValue']
817
879
  end
818
880
 
881
+ if attributes.has_key?(:'originalNumericalValue')
882
+ self.original_numerical_value = attributes[:'originalNumericalValue']
883
+ end
884
+
819
885
  if attributes.has_key?(:'originalValue')
820
886
  self.original_value = attributes[:'originalValue']
821
887
  end
@@ -1106,6 +1172,7 @@ module DocuSign_eSign
1106
1172
  name == o.name &&
1107
1173
  name_metadata == o.name_metadata &&
1108
1174
  numerical_value == o.numerical_value &&
1175
+ original_numerical_value == o.original_numerical_value &&
1109
1176
  original_value == o.original_value &&
1110
1177
  original_value_metadata == o.original_value_metadata &&
1111
1178
  page_number == o.page_number &&
@@ -1168,7 +1235,7 @@ module DocuSign_eSign
1168
1235
  # Calculates hash code according to all attributes.
1169
1236
  # @return [Fixnum] Hash code
1170
1237
  def hash
1171
- [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, conceal_value_on_document, conceal_value_on_document_metadata, conditional_parent_label, conditional_parent_label_metadata, conditional_parent_value, conditional_parent_value_metadata, custom_tab_id, custom_tab_id_metadata, disable_auto_size, disable_auto_size_metadata, document_id, document_id_metadata, error_details, font, font_color, font_color_metadata, font_metadata, font_size, font_size_metadata, form_order, form_order_metadata, form_page_label, form_page_label_metadata, form_page_number, form_page_number_metadata, height, height_metadata, italic, italic_metadata, locale_policy, locked, locked_metadata, max_length, max_length_metadata, max_numerical_value, merge_field, merge_field_xml, min_numerical_value, name, name_metadata, numerical_value, original_value, original_value_metadata, page_number, page_number_metadata, recipient_id, recipient_id_guid, recipient_id_guid_metadata, recipient_id_metadata, require_all, require_all_metadata, required, required_metadata, require_initial_on_shared_change, require_initial_on_shared_change_metadata, sender_required, sender_required_metadata, shared, shared_metadata, share_to_recipients, share_to_recipients_metadata, smart_contract_information, source, status, status_metadata, tab_group_labels, tab_group_labels_metadata, tab_id, tab_id_metadata, tab_label, tab_label_metadata, tab_order, tab_order_metadata, tab_type, tab_type_metadata, template_locked, template_locked_metadata, template_required, template_required_metadata, tooltip, tool_tip_metadata, underline, underline_metadata, validation_type, value, value_metadata, width, width_metadata, x_position, x_position_metadata, y_position, y_position_metadata].hash
1238
+ [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, conceal_value_on_document, conceal_value_on_document_metadata, conditional_parent_label, conditional_parent_label_metadata, conditional_parent_value, conditional_parent_value_metadata, custom_tab_id, custom_tab_id_metadata, disable_auto_size, disable_auto_size_metadata, document_id, document_id_metadata, error_details, font, font_color, font_color_metadata, font_metadata, font_size, font_size_metadata, form_order, form_order_metadata, form_page_label, form_page_label_metadata, form_page_number, form_page_number_metadata, height, height_metadata, italic, italic_metadata, locale_policy, locked, locked_metadata, max_length, max_length_metadata, max_numerical_value, merge_field, merge_field_xml, min_numerical_value, name, name_metadata, numerical_value, original_numerical_value, original_value, original_value_metadata, page_number, page_number_metadata, recipient_id, recipient_id_guid, recipient_id_guid_metadata, recipient_id_metadata, require_all, require_all_metadata, required, required_metadata, require_initial_on_shared_change, require_initial_on_shared_change_metadata, sender_required, sender_required_metadata, shared, shared_metadata, share_to_recipients, share_to_recipients_metadata, smart_contract_information, source, status, status_metadata, tab_group_labels, tab_group_labels_metadata, tab_id, tab_id_metadata, tab_label, tab_label_metadata, tab_order, tab_order_metadata, tab_type, tab_type_metadata, template_locked, template_locked_metadata, template_required, template_required_metadata, tooltip, tool_tip_metadata, underline, underline_metadata, validation_type, value, value_metadata, width, width_metadata, x_position, x_position_metadata, y_position, y_position_metadata].hash
1172
1239
  end
1173
1240
 
1174
1241
  # Builds the object from hash
@@ -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
  #