docspring 4.2.0 → 4.3.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 (362) hide show
  1. checksums.yaml +4 -4
  2. data/.travis.yml +1 -1
  3. data/AGENTS.md +2 -2
  4. data/CHANGELOG.md +27 -0
  5. data/Gemfile.lock +4 -3
  6. data/README.md +7 -6
  7. data/docs/Client.md +104 -102
  8. data/docs/CreateSubmissionRequest.md +3 -3
  9. data/docs/CreateTemplateRequest.md +11 -9
  10. data/docs/ErrorInfo.md +1 -1
  11. data/docs/FieldGroup.md +2 -2
  12. data/docs/FieldGroupInput.md +1 -1
  13. data/docs/GenerateSubmissionFilesRequest.md +1 -1
  14. data/docs/GeneratedFile.md +2 -2
  15. data/docs/Submission.md +4 -4
  16. data/docs/SubmissionBatch.md +3 -3
  17. data/docs/SubmissionFiles.md +4 -0
  18. data/docs/SubmissionInput.md +3 -3
  19. data/docs/SubmissionSummary.md +2 -2
  20. data/docs/Template.md +10 -8
  21. data/docs/TemplateDiff.md +2 -2
  22. data/docs/TemplateDocument.md +10 -10
  23. data/docs/TemplateDocumentSummary.md +4 -4
  24. data/docs/TemplatePreview.md +1 -1
  25. data/docs/TemplateSummary.md +5 -3
  26. data/docs/UpdateTemplateDocumentRequest.md +5 -5
  27. data/docs/UpdateTemplateRequest.md +6 -4
  28. data/docs/ValidateSubmissionRequest.md +3 -3
  29. data/docspring.gemspec +2 -2
  30. data/lib/docspring/api/client.rb +50 -47
  31. data/lib/docspring/api_client.rb +2 -2
  32. data/lib/docspring/api_error.rb +1 -1
  33. data/lib/docspring/api_model_base.rb +1 -1
  34. data/lib/docspring/configuration.rb +1 -1
  35. data/lib/docspring/models/add_template_fields_request.rb +1 -1
  36. data/lib/docspring/models/ai_field_naming_language.rb +1 -1
  37. data/lib/docspring/models/authentication_check.rb +1 -1
  38. data/lib/docspring/models/barcode_symbology.rb +1 -1
  39. data/lib/docspring/models/check_character.rb +1 -1
  40. data/lib/docspring/models/combined_field_type.rb +1 -1
  41. data/lib/docspring/models/combined_pdf.rb +1 -1
  42. data/lib/docspring/models/combined_pdf_files.rb +1 -1
  43. data/lib/docspring/models/combined_pdf_list.rb +1 -1
  44. data/lib/docspring/models/combined_pdf_source.rb +1 -1
  45. data/lib/docspring/models/combined_pdf_source_input.rb +1 -1
  46. data/lib/docspring/models/combined_pdf_source_pdf.rb +1 -1
  47. data/lib/docspring/models/combined_pdf_source_type.rb +1 -1
  48. data/lib/docspring/models/combined_pdf_state.rb +1 -1
  49. data/lib/docspring/models/copy_template_request.rb +1 -1
  50. data/lib/docspring/models/create_combined_pdf_request.rb +1 -1
  51. data/lib/docspring/models/create_custom_file_from_upload_request.rb +1 -1
  52. data/lib/docspring/models/create_folder_request.rb +1 -1
  53. data/lib/docspring/models/create_signature_request_event_request.rb +1 -1
  54. data/lib/docspring/models/create_signature_request_token_request.rb +1 -1
  55. data/lib/docspring/models/create_submission_batch_request.rb +1 -1
  56. data/lib/docspring/models/create_submission_request.rb +4 -4
  57. data/lib/docspring/models/create_template_preview_request.rb +1 -1
  58. data/lib/docspring/models/create_template_request.rb +21 -11
  59. data/lib/docspring/models/create_webhook_request.rb +1 -1
  60. data/lib/docspring/models/custom_file.rb +1 -1
  61. data/lib/docspring/models/custom_file_list.rb +1 -1
  62. data/lib/docspring/models/custom_file_source_pdf.rb +1 -1
  63. data/lib/docspring/models/error_code.rb +1 -1
  64. data/lib/docspring/models/error_detail.rb +1 -1
  65. data/lib/docspring/models/error_info.rb +2 -2
  66. data/lib/docspring/models/error_response.rb +1 -1
  67. data/lib/docspring/models/expiration_interval.rb +1 -1
  68. data/lib/docspring/models/field.rb +2 -2
  69. data/lib/docspring/models/field_comparison_condition.rb +1 -1
  70. data/lib/docspring/models/field_comparison_operator.rb +1 -1
  71. data/lib/docspring/models/field_dependency.rb +1 -1
  72. data/lib/docspring/models/field_dependency_input.rb +1 -1
  73. data/lib/docspring/models/field_display_type.rb +1 -1
  74. data/lib/docspring/models/field_equals_condition.rb +1 -1
  75. data/lib/docspring/models/field_equals_operator.rb +1 -1
  76. data/lib/docspring/models/field_group.rb +3 -3
  77. data/lib/docspring/models/field_group_input.rb +2 -2
  78. data/lib/docspring/models/field_group_type.rb +1 -1
  79. data/lib/docspring/models/field_in_condition.rb +1 -1
  80. data/lib/docspring/models/field_input.rb +2 -2
  81. data/lib/docspring/models/field_override.rb +1 -1
  82. data/lib/docspring/models/field_presence_condition.rb +1 -1
  83. data/lib/docspring/models/field_presence_operator.rb +1 -1
  84. data/lib/docspring/models/field_range_condition.rb +1 -1
  85. data/lib/docspring/models/field_reimport_state.rb +1 -1
  86. data/lib/docspring/models/field_setup_logic.rb +1 -1
  87. data/lib/docspring/models/field_setup_naming.rb +1 -1
  88. data/lib/docspring/models/field_setup_source.rb +1 -1
  89. data/lib/docspring/models/field_type.rb +1 -1
  90. data/lib/docspring/models/folder.rb +1 -1
  91. data/lib/docspring/models/folder_list.rb +1 -1
  92. data/lib/docspring/models/generate_files_format.rb +5 -2
  93. data/lib/docspring/models/generate_submission_files_request.rb +2 -2
  94. data/lib/docspring/models/generated_file.rb +4 -4
  95. data/lib/docspring/models/generated_file_state.rb +1 -1
  96. data/lib/docspring/models/html_engine_options.rb +1 -1
  97. data/lib/docspring/models/html_engine_options_input.rb +1 -1
  98. data/lib/docspring/models/image_gravity.rb +1 -1
  99. data/lib/docspring/models/image_scale_type.rb +1 -1
  100. data/lib/docspring/models/model_code_language.rb +3 -2
  101. data/lib/docspring/models/move_folder_request.rb +1 -1
  102. data/lib/docspring/models/move_template_request.rb +1 -1
  103. data/lib/docspring/models/number_condition_type.rb +1 -1
  104. data/lib/docspring/models/output_format.rb +4 -2
  105. data/lib/docspring/models/page_format.rb +1 -1
  106. data/lib/docspring/models/page_image.rb +1 -1
  107. data/lib/docspring/models/page_images.rb +1 -1
  108. data/lib/docspring/models/predefined_field.rb +1 -1
  109. data/lib/docspring/models/predefined_field_input.rb +1 -1
  110. data/lib/docspring/models/publish_template_version_request.rb +1 -1
  111. data/lib/docspring/models/remove_template_fields_request.rb +1 -1
  112. data/lib/docspring/models/rename_folder_request.rb +1 -1
  113. data/lib/docspring/models/reorder_template_fields_request.rb +1 -1
  114. data/lib/docspring/models/restore_template_version_request.rb +1 -1
  115. data/lib/docspring/models/shape_type.rb +1 -1
  116. data/lib/docspring/models/signature_request.rb +1 -1
  117. data/lib/docspring/models/signature_request_auth_second_factor_type.rb +1 -1
  118. data/lib/docspring/models/signature_request_auth_type.rb +1 -1
  119. data/lib/docspring/models/signature_request_event.rb +1 -1
  120. data/lib/docspring/models/signature_request_event_type.rb +1 -1
  121. data/lib/docspring/models/signature_request_input.rb +1 -1
  122. data/lib/docspring/models/signature_request_message_type.rb +1 -1
  123. data/lib/docspring/models/signature_request_state.rb +1 -1
  124. data/lib/docspring/models/signature_request_token.rb +1 -1
  125. data/lib/docspring/models/signature_request_token_type.rb +1 -1
  126. data/lib/docspring/models/string_condition_type.rb +1 -1
  127. data/lib/docspring/models/submission.rb +6 -6
  128. data/lib/docspring/models/submission_action.rb +1 -1
  129. data/lib/docspring/models/submission_action_state.rb +1 -1
  130. data/lib/docspring/models/submission_action_type.rb +1 -1
  131. data/lib/docspring/models/submission_batch.rb +5 -5
  132. data/lib/docspring/models/submission_batch_state.rb +1 -1
  133. data/lib/docspring/models/submission_files.rb +22 -2
  134. data/lib/docspring/models/submission_input.rb +4 -4
  135. data/lib/docspring/models/submission_list.rb +1 -1
  136. data/lib/docspring/models/submission_source.rb +1 -1
  137. data/lib/docspring/models/submission_source_pdf.rb +1 -1
  138. data/lib/docspring/models/submission_state.rb +1 -1
  139. data/lib/docspring/models/submission_summary.rb +3 -3
  140. data/lib/docspring/models/submission_validation.rb +1 -1
  141. data/lib/docspring/models/template.rb +37 -10
  142. data/lib/docspring/models/template_actor.rb +1 -1
  143. data/lib/docspring/models/template_actor_type.rb +1 -1
  144. data/lib/docspring/models/template_defaults.rb +1 -1
  145. data/lib/docspring/models/template_defaults_input.rb +1 -1
  146. data/lib/docspring/models/template_diff.rb +3 -3
  147. data/lib/docspring/models/template_diff_summary.rb +1 -1
  148. data/lib/docspring/models/template_document.rb +12 -12
  149. data/lib/docspring/models/template_document_state.rb +4 -2
  150. data/lib/docspring/models/template_document_summary.rb +6 -6
  151. data/lib/docspring/models/template_field_change.rb +1 -1
  152. data/lib/docspring/models/template_field_changes.rb +1 -1
  153. data/lib/docspring/models/template_field_dependency.rb +1 -1
  154. data/lib/docspring/models/template_field_dependency_action.rb +1 -1
  155. data/lib/docspring/models/template_field_dependency_condition.rb +1 -1
  156. data/lib/docspring/models/template_field_dependency_condition_input.rb +1 -1
  157. data/lib/docspring/models/template_field_dependency_input.rb +1 -1
  158. data/lib/docspring/models/template_field_dependency_match.rb +1 -1
  159. data/lib/docspring/models/template_field_dependency_operator.rb +1 -1
  160. data/lib/docspring/models/template_field_logic_status.rb +1 -1
  161. data/lib/docspring/models/template_field_move.rb +1 -1
  162. data/lib/docspring/models/template_fields.rb +1 -1
  163. data/lib/docspring/models/template_form_mode.rb +1 -1
  164. data/lib/docspring/models/template_model_code.rb +1 -1
  165. data/lib/docspring/models/template_page_ai_error.rb +1 -1
  166. data/lib/docspring/models/template_page_ai_naming_status.rb +1 -1
  167. data/lib/docspring/models/template_page_fields_status.rb +1 -1
  168. data/lib/docspring/models/template_page_image_status.rb +1 -1
  169. data/lib/docspring/models/template_page_images.rb +1 -1
  170. data/lib/docspring/models/template_page_processing_status.rb +1 -1
  171. data/lib/docspring/models/template_preview.rb +3 -3
  172. data/lib/docspring/models/template_preview_state.rb +1 -1
  173. data/lib/docspring/models/template_source_pdf.rb +1 -1
  174. data/lib/docspring/models/template_summary.rb +32 -5
  175. data/lib/docspring/models/template_summary_list.rb +1 -1
  176. data/lib/docspring/models/template_type.rb +3 -2
  177. data/lib/docspring/models/template_version.rb +1 -1
  178. data/lib/docspring/models/template_version_type.rb +1 -1
  179. data/lib/docspring/models/text_alignment.rb +1 -1
  180. data/lib/docspring/models/text_overflow.rb +1 -1
  181. data/lib/docspring/models/text_vertical_alignment.rb +1 -1
  182. data/lib/docspring/models/typeface.rb +1 -1
  183. data/lib/docspring/models/update_signature_request_request.rb +1 -1
  184. data/lib/docspring/models/update_template_document_request.rb +7 -7
  185. data/lib/docspring/models/update_template_fields_request.rb +1 -1
  186. data/lib/docspring/models/update_template_request.rb +16 -6
  187. data/lib/docspring/models/update_webhook_request.rb +1 -1
  188. data/lib/docspring/models/upload_method.rb +1 -1
  189. data/lib/docspring/models/upload_presign.rb +1 -1
  190. data/lib/docspring/models/url_source_pdf.rb +1 -1
  191. data/lib/docspring/models/validate_submission_request.rb +4 -4
  192. data/lib/docspring/models/webhook.rb +1 -1
  193. data/lib/docspring/models/webhook_event_type.rb +1 -1
  194. data/lib/docspring/models/webhook_list.rb +1 -1
  195. data/lib/docspring/models/webhook_mode.rb +1 -1
  196. data/lib/docspring/request_schemas.json +39 -2
  197. data/lib/docspring/version.rb +2 -2
  198. data/lib/docspring.rb +1 -1
  199. data/spec/api/client_spec.rb +25 -24
  200. data/spec/models/add_template_fields_request_spec.rb +1 -1
  201. data/spec/models/ai_field_naming_language_spec.rb +1 -1
  202. data/spec/models/authentication_check_spec.rb +1 -1
  203. data/spec/models/barcode_symbology_spec.rb +1 -1
  204. data/spec/models/check_character_spec.rb +1 -1
  205. data/spec/models/combined_field_type_spec.rb +1 -1
  206. data/spec/models/combined_pdf_files_spec.rb +1 -1
  207. data/spec/models/combined_pdf_list_spec.rb +1 -1
  208. data/spec/models/combined_pdf_source_input_spec.rb +1 -1
  209. data/spec/models/combined_pdf_source_pdf_spec.rb +1 -1
  210. data/spec/models/combined_pdf_source_spec.rb +1 -1
  211. data/spec/models/combined_pdf_source_type_spec.rb +1 -1
  212. data/spec/models/combined_pdf_spec.rb +1 -1
  213. data/spec/models/combined_pdf_state_spec.rb +1 -1
  214. data/spec/models/copy_template_request_spec.rb +1 -1
  215. data/spec/models/create_combined_pdf_request_spec.rb +1 -1
  216. data/spec/models/create_custom_file_from_upload_request_spec.rb +1 -1
  217. data/spec/models/create_folder_request_spec.rb +1 -1
  218. data/spec/models/create_signature_request_event_request_spec.rb +1 -1
  219. data/spec/models/create_signature_request_token_request_spec.rb +1 -1
  220. data/spec/models/create_submission_batch_request_spec.rb +1 -1
  221. data/spec/models/create_submission_request_spec.rb +1 -1
  222. data/spec/models/create_template_preview_request_spec.rb +1 -1
  223. data/spec/models/create_template_request_spec.rb +7 -1
  224. data/spec/models/create_webhook_request_spec.rb +1 -1
  225. data/spec/models/custom_file_list_spec.rb +1 -1
  226. data/spec/models/custom_file_source_pdf_spec.rb +1 -1
  227. data/spec/models/custom_file_spec.rb +1 -1
  228. data/spec/models/error_code_spec.rb +1 -1
  229. data/spec/models/error_detail_spec.rb +1 -1
  230. data/spec/models/error_info_spec.rb +1 -1
  231. data/spec/models/error_response_spec.rb +1 -1
  232. data/spec/models/expiration_interval_spec.rb +1 -1
  233. data/spec/models/field_comparison_condition_spec.rb +1 -1
  234. data/spec/models/field_comparison_operator_spec.rb +1 -1
  235. data/spec/models/field_dependency_input_spec.rb +1 -1
  236. data/spec/models/field_dependency_spec.rb +1 -1
  237. data/spec/models/field_display_type_spec.rb +1 -1
  238. data/spec/models/field_equals_condition_spec.rb +1 -1
  239. data/spec/models/field_equals_operator_spec.rb +1 -1
  240. data/spec/models/field_group_input_spec.rb +1 -1
  241. data/spec/models/field_group_spec.rb +1 -1
  242. data/spec/models/field_group_type_spec.rb +1 -1
  243. data/spec/models/field_in_condition_spec.rb +1 -1
  244. data/spec/models/field_input_spec.rb +1 -1
  245. data/spec/models/field_override_spec.rb +1 -1
  246. data/spec/models/field_presence_condition_spec.rb +1 -1
  247. data/spec/models/field_presence_operator_spec.rb +1 -1
  248. data/spec/models/field_range_condition_spec.rb +1 -1
  249. data/spec/models/field_reimport_state_spec.rb +1 -1
  250. data/spec/models/field_setup_logic_spec.rb +1 -1
  251. data/spec/models/field_setup_naming_spec.rb +1 -1
  252. data/spec/models/field_setup_source_spec.rb +1 -1
  253. data/spec/models/field_spec.rb +1 -1
  254. data/spec/models/field_type_spec.rb +1 -1
  255. data/spec/models/folder_list_spec.rb +1 -1
  256. data/spec/models/folder_spec.rb +1 -1
  257. data/spec/models/generate_files_format_spec.rb +1 -1
  258. data/spec/models/generate_submission_files_request_spec.rb +1 -1
  259. data/spec/models/generated_file_spec.rb +1 -1
  260. data/spec/models/generated_file_state_spec.rb +1 -1
  261. data/spec/models/html_engine_options_input_spec.rb +1 -1
  262. data/spec/models/html_engine_options_spec.rb +1 -1
  263. data/spec/models/image_gravity_spec.rb +1 -1
  264. data/spec/models/image_scale_type_spec.rb +1 -1
  265. data/spec/models/model_code_language_spec.rb +1 -1
  266. data/spec/models/move_folder_request_spec.rb +1 -1
  267. data/spec/models/move_template_request_spec.rb +1 -1
  268. data/spec/models/number_condition_type_spec.rb +1 -1
  269. data/spec/models/output_format_spec.rb +1 -1
  270. data/spec/models/page_format_spec.rb +1 -1
  271. data/spec/models/page_image_spec.rb +1 -1
  272. data/spec/models/page_images_spec.rb +1 -1
  273. data/spec/models/predefined_field_input_spec.rb +1 -1
  274. data/spec/models/predefined_field_spec.rb +1 -1
  275. data/spec/models/publish_template_version_request_spec.rb +1 -1
  276. data/spec/models/remove_template_fields_request_spec.rb +1 -1
  277. data/spec/models/rename_folder_request_spec.rb +1 -1
  278. data/spec/models/reorder_template_fields_request_spec.rb +1 -1
  279. data/spec/models/restore_template_version_request_spec.rb +1 -1
  280. data/spec/models/shape_type_spec.rb +1 -1
  281. data/spec/models/signature_request_auth_second_factor_type_spec.rb +1 -1
  282. data/spec/models/signature_request_auth_type_spec.rb +1 -1
  283. data/spec/models/signature_request_event_spec.rb +1 -1
  284. data/spec/models/signature_request_event_type_spec.rb +1 -1
  285. data/spec/models/signature_request_input_spec.rb +1 -1
  286. data/spec/models/signature_request_message_type_spec.rb +1 -1
  287. data/spec/models/signature_request_spec.rb +1 -1
  288. data/spec/models/signature_request_state_spec.rb +1 -1
  289. data/spec/models/signature_request_token_spec.rb +1 -1
  290. data/spec/models/signature_request_token_type_spec.rb +1 -1
  291. data/spec/models/string_condition_type_spec.rb +1 -1
  292. data/spec/models/submission_action_spec.rb +1 -1
  293. data/spec/models/submission_action_state_spec.rb +1 -1
  294. data/spec/models/submission_action_type_spec.rb +1 -1
  295. data/spec/models/submission_batch_spec.rb +1 -1
  296. data/spec/models/submission_batch_state_spec.rb +1 -1
  297. data/spec/models/submission_files_spec.rb +13 -1
  298. data/spec/models/submission_input_spec.rb +1 -1
  299. data/spec/models/submission_list_spec.rb +1 -1
  300. data/spec/models/submission_source_pdf_spec.rb +1 -1
  301. data/spec/models/submission_source_spec.rb +1 -1
  302. data/spec/models/submission_spec.rb +1 -1
  303. data/spec/models/submission_state_spec.rb +1 -1
  304. data/spec/models/submission_summary_spec.rb +1 -1
  305. data/spec/models/submission_validation_spec.rb +1 -1
  306. data/spec/models/template_actor_spec.rb +1 -1
  307. data/spec/models/template_actor_type_spec.rb +1 -1
  308. data/spec/models/template_defaults_input_spec.rb +1 -1
  309. data/spec/models/template_defaults_spec.rb +1 -1
  310. data/spec/models/template_diff_spec.rb +1 -1
  311. data/spec/models/template_diff_summary_spec.rb +1 -1
  312. data/spec/models/template_document_spec.rb +1 -1
  313. data/spec/models/template_document_state_spec.rb +1 -1
  314. data/spec/models/template_document_summary_spec.rb +1 -1
  315. data/spec/models/template_field_change_spec.rb +1 -1
  316. data/spec/models/template_field_changes_spec.rb +1 -1
  317. data/spec/models/template_field_dependency_action_spec.rb +1 -1
  318. data/spec/models/template_field_dependency_condition_input_spec.rb +1 -1
  319. data/spec/models/template_field_dependency_condition_spec.rb +1 -1
  320. data/spec/models/template_field_dependency_input_spec.rb +1 -1
  321. data/spec/models/template_field_dependency_match_spec.rb +1 -1
  322. data/spec/models/template_field_dependency_operator_spec.rb +1 -1
  323. data/spec/models/template_field_dependency_spec.rb +1 -1
  324. data/spec/models/template_field_logic_status_spec.rb +1 -1
  325. data/spec/models/template_field_move_spec.rb +1 -1
  326. data/spec/models/template_fields_spec.rb +1 -1
  327. data/spec/models/template_form_mode_spec.rb +1 -1
  328. data/spec/models/template_model_code_spec.rb +1 -1
  329. data/spec/models/template_page_ai_error_spec.rb +1 -1
  330. data/spec/models/template_page_ai_naming_status_spec.rb +1 -1
  331. data/spec/models/template_page_fields_status_spec.rb +1 -1
  332. data/spec/models/template_page_image_status_spec.rb +1 -1
  333. data/spec/models/template_page_images_spec.rb +1 -1
  334. data/spec/models/template_page_processing_status_spec.rb +1 -1
  335. data/spec/models/template_preview_spec.rb +1 -1
  336. data/spec/models/template_preview_state_spec.rb +1 -1
  337. data/spec/models/template_source_pdf_spec.rb +1 -1
  338. data/spec/models/template_spec.rb +7 -1
  339. data/spec/models/template_summary_list_spec.rb +1 -1
  340. data/spec/models/template_summary_spec.rb +7 -1
  341. data/spec/models/template_type_spec.rb +1 -1
  342. data/spec/models/template_version_spec.rb +1 -1
  343. data/spec/models/template_version_type_spec.rb +1 -1
  344. data/spec/models/text_alignment_spec.rb +1 -1
  345. data/spec/models/text_overflow_spec.rb +1 -1
  346. data/spec/models/text_vertical_alignment_spec.rb +1 -1
  347. data/spec/models/typeface_spec.rb +1 -1
  348. data/spec/models/update_signature_request_request_spec.rb +1 -1
  349. data/spec/models/update_template_document_request_spec.rb +1 -1
  350. data/spec/models/update_template_fields_request_spec.rb +1 -1
  351. data/spec/models/update_template_request_spec.rb +7 -1
  352. data/spec/models/update_webhook_request_spec.rb +1 -1
  353. data/spec/models/upload_method_spec.rb +1 -1
  354. data/spec/models/upload_presign_spec.rb +1 -1
  355. data/spec/models/url_source_pdf_spec.rb +1 -1
  356. data/spec/models/validate_submission_request_spec.rb +1 -1
  357. data/spec/models/webhook_event_type_spec.rb +1 -1
  358. data/spec/models/webhook_list_spec.rb +1 -1
  359. data/spec/models/webhook_mode_spec.rb +1 -1
  360. data/spec/models/webhook_spec.rb +1 -1
  361. data/spec/spec_helper.rb +1 -1
  362. metadata +3 -2
@@ -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
 
@@ -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
 
@@ -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
@@ -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
 
@@ -16,10 +16,12 @@ require 'time'
16
16
  module DocSpring
17
17
  class OutputFormat
18
18
  PDF = "pdf".freeze
19
+ DOCX = "docx".freeze
20
+ ODT = "odt".freeze
19
21
  PNG = "png".freeze
20
22
 
21
23
  def self.all_vars
22
- @all_vars ||= [PDF, PNG].freeze
24
+ @all_vars ||= [PDF, DOCX, ODT, PNG].freeze
23
25
  end
24
26
 
25
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
 
@@ -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
 
@@ -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
 
@@ -14,7 +14,7 @@ require 'date'
14
14
  require 'time'
15
15
 
16
16
  module DocSpring
17
- # Data submitted to a template, and the PDF generated from it.
17
+ # Data submitted to a template, and the files generated from it (a PDF, a Word document, an OpenDocument file, or more than one of them).
18
18
  class Submission < ApiModelBase
19
19
  # The submission's ID.
20
20
  attr_accessor :id
@@ -22,7 +22,7 @@ module DocSpring
22
22
  # Null once the template has been permanently deleted.
23
23
  attr_accessor :template_id
24
24
 
25
- # The template's type: `pdf` or `html`.
25
+ # The template's type: `pdf`, `html` or `docx`.
26
26
  attr_accessor :template_type
27
27
 
28
28
  # The published version of the template the submission used. Null for the draft.
@@ -34,7 +34,7 @@ module DocSpring
34
34
  # `api`: created with the API. `web`: a web form. `reprocess`: a copy of another submission, made to generate its PDF again.
35
35
  attr_accessor :source
36
36
 
37
- # `pending` until the PDF has been generated, then `processed`. `waiting_for_signature_requests` until every signature request is completed. `insufficient_credits`: waiting for credits; `error_message` says whether the PDF is generated once you add them. `account_suspended`: waiting for the account to be reactivated, for up to 30 days. Waiting ends in `error` if it's discarded or takes over 30 days. Every other state is final, with no PDF: `invalid_data` (the data doesn't match the template's fields: see `data_errors`), `declined` (a signature request was declined), and the states where generating the PDF failed, which have an `error_message`: `syntax_error` (a mistake in an HTML template's Liquid or SCSS), `image_download_failed` or `image_processing_failed` (an image in the data or the template couldn't be downloaded or read) and `error` (anything else). Older submissions can also be `license_revoked` or `accidental`.
37
+ # `pending` until the files have been generated, then `processed`. `waiting_for_signature_requests` until every signature request is completed. `insufficient_credits`: waiting for credits; `error_message` says whether the files are generated once you add them. `account_suspended`: waiting for the account to be reactivated, for up to 30 days. Waiting ends in `error` if it's discarded or takes over 30 days. Every other state is final, with no files: `invalid_data` (the data doesn't match the template's fields: see `data_errors`), `declined` (a signature request was declined), and the states where generating the files failed, which have an `error_message`: `syntax_error` (a mistake in an HTML template's Liquid or SCSS, or in a Word template's tags), `image_download_failed` or `image_processing_failed` (an image in the data or the template couldn't be downloaded or read) and `error` (anything else). Older submissions can also be `license_revoked` or `accidental`.
38
38
  attr_accessor :state
39
39
 
40
40
  # Test PDFs have a watermark and are free. Live PDFs use credits. Submissions made with a test API token are always test submissions.
@@ -55,7 +55,7 @@ module DocSpring
55
55
  # Your own data about the submission, such as an ID from your app. It isn't printed on the PDF. Two keys also change the PDF: `pdf_filename` names its file (`files.pdf.filename`, and its download), and `pdf_title` is its title in the PDF's document properties (and an HTML template's `<title>`, unless its HTML has one). Without `pdf_title`, the title is the template's name. In `pdf_filename`, a `.pdf` ending is removed, each run of characters other than letters, digits, `-`, `_` and `.` becomes one `_`, and the first 128 characters are kept, then `.pdf` is added. Without it, the file is named after the submission's ID (`sub_1234567890abcdef01.pdf`).
56
56
  attr_accessor :metadata
57
57
 
58
- # The generated files: `pdf` once the submission has been processed, `png` (the images of the PDF's pages, when `output_formats` has it: `files.png.pages[0]` is page 1), `audit_trail` once its signature requests are completed, and `preview` once a preview PDF has been generated. Empty once the submission has expired.
58
+ # The generated files: `pdf`, `docx` and `odt` (by `output_formats`) once the submission has been processed, `png` (the images of the PDF's pages, when `output_formats` has it: `files.png.pages[0]` is page 1), `audit_trail` once its signature requests are completed, and `preview` once a preview PDF has been generated. Empty once the submission has expired.
59
59
  attr_accessor :files
60
60
 
61
61
  # An expired submission's data, metadata, password and PDF have been deleted.
@@ -85,7 +85,7 @@ module DocSpring
85
85
  # The text of each field that didn't fit in it, by field name. Left out (null) with `data`, and empty once the submission has expired.
86
86
  attr_accessor :truncated_text
87
87
 
88
- # What the submission makes: `pdf`, and `png` (an image of each page of the PDF, up to 100 pages) when you ask for it. Default `["pdf"]`. POST /submissions/{submission_id}/generate_files adds `png` to a processed submission.
88
+ # What the submission makes: `pdf`, `docx` (a Word document, from a Word template), `odt` (an OpenDocument file, the format LibreOffice uses, converted from a Word template's Word document), and `png` (an image of each page of the PDF, up to 100 pages, which adds `pdf`) when you ask for it. Default `["pdf"]`, or a Word template's `output_format`. POST /submissions/{submission_id}/generate_files adds `png`, and a Word template's submission's `pdf`, `docx` or `odt`, to a processed submission.
89
89
  attr_accessor :output_formats
90
90
 
91
91
  # When the preview PDF was generated. Null if there is no preview.
@@ -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
 
@@ -14,12 +14,12 @@ require 'date'
14
14
  require 'time'
15
15
 
16
16
  module DocSpring
17
- # Submissions created together in one request. Their PDFs are only generated when every submission in the batch is valid.
17
+ # Submissions created together in one request. Their files are only generated when every submission in the batch is valid.
18
18
  class SubmissionBatch < ApiModelBase
19
19
  # The batch's ID.
20
20
  attr_accessor :id
21
21
 
22
- # `pending` while the PDFs are being generated, then `processed`. `error` as soon as a submission fails, while the others can still be pending: the batch has finished once `processed_at` is set.
22
+ # `pending` while the files are being generated, then `processed`. `error` as soon as a submission fails, while the others can still be pending: the batch has finished once `processed_at` is set.
23
23
  attr_accessor :state
24
24
 
25
25
  # Your own data about the batch, such as an ID from your app.
@@ -28,10 +28,10 @@ module DocSpring
28
28
  # The number of submissions in the request.
29
29
  attr_accessor :total_count
30
30
 
31
- # The submissions whose PDFs haven't been generated yet.
31
+ # The submissions whose files haven't been generated yet.
32
32
  attr_accessor :pending_count
33
33
 
34
- # The submissions that were invalid or whose PDFs couldn't be generated.
34
+ # The submissions that were invalid or whose files couldn't be generated.
35
35
  attr_accessor :error_count
36
36
 
37
37
  # The percentage of the batch's submissions that have finished, from 0 to 100.
@@ -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,6 +25,12 @@ module DocSpring
25
25
  # The preview PDF from POST /submissions/{submission_id}/generate_preview, such as for a submission still waiting for its signature requests.
26
26
  attr_accessor :preview
27
27
 
28
+ # The Word document of a Word template's submission, when the submission makes one (`output_formats`).
29
+ attr_accessor :docx
30
+
31
+ # The OpenDocument file (.odt, the format LibreOffice uses) of a Word template's submission, converted from its Word document, when the submission makes one (`output_formats`).
32
+ attr_accessor :odt
33
+
28
34
  attr_accessor :png
29
35
 
30
36
  # Attribute mapping from ruby-style variable name to JSON key.
@@ -33,6 +39,8 @@ module DocSpring
33
39
  :'pdf' => :'pdf',
34
40
  :'audit_trail' => :'audit_trail',
35
41
  :'preview' => :'preview',
42
+ :'docx' => :'docx',
43
+ :'odt' => :'odt',
36
44
  :'png' => :'png'
37
45
  }
38
46
  end
@@ -53,6 +61,8 @@ module DocSpring
53
61
  :'pdf' => :'GeneratedFile',
54
62
  :'audit_trail' => :'GeneratedFile',
55
63
  :'preview' => :'GeneratedFile',
64
+ :'docx' => :'GeneratedFile',
65
+ :'odt' => :'GeneratedFile',
56
66
  :'png' => :'PageImages'
57
67
  }
58
68
  end
@@ -101,6 +111,14 @@ module DocSpring
101
111
  self.preview = attributes[:'preview']
102
112
  end
103
113
 
114
+ if attributes.key?(:'docx')
115
+ self.docx = attributes[:'docx']
116
+ end
117
+
118
+ if attributes.key?(:'odt')
119
+ self.odt = attributes[:'odt']
120
+ end
121
+
104
122
  if attributes.key?(:'png')
105
123
  self.png = attributes[:'png']
106
124
  end
@@ -129,6 +147,8 @@ module DocSpring
129
147
  pdf == o.pdf &&
130
148
  audit_trail == o.audit_trail &&
131
149
  preview == o.preview &&
150
+ docx == o.docx &&
151
+ odt == o.odt &&
132
152
  png == o.png
133
153
  end
134
154
 
@@ -141,7 +161,7 @@ module DocSpring
141
161
  # Calculates hash code according to all attributes.
142
162
  # @return [Integer] Hash code
143
163
  def hash
144
- [pdf, audit_trail, preview, png].hash
164
+ [pdf, audit_trail, preview, docx, odt, png].hash
145
165
  end
146
166
 
147
167
  # Builds the object from hash