docspring 4.3.0 → 4.4.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 (160) hide show
  1. checksums.yaml +4 -4
  2. data/.github/workflows/release.yml +80 -0
  3. data/.openapi-generator/FILES +84 -0
  4. data/CHANGELOG.md +55 -0
  5. data/Gemfile.lock +2 -2
  6. data/README.md +20 -1
  7. data/docs/AddTemplateFieldsRequest.md +1 -1
  8. data/docs/Client.md +2311 -766
  9. data/docs/CombinedPdfSource.md +1 -1
  10. data/docs/CreateAccountEmailActionRequest.md +54 -0
  11. data/docs/CreateEmailActionRequest.md +50 -0
  12. data/docs/CreateEmailDomainRequest.md +18 -0
  13. data/docs/CreateSubmissionBatchRequest.md +2 -2
  14. data/docs/CreateSubmissionRequest.md +22 -4
  15. data/docs/CreateTemplateRequest.md +22 -6
  16. data/docs/DnsRecordType.md +15 -0
  17. data/docs/EmailAction.md +76 -0
  18. data/docs/EmailActionConditions.md +20 -0
  19. data/docs/EmailActionConditionsInput.md +20 -0
  20. data/docs/EmailActionCustomization.md +36 -0
  21. data/docs/EmailActionDelivery.md +15 -0
  22. data/docs/EmailActionFileFormats.md +15 -0
  23. data/docs/EmailActionList.md +20 -0
  24. data/docs/EmailActionSetting.md +15 -0
  25. data/docs/EmailActionSubmissionType.md +15 -0
  26. data/docs/EmailActionTestEmail.md +18 -0
  27. data/docs/EmailDomain.md +38 -0
  28. data/docs/EmailDomainDnsRecord.md +24 -0
  29. data/docs/EmailDomainDnsRecordPurpose.md +15 -0
  30. data/docs/EmailDomainList.md +20 -0
  31. data/docs/EmailDomainRecordState.md +15 -0
  32. data/docs/EmailDomainState.md +15 -0
  33. data/docs/ErrorInfo.md +12 -6
  34. data/docs/Field.md +1 -1
  35. data/docs/FieldInput.md +1 -1
  36. data/docs/HtmlEngineOptions.md +1 -1
  37. data/docs/HtmlEngineOptionsInput.md +1 -1
  38. data/docs/SendAccountEmailActionTestEmailRequest.md +18 -0
  39. data/docs/SignatureRequest.md +9 -1
  40. data/docs/SignatureRequestEmailAttachments.md +15 -0
  41. data/docs/SignatureRequestEmailStatus.md +15 -0
  42. data/docs/SignatureRequestInput.md +7 -3
  43. data/docs/SignatureRequestReminders.md +20 -0
  44. data/docs/SigningOrder.md +15 -0
  45. data/docs/Submission.md +4 -2
  46. data/docs/SubmissionAction.md +5 -3
  47. data/docs/SubmissionInput.md +3 -3
  48. data/docs/SubmissionSummary.md +1 -1
  49. data/docs/Template.md +23 -7
  50. data/docs/TemplateSourcePdf.md +1 -1
  51. data/docs/TemplateSummary.md +4 -4
  52. data/docs/UpdateAccountEmailActionRequest.md +54 -0
  53. data/docs/UpdateEmailActionCustomizationRequest.md +46 -0
  54. data/docs/UpdateEmailActionRequest.md +50 -0
  55. data/docs/UpdateTemplateDocumentRequest.md +1 -1
  56. data/docs/UpdateTemplateRequest.md +21 -5
  57. data/docs/ValidateSubmissionRequest.md +22 -4
  58. data/lib/docspring/api/client.rb +1749 -314
  59. data/lib/docspring/api_client.rb +1 -1
  60. data/lib/docspring/models/add_template_fields_request.rb +1 -1
  61. data/lib/docspring/models/combined_pdf_source.rb +1 -1
  62. data/lib/docspring/models/create_account_email_action_request.rb +388 -0
  63. data/lib/docspring/models/create_email_action_request.rb +364 -0
  64. data/lib/docspring/models/create_email_domain_request.rb +185 -0
  65. data/lib/docspring/models/create_submission_batch_request.rb +2 -2
  66. data/lib/docspring/models/create_submission_request.rb +143 -7
  67. data/lib/docspring/models/create_template_request.rb +107 -7
  68. data/lib/docspring/models/dns_record_type.rb +42 -0
  69. data/lib/docspring/models/email_action.rb +790 -0
  70. data/lib/docspring/models/email_action_conditions.rb +219 -0
  71. data/lib/docspring/models/email_action_conditions_input.rb +219 -0
  72. data/lib/docspring/models/email_action_customization.rb +360 -0
  73. data/lib/docspring/models/email_action_delivery.rb +41 -0
  74. data/lib/docspring/models/email_action_file_formats.rb +43 -0
  75. data/lib/docspring/models/email_action_list.rb +200 -0
  76. data/lib/docspring/models/email_action_setting.rb +53 -0
  77. data/lib/docspring/models/email_action_submission_type.rb +42 -0
  78. data/lib/docspring/models/email_action_test_email.rb +185 -0
  79. data/lib/docspring/models/email_domain.rb +423 -0
  80. data/lib/docspring/models/email_domain_dns_record.rb +288 -0
  81. data/lib/docspring/models/email_domain_dns_record_purpose.rb +42 -0
  82. data/lib/docspring/models/email_domain_list.rb +200 -0
  83. data/lib/docspring/models/email_domain_record_state.rb +42 -0
  84. data/lib/docspring/models/email_domain_state.rb +42 -0
  85. data/lib/docspring/models/error_code.rb +3 -1
  86. data/lib/docspring/models/error_info.rb +39 -9
  87. data/lib/docspring/models/field.rb +1 -1
  88. data/lib/docspring/models/field_input.rb +1 -1
  89. data/lib/docspring/models/html_engine_options.rb +1 -1
  90. data/lib/docspring/models/html_engine_options_input.rb +1 -1
  91. data/lib/docspring/models/send_account_email_action_test_email_request.rb +168 -0
  92. data/lib/docspring/models/signature_request.rb +68 -2
  93. data/lib/docspring/models/signature_request_email_attachments.rb +41 -0
  94. data/lib/docspring/models/signature_request_email_status.rb +47 -0
  95. data/lib/docspring/models/signature_request_event_type.rb +3 -1
  96. data/lib/docspring/models/signature_request_input.rb +25 -22
  97. data/lib/docspring/models/signature_request_reminders.rb +212 -0
  98. data/lib/docspring/models/signing_order.rb +41 -0
  99. data/lib/docspring/models/string_condition_type.rb +8 -1
  100. data/lib/docspring/models/submission.rb +30 -3
  101. data/lib/docspring/models/submission_action.rb +18 -5
  102. data/lib/docspring/models/submission_input.rb +3 -3
  103. data/lib/docspring/models/submission_summary.rb +1 -1
  104. data/lib/docspring/models/template.rb +144 -8
  105. data/lib/docspring/models/template_source_pdf.rb +1 -1
  106. data/lib/docspring/models/template_summary.rb +4 -4
  107. data/lib/docspring/models/template_type.rb +2 -1
  108. data/lib/docspring/models/update_account_email_action_request.rb +388 -0
  109. data/lib/docspring/models/update_email_action_customization_request.rb +343 -0
  110. data/lib/docspring/models/update_email_action_request.rb +364 -0
  111. data/lib/docspring/models/update_template_document_request.rb +1 -1
  112. data/lib/docspring/models/update_template_request.rb +108 -8
  113. data/lib/docspring/models/validate_submission_request.rb +143 -7
  114. data/lib/docspring/models/webhook_event_type.rb +3 -1
  115. data/lib/docspring/request_schemas.json +1691 -145
  116. data/lib/docspring/request_validator.rb +4 -0
  117. data/lib/docspring/version.rb +1 -1
  118. data/lib/docspring.rb +28 -0
  119. data/spec/api/client_spec.rb +306 -18
  120. data/spec/models/create_account_email_action_request_spec.rb +144 -0
  121. data/spec/models/create_email_action_request_spec.rb +132 -0
  122. data/spec/models/create_email_domain_request_spec.rb +36 -0
  123. data/spec/models/create_submission_request_spec.rb +54 -0
  124. data/spec/models/create_template_request_spec.rb +48 -0
  125. data/spec/models/dns_record_type_spec.rb +30 -0
  126. data/spec/models/email_action_conditions_input_spec.rb +42 -0
  127. data/spec/models/email_action_conditions_spec.rb +42 -0
  128. data/spec/models/email_action_customization_spec.rb +90 -0
  129. data/spec/models/email_action_delivery_spec.rb +30 -0
  130. data/spec/models/email_action_file_formats_spec.rb +30 -0
  131. data/spec/models/email_action_list_spec.rb +42 -0
  132. data/spec/models/email_action_setting_spec.rb +30 -0
  133. data/spec/models/email_action_spec.rb +210 -0
  134. data/spec/models/email_action_submission_type_spec.rb +30 -0
  135. data/spec/models/email_action_test_email_spec.rb +36 -0
  136. data/spec/models/email_domain_dns_record_purpose_spec.rb +30 -0
  137. data/spec/models/email_domain_dns_record_spec.rb +54 -0
  138. data/spec/models/email_domain_list_spec.rb +42 -0
  139. data/spec/models/email_domain_record_state_spec.rb +30 -0
  140. data/spec/models/email_domain_spec.rb +96 -0
  141. data/spec/models/email_domain_state_spec.rb +30 -0
  142. data/spec/models/error_info_spec.rb +18 -0
  143. data/spec/models/send_account_email_action_test_email_request_spec.rb +36 -0
  144. data/spec/models/signature_request_email_attachments_spec.rb +30 -0
  145. data/spec/models/signature_request_email_status_spec.rb +30 -0
  146. data/spec/models/signature_request_input_spec.rb +12 -0
  147. data/spec/models/signature_request_reminders_spec.rb +42 -0
  148. data/spec/models/signature_request_spec.rb +24 -0
  149. data/spec/models/signing_order_spec.rb +30 -0
  150. data/spec/models/submission_action_spec.rb +6 -0
  151. data/spec/models/submission_spec.rb +6 -0
  152. data/spec/models/template_spec.rb +48 -0
  153. data/spec/models/update_account_email_action_request_spec.rb +144 -0
  154. data/spec/models/update_email_action_customization_request_spec.rb +120 -0
  155. data/spec/models/update_email_action_request_spec.rb +132 -0
  156. data/spec/models/update_template_request_spec.rb +48 -0
  157. data/spec/models/validate_submission_request_spec.rb +54 -0
  158. metadata +115 -4
  159. data/.gitlab-ci.yml +0 -26
  160. data/.travis.yml +0 -11
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: e997a9a92a04e7b8eaeb759762e39be31bb36af02db1fa61f65637c984f6e88f
4
- data.tar.gz: 50b74a6a63e254b540af52e18e7c1b32275e4069ed1e71ceb3edea81824532be
3
+ metadata.gz: '06689a7623615dd4907cfb24376f8eac296b83f743e49d4d8c734f30b620115d'
4
+ data.tar.gz: 9e7678924d7b901941430d3342a680d05c080bab4896cb4329b7ecdd216660bd
5
5
  SHA512:
6
- metadata.gz: 1a60aa7099efbb3871f29e3f4ea86c7095fa3495fb62c3f25bdc23c0640425291626c173b923f5baf07126f304ead67c79c970a99ce6244405c3150947b942e3
7
- data.tar.gz: 6ef873b90d45b59c89829065d1d70b225c30e7feb116698a545347c2563580f9fe44fa0fde50378b8bf87052c0ba109d017fd11c52d200dcf55000d57d4f7649
6
+ metadata.gz: 152eda44814798d0e00c7cb6b01d313fa07f8285e38cc0c8c8abb0aa43959fd452434b07e3f620a84ecf1820e183493a1fcdd152e899eb22aa4d2524182fb212
7
+ data.tar.gz: 5634ed9564608f3c14b9e5583e29e186c28282a49e08ea656d1b40fc881e9a2d25c882d48378deeb17806bbc3b61c68e281859b3d0e397c1c5f6a56a2119c023
@@ -0,0 +1,80 @@
1
+ # Written by DocSpring/docspring's api_clients/scripts/generate from api_clients/github_workflows/ruby/release.yml:
2
+ # change it there.
3
+ #
4
+ # Builds the gem on every push and pull request. A v* tag (pushed by the monorepo's api_clients/scripts/release) also
5
+ # pushes it to RubyGems.org with trusted publishing, in the release environment, and waits until RubyGems.org serves
6
+ # it.
7
+ name: Release
8
+
9
+ on:
10
+ push:
11
+ branches: ['**']
12
+ tags: ['v*']
13
+ pull_request:
14
+
15
+ permissions:
16
+ contents: read
17
+
18
+ jobs:
19
+ build:
20
+ runs-on: ubuntu-latest
21
+ steps:
22
+ # The gemspec lists the gem's files with git ls-files
23
+ - uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
24
+ with:
25
+ persist-credentials: false
26
+ - uses: ruby/setup-ruby@de492cf36cbab201753d720ce4f4e336cd688c94 # v1.336.0
27
+ with:
28
+ ruby-version: '3.4'
29
+ - name: Check the tag matches the package version
30
+ if: github.ref_type == 'tag'
31
+ run: |
32
+ VERSION="$(ruby -e 'puts Gem::Specification.load("docspring.gemspec").version')"
33
+ if [ "v$VERSION" != "$GITHUB_REF_NAME" ]; then
34
+ echo "::error::The tag is $GITHUB_REF_NAME, but the package version is $VERSION"
35
+ exit 1
36
+ fi
37
+ - run: gem build docspring.gemspec
38
+ - if: github.ref_type == 'tag'
39
+ uses: actions/upload-artifact@cf430e030ddbb5b0abf93d22962f4752f3646cd9 # v7.0.2
40
+ with:
41
+ name: package
42
+ path: docspring-*.gem
43
+ if-no-files-found: error
44
+
45
+ publish:
46
+ needs: build
47
+ if: github.ref_type == 'tag'
48
+ runs-on: ubuntu-latest
49
+ environment: release
50
+ permissions:
51
+ contents: read
52
+ id-token: write
53
+ steps:
54
+ - uses: ruby/setup-ruby@de492cf36cbab201753d720ce4f4e336cd688c94 # v1.336.0
55
+ with:
56
+ ruby-version: '3.4'
57
+ - uses: actions/download-artifact@9000827ccba6bdab643e8b6fd33ac0654aef8333 # v8.0.2
58
+ with:
59
+ name: package
60
+ - uses: rubygems/configure-rubygems-credentials@dc5a8d8553e6ee01fc26761a49e99e733d17954a # v2.1.0
61
+ - name: Push to RubyGems.org
62
+ run: gem push "docspring-${GITHUB_REF_NAME#v}.gem"
63
+
64
+ verify:
65
+ needs: publish
66
+ runs-on: ubuntu-latest
67
+ timeout-minutes: 15
68
+ steps:
69
+ - name: Wait until RubyGems.org serves the version
70
+ run: |
71
+ VERSION="${GITHUB_REF_NAME#v}"
72
+ for _ in $(seq 60); do
73
+ if curl -fsS -o /dev/null "https://rubygems.org/api/v2/rubygems/docspring/versions/$VERSION.json"; then
74
+ echo "RubyGems.org serves docspring $VERSION"
75
+ exit 0
76
+ fi
77
+ sleep 10
78
+ done
79
+ echo "::error::RubyGems.org doesn't serve docspring $VERSION after 10 minutes"
80
+ exit 1
@@ -22,8 +22,11 @@ docs/CombinedPdfSourcePdf.md
22
22
  docs/CombinedPdfSourceType.md
23
23
  docs/CombinedPdfState.md
24
24
  docs/CopyTemplateRequest.md
25
+ docs/CreateAccountEmailActionRequest.md
25
26
  docs/CreateCombinedPdfRequest.md
26
27
  docs/CreateCustomFileFromUploadRequest.md
28
+ docs/CreateEmailActionRequest.md
29
+ docs/CreateEmailDomainRequest.md
27
30
  docs/CreateFolderRequest.md
28
31
  docs/CreateSignatureRequestEventRequest.md
29
32
  docs/CreateSignatureRequestTokenRequest.md
@@ -35,6 +38,23 @@ docs/CreateWebhookRequest.md
35
38
  docs/CustomFile.md
36
39
  docs/CustomFileList.md
37
40
  docs/CustomFileSourcePdf.md
41
+ docs/DnsRecordType.md
42
+ docs/EmailAction.md
43
+ docs/EmailActionConditions.md
44
+ docs/EmailActionConditionsInput.md
45
+ docs/EmailActionCustomization.md
46
+ docs/EmailActionDelivery.md
47
+ docs/EmailActionFileFormats.md
48
+ docs/EmailActionList.md
49
+ docs/EmailActionSetting.md
50
+ docs/EmailActionSubmissionType.md
51
+ docs/EmailActionTestEmail.md
52
+ docs/EmailDomain.md
53
+ docs/EmailDomainDnsRecord.md
54
+ docs/EmailDomainDnsRecordPurpose.md
55
+ docs/EmailDomainList.md
56
+ docs/EmailDomainRecordState.md
57
+ docs/EmailDomainState.md
38
58
  docs/ErrorCode.md
39
59
  docs/ErrorDetail.md
40
60
  docs/ErrorInfo.md
@@ -87,17 +107,22 @@ docs/RemoveTemplateFieldsRequest.md
87
107
  docs/RenameFolderRequest.md
88
108
  docs/ReorderTemplateFieldsRequest.md
89
109
  docs/RestoreTemplateVersionRequest.md
110
+ docs/SendAccountEmailActionTestEmailRequest.md
90
111
  docs/ShapeType.md
91
112
  docs/SignatureRequest.md
92
113
  docs/SignatureRequestAuthSecondFactorType.md
93
114
  docs/SignatureRequestAuthType.md
115
+ docs/SignatureRequestEmailAttachments.md
116
+ docs/SignatureRequestEmailStatus.md
94
117
  docs/SignatureRequestEvent.md
95
118
  docs/SignatureRequestEventType.md
96
119
  docs/SignatureRequestInput.md
97
120
  docs/SignatureRequestMessageType.md
121
+ docs/SignatureRequestReminders.md
98
122
  docs/SignatureRequestState.md
99
123
  docs/SignatureRequestToken.md
100
124
  docs/SignatureRequestTokenType.md
125
+ docs/SigningOrder.md
101
126
  docs/StringConditionType.md
102
127
  docs/Submission.md
103
128
  docs/SubmissionAction.md
@@ -155,6 +180,9 @@ docs/TextAlignment.md
155
180
  docs/TextOverflow.md
156
181
  docs/TextVerticalAlignment.md
157
182
  docs/Typeface.md
183
+ docs/UpdateAccountEmailActionRequest.md
184
+ docs/UpdateEmailActionCustomizationRequest.md
185
+ docs/UpdateEmailActionRequest.md
158
186
  docs/UpdateSignatureRequestRequest.md
159
187
  docs/UpdateTemplateDocumentRequest.md
160
188
  docs/UpdateTemplateFieldsRequest.md
@@ -191,8 +219,11 @@ lib/docspring/models/combined_pdf_source_pdf.rb
191
219
  lib/docspring/models/combined_pdf_source_type.rb
192
220
  lib/docspring/models/combined_pdf_state.rb
193
221
  lib/docspring/models/copy_template_request.rb
222
+ lib/docspring/models/create_account_email_action_request.rb
194
223
  lib/docspring/models/create_combined_pdf_request.rb
195
224
  lib/docspring/models/create_custom_file_from_upload_request.rb
225
+ lib/docspring/models/create_email_action_request.rb
226
+ lib/docspring/models/create_email_domain_request.rb
196
227
  lib/docspring/models/create_folder_request.rb
197
228
  lib/docspring/models/create_signature_request_event_request.rb
198
229
  lib/docspring/models/create_signature_request_token_request.rb
@@ -204,6 +235,23 @@ lib/docspring/models/create_webhook_request.rb
204
235
  lib/docspring/models/custom_file.rb
205
236
  lib/docspring/models/custom_file_list.rb
206
237
  lib/docspring/models/custom_file_source_pdf.rb
238
+ lib/docspring/models/dns_record_type.rb
239
+ lib/docspring/models/email_action.rb
240
+ lib/docspring/models/email_action_conditions.rb
241
+ lib/docspring/models/email_action_conditions_input.rb
242
+ lib/docspring/models/email_action_customization.rb
243
+ lib/docspring/models/email_action_delivery.rb
244
+ lib/docspring/models/email_action_file_formats.rb
245
+ lib/docspring/models/email_action_list.rb
246
+ lib/docspring/models/email_action_setting.rb
247
+ lib/docspring/models/email_action_submission_type.rb
248
+ lib/docspring/models/email_action_test_email.rb
249
+ lib/docspring/models/email_domain.rb
250
+ lib/docspring/models/email_domain_dns_record.rb
251
+ lib/docspring/models/email_domain_dns_record_purpose.rb
252
+ lib/docspring/models/email_domain_list.rb
253
+ lib/docspring/models/email_domain_record_state.rb
254
+ lib/docspring/models/email_domain_state.rb
207
255
  lib/docspring/models/error_code.rb
208
256
  lib/docspring/models/error_detail.rb
209
257
  lib/docspring/models/error_info.rb
@@ -256,17 +304,22 @@ lib/docspring/models/remove_template_fields_request.rb
256
304
  lib/docspring/models/rename_folder_request.rb
257
305
  lib/docspring/models/reorder_template_fields_request.rb
258
306
  lib/docspring/models/restore_template_version_request.rb
307
+ lib/docspring/models/send_account_email_action_test_email_request.rb
259
308
  lib/docspring/models/shape_type.rb
260
309
  lib/docspring/models/signature_request.rb
261
310
  lib/docspring/models/signature_request_auth_second_factor_type.rb
262
311
  lib/docspring/models/signature_request_auth_type.rb
312
+ lib/docspring/models/signature_request_email_attachments.rb
313
+ lib/docspring/models/signature_request_email_status.rb
263
314
  lib/docspring/models/signature_request_event.rb
264
315
  lib/docspring/models/signature_request_event_type.rb
265
316
  lib/docspring/models/signature_request_input.rb
266
317
  lib/docspring/models/signature_request_message_type.rb
318
+ lib/docspring/models/signature_request_reminders.rb
267
319
  lib/docspring/models/signature_request_state.rb
268
320
  lib/docspring/models/signature_request_token.rb
269
321
  lib/docspring/models/signature_request_token_type.rb
322
+ lib/docspring/models/signing_order.rb
270
323
  lib/docspring/models/string_condition_type.rb
271
324
  lib/docspring/models/submission.rb
272
325
  lib/docspring/models/submission_action.rb
@@ -324,6 +377,9 @@ lib/docspring/models/text_alignment.rb
324
377
  lib/docspring/models/text_overflow.rb
325
378
  lib/docspring/models/text_vertical_alignment.rb
326
379
  lib/docspring/models/typeface.rb
380
+ lib/docspring/models/update_account_email_action_request.rb
381
+ lib/docspring/models/update_email_action_customization_request.rb
382
+ lib/docspring/models/update_email_action_request.rb
327
383
  lib/docspring/models/update_signature_request_request.rb
328
384
  lib/docspring/models/update_template_document_request.rb
329
385
  lib/docspring/models/update_template_fields_request.rb
@@ -354,8 +410,11 @@ spec/models/combined_pdf_source_type_spec.rb
354
410
  spec/models/combined_pdf_spec.rb
355
411
  spec/models/combined_pdf_state_spec.rb
356
412
  spec/models/copy_template_request_spec.rb
413
+ spec/models/create_account_email_action_request_spec.rb
357
414
  spec/models/create_combined_pdf_request_spec.rb
358
415
  spec/models/create_custom_file_from_upload_request_spec.rb
416
+ spec/models/create_email_action_request_spec.rb
417
+ spec/models/create_email_domain_request_spec.rb
359
418
  spec/models/create_folder_request_spec.rb
360
419
  spec/models/create_signature_request_event_request_spec.rb
361
420
  spec/models/create_signature_request_token_request_spec.rb
@@ -367,6 +426,23 @@ spec/models/create_webhook_request_spec.rb
367
426
  spec/models/custom_file_list_spec.rb
368
427
  spec/models/custom_file_source_pdf_spec.rb
369
428
  spec/models/custom_file_spec.rb
429
+ spec/models/dns_record_type_spec.rb
430
+ spec/models/email_action_conditions_input_spec.rb
431
+ spec/models/email_action_conditions_spec.rb
432
+ spec/models/email_action_customization_spec.rb
433
+ spec/models/email_action_delivery_spec.rb
434
+ spec/models/email_action_file_formats_spec.rb
435
+ spec/models/email_action_list_spec.rb
436
+ spec/models/email_action_setting_spec.rb
437
+ spec/models/email_action_spec.rb
438
+ spec/models/email_action_submission_type_spec.rb
439
+ spec/models/email_action_test_email_spec.rb
440
+ spec/models/email_domain_dns_record_purpose_spec.rb
441
+ spec/models/email_domain_dns_record_spec.rb
442
+ spec/models/email_domain_list_spec.rb
443
+ spec/models/email_domain_record_state_spec.rb
444
+ spec/models/email_domain_spec.rb
445
+ spec/models/email_domain_state_spec.rb
370
446
  spec/models/error_code_spec.rb
371
447
  spec/models/error_detail_spec.rb
372
448
  spec/models/error_info_spec.rb
@@ -419,17 +495,22 @@ spec/models/remove_template_fields_request_spec.rb
419
495
  spec/models/rename_folder_request_spec.rb
420
496
  spec/models/reorder_template_fields_request_spec.rb
421
497
  spec/models/restore_template_version_request_spec.rb
498
+ spec/models/send_account_email_action_test_email_request_spec.rb
422
499
  spec/models/shape_type_spec.rb
423
500
  spec/models/signature_request_auth_second_factor_type_spec.rb
424
501
  spec/models/signature_request_auth_type_spec.rb
502
+ spec/models/signature_request_email_attachments_spec.rb
503
+ spec/models/signature_request_email_status_spec.rb
425
504
  spec/models/signature_request_event_spec.rb
426
505
  spec/models/signature_request_event_type_spec.rb
427
506
  spec/models/signature_request_input_spec.rb
428
507
  spec/models/signature_request_message_type_spec.rb
508
+ spec/models/signature_request_reminders_spec.rb
429
509
  spec/models/signature_request_spec.rb
430
510
  spec/models/signature_request_state_spec.rb
431
511
  spec/models/signature_request_token_spec.rb
432
512
  spec/models/signature_request_token_type_spec.rb
513
+ spec/models/signing_order_spec.rb
433
514
  spec/models/string_condition_type_spec.rb
434
515
  spec/models/submission_action_spec.rb
435
516
  spec/models/submission_action_state_spec.rb
@@ -487,6 +568,9 @@ spec/models/text_alignment_spec.rb
487
568
  spec/models/text_overflow_spec.rb
488
569
  spec/models/text_vertical_alignment_spec.rb
489
570
  spec/models/typeface_spec.rb
571
+ spec/models/update_account_email_action_request_spec.rb
572
+ spec/models/update_email_action_customization_request_spec.rb
573
+ spec/models/update_email_action_request_spec.rb
490
574
  spec/models/update_signature_request_request_spec.rb
491
575
  spec/models/update_template_document_request_spec.rb
492
576
  spec/models/update_template_fields_request_spec.rb
data/CHANGELOG.md CHANGED
@@ -1,3 +1,58 @@
1
+ ### 4.4.0 [November 1, 2026]
2
+
3
+ - New: list_email_actions, create_email_action, get_email_action, update_email_action and delete_email_action manage a
4
+ template's email actions (`EmailAction`), which email each processed submission's files as attachments or a download
5
+ link. `to`, `cc` and `bcc` take addresses, and tags for an address in the submission's fields
6
+ (`{{ data.client_email }}`) or metadata (`{{ metadata.agent_email }}`). `send_when` sends only for the submissions
7
+ that meet its conditions. `file_name` names the attached files, and `file_formats` chooses them: a Word template's
8
+ Word document (`docx`), OpenDocument file (`odt`) or PDF (`pdf`), or every file the submission made (`all`). Attached
9
+ files over `max_attachment_mb` together (7 MB unless you raise it, up to 25) go as a link instead.
10
+ send_email_action_test_email sends one to you to check how it looks (`EmailActionTestEmail`). Without a paid plan
11
+ (Starter or higher), email actions only email your team: test emails, and test submissions' emails.
12
+ - New: list_account_email_actions, create_account_email_action, get_account_email_action, update_account_email_action
13
+ and delete_account_email_action manage your account's email actions, which send for every template, or for the
14
+ templates and folders they list (`template_ids`, `folder_ids`). send_account_email_action_test_email sends one to you
15
+ for one of its templates.
16
+ - New: list_email_actions also lists your account's email actions that send for the template, with the template's
17
+ changes in `customization` (`EmailActionCustomization`). update_email_action_customization changes one for that
18
+ template only, or turns it off there (`enabled`), and delete_email_action_customization removes the template's
19
+ changes.
20
+ - New: list_email_domains, create_email_domain, get_email_domain, verify_email_domain and delete_email_domain manage the
21
+ domains your email actions send from (`EmailDomain`), with the DNS records to add to each one (`EmailDomainDnsRecord`).
22
+ - A submission's `actions` include the emails its email actions sent (its template's and your account's), with each
23
+ recipient and what happened to their email, and a new `email_action_id`.
24
+ - New: a field's `string_condition_type` can be `not_equals`, `not_contains`, `not_starts_with`, `not_ends_with`,
25
+ `not_regex`, `blank` or `not_blank`, and a `regex` condition uses RE2 syntax (no lookarounds or backreferences).
26
+ - create_submission: DocSpring now emails the signers of a submission's `signature_requests` a link to sign, any
27
+ reminders, and the signed PDF once everyone has signed. Set `send_email` to false, for the submission or for one
28
+ signature request, when you send the links yourself or show the signing form in your app. A signature request that
29
+ DocSpring emails needs an `email`, and its `auth_type` is optional (`email_link`). Before anyone is emailed, the
30
+ request can be refused with a 402 (`insufficient_credits_to_send`), a 403 or a 429 (`daily_email_limit_reached`), and
31
+ nothing is saved.
32
+ - New create_submission properties for these emails: `signing_order` (`SigningOrder`) with each signature request's
33
+ `signing_step`, `email_subject`, `email_message`, `cc`, `reply_to`, `notification_emails`, `notify_when_signed` and
34
+ `reminders` (`SignatureRequestReminders`).
35
+ - A signature request has `send_email`, `signing_step`, `sent_at` and `email_status` (`SignatureRequestEmailStatus`),
36
+ and a submission has `signing_order`.
37
+ - Templates have new settings for these emails: `signature_request_from_name`, `signature_request_from_address`,
38
+ `signature_request_signing_url`, `signature_request_include_signing_token`, `signature_request_reply_to`,
39
+ `signature_request_notification_emails` and `signature_request_email_attachments`
40
+ (`SignatureRequestEmailAttachments`).
41
+ - New webhook event types: `signature_request.sent` and `signature_request.email_bounced`.
42
+ - New: page designs (`template_type` `page_designer`), PDFs designed in the Page Designer from a JSON layout, with no
43
+ document to start from. create_template makes one from its `layout`, or with an empty page when `layout` is left
44
+ out, and update_template replaces its layout. DocSpring adds a field for each value the layout reads. A template's
45
+ `layout` is in the [Page Designer layout format](https://docspring.com/docs/page-designer/layout-format/) (its
46
+ [JSON Schema](https://docspring.com/schemas/page-designer/layout.v1.json)), and is null for other templates.
47
+ - New: every method that creates, changes or deletes something takes an `Idempotency-Key` header, as the
48
+ `idempotency_key` option. Send the same key when you send a request again after a timeout or a network error: within
49
+ 24 hours, DocSpring returns the first response instead of running the request twice. Arguments you already pass keep
50
+ their places.
51
+ - Changed: the request validator checks what API v2 now refuses: an ID, a query value or a template name that's blank or
52
+ only whitespace, an update with nothing to change, a version with a leading zero (`01`), a `filename` with a slash, a
53
+ signer `email` that isn't an email address, and an HTML template's `scale` outside 0.1 to 2.
54
+ - New: get_template_model_code takes `rust` as its `lang`, for Rust structs that serde reads and writes.
55
+
1
56
  ### 4.3.0 [October 31, 2026]
2
57
 
3
58
  - New: get_template_model_code takes `rust` as its `lang`, for Rust structs that serde reads and writes.
data/Gemfile.lock CHANGED
@@ -1,7 +1,7 @@
1
1
  PATH
2
2
  remote: .
3
3
  specs:
4
- docspring (4.3.0)
4
+ docspring (4.4.0)
5
5
  logger
6
6
  typhoeus (~> 1.0, >= 1.0.1)
7
7
 
@@ -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.3.0)
108
+ docspring (4.4.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
data/README.md CHANGED
@@ -10,7 +10,7 @@ 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.3.0. Requires Ruby >= 2.7.
13
+ Version 4.4.0. Requires Ruby >= 2.7.
14
14
 
15
15
  ## Install and configure
16
16
 
@@ -89,8 +89,11 @@ Ruby code for every method.
89
89
  | ------ | ----------- |
90
90
  | [`add_template_fields`](https://github.com/DocSpring/docspring-ruby/blob/main/docs/Client.md#add_template_fields) | Add fields to a template |
91
91
  | [`copy_template`](https://github.com/DocSpring/docspring-ruby/blob/main/docs/Client.md#copy_template) | Copy a template |
92
+ | [`create_account_email_action`](https://github.com/DocSpring/docspring-ruby/blob/main/docs/Client.md#create_account_email_action) | Create an account email action |
92
93
  | [`create_combined_pdf`](https://github.com/DocSpring/docspring-ruby/blob/main/docs/Client.md#create_combined_pdf) | Combine PDFs |
93
94
  | [`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 |
95
+ | [`create_email_action`](https://github.com/DocSpring/docspring-ruby/blob/main/docs/Client.md#create_email_action) | Create an email action |
96
+ | [`create_email_domain`](https://github.com/DocSpring/docspring-ruby/blob/main/docs/Client.md#create_email_domain) | Add an email domain |
94
97
  | [`create_folder`](https://github.com/DocSpring/docspring-ruby/blob/main/docs/Client.md#create_folder) | Create a folder |
95
98
  | [`create_signature_request_event`](https://github.com/DocSpring/docspring-ruby/blob/main/docs/Client.md#create_signature_request_event) | Record a signature request event |
96
99
  | [`create_signature_request_token`](https://github.com/DocSpring/docspring-ruby/blob/main/docs/Client.md#create_signature_request_token) | Create a signature request token |
@@ -99,7 +102,11 @@ Ruby code for every method.
99
102
  | [`create_template`](https://github.com/DocSpring/docspring-ruby/blob/main/docs/Client.md#create_template) | Create a template |
100
103
  | [`create_template_preview`](https://github.com/DocSpring/docspring-ruby/blob/main/docs/Client.md#create_template_preview) | Preview a template with data |
101
104
  | [`create_webhook`](https://github.com/DocSpring/docspring-ruby/blob/main/docs/Client.md#create_webhook) | Create a webhook |
105
+ | [`delete_account_email_action`](https://github.com/DocSpring/docspring-ruby/blob/main/docs/Client.md#delete_account_email_action) | Delete an account email action |
102
106
  | [`delete_custom_file`](https://github.com/DocSpring/docspring-ruby/blob/main/docs/Client.md#delete_custom_file) | Delete a custom file |
107
+ | [`delete_email_action`](https://github.com/DocSpring/docspring-ruby/blob/main/docs/Client.md#delete_email_action) | Delete an email action |
108
+ | [`delete_email_action_customization`](https://github.com/DocSpring/docspring-ruby/blob/main/docs/Client.md#delete_email_action_customization) | Reset an account email action's customization |
109
+ | [`delete_email_domain`](https://github.com/DocSpring/docspring-ruby/blob/main/docs/Client.md#delete_email_domain) | Remove an email domain |
103
110
  | [`delete_folder`](https://github.com/DocSpring/docspring-ruby/blob/main/docs/Client.md#delete_folder) | Delete a folder |
104
111
  | [`delete_template`](https://github.com/DocSpring/docspring-ruby/blob/main/docs/Client.md#delete_template) | Delete a template |
105
112
  | [`delete_webhook`](https://github.com/DocSpring/docspring-ruby/blob/main/docs/Client.md#delete_webhook) | Delete a webhook |
@@ -107,8 +114,11 @@ Ruby code for every method.
107
114
  | [`expire_submission`](https://github.com/DocSpring/docspring-ruby/blob/main/docs/Client.md#expire_submission) | Expire a submission |
108
115
  | [`generate_submission_files`](https://github.com/DocSpring/docspring-ruby/blob/main/docs/Client.md#generate_submission_files) | Generate more files |
109
116
  | [`generate_submission_preview`](https://github.com/DocSpring/docspring-ruby/blob/main/docs/Client.md#generate_submission_preview) | Generate a preview PDF |
117
+ | [`get_account_email_action`](https://github.com/DocSpring/docspring-ruby/blob/main/docs/Client.md#get_account_email_action) | Get an account email action |
110
118
  | [`get_combined_pdf`](https://github.com/DocSpring/docspring-ruby/blob/main/docs/Client.md#get_combined_pdf) | Get a combined PDF |
111
119
  | [`get_custom_file`](https://github.com/DocSpring/docspring-ruby/blob/main/docs/Client.md#get_custom_file) | Get a custom file |
120
+ | [`get_email_action`](https://github.com/DocSpring/docspring-ruby/blob/main/docs/Client.md#get_email_action) | Get an email action |
121
+ | [`get_email_domain`](https://github.com/DocSpring/docspring-ruby/blob/main/docs/Client.md#get_email_domain) | Get an email domain |
112
122
  | [`get_folder`](https://github.com/DocSpring/docspring-ruby/blob/main/docs/Client.md#get_folder) | Get a folder |
113
123
  | [`get_presign_url`](https://github.com/DocSpring/docspring-ruby/blob/main/docs/Client.md#get_presign_url) | Get a presigned URL to upload a file |
114
124
  | [`get_signature_request`](https://github.com/DocSpring/docspring-ruby/blob/main/docs/Client.md#get_signature_request) | Get a signature request |
@@ -121,8 +131,11 @@ Ruby code for every method.
121
131
  | [`get_template_preview`](https://github.com/DocSpring/docspring-ruby/blob/main/docs/Client.md#get_template_preview) | Get a template preview |
122
132
  | [`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 |
123
133
  | [`get_webhook`](https://github.com/DocSpring/docspring-ruby/blob/main/docs/Client.md#get_webhook) | Get a webhook |
134
+ | [`list_account_email_actions`](https://github.com/DocSpring/docspring-ruby/blob/main/docs/Client.md#list_account_email_actions) | List account email actions |
124
135
  | [`list_combined_pdfs`](https://github.com/DocSpring/docspring-ruby/blob/main/docs/Client.md#list_combined_pdfs) | List combined PDFs |
125
136
  | [`list_custom_files`](https://github.com/DocSpring/docspring-ruby/blob/main/docs/Client.md#list_custom_files) | List custom files |
137
+ | [`list_email_actions`](https://github.com/DocSpring/docspring-ruby/blob/main/docs/Client.md#list_email_actions) | List email actions |
138
+ | [`list_email_domains`](https://github.com/DocSpring/docspring-ruby/blob/main/docs/Client.md#list_email_domains) | List email domains |
126
139
  | [`list_folders`](https://github.com/DocSpring/docspring-ruby/blob/main/docs/Client.md#list_folders) | List folders |
127
140
  | [`list_submissions`](https://github.com/DocSpring/docspring-ruby/blob/main/docs/Client.md#list_submissions) | List submissions |
128
141
  | [`list_template_fields`](https://github.com/DocSpring/docspring-ruby/blob/main/docs/Client.md#list_template_fields) | List a template's fields |
@@ -136,7 +149,12 @@ Ruby code for every method.
136
149
  | [`rename_folder`](https://github.com/DocSpring/docspring-ruby/blob/main/docs/Client.md#rename_folder) | Rename a folder |
137
150
  | [`reorder_template_fields`](https://github.com/DocSpring/docspring-ruby/blob/main/docs/Client.md#reorder_template_fields) | Reorder a template's fields |
138
151
  | [`restore_template_version`](https://github.com/DocSpring/docspring-ruby/blob/main/docs/Client.md#restore_template_version) | Restore a template version |
152
+ | [`send_account_email_action_test_email`](https://github.com/DocSpring/docspring-ruby/blob/main/docs/Client.md#send_account_email_action_test_email) | Send a test email for an account email action |
153
+ | [`send_email_action_test_email`](https://github.com/DocSpring/docspring-ruby/blob/main/docs/Client.md#send_email_action_test_email) | Send a test email |
139
154
  | [`test_authentication`](https://github.com/DocSpring/docspring-ruby/blob/main/docs/Client.md#test_authentication) | Test authentication |
155
+ | [`update_account_email_action`](https://github.com/DocSpring/docspring-ruby/blob/main/docs/Client.md#update_account_email_action) | Update an account email action |
156
+ | [`update_email_action`](https://github.com/DocSpring/docspring-ruby/blob/main/docs/Client.md#update_email_action) | Update an email action |
157
+ | [`update_email_action_customization`](https://github.com/DocSpring/docspring-ruby/blob/main/docs/Client.md#update_email_action_customization) | Customize an account email action for a template |
140
158
  | [`update_signature_request`](https://github.com/DocSpring/docspring-ruby/blob/main/docs/Client.md#update_signature_request) | Update a signature request |
141
159
  | [`update_template`](https://github.com/DocSpring/docspring-ruby/blob/main/docs/Client.md#update_template) | Update a template |
142
160
  | [`update_template_document`](https://github.com/DocSpring/docspring-ruby/blob/main/docs/Client.md#update_template_document) | Replace a template's document |
@@ -145,6 +163,7 @@ Ruby code for every method.
145
163
  | [`upload_template`](https://github.com/DocSpring/docspring-ruby/blob/main/docs/Client.md#upload_template) | Create a template from an uploaded PDF or Word document |
146
164
  | [`upload_template_document`](https://github.com/DocSpring/docspring-ruby/blob/main/docs/Client.md#upload_template_document) | Replace a template's document with an uploaded file |
147
165
  | [`validate_submission`](https://github.com/DocSpring/docspring-ruby/blob/main/docs/Client.md#validate_submission) | Check a submission without creating it |
166
+ | [`verify_email_domain`](https://github.com/DocSpring/docspring-ruby/blob/main/docs/Client.md#verify_email_domain) | Verify an email domain |
148
167
 
149
168
  ## Errors
150
169
 
@@ -4,7 +4,7 @@
4
4
 
5
5
  | Name | Type | Description | Notes |
6
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. | |
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. It can't set one of them to another value: PUT /templates/{template_id}/fields changes them for every field with the name. | |
8
8
 
9
9
  ## Example
10
10