docspring 4.1.0 → 4.2.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.
Files changed (69) hide show
  1. checksums.yaml +4 -4
  2. data/.openapi-generator/FILES +15 -0
  3. data/.travis.yml +1 -1
  4. data/AGENTS.md +3 -2
  5. data/CHANGELOG.md +40 -0
  6. data/Gemfile.lock +9 -9
  7. data/README.md +5 -1
  8. data/docs/Client.md +176 -10
  9. data/docs/CombinedPdf.md +1 -1
  10. data/docs/CreateCombinedPdfRequest.md +1 -1
  11. data/docs/CreateSubmissionRequest.md +2 -2
  12. data/docs/CreateTemplatePreviewRequest.md +18 -0
  13. data/docs/CreateTemplateRequest.md +3 -1
  14. data/docs/ErrorDetail.md +1 -1
  15. data/docs/ErrorInfo.md +4 -4
  16. data/docs/Submission.md +15 -15
  17. data/docs/SubmissionInput.md +2 -2
  18. data/docs/SubmissionList.md +1 -1
  19. data/docs/SubmissionSummary.md +54 -0
  20. data/docs/Template.md +12 -10
  21. data/docs/TemplateActor.md +1 -1
  22. data/docs/TemplateDocument.md +5 -5
  23. data/docs/TemplateDocumentSummary.md +24 -0
  24. data/docs/TemplatePreview.md +32 -0
  25. data/docs/TemplatePreviewState.md +15 -0
  26. data/docs/TemplateSummary.md +2 -48
  27. data/docs/UpdateTemplateRequest.md +4 -2
  28. data/docs/ValidateSubmissionRequest.md +2 -2
  29. data/lib/docspring/api/client.rb +178 -8
  30. data/lib/docspring/api_client.rb +4 -2
  31. data/lib/docspring/date_time_values.rb +33 -0
  32. data/lib/docspring/models/combined_pdf.rb +1 -1
  33. data/lib/docspring/models/create_combined_pdf_request.rb +1 -1
  34. data/lib/docspring/models/create_submission_request.rb +2 -2
  35. data/lib/docspring/models/create_template_preview_request.rb +187 -0
  36. data/lib/docspring/models/create_template_request.rb +12 -2
  37. data/lib/docspring/models/error_code.rb +3 -1
  38. data/lib/docspring/models/error_detail.rb +1 -1
  39. data/lib/docspring/models/error_info.rb +4 -4
  40. data/lib/docspring/models/submission.rb +140 -140
  41. data/lib/docspring/models/submission_input.rb +2 -2
  42. data/lib/docspring/models/submission_list.rb +1 -1
  43. data/lib/docspring/models/submission_summary.rb +601 -0
  44. data/lib/docspring/models/template.rb +96 -83
  45. data/lib/docspring/models/template_actor.rb +1 -1
  46. data/lib/docspring/models/template_document.rb +42 -42
  47. data/lib/docspring/models/template_document_summary.rb +260 -0
  48. data/lib/docspring/models/template_preview.rb +356 -0
  49. data/lib/docspring/models/template_preview_state.rb +42 -0
  50. data/lib/docspring/models/template_summary.rb +5 -572
  51. data/lib/docspring/models/update_template_request.rb +16 -6
  52. data/lib/docspring/models/validate_submission_request.rb +2 -2
  53. data/lib/docspring/request_schemas.json +105 -8
  54. data/lib/docspring/version.rb +1 -1
  55. data/lib/docspring/webhook_signature.rb +45 -0
  56. data/lib/docspring.rb +6 -0
  57. data/spec/api/client_spec.rb +39 -4
  58. data/spec/models/create_template_preview_request_spec.rb +36 -0
  59. data/spec/models/create_template_request_spec.rb +6 -0
  60. data/spec/models/submission_spec.rb +12 -12
  61. data/spec/models/submission_summary_spec.rb +144 -0
  62. data/spec/models/template_document_spec.rb +5 -5
  63. data/spec/models/template_document_summary_spec.rb +54 -0
  64. data/spec/models/template_preview_spec.rb +78 -0
  65. data/spec/models/template_preview_state_spec.rb +30 -0
  66. data/spec/models/template_spec.rb +28 -22
  67. data/spec/models/template_summary_spec.rb +0 -138
  68. data/spec/models/update_template_request_spec.rb +6 -0
  69. metadata +23 -1
data/spec/models/update_template_request_spec.rb CHANGED
@@ -237,4 +237,10 @@ describe DocSpring::UpdateTemplateRequest do
237
237
  end
238
238
  end
239
239
 
240
+ describe 'test attribute "html_escape_data"' do
241
+ it 'should work' do
242
+ # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
243
+ end
244
+ end
245
+
240
246
  end
metadata CHANGED
@@ -1,7 +1,7 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: docspring
3
3
  version: !ruby/object:Gem::Version
4
- version: 4.1.0
4
+ version: 4.2.0
5
5
  platform: ruby
6
6
  authors:
7
7
  - DocSpring
@@ -108,6 +108,7 @@ files:
108
108
  - docs/CreateSignatureRequestTokenRequest.md
109
109
  - docs/CreateSubmissionBatchRequest.md
110
110
  - docs/CreateSubmissionRequest.md
111
+ - docs/CreateTemplatePreviewRequest.md
111
112
  - docs/CreateTemplateRequest.md
112
113
  - docs/CreateWebhookRequest.md
113
114
  - docs/CustomFile.md
@@ -189,6 +190,7 @@ files:
189
190
  - docs/SubmissionSource.md
190
191
  - docs/SubmissionSourcePdf.md
191
192
  - docs/SubmissionState.md
193
+ - docs/SubmissionSummary.md
192
194
  - docs/SubmissionValidation.md
193
195
  - docs/Template.md
194
196
  - docs/TemplateActor.md
@@ -199,6 +201,7 @@ files:
199
201
  - docs/TemplateDiffSummary.md
200
202
  - docs/TemplateDocument.md
201
203
  - docs/TemplateDocumentState.md
204
+ - docs/TemplateDocumentSummary.md
202
205
  - docs/TemplateFieldChange.md
203
206
  - docs/TemplateFieldChanges.md
204
207
  - docs/TemplateFieldDependency.md
@@ -219,6 +222,8 @@ files:
219
222
  - docs/TemplatePageImageStatus.md
220
223
  - docs/TemplatePageImages.md
221
224
  - docs/TemplatePageProcessingStatus.md
225
+ - docs/TemplatePreview.md
226
+ - docs/TemplatePreviewState.md
222
227
  - docs/TemplateSourcePdf.md
223
228
  - docs/TemplateSummary.md
224
229
  - docs/TemplateSummaryList.md
@@ -249,6 +254,7 @@ files:
249
254
  - lib/docspring/api_error.rb
250
255
  - lib/docspring/api_model_base.rb
251
256
  - lib/docspring/configuration.rb
257
+ - lib/docspring/date_time_values.rb
252
258
  - lib/docspring/ethon_multipart_put_fix.rb
253
259
  - lib/docspring/models/add_template_fields_request.rb
254
260
  - lib/docspring/models/ai_field_naming_language.rb
@@ -272,6 +278,7 @@ files:
272
278
  - lib/docspring/models/create_signature_request_token_request.rb
273
279
  - lib/docspring/models/create_submission_batch_request.rb
274
280
  - lib/docspring/models/create_submission_request.rb
281
+ - lib/docspring/models/create_template_preview_request.rb
275
282
  - lib/docspring/models/create_template_request.rb
276
283
  - lib/docspring/models/create_webhook_request.rb
277
284
  - lib/docspring/models/custom_file.rb
@@ -353,6 +360,7 @@ files:
353
360
  - lib/docspring/models/submission_source.rb
354
361
  - lib/docspring/models/submission_source_pdf.rb
355
362
  - lib/docspring/models/submission_state.rb
363
+ - lib/docspring/models/submission_summary.rb
356
364
  - lib/docspring/models/submission_validation.rb
357
365
  - lib/docspring/models/template.rb
358
366
  - lib/docspring/models/template_actor.rb
@@ -363,6 +371,7 @@ files:
363
371
  - lib/docspring/models/template_diff_summary.rb
364
372
  - lib/docspring/models/template_document.rb
365
373
  - lib/docspring/models/template_document_state.rb
374
+ - lib/docspring/models/template_document_summary.rb
366
375
  - lib/docspring/models/template_field_change.rb
367
376
  - lib/docspring/models/template_field_changes.rb
368
377
  - lib/docspring/models/template_field_dependency.rb
@@ -383,6 +392,8 @@ files:
383
392
  - lib/docspring/models/template_page_image_status.rb
384
393
  - lib/docspring/models/template_page_images.rb
385
394
  - lib/docspring/models/template_page_processing_status.rb
395
+ - lib/docspring/models/template_preview.rb
396
+ - lib/docspring/models/template_preview_state.rb
386
397
  - lib/docspring/models/template_source_pdf.rb
387
398
  - lib/docspring/models/template_summary.rb
388
399
  - lib/docspring/models/template_summary_list.rb
@@ -409,6 +420,7 @@ files:
409
420
  - lib/docspring/request_schemas.json
410
421
  - lib/docspring/request_validator.rb
411
422
  - lib/docspring/version.rb
423
+ - lib/docspring/webhook_signature.rb
412
424
  - spec/api/client_spec.rb
413
425
  - spec/models/add_template_fields_request_spec.rb
414
426
  - spec/models/ai_field_naming_language_spec.rb
@@ -432,6 +444,7 @@ files:
432
444
  - spec/models/create_signature_request_token_request_spec.rb
433
445
  - spec/models/create_submission_batch_request_spec.rb
434
446
  - spec/models/create_submission_request_spec.rb
447
+ - spec/models/create_template_preview_request_spec.rb
435
448
  - spec/models/create_template_request_spec.rb
436
449
  - spec/models/create_webhook_request_spec.rb
437
450
  - spec/models/custom_file_list_spec.rb
@@ -513,6 +526,7 @@ files:
513
526
  - spec/models/submission_source_spec.rb
514
527
  - spec/models/submission_spec.rb
515
528
  - spec/models/submission_state_spec.rb
529
+ - spec/models/submission_summary_spec.rb
516
530
  - spec/models/submission_validation_spec.rb
517
531
  - spec/models/template_actor_spec.rb
518
532
  - spec/models/template_actor_type_spec.rb
@@ -522,6 +536,7 @@ files:
522
536
  - spec/models/template_diff_summary_spec.rb
523
537
  - spec/models/template_document_spec.rb
524
538
  - spec/models/template_document_state_spec.rb
539
+ - spec/models/template_document_summary_spec.rb
525
540
  - spec/models/template_field_change_spec.rb
526
541
  - spec/models/template_field_changes_spec.rb
527
542
  - spec/models/template_field_dependency_action_spec.rb
@@ -542,6 +557,8 @@ files:
542
557
  - spec/models/template_page_image_status_spec.rb
543
558
  - spec/models/template_page_images_spec.rb
544
559
  - spec/models/template_page_processing_status_spec.rb
560
+ - spec/models/template_preview_spec.rb
561
+ - spec/models/template_preview_state_spec.rb
545
562
  - spec/models/template_source_pdf_spec.rb
546
563
  - spec/models/template_spec.rb
547
564
  - spec/models/template_summary_list_spec.rb
@@ -612,6 +629,7 @@ test_files:
612
629
  - spec/models/create_signature_request_token_request_spec.rb
613
630
  - spec/models/create_submission_batch_request_spec.rb
614
631
  - spec/models/create_submission_request_spec.rb
632
+ - spec/models/create_template_preview_request_spec.rb
615
633
  - spec/models/create_template_request_spec.rb
616
634
  - spec/models/create_webhook_request_spec.rb
617
635
  - spec/models/custom_file_list_spec.rb
@@ -693,6 +711,7 @@ test_files:
693
711
  - spec/models/submission_source_spec.rb
694
712
  - spec/models/submission_spec.rb
695
713
  - spec/models/submission_state_spec.rb
714
+ - spec/models/submission_summary_spec.rb
696
715
  - spec/models/submission_validation_spec.rb
697
716
  - spec/models/template_actor_spec.rb
698
717
  - spec/models/template_actor_type_spec.rb
@@ -702,6 +721,7 @@ test_files:
702
721
  - spec/models/template_diff_summary_spec.rb
703
722
  - spec/models/template_document_spec.rb
704
723
  - spec/models/template_document_state_spec.rb
724
+ - spec/models/template_document_summary_spec.rb
705
725
  - spec/models/template_field_change_spec.rb
706
726
  - spec/models/template_field_changes_spec.rb
707
727
  - spec/models/template_field_dependency_action_spec.rb
@@ -722,6 +742,8 @@ test_files:
722
742
  - spec/models/template_page_image_status_spec.rb
723
743
  - spec/models/template_page_images_spec.rb
724
744
  - spec/models/template_page_processing_status_spec.rb
745
+ - spec/models/template_preview_spec.rb
746
+ - spec/models/template_preview_state_spec.rb
725
747
  - spec/models/template_source_pdf_spec.rb
726
748
  - spec/models/template_spec.rb
727
749
  - spec/models/template_summary_list_spec.rb