docspring 4.2.0 → 4.4.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (461) hide show
  1. checksums.yaml +4 -4
  2. data/.github/workflows/release.yml +80 -0
  3. data/.openapi-generator/FILES +84 -0
  4. data/AGENTS.md +2 -2
  5. data/CHANGELOG.md +82 -0
  6. data/Gemfile.lock +4 -3
  7. data/README.md +26 -6
  8. data/docs/AddTemplateFieldsRequest.md +1 -1
  9. data/docs/Client.md +2400 -853
  10. data/docs/CombinedPdfSource.md +1 -1
  11. data/docs/CreateAccountEmailActionRequest.md +54 -0
  12. data/docs/CreateEmailActionRequest.md +50 -0
  13. data/docs/CreateEmailDomainRequest.md +18 -0
  14. data/docs/CreateSubmissionBatchRequest.md +2 -2
  15. data/docs/CreateSubmissionRequest.md +24 -6
  16. data/docs/CreateTemplateRequest.md +29 -11
  17. data/docs/DnsRecordType.md +15 -0
  18. data/docs/EmailAction.md +76 -0
  19. data/docs/EmailActionConditions.md +20 -0
  20. data/docs/EmailActionConditionsInput.md +20 -0
  21. data/docs/EmailActionCustomization.md +36 -0
  22. data/docs/EmailActionDelivery.md +15 -0
  23. data/docs/EmailActionFileFormats.md +15 -0
  24. data/docs/EmailActionList.md +20 -0
  25. data/docs/EmailActionSetting.md +15 -0
  26. data/docs/EmailActionSubmissionType.md +15 -0
  27. data/docs/EmailActionTestEmail.md +18 -0
  28. data/docs/EmailDomain.md +38 -0
  29. data/docs/EmailDomainDnsRecord.md +24 -0
  30. data/docs/EmailDomainDnsRecordPurpose.md +15 -0
  31. data/docs/EmailDomainList.md +20 -0
  32. data/docs/EmailDomainRecordState.md +15 -0
  33. data/docs/EmailDomainState.md +15 -0
  34. data/docs/ErrorInfo.md +12 -6
  35. data/docs/Field.md +1 -1
  36. data/docs/FieldGroup.md +2 -2
  37. data/docs/FieldGroupInput.md +1 -1
  38. data/docs/FieldInput.md +1 -1
  39. data/docs/GenerateSubmissionFilesRequest.md +1 -1
  40. data/docs/GeneratedFile.md +2 -2
  41. data/docs/HtmlEngineOptions.md +1 -1
  42. data/docs/HtmlEngineOptionsInput.md +1 -1
  43. data/docs/SendAccountEmailActionTestEmailRequest.md +18 -0
  44. data/docs/SignatureRequest.md +9 -1
  45. data/docs/SignatureRequestEmailAttachments.md +15 -0
  46. data/docs/SignatureRequestEmailStatus.md +15 -0
  47. data/docs/SignatureRequestInput.md +7 -3
  48. data/docs/SignatureRequestReminders.md +20 -0
  49. data/docs/SigningOrder.md +15 -0
  50. data/docs/Submission.md +8 -6
  51. data/docs/SubmissionAction.md +5 -3
  52. data/docs/SubmissionBatch.md +3 -3
  53. data/docs/SubmissionFiles.md +4 -0
  54. data/docs/SubmissionInput.md +5 -5
  55. data/docs/SubmissionSummary.md +3 -3
  56. data/docs/Template.md +28 -10
  57. data/docs/TemplateDiff.md +2 -2
  58. data/docs/TemplateDocument.md +10 -10
  59. data/docs/TemplateDocumentSummary.md +4 -4
  60. data/docs/TemplatePreview.md +1 -1
  61. data/docs/TemplateSourcePdf.md +1 -1
  62. data/docs/TemplateSummary.md +5 -3
  63. data/docs/UpdateAccountEmailActionRequest.md +54 -0
  64. data/docs/UpdateEmailActionCustomizationRequest.md +46 -0
  65. data/docs/UpdateEmailActionRequest.md +50 -0
  66. data/docs/UpdateTemplateDocumentRequest.md +5 -5
  67. data/docs/UpdateTemplateRequest.md +25 -7
  68. data/docs/ValidateSubmissionRequest.md +24 -6
  69. data/docspring.gemspec +2 -2
  70. data/lib/docspring/api/client.rb +1791 -353
  71. data/lib/docspring/api_client.rb +2 -2
  72. data/lib/docspring/api_error.rb +1 -1
  73. data/lib/docspring/api_model_base.rb +1 -1
  74. data/lib/docspring/configuration.rb +1 -1
  75. data/lib/docspring/models/add_template_fields_request.rb +2 -2
  76. data/lib/docspring/models/ai_field_naming_language.rb +1 -1
  77. data/lib/docspring/models/authentication_check.rb +1 -1
  78. data/lib/docspring/models/barcode_symbology.rb +1 -1
  79. data/lib/docspring/models/check_character.rb +1 -1
  80. data/lib/docspring/models/combined_field_type.rb +1 -1
  81. data/lib/docspring/models/combined_pdf.rb +1 -1
  82. data/lib/docspring/models/combined_pdf_files.rb +1 -1
  83. data/lib/docspring/models/combined_pdf_list.rb +1 -1
  84. data/lib/docspring/models/combined_pdf_source.rb +2 -2
  85. data/lib/docspring/models/combined_pdf_source_input.rb +1 -1
  86. data/lib/docspring/models/combined_pdf_source_pdf.rb +1 -1
  87. data/lib/docspring/models/combined_pdf_source_type.rb +1 -1
  88. data/lib/docspring/models/combined_pdf_state.rb +1 -1
  89. data/lib/docspring/models/copy_template_request.rb +1 -1
  90. data/lib/docspring/models/create_account_email_action_request.rb +388 -0
  91. data/lib/docspring/models/create_combined_pdf_request.rb +1 -1
  92. data/lib/docspring/models/create_custom_file_from_upload_request.rb +1 -1
  93. data/lib/docspring/models/create_email_action_request.rb +364 -0
  94. data/lib/docspring/models/create_email_domain_request.rb +185 -0
  95. data/lib/docspring/models/create_folder_request.rb +1 -1
  96. data/lib/docspring/models/create_signature_request_event_request.rb +1 -1
  97. data/lib/docspring/models/create_signature_request_token_request.rb +1 -1
  98. data/lib/docspring/models/create_submission_batch_request.rb +3 -3
  99. data/lib/docspring/models/create_submission_request.rb +146 -10
  100. data/lib/docspring/models/create_template_preview_request.rb +1 -1
  101. data/lib/docspring/models/create_template_request.rb +123 -13
  102. data/lib/docspring/models/create_webhook_request.rb +1 -1
  103. data/lib/docspring/models/custom_file.rb +1 -1
  104. data/lib/docspring/models/custom_file_list.rb +1 -1
  105. data/lib/docspring/models/custom_file_source_pdf.rb +1 -1
  106. data/lib/docspring/models/dns_record_type.rb +42 -0
  107. data/lib/docspring/models/email_action.rb +790 -0
  108. data/lib/docspring/models/email_action_conditions.rb +219 -0
  109. data/lib/docspring/models/email_action_conditions_input.rb +219 -0
  110. data/lib/docspring/models/email_action_customization.rb +360 -0
  111. data/lib/docspring/models/email_action_delivery.rb +41 -0
  112. data/lib/docspring/models/email_action_file_formats.rb +43 -0
  113. data/lib/docspring/models/email_action_list.rb +200 -0
  114. data/lib/docspring/models/email_action_setting.rb +53 -0
  115. data/lib/docspring/models/email_action_submission_type.rb +42 -0
  116. data/lib/docspring/models/email_action_test_email.rb +185 -0
  117. data/lib/docspring/models/email_domain.rb +423 -0
  118. data/lib/docspring/models/email_domain_dns_record.rb +288 -0
  119. data/lib/docspring/models/email_domain_dns_record_purpose.rb +42 -0
  120. data/lib/docspring/models/email_domain_list.rb +200 -0
  121. data/lib/docspring/models/email_domain_record_state.rb +42 -0
  122. data/lib/docspring/models/email_domain_state.rb +42 -0
  123. data/lib/docspring/models/error_code.rb +4 -2
  124. data/lib/docspring/models/error_detail.rb +1 -1
  125. data/lib/docspring/models/error_info.rb +40 -10
  126. data/lib/docspring/models/error_response.rb +1 -1
  127. data/lib/docspring/models/expiration_interval.rb +1 -1
  128. data/lib/docspring/models/field.rb +3 -3
  129. data/lib/docspring/models/field_comparison_condition.rb +1 -1
  130. data/lib/docspring/models/field_comparison_operator.rb +1 -1
  131. data/lib/docspring/models/field_dependency.rb +1 -1
  132. data/lib/docspring/models/field_dependency_input.rb +1 -1
  133. data/lib/docspring/models/field_display_type.rb +1 -1
  134. data/lib/docspring/models/field_equals_condition.rb +1 -1
  135. data/lib/docspring/models/field_equals_operator.rb +1 -1
  136. data/lib/docspring/models/field_group.rb +3 -3
  137. data/lib/docspring/models/field_group_input.rb +2 -2
  138. data/lib/docspring/models/field_group_type.rb +1 -1
  139. data/lib/docspring/models/field_in_condition.rb +1 -1
  140. data/lib/docspring/models/field_input.rb +3 -3
  141. data/lib/docspring/models/field_override.rb +1 -1
  142. data/lib/docspring/models/field_presence_condition.rb +1 -1
  143. data/lib/docspring/models/field_presence_operator.rb +1 -1
  144. data/lib/docspring/models/field_range_condition.rb +1 -1
  145. data/lib/docspring/models/field_reimport_state.rb +1 -1
  146. data/lib/docspring/models/field_setup_logic.rb +1 -1
  147. data/lib/docspring/models/field_setup_naming.rb +1 -1
  148. data/lib/docspring/models/field_setup_source.rb +1 -1
  149. data/lib/docspring/models/field_type.rb +1 -1
  150. data/lib/docspring/models/folder.rb +1 -1
  151. data/lib/docspring/models/folder_list.rb +1 -1
  152. data/lib/docspring/models/generate_files_format.rb +5 -2
  153. data/lib/docspring/models/generate_submission_files_request.rb +2 -2
  154. data/lib/docspring/models/generated_file.rb +4 -4
  155. data/lib/docspring/models/generated_file_state.rb +1 -1
  156. data/lib/docspring/models/html_engine_options.rb +2 -2
  157. data/lib/docspring/models/html_engine_options_input.rb +2 -2
  158. data/lib/docspring/models/image_gravity.rb +1 -1
  159. data/lib/docspring/models/image_scale_type.rb +1 -1
  160. data/lib/docspring/models/model_code_language.rb +3 -2
  161. data/lib/docspring/models/move_folder_request.rb +1 -1
  162. data/lib/docspring/models/move_template_request.rb +1 -1
  163. data/lib/docspring/models/number_condition_type.rb +1 -1
  164. data/lib/docspring/models/output_format.rb +4 -2
  165. data/lib/docspring/models/page_format.rb +1 -1
  166. data/lib/docspring/models/page_image.rb +1 -1
  167. data/lib/docspring/models/page_images.rb +1 -1
  168. data/lib/docspring/models/predefined_field.rb +1 -1
  169. data/lib/docspring/models/predefined_field_input.rb +1 -1
  170. data/lib/docspring/models/publish_template_version_request.rb +1 -1
  171. data/lib/docspring/models/remove_template_fields_request.rb +1 -1
  172. data/lib/docspring/models/rename_folder_request.rb +1 -1
  173. data/lib/docspring/models/reorder_template_fields_request.rb +1 -1
  174. data/lib/docspring/models/restore_template_version_request.rb +1 -1
  175. data/lib/docspring/models/send_account_email_action_test_email_request.rb +168 -0
  176. data/lib/docspring/models/shape_type.rb +1 -1
  177. data/lib/docspring/models/signature_request.rb +69 -3
  178. data/lib/docspring/models/signature_request_auth_second_factor_type.rb +1 -1
  179. data/lib/docspring/models/signature_request_auth_type.rb +1 -1
  180. data/lib/docspring/models/signature_request_email_attachments.rb +41 -0
  181. data/lib/docspring/models/signature_request_email_status.rb +47 -0
  182. data/lib/docspring/models/signature_request_event.rb +1 -1
  183. data/lib/docspring/models/signature_request_event_type.rb +4 -2
  184. data/lib/docspring/models/signature_request_input.rb +26 -23
  185. data/lib/docspring/models/signature_request_message_type.rb +1 -1
  186. data/lib/docspring/models/signature_request_reminders.rb +212 -0
  187. data/lib/docspring/models/signature_request_state.rb +1 -1
  188. data/lib/docspring/models/signature_request_token.rb +1 -1
  189. data/lib/docspring/models/signature_request_token_type.rb +1 -1
  190. data/lib/docspring/models/signing_order.rb +41 -0
  191. data/lib/docspring/models/string_condition_type.rb +9 -2
  192. data/lib/docspring/models/submission.rb +36 -9
  193. data/lib/docspring/models/submission_action.rb +19 -6
  194. data/lib/docspring/models/submission_action_state.rb +1 -1
  195. data/lib/docspring/models/submission_action_type.rb +1 -1
  196. data/lib/docspring/models/submission_batch.rb +5 -5
  197. data/lib/docspring/models/submission_batch_state.rb +1 -1
  198. data/lib/docspring/models/submission_files.rb +22 -2
  199. data/lib/docspring/models/submission_input.rb +6 -6
  200. data/lib/docspring/models/submission_list.rb +1 -1
  201. data/lib/docspring/models/submission_source.rb +1 -1
  202. data/lib/docspring/models/submission_source_pdf.rb +1 -1
  203. data/lib/docspring/models/submission_state.rb +1 -1
  204. data/lib/docspring/models/submission_summary.rb +4 -4
  205. data/lib/docspring/models/submission_validation.rb +1 -1
  206. data/lib/docspring/models/template.rb +175 -12
  207. data/lib/docspring/models/template_actor.rb +1 -1
  208. data/lib/docspring/models/template_actor_type.rb +1 -1
  209. data/lib/docspring/models/template_defaults.rb +1 -1
  210. data/lib/docspring/models/template_defaults_input.rb +1 -1
  211. data/lib/docspring/models/template_diff.rb +3 -3
  212. data/lib/docspring/models/template_diff_summary.rb +1 -1
  213. data/lib/docspring/models/template_document.rb +12 -12
  214. data/lib/docspring/models/template_document_state.rb +4 -2
  215. data/lib/docspring/models/template_document_summary.rb +6 -6
  216. data/lib/docspring/models/template_field_change.rb +1 -1
  217. data/lib/docspring/models/template_field_changes.rb +1 -1
  218. data/lib/docspring/models/template_field_dependency.rb +1 -1
  219. data/lib/docspring/models/template_field_dependency_action.rb +1 -1
  220. data/lib/docspring/models/template_field_dependency_condition.rb +1 -1
  221. data/lib/docspring/models/template_field_dependency_condition_input.rb +1 -1
  222. data/lib/docspring/models/template_field_dependency_input.rb +1 -1
  223. data/lib/docspring/models/template_field_dependency_match.rb +1 -1
  224. data/lib/docspring/models/template_field_dependency_operator.rb +1 -1
  225. data/lib/docspring/models/template_field_logic_status.rb +1 -1
  226. data/lib/docspring/models/template_field_move.rb +1 -1
  227. data/lib/docspring/models/template_fields.rb +1 -1
  228. data/lib/docspring/models/template_form_mode.rb +1 -1
  229. data/lib/docspring/models/template_model_code.rb +1 -1
  230. data/lib/docspring/models/template_page_ai_error.rb +1 -1
  231. data/lib/docspring/models/template_page_ai_naming_status.rb +1 -1
  232. data/lib/docspring/models/template_page_fields_status.rb +1 -1
  233. data/lib/docspring/models/template_page_image_status.rb +1 -1
  234. data/lib/docspring/models/template_page_images.rb +1 -1
  235. data/lib/docspring/models/template_page_processing_status.rb +1 -1
  236. data/lib/docspring/models/template_preview.rb +3 -3
  237. data/lib/docspring/models/template_preview_state.rb +1 -1
  238. data/lib/docspring/models/template_source_pdf.rb +2 -2
  239. data/lib/docspring/models/template_summary.rb +32 -5
  240. data/lib/docspring/models/template_summary_list.rb +1 -1
  241. data/lib/docspring/models/template_type.rb +4 -2
  242. data/lib/docspring/models/template_version.rb +1 -1
  243. data/lib/docspring/models/template_version_type.rb +1 -1
  244. data/lib/docspring/models/text_alignment.rb +1 -1
  245. data/lib/docspring/models/text_overflow.rb +1 -1
  246. data/lib/docspring/models/text_vertical_alignment.rb +1 -1
  247. data/lib/docspring/models/typeface.rb +1 -1
  248. data/lib/docspring/models/update_account_email_action_request.rb +388 -0
  249. data/lib/docspring/models/update_email_action_customization_request.rb +343 -0
  250. data/lib/docspring/models/update_email_action_request.rb +364 -0
  251. data/lib/docspring/models/update_signature_request_request.rb +1 -1
  252. data/lib/docspring/models/update_template_document_request.rb +7 -7
  253. data/lib/docspring/models/update_template_fields_request.rb +1 -1
  254. data/lib/docspring/models/update_template_request.rb +121 -11
  255. data/lib/docspring/models/update_webhook_request.rb +1 -1
  256. data/lib/docspring/models/upload_method.rb +1 -1
  257. data/lib/docspring/models/upload_presign.rb +1 -1
  258. data/lib/docspring/models/url_source_pdf.rb +1 -1
  259. data/lib/docspring/models/validate_submission_request.rb +146 -10
  260. data/lib/docspring/models/webhook.rb +1 -1
  261. data/lib/docspring/models/webhook_event_type.rb +4 -2
  262. data/lib/docspring/models/webhook_list.rb +1 -1
  263. data/lib/docspring/models/webhook_mode.rb +1 -1
  264. data/lib/docspring/request_schemas.json +1692 -109
  265. data/lib/docspring/request_validator.rb +4 -0
  266. data/lib/docspring/version.rb +2 -2
  267. data/lib/docspring.rb +29 -1
  268. data/spec/api/client_spec.rb +328 -39
  269. data/spec/models/add_template_fields_request_spec.rb +1 -1
  270. data/spec/models/ai_field_naming_language_spec.rb +1 -1
  271. data/spec/models/authentication_check_spec.rb +1 -1
  272. data/spec/models/barcode_symbology_spec.rb +1 -1
  273. data/spec/models/check_character_spec.rb +1 -1
  274. data/spec/models/combined_field_type_spec.rb +1 -1
  275. data/spec/models/combined_pdf_files_spec.rb +1 -1
  276. data/spec/models/combined_pdf_list_spec.rb +1 -1
  277. data/spec/models/combined_pdf_source_input_spec.rb +1 -1
  278. data/spec/models/combined_pdf_source_pdf_spec.rb +1 -1
  279. data/spec/models/combined_pdf_source_spec.rb +1 -1
  280. data/spec/models/combined_pdf_source_type_spec.rb +1 -1
  281. data/spec/models/combined_pdf_spec.rb +1 -1
  282. data/spec/models/combined_pdf_state_spec.rb +1 -1
  283. data/spec/models/copy_template_request_spec.rb +1 -1
  284. data/spec/models/create_account_email_action_request_spec.rb +144 -0
  285. data/spec/models/create_combined_pdf_request_spec.rb +1 -1
  286. data/spec/models/create_custom_file_from_upload_request_spec.rb +1 -1
  287. data/spec/models/create_email_action_request_spec.rb +132 -0
  288. data/spec/models/create_email_domain_request_spec.rb +36 -0
  289. data/spec/models/create_folder_request_spec.rb +1 -1
  290. data/spec/models/create_signature_request_event_request_spec.rb +1 -1
  291. data/spec/models/create_signature_request_token_request_spec.rb +1 -1
  292. data/spec/models/create_submission_batch_request_spec.rb +1 -1
  293. data/spec/models/create_submission_request_spec.rb +55 -1
  294. data/spec/models/create_template_preview_request_spec.rb +1 -1
  295. data/spec/models/create_template_request_spec.rb +55 -1
  296. data/spec/models/create_webhook_request_spec.rb +1 -1
  297. data/spec/models/custom_file_list_spec.rb +1 -1
  298. data/spec/models/custom_file_source_pdf_spec.rb +1 -1
  299. data/spec/models/custom_file_spec.rb +1 -1
  300. data/spec/models/dns_record_type_spec.rb +30 -0
  301. data/spec/models/email_action_conditions_input_spec.rb +42 -0
  302. data/spec/models/email_action_conditions_spec.rb +42 -0
  303. data/spec/models/email_action_customization_spec.rb +90 -0
  304. data/spec/models/email_action_delivery_spec.rb +30 -0
  305. data/spec/models/email_action_file_formats_spec.rb +30 -0
  306. data/spec/models/email_action_list_spec.rb +42 -0
  307. data/spec/models/email_action_setting_spec.rb +30 -0
  308. data/spec/models/email_action_spec.rb +210 -0
  309. data/spec/models/email_action_submission_type_spec.rb +30 -0
  310. data/spec/models/email_action_test_email_spec.rb +36 -0
  311. data/spec/models/email_domain_dns_record_purpose_spec.rb +30 -0
  312. data/spec/models/email_domain_dns_record_spec.rb +54 -0
  313. data/spec/models/email_domain_list_spec.rb +42 -0
  314. data/spec/models/email_domain_record_state_spec.rb +30 -0
  315. data/spec/models/email_domain_spec.rb +96 -0
  316. data/spec/models/email_domain_state_spec.rb +30 -0
  317. data/spec/models/error_code_spec.rb +1 -1
  318. data/spec/models/error_detail_spec.rb +1 -1
  319. data/spec/models/error_info_spec.rb +19 -1
  320. data/spec/models/error_response_spec.rb +1 -1
  321. data/spec/models/expiration_interval_spec.rb +1 -1
  322. data/spec/models/field_comparison_condition_spec.rb +1 -1
  323. data/spec/models/field_comparison_operator_spec.rb +1 -1
  324. data/spec/models/field_dependency_input_spec.rb +1 -1
  325. data/spec/models/field_dependency_spec.rb +1 -1
  326. data/spec/models/field_display_type_spec.rb +1 -1
  327. data/spec/models/field_equals_condition_spec.rb +1 -1
  328. data/spec/models/field_equals_operator_spec.rb +1 -1
  329. data/spec/models/field_group_input_spec.rb +1 -1
  330. data/spec/models/field_group_spec.rb +1 -1
  331. data/spec/models/field_group_type_spec.rb +1 -1
  332. data/spec/models/field_in_condition_spec.rb +1 -1
  333. data/spec/models/field_input_spec.rb +1 -1
  334. data/spec/models/field_override_spec.rb +1 -1
  335. data/spec/models/field_presence_condition_spec.rb +1 -1
  336. data/spec/models/field_presence_operator_spec.rb +1 -1
  337. data/spec/models/field_range_condition_spec.rb +1 -1
  338. data/spec/models/field_reimport_state_spec.rb +1 -1
  339. data/spec/models/field_setup_logic_spec.rb +1 -1
  340. data/spec/models/field_setup_naming_spec.rb +1 -1
  341. data/spec/models/field_setup_source_spec.rb +1 -1
  342. data/spec/models/field_spec.rb +1 -1
  343. data/spec/models/field_type_spec.rb +1 -1
  344. data/spec/models/folder_list_spec.rb +1 -1
  345. data/spec/models/folder_spec.rb +1 -1
  346. data/spec/models/generate_files_format_spec.rb +1 -1
  347. data/spec/models/generate_submission_files_request_spec.rb +1 -1
  348. data/spec/models/generated_file_spec.rb +1 -1
  349. data/spec/models/generated_file_state_spec.rb +1 -1
  350. data/spec/models/html_engine_options_input_spec.rb +1 -1
  351. data/spec/models/html_engine_options_spec.rb +1 -1
  352. data/spec/models/image_gravity_spec.rb +1 -1
  353. data/spec/models/image_scale_type_spec.rb +1 -1
  354. data/spec/models/model_code_language_spec.rb +1 -1
  355. data/spec/models/move_folder_request_spec.rb +1 -1
  356. data/spec/models/move_template_request_spec.rb +1 -1
  357. data/spec/models/number_condition_type_spec.rb +1 -1
  358. data/spec/models/output_format_spec.rb +1 -1
  359. data/spec/models/page_format_spec.rb +1 -1
  360. data/spec/models/page_image_spec.rb +1 -1
  361. data/spec/models/page_images_spec.rb +1 -1
  362. data/spec/models/predefined_field_input_spec.rb +1 -1
  363. data/spec/models/predefined_field_spec.rb +1 -1
  364. data/spec/models/publish_template_version_request_spec.rb +1 -1
  365. data/spec/models/remove_template_fields_request_spec.rb +1 -1
  366. data/spec/models/rename_folder_request_spec.rb +1 -1
  367. data/spec/models/reorder_template_fields_request_spec.rb +1 -1
  368. data/spec/models/restore_template_version_request_spec.rb +1 -1
  369. data/spec/models/send_account_email_action_test_email_request_spec.rb +36 -0
  370. data/spec/models/shape_type_spec.rb +1 -1
  371. data/spec/models/signature_request_auth_second_factor_type_spec.rb +1 -1
  372. data/spec/models/signature_request_auth_type_spec.rb +1 -1
  373. data/spec/models/signature_request_email_attachments_spec.rb +30 -0
  374. data/spec/models/signature_request_email_status_spec.rb +30 -0
  375. data/spec/models/signature_request_event_spec.rb +1 -1
  376. data/spec/models/signature_request_event_type_spec.rb +1 -1
  377. data/spec/models/signature_request_input_spec.rb +13 -1
  378. data/spec/models/signature_request_message_type_spec.rb +1 -1
  379. data/spec/models/signature_request_reminders_spec.rb +42 -0
  380. data/spec/models/signature_request_spec.rb +25 -1
  381. data/spec/models/signature_request_state_spec.rb +1 -1
  382. data/spec/models/signature_request_token_spec.rb +1 -1
  383. data/spec/models/signature_request_token_type_spec.rb +1 -1
  384. data/spec/models/signing_order_spec.rb +30 -0
  385. data/spec/models/string_condition_type_spec.rb +1 -1
  386. data/spec/models/submission_action_spec.rb +7 -1
  387. data/spec/models/submission_action_state_spec.rb +1 -1
  388. data/spec/models/submission_action_type_spec.rb +1 -1
  389. data/spec/models/submission_batch_spec.rb +1 -1
  390. data/spec/models/submission_batch_state_spec.rb +1 -1
  391. data/spec/models/submission_files_spec.rb +13 -1
  392. data/spec/models/submission_input_spec.rb +1 -1
  393. data/spec/models/submission_list_spec.rb +1 -1
  394. data/spec/models/submission_source_pdf_spec.rb +1 -1
  395. data/spec/models/submission_source_spec.rb +1 -1
  396. data/spec/models/submission_spec.rb +7 -1
  397. data/spec/models/submission_state_spec.rb +1 -1
  398. data/spec/models/submission_summary_spec.rb +1 -1
  399. data/spec/models/submission_validation_spec.rb +1 -1
  400. data/spec/models/template_actor_spec.rb +1 -1
  401. data/spec/models/template_actor_type_spec.rb +1 -1
  402. data/spec/models/template_defaults_input_spec.rb +1 -1
  403. data/spec/models/template_defaults_spec.rb +1 -1
  404. data/spec/models/template_diff_spec.rb +1 -1
  405. data/spec/models/template_diff_summary_spec.rb +1 -1
  406. data/spec/models/template_document_spec.rb +1 -1
  407. data/spec/models/template_document_state_spec.rb +1 -1
  408. data/spec/models/template_document_summary_spec.rb +1 -1
  409. data/spec/models/template_field_change_spec.rb +1 -1
  410. data/spec/models/template_field_changes_spec.rb +1 -1
  411. data/spec/models/template_field_dependency_action_spec.rb +1 -1
  412. data/spec/models/template_field_dependency_condition_input_spec.rb +1 -1
  413. data/spec/models/template_field_dependency_condition_spec.rb +1 -1
  414. data/spec/models/template_field_dependency_input_spec.rb +1 -1
  415. data/spec/models/template_field_dependency_match_spec.rb +1 -1
  416. data/spec/models/template_field_dependency_operator_spec.rb +1 -1
  417. data/spec/models/template_field_dependency_spec.rb +1 -1
  418. data/spec/models/template_field_logic_status_spec.rb +1 -1
  419. data/spec/models/template_field_move_spec.rb +1 -1
  420. data/spec/models/template_fields_spec.rb +1 -1
  421. data/spec/models/template_form_mode_spec.rb +1 -1
  422. data/spec/models/template_model_code_spec.rb +1 -1
  423. data/spec/models/template_page_ai_error_spec.rb +1 -1
  424. data/spec/models/template_page_ai_naming_status_spec.rb +1 -1
  425. data/spec/models/template_page_fields_status_spec.rb +1 -1
  426. data/spec/models/template_page_image_status_spec.rb +1 -1
  427. data/spec/models/template_page_images_spec.rb +1 -1
  428. data/spec/models/template_page_processing_status_spec.rb +1 -1
  429. data/spec/models/template_preview_spec.rb +1 -1
  430. data/spec/models/template_preview_state_spec.rb +1 -1
  431. data/spec/models/template_source_pdf_spec.rb +1 -1
  432. data/spec/models/template_spec.rb +55 -1
  433. data/spec/models/template_summary_list_spec.rb +1 -1
  434. data/spec/models/template_summary_spec.rb +7 -1
  435. data/spec/models/template_type_spec.rb +1 -1
  436. data/spec/models/template_version_spec.rb +1 -1
  437. data/spec/models/template_version_type_spec.rb +1 -1
  438. data/spec/models/text_alignment_spec.rb +1 -1
  439. data/spec/models/text_overflow_spec.rb +1 -1
  440. data/spec/models/text_vertical_alignment_spec.rb +1 -1
  441. data/spec/models/typeface_spec.rb +1 -1
  442. data/spec/models/update_account_email_action_request_spec.rb +144 -0
  443. data/spec/models/update_email_action_customization_request_spec.rb +120 -0
  444. data/spec/models/update_email_action_request_spec.rb +132 -0
  445. data/spec/models/update_signature_request_request_spec.rb +1 -1
  446. data/spec/models/update_template_document_request_spec.rb +1 -1
  447. data/spec/models/update_template_fields_request_spec.rb +1 -1
  448. data/spec/models/update_template_request_spec.rb +55 -1
  449. data/spec/models/update_webhook_request_spec.rb +1 -1
  450. data/spec/models/upload_method_spec.rb +1 -1
  451. data/spec/models/upload_presign_spec.rb +1 -1
  452. data/spec/models/url_source_pdf_spec.rb +1 -1
  453. data/spec/models/validate_submission_request_spec.rb +55 -1
  454. data/spec/models/webhook_event_type_spec.rb +1 -1
  455. data/spec/models/webhook_list_spec.rb +1 -1
  456. data/spec/models/webhook_mode_spec.rb +1 -1
  457. data/spec/models/webhook_spec.rb +1 -1
  458. data/spec/spec_helper.rb +1 -1
  459. metadata +117 -5
  460. data/.gitlab-ci.yml +0 -26
  461. data/.travis.yml +0 -11
@@ -1,7 +1,7 @@
1
1
  =begin
2
2
  #DocSpring API
3
3
 
4
- #Use DocSpring's API to programmatically fill out PDF forms, convert HTML to PDFs, merge PDFs, or request legally binding e-signatures.
4
+ #Use DocSpring's API to fill PDF forms, generate PDFs and Word documents from HTML or Word templates, merge PDFs, and request legally binding e-signatures.
5
5
 
6
6
  The version of the OpenAPI document: v2
7
7
 
@@ -19,7 +19,7 @@ module DocSpring
19
19
  # The name of the person the request is for.
20
20
  attr_accessor :name
21
21
 
22
- # Their email address.
22
+ # Their email address. Null when they have none.
23
23
  attr_accessor :email
24
24
 
25
25
  # The fields this person fills in. Each field can only be in one signature request, and a field that `data` fills in needs `prefilled_values_editable`.
@@ -61,6 +61,12 @@ module DocSpring
61
61
  # Let the person change the values that `data` already has for fields in `fields`. Without it, those fields are a 422.
62
62
  attr_accessor :prefilled_values_editable
63
63
 
64
+ # Whether DocSpring emails this person their signing link. Default: the submission's `send_email`. Set it to false for someone who signs in your app (embedded signing) or whose link you send yourself. When DocSpring emails them, `email` is required and `auth_type` is `email_link` (the default). Otherwise `auth_type` is required.
65
+ attr_accessor :send_email
66
+
67
+ # When this person signs, with `signing_order: sequential`: everyone in step 1 first, then step 2, and so on. People in the same step sign in any order. Only the order of the numbers matters. Either every signature request has a `signing_step` or none does; without them, each person is a step of their own, in the order of `signature_requests`.
68
+ attr_accessor :signing_step
69
+
64
70
  class EnumAttributeValidator
65
71
  attr_reader :datatype
66
72
  attr_reader :allowable_values
@@ -100,7 +106,9 @@ module DocSpring
100
106
  :'auth_username_hash' => :'auth_username_hash',
101
107
  :'auth_phone_number_hash' => :'auth_phone_number_hash',
102
108
  :'ignore_unknown_fields' => :'ignore_unknown_fields',
103
- :'prefilled_values_editable' => :'prefilled_values_editable'
109
+ :'prefilled_values_editable' => :'prefilled_values_editable',
110
+ :'send_email' => :'send_email',
111
+ :'signing_step' => :'signing_step'
104
112
  }
105
113
  end
106
114
 
@@ -131,7 +139,9 @@ module DocSpring
131
139
  :'auth_username_hash' => :'String',
132
140
  :'auth_phone_number_hash' => :'String',
133
141
  :'ignore_unknown_fields' => :'Boolean',
134
- :'prefilled_values_editable' => :'Boolean'
142
+ :'prefilled_values_editable' => :'Boolean',
143
+ :'send_email' => :'Boolean',
144
+ :'signing_step' => :'Integer'
135
145
  }
136
146
  end
137
147
 
@@ -203,8 +213,6 @@ module DocSpring
203
213
 
204
214
  if attributes.key?(:'auth_type')
205
215
  self.auth_type = attributes[:'auth_type']
206
- else
207
- self.auth_type = nil
208
216
  end
209
217
 
210
218
  if attributes.key?(:'auth_second_factor_type')
@@ -242,6 +250,14 @@ module DocSpring
242
250
  if attributes.key?(:'prefilled_values_editable')
243
251
  self.prefilled_values_editable = attributes[:'prefilled_values_editable']
244
252
  end
253
+
254
+ if attributes.key?(:'send_email')
255
+ self.send_email = attributes[:'send_email']
256
+ end
257
+
258
+ if attributes.key?(:'signing_step')
259
+ self.signing_step = attributes[:'signing_step']
260
+ end
245
261
  end
246
262
 
247
263
  # Show invalid properties with the reasons. Usually used together with valid?
@@ -253,10 +269,6 @@ module DocSpring
253
269
  invalid_properties.push('invalid value for "fields", fields cannot be nil.')
254
270
  end
255
271
 
256
- if @auth_type.nil?
257
- invalid_properties.push('invalid value for "auth_type", auth_type cannot be nil.')
258
- end
259
-
260
272
  invalid_properties
261
273
  end
262
274
 
@@ -265,7 +277,6 @@ module DocSpring
265
277
  def valid?
266
278
  warn '[DEPRECATED] the `valid?` method is obsolete'
267
279
  return false if @fields.nil?
268
- return false if @auth_type.nil?
269
280
  true
270
281
  end
271
282
 
@@ -279,16 +290,6 @@ module DocSpring
279
290
  @fields = fields
280
291
  end
281
292
 
282
- # Custom attribute writer method with validation
283
- # @param [Object] auth_type Value to be assigned
284
- def auth_type=(auth_type)
285
- if auth_type.nil?
286
- fail ArgumentError, 'auth_type cannot be nil'
287
- end
288
-
289
- @auth_type = auth_type
290
- end
291
-
292
293
  # Checks equality by comparing each attribute.
293
294
  # @param [Object] Object to be compared
294
295
  def ==(o)
@@ -308,7 +309,9 @@ module DocSpring
308
309
  auth_username_hash == o.auth_username_hash &&
309
310
  auth_phone_number_hash == o.auth_phone_number_hash &&
310
311
  ignore_unknown_fields == o.ignore_unknown_fields &&
311
- prefilled_values_editable == o.prefilled_values_editable
312
+ prefilled_values_editable == o.prefilled_values_editable &&
313
+ send_email == o.send_email &&
314
+ signing_step == o.signing_step
312
315
  end
313
316
 
314
317
  # @see the `==` method
@@ -320,7 +323,7 @@ module DocSpring
320
323
  # Calculates hash code according to all attributes.
321
324
  # @return [Integer] Hash code
322
325
  def hash
323
- [name, email, fields, metadata, role, auth_type, auth_second_factor_type, auth_provider, auth_session_started_at, auth_session_id_hash, auth_user_id_hash, auth_username_hash, auth_phone_number_hash, ignore_unknown_fields, prefilled_values_editable].hash
326
+ [name, email, fields, metadata, role, auth_type, auth_second_factor_type, auth_provider, auth_session_started_at, auth_session_id_hash, auth_user_id_hash, auth_username_hash, auth_phone_number_hash, ignore_unknown_fields, prefilled_values_editable, send_email, signing_step].hash
324
327
  end
325
328
 
326
329
  # 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
 
@@ -0,0 +1,212 @@
1
+ =begin
2
+ #DocSpring API
3
+
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
+
6
+ The version of the OpenAPI document: v2
7
+
8
+ Generated by: https://openapi-generator.tech
9
+ Generator version: 7.26.0-DOCSPRING
10
+
11
+ =end
12
+
13
+ require 'date'
14
+ require 'time'
15
+
16
+ module DocSpring
17
+ # How often DocSpring reminds people who haven't signed.
18
+ class SignatureRequestReminders < ApiModelBase
19
+ # Days between reminders.
20
+ attr_accessor :interval_days
21
+
22
+ # The most reminders each person gets.
23
+ attr_accessor :max_count
24
+
25
+ # Attribute mapping from ruby-style variable name to JSON key.
26
+ def self.attribute_map
27
+ {
28
+ :'interval_days' => :'interval_days',
29
+ :'max_count' => :'max_count'
30
+ }
31
+ end
32
+
33
+ # Returns attribute mapping this model knows about
34
+ def self.acceptable_attribute_map
35
+ attribute_map
36
+ end
37
+
38
+ # Returns all the JSON keys this model knows about
39
+ def self.acceptable_attributes
40
+ acceptable_attribute_map.values
41
+ end
42
+
43
+ # Attribute type mapping.
44
+ def self.openapi_types
45
+ {
46
+ :'interval_days' => :'Integer',
47
+ :'max_count' => :'Integer'
48
+ }
49
+ end
50
+
51
+ # List of attributes with nullable: true
52
+ def self.openapi_nullable
53
+ Set.new([
54
+ ])
55
+ end
56
+
57
+ # Returns attribute type mapping
58
+ def self.acceptable_openapi_types
59
+ openapi_types
60
+ end
61
+
62
+ # Returns the nullable attributes
63
+ def self.acceptable_openapi_nullable
64
+ openapi_nullable
65
+ end
66
+
67
+ # Initializes the object
68
+ # @param [Hash] attributes Model attributes in the form of hash
69
+ def initialize(attributes = {})
70
+ if (!attributes.is_a?(Hash))
71
+ fail ArgumentError, "The input argument (attributes) must be a hash in `DocSpring::SignatureRequestReminders` initialize method"
72
+ end
73
+
74
+ # check to see if the attribute exists and convert string to symbol for hash key
75
+ acceptable_attribute_map = self.class.acceptable_attribute_map
76
+ attributes = attributes.each_with_object({}) { |(k, v), h|
77
+ if (!acceptable_attribute_map.key?(k.to_sym))
78
+ fail ArgumentError, "`#{k}` is not a valid attribute in `DocSpring::SignatureRequestReminders`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect
79
+ end
80
+ h[k.to_sym] = v
81
+ }
82
+
83
+ if attributes.key?(:'interval_days')
84
+ self.interval_days = attributes[:'interval_days']
85
+ else
86
+ self.interval_days = nil
87
+ end
88
+
89
+ if attributes.key?(:'max_count')
90
+ self.max_count = attributes[:'max_count']
91
+ else
92
+ self.max_count = nil
93
+ end
94
+ end
95
+
96
+ # Show invalid properties with the reasons. Usually used together with valid?
97
+ # @return Array for valid properties with the reasons
98
+ def list_invalid_properties
99
+ warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
100
+ invalid_properties = Array.new
101
+ if @interval_days.nil?
102
+ invalid_properties.push('invalid value for "interval_days", interval_days cannot be nil.')
103
+ end
104
+
105
+ if @max_count.nil?
106
+ invalid_properties.push('invalid value for "max_count", max_count cannot be nil.')
107
+ end
108
+
109
+ invalid_properties
110
+ end
111
+
112
+ # Check to see if the all the properties in the model are valid
113
+ # @return true if the model is valid
114
+ def valid?
115
+ warn '[DEPRECATED] the `valid?` method is obsolete'
116
+ return false if @interval_days.nil?
117
+ return false if @max_count.nil?
118
+ true
119
+ end
120
+
121
+ # Custom attribute writer method with validation
122
+ # @param [Object] interval_days Value to be assigned
123
+ def interval_days=(interval_days)
124
+ if interval_days.nil?
125
+ fail ArgumentError, 'interval_days cannot be nil'
126
+ end
127
+
128
+ @interval_days = interval_days
129
+ end
130
+
131
+ # Custom attribute writer method with validation
132
+ # @param [Object] max_count Value to be assigned
133
+ def max_count=(max_count)
134
+ if max_count.nil?
135
+ fail ArgumentError, 'max_count cannot be nil'
136
+ end
137
+
138
+ @max_count = max_count
139
+ end
140
+
141
+ # Checks equality by comparing each attribute.
142
+ # @param [Object] Object to be compared
143
+ def ==(o)
144
+ return true if self.equal?(o)
145
+ self.class == o.class &&
146
+ interval_days == o.interval_days &&
147
+ max_count == o.max_count
148
+ end
149
+
150
+ # @see the `==` method
151
+ # @param [Object] Object to be compared
152
+ def eql?(o)
153
+ self == o
154
+ end
155
+
156
+ # Calculates hash code according to all attributes.
157
+ # @return [Integer] Hash code
158
+ def hash
159
+ [interval_days, max_count].hash
160
+ end
161
+
162
+ # Builds the object from hash
163
+ # @param [Hash] attributes Model attributes in the form of hash
164
+ # @return [Object] Returns the model itself
165
+ def self.build_from_hash(attributes)
166
+ return nil unless attributes.is_a?(Hash)
167
+ attributes = attributes.transform_keys(&:to_sym)
168
+ # include attributes inherited from allOf parents (the nearest declaration wins)
169
+ map = acceptable_attribute_map
170
+ transformed_hash = {}
171
+ acceptable_openapi_types.each_pair do |key, type|
172
+ if attributes.key?(map[key]) && attributes[map[key]].nil?
173
+ transformed_hash["#{key}"] = nil
174
+ elsif type =~ /\AArray<(.*)>/i
175
+ # check to ensure the input is an array given that the attribute
176
+ # is documented as an array but the input is not
177
+ if attributes[map[key]].is_a?(Array)
178
+ transformed_hash["#{key}"] = attributes[map[key]].map { |v| _deserialize($1, v) }
179
+ end
180
+ elsif !attributes[map[key]].nil?
181
+ transformed_hash["#{key}"] = _deserialize(type, attributes[map[key]])
182
+ end
183
+ end
184
+ # Responses can include enum values added after this client was released, so the enum setters
185
+ # accept any value while the model is built from a response
186
+ allocate.tap do |model|
187
+ model.instance_variable_set(:@_skip_enum_validation, true)
188
+ model.send(:initialize, transformed_hash)
189
+ model.remove_instance_variable(:@_skip_enum_validation)
190
+ end
191
+ end
192
+
193
+ # Returns the object in the form of hash
194
+ # @return [Hash] Returns the object in the form of hash
195
+ def to_hash
196
+ hash = {}
197
+ # include attributes inherited from allOf parents (the nearest declaration wins)
198
+ self.class.acceptable_attribute_map.each_pair do |attr, param|
199
+ value = self.send(attr)
200
+ if value.nil?
201
+ is_nullable = self.class.acceptable_openapi_nullable.include?(attr)
202
+ next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
203
+ end
204
+
205
+ hash[param] = _to_hash(value)
206
+ end
207
+ hash
208
+ end
209
+
210
+ end
211
+
212
+ end
@@ -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
 
@@ -0,0 +1,41 @@
1
+ =begin
2
+ #DocSpring API
3
+
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
+
6
+ The version of the OpenAPI document: v2
7
+
8
+ Generated by: https://openapi-generator.tech
9
+ Generator version: 7.26.0-DOCSPRING
10
+
11
+ =end
12
+
13
+ require 'date'
14
+ require 'time'
15
+
16
+ module DocSpring
17
+ class SigningOrder
18
+ PARALLEL = "parallel".freeze
19
+ SEQUENTIAL = "sequential".freeze
20
+
21
+ def self.all_vars
22
+ @all_vars ||= [PARALLEL, SEQUENTIAL].freeze
23
+ end
24
+
25
+ # Builds the enum from string
26
+ # @param [String] The enum value in the form of the string
27
+ # @return [String] The enum value
28
+ def self.build_from_hash(value)
29
+ new.build_from_hash(value)
30
+ end
31
+
32
+ # Builds the enum from string
33
+ # @param [String] The enum value in the form of the string
34
+ # @return [String] The enum value
35
+ def build_from_hash(value)
36
+ # Only responses are built from hashes, and a value added to the API after this client was released is kept as it
37
+ # is: the constants are the values this client knows
38
+ value
39
+ end
40
+ end
41
+ end
@@ -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,13 +16,20 @@ require 'time'
16
16
  module DocSpring
17
17
  class StringConditionType
18
18
  EQUALS = "equals".freeze
19
+ NOT_EQUALS = "not_equals".freeze
19
20
  CONTAINS = "contains".freeze
21
+ NOT_CONTAINS = "not_contains".freeze
20
22
  STARTS_WITH = "starts_with".freeze
23
+ NOT_STARTS_WITH = "not_starts_with".freeze
21
24
  ENDS_WITH = "ends_with".freeze
25
+ NOT_ENDS_WITH = "not_ends_with".freeze
22
26
  REGEX = "regex".freeze
27
+ NOT_REGEX = "not_regex".freeze
28
+ BLANK = "blank".freeze
29
+ NOT_BLANK = "not_blank".freeze
23
30
 
24
31
  def self.all_vars
25
- @all_vars ||= [EQUALS, CONTAINS, STARTS_WITH, ENDS_WITH, REGEX].freeze
32
+ @all_vars ||= [EQUALS, NOT_EQUALS, CONTAINS, NOT_CONTAINS, STARTS_WITH, NOT_STARTS_WITH, ENDS_WITH, NOT_ENDS_WITH, REGEX, NOT_REGEX, BLANK, NOT_BLANK].freeze
26
33
  end
27
34
 
28
35
  # 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
 
@@ -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,10 +34,10 @@ 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
- # Test PDFs have a watermark and are free. Live PDFs use credits. Submissions made with a test API token are always test submissions.
40
+ # Test PDFs have a watermark and are free. Live PDFs use credits. Submissions made with a test API token are always test submissions, and the demo API token's are always live.
41
41
  attr_accessor :test
42
42
 
43
43
  # `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`.
@@ -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.
@@ -79,13 +79,16 @@ module DocSpring
79
79
  # The people asked to sign the submission (and fill in their fields), in order.
80
80
  attr_accessor :signature_requests
81
81
 
82
- # The uploads of the submission's PDF to your storage (account integrations).
82
+ # `parallel`: everyone can sign at once. `sequential`: people sign one step at a time (each signature request's `signing_step`).
83
+ attr_accessor :signing_order
84
+
85
+ # The uploads of the submission's PDF to your storage (account integrations), and the emails its template's email actions sent.
83
86
  attr_accessor :actions
84
87
 
85
88
  # 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
89
  attr_accessor :truncated_text
87
90
 
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.
91
+ # 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
92
  attr_accessor :output_formats
90
93
 
91
94
  # When the preview PDF was generated. Null if there is no preview.
@@ -137,6 +140,7 @@ module DocSpring
137
140
  :'updated_at' => :'updated_at',
138
141
  :'has_password' => :'has_password',
139
142
  :'signature_requests' => :'signature_requests',
143
+ :'signing_order' => :'signing_order',
140
144
  :'actions' => :'actions',
141
145
  :'truncated_text' => :'truncated_text',
142
146
  :'output_formats' => :'output_formats',
@@ -178,6 +182,7 @@ module DocSpring
178
182
  :'updated_at' => :'Time',
179
183
  :'has_password' => :'Boolean',
180
184
  :'signature_requests' => :'Array<SignatureRequest>',
185
+ :'signing_order' => :'SigningOrder',
181
186
  :'actions' => :'Array<SubmissionAction>',
182
187
  :'truncated_text' => :'Hash<String, Array<String>>',
183
188
  :'output_formats' => :'Array<OutputFormat>',
@@ -360,6 +365,12 @@ module DocSpring
360
365
  self.signature_requests = nil
361
366
  end
362
367
 
368
+ if attributes.key?(:'signing_order')
369
+ self.signing_order = attributes[:'signing_order']
370
+ else
371
+ self.signing_order = nil
372
+ end
373
+
363
374
  if attributes.key?(:'actions')
364
375
  if (value = attributes[:'actions']).is_a?(Array)
365
376
  self.actions = value
@@ -452,6 +463,10 @@ module DocSpring
452
463
  invalid_properties.push('invalid value for "signature_requests", signature_requests cannot be nil.')
453
464
  end
454
465
 
466
+ if @signing_order.nil?
467
+ invalid_properties.push('invalid value for "signing_order", signing_order cannot be nil.')
468
+ end
469
+
455
470
  if @actions.nil?
456
471
  invalid_properties.push('invalid value for "actions", actions cannot be nil.')
457
472
  end
@@ -481,6 +496,7 @@ module DocSpring
481
496
  return false if @updated_at.nil?
482
497
  return false if @has_password.nil?
483
498
  return false if @signature_requests.nil?
499
+ return false if @signing_order.nil?
484
500
  return false if @actions.nil?
485
501
  return false if @output_formats.nil?
486
502
  true
@@ -626,6 +642,16 @@ module DocSpring
626
642
  @signature_requests = signature_requests
627
643
  end
628
644
 
645
+ # Custom attribute writer method with validation
646
+ # @param [Object] signing_order Value to be assigned
647
+ def signing_order=(signing_order)
648
+ if signing_order.nil?
649
+ fail ArgumentError, 'signing_order cannot be nil'
650
+ end
651
+
652
+ @signing_order = signing_order
653
+ end
654
+
629
655
  # Custom attribute writer method with validation
630
656
  # @param [Object] actions Value to be assigned
631
657
  def actions=(actions)
@@ -672,6 +698,7 @@ module DocSpring
672
698
  updated_at == o.updated_at &&
673
699
  has_password == o.has_password &&
674
700
  signature_requests == o.signature_requests &&
701
+ signing_order == o.signing_order &&
675
702
  actions == o.actions &&
676
703
  truncated_text == o.truncated_text &&
677
704
  output_formats == o.output_formats &&
@@ -687,7 +714,7 @@ module DocSpring
687
714
  # Calculates hash code according to all attributes.
688
715
  # @return [Integer] Hash code
689
716
  def hash
690
- [id, template_id, template_type, template_version, batch_id, source, state, test, editable, data, data_errors, error_message, metadata, files, expired, expires_at, processed_at, created_at, updated_at, has_password, signature_requests, actions, truncated_text, output_formats, preview_generated_at].hash
717
+ [id, template_id, template_type, template_version, batch_id, source, state, test, editable, data, data_errors, error_message, metadata, files, expired, expires_at, processed_at, created_at, updated_at, has_password, signature_requests, signing_order, actions, truncated_text, output_formats, preview_generated_at].hash
691
718
  end
692
719
 
693
720
  # Builds the object from hash