docspring 4.2.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 (461) hide show
  1. checksums.yaml +4 -4
  2. data/.github/workflows/release.yml +80 -0
  3. data/.openapi-generator/FILES +84 -0
  4. data/AGENTS.md +2 -2
  5. data/CHANGELOG.md +82 -0
  6. data/Gemfile.lock +4 -3
  7. data/README.md +26 -6
  8. data/docs/AddTemplateFieldsRequest.md +1 -1
  9. data/docs/Client.md +2400 -853
  10. data/docs/CombinedPdfSource.md +1 -1
  11. data/docs/CreateAccountEmailActionRequest.md +54 -0
  12. data/docs/CreateEmailActionRequest.md +50 -0
  13. data/docs/CreateEmailDomainRequest.md +18 -0
  14. data/docs/CreateSubmissionBatchRequest.md +2 -2
  15. data/docs/CreateSubmissionRequest.md +24 -6
  16. data/docs/CreateTemplateRequest.md +29 -11
  17. data/docs/DnsRecordType.md +15 -0
  18. data/docs/EmailAction.md +76 -0
  19. data/docs/EmailActionConditions.md +20 -0
  20. data/docs/EmailActionConditionsInput.md +20 -0
  21. data/docs/EmailActionCustomization.md +36 -0
  22. data/docs/EmailActionDelivery.md +15 -0
  23. data/docs/EmailActionFileFormats.md +15 -0
  24. data/docs/EmailActionList.md +20 -0
  25. data/docs/EmailActionSetting.md +15 -0
  26. data/docs/EmailActionSubmissionType.md +15 -0
  27. data/docs/EmailActionTestEmail.md +18 -0
  28. data/docs/EmailDomain.md +38 -0
  29. data/docs/EmailDomainDnsRecord.md +24 -0
  30. data/docs/EmailDomainDnsRecordPurpose.md +15 -0
  31. data/docs/EmailDomainList.md +20 -0
  32. data/docs/EmailDomainRecordState.md +15 -0
  33. data/docs/EmailDomainState.md +15 -0
  34. data/docs/ErrorInfo.md +12 -6
  35. data/docs/Field.md +1 -1
  36. data/docs/FieldGroup.md +2 -2
  37. data/docs/FieldGroupInput.md +1 -1
  38. data/docs/FieldInput.md +1 -1
  39. data/docs/GenerateSubmissionFilesRequest.md +1 -1
  40. data/docs/GeneratedFile.md +2 -2
  41. data/docs/HtmlEngineOptions.md +1 -1
  42. data/docs/HtmlEngineOptionsInput.md +1 -1
  43. data/docs/SendAccountEmailActionTestEmailRequest.md +18 -0
  44. data/docs/SignatureRequest.md +9 -1
  45. data/docs/SignatureRequestEmailAttachments.md +15 -0
  46. data/docs/SignatureRequestEmailStatus.md +15 -0
  47. data/docs/SignatureRequestInput.md +7 -3
  48. data/docs/SignatureRequestReminders.md +20 -0
  49. data/docs/SigningOrder.md +15 -0
  50. data/docs/Submission.md +8 -6
  51. data/docs/SubmissionAction.md +5 -3
  52. data/docs/SubmissionBatch.md +3 -3
  53. data/docs/SubmissionFiles.md +4 -0
  54. data/docs/SubmissionInput.md +5 -5
  55. data/docs/SubmissionSummary.md +3 -3
  56. data/docs/Template.md +28 -10
  57. data/docs/TemplateDiff.md +2 -2
  58. data/docs/TemplateDocument.md +10 -10
  59. data/docs/TemplateDocumentSummary.md +4 -4
  60. data/docs/TemplatePreview.md +1 -1
  61. data/docs/TemplateSourcePdf.md +1 -1
  62. data/docs/TemplateSummary.md +5 -3
  63. data/docs/UpdateAccountEmailActionRequest.md +54 -0
  64. data/docs/UpdateEmailActionCustomizationRequest.md +46 -0
  65. data/docs/UpdateEmailActionRequest.md +50 -0
  66. data/docs/UpdateTemplateDocumentRequest.md +5 -5
  67. data/docs/UpdateTemplateRequest.md +25 -7
  68. data/docs/ValidateSubmissionRequest.md +24 -6
  69. data/docspring.gemspec +2 -2
  70. data/lib/docspring/api/client.rb +1791 -353
  71. data/lib/docspring/api_client.rb +2 -2
  72. data/lib/docspring/api_error.rb +1 -1
  73. data/lib/docspring/api_model_base.rb +1 -1
  74. data/lib/docspring/configuration.rb +1 -1
  75. data/lib/docspring/models/add_template_fields_request.rb +2 -2
  76. data/lib/docspring/models/ai_field_naming_language.rb +1 -1
  77. data/lib/docspring/models/authentication_check.rb +1 -1
  78. data/lib/docspring/models/barcode_symbology.rb +1 -1
  79. data/lib/docspring/models/check_character.rb +1 -1
  80. data/lib/docspring/models/combined_field_type.rb +1 -1
  81. data/lib/docspring/models/combined_pdf.rb +1 -1
  82. data/lib/docspring/models/combined_pdf_files.rb +1 -1
  83. data/lib/docspring/models/combined_pdf_list.rb +1 -1
  84. data/lib/docspring/models/combined_pdf_source.rb +2 -2
  85. data/lib/docspring/models/combined_pdf_source_input.rb +1 -1
  86. data/lib/docspring/models/combined_pdf_source_pdf.rb +1 -1
  87. data/lib/docspring/models/combined_pdf_source_type.rb +1 -1
  88. data/lib/docspring/models/combined_pdf_state.rb +1 -1
  89. data/lib/docspring/models/copy_template_request.rb +1 -1
  90. data/lib/docspring/models/create_account_email_action_request.rb +388 -0
  91. data/lib/docspring/models/create_combined_pdf_request.rb +1 -1
  92. data/lib/docspring/models/create_custom_file_from_upload_request.rb +1 -1
  93. data/lib/docspring/models/create_email_action_request.rb +364 -0
  94. data/lib/docspring/models/create_email_domain_request.rb +185 -0
  95. data/lib/docspring/models/create_folder_request.rb +1 -1
  96. data/lib/docspring/models/create_signature_request_event_request.rb +1 -1
  97. data/lib/docspring/models/create_signature_request_token_request.rb +1 -1
  98. data/lib/docspring/models/create_submission_batch_request.rb +3 -3
  99. data/lib/docspring/models/create_submission_request.rb +146 -10
  100. data/lib/docspring/models/create_template_preview_request.rb +1 -1
  101. data/lib/docspring/models/create_template_request.rb +123 -13
  102. data/lib/docspring/models/create_webhook_request.rb +1 -1
  103. data/lib/docspring/models/custom_file.rb +1 -1
  104. data/lib/docspring/models/custom_file_list.rb +1 -1
  105. data/lib/docspring/models/custom_file_source_pdf.rb +1 -1
  106. data/lib/docspring/models/dns_record_type.rb +42 -0
  107. data/lib/docspring/models/email_action.rb +790 -0
  108. data/lib/docspring/models/email_action_conditions.rb +219 -0
  109. data/lib/docspring/models/email_action_conditions_input.rb +219 -0
  110. data/lib/docspring/models/email_action_customization.rb +360 -0
  111. data/lib/docspring/models/email_action_delivery.rb +41 -0
  112. data/lib/docspring/models/email_action_file_formats.rb +43 -0
  113. data/lib/docspring/models/email_action_list.rb +200 -0
  114. data/lib/docspring/models/email_action_setting.rb +53 -0
  115. data/lib/docspring/models/email_action_submission_type.rb +42 -0
  116. data/lib/docspring/models/email_action_test_email.rb +185 -0
  117. data/lib/docspring/models/email_domain.rb +423 -0
  118. data/lib/docspring/models/email_domain_dns_record.rb +288 -0
  119. data/lib/docspring/models/email_domain_dns_record_purpose.rb +42 -0
  120. data/lib/docspring/models/email_domain_list.rb +200 -0
  121. data/lib/docspring/models/email_domain_record_state.rb +42 -0
  122. data/lib/docspring/models/email_domain_state.rb +42 -0
  123. data/lib/docspring/models/error_code.rb +4 -2
  124. data/lib/docspring/models/error_detail.rb +1 -1
  125. data/lib/docspring/models/error_info.rb +40 -10
  126. data/lib/docspring/models/error_response.rb +1 -1
  127. data/lib/docspring/models/expiration_interval.rb +1 -1
  128. data/lib/docspring/models/field.rb +3 -3
  129. data/lib/docspring/models/field_comparison_condition.rb +1 -1
  130. data/lib/docspring/models/field_comparison_operator.rb +1 -1
  131. data/lib/docspring/models/field_dependency.rb +1 -1
  132. data/lib/docspring/models/field_dependency_input.rb +1 -1
  133. data/lib/docspring/models/field_display_type.rb +1 -1
  134. data/lib/docspring/models/field_equals_condition.rb +1 -1
  135. data/lib/docspring/models/field_equals_operator.rb +1 -1
  136. data/lib/docspring/models/field_group.rb +3 -3
  137. data/lib/docspring/models/field_group_input.rb +2 -2
  138. data/lib/docspring/models/field_group_type.rb +1 -1
  139. data/lib/docspring/models/field_in_condition.rb +1 -1
  140. data/lib/docspring/models/field_input.rb +3 -3
  141. data/lib/docspring/models/field_override.rb +1 -1
  142. data/lib/docspring/models/field_presence_condition.rb +1 -1
  143. data/lib/docspring/models/field_presence_operator.rb +1 -1
  144. data/lib/docspring/models/field_range_condition.rb +1 -1
  145. data/lib/docspring/models/field_reimport_state.rb +1 -1
  146. data/lib/docspring/models/field_setup_logic.rb +1 -1
  147. data/lib/docspring/models/field_setup_naming.rb +1 -1
  148. data/lib/docspring/models/field_setup_source.rb +1 -1
  149. data/lib/docspring/models/field_type.rb +1 -1
  150. data/lib/docspring/models/folder.rb +1 -1
  151. data/lib/docspring/models/folder_list.rb +1 -1
  152. data/lib/docspring/models/generate_files_format.rb +5 -2
  153. data/lib/docspring/models/generate_submission_files_request.rb +2 -2
  154. data/lib/docspring/models/generated_file.rb +4 -4
  155. data/lib/docspring/models/generated_file_state.rb +1 -1
  156. data/lib/docspring/models/html_engine_options.rb +2 -2
  157. data/lib/docspring/models/html_engine_options_input.rb +2 -2
  158. data/lib/docspring/models/image_gravity.rb +1 -1
  159. data/lib/docspring/models/image_scale_type.rb +1 -1
  160. data/lib/docspring/models/model_code_language.rb +3 -2
  161. data/lib/docspring/models/move_folder_request.rb +1 -1
  162. data/lib/docspring/models/move_template_request.rb +1 -1
  163. data/lib/docspring/models/number_condition_type.rb +1 -1
  164. data/lib/docspring/models/output_format.rb +4 -2
  165. data/lib/docspring/models/page_format.rb +1 -1
  166. data/lib/docspring/models/page_image.rb +1 -1
  167. data/lib/docspring/models/page_images.rb +1 -1
  168. data/lib/docspring/models/predefined_field.rb +1 -1
  169. data/lib/docspring/models/predefined_field_input.rb +1 -1
  170. data/lib/docspring/models/publish_template_version_request.rb +1 -1
  171. data/lib/docspring/models/remove_template_fields_request.rb +1 -1
  172. data/lib/docspring/models/rename_folder_request.rb +1 -1
  173. data/lib/docspring/models/reorder_template_fields_request.rb +1 -1
  174. data/lib/docspring/models/restore_template_version_request.rb +1 -1
  175. data/lib/docspring/models/send_account_email_action_test_email_request.rb +168 -0
  176. data/lib/docspring/models/shape_type.rb +1 -1
  177. data/lib/docspring/models/signature_request.rb +69 -3
  178. data/lib/docspring/models/signature_request_auth_second_factor_type.rb +1 -1
  179. data/lib/docspring/models/signature_request_auth_type.rb +1 -1
  180. data/lib/docspring/models/signature_request_email_attachments.rb +41 -0
  181. data/lib/docspring/models/signature_request_email_status.rb +47 -0
  182. data/lib/docspring/models/signature_request_event.rb +1 -1
  183. data/lib/docspring/models/signature_request_event_type.rb +4 -2
  184. data/lib/docspring/models/signature_request_input.rb +26 -23
  185. data/lib/docspring/models/signature_request_message_type.rb +1 -1
  186. data/lib/docspring/models/signature_request_reminders.rb +212 -0
  187. data/lib/docspring/models/signature_request_state.rb +1 -1
  188. data/lib/docspring/models/signature_request_token.rb +1 -1
  189. data/lib/docspring/models/signature_request_token_type.rb +1 -1
  190. data/lib/docspring/models/signing_order.rb +41 -0
  191. data/lib/docspring/models/string_condition_type.rb +9 -2
  192. data/lib/docspring/models/submission.rb +36 -9
  193. data/lib/docspring/models/submission_action.rb +19 -6
  194. data/lib/docspring/models/submission_action_state.rb +1 -1
  195. data/lib/docspring/models/submission_action_type.rb +1 -1
  196. data/lib/docspring/models/submission_batch.rb +5 -5
  197. data/lib/docspring/models/submission_batch_state.rb +1 -1
  198. data/lib/docspring/models/submission_files.rb +22 -2
  199. data/lib/docspring/models/submission_input.rb +6 -6
  200. data/lib/docspring/models/submission_list.rb +1 -1
  201. data/lib/docspring/models/submission_source.rb +1 -1
  202. data/lib/docspring/models/submission_source_pdf.rb +1 -1
  203. data/lib/docspring/models/submission_state.rb +1 -1
  204. data/lib/docspring/models/submission_summary.rb +4 -4
  205. data/lib/docspring/models/submission_validation.rb +1 -1
  206. data/lib/docspring/models/template.rb +175 -12
  207. data/lib/docspring/models/template_actor.rb +1 -1
  208. data/lib/docspring/models/template_actor_type.rb +1 -1
  209. data/lib/docspring/models/template_defaults.rb +1 -1
  210. data/lib/docspring/models/template_defaults_input.rb +1 -1
  211. data/lib/docspring/models/template_diff.rb +3 -3
  212. data/lib/docspring/models/template_diff_summary.rb +1 -1
  213. data/lib/docspring/models/template_document.rb +12 -12
  214. data/lib/docspring/models/template_document_state.rb +4 -2
  215. data/lib/docspring/models/template_document_summary.rb +6 -6
  216. data/lib/docspring/models/template_field_change.rb +1 -1
  217. data/lib/docspring/models/template_field_changes.rb +1 -1
  218. data/lib/docspring/models/template_field_dependency.rb +1 -1
  219. data/lib/docspring/models/template_field_dependency_action.rb +1 -1
  220. data/lib/docspring/models/template_field_dependency_condition.rb +1 -1
  221. data/lib/docspring/models/template_field_dependency_condition_input.rb +1 -1
  222. data/lib/docspring/models/template_field_dependency_input.rb +1 -1
  223. data/lib/docspring/models/template_field_dependency_match.rb +1 -1
  224. data/lib/docspring/models/template_field_dependency_operator.rb +1 -1
  225. data/lib/docspring/models/template_field_logic_status.rb +1 -1
  226. data/lib/docspring/models/template_field_move.rb +1 -1
  227. data/lib/docspring/models/template_fields.rb +1 -1
  228. data/lib/docspring/models/template_form_mode.rb +1 -1
  229. data/lib/docspring/models/template_model_code.rb +1 -1
  230. data/lib/docspring/models/template_page_ai_error.rb +1 -1
  231. data/lib/docspring/models/template_page_ai_naming_status.rb +1 -1
  232. data/lib/docspring/models/template_page_fields_status.rb +1 -1
  233. data/lib/docspring/models/template_page_image_status.rb +1 -1
  234. data/lib/docspring/models/template_page_images.rb +1 -1
  235. data/lib/docspring/models/template_page_processing_status.rb +1 -1
  236. data/lib/docspring/models/template_preview.rb +3 -3
  237. data/lib/docspring/models/template_preview_state.rb +1 -1
  238. data/lib/docspring/models/template_source_pdf.rb +2 -2
  239. data/lib/docspring/models/template_summary.rb +32 -5
  240. data/lib/docspring/models/template_summary_list.rb +1 -1
  241. data/lib/docspring/models/template_type.rb +4 -2
  242. data/lib/docspring/models/template_version.rb +1 -1
  243. data/lib/docspring/models/template_version_type.rb +1 -1
  244. data/lib/docspring/models/text_alignment.rb +1 -1
  245. data/lib/docspring/models/text_overflow.rb +1 -1
  246. data/lib/docspring/models/text_vertical_alignment.rb +1 -1
  247. data/lib/docspring/models/typeface.rb +1 -1
  248. data/lib/docspring/models/update_account_email_action_request.rb +388 -0
  249. data/lib/docspring/models/update_email_action_customization_request.rb +343 -0
  250. data/lib/docspring/models/update_email_action_request.rb +364 -0
  251. data/lib/docspring/models/update_signature_request_request.rb +1 -1
  252. data/lib/docspring/models/update_template_document_request.rb +7 -7
  253. data/lib/docspring/models/update_template_fields_request.rb +1 -1
  254. data/lib/docspring/models/update_template_request.rb +121 -11
  255. data/lib/docspring/models/update_webhook_request.rb +1 -1
  256. data/lib/docspring/models/upload_method.rb +1 -1
  257. data/lib/docspring/models/upload_presign.rb +1 -1
  258. data/lib/docspring/models/url_source_pdf.rb +1 -1
  259. data/lib/docspring/models/validate_submission_request.rb +146 -10
  260. data/lib/docspring/models/webhook.rb +1 -1
  261. data/lib/docspring/models/webhook_event_type.rb +4 -2
  262. data/lib/docspring/models/webhook_list.rb +1 -1
  263. data/lib/docspring/models/webhook_mode.rb +1 -1
  264. data/lib/docspring/request_schemas.json +1692 -109
  265. data/lib/docspring/request_validator.rb +4 -0
  266. data/lib/docspring/version.rb +2 -2
  267. data/lib/docspring.rb +29 -1
  268. data/spec/api/client_spec.rb +328 -39
  269. data/spec/models/add_template_fields_request_spec.rb +1 -1
  270. data/spec/models/ai_field_naming_language_spec.rb +1 -1
  271. data/spec/models/authentication_check_spec.rb +1 -1
  272. data/spec/models/barcode_symbology_spec.rb +1 -1
  273. data/spec/models/check_character_spec.rb +1 -1
  274. data/spec/models/combined_field_type_spec.rb +1 -1
  275. data/spec/models/combined_pdf_files_spec.rb +1 -1
  276. data/spec/models/combined_pdf_list_spec.rb +1 -1
  277. data/spec/models/combined_pdf_source_input_spec.rb +1 -1
  278. data/spec/models/combined_pdf_source_pdf_spec.rb +1 -1
  279. data/spec/models/combined_pdf_source_spec.rb +1 -1
  280. data/spec/models/combined_pdf_source_type_spec.rb +1 -1
  281. data/spec/models/combined_pdf_spec.rb +1 -1
  282. data/spec/models/combined_pdf_state_spec.rb +1 -1
  283. data/spec/models/copy_template_request_spec.rb +1 -1
  284. data/spec/models/create_account_email_action_request_spec.rb +144 -0
  285. data/spec/models/create_combined_pdf_request_spec.rb +1 -1
  286. data/spec/models/create_custom_file_from_upload_request_spec.rb +1 -1
  287. data/spec/models/create_email_action_request_spec.rb +132 -0
  288. data/spec/models/create_email_domain_request_spec.rb +36 -0
  289. data/spec/models/create_folder_request_spec.rb +1 -1
  290. data/spec/models/create_signature_request_event_request_spec.rb +1 -1
  291. data/spec/models/create_signature_request_token_request_spec.rb +1 -1
  292. data/spec/models/create_submission_batch_request_spec.rb +1 -1
  293. data/spec/models/create_submission_request_spec.rb +55 -1
  294. data/spec/models/create_template_preview_request_spec.rb +1 -1
  295. data/spec/models/create_template_request_spec.rb +55 -1
  296. data/spec/models/create_webhook_request_spec.rb +1 -1
  297. data/spec/models/custom_file_list_spec.rb +1 -1
  298. data/spec/models/custom_file_source_pdf_spec.rb +1 -1
  299. data/spec/models/custom_file_spec.rb +1 -1
  300. data/spec/models/dns_record_type_spec.rb +30 -0
  301. data/spec/models/email_action_conditions_input_spec.rb +42 -0
  302. data/spec/models/email_action_conditions_spec.rb +42 -0
  303. data/spec/models/email_action_customization_spec.rb +90 -0
  304. data/spec/models/email_action_delivery_spec.rb +30 -0
  305. data/spec/models/email_action_file_formats_spec.rb +30 -0
  306. data/spec/models/email_action_list_spec.rb +42 -0
  307. data/spec/models/email_action_setting_spec.rb +30 -0
  308. data/spec/models/email_action_spec.rb +210 -0
  309. data/spec/models/email_action_submission_type_spec.rb +30 -0
  310. data/spec/models/email_action_test_email_spec.rb +36 -0
  311. data/spec/models/email_domain_dns_record_purpose_spec.rb +30 -0
  312. data/spec/models/email_domain_dns_record_spec.rb +54 -0
  313. data/spec/models/email_domain_list_spec.rb +42 -0
  314. data/spec/models/email_domain_record_state_spec.rb +30 -0
  315. data/spec/models/email_domain_spec.rb +96 -0
  316. data/spec/models/email_domain_state_spec.rb +30 -0
  317. data/spec/models/error_code_spec.rb +1 -1
  318. data/spec/models/error_detail_spec.rb +1 -1
  319. data/spec/models/error_info_spec.rb +19 -1
  320. data/spec/models/error_response_spec.rb +1 -1
  321. data/spec/models/expiration_interval_spec.rb +1 -1
  322. data/spec/models/field_comparison_condition_spec.rb +1 -1
  323. data/spec/models/field_comparison_operator_spec.rb +1 -1
  324. data/spec/models/field_dependency_input_spec.rb +1 -1
  325. data/spec/models/field_dependency_spec.rb +1 -1
  326. data/spec/models/field_display_type_spec.rb +1 -1
  327. data/spec/models/field_equals_condition_spec.rb +1 -1
  328. data/spec/models/field_equals_operator_spec.rb +1 -1
  329. data/spec/models/field_group_input_spec.rb +1 -1
  330. data/spec/models/field_group_spec.rb +1 -1
  331. data/spec/models/field_group_type_spec.rb +1 -1
  332. data/spec/models/field_in_condition_spec.rb +1 -1
  333. data/spec/models/field_input_spec.rb +1 -1
  334. data/spec/models/field_override_spec.rb +1 -1
  335. data/spec/models/field_presence_condition_spec.rb +1 -1
  336. data/spec/models/field_presence_operator_spec.rb +1 -1
  337. data/spec/models/field_range_condition_spec.rb +1 -1
  338. data/spec/models/field_reimport_state_spec.rb +1 -1
  339. data/spec/models/field_setup_logic_spec.rb +1 -1
  340. data/spec/models/field_setup_naming_spec.rb +1 -1
  341. data/spec/models/field_setup_source_spec.rb +1 -1
  342. data/spec/models/field_spec.rb +1 -1
  343. data/spec/models/field_type_spec.rb +1 -1
  344. data/spec/models/folder_list_spec.rb +1 -1
  345. data/spec/models/folder_spec.rb +1 -1
  346. data/spec/models/generate_files_format_spec.rb +1 -1
  347. data/spec/models/generate_submission_files_request_spec.rb +1 -1
  348. data/spec/models/generated_file_spec.rb +1 -1
  349. data/spec/models/generated_file_state_spec.rb +1 -1
  350. data/spec/models/html_engine_options_input_spec.rb +1 -1
  351. data/spec/models/html_engine_options_spec.rb +1 -1
  352. data/spec/models/image_gravity_spec.rb +1 -1
  353. data/spec/models/image_scale_type_spec.rb +1 -1
  354. data/spec/models/model_code_language_spec.rb +1 -1
  355. data/spec/models/move_folder_request_spec.rb +1 -1
  356. data/spec/models/move_template_request_spec.rb +1 -1
  357. data/spec/models/number_condition_type_spec.rb +1 -1
  358. data/spec/models/output_format_spec.rb +1 -1
  359. data/spec/models/page_format_spec.rb +1 -1
  360. data/spec/models/page_image_spec.rb +1 -1
  361. data/spec/models/page_images_spec.rb +1 -1
  362. data/spec/models/predefined_field_input_spec.rb +1 -1
  363. data/spec/models/predefined_field_spec.rb +1 -1
  364. data/spec/models/publish_template_version_request_spec.rb +1 -1
  365. data/spec/models/remove_template_fields_request_spec.rb +1 -1
  366. data/spec/models/rename_folder_request_spec.rb +1 -1
  367. data/spec/models/reorder_template_fields_request_spec.rb +1 -1
  368. data/spec/models/restore_template_version_request_spec.rb +1 -1
  369. data/spec/models/send_account_email_action_test_email_request_spec.rb +36 -0
  370. data/spec/models/shape_type_spec.rb +1 -1
  371. data/spec/models/signature_request_auth_second_factor_type_spec.rb +1 -1
  372. data/spec/models/signature_request_auth_type_spec.rb +1 -1
  373. data/spec/models/signature_request_email_attachments_spec.rb +30 -0
  374. data/spec/models/signature_request_email_status_spec.rb +30 -0
  375. data/spec/models/signature_request_event_spec.rb +1 -1
  376. data/spec/models/signature_request_event_type_spec.rb +1 -1
  377. data/spec/models/signature_request_input_spec.rb +13 -1
  378. data/spec/models/signature_request_message_type_spec.rb +1 -1
  379. data/spec/models/signature_request_reminders_spec.rb +42 -0
  380. data/spec/models/signature_request_spec.rb +25 -1
  381. data/spec/models/signature_request_state_spec.rb +1 -1
  382. data/spec/models/signature_request_token_spec.rb +1 -1
  383. data/spec/models/signature_request_token_type_spec.rb +1 -1
  384. data/spec/models/signing_order_spec.rb +30 -0
  385. data/spec/models/string_condition_type_spec.rb +1 -1
  386. data/spec/models/submission_action_spec.rb +7 -1
  387. data/spec/models/submission_action_state_spec.rb +1 -1
  388. data/spec/models/submission_action_type_spec.rb +1 -1
  389. data/spec/models/submission_batch_spec.rb +1 -1
  390. data/spec/models/submission_batch_state_spec.rb +1 -1
  391. data/spec/models/submission_files_spec.rb +13 -1
  392. data/spec/models/submission_input_spec.rb +1 -1
  393. data/spec/models/submission_list_spec.rb +1 -1
  394. data/spec/models/submission_source_pdf_spec.rb +1 -1
  395. data/spec/models/submission_source_spec.rb +1 -1
  396. data/spec/models/submission_spec.rb +7 -1
  397. data/spec/models/submission_state_spec.rb +1 -1
  398. data/spec/models/submission_summary_spec.rb +1 -1
  399. data/spec/models/submission_validation_spec.rb +1 -1
  400. data/spec/models/template_actor_spec.rb +1 -1
  401. data/spec/models/template_actor_type_spec.rb +1 -1
  402. data/spec/models/template_defaults_input_spec.rb +1 -1
  403. data/spec/models/template_defaults_spec.rb +1 -1
  404. data/spec/models/template_diff_spec.rb +1 -1
  405. data/spec/models/template_diff_summary_spec.rb +1 -1
  406. data/spec/models/template_document_spec.rb +1 -1
  407. data/spec/models/template_document_state_spec.rb +1 -1
  408. data/spec/models/template_document_summary_spec.rb +1 -1
  409. data/spec/models/template_field_change_spec.rb +1 -1
  410. data/spec/models/template_field_changes_spec.rb +1 -1
  411. data/spec/models/template_field_dependency_action_spec.rb +1 -1
  412. data/spec/models/template_field_dependency_condition_input_spec.rb +1 -1
  413. data/spec/models/template_field_dependency_condition_spec.rb +1 -1
  414. data/spec/models/template_field_dependency_input_spec.rb +1 -1
  415. data/spec/models/template_field_dependency_match_spec.rb +1 -1
  416. data/spec/models/template_field_dependency_operator_spec.rb +1 -1
  417. data/spec/models/template_field_dependency_spec.rb +1 -1
  418. data/spec/models/template_field_logic_status_spec.rb +1 -1
  419. data/spec/models/template_field_move_spec.rb +1 -1
  420. data/spec/models/template_fields_spec.rb +1 -1
  421. data/spec/models/template_form_mode_spec.rb +1 -1
  422. data/spec/models/template_model_code_spec.rb +1 -1
  423. data/spec/models/template_page_ai_error_spec.rb +1 -1
  424. data/spec/models/template_page_ai_naming_status_spec.rb +1 -1
  425. data/spec/models/template_page_fields_status_spec.rb +1 -1
  426. data/spec/models/template_page_image_status_spec.rb +1 -1
  427. data/spec/models/template_page_images_spec.rb +1 -1
  428. data/spec/models/template_page_processing_status_spec.rb +1 -1
  429. data/spec/models/template_preview_spec.rb +1 -1
  430. data/spec/models/template_preview_state_spec.rb +1 -1
  431. data/spec/models/template_source_pdf_spec.rb +1 -1
  432. data/spec/models/template_spec.rb +55 -1
  433. data/spec/models/template_summary_list_spec.rb +1 -1
  434. data/spec/models/template_summary_spec.rb +7 -1
  435. data/spec/models/template_type_spec.rb +1 -1
  436. data/spec/models/template_version_spec.rb +1 -1
  437. data/spec/models/template_version_type_spec.rb +1 -1
  438. data/spec/models/text_alignment_spec.rb +1 -1
  439. data/spec/models/text_overflow_spec.rb +1 -1
  440. data/spec/models/text_vertical_alignment_spec.rb +1 -1
  441. data/spec/models/typeface_spec.rb +1 -1
  442. data/spec/models/update_account_email_action_request_spec.rb +144 -0
  443. data/spec/models/update_email_action_customization_request_spec.rb +120 -0
  444. data/spec/models/update_email_action_request_spec.rb +132 -0
  445. data/spec/models/update_signature_request_request_spec.rb +1 -1
  446. data/spec/models/update_template_document_request_spec.rb +1 -1
  447. data/spec/models/update_template_fields_request_spec.rb +1 -1
  448. data/spec/models/update_template_request_spec.rb +55 -1
  449. data/spec/models/update_webhook_request_spec.rb +1 -1
  450. data/spec/models/upload_method_spec.rb +1 -1
  451. data/spec/models/upload_presign_spec.rb +1 -1
  452. data/spec/models/url_source_pdf_spec.rb +1 -1
  453. data/spec/models/validate_submission_request_spec.rb +55 -1
  454. data/spec/models/webhook_event_type_spec.rb +1 -1
  455. data/spec/models/webhook_list_spec.rb +1 -1
  456. data/spec/models/webhook_mode_spec.rb +1 -1
  457. data/spec/models/webhook_spec.rb +1 -1
  458. data/spec/spec_helper.rb +1 -1
  459. metadata +117 -5
  460. data/.gitlab-ci.yml +0 -26
  461. data/.travis.yml +0 -11
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: f14e5a7b2bfc1d3afccaa2fe06b9a452849c1e68159d2bb3b5cd28317251105d
4
- data.tar.gz: b34c23551a9e275212671e5bac87568bec392ee68f379589cb9de514b6871152
3
+ metadata.gz: '06689a7623615dd4907cfb24376f8eac296b83f743e49d4d8c734f30b620115d'
4
+ data.tar.gz: 9e7678924d7b901941430d3342a680d05c080bab4896cb4329b7ecdd216660bd
5
5
  SHA512:
6
- metadata.gz: c9c41809479101fc003e24371dc49de667b566329208c656f653977cc7548a174f482c90978d3bcc62800771c173dc374406cbcfc973365f72ecdf6f5d6f2457
7
- data.tar.gz: 51775f90a82bb42c0a6ce063b3a834c665f8adfa2e8acfd14dca4925adf65cd835e0fb8a79b108cb567daeccf6f477fe02be3b20848fbf42ea5854ad63e7a7e9
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/AGENTS.md CHANGED
@@ -90,5 +90,5 @@ keeps it.
90
90
 
91
91
  - List methods return `data` and `next_cursor`: pass `next_cursor` as `cursor` to get the next page.
92
92
  - Responses can be newer than this SDK, because DocSpring adds fields and enum values to API v2 without a new
93
- version. The model leaves out a response field added to the API after this release. Enum values in responses are strings, so a
94
- value added after this release comes back as it is: handle values you don't recognize.
93
+ version. The model leaves out a response field added to the API after this release. An enum value added after this release comes
94
+ back as the API sent it: handle values you don't recognize.
data/CHANGELOG.md CHANGED
@@ -1,3 +1,85 @@
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
+
56
+ ### 4.3.0 [October 31, 2026]
57
+
58
+ - New: get_template_model_code takes `rust` as its `lang`, for Rust structs that serde reads and writes.
59
+ - New: Word templates (`template_type` `docx`). create_template makes one from a Word document (.docx, up to 50 MB)
60
+ that you upload and pass as a `cache_id`, or pass as a `document_url` or `document_base64`; upload_template takes the
61
+ file itself. update_template_document and upload_template_document replace its document the same ways. Each tag in
62
+ the document, such as `{{ customer.name }}`, becomes a field. Each of them takes an OpenDocument text file (.odt)
63
+ too, which DocSpring converts to a Word document.
64
+ - New: a Word template's `output_format`, what its submissions make unless they set `output_formats`: `docx` (a Word
65
+ document), `odt` (an OpenDocument file) or `pdf`. create_template and upload_template require it, and
66
+ update_template changes it. A Word template that encrypts its PDFs makes PDFs, because Word documents and
67
+ OpenDocument files can't be password-protected.
68
+ - New: the `docx` and `odt` output formats, a Word template's filled-in Word document (`files.docx`) and OpenDocument
69
+ file (`files.odt`, converted from the Word document). Add them to `output_formats` in create_submission or
70
+ create_submission_batch to get more than one file, such as the Word document and the PDF.
71
+ - generate_submission_files takes `pdf`, the PDF of a Word template's submission that didn't make one (converted from
72
+ its Word document), `docx`, the Word document of one that made only its PDF (made again from its data and the
73
+ template version it used), and `odt`, its OpenDocument file. None of them uses credits again. Until the new file is
74
+ ready, its `state` in `files` is `pending`, and when it couldn't be made, its `error_message` says why.
75
+ - A Word template's `document` is its Word document: `document.permanent_url` downloads it. Its `state` is `processed`
76
+ once it's uploaded or downloaded (`downloading` or `download_failed` while a `document_url` downloads, `converting`
77
+ or `conversion_failed` while an OpenDocument file is converted), and get_template_diff's `document_changed` says
78
+ whether it was edited.
79
+ - get_template_page_images returns a 409 for a Word template, whose pages are only laid out when a document is made.
80
+ - create_template_preview previews Word templates too: images of the pages of the PDF that the template's Word
81
+ document makes with your data. A DocSpring server that can't convert Word documents to PDF returns a 409.
82
+
1
83
  ### 4.2.0 [October 29, 2026]
2
84
 
3
85
  - **BREAKING CHANGE**: list_templates returns a shorter `TemplateSummary`: a template's name, description, type, folder
data/Gemfile.lock CHANGED
@@ -1,7 +1,7 @@
1
1
  PATH
2
2
  remote: .
3
3
  specs:
4
- docspring (4.2.0)
4
+ docspring (4.4.0)
5
5
  logger
6
6
  typhoeus (~> 1.0, >= 1.0.1)
7
7
 
@@ -100,11 +100,12 @@ DEPENDENCIES
100
100
 
101
101
  CHECKSUMS
102
102
  ast (2.4.3) sha256=954615157c1d6a382bc27d690d973195e79db7f55e9765ac7c481c60bdb4d383
103
+ bundler (4.0.23) sha256=407ba8a1d928f412847f819aa5f8b6aef7c59fb51feb517112af8a165487287b
103
104
  byebug (13.0.0) sha256=d2263efe751941ca520fa29744b71972d39cbc41839496706f5d9b22e92ae05d
104
105
  coderay (1.1.3) sha256=dc530018a4684512f8f38143cd2a096c9f02a1fc2459edcfe534787a7fc77d4b
105
106
  date (3.6.0) sha256=18ac945c4e24ebd93534f8eab8c2fd8c5604b3e977105b3798d62a1e8d27b580
106
107
  diff-lcs (1.6.2) sha256=9ae0d2cba7d4df3075fe8cd8602a8604993efc0dfa934cff568969efb1909962
107
- docspring (4.2.0)
108
+ docspring (4.4.0)
108
109
  ethon (0.19.1) sha256=f309dec67cfdefaf96b3d1ee0ed4f186eac518f131340f607bb3df3b4e13ddc4
109
110
  ffi (1.17.4) sha256=bcd1642e06f0d16fc9e09ac6d49c3a7298b9789bcb58127302f934e437d60acf
110
111
  ffi (1.17.4-aarch64-linux-gnu) sha256=b208f06f91ffd8f5e1193da3cae3d2ccfc27fc36fba577baf698d26d91c080df
@@ -142,4 +143,4 @@ CHECKSUMS
142
143
  unicode-display_width (1.5.0) sha256=9890eebd24feb4cb0e0542c9b8c6beecb40cda27be8c7afe49312625b36156eb
143
144
 
144
145
  BUNDLED WITH
145
- 4.0.20
146
+ 4.0.23
data/README.md CHANGED
@@ -1,7 +1,8 @@
1
1
  # DocSpring Ruby SDK
2
2
 
3
3
  The official Ruby client for the [DocSpring API](https://docspring.com/docs/api/). DocSpring fills PDF
4
- templates with your data, generates PDFs from HTML templates, combines PDFs and collects e-signatures.
4
+ forms with your data, generates PDFs and Word documents from HTML and Word templates, combines PDFs and collects
5
+ e-signatures.
5
6
 
6
7
  [Documentation](https://docspring.com/docs/) · [API reference](https://docspring.com/docs/api/) ·
7
8
  [RubyGems](https://rubygems.org/gems/docspring) · [Changelog](https://github.com/DocSpring/docspring-ruby/blob/main/CHANGELOG.md)
@@ -9,7 +10,7 @@ templates with your data, generates PDFs from HTML templates, combines PDFs and
9
10
  The code in this repository is generated from DocSpring's OpenAPI spec ([About this SDK](#about-this-sdk)). Issues and
10
11
  pull requests are welcome.
11
12
 
12
- Version 4.2.0. Requires Ruby >= 2.7.
13
+ Version 4.4.0. Requires Ruby >= 2.7.
13
14
 
14
15
  ## Install and configure
15
16
 
@@ -88,8 +89,11 @@ Ruby code for every method.
88
89
  | ------ | ----------- |
89
90
  | [`add_template_fields`](https://github.com/DocSpring/docspring-ruby/blob/main/docs/Client.md#add_template_fields) | Add fields to a template |
90
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 |
91
93
  | [`create_combined_pdf`](https://github.com/DocSpring/docspring-ruby/blob/main/docs/Client.md#create_combined_pdf) | Combine PDFs |
92
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 |
93
97
  | [`create_folder`](https://github.com/DocSpring/docspring-ruby/blob/main/docs/Client.md#create_folder) | Create a folder |
94
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 |
95
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 |
@@ -98,7 +102,11 @@ Ruby code for every method.
98
102
  | [`create_template`](https://github.com/DocSpring/docspring-ruby/blob/main/docs/Client.md#create_template) | Create a template |
99
103
  | [`create_template_preview`](https://github.com/DocSpring/docspring-ruby/blob/main/docs/Client.md#create_template_preview) | Preview a template with data |
100
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 |
101
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 |
102
110
  | [`delete_folder`](https://github.com/DocSpring/docspring-ruby/blob/main/docs/Client.md#delete_folder) | Delete a folder |
103
111
  | [`delete_template`](https://github.com/DocSpring/docspring-ruby/blob/main/docs/Client.md#delete_template) | Delete a template |
104
112
  | [`delete_webhook`](https://github.com/DocSpring/docspring-ruby/blob/main/docs/Client.md#delete_webhook) | Delete a webhook |
@@ -106,8 +114,11 @@ Ruby code for every method.
106
114
  | [`expire_submission`](https://github.com/DocSpring/docspring-ruby/blob/main/docs/Client.md#expire_submission) | Expire a submission |
107
115
  | [`generate_submission_files`](https://github.com/DocSpring/docspring-ruby/blob/main/docs/Client.md#generate_submission_files) | Generate more files |
108
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 |
109
118
  | [`get_combined_pdf`](https://github.com/DocSpring/docspring-ruby/blob/main/docs/Client.md#get_combined_pdf) | Get a combined PDF |
110
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 |
111
122
  | [`get_folder`](https://github.com/DocSpring/docspring-ruby/blob/main/docs/Client.md#get_folder) | Get a folder |
112
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 |
113
124
  | [`get_signature_request`](https://github.com/DocSpring/docspring-ruby/blob/main/docs/Client.md#get_signature_request) | Get a signature request |
@@ -120,8 +131,11 @@ Ruby code for every method.
120
131
  | [`get_template_preview`](https://github.com/DocSpring/docspring-ruby/blob/main/docs/Client.md#get_template_preview) | Get a template preview |
121
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 |
122
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 |
123
135
  | [`list_combined_pdfs`](https://github.com/DocSpring/docspring-ruby/blob/main/docs/Client.md#list_combined_pdfs) | List combined PDFs |
124
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 |
125
139
  | [`list_folders`](https://github.com/DocSpring/docspring-ruby/blob/main/docs/Client.md#list_folders) | List folders |
126
140
  | [`list_submissions`](https://github.com/DocSpring/docspring-ruby/blob/main/docs/Client.md#list_submissions) | List submissions |
127
141
  | [`list_template_fields`](https://github.com/DocSpring/docspring-ruby/blob/main/docs/Client.md#list_template_fields) | List a template's fields |
@@ -135,15 +149,21 @@ Ruby code for every method.
135
149
  | [`rename_folder`](https://github.com/DocSpring/docspring-ruby/blob/main/docs/Client.md#rename_folder) | Rename a folder |
136
150
  | [`reorder_template_fields`](https://github.com/DocSpring/docspring-ruby/blob/main/docs/Client.md#reorder_template_fields) | Reorder a template's fields |
137
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 |
138
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 |
139
158
  | [`update_signature_request`](https://github.com/DocSpring/docspring-ruby/blob/main/docs/Client.md#update_signature_request) | Update a signature request |
140
159
  | [`update_template`](https://github.com/DocSpring/docspring-ruby/blob/main/docs/Client.md#update_template) | Update a template |
141
- | [`update_template_document`](https://github.com/DocSpring/docspring-ruby/blob/main/docs/Client.md#update_template_document) | Replace a template's PDF |
160
+ | [`update_template_document`](https://github.com/DocSpring/docspring-ruby/blob/main/docs/Client.md#update_template_document) | Replace a template's document |
142
161
  | [`update_template_fields`](https://github.com/DocSpring/docspring-ruby/blob/main/docs/Client.md#update_template_fields) | Update a template's fields |
143
162
  | [`update_webhook`](https://github.com/DocSpring/docspring-ruby/blob/main/docs/Client.md#update_webhook) | Update a webhook |
144
- | [`upload_template`](https://github.com/DocSpring/docspring-ruby/blob/main/docs/Client.md#upload_template) | Create a PDF template from an uploaded PDF |
145
- | [`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 |
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 |
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 |
146
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 |
147
167
 
148
168
  ## Errors
149
169
 
@@ -160,7 +180,7 @@ existing code, such as removing or renaming a field, go in a new API version
160
180
  responses that are newer than it is:
161
181
 
162
182
  - The model leaves out a response field added to the API after this release.
163
- - Enum values in responses are strings, so a value added to the API after this release comes back as it is: handle values you don't recognize.
183
+ - An enum value added to the API after this release comes back as the API sent it: handle values you don't recognize.
164
184
 
165
185
  Upgrade the SDK to read new fields and enum values. The [changelog](https://github.com/DocSpring/docspring-ruby/blob/main/CHANGELOG.md) lists
166
186
  what each release adds.
@@ -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