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
 
@@ -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
- # PNG images of a template's pages filled in with data you send (not a PDF), to check how an HTML or PDF template prints with your data before you publish a version or send live data. A preview makes no submission and uses no credits. Its pages are watermarked like a test submission's PDF, and it's deleted an hour after it's created.
17
+ # PNG images of a template's pages filled in with data you send (not a PDF), to check how an HTML, PDF or Word template prints with your data before you publish a version or send live data. A preview makes no submission and uses no credits. Its pages are watermarked like a test submission's PDF, and it's deleted an hour after it's created.
18
18
  class TemplatePreview < ApiModelBase
19
19
  # The preview's ID.
20
20
  attr_accessor :id
@@ -28,7 +28,7 @@ module DocSpring
28
28
  # `pending` while it renders (usually a few seconds), then `processed`, or `error` with an `error_message`.
29
29
  attr_accessor :state
30
30
 
31
- # Why the preview couldn't be rendered, such as an error in an HTML template's Liquid, or a value in the data that a field can't print.
31
+ # Why the preview couldn't be rendered, such as an error in an HTML or Word template's Liquid, or a value in the data that a field can't print.
32
32
  attr_accessor :error_message
33
33
 
34
34
  # How many pages the template printed, once it's processed.
@@ -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
 
@@ -25,13 +25,16 @@ module DocSpring
25
25
  # Shown under the template's name at the top of its hosted forms, and used as their meta description. Not shown on embedded forms or signature requests.
26
26
  attr_accessor :description
27
27
 
28
- # `pdf`: fields placed on an uploaded PDF. `html`: a PDF rendered from HTML and SCSS. It can't be changed after the template is created.
28
+ # `pdf`: fields placed on an uploaded PDF. `html`: a PDF rendered from HTML and SCSS. `docx`: a Word document with tags where the data goes, which makes Word documents or PDFs. It can't be changed after the template is created.
29
29
  attr_accessor :template_type
30
30
 
31
- # Whether the template can generate PDFs. HTML templates are always ready. A PDF template is ready once DocSpring has stored its PDF, made an image of each page and finished looking for fields on each page, which can be after `document.state` becomes `processed`. A PDF template with no PDF (`document` is null) isn't ready.
31
+ # What each submission makes unless its request sets `output_formats`: `docx` (a Word document), `odt` (an OpenDocument file, converted from the Word document) or `pdf`. A Word template's is chosen when it's created; PDF and HTML templates always make PDFs. A Word template that encrypts its PDFs makes PDFs, because Word documents and OpenDocument files can't be password-protected.
32
+ attr_accessor :output_format
33
+
34
+ # Whether the template can make documents. HTML templates are always ready. A PDF template is ready once DocSpring has stored its PDF, made an image of each page and finished looking for fields on each page, which can be after `document.state` becomes `processed`. A PDF template with no PDF (`document` is null) isn't ready. A Word template is ready once it has a Word document (a `document_url`'s has been downloaded).
32
35
  attr_accessor :ready
33
36
 
34
- # The PDF of a PDF template: its file name, page count and processing state. Null for HTML templates, and for a PDF template that has no PDF yet.
37
+ # The PDF of a PDF template, or the Word document of a Word template: its file name, page count and processing state. Null for HTML templates, and for a PDF template that has no PDF yet. A template created from a `document_url`, or a Word template created from an OpenDocument file (.odt), has one, with no file, while it's downloaded or converted.
35
38
  attr_accessor :document
36
39
 
37
40
  # The ID of the folder the template is in. Null for a template at the root. Setting it moves the template and all of its published versions.
@@ -87,6 +90,7 @@ module DocSpring
87
90
  :'name' => :'name',
88
91
  :'description' => :'description',
89
92
  :'template_type' => :'template_type',
93
+ :'output_format' => :'output_format',
90
94
  :'ready' => :'ready',
91
95
  :'document' => :'document',
92
96
  :'parent_folder_id' => :'parent_folder_id',
@@ -117,6 +121,7 @@ module DocSpring
117
121
  :'name' => :'String',
118
122
  :'description' => :'String',
119
123
  :'template_type' => :'TemplateType',
124
+ :'output_format' => :'OutputFormat',
120
125
  :'ready' => :'Boolean',
121
126
  :'document' => :'TemplateDocumentSummary',
122
127
  :'parent_folder_id' => :'String',
@@ -193,6 +198,12 @@ module DocSpring
193
198
  self.template_type = nil
194
199
  end
195
200
 
201
+ if attributes.key?(:'output_format')
202
+ self.output_format = attributes[:'output_format']
203
+ else
204
+ self.output_format = nil
205
+ end
206
+
196
207
  if attributes.key?(:'ready')
197
208
  self.ready = attributes[:'ready']
198
209
  else
@@ -267,6 +278,10 @@ module DocSpring
267
278
  invalid_properties.push('invalid value for "template_type", template_type cannot be nil.')
268
279
  end
269
280
 
281
+ if @output_format.nil?
282
+ invalid_properties.push('invalid value for "output_format", output_format cannot be nil.')
283
+ end
284
+
270
285
  if @ready.nil?
271
286
  invalid_properties.push('invalid value for "ready", ready cannot be nil.')
272
287
  end
@@ -296,6 +311,7 @@ module DocSpring
296
311
  warn '[DEPRECATED] the `valid?` method is obsolete'
297
312
  return false if @id.nil?
298
313
  return false if @template_type.nil?
314
+ return false if @output_format.nil?
299
315
  return false if @ready.nil?
300
316
  return false if @path.nil?
301
317
  return false if @locked.nil?
@@ -324,6 +340,16 @@ module DocSpring
324
340
  @template_type = template_type
325
341
  end
326
342
 
343
+ # Custom attribute writer method with validation
344
+ # @param [Object] output_format Value to be assigned
345
+ def output_format=(output_format)
346
+ if output_format.nil?
347
+ fail ArgumentError, 'output_format cannot be nil'
348
+ end
349
+
350
+ @output_format = output_format
351
+ end
352
+
327
353
  # Custom attribute writer method with validation
328
354
  # @param [Object] ready Value to be assigned
329
355
  def ready=(ready)
@@ -383,6 +409,7 @@ module DocSpring
383
409
  name == o.name &&
384
410
  description == o.description &&
385
411
  template_type == o.template_type &&
412
+ output_format == o.output_format &&
386
413
  ready == o.ready &&
387
414
  document == o.document &&
388
415
  parent_folder_id == o.parent_folder_id &&
@@ -404,7 +431,7 @@ module DocSpring
404
431
  # Calculates hash code according to all attributes.
405
432
  # @return [Integer] Hash code
406
433
  def hash
407
- [id, name, description, template_type, ready, document, parent_folder_id, path, latest_version, version_published_at, locked, last_changed_at, created_at, updated_at].hash
434
+ [id, name, description, template_type, output_format, ready, document, parent_folder_id, path, latest_version, version_published_at, locked, last_changed_at, created_at, updated_at].hash
408
435
  end
409
436
 
410
437
  # 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
 
@@ -17,9 +17,10 @@ module DocSpring
17
17
  class TemplateType
18
18
  PDF = "pdf".freeze
19
19
  HTML = "html".freeze
20
+ DOCX = "docx".freeze
20
21
 
21
22
  def self.all_vars
22
- @all_vars ||= [PDF, HTML].freeze
23
+ @all_vars ||= [PDF, HTML, DOCX].freeze
23
24
  end
24
25
 
25
26
  # 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
 
@@ -14,21 +14,21 @@ require 'date'
14
14
  require 'time'
15
15
 
16
16
  module DocSpring
17
- # The new PDF, as one of `cache_id`, `document_url` and `document_base64`.
17
+ # The new PDF, or a Word template's new Word document, as one of `cache_id`, `document_url` and `document_base64`.
18
18
  class UpdateTemplateDocumentRequest < ApiModelBase
19
- # The `fields.key` of the new PDF, uploaded with the presigned upload (GET /uploads/presign).
19
+ # The `fields.key` of the new PDF or Word document (.docx or .odt), uploaded with the presigned upload (GET /uploads/presign).
20
20
  attr_accessor :cache_id
21
21
 
22
- # An https:// link to the template's PDF (up to 100 MB), instead of `cache_id`. DocSpring downloads it after responding, following redirects to other https:// links: the template's `document.state` is `downloading` until then (sync.api hosts wait for it). If it can't be downloaded, the state is `download_failed` and `document.error_message` says why.
22
+ # An https:// link to the template's document, instead of `cache_id`: a PDF template's PDF (up to 100 MB) or a Word template's Word document (.docx or .odt, up to 50 MB). DocSpring downloads it after responding, following redirects to other https:// links: the template's `document.state` is `downloading` until then, and `converting` while an .odt is converted (sync.api hosts wait for both). If it can't be downloaded, the state is `download_failed` and `document.error_message` says why.
23
23
  attr_accessor :document_url
24
24
 
25
- # The template's PDF, encoded as base64 (a `data:` URI works too), instead of `cache_id`. Up to 7 MB before it's encoded: send a larger file with `cache_id` or `document_url`.
25
+ # The template's document (a PDF, or a Word template's Word document), encoded as base64 (a `data:` URI works too), instead of `cache_id`. Up to 7 MB before it's encoded: send a larger file with `cache_id` or `document_url`.
26
26
  attr_accessor :document_base64
27
27
 
28
- # The PDF's file name, for a `cache_id` (presigned uploads don't send one) or `document_base64`. A `document_url`'s is the last part of its path unless you set it.
28
+ # The file's name, for a `cache_id` (presigned uploads don't send one) or `document_base64`. A `document_url`'s is the last part of its path unless you set it.
29
29
  attr_accessor :filename
30
30
 
31
- # Replace all of the template's fields with the fillable fields in the new PDF, once DocSpring has processed it (`document.field_reimport_state`). As on a first upload, the default typeface, font size, bold and color are taken from the PDF's fields; the template's other settings are kept. If the PDF has no fillable fields, the template keeps its fields. A locked template can't re-import its fields.
31
+ # Replace all of the template's fields with the fillable fields in the new PDF, once DocSpring has processed it (`document.field_reimport_state`). As on a first upload, the default typeface, font size, bold and color are taken from the PDF's fields; the template's other settings are kept. If the PDF has no fillable fields, the template keeps its fields. A locked template can't re-import its fields. Only for PDF templates: a Word template adds a field for each new tag.
32
32
  attr_accessor :reimport_fields
33
33
 
34
34
  # 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
 
@@ -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
 
@@ -22,6 +22,9 @@ module DocSpring
22
22
  # Shown under the template's name at the top of its hosted forms, and used as their meta description. Not shown on embedded forms or signature requests.
23
23
  attr_accessor :description
24
24
 
25
+ # What each submission makes unless its request sets `output_formats`: `docx` (a Word document), `odt` (an OpenDocument file, converted from the Word document) or `pdf`. A Word template's is chosen when it's created; PDF and HTML templates always make PDFs. A Word template that encrypts its PDFs makes PDFs, because Word documents and OpenDocument files can't be password-protected.
26
+ attr_accessor :output_format
27
+
25
28
  # The ID of the folder the template is in. Null for a template at the root. Setting it moves the template and all of its published versions.
26
29
  attr_accessor :parent_folder_id
27
30
 
@@ -40,7 +43,7 @@ module DocSpring
40
43
  # Visual forms and signature request forms show the Continue button as soon as the required fields are filled in, without visiting each optional field. The `allowSkippingOptionalFields` embed option overrides it.
41
44
  attr_accessor :allow_skipping_optional_fields
42
45
 
43
- # The hosted form that /templates/{template_id}/form shows when its URL has no `mode` parameter: `web` (the web form), `visual` (the visual form, where fields are filled in on the PDF) or `dual` (both, in tabs). HTML templates have no visual form, so `web` is the only value they accept.
46
+ # The hosted form that /templates/{template_id}/form shows when its URL has no `mode` parameter: `web` (the web form), `visual` (the visual form, where fields are filled in on the PDF) or `dual` (both, in tabs). Only PDF templates have a visual form, so other templates accept only `web`.
44
47
  attr_accessor :default_form_mode
45
48
 
46
49
  # Generate PDFs whose text and check fields stay fillable ("Generate Editable PDFs"). A submission's `editable` overrides it.
@@ -58,7 +61,7 @@ module DocSpring
58
61
  # Allow the embedded template editor to replace the template's PDF.
59
62
  attr_accessor :embed_edit_allow_document_replacement
60
63
 
61
- # Encrypt generated PDFs with `encrypt_pdfs_password`.
64
+ # Encrypt generated PDFs with `encrypt_pdfs_password`. A Word template can only encrypt its PDFs when its `output_format` is `pdf`, because Word documents and OpenDocument files can't be password-protected.
62
65
  attr_accessor :encrypt_pdfs
63
66
 
64
67
  # The password that opens encrypted PDFs. It's never returned; `has_encrypt_pdfs_password` says if it's set.
@@ -76,7 +79,7 @@ module DocSpring
76
79
  # Add the audit trail to the end of PDFs signed through signature requests.
77
80
  attr_accessor :merge_audit_trail_pdf
78
81
 
79
- # Date fields also accept NN/NN/YYYY dates (with slashes, dashes or dots), read in the order of the template's default date format: month first for %m/%d/%Y, day first for %d/%m/%Y. When false, date fields only accept YYYY-MM-DD. Applies to PDF templates: an HTML template's date fields only accept YYYY-MM-DD. Date fields that include a time take RFC 3339 date-times either way.
82
+ # Date fields also accept NN/NN/YYYY dates (with slashes, dashes or dots), read in the order of the template's default date format: month first for %m/%d/%Y, day first for %d/%m/%Y. When false, date fields only accept YYYY-MM-DD. Applies to PDF templates: an HTML or Word template's date fields only accept YYYY-MM-DD. Date fields that include a time take RFC 3339 date-times either way.
80
83
  attr_accessor :parse_dates_using_template_date_format
81
84
 
82
85
  # Allow anyone with a submission's ID to download its PDF.
@@ -106,7 +109,7 @@ module DocSpring
106
109
  # Sample submission data that sets `predefined_fields`: each value becomes a predefined field, with a type that fits it (`string`, `number`, `boolean`, `date`, `email` or `url`) and `required_in_template` true. Nested objects and arrays become names with `/`, such as `customer/email`. Without `predefined_fields` in the same request, it replaces them; with them, it adds to them and sets the types of the ones it has values for.
107
110
  attr_accessor :predefined_fields_sample_data
108
111
 
109
- # The HTML of an HTML template, as a Liquid template. Null for PDF templates.
112
+ # The HTML of an HTML template, as a Liquid template. Null for PDF and Word templates.
110
113
  attr_accessor :html
111
114
 
112
115
  # The SCSS of an HTML template.
@@ -151,6 +154,7 @@ module DocSpring
151
154
  {
152
155
  :'name' => :'name',
153
156
  :'description' => :'description',
157
+ :'output_format' => :'output_format',
154
158
  :'parent_folder_id' => :'parent_folder_id',
155
159
  :'locked' => :'locked',
156
160
  :'add_signature_request_submission_id_footers' => :'add_signature_request_submission_id_footers',
@@ -203,6 +207,7 @@ module DocSpring
203
207
  {
204
208
  :'name' => :'String',
205
209
  :'description' => :'String',
210
+ :'output_format' => :'OutputFormat',
206
211
  :'parent_folder_id' => :'String',
207
212
  :'locked' => :'Boolean',
208
213
  :'add_signature_request_submission_id_footers' => :'Boolean',
@@ -291,6 +296,10 @@ module DocSpring
291
296
  self.description = attributes[:'description']
292
297
  end
293
298
 
299
+ if attributes.key?(:'output_format')
300
+ self.output_format = attributes[:'output_format']
301
+ end
302
+
294
303
  if attributes.key?(:'parent_folder_id')
295
304
  self.parent_folder_id = attributes[:'parent_folder_id']
296
305
  end
@@ -460,6 +469,7 @@ module DocSpring
460
469
  self.class == o.class &&
461
470
  name == o.name &&
462
471
  description == o.description &&
472
+ output_format == o.output_format &&
463
473
  parent_folder_id == o.parent_folder_id &&
464
474
  locked == o.locked &&
465
475
  add_signature_request_submission_id_footers == o.add_signature_request_submission_id_footers &&
@@ -505,7 +515,7 @@ module DocSpring
505
515
  # Calculates hash code according to all attributes.
506
516
  # @return [Integer] Hash code
507
517
  def hash
508
- [name, description, parent_folder_id, locked, add_signature_request_submission_id_footers, ai_field_naming_language, allow_additional_properties, allow_skipping_optional_fields, default_form_mode, editable_submissions, embed_domains, embed_edit_allow_settings, embed_edit_allow_versioning, embed_edit_allow_document_replacement, encrypt_pdfs, encrypt_pdfs_password, expire_submissions, expire_after, expiration_interval, merge_audit_trail_pdf, parse_dates_using_template_date_format, public_submissions, public_web_form, redirect_url, slack_webhook_url, defaults, field_dependencies, field_groups, predefined_fields, predefined_fields_sample_data, html, scss, header_html, footer_html, html_engine_options, html_escape_data].hash
518
+ [name, description, output_format, parent_folder_id, locked, add_signature_request_submission_id_footers, ai_field_naming_language, allow_additional_properties, allow_skipping_optional_fields, default_form_mode, editable_submissions, embed_domains, embed_edit_allow_settings, embed_edit_allow_versioning, embed_edit_allow_document_replacement, encrypt_pdfs, encrypt_pdfs_password, expire_submissions, expire_after, expiration_interval, merge_audit_trail_pdf, parse_dates_using_template_date_format, public_submissions, public_web_form, redirect_url, slack_webhook_url, defaults, field_dependencies, field_groups, predefined_fields, predefined_fields_sample_data, html, scss, header_html, footer_html, html_engine_options, html_escape_data].hash
509
519
  end
510
520
 
511
521
  # 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
 
@@ -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
 
@@ -22,16 +22,16 @@ module DocSpring
22
22
  # `true` keeps the PDF's text and check fields fillable, and `false` flattens every field. Left out, the template decides: its `editable_submissions` setting, or each field's own Editable option. A response shows the template's setting when the request left this out. Can't be `true` with `signature_requests`.
23
23
  attr_accessor :editable
24
24
 
25
- # The values of the template's fields, by field name. Required for a PDF template, unless `signature_requests` collects the values.
25
+ # The values of the template's fields, by field name. Required for PDF and Word templates, unless `signature_requests` collects them (PDF templates only).
26
26
  attr_accessor :data
27
27
 
28
28
  # 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`).
29
29
  attr_accessor :metadata
30
30
 
31
- # A password that the PDF needs to be opened with. It's never returned; `has_password` says if it's set.
31
+ # A password that the PDF needs to be opened with. It's never returned; `has_password` says if it's set. Word documents and OpenDocument files can't be password-protected, so a submission with a password can't make them.
32
32
  attr_accessor :password
33
33
 
34
- # 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.
34
+ # 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.
35
35
  attr_accessor :output_formats
36
36
 
37
37
  # Seconds after the PDF is generated until the submission expires, up to 10 years (315360000). Default the template's expiration setting. A submission that isn't processed, such as one with invalid data, is kept for at least 48 hours.
@@ -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