docspring 4.4.0 → 4.5.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 (43) hide show
  1. checksums.yaml +4 -4
  2. data/.openapi-generator/FILES +6 -0
  3. data/AGENTS.md +2 -0
  4. data/CHANGELOG.md +15 -0
  5. data/Gemfile.lock +10 -10
  6. data/LICENSE +1 -1
  7. data/README.md +4 -1
  8. data/docs/Client.md +98 -96
  9. data/docs/CreateSubmissionRequest.md +3 -3
  10. data/docs/CreateTemplateRequest.md +11 -3
  11. data/docs/ErrorInfo.md +7 -3
  12. data/docs/HtmlEngineOptions.md +4 -4
  13. data/docs/HtmlEngineOptionsInput.md +4 -4
  14. data/docs/SubmissionInput.md +1 -1
  15. data/docs/Template.md +10 -2
  16. data/docs/TemplateFormSection.md +24 -0
  17. data/docs/TemplateFormSectionInput.md +24 -0
  18. data/docs/UpdateTemplateRequest.md +10 -2
  19. data/docs/ValidateSubmissionRequest.md +3 -3
  20. data/lib/docspring/api/client.rb +99 -96
  21. data/lib/docspring/api_client.rb +1 -1
  22. data/lib/docspring/models/create_submission_request.rb +3 -3
  23. data/lib/docspring/models/create_template_request.rb +48 -6
  24. data/lib/docspring/models/error_info.rb +26 -6
  25. data/lib/docspring/models/html_engine_options.rb +4 -4
  26. data/lib/docspring/models/html_engine_options_input.rb +4 -4
  27. data/lib/docspring/models/submission_input.rb +1 -1
  28. data/lib/docspring/models/template.rb +85 -3
  29. data/lib/docspring/models/template_form_section.rb +254 -0
  30. data/lib/docspring/models/template_form_section_input.rb +252 -0
  31. data/lib/docspring/models/update_template_request.rb +47 -3
  32. data/lib/docspring/models/validate_submission_request.rb +3 -3
  33. data/lib/docspring/request_schemas.json +84 -10
  34. data/lib/docspring/version.rb +1 -1
  35. data/lib/docspring.rb +2 -0
  36. data/spec/api/client_spec.rb +49 -48
  37. data/spec/models/create_template_request_spec.rb +24 -0
  38. data/spec/models/error_info_spec.rb +12 -0
  39. data/spec/models/template_form_section_input_spec.rb +54 -0
  40. data/spec/models/template_form_section_spec.rb +54 -0
  41. data/spec/models/template_spec.rb +24 -0
  42. data/spec/models/update_template_request_spec.rb +24 -0
  43. metadata +9 -1
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: '06689a7623615dd4907cfb24376f8eac296b83f743e49d4d8c734f30b620115d'
4
- data.tar.gz: 9e7678924d7b901941430d3342a680d05c080bab4896cb4329b7ecdd216660bd
3
+ metadata.gz: cc16868d6e18877259bb5b73f6dd74122dc6990538dd517988adb02e77a4c87c
4
+ data.tar.gz: c0e126d95a0e2c7ded395fe479832a1d0a9318e5d81a5f5e575120d5250bb4cf
5
5
  SHA512:
6
- metadata.gz: 152eda44814798d0e00c7cb6b01d313fa07f8285e38cc0c8c8abb0aa43959fd452434b07e3f620a84ecf1820e183493a1fcdd152e899eb22aa4d2524182fb212
7
- data.tar.gz: 5634ed9564608f3c14b9e5583e29e186c28282a49e08ea656d1b40fc881e9a2d25c882d48378deeb17806bbc3b61c68e281859b3d0e397c1c5f6a56a2119c023
6
+ metadata.gz: 692fa902d8f0e7b869cfe67e9fe48af9170cffb9259477df89a254428063d8dd4f0581b55df2f5cfbf2c1703b9b321bc9dbb23897abf08a886ffead1de1255a9
7
+ data.tar.gz: 4085af7743e15bcf577e7e57266288a148dffe44a85e43be10320045e5f0760b50c7a119c57d0ac9ed3c92a9c0ec7d1b5637c15d6332f8a437785691d30f1c87
@@ -161,6 +161,8 @@ docs/TemplateFieldLogicStatus.md
161
161
  docs/TemplateFieldMove.md
162
162
  docs/TemplateFields.md
163
163
  docs/TemplateFormMode.md
164
+ docs/TemplateFormSection.md
165
+ docs/TemplateFormSectionInput.md
164
166
  docs/TemplateModelCode.md
165
167
  docs/TemplatePageAiError.md
166
168
  docs/TemplatePageAiNamingStatus.md
@@ -358,6 +360,8 @@ lib/docspring/models/template_field_logic_status.rb
358
360
  lib/docspring/models/template_field_move.rb
359
361
  lib/docspring/models/template_fields.rb
360
362
  lib/docspring/models/template_form_mode.rb
363
+ lib/docspring/models/template_form_section.rb
364
+ lib/docspring/models/template_form_section_input.rb
361
365
  lib/docspring/models/template_model_code.rb
362
366
  lib/docspring/models/template_page_ai_error.rb
363
367
  lib/docspring/models/template_page_ai_naming_status.rb
@@ -548,6 +552,8 @@ spec/models/template_field_logic_status_spec.rb
548
552
  spec/models/template_field_move_spec.rb
549
553
  spec/models/template_fields_spec.rb
550
554
  spec/models/template_form_mode_spec.rb
555
+ spec/models/template_form_section_input_spec.rb
556
+ spec/models/template_form_section_spec.rb
551
557
  spec/models/template_model_code_spec.rb
552
558
  spec/models/template_page_ai_error_spec.rb
553
559
  spec/models/template_page_ai_naming_status_spec.rb
data/AGENTS.md CHANGED
@@ -20,6 +20,8 @@ keeps it.
20
20
  - https://docspring.com/docs/: the guides. https://docspring.com/docs/api/: the API reference, with Ruby code
21
21
  for every method.
22
22
  - https://docspring.com/api-docs/v2/openapi.json: the OpenAPI spec this SDK is generated from.
23
+ - https://docspring.com/docs/cli/: the DocSpring CLI (`docspring`), for scripts and terminal work outside Ruby
24
+ code. https://docspring.com/docs/mcp/: the MCP server, which connects AI assistants to a DocSpring account.
23
25
 
24
26
  ## Set up
25
27
 
data/CHANGELOG.md CHANGED
@@ -1,3 +1,18 @@
1
+ ### 4.5.0 [November 7, 2026]
2
+
3
+ - New: `Template` has `form_sections`, the web form's sections in order (`TemplateFormSection`: an `id`, a `title`, a
4
+ `description` and the `field_ids` in it), which update_template takes too. Setting them replaces all of the sections.
5
+ - New: `Template` has `success_title`, `success_message` and `show_fill_again_button`, what the web form shows once
6
+ it's submitted, which create_template and update_template take too.
7
+ - New: create_template and upload_template take `include_office_use_fields`: with `detect_fields`, whether AI field
8
+ setup keeps the fields that only the office receiving the form fills in, such as a "For office use only" box. It
9
+ leaves them out by default (your account's template settings).
10
+ - Changed: the request validator refuses a `filename` that's blank or only whitespace (create_template,
11
+ update_template_document), and an empty `field_groups` list in update_template.
12
+ - New: a 409 `idempotency_key_in_use` error names what the first request with the key did: the email action
13
+ (`email_action_id`) or email domain (`email_domain_id`) it created, or the template whose fields it changed or whose
14
+ version it published (`template_id`).
15
+
1
16
  ### 4.4.0 [November 1, 2026]
2
17
 
3
18
  - New: list_email_actions, create_email_action, get_email_action, update_email_action and delete_email_action manage a
data/Gemfile.lock CHANGED
@@ -1,7 +1,7 @@
1
1
  PATH
2
2
  remote: .
3
3
  specs:
4
- docspring (4.4.0)
4
+ docspring (4.5.0)
5
5
  logger
6
6
  typhoeus (~> 1.0, >= 1.0.1)
7
7
 
@@ -55,15 +55,15 @@ GEM
55
55
  rspec-core (~> 3.13.0)
56
56
  rspec-expectations (~> 3.13.0)
57
57
  rspec-mocks (~> 3.13.0)
58
- rspec-core (3.13.6)
58
+ rspec-core (3.13.7)
59
59
  rspec-support (~> 3.13.0)
60
- rspec-expectations (3.13.5)
60
+ rspec-expectations (3.13.6)
61
61
  diff-lcs (>= 1.2.0, < 2.0)
62
62
  rspec-support (~> 3.13.0)
63
- rspec-mocks (3.13.8)
63
+ rspec-mocks (3.13.9)
64
64
  diff-lcs (>= 1.2.0, < 2.0)
65
65
  rspec-support (~> 3.13.0)
66
- rspec-support (3.13.7)
66
+ rspec-support (3.13.8)
67
67
  rubocop (0.66.0)
68
68
  jaro_winkler (~> 1.5.1)
69
69
  parallel (~> 1.10)
@@ -105,7 +105,7 @@ CHECKSUMS
105
105
  coderay (1.1.3) sha256=dc530018a4684512f8f38143cd2a096c9f02a1fc2459edcfe534787a7fc77d4b
106
106
  date (3.6.0) sha256=18ac945c4e24ebd93534f8eab8c2fd8c5604b3e977105b3798d62a1e8d27b580
107
107
  diff-lcs (1.6.2) sha256=9ae0d2cba7d4df3075fe8cd8602a8604993efc0dfa934cff568969efb1909962
108
- docspring (4.4.0)
108
+ docspring (4.5.0)
109
109
  ethon (0.19.1) sha256=f309dec67cfdefaf96b3d1ee0ed4f186eac518f131340f607bb3df3b4e13ddc4
110
110
  ffi (1.17.4) sha256=bcd1642e06f0d16fc9e09ac6d49c3a7298b9789bcb58127302f934e437d60acf
111
111
  ffi (1.17.4-aarch64-linux-gnu) sha256=b208f06f91ffd8f5e1193da3cae3d2ccfc27fc36fba577baf698d26d91c080df
@@ -132,10 +132,10 @@ CHECKSUMS
132
132
  rake (13.0.6) sha256=5ce4bf5037b4196c24ac62834d8db1ce175470391026bd9e557d669beeb19097
133
133
  reline (0.7.0) sha256=5b012d8e55dbf9d450f12bde2cf7d15ff546ae80b3f8f3b30e570d431815583d
134
134
  rspec (3.13.2) sha256=206284a08ad798e61f86d7ca3e376718d52c0bc944626b2349266f239f820587
135
- rspec-core (3.13.6) sha256=a8823c6411667b60a8bca135364351dda34cd55e44ff94c4be4633b37d828b2d
136
- rspec-expectations (3.13.5) sha256=33a4d3a1d95060aea4c94e9f237030a8f9eae5615e9bd85718fe3a09e4b58836
137
- rspec-mocks (3.13.8) sha256=086ad3d3d17533f4237643de0b5c42f04b66348c28bf6b9c2d3f4a3b01af1d47
138
- rspec-support (3.13.7) sha256=0640e5570872aafefd79867901deeeeb40b0c9875a36b983d85f54fb7381c47c
135
+ rspec-core (3.13.7) sha256=c64ff16d9788119805cbc6a3f4b6d87cc22417c2d25976a3330de136896b5469
136
+ rspec-expectations (3.13.6) sha256=bf538ca6d367ff5b0d85a87fdb5c0c6038f2cd1308a0eeba07476caa02d22f35
137
+ rspec-mocks (3.13.9) sha256=ea5c7ff3054a6098ca6039aacef80aec69d5a8a3ef80be8fc88337359b672a30
138
+ rspec-support (3.13.8) sha256=e4160030309b7e3e9d9863dfe720a35dfcc577162f5402cd68fc8c5258a0ffd6
139
139
  rubocop (0.66.0) sha256=f05a6896f367765b3f0fba663d0add120444f8de604dada405662b10a0860f5a
140
140
  ruby-progressbar (1.13.0) sha256=80fc9c47a9b640d6834e0dc7b3c94c9df37f08cb072b7761e4a71e22cff29b33
141
141
  stringio (3.2.0) sha256=c37cb2e58b4ffbd33fe5cd948c05934af997b36e0b6ca6fdf43afa234cf222e1
data/LICENSE CHANGED
@@ -1,4 +1,4 @@
1
- Copyright © 2018-2020 DocSpring, Inc.
1
+ Copyright © 2018-2026 DocSpring, Inc.
2
2
 
3
3
  Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
4
4
 
data/README.md CHANGED
@@ -10,7 +10,10 @@ e-signatures.
10
10
  The code in this repository is generated from DocSpring's OpenAPI spec ([About this SDK](#about-this-sdk)). Issues and
11
11
  pull requests are welcome.
12
12
 
13
- Version 4.4.0. Requires Ruby >= 2.7.
13
+ Outside Ruby code, the [DocSpring CLI](https://docspring.com/docs/cli/) calls the same API from a terminal or a
14
+ shell script, and the [MCP server](https://docspring.com/docs/mcp/) connects AI assistants to your account.
15
+
16
+ Version 4.5.0. Requires Ruby >= 2.7.
14
17
 
15
18
  ## Install and configure
16
19