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
@@ -1,7 +1,7 @@
1
1
  =begin
2
2
  #DocSpring API
3
3
 
4
- #Use DocSpring's API to programmatically fill out PDF forms, convert HTML to PDFs, merge PDFs, or request legally binding e-signatures.
4
+ #Use DocSpring's API to fill PDF forms, generate PDFs and Word documents from HTML or Word templates, merge PDFs, and request legally binding e-signatures.
5
5
 
6
6
  The version of the OpenAPI document: v2
7
7
 
@@ -16,7 +16,7 @@ require 'time'
16
16
  module DocSpring
17
17
  # What went wrong.
18
18
  class ErrorInfo < ApiModelBase
19
- # A machine-readable error code. Clients should handle codes they don't know: new codes can be added. `invalid_data`: a submission's data doesn't match its template's fields. The submission is still recorded. `insufficient_credits` (402): your credit balance can't cover a live PDF. The record was saved and waits for credits in the `insufficient_credits` state: its ID is in `submission_id`, `submission_batch_id` or `combined_pdf_id`. `upgrade_required` (403): your plan doesn't include this, such as more templates or the embedded template editor. `account_suspended` (403): the account is suspended, so it can't create submissions. `polling_timeout`: on a sync.api host, the PDF wasn't ready in time. The record was created and is still being processed: its ID is in `submission_id`, `submission_batch_id`, `combined_pdf_id` or `template_id`. Without one of these IDs, the request itself got no answer in time, and the record may or may not have been created. `idempotency_key_in_use` (409): a request with the same Idempotency-Key is still being processed. Send the request again in a few seconds; when the first request has already created its record, its ID is in `submission_id`, `submission_batch_id` or `combined_pdf_id`. `idempotency_key_reused` (422): the Idempotency-Key was already used for a different request.
19
+ # A machine-readable error code. Clients should handle codes they don't know: new codes can be added. `invalid_data`: a submission's data doesn't match its template's fields. The submission is still recorded. `insufficient_credits` (402): your credit balance can't cover a live PDF. The record was saved and waits for credits in the `insufficient_credits` state: its ID is in `submission_id`, `submission_batch_id` or `combined_pdf_id`. `insufficient_credits_to_send` (402): your credit balance can't cover a live signature request that DocSpring would email, so nothing was saved. Add credits and send the request again. `upgrade_required` (403): your plan doesn't include this, such as more templates, another active integration (webhooks count), the embedded template editor, email actions, or live signature requests before your account's first payment. `account_suspended` (403): the account is suspended, so it can't create submissions. `polling_timeout`: on a sync.api host, the files weren't ready in time. The record was created and is still being processed: its ID is in `submission_id`, `submission_batch_id`, `combined_pdf_id` or `template_id`. Without one of these IDs, the request itself got no answer in time, and the record may or may not have been created. `idempotency_key_in_use` (409): the first request with the same Idempotency-Key is still being processed, and the response has a `Retry-After` header: send the request again then. Without the header, the first request was processed but its response is no longer kept. When the first request created a record, its ID is in `submission_id`, `submission_batch_id`, `combined_pdf_id`, `template_id`, `folder_id`, `custom_file_id` or `webhook_id`. `idempotency_key_reused` (422): the Idempotency-Key was already used for a different request. `rate_limited` (429): too many API requests. Wait for the `Retry-After` header's seconds. `daily_email_limit_reached` (429): a submission that DocSpring would email would take your account over its daily email limit, so nothing was saved. Send it again after the `Retry-After` header's seconds (midnight UTC), or send the signing links yourself (`send_email: false`).
20
20
  attr_accessor :code
21
21
 
22
22
  # A human-readable explanation, safe to show to developers.
@@ -28,18 +28,27 @@ module DocSpring
28
28
  # The ID of the request. Include it when you contact support.
29
29
  attr_accessor :request_id
30
30
 
31
- # When a submission's data fails validation, the submission is still recorded (state `invalid_data`) so you can see it in the dashboard. This is its ID. With `insufficient_credits`, the submission that waits for credits. With `polling_timeout` or `idempotency_key_in_use`, the submission that's still being processed.
31
+ # When a submission's data fails validation, the submission is still recorded (state `invalid_data`) so you can see it in the dashboard. This is its ID. With `insufficient_credits`, the submission that waits for credits. With `polling_timeout`, the submission that's still being processed. With `idempotency_key_in_use`, the submission the first request with the key created.
32
32
  attr_accessor :submission_id
33
33
 
34
- # The ID of the recorded batch, when items in a batch fail validation. With `insufficient_credits`, the batch whose submissions wait for credits. With `polling_timeout` or `idempotency_key_in_use`, the batch that's still being processed.
34
+ # The ID of the recorded batch, when items in a batch fail validation. With `insufficient_credits`, the batch whose submissions wait for credits. With `polling_timeout`, the batch that's still being processed. With `idempotency_key_in_use`, the batch the first request with the key created.
35
35
  attr_accessor :submission_batch_id
36
36
 
37
- # With `insufficient_credits`, the combined PDF that waits for credits. With `polling_timeout` or `idempotency_key_in_use`, the combined PDF that's still being processed.
37
+ # With `insufficient_credits`, the combined PDF that waits for credits. With `polling_timeout`, the combined PDF that's still being processed. With `idempotency_key_in_use`, the combined PDF the first request with the key created.
38
38
  attr_accessor :combined_pdf_id
39
39
 
40
- # With `polling_timeout`, the template whose PDF is still being processed.
40
+ # With `polling_timeout`, the template whose PDF is still being processed. With `idempotency_key_in_use`, the template the first request with the key created.
41
41
  attr_accessor :template_id
42
42
 
43
+ # With `idempotency_key_in_use`, the folder the first request with the key created.
44
+ attr_accessor :folder_id
45
+
46
+ # With `idempotency_key_in_use`, the custom file the first request with the key created.
47
+ attr_accessor :custom_file_id
48
+
49
+ # With `idempotency_key_in_use`, the webhook the first request with the key created.
50
+ attr_accessor :webhook_id
51
+
43
52
  class EnumAttributeValidator
44
53
  attr_reader :datatype
45
54
  attr_reader :allowable_values
@@ -72,7 +81,10 @@ module DocSpring
72
81
  :'submission_id' => :'submission_id',
73
82
  :'submission_batch_id' => :'submission_batch_id',
74
83
  :'combined_pdf_id' => :'combined_pdf_id',
75
- :'template_id' => :'template_id'
84
+ :'template_id' => :'template_id',
85
+ :'folder_id' => :'folder_id',
86
+ :'custom_file_id' => :'custom_file_id',
87
+ :'webhook_id' => :'webhook_id'
76
88
  }
77
89
  end
78
90
 
@@ -96,7 +108,10 @@ module DocSpring
96
108
  :'submission_id' => :'String',
97
109
  :'submission_batch_id' => :'String',
98
110
  :'combined_pdf_id' => :'String',
99
- :'template_id' => :'String'
111
+ :'template_id' => :'String',
112
+ :'folder_id' => :'String',
113
+ :'custom_file_id' => :'String',
114
+ :'webhook_id' => :'String'
100
115
  }
101
116
  end
102
117
 
@@ -174,6 +189,18 @@ module DocSpring
174
189
  if attributes.key?(:'template_id')
175
190
  self.template_id = attributes[:'template_id']
176
191
  end
192
+
193
+ if attributes.key?(:'folder_id')
194
+ self.folder_id = attributes[:'folder_id']
195
+ end
196
+
197
+ if attributes.key?(:'custom_file_id')
198
+ self.custom_file_id = attributes[:'custom_file_id']
199
+ end
200
+
201
+ if attributes.key?(:'webhook_id')
202
+ self.webhook_id = attributes[:'webhook_id']
203
+ end
177
204
  end
178
205
 
179
206
  # Show invalid properties with the reasons. Usually used together with valid?
@@ -248,7 +275,10 @@ module DocSpring
248
275
  submission_id == o.submission_id &&
249
276
  submission_batch_id == o.submission_batch_id &&
250
277
  combined_pdf_id == o.combined_pdf_id &&
251
- template_id == o.template_id
278
+ template_id == o.template_id &&
279
+ folder_id == o.folder_id &&
280
+ custom_file_id == o.custom_file_id &&
281
+ webhook_id == o.webhook_id
252
282
  end
253
283
 
254
284
  # @see the `==` method
@@ -260,7 +290,7 @@ module DocSpring
260
290
  # Calculates hash code according to all attributes.
261
291
  # @return [Integer] Hash code
262
292
  def hash
263
- [code, message, details, request_id, submission_id, submission_batch_id, combined_pdf_id, template_id].hash
293
+ [code, message, details, request_id, submission_id, submission_batch_id, combined_pdf_id, template_id, folder_id, custom_file_id, webhook_id].hash
264
294
  end
265
295
 
266
296
  # Builds the object from hash
@@ -1,7 +1,7 @@
1
1
  =begin
2
2
  #DocSpring API
3
3
 
4
- #Use DocSpring's API to programmatically fill out PDF forms, convert HTML to PDFs, merge PDFs, or request legally binding e-signatures.
4
+ #Use DocSpring's API to fill PDF forms, generate PDFs and Word documents from HTML or Word templates, merge PDFs, and request legally binding e-signatures.
5
5
 
6
6
  The version of the OpenAPI document: v2
7
7
 
@@ -1,7 +1,7 @@
1
1
  =begin
2
2
  #DocSpring API
3
3
 
4
- #Use DocSpring's API to programmatically fill out PDF forms, convert HTML to PDFs, merge PDFs, or request legally binding e-signatures.
4
+ #Use DocSpring's API to fill PDF forms, generate PDFs and Word documents from HTML or Word templates, merge PDFs, and request legally binding e-signatures.
5
5
 
6
6
  The version of the OpenAPI document: v2
7
7
 
@@ -1,7 +1,7 @@
1
1
  =begin
2
2
  #DocSpring API
3
3
 
4
- #Use DocSpring's API to programmatically fill out PDF forms, convert HTML to PDFs, merge PDFs, or request legally binding e-signatures.
4
+ #Use DocSpring's API to fill PDF forms, generate PDFs and Word documents from HTML or Word templates, merge PDFs, and request legally binding e-signatures.
5
5
 
6
6
  The version of the OpenAPI document: v2
7
7
 
@@ -14,7 +14,7 @@ require 'date'
14
14
  require 'time'
15
15
 
16
16
  module DocSpring
17
- # A field of a template: the name of a value in submission data, and how and where it prints. Fields with the same `name` share one value and the settings the descriptions say are shared. A PDF template's fields are placed on its pages: `x`, `y`, `width` and `height` are in units where every page is 2480 wide, measured from the top-left corner of the field's `page`. To convert from PDF points, multiply by 2480 and divide by the page's width in points (`document.page_dimensions` on the template). An HTML template's fields are all on page 1, and their placement and style settings aren't used.
17
+ # A field of a template: the name of a value in submission data, and how and where it prints. Fields with the same `name` share one value and the settings the descriptions say are shared. A PDF template's fields are placed on its pages: `x`, `y`, `width` and `height` are in units where every page is 2480 wide, measured from the top-left corner of the field's `page`. To convert from PDF points, multiply by 2480 and divide by the page's width in points (`document.page_dimensions` on the template). An HTML or Word template's fields are all on page 1, and their placement and style settings aren't used: its HTML or Word document places and styles each value.
18
18
  class Field < ApiModelBase
19
19
  # The field's ID, an integer that's unique within the template.
20
20
  attr_accessor :id
@@ -253,7 +253,7 @@ module DocSpring
253
253
  # Check and shape display only: the value a string or number field's value is compared with, by `string_condition_type` or `number_condition_type`, to decide whether the check mark or shape prints. Boolean fields print when `true` (see `invert_boolean_condition`), and other types print when they have a value.
254
254
  attr_accessor :condition
255
255
 
256
- # String fields with check or shape display: how the value is compared with `condition`: `equals`, `contains`, `starts_with`, `ends_with`, or `regex`, where `condition` is a regular expression the value must match.
256
+ # String fields with check or shape display: how the value is compared with `condition`: `equals`, `contains`, `starts_with`, `ends_with`, or `regex`, where `condition` is a regular expression (RE2 syntax) the value must match; each has a `not_` form that prints when it doesn't match (`not_equals`, `not_regex`, ...). `blank` prints when the value is empty or only spaces and line breaks, and `not_blank` when it isn't; they ignore `condition`.
257
257
  attr_accessor :string_condition_type
258
258
 
259
259
  # Number fields with check or shape display: how the value is compared with `condition`: `equals`, `gt` (greater than), `gte` (greater than or equal to), `lt` (less than), `lte` (less than or equal to), or `range`, between `number_condition_range_min` and `number_condition_range_max`.
@@ -1,7 +1,7 @@
1
1
  =begin
2
2
  #DocSpring API
3
3
 
4
- #Use DocSpring's API to programmatically fill out PDF forms, convert HTML to PDFs, merge PDFs, or request legally binding e-signatures.
4
+ #Use DocSpring's API to fill PDF forms, generate PDFs and Word documents from HTML or Word templates, merge PDFs, and request legally binding e-signatures.
5
5
 
6
6
  The version of the OpenAPI document: v2
7
7
 
@@ -1,7 +1,7 @@
1
1
  =begin
2
2
  #DocSpring API
3
3
 
4
- #Use DocSpring's API to programmatically fill out PDF forms, convert HTML to PDFs, merge PDFs, or request legally binding e-signatures.
4
+ #Use DocSpring's API to fill PDF forms, generate PDFs and Word documents from HTML or Word templates, merge PDFs, and request legally binding e-signatures.
5
5
 
6
6
  The version of the OpenAPI document: v2
7
7
 
@@ -1,7 +1,7 @@
1
1
  =begin
2
2
  #DocSpring API
3
3
 
4
- #Use DocSpring's API to programmatically fill out PDF forms, convert HTML to PDFs, merge PDFs, or request legally binding e-signatures.
4
+ #Use DocSpring's API to fill PDF forms, generate PDFs and Word documents from HTML or Word templates, merge PDFs, and request legally binding e-signatures.
5
5
 
6
6
  The version of the OpenAPI document: v2
7
7
 
@@ -1,7 +1,7 @@
1
1
  =begin
2
2
  #DocSpring API
3
3
 
4
- #Use DocSpring's API to programmatically fill out PDF forms, convert HTML to PDFs, merge PDFs, or request legally binding e-signatures.
4
+ #Use DocSpring's API to fill PDF forms, generate PDFs and Word documents from HTML or Word templates, merge PDFs, and request legally binding e-signatures.
5
5
 
6
6
  The version of the OpenAPI document: v2
7
7
 
@@ -1,7 +1,7 @@
1
1
  =begin
2
2
  #DocSpring API
3
3
 
4
- #Use DocSpring's API to programmatically fill out PDF forms, convert HTML to PDFs, merge PDFs, or request legally binding e-signatures.
4
+ #Use DocSpring's API to fill PDF forms, generate PDFs and Word documents from HTML or Word templates, merge PDFs, and request legally binding e-signatures.
5
5
 
6
6
  The version of the OpenAPI document: v2
7
7
 
@@ -1,7 +1,7 @@
1
1
  =begin
2
2
  #DocSpring API
3
3
 
4
- #Use DocSpring's API to programmatically fill out PDF forms, convert HTML to PDFs, merge PDFs, or request legally binding e-signatures.
4
+ #Use DocSpring's API to fill PDF forms, generate PDFs and Word documents from HTML or Word templates, merge PDFs, and request legally binding e-signatures.
5
5
 
6
6
  The version of the OpenAPI document: v2
7
7
 
@@ -1,7 +1,7 @@
1
1
  =begin
2
2
  #DocSpring API
3
3
 
4
- #Use DocSpring's API to programmatically fill out PDF forms, convert HTML to PDFs, merge PDFs, or request legally binding e-signatures.
4
+ #Use DocSpring's API to fill PDF forms, generate PDFs and Word documents from HTML or Word templates, merge PDFs, and request legally binding e-signatures.
5
5
 
6
6
  The version of the OpenAPI document: v2
7
7
 
@@ -1,7 +1,7 @@
1
1
  =begin
2
2
  #DocSpring API
3
3
 
4
- #Use DocSpring's API to programmatically fill out PDF forms, convert HTML to PDFs, merge PDFs, or request legally binding e-signatures.
4
+ #Use DocSpring's API to fill PDF forms, generate PDFs and Word documents from HTML or Word templates, merge PDFs, and request legally binding e-signatures.
5
5
 
6
6
  The version of the OpenAPI document: v2
7
7
 
@@ -19,7 +19,7 @@ module DocSpring
19
19
  # The group's name: `address` for the field `address/city`. A list's item numbers are written as `~`, so the fields `items/0/price` and `items/1/price` are in the groups `items` and `items/~`, the list's items.
20
20
  attr_accessor :name
21
21
 
22
- # `array` for a list, whose fields' names number its items after the group's name (`items/0/price`, or `items/~/price` in an HTML template), and `object` for the other groups.
22
+ # `array` for a list, whose fields' names number its items after the group's name (`items/0/price`, or `items/~/price` in an HTML or Word template), and `object` for the other groups.
23
23
  attr_accessor :type
24
24
 
25
25
  # The group's title in the template's data schema and on forms. When it's empty, a title is made from the group's name.
@@ -34,7 +34,7 @@ module DocSpring
34
34
  # Lists only (`type` `array`): the fewest items submission data must have. Null for no minimum.
35
35
  attr_accessor :min_items
36
36
 
37
- # HTML templates' lists only: the most items submission data can have. Null for no limit. A PDF template's list takes as many items as its fields are numbered for, or more with `allow_additional_items`.
37
+ # HTML and Word templates' lists only: the most items submission data can have. Null for no limit. A PDF template's list takes as many items as its fields are numbered for, or more with `allow_additional_items`.
38
38
  attr_accessor :max_items
39
39
 
40
40
  # PDF templates' lists only: submission data can have more items than the list's fields are numbered for. Default false.
@@ -1,7 +1,7 @@
1
1
  =begin
2
2
  #DocSpring API
3
3
 
4
- #Use DocSpring's API to programmatically fill out PDF forms, convert HTML to PDFs, merge PDFs, or request legally binding e-signatures.
4
+ #Use DocSpring's API to fill PDF forms, generate PDFs and Word documents from HTML or Word templates, merge PDFs, and request legally binding e-signatures.
5
5
 
6
6
  The version of the OpenAPI document: v2
7
7
 
@@ -31,7 +31,7 @@ module DocSpring
31
31
  # Lists only (`type` `array`): the fewest items submission data must have. Null for no minimum.
32
32
  attr_accessor :min_items
33
33
 
34
- # HTML templates' lists only: the most items submission data can have. Null for no limit. A PDF template's list takes as many items as its fields are numbered for, or more with `allow_additional_items`.
34
+ # HTML and Word templates' lists only: the most items submission data can have. Null for no limit. A PDF template's list takes as many items as its fields are numbered for, or more with `allow_additional_items`.
35
35
  attr_accessor :max_items
36
36
 
37
37
  # PDF templates' lists only: submission data can have more items than the list's fields are numbered for. Default false.
@@ -1,7 +1,7 @@
1
1
  =begin
2
2
  #DocSpring API
3
3
 
4
- #Use DocSpring's API to programmatically fill out PDF forms, convert HTML to PDFs, merge PDFs, or request legally binding e-signatures.
4
+ #Use DocSpring's API to fill PDF forms, generate PDFs and Word documents from HTML or Word templates, merge PDFs, and request legally binding e-signatures.
5
5
 
6
6
  The version of the OpenAPI document: v2
7
7
 
@@ -1,7 +1,7 @@
1
1
  =begin
2
2
  #DocSpring API
3
3
 
4
- #Use DocSpring's API to programmatically fill out PDF forms, convert HTML to PDFs, merge PDFs, or request legally binding e-signatures.
4
+ #Use DocSpring's API to fill PDF forms, generate PDFs and Word documents from HTML or Word templates, merge PDFs, and request legally binding e-signatures.
5
5
 
6
6
  The version of the OpenAPI document: v2
7
7
 
@@ -1,7 +1,7 @@
1
1
  =begin
2
2
  #DocSpring API
3
3
 
4
- #Use DocSpring's API to programmatically fill out PDF forms, convert HTML to PDFs, merge PDFs, or request legally binding e-signatures.
4
+ #Use DocSpring's API to fill PDF forms, generate PDFs and Word documents from HTML or Word templates, merge PDFs, and request legally binding e-signatures.
5
5
 
6
6
  The version of the OpenAPI document: v2
7
7
 
@@ -14,7 +14,7 @@ require 'date'
14
14
  require 'time'
15
15
 
16
16
  module DocSpring
17
- # A field of a template: the name of a value in submission data, and how and where it prints. Fields with the same `name` share one value and the settings the descriptions say are shared. A PDF template's fields are placed on its pages: `x`, `y`, `width` and `height` are in units where every page is 2480 wide, measured from the top-left corner of the field's `page`. To convert from PDF points, multiply by 2480 and divide by the page's width in points (`document.page_dimensions` on the template). An HTML template's fields are all on page 1, and their placement and style settings aren't used.
17
+ # A field of a template: the name of a value in submission data, and how and where it prints. Fields with the same `name` share one value and the settings the descriptions say are shared. A PDF template's fields are placed on its pages: `x`, `y`, `width` and `height` are in units where every page is 2480 wide, measured from the top-left corner of the field's `page`. To convert from PDF points, multiply by 2480 and divide by the page's width in points (`document.page_dimensions` on the template). An HTML or Word template's fields are all on page 1, and their placement and style settings aren't used: its HTML or Word document places and styles each value.
18
18
  class FieldInput < ApiModelBase
19
19
  # The field's name, the key of its value in submission data. A `/` nests the key in objects and arrays (`client/address`, `items/0/price`); write a literal `/` as `~1` and `~` as `~0`. Fields with the same name share one value and their shared settings, and array indexes inside a name are ignored for settings, so `items/0/price` and `items/1/price` share settings but not values. A `#` and a line number (`notes#0`, `notes#1`) splits one value over several fields as lines of text, and names that start with `@@` print submission details such as `@@date`.
20
20
  attr_accessor :name
@@ -247,7 +247,7 @@ module DocSpring
247
247
  # Check and shape display only: the value a string or number field's value is compared with, by `string_condition_type` or `number_condition_type`, to decide whether the check mark or shape prints. Boolean fields print when `true` (see `invert_boolean_condition`), and other types print when they have a value.
248
248
  attr_accessor :condition
249
249
 
250
- # String fields with check or shape display: how the value is compared with `condition`: `equals`, `contains`, `starts_with`, `ends_with`, or `regex`, where `condition` is a regular expression the value must match.
250
+ # String fields with check or shape display: how the value is compared with `condition`: `equals`, `contains`, `starts_with`, `ends_with`, or `regex`, where `condition` is a regular expression (RE2 syntax) the value must match; each has a `not_` form that prints when it doesn't match (`not_equals`, `not_regex`, ...). `blank` prints when the value is empty or only spaces and line breaks, and `not_blank` when it isn't; they ignore `condition`.
251
251
  attr_accessor :string_condition_type
252
252
 
253
253
  # Number fields with check or shape display: how the value is compared with `condition`: `equals`, `gt` (greater than), `gte` (greater than or equal to), `lt` (less than), `lte` (less than or equal to), or `range`, between `number_condition_range_min` and `number_condition_range_max`.
@@ -1,7 +1,7 @@
1
1
  =begin
2
2
  #DocSpring API
3
3
 
4
- #Use DocSpring's API to programmatically fill out PDF forms, convert HTML to PDFs, merge PDFs, or request legally binding e-signatures.
4
+ #Use DocSpring's API to fill PDF forms, generate PDFs and Word documents from HTML or Word templates, merge PDFs, and request legally binding e-signatures.
5
5
 
6
6
  The version of the OpenAPI document: v2
7
7
 
@@ -1,7 +1,7 @@
1
1
  =begin
2
2
  #DocSpring API
3
3
 
4
- #Use DocSpring's API to programmatically fill out PDF forms, convert HTML to PDFs, merge PDFs, or request legally binding e-signatures.
4
+ #Use DocSpring's API to fill PDF forms, generate PDFs and Word documents from HTML or Word templates, merge PDFs, and request legally binding e-signatures.
5
5
 
6
6
  The version of the OpenAPI document: v2
7
7
 
@@ -1,7 +1,7 @@
1
1
  =begin
2
2
  #DocSpring API
3
3
 
4
- #Use DocSpring's API to programmatically fill out PDF forms, convert HTML to PDFs, merge PDFs, or request legally binding e-signatures.
4
+ #Use DocSpring's API to fill PDF forms, generate PDFs and Word documents from HTML or Word templates, merge PDFs, and request legally binding e-signatures.
5
5
 
6
6
  The version of the OpenAPI document: v2
7
7
 
@@ -1,7 +1,7 @@
1
1
  =begin
2
2
  #DocSpring API
3
3
 
4
- #Use DocSpring's API to programmatically fill out PDF forms, convert HTML to PDFs, merge PDFs, or request legally binding e-signatures.
4
+ #Use DocSpring's API to fill PDF forms, generate PDFs and Word documents from HTML or Word templates, merge PDFs, and request legally binding e-signatures.
5
5
 
6
6
  The version of the OpenAPI document: v2
7
7
 
@@ -1,7 +1,7 @@
1
1
  =begin
2
2
  #DocSpring API
3
3
 
4
- #Use DocSpring's API to programmatically fill out PDF forms, convert HTML to PDFs, merge PDFs, or request legally binding e-signatures.
4
+ #Use DocSpring's API to fill PDF forms, generate PDFs and Word documents from HTML or Word templates, merge PDFs, and request legally binding e-signatures.
5
5
 
6
6
  The version of the OpenAPI document: v2
7
7
 
@@ -1,7 +1,7 @@
1
1
  =begin
2
2
  #DocSpring API
3
3
 
4
- #Use DocSpring's API to programmatically fill out PDF forms, convert HTML to PDFs, merge PDFs, or request legally binding e-signatures.
4
+ #Use DocSpring's API to fill PDF forms, generate PDFs and Word documents from HTML or Word templates, merge PDFs, and request legally binding e-signatures.
5
5
 
6
6
  The version of the OpenAPI document: v2
7
7
 
@@ -1,7 +1,7 @@
1
1
  =begin
2
2
  #DocSpring API
3
3
 
4
- #Use DocSpring's API to programmatically fill out PDF forms, convert HTML to PDFs, merge PDFs, or request legally binding e-signatures.
4
+ #Use DocSpring's API to fill PDF forms, generate PDFs and Word documents from HTML or Word templates, merge PDFs, and request legally binding e-signatures.
5
5
 
6
6
  The version of the OpenAPI document: v2
7
7
 
@@ -1,7 +1,7 @@
1
1
  =begin
2
2
  #DocSpring API
3
3
 
4
- #Use DocSpring's API to programmatically fill out PDF forms, convert HTML to PDFs, merge PDFs, or request legally binding e-signatures.
4
+ #Use DocSpring's API to fill PDF forms, generate PDFs and Word documents from HTML or Word templates, merge PDFs, and request legally binding e-signatures.
5
5
 
6
6
  The version of the OpenAPI document: v2
7
7
 
@@ -1,7 +1,7 @@
1
1
  =begin
2
2
  #DocSpring API
3
3
 
4
- #Use DocSpring's API to programmatically fill out PDF forms, convert HTML to PDFs, merge PDFs, or request legally binding e-signatures.
4
+ #Use DocSpring's API to fill PDF forms, generate PDFs and Word documents from HTML or Word templates, merge PDFs, and request legally binding e-signatures.
5
5
 
6
6
  The version of the OpenAPI document: v2
7
7
 
@@ -1,7 +1,7 @@
1
1
  =begin
2
2
  #DocSpring API
3
3
 
4
- #Use DocSpring's API to programmatically fill out PDF forms, convert HTML to PDFs, merge PDFs, or request legally binding e-signatures.
4
+ #Use DocSpring's API to fill PDF forms, generate PDFs and Word documents from HTML or Word templates, merge PDFs, and request legally binding e-signatures.
5
5
 
6
6
  The version of the OpenAPI document: v2
7
7
 
@@ -1,7 +1,7 @@
1
1
  =begin
2
2
  #DocSpring API
3
3
 
4
- #Use DocSpring's API to programmatically fill out PDF forms, convert HTML to PDFs, merge PDFs, or request legally binding e-signatures.
4
+ #Use DocSpring's API to fill PDF forms, generate PDFs and Word documents from HTML or Word templates, merge PDFs, and request legally binding e-signatures.
5
5
 
6
6
  The version of the OpenAPI document: v2
7
7
 
@@ -1,7 +1,7 @@
1
1
  =begin
2
2
  #DocSpring API
3
3
 
4
- #Use DocSpring's API to programmatically fill out PDF forms, convert HTML to PDFs, merge PDFs, or request legally binding e-signatures.
4
+ #Use DocSpring's API to fill PDF forms, generate PDFs and Word documents from HTML or Word templates, merge PDFs, and request legally binding e-signatures.
5
5
 
6
6
  The version of the OpenAPI document: v2
7
7
 
@@ -15,10 +15,13 @@ require 'time'
15
15
 
16
16
  module DocSpring
17
17
  class GenerateFilesFormat
18
+ PDF = "pdf".freeze
19
+ DOCX = "docx".freeze
20
+ ODT = "odt".freeze
18
21
  PNG = "png".freeze
19
22
 
20
23
  def self.all_vars
21
- @all_vars ||= [PNG].freeze
24
+ @all_vars ||= [PDF, DOCX, ODT, PNG].freeze
22
25
  end
23
26
 
24
27
  # Builds the enum from string
@@ -1,7 +1,7 @@
1
1
  =begin
2
2
  #DocSpring API
3
3
 
4
- #Use DocSpring's API to programmatically fill out PDF forms, convert HTML to PDFs, merge PDFs, or request legally binding e-signatures.
4
+ #Use DocSpring's API to fill PDF forms, generate PDFs and Word documents from HTML or Word templates, merge PDFs, and request legally binding e-signatures.
5
5
 
6
6
  The version of the OpenAPI document: v2
7
7
 
@@ -16,7 +16,7 @@ require 'time'
16
16
  module DocSpring
17
17
  # The formats to make.
18
18
  class GenerateSubmissionFilesRequest < ApiModelBase
19
- # The formats to add to the submission's files: `png`, an image of each page of the submission's PDF (up to 100 pages). A format the submission already has (or is making) is left as it is.
19
+ # The formats to add to the submission's files: `pdf`, the PDF of a Word template's submission that didn't make one (converted from its Word document); `docx`, the Word document of a Word template's submission that didn't make one (made again from the submission's data and the template version it used); `odt`, the OpenDocument file of a Word template's submission that didn't make one (converted from its Word document); and `png`, an image of each page of the PDF (up to 100 pages), which makes the PDF first if the submission doesn't have one. A submission without a Word document makes it again for `pdf` and `odt`, without keeping it. A format the submission already has (or is making) is left as it is.
20
20
  attr_accessor :formats
21
21
 
22
22
  # Attribute mapping from ruby-style variable name to JSON key.
@@ -1,7 +1,7 @@
1
1
  =begin
2
2
  #DocSpring API
3
3
 
4
- #Use DocSpring's API to programmatically fill out PDF forms, convert HTML to PDFs, merge PDFs, or request legally binding e-signatures.
4
+ #Use DocSpring's API to fill PDF forms, generate PDFs and Word documents from HTML or Word templates, merge PDFs, and request legally binding e-signatures.
5
5
 
6
6
  The version of the OpenAPI document: v2
7
7
 
@@ -14,7 +14,7 @@ require 'date'
14
14
  require 'time'
15
15
 
16
16
  module DocSpring
17
- # A file that DocSpring generated, such as a submission's PDF. A file made after its submission was processed is listed while it's being made: check its `state` before using its links.
17
+ # A file that DocSpring generated, such as a submission's PDF or Word document. A file made after its submission was processed is listed while it's being made: check its `state` before using its links.
18
18
  class GeneratedFile < ApiModelBase
19
19
  # `processed` once the file has been made. `pending` while it's being made, and `error` if it couldn't be made (see `error_message`).
20
20
  attr_accessor :state
@@ -28,10 +28,10 @@ module DocSpring
28
28
  # A link to download the file that doesn't expire: it redirects to a new temporary link. It needs your API token or a signed-in session, except for a submission of a template that makes its submissions public. Null until the file has been made.
29
29
  attr_accessor :permanent_url
30
30
 
31
- # The file's name, such as `sub_123.pdf`.
31
+ # The file's name, such as `sub_123.pdf`, `sub_123.docx` or `sub_123.odt`.
32
32
  attr_accessor :filename
33
33
 
34
- # The file's media type, such as `application/pdf`.
34
+ # The file's media type: `application/pdf`, `application/vnd.openxmlformats-officedocument.wordprocessingml.document` for a Word document, or `application/vnd.oasis.opendocument.text` for an OpenDocument file.
35
35
  attr_accessor :content_type
36
36
 
37
37
  # The file's size in bytes. Null until the file has been made.
@@ -1,7 +1,7 @@
1
1
  =begin
2
2
  #DocSpring API
3
3
 
4
- #Use DocSpring's API to programmatically fill out PDF forms, convert HTML to PDFs, merge PDFs, or request legally binding e-signatures.
4
+ #Use DocSpring's API to fill PDF forms, generate PDFs and Word documents from HTML or Word templates, merge PDFs, and request legally binding e-signatures.
5
5
 
6
6
  The version of the OpenAPI document: v2
7
7
 
@@ -1,7 +1,7 @@
1
1
  =begin
2
2
  #DocSpring API
3
3
 
4
- #Use DocSpring's API to programmatically fill out PDF forms, convert HTML to PDFs, merge PDFs, or request legally binding e-signatures.
4
+ #Use DocSpring's API to fill PDF forms, generate PDFs and Word documents from HTML or Word templates, merge PDFs, and request legally binding e-signatures.
5
5
 
6
6
  The version of the OpenAPI document: v2
7
7
 
@@ -25,7 +25,7 @@ module DocSpring
25
25
  # The page height for the `Custom` format, with a unit.
26
26
  attr_accessor :height
27
27
 
28
- # How much to scale the page, such as `0.8`. `1` prints it at its normal size.
28
+ # How much to scale the page, from 0.1 to 2, such as `0.8`. `1` prints it at its normal size.
29
29
  attr_accessor :scale
30
30
 
31
31
  # Print pages in landscape orientation.
@@ -1,7 +1,7 @@
1
1
  =begin
2
2
  #DocSpring API
3
3
 
4
- #Use DocSpring's API to programmatically fill out PDF forms, convert HTML to PDFs, merge PDFs, or request legally binding e-signatures.
4
+ #Use DocSpring's API to fill PDF forms, generate PDFs and Word documents from HTML or Word templates, merge PDFs, and request legally binding e-signatures.
5
5
 
6
6
  The version of the OpenAPI document: v2
7
7
 
@@ -25,7 +25,7 @@ module DocSpring
25
25
  # The page height for the `Custom` format, with a unit.
26
26
  attr_accessor :height
27
27
 
28
- # How much to scale the page, such as `0.8`. `1` prints it at its normal size.
28
+ # How much to scale the page, from 0.1 to 2, such as `0.8`. `1` prints it at its normal size.
29
29
  attr_accessor :scale
30
30
 
31
31
  # Print pages in landscape orientation.
@@ -1,7 +1,7 @@
1
1
  =begin
2
2
  #DocSpring API
3
3
 
4
- #Use DocSpring's API to programmatically fill out PDF forms, convert HTML to PDFs, merge PDFs, or request legally binding e-signatures.
4
+ #Use DocSpring's API to fill PDF forms, generate PDFs and Word documents from HTML or Word templates, merge PDFs, and request legally binding e-signatures.
5
5
 
6
6
  The version of the OpenAPI document: v2
7
7
 
@@ -1,7 +1,7 @@
1
1
  =begin
2
2
  #DocSpring API
3
3
 
4
- #Use DocSpring's API to programmatically fill out PDF forms, convert HTML to PDFs, merge PDFs, or request legally binding e-signatures.
4
+ #Use DocSpring's API to fill PDF forms, generate PDFs and Word documents from HTML or Word templates, merge PDFs, and request legally binding e-signatures.
5
5
 
6
6
  The version of the OpenAPI document: v2
7
7
 
@@ -1,7 +1,7 @@
1
1
  =begin
2
2
  #DocSpring API
3
3
 
4
- #Use DocSpring's API to programmatically fill out PDF forms, convert HTML to PDFs, merge PDFs, or request legally binding e-signatures.
4
+ #Use DocSpring's API to fill PDF forms, generate PDFs and Word documents from HTML or Word templates, merge PDFs, and request legally binding e-signatures.
5
5
 
6
6
  The version of the OpenAPI document: v2
7
7
 
@@ -24,9 +24,10 @@ module DocSpring
24
24
  CSHARP = "csharp".freeze
25
25
  ELIXIR = "elixir".freeze
26
26
  GO = "go".freeze
27
+ RUST = "rust".freeze
27
28
 
28
29
  def self.all_vars
29
- @all_vars ||= [TYPESCRIPT, JAVASCRIPT, RUBY, PYTHON, PHP, JAVA, CSHARP, ELIXIR, GO].freeze
30
+ @all_vars ||= [TYPESCRIPT, JAVASCRIPT, RUBY, PYTHON, PHP, JAVA, CSHARP, ELIXIR, GO, RUST].freeze
30
31
  end
31
32
 
32
33
  # Builds the enum from string