docspring 3.5.0 → 4.0.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 (505) hide show
  1. checksums.yaml +4 -4
  2. data/.openapi-generator/FILES +361 -150
  3. data/.openapi-generator/VERSION +1 -1
  4. data/.rubocop.yml +1 -1
  5. data/.travis.yml +1 -1
  6. data/AGENTS.md +79 -19
  7. data/CHANGELOG.md +123 -0
  8. data/Gemfile.lock +7 -7
  9. data/README.md +60 -53
  10. data/docs/{RenameFolderData.md → AiFieldNamingLanguage.md} +2 -5
  11. data/docs/AuthenticationCheck.md +18 -0
  12. data/docs/{CreateFolderData.md → BarcodeSymbology.md} +2 -5
  13. data/docs/{CreateWebhookData.md → CheckCharacter.md} +2 -5
  14. data/docs/Client.md +890 -777
  15. data/docs/{UpdateWebhookData.md → CombinedFieldType.md} +2 -5
  16. data/docs/CombinedPdf.md +44 -0
  17. data/docs/CombinedPdfFiles.md +18 -0
  18. data/docs/CombinedPdfList.md +20 -0
  19. data/docs/CombinedPdfSource.md +26 -0
  20. data/docs/CombinedPdfSourceInput.md +88 -0
  21. data/docs/CombinedPdfSourcePdf.md +20 -0
  22. data/docs/CombinedPdfSourceType.md +15 -0
  23. data/docs/CombinedPdfState.md +15 -0
  24. data/docs/CopyTemplateRequest.md +22 -0
  25. data/docs/CreateCombinedPdfRequest.md +26 -0
  26. data/docs/CreateCustomFileFromUploadRequest.md +18 -0
  27. data/docs/CreateFolderRequest.md +20 -0
  28. data/docs/CreateSignatureRequestEventRequest.md +24 -0
  29. data/docs/CreateSignatureRequestTokenRequest.md +18 -0
  30. data/docs/CreateSubmissionBatchRequest.md +26 -0
  31. data/docs/CreateSubmissionRequest.md +36 -0
  32. data/docs/CreateTemplateRequest.md +94 -0
  33. data/docs/CreateWebhookRequest.md +38 -0
  34. data/docs/CustomFile.md +11 -3
  35. data/docs/CustomFileList.md +20 -0
  36. data/docs/CustomFileSourcePdf.md +20 -0
  37. data/docs/ErrorCode.md +15 -0
  38. data/docs/ErrorDetail.md +26 -0
  39. data/docs/ErrorInfo.md +32 -0
  40. data/docs/ErrorResponse.md +1 -3
  41. data/docs/ExpirationInterval.md +15 -0
  42. data/docs/FieldComparisonCondition.md +22 -0
  43. data/docs/FieldComparisonOperator.md +15 -0
  44. data/docs/FieldDisplayType.md +15 -0
  45. data/docs/FieldEqualsCondition.md +22 -0
  46. data/docs/FieldEqualsOperator.md +15 -0
  47. data/docs/FieldInCondition.md +22 -0
  48. data/docs/FieldOverride.md +142 -0
  49. data/docs/FieldPresenceCondition.md +20 -0
  50. data/docs/FieldPresenceOperator.md +15 -0
  51. data/docs/FieldRangeCondition.md +24 -0
  52. data/docs/FieldReimportState.md +15 -0
  53. data/docs/FieldSetupLogic.md +15 -0
  54. data/docs/FieldSetupNaming.md +15 -0
  55. data/docs/FieldSetupSource.md +15 -0
  56. data/docs/Folder.md +9 -5
  57. data/docs/FolderList.md +20 -0
  58. data/docs/GeneratedFile.md +32 -0
  59. data/docs/GeneratedFileState.md +15 -0
  60. data/docs/HtmlEngineOptions.md +36 -0
  61. data/docs/HtmlEngineOptionsInput.md +36 -0
  62. data/docs/ImageGravity.md +15 -0
  63. data/docs/ImageScaleType.md +15 -0
  64. data/docs/ModelCodeLanguage.md +15 -0
  65. data/docs/MoveFolderRequest.md +18 -0
  66. data/docs/MoveTemplateRequest.md +18 -0
  67. data/docs/NumberConditionType.md +15 -0
  68. data/docs/PageFormat.md +15 -0
  69. data/docs/PublishTemplateVersionRequest.md +20 -0
  70. data/docs/RenameFolderRequest.md +18 -0
  71. data/docs/RestoreTemplateVersionRequest.md +18 -0
  72. data/docs/ShapeType.md +15 -0
  73. data/docs/SignatureRequest.md +66 -0
  74. data/docs/SignatureRequestAuthSecondFactorType.md +15 -0
  75. data/docs/SignatureRequestAuthType.md +15 -0
  76. data/docs/SignatureRequestEvent.md +32 -0
  77. data/docs/SignatureRequestEventType.md +15 -0
  78. data/docs/SignatureRequestInput.md +46 -0
  79. data/docs/SignatureRequestMessageType.md +15 -0
  80. data/docs/SignatureRequestState.md +15 -0
  81. data/docs/SignatureRequestToken.md +30 -0
  82. data/docs/SignatureRequestTokenType.md +15 -0
  83. data/docs/StringConditionType.md +15 -0
  84. data/docs/Submission.md +41 -47
  85. data/docs/SubmissionAction.md +6 -8
  86. data/docs/SubmissionActionState.md +15 -0
  87. data/docs/SubmissionActionType.md +15 -0
  88. data/docs/SubmissionBatch.md +16 -10
  89. data/docs/SubmissionBatchState.md +15 -0
  90. data/docs/SubmissionFiles.md +22 -0
  91. data/docs/SubmissionInput.md +38 -0
  92. data/docs/SubmissionList.md +20 -0
  93. data/docs/SubmissionSource.md +15 -0
  94. data/docs/SubmissionSourcePdf.md +20 -0
  95. data/docs/SubmissionState.md +15 -0
  96. data/docs/Template.md +73 -107
  97. data/docs/TemplateActor.md +26 -0
  98. data/docs/TemplateActorType.md +15 -0
  99. data/docs/TemplateDefaults.md +56 -0
  100. data/docs/TemplateDefaultsInput.md +56 -0
  101. data/docs/TemplateDocument.md +40 -0
  102. data/docs/TemplateDocumentState.md +15 -0
  103. data/docs/TemplateFieldDependency.md +26 -0
  104. data/docs/TemplateFieldDependencyAction.md +15 -0
  105. data/docs/TemplateFieldDependencyCondition.md +24 -0
  106. data/docs/TemplateFieldDependencyConditionInput.md +93 -0
  107. data/docs/TemplateFieldDependencyInput.md +26 -0
  108. data/docs/TemplateFieldDependencyMatch.md +15 -0
  109. data/docs/TemplateFieldDependencyOperator.md +15 -0
  110. data/docs/TemplateFieldLogicStatus.md +15 -0
  111. data/docs/TemplateFormMode.md +15 -0
  112. data/docs/TemplateModelCode.md +22 -0
  113. data/docs/TemplatePageAiError.md +15 -0
  114. data/docs/TemplatePageAiNamingStatus.md +15 -0
  115. data/docs/TemplatePageFieldsStatus.md +15 -0
  116. data/docs/TemplatePageImageStatus.md +15 -0
  117. data/docs/TemplatePageProcessingStatus.md +26 -0
  118. data/docs/TemplateSourcePdf.md +24 -0
  119. data/docs/TemplateSummary.md +90 -0
  120. data/docs/TemplateSummaryList.md +20 -0
  121. data/docs/TemplateType.md +15 -0
  122. data/docs/TemplateVersion.md +24 -0
  123. data/docs/TemplateVersionType.md +15 -0
  124. data/docs/TextAlignment.md +15 -0
  125. data/docs/TextOverflow.md +15 -0
  126. data/docs/TextVerticalAlignment.md +15 -0
  127. data/docs/Typeface.md +15 -0
  128. data/docs/UpdateSignatureRequestRequest.md +34 -0
  129. data/docs/UpdateTemplateDocumentRequest.md +22 -0
  130. data/docs/UpdateTemplateRequest.md +80 -0
  131. data/docs/UpdateWebhookRequest.md +38 -0
  132. data/docs/UploadMethod.md +15 -0
  133. data/docs/UploadPresign.md +24 -0
  134. data/docs/UrlSourcePdf.md +20 -0
  135. data/docs/Webhook.md +20 -20
  136. data/docs/WebhookEventType.md +15 -0
  137. data/docs/WebhookList.md +20 -0
  138. data/docs/WebhookMode.md +15 -0
  139. data/docspring.gemspec +3 -3
  140. data/lib/docspring/api/client.rb +995 -942
  141. data/lib/docspring/api_client.rb +14 -6
  142. data/lib/docspring/api_error.rb +3 -3
  143. data/lib/docspring/api_model_base.rb +88 -0
  144. data/lib/docspring/configuration.rb +12 -7
  145. data/lib/docspring/models/ai_field_naming_language.rb +42 -0
  146. data/lib/docspring/models/authentication_check.rb +185 -0
  147. data/lib/docspring/models/barcode_symbology.rb +47 -0
  148. data/lib/docspring/models/check_character.rb +44 -0
  149. data/lib/docspring/models/combined_field_type.rb +41 -0
  150. data/lib/docspring/models/{combined_submission.rb → combined_pdf.rb} +228 -206
  151. data/lib/docspring/models/combined_pdf_files.rb +167 -0
  152. data/lib/docspring/models/combined_pdf_list.rb +200 -0
  153. data/lib/docspring/models/{update_webhook_data.rb → combined_pdf_source.rb} +107 -103
  154. data/lib/docspring/models/combined_pdf_source_input.rb +62 -0
  155. data/lib/docspring/models/combined_pdf_source_pdf.rb +212 -0
  156. data/lib/docspring/models/combined_pdf_source_type.rb +44 -0
  157. data/lib/docspring/models/combined_pdf_state.rb +44 -0
  158. data/lib/docspring/models/{copy_template_options.rb → copy_template_request.rb} +32 -87
  159. data/lib/docspring/models/{combine_pdfs_data.rb → create_combined_pdf_request.rb} +60 -123
  160. data/lib/docspring/models/{create_custom_file_data.rb → create_custom_file_from_upload_request.rb} +29 -96
  161. data/lib/docspring/models/{move_template_data.rb → create_folder_request.rb} +60 -102
  162. data/lib/docspring/models/{create_submission_data_request_event_request.rb → create_signature_request_event_request.rb} +50 -122
  163. data/lib/docspring/models/create_signature_request_token_request.rb +190 -0
  164. data/lib/docspring/models/{submission_batch_data.rb → create_submission_batch_request.rb} +53 -108
  165. data/lib/docspring/models/{create_pdf_submission_data.rb → create_submission_request.rb} +97 -149
  166. data/lib/docspring/models/create_template_request.rb +601 -0
  167. data/lib/docspring/models/create_webhook_request.rb +368 -0
  168. data/lib/docspring/models/custom_file.rb +132 -95
  169. data/lib/docspring/models/custom_file_list.rb +200 -0
  170. data/lib/docspring/models/custom_file_source_pdf.rb +212 -0
  171. data/lib/docspring/models/error_code.rb +60 -0
  172. data/lib/docspring/models/error_detail.rb +242 -0
  173. data/lib/docspring/models/error_info.rb +316 -0
  174. data/lib/docspring/models/error_response.rb +28 -138
  175. data/lib/docspring/models/expiration_interval.rb +42 -0
  176. data/lib/docspring/models/field_comparison_condition.rb +247 -0
  177. data/lib/docspring/models/field_comparison_operator.rb +43 -0
  178. data/lib/docspring/models/field_display_type.rb +45 -0
  179. data/lib/docspring/models/field_equals_condition.rb +247 -0
  180. data/lib/docspring/models/field_equals_operator.rb +41 -0
  181. data/lib/docspring/models/{create_folder_data.rb → field_in_condition.rb} +101 -103
  182. data/lib/docspring/models/field_override.rb +829 -0
  183. data/lib/docspring/models/field_presence_condition.rb +234 -0
  184. data/lib/docspring/models/field_presence_operator.rb +41 -0
  185. data/lib/docspring/models/field_range_condition.rb +234 -0
  186. data/lib/docspring/models/field_reimport_state.rb +43 -0
  187. data/lib/docspring/models/field_setup_logic.rb +41 -0
  188. data/lib/docspring/models/field_setup_naming.rb +41 -0
  189. data/lib/docspring/models/field_setup_source.rb +42 -0
  190. data/lib/docspring/models/folder.rb +134 -93
  191. data/lib/docspring/models/folder_list.rb +200 -0
  192. data/lib/docspring/models/generated_file.rb +326 -0
  193. data/lib/docspring/models/generated_file_state.rb +42 -0
  194. data/lib/docspring/models/html_engine_options.rb +416 -0
  195. data/lib/docspring/models/html_engine_options_input.rb +280 -0
  196. data/lib/docspring/models/image_gravity.rb +48 -0
  197. data/lib/docspring/models/image_scale_type.rb +42 -0
  198. data/lib/docspring/models/model_code_language.rb +48 -0
  199. data/lib/docspring/models/{move_folder_data.rb → move_folder_request.rb} +31 -87
  200. data/lib/docspring/models/move_template_request.rb +171 -0
  201. data/lib/docspring/models/number_condition_type.rb +45 -0
  202. data/lib/docspring/models/page_format.rb +52 -0
  203. data/lib/docspring/models/{publish_version_data.rb → publish_template_version_request.rb} +64 -99
  204. data/lib/docspring/models/{rename_folder_data.rb → rename_folder_request.rb} +29 -87
  205. data/lib/docspring/models/{restore_version_data.rb → restore_template_version_request.rb} +29 -87
  206. data/lib/docspring/models/shape_type.rb +45 -0
  207. data/lib/docspring/models/{submission_data_request_show.rb → signature_request.rb} +240 -171
  208. data/lib/docspring/models/signature_request_auth_second_factor_type.rb +45 -0
  209. data/lib/docspring/models/signature_request_auth_type.rb +46 -0
  210. data/lib/docspring/models/{submission_data_request_event.rb → signature_request_event.rb} +137 -122
  211. data/lib/docspring/models/signature_request_event_type.rb +45 -0
  212. data/lib/docspring/models/{update_submission_data_request_data.rb → signature_request_input.rb} +156 -173
  213. data/lib/docspring/models/signature_request_message_type.rb +48 -0
  214. data/lib/docspring/models/signature_request_state.rb +42 -0
  215. data/lib/docspring/models/signature_request_token.rb +369 -0
  216. data/lib/docspring/models/signature_request_token_type.rb +41 -0
  217. data/lib/docspring/models/string_condition_type.rb +44 -0
  218. data/lib/docspring/models/submission.rb +374 -339
  219. data/lib/docspring/models/submission_action.rb +64 -136
  220. data/lib/docspring/models/submission_action_state.rb +43 -0
  221. data/lib/docspring/models/submission_action_type.rb +46 -0
  222. data/lib/docspring/models/submission_batch.rb +157 -112
  223. data/lib/docspring/models/submission_batch_state.rb +42 -0
  224. data/lib/docspring/models/submission_files.rb +188 -0
  225. data/lib/docspring/models/submission_input.rb +274 -0
  226. data/lib/docspring/models/submission_list.rb +200 -0
  227. data/lib/docspring/models/submission_source.rb +43 -0
  228. data/lib/docspring/models/submission_source_pdf.rb +212 -0
  229. data/lib/docspring/models/submission_state.rb +52 -0
  230. data/lib/docspring/models/template.rb +485 -766
  231. data/lib/docspring/models/{add_fields_data.rb → template_actor.rb} +119 -105
  232. data/lib/docspring/models/template_actor_type.rb +42 -0
  233. data/lib/docspring/models/template_defaults.rb +395 -0
  234. data/lib/docspring/models/template_defaults_input.rb +395 -0
  235. data/lib/docspring/models/template_document.rb +396 -0
  236. data/lib/docspring/models/template_document_state.rb +44 -0
  237. data/lib/docspring/models/{success_error_response.rb → template_field_dependency.rb} +122 -114
  238. data/lib/docspring/models/template_field_dependency_action.rb +42 -0
  239. data/lib/docspring/models/{create_pdf_template.rb → template_field_dependency_condition.rb} +116 -103
  240. data/lib/docspring/models/template_field_dependency_condition_input.rb +67 -0
  241. data/lib/docspring/models/template_field_dependency_input.rb +285 -0
  242. data/lib/docspring/models/template_field_dependency_match.rb +41 -0
  243. data/lib/docspring/models/template_field_dependency_operator.rb +49 -0
  244. data/lib/docspring/models/template_field_logic_status.rb +44 -0
  245. data/lib/docspring/models/template_form_mode.rb +42 -0
  246. data/lib/docspring/models/{template_model_code_response.rb → template_model_code.rb} +37 -96
  247. data/lib/docspring/models/template_page_ai_error.rb +43 -0
  248. data/lib/docspring/models/template_page_ai_naming_status.rb +41 -0
  249. data/lib/docspring/models/template_page_fields_status.rb +44 -0
  250. data/lib/docspring/models/template_page_image_status.rb +41 -0
  251. data/lib/docspring/models/template_page_processing_status.rb +275 -0
  252. data/lib/docspring/models/{create_webhook_data.rb → template_source_pdf.rb} +92 -103
  253. data/lib/docspring/models/{template_preview.rb → template_summary.rb} +436 -589
  254. data/lib/docspring/models/template_summary_list.rb +200 -0
  255. data/lib/docspring/models/template_type.rb +41 -0
  256. data/lib/docspring/models/template_version.rb +238 -0
  257. data/lib/docspring/models/template_version_type.rb +42 -0
  258. data/lib/docspring/models/text_alignment.rb +43 -0
  259. data/lib/docspring/models/text_overflow.rb +41 -0
  260. data/lib/docspring/models/text_vertical_alignment.rb +42 -0
  261. data/lib/docspring/models/typeface.rb +56 -0
  262. data/lib/docspring/models/{create_submission_data_request_data.rb → update_signature_request_request.rb} +72 -196
  263. data/lib/docspring/models/update_template_document_request.rb +205 -0
  264. data/lib/docspring/models/update_template_request.rb +514 -0
  265. data/lib/docspring/models/update_webhook_request.rb +344 -0
  266. data/lib/docspring/models/upload_method.rb +40 -0
  267. data/lib/docspring/models/{upload_presign_response.rb → upload_presign.rb} +93 -140
  268. data/lib/docspring/models/url_source_pdf.rb +212 -0
  269. data/lib/docspring/models/webhook.rb +97 -107
  270. data/lib/docspring/models/webhook_event_type.rb +64 -0
  271. data/lib/docspring/models/webhook_list.rb +200 -0
  272. data/lib/docspring/models/webhook_mode.rb +41 -0
  273. data/lib/docspring/request_schemas.json +3187 -0
  274. data/lib/docspring/request_validator.rb +396 -0
  275. data/lib/docspring/version.rb +4 -4
  276. data/lib/docspring.rb +125 -53
  277. data/spec/api/client_spec.rb +304 -277
  278. data/spec/models/ai_field_naming_language_spec.rb +30 -0
  279. data/spec/models/authentication_check_spec.rb +36 -0
  280. data/spec/models/barcode_symbology_spec.rb +30 -0
  281. data/spec/models/check_character_spec.rb +30 -0
  282. data/spec/models/combined_field_type_spec.rb +30 -0
  283. data/spec/models/combined_pdf_files_spec.rb +36 -0
  284. data/spec/models/combined_pdf_list_spec.rb +42 -0
  285. data/spec/models/combined_pdf_source_input_spec.rb +44 -0
  286. data/spec/models/combined_pdf_source_pdf_spec.rb +42 -0
  287. data/spec/models/{submission_data_request_token_spec.rb → combined_pdf_source_spec.rb} +18 -12
  288. data/spec/models/combined_pdf_source_type_spec.rb +30 -0
  289. data/spec/models/{combined_submission_spec.rb → combined_pdf_spec.rb} +20 -24
  290. data/spec/models/combined_pdf_state_spec.rb +30 -0
  291. data/spec/models/{copy_template_options_spec.rb → copy_template_request_spec.rb} +9 -9
  292. data/spec/models/{combine_pdfs_data_spec.rb → create_combined_pdf_request_spec.rb} +12 -18
  293. data/spec/models/{create_custom_file_data_spec.rb → create_custom_file_from_upload_request_spec.rb} +9 -9
  294. data/spec/models/{move_template_data_spec.rb → create_folder_request_spec.rb} +11 -11
  295. data/spec/models/{list_submissions_response_spec.rb → create_signature_request_event_request_spec.rb} +18 -12
  296. data/spec/models/create_signature_request_token_request_spec.rb +36 -0
  297. data/spec/models/{submission_batch_data_spec.rb → create_submission_batch_request_spec.rb} +13 -13
  298. data/spec/models/{create_pdf_submission_data_spec.rb → create_submission_request_spec.rb} +24 -18
  299. data/spec/models/{template_preview_spec.rb → create_template_request_spec.rb} +40 -118
  300. data/spec/models/create_webhook_request_spec.rb +96 -0
  301. data/spec/models/custom_file_list_spec.rb +42 -0
  302. data/spec/models/custom_file_source_pdf_spec.rb +42 -0
  303. data/spec/models/custom_file_spec.rb +29 -5
  304. data/spec/models/error_code_spec.rb +30 -0
  305. data/spec/models/{create_submission_response_spec.rb → error_detail_spec.rb} +14 -18
  306. data/spec/models/{batch_generate_pdfs201_response_spec.rb → error_info_spec.rb} +27 -19
  307. data/spec/models/error_response_spec.rb +4 -14
  308. data/spec/models/expiration_interval_spec.rb +30 -0
  309. data/spec/models/field_comparison_condition_spec.rb +48 -0
  310. data/spec/models/field_comparison_operator_spec.rb +30 -0
  311. data/spec/models/field_display_type_spec.rb +30 -0
  312. data/spec/models/field_equals_condition_spec.rb +48 -0
  313. data/spec/models/field_equals_operator_spec.rb +30 -0
  314. data/spec/models/field_in_condition_spec.rb +48 -0
  315. data/spec/models/field_override_spec.rb +408 -0
  316. data/spec/models/field_presence_condition_spec.rb +42 -0
  317. data/spec/models/field_presence_operator_spec.rb +30 -0
  318. data/spec/models/field_range_condition_spec.rb +54 -0
  319. data/spec/models/field_reimport_state_spec.rb +30 -0
  320. data/spec/models/field_setup_logic_spec.rb +30 -0
  321. data/spec/models/field_setup_naming_spec.rb +30 -0
  322. data/spec/models/field_setup_source_spec.rb +30 -0
  323. data/spec/models/folder_list_spec.rb +42 -0
  324. data/spec/models/folder_spec.rb +16 -4
  325. data/spec/models/generated_file_spec.rb +78 -0
  326. data/spec/models/generated_file_state_spec.rb +30 -0
  327. data/spec/models/html_engine_options_input_spec.rb +90 -0
  328. data/spec/models/html_engine_options_spec.rb +90 -0
  329. data/spec/models/image_gravity_spec.rb +30 -0
  330. data/spec/models/image_scale_type_spec.rb +30 -0
  331. data/spec/models/model_code_language_spec.rb +30 -0
  332. data/spec/models/move_folder_request_spec.rb +36 -0
  333. data/spec/models/move_template_request_spec.rb +36 -0
  334. data/spec/models/number_condition_type_spec.rb +30 -0
  335. data/spec/models/page_format_spec.rb +30 -0
  336. data/spec/models/{publish_version_data_spec.rb → publish_template_version_request_spec.rb} +11 -11
  337. data/spec/models/{rename_folder_data_spec.rb → rename_folder_request_spec.rb} +9 -9
  338. data/spec/models/restore_template_version_request_spec.rb +36 -0
  339. data/spec/models/shape_type_spec.rb +30 -0
  340. data/spec/models/signature_request_auth_second_factor_type_spec.rb +30 -0
  341. data/spec/models/signature_request_auth_type_spec.rb +30 -0
  342. data/spec/models/{submission_data_request_event_spec.rb → signature_request_event_spec.rb} +16 -18
  343. data/spec/models/signature_request_event_type_spec.rb +30 -0
  344. data/spec/models/{create_submission_data_request_data_spec.rb → signature_request_input_spec.rb} +28 -30
  345. data/spec/models/signature_request_message_type_spec.rb +30 -0
  346. data/spec/models/{submission_data_request_show_spec.rb → signature_request_spec.rb} +31 -31
  347. data/spec/models/signature_request_state_spec.rb +30 -0
  348. data/spec/models/signature_request_token_spec.rb +72 -0
  349. data/spec/models/signature_request_token_type_spec.rb +30 -0
  350. data/spec/models/string_condition_type_spec.rb +30 -0
  351. data/spec/models/submission_action_spec.rb +4 -22
  352. data/spec/models/submission_action_state_spec.rb +30 -0
  353. data/spec/models/submission_action_type_spec.rb +30 -0
  354. data/spec/models/submission_batch_spec.rb +27 -13
  355. data/spec/models/submission_batch_state_spec.rb +30 -0
  356. data/spec/models/submission_files_spec.rb +48 -0
  357. data/spec/models/submission_input_spec.rb +96 -0
  358. data/spec/models/submission_list_spec.rb +42 -0
  359. data/spec/models/submission_source_pdf_spec.rb +42 -0
  360. data/spec/models/submission_source_spec.rb +30 -0
  361. data/spec/models/submission_spec.rb +26 -56
  362. data/spec/models/submission_state_spec.rb +30 -0
  363. data/spec/models/template_actor_spec.rb +60 -0
  364. data/spec/models/template_actor_type_spec.rb +30 -0
  365. data/spec/models/{submission_data_request_spec.rb → template_defaults_input_spec.rb} +29 -53
  366. data/spec/models/template_defaults_spec.rb +150 -0
  367. data/spec/models/{json_schema_spec.rb → template_document_spec.rb} +21 -21
  368. data/spec/models/template_document_state_spec.rb +30 -0
  369. data/spec/models/template_field_dependency_action_spec.rb +30 -0
  370. data/spec/models/template_field_dependency_condition_input_spec.rb +44 -0
  371. data/spec/models/template_field_dependency_condition_spec.rb +54 -0
  372. data/spec/models/template_field_dependency_input_spec.rb +60 -0
  373. data/spec/models/template_field_dependency_match_spec.rb +30 -0
  374. data/spec/models/template_field_dependency_operator_spec.rb +30 -0
  375. data/spec/models/template_field_dependency_spec.rb +60 -0
  376. data/spec/models/template_field_logic_status_spec.rb +30 -0
  377. data/spec/models/template_form_mode_spec.rb +30 -0
  378. data/spec/models/{template_model_code_response_spec.rb → template_model_code_spec.rb} +9 -13
  379. data/spec/models/template_page_ai_error_spec.rb +30 -0
  380. data/spec/models/template_page_ai_naming_status_spec.rb +30 -0
  381. data/spec/models/template_page_fields_status_spec.rb +30 -0
  382. data/spec/models/template_page_image_status_spec.rb +30 -0
  383. data/spec/models/template_page_processing_status_spec.rb +60 -0
  384. data/spec/models/template_source_pdf_spec.rb +54 -0
  385. data/spec/models/template_spec.rb +40 -154
  386. data/spec/models/template_summary_list_spec.rb +42 -0
  387. data/spec/models/template_summary_spec.rb +252 -0
  388. data/spec/models/template_type_spec.rb +30 -0
  389. data/spec/models/template_version_spec.rb +54 -0
  390. data/spec/models/template_version_type_spec.rb +30 -0
  391. data/spec/models/text_alignment_spec.rb +30 -0
  392. data/spec/models/text_overflow_spec.rb +30 -0
  393. data/spec/models/text_vertical_alignment_spec.rb +30 -0
  394. data/spec/models/typeface_spec.rb +30 -0
  395. data/spec/models/{submission_batch_with_submissions_spec.rb → update_signature_request_request_spec.rb} +18 -22
  396. data/spec/models/update_template_document_request_spec.rb +48 -0
  397. data/spec/models/{submission_preview_spec.rb → update_template_request_spec.rb} +81 -41
  398. data/spec/models/update_webhook_request_spec.rb +96 -0
  399. data/spec/models/upload_method_spec.rb +30 -0
  400. data/spec/models/{upload_presign_response_spec.rb → upload_presign_spec.rb} +13 -17
  401. data/spec/models/url_source_pdf_spec.rb +42 -0
  402. data/spec/models/webhook_event_type_spec.rb +30 -0
  403. data/spec/models/webhook_list_spec.rb +42 -0
  404. data/spec/models/webhook_mode_spec.rb +30 -0
  405. data/spec/models/webhook_spec.rb +4 -8
  406. data/spec/spec_helper.rb +3 -3
  407. metadata +485 -202
  408. data/docs/AddFieldsData.md +0 -18
  409. data/docs/BatchGeneratePdfs201Response.md +0 -28
  410. data/docs/CombinePdfsData.md +0 -28
  411. data/docs/CombinedSubmission.md +0 -44
  412. data/docs/CombinedSubmissionAction.md +0 -30
  413. data/docs/CopyTemplateOptions.md +0 -22
  414. data/docs/CreateCombinedSubmissionResponse.md +0 -26
  415. data/docs/CreateCustomFileData.md +0 -18
  416. data/docs/CreateCustomFileResponse.md +0 -24
  417. data/docs/CreateHtmlTemplate.md +0 -18
  418. data/docs/CreatePdfSubmissionData.md +0 -34
  419. data/docs/CreatePdfTemplate.md +0 -18
  420. data/docs/CreateSubmissionDataRequestData.md +0 -44
  421. data/docs/CreateSubmissionDataRequestEventRequest.md +0 -24
  422. data/docs/CreateSubmissionDataRequestEventResponse.md +0 -24
  423. data/docs/CreateSubmissionDataRequestResponse.md +0 -24
  424. data/docs/CreateSubmissionDataRequestTokenResponse.md +0 -24
  425. data/docs/CreateSubmissionResponse.md +0 -26
  426. data/docs/ErrorOrMultipleErrorsResponse.md +0 -22
  427. data/docs/ForbiddenErrorResponse.md +0 -22
  428. data/docs/JsonSchema.md +0 -40
  429. data/docs/ListSubmissionsResponse.md +0 -22
  430. data/docs/MoveFolderData.md +0 -18
  431. data/docs/MoveTemplateData.md +0 -20
  432. data/docs/MultipleErrorsResponse.md +0 -20
  433. data/docs/PublishVersionData.md +0 -20
  434. data/docs/RestoreVersionData.md +0 -18
  435. data/docs/Submission422Response.md +0 -24
  436. data/docs/SubmissionBatchData.md +0 -26
  437. data/docs/SubmissionBatchWithSubmissions.md +0 -34
  438. data/docs/SubmissionDataRequest.md +0 -60
  439. data/docs/SubmissionDataRequestEvent.md +0 -30
  440. data/docs/SubmissionDataRequestShow.md +0 -62
  441. data/docs/SubmissionDataRequestToken.md +0 -24
  442. data/docs/SubmissionPreview.md +0 -64
  443. data/docs/SuccessErrorResponse.md +0 -20
  444. data/docs/SuccessMultipleErrorsResponse.md +0 -20
  445. data/docs/TemplateAddFieldsResponse.md +0 -22
  446. data/docs/TemplateDeleteResponse.md +0 -24
  447. data/docs/TemplateModelCodeResponse.md +0 -22
  448. data/docs/TemplatePreview.md +0 -116
  449. data/docs/TemplatePublishVersionResponse.md +0 -22
  450. data/docs/UpdateHtmlTemplate.md +0 -18
  451. data/docs/UpdatePdfTemplate.md +0 -18
  452. data/docs/UpdateSubmissionDataRequestData.md +0 -42
  453. data/docs/UploadPresignResponse.md +0 -24
  454. data/lib/docspring/models/batch_generate_pdfs201_response.rb +0 -352
  455. data/lib/docspring/models/combined_submission_action.rb +0 -384
  456. data/lib/docspring/models/create_combined_submission_response.rb +0 -324
  457. data/lib/docspring/models/create_custom_file_response.rb +0 -314
  458. data/lib/docspring/models/create_html_template.rb +0 -243
  459. data/lib/docspring/models/create_submission_data_request_event_response.rb +0 -314
  460. data/lib/docspring/models/create_submission_data_request_response.rb +0 -314
  461. data/lib/docspring/models/create_submission_data_request_token_response.rb +0 -314
  462. data/lib/docspring/models/create_submission_response.rb +0 -324
  463. data/lib/docspring/models/error_or_multiple_errors_response.rb +0 -290
  464. data/lib/docspring/models/forbidden_error_response.rb +0 -323
  465. data/lib/docspring/models/json_schema.rb +0 -329
  466. data/lib/docspring/models/list_submissions_response.rb +0 -283
  467. data/lib/docspring/models/multiple_errors_response.rb +0 -296
  468. data/lib/docspring/models/submission422_response.rb +0 -299
  469. data/lib/docspring/models/submission_batch_with_submissions.rb +0 -433
  470. data/lib/docspring/models/submission_data_request.rb +0 -570
  471. data/lib/docspring/models/submission_data_request_token.rb +0 -279
  472. data/lib/docspring/models/submission_preview.rb +0 -637
  473. data/lib/docspring/models/success_multiple_errors_response.rb +0 -279
  474. data/lib/docspring/models/template_add_fields_response.rb +0 -290
  475. data/lib/docspring/models/template_delete_response.rb +0 -300
  476. data/lib/docspring/models/template_publish_version_response.rb +0 -305
  477. data/lib/docspring/models/update_html_template.rb +0 -243
  478. data/lib/docspring/models/update_pdf_template.rb +0 -243
  479. data/spec/models/add_fields_data_spec.rb +0 -36
  480. data/spec/models/combined_submission_action_spec.rb +0 -84
  481. data/spec/models/create_combined_submission_response_spec.rb +0 -64
  482. data/spec/models/create_custom_file_response_spec.rb +0 -58
  483. data/spec/models/create_folder_data_spec.rb +0 -36
  484. data/spec/models/create_html_template_spec.rb +0 -36
  485. data/spec/models/create_pdf_template_spec.rb +0 -36
  486. data/spec/models/create_submission_data_request_event_request_spec.rb +0 -62
  487. data/spec/models/create_submission_data_request_event_response_spec.rb +0 -58
  488. data/spec/models/create_submission_data_request_response_spec.rb +0 -58
  489. data/spec/models/create_submission_data_request_token_response_spec.rb +0 -58
  490. data/spec/models/create_webhook_data_spec.rb +0 -36
  491. data/spec/models/error_or_multiple_errors_response_spec.rb +0 -52
  492. data/spec/models/forbidden_error_response_spec.rb +0 -56
  493. data/spec/models/move_folder_data_spec.rb +0 -36
  494. data/spec/models/multiple_errors_response_spec.rb +0 -46
  495. data/spec/models/restore_version_data_spec.rb +0 -36
  496. data/spec/models/submission422_response_spec.rb +0 -58
  497. data/spec/models/success_error_response_spec.rb +0 -46
  498. data/spec/models/success_multiple_errors_response_spec.rb +0 -46
  499. data/spec/models/template_add_fields_response_spec.rb +0 -52
  500. data/spec/models/template_delete_response_spec.rb +0 -58
  501. data/spec/models/template_publish_version_response_spec.rb +0 -52
  502. data/spec/models/update_html_template_spec.rb +0 -36
  503. data/spec/models/update_pdf_template_spec.rb +0 -36
  504. data/spec/models/update_submission_data_request_data_spec.rb +0 -116
  505. data/spec/models/update_webhook_data_spec.rb +0 -36
data/lib/docspring/request_schemas.json ADDED
@@ -0,0 +1,3187 @@
1
+ {
2
+ "operations": {
3
+ "copyTemplate": {
4
+ "body": {
5
+ "mediaType": "application/json",
6
+ "required": false,
7
+ "schema": {
8
+ "type": "object",
9
+ "properties": {
10
+ "name": {
11
+ "type": "string",
12
+ "minLength": 1,
13
+ "maxLength": 255
14
+ },
15
+ "parent_folder_id": {
16
+ "type": [
17
+ "string",
18
+ "null"
19
+ ],
20
+ "minLength": 1
21
+ },
22
+ "version": {
23
+ "type": "string",
24
+ "pattern": "^\\d+(\\.\\d+(\\.\\d+)?)?$",
25
+ "x-pattern-message": "must be a published version like 1.2.3 or 1"
26
+ }
27
+ },
28
+ "additionalProperties": false
29
+ }
30
+ }
31
+ },
32
+ "createCombinedPdf": {
33
+ "query": {
34
+ "wait": {
35
+ "required": false,
36
+ "schema": {
37
+ "type": "boolean"
38
+ }
39
+ }
40
+ },
41
+ "body": {
42
+ "mediaType": "application/json",
43
+ "required": true,
44
+ "schema": {
45
+ "type": "object",
46
+ "properties": {
47
+ "source_pdfs": {
48
+ "type": "array",
49
+ "minItems": 1,
50
+ "items": {
51
+ "oneOf": [
52
+ {
53
+ "$ref": "#/components/schemas/SubmissionSourcePdf"
54
+ },
55
+ {
56
+ "$ref": "#/components/schemas/CombinedPdfSourcePdf"
57
+ },
58
+ {
59
+ "$ref": "#/components/schemas/TemplateSourcePdf"
60
+ },
61
+ {
62
+ "$ref": "#/components/schemas/CustomFileSourcePdf"
63
+ },
64
+ {
65
+ "$ref": "#/components/schemas/UrlSourcePdf"
66
+ }
67
+ ],
68
+ "discriminator": {
69
+ "propertyName": "type",
70
+ "mapping": [
71
+ [
72
+ "submission",
73
+ "#/components/schemas/SubmissionSourcePdf"
74
+ ],
75
+ [
76
+ "combined_pdf",
77
+ "#/components/schemas/CombinedPdfSourcePdf"
78
+ ],
79
+ [
80
+ "template",
81
+ "#/components/schemas/TemplateSourcePdf"
82
+ ],
83
+ [
84
+ "custom_file",
85
+ "#/components/schemas/CustomFileSourcePdf"
86
+ ],
87
+ [
88
+ "url",
89
+ "#/components/schemas/UrlSourcePdf"
90
+ ]
91
+ ]
92
+ }
93
+ }
94
+ },
95
+ "metadata": {
96
+ "type": "object"
97
+ },
98
+ "password": {
99
+ "type": "string",
100
+ "minLength": 1
101
+ },
102
+ "delete_custom_files": {
103
+ "type": "boolean"
104
+ },
105
+ "expires_in": {
106
+ "type": "integer",
107
+ "minimum": 1,
108
+ "maximum": 315360000
109
+ }
110
+ },
111
+ "required": [
112
+ "source_pdfs"
113
+ ],
114
+ "additionalProperties": false
115
+ }
116
+ }
117
+ },
118
+ "createCustomFileFromUpload": {
119
+ "body": {
120
+ "mediaType": "application/json",
121
+ "required": true,
122
+ "schema": {
123
+ "type": "object",
124
+ "required": [
125
+ "cache_id"
126
+ ],
127
+ "properties": {
128
+ "cache_id": {
129
+ "type": "string",
130
+ "minLength": 1,
131
+ "maxLength": 255
132
+ }
133
+ },
134
+ "additionalProperties": false
135
+ }
136
+ }
137
+ },
138
+ "createFolder": {
139
+ "body": {
140
+ "mediaType": "application/json",
141
+ "required": true,
142
+ "schema": {
143
+ "type": "object",
144
+ "properties": {
145
+ "name": {
146
+ "type": "string",
147
+ "minLength": 1,
148
+ "maxLength": 255,
149
+ "pattern": "^[^/]*$",
150
+ "x-pattern-message": "can't contain a slash (/)"
151
+ },
152
+ "parent_folder_id": {
153
+ "type": [
154
+ "string",
155
+ "null"
156
+ ],
157
+ "minLength": 1
158
+ }
159
+ },
160
+ "required": [
161
+ "name"
162
+ ],
163
+ "additionalProperties": false
164
+ }
165
+ }
166
+ },
167
+ "createSignatureRequestEvent": {
168
+ "body": {
169
+ "mediaType": "application/json",
170
+ "required": true,
171
+ "schema": {
172
+ "type": "object",
173
+ "properties": {
174
+ "event_type": {
175
+ "type": "string",
176
+ "enum": [
177
+ "send_request"
178
+ ]
179
+ },
180
+ "message_type": {
181
+ "type": [
182
+ "string",
183
+ "null"
184
+ ],
185
+ "enum": [
186
+ "email",
187
+ "sms",
188
+ "fax",
189
+ "mail",
190
+ "slack",
191
+ "msteams",
192
+ "discord",
193
+ "telegram",
194
+ "whatsapp",
195
+ null
196
+ ]
197
+ },
198
+ "message_recipient": {
199
+ "type": [
200
+ "string",
201
+ "null"
202
+ ],
203
+ "maxLength": 255
204
+ },
205
+ "occurred_at": {
206
+ "type": "string",
207
+ "format": "date-time"
208
+ }
209
+ },
210
+ "required": [
211
+ "event_type"
212
+ ],
213
+ "additionalProperties": false
214
+ }
215
+ }
216
+ },
217
+ "createSignatureRequestToken": {
218
+ "body": {
219
+ "mediaType": "application/json",
220
+ "required": false,
221
+ "schema": {
222
+ "type": "object",
223
+ "properties": {
224
+ "type": {
225
+ "type": "string",
226
+ "enum": [
227
+ "api",
228
+ "email"
229
+ ]
230
+ }
231
+ },
232
+ "additionalProperties": false
233
+ }
234
+ }
235
+ },
236
+ "createSubmission": {
237
+ "query": {
238
+ "version": {
239
+ "required": false,
240
+ "schema": {
241
+ "type": "string",
242
+ "pattern": "^(\\d+(\\.\\d+(\\.\\d+)?)?|latest|draft)$",
243
+ "x-pattern-message": "must be a version like 1.2.3 or 1, or latest or draft"
244
+ }
245
+ },
246
+ "wait": {
247
+ "required": false,
248
+ "schema": {
249
+ "type": "boolean"
250
+ }
251
+ }
252
+ },
253
+ "body": {
254
+ "mediaType": "application/json",
255
+ "required": true,
256
+ "schema": {
257
+ "type": "object",
258
+ "properties": {
259
+ "test": {
260
+ "type": "boolean"
261
+ },
262
+ "editable": {
263
+ "type": "boolean"
264
+ },
265
+ "data": {
266
+ "type": "object"
267
+ },
268
+ "metadata": {
269
+ "type": "object"
270
+ },
271
+ "password": {
272
+ "type": "string",
273
+ "minLength": 1
274
+ },
275
+ "expires_in": {
276
+ "type": "integer",
277
+ "minimum": 1,
278
+ "maximum": 315360000
279
+ },
280
+ "field_overrides": {
281
+ "type": "object",
282
+ "additionalProperties": {
283
+ "$ref": "#/components/schemas/FieldOverride"
284
+ }
285
+ },
286
+ "html": {
287
+ "type": "string"
288
+ },
289
+ "css": {
290
+ "type": "string"
291
+ },
292
+ "signature_requests": {
293
+ "type": "array",
294
+ "maxItems": 100,
295
+ "items": {
296
+ "type": "object",
297
+ "properties": {
298
+ "name": {
299
+ "type": [
300
+ "string",
301
+ "null"
302
+ ],
303
+ "maxLength": 255
304
+ },
305
+ "email": {
306
+ "type": [
307
+ "string",
308
+ "null"
309
+ ],
310
+ "maxLength": 255
311
+ },
312
+ "fields": {
313
+ "type": "array",
314
+ "minItems": 1,
315
+ "uniqueItems": true,
316
+ "items": {
317
+ "type": "string",
318
+ "minLength": 1
319
+ }
320
+ },
321
+ "metadata": {
322
+ "type": "object"
323
+ },
324
+ "role": {
325
+ "type": "string",
326
+ "minLength": 1
327
+ },
328
+ "auth_type": {
329
+ "type": "string",
330
+ "enum": [
331
+ "password",
332
+ "oauth",
333
+ "email_link",
334
+ "phone_number",
335
+ "ldap",
336
+ "saml"
337
+ ]
338
+ },
339
+ "auth_second_factor_type": {
340
+ "type": "string",
341
+ "enum": [
342
+ "none",
343
+ "phone_number",
344
+ "totp",
345
+ "mobile_push",
346
+ "security_key",
347
+ "fingerprint"
348
+ ]
349
+ },
350
+ "auth_provider": {
351
+ "type": [
352
+ "string",
353
+ "null"
354
+ ],
355
+ "maxLength": 255
356
+ },
357
+ "auth_session_started_at": {
358
+ "type": [
359
+ "string",
360
+ "null"
361
+ ],
362
+ "format": "date-time"
363
+ },
364
+ "auth_session_id_hash": {
365
+ "type": [
366
+ "string",
367
+ "null"
368
+ ]
369
+ },
370
+ "auth_user_id_hash": {
371
+ "type": [
372
+ "string",
373
+ "null"
374
+ ]
375
+ },
376
+ "auth_username_hash": {
377
+ "type": [
378
+ "string",
379
+ "null"
380
+ ]
381
+ },
382
+ "auth_phone_number_hash": {
383
+ "type": [
384
+ "string",
385
+ "null"
386
+ ]
387
+ },
388
+ "ignore_unknown_fields": {
389
+ "type": "boolean"
390
+ },
391
+ "prefilled_values_editable": {
392
+ "type": "boolean"
393
+ }
394
+ },
395
+ "required": [
396
+ "fields",
397
+ "auth_type"
398
+ ],
399
+ "additionalProperties": false
400
+ }
401
+ }
402
+ },
403
+ "additionalProperties": false
404
+ }
405
+ }
406
+ },
407
+ "createSubmissionBatch": {
408
+ "query": {
409
+ "wait": {
410
+ "required": false,
411
+ "schema": {
412
+ "type": "boolean"
413
+ }
414
+ }
415
+ },
416
+ "body": {
417
+ "mediaType": "application/json",
418
+ "required": true,
419
+ "schema": {
420
+ "type": "object",
421
+ "properties": {
422
+ "metadata": {
423
+ "type": "object"
424
+ },
425
+ "template_id": {
426
+ "type": "string"
427
+ },
428
+ "template_version": {
429
+ "type": "string",
430
+ "pattern": "^(\\d+(\\.\\d+(\\.\\d+)?)?|latest|draft)$",
431
+ "x-pattern-message": "must be a version like 1.2.3 or 1, or latest or draft"
432
+ },
433
+ "test": {
434
+ "type": "boolean"
435
+ },
436
+ "submissions": {
437
+ "type": "array",
438
+ "minItems": 1,
439
+ "maxItems": 50,
440
+ "items": {
441
+ "type": "object",
442
+ "properties": {
443
+ "test": {
444
+ "type": "boolean"
445
+ },
446
+ "editable": {
447
+ "type": "boolean"
448
+ },
449
+ "data": {
450
+ "type": "object"
451
+ },
452
+ "metadata": {
453
+ "type": "object"
454
+ },
455
+ "password": {
456
+ "type": "string",
457
+ "minLength": 1
458
+ },
459
+ "expires_in": {
460
+ "type": "integer",
461
+ "minimum": 1,
462
+ "maximum": 315360000
463
+ },
464
+ "field_overrides": {
465
+ "type": "object",
466
+ "additionalProperties": {
467
+ "$ref": "#/components/schemas/FieldOverride"
468
+ }
469
+ },
470
+ "html": {
471
+ "type": "string"
472
+ },
473
+ "css": {
474
+ "type": "string"
475
+ },
476
+ "template_id": {
477
+ "type": "string"
478
+ },
479
+ "template_version": {
480
+ "type": "string",
481
+ "pattern": "^(\\d+(\\.\\d+(\\.\\d+)?)?|latest|draft)$",
482
+ "x-pattern-message": "must be a version like 1.2.3 or 1, or latest or draft"
483
+ }
484
+ },
485
+ "additionalProperties": false
486
+ }
487
+ }
488
+ },
489
+ "required": [
490
+ "submissions"
491
+ ],
492
+ "additionalProperties": false
493
+ }
494
+ }
495
+ },
496
+ "createTemplate": {
497
+ "query": {
498
+ "wait": {
499
+ "required": false,
500
+ "schema": {
501
+ "type": "boolean"
502
+ }
503
+ }
504
+ },
505
+ "body": {
506
+ "mediaType": "application/json",
507
+ "required": true,
508
+ "schema": {
509
+ "type": "object",
510
+ "properties": {
511
+ "name": {
512
+ "type": "string",
513
+ "minLength": 1,
514
+ "maxLength": 255
515
+ },
516
+ "description": {
517
+ "type": [
518
+ "string",
519
+ "null"
520
+ ]
521
+ },
522
+ "template_type": {
523
+ "type": "string",
524
+ "enum": [
525
+ "pdf",
526
+ "html"
527
+ ]
528
+ },
529
+ "parent_folder_id": {
530
+ "type": [
531
+ "string",
532
+ "null"
533
+ ],
534
+ "minLength": 1
535
+ },
536
+ "locked": {
537
+ "type": "boolean"
538
+ },
539
+ "add_signature_request_submission_id_footers": {
540
+ "type": "boolean"
541
+ },
542
+ "ai_field_naming_language": {
543
+ "type": "string",
544
+ "enum": [
545
+ "auto",
546
+ "english",
547
+ "form_language"
548
+ ]
549
+ },
550
+ "allow_additional_properties": {
551
+ "type": "boolean"
552
+ },
553
+ "allow_skipping_optional_fields": {
554
+ "type": "boolean"
555
+ },
556
+ "default_form_mode": {
557
+ "type": "string",
558
+ "enum": [
559
+ "web",
560
+ "visual",
561
+ "dual"
562
+ ]
563
+ },
564
+ "editable_submissions": {
565
+ "type": "boolean"
566
+ },
567
+ "embed_domains": {
568
+ "type": "array",
569
+ "maxItems": 100,
570
+ "items": {
571
+ "type": "string",
572
+ "minLength": 1,
573
+ "maxLength": 255
574
+ }
575
+ },
576
+ "embed_edit_allow_settings": {
577
+ "type": "boolean"
578
+ },
579
+ "embed_edit_allow_versioning": {
580
+ "type": "boolean"
581
+ },
582
+ "embed_edit_allow_document_replacement": {
583
+ "type": "boolean"
584
+ },
585
+ "encrypt_pdfs": {
586
+ "type": "boolean"
587
+ },
588
+ "encrypt_pdfs_password": {
589
+ "type": [
590
+ "string",
591
+ "null"
592
+ ]
593
+ },
594
+ "expire_submissions": {
595
+ "type": "boolean"
596
+ },
597
+ "expire_after": {
598
+ "type": "integer",
599
+ "minimum": 1,
600
+ "maximum": 5256000
601
+ },
602
+ "expiration_interval": {
603
+ "type": "string",
604
+ "enum": [
605
+ "minutes",
606
+ "hours",
607
+ "days"
608
+ ]
609
+ },
610
+ "merge_audit_trail_pdf": {
611
+ "type": "boolean"
612
+ },
613
+ "parse_dates_using_template_date_format": {
614
+ "type": "boolean"
615
+ },
616
+ "public_submissions": {
617
+ "type": "boolean"
618
+ },
619
+ "public_web_form": {
620
+ "type": "boolean"
621
+ },
622
+ "redirect_url": {
623
+ "type": [
624
+ "string",
625
+ "null"
626
+ ],
627
+ "format": "uri"
628
+ },
629
+ "slack_webhook_url": {
630
+ "type": [
631
+ "string",
632
+ "null"
633
+ ],
634
+ "format": "uri"
635
+ },
636
+ "defaults": {
637
+ "type": "object",
638
+ "properties": {
639
+ "typeface": {
640
+ "type": [
641
+ "string",
642
+ "null"
643
+ ],
644
+ "enum": [
645
+ "Inconsolata",
646
+ "Roboto Mono",
647
+ "Ubuntu Mono",
648
+ "Menlo",
649
+ "Courier",
650
+ "Helvetica",
651
+ "Arial",
652
+ "Calibri",
653
+ "Open Sans",
654
+ "Roboto",
655
+ "Lato",
656
+ "Poppins",
657
+ "Public Sans",
658
+ "Questrial",
659
+ "Times New Roman",
660
+ "Dancing Script",
661
+ "Lovtony Script",
662
+ null
663
+ ]
664
+ },
665
+ "font_size": {
666
+ "type": [
667
+ "integer",
668
+ "null"
669
+ ],
670
+ "minimum": 1
671
+ },
672
+ "character_spacing": {
673
+ "type": [
674
+ "number",
675
+ "null"
676
+ ],
677
+ "minimum": 0,
678
+ "maximum": 50
679
+ },
680
+ "color": {
681
+ "type": [
682
+ "string",
683
+ "null"
684
+ ],
685
+ "pattern": "^[A-Fa-f0-9]{6}$",
686
+ "x-pattern-message": "must be a 6-digit hex color without #, like FF0000"
687
+ },
688
+ "background_color": {
689
+ "type": [
690
+ "string",
691
+ "null"
692
+ ],
693
+ "pattern": "^[A-Fa-f0-9]{6}$",
694
+ "x-pattern-message": "must be a 6-digit hex color without #, like FF0000"
695
+ },
696
+ "bold": {
697
+ "type": "boolean"
698
+ },
699
+ "uppercase": {
700
+ "type": "boolean"
701
+ },
702
+ "alignment": {
703
+ "type": "string",
704
+ "enum": [
705
+ "left",
706
+ "center",
707
+ "right",
708
+ "justify"
709
+ ]
710
+ },
711
+ "opacity": {
712
+ "type": "number",
713
+ "minimum": 0,
714
+ "maximum": 1
715
+ },
716
+ "date_format": {
717
+ "type": [
718
+ "string",
719
+ "null"
720
+ ]
721
+ },
722
+ "date_time_format": {
723
+ "type": [
724
+ "string",
725
+ "null"
726
+ ]
727
+ },
728
+ "check_color": {
729
+ "type": [
730
+ "string",
731
+ "null"
732
+ ],
733
+ "pattern": "^[A-Fa-f0-9]{6}$",
734
+ "x-pattern-message": "must be a 6-digit hex color without #, like FF0000"
735
+ },
736
+ "check_character": {
737
+ "type": [
738
+ "string",
739
+ "null"
740
+ ],
741
+ "enum": [
742
+ "✓",
743
+ "✔",
744
+ "✖",
745
+ "✗",
746
+ "✘",
747
+ null
748
+ ]
749
+ },
750
+ "check_background_color": {
751
+ "type": [
752
+ "string",
753
+ "null"
754
+ ],
755
+ "pattern": "^[A-Fa-f0-9]{6}$",
756
+ "x-pattern-message": "must be a 6-digit hex color without #, like FF0000"
757
+ },
758
+ "required_field_background_color": {
759
+ "type": [
760
+ "string",
761
+ "null"
762
+ ],
763
+ "pattern": "^[A-Fa-f0-9]{6}$",
764
+ "x-pattern-message": "must be a 6-digit hex color without #, like FF0000"
765
+ },
766
+ "true_text": {
767
+ "type": [
768
+ "string",
769
+ "null"
770
+ ]
771
+ },
772
+ "false_text": {
773
+ "type": [
774
+ "string",
775
+ "null"
776
+ ]
777
+ },
778
+ "shape_fill_color": {
779
+ "type": [
780
+ "string",
781
+ "null"
782
+ ],
783
+ "pattern": "^[A-Fa-f0-9]{6}$",
784
+ "x-pattern-message": "must be a 6-digit hex color without #, like FF0000"
785
+ },
786
+ "shape_border_color": {
787
+ "type": [
788
+ "string",
789
+ "null"
790
+ ],
791
+ "pattern": "^[A-Fa-f0-9]{6}$",
792
+ "x-pattern-message": "must be a 6-digit hex color without #, like FF0000"
793
+ },
794
+ "shape_border_width": {
795
+ "type": "integer",
796
+ "minimum": 1
797
+ }
798
+ },
799
+ "additionalProperties": false
800
+ },
801
+ "field_dependencies": {
802
+ "type": "array",
803
+ "items": {
804
+ "type": "object",
805
+ "properties": {
806
+ "action": {
807
+ "type": "string",
808
+ "enum": [
809
+ "require_and_show",
810
+ "show",
811
+ "require"
812
+ ]
813
+ },
814
+ "match": {
815
+ "type": "string",
816
+ "enum": [
817
+ "all",
818
+ "any"
819
+ ]
820
+ },
821
+ "conditions": {
822
+ "type": "array",
823
+ "items": {
824
+ "oneOf": [
825
+ {
826
+ "$ref": "#/components/schemas/FieldPresenceCondition"
827
+ },
828
+ {
829
+ "$ref": "#/components/schemas/FieldEqualsCondition"
830
+ },
831
+ {
832
+ "$ref": "#/components/schemas/FieldInCondition"
833
+ },
834
+ {
835
+ "$ref": "#/components/schemas/FieldComparisonCondition"
836
+ },
837
+ {
838
+ "$ref": "#/components/schemas/FieldRangeCondition"
839
+ }
840
+ ],
841
+ "discriminator": {
842
+ "propertyName": "operator",
843
+ "mapping": [
844
+ [
845
+ "present",
846
+ "#/components/schemas/FieldPresenceCondition"
847
+ ],
848
+ [
849
+ "blank",
850
+ "#/components/schemas/FieldPresenceCondition"
851
+ ],
852
+ [
853
+ "equals",
854
+ "#/components/schemas/FieldEqualsCondition"
855
+ ],
856
+ [
857
+ "not_equals",
858
+ "#/components/schemas/FieldEqualsCondition"
859
+ ],
860
+ [
861
+ "in",
862
+ "#/components/schemas/FieldInCondition"
863
+ ],
864
+ [
865
+ "gt",
866
+ "#/components/schemas/FieldComparisonCondition"
867
+ ],
868
+ [
869
+ "gte",
870
+ "#/components/schemas/FieldComparisonCondition"
871
+ ],
872
+ [
873
+ "lt",
874
+ "#/components/schemas/FieldComparisonCondition"
875
+ ],
876
+ [
877
+ "lte",
878
+ "#/components/schemas/FieldComparisonCondition"
879
+ ],
880
+ [
881
+ "range",
882
+ "#/components/schemas/FieldRangeCondition"
883
+ ]
884
+ ]
885
+ }
886
+ }
887
+ },
888
+ "targets": {
889
+ "type": "array",
890
+ "minItems": 1,
891
+ "items": {
892
+ "type": "string",
893
+ "minLength": 1
894
+ }
895
+ },
896
+ "group": {
897
+ "type": "string"
898
+ }
899
+ },
900
+ "required": [
901
+ "action",
902
+ "conditions",
903
+ "targets"
904
+ ],
905
+ "additionalProperties": false
906
+ }
907
+ },
908
+ "html": {
909
+ "type": [
910
+ "string",
911
+ "null"
912
+ ]
913
+ },
914
+ "scss": {
915
+ "type": [
916
+ "string",
917
+ "null"
918
+ ]
919
+ },
920
+ "header_html": {
921
+ "type": [
922
+ "string",
923
+ "null"
924
+ ]
925
+ },
926
+ "footer_html": {
927
+ "type": [
928
+ "string",
929
+ "null"
930
+ ]
931
+ },
932
+ "html_engine_options": {
933
+ "type": [
934
+ "object",
935
+ "null"
936
+ ],
937
+ "properties": {
938
+ "format": {
939
+ "type": "string",
940
+ "enum": [
941
+ "Letter",
942
+ "Legal",
943
+ "Tabloid",
944
+ "Ledger",
945
+ "CR80",
946
+ "A0",
947
+ "A1",
948
+ "A2",
949
+ "A3",
950
+ "A4",
951
+ "A5",
952
+ "A6",
953
+ "Custom"
954
+ ]
955
+ },
956
+ "width": {
957
+ "type": "string"
958
+ },
959
+ "height": {
960
+ "type": "string"
961
+ },
962
+ "scale": {
963
+ "type": "number",
964
+ "exclusiveMinimum": 0
965
+ },
966
+ "landscape": {
967
+ "type": "boolean"
968
+ },
969
+ "print_background": {
970
+ "type": "boolean"
971
+ },
972
+ "margin_top": {
973
+ "type": "string"
974
+ },
975
+ "margin_bottom": {
976
+ "type": "string"
977
+ },
978
+ "margin_left": {
979
+ "type": "string"
980
+ },
981
+ "margin_right": {
982
+ "type": "string"
983
+ }
984
+ },
985
+ "additionalProperties": false
986
+ },
987
+ "cache_id": {
988
+ "type": "string",
989
+ "minLength": 1,
990
+ "maxLength": 255
991
+ },
992
+ "filename": {
993
+ "type": "string",
994
+ "minLength": 1,
995
+ "maxLength": 255
996
+ },
997
+ "detect_fields": {
998
+ "type": "boolean"
999
+ },
1000
+ "field_source": {
1001
+ "type": "string",
1002
+ "enum": [
1003
+ "auto",
1004
+ "pdf_detection",
1005
+ "pdf_form_fields"
1006
+ ]
1007
+ },
1008
+ "field_naming": {
1009
+ "type": "string",
1010
+ "enum": [
1011
+ "ai",
1012
+ "preserve"
1013
+ ]
1014
+ },
1015
+ "field_logic": {
1016
+ "type": "string",
1017
+ "enum": [
1018
+ "ai",
1019
+ "none"
1020
+ ]
1021
+ }
1022
+ },
1023
+ "required": [
1024
+ "template_type"
1025
+ ],
1026
+ "additionalProperties": false
1027
+ }
1028
+ }
1029
+ },
1030
+ "createWebhook": {
1031
+ "body": {
1032
+ "mediaType": "application/json",
1033
+ "required": true,
1034
+ "schema": {
1035
+ "type": "object",
1036
+ "properties": {
1037
+ "name": {
1038
+ "type": [
1039
+ "string",
1040
+ "null"
1041
+ ],
1042
+ "maxLength": 255
1043
+ },
1044
+ "url": {
1045
+ "type": "string",
1046
+ "format": "uri"
1047
+ },
1048
+ "enabled": {
1049
+ "type": "boolean"
1050
+ },
1051
+ "event_types": {
1052
+ "type": "array",
1053
+ "minItems": 1,
1054
+ "uniqueItems": true,
1055
+ "items": {
1056
+ "type": "string",
1057
+ "enum": [
1058
+ "submission.processed",
1059
+ "submission.failed",
1060
+ "submission.declined",
1061
+ "signature_request.viewed",
1062
+ "signature_request.completed",
1063
+ "signature_request.declined",
1064
+ "combined_pdf.processed",
1065
+ "combined_pdf.failed",
1066
+ "submission_batch.processed",
1067
+ "submission_batch.failed",
1068
+ "submission.created",
1069
+ "submission.updated",
1070
+ "submission.expired",
1071
+ "signature_request.updated",
1072
+ "combined_pdf.expired",
1073
+ "template.created",
1074
+ "template.updated",
1075
+ "template.deleted",
1076
+ "webhook.created",
1077
+ "webhook.updated",
1078
+ "webhook.deleted",
1079
+ "custom_file.created",
1080
+ "folder.created",
1081
+ "folder.updated",
1082
+ "folder.deleted"
1083
+ ]
1084
+ }
1085
+ },
1086
+ "mode": {
1087
+ "type": [
1088
+ "string",
1089
+ "null"
1090
+ ],
1091
+ "enum": [
1092
+ "test",
1093
+ "live",
1094
+ null
1095
+ ]
1096
+ },
1097
+ "api_token_ids": {
1098
+ "type": "array",
1099
+ "uniqueItems": true,
1100
+ "items": {
1101
+ "type": "string"
1102
+ }
1103
+ },
1104
+ "template_ids": {
1105
+ "type": "array",
1106
+ "uniqueItems": true,
1107
+ "items": {
1108
+ "type": "string"
1109
+ }
1110
+ },
1111
+ "folder_ids": {
1112
+ "type": "array",
1113
+ "uniqueItems": true,
1114
+ "items": {
1115
+ "type": "string"
1116
+ }
1117
+ },
1118
+ "include_submission_data": {
1119
+ "type": "boolean"
1120
+ },
1121
+ "strip_fields": {
1122
+ "type": "array",
1123
+ "items": {
1124
+ "type": "string"
1125
+ }
1126
+ },
1127
+ "headers": {
1128
+ "type": "object",
1129
+ "additionalProperties": {
1130
+ "type": "string"
1131
+ }
1132
+ }
1133
+ },
1134
+ "required": [
1135
+ "url",
1136
+ "event_types"
1137
+ ],
1138
+ "additionalProperties": false
1139
+ }
1140
+ }
1141
+ },
1142
+ "deleteCustomFile": {},
1143
+ "deleteFolder": {},
1144
+ "deleteTemplate": {
1145
+ "query": {
1146
+ "version": {
1147
+ "required": false,
1148
+ "schema": {
1149
+ "type": "string",
1150
+ "pattern": "^(\\d+\\.\\d+\\.\\d+|draft)$",
1151
+ "x-pattern-message": "must be a full version like 1.2.3, or draft"
1152
+ }
1153
+ }
1154
+ }
1155
+ },
1156
+ "deleteWebhook": {},
1157
+ "expireCombinedPdf": {},
1158
+ "expireSubmission": {},
1159
+ "generateSubmissionPreview": {},
1160
+ "getCombinedPdf": {},
1161
+ "getCustomFile": {},
1162
+ "getFolder": {},
1163
+ "getPresignUrl": {},
1164
+ "getSignatureRequest": {},
1165
+ "getSubmission": {},
1166
+ "getSubmissionBatch": {
1167
+ "query": {
1168
+ "include_data": {
1169
+ "required": false,
1170
+ "schema": {
1171
+ "type": "boolean"
1172
+ }
1173
+ }
1174
+ }
1175
+ },
1176
+ "getTemplate": {
1177
+ "query": {
1178
+ "version": {
1179
+ "required": false,
1180
+ "schema": {
1181
+ "type": "string",
1182
+ "pattern": "^(\\d+(\\.\\d+(\\.\\d+)?)?|latest|draft)$",
1183
+ "x-pattern-message": "must be a version like 1.2.3 or 1, or latest or draft"
1184
+ }
1185
+ }
1186
+ }
1187
+ },
1188
+ "getTemplateModelCode": {
1189
+ "query": {
1190
+ "version": {
1191
+ "required": false,
1192
+ "schema": {
1193
+ "type": "string",
1194
+ "pattern": "^(\\d+(\\.\\d+(\\.\\d+)?)?|latest|draft)$",
1195
+ "x-pattern-message": "must be a version like 1.2.3 or 1, or latest or draft"
1196
+ }
1197
+ },
1198
+ "lang": {
1199
+ "required": true,
1200
+ "schema": {
1201
+ "type": "string",
1202
+ "enum": [
1203
+ "typescript",
1204
+ "javascript",
1205
+ "ruby",
1206
+ "python",
1207
+ "php",
1208
+ "java",
1209
+ "csharp",
1210
+ "elixir",
1211
+ "go"
1212
+ ]
1213
+ }
1214
+ }
1215
+ }
1216
+ },
1217
+ "getTemplateSchema": {
1218
+ "query": {
1219
+ "version": {
1220
+ "required": false,
1221
+ "schema": {
1222
+ "type": "string",
1223
+ "pattern": "^(\\d+(\\.\\d+(\\.\\d+)?)?|latest|draft)$",
1224
+ "x-pattern-message": "must be a version like 1.2.3 or 1, or latest or draft"
1225
+ }
1226
+ }
1227
+ }
1228
+ },
1229
+ "getWebhook": {},
1230
+ "listCombinedPdfs": {
1231
+ "query": {
1232
+ "limit": {
1233
+ "required": false,
1234
+ "schema": {
1235
+ "type": "integer",
1236
+ "minimum": 1,
1237
+ "maximum": 100
1238
+ }
1239
+ },
1240
+ "cursor": {
1241
+ "required": false,
1242
+ "schema": {
1243
+ "type": "string"
1244
+ }
1245
+ }
1246
+ }
1247
+ },
1248
+ "listCustomFiles": {
1249
+ "query": {
1250
+ "limit": {
1251
+ "required": false,
1252
+ "schema": {
1253
+ "type": "integer",
1254
+ "minimum": 1,
1255
+ "maximum": 100
1256
+ }
1257
+ },
1258
+ "cursor": {
1259
+ "required": false,
1260
+ "schema": {
1261
+ "type": "string"
1262
+ }
1263
+ }
1264
+ }
1265
+ },
1266
+ "listFolders": {
1267
+ "query": {
1268
+ "parent_folder_id": {
1269
+ "required": false,
1270
+ "schema": {
1271
+ "type": "string"
1272
+ }
1273
+ },
1274
+ "limit": {
1275
+ "required": false,
1276
+ "schema": {
1277
+ "type": "integer",
1278
+ "minimum": 1,
1279
+ "maximum": 100
1280
+ }
1281
+ },
1282
+ "cursor": {
1283
+ "required": false,
1284
+ "schema": {
1285
+ "type": "string"
1286
+ }
1287
+ }
1288
+ }
1289
+ },
1290
+ "listSubmissions": {
1291
+ "query": {
1292
+ "template_id": {
1293
+ "required": false,
1294
+ "schema": {
1295
+ "type": "string"
1296
+ }
1297
+ },
1298
+ "test": {
1299
+ "required": false,
1300
+ "schema": {
1301
+ "type": "boolean"
1302
+ }
1303
+ },
1304
+ "created_after": {
1305
+ "required": false,
1306
+ "schema": {
1307
+ "type": "string",
1308
+ "format": "date-time"
1309
+ }
1310
+ },
1311
+ "created_before": {
1312
+ "required": false,
1313
+ "schema": {
1314
+ "type": "string",
1315
+ "format": "date-time"
1316
+ }
1317
+ },
1318
+ "include_data": {
1319
+ "required": false,
1320
+ "schema": {
1321
+ "type": "boolean"
1322
+ }
1323
+ },
1324
+ "limit": {
1325
+ "required": false,
1326
+ "schema": {
1327
+ "type": "integer",
1328
+ "minimum": 1,
1329
+ "maximum": 100
1330
+ }
1331
+ },
1332
+ "cursor": {
1333
+ "required": false,
1334
+ "schema": {
1335
+ "type": "string"
1336
+ }
1337
+ }
1338
+ }
1339
+ },
1340
+ "listTemplateSubmissions": {
1341
+ "query": {
1342
+ "test": {
1343
+ "required": false,
1344
+ "schema": {
1345
+ "type": "boolean"
1346
+ }
1347
+ },
1348
+ "created_after": {
1349
+ "required": false,
1350
+ "schema": {
1351
+ "type": "string",
1352
+ "format": "date-time"
1353
+ }
1354
+ },
1355
+ "created_before": {
1356
+ "required": false,
1357
+ "schema": {
1358
+ "type": "string",
1359
+ "format": "date-time"
1360
+ }
1361
+ },
1362
+ "include_data": {
1363
+ "required": false,
1364
+ "schema": {
1365
+ "type": "boolean"
1366
+ }
1367
+ },
1368
+ "limit": {
1369
+ "required": false,
1370
+ "schema": {
1371
+ "type": "integer",
1372
+ "minimum": 1,
1373
+ "maximum": 100
1374
+ }
1375
+ },
1376
+ "cursor": {
1377
+ "required": false,
1378
+ "schema": {
1379
+ "type": "string"
1380
+ }
1381
+ }
1382
+ }
1383
+ },
1384
+ "listTemplates": {
1385
+ "query": {
1386
+ "query": {
1387
+ "required": false,
1388
+ "schema": {
1389
+ "type": "string"
1390
+ }
1391
+ },
1392
+ "parent_folder_id": {
1393
+ "required": false,
1394
+ "schema": {
1395
+ "type": "string"
1396
+ }
1397
+ },
1398
+ "limit": {
1399
+ "required": false,
1400
+ "schema": {
1401
+ "type": "integer",
1402
+ "minimum": 1,
1403
+ "maximum": 100
1404
+ }
1405
+ },
1406
+ "cursor": {
1407
+ "required": false,
1408
+ "schema": {
1409
+ "type": "string"
1410
+ }
1411
+ }
1412
+ }
1413
+ },
1414
+ "listWebhooks": {
1415
+ "query": {
1416
+ "event_type": {
1417
+ "required": false,
1418
+ "schema": {
1419
+ "type": "string",
1420
+ "enum": [
1421
+ "submission.processed",
1422
+ "submission.failed",
1423
+ "submission.declined",
1424
+ "signature_request.viewed",
1425
+ "signature_request.completed",
1426
+ "signature_request.declined",
1427
+ "combined_pdf.processed",
1428
+ "combined_pdf.failed",
1429
+ "submission_batch.processed",
1430
+ "submission_batch.failed",
1431
+ "submission.created",
1432
+ "submission.updated",
1433
+ "submission.expired",
1434
+ "signature_request.updated",
1435
+ "combined_pdf.expired",
1436
+ "template.created",
1437
+ "template.updated",
1438
+ "template.deleted",
1439
+ "webhook.created",
1440
+ "webhook.updated",
1441
+ "webhook.deleted",
1442
+ "custom_file.created",
1443
+ "folder.created",
1444
+ "folder.updated",
1445
+ "folder.deleted"
1446
+ ]
1447
+ }
1448
+ },
1449
+ "mode": {
1450
+ "required": false,
1451
+ "schema": {
1452
+ "type": "string",
1453
+ "enum": [
1454
+ "test",
1455
+ "live"
1456
+ ]
1457
+ }
1458
+ },
1459
+ "template_id": {
1460
+ "required": false,
1461
+ "schema": {
1462
+ "type": "string"
1463
+ }
1464
+ },
1465
+ "folder_id": {
1466
+ "required": false,
1467
+ "schema": {
1468
+ "type": "string"
1469
+ }
1470
+ },
1471
+ "api_token_id": {
1472
+ "required": false,
1473
+ "schema": {
1474
+ "type": "string"
1475
+ }
1476
+ },
1477
+ "limit": {
1478
+ "required": false,
1479
+ "schema": {
1480
+ "type": "integer",
1481
+ "minimum": 1,
1482
+ "maximum": 100
1483
+ }
1484
+ },
1485
+ "cursor": {
1486
+ "required": false,
1487
+ "schema": {
1488
+ "type": "string"
1489
+ }
1490
+ }
1491
+ }
1492
+ },
1493
+ "moveFolder": {
1494
+ "body": {
1495
+ "mediaType": "application/json",
1496
+ "required": true,
1497
+ "schema": {
1498
+ "type": "object",
1499
+ "properties": {
1500
+ "parent_folder_id": {
1501
+ "type": [
1502
+ "string",
1503
+ "null"
1504
+ ],
1505
+ "minLength": 1
1506
+ }
1507
+ },
1508
+ "required": [
1509
+ "parent_folder_id"
1510
+ ],
1511
+ "additionalProperties": false
1512
+ }
1513
+ }
1514
+ },
1515
+ "moveTemplate": {
1516
+ "body": {
1517
+ "mediaType": "application/json",
1518
+ "required": true,
1519
+ "schema": {
1520
+ "type": "object",
1521
+ "required": [
1522
+ "parent_folder_id"
1523
+ ],
1524
+ "properties": {
1525
+ "parent_folder_id": {
1526
+ "type": [
1527
+ "string",
1528
+ "null"
1529
+ ],
1530
+ "minLength": 1
1531
+ }
1532
+ },
1533
+ "additionalProperties": false
1534
+ }
1535
+ }
1536
+ },
1537
+ "publishTemplateVersion": {
1538
+ "body": {
1539
+ "mediaType": "application/json",
1540
+ "required": true,
1541
+ "schema": {
1542
+ "type": "object",
1543
+ "required": [
1544
+ "version_type"
1545
+ ],
1546
+ "properties": {
1547
+ "version_type": {
1548
+ "type": "string",
1549
+ "enum": [
1550
+ "major",
1551
+ "minor",
1552
+ "patch"
1553
+ ]
1554
+ },
1555
+ "description": {
1556
+ "type": "string",
1557
+ "maxLength": 500
1558
+ }
1559
+ },
1560
+ "additionalProperties": false
1561
+ }
1562
+ }
1563
+ },
1564
+ "renameFolder": {
1565
+ "body": {
1566
+ "mediaType": "application/json",
1567
+ "required": true,
1568
+ "schema": {
1569
+ "type": "object",
1570
+ "properties": {
1571
+ "name": {
1572
+ "type": "string",
1573
+ "minLength": 1,
1574
+ "maxLength": 255,
1575
+ "pattern": "^[^/]*$",
1576
+ "x-pattern-message": "can't contain a slash (/)"
1577
+ }
1578
+ },
1579
+ "required": [
1580
+ "name"
1581
+ ],
1582
+ "additionalProperties": false
1583
+ }
1584
+ }
1585
+ },
1586
+ "restoreTemplateVersion": {
1587
+ "body": {
1588
+ "mediaType": "application/json",
1589
+ "required": true,
1590
+ "schema": {
1591
+ "type": "object",
1592
+ "required": [
1593
+ "version"
1594
+ ],
1595
+ "properties": {
1596
+ "version": {
1597
+ "type": "string",
1598
+ "pattern": "^\\d+(\\.\\d+(\\.\\d+)?)?$",
1599
+ "x-pattern-message": "must be a published version like 1.2.3 or 1"
1600
+ }
1601
+ },
1602
+ "additionalProperties": false
1603
+ }
1604
+ }
1605
+ },
1606
+ "testAuthentication": {},
1607
+ "updateSignatureRequest": {
1608
+ "body": {
1609
+ "mediaType": "application/json",
1610
+ "required": true,
1611
+ "schema": {
1612
+ "type": "object",
1613
+ "properties": {
1614
+ "metadata": {
1615
+ "type": "object"
1616
+ },
1617
+ "auth_type": {
1618
+ "type": "string",
1619
+ "enum": [
1620
+ "password",
1621
+ "oauth",
1622
+ "email_link",
1623
+ "phone_number",
1624
+ "ldap",
1625
+ "saml"
1626
+ ]
1627
+ },
1628
+ "auth_second_factor_type": {
1629
+ "type": "string",
1630
+ "enum": [
1631
+ "none",
1632
+ "phone_number",
1633
+ "totp",
1634
+ "mobile_push",
1635
+ "security_key",
1636
+ "fingerprint"
1637
+ ]
1638
+ },
1639
+ "auth_provider": {
1640
+ "type": [
1641
+ "string",
1642
+ "null"
1643
+ ],
1644
+ "maxLength": 255
1645
+ },
1646
+ "auth_session_started_at": {
1647
+ "type": [
1648
+ "string",
1649
+ "null"
1650
+ ],
1651
+ "format": "date-time"
1652
+ },
1653
+ "auth_session_id_hash": {
1654
+ "type": [
1655
+ "string",
1656
+ "null"
1657
+ ]
1658
+ },
1659
+ "auth_user_id_hash": {
1660
+ "type": [
1661
+ "string",
1662
+ "null"
1663
+ ]
1664
+ },
1665
+ "auth_username_hash": {
1666
+ "type": [
1667
+ "string",
1668
+ "null"
1669
+ ]
1670
+ },
1671
+ "auth_phone_number_hash": {
1672
+ "type": [
1673
+ "string",
1674
+ "null"
1675
+ ]
1676
+ }
1677
+ },
1678
+ "additionalProperties": false
1679
+ }
1680
+ }
1681
+ },
1682
+ "updateTemplate": {
1683
+ "body": {
1684
+ "mediaType": "application/json",
1685
+ "required": true,
1686
+ "schema": {
1687
+ "type": "object",
1688
+ "properties": {
1689
+ "name": {
1690
+ "type": "string",
1691
+ "minLength": 1,
1692
+ "maxLength": 255
1693
+ },
1694
+ "description": {
1695
+ "type": [
1696
+ "string",
1697
+ "null"
1698
+ ]
1699
+ },
1700
+ "parent_folder_id": {
1701
+ "type": [
1702
+ "string",
1703
+ "null"
1704
+ ],
1705
+ "minLength": 1
1706
+ },
1707
+ "locked": {
1708
+ "type": "boolean"
1709
+ },
1710
+ "add_signature_request_submission_id_footers": {
1711
+ "type": "boolean"
1712
+ },
1713
+ "ai_field_naming_language": {
1714
+ "type": "string",
1715
+ "enum": [
1716
+ "auto",
1717
+ "english",
1718
+ "form_language"
1719
+ ]
1720
+ },
1721
+ "allow_additional_properties": {
1722
+ "type": "boolean"
1723
+ },
1724
+ "allow_skipping_optional_fields": {
1725
+ "type": "boolean"
1726
+ },
1727
+ "default_form_mode": {
1728
+ "type": "string",
1729
+ "enum": [
1730
+ "web",
1731
+ "visual",
1732
+ "dual"
1733
+ ]
1734
+ },
1735
+ "editable_submissions": {
1736
+ "type": "boolean"
1737
+ },
1738
+ "embed_domains": {
1739
+ "type": "array",
1740
+ "maxItems": 100,
1741
+ "items": {
1742
+ "type": "string",
1743
+ "minLength": 1,
1744
+ "maxLength": 255
1745
+ }
1746
+ },
1747
+ "embed_edit_allow_settings": {
1748
+ "type": "boolean"
1749
+ },
1750
+ "embed_edit_allow_versioning": {
1751
+ "type": "boolean"
1752
+ },
1753
+ "embed_edit_allow_document_replacement": {
1754
+ "type": "boolean"
1755
+ },
1756
+ "encrypt_pdfs": {
1757
+ "type": "boolean"
1758
+ },
1759
+ "encrypt_pdfs_password": {
1760
+ "type": [
1761
+ "string",
1762
+ "null"
1763
+ ]
1764
+ },
1765
+ "expire_submissions": {
1766
+ "type": "boolean"
1767
+ },
1768
+ "expire_after": {
1769
+ "type": "integer",
1770
+ "minimum": 1,
1771
+ "maximum": 5256000
1772
+ },
1773
+ "expiration_interval": {
1774
+ "type": "string",
1775
+ "enum": [
1776
+ "minutes",
1777
+ "hours",
1778
+ "days"
1779
+ ]
1780
+ },
1781
+ "merge_audit_trail_pdf": {
1782
+ "type": "boolean"
1783
+ },
1784
+ "parse_dates_using_template_date_format": {
1785
+ "type": "boolean"
1786
+ },
1787
+ "public_submissions": {
1788
+ "type": "boolean"
1789
+ },
1790
+ "public_web_form": {
1791
+ "type": "boolean"
1792
+ },
1793
+ "redirect_url": {
1794
+ "type": [
1795
+ "string",
1796
+ "null"
1797
+ ],
1798
+ "format": "uri"
1799
+ },
1800
+ "slack_webhook_url": {
1801
+ "type": [
1802
+ "string",
1803
+ "null"
1804
+ ],
1805
+ "format": "uri"
1806
+ },
1807
+ "defaults": {
1808
+ "type": "object",
1809
+ "properties": {
1810
+ "typeface": {
1811
+ "type": [
1812
+ "string",
1813
+ "null"
1814
+ ],
1815
+ "enum": [
1816
+ "Inconsolata",
1817
+ "Roboto Mono",
1818
+ "Ubuntu Mono",
1819
+ "Menlo",
1820
+ "Courier",
1821
+ "Helvetica",
1822
+ "Arial",
1823
+ "Calibri",
1824
+ "Open Sans",
1825
+ "Roboto",
1826
+ "Lato",
1827
+ "Poppins",
1828
+ "Public Sans",
1829
+ "Questrial",
1830
+ "Times New Roman",
1831
+ "Dancing Script",
1832
+ "Lovtony Script",
1833
+ null
1834
+ ]
1835
+ },
1836
+ "font_size": {
1837
+ "type": [
1838
+ "integer",
1839
+ "null"
1840
+ ],
1841
+ "minimum": 1
1842
+ },
1843
+ "character_spacing": {
1844
+ "type": [
1845
+ "number",
1846
+ "null"
1847
+ ],
1848
+ "minimum": 0,
1849
+ "maximum": 50
1850
+ },
1851
+ "color": {
1852
+ "type": [
1853
+ "string",
1854
+ "null"
1855
+ ],
1856
+ "pattern": "^[A-Fa-f0-9]{6}$",
1857
+ "x-pattern-message": "must be a 6-digit hex color without #, like FF0000"
1858
+ },
1859
+ "background_color": {
1860
+ "type": [
1861
+ "string",
1862
+ "null"
1863
+ ],
1864
+ "pattern": "^[A-Fa-f0-9]{6}$",
1865
+ "x-pattern-message": "must be a 6-digit hex color without #, like FF0000"
1866
+ },
1867
+ "bold": {
1868
+ "type": "boolean"
1869
+ },
1870
+ "uppercase": {
1871
+ "type": "boolean"
1872
+ },
1873
+ "alignment": {
1874
+ "type": "string",
1875
+ "enum": [
1876
+ "left",
1877
+ "center",
1878
+ "right",
1879
+ "justify"
1880
+ ]
1881
+ },
1882
+ "opacity": {
1883
+ "type": "number",
1884
+ "minimum": 0,
1885
+ "maximum": 1
1886
+ },
1887
+ "date_format": {
1888
+ "type": [
1889
+ "string",
1890
+ "null"
1891
+ ]
1892
+ },
1893
+ "date_time_format": {
1894
+ "type": [
1895
+ "string",
1896
+ "null"
1897
+ ]
1898
+ },
1899
+ "check_color": {
1900
+ "type": [
1901
+ "string",
1902
+ "null"
1903
+ ],
1904
+ "pattern": "^[A-Fa-f0-9]{6}$",
1905
+ "x-pattern-message": "must be a 6-digit hex color without #, like FF0000"
1906
+ },
1907
+ "check_character": {
1908
+ "type": [
1909
+ "string",
1910
+ "null"
1911
+ ],
1912
+ "enum": [
1913
+ "✓",
1914
+ "✔",
1915
+ "✖",
1916
+ "✗",
1917
+ "✘",
1918
+ null
1919
+ ]
1920
+ },
1921
+ "check_background_color": {
1922
+ "type": [
1923
+ "string",
1924
+ "null"
1925
+ ],
1926
+ "pattern": "^[A-Fa-f0-9]{6}$",
1927
+ "x-pattern-message": "must be a 6-digit hex color without #, like FF0000"
1928
+ },
1929
+ "required_field_background_color": {
1930
+ "type": [
1931
+ "string",
1932
+ "null"
1933
+ ],
1934
+ "pattern": "^[A-Fa-f0-9]{6}$",
1935
+ "x-pattern-message": "must be a 6-digit hex color without #, like FF0000"
1936
+ },
1937
+ "true_text": {
1938
+ "type": [
1939
+ "string",
1940
+ "null"
1941
+ ]
1942
+ },
1943
+ "false_text": {
1944
+ "type": [
1945
+ "string",
1946
+ "null"
1947
+ ]
1948
+ },
1949
+ "shape_fill_color": {
1950
+ "type": [
1951
+ "string",
1952
+ "null"
1953
+ ],
1954
+ "pattern": "^[A-Fa-f0-9]{6}$",
1955
+ "x-pattern-message": "must be a 6-digit hex color without #, like FF0000"
1956
+ },
1957
+ "shape_border_color": {
1958
+ "type": [
1959
+ "string",
1960
+ "null"
1961
+ ],
1962
+ "pattern": "^[A-Fa-f0-9]{6}$",
1963
+ "x-pattern-message": "must be a 6-digit hex color without #, like FF0000"
1964
+ },
1965
+ "shape_border_width": {
1966
+ "type": "integer",
1967
+ "minimum": 1
1968
+ }
1969
+ },
1970
+ "additionalProperties": false
1971
+ },
1972
+ "field_dependencies": {
1973
+ "type": "array",
1974
+ "items": {
1975
+ "type": "object",
1976
+ "properties": {
1977
+ "action": {
1978
+ "type": "string",
1979
+ "enum": [
1980
+ "require_and_show",
1981
+ "show",
1982
+ "require"
1983
+ ]
1984
+ },
1985
+ "match": {
1986
+ "type": "string",
1987
+ "enum": [
1988
+ "all",
1989
+ "any"
1990
+ ]
1991
+ },
1992
+ "conditions": {
1993
+ "type": "array",
1994
+ "items": {
1995
+ "oneOf": [
1996
+ {
1997
+ "$ref": "#/components/schemas/FieldPresenceCondition"
1998
+ },
1999
+ {
2000
+ "$ref": "#/components/schemas/FieldEqualsCondition"
2001
+ },
2002
+ {
2003
+ "$ref": "#/components/schemas/FieldInCondition"
2004
+ },
2005
+ {
2006
+ "$ref": "#/components/schemas/FieldComparisonCondition"
2007
+ },
2008
+ {
2009
+ "$ref": "#/components/schemas/FieldRangeCondition"
2010
+ }
2011
+ ],
2012
+ "discriminator": {
2013
+ "propertyName": "operator",
2014
+ "mapping": [
2015
+ [
2016
+ "present",
2017
+ "#/components/schemas/FieldPresenceCondition"
2018
+ ],
2019
+ [
2020
+ "blank",
2021
+ "#/components/schemas/FieldPresenceCondition"
2022
+ ],
2023
+ [
2024
+ "equals",
2025
+ "#/components/schemas/FieldEqualsCondition"
2026
+ ],
2027
+ [
2028
+ "not_equals",
2029
+ "#/components/schemas/FieldEqualsCondition"
2030
+ ],
2031
+ [
2032
+ "in",
2033
+ "#/components/schemas/FieldInCondition"
2034
+ ],
2035
+ [
2036
+ "gt",
2037
+ "#/components/schemas/FieldComparisonCondition"
2038
+ ],
2039
+ [
2040
+ "gte",
2041
+ "#/components/schemas/FieldComparisonCondition"
2042
+ ],
2043
+ [
2044
+ "lt",
2045
+ "#/components/schemas/FieldComparisonCondition"
2046
+ ],
2047
+ [
2048
+ "lte",
2049
+ "#/components/schemas/FieldComparisonCondition"
2050
+ ],
2051
+ [
2052
+ "range",
2053
+ "#/components/schemas/FieldRangeCondition"
2054
+ ]
2055
+ ]
2056
+ }
2057
+ }
2058
+ },
2059
+ "targets": {
2060
+ "type": "array",
2061
+ "minItems": 1,
2062
+ "items": {
2063
+ "type": "string",
2064
+ "minLength": 1
2065
+ }
2066
+ },
2067
+ "group": {
2068
+ "type": "string"
2069
+ }
2070
+ },
2071
+ "required": [
2072
+ "action",
2073
+ "conditions",
2074
+ "targets"
2075
+ ],
2076
+ "additionalProperties": false
2077
+ }
2078
+ },
2079
+ "html": {
2080
+ "type": [
2081
+ "string",
2082
+ "null"
2083
+ ]
2084
+ },
2085
+ "scss": {
2086
+ "type": [
2087
+ "string",
2088
+ "null"
2089
+ ]
2090
+ },
2091
+ "header_html": {
2092
+ "type": [
2093
+ "string",
2094
+ "null"
2095
+ ]
2096
+ },
2097
+ "footer_html": {
2098
+ "type": [
2099
+ "string",
2100
+ "null"
2101
+ ]
2102
+ },
2103
+ "html_engine_options": {
2104
+ "type": [
2105
+ "object",
2106
+ "null"
2107
+ ],
2108
+ "properties": {
2109
+ "format": {
2110
+ "type": "string",
2111
+ "enum": [
2112
+ "Letter",
2113
+ "Legal",
2114
+ "Tabloid",
2115
+ "Ledger",
2116
+ "CR80",
2117
+ "A0",
2118
+ "A1",
2119
+ "A2",
2120
+ "A3",
2121
+ "A4",
2122
+ "A5",
2123
+ "A6",
2124
+ "Custom"
2125
+ ]
2126
+ },
2127
+ "width": {
2128
+ "type": "string"
2129
+ },
2130
+ "height": {
2131
+ "type": "string"
2132
+ },
2133
+ "scale": {
2134
+ "type": "number",
2135
+ "exclusiveMinimum": 0
2136
+ },
2137
+ "landscape": {
2138
+ "type": "boolean"
2139
+ },
2140
+ "print_background": {
2141
+ "type": "boolean"
2142
+ },
2143
+ "margin_top": {
2144
+ "type": "string"
2145
+ },
2146
+ "margin_bottom": {
2147
+ "type": "string"
2148
+ },
2149
+ "margin_left": {
2150
+ "type": "string"
2151
+ },
2152
+ "margin_right": {
2153
+ "type": "string"
2154
+ }
2155
+ },
2156
+ "additionalProperties": false
2157
+ }
2158
+ },
2159
+ "additionalProperties": false
2160
+ }
2161
+ }
2162
+ },
2163
+ "updateTemplateDocument": {
2164
+ "query": {
2165
+ "wait": {
2166
+ "required": false,
2167
+ "schema": {
2168
+ "type": "boolean"
2169
+ }
2170
+ }
2171
+ },
2172
+ "body": {
2173
+ "mediaType": "application/json",
2174
+ "required": true,
2175
+ "schema": {
2176
+ "type": "object",
2177
+ "required": [
2178
+ "cache_id"
2179
+ ],
2180
+ "properties": {
2181
+ "cache_id": {
2182
+ "type": "string",
2183
+ "minLength": 1,
2184
+ "maxLength": 255
2185
+ },
2186
+ "filename": {
2187
+ "type": "string",
2188
+ "minLength": 1,
2189
+ "maxLength": 255
2190
+ },
2191
+ "reimport_fields": {
2192
+ "type": "boolean"
2193
+ }
2194
+ },
2195
+ "additionalProperties": false
2196
+ }
2197
+ }
2198
+ },
2199
+ "updateWebhook": {
2200
+ "body": {
2201
+ "mediaType": "application/json",
2202
+ "required": true,
2203
+ "schema": {
2204
+ "type": "object",
2205
+ "properties": {
2206
+ "name": {
2207
+ "type": [
2208
+ "string",
2209
+ "null"
2210
+ ],
2211
+ "maxLength": 255
2212
+ },
2213
+ "url": {
2214
+ "type": "string",
2215
+ "format": "uri"
2216
+ },
2217
+ "enabled": {
2218
+ "type": "boolean"
2219
+ },
2220
+ "event_types": {
2221
+ "type": "array",
2222
+ "minItems": 1,
2223
+ "uniqueItems": true,
2224
+ "items": {
2225
+ "type": "string",
2226
+ "enum": [
2227
+ "submission.processed",
2228
+ "submission.failed",
2229
+ "submission.declined",
2230
+ "signature_request.viewed",
2231
+ "signature_request.completed",
2232
+ "signature_request.declined",
2233
+ "combined_pdf.processed",
2234
+ "combined_pdf.failed",
2235
+ "submission_batch.processed",
2236
+ "submission_batch.failed",
2237
+ "submission.created",
2238
+ "submission.updated",
2239
+ "submission.expired",
2240
+ "signature_request.updated",
2241
+ "combined_pdf.expired",
2242
+ "template.created",
2243
+ "template.updated",
2244
+ "template.deleted",
2245
+ "webhook.created",
2246
+ "webhook.updated",
2247
+ "webhook.deleted",
2248
+ "custom_file.created",
2249
+ "folder.created",
2250
+ "folder.updated",
2251
+ "folder.deleted"
2252
+ ]
2253
+ }
2254
+ },
2255
+ "mode": {
2256
+ "type": [
2257
+ "string",
2258
+ "null"
2259
+ ],
2260
+ "enum": [
2261
+ "test",
2262
+ "live",
2263
+ null
2264
+ ]
2265
+ },
2266
+ "api_token_ids": {
2267
+ "type": "array",
2268
+ "uniqueItems": true,
2269
+ "items": {
2270
+ "type": "string"
2271
+ }
2272
+ },
2273
+ "template_ids": {
2274
+ "type": "array",
2275
+ "uniqueItems": true,
2276
+ "items": {
2277
+ "type": "string"
2278
+ }
2279
+ },
2280
+ "folder_ids": {
2281
+ "type": "array",
2282
+ "uniqueItems": true,
2283
+ "items": {
2284
+ "type": "string"
2285
+ }
2286
+ },
2287
+ "include_submission_data": {
2288
+ "type": "boolean"
2289
+ },
2290
+ "strip_fields": {
2291
+ "type": "array",
2292
+ "items": {
2293
+ "type": "string"
2294
+ }
2295
+ },
2296
+ "headers": {
2297
+ "type": "object",
2298
+ "additionalProperties": {
2299
+ "type": "string"
2300
+ }
2301
+ }
2302
+ },
2303
+ "additionalProperties": false
2304
+ }
2305
+ }
2306
+ },
2307
+ "uploadTemplate": {
2308
+ "query": {
2309
+ "wait": {
2310
+ "required": false,
2311
+ "schema": {
2312
+ "type": "boolean"
2313
+ }
2314
+ }
2315
+ },
2316
+ "body": {
2317
+ "mediaType": "multipart/form-data",
2318
+ "required": true,
2319
+ "schema": {
2320
+ "type": "object",
2321
+ "required": [
2322
+ "document"
2323
+ ],
2324
+ "properties": {
2325
+ "document": {
2326
+ "type": "string",
2327
+ "format": "binary"
2328
+ },
2329
+ "name": {
2330
+ "type": "string",
2331
+ "minLength": 1,
2332
+ "maxLength": 255
2333
+ },
2334
+ "description": {
2335
+ "type": "string"
2336
+ },
2337
+ "parent_folder_id": {
2338
+ "type": "string",
2339
+ "minLength": 1
2340
+ },
2341
+ "ai_field_naming_language": {
2342
+ "type": "string",
2343
+ "enum": [
2344
+ "auto",
2345
+ "english",
2346
+ "form_language"
2347
+ ]
2348
+ },
2349
+ "detect_fields": {
2350
+ "type": "boolean"
2351
+ },
2352
+ "field_source": {
2353
+ "type": "string",
2354
+ "enum": [
2355
+ "auto",
2356
+ "pdf_detection",
2357
+ "pdf_form_fields"
2358
+ ]
2359
+ },
2360
+ "field_naming": {
2361
+ "type": "string",
2362
+ "enum": [
2363
+ "ai",
2364
+ "preserve"
2365
+ ]
2366
+ },
2367
+ "field_logic": {
2368
+ "type": "string",
2369
+ "enum": [
2370
+ "ai",
2371
+ "none"
2372
+ ]
2373
+ }
2374
+ },
2375
+ "additionalProperties": false
2376
+ }
2377
+ }
2378
+ },
2379
+ "uploadTemplateDocument": {
2380
+ "query": {
2381
+ "wait": {
2382
+ "required": false,
2383
+ "schema": {
2384
+ "type": "boolean"
2385
+ }
2386
+ }
2387
+ },
2388
+ "body": {
2389
+ "mediaType": "multipart/form-data",
2390
+ "required": true,
2391
+ "schema": {
2392
+ "type": "object",
2393
+ "required": [
2394
+ "document"
2395
+ ],
2396
+ "properties": {
2397
+ "document": {
2398
+ "type": "string",
2399
+ "format": "binary"
2400
+ },
2401
+ "reimport_fields": {
2402
+ "type": "boolean"
2403
+ }
2404
+ },
2405
+ "additionalProperties": false
2406
+ }
2407
+ }
2408
+ }
2409
+ },
2410
+ "routes": {
2411
+ "DELETE /combined_pdfs/{combined_pdf_id}": "expireCombinedPdf",
2412
+ "DELETE /custom_files/{custom_file_id}": "deleteCustomFile",
2413
+ "DELETE /folders/{folder_id}": "deleteFolder",
2414
+ "DELETE /submissions/{submission_id}": "expireSubmission",
2415
+ "DELETE /templates/{template_id}": "deleteTemplate",
2416
+ "DELETE /webhooks/{webhook_id}": "deleteWebhook",
2417
+ "GET /authentication": "testAuthentication",
2418
+ "GET /combined_pdfs": "listCombinedPdfs",
2419
+ "GET /combined_pdfs/{combined_pdf_id}": "getCombinedPdf",
2420
+ "GET /custom_files": "listCustomFiles",
2421
+ "GET /custom_files/{custom_file_id}": "getCustomFile",
2422
+ "GET /folders": "listFolders",
2423
+ "GET /folders/{folder_id}": "getFolder",
2424
+ "GET /signature_requests/{signature_request_id}": "getSignatureRequest",
2425
+ "GET /submissions": "listSubmissions",
2426
+ "GET /submissions/batches/{submission_batch_id}": "getSubmissionBatch",
2427
+ "GET /submissions/{submission_id}": "getSubmission",
2428
+ "GET /templates": "listTemplates",
2429
+ "GET /templates/{template_id}": "getTemplate",
2430
+ "GET /templates/{template_id}/model_code": "getTemplateModelCode",
2431
+ "GET /templates/{template_id}/schema": "getTemplateSchema",
2432
+ "GET /templates/{template_id}/submissions": "listTemplateSubmissions",
2433
+ "GET /uploads/presign": "getPresignUrl",
2434
+ "GET /webhooks": "listWebhooks",
2435
+ "GET /webhooks/{webhook_id}": "getWebhook",
2436
+ "POST /combined_pdfs": "createCombinedPdf",
2437
+ "POST /custom_files": "createCustomFileFromUpload",
2438
+ "POST /folders": "createFolder",
2439
+ "POST /folders/{folder_id}/move": "moveFolder",
2440
+ "POST /folders/{folder_id}/rename": "renameFolder",
2441
+ "POST /signature_requests/{signature_request_id}/events": "createSignatureRequestEvent",
2442
+ "POST /signature_requests/{signature_request_id}/tokens": "createSignatureRequestToken",
2443
+ "POST /submissions/batches": "createSubmissionBatch",
2444
+ "POST /submissions/{submission_id}/generate_preview": "generateSubmissionPreview",
2445
+ "POST /templates": "createTemplate",
2446
+ "POST /templates/upload": "uploadTemplate",
2447
+ "POST /templates/{template_id}/copy": "copyTemplate",
2448
+ "POST /templates/{template_id}/move": "moveTemplate",
2449
+ "POST /templates/{template_id}/publish_version": "publishTemplateVersion",
2450
+ "POST /templates/{template_id}/restore_version": "restoreTemplateVersion",
2451
+ "POST /templates/{template_id}/submissions": "createSubmission",
2452
+ "POST /webhooks": "createWebhook",
2453
+ "PUT /signature_requests/{signature_request_id}": "updateSignatureRequest",
2454
+ "PUT /templates/{template_id}": "updateTemplate",
2455
+ "PUT /templates/{template_id}/document": "updateTemplateDocument",
2456
+ "PUT /templates/{template_id}/document/upload": "uploadTemplateDocument",
2457
+ "PUT /webhooks/{webhook_id}": "updateWebhook"
2458
+ },
2459
+ "components": {
2460
+ "schemas": {
2461
+ "CombinedPdfSourcePdf": {
2462
+ "type": "object",
2463
+ "required": [
2464
+ "type",
2465
+ "id"
2466
+ ],
2467
+ "properties": {
2468
+ "type": {
2469
+ "type": "string",
2470
+ "const": "combined_pdf"
2471
+ },
2472
+ "id": {
2473
+ "type": "string",
2474
+ "minLength": 1
2475
+ }
2476
+ },
2477
+ "additionalProperties": false,
2478
+ "x-not-allowed-properties": {
2479
+ "url": "isn't used by 'combined_pdf' source PDFs. Remove it",
2480
+ "template_version": "isn't used by 'combined_pdf' source PDFs. Remove it",
2481
+ "processed": "isn't used by 'combined_pdf' source PDFs. Remove it"
2482
+ }
2483
+ },
2484
+ "CustomFileSourcePdf": {
2485
+ "type": "object",
2486
+ "required": [
2487
+ "type",
2488
+ "id"
2489
+ ],
2490
+ "properties": {
2491
+ "type": {
2492
+ "type": "string",
2493
+ "const": "custom_file"
2494
+ },
2495
+ "id": {
2496
+ "type": "string",
2497
+ "minLength": 1
2498
+ }
2499
+ },
2500
+ "additionalProperties": false,
2501
+ "x-not-allowed-properties": {
2502
+ "url": "isn't used by 'custom_file' source PDFs. Remove it",
2503
+ "template_version": "isn't used by 'custom_file' source PDFs. Remove it",
2504
+ "processed": "isn't used by 'custom_file' source PDFs. Remove it"
2505
+ }
2506
+ },
2507
+ "FieldComparisonCondition": {
2508
+ "type": "object",
2509
+ "required": [
2510
+ "field",
2511
+ "operator",
2512
+ "value"
2513
+ ],
2514
+ "properties": {
2515
+ "field": {
2516
+ "type": "string"
2517
+ },
2518
+ "operator": {
2519
+ "type": "string",
2520
+ "enum": [
2521
+ "gt",
2522
+ "gte",
2523
+ "lt",
2524
+ "lte"
2525
+ ]
2526
+ },
2527
+ "value": {
2528
+ "type": [
2529
+ "number",
2530
+ "string"
2531
+ ],
2532
+ "pattern": "^-?\\d+(\\.\\d+)?([eE][-+]?\\d+)?$",
2533
+ "x-pattern-message": "must be a number, like 10 or 2.5"
2534
+ }
2535
+ },
2536
+ "additionalProperties": false,
2537
+ "x-not-allowed-properties": {
2538
+ "range_max": "isn't used by 'gt', 'gte', 'lt' or 'lte' conditions. Remove it"
2539
+ }
2540
+ },
2541
+ "FieldEqualsCondition": {
2542
+ "type": "object",
2543
+ "required": [
2544
+ "field",
2545
+ "operator",
2546
+ "value"
2547
+ ],
2548
+ "properties": {
2549
+ "field": {
2550
+ "type": "string"
2551
+ },
2552
+ "operator": {
2553
+ "type": "string",
2554
+ "enum": [
2555
+ "equals",
2556
+ "not_equals"
2557
+ ]
2558
+ },
2559
+ "value": {
2560
+ "type": [
2561
+ "string",
2562
+ "number",
2563
+ "boolean"
2564
+ ]
2565
+ }
2566
+ },
2567
+ "additionalProperties": false,
2568
+ "x-not-allowed-properties": {
2569
+ "range_max": "isn't used by 'equals' or 'not_equals' conditions. Remove it"
2570
+ }
2571
+ },
2572
+ "FieldInCondition": {
2573
+ "type": "object",
2574
+ "required": [
2575
+ "field",
2576
+ "operator",
2577
+ "value"
2578
+ ],
2579
+ "properties": {
2580
+ "field": {
2581
+ "type": "string"
2582
+ },
2583
+ "operator": {
2584
+ "type": "string",
2585
+ "const": "in"
2586
+ },
2587
+ "value": {
2588
+ "type": "array",
2589
+ "minItems": 1,
2590
+ "items": {
2591
+ "type": [
2592
+ "string",
2593
+ "number",
2594
+ "boolean"
2595
+ ],
2596
+ "minLength": 1
2597
+ }
2598
+ }
2599
+ },
2600
+ "additionalProperties": false,
2601
+ "x-not-allowed-properties": {
2602
+ "range_max": "isn't used by 'in' conditions. Remove it"
2603
+ }
2604
+ },
2605
+ "FieldOverride": {
2606
+ "type": "object",
2607
+ "properties": {
2608
+ "static": {
2609
+ "type": "boolean"
2610
+ },
2611
+ "editable": {
2612
+ "type": "boolean"
2613
+ },
2614
+ "default": {
2615
+ "type": [
2616
+ "string",
2617
+ "null"
2618
+ ]
2619
+ },
2620
+ "title": {
2621
+ "type": "string"
2622
+ },
2623
+ "required": {
2624
+ "type": "boolean"
2625
+ },
2626
+ "option_list": {
2627
+ "type": [
2628
+ "string",
2629
+ "null"
2630
+ ]
2631
+ },
2632
+ "combined_field_names": {
2633
+ "type": "string"
2634
+ },
2635
+ "combined_field_type": {
2636
+ "type": "string",
2637
+ "enum": [
2638
+ "separator",
2639
+ "format"
2640
+ ]
2641
+ },
2642
+ "combined_field_separator": {
2643
+ "type": "string"
2644
+ },
2645
+ "combined_field_format": {
2646
+ "type": "string"
2647
+ },
2648
+ "integer": {
2649
+ "type": "boolean"
2650
+ },
2651
+ "include_time": {
2652
+ "type": [
2653
+ "boolean",
2654
+ "null"
2655
+ ]
2656
+ },
2657
+ "signature_allow_draw": {
2658
+ "type": "boolean"
2659
+ },
2660
+ "signature_allow_type": {
2661
+ "type": "boolean"
2662
+ },
2663
+ "barcode_symbology": {
2664
+ "type": "string",
2665
+ "enum": [
2666
+ "code_25",
2667
+ "code_39",
2668
+ "code_93",
2669
+ "code_128",
2670
+ "ean_13",
2671
+ "ean_8",
2672
+ "upc_a",
2673
+ "pdf417"
2674
+ ]
2675
+ },
2676
+ "hidden": {
2677
+ "type": "boolean"
2678
+ },
2679
+ "x": {
2680
+ "type": "number",
2681
+ "minimum": 0
2682
+ },
2683
+ "y": {
2684
+ "type": "number",
2685
+ "minimum": 0
2686
+ },
2687
+ "width": {
2688
+ "type": "number",
2689
+ "exclusiveMinimum": 0
2690
+ },
2691
+ "height": {
2692
+ "type": "number",
2693
+ "exclusiveMinimum": 0
2694
+ },
2695
+ "rotation": {
2696
+ "type": "number",
2697
+ "minimum": -360,
2698
+ "maximum": 360
2699
+ },
2700
+ "display_type": {
2701
+ "type": "string",
2702
+ "enum": [
2703
+ "text",
2704
+ "check",
2705
+ "qrcode",
2706
+ "barcode",
2707
+ "image",
2708
+ "shape"
2709
+ ]
2710
+ },
2711
+ "opacity": {
2712
+ "type": "number",
2713
+ "minimum": 0,
2714
+ "maximum": 1
2715
+ },
2716
+ "date_time_format": {
2717
+ "type": [
2718
+ "string",
2719
+ "null"
2720
+ ]
2721
+ },
2722
+ "typeface": {
2723
+ "type": [
2724
+ "string",
2725
+ "null"
2726
+ ],
2727
+ "enum": [
2728
+ "Inconsolata",
2729
+ "Roboto Mono",
2730
+ "Ubuntu Mono",
2731
+ "Menlo",
2732
+ "Courier",
2733
+ "Helvetica",
2734
+ "Arial",
2735
+ "Calibri",
2736
+ "Open Sans",
2737
+ "Roboto",
2738
+ "Lato",
2739
+ "Poppins",
2740
+ "Public Sans",
2741
+ "Questrial",
2742
+ "Times New Roman",
2743
+ "Dancing Script",
2744
+ "Lovtony Script",
2745
+ null
2746
+ ]
2747
+ },
2748
+ "font_size": {
2749
+ "type": [
2750
+ "integer",
2751
+ "null"
2752
+ ],
2753
+ "minimum": 1
2754
+ },
2755
+ "character_spacing": {
2756
+ "type": "number",
2757
+ "minimum": 0,
2758
+ "maximum": 50
2759
+ },
2760
+ "bold": {
2761
+ "type": "boolean"
2762
+ },
2763
+ "uppercase": {
2764
+ "type": "boolean"
2765
+ },
2766
+ "strikethrough": {
2767
+ "type": "boolean"
2768
+ },
2769
+ "keep_leading_spaces": {
2770
+ "type": "boolean"
2771
+ },
2772
+ "overflow": {
2773
+ "type": "string",
2774
+ "enum": [
2775
+ "shrink_to_fit",
2776
+ "truncate"
2777
+ ]
2778
+ },
2779
+ "multiline": {
2780
+ "type": "boolean"
2781
+ },
2782
+ "multiline_lines": {
2783
+ "type": [
2784
+ "integer",
2785
+ "null"
2786
+ ],
2787
+ "minimum": 1,
2788
+ "maximum": 300
2789
+ },
2790
+ "max_length": {
2791
+ "type": [
2792
+ "integer",
2793
+ "null"
2794
+ ],
2795
+ "minimum": 0
2796
+ },
2797
+ "color": {
2798
+ "type": [
2799
+ "string",
2800
+ "null"
2801
+ ],
2802
+ "pattern": "^[A-Fa-f0-9]{6}$",
2803
+ "x-pattern-message": "must be a 6-digit hex color without #, like FF0000"
2804
+ },
2805
+ "background_color": {
2806
+ "type": [
2807
+ "string",
2808
+ "null"
2809
+ ],
2810
+ "pattern": "^[A-Fa-f0-9]{6}$",
2811
+ "x-pattern-message": "must be a 6-digit hex color without #, like FF0000"
2812
+ },
2813
+ "alignment": {
2814
+ "type": "string",
2815
+ "enum": [
2816
+ "left",
2817
+ "center",
2818
+ "right",
2819
+ "justify"
2820
+ ]
2821
+ },
2822
+ "v_alignment": {
2823
+ "type": "string",
2824
+ "enum": [
2825
+ "bottom",
2826
+ "center",
2827
+ "top"
2828
+ ]
2829
+ },
2830
+ "comb": {
2831
+ "type": "boolean"
2832
+ },
2833
+ "comb_number_of_cells": {
2834
+ "type": "integer",
2835
+ "minimum": 1
2836
+ },
2837
+ "comb_value_offset": {
2838
+ "type": "integer",
2839
+ "minimum": 0
2840
+ },
2841
+ "shape_type": {
2842
+ "type": "string",
2843
+ "enum": [
2844
+ "square",
2845
+ "rectangle",
2846
+ "circle",
2847
+ "ellipse",
2848
+ "triangle",
2849
+ "polygon"
2850
+ ]
2851
+ },
2852
+ "shape_sides": {
2853
+ "type": "integer",
2854
+ "minimum": 3,
2855
+ "maximum": 12
2856
+ },
2857
+ "shape_border_width": {
2858
+ "type": "integer",
2859
+ "minimum": 1
2860
+ },
2861
+ "shape_border_color": {
2862
+ "type": "string",
2863
+ "pattern": "^[A-Fa-f0-9]{6}$",
2864
+ "x-pattern-message": "must be a 6-digit hex color without #, like FF0000"
2865
+ },
2866
+ "shape_fill_color": {
2867
+ "type": [
2868
+ "string",
2869
+ "null"
2870
+ ],
2871
+ "pattern": "^[A-Fa-f0-9]{6}$",
2872
+ "x-pattern-message": "must be a 6-digit hex color without #, like FF0000"
2873
+ },
2874
+ "check_character": {
2875
+ "type": "string",
2876
+ "enum": [
2877
+ "✓",
2878
+ "✔",
2879
+ "✖",
2880
+ "✗",
2881
+ "✘"
2882
+ ]
2883
+ },
2884
+ "check_color": {
2885
+ "type": [
2886
+ "string",
2887
+ "null"
2888
+ ],
2889
+ "pattern": "^[A-Fa-f0-9]{6}$",
2890
+ "x-pattern-message": "must be a 6-digit hex color without #, like FF0000"
2891
+ },
2892
+ "qrcode_color": {
2893
+ "type": [
2894
+ "string",
2895
+ "null"
2896
+ ],
2897
+ "pattern": "^[A-Fa-f0-9]{6}$",
2898
+ "x-pattern-message": "must be a 6-digit hex color without #, like FF0000"
2899
+ },
2900
+ "true_text": {
2901
+ "type": [
2902
+ "string",
2903
+ "null"
2904
+ ]
2905
+ },
2906
+ "false_text": {
2907
+ "type": [
2908
+ "string",
2909
+ "null"
2910
+ ]
2911
+ },
2912
+ "condition": {
2913
+ "type": [
2914
+ "string",
2915
+ "null"
2916
+ ]
2917
+ },
2918
+ "string_condition_type": {
2919
+ "type": "string",
2920
+ "enum": [
2921
+ "equals",
2922
+ "contains",
2923
+ "starts_with",
2924
+ "ends_with",
2925
+ "regex"
2926
+ ]
2927
+ },
2928
+ "number_condition_type": {
2929
+ "type": "string",
2930
+ "enum": [
2931
+ "equals",
2932
+ "range",
2933
+ "gte",
2934
+ "gt",
2935
+ "lte",
2936
+ "lt"
2937
+ ]
2938
+ },
2939
+ "number_condition_range_min": {
2940
+ "type": [
2941
+ "number",
2942
+ "null"
2943
+ ]
2944
+ },
2945
+ "number_condition_range_max": {
2946
+ "type": [
2947
+ "number",
2948
+ "null"
2949
+ ]
2950
+ },
2951
+ "number_condition_range_exclusive_min": {
2952
+ "type": "boolean"
2953
+ },
2954
+ "number_condition_range_exclusive_max": {
2955
+ "type": "boolean"
2956
+ },
2957
+ "invert_boolean_condition": {
2958
+ "type": "boolean"
2959
+ },
2960
+ "decimal_places": {
2961
+ "type": [
2962
+ "integer",
2963
+ "null"
2964
+ ],
2965
+ "minimum": 0,
2966
+ "maximum": 99
2967
+ },
2968
+ "image_scale_type": {
2969
+ "type": "string",
2970
+ "enum": [
2971
+ "fit",
2972
+ "fill",
2973
+ "stretch"
2974
+ ]
2975
+ },
2976
+ "image_gravity": {
2977
+ "type": "string",
2978
+ "enum": [
2979
+ "NorthWest",
2980
+ "North",
2981
+ "NorthEast",
2982
+ "West",
2983
+ "Center",
2984
+ "East",
2985
+ "SouthWest",
2986
+ "South",
2987
+ "SouthEast"
2988
+ ]
2989
+ }
2990
+ },
2991
+ "x-unknown-property-message": "isn't a field setting",
2992
+ "x-not-allowed-properties": {
2993
+ "id": "can't be changed for one submission. Change the field in the template",
2994
+ "name": "can't be changed for one submission. Change the field in the template",
2995
+ "type": "can't be changed for one submission. Change the field in the template",
2996
+ "field_count": "can't be changed for one submission. Change the field in the template",
2997
+ "fieldCount": "can't be changed for one submission. Change the field in the template",
2998
+ "dependencies": "can't be changed for one submission. Change the field in the template",
2999
+ "acroform_name": "can't be changed for one submission. Change the field in the template",
3000
+ "allow_additional_items": "can't be changed for one submission. Change the field in the template",
3001
+ "allowAdditionalItems": "can't be changed for one submission. Change the field in the template",
3002
+ "min_items": "can't be changed for one submission. Change the field in the template",
3003
+ "minItems": "can't be changed for one submission. Change the field in the template",
3004
+ "max_items": "can't be changed for one submission. Change the field in the template",
3005
+ "maxItems": "can't be changed for one submission. Change the field in the template",
3006
+ "description": "can't be changed for one submission: the template's setting always applies. Change it in the template",
3007
+ "placeholder": "can't be changed for one submission: the template's setting always applies. Change it in the template",
3008
+ "metadata": "can't be changed for one submission: the template's setting always applies. Change it in the template",
3009
+ "minimum": "can't be changed for one submission: the template's setting always applies. Change it in the template",
3010
+ "maximum": "can't be changed for one submission: the template's setting always applies. Change it in the template",
3011
+ "exclusive_minimum": "can't be changed for one submission: the template's setting always applies. Change it in the template",
3012
+ "exclusiveMinimum": "can't be changed for one submission: the template's setting always applies. Change it in the template",
3013
+ "exclusive_maximum": "can't be changed for one submission: the template's setting always applies. Change it in the template",
3014
+ "exclusiveMaximum": "can't be changed for one submission: the template's setting always applies. Change it in the template",
3015
+ "currency": "can't be changed for one submission: the template's setting always applies. Change it in the template",
3016
+ "min_length": "can't be changed for one submission: the template's setting always applies. Change it in the template",
3017
+ "minLength": "can't be changed for one submission: the template's setting always applies. Change it in the template",
3018
+ "auto_calculate_max_length": "can't be changed for one submission: the template's setting always applies. Change it in the template",
3019
+ "autoCalculateMaxLength": "can't be changed for one submission: the template's setting always applies. Change it in the template",
3020
+ "color_field_name": "can't be changed for one submission: the template's setting always applies. Change it in the template",
3021
+ "colorFieldName": "can't be changed for one submission: the template's setting always applies. Change it in the template",
3022
+ "color_field_required": "can't be changed for one submission: the template's setting always applies. Change it in the template",
3023
+ "colorFieldRequired": "can't be changed for one submission: the template's setting always applies. Change it in the template",
3024
+ "background_color_field_name": "can't be changed for one submission: the template's setting always applies. Change it in the template",
3025
+ "backgroundColorFieldName": "can't be changed for one submission: the template's setting always applies. Change it in the template",
3026
+ "background_color_field_required": "can't be changed for one submission: the template's setting always applies. Change it in the template",
3027
+ "backgroundColorFieldRequired": "can't be changed for one submission: the template's setting always applies. Change it in the template",
3028
+ "check_color_field_name": "can't be changed for one submission: the template's setting always applies. Change it in the template",
3029
+ "checkColorFieldName": "can't be changed for one submission: the template's setting always applies. Change it in the template",
3030
+ "check_color_field_required": "can't be changed for one submission: the template's setting always applies. Change it in the template",
3031
+ "checkColorFieldRequired": "can't be changed for one submission: the template's setting always applies. Change it in the template",
3032
+ "qrcode_color_field_name": "can't be changed for one submission: the template's setting always applies. Change it in the template",
3033
+ "qrcodeColorFieldName": "can't be changed for one submission: the template's setting always applies. Change it in the template",
3034
+ "qrcode_color_field_required": "can't be changed for one submission: the template's setting always applies. Change it in the template",
3035
+ "qrcodeColorFieldRequired": "can't be changed for one submission: the template's setting always applies. Change it in the template",
3036
+ "shape_border_color_field_name": "can't be changed for one submission: the template's setting always applies. Change it in the template",
3037
+ "shapeBorderColorFieldName": "can't be changed for one submission: the template's setting always applies. Change it in the template",
3038
+ "shape_border_color_field_required": "can't be changed for one submission: the template's setting always applies. Change it in the template",
3039
+ "shapeBorderColorFieldRequired": "can't be changed for one submission: the template's setting always applies. Change it in the template",
3040
+ "shape_fill_color_field_name": "can't be changed for one submission: the template's setting always applies. Change it in the template",
3041
+ "shapeFillColorFieldName": "can't be changed for one submission: the template's setting always applies. Change it in the template",
3042
+ "shape_fill_color_field_required": "can't be changed for one submission: the template's setting always applies. Change it in the template",
3043
+ "shapeFillColorFieldRequired": "can't be changed for one submission: the template's setting always applies. Change it in the template"
3044
+ },
3045
+ "additionalProperties": false
3046
+ },
3047
+ "FieldPresenceCondition": {
3048
+ "type": "object",
3049
+ "required": [
3050
+ "field",
3051
+ "operator"
3052
+ ],
3053
+ "properties": {
3054
+ "field": {
3055
+ "type": "string"
3056
+ },
3057
+ "operator": {
3058
+ "type": "string",
3059
+ "enum": [
3060
+ "present",
3061
+ "blank"
3062
+ ]
3063
+ }
3064
+ },
3065
+ "additionalProperties": false,
3066
+ "x-not-allowed-properties": {
3067
+ "value": "isn't used by 'present' or 'blank' conditions. Remove it",
3068
+ "range_max": "isn't used by 'present' or 'blank' conditions. Remove it"
3069
+ }
3070
+ },
3071
+ "FieldRangeCondition": {
3072
+ "type": "object",
3073
+ "required": [
3074
+ "field",
3075
+ "operator"
3076
+ ],
3077
+ "properties": {
3078
+ "field": {
3079
+ "type": "string"
3080
+ },
3081
+ "operator": {
3082
+ "type": "string",
3083
+ "const": "range"
3084
+ },
3085
+ "value": {
3086
+ "type": [
3087
+ "number",
3088
+ "string",
3089
+ "null"
3090
+ ],
3091
+ "pattern": "^-?\\d+(\\.\\d+)?([eE][-+]?\\d+)?$",
3092
+ "x-pattern-message": "must be a number, like 10 or 2.5"
3093
+ },
3094
+ "range_max": {
3095
+ "type": [
3096
+ "number",
3097
+ "string",
3098
+ "null"
3099
+ ],
3100
+ "pattern": "^-?\\d+(\\.\\d+)?([eE][-+]?\\d+)?$",
3101
+ "x-pattern-message": "must be a number, like 10 or 2.5"
3102
+ }
3103
+ },
3104
+ "additionalProperties": false
3105
+ },
3106
+ "SubmissionSourcePdf": {
3107
+ "type": "object",
3108
+ "required": [
3109
+ "type",
3110
+ "id"
3111
+ ],
3112
+ "properties": {
3113
+ "type": {
3114
+ "type": "string",
3115
+ "const": "submission"
3116
+ },
3117
+ "id": {
3118
+ "type": "string",
3119
+ "minLength": 1
3120
+ }
3121
+ },
3122
+ "additionalProperties": false,
3123
+ "x-not-allowed-properties": {
3124
+ "url": "isn't used by 'submission' source PDFs. Remove it",
3125
+ "template_version": "isn't used by 'submission' source PDFs. Remove it",
3126
+ "processed": "isn't used by 'submission' source PDFs. Remove it"
3127
+ }
3128
+ },
3129
+ "TemplateSourcePdf": {
3130
+ "type": "object",
3131
+ "required": [
3132
+ "type",
3133
+ "id"
3134
+ ],
3135
+ "properties": {
3136
+ "type": {
3137
+ "type": "string",
3138
+ "const": "template"
3139
+ },
3140
+ "id": {
3141
+ "type": "string",
3142
+ "minLength": 1
3143
+ },
3144
+ "template_version": {
3145
+ "type": "string",
3146
+ "pattern": "^(\\d+(\\.\\d+(\\.\\d+)?)?|latest|draft)$",
3147
+ "x-pattern-message": "must be a version like 1.2.3 or 1, or latest or draft"
3148
+ },
3149
+ "processed": {
3150
+ "type": "boolean"
3151
+ }
3152
+ },
3153
+ "additionalProperties": false,
3154
+ "x-not-allowed-properties": {
3155
+ "url": "isn't used by 'template' source PDFs. Remove it"
3156
+ }
3157
+ },
3158
+ "UrlSourcePdf": {
3159
+ "type": "object",
3160
+ "required": [
3161
+ "type",
3162
+ "url"
3163
+ ],
3164
+ "properties": {
3165
+ "type": {
3166
+ "type": "string",
3167
+ "const": "url"
3168
+ },
3169
+ "url": {
3170
+ "type": "string",
3171
+ "format": "uri"
3172
+ }
3173
+ },
3174
+ "additionalProperties": false,
3175
+ "x-not-allowed-properties": {
3176
+ "id": "isn't used by 'url' source PDFs. Remove it",
3177
+ "template_version": "isn't used by 'url' source PDFs. Remove it",
3178
+ "processed": "isn't used by 'url' source PDFs. Remove it"
3179
+ }
3180
+ }
3181
+ }
3182
+ },
3183
+ "formatMessages": {
3184
+ "uri": "must be a full URL, like https://example.com",
3185
+ "date-time": "must be a date and time in RFC 3339 format, like 2026-10-20T09:00:00Z"
3186
+ }
3187
+ }