dropbox-sign 1.1.2 → 1.4.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/Gemfile.lock +6 -3
- data/README.md +9 -4
- data/VERSION +1 -1
- data/docs/BulkSendJobGetResponseSignatureRequests.md +1 -0
- data/docs/EmbeddedEditUrlRequest.md +1 -1
- data/docs/EventCallbackRequestEvent.md +1 -1
- data/docs/OAuthApi.md +0 -16
- data/docs/SignatureRequestApi.md +11 -10
- data/docs/SignatureRequestBulkCreateEmbeddedWithTemplateRequest.md +1 -1
- data/docs/SignatureRequestBulkSendWithTemplateRequest.md +1 -1
- data/docs/SignatureRequestCreateEmbeddedRequest.md +4 -4
- data/docs/SignatureRequestCreateEmbeddedWithTemplateRequest.md +1 -1
- data/docs/SignatureRequestResponse.md +2 -0
- data/docs/SignatureRequestSendRequest.md +5 -4
- data/docs/SignatureRequestSendWithTemplateRequest.md +2 -1
- data/docs/SignatureRequestUpdateRequest.md +2 -2
- data/docs/SubAttachment.md +1 -1
- data/docs/SubCustomField.md +1 -1
- data/docs/SubFieldOptions.md +1 -1
- data/docs/SubFormFieldsPerDocumentBase.md +2 -2
- data/docs/SubFormFieldsPerDocumentDateSigned.md +2 -0
- data/docs/SubFormFieldsPerDocumentDropdown.md +2 -0
- data/docs/SubFormFieldsPerDocumentFontEnum.md +9 -0
- data/docs/SubFormFieldsPerDocumentHyperlink.md +2 -0
- data/docs/SubFormFieldsPerDocumentText.md +4 -1
- data/docs/SubFormFieldsPerDocumentTextMerge.md +2 -0
- data/docs/SubSignatureRequestGroupedSigners.md +1 -1
- data/docs/SubSignatureRequestSigner.md +1 -1
- data/docs/SubSignatureRequestTemplateSigner.md +1 -1
- data/docs/SubSigningOptions.md +1 -1
- data/docs/SubWhiteLabelingOptions.md +1 -1
- data/docs/TeamAddMemberRequest.md +1 -1
- data/docs/TeamRemoveMemberRequest.md +2 -2
- data/docs/TemplateAddUserRequest.md +2 -2
- data/docs/TemplateApi.md +106 -3
- data/docs/TemplateCreateEmbeddedDraftRequest.md +2 -2
- data/docs/TemplateCreateRequest.md +27 -0
- data/docs/TemplateCreateResponse.md +11 -0
- data/docs/TemplateCreateResponseTemplate.md +10 -0
- data/docs/TemplateResponseDocument.md +1 -1
- data/docs/TemplateResponseDocumentStaticFieldBase.md +1 -1
- data/docs/UnclaimedDraftApi.md +3 -3
- data/docs/UnclaimedDraftCreateEmbeddedRequest.md +4 -4
- data/docs/UnclaimedDraftCreateEmbeddedWithTemplateRequest.md +4 -3
- data/docs/UnclaimedDraftCreateRequest.md +2 -2
- data/examples/OauthTokenGenerate.rb +0 -8
- data/examples/OauthTokenRefresh.rb +0 -8
- data/examples/SignatureRequestEdit.rb +58 -0
- data/examples/SignatureRequestEditEmbedded.rb +48 -0
- data/examples/SignatureRequestEditEmbeddedWithTemplate.rb +41 -0
- data/examples/SignatureRequestEditWithTemplate.rb +52 -0
- data/examples/TemplateCreate.rb +49 -0
- data/lib/dropbox-sign/api/api_app_api.rb +1 -1
- data/lib/dropbox-sign/api/signature_request_api.rb +17 -14
- data/lib/dropbox-sign/api/team_api.rb +1 -1
- data/lib/dropbox-sign/api/template_api.rb +112 -0
- data/lib/dropbox-sign/api/unclaimed_draft_api.rb +6 -6
- data/lib/dropbox-sign/event_callback_helper.rb +1 -1
- data/lib/dropbox-sign/models/bulk_send_job_get_response_signature_requests.rb +13 -1
- data/lib/dropbox-sign/models/embedded_edit_url_request.rb +1 -1
- data/lib/dropbox-sign/models/event_callback_request_event.rb +2 -7
- data/lib/dropbox-sign/models/signature_request_bulk_create_embedded_with_template_request.rb +1 -1
- data/lib/dropbox-sign/models/signature_request_bulk_send_with_template_request.rb +1 -1
- data/lib/dropbox-sign/models/signature_request_create_embedded_request.rb +4 -4
- data/lib/dropbox-sign/models/signature_request_create_embedded_with_template_request.rb +1 -1
- data/lib/dropbox-sign/models/signature_request_response.rb +28 -4
- data/lib/dropbox-sign/models/signature_request_send_request.rb +18 -5
- data/lib/dropbox-sign/models/signature_request_send_with_template_request.rb +15 -2
- data/lib/dropbox-sign/models/signature_request_update_request.rb +2 -2
- data/lib/dropbox-sign/models/sub_attachment.rb +1 -1
- data/lib/dropbox-sign/models/sub_custom_field.rb +1 -1
- data/lib/dropbox-sign/models/sub_field_options.rb +1 -1
- data/lib/dropbox-sign/models/sub_form_fields_per_document_base.rb +2 -2
- data/lib/dropbox-sign/models/sub_form_fields_per_document_date_signed.rb +62 -4
- data/lib/dropbox-sign/models/sub_form_fields_per_document_dropdown.rb +62 -4
- data/lib/dropbox-sign/models/sub_form_fields_per_document_font_enum.rb +54 -0
- data/lib/dropbox-sign/models/sub_form_fields_per_document_hyperlink.rb +62 -4
- data/lib/dropbox-sign/models/sub_form_fields_per_document_text.rb +52 -5
- data/lib/dropbox-sign/models/sub_form_fields_per_document_text_merge.rb +62 -4
- data/lib/dropbox-sign/models/sub_signature_request_grouped_signers.rb +1 -1
- data/lib/dropbox-sign/models/sub_signature_request_signer.rb +1 -1
- data/lib/dropbox-sign/models/sub_signature_request_template_signer.rb +1 -1
- data/lib/dropbox-sign/models/sub_signing_options.rb +1 -1
- data/lib/dropbox-sign/models/sub_white_labeling_options.rb +1 -1
- data/lib/dropbox-sign/models/team_add_member_request.rb +1 -1
- data/lib/dropbox-sign/models/team_remove_member_request.rb +2 -2
- data/lib/dropbox-sign/models/template_add_user_request.rb +2 -2
- data/lib/dropbox-sign/models/template_create_embedded_draft_request.rb +2 -2
- data/lib/dropbox-sign/models/template_create_request.rb +509 -0
- data/lib/dropbox-sign/models/template_create_response.rb +263 -0
- data/lib/dropbox-sign/models/template_create_response_template.rb +252 -0
- data/lib/dropbox-sign/models/template_response_document.rb +1 -1
- data/lib/dropbox-sign/models/template_response_document_static_field_base.rb +1 -1
- data/lib/dropbox-sign/models/unclaimed_draft_create_embedded_request.rb +4 -4
- data/lib/dropbox-sign/models/unclaimed_draft_create_embedded_with_template_request.rb +20 -7
- data/lib/dropbox-sign/models/unclaimed_draft_create_request.rb +2 -2
- data/lib/dropbox-sign/version.rb +1 -1
- data/lib/dropbox-sign.rb +4 -0
- data/openapi-config.yaml +1 -1
- data/openapi-sdk.yaml +1010 -499
- data/spec/event_callback_helper_spec.rb +17 -3
- data/templates/event_callback_helper.mustache +1 -1
- data/test_fixtures/EventCallbackHelper_AccountCallbacks.json +82 -0
- data/test_fixtures/{EventCallbackHelper.json → EventCallbackHelper_AppCallbacks.json} +8 -4
- data/test_fixtures/SignatureRequestCreateEmbeddedRequest.json +6 -2
- data/test_fixtures/SignatureRequestSendRequest.json +20 -8
- data/test_fixtures/SignatureRequestSendWithTemplateRequest.json +1 -0
- data/test_fixtures/SubFormFieldsPerDocument.json +8 -4
- data/test_fixtures/TemplateCreateEmbeddedDraftRequest.json +3 -1
- data/test_fixtures/TemplateCreateRequest.json +120 -0
- data/test_fixtures/TemplateCreateResponse.json +7 -0
- data/test_fixtures/UnclaimedDraftCreateEmbeddedRequest.json +3 -1
- data/test_fixtures/UnclaimedDraftCreateEmbeddedWithTemplateRequest.json +2 -1
- data/test_fixtures/UnclaimedDraftCreateRequest.json +3 -1
- metadata +27 -11
@@ -91,6 +91,10 @@ module Dropbox::Sign
|
|
91
91
|
# @return [String, nil]
|
92
92
|
attr_accessor :signing_redirect_url
|
93
93
|
|
94
|
+
# The path where the completed document can be downloaded
|
95
|
+
# @return [String, nil]
|
96
|
+
attr_accessor :final_copy_uri
|
97
|
+
|
94
98
|
# Templates IDs used in this SignatureRequest (if any).
|
95
99
|
# @return [Array<String>, nil]
|
96
100
|
attr_accessor :template_ids
|
@@ -111,6 +115,10 @@ module Dropbox::Sign
|
|
111
115
|
# @return [Array<SignatureRequestResponseSignatures>]
|
112
116
|
attr_accessor :signatures
|
113
117
|
|
118
|
+
# The ID of the Bulk Send job which sent the signature request, if applicable.
|
119
|
+
# @return [String, nil]
|
120
|
+
attr_accessor :bulk_send_job_id
|
121
|
+
|
114
122
|
# Attribute mapping from ruby-style variable name to JSON key.
|
115
123
|
def self.attribute_map
|
116
124
|
{
|
@@ -132,11 +140,13 @@ module Dropbox::Sign
|
|
132
140
|
:'details_url' => :'details_url',
|
133
141
|
:'cc_email_addresses' => :'cc_email_addresses',
|
134
142
|
:'signing_redirect_url' => :'signing_redirect_url',
|
143
|
+
:'final_copy_uri' => :'final_copy_uri',
|
135
144
|
:'template_ids' => :'template_ids',
|
136
145
|
:'custom_fields' => :'custom_fields',
|
137
146
|
:'attachments' => :'attachments',
|
138
147
|
:'response_data' => :'response_data',
|
139
|
-
:'signatures' => :'signatures'
|
148
|
+
:'signatures' => :'signatures',
|
149
|
+
:'bulk_send_job_id' => :'bulk_send_job_id'
|
140
150
|
}
|
141
151
|
end
|
142
152
|
|
@@ -171,11 +181,13 @@ module Dropbox::Sign
|
|
171
181
|
:'details_url' => :'String',
|
172
182
|
:'cc_email_addresses' => :'Array<String>',
|
173
183
|
:'signing_redirect_url' => :'String',
|
184
|
+
:'final_copy_uri' => :'String',
|
174
185
|
:'template_ids' => :'Array<String>',
|
175
186
|
:'custom_fields' => :'Array<SignatureRequestResponseCustomFieldBase>',
|
176
187
|
:'attachments' => :'Array<SignatureRequestResponseAttachment>',
|
177
188
|
:'response_data' => :'Array<SignatureRequestResponseDataBase>',
|
178
|
-
:'signatures' => :'Array<SignatureRequestResponseSignatures>'
|
189
|
+
:'signatures' => :'Array<SignatureRequestResponseSignatures>',
|
190
|
+
:'bulk_send_job_id' => :'String'
|
179
191
|
}
|
180
192
|
end
|
181
193
|
|
@@ -192,10 +204,12 @@ module Dropbox::Sign
|
|
192
204
|
:'message',
|
193
205
|
:'signing_url',
|
194
206
|
:'signing_redirect_url',
|
207
|
+
:'final_copy_uri',
|
195
208
|
:'template_ids',
|
196
209
|
:'custom_fields',
|
197
210
|
:'attachments',
|
198
211
|
:'response_data',
|
212
|
+
:'bulk_send_job_id'
|
199
213
|
])
|
200
214
|
end
|
201
215
|
|
@@ -305,6 +319,10 @@ module Dropbox::Sign
|
|
305
319
|
self.signing_redirect_url = attributes[:'signing_redirect_url']
|
306
320
|
end
|
307
321
|
|
322
|
+
if attributes.key?(:'final_copy_uri')
|
323
|
+
self.final_copy_uri = attributes[:'final_copy_uri']
|
324
|
+
end
|
325
|
+
|
308
326
|
if attributes.key?(:'template_ids')
|
309
327
|
if (value = attributes[:'template_ids']).is_a?(Array)
|
310
328
|
self.template_ids = value
|
@@ -334,6 +352,10 @@ module Dropbox::Sign
|
|
334
352
|
self.signatures = value
|
335
353
|
end
|
336
354
|
end
|
355
|
+
|
356
|
+
if attributes.key?(:'bulk_send_job_id')
|
357
|
+
self.bulk_send_job_id = attributes[:'bulk_send_job_id']
|
358
|
+
end
|
337
359
|
end
|
338
360
|
|
339
361
|
# Show invalid properties with the reasons. Usually used together with valid?
|
@@ -372,11 +394,13 @@ module Dropbox::Sign
|
|
372
394
|
details_url == o.details_url &&
|
373
395
|
cc_email_addresses == o.cc_email_addresses &&
|
374
396
|
signing_redirect_url == o.signing_redirect_url &&
|
397
|
+
final_copy_uri == o.final_copy_uri &&
|
375
398
|
template_ids == o.template_ids &&
|
376
399
|
custom_fields == o.custom_fields &&
|
377
400
|
attachments == o.attachments &&
|
378
401
|
response_data == o.response_data &&
|
379
|
-
signatures == o.signatures
|
402
|
+
signatures == o.signatures &&
|
403
|
+
bulk_send_job_id == o.bulk_send_job_id
|
380
404
|
end
|
381
405
|
|
382
406
|
# @see the `==` method
|
@@ -388,7 +412,7 @@ module Dropbox::Sign
|
|
388
412
|
# Calculates hash code according to all attributes.
|
389
413
|
# @return [Integer] Hash code
|
390
414
|
def hash
|
391
|
-
[test_mode, signature_request_id, requester_email_address, title, original_title, subject, message, metadata, created_at, expires_at, is_complete, is_declined, has_error, files_url, signing_url, details_url, cc_email_addresses, signing_redirect_url, template_ids, custom_fields, attachments, response_data, signatures].hash
|
415
|
+
[test_mode, signature_request_id, requester_email_address, title, original_title, subject, message, metadata, created_at, expires_at, is_complete, is_declined, has_error, files_url, signing_url, details_url, cc_email_addresses, signing_redirect_url, final_copy_uri, template_ids, custom_fields, attachments, response_data, signatures, bulk_send_job_id].hash
|
392
416
|
end
|
393
417
|
|
394
418
|
# Builds the object from hash
|
@@ -38,7 +38,7 @@ module Dropbox::Sign
|
|
38
38
|
# @return [Boolean]
|
39
39
|
attr_accessor :allow_decline
|
40
40
|
|
41
|
-
# Allows signers to reassign their signature requests to other signers if set to `true`. Defaults to `false`. **
|
41
|
+
# Allows signers to reassign their signature requests to other signers if set to `true`. Defaults to `false`. **NOTE:** Only available for Premium plan and higher.
|
42
42
|
# @return [Boolean]
|
43
43
|
attr_accessor :allow_reassign
|
44
44
|
|
@@ -69,18 +69,22 @@ module Dropbox::Sign
|
|
69
69
|
# @return [Array<SubFormFieldRule>]
|
70
70
|
attr_accessor :form_field_rules
|
71
71
|
|
72
|
-
# The fields that should appear on the document, expressed as an array of objects. (For more details you can read about it here: [Using Form Fields per Document](/docs/openapi/form-fields-per-document).) **NOTE
|
72
|
+
# The fields that should appear on the document, expressed as an array of objects. (For more details you can read about it here: [Using Form Fields per Document](/docs/openapi/form-fields-per-document).) **NOTE:** Fields like **text**, **dropdown**, **checkbox**, **radio**, and **hyperlink** have additional required and optional parameters. Check out the list of [additional parameters](/api/reference/constants/#form-fields-per-document) for these field types. * Text Field use `SubFormFieldsPerDocumentText` * Dropdown Field use `SubFormFieldsPerDocumentDropdown` * Hyperlink Field use `SubFormFieldsPerDocumentHyperlink` * Checkbox Field use `SubFormFieldsPerDocumentCheckbox` * Radio Field use `SubFormFieldsPerDocumentRadio` * Signature Field use `SubFormFieldsPerDocumentSignature` * Date Signed Field use `SubFormFieldsPerDocumentDateSigned` * Initials Field use `SubFormFieldsPerDocumentInitials` * Text Merge Field use `SubFormFieldsPerDocumentTextMerge` * Checkbox Merge Field use `SubFormFieldsPerDocumentCheckboxMerge`
|
73
73
|
# @return [Array<SubFormFieldsPerDocumentBase>]
|
74
74
|
attr_accessor :form_fields_per_document
|
75
75
|
|
76
|
-
# Enables automatic Text Tag removal when set to true. **NOTE
|
76
|
+
# Enables automatic Text Tag removal when set to true. **NOTE:** Removing text tags this way can cause unwanted clipping. We recommend leaving this setting on `false` and instead hiding your text tags using white text or a similar approach. See the [Text Tags Walkthrough](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) for more information.
|
77
77
|
# @return [Boolean]
|
78
78
|
attr_accessor :hide_text_tags
|
79
79
|
|
80
|
-
# Send with a value of `true` if you wish to enable [Qualified Electronic Signatures](https://www.hellosign.com/features/qualified-electronic-signatures) (QES), which requires a face-to-face call to verify the signer's identity.<br> **
|
80
|
+
# Send with a value of `true` if you wish to enable [Qualified Electronic Signatures](https://www.hellosign.com/features/qualified-electronic-signatures) (QES), which requires a face-to-face call to verify the signer's identity.<br> **NOTE:** QES is only available on the Premium API plan as an add-on purchase. Cannot be used in `test_mode`. Only works on requests with one signer.
|
81
81
|
# @return [Boolean]
|
82
82
|
attr_accessor :is_qualified_signature
|
83
83
|
|
84
|
+
# Send with a value of `true` if you wish to enable [electronic identification (eID)](https://www.hellosign.com/features/electronic-id), which requires the signer to verify their identity with an eID provider to sign a document.<br> **NOTE:** eID is only available on the Premium API plan. Cannot be used in `test_mode`. Only works on requests with one signer.
|
85
|
+
# @return [Boolean]
|
86
|
+
attr_accessor :is_eid
|
87
|
+
|
84
88
|
# The custom message in the email that will be sent to the signers.
|
85
89
|
# @return [String]
|
86
90
|
attr_accessor :message
|
@@ -135,6 +139,7 @@ module Dropbox::Sign
|
|
135
139
|
:'form_fields_per_document' => :'form_fields_per_document',
|
136
140
|
:'hide_text_tags' => :'hide_text_tags',
|
137
141
|
:'is_qualified_signature' => :'is_qualified_signature',
|
142
|
+
:'is_eid' => :'is_eid',
|
138
143
|
:'message' => :'message',
|
139
144
|
:'metadata' => :'metadata',
|
140
145
|
:'signing_options' => :'signing_options',
|
@@ -176,6 +181,7 @@ module Dropbox::Sign
|
|
176
181
|
:'form_fields_per_document' => :'Array<SubFormFieldsPerDocumentBase>',
|
177
182
|
:'hide_text_tags' => :'Boolean',
|
178
183
|
:'is_qualified_signature' => :'Boolean',
|
184
|
+
:'is_eid' => :'Boolean',
|
179
185
|
:'message' => :'String',
|
180
186
|
:'metadata' => :'Hash<String, Object>',
|
181
187
|
:'signing_options' => :'SubSigningOptions',
|
@@ -322,6 +328,12 @@ module Dropbox::Sign
|
|
322
328
|
self.is_qualified_signature = false
|
323
329
|
end
|
324
330
|
|
331
|
+
if attributes.key?(:'is_eid')
|
332
|
+
self.is_eid = attributes[:'is_eid']
|
333
|
+
else
|
334
|
+
self.is_eid = false
|
335
|
+
end
|
336
|
+
|
325
337
|
if attributes.key?(:'message')
|
326
338
|
self.message = attributes[:'message']
|
327
339
|
end
|
@@ -450,6 +462,7 @@ module Dropbox::Sign
|
|
450
462
|
form_fields_per_document == o.form_fields_per_document &&
|
451
463
|
hide_text_tags == o.hide_text_tags &&
|
452
464
|
is_qualified_signature == o.is_qualified_signature &&
|
465
|
+
is_eid == o.is_eid &&
|
453
466
|
message == o.message &&
|
454
467
|
metadata == o.metadata &&
|
455
468
|
signing_options == o.signing_options &&
|
@@ -470,7 +483,7 @@ module Dropbox::Sign
|
|
470
483
|
# Calculates hash code according to all attributes.
|
471
484
|
# @return [Integer] Hash code
|
472
485
|
def hash
|
473
|
-
[files, file_urls, signers, grouped_signers, allow_decline, allow_reassign, attachments, cc_email_addresses, client_id, custom_fields, field_options, form_field_groups, form_field_rules, form_fields_per_document, hide_text_tags, is_qualified_signature, message, metadata, signing_options, signing_redirect_url, subject, test_mode, title, use_text_tags, expires_at].hash
|
486
|
+
[files, file_urls, signers, grouped_signers, allow_decline, allow_reassign, attachments, cc_email_addresses, client_id, custom_fields, field_options, form_field_groups, form_field_rules, form_fields_per_document, hide_text_tags, is_qualified_signature, is_eid, message, metadata, signing_options, signing_redirect_url, subject, test_mode, title, use_text_tags, expires_at].hash
|
474
487
|
end
|
475
488
|
|
476
489
|
# Builds the object from hash
|
@@ -50,10 +50,14 @@ module Dropbox::Sign
|
|
50
50
|
# @return [Array<String>]
|
51
51
|
attr_accessor :file_urls
|
52
52
|
|
53
|
-
# Send with a value of `true` if you wish to enable [Qualified Electronic Signatures](https://www.hellosign.com/features/qualified-electronic-signatures) (QES), which requires a face-to-face call to verify the signer's identity.<br> **
|
53
|
+
# Send with a value of `true` if you wish to enable [Qualified Electronic Signatures](https://www.hellosign.com/features/qualified-electronic-signatures) (QES), which requires a face-to-face call to verify the signer's identity.<br> **NOTE:** QES is only available on the Premium API plan as an add-on purchase. Cannot be used in `test_mode`. Only works on requests with one signer.
|
54
54
|
# @return [Boolean]
|
55
55
|
attr_accessor :is_qualified_signature
|
56
56
|
|
57
|
+
# Send with a value of `true` if you wish to enable [electronic identification (eID)](https://www.hellosign.com/features/electronic-id), which requires the signer to verify their identity with an eID provider to sign a document.<br> **NOTE:** eID is only available on the Premium API plan. Cannot be used in `test_mode`. Only works on requests with one signer.
|
58
|
+
# @return [Boolean]
|
59
|
+
attr_accessor :is_eid
|
60
|
+
|
57
61
|
# The custom message in the email that will be sent to the signers.
|
58
62
|
# @return [String]
|
59
63
|
attr_accessor :message
|
@@ -93,6 +97,7 @@ module Dropbox::Sign
|
|
93
97
|
:'files' => :'files',
|
94
98
|
:'file_urls' => :'file_urls',
|
95
99
|
:'is_qualified_signature' => :'is_qualified_signature',
|
100
|
+
:'is_eid' => :'is_eid',
|
96
101
|
:'message' => :'message',
|
97
102
|
:'metadata' => :'metadata',
|
98
103
|
:'signing_options' => :'signing_options',
|
@@ -125,6 +130,7 @@ module Dropbox::Sign
|
|
125
130
|
:'files' => :'Array<File>',
|
126
131
|
:'file_urls' => :'Array<String>',
|
127
132
|
:'is_qualified_signature' => :'Boolean',
|
133
|
+
:'is_eid' => :'Boolean',
|
128
134
|
:'message' => :'String',
|
129
135
|
:'metadata' => :'Hash<String, Object>',
|
130
136
|
:'signing_options' => :'SubSigningOptions',
|
@@ -228,6 +234,12 @@ module Dropbox::Sign
|
|
228
234
|
self.is_qualified_signature = false
|
229
235
|
end
|
230
236
|
|
237
|
+
if attributes.key?(:'is_eid')
|
238
|
+
self.is_eid = attributes[:'is_eid']
|
239
|
+
else
|
240
|
+
self.is_eid = false
|
241
|
+
end
|
242
|
+
|
231
243
|
if attributes.key?(:'message')
|
232
244
|
self.message = attributes[:'message']
|
233
245
|
end
|
@@ -349,6 +361,7 @@ module Dropbox::Sign
|
|
349
361
|
files == o.files &&
|
350
362
|
file_urls == o.file_urls &&
|
351
363
|
is_qualified_signature == o.is_qualified_signature &&
|
364
|
+
is_eid == o.is_eid &&
|
352
365
|
message == o.message &&
|
353
366
|
metadata == o.metadata &&
|
354
367
|
signing_options == o.signing_options &&
|
@@ -367,7 +380,7 @@ module Dropbox::Sign
|
|
367
380
|
# Calculates hash code according to all attributes.
|
368
381
|
# @return [Integer] Hash code
|
369
382
|
def hash
|
370
|
-
[template_ids, signers, allow_decline, ccs, client_id, custom_fields, files, file_urls, is_qualified_signature, message, metadata, signing_options, signing_redirect_url, subject, test_mode, title].hash
|
383
|
+
[template_ids, signers, allow_decline, ccs, client_id, custom_fields, files, file_urls, is_qualified_signature, is_eid, message, metadata, signing_options, signing_redirect_url, subject, test_mode, title].hash
|
371
384
|
end
|
372
385
|
|
373
386
|
# Builds the object from hash
|
@@ -22,11 +22,11 @@ module Dropbox::Sign
|
|
22
22
|
# @return [String]
|
23
23
|
attr_accessor :signature_id
|
24
24
|
|
25
|
-
# The new email address for the recipient. **NOTE
|
25
|
+
# The new email address for the recipient. This will generate a new `signature_id` value. **NOTE:** Optional if `name` is provided.
|
26
26
|
# @return [String]
|
27
27
|
attr_accessor :email_address
|
28
28
|
|
29
|
-
# The new name for the recipient. **NOTE
|
29
|
+
# The new name for the recipient. **NOTE:** Optional if `email_address` is provided.
|
30
30
|
# @return [String]
|
31
31
|
attr_accessor :name
|
32
32
|
|
@@ -22,7 +22,7 @@ module Dropbox::Sign
|
|
22
22
|
# @return [String]
|
23
23
|
attr_accessor :name
|
24
24
|
|
25
|
-
# The signer's index in the `signers` parameter (0-based indexing). **NOTE
|
25
|
+
# The signer's index in the `signers` parameter (0-based indexing). **NOTE:** Only one signer can be assigned per attachment.
|
26
26
|
# @return [Integer]
|
27
27
|
attr_accessor :signer_index
|
28
28
|
|
@@ -23,7 +23,7 @@ module Dropbox::Sign
|
|
23
23
|
# @return [String]
|
24
24
|
attr_accessor :name
|
25
25
|
|
26
|
-
# Used to create editable merge fields. When the value matches a role passed in with `signers`, that role can edit the data that was pre-filled to that field. This field is optional, but required when this custom field object is set to `required = true`. **
|
26
|
+
# Used to create editable merge fields. When the value matches a role passed in with `signers`, that role can edit the data that was pre-filled to that field. This field is optional, but required when this custom field object is set to `required = true`. **NOTE:** Editable merge fields are only supported for single signer requests (or the first signer in ordered signature requests). If used when there are multiple signers in an unordered signature request, the editor value is ignored and the field won't be editable.
|
27
27
|
# @return [String]
|
28
28
|
attr_accessor :editor
|
29
29
|
|
@@ -19,7 +19,7 @@ end
|
|
19
19
|
module Dropbox::Sign
|
20
20
|
# This allows the requester to specify field options for a signature request.
|
21
21
|
class SubFieldOptions
|
22
|
-
# Allows requester to specify the date format (see list of allowed [formats](/api/reference/constants/#date-formats)) **
|
22
|
+
# Allows requester to specify the date format (see list of allowed [formats](/api/reference/constants/#date-formats)) **NOTE:** Only available for Premium and higher.
|
23
23
|
# @return [String]
|
24
24
|
attr_accessor :date_format
|
25
25
|
|
@@ -17,7 +17,7 @@ module Dropbox
|
|
17
17
|
end
|
18
18
|
|
19
19
|
module Dropbox::Sign
|
20
|
-
# The fields that should appear on the document, expressed as an array of objects. (For more details you can read about it here: [Using Form Fields per Document](/docs/openapi/form-fields-per-document).) **NOTE
|
20
|
+
# The fields that should appear on the document, expressed as an array of objects. (For more details you can read about it here: [Using Form Fields per Document](/docs/openapi/form-fields-per-document).) **NOTE:** Fields like **text**, **dropdown**, **checkbox**, **radio**, and **hyperlink** have additional required and optional parameters. Check out the list of [additional parameters](/api/reference/constants/#form-fields-per-document) for these field types. * Text Field use `SubFormFieldsPerDocumentText` * Dropdown Field use `SubFormFieldsPerDocumentDropdown` * Hyperlink Field use `SubFormFieldsPerDocumentHyperlink` * Checkbox Field use `SubFormFieldsPerDocumentCheckbox` * Radio Field use `SubFormFieldsPerDocumentRadio` * Signature Field use `SubFormFieldsPerDocumentSignature` * Date Signed Field use `SubFormFieldsPerDocumentDateSigned` * Initials Field use `SubFormFieldsPerDocumentInitials` * Text Merge Field use `SubFormFieldsPerDocumentTextMerge` * Checkbox Merge Field use `SubFormFieldsPerDocumentCheckboxMerge`
|
21
21
|
class SubFormFieldsPerDocumentBase
|
22
22
|
# Represents the integer index of the `file` or `file_url` document the field should be attached to.
|
23
23
|
# @return [Integer]
|
@@ -35,7 +35,7 @@ module Dropbox::Sign
|
|
35
35
|
# @return [Boolean]
|
36
36
|
attr_accessor :required
|
37
37
|
|
38
|
-
# Signer index identified by the offset in the signers parameter (0-based indexing), indicating which signer should fill out the field. **NOTE
|
38
|
+
# Signer index identified by the offset in the signers parameter (0-based indexing), indicating which signer should fill out the field. **NOTE:** To set the value of the field as the preparer you must set this to `me_now` **NOTE:** If type is `text-merge` or `checkbox-merge`, you must set this to sender in order to use pre-filled data.
|
39
39
|
# @return [Integer, String]
|
40
40
|
attr_accessor :signer
|
41
41
|
|
@@ -23,10 +23,42 @@ module Dropbox::Sign
|
|
23
23
|
# @return [String]
|
24
24
|
attr_accessor :type
|
25
25
|
|
26
|
+
# Font family for the field.
|
27
|
+
# @return [String]
|
28
|
+
attr_accessor :font_family
|
29
|
+
|
30
|
+
# The initial px font size for the field contents. Can be any integer value between `7` and `49`. **NOTE:** Font size may be reduced during processing in order to fit the contents within the dimensions of the field.
|
31
|
+
# @return [Integer]
|
32
|
+
attr_accessor :font_size
|
33
|
+
|
34
|
+
class EnumAttributeValidator
|
35
|
+
attr_reader :datatype
|
36
|
+
attr_reader :allowable_values
|
37
|
+
|
38
|
+
def initialize(datatype, allowable_values)
|
39
|
+
@allowable_values = allowable_values.map do |value|
|
40
|
+
case datatype.to_s
|
41
|
+
when /Integer/i
|
42
|
+
value.to_i
|
43
|
+
when /Float/i
|
44
|
+
value.to_f
|
45
|
+
else
|
46
|
+
value
|
47
|
+
end
|
48
|
+
end
|
49
|
+
end
|
50
|
+
|
51
|
+
def valid?(value)
|
52
|
+
!value || allowable_values.include?(value)
|
53
|
+
end
|
54
|
+
end
|
55
|
+
|
26
56
|
# Attribute mapping from ruby-style variable name to JSON key.
|
27
57
|
def self.attribute_map
|
28
58
|
{
|
29
|
-
:'type' => :'type'
|
59
|
+
:'type' => :'type',
|
60
|
+
:'font_family' => :'font_family',
|
61
|
+
:'font_size' => :'font_size'
|
30
62
|
}
|
31
63
|
end
|
32
64
|
|
@@ -43,7 +75,9 @@ module Dropbox::Sign
|
|
43
75
|
# Attribute type mapping.
|
44
76
|
def self.openapi_types
|
45
77
|
{
|
46
|
-
:'type' => :'String'
|
78
|
+
:'type' => :'String',
|
79
|
+
:'font_family' => :'String',
|
80
|
+
:'font_size' => :'Integer'
|
47
81
|
}
|
48
82
|
end
|
49
83
|
|
@@ -96,6 +130,16 @@ module Dropbox::Sign
|
|
96
130
|
else
|
97
131
|
self.type = 'date_signed'
|
98
132
|
end
|
133
|
+
|
134
|
+
if attributes.key?(:'font_family')
|
135
|
+
self.font_family = attributes[:'font_family']
|
136
|
+
end
|
137
|
+
|
138
|
+
if attributes.key?(:'font_size')
|
139
|
+
self.font_size = attributes[:'font_size']
|
140
|
+
else
|
141
|
+
self.font_size = 12
|
142
|
+
end
|
99
143
|
end
|
100
144
|
|
101
145
|
# Show invalid properties with the reasons. Usually used together with valid?
|
@@ -113,15 +157,29 @@ module Dropbox::Sign
|
|
113
157
|
# @return true if the model is valid
|
114
158
|
def valid?
|
115
159
|
return false if @type.nil?
|
160
|
+
font_family_validator = EnumAttributeValidator.new('String', ["helvetica", "arial", "courier", "calibri", "cambria", "georgia", "times", "trebuchet", "verdana", "roboto", "robotoMono", "notoSans", "notoSerif", "notoCJK-JP-Regular", "notoHebrew-Regular", "notoSanThaiMerged"])
|
161
|
+
return false unless font_family_validator.valid?(@font_family)
|
116
162
|
true && super
|
117
163
|
end
|
118
164
|
|
165
|
+
# Custom attribute writer method checking allowed values (enum).
|
166
|
+
# @param [Object] font_family Object to be assigned
|
167
|
+
def font_family=(font_family)
|
168
|
+
validator = EnumAttributeValidator.new('String', ["helvetica", "arial", "courier", "calibri", "cambria", "georgia", "times", "trebuchet", "verdana", "roboto", "robotoMono", "notoSans", "notoSerif", "notoCJK-JP-Regular", "notoHebrew-Regular", "notoSanThaiMerged"])
|
169
|
+
unless validator.valid?(font_family)
|
170
|
+
fail ArgumentError, "invalid value for \"font_family\", must be one of #{validator.allowable_values}."
|
171
|
+
end
|
172
|
+
@font_family = font_family
|
173
|
+
end
|
174
|
+
|
119
175
|
# Checks equality by comparing each attribute.
|
120
176
|
# @param [Object] Object to be compared
|
121
177
|
def ==(o)
|
122
178
|
return true if self.equal?(o)
|
123
179
|
self.class == o.class &&
|
124
|
-
type == o.type &&
|
180
|
+
type == o.type &&
|
181
|
+
font_family == o.font_family &&
|
182
|
+
font_size == o.font_size && super(o)
|
125
183
|
end
|
126
184
|
|
127
185
|
# @see the `==` method
|
@@ -133,7 +191,7 @@ module Dropbox::Sign
|
|
133
191
|
# Calculates hash code according to all attributes.
|
134
192
|
# @return [Integer] Hash code
|
135
193
|
def hash
|
136
|
-
[type].hash
|
194
|
+
[type, font_family, font_size].hash
|
137
195
|
end
|
138
196
|
|
139
197
|
# Builds the object from hash
|
@@ -31,12 +31,44 @@ module Dropbox::Sign
|
|
31
31
|
# @return [String]
|
32
32
|
attr_accessor :content
|
33
33
|
|
34
|
+
# Font family for the field.
|
35
|
+
# @return [String]
|
36
|
+
attr_accessor :font_family
|
37
|
+
|
38
|
+
# The initial px font size for the field contents. Can be any integer value between `7` and `49`. **NOTE:** Font size may be reduced during processing in order to fit the contents within the dimensions of the field.
|
39
|
+
# @return [Integer]
|
40
|
+
attr_accessor :font_size
|
41
|
+
|
42
|
+
class EnumAttributeValidator
|
43
|
+
attr_reader :datatype
|
44
|
+
attr_reader :allowable_values
|
45
|
+
|
46
|
+
def initialize(datatype, allowable_values)
|
47
|
+
@allowable_values = allowable_values.map do |value|
|
48
|
+
case datatype.to_s
|
49
|
+
when /Integer/i
|
50
|
+
value.to_i
|
51
|
+
when /Float/i
|
52
|
+
value.to_f
|
53
|
+
else
|
54
|
+
value
|
55
|
+
end
|
56
|
+
end
|
57
|
+
end
|
58
|
+
|
59
|
+
def valid?(value)
|
60
|
+
!value || allowable_values.include?(value)
|
61
|
+
end
|
62
|
+
end
|
63
|
+
|
34
64
|
# Attribute mapping from ruby-style variable name to JSON key.
|
35
65
|
def self.attribute_map
|
36
66
|
{
|
37
67
|
:'type' => :'type',
|
38
68
|
:'options' => :'options',
|
39
|
-
:'content' => :'content'
|
69
|
+
:'content' => :'content',
|
70
|
+
:'font_family' => :'font_family',
|
71
|
+
:'font_size' => :'font_size'
|
40
72
|
}
|
41
73
|
end
|
42
74
|
|
@@ -55,7 +87,9 @@ module Dropbox::Sign
|
|
55
87
|
{
|
56
88
|
:'type' => :'String',
|
57
89
|
:'options' => :'Array<String>',
|
58
|
-
:'content' => :'String'
|
90
|
+
:'content' => :'String',
|
91
|
+
:'font_family' => :'String',
|
92
|
+
:'font_size' => :'Integer'
|
59
93
|
}
|
60
94
|
end
|
61
95
|
|
@@ -118,6 +152,16 @@ module Dropbox::Sign
|
|
118
152
|
if attributes.key?(:'content')
|
119
153
|
self.content = attributes[:'content']
|
120
154
|
end
|
155
|
+
|
156
|
+
if attributes.key?(:'font_family')
|
157
|
+
self.font_family = attributes[:'font_family']
|
158
|
+
end
|
159
|
+
|
160
|
+
if attributes.key?(:'font_size')
|
161
|
+
self.font_size = attributes[:'font_size']
|
162
|
+
else
|
163
|
+
self.font_size = 12
|
164
|
+
end
|
121
165
|
end
|
122
166
|
|
123
167
|
# Show invalid properties with the reasons. Usually used together with valid?
|
@@ -145,6 +189,8 @@ module Dropbox::Sign
|
|
145
189
|
return false if @type.nil?
|
146
190
|
return false if @options.nil?
|
147
191
|
return false if @options.length < 1
|
192
|
+
font_family_validator = EnumAttributeValidator.new('String', ["helvetica", "arial", "courier", "calibri", "cambria", "georgia", "times", "trebuchet", "verdana", "roboto", "robotoMono", "notoSans", "notoSerif", "notoCJK-JP-Regular", "notoHebrew-Regular", "notoSanThaiMerged"])
|
193
|
+
return false unless font_family_validator.valid?(@font_family)
|
148
194
|
true && super
|
149
195
|
end
|
150
196
|
|
@@ -162,6 +208,16 @@ module Dropbox::Sign
|
|
162
208
|
@options = options
|
163
209
|
end
|
164
210
|
|
211
|
+
# Custom attribute writer method checking allowed values (enum).
|
212
|
+
# @param [Object] font_family Object to be assigned
|
213
|
+
def font_family=(font_family)
|
214
|
+
validator = EnumAttributeValidator.new('String', ["helvetica", "arial", "courier", "calibri", "cambria", "georgia", "times", "trebuchet", "verdana", "roboto", "robotoMono", "notoSans", "notoSerif", "notoCJK-JP-Regular", "notoHebrew-Regular", "notoSanThaiMerged"])
|
215
|
+
unless validator.valid?(font_family)
|
216
|
+
fail ArgumentError, "invalid value for \"font_family\", must be one of #{validator.allowable_values}."
|
217
|
+
end
|
218
|
+
@font_family = font_family
|
219
|
+
end
|
220
|
+
|
165
221
|
# Checks equality by comparing each attribute.
|
166
222
|
# @param [Object] Object to be compared
|
167
223
|
def ==(o)
|
@@ -169,7 +225,9 @@ module Dropbox::Sign
|
|
169
225
|
self.class == o.class &&
|
170
226
|
type == o.type &&
|
171
227
|
options == o.options &&
|
172
|
-
content == o.content &&
|
228
|
+
content == o.content &&
|
229
|
+
font_family == o.font_family &&
|
230
|
+
font_size == o.font_size && super(o)
|
173
231
|
end
|
174
232
|
|
175
233
|
# @see the `==` method
|
@@ -181,7 +239,7 @@ module Dropbox::Sign
|
|
181
239
|
# Calculates hash code according to all attributes.
|
182
240
|
# @return [Integer] Hash code
|
183
241
|
def hash
|
184
|
-
[type, options, content].hash
|
242
|
+
[type, options, content, font_family, font_size].hash
|
185
243
|
end
|
186
244
|
|
187
245
|
# Builds the object from hash
|
@@ -0,0 +1,54 @@
|
|
1
|
+
=begin
|
2
|
+
#Dropbox Sign API
|
3
|
+
|
4
|
+
#Dropbox Sign v3 API
|
5
|
+
|
6
|
+
The version of the OpenAPI document: 3.0.0
|
7
|
+
Contact: apisupport@hellosign.com
|
8
|
+
Generated by: https://openapi-generator.tech
|
9
|
+
OpenAPI Generator version: 5.3.0
|
10
|
+
|
11
|
+
=end
|
12
|
+
|
13
|
+
require 'date'
|
14
|
+
require 'time'
|
15
|
+
|
16
|
+
module Dropbox
|
17
|
+
end
|
18
|
+
|
19
|
+
module Dropbox::Sign
|
20
|
+
class SubFormFieldsPerDocumentFontEnum
|
21
|
+
HELVETICA = "helvetica".freeze
|
22
|
+
ARIAL = "arial".freeze
|
23
|
+
COURIER = "courier".freeze
|
24
|
+
CALIBRI = "calibri".freeze
|
25
|
+
CAMBRIA = "cambria".freeze
|
26
|
+
GEORGIA = "georgia".freeze
|
27
|
+
TIMES = "times".freeze
|
28
|
+
TREBUCHET = "trebuchet".freeze
|
29
|
+
VERDANA = "verdana".freeze
|
30
|
+
ROBOTO = "roboto".freeze
|
31
|
+
ROBOTO_MONO = "robotoMono".freeze
|
32
|
+
NOTO_SANS = "notoSans".freeze
|
33
|
+
NOTO_SERIF = "notoSerif".freeze
|
34
|
+
NOTO_CJK_JP_REGULAR = "notoCJK-JP-Regular".freeze
|
35
|
+
NOTO_HEBREW_REGULAR = "notoHebrew-Regular".freeze
|
36
|
+
NOTO_SAN_THAI_MERGED = "notoSanThaiMerged".freeze
|
37
|
+
|
38
|
+
# Builds the enum from string
|
39
|
+
# @param [String] The enum value in the form of the string
|
40
|
+
# @return [String] The enum value
|
41
|
+
def self.build_from_hash(value)
|
42
|
+
new.build_from_hash(value)
|
43
|
+
end
|
44
|
+
|
45
|
+
# Builds the enum from string
|
46
|
+
# @param [String] The enum value in the form of the string
|
47
|
+
# @return [String] The enum value
|
48
|
+
def build_from_hash(value)
|
49
|
+
constantValues = SubFormFieldsPerDocumentFontEnum.constants.select { |c| SubFormFieldsPerDocumentFontEnum::const_get(c) == value }
|
50
|
+
raise "Invalid ENUM value #{value} for class #SubFormFieldsPerDocumentFontEnum" if constantValues.empty?
|
51
|
+
value
|
52
|
+
end
|
53
|
+
end
|
54
|
+
end
|