docspring 4.0.0 → 4.1.0
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/.openapi-generator/FILES +84 -0
- data/.travis.yml +1 -1
- data/CHANGELOG.md +24 -0
- data/Gemfile.lock +2 -2
- data/README.md +10 -1
- data/docs/AddTemplateFieldsRequest.md +18 -0
- data/docs/Client.md +704 -33
- data/docs/CreateSubmissionBatchRequest.md +2 -0
- data/docs/CreateSubmissionRequest.md +2 -0
- data/docs/CreateTemplateRequest.md +10 -2
- data/docs/Field.md +198 -0
- data/docs/FieldDependency.md +22 -0
- data/docs/FieldDependencyInput.md +22 -0
- data/docs/FieldGroup.md +32 -0
- data/docs/FieldGroupInput.md +30 -0
- data/docs/FieldGroupType.md +15 -0
- data/docs/FieldInput.md +196 -0
- data/docs/FieldType.md +15 -0
- data/docs/GenerateFilesFormat.md +15 -0
- data/docs/GenerateSubmissionFilesRequest.md +18 -0
- data/docs/OutputFormat.md +15 -0
- data/docs/PageImage.md +34 -0
- data/docs/PageImages.md +24 -0
- data/docs/PredefinedField.md +30 -0
- data/docs/PredefinedFieldInput.md +30 -0
- data/docs/RemoveTemplateFieldsRequest.md +18 -0
- data/docs/ReorderTemplateFieldsRequest.md +18 -0
- data/docs/Submission.md +3 -1
- data/docs/SubmissionFiles.md +3 -1
- data/docs/SubmissionInput.md +2 -0
- data/docs/SubmissionValidation.md +24 -0
- data/docs/Template.md +6 -0
- data/docs/TemplateDiff.md +30 -0
- data/docs/TemplateDiffSummary.md +28 -0
- data/docs/TemplateDocument.md +3 -3
- data/docs/TemplateFieldChange.md +24 -0
- data/docs/TemplateFieldChanges.md +24 -0
- data/docs/TemplateFieldDependency.md +1 -1
- data/docs/TemplateFieldDependencyInput.md +1 -1
- data/docs/TemplateFieldMove.md +22 -0
- data/docs/TemplateFields.md +22 -0
- data/docs/TemplatePageImages.md +24 -0
- data/docs/UpdateTemplateDocumentRequest.md +6 -2
- data/docs/UpdateTemplateFieldsRequest.md +18 -0
- data/docs/UpdateTemplateRequest.md +6 -0
- data/docs/ValidateSubmissionRequest.md +38 -0
- data/lib/docspring/api/client.rb +666 -18
- data/lib/docspring/api_client.rb +1 -1
- data/lib/docspring/models/add_template_fields_request.rb +187 -0
- data/lib/docspring/models/create_submission_batch_request.rb +23 -1
- data/lib/docspring/models/create_submission_request.rb +23 -1
- data/lib/docspring/models/create_template_request.rb +48 -3
- data/lib/docspring/models/field.rb +2217 -0
- data/lib/docspring/models/field_dependency.rb +246 -0
- data/lib/docspring/models/field_dependency_input.rb +246 -0
- data/lib/docspring/models/field_group.rb +368 -0
- data/lib/docspring/models/field_group_input.rb +247 -0
- data/lib/docspring/models/field_group_type.rb +41 -0
- data/lib/docspring/models/field_input.rb +1109 -0
- data/lib/docspring/models/field_type.rb +54 -0
- data/lib/docspring/models/generate_files_format.rb +40 -0
- data/lib/docspring/models/generate_submission_files_request.rb +187 -0
- data/lib/docspring/models/output_format.rb +41 -0
- data/lib/docspring/models/page_image.rb +359 -0
- data/lib/docspring/models/page_images.rb +248 -0
- data/lib/docspring/models/predefined_field.rb +287 -0
- data/lib/docspring/models/predefined_field_input.rb +287 -0
- data/lib/docspring/models/remove_template_fields_request.rb +187 -0
- data/lib/docspring/models/reorder_template_fields_request.rb +187 -0
- data/lib/docspring/models/submission.rb +31 -2
- data/lib/docspring/models/submission_files.rb +13 -4
- data/lib/docspring/models/submission_input.rb +23 -1
- data/lib/docspring/models/submission_validation.rb +234 -0
- data/lib/docspring/models/template.rb +74 -1
- data/lib/docspring/models/template_diff.rb +321 -0
- data/lib/docspring/models/template_diff_summary.rb +320 -0
- data/lib/docspring/models/template_document.rb +3 -3
- data/lib/docspring/models/template_document_state.rb +3 -1
- data/lib/docspring/models/template_field_change.rb +266 -0
- data/lib/docspring/models/template_field_changes.rb +274 -0
- data/lib/docspring/models/template_field_dependency.rb +1 -1
- data/lib/docspring/models/template_field_dependency_input.rb +1 -1
- data/lib/docspring/models/template_field_move.rb +239 -0
- data/lib/docspring/models/template_fields.rb +227 -0
- data/lib/docspring/models/template_page_images.rb +254 -0
- data/lib/docspring/models/update_template_document_request.rb +23 -20
- data/lib/docspring/models/update_template_fields_request.rb +187 -0
- data/lib/docspring/models/update_template_request.rb +38 -1
- data/lib/docspring/models/validate_submission_request.rb +288 -0
- data/lib/docspring/request_schemas.json +3364 -1584
- data/lib/docspring/version.rb +1 -1
- data/lib/docspring.rb +28 -0
- data/spec/api/client_spec.rb +128 -9
- data/spec/models/add_template_fields_request_spec.rb +36 -0
- data/spec/models/create_submission_batch_request_spec.rb +6 -0
- data/spec/models/create_submission_request_spec.rb +6 -0
- data/spec/models/create_template_request_spec.rb +24 -0
- data/spec/models/field_dependency_input_spec.rb +48 -0
- data/spec/models/field_dependency_spec.rb +48 -0
- data/spec/models/field_group_input_spec.rb +72 -0
- data/spec/models/field_group_spec.rb +78 -0
- data/spec/models/field_group_type_spec.rb +30 -0
- data/spec/models/field_input_spec.rb +570 -0
- data/spec/models/field_spec.rb +576 -0
- data/spec/models/field_type_spec.rb +30 -0
- data/spec/models/generate_files_format_spec.rb +30 -0
- data/spec/models/generate_submission_files_request_spec.rb +36 -0
- data/spec/models/output_format_spec.rb +30 -0
- data/spec/models/page_image_spec.rb +84 -0
- data/spec/models/page_images_spec.rb +54 -0
- data/spec/models/predefined_field_input_spec.rb +72 -0
- data/spec/models/predefined_field_spec.rb +72 -0
- data/spec/models/remove_template_fields_request_spec.rb +36 -0
- data/spec/models/reorder_template_fields_request_spec.rb +36 -0
- data/spec/models/submission_files_spec.rb +6 -0
- data/spec/models/submission_input_spec.rb +6 -0
- data/spec/models/submission_spec.rb +6 -0
- data/spec/models/submission_validation_spec.rb +54 -0
- data/spec/models/template_diff_spec.rb +72 -0
- data/spec/models/template_diff_summary_spec.rb +66 -0
- data/spec/models/template_field_change_spec.rb +54 -0
- data/spec/models/template_field_changes_spec.rb +54 -0
- data/spec/models/template_field_move_spec.rb +48 -0
- data/spec/models/template_fields_spec.rb +48 -0
- data/spec/models/template_page_images_spec.rb +54 -0
- data/spec/models/template_spec.rb +18 -0
- data/spec/models/update_template_document_request_spec.rb +12 -0
- data/spec/models/update_template_fields_request_spec.rb +36 -0
- data/spec/models/update_template_request_spec.rb +18 -0
- data/spec/models/validate_submission_request_spec.rb +96 -0
- metadata +113 -1
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: d124a4eb39c1edc1b535fe60c6027af58866731018f574e3b58e9c9e658081bb
|
|
4
|
+
data.tar.gz: 4a365cf441b2b34c9a841059ea647b0c8ce0e2680183ddc229a7f6482e4af8e1
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: e565b0c650ff70a2e1791e82c6be2b9afe21c0edce375b77c17cc92f98954b71e5ff6fa473d8df181a17687e9e2cfc8b4ddffa34dbc7e103f16366eb74936e88
|
|
7
|
+
data.tar.gz: cd338cfa5caed832ebcfe25aedab0582c2e004050bab456d3b2d5b7f1e43001644d44a4a6d16be5d942f600f4a2a203fd41e83331b6ec2e7ea82f8badfe42aa2
|
data/.openapi-generator/FILES
CHANGED
|
@@ -6,6 +6,7 @@
|
|
|
6
6
|
Gemfile
|
|
7
7
|
README.md
|
|
8
8
|
Rakefile
|
|
9
|
+
docs/AddTemplateFieldsRequest.md
|
|
9
10
|
docs/AiFieldNamingLanguage.md
|
|
10
11
|
docs/AuthenticationCheck.md
|
|
11
12
|
docs/BarcodeSymbology.md
|
|
@@ -38,12 +39,19 @@ docs/ErrorDetail.md
|
|
|
38
39
|
docs/ErrorInfo.md
|
|
39
40
|
docs/ErrorResponse.md
|
|
40
41
|
docs/ExpirationInterval.md
|
|
42
|
+
docs/Field.md
|
|
41
43
|
docs/FieldComparisonCondition.md
|
|
42
44
|
docs/FieldComparisonOperator.md
|
|
45
|
+
docs/FieldDependency.md
|
|
46
|
+
docs/FieldDependencyInput.md
|
|
43
47
|
docs/FieldDisplayType.md
|
|
44
48
|
docs/FieldEqualsCondition.md
|
|
45
49
|
docs/FieldEqualsOperator.md
|
|
50
|
+
docs/FieldGroup.md
|
|
51
|
+
docs/FieldGroupInput.md
|
|
52
|
+
docs/FieldGroupType.md
|
|
46
53
|
docs/FieldInCondition.md
|
|
54
|
+
docs/FieldInput.md
|
|
47
55
|
docs/FieldOverride.md
|
|
48
56
|
docs/FieldPresenceCondition.md
|
|
49
57
|
docs/FieldPresenceOperator.md
|
|
@@ -52,8 +60,11 @@ docs/FieldReimportState.md
|
|
|
52
60
|
docs/FieldSetupLogic.md
|
|
53
61
|
docs/FieldSetupNaming.md
|
|
54
62
|
docs/FieldSetupSource.md
|
|
63
|
+
docs/FieldType.md
|
|
55
64
|
docs/Folder.md
|
|
56
65
|
docs/FolderList.md
|
|
66
|
+
docs/GenerateFilesFormat.md
|
|
67
|
+
docs/GenerateSubmissionFilesRequest.md
|
|
57
68
|
docs/GeneratedFile.md
|
|
58
69
|
docs/GeneratedFileState.md
|
|
59
70
|
docs/HtmlEngineOptions.md
|
|
@@ -64,9 +75,16 @@ docs/ModelCodeLanguage.md
|
|
|
64
75
|
docs/MoveFolderRequest.md
|
|
65
76
|
docs/MoveTemplateRequest.md
|
|
66
77
|
docs/NumberConditionType.md
|
|
78
|
+
docs/OutputFormat.md
|
|
67
79
|
docs/PageFormat.md
|
|
80
|
+
docs/PageImage.md
|
|
81
|
+
docs/PageImages.md
|
|
82
|
+
docs/PredefinedField.md
|
|
83
|
+
docs/PredefinedFieldInput.md
|
|
68
84
|
docs/PublishTemplateVersionRequest.md
|
|
85
|
+
docs/RemoveTemplateFieldsRequest.md
|
|
69
86
|
docs/RenameFolderRequest.md
|
|
87
|
+
docs/ReorderTemplateFieldsRequest.md
|
|
70
88
|
docs/RestoreTemplateVersionRequest.md
|
|
71
89
|
docs/ShapeType.md
|
|
72
90
|
docs/SignatureRequest.md
|
|
@@ -92,13 +110,18 @@ docs/SubmissionList.md
|
|
|
92
110
|
docs/SubmissionSource.md
|
|
93
111
|
docs/SubmissionSourcePdf.md
|
|
94
112
|
docs/SubmissionState.md
|
|
113
|
+
docs/SubmissionValidation.md
|
|
95
114
|
docs/Template.md
|
|
96
115
|
docs/TemplateActor.md
|
|
97
116
|
docs/TemplateActorType.md
|
|
98
117
|
docs/TemplateDefaults.md
|
|
99
118
|
docs/TemplateDefaultsInput.md
|
|
119
|
+
docs/TemplateDiff.md
|
|
120
|
+
docs/TemplateDiffSummary.md
|
|
100
121
|
docs/TemplateDocument.md
|
|
101
122
|
docs/TemplateDocumentState.md
|
|
123
|
+
docs/TemplateFieldChange.md
|
|
124
|
+
docs/TemplateFieldChanges.md
|
|
102
125
|
docs/TemplateFieldDependency.md
|
|
103
126
|
docs/TemplateFieldDependencyAction.md
|
|
104
127
|
docs/TemplateFieldDependencyCondition.md
|
|
@@ -107,12 +130,15 @@ docs/TemplateFieldDependencyInput.md
|
|
|
107
130
|
docs/TemplateFieldDependencyMatch.md
|
|
108
131
|
docs/TemplateFieldDependencyOperator.md
|
|
109
132
|
docs/TemplateFieldLogicStatus.md
|
|
133
|
+
docs/TemplateFieldMove.md
|
|
134
|
+
docs/TemplateFields.md
|
|
110
135
|
docs/TemplateFormMode.md
|
|
111
136
|
docs/TemplateModelCode.md
|
|
112
137
|
docs/TemplatePageAiError.md
|
|
113
138
|
docs/TemplatePageAiNamingStatus.md
|
|
114
139
|
docs/TemplatePageFieldsStatus.md
|
|
115
140
|
docs/TemplatePageImageStatus.md
|
|
141
|
+
docs/TemplatePageImages.md
|
|
116
142
|
docs/TemplatePageProcessingStatus.md
|
|
117
143
|
docs/TemplateSourcePdf.md
|
|
118
144
|
docs/TemplateSummary.md
|
|
@@ -126,11 +152,13 @@ docs/TextVerticalAlignment.md
|
|
|
126
152
|
docs/Typeface.md
|
|
127
153
|
docs/UpdateSignatureRequestRequest.md
|
|
128
154
|
docs/UpdateTemplateDocumentRequest.md
|
|
155
|
+
docs/UpdateTemplateFieldsRequest.md
|
|
129
156
|
docs/UpdateTemplateRequest.md
|
|
130
157
|
docs/UpdateWebhookRequest.md
|
|
131
158
|
docs/UploadMethod.md
|
|
132
159
|
docs/UploadPresign.md
|
|
133
160
|
docs/UrlSourcePdf.md
|
|
161
|
+
docs/ValidateSubmissionRequest.md
|
|
134
162
|
docs/Webhook.md
|
|
135
163
|
docs/WebhookEventType.md
|
|
136
164
|
docs/WebhookList.md
|
|
@@ -143,6 +171,7 @@ lib/docspring/api_client.rb
|
|
|
143
171
|
lib/docspring/api_error.rb
|
|
144
172
|
lib/docspring/api_model_base.rb
|
|
145
173
|
lib/docspring/configuration.rb
|
|
174
|
+
lib/docspring/models/add_template_fields_request.rb
|
|
146
175
|
lib/docspring/models/ai_field_naming_language.rb
|
|
147
176
|
lib/docspring/models/authentication_check.rb
|
|
148
177
|
lib/docspring/models/barcode_symbology.rb
|
|
@@ -174,12 +203,19 @@ lib/docspring/models/error_detail.rb
|
|
|
174
203
|
lib/docspring/models/error_info.rb
|
|
175
204
|
lib/docspring/models/error_response.rb
|
|
176
205
|
lib/docspring/models/expiration_interval.rb
|
|
206
|
+
lib/docspring/models/field.rb
|
|
177
207
|
lib/docspring/models/field_comparison_condition.rb
|
|
178
208
|
lib/docspring/models/field_comparison_operator.rb
|
|
209
|
+
lib/docspring/models/field_dependency.rb
|
|
210
|
+
lib/docspring/models/field_dependency_input.rb
|
|
179
211
|
lib/docspring/models/field_display_type.rb
|
|
180
212
|
lib/docspring/models/field_equals_condition.rb
|
|
181
213
|
lib/docspring/models/field_equals_operator.rb
|
|
214
|
+
lib/docspring/models/field_group.rb
|
|
215
|
+
lib/docspring/models/field_group_input.rb
|
|
216
|
+
lib/docspring/models/field_group_type.rb
|
|
182
217
|
lib/docspring/models/field_in_condition.rb
|
|
218
|
+
lib/docspring/models/field_input.rb
|
|
183
219
|
lib/docspring/models/field_override.rb
|
|
184
220
|
lib/docspring/models/field_presence_condition.rb
|
|
185
221
|
lib/docspring/models/field_presence_operator.rb
|
|
@@ -188,8 +224,11 @@ lib/docspring/models/field_reimport_state.rb
|
|
|
188
224
|
lib/docspring/models/field_setup_logic.rb
|
|
189
225
|
lib/docspring/models/field_setup_naming.rb
|
|
190
226
|
lib/docspring/models/field_setup_source.rb
|
|
227
|
+
lib/docspring/models/field_type.rb
|
|
191
228
|
lib/docspring/models/folder.rb
|
|
192
229
|
lib/docspring/models/folder_list.rb
|
|
230
|
+
lib/docspring/models/generate_files_format.rb
|
|
231
|
+
lib/docspring/models/generate_submission_files_request.rb
|
|
193
232
|
lib/docspring/models/generated_file.rb
|
|
194
233
|
lib/docspring/models/generated_file_state.rb
|
|
195
234
|
lib/docspring/models/html_engine_options.rb
|
|
@@ -200,9 +239,16 @@ lib/docspring/models/model_code_language.rb
|
|
|
200
239
|
lib/docspring/models/move_folder_request.rb
|
|
201
240
|
lib/docspring/models/move_template_request.rb
|
|
202
241
|
lib/docspring/models/number_condition_type.rb
|
|
242
|
+
lib/docspring/models/output_format.rb
|
|
203
243
|
lib/docspring/models/page_format.rb
|
|
244
|
+
lib/docspring/models/page_image.rb
|
|
245
|
+
lib/docspring/models/page_images.rb
|
|
246
|
+
lib/docspring/models/predefined_field.rb
|
|
247
|
+
lib/docspring/models/predefined_field_input.rb
|
|
204
248
|
lib/docspring/models/publish_template_version_request.rb
|
|
249
|
+
lib/docspring/models/remove_template_fields_request.rb
|
|
205
250
|
lib/docspring/models/rename_folder_request.rb
|
|
251
|
+
lib/docspring/models/reorder_template_fields_request.rb
|
|
206
252
|
lib/docspring/models/restore_template_version_request.rb
|
|
207
253
|
lib/docspring/models/shape_type.rb
|
|
208
254
|
lib/docspring/models/signature_request.rb
|
|
@@ -228,13 +274,18 @@ lib/docspring/models/submission_list.rb
|
|
|
228
274
|
lib/docspring/models/submission_source.rb
|
|
229
275
|
lib/docspring/models/submission_source_pdf.rb
|
|
230
276
|
lib/docspring/models/submission_state.rb
|
|
277
|
+
lib/docspring/models/submission_validation.rb
|
|
231
278
|
lib/docspring/models/template.rb
|
|
232
279
|
lib/docspring/models/template_actor.rb
|
|
233
280
|
lib/docspring/models/template_actor_type.rb
|
|
234
281
|
lib/docspring/models/template_defaults.rb
|
|
235
282
|
lib/docspring/models/template_defaults_input.rb
|
|
283
|
+
lib/docspring/models/template_diff.rb
|
|
284
|
+
lib/docspring/models/template_diff_summary.rb
|
|
236
285
|
lib/docspring/models/template_document.rb
|
|
237
286
|
lib/docspring/models/template_document_state.rb
|
|
287
|
+
lib/docspring/models/template_field_change.rb
|
|
288
|
+
lib/docspring/models/template_field_changes.rb
|
|
238
289
|
lib/docspring/models/template_field_dependency.rb
|
|
239
290
|
lib/docspring/models/template_field_dependency_action.rb
|
|
240
291
|
lib/docspring/models/template_field_dependency_condition.rb
|
|
@@ -243,12 +294,15 @@ lib/docspring/models/template_field_dependency_input.rb
|
|
|
243
294
|
lib/docspring/models/template_field_dependency_match.rb
|
|
244
295
|
lib/docspring/models/template_field_dependency_operator.rb
|
|
245
296
|
lib/docspring/models/template_field_logic_status.rb
|
|
297
|
+
lib/docspring/models/template_field_move.rb
|
|
298
|
+
lib/docspring/models/template_fields.rb
|
|
246
299
|
lib/docspring/models/template_form_mode.rb
|
|
247
300
|
lib/docspring/models/template_model_code.rb
|
|
248
301
|
lib/docspring/models/template_page_ai_error.rb
|
|
249
302
|
lib/docspring/models/template_page_ai_naming_status.rb
|
|
250
303
|
lib/docspring/models/template_page_fields_status.rb
|
|
251
304
|
lib/docspring/models/template_page_image_status.rb
|
|
305
|
+
lib/docspring/models/template_page_images.rb
|
|
252
306
|
lib/docspring/models/template_page_processing_status.rb
|
|
253
307
|
lib/docspring/models/template_source_pdf.rb
|
|
254
308
|
lib/docspring/models/template_summary.rb
|
|
@@ -262,17 +316,20 @@ lib/docspring/models/text_vertical_alignment.rb
|
|
|
262
316
|
lib/docspring/models/typeface.rb
|
|
263
317
|
lib/docspring/models/update_signature_request_request.rb
|
|
264
318
|
lib/docspring/models/update_template_document_request.rb
|
|
319
|
+
lib/docspring/models/update_template_fields_request.rb
|
|
265
320
|
lib/docspring/models/update_template_request.rb
|
|
266
321
|
lib/docspring/models/update_webhook_request.rb
|
|
267
322
|
lib/docspring/models/upload_method.rb
|
|
268
323
|
lib/docspring/models/upload_presign.rb
|
|
269
324
|
lib/docspring/models/url_source_pdf.rb
|
|
325
|
+
lib/docspring/models/validate_submission_request.rb
|
|
270
326
|
lib/docspring/models/webhook.rb
|
|
271
327
|
lib/docspring/models/webhook_event_type.rb
|
|
272
328
|
lib/docspring/models/webhook_list.rb
|
|
273
329
|
lib/docspring/models/webhook_mode.rb
|
|
274
330
|
lib/docspring/version.rb
|
|
275
331
|
spec/api/client_spec.rb
|
|
332
|
+
spec/models/add_template_fields_request_spec.rb
|
|
276
333
|
spec/models/ai_field_naming_language_spec.rb
|
|
277
334
|
spec/models/authentication_check_spec.rb
|
|
278
335
|
spec/models/barcode_symbology_spec.rb
|
|
@@ -306,10 +363,16 @@ spec/models/error_response_spec.rb
|
|
|
306
363
|
spec/models/expiration_interval_spec.rb
|
|
307
364
|
spec/models/field_comparison_condition_spec.rb
|
|
308
365
|
spec/models/field_comparison_operator_spec.rb
|
|
366
|
+
spec/models/field_dependency_input_spec.rb
|
|
367
|
+
spec/models/field_dependency_spec.rb
|
|
309
368
|
spec/models/field_display_type_spec.rb
|
|
310
369
|
spec/models/field_equals_condition_spec.rb
|
|
311
370
|
spec/models/field_equals_operator_spec.rb
|
|
371
|
+
spec/models/field_group_input_spec.rb
|
|
372
|
+
spec/models/field_group_spec.rb
|
|
373
|
+
spec/models/field_group_type_spec.rb
|
|
312
374
|
spec/models/field_in_condition_spec.rb
|
|
375
|
+
spec/models/field_input_spec.rb
|
|
313
376
|
spec/models/field_override_spec.rb
|
|
314
377
|
spec/models/field_presence_condition_spec.rb
|
|
315
378
|
spec/models/field_presence_operator_spec.rb
|
|
@@ -318,8 +381,12 @@ spec/models/field_reimport_state_spec.rb
|
|
|
318
381
|
spec/models/field_setup_logic_spec.rb
|
|
319
382
|
spec/models/field_setup_naming_spec.rb
|
|
320
383
|
spec/models/field_setup_source_spec.rb
|
|
384
|
+
spec/models/field_spec.rb
|
|
385
|
+
spec/models/field_type_spec.rb
|
|
321
386
|
spec/models/folder_list_spec.rb
|
|
322
387
|
spec/models/folder_spec.rb
|
|
388
|
+
spec/models/generate_files_format_spec.rb
|
|
389
|
+
spec/models/generate_submission_files_request_spec.rb
|
|
323
390
|
spec/models/generated_file_spec.rb
|
|
324
391
|
spec/models/generated_file_state_spec.rb
|
|
325
392
|
spec/models/html_engine_options_input_spec.rb
|
|
@@ -330,9 +397,16 @@ spec/models/model_code_language_spec.rb
|
|
|
330
397
|
spec/models/move_folder_request_spec.rb
|
|
331
398
|
spec/models/move_template_request_spec.rb
|
|
332
399
|
spec/models/number_condition_type_spec.rb
|
|
400
|
+
spec/models/output_format_spec.rb
|
|
333
401
|
spec/models/page_format_spec.rb
|
|
402
|
+
spec/models/page_image_spec.rb
|
|
403
|
+
spec/models/page_images_spec.rb
|
|
404
|
+
spec/models/predefined_field_input_spec.rb
|
|
405
|
+
spec/models/predefined_field_spec.rb
|
|
334
406
|
spec/models/publish_template_version_request_spec.rb
|
|
407
|
+
spec/models/remove_template_fields_request_spec.rb
|
|
335
408
|
spec/models/rename_folder_request_spec.rb
|
|
409
|
+
spec/models/reorder_template_fields_request_spec.rb
|
|
336
410
|
spec/models/restore_template_version_request_spec.rb
|
|
337
411
|
spec/models/shape_type_spec.rb
|
|
338
412
|
spec/models/signature_request_auth_second_factor_type_spec.rb
|
|
@@ -358,12 +432,17 @@ spec/models/submission_source_pdf_spec.rb
|
|
|
358
432
|
spec/models/submission_source_spec.rb
|
|
359
433
|
spec/models/submission_spec.rb
|
|
360
434
|
spec/models/submission_state_spec.rb
|
|
435
|
+
spec/models/submission_validation_spec.rb
|
|
361
436
|
spec/models/template_actor_spec.rb
|
|
362
437
|
spec/models/template_actor_type_spec.rb
|
|
363
438
|
spec/models/template_defaults_input_spec.rb
|
|
364
439
|
spec/models/template_defaults_spec.rb
|
|
440
|
+
spec/models/template_diff_spec.rb
|
|
441
|
+
spec/models/template_diff_summary_spec.rb
|
|
365
442
|
spec/models/template_document_spec.rb
|
|
366
443
|
spec/models/template_document_state_spec.rb
|
|
444
|
+
spec/models/template_field_change_spec.rb
|
|
445
|
+
spec/models/template_field_changes_spec.rb
|
|
367
446
|
spec/models/template_field_dependency_action_spec.rb
|
|
368
447
|
spec/models/template_field_dependency_condition_input_spec.rb
|
|
369
448
|
spec/models/template_field_dependency_condition_spec.rb
|
|
@@ -372,12 +451,15 @@ spec/models/template_field_dependency_match_spec.rb
|
|
|
372
451
|
spec/models/template_field_dependency_operator_spec.rb
|
|
373
452
|
spec/models/template_field_dependency_spec.rb
|
|
374
453
|
spec/models/template_field_logic_status_spec.rb
|
|
454
|
+
spec/models/template_field_move_spec.rb
|
|
455
|
+
spec/models/template_fields_spec.rb
|
|
375
456
|
spec/models/template_form_mode_spec.rb
|
|
376
457
|
spec/models/template_model_code_spec.rb
|
|
377
458
|
spec/models/template_page_ai_error_spec.rb
|
|
378
459
|
spec/models/template_page_ai_naming_status_spec.rb
|
|
379
460
|
spec/models/template_page_fields_status_spec.rb
|
|
380
461
|
spec/models/template_page_image_status_spec.rb
|
|
462
|
+
spec/models/template_page_images_spec.rb
|
|
381
463
|
spec/models/template_page_processing_status_spec.rb
|
|
382
464
|
spec/models/template_source_pdf_spec.rb
|
|
383
465
|
spec/models/template_spec.rb
|
|
@@ -392,11 +474,13 @@ spec/models/text_vertical_alignment_spec.rb
|
|
|
392
474
|
spec/models/typeface_spec.rb
|
|
393
475
|
spec/models/update_signature_request_request_spec.rb
|
|
394
476
|
spec/models/update_template_document_request_spec.rb
|
|
477
|
+
spec/models/update_template_fields_request_spec.rb
|
|
395
478
|
spec/models/update_template_request_spec.rb
|
|
396
479
|
spec/models/update_webhook_request_spec.rb
|
|
397
480
|
spec/models/upload_method_spec.rb
|
|
398
481
|
spec/models/upload_presign_spec.rb
|
|
399
482
|
spec/models/url_source_pdf_spec.rb
|
|
483
|
+
spec/models/validate_submission_request_spec.rb
|
|
400
484
|
spec/models/webhook_event_type_spec.rb
|
|
401
485
|
spec/models/webhook_list_spec.rb
|
|
402
486
|
spec/models/webhook_mode_spec.rb
|
data/.travis.yml
CHANGED
data/CHANGELOG.md
CHANGED
|
@@ -1,3 +1,27 @@
|
|
|
1
|
+
### 4.1.0 [October 27, 2026]
|
|
2
|
+
|
|
3
|
+
- New: list_template_fields, add_template_fields, update_template_fields, remove_template_fields and
|
|
4
|
+
reorder_template_fields read and edit a template's fields (`Field`), with all their settings and their own conditional
|
|
5
|
+
logic (`dependencies`). A field's `y` is measured from the top of its page.
|
|
6
|
+
- New: a template's `predefined_fields` (`PredefinedField`) and `predefined_fields_sample_data`, the field names that
|
|
7
|
+
people using the embedded template editor choose from. get_template returns them, and create_template and
|
|
8
|
+
update_template set them.
|
|
9
|
+
- New: a template's `field_groups` (`FieldGroup`), the groups that its fields' names make, with their titles and the
|
|
10
|
+
settings of lists (`min_items`, `max_items`, `allow_additional_items`). get_template returns them, and update_template
|
|
11
|
+
changes them.
|
|
12
|
+
- New: get_template_page_images returns an image of each page of a PDF template (`TemplatePageImages`), to see where
|
|
13
|
+
fields go.
|
|
14
|
+
- New: get_template_diff says what changed in a template's draft since its latest published version, or in a published
|
|
15
|
+
version since the one before it (`TemplateDiff`).
|
|
16
|
+
- New: validate_submission checks a submission's data and settings as create_submission does, without creating the
|
|
17
|
+
submission or using credits (`SubmissionValidation`). It doesn't check your account's credits.
|
|
18
|
+
- New: the `png` output format, an image of each page of a submission's PDF (`files.png.pages`). Add it to
|
|
19
|
+
`output_formats` in create_submission or create_submission_batch (it adds `pdf`), or to a processed submission with
|
|
20
|
+
generate_submission_files.
|
|
21
|
+
- create_template and update_template_document take a `document_url` (DocSpring downloads it) or a `document_base64`
|
|
22
|
+
instead of a `cache_id`. While the URL downloads, the template's `document.state` is `downloading`; if it can't be
|
|
23
|
+
downloaded, it's `download_failed` and `document.error_message` says why.
|
|
24
|
+
|
|
1
25
|
### 4.0.0 [October 26, 2026]
|
|
2
26
|
|
|
3
27
|
- **BREAKING CHANGE**: This version calls DocSpring API v2 (`/api/v2`). The 3.x versions call API v1, which keeps
|
data/Gemfile.lock
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
PATH
|
|
2
2
|
remote: .
|
|
3
3
|
specs:
|
|
4
|
-
docspring (4.
|
|
4
|
+
docspring (4.1.0)
|
|
5
5
|
logger
|
|
6
6
|
typhoeus (~> 1.0, >= 1.0.1)
|
|
7
7
|
|
|
@@ -104,7 +104,7 @@ CHECKSUMS
|
|
|
104
104
|
coderay (1.1.3) sha256=dc530018a4684512f8f38143cd2a096c9f02a1fc2459edcfe534787a7fc77d4b
|
|
105
105
|
date (3.6.0) sha256=18ac945c4e24ebd93534f8eab8c2fd8c5604b3e977105b3798d62a1e8d27b580
|
|
106
106
|
diff-lcs (1.6.2) sha256=9ae0d2cba7d4df3075fe8cd8602a8604993efc0dfa934cff568969efb1909962
|
|
107
|
-
docspring (4.
|
|
107
|
+
docspring (4.1.0)
|
|
108
108
|
ethon (0.18.0) sha256=b598afc9f30448cb068b850714b7d6948e941476095d04f90a4ac65b8d6efcb2
|
|
109
109
|
ffi (1.17.4) sha256=bcd1642e06f0d16fc9e09ac6d49c3a7298b9789bcb58127302f934e437d60acf
|
|
110
110
|
ffi (1.17.4-aarch64-linux-gnu) sha256=b208f06f91ffd8f5e1193da3cae3d2ccfc27fc36fba577baf698d26d91c080df
|
data/README.md
CHANGED
|
@@ -9,7 +9,7 @@ templates with your data, generates PDFs from HTML templates, combines PDFs and
|
|
|
9
9
|
The code in this repository is generated from DocSpring's OpenAPI spec ([About this SDK](#about-this-sdk)). Issues and
|
|
10
10
|
pull requests are welcome.
|
|
11
11
|
|
|
12
|
-
Version 4.
|
|
12
|
+
Version 4.1.0. Requires Ruby >= 2.7.
|
|
13
13
|
|
|
14
14
|
## Install and configure
|
|
15
15
|
|
|
@@ -86,6 +86,7 @@ Ruby code for every method.
|
|
|
86
86
|
|
|
87
87
|
| Method | Description |
|
|
88
88
|
| ------ | ----------- |
|
|
89
|
+
| [`add_template_fields`](https://github.com/DocSpring/docspring-ruby/blob/main/docs/Client.md#add_template_fields) | Add fields to a template |
|
|
89
90
|
| [`copy_template`](https://github.com/DocSpring/docspring-ruby/blob/main/docs/Client.md#copy_template) | Copy a template |
|
|
90
91
|
| [`create_combined_pdf`](https://github.com/DocSpring/docspring-ruby/blob/main/docs/Client.md#create_combined_pdf) | Combine PDFs |
|
|
91
92
|
| [`create_custom_file_from_upload`](https://github.com/DocSpring/docspring-ruby/blob/main/docs/Client.md#create_custom_file_from_upload) | Create a custom file from an upload |
|
|
@@ -102,6 +103,7 @@ Ruby code for every method.
|
|
|
102
103
|
| [`delete_webhook`](https://github.com/DocSpring/docspring-ruby/blob/main/docs/Client.md#delete_webhook) | Delete a webhook |
|
|
103
104
|
| [`expire_combined_pdf`](https://github.com/DocSpring/docspring-ruby/blob/main/docs/Client.md#expire_combined_pdf) | Expire a combined PDF |
|
|
104
105
|
| [`expire_submission`](https://github.com/DocSpring/docspring-ruby/blob/main/docs/Client.md#expire_submission) | Expire a submission |
|
|
106
|
+
| [`generate_submission_files`](https://github.com/DocSpring/docspring-ruby/blob/main/docs/Client.md#generate_submission_files) | Generate more files |
|
|
105
107
|
| [`generate_submission_preview`](https://github.com/DocSpring/docspring-ruby/blob/main/docs/Client.md#generate_submission_preview) | Generate a preview PDF |
|
|
106
108
|
| [`get_combined_pdf`](https://github.com/DocSpring/docspring-ruby/blob/main/docs/Client.md#get_combined_pdf) | Get a combined PDF |
|
|
107
109
|
| [`get_custom_file`](https://github.com/DocSpring/docspring-ruby/blob/main/docs/Client.md#get_custom_file) | Get a custom file |
|
|
@@ -111,28 +113,35 @@ Ruby code for every method.
|
|
|
111
113
|
| [`get_submission`](https://github.com/DocSpring/docspring-ruby/blob/main/docs/Client.md#get_submission) | Get a submission |
|
|
112
114
|
| [`get_submission_batch`](https://github.com/DocSpring/docspring-ruby/blob/main/docs/Client.md#get_submission_batch) | Get a batch |
|
|
113
115
|
| [`get_template`](https://github.com/DocSpring/docspring-ruby/blob/main/docs/Client.md#get_template) | Get a template |
|
|
116
|
+
| [`get_template_diff`](https://github.com/DocSpring/docspring-ruby/blob/main/docs/Client.md#get_template_diff) | Compare a version of a template with the one before it |
|
|
114
117
|
| [`get_template_model_code`](https://github.com/DocSpring/docspring-ruby/blob/main/docs/Client.md#get_template_model_code) | Generate typed code for a template's submission data |
|
|
118
|
+
| [`get_template_page_images`](https://github.com/DocSpring/docspring-ruby/blob/main/docs/Client.md#get_template_page_images) | Get images of a template's pages |
|
|
115
119
|
| [`get_template_schema`](https://github.com/DocSpring/docspring-ruby/blob/main/docs/Client.md#get_template_schema) | Get the JSON Schema of a template's submission data |
|
|
116
120
|
| [`get_webhook`](https://github.com/DocSpring/docspring-ruby/blob/main/docs/Client.md#get_webhook) | Get a webhook |
|
|
117
121
|
| [`list_combined_pdfs`](https://github.com/DocSpring/docspring-ruby/blob/main/docs/Client.md#list_combined_pdfs) | List combined PDFs |
|
|
118
122
|
| [`list_custom_files`](https://github.com/DocSpring/docspring-ruby/blob/main/docs/Client.md#list_custom_files) | List custom files |
|
|
119
123
|
| [`list_folders`](https://github.com/DocSpring/docspring-ruby/blob/main/docs/Client.md#list_folders) | List folders |
|
|
120
124
|
| [`list_submissions`](https://github.com/DocSpring/docspring-ruby/blob/main/docs/Client.md#list_submissions) | List submissions |
|
|
125
|
+
| [`list_template_fields`](https://github.com/DocSpring/docspring-ruby/blob/main/docs/Client.md#list_template_fields) | List a template's fields |
|
|
121
126
|
| [`list_template_submissions`](https://github.com/DocSpring/docspring-ruby/blob/main/docs/Client.md#list_template_submissions) | List a template's submissions |
|
|
122
127
|
| [`list_templates`](https://github.com/DocSpring/docspring-ruby/blob/main/docs/Client.md#list_templates) | List templates |
|
|
123
128
|
| [`list_webhooks`](https://github.com/DocSpring/docspring-ruby/blob/main/docs/Client.md#list_webhooks) | List webhooks |
|
|
124
129
|
| [`move_folder`](https://github.com/DocSpring/docspring-ruby/blob/main/docs/Client.md#move_folder) | Move a folder |
|
|
125
130
|
| [`move_template`](https://github.com/DocSpring/docspring-ruby/blob/main/docs/Client.md#move_template) | Move a template to a folder |
|
|
126
131
|
| [`publish_template_version`](https://github.com/DocSpring/docspring-ruby/blob/main/docs/Client.md#publish_template_version) | Publish a template version |
|
|
132
|
+
| [`remove_template_fields`](https://github.com/DocSpring/docspring-ruby/blob/main/docs/Client.md#remove_template_fields) | Remove fields from a template |
|
|
127
133
|
| [`rename_folder`](https://github.com/DocSpring/docspring-ruby/blob/main/docs/Client.md#rename_folder) | Rename a folder |
|
|
134
|
+
| [`reorder_template_fields`](https://github.com/DocSpring/docspring-ruby/blob/main/docs/Client.md#reorder_template_fields) | Reorder a template's fields |
|
|
128
135
|
| [`restore_template_version`](https://github.com/DocSpring/docspring-ruby/blob/main/docs/Client.md#restore_template_version) | Restore a template version |
|
|
129
136
|
| [`test_authentication`](https://github.com/DocSpring/docspring-ruby/blob/main/docs/Client.md#test_authentication) | Test authentication |
|
|
130
137
|
| [`update_signature_request`](https://github.com/DocSpring/docspring-ruby/blob/main/docs/Client.md#update_signature_request) | Update a signature request |
|
|
131
138
|
| [`update_template`](https://github.com/DocSpring/docspring-ruby/blob/main/docs/Client.md#update_template) | Update a template |
|
|
132
139
|
| [`update_template_document`](https://github.com/DocSpring/docspring-ruby/blob/main/docs/Client.md#update_template_document) | Replace a template's PDF |
|
|
140
|
+
| [`update_template_fields`](https://github.com/DocSpring/docspring-ruby/blob/main/docs/Client.md#update_template_fields) | Update a template's fields |
|
|
133
141
|
| [`update_webhook`](https://github.com/DocSpring/docspring-ruby/blob/main/docs/Client.md#update_webhook) | Update a webhook |
|
|
134
142
|
| [`upload_template`](https://github.com/DocSpring/docspring-ruby/blob/main/docs/Client.md#upload_template) | Create a PDF template from an uploaded PDF |
|
|
135
143
|
| [`upload_template_document`](https://github.com/DocSpring/docspring-ruby/blob/main/docs/Client.md#upload_template_document) | Replace a template's PDF with an uploaded PDF |
|
|
144
|
+
| [`validate_submission`](https://github.com/DocSpring/docspring-ruby/blob/main/docs/Client.md#validate_submission) | Check a submission without creating it |
|
|
136
145
|
|
|
137
146
|
## Errors
|
|
138
147
|
|
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
# DocSpring::AddTemplateFieldsRequest
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **fields** | [**Array<FieldInput>**](FieldInput.md) | The fields to add. Settings left out have their defaults, except that a field with the name of other fields takes their shared settings. Shared settings it sets change them for every field with the name. | |
|
|
8
|
+
|
|
9
|
+
## Example
|
|
10
|
+
|
|
11
|
+
```ruby
|
|
12
|
+
require 'docspring'
|
|
13
|
+
|
|
14
|
+
instance = DocSpring::AddTemplateFieldsRequest.new(
|
|
15
|
+
fields: null
|
|
16
|
+
)
|
|
17
|
+
```
|
|
18
|
+
|