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
@@ -0,0 +1,1346 @@
1
+ =begin
2
+ #DocuSign REST API
3
+
4
+ #The DocuSign REST API provides you with a powerful, convenient, and simple Web services API for interacting with DocuSign.
5
+
6
+ OpenAPI spec version: v2.1
7
+ Contact: devcenter@docusign.com
8
+ Generated by: https://github.com/swagger-api/swagger-codegen.git
9
+
10
+ =end
11
+
12
+ require 'date'
13
+
14
+ module DocuSign_eSign
15
+ class Numerical
16
+ #
17
+ attr_accessor :anchor_allow_white_space_in_characters
18
+
19
+ #
20
+ attr_accessor :anchor_allow_white_space_in_characters_metadata
21
+
22
+ # When set to **true**, the anchor string does not consider case when matching strings in the document. The default value is **true**.
23
+ attr_accessor :anchor_case_sensitive
24
+
25
+ #
26
+ attr_accessor :anchor_case_sensitive_metadata
27
+
28
+ # Specifies the alignment of anchor tabs with anchor strings. Possible values are **left** or **right**. The default value is **left**.
29
+ attr_accessor :anchor_horizontal_alignment
30
+
31
+ #
32
+ attr_accessor :anchor_horizontal_alignment_metadata
33
+
34
+ # When set to **true**, this tab is ignored if anchorString is not found in the document.
35
+ attr_accessor :anchor_ignore_if_not_present
36
+
37
+ #
38
+ attr_accessor :anchor_ignore_if_not_present_metadata
39
+
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**.
41
+ attr_accessor :anchor_match_whole_word
42
+
43
+ #
44
+ attr_accessor :anchor_match_whole_word_metadata
45
+
46
+ # Anchor text information for a radio button.
47
+ attr_accessor :anchor_string
48
+
49
+ #
50
+ attr_accessor :anchor_string_metadata
51
+
52
+ #
53
+ attr_accessor :anchor_tab_processor_version
54
+
55
+ #
56
+ attr_accessor :anchor_tab_processor_version_metadata
57
+
58
+ # Specifies units of the X and Y offset. Units could be pixels, millimeters, centimeters, or inches.
59
+ attr_accessor :anchor_units
60
+
61
+ #
62
+ attr_accessor :anchor_units_metadata
63
+
64
+ # Specifies the X axis location of the tab, in anchorUnits, relative to the anchorString.
65
+ attr_accessor :anchor_x_offset
66
+
67
+ #
68
+ attr_accessor :anchor_x_offset_metadata
69
+
70
+ # Specifies the Y axis location of the tab, in anchorUnits, relative to the anchorString.
71
+ attr_accessor :anchor_y_offset
72
+
73
+ #
74
+ attr_accessor :anchor_y_offset_metadata
75
+
76
+ # When set to **true**, the information in the tab is bold.
77
+ attr_accessor :bold
78
+
79
+ #
80
+ attr_accessor :bold_metadata
81
+
82
+ #
83
+ attr_accessor :caption
84
+
85
+ #
86
+ attr_accessor :caption_metadata
87
+
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.
89
+ attr_accessor :conceal_value_on_document
90
+
91
+ #
92
+ attr_accessor :conceal_value_on_document_metadata
93
+
94
+ # For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility.
95
+ attr_accessor :conditional_parent_label
96
+
97
+ #
98
+ attr_accessor :conditional_parent_label_metadata
99
+
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.
101
+ attr_accessor :conditional_parent_value
102
+
103
+ #
104
+ attr_accessor :conditional_parent_value_metadata
105
+
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.
107
+ attr_accessor :custom_tab_id
108
+
109
+ #
110
+ attr_accessor :custom_tab_id_metadata
111
+
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.
113
+ attr_accessor :disable_auto_size
114
+
115
+ #
116
+ attr_accessor :disable_auto_size_metadata
117
+
118
+ # Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute.
119
+ attr_accessor :document_id
120
+
121
+ #
122
+ attr_accessor :document_id_metadata
123
+
124
+ # Array or errors.
125
+ attr_accessor :error_details
126
+
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.
128
+ attr_accessor :font
129
+
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.
131
+ attr_accessor :font_color
132
+
133
+ #
134
+ attr_accessor :font_color_metadata
135
+
136
+ #
137
+ attr_accessor :font_metadata
138
+
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.
140
+ attr_accessor :font_size
141
+
142
+ #
143
+ attr_accessor :font_size_metadata
144
+
145
+ #
146
+ attr_accessor :form_order
147
+
148
+ #
149
+ attr_accessor :form_order_metadata
150
+
151
+ #
152
+ attr_accessor :form_page_label
153
+
154
+ #
155
+ attr_accessor :form_page_label_metadata
156
+
157
+ #
158
+ attr_accessor :form_page_number
159
+
160
+ #
161
+ attr_accessor :form_page_number_metadata
162
+
163
+ # Height of the tab in pixels.
164
+ attr_accessor :height
165
+
166
+ #
167
+ attr_accessor :height_metadata
168
+
169
+ # When set to **true**, the information in the tab is italic.
170
+ attr_accessor :italic
171
+
172
+ #
173
+ attr_accessor :italic_metadata
174
+
175
+ #
176
+ attr_accessor :locale_policy
177
+
178
+ # When set to **true**, the signer cannot change the data of the custom tab.
179
+ attr_accessor :locked
180
+
181
+ #
182
+ attr_accessor :locked_metadata
183
+
184
+ # An optional value that describes the maximum length of the property when the property is a string.
185
+ attr_accessor :max_length
186
+
187
+ #
188
+ attr_accessor :max_length_metadata
189
+
190
+ #
191
+ attr_accessor :max_numerical_value
192
+
193
+ #
194
+ attr_accessor :merge_field
195
+
196
+ #
197
+ attr_accessor :merge_field_xml
198
+
199
+ #
200
+ attr_accessor :min_numerical_value
201
+
202
+ #
203
+ attr_accessor :name
204
+
205
+ #
206
+ attr_accessor :name_metadata
207
+
208
+ #
209
+ attr_accessor :numerical_value
210
+
211
+ #
212
+ attr_accessor :original_numerical_value
213
+
214
+ # The initial value of the tab when it was sent to the recipient.
215
+ attr_accessor :original_value
216
+
217
+ #
218
+ attr_accessor :original_value_metadata
219
+
220
+ # Specifies the page number on which the tab is located.
221
+ attr_accessor :page_number
222
+
223
+ #
224
+ attr_accessor :page_number_metadata
225
+
226
+ # Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document.
227
+ attr_accessor :recipient_id
228
+
229
+ #
230
+ attr_accessor :recipient_id_guid
231
+
232
+ #
233
+ attr_accessor :recipient_id_guid_metadata
234
+
235
+ #
236
+ attr_accessor :recipient_id_metadata
237
+
238
+ # When set to **true** and shared is true, information must be entered in this field to complete the envelope.
239
+ attr_accessor :require_all
240
+
241
+ #
242
+ attr_accessor :require_all_metadata
243
+
244
+ # When set to **true**, the signer is required to fill out this tab
245
+ attr_accessor :required
246
+
247
+ #
248
+ attr_accessor :required_metadata
249
+
250
+ # Optional element for field markup. When set to **true**, the signer is required to initial when they modify a shared field.
251
+ attr_accessor :require_initial_on_shared_change
252
+
253
+ #
254
+ attr_accessor :require_initial_on_shared_change_metadata
255
+
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.
257
+ attr_accessor :sender_required
258
+
259
+ #
260
+ attr_accessor :sender_required_metadata
261
+
262
+ # When set to **true**, this custom tab is shared.
263
+ attr_accessor :shared
264
+
265
+ #
266
+ attr_accessor :shared_metadata
267
+
268
+ #
269
+ attr_accessor :share_to_recipients
270
+
271
+ #
272
+ attr_accessor :share_to_recipients_metadata
273
+
274
+ #
275
+ attr_accessor :smart_contract_information
276
+
277
+ #
278
+ attr_accessor :source
279
+
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.
281
+ attr_accessor :status
282
+
283
+ #
284
+ attr_accessor :status_metadata
285
+
286
+ #
287
+ attr_accessor :tab_group_labels
288
+
289
+ #
290
+ attr_accessor :tab_group_labels_metadata
291
+
292
+ # The unique identifier for the tab. The tabid can be retrieved with the [ML:GET call].
293
+ attr_accessor :tab_id
294
+
295
+ #
296
+ attr_accessor :tab_id_metadata
297
+
298
+ # The label string associated with the tab.
299
+ attr_accessor :tab_label
300
+
301
+ #
302
+ attr_accessor :tab_label_metadata
303
+
304
+ #
305
+ attr_accessor :tab_order
306
+
307
+ #
308
+ attr_accessor :tab_order_metadata
309
+
310
+ #
311
+ attr_accessor :tab_type
312
+
313
+ #
314
+ attr_accessor :tab_type_metadata
315
+
316
+ # When set to **true**, the sender cannot change any attributes of the recipient. Used only when working with template recipients.
317
+ attr_accessor :template_locked
318
+
319
+ #
320
+ attr_accessor :template_locked_metadata
321
+
322
+ # When set to **true**, the sender may not remove the recipient. Used only when working with template recipients.
323
+ attr_accessor :template_required
324
+
325
+ #
326
+ attr_accessor :template_required_metadata
327
+
328
+ #
329
+ attr_accessor :tooltip
330
+
331
+ #
332
+ attr_accessor :tool_tip_metadata
333
+
334
+ # When set to **true**, the information in the tab is underlined.
335
+ attr_accessor :underline
336
+
337
+ #
338
+ attr_accessor :underline_metadata
339
+
340
+ #
341
+ attr_accessor :validation_type
342
+
343
+ # Specifies the value of the tab.
344
+ attr_accessor :value
345
+
346
+ #
347
+ attr_accessor :value_metadata
348
+
349
+ # Width of the tab in pixels.
350
+ attr_accessor :width
351
+
352
+ #
353
+ attr_accessor :width_metadata
354
+
355
+ # This indicates the horizontal offset of the object on the page. DocuSign uses 72 DPI when determining position.
356
+ attr_accessor :x_position
357
+
358
+ #
359
+ attr_accessor :x_position_metadata
360
+
361
+ # This indicates the vertical offset of the object on the page. DocuSign uses 72 DPI when determining position.
362
+ attr_accessor :y_position
363
+
364
+ #
365
+ attr_accessor :y_position_metadata
366
+
367
+ # Attribute mapping from ruby-style variable name to JSON key.
368
+ def self.attribute_map
369
+ {
370
+ :'anchor_allow_white_space_in_characters' => :'anchorAllowWhiteSpaceInCharacters',
371
+ :'anchor_allow_white_space_in_characters_metadata' => :'anchorAllowWhiteSpaceInCharactersMetadata',
372
+ :'anchor_case_sensitive' => :'anchorCaseSensitive',
373
+ :'anchor_case_sensitive_metadata' => :'anchorCaseSensitiveMetadata',
374
+ :'anchor_horizontal_alignment' => :'anchorHorizontalAlignment',
375
+ :'anchor_horizontal_alignment_metadata' => :'anchorHorizontalAlignmentMetadata',
376
+ :'anchor_ignore_if_not_present' => :'anchorIgnoreIfNotPresent',
377
+ :'anchor_ignore_if_not_present_metadata' => :'anchorIgnoreIfNotPresentMetadata',
378
+ :'anchor_match_whole_word' => :'anchorMatchWholeWord',
379
+ :'anchor_match_whole_word_metadata' => :'anchorMatchWholeWordMetadata',
380
+ :'anchor_string' => :'anchorString',
381
+ :'anchor_string_metadata' => :'anchorStringMetadata',
382
+ :'anchor_tab_processor_version' => :'anchorTabProcessorVersion',
383
+ :'anchor_tab_processor_version_metadata' => :'anchorTabProcessorVersionMetadata',
384
+ :'anchor_units' => :'anchorUnits',
385
+ :'anchor_units_metadata' => :'anchorUnitsMetadata',
386
+ :'anchor_x_offset' => :'anchorXOffset',
387
+ :'anchor_x_offset_metadata' => :'anchorXOffsetMetadata',
388
+ :'anchor_y_offset' => :'anchorYOffset',
389
+ :'anchor_y_offset_metadata' => :'anchorYOffsetMetadata',
390
+ :'bold' => :'bold',
391
+ :'bold_metadata' => :'boldMetadata',
392
+ :'caption' => :'caption',
393
+ :'caption_metadata' => :'captionMetadata',
394
+ :'conceal_value_on_document' => :'concealValueOnDocument',
395
+ :'conceal_value_on_document_metadata' => :'concealValueOnDocumentMetadata',
396
+ :'conditional_parent_label' => :'conditionalParentLabel',
397
+ :'conditional_parent_label_metadata' => :'conditionalParentLabelMetadata',
398
+ :'conditional_parent_value' => :'conditionalParentValue',
399
+ :'conditional_parent_value_metadata' => :'conditionalParentValueMetadata',
400
+ :'custom_tab_id' => :'customTabId',
401
+ :'custom_tab_id_metadata' => :'customTabIdMetadata',
402
+ :'disable_auto_size' => :'disableAutoSize',
403
+ :'disable_auto_size_metadata' => :'disableAutoSizeMetadata',
404
+ :'document_id' => :'documentId',
405
+ :'document_id_metadata' => :'documentIdMetadata',
406
+ :'error_details' => :'errorDetails',
407
+ :'font' => :'font',
408
+ :'font_color' => :'fontColor',
409
+ :'font_color_metadata' => :'fontColorMetadata',
410
+ :'font_metadata' => :'fontMetadata',
411
+ :'font_size' => :'fontSize',
412
+ :'font_size_metadata' => :'fontSizeMetadata',
413
+ :'form_order' => :'formOrder',
414
+ :'form_order_metadata' => :'formOrderMetadata',
415
+ :'form_page_label' => :'formPageLabel',
416
+ :'form_page_label_metadata' => :'formPageLabelMetadata',
417
+ :'form_page_number' => :'formPageNumber',
418
+ :'form_page_number_metadata' => :'formPageNumberMetadata',
419
+ :'height' => :'height',
420
+ :'height_metadata' => :'heightMetadata',
421
+ :'italic' => :'italic',
422
+ :'italic_metadata' => :'italicMetadata',
423
+ :'locale_policy' => :'localePolicy',
424
+ :'locked' => :'locked',
425
+ :'locked_metadata' => :'lockedMetadata',
426
+ :'max_length' => :'maxLength',
427
+ :'max_length_metadata' => :'maxLengthMetadata',
428
+ :'max_numerical_value' => :'maxNumericalValue',
429
+ :'merge_field' => :'mergeField',
430
+ :'merge_field_xml' => :'mergeFieldXml',
431
+ :'min_numerical_value' => :'minNumericalValue',
432
+ :'name' => :'name',
433
+ :'name_metadata' => :'nameMetadata',
434
+ :'numerical_value' => :'numericalValue',
435
+ :'original_numerical_value' => :'originalNumericalValue',
436
+ :'original_value' => :'originalValue',
437
+ :'original_value_metadata' => :'originalValueMetadata',
438
+ :'page_number' => :'pageNumber',
439
+ :'page_number_metadata' => :'pageNumberMetadata',
440
+ :'recipient_id' => :'recipientId',
441
+ :'recipient_id_guid' => :'recipientIdGuid',
442
+ :'recipient_id_guid_metadata' => :'recipientIdGuidMetadata',
443
+ :'recipient_id_metadata' => :'recipientIdMetadata',
444
+ :'require_all' => :'requireAll',
445
+ :'require_all_metadata' => :'requireAllMetadata',
446
+ :'required' => :'required',
447
+ :'required_metadata' => :'requiredMetadata',
448
+ :'require_initial_on_shared_change' => :'requireInitialOnSharedChange',
449
+ :'require_initial_on_shared_change_metadata' => :'requireInitialOnSharedChangeMetadata',
450
+ :'sender_required' => :'senderRequired',
451
+ :'sender_required_metadata' => :'senderRequiredMetadata',
452
+ :'shared' => :'shared',
453
+ :'shared_metadata' => :'sharedMetadata',
454
+ :'share_to_recipients' => :'shareToRecipients',
455
+ :'share_to_recipients_metadata' => :'shareToRecipientsMetadata',
456
+ :'smart_contract_information' => :'smartContractInformation',
457
+ :'source' => :'source',
458
+ :'status' => :'status',
459
+ :'status_metadata' => :'statusMetadata',
460
+ :'tab_group_labels' => :'tabGroupLabels',
461
+ :'tab_group_labels_metadata' => :'tabGroupLabelsMetadata',
462
+ :'tab_id' => :'tabId',
463
+ :'tab_id_metadata' => :'tabIdMetadata',
464
+ :'tab_label' => :'tabLabel',
465
+ :'tab_label_metadata' => :'tabLabelMetadata',
466
+ :'tab_order' => :'tabOrder',
467
+ :'tab_order_metadata' => :'tabOrderMetadata',
468
+ :'tab_type' => :'tabType',
469
+ :'tab_type_metadata' => :'tabTypeMetadata',
470
+ :'template_locked' => :'templateLocked',
471
+ :'template_locked_metadata' => :'templateLockedMetadata',
472
+ :'template_required' => :'templateRequired',
473
+ :'template_required_metadata' => :'templateRequiredMetadata',
474
+ :'tooltip' => :'tooltip',
475
+ :'tool_tip_metadata' => :'toolTipMetadata',
476
+ :'underline' => :'underline',
477
+ :'underline_metadata' => :'underlineMetadata',
478
+ :'validation_type' => :'validationType',
479
+ :'value' => :'value',
480
+ :'value_metadata' => :'valueMetadata',
481
+ :'width' => :'width',
482
+ :'width_metadata' => :'widthMetadata',
483
+ :'x_position' => :'xPosition',
484
+ :'x_position_metadata' => :'xPositionMetadata',
485
+ :'y_position' => :'yPosition',
486
+ :'y_position_metadata' => :'yPositionMetadata'
487
+ }
488
+ end
489
+
490
+ # Attribute type mapping.
491
+ def self.swagger_types
492
+ {
493
+ :'anchor_allow_white_space_in_characters' => :'String',
494
+ :'anchor_allow_white_space_in_characters_metadata' => :'PropertyMetadata',
495
+ :'anchor_case_sensitive' => :'String',
496
+ :'anchor_case_sensitive_metadata' => :'PropertyMetadata',
497
+ :'anchor_horizontal_alignment' => :'String',
498
+ :'anchor_horizontal_alignment_metadata' => :'PropertyMetadata',
499
+ :'anchor_ignore_if_not_present' => :'String',
500
+ :'anchor_ignore_if_not_present_metadata' => :'PropertyMetadata',
501
+ :'anchor_match_whole_word' => :'String',
502
+ :'anchor_match_whole_word_metadata' => :'PropertyMetadata',
503
+ :'anchor_string' => :'String',
504
+ :'anchor_string_metadata' => :'PropertyMetadata',
505
+ :'anchor_tab_processor_version' => :'String',
506
+ :'anchor_tab_processor_version_metadata' => :'PropertyMetadata',
507
+ :'anchor_units' => :'String',
508
+ :'anchor_units_metadata' => :'PropertyMetadata',
509
+ :'anchor_x_offset' => :'String',
510
+ :'anchor_x_offset_metadata' => :'PropertyMetadata',
511
+ :'anchor_y_offset' => :'String',
512
+ :'anchor_y_offset_metadata' => :'PropertyMetadata',
513
+ :'bold' => :'String',
514
+ :'bold_metadata' => :'PropertyMetadata',
515
+ :'caption' => :'String',
516
+ :'caption_metadata' => :'PropertyMetadata',
517
+ :'conceal_value_on_document' => :'String',
518
+ :'conceal_value_on_document_metadata' => :'PropertyMetadata',
519
+ :'conditional_parent_label' => :'String',
520
+ :'conditional_parent_label_metadata' => :'PropertyMetadata',
521
+ :'conditional_parent_value' => :'String',
522
+ :'conditional_parent_value_metadata' => :'PropertyMetadata',
523
+ :'custom_tab_id' => :'String',
524
+ :'custom_tab_id_metadata' => :'PropertyMetadata',
525
+ :'disable_auto_size' => :'String',
526
+ :'disable_auto_size_metadata' => :'PropertyMetadata',
527
+ :'document_id' => :'String',
528
+ :'document_id_metadata' => :'PropertyMetadata',
529
+ :'error_details' => :'ErrorDetails',
530
+ :'font' => :'String',
531
+ :'font_color' => :'String',
532
+ :'font_color_metadata' => :'PropertyMetadata',
533
+ :'font_metadata' => :'PropertyMetadata',
534
+ :'font_size' => :'String',
535
+ :'font_size_metadata' => :'PropertyMetadata',
536
+ :'form_order' => :'String',
537
+ :'form_order_metadata' => :'PropertyMetadata',
538
+ :'form_page_label' => :'String',
539
+ :'form_page_label_metadata' => :'PropertyMetadata',
540
+ :'form_page_number' => :'String',
541
+ :'form_page_number_metadata' => :'PropertyMetadata',
542
+ :'height' => :'String',
543
+ :'height_metadata' => :'PropertyMetadata',
544
+ :'italic' => :'String',
545
+ :'italic_metadata' => :'PropertyMetadata',
546
+ :'locale_policy' => :'LocalePolicyTab',
547
+ :'locked' => :'String',
548
+ :'locked_metadata' => :'PropertyMetadata',
549
+ :'max_length' => :'String',
550
+ :'max_length_metadata' => :'PropertyMetadata',
551
+ :'max_numerical_value' => :'String',
552
+ :'merge_field' => :'MergeField',
553
+ :'merge_field_xml' => :'String',
554
+ :'min_numerical_value' => :'String',
555
+ :'name' => :'String',
556
+ :'name_metadata' => :'PropertyMetadata',
557
+ :'numerical_value' => :'String',
558
+ :'original_numerical_value' => :'String',
559
+ :'original_value' => :'String',
560
+ :'original_value_metadata' => :'PropertyMetadata',
561
+ :'page_number' => :'String',
562
+ :'page_number_metadata' => :'PropertyMetadata',
563
+ :'recipient_id' => :'String',
564
+ :'recipient_id_guid' => :'String',
565
+ :'recipient_id_guid_metadata' => :'PropertyMetadata',
566
+ :'recipient_id_metadata' => :'PropertyMetadata',
567
+ :'require_all' => :'String',
568
+ :'require_all_metadata' => :'PropertyMetadata',
569
+ :'required' => :'String',
570
+ :'required_metadata' => :'PropertyMetadata',
571
+ :'require_initial_on_shared_change' => :'String',
572
+ :'require_initial_on_shared_change_metadata' => :'PropertyMetadata',
573
+ :'sender_required' => :'String',
574
+ :'sender_required_metadata' => :'PropertyMetadata',
575
+ :'shared' => :'String',
576
+ :'shared_metadata' => :'PropertyMetadata',
577
+ :'share_to_recipients' => :'String',
578
+ :'share_to_recipients_metadata' => :'PropertyMetadata',
579
+ :'smart_contract_information' => :'SmartContractInformation',
580
+ :'source' => :'String',
581
+ :'status' => :'String',
582
+ :'status_metadata' => :'PropertyMetadata',
583
+ :'tab_group_labels' => :'Array<String>',
584
+ :'tab_group_labels_metadata' => :'PropertyMetadata',
585
+ :'tab_id' => :'String',
586
+ :'tab_id_metadata' => :'PropertyMetadata',
587
+ :'tab_label' => :'String',
588
+ :'tab_label_metadata' => :'PropertyMetadata',
589
+ :'tab_order' => :'String',
590
+ :'tab_order_metadata' => :'PropertyMetadata',
591
+ :'tab_type' => :'String',
592
+ :'tab_type_metadata' => :'PropertyMetadata',
593
+ :'template_locked' => :'String',
594
+ :'template_locked_metadata' => :'PropertyMetadata',
595
+ :'template_required' => :'String',
596
+ :'template_required_metadata' => :'PropertyMetadata',
597
+ :'tooltip' => :'String',
598
+ :'tool_tip_metadata' => :'PropertyMetadata',
599
+ :'underline' => :'String',
600
+ :'underline_metadata' => :'PropertyMetadata',
601
+ :'validation_type' => :'String',
602
+ :'value' => :'String',
603
+ :'value_metadata' => :'PropertyMetadata',
604
+ :'width' => :'String',
605
+ :'width_metadata' => :'PropertyMetadata',
606
+ :'x_position' => :'String',
607
+ :'x_position_metadata' => :'PropertyMetadata',
608
+ :'y_position' => :'String',
609
+ :'y_position_metadata' => :'PropertyMetadata'
610
+ }
611
+ end
612
+
613
+ # Initializes the object
614
+ # @param [Hash] attributes Model attributes in the form of hash
615
+ def initialize(attributes = {})
616
+ return unless attributes.is_a?(Hash)
617
+
618
+ # convert string to symbol for hash key
619
+ attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }
620
+
621
+ if attributes.has_key?(:'anchorAllowWhiteSpaceInCharacters')
622
+ self.anchor_allow_white_space_in_characters = attributes[:'anchorAllowWhiteSpaceInCharacters']
623
+ end
624
+
625
+ if attributes.has_key?(:'anchorAllowWhiteSpaceInCharactersMetadata')
626
+ self.anchor_allow_white_space_in_characters_metadata = attributes[:'anchorAllowWhiteSpaceInCharactersMetadata']
627
+ end
628
+
629
+ if attributes.has_key?(:'anchorCaseSensitive')
630
+ self.anchor_case_sensitive = attributes[:'anchorCaseSensitive']
631
+ end
632
+
633
+ if attributes.has_key?(:'anchorCaseSensitiveMetadata')
634
+ self.anchor_case_sensitive_metadata = attributes[:'anchorCaseSensitiveMetadata']
635
+ end
636
+
637
+ if attributes.has_key?(:'anchorHorizontalAlignment')
638
+ self.anchor_horizontal_alignment = attributes[:'anchorHorizontalAlignment']
639
+ end
640
+
641
+ if attributes.has_key?(:'anchorHorizontalAlignmentMetadata')
642
+ self.anchor_horizontal_alignment_metadata = attributes[:'anchorHorizontalAlignmentMetadata']
643
+ end
644
+
645
+ if attributes.has_key?(:'anchorIgnoreIfNotPresent')
646
+ self.anchor_ignore_if_not_present = attributes[:'anchorIgnoreIfNotPresent']
647
+ end
648
+
649
+ if attributes.has_key?(:'anchorIgnoreIfNotPresentMetadata')
650
+ self.anchor_ignore_if_not_present_metadata = attributes[:'anchorIgnoreIfNotPresentMetadata']
651
+ end
652
+
653
+ if attributes.has_key?(:'anchorMatchWholeWord')
654
+ self.anchor_match_whole_word = attributes[:'anchorMatchWholeWord']
655
+ end
656
+
657
+ if attributes.has_key?(:'anchorMatchWholeWordMetadata')
658
+ self.anchor_match_whole_word_metadata = attributes[:'anchorMatchWholeWordMetadata']
659
+ end
660
+
661
+ if attributes.has_key?(:'anchorString')
662
+ self.anchor_string = attributes[:'anchorString']
663
+ end
664
+
665
+ if attributes.has_key?(:'anchorStringMetadata')
666
+ self.anchor_string_metadata = attributes[:'anchorStringMetadata']
667
+ end
668
+
669
+ if attributes.has_key?(:'anchorTabProcessorVersion')
670
+ self.anchor_tab_processor_version = attributes[:'anchorTabProcessorVersion']
671
+ end
672
+
673
+ if attributes.has_key?(:'anchorTabProcessorVersionMetadata')
674
+ self.anchor_tab_processor_version_metadata = attributes[:'anchorTabProcessorVersionMetadata']
675
+ end
676
+
677
+ if attributes.has_key?(:'anchorUnits')
678
+ self.anchor_units = attributes[:'anchorUnits']
679
+ end
680
+
681
+ if attributes.has_key?(:'anchorUnitsMetadata')
682
+ self.anchor_units_metadata = attributes[:'anchorUnitsMetadata']
683
+ end
684
+
685
+ if attributes.has_key?(:'anchorXOffset')
686
+ self.anchor_x_offset = attributes[:'anchorXOffset']
687
+ end
688
+
689
+ if attributes.has_key?(:'anchorXOffsetMetadata')
690
+ self.anchor_x_offset_metadata = attributes[:'anchorXOffsetMetadata']
691
+ end
692
+
693
+ if attributes.has_key?(:'anchorYOffset')
694
+ self.anchor_y_offset = attributes[:'anchorYOffset']
695
+ end
696
+
697
+ if attributes.has_key?(:'anchorYOffsetMetadata')
698
+ self.anchor_y_offset_metadata = attributes[:'anchorYOffsetMetadata']
699
+ end
700
+
701
+ if attributes.has_key?(:'bold')
702
+ self.bold = attributes[:'bold']
703
+ end
704
+
705
+ if attributes.has_key?(:'boldMetadata')
706
+ self.bold_metadata = attributes[:'boldMetadata']
707
+ end
708
+
709
+ if attributes.has_key?(:'caption')
710
+ self.caption = attributes[:'caption']
711
+ end
712
+
713
+ if attributes.has_key?(:'captionMetadata')
714
+ self.caption_metadata = attributes[:'captionMetadata']
715
+ end
716
+
717
+ if attributes.has_key?(:'concealValueOnDocument')
718
+ self.conceal_value_on_document = attributes[:'concealValueOnDocument']
719
+ end
720
+
721
+ if attributes.has_key?(:'concealValueOnDocumentMetadata')
722
+ self.conceal_value_on_document_metadata = attributes[:'concealValueOnDocumentMetadata']
723
+ end
724
+
725
+ if attributes.has_key?(:'conditionalParentLabel')
726
+ self.conditional_parent_label = attributes[:'conditionalParentLabel']
727
+ end
728
+
729
+ if attributes.has_key?(:'conditionalParentLabelMetadata')
730
+ self.conditional_parent_label_metadata = attributes[:'conditionalParentLabelMetadata']
731
+ end
732
+
733
+ if attributes.has_key?(:'conditionalParentValue')
734
+ self.conditional_parent_value = attributes[:'conditionalParentValue']
735
+ end
736
+
737
+ if attributes.has_key?(:'conditionalParentValueMetadata')
738
+ self.conditional_parent_value_metadata = attributes[:'conditionalParentValueMetadata']
739
+ end
740
+
741
+ if attributes.has_key?(:'customTabId')
742
+ self.custom_tab_id = attributes[:'customTabId']
743
+ end
744
+
745
+ if attributes.has_key?(:'customTabIdMetadata')
746
+ self.custom_tab_id_metadata = attributes[:'customTabIdMetadata']
747
+ end
748
+
749
+ if attributes.has_key?(:'disableAutoSize')
750
+ self.disable_auto_size = attributes[:'disableAutoSize']
751
+ end
752
+
753
+ if attributes.has_key?(:'disableAutoSizeMetadata')
754
+ self.disable_auto_size_metadata = attributes[:'disableAutoSizeMetadata']
755
+ end
756
+
757
+ if attributes.has_key?(:'documentId')
758
+ self.document_id = attributes[:'documentId']
759
+ end
760
+
761
+ if attributes.has_key?(:'documentIdMetadata')
762
+ self.document_id_metadata = attributes[:'documentIdMetadata']
763
+ end
764
+
765
+ if attributes.has_key?(:'errorDetails')
766
+ self.error_details = attributes[:'errorDetails']
767
+ end
768
+
769
+ if attributes.has_key?(:'font')
770
+ self.font = attributes[:'font']
771
+ end
772
+
773
+ if attributes.has_key?(:'fontColor')
774
+ self.font_color = attributes[:'fontColor']
775
+ end
776
+
777
+ if attributes.has_key?(:'fontColorMetadata')
778
+ self.font_color_metadata = attributes[:'fontColorMetadata']
779
+ end
780
+
781
+ if attributes.has_key?(:'fontMetadata')
782
+ self.font_metadata = attributes[:'fontMetadata']
783
+ end
784
+
785
+ if attributes.has_key?(:'fontSize')
786
+ self.font_size = attributes[:'fontSize']
787
+ end
788
+
789
+ if attributes.has_key?(:'fontSizeMetadata')
790
+ self.font_size_metadata = attributes[:'fontSizeMetadata']
791
+ end
792
+
793
+ if attributes.has_key?(:'formOrder')
794
+ self.form_order = attributes[:'formOrder']
795
+ end
796
+
797
+ if attributes.has_key?(:'formOrderMetadata')
798
+ self.form_order_metadata = attributes[:'formOrderMetadata']
799
+ end
800
+
801
+ if attributes.has_key?(:'formPageLabel')
802
+ self.form_page_label = attributes[:'formPageLabel']
803
+ end
804
+
805
+ if attributes.has_key?(:'formPageLabelMetadata')
806
+ self.form_page_label_metadata = attributes[:'formPageLabelMetadata']
807
+ end
808
+
809
+ if attributes.has_key?(:'formPageNumber')
810
+ self.form_page_number = attributes[:'formPageNumber']
811
+ end
812
+
813
+ if attributes.has_key?(:'formPageNumberMetadata')
814
+ self.form_page_number_metadata = attributes[:'formPageNumberMetadata']
815
+ end
816
+
817
+ if attributes.has_key?(:'height')
818
+ self.height = attributes[:'height']
819
+ end
820
+
821
+ if attributes.has_key?(:'heightMetadata')
822
+ self.height_metadata = attributes[:'heightMetadata']
823
+ end
824
+
825
+ if attributes.has_key?(:'italic')
826
+ self.italic = attributes[:'italic']
827
+ end
828
+
829
+ if attributes.has_key?(:'italicMetadata')
830
+ self.italic_metadata = attributes[:'italicMetadata']
831
+ end
832
+
833
+ if attributes.has_key?(:'localePolicy')
834
+ self.locale_policy = attributes[:'localePolicy']
835
+ end
836
+
837
+ if attributes.has_key?(:'locked')
838
+ self.locked = attributes[:'locked']
839
+ end
840
+
841
+ if attributes.has_key?(:'lockedMetadata')
842
+ self.locked_metadata = attributes[:'lockedMetadata']
843
+ end
844
+
845
+ if attributes.has_key?(:'maxLength')
846
+ self.max_length = attributes[:'maxLength']
847
+ end
848
+
849
+ if attributes.has_key?(:'maxLengthMetadata')
850
+ self.max_length_metadata = attributes[:'maxLengthMetadata']
851
+ end
852
+
853
+ if attributes.has_key?(:'maxNumericalValue')
854
+ self.max_numerical_value = attributes[:'maxNumericalValue']
855
+ end
856
+
857
+ if attributes.has_key?(:'mergeField')
858
+ self.merge_field = attributes[:'mergeField']
859
+ end
860
+
861
+ if attributes.has_key?(:'mergeFieldXml')
862
+ self.merge_field_xml = attributes[:'mergeFieldXml']
863
+ end
864
+
865
+ if attributes.has_key?(:'minNumericalValue')
866
+ self.min_numerical_value = attributes[:'minNumericalValue']
867
+ end
868
+
869
+ if attributes.has_key?(:'name')
870
+ self.name = attributes[:'name']
871
+ end
872
+
873
+ if attributes.has_key?(:'nameMetadata')
874
+ self.name_metadata = attributes[:'nameMetadata']
875
+ end
876
+
877
+ if attributes.has_key?(:'numericalValue')
878
+ self.numerical_value = attributes[:'numericalValue']
879
+ end
880
+
881
+ if attributes.has_key?(:'originalNumericalValue')
882
+ self.original_numerical_value = attributes[:'originalNumericalValue']
883
+ end
884
+
885
+ if attributes.has_key?(:'originalValue')
886
+ self.original_value = attributes[:'originalValue']
887
+ end
888
+
889
+ if attributes.has_key?(:'originalValueMetadata')
890
+ self.original_value_metadata = attributes[:'originalValueMetadata']
891
+ end
892
+
893
+ if attributes.has_key?(:'pageNumber')
894
+ self.page_number = attributes[:'pageNumber']
895
+ end
896
+
897
+ if attributes.has_key?(:'pageNumberMetadata')
898
+ self.page_number_metadata = attributes[:'pageNumberMetadata']
899
+ end
900
+
901
+ if attributes.has_key?(:'recipientId')
902
+ self.recipient_id = attributes[:'recipientId']
903
+ end
904
+
905
+ if attributes.has_key?(:'recipientIdGuid')
906
+ self.recipient_id_guid = attributes[:'recipientIdGuid']
907
+ end
908
+
909
+ if attributes.has_key?(:'recipientIdGuidMetadata')
910
+ self.recipient_id_guid_metadata = attributes[:'recipientIdGuidMetadata']
911
+ end
912
+
913
+ if attributes.has_key?(:'recipientIdMetadata')
914
+ self.recipient_id_metadata = attributes[:'recipientIdMetadata']
915
+ end
916
+
917
+ if attributes.has_key?(:'requireAll')
918
+ self.require_all = attributes[:'requireAll']
919
+ end
920
+
921
+ if attributes.has_key?(:'requireAllMetadata')
922
+ self.require_all_metadata = attributes[:'requireAllMetadata']
923
+ end
924
+
925
+ if attributes.has_key?(:'required')
926
+ self.required = attributes[:'required']
927
+ end
928
+
929
+ if attributes.has_key?(:'requiredMetadata')
930
+ self.required_metadata = attributes[:'requiredMetadata']
931
+ end
932
+
933
+ if attributes.has_key?(:'requireInitialOnSharedChange')
934
+ self.require_initial_on_shared_change = attributes[:'requireInitialOnSharedChange']
935
+ end
936
+
937
+ if attributes.has_key?(:'requireInitialOnSharedChangeMetadata')
938
+ self.require_initial_on_shared_change_metadata = attributes[:'requireInitialOnSharedChangeMetadata']
939
+ end
940
+
941
+ if attributes.has_key?(:'senderRequired')
942
+ self.sender_required = attributes[:'senderRequired']
943
+ end
944
+
945
+ if attributes.has_key?(:'senderRequiredMetadata')
946
+ self.sender_required_metadata = attributes[:'senderRequiredMetadata']
947
+ end
948
+
949
+ if attributes.has_key?(:'shared')
950
+ self.shared = attributes[:'shared']
951
+ end
952
+
953
+ if attributes.has_key?(:'sharedMetadata')
954
+ self.shared_metadata = attributes[:'sharedMetadata']
955
+ end
956
+
957
+ if attributes.has_key?(:'shareToRecipients')
958
+ self.share_to_recipients = attributes[:'shareToRecipients']
959
+ end
960
+
961
+ if attributes.has_key?(:'shareToRecipientsMetadata')
962
+ self.share_to_recipients_metadata = attributes[:'shareToRecipientsMetadata']
963
+ end
964
+
965
+ if attributes.has_key?(:'smartContractInformation')
966
+ self.smart_contract_information = attributes[:'smartContractInformation']
967
+ end
968
+
969
+ if attributes.has_key?(:'source')
970
+ self.source = attributes[:'source']
971
+ end
972
+
973
+ if attributes.has_key?(:'status')
974
+ self.status = attributes[:'status']
975
+ end
976
+
977
+ if attributes.has_key?(:'statusMetadata')
978
+ self.status_metadata = attributes[:'statusMetadata']
979
+ end
980
+
981
+ if attributes.has_key?(:'tabGroupLabels')
982
+ if (value = attributes[:'tabGroupLabels']).is_a?(Array)
983
+ self.tab_group_labels = value
984
+ end
985
+ end
986
+
987
+ if attributes.has_key?(:'tabGroupLabelsMetadata')
988
+ self.tab_group_labels_metadata = attributes[:'tabGroupLabelsMetadata']
989
+ end
990
+
991
+ if attributes.has_key?(:'tabId')
992
+ self.tab_id = attributes[:'tabId']
993
+ end
994
+
995
+ if attributes.has_key?(:'tabIdMetadata')
996
+ self.tab_id_metadata = attributes[:'tabIdMetadata']
997
+ end
998
+
999
+ if attributes.has_key?(:'tabLabel')
1000
+ self.tab_label = attributes[:'tabLabel']
1001
+ end
1002
+
1003
+ if attributes.has_key?(:'tabLabelMetadata')
1004
+ self.tab_label_metadata = attributes[:'tabLabelMetadata']
1005
+ end
1006
+
1007
+ if attributes.has_key?(:'tabOrder')
1008
+ self.tab_order = attributes[:'tabOrder']
1009
+ end
1010
+
1011
+ if attributes.has_key?(:'tabOrderMetadata')
1012
+ self.tab_order_metadata = attributes[:'tabOrderMetadata']
1013
+ end
1014
+
1015
+ if attributes.has_key?(:'tabType')
1016
+ self.tab_type = attributes[:'tabType']
1017
+ end
1018
+
1019
+ if attributes.has_key?(:'tabTypeMetadata')
1020
+ self.tab_type_metadata = attributes[:'tabTypeMetadata']
1021
+ end
1022
+
1023
+ if attributes.has_key?(:'templateLocked')
1024
+ self.template_locked = attributes[:'templateLocked']
1025
+ end
1026
+
1027
+ if attributes.has_key?(:'templateLockedMetadata')
1028
+ self.template_locked_metadata = attributes[:'templateLockedMetadata']
1029
+ end
1030
+
1031
+ if attributes.has_key?(:'templateRequired')
1032
+ self.template_required = attributes[:'templateRequired']
1033
+ end
1034
+
1035
+ if attributes.has_key?(:'templateRequiredMetadata')
1036
+ self.template_required_metadata = attributes[:'templateRequiredMetadata']
1037
+ end
1038
+
1039
+ if attributes.has_key?(:'tooltip')
1040
+ self.tooltip = attributes[:'tooltip']
1041
+ end
1042
+
1043
+ if attributes.has_key?(:'toolTipMetadata')
1044
+ self.tool_tip_metadata = attributes[:'toolTipMetadata']
1045
+ end
1046
+
1047
+ if attributes.has_key?(:'underline')
1048
+ self.underline = attributes[:'underline']
1049
+ end
1050
+
1051
+ if attributes.has_key?(:'underlineMetadata')
1052
+ self.underline_metadata = attributes[:'underlineMetadata']
1053
+ end
1054
+
1055
+ if attributes.has_key?(:'validationType')
1056
+ self.validation_type = attributes[:'validationType']
1057
+ end
1058
+
1059
+ if attributes.has_key?(:'value')
1060
+ self.value = attributes[:'value']
1061
+ end
1062
+
1063
+ if attributes.has_key?(:'valueMetadata')
1064
+ self.value_metadata = attributes[:'valueMetadata']
1065
+ end
1066
+
1067
+ if attributes.has_key?(:'width')
1068
+ self.width = attributes[:'width']
1069
+ end
1070
+
1071
+ if attributes.has_key?(:'widthMetadata')
1072
+ self.width_metadata = attributes[:'widthMetadata']
1073
+ end
1074
+
1075
+ if attributes.has_key?(:'xPosition')
1076
+ self.x_position = attributes[:'xPosition']
1077
+ end
1078
+
1079
+ if attributes.has_key?(:'xPositionMetadata')
1080
+ self.x_position_metadata = attributes[:'xPositionMetadata']
1081
+ end
1082
+
1083
+ if attributes.has_key?(:'yPosition')
1084
+ self.y_position = attributes[:'yPosition']
1085
+ end
1086
+
1087
+ if attributes.has_key?(:'yPositionMetadata')
1088
+ self.y_position_metadata = attributes[:'yPositionMetadata']
1089
+ end
1090
+ end
1091
+
1092
+ # Show invalid properties with the reasons. Usually used together with valid?
1093
+ # @return Array for valid properties with the reasons
1094
+ def list_invalid_properties
1095
+ invalid_properties = Array.new
1096
+ invalid_properties
1097
+ end
1098
+
1099
+ # Check to see if the all the properties in the model are valid
1100
+ # @return true if the model is valid
1101
+ def valid?
1102
+ true
1103
+ end
1104
+
1105
+ # Checks equality by comparing each attribute.
1106
+ # @param [Object] Object to be compared
1107
+ def ==(o)
1108
+ return true if self.equal?(o)
1109
+ self.class == o.class &&
1110
+ anchor_allow_white_space_in_characters == o.anchor_allow_white_space_in_characters &&
1111
+ anchor_allow_white_space_in_characters_metadata == o.anchor_allow_white_space_in_characters_metadata &&
1112
+ anchor_case_sensitive == o.anchor_case_sensitive &&
1113
+ anchor_case_sensitive_metadata == o.anchor_case_sensitive_metadata &&
1114
+ anchor_horizontal_alignment == o.anchor_horizontal_alignment &&
1115
+ anchor_horizontal_alignment_metadata == o.anchor_horizontal_alignment_metadata &&
1116
+ anchor_ignore_if_not_present == o.anchor_ignore_if_not_present &&
1117
+ anchor_ignore_if_not_present_metadata == o.anchor_ignore_if_not_present_metadata &&
1118
+ anchor_match_whole_word == o.anchor_match_whole_word &&
1119
+ anchor_match_whole_word_metadata == o.anchor_match_whole_word_metadata &&
1120
+ anchor_string == o.anchor_string &&
1121
+ anchor_string_metadata == o.anchor_string_metadata &&
1122
+ anchor_tab_processor_version == o.anchor_tab_processor_version &&
1123
+ anchor_tab_processor_version_metadata == o.anchor_tab_processor_version_metadata &&
1124
+ anchor_units == o.anchor_units &&
1125
+ anchor_units_metadata == o.anchor_units_metadata &&
1126
+ anchor_x_offset == o.anchor_x_offset &&
1127
+ anchor_x_offset_metadata == o.anchor_x_offset_metadata &&
1128
+ anchor_y_offset == o.anchor_y_offset &&
1129
+ anchor_y_offset_metadata == o.anchor_y_offset_metadata &&
1130
+ bold == o.bold &&
1131
+ bold_metadata == o.bold_metadata &&
1132
+ caption == o.caption &&
1133
+ caption_metadata == o.caption_metadata &&
1134
+ conceal_value_on_document == o.conceal_value_on_document &&
1135
+ conceal_value_on_document_metadata == o.conceal_value_on_document_metadata &&
1136
+ conditional_parent_label == o.conditional_parent_label &&
1137
+ conditional_parent_label_metadata == o.conditional_parent_label_metadata &&
1138
+ conditional_parent_value == o.conditional_parent_value &&
1139
+ conditional_parent_value_metadata == o.conditional_parent_value_metadata &&
1140
+ custom_tab_id == o.custom_tab_id &&
1141
+ custom_tab_id_metadata == o.custom_tab_id_metadata &&
1142
+ disable_auto_size == o.disable_auto_size &&
1143
+ disable_auto_size_metadata == o.disable_auto_size_metadata &&
1144
+ document_id == o.document_id &&
1145
+ document_id_metadata == o.document_id_metadata &&
1146
+ error_details == o.error_details &&
1147
+ font == o.font &&
1148
+ font_color == o.font_color &&
1149
+ font_color_metadata == o.font_color_metadata &&
1150
+ font_metadata == o.font_metadata &&
1151
+ font_size == o.font_size &&
1152
+ font_size_metadata == o.font_size_metadata &&
1153
+ form_order == o.form_order &&
1154
+ form_order_metadata == o.form_order_metadata &&
1155
+ form_page_label == o.form_page_label &&
1156
+ form_page_label_metadata == o.form_page_label_metadata &&
1157
+ form_page_number == o.form_page_number &&
1158
+ form_page_number_metadata == o.form_page_number_metadata &&
1159
+ height == o.height &&
1160
+ height_metadata == o.height_metadata &&
1161
+ italic == o.italic &&
1162
+ italic_metadata == o.italic_metadata &&
1163
+ locale_policy == o.locale_policy &&
1164
+ locked == o.locked &&
1165
+ locked_metadata == o.locked_metadata &&
1166
+ max_length == o.max_length &&
1167
+ max_length_metadata == o.max_length_metadata &&
1168
+ max_numerical_value == o.max_numerical_value &&
1169
+ merge_field == o.merge_field &&
1170
+ merge_field_xml == o.merge_field_xml &&
1171
+ min_numerical_value == o.min_numerical_value &&
1172
+ name == o.name &&
1173
+ name_metadata == o.name_metadata &&
1174
+ numerical_value == o.numerical_value &&
1175
+ original_numerical_value == o.original_numerical_value &&
1176
+ original_value == o.original_value &&
1177
+ original_value_metadata == o.original_value_metadata &&
1178
+ page_number == o.page_number &&
1179
+ page_number_metadata == o.page_number_metadata &&
1180
+ recipient_id == o.recipient_id &&
1181
+ recipient_id_guid == o.recipient_id_guid &&
1182
+ recipient_id_guid_metadata == o.recipient_id_guid_metadata &&
1183
+ recipient_id_metadata == o.recipient_id_metadata &&
1184
+ require_all == o.require_all &&
1185
+ require_all_metadata == o.require_all_metadata &&
1186
+ required == o.required &&
1187
+ required_metadata == o.required_metadata &&
1188
+ require_initial_on_shared_change == o.require_initial_on_shared_change &&
1189
+ require_initial_on_shared_change_metadata == o.require_initial_on_shared_change_metadata &&
1190
+ sender_required == o.sender_required &&
1191
+ sender_required_metadata == o.sender_required_metadata &&
1192
+ shared == o.shared &&
1193
+ shared_metadata == o.shared_metadata &&
1194
+ share_to_recipients == o.share_to_recipients &&
1195
+ share_to_recipients_metadata == o.share_to_recipients_metadata &&
1196
+ smart_contract_information == o.smart_contract_information &&
1197
+ source == o.source &&
1198
+ status == o.status &&
1199
+ status_metadata == o.status_metadata &&
1200
+ tab_group_labels == o.tab_group_labels &&
1201
+ tab_group_labels_metadata == o.tab_group_labels_metadata &&
1202
+ tab_id == o.tab_id &&
1203
+ tab_id_metadata == o.tab_id_metadata &&
1204
+ tab_label == o.tab_label &&
1205
+ tab_label_metadata == o.tab_label_metadata &&
1206
+ tab_order == o.tab_order &&
1207
+ tab_order_metadata == o.tab_order_metadata &&
1208
+ tab_type == o.tab_type &&
1209
+ tab_type_metadata == o.tab_type_metadata &&
1210
+ template_locked == o.template_locked &&
1211
+ template_locked_metadata == o.template_locked_metadata &&
1212
+ template_required == o.template_required &&
1213
+ template_required_metadata == o.template_required_metadata &&
1214
+ tooltip == o.tooltip &&
1215
+ tool_tip_metadata == o.tool_tip_metadata &&
1216
+ underline == o.underline &&
1217
+ underline_metadata == o.underline_metadata &&
1218
+ validation_type == o.validation_type &&
1219
+ value == o.value &&
1220
+ value_metadata == o.value_metadata &&
1221
+ width == o.width &&
1222
+ width_metadata == o.width_metadata &&
1223
+ x_position == o.x_position &&
1224
+ x_position_metadata == o.x_position_metadata &&
1225
+ y_position == o.y_position &&
1226
+ y_position_metadata == o.y_position_metadata
1227
+ end
1228
+
1229
+ # @see the `==` method
1230
+ # @param [Object] Object to be compared
1231
+ def eql?(o)
1232
+ self == o
1233
+ end
1234
+
1235
+ # Calculates hash code according to all attributes.
1236
+ # @return [Fixnum] Hash code
1237
+ def 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
1239
+ end
1240
+
1241
+ # Builds the object from hash
1242
+ # @param [Hash] attributes Model attributes in the form of hash
1243
+ # @return [Object] Returns the model itself
1244
+ def build_from_hash(attributes)
1245
+ return nil unless attributes.is_a?(Hash)
1246
+ self.class.swagger_types.each_pair do |key, type|
1247
+ if type =~ /\AArray<(.*)>/i
1248
+ # check to ensure the input is an array given that the attribute
1249
+ # is documented as an array but the input is not
1250
+ if attributes[self.class.attribute_map[key]].is_a?(Array)
1251
+ self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
1252
+ end
1253
+ elsif !attributes[self.class.attribute_map[key]].nil?
1254
+ self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
1255
+ end # or else data not found in attributes(hash), not an issue as the data can be optional
1256
+ end
1257
+
1258
+ self
1259
+ end
1260
+
1261
+ # Deserializes the data based on type
1262
+ # @param string type Data type
1263
+ # @param string value Value to be deserialized
1264
+ # @return [Object] Deserialized data
1265
+ def _deserialize(type, value)
1266
+ case type.to_sym
1267
+ when :DateTime
1268
+ DateTime.parse(value)
1269
+ when :Date
1270
+ Date.parse(value)
1271
+ when :String
1272
+ value.to_s
1273
+ when :Integer
1274
+ value.to_i
1275
+ when :Float
1276
+ value.to_f
1277
+ when :BOOLEAN
1278
+ if value.to_s =~ /\A(true|t|yes|y|1)\z/i
1279
+ true
1280
+ else
1281
+ false
1282
+ end
1283
+ when :Object
1284
+ # generic object (usually a Hash), return directly
1285
+ value
1286
+ when /\AArray<(?<inner_type>.+)>\z/
1287
+ inner_type = Regexp.last_match[:inner_type]
1288
+ value.map { |v| _deserialize(inner_type, v) }
1289
+ when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
1290
+ k_type = Regexp.last_match[:k_type]
1291
+ v_type = Regexp.last_match[:v_type]
1292
+ {}.tap do |hash|
1293
+ value.each do |k, v|
1294
+ hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
1295
+ end
1296
+ end
1297
+ else # model
1298
+ temp_model = DocuSign_eSign.const_get(type).new
1299
+ temp_model.build_from_hash(value)
1300
+ end
1301
+ end
1302
+
1303
+ # Returns the string representation of the object
1304
+ # @return [String] String presentation of the object
1305
+ def to_s
1306
+ to_hash.to_s
1307
+ end
1308
+
1309
+ # to_body is an alias to to_hash (backward compatibility)
1310
+ # @return [Hash] Returns the object in the form of hash
1311
+ def to_body
1312
+ to_hash
1313
+ end
1314
+
1315
+ # Returns the object in the form of hash
1316
+ # @return [Hash] Returns the object in the form of hash
1317
+ def to_hash
1318
+ hash = {}
1319
+ self.class.attribute_map.each_pair do |attr, param|
1320
+ value = self.send(attr)
1321
+ next if value.nil?
1322
+ hash[param] = _to_hash(value)
1323
+ end
1324
+ hash
1325
+ end
1326
+
1327
+ # Outputs non-array value in the form of hash
1328
+ # For object, use to_hash. Otherwise, just return the value
1329
+ # @param [Object] value Any valid value
1330
+ # @return [Hash] Returns the value in the form of hash
1331
+ def _to_hash(value)
1332
+ if value.is_a?(Array)
1333
+ value.compact.map { |v| _to_hash(v) }
1334
+ elsif value.is_a?(Hash)
1335
+ {}.tap do |hash|
1336
+ value.each { |k, v| hash[k] = _to_hash(v) }
1337
+ end
1338
+ elsif value.respond_to? :to_hash
1339
+ value.to_hash
1340
+ else
1341
+ value
1342
+ end
1343
+ end
1344
+
1345
+ end
1346
+ end