docspring 3.5.0 → 4.1.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 (588) hide show
  1. checksums.yaml +4 -4
  2. data/.openapi-generator/FILES +445 -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 +147 -0
  8. data/Gemfile.lock +7 -7
  9. data/README.md +69 -53
  10. data/docs/AddTemplateFieldsRequest.md +18 -0
  11. data/docs/{RenameFolderData.md → AiFieldNamingLanguage.md} +2 -5
  12. data/docs/AuthenticationCheck.md +18 -0
  13. data/docs/{CreateFolderData.md → BarcodeSymbology.md} +2 -5
  14. data/docs/{CreateWebhookData.md → CheckCharacter.md} +2 -5
  15. data/docs/Client.md +1570 -786
  16. data/docs/{UpdateWebhookData.md → CombinedFieldType.md} +2 -5
  17. data/docs/CombinedPdf.md +44 -0
  18. data/docs/CombinedPdfFiles.md +18 -0
  19. data/docs/CombinedPdfList.md +20 -0
  20. data/docs/CombinedPdfSource.md +26 -0
  21. data/docs/CombinedPdfSourceInput.md +88 -0
  22. data/docs/CombinedPdfSourcePdf.md +20 -0
  23. data/docs/CombinedPdfSourceType.md +15 -0
  24. data/docs/CombinedPdfState.md +15 -0
  25. data/docs/CopyTemplateRequest.md +22 -0
  26. data/docs/CreateCombinedPdfRequest.md +26 -0
  27. data/docs/CreateCustomFileFromUploadRequest.md +18 -0
  28. data/docs/CreateFolderRequest.md +20 -0
  29. data/docs/CreateSignatureRequestEventRequest.md +24 -0
  30. data/docs/CreateSignatureRequestTokenRequest.md +18 -0
  31. data/docs/CreateSubmissionBatchRequest.md +28 -0
  32. data/docs/CreateSubmissionRequest.md +38 -0
  33. data/docs/CreateTemplateRequest.md +102 -0
  34. data/docs/CreateWebhookRequest.md +38 -0
  35. data/docs/CustomFile.md +11 -3
  36. data/docs/CustomFileList.md +20 -0
  37. data/docs/CustomFileSourcePdf.md +20 -0
  38. data/docs/ErrorCode.md +15 -0
  39. data/docs/ErrorDetail.md +26 -0
  40. data/docs/ErrorInfo.md +32 -0
  41. data/docs/ErrorResponse.md +1 -3
  42. data/docs/ExpirationInterval.md +15 -0
  43. data/docs/Field.md +198 -0
  44. data/docs/FieldComparisonCondition.md +22 -0
  45. data/docs/FieldComparisonOperator.md +15 -0
  46. data/docs/FieldDependency.md +22 -0
  47. data/docs/FieldDependencyInput.md +22 -0
  48. data/docs/FieldDisplayType.md +15 -0
  49. data/docs/FieldEqualsCondition.md +22 -0
  50. data/docs/FieldEqualsOperator.md +15 -0
  51. data/docs/FieldGroup.md +32 -0
  52. data/docs/FieldGroupInput.md +30 -0
  53. data/docs/FieldGroupType.md +15 -0
  54. data/docs/FieldInCondition.md +22 -0
  55. data/docs/FieldInput.md +196 -0
  56. data/docs/FieldOverride.md +142 -0
  57. data/docs/FieldPresenceCondition.md +20 -0
  58. data/docs/FieldPresenceOperator.md +15 -0
  59. data/docs/FieldRangeCondition.md +24 -0
  60. data/docs/FieldReimportState.md +15 -0
  61. data/docs/FieldSetupLogic.md +15 -0
  62. data/docs/FieldSetupNaming.md +15 -0
  63. data/docs/FieldSetupSource.md +15 -0
  64. data/docs/FieldType.md +15 -0
  65. data/docs/Folder.md +9 -5
  66. data/docs/FolderList.md +20 -0
  67. data/docs/GenerateFilesFormat.md +15 -0
  68. data/docs/GenerateSubmissionFilesRequest.md +18 -0
  69. data/docs/GeneratedFile.md +32 -0
  70. data/docs/GeneratedFileState.md +15 -0
  71. data/docs/HtmlEngineOptions.md +36 -0
  72. data/docs/HtmlEngineOptionsInput.md +36 -0
  73. data/docs/ImageGravity.md +15 -0
  74. data/docs/ImageScaleType.md +15 -0
  75. data/docs/ModelCodeLanguage.md +15 -0
  76. data/docs/MoveFolderRequest.md +18 -0
  77. data/docs/MoveTemplateRequest.md +18 -0
  78. data/docs/NumberConditionType.md +15 -0
  79. data/docs/OutputFormat.md +15 -0
  80. data/docs/PageFormat.md +15 -0
  81. data/docs/PageImage.md +34 -0
  82. data/docs/PageImages.md +24 -0
  83. data/docs/PredefinedField.md +30 -0
  84. data/docs/PredefinedFieldInput.md +30 -0
  85. data/docs/PublishTemplateVersionRequest.md +20 -0
  86. data/docs/RemoveTemplateFieldsRequest.md +18 -0
  87. data/docs/RenameFolderRequest.md +18 -0
  88. data/docs/ReorderTemplateFieldsRequest.md +18 -0
  89. data/docs/RestoreTemplateVersionRequest.md +18 -0
  90. data/docs/ShapeType.md +15 -0
  91. data/docs/SignatureRequest.md +66 -0
  92. data/docs/SignatureRequestAuthSecondFactorType.md +15 -0
  93. data/docs/SignatureRequestAuthType.md +15 -0
  94. data/docs/SignatureRequestEvent.md +32 -0
  95. data/docs/SignatureRequestEventType.md +15 -0
  96. data/docs/SignatureRequestInput.md +46 -0
  97. data/docs/SignatureRequestMessageType.md +15 -0
  98. data/docs/SignatureRequestState.md +15 -0
  99. data/docs/SignatureRequestToken.md +30 -0
  100. data/docs/SignatureRequestTokenType.md +15 -0
  101. data/docs/StringConditionType.md +15 -0
  102. data/docs/Submission.md +43 -47
  103. data/docs/SubmissionAction.md +6 -8
  104. data/docs/SubmissionActionState.md +15 -0
  105. data/docs/SubmissionActionType.md +15 -0
  106. data/docs/SubmissionBatch.md +16 -10
  107. data/docs/SubmissionBatchState.md +15 -0
  108. data/docs/SubmissionFiles.md +24 -0
  109. data/docs/SubmissionInput.md +40 -0
  110. data/docs/SubmissionList.md +20 -0
  111. data/docs/SubmissionSource.md +15 -0
  112. data/docs/SubmissionSourcePdf.md +20 -0
  113. data/docs/SubmissionState.md +15 -0
  114. data/docs/SubmissionValidation.md +24 -0
  115. data/docs/Template.md +79 -107
  116. data/docs/TemplateActor.md +26 -0
  117. data/docs/TemplateActorType.md +15 -0
  118. data/docs/TemplateDefaults.md +56 -0
  119. data/docs/TemplateDefaultsInput.md +56 -0
  120. data/docs/TemplateDiff.md +30 -0
  121. data/docs/TemplateDiffSummary.md +28 -0
  122. data/docs/TemplateDocument.md +40 -0
  123. data/docs/TemplateDocumentState.md +15 -0
  124. data/docs/TemplateFieldChange.md +24 -0
  125. data/docs/TemplateFieldChanges.md +24 -0
  126. data/docs/TemplateFieldDependency.md +26 -0
  127. data/docs/TemplateFieldDependencyAction.md +15 -0
  128. data/docs/TemplateFieldDependencyCondition.md +24 -0
  129. data/docs/TemplateFieldDependencyConditionInput.md +93 -0
  130. data/docs/TemplateFieldDependencyInput.md +26 -0
  131. data/docs/TemplateFieldDependencyMatch.md +15 -0
  132. data/docs/TemplateFieldDependencyOperator.md +15 -0
  133. data/docs/TemplateFieldLogicStatus.md +15 -0
  134. data/docs/TemplateFieldMove.md +22 -0
  135. data/docs/TemplateFields.md +22 -0
  136. data/docs/TemplateFormMode.md +15 -0
  137. data/docs/TemplateModelCode.md +22 -0
  138. data/docs/TemplatePageAiError.md +15 -0
  139. data/docs/TemplatePageAiNamingStatus.md +15 -0
  140. data/docs/TemplatePageFieldsStatus.md +15 -0
  141. data/docs/TemplatePageImageStatus.md +15 -0
  142. data/docs/TemplatePageImages.md +24 -0
  143. data/docs/TemplatePageProcessingStatus.md +26 -0
  144. data/docs/TemplateSourcePdf.md +24 -0
  145. data/docs/TemplateSummary.md +90 -0
  146. data/docs/TemplateSummaryList.md +20 -0
  147. data/docs/TemplateType.md +15 -0
  148. data/docs/TemplateVersion.md +24 -0
  149. data/docs/TemplateVersionType.md +15 -0
  150. data/docs/TextAlignment.md +15 -0
  151. data/docs/TextOverflow.md +15 -0
  152. data/docs/TextVerticalAlignment.md +15 -0
  153. data/docs/Typeface.md +15 -0
  154. data/docs/UpdateSignatureRequestRequest.md +34 -0
  155. data/docs/UpdateTemplateDocumentRequest.md +26 -0
  156. data/docs/UpdateTemplateFieldsRequest.md +18 -0
  157. data/docs/UpdateTemplateRequest.md +86 -0
  158. data/docs/UpdateWebhookRequest.md +38 -0
  159. data/docs/UploadMethod.md +15 -0
  160. data/docs/UploadPresign.md +24 -0
  161. data/docs/UrlSourcePdf.md +20 -0
  162. data/docs/ValidateSubmissionRequest.md +38 -0
  163. data/docs/Webhook.md +20 -20
  164. data/docs/WebhookEventType.md +15 -0
  165. data/docs/WebhookList.md +20 -0
  166. data/docs/WebhookMode.md +15 -0
  167. data/docspring.gemspec +3 -3
  168. data/lib/docspring/api/client.rb +1606 -905
  169. data/lib/docspring/api_client.rb +14 -6
  170. data/lib/docspring/api_error.rb +3 -3
  171. data/lib/docspring/api_model_base.rb +88 -0
  172. data/lib/docspring/configuration.rb +12 -7
  173. data/lib/docspring/models/add_template_fields_request.rb +187 -0
  174. data/lib/docspring/models/ai_field_naming_language.rb +42 -0
  175. data/lib/docspring/models/authentication_check.rb +185 -0
  176. data/lib/docspring/models/barcode_symbology.rb +47 -0
  177. data/lib/docspring/models/check_character.rb +44 -0
  178. data/lib/docspring/models/combined_field_type.rb +41 -0
  179. data/lib/docspring/models/{combined_submission.rb → combined_pdf.rb} +228 -206
  180. data/lib/docspring/models/combined_pdf_files.rb +167 -0
  181. data/lib/docspring/models/combined_pdf_list.rb +200 -0
  182. data/lib/docspring/models/{create_webhook_data.rb → combined_pdf_source.rb} +107 -103
  183. data/lib/docspring/models/combined_pdf_source_input.rb +62 -0
  184. data/lib/docspring/models/combined_pdf_source_pdf.rb +212 -0
  185. data/lib/docspring/models/combined_pdf_source_type.rb +44 -0
  186. data/lib/docspring/models/combined_pdf_state.rb +44 -0
  187. data/lib/docspring/models/{copy_template_options.rb → copy_template_request.rb} +32 -87
  188. data/lib/docspring/models/{combine_pdfs_data.rb → create_combined_pdf_request.rb} +60 -123
  189. data/lib/docspring/models/{create_custom_file_data.rb → create_custom_file_from_upload_request.rb} +29 -96
  190. data/lib/docspring/models/{move_template_data.rb → create_folder_request.rb} +60 -102
  191. data/lib/docspring/models/{create_submission_data_request_event_request.rb → create_signature_request_event_request.rb} +50 -122
  192. data/lib/docspring/models/create_signature_request_token_request.rb +190 -0
  193. data/lib/docspring/models/{submission_batch_data.rb → create_submission_batch_request.rb} +75 -108
  194. data/lib/docspring/models/{create_pdf_submission_data.rb → create_submission_request.rb} +114 -144
  195. data/lib/docspring/models/create_template_request.rb +646 -0
  196. data/lib/docspring/models/create_webhook_request.rb +368 -0
  197. data/lib/docspring/models/custom_file.rb +132 -95
  198. data/lib/docspring/models/custom_file_list.rb +200 -0
  199. data/lib/docspring/models/custom_file_source_pdf.rb +212 -0
  200. data/lib/docspring/models/error_code.rb +60 -0
  201. data/lib/docspring/models/error_detail.rb +242 -0
  202. data/lib/docspring/models/error_info.rb +316 -0
  203. data/lib/docspring/models/error_response.rb +28 -138
  204. data/lib/docspring/models/expiration_interval.rb +42 -0
  205. data/lib/docspring/models/field.rb +2217 -0
  206. data/lib/docspring/models/field_comparison_condition.rb +247 -0
  207. data/lib/docspring/models/field_comparison_operator.rb +43 -0
  208. data/lib/docspring/models/field_dependency.rb +246 -0
  209. data/lib/docspring/models/field_dependency_input.rb +246 -0
  210. data/lib/docspring/models/field_display_type.rb +45 -0
  211. data/lib/docspring/models/field_equals_condition.rb +247 -0
  212. data/lib/docspring/models/field_equals_operator.rb +41 -0
  213. data/lib/docspring/models/field_group.rb +368 -0
  214. data/lib/docspring/models/field_group_input.rb +247 -0
  215. data/lib/docspring/models/field_group_type.rb +41 -0
  216. data/lib/docspring/models/{create_folder_data.rb → field_in_condition.rb} +101 -103
  217. data/lib/docspring/models/field_input.rb +1109 -0
  218. data/lib/docspring/models/field_override.rb +829 -0
  219. data/lib/docspring/models/field_presence_condition.rb +234 -0
  220. data/lib/docspring/models/field_presence_operator.rb +41 -0
  221. data/lib/docspring/models/field_range_condition.rb +234 -0
  222. data/lib/docspring/models/field_reimport_state.rb +43 -0
  223. data/lib/docspring/models/field_setup_logic.rb +41 -0
  224. data/lib/docspring/models/field_setup_naming.rb +41 -0
  225. data/lib/docspring/models/field_setup_source.rb +42 -0
  226. data/lib/docspring/models/field_type.rb +54 -0
  227. data/lib/docspring/models/folder.rb +134 -93
  228. data/lib/docspring/models/folder_list.rb +200 -0
  229. data/lib/docspring/models/generate_files_format.rb +40 -0
  230. data/lib/docspring/models/generate_submission_files_request.rb +187 -0
  231. data/lib/docspring/models/generated_file.rb +326 -0
  232. data/lib/docspring/models/generated_file_state.rb +42 -0
  233. data/lib/docspring/models/html_engine_options.rb +416 -0
  234. data/lib/docspring/models/html_engine_options_input.rb +280 -0
  235. data/lib/docspring/models/image_gravity.rb +48 -0
  236. data/lib/docspring/models/image_scale_type.rb +42 -0
  237. data/lib/docspring/models/model_code_language.rb +48 -0
  238. data/lib/docspring/models/{move_folder_data.rb → move_folder_request.rb} +31 -87
  239. data/lib/docspring/models/move_template_request.rb +171 -0
  240. data/lib/docspring/models/number_condition_type.rb +45 -0
  241. data/lib/docspring/models/output_format.rb +41 -0
  242. data/lib/docspring/models/page_format.rb +52 -0
  243. data/lib/docspring/models/page_image.rb +359 -0
  244. data/lib/docspring/models/page_images.rb +248 -0
  245. data/lib/docspring/models/predefined_field.rb +287 -0
  246. data/lib/docspring/models/predefined_field_input.rb +287 -0
  247. data/lib/docspring/models/{publish_version_data.rb → publish_template_version_request.rb} +64 -99
  248. data/lib/docspring/models/remove_template_fields_request.rb +187 -0
  249. data/lib/docspring/models/{rename_folder_data.rb → rename_folder_request.rb} +29 -87
  250. data/lib/docspring/models/reorder_template_fields_request.rb +187 -0
  251. data/lib/docspring/models/{restore_version_data.rb → restore_template_version_request.rb} +29 -87
  252. data/lib/docspring/models/shape_type.rb +45 -0
  253. data/lib/docspring/models/{submission_data_request_show.rb → signature_request.rb} +240 -171
  254. data/lib/docspring/models/signature_request_auth_second_factor_type.rb +45 -0
  255. data/lib/docspring/models/signature_request_auth_type.rb +46 -0
  256. data/lib/docspring/models/{submission_data_request_event.rb → signature_request_event.rb} +137 -122
  257. data/lib/docspring/models/signature_request_event_type.rb +45 -0
  258. data/lib/docspring/models/{update_submission_data_request_data.rb → signature_request_input.rb} +156 -173
  259. data/lib/docspring/models/signature_request_message_type.rb +48 -0
  260. data/lib/docspring/models/signature_request_state.rb +42 -0
  261. data/lib/docspring/models/signature_request_token.rb +369 -0
  262. data/lib/docspring/models/signature_request_token_type.rb +41 -0
  263. data/lib/docspring/models/string_condition_type.rb +44 -0
  264. data/lib/docspring/models/submission.rb +399 -335
  265. data/lib/docspring/models/submission_action.rb +64 -136
  266. data/lib/docspring/models/submission_action_state.rb +43 -0
  267. data/lib/docspring/models/submission_action_type.rb +46 -0
  268. data/lib/docspring/models/submission_batch.rb +157 -112
  269. data/lib/docspring/models/submission_batch_state.rb +42 -0
  270. data/lib/docspring/models/submission_files.rb +197 -0
  271. data/lib/docspring/models/submission_input.rb +296 -0
  272. data/lib/docspring/models/submission_list.rb +200 -0
  273. data/lib/docspring/models/submission_source.rb +43 -0
  274. data/lib/docspring/models/submission_source_pdf.rb +212 -0
  275. data/lib/docspring/models/submission_state.rb +52 -0
  276. data/lib/docspring/models/submission_validation.rb +234 -0
  277. data/lib/docspring/models/template.rb +528 -736
  278. data/lib/docspring/models/template_actor.rb +259 -0
  279. data/lib/docspring/models/template_actor_type.rb +42 -0
  280. data/lib/docspring/models/template_defaults.rb +395 -0
  281. data/lib/docspring/models/template_defaults_input.rb +395 -0
  282. data/lib/docspring/models/template_diff.rb +321 -0
  283. data/lib/docspring/models/template_diff_summary.rb +320 -0
  284. data/lib/docspring/models/template_document.rb +396 -0
  285. data/lib/docspring/models/template_document_state.rb +46 -0
  286. data/lib/docspring/models/template_field_change.rb +266 -0
  287. data/lib/docspring/models/template_field_changes.rb +274 -0
  288. data/lib/docspring/models/{success_error_response.rb → template_field_dependency.rb} +122 -114
  289. data/lib/docspring/models/template_field_dependency_action.rb +42 -0
  290. data/lib/docspring/models/{create_pdf_template.rb → template_field_dependency_condition.rb} +116 -103
  291. data/lib/docspring/models/template_field_dependency_condition_input.rb +67 -0
  292. data/lib/docspring/models/template_field_dependency_input.rb +285 -0
  293. data/lib/docspring/models/template_field_dependency_match.rb +41 -0
  294. data/lib/docspring/models/template_field_dependency_operator.rb +49 -0
  295. data/lib/docspring/models/template_field_logic_status.rb +44 -0
  296. data/lib/docspring/models/{update_webhook_data.rb → template_field_move.rb} +99 -103
  297. data/lib/docspring/models/{add_fields_data.rb → template_fields.rb} +71 -89
  298. data/lib/docspring/models/template_form_mode.rb +42 -0
  299. data/lib/docspring/models/{template_model_code_response.rb → template_model_code.rb} +37 -96
  300. data/lib/docspring/models/template_page_ai_error.rb +43 -0
  301. data/lib/docspring/models/template_page_ai_naming_status.rb +41 -0
  302. data/lib/docspring/models/template_page_fields_status.rb +44 -0
  303. data/lib/docspring/models/template_page_image_status.rb +41 -0
  304. data/lib/docspring/models/template_page_images.rb +254 -0
  305. data/lib/docspring/models/template_page_processing_status.rb +275 -0
  306. data/lib/docspring/models/{update_pdf_template.rb → template_source_pdf.rb} +92 -103
  307. data/lib/docspring/models/{template_preview.rb → template_summary.rb} +436 -589
  308. data/lib/docspring/models/template_summary_list.rb +200 -0
  309. data/lib/docspring/models/template_type.rb +41 -0
  310. data/lib/docspring/models/template_version.rb +238 -0
  311. data/lib/docspring/models/template_version_type.rb +42 -0
  312. data/lib/docspring/models/text_alignment.rb +43 -0
  313. data/lib/docspring/models/text_overflow.rb +41 -0
  314. data/lib/docspring/models/text_vertical_alignment.rb +42 -0
  315. data/lib/docspring/models/typeface.rb +56 -0
  316. data/lib/docspring/models/{create_submission_data_request_data.rb → update_signature_request_request.rb} +72 -196
  317. data/lib/docspring/models/update_template_document_request.rb +208 -0
  318. data/lib/docspring/models/update_template_fields_request.rb +187 -0
  319. data/lib/docspring/models/update_template_request.rb +551 -0
  320. data/lib/docspring/models/update_webhook_request.rb +344 -0
  321. data/lib/docspring/models/upload_method.rb +40 -0
  322. data/lib/docspring/models/{upload_presign_response.rb → upload_presign.rb} +93 -140
  323. data/lib/docspring/models/url_source_pdf.rb +212 -0
  324. data/lib/docspring/models/validate_submission_request.rb +288 -0
  325. data/lib/docspring/models/webhook.rb +97 -107
  326. data/lib/docspring/models/webhook_event_type.rb +64 -0
  327. data/lib/docspring/models/webhook_list.rb +200 -0
  328. data/lib/docspring/models/webhook_mode.rb +41 -0
  329. data/lib/docspring/request_schemas.json +4967 -0
  330. data/lib/docspring/request_validator.rb +396 -0
  331. data/lib/docspring/version.rb +4 -4
  332. data/lib/docspring.rb +153 -53
  333. data/spec/api/client_spec.rb +411 -265
  334. data/spec/models/add_template_fields_request_spec.rb +36 -0
  335. data/spec/models/ai_field_naming_language_spec.rb +30 -0
  336. data/spec/models/authentication_check_spec.rb +36 -0
  337. data/spec/models/barcode_symbology_spec.rb +30 -0
  338. data/spec/models/check_character_spec.rb +30 -0
  339. data/spec/models/combined_field_type_spec.rb +30 -0
  340. data/spec/models/combined_pdf_files_spec.rb +36 -0
  341. data/spec/models/combined_pdf_list_spec.rb +42 -0
  342. data/spec/models/combined_pdf_source_input_spec.rb +44 -0
  343. data/spec/models/combined_pdf_source_pdf_spec.rb +42 -0
  344. data/spec/models/{submission_data_request_token_spec.rb → combined_pdf_source_spec.rb} +18 -12
  345. data/spec/models/combined_pdf_source_type_spec.rb +30 -0
  346. data/spec/models/{combined_submission_spec.rb → combined_pdf_spec.rb} +20 -24
  347. data/spec/models/combined_pdf_state_spec.rb +30 -0
  348. data/spec/models/{copy_template_options_spec.rb → copy_template_request_spec.rb} +9 -9
  349. data/spec/models/{combine_pdfs_data_spec.rb → create_combined_pdf_request_spec.rb} +12 -18
  350. data/spec/models/{create_custom_file_data_spec.rb → create_custom_file_from_upload_request_spec.rb} +9 -9
  351. data/spec/models/{move_template_data_spec.rb → create_folder_request_spec.rb} +11 -11
  352. data/spec/models/{list_submissions_response_spec.rb → create_signature_request_event_request_spec.rb} +18 -12
  353. data/spec/models/create_signature_request_token_request_spec.rb +36 -0
  354. data/spec/models/{submission_batch_data_spec.rb → create_submission_batch_request_spec.rb} +19 -13
  355. data/spec/models/{create_pdf_submission_data_spec.rb → create_submission_request_spec.rb} +29 -17
  356. data/spec/models/{template_preview_spec.rb → create_template_request_spec.rb} +49 -103
  357. data/spec/models/create_webhook_request_spec.rb +96 -0
  358. data/spec/models/custom_file_list_spec.rb +42 -0
  359. data/spec/models/custom_file_source_pdf_spec.rb +42 -0
  360. data/spec/models/custom_file_spec.rb +29 -5
  361. data/spec/models/error_code_spec.rb +30 -0
  362. data/spec/models/{create_submission_response_spec.rb → error_detail_spec.rb} +14 -18
  363. data/spec/models/{batch_generate_pdfs201_response_spec.rb → error_info_spec.rb} +27 -19
  364. data/spec/models/error_response_spec.rb +4 -14
  365. data/spec/models/expiration_interval_spec.rb +30 -0
  366. data/spec/models/field_comparison_condition_spec.rb +48 -0
  367. data/spec/models/field_comparison_operator_spec.rb +30 -0
  368. data/spec/models/field_dependency_input_spec.rb +48 -0
  369. data/spec/models/field_dependency_spec.rb +48 -0
  370. data/spec/models/field_display_type_spec.rb +30 -0
  371. data/spec/models/field_equals_condition_spec.rb +48 -0
  372. data/spec/models/field_equals_operator_spec.rb +30 -0
  373. data/spec/models/field_group_input_spec.rb +72 -0
  374. data/spec/models/field_group_spec.rb +78 -0
  375. data/spec/models/field_group_type_spec.rb +30 -0
  376. data/spec/models/field_in_condition_spec.rb +48 -0
  377. data/spec/models/field_input_spec.rb +570 -0
  378. data/spec/models/field_override_spec.rb +408 -0
  379. data/spec/models/field_presence_condition_spec.rb +42 -0
  380. data/spec/models/field_presence_operator_spec.rb +30 -0
  381. data/spec/models/field_range_condition_spec.rb +54 -0
  382. data/spec/models/field_reimport_state_spec.rb +30 -0
  383. data/spec/models/field_setup_logic_spec.rb +30 -0
  384. data/spec/models/field_setup_naming_spec.rb +30 -0
  385. data/spec/models/field_setup_source_spec.rb +30 -0
  386. data/spec/models/field_spec.rb +576 -0
  387. data/spec/models/field_type_spec.rb +30 -0
  388. data/spec/models/folder_list_spec.rb +42 -0
  389. data/spec/models/folder_spec.rb +16 -4
  390. data/spec/models/generate_files_format_spec.rb +30 -0
  391. data/spec/models/generate_submission_files_request_spec.rb +36 -0
  392. data/spec/models/generated_file_spec.rb +78 -0
  393. data/spec/models/generated_file_state_spec.rb +30 -0
  394. data/spec/models/html_engine_options_input_spec.rb +90 -0
  395. data/spec/models/html_engine_options_spec.rb +90 -0
  396. data/spec/models/image_gravity_spec.rb +30 -0
  397. data/spec/models/image_scale_type_spec.rb +30 -0
  398. data/spec/models/model_code_language_spec.rb +30 -0
  399. data/spec/models/move_folder_request_spec.rb +36 -0
  400. data/spec/models/move_template_request_spec.rb +36 -0
  401. data/spec/models/number_condition_type_spec.rb +30 -0
  402. data/spec/models/output_format_spec.rb +30 -0
  403. data/spec/models/page_format_spec.rb +30 -0
  404. data/spec/models/page_image_spec.rb +84 -0
  405. data/spec/models/page_images_spec.rb +54 -0
  406. data/spec/models/predefined_field_input_spec.rb +72 -0
  407. data/spec/models/predefined_field_spec.rb +72 -0
  408. data/spec/models/{publish_version_data_spec.rb → publish_template_version_request_spec.rb} +11 -11
  409. data/spec/models/remove_template_fields_request_spec.rb +36 -0
  410. data/spec/models/{rename_folder_data_spec.rb → rename_folder_request_spec.rb} +9 -9
  411. data/spec/models/reorder_template_fields_request_spec.rb +36 -0
  412. data/spec/models/restore_template_version_request_spec.rb +36 -0
  413. data/spec/models/shape_type_spec.rb +30 -0
  414. data/spec/models/signature_request_auth_second_factor_type_spec.rb +30 -0
  415. data/spec/models/signature_request_auth_type_spec.rb +30 -0
  416. data/spec/models/{submission_data_request_event_spec.rb → signature_request_event_spec.rb} +16 -18
  417. data/spec/models/signature_request_event_type_spec.rb +30 -0
  418. data/spec/models/{create_submission_data_request_data_spec.rb → signature_request_input_spec.rb} +28 -30
  419. data/spec/models/signature_request_message_type_spec.rb +30 -0
  420. data/spec/models/{submission_data_request_show_spec.rb → signature_request_spec.rb} +31 -31
  421. data/spec/models/signature_request_state_spec.rb +30 -0
  422. data/spec/models/signature_request_token_spec.rb +72 -0
  423. data/spec/models/signature_request_token_type_spec.rb +30 -0
  424. data/spec/models/string_condition_type_spec.rb +30 -0
  425. data/spec/models/submission_action_spec.rb +4 -22
  426. data/spec/models/submission_action_state_spec.rb +30 -0
  427. data/spec/models/submission_action_type_spec.rb +30 -0
  428. data/spec/models/submission_batch_spec.rb +27 -13
  429. data/spec/models/submission_batch_state_spec.rb +30 -0
  430. data/spec/models/submission_files_spec.rb +54 -0
  431. data/spec/models/{json_schema_spec.rb → submission_input_spec.rb} +21 -21
  432. data/spec/models/submission_list_spec.rb +42 -0
  433. data/spec/models/submission_source_pdf_spec.rb +42 -0
  434. data/spec/models/submission_source_spec.rb +30 -0
  435. data/spec/models/submission_spec.rb +27 -51
  436. data/spec/models/submission_state_spec.rb +30 -0
  437. data/spec/models/submission_validation_spec.rb +54 -0
  438. data/spec/models/template_actor_spec.rb +60 -0
  439. data/spec/models/template_actor_type_spec.rb +30 -0
  440. data/spec/models/{submission_data_request_spec.rb → template_defaults_input_spec.rb} +29 -53
  441. data/spec/models/{submission_preview_spec.rb → template_defaults_spec.rb} +29 -61
  442. data/spec/models/template_diff_spec.rb +72 -0
  443. data/spec/models/template_diff_summary_spec.rb +66 -0
  444. data/spec/models/template_document_spec.rb +102 -0
  445. data/spec/models/template_document_state_spec.rb +30 -0
  446. data/spec/models/template_field_change_spec.rb +54 -0
  447. data/spec/models/template_field_changes_spec.rb +54 -0
  448. data/spec/models/template_field_dependency_action_spec.rb +30 -0
  449. data/spec/models/template_field_dependency_condition_input_spec.rb +44 -0
  450. data/spec/models/template_field_dependency_condition_spec.rb +54 -0
  451. data/spec/models/template_field_dependency_input_spec.rb +60 -0
  452. data/spec/models/template_field_dependency_match_spec.rb +30 -0
  453. data/spec/models/template_field_dependency_operator_spec.rb +30 -0
  454. data/spec/models/template_field_dependency_spec.rb +60 -0
  455. data/spec/models/template_field_logic_status_spec.rb +30 -0
  456. data/spec/models/template_field_move_spec.rb +48 -0
  457. data/spec/models/template_fields_spec.rb +48 -0
  458. data/spec/models/template_form_mode_spec.rb +30 -0
  459. data/spec/models/{template_model_code_response_spec.rb → template_model_code_spec.rb} +9 -13
  460. data/spec/models/template_page_ai_error_spec.rb +30 -0
  461. data/spec/models/template_page_ai_naming_status_spec.rb +30 -0
  462. data/spec/models/template_page_fields_status_spec.rb +30 -0
  463. data/spec/models/template_page_image_status_spec.rb +30 -0
  464. data/spec/models/template_page_images_spec.rb +54 -0
  465. data/spec/models/template_page_processing_status_spec.rb +60 -0
  466. data/spec/models/template_source_pdf_spec.rb +54 -0
  467. data/spec/models/template_spec.rb +44 -140
  468. data/spec/models/template_summary_list_spec.rb +42 -0
  469. data/spec/models/template_summary_spec.rb +252 -0
  470. data/spec/models/template_type_spec.rb +30 -0
  471. data/spec/models/template_version_spec.rb +54 -0
  472. data/spec/models/template_version_type_spec.rb +30 -0
  473. data/spec/models/text_alignment_spec.rb +30 -0
  474. data/spec/models/text_overflow_spec.rb +30 -0
  475. data/spec/models/text_vertical_alignment_spec.rb +30 -0
  476. data/spec/models/typeface_spec.rb +30 -0
  477. data/spec/models/{submission_batch_with_submissions_spec.rb → update_signature_request_request_spec.rb} +18 -22
  478. data/spec/models/update_template_document_request_spec.rb +60 -0
  479. data/spec/models/update_template_fields_request_spec.rb +36 -0
  480. data/spec/models/update_template_request_spec.rb +240 -0
  481. data/spec/models/update_webhook_request_spec.rb +96 -0
  482. data/spec/models/upload_method_spec.rb +30 -0
  483. data/spec/models/{upload_presign_response_spec.rb → upload_presign_spec.rb} +13 -17
  484. data/spec/models/url_source_pdf_spec.rb +42 -0
  485. data/spec/models/validate_submission_request_spec.rb +96 -0
  486. data/spec/models/webhook_event_type_spec.rb +30 -0
  487. data/spec/models/webhook_list_spec.rb +42 -0
  488. data/spec/models/webhook_mode_spec.rb +30 -0
  489. data/spec/models/webhook_spec.rb +4 -8
  490. data/spec/spec_helper.rb +3 -3
  491. metadata +597 -202
  492. data/docs/AddFieldsData.md +0 -18
  493. data/docs/BatchGeneratePdfs201Response.md +0 -28
  494. data/docs/CombinePdfsData.md +0 -28
  495. data/docs/CombinedSubmission.md +0 -44
  496. data/docs/CombinedSubmissionAction.md +0 -30
  497. data/docs/CopyTemplateOptions.md +0 -22
  498. data/docs/CreateCombinedSubmissionResponse.md +0 -26
  499. data/docs/CreateCustomFileData.md +0 -18
  500. data/docs/CreateCustomFileResponse.md +0 -24
  501. data/docs/CreateHtmlTemplate.md +0 -18
  502. data/docs/CreatePdfSubmissionData.md +0 -34
  503. data/docs/CreatePdfTemplate.md +0 -18
  504. data/docs/CreateSubmissionDataRequestData.md +0 -44
  505. data/docs/CreateSubmissionDataRequestEventRequest.md +0 -24
  506. data/docs/CreateSubmissionDataRequestEventResponse.md +0 -24
  507. data/docs/CreateSubmissionDataRequestResponse.md +0 -24
  508. data/docs/CreateSubmissionDataRequestTokenResponse.md +0 -24
  509. data/docs/CreateSubmissionResponse.md +0 -26
  510. data/docs/ErrorOrMultipleErrorsResponse.md +0 -22
  511. data/docs/ForbiddenErrorResponse.md +0 -22
  512. data/docs/JsonSchema.md +0 -40
  513. data/docs/ListSubmissionsResponse.md +0 -22
  514. data/docs/MoveFolderData.md +0 -18
  515. data/docs/MoveTemplateData.md +0 -20
  516. data/docs/MultipleErrorsResponse.md +0 -20
  517. data/docs/PublishVersionData.md +0 -20
  518. data/docs/RestoreVersionData.md +0 -18
  519. data/docs/Submission422Response.md +0 -24
  520. data/docs/SubmissionBatchData.md +0 -26
  521. data/docs/SubmissionBatchWithSubmissions.md +0 -34
  522. data/docs/SubmissionDataRequest.md +0 -60
  523. data/docs/SubmissionDataRequestEvent.md +0 -30
  524. data/docs/SubmissionDataRequestShow.md +0 -62
  525. data/docs/SubmissionDataRequestToken.md +0 -24
  526. data/docs/SubmissionPreview.md +0 -64
  527. data/docs/SuccessErrorResponse.md +0 -20
  528. data/docs/SuccessMultipleErrorsResponse.md +0 -20
  529. data/docs/TemplateAddFieldsResponse.md +0 -22
  530. data/docs/TemplateDeleteResponse.md +0 -24
  531. data/docs/TemplateModelCodeResponse.md +0 -22
  532. data/docs/TemplatePreview.md +0 -116
  533. data/docs/TemplatePublishVersionResponse.md +0 -22
  534. data/docs/UpdateHtmlTemplate.md +0 -18
  535. data/docs/UpdatePdfTemplate.md +0 -18
  536. data/docs/UpdateSubmissionDataRequestData.md +0 -42
  537. data/docs/UploadPresignResponse.md +0 -24
  538. data/lib/docspring/models/batch_generate_pdfs201_response.rb +0 -352
  539. data/lib/docspring/models/combined_submission_action.rb +0 -384
  540. data/lib/docspring/models/create_combined_submission_response.rb +0 -324
  541. data/lib/docspring/models/create_custom_file_response.rb +0 -314
  542. data/lib/docspring/models/create_html_template.rb +0 -243
  543. data/lib/docspring/models/create_submission_data_request_event_response.rb +0 -314
  544. data/lib/docspring/models/create_submission_data_request_response.rb +0 -314
  545. data/lib/docspring/models/create_submission_data_request_token_response.rb +0 -314
  546. data/lib/docspring/models/create_submission_response.rb +0 -324
  547. data/lib/docspring/models/error_or_multiple_errors_response.rb +0 -290
  548. data/lib/docspring/models/forbidden_error_response.rb +0 -323
  549. data/lib/docspring/models/json_schema.rb +0 -329
  550. data/lib/docspring/models/list_submissions_response.rb +0 -283
  551. data/lib/docspring/models/multiple_errors_response.rb +0 -296
  552. data/lib/docspring/models/submission422_response.rb +0 -299
  553. data/lib/docspring/models/submission_batch_with_submissions.rb +0 -433
  554. data/lib/docspring/models/submission_data_request.rb +0 -570
  555. data/lib/docspring/models/submission_data_request_token.rb +0 -279
  556. data/lib/docspring/models/submission_preview.rb +0 -637
  557. data/lib/docspring/models/success_multiple_errors_response.rb +0 -279
  558. data/lib/docspring/models/template_add_fields_response.rb +0 -290
  559. data/lib/docspring/models/template_delete_response.rb +0 -300
  560. data/lib/docspring/models/template_publish_version_response.rb +0 -305
  561. data/lib/docspring/models/update_html_template.rb +0 -243
  562. data/spec/models/add_fields_data_spec.rb +0 -36
  563. data/spec/models/combined_submission_action_spec.rb +0 -84
  564. data/spec/models/create_combined_submission_response_spec.rb +0 -64
  565. data/spec/models/create_custom_file_response_spec.rb +0 -58
  566. data/spec/models/create_folder_data_spec.rb +0 -36
  567. data/spec/models/create_html_template_spec.rb +0 -36
  568. data/spec/models/create_pdf_template_spec.rb +0 -36
  569. data/spec/models/create_submission_data_request_event_request_spec.rb +0 -62
  570. data/spec/models/create_submission_data_request_event_response_spec.rb +0 -58
  571. data/spec/models/create_submission_data_request_response_spec.rb +0 -58
  572. data/spec/models/create_submission_data_request_token_response_spec.rb +0 -58
  573. data/spec/models/create_webhook_data_spec.rb +0 -36
  574. data/spec/models/error_or_multiple_errors_response_spec.rb +0 -52
  575. data/spec/models/forbidden_error_response_spec.rb +0 -56
  576. data/spec/models/move_folder_data_spec.rb +0 -36
  577. data/spec/models/multiple_errors_response_spec.rb +0 -46
  578. data/spec/models/restore_version_data_spec.rb +0 -36
  579. data/spec/models/submission422_response_spec.rb +0 -58
  580. data/spec/models/success_error_response_spec.rb +0 -46
  581. data/spec/models/success_multiple_errors_response_spec.rb +0 -46
  582. data/spec/models/template_add_fields_response_spec.rb +0 -52
  583. data/spec/models/template_delete_response_spec.rb +0 -58
  584. data/spec/models/template_publish_version_response_spec.rb +0 -52
  585. data/spec/models/update_html_template_spec.rb +0 -36
  586. data/spec/models/update_pdf_template_spec.rb +0 -36
  587. data/spec/models/update_submission_data_request_data_spec.rb +0 -116
  588. data/spec/models/update_webhook_data_spec.rb +0 -36
@@ -0,0 +1,4967 @@
1
+ {
2
+ "operations": {
3
+ "addTemplateFields": {
4
+ "body": {
5
+ "mediaType": "application/json",
6
+ "required": true,
7
+ "schema": {
8
+ "type": "object",
9
+ "required": [
10
+ "fields"
11
+ ],
12
+ "properties": {
13
+ "fields": {
14
+ "type": "array",
15
+ "minItems": 1,
16
+ "maxItems": 1000,
17
+ "items": {
18
+ "type": "object",
19
+ "properties": {
20
+ "name": {
21
+ "type": [
22
+ "string",
23
+ "null"
24
+ ]
25
+ },
26
+ "page": {
27
+ "type": "integer",
28
+ "minimum": 1
29
+ },
30
+ "type": {
31
+ "type": "string",
32
+ "enum": [
33
+ "string",
34
+ "number",
35
+ "boolean",
36
+ "date",
37
+ "address",
38
+ "country",
39
+ "email",
40
+ "url",
41
+ "image",
42
+ "signature",
43
+ "initials",
44
+ "barcode",
45
+ "combined"
46
+ ]
47
+ },
48
+ "static": {
49
+ "type": "boolean"
50
+ },
51
+ "editable": {
52
+ "type": "boolean"
53
+ },
54
+ "default": {
55
+ "type": [
56
+ "string",
57
+ "null"
58
+ ]
59
+ },
60
+ "title": {
61
+ "type": "string"
62
+ },
63
+ "description": {
64
+ "type": "string"
65
+ },
66
+ "placeholder": {
67
+ "type": "string"
68
+ },
69
+ "metadata": {
70
+ "type": "string"
71
+ },
72
+ "required": {
73
+ "type": "boolean"
74
+ },
75
+ "option_list": {
76
+ "type": [
77
+ "string",
78
+ "null"
79
+ ]
80
+ },
81
+ "combined_field_names": {
82
+ "type": "string"
83
+ },
84
+ "combined_field_type": {
85
+ "type": "string",
86
+ "enum": [
87
+ "separator",
88
+ "format"
89
+ ]
90
+ },
91
+ "combined_field_separator": {
92
+ "type": "string"
93
+ },
94
+ "combined_field_format": {
95
+ "type": "string"
96
+ },
97
+ "integer": {
98
+ "type": "boolean"
99
+ },
100
+ "minimum": {
101
+ "type": [
102
+ "number",
103
+ "null"
104
+ ]
105
+ },
106
+ "maximum": {
107
+ "type": [
108
+ "number",
109
+ "null"
110
+ ]
111
+ },
112
+ "exclusive_minimum": {
113
+ "type": "boolean"
114
+ },
115
+ "exclusive_maximum": {
116
+ "type": "boolean"
117
+ },
118
+ "include_time": {
119
+ "type": [
120
+ "boolean",
121
+ "null"
122
+ ]
123
+ },
124
+ "signature_allow_draw": {
125
+ "type": "boolean"
126
+ },
127
+ "signature_allow_type": {
128
+ "type": "boolean"
129
+ },
130
+ "barcode_symbology": {
131
+ "type": "string",
132
+ "enum": [
133
+ "code_25",
134
+ "code_39",
135
+ "code_93",
136
+ "code_128",
137
+ "ean_13",
138
+ "ean_8",
139
+ "upc_a",
140
+ "pdf417"
141
+ ]
142
+ },
143
+ "hidden": {
144
+ "type": "boolean"
145
+ },
146
+ "x": {
147
+ "type": "number",
148
+ "minimum": 0
149
+ },
150
+ "y": {
151
+ "type": "number",
152
+ "minimum": 0
153
+ },
154
+ "width": {
155
+ "type": "number",
156
+ "exclusiveMinimum": 0
157
+ },
158
+ "height": {
159
+ "type": "number",
160
+ "exclusiveMinimum": 0
161
+ },
162
+ "rotation": {
163
+ "type": "number",
164
+ "minimum": -360,
165
+ "maximum": 360
166
+ },
167
+ "display_type": {
168
+ "type": "string",
169
+ "enum": [
170
+ "text",
171
+ "check",
172
+ "qrcode",
173
+ "barcode",
174
+ "image",
175
+ "shape"
176
+ ]
177
+ },
178
+ "opacity": {
179
+ "type": "number",
180
+ "minimum": 0,
181
+ "maximum": 1
182
+ },
183
+ "date_time_format": {
184
+ "type": [
185
+ "string",
186
+ "null"
187
+ ]
188
+ },
189
+ "typeface": {
190
+ "type": [
191
+ "string",
192
+ "null"
193
+ ],
194
+ "enum": [
195
+ "Inconsolata",
196
+ "Roboto Mono",
197
+ "Ubuntu Mono",
198
+ "Menlo",
199
+ "Courier",
200
+ "Helvetica",
201
+ "Arial",
202
+ "Calibri",
203
+ "Open Sans",
204
+ "Roboto",
205
+ "Lato",
206
+ "Poppins",
207
+ "Public Sans",
208
+ "Questrial",
209
+ "Times New Roman",
210
+ "Dancing Script",
211
+ "Lovtony Script",
212
+ null
213
+ ]
214
+ },
215
+ "font_size": {
216
+ "type": [
217
+ "integer",
218
+ "null"
219
+ ],
220
+ "minimum": 1
221
+ },
222
+ "character_spacing": {
223
+ "type": "number",
224
+ "minimum": 0,
225
+ "maximum": 50
226
+ },
227
+ "bold": {
228
+ "type": "boolean"
229
+ },
230
+ "uppercase": {
231
+ "type": "boolean"
232
+ },
233
+ "strikethrough": {
234
+ "type": "boolean"
235
+ },
236
+ "keep_leading_spaces": {
237
+ "type": "boolean"
238
+ },
239
+ "overflow": {
240
+ "type": "string",
241
+ "enum": [
242
+ "shrink_to_fit",
243
+ "truncate"
244
+ ]
245
+ },
246
+ "multiline": {
247
+ "type": "boolean"
248
+ },
249
+ "multiline_lines": {
250
+ "type": [
251
+ "integer",
252
+ "null"
253
+ ],
254
+ "minimum": 1,
255
+ "maximum": 300
256
+ },
257
+ "min_length": {
258
+ "type": "number"
259
+ },
260
+ "max_length": {
261
+ "type": [
262
+ "integer",
263
+ "null"
264
+ ],
265
+ "minimum": 0
266
+ },
267
+ "auto_calculate_max_length": {
268
+ "type": "boolean"
269
+ },
270
+ "color": {
271
+ "type": [
272
+ "string",
273
+ "null"
274
+ ],
275
+ "pattern": "^[A-Fa-f0-9]{6}$",
276
+ "x-pattern-message": "must be a 6-digit hex color without #, like FF0000"
277
+ },
278
+ "color_field_name": {
279
+ "type": [
280
+ "string",
281
+ "null"
282
+ ]
283
+ },
284
+ "color_field_required": {
285
+ "type": "boolean"
286
+ },
287
+ "background_color": {
288
+ "type": [
289
+ "string",
290
+ "null"
291
+ ],
292
+ "pattern": "^[A-Fa-f0-9]{6}$",
293
+ "x-pattern-message": "must be a 6-digit hex color without #, like FF0000"
294
+ },
295
+ "background_color_field_name": {
296
+ "type": [
297
+ "string",
298
+ "null"
299
+ ]
300
+ },
301
+ "background_color_field_required": {
302
+ "type": "boolean"
303
+ },
304
+ "alignment": {
305
+ "type": "string",
306
+ "enum": [
307
+ "left",
308
+ "center",
309
+ "right",
310
+ "justify"
311
+ ]
312
+ },
313
+ "v_alignment": {
314
+ "type": "string",
315
+ "enum": [
316
+ "bottom",
317
+ "center",
318
+ "top"
319
+ ]
320
+ },
321
+ "comb": {
322
+ "type": "boolean"
323
+ },
324
+ "comb_number_of_cells": {
325
+ "type": "integer",
326
+ "minimum": 1
327
+ },
328
+ "comb_value_offset": {
329
+ "type": "integer",
330
+ "minimum": 0
331
+ },
332
+ "shape_type": {
333
+ "type": "string",
334
+ "enum": [
335
+ "square",
336
+ "rectangle",
337
+ "circle",
338
+ "ellipse",
339
+ "triangle",
340
+ "polygon"
341
+ ]
342
+ },
343
+ "shape_sides": {
344
+ "type": "integer",
345
+ "minimum": 3,
346
+ "maximum": 12
347
+ },
348
+ "shape_border_width": {
349
+ "type": "integer",
350
+ "minimum": 1
351
+ },
352
+ "shape_border_color": {
353
+ "type": "string",
354
+ "pattern": "^[A-Fa-f0-9]{6}$",
355
+ "x-pattern-message": "must be a 6-digit hex color without #, like FF0000"
356
+ },
357
+ "shape_border_color_field_name": {
358
+ "type": [
359
+ "string",
360
+ "null"
361
+ ]
362
+ },
363
+ "shape_border_color_field_required": {
364
+ "type": "boolean"
365
+ },
366
+ "shape_fill_color": {
367
+ "type": [
368
+ "string",
369
+ "null"
370
+ ],
371
+ "pattern": "^[A-Fa-f0-9]{6}$",
372
+ "x-pattern-message": "must be a 6-digit hex color without #, like FF0000"
373
+ },
374
+ "shape_fill_color_field_name": {
375
+ "type": [
376
+ "string",
377
+ "null"
378
+ ]
379
+ },
380
+ "shape_fill_color_field_required": {
381
+ "type": "boolean"
382
+ },
383
+ "check_character": {
384
+ "type": "string",
385
+ "enum": [
386
+ "✓",
387
+ "✔",
388
+ "✖",
389
+ "✗",
390
+ "✘"
391
+ ]
392
+ },
393
+ "check_color": {
394
+ "type": [
395
+ "string",
396
+ "null"
397
+ ],
398
+ "pattern": "^[A-Fa-f0-9]{6}$",
399
+ "x-pattern-message": "must be a 6-digit hex color without #, like FF0000"
400
+ },
401
+ "check_color_field_name": {
402
+ "type": [
403
+ "string",
404
+ "null"
405
+ ]
406
+ },
407
+ "check_color_field_required": {
408
+ "type": "boolean"
409
+ },
410
+ "qrcode_color": {
411
+ "type": [
412
+ "string",
413
+ "null"
414
+ ],
415
+ "pattern": "^[A-Fa-f0-9]{6}$",
416
+ "x-pattern-message": "must be a 6-digit hex color without #, like FF0000"
417
+ },
418
+ "qrcode_color_field_name": {
419
+ "type": [
420
+ "string",
421
+ "null"
422
+ ]
423
+ },
424
+ "qrcode_color_field_required": {
425
+ "type": "boolean"
426
+ },
427
+ "true_text": {
428
+ "type": [
429
+ "string",
430
+ "null"
431
+ ]
432
+ },
433
+ "false_text": {
434
+ "type": [
435
+ "string",
436
+ "null"
437
+ ]
438
+ },
439
+ "condition": {
440
+ "type": [
441
+ "string",
442
+ "null"
443
+ ]
444
+ },
445
+ "string_condition_type": {
446
+ "type": "string",
447
+ "enum": [
448
+ "equals",
449
+ "contains",
450
+ "starts_with",
451
+ "ends_with",
452
+ "regex"
453
+ ]
454
+ },
455
+ "number_condition_type": {
456
+ "type": "string",
457
+ "enum": [
458
+ "equals",
459
+ "range",
460
+ "gte",
461
+ "gt",
462
+ "lte",
463
+ "lt"
464
+ ]
465
+ },
466
+ "number_condition_range_min": {
467
+ "type": [
468
+ "number",
469
+ "null"
470
+ ]
471
+ },
472
+ "number_condition_range_max": {
473
+ "type": [
474
+ "number",
475
+ "null"
476
+ ]
477
+ },
478
+ "number_condition_range_exclusive_min": {
479
+ "type": "boolean"
480
+ },
481
+ "number_condition_range_exclusive_max": {
482
+ "type": "boolean"
483
+ },
484
+ "invert_boolean_condition": {
485
+ "type": "boolean"
486
+ },
487
+ "currency": {
488
+ "type": "boolean"
489
+ },
490
+ "decimal_places": {
491
+ "type": [
492
+ "integer",
493
+ "null"
494
+ ],
495
+ "minimum": 0,
496
+ "maximum": 99
497
+ },
498
+ "image_scale_type": {
499
+ "type": "string",
500
+ "enum": [
501
+ "fit",
502
+ "fill",
503
+ "stretch"
504
+ ]
505
+ },
506
+ "image_gravity": {
507
+ "type": "string",
508
+ "enum": [
509
+ "NorthWest",
510
+ "North",
511
+ "NorthEast",
512
+ "West",
513
+ "Center",
514
+ "East",
515
+ "SouthWest",
516
+ "South",
517
+ "SouthEast"
518
+ ]
519
+ },
520
+ "dependencies": {
521
+ "type": [
522
+ "object",
523
+ "null"
524
+ ],
525
+ "required": [
526
+ "action",
527
+ "conditions"
528
+ ],
529
+ "properties": {
530
+ "action": {
531
+ "type": "string",
532
+ "enum": [
533
+ "require_and_show",
534
+ "show",
535
+ "require"
536
+ ]
537
+ },
538
+ "match": {
539
+ "type": "string",
540
+ "enum": [
541
+ "all",
542
+ "any"
543
+ ]
544
+ },
545
+ "conditions": {
546
+ "type": "array",
547
+ "items": {
548
+ "oneOf": [
549
+ {
550
+ "$ref": "#/components/schemas/FieldPresenceCondition"
551
+ },
552
+ {
553
+ "$ref": "#/components/schemas/FieldEqualsCondition"
554
+ },
555
+ {
556
+ "$ref": "#/components/schemas/FieldInCondition"
557
+ },
558
+ {
559
+ "$ref": "#/components/schemas/FieldComparisonCondition"
560
+ },
561
+ {
562
+ "$ref": "#/components/schemas/FieldRangeCondition"
563
+ }
564
+ ],
565
+ "discriminator": {
566
+ "propertyName": "operator",
567
+ "mapping": [
568
+ [
569
+ "present",
570
+ "#/components/schemas/FieldPresenceCondition"
571
+ ],
572
+ [
573
+ "blank",
574
+ "#/components/schemas/FieldPresenceCondition"
575
+ ],
576
+ [
577
+ "equals",
578
+ "#/components/schemas/FieldEqualsCondition"
579
+ ],
580
+ [
581
+ "not_equals",
582
+ "#/components/schemas/FieldEqualsCondition"
583
+ ],
584
+ [
585
+ "in",
586
+ "#/components/schemas/FieldInCondition"
587
+ ],
588
+ [
589
+ "gt",
590
+ "#/components/schemas/FieldComparisonCondition"
591
+ ],
592
+ [
593
+ "gte",
594
+ "#/components/schemas/FieldComparisonCondition"
595
+ ],
596
+ [
597
+ "lt",
598
+ "#/components/schemas/FieldComparisonCondition"
599
+ ],
600
+ [
601
+ "lte",
602
+ "#/components/schemas/FieldComparisonCondition"
603
+ ],
604
+ [
605
+ "range",
606
+ "#/components/schemas/FieldRangeCondition"
607
+ ]
608
+ ]
609
+ }
610
+ }
611
+ }
612
+ },
613
+ "additionalProperties": false
614
+ },
615
+ "id": {
616
+ "type": "integer",
617
+ "minimum": 0
618
+ }
619
+ },
620
+ "additionalProperties": false
621
+ }
622
+ }
623
+ },
624
+ "additionalProperties": false
625
+ }
626
+ }
627
+ },
628
+ "copyTemplate": {
629
+ "body": {
630
+ "mediaType": "application/json",
631
+ "required": false,
632
+ "schema": {
633
+ "type": "object",
634
+ "properties": {
635
+ "name": {
636
+ "type": "string",
637
+ "minLength": 1,
638
+ "maxLength": 255
639
+ },
640
+ "parent_folder_id": {
641
+ "type": [
642
+ "string",
643
+ "null"
644
+ ],
645
+ "minLength": 1
646
+ },
647
+ "version": {
648
+ "type": "string",
649
+ "pattern": "^\\d+(\\.\\d+(\\.\\d+)?)?$",
650
+ "x-pattern-message": "must be a published version like 1.2.3 or 1"
651
+ }
652
+ },
653
+ "additionalProperties": false
654
+ }
655
+ }
656
+ },
657
+ "createCombinedPdf": {
658
+ "query": {
659
+ "wait": {
660
+ "required": false,
661
+ "schema": {
662
+ "type": "boolean"
663
+ }
664
+ }
665
+ },
666
+ "body": {
667
+ "mediaType": "application/json",
668
+ "required": true,
669
+ "schema": {
670
+ "type": "object",
671
+ "properties": {
672
+ "source_pdfs": {
673
+ "type": "array",
674
+ "minItems": 1,
675
+ "items": {
676
+ "oneOf": [
677
+ {
678
+ "$ref": "#/components/schemas/SubmissionSourcePdf"
679
+ },
680
+ {
681
+ "$ref": "#/components/schemas/CombinedPdfSourcePdf"
682
+ },
683
+ {
684
+ "$ref": "#/components/schemas/TemplateSourcePdf"
685
+ },
686
+ {
687
+ "$ref": "#/components/schemas/CustomFileSourcePdf"
688
+ },
689
+ {
690
+ "$ref": "#/components/schemas/UrlSourcePdf"
691
+ }
692
+ ],
693
+ "discriminator": {
694
+ "propertyName": "type",
695
+ "mapping": [
696
+ [
697
+ "submission",
698
+ "#/components/schemas/SubmissionSourcePdf"
699
+ ],
700
+ [
701
+ "combined_pdf",
702
+ "#/components/schemas/CombinedPdfSourcePdf"
703
+ ],
704
+ [
705
+ "template",
706
+ "#/components/schemas/TemplateSourcePdf"
707
+ ],
708
+ [
709
+ "custom_file",
710
+ "#/components/schemas/CustomFileSourcePdf"
711
+ ],
712
+ [
713
+ "url",
714
+ "#/components/schemas/UrlSourcePdf"
715
+ ]
716
+ ]
717
+ }
718
+ }
719
+ },
720
+ "metadata": {
721
+ "type": "object"
722
+ },
723
+ "password": {
724
+ "type": "string",
725
+ "minLength": 1
726
+ },
727
+ "delete_custom_files": {
728
+ "type": "boolean"
729
+ },
730
+ "expires_in": {
731
+ "type": "integer",
732
+ "minimum": 1,
733
+ "maximum": 315360000
734
+ }
735
+ },
736
+ "required": [
737
+ "source_pdfs"
738
+ ],
739
+ "additionalProperties": false
740
+ }
741
+ }
742
+ },
743
+ "createCustomFileFromUpload": {
744
+ "body": {
745
+ "mediaType": "application/json",
746
+ "required": true,
747
+ "schema": {
748
+ "type": "object",
749
+ "required": [
750
+ "cache_id"
751
+ ],
752
+ "properties": {
753
+ "cache_id": {
754
+ "type": "string",
755
+ "minLength": 1,
756
+ "maxLength": 255
757
+ }
758
+ },
759
+ "additionalProperties": false
760
+ }
761
+ }
762
+ },
763
+ "createFolder": {
764
+ "body": {
765
+ "mediaType": "application/json",
766
+ "required": true,
767
+ "schema": {
768
+ "type": "object",
769
+ "properties": {
770
+ "name": {
771
+ "type": "string",
772
+ "minLength": 1,
773
+ "maxLength": 255,
774
+ "pattern": "^[^/]*$",
775
+ "x-pattern-message": "can't contain a slash (/)"
776
+ },
777
+ "parent_folder_id": {
778
+ "type": [
779
+ "string",
780
+ "null"
781
+ ],
782
+ "minLength": 1
783
+ }
784
+ },
785
+ "required": [
786
+ "name"
787
+ ],
788
+ "additionalProperties": false
789
+ }
790
+ }
791
+ },
792
+ "createSignatureRequestEvent": {
793
+ "body": {
794
+ "mediaType": "application/json",
795
+ "required": true,
796
+ "schema": {
797
+ "type": "object",
798
+ "properties": {
799
+ "event_type": {
800
+ "type": "string",
801
+ "enum": [
802
+ "send_request"
803
+ ]
804
+ },
805
+ "message_type": {
806
+ "type": [
807
+ "string",
808
+ "null"
809
+ ],
810
+ "enum": [
811
+ "email",
812
+ "sms",
813
+ "fax",
814
+ "mail",
815
+ "slack",
816
+ "msteams",
817
+ "discord",
818
+ "telegram",
819
+ "whatsapp",
820
+ null
821
+ ]
822
+ },
823
+ "message_recipient": {
824
+ "type": [
825
+ "string",
826
+ "null"
827
+ ],
828
+ "maxLength": 255
829
+ },
830
+ "occurred_at": {
831
+ "type": "string",
832
+ "format": "date-time"
833
+ }
834
+ },
835
+ "required": [
836
+ "event_type"
837
+ ],
838
+ "additionalProperties": false
839
+ }
840
+ }
841
+ },
842
+ "createSignatureRequestToken": {
843
+ "body": {
844
+ "mediaType": "application/json",
845
+ "required": false,
846
+ "schema": {
847
+ "type": "object",
848
+ "properties": {
849
+ "type": {
850
+ "type": "string",
851
+ "enum": [
852
+ "api",
853
+ "email"
854
+ ]
855
+ }
856
+ },
857
+ "additionalProperties": false
858
+ }
859
+ }
860
+ },
861
+ "createSubmission": {
862
+ "query": {
863
+ "version": {
864
+ "required": false,
865
+ "schema": {
866
+ "type": "string",
867
+ "pattern": "^(\\d+(\\.\\d+(\\.\\d+)?)?|latest|draft)$",
868
+ "x-pattern-message": "must be a version like 1.2.3 or 1, or latest or draft"
869
+ }
870
+ },
871
+ "wait": {
872
+ "required": false,
873
+ "schema": {
874
+ "type": "boolean"
875
+ }
876
+ }
877
+ },
878
+ "body": {
879
+ "mediaType": "application/json",
880
+ "required": true,
881
+ "schema": {
882
+ "type": "object",
883
+ "properties": {
884
+ "test": {
885
+ "type": "boolean"
886
+ },
887
+ "editable": {
888
+ "type": "boolean"
889
+ },
890
+ "data": {
891
+ "type": "object"
892
+ },
893
+ "metadata": {
894
+ "type": "object"
895
+ },
896
+ "password": {
897
+ "type": "string",
898
+ "minLength": 1
899
+ },
900
+ "output_formats": {
901
+ "type": "array",
902
+ "minItems": 1,
903
+ "uniqueItems": true,
904
+ "items": {
905
+ "type": "string",
906
+ "enum": [
907
+ "pdf",
908
+ "png"
909
+ ]
910
+ }
911
+ },
912
+ "expires_in": {
913
+ "type": "integer",
914
+ "minimum": 1,
915
+ "maximum": 315360000
916
+ },
917
+ "field_overrides": {
918
+ "type": "object",
919
+ "additionalProperties": {
920
+ "$ref": "#/components/schemas/FieldOverride"
921
+ }
922
+ },
923
+ "html": {
924
+ "type": "string"
925
+ },
926
+ "css": {
927
+ "type": "string"
928
+ },
929
+ "signature_requests": {
930
+ "type": "array",
931
+ "maxItems": 100,
932
+ "items": {
933
+ "type": "object",
934
+ "properties": {
935
+ "name": {
936
+ "type": [
937
+ "string",
938
+ "null"
939
+ ],
940
+ "maxLength": 255
941
+ },
942
+ "email": {
943
+ "type": [
944
+ "string",
945
+ "null"
946
+ ],
947
+ "maxLength": 255
948
+ },
949
+ "fields": {
950
+ "type": "array",
951
+ "minItems": 1,
952
+ "uniqueItems": true,
953
+ "items": {
954
+ "type": "string",
955
+ "minLength": 1
956
+ }
957
+ },
958
+ "metadata": {
959
+ "type": "object"
960
+ },
961
+ "role": {
962
+ "type": "string",
963
+ "minLength": 1
964
+ },
965
+ "auth_type": {
966
+ "type": "string",
967
+ "enum": [
968
+ "password",
969
+ "oauth",
970
+ "email_link",
971
+ "phone_number",
972
+ "ldap",
973
+ "saml"
974
+ ]
975
+ },
976
+ "auth_second_factor_type": {
977
+ "type": "string",
978
+ "enum": [
979
+ "none",
980
+ "phone_number",
981
+ "totp",
982
+ "mobile_push",
983
+ "security_key",
984
+ "fingerprint"
985
+ ]
986
+ },
987
+ "auth_provider": {
988
+ "type": [
989
+ "string",
990
+ "null"
991
+ ],
992
+ "maxLength": 255
993
+ },
994
+ "auth_session_started_at": {
995
+ "type": [
996
+ "string",
997
+ "null"
998
+ ],
999
+ "format": "date-time"
1000
+ },
1001
+ "auth_session_id_hash": {
1002
+ "type": [
1003
+ "string",
1004
+ "null"
1005
+ ]
1006
+ },
1007
+ "auth_user_id_hash": {
1008
+ "type": [
1009
+ "string",
1010
+ "null"
1011
+ ]
1012
+ },
1013
+ "auth_username_hash": {
1014
+ "type": [
1015
+ "string",
1016
+ "null"
1017
+ ]
1018
+ },
1019
+ "auth_phone_number_hash": {
1020
+ "type": [
1021
+ "string",
1022
+ "null"
1023
+ ]
1024
+ },
1025
+ "ignore_unknown_fields": {
1026
+ "type": "boolean"
1027
+ },
1028
+ "prefilled_values_editable": {
1029
+ "type": "boolean"
1030
+ }
1031
+ },
1032
+ "required": [
1033
+ "fields",
1034
+ "auth_type"
1035
+ ],
1036
+ "additionalProperties": false
1037
+ }
1038
+ }
1039
+ },
1040
+ "additionalProperties": false
1041
+ }
1042
+ }
1043
+ },
1044
+ "createSubmissionBatch": {
1045
+ "query": {
1046
+ "wait": {
1047
+ "required": false,
1048
+ "schema": {
1049
+ "type": "boolean"
1050
+ }
1051
+ }
1052
+ },
1053
+ "body": {
1054
+ "mediaType": "application/json",
1055
+ "required": true,
1056
+ "schema": {
1057
+ "type": "object",
1058
+ "properties": {
1059
+ "metadata": {
1060
+ "type": "object"
1061
+ },
1062
+ "template_id": {
1063
+ "type": "string"
1064
+ },
1065
+ "template_version": {
1066
+ "type": "string",
1067
+ "pattern": "^(\\d+(\\.\\d+(\\.\\d+)?)?|latest|draft)$",
1068
+ "x-pattern-message": "must be a version like 1.2.3 or 1, or latest or draft"
1069
+ },
1070
+ "test": {
1071
+ "type": "boolean"
1072
+ },
1073
+ "output_formats": {
1074
+ "type": "array",
1075
+ "minItems": 1,
1076
+ "uniqueItems": true,
1077
+ "items": {
1078
+ "type": "string",
1079
+ "enum": [
1080
+ "pdf",
1081
+ "png"
1082
+ ]
1083
+ }
1084
+ },
1085
+ "submissions": {
1086
+ "type": "array",
1087
+ "minItems": 1,
1088
+ "maxItems": 50,
1089
+ "items": {
1090
+ "type": "object",
1091
+ "properties": {
1092
+ "test": {
1093
+ "type": "boolean"
1094
+ },
1095
+ "editable": {
1096
+ "type": "boolean"
1097
+ },
1098
+ "data": {
1099
+ "type": "object"
1100
+ },
1101
+ "metadata": {
1102
+ "type": "object"
1103
+ },
1104
+ "password": {
1105
+ "type": "string",
1106
+ "minLength": 1
1107
+ },
1108
+ "output_formats": {
1109
+ "type": "array",
1110
+ "minItems": 1,
1111
+ "uniqueItems": true,
1112
+ "items": {
1113
+ "type": "string",
1114
+ "enum": [
1115
+ "pdf",
1116
+ "png"
1117
+ ]
1118
+ }
1119
+ },
1120
+ "expires_in": {
1121
+ "type": "integer",
1122
+ "minimum": 1,
1123
+ "maximum": 315360000
1124
+ },
1125
+ "field_overrides": {
1126
+ "type": "object",
1127
+ "additionalProperties": {
1128
+ "$ref": "#/components/schemas/FieldOverride"
1129
+ }
1130
+ },
1131
+ "html": {
1132
+ "type": "string"
1133
+ },
1134
+ "css": {
1135
+ "type": "string"
1136
+ },
1137
+ "template_id": {
1138
+ "type": "string"
1139
+ },
1140
+ "template_version": {
1141
+ "type": "string",
1142
+ "pattern": "^(\\d+(\\.\\d+(\\.\\d+)?)?|latest|draft)$",
1143
+ "x-pattern-message": "must be a version like 1.2.3 or 1, or latest or draft"
1144
+ }
1145
+ },
1146
+ "additionalProperties": false
1147
+ }
1148
+ }
1149
+ },
1150
+ "required": [
1151
+ "submissions"
1152
+ ],
1153
+ "additionalProperties": false
1154
+ }
1155
+ }
1156
+ },
1157
+ "createTemplate": {
1158
+ "query": {
1159
+ "wait": {
1160
+ "required": false,
1161
+ "schema": {
1162
+ "type": "boolean"
1163
+ }
1164
+ }
1165
+ },
1166
+ "body": {
1167
+ "mediaType": "application/json",
1168
+ "required": true,
1169
+ "schema": {
1170
+ "type": "object",
1171
+ "properties": {
1172
+ "name": {
1173
+ "type": "string",
1174
+ "minLength": 1,
1175
+ "maxLength": 255
1176
+ },
1177
+ "description": {
1178
+ "type": [
1179
+ "string",
1180
+ "null"
1181
+ ]
1182
+ },
1183
+ "template_type": {
1184
+ "type": "string",
1185
+ "enum": [
1186
+ "pdf",
1187
+ "html"
1188
+ ]
1189
+ },
1190
+ "parent_folder_id": {
1191
+ "type": [
1192
+ "string",
1193
+ "null"
1194
+ ],
1195
+ "minLength": 1
1196
+ },
1197
+ "locked": {
1198
+ "type": "boolean"
1199
+ },
1200
+ "add_signature_request_submission_id_footers": {
1201
+ "type": "boolean"
1202
+ },
1203
+ "ai_field_naming_language": {
1204
+ "type": "string",
1205
+ "enum": [
1206
+ "auto",
1207
+ "english",
1208
+ "form_language"
1209
+ ]
1210
+ },
1211
+ "allow_additional_properties": {
1212
+ "type": "boolean"
1213
+ },
1214
+ "allow_skipping_optional_fields": {
1215
+ "type": "boolean"
1216
+ },
1217
+ "default_form_mode": {
1218
+ "type": "string",
1219
+ "enum": [
1220
+ "web",
1221
+ "visual",
1222
+ "dual"
1223
+ ]
1224
+ },
1225
+ "editable_submissions": {
1226
+ "type": "boolean"
1227
+ },
1228
+ "embed_domains": {
1229
+ "type": "array",
1230
+ "maxItems": 100,
1231
+ "items": {
1232
+ "type": "string",
1233
+ "minLength": 1,
1234
+ "maxLength": 255
1235
+ }
1236
+ },
1237
+ "embed_edit_allow_settings": {
1238
+ "type": "boolean"
1239
+ },
1240
+ "embed_edit_allow_versioning": {
1241
+ "type": "boolean"
1242
+ },
1243
+ "embed_edit_allow_document_replacement": {
1244
+ "type": "boolean"
1245
+ },
1246
+ "encrypt_pdfs": {
1247
+ "type": "boolean"
1248
+ },
1249
+ "encrypt_pdfs_password": {
1250
+ "type": [
1251
+ "string",
1252
+ "null"
1253
+ ]
1254
+ },
1255
+ "expire_submissions": {
1256
+ "type": "boolean"
1257
+ },
1258
+ "expire_after": {
1259
+ "type": "integer",
1260
+ "minimum": 1,
1261
+ "maximum": 5256000
1262
+ },
1263
+ "expiration_interval": {
1264
+ "type": "string",
1265
+ "enum": [
1266
+ "minutes",
1267
+ "hours",
1268
+ "days"
1269
+ ]
1270
+ },
1271
+ "merge_audit_trail_pdf": {
1272
+ "type": "boolean"
1273
+ },
1274
+ "parse_dates_using_template_date_format": {
1275
+ "type": "boolean"
1276
+ },
1277
+ "public_submissions": {
1278
+ "type": "boolean"
1279
+ },
1280
+ "public_web_form": {
1281
+ "type": "boolean"
1282
+ },
1283
+ "redirect_url": {
1284
+ "type": [
1285
+ "string",
1286
+ "null"
1287
+ ],
1288
+ "format": "uri"
1289
+ },
1290
+ "slack_webhook_url": {
1291
+ "type": [
1292
+ "string",
1293
+ "null"
1294
+ ],
1295
+ "format": "uri"
1296
+ },
1297
+ "defaults": {
1298
+ "type": "object",
1299
+ "properties": {
1300
+ "typeface": {
1301
+ "type": [
1302
+ "string",
1303
+ "null"
1304
+ ],
1305
+ "enum": [
1306
+ "Inconsolata",
1307
+ "Roboto Mono",
1308
+ "Ubuntu Mono",
1309
+ "Menlo",
1310
+ "Courier",
1311
+ "Helvetica",
1312
+ "Arial",
1313
+ "Calibri",
1314
+ "Open Sans",
1315
+ "Roboto",
1316
+ "Lato",
1317
+ "Poppins",
1318
+ "Public Sans",
1319
+ "Questrial",
1320
+ "Times New Roman",
1321
+ "Dancing Script",
1322
+ "Lovtony Script",
1323
+ null
1324
+ ]
1325
+ },
1326
+ "font_size": {
1327
+ "type": [
1328
+ "integer",
1329
+ "null"
1330
+ ],
1331
+ "minimum": 1
1332
+ },
1333
+ "character_spacing": {
1334
+ "type": [
1335
+ "number",
1336
+ "null"
1337
+ ],
1338
+ "minimum": 0,
1339
+ "maximum": 50
1340
+ },
1341
+ "color": {
1342
+ "type": [
1343
+ "string",
1344
+ "null"
1345
+ ],
1346
+ "pattern": "^[A-Fa-f0-9]{6}$",
1347
+ "x-pattern-message": "must be a 6-digit hex color without #, like FF0000"
1348
+ },
1349
+ "background_color": {
1350
+ "type": [
1351
+ "string",
1352
+ "null"
1353
+ ],
1354
+ "pattern": "^[A-Fa-f0-9]{6}$",
1355
+ "x-pattern-message": "must be a 6-digit hex color without #, like FF0000"
1356
+ },
1357
+ "bold": {
1358
+ "type": "boolean"
1359
+ },
1360
+ "uppercase": {
1361
+ "type": "boolean"
1362
+ },
1363
+ "alignment": {
1364
+ "type": "string",
1365
+ "enum": [
1366
+ "left",
1367
+ "center",
1368
+ "right",
1369
+ "justify"
1370
+ ]
1371
+ },
1372
+ "opacity": {
1373
+ "type": "number",
1374
+ "minimum": 0,
1375
+ "maximum": 1
1376
+ },
1377
+ "date_format": {
1378
+ "type": [
1379
+ "string",
1380
+ "null"
1381
+ ]
1382
+ },
1383
+ "date_time_format": {
1384
+ "type": [
1385
+ "string",
1386
+ "null"
1387
+ ]
1388
+ },
1389
+ "check_color": {
1390
+ "type": [
1391
+ "string",
1392
+ "null"
1393
+ ],
1394
+ "pattern": "^[A-Fa-f0-9]{6}$",
1395
+ "x-pattern-message": "must be a 6-digit hex color without #, like FF0000"
1396
+ },
1397
+ "check_character": {
1398
+ "type": [
1399
+ "string",
1400
+ "null"
1401
+ ],
1402
+ "enum": [
1403
+ "✓",
1404
+ "✔",
1405
+ "✖",
1406
+ "✗",
1407
+ "✘",
1408
+ null
1409
+ ]
1410
+ },
1411
+ "check_background_color": {
1412
+ "type": [
1413
+ "string",
1414
+ "null"
1415
+ ],
1416
+ "pattern": "^[A-Fa-f0-9]{6}$",
1417
+ "x-pattern-message": "must be a 6-digit hex color without #, like FF0000"
1418
+ },
1419
+ "required_field_background_color": {
1420
+ "type": [
1421
+ "string",
1422
+ "null"
1423
+ ],
1424
+ "pattern": "^[A-Fa-f0-9]{6}$",
1425
+ "x-pattern-message": "must be a 6-digit hex color without #, like FF0000"
1426
+ },
1427
+ "true_text": {
1428
+ "type": [
1429
+ "string",
1430
+ "null"
1431
+ ]
1432
+ },
1433
+ "false_text": {
1434
+ "type": [
1435
+ "string",
1436
+ "null"
1437
+ ]
1438
+ },
1439
+ "shape_fill_color": {
1440
+ "type": [
1441
+ "string",
1442
+ "null"
1443
+ ],
1444
+ "pattern": "^[A-Fa-f0-9]{6}$",
1445
+ "x-pattern-message": "must be a 6-digit hex color without #, like FF0000"
1446
+ },
1447
+ "shape_border_color": {
1448
+ "type": [
1449
+ "string",
1450
+ "null"
1451
+ ],
1452
+ "pattern": "^[A-Fa-f0-9]{6}$",
1453
+ "x-pattern-message": "must be a 6-digit hex color without #, like FF0000"
1454
+ },
1455
+ "shape_border_width": {
1456
+ "type": "integer",
1457
+ "minimum": 1
1458
+ }
1459
+ },
1460
+ "additionalProperties": false
1461
+ },
1462
+ "field_dependencies": {
1463
+ "type": "array",
1464
+ "items": {
1465
+ "type": "object",
1466
+ "properties": {
1467
+ "action": {
1468
+ "type": "string",
1469
+ "enum": [
1470
+ "require_and_show",
1471
+ "show",
1472
+ "require"
1473
+ ]
1474
+ },
1475
+ "match": {
1476
+ "type": "string",
1477
+ "enum": [
1478
+ "all",
1479
+ "any"
1480
+ ]
1481
+ },
1482
+ "conditions": {
1483
+ "type": "array",
1484
+ "items": {
1485
+ "oneOf": [
1486
+ {
1487
+ "$ref": "#/components/schemas/FieldPresenceCondition"
1488
+ },
1489
+ {
1490
+ "$ref": "#/components/schemas/FieldEqualsCondition"
1491
+ },
1492
+ {
1493
+ "$ref": "#/components/schemas/FieldInCondition"
1494
+ },
1495
+ {
1496
+ "$ref": "#/components/schemas/FieldComparisonCondition"
1497
+ },
1498
+ {
1499
+ "$ref": "#/components/schemas/FieldRangeCondition"
1500
+ }
1501
+ ],
1502
+ "discriminator": {
1503
+ "propertyName": "operator",
1504
+ "mapping": [
1505
+ [
1506
+ "present",
1507
+ "#/components/schemas/FieldPresenceCondition"
1508
+ ],
1509
+ [
1510
+ "blank",
1511
+ "#/components/schemas/FieldPresenceCondition"
1512
+ ],
1513
+ [
1514
+ "equals",
1515
+ "#/components/schemas/FieldEqualsCondition"
1516
+ ],
1517
+ [
1518
+ "not_equals",
1519
+ "#/components/schemas/FieldEqualsCondition"
1520
+ ],
1521
+ [
1522
+ "in",
1523
+ "#/components/schemas/FieldInCondition"
1524
+ ],
1525
+ [
1526
+ "gt",
1527
+ "#/components/schemas/FieldComparisonCondition"
1528
+ ],
1529
+ [
1530
+ "gte",
1531
+ "#/components/schemas/FieldComparisonCondition"
1532
+ ],
1533
+ [
1534
+ "lt",
1535
+ "#/components/schemas/FieldComparisonCondition"
1536
+ ],
1537
+ [
1538
+ "lte",
1539
+ "#/components/schemas/FieldComparisonCondition"
1540
+ ],
1541
+ [
1542
+ "range",
1543
+ "#/components/schemas/FieldRangeCondition"
1544
+ ]
1545
+ ]
1546
+ }
1547
+ }
1548
+ },
1549
+ "targets": {
1550
+ "type": "array",
1551
+ "minItems": 1,
1552
+ "items": {
1553
+ "type": "string",
1554
+ "minLength": 1
1555
+ }
1556
+ },
1557
+ "group": {
1558
+ "type": "string"
1559
+ }
1560
+ },
1561
+ "required": [
1562
+ "action",
1563
+ "conditions",
1564
+ "targets"
1565
+ ],
1566
+ "additionalProperties": false
1567
+ }
1568
+ },
1569
+ "predefined_fields": {
1570
+ "type": "array",
1571
+ "items": {
1572
+ "type": "object",
1573
+ "required": [
1574
+ "name",
1575
+ "type"
1576
+ ],
1577
+ "properties": {
1578
+ "name": {
1579
+ "type": "string",
1580
+ "minLength": 1
1581
+ },
1582
+ "display_name": {
1583
+ "type": [
1584
+ "string",
1585
+ "null"
1586
+ ],
1587
+ "minLength": 1
1588
+ },
1589
+ "title": {
1590
+ "type": [
1591
+ "string",
1592
+ "null"
1593
+ ]
1594
+ },
1595
+ "type": {
1596
+ "type": "string",
1597
+ "enum": [
1598
+ "string",
1599
+ "number",
1600
+ "boolean",
1601
+ "date",
1602
+ "address",
1603
+ "country",
1604
+ "email",
1605
+ "url",
1606
+ "image",
1607
+ "signature",
1608
+ "initials",
1609
+ "barcode",
1610
+ "combined"
1611
+ ]
1612
+ },
1613
+ "option_list": {
1614
+ "type": [
1615
+ "string",
1616
+ "null"
1617
+ ]
1618
+ },
1619
+ "required_in_template": {
1620
+ "type": "boolean"
1621
+ },
1622
+ "field_required": {
1623
+ "type": "boolean"
1624
+ }
1625
+ },
1626
+ "additionalProperties": false
1627
+ }
1628
+ },
1629
+ "predefined_fields_sample_data": {
1630
+ "type": [
1631
+ "object",
1632
+ "null"
1633
+ ]
1634
+ },
1635
+ "html": {
1636
+ "type": [
1637
+ "string",
1638
+ "null"
1639
+ ]
1640
+ },
1641
+ "scss": {
1642
+ "type": [
1643
+ "string",
1644
+ "null"
1645
+ ]
1646
+ },
1647
+ "header_html": {
1648
+ "type": [
1649
+ "string",
1650
+ "null"
1651
+ ]
1652
+ },
1653
+ "footer_html": {
1654
+ "type": [
1655
+ "string",
1656
+ "null"
1657
+ ]
1658
+ },
1659
+ "html_engine_options": {
1660
+ "type": [
1661
+ "object",
1662
+ "null"
1663
+ ],
1664
+ "properties": {
1665
+ "format": {
1666
+ "type": "string",
1667
+ "enum": [
1668
+ "Letter",
1669
+ "Legal",
1670
+ "Tabloid",
1671
+ "Ledger",
1672
+ "CR80",
1673
+ "A0",
1674
+ "A1",
1675
+ "A2",
1676
+ "A3",
1677
+ "A4",
1678
+ "A5",
1679
+ "A6",
1680
+ "Custom"
1681
+ ]
1682
+ },
1683
+ "width": {
1684
+ "type": "string"
1685
+ },
1686
+ "height": {
1687
+ "type": "string"
1688
+ },
1689
+ "scale": {
1690
+ "type": "number",
1691
+ "exclusiveMinimum": 0
1692
+ },
1693
+ "landscape": {
1694
+ "type": "boolean"
1695
+ },
1696
+ "print_background": {
1697
+ "type": "boolean"
1698
+ },
1699
+ "margin_top": {
1700
+ "type": "string"
1701
+ },
1702
+ "margin_bottom": {
1703
+ "type": "string"
1704
+ },
1705
+ "margin_left": {
1706
+ "type": "string"
1707
+ },
1708
+ "margin_right": {
1709
+ "type": "string"
1710
+ }
1711
+ },
1712
+ "additionalProperties": false
1713
+ },
1714
+ "cache_id": {
1715
+ "type": "string",
1716
+ "minLength": 1,
1717
+ "maxLength": 255
1718
+ },
1719
+ "document_url": {
1720
+ "type": "string",
1721
+ "minLength": 1,
1722
+ "maxLength": 2048,
1723
+ "pattern": "^https://",
1724
+ "x-pattern-message": "must be an https:// link"
1725
+ },
1726
+ "document_base64": {
1727
+ "type": "string",
1728
+ "minLength": 1
1729
+ },
1730
+ "filename": {
1731
+ "type": "string",
1732
+ "minLength": 1,
1733
+ "maxLength": 255
1734
+ },
1735
+ "detect_fields": {
1736
+ "type": "boolean"
1737
+ },
1738
+ "field_source": {
1739
+ "type": "string",
1740
+ "enum": [
1741
+ "auto",
1742
+ "pdf_detection",
1743
+ "pdf_form_fields"
1744
+ ]
1745
+ },
1746
+ "field_naming": {
1747
+ "type": "string",
1748
+ "enum": [
1749
+ "ai",
1750
+ "preserve"
1751
+ ]
1752
+ },
1753
+ "field_logic": {
1754
+ "type": "string",
1755
+ "enum": [
1756
+ "ai",
1757
+ "none"
1758
+ ]
1759
+ }
1760
+ },
1761
+ "required": [
1762
+ "template_type"
1763
+ ],
1764
+ "additionalProperties": false
1765
+ }
1766
+ }
1767
+ },
1768
+ "createWebhook": {
1769
+ "body": {
1770
+ "mediaType": "application/json",
1771
+ "required": true,
1772
+ "schema": {
1773
+ "type": "object",
1774
+ "properties": {
1775
+ "name": {
1776
+ "type": [
1777
+ "string",
1778
+ "null"
1779
+ ],
1780
+ "maxLength": 255
1781
+ },
1782
+ "url": {
1783
+ "type": "string",
1784
+ "format": "uri"
1785
+ },
1786
+ "enabled": {
1787
+ "type": "boolean"
1788
+ },
1789
+ "event_types": {
1790
+ "type": "array",
1791
+ "minItems": 1,
1792
+ "uniqueItems": true,
1793
+ "items": {
1794
+ "type": "string",
1795
+ "enum": [
1796
+ "submission.processed",
1797
+ "submission.failed",
1798
+ "submission.declined",
1799
+ "signature_request.viewed",
1800
+ "signature_request.completed",
1801
+ "signature_request.declined",
1802
+ "combined_pdf.processed",
1803
+ "combined_pdf.failed",
1804
+ "submission_batch.processed",
1805
+ "submission_batch.failed",
1806
+ "submission.created",
1807
+ "submission.updated",
1808
+ "submission.expired",
1809
+ "signature_request.updated",
1810
+ "combined_pdf.expired",
1811
+ "template.created",
1812
+ "template.updated",
1813
+ "template.deleted",
1814
+ "webhook.created",
1815
+ "webhook.updated",
1816
+ "webhook.deleted",
1817
+ "custom_file.created",
1818
+ "folder.created",
1819
+ "folder.updated",
1820
+ "folder.deleted"
1821
+ ]
1822
+ }
1823
+ },
1824
+ "mode": {
1825
+ "type": [
1826
+ "string",
1827
+ "null"
1828
+ ],
1829
+ "enum": [
1830
+ "test",
1831
+ "live",
1832
+ null
1833
+ ]
1834
+ },
1835
+ "api_token_ids": {
1836
+ "type": "array",
1837
+ "uniqueItems": true,
1838
+ "items": {
1839
+ "type": "string"
1840
+ }
1841
+ },
1842
+ "template_ids": {
1843
+ "type": "array",
1844
+ "uniqueItems": true,
1845
+ "items": {
1846
+ "type": "string"
1847
+ }
1848
+ },
1849
+ "folder_ids": {
1850
+ "type": "array",
1851
+ "uniqueItems": true,
1852
+ "items": {
1853
+ "type": "string"
1854
+ }
1855
+ },
1856
+ "include_submission_data": {
1857
+ "type": "boolean"
1858
+ },
1859
+ "strip_fields": {
1860
+ "type": "array",
1861
+ "items": {
1862
+ "type": "string"
1863
+ }
1864
+ },
1865
+ "headers": {
1866
+ "type": "object",
1867
+ "additionalProperties": {
1868
+ "type": "string"
1869
+ }
1870
+ }
1871
+ },
1872
+ "required": [
1873
+ "url",
1874
+ "event_types"
1875
+ ],
1876
+ "additionalProperties": false
1877
+ }
1878
+ }
1879
+ },
1880
+ "deleteCustomFile": {},
1881
+ "deleteFolder": {},
1882
+ "deleteTemplate": {
1883
+ "query": {
1884
+ "version": {
1885
+ "required": false,
1886
+ "schema": {
1887
+ "type": "string",
1888
+ "pattern": "^(\\d+\\.\\d+\\.\\d+|draft)$",
1889
+ "x-pattern-message": "must be a full version like 1.2.3, or draft"
1890
+ }
1891
+ }
1892
+ }
1893
+ },
1894
+ "deleteWebhook": {},
1895
+ "expireCombinedPdf": {},
1896
+ "expireSubmission": {},
1897
+ "generateSubmissionFiles": {
1898
+ "query": {
1899
+ "wait": {
1900
+ "required": false,
1901
+ "schema": {
1902
+ "type": "boolean"
1903
+ }
1904
+ }
1905
+ },
1906
+ "body": {
1907
+ "mediaType": "application/json",
1908
+ "required": true,
1909
+ "schema": {
1910
+ "type": "object",
1911
+ "required": [
1912
+ "formats"
1913
+ ],
1914
+ "properties": {
1915
+ "formats": {
1916
+ "type": "array",
1917
+ "minItems": 1,
1918
+ "uniqueItems": true,
1919
+ "items": {
1920
+ "type": "string",
1921
+ "enum": [
1922
+ "png"
1923
+ ]
1924
+ }
1925
+ }
1926
+ },
1927
+ "additionalProperties": false
1928
+ }
1929
+ }
1930
+ },
1931
+ "generateSubmissionPreview": {},
1932
+ "getCombinedPdf": {},
1933
+ "getCustomFile": {},
1934
+ "getFolder": {},
1935
+ "getPresignUrl": {},
1936
+ "getSignatureRequest": {},
1937
+ "getSubmission": {},
1938
+ "getSubmissionBatch": {
1939
+ "query": {
1940
+ "include_data": {
1941
+ "required": false,
1942
+ "schema": {
1943
+ "type": "boolean"
1944
+ }
1945
+ }
1946
+ }
1947
+ },
1948
+ "getTemplate": {
1949
+ "query": {
1950
+ "version": {
1951
+ "required": false,
1952
+ "schema": {
1953
+ "type": "string",
1954
+ "pattern": "^(\\d+(\\.\\d+(\\.\\d+)?)?|latest|draft)$",
1955
+ "x-pattern-message": "must be a version like 1.2.3 or 1, or latest or draft"
1956
+ }
1957
+ }
1958
+ }
1959
+ },
1960
+ "getTemplateDiff": {
1961
+ "query": {
1962
+ "version": {
1963
+ "required": false,
1964
+ "schema": {
1965
+ "type": "string",
1966
+ "pattern": "^(\\d+(\\.\\d+(\\.\\d+)?)?|latest|draft)$",
1967
+ "x-pattern-message": "must be a version like 1.2.3 or 1, or latest or draft"
1968
+ }
1969
+ }
1970
+ }
1971
+ },
1972
+ "getTemplateModelCode": {
1973
+ "query": {
1974
+ "version": {
1975
+ "required": false,
1976
+ "schema": {
1977
+ "type": "string",
1978
+ "pattern": "^(\\d+(\\.\\d+(\\.\\d+)?)?|latest|draft)$",
1979
+ "x-pattern-message": "must be a version like 1.2.3 or 1, or latest or draft"
1980
+ }
1981
+ },
1982
+ "lang": {
1983
+ "required": true,
1984
+ "schema": {
1985
+ "type": "string",
1986
+ "enum": [
1987
+ "typescript",
1988
+ "javascript",
1989
+ "ruby",
1990
+ "python",
1991
+ "php",
1992
+ "java",
1993
+ "csharp",
1994
+ "elixir",
1995
+ "go"
1996
+ ]
1997
+ }
1998
+ }
1999
+ }
2000
+ },
2001
+ "getTemplatePageImages": {
2002
+ "query": {
2003
+ "version": {
2004
+ "required": false,
2005
+ "schema": {
2006
+ "type": "string",
2007
+ "pattern": "^(\\d+(\\.\\d+(\\.\\d+)?)?|latest|draft)$",
2008
+ "x-pattern-message": "must be a version like 1.2.3 or 1, or latest or draft"
2009
+ }
2010
+ }
2011
+ }
2012
+ },
2013
+ "getTemplateSchema": {
2014
+ "query": {
2015
+ "version": {
2016
+ "required": false,
2017
+ "schema": {
2018
+ "type": "string",
2019
+ "pattern": "^(\\d+(\\.\\d+(\\.\\d+)?)?|latest|draft)$",
2020
+ "x-pattern-message": "must be a version like 1.2.3 or 1, or latest or draft"
2021
+ }
2022
+ }
2023
+ }
2024
+ },
2025
+ "getWebhook": {},
2026
+ "listCombinedPdfs": {
2027
+ "query": {
2028
+ "limit": {
2029
+ "required": false,
2030
+ "schema": {
2031
+ "type": "integer",
2032
+ "minimum": 1,
2033
+ "maximum": 100
2034
+ }
2035
+ },
2036
+ "cursor": {
2037
+ "required": false,
2038
+ "schema": {
2039
+ "type": "string"
2040
+ }
2041
+ }
2042
+ }
2043
+ },
2044
+ "listCustomFiles": {
2045
+ "query": {
2046
+ "limit": {
2047
+ "required": false,
2048
+ "schema": {
2049
+ "type": "integer",
2050
+ "minimum": 1,
2051
+ "maximum": 100
2052
+ }
2053
+ },
2054
+ "cursor": {
2055
+ "required": false,
2056
+ "schema": {
2057
+ "type": "string"
2058
+ }
2059
+ }
2060
+ }
2061
+ },
2062
+ "listFolders": {
2063
+ "query": {
2064
+ "parent_folder_id": {
2065
+ "required": false,
2066
+ "schema": {
2067
+ "type": "string"
2068
+ }
2069
+ },
2070
+ "limit": {
2071
+ "required": false,
2072
+ "schema": {
2073
+ "type": "integer",
2074
+ "minimum": 1,
2075
+ "maximum": 100
2076
+ }
2077
+ },
2078
+ "cursor": {
2079
+ "required": false,
2080
+ "schema": {
2081
+ "type": "string"
2082
+ }
2083
+ }
2084
+ }
2085
+ },
2086
+ "listSubmissions": {
2087
+ "query": {
2088
+ "template_id": {
2089
+ "required": false,
2090
+ "schema": {
2091
+ "type": "string"
2092
+ }
2093
+ },
2094
+ "test": {
2095
+ "required": false,
2096
+ "schema": {
2097
+ "type": "boolean"
2098
+ }
2099
+ },
2100
+ "created_after": {
2101
+ "required": false,
2102
+ "schema": {
2103
+ "type": "string",
2104
+ "format": "date-time"
2105
+ }
2106
+ },
2107
+ "created_before": {
2108
+ "required": false,
2109
+ "schema": {
2110
+ "type": "string",
2111
+ "format": "date-time"
2112
+ }
2113
+ },
2114
+ "include_data": {
2115
+ "required": false,
2116
+ "schema": {
2117
+ "type": "boolean"
2118
+ }
2119
+ },
2120
+ "limit": {
2121
+ "required": false,
2122
+ "schema": {
2123
+ "type": "integer",
2124
+ "minimum": 1,
2125
+ "maximum": 100
2126
+ }
2127
+ },
2128
+ "cursor": {
2129
+ "required": false,
2130
+ "schema": {
2131
+ "type": "string"
2132
+ }
2133
+ }
2134
+ }
2135
+ },
2136
+ "listTemplateFields": {
2137
+ "query": {
2138
+ "version": {
2139
+ "required": false,
2140
+ "schema": {
2141
+ "type": "string",
2142
+ "pattern": "^(\\d+(\\.\\d+(\\.\\d+)?)?|latest|draft)$",
2143
+ "x-pattern-message": "must be a version like 1.2.3 or 1, or latest or draft"
2144
+ }
2145
+ }
2146
+ }
2147
+ },
2148
+ "listTemplateSubmissions": {
2149
+ "query": {
2150
+ "test": {
2151
+ "required": false,
2152
+ "schema": {
2153
+ "type": "boolean"
2154
+ }
2155
+ },
2156
+ "created_after": {
2157
+ "required": false,
2158
+ "schema": {
2159
+ "type": "string",
2160
+ "format": "date-time"
2161
+ }
2162
+ },
2163
+ "created_before": {
2164
+ "required": false,
2165
+ "schema": {
2166
+ "type": "string",
2167
+ "format": "date-time"
2168
+ }
2169
+ },
2170
+ "include_data": {
2171
+ "required": false,
2172
+ "schema": {
2173
+ "type": "boolean"
2174
+ }
2175
+ },
2176
+ "limit": {
2177
+ "required": false,
2178
+ "schema": {
2179
+ "type": "integer",
2180
+ "minimum": 1,
2181
+ "maximum": 100
2182
+ }
2183
+ },
2184
+ "cursor": {
2185
+ "required": false,
2186
+ "schema": {
2187
+ "type": "string"
2188
+ }
2189
+ }
2190
+ }
2191
+ },
2192
+ "listTemplates": {
2193
+ "query": {
2194
+ "query": {
2195
+ "required": false,
2196
+ "schema": {
2197
+ "type": "string"
2198
+ }
2199
+ },
2200
+ "parent_folder_id": {
2201
+ "required": false,
2202
+ "schema": {
2203
+ "type": "string"
2204
+ }
2205
+ },
2206
+ "limit": {
2207
+ "required": false,
2208
+ "schema": {
2209
+ "type": "integer",
2210
+ "minimum": 1,
2211
+ "maximum": 100
2212
+ }
2213
+ },
2214
+ "cursor": {
2215
+ "required": false,
2216
+ "schema": {
2217
+ "type": "string"
2218
+ }
2219
+ }
2220
+ }
2221
+ },
2222
+ "listWebhooks": {
2223
+ "query": {
2224
+ "event_type": {
2225
+ "required": false,
2226
+ "schema": {
2227
+ "type": "string",
2228
+ "enum": [
2229
+ "submission.processed",
2230
+ "submission.failed",
2231
+ "submission.declined",
2232
+ "signature_request.viewed",
2233
+ "signature_request.completed",
2234
+ "signature_request.declined",
2235
+ "combined_pdf.processed",
2236
+ "combined_pdf.failed",
2237
+ "submission_batch.processed",
2238
+ "submission_batch.failed",
2239
+ "submission.created",
2240
+ "submission.updated",
2241
+ "submission.expired",
2242
+ "signature_request.updated",
2243
+ "combined_pdf.expired",
2244
+ "template.created",
2245
+ "template.updated",
2246
+ "template.deleted",
2247
+ "webhook.created",
2248
+ "webhook.updated",
2249
+ "webhook.deleted",
2250
+ "custom_file.created",
2251
+ "folder.created",
2252
+ "folder.updated",
2253
+ "folder.deleted"
2254
+ ]
2255
+ }
2256
+ },
2257
+ "mode": {
2258
+ "required": false,
2259
+ "schema": {
2260
+ "type": "string",
2261
+ "enum": [
2262
+ "test",
2263
+ "live"
2264
+ ]
2265
+ }
2266
+ },
2267
+ "template_id": {
2268
+ "required": false,
2269
+ "schema": {
2270
+ "type": "string"
2271
+ }
2272
+ },
2273
+ "folder_id": {
2274
+ "required": false,
2275
+ "schema": {
2276
+ "type": "string"
2277
+ }
2278
+ },
2279
+ "api_token_id": {
2280
+ "required": false,
2281
+ "schema": {
2282
+ "type": "string"
2283
+ }
2284
+ },
2285
+ "limit": {
2286
+ "required": false,
2287
+ "schema": {
2288
+ "type": "integer",
2289
+ "minimum": 1,
2290
+ "maximum": 100
2291
+ }
2292
+ },
2293
+ "cursor": {
2294
+ "required": false,
2295
+ "schema": {
2296
+ "type": "string"
2297
+ }
2298
+ }
2299
+ }
2300
+ },
2301
+ "moveFolder": {
2302
+ "body": {
2303
+ "mediaType": "application/json",
2304
+ "required": true,
2305
+ "schema": {
2306
+ "type": "object",
2307
+ "properties": {
2308
+ "parent_folder_id": {
2309
+ "type": [
2310
+ "string",
2311
+ "null"
2312
+ ],
2313
+ "minLength": 1
2314
+ }
2315
+ },
2316
+ "required": [
2317
+ "parent_folder_id"
2318
+ ],
2319
+ "additionalProperties": false
2320
+ }
2321
+ }
2322
+ },
2323
+ "moveTemplate": {
2324
+ "body": {
2325
+ "mediaType": "application/json",
2326
+ "required": true,
2327
+ "schema": {
2328
+ "type": "object",
2329
+ "required": [
2330
+ "parent_folder_id"
2331
+ ],
2332
+ "properties": {
2333
+ "parent_folder_id": {
2334
+ "type": [
2335
+ "string",
2336
+ "null"
2337
+ ],
2338
+ "minLength": 1
2339
+ }
2340
+ },
2341
+ "additionalProperties": false
2342
+ }
2343
+ }
2344
+ },
2345
+ "publishTemplateVersion": {
2346
+ "body": {
2347
+ "mediaType": "application/json",
2348
+ "required": true,
2349
+ "schema": {
2350
+ "type": "object",
2351
+ "required": [
2352
+ "version_type"
2353
+ ],
2354
+ "properties": {
2355
+ "version_type": {
2356
+ "type": "string",
2357
+ "enum": [
2358
+ "major",
2359
+ "minor",
2360
+ "patch"
2361
+ ]
2362
+ },
2363
+ "description": {
2364
+ "type": "string",
2365
+ "maxLength": 500
2366
+ }
2367
+ },
2368
+ "additionalProperties": false
2369
+ }
2370
+ }
2371
+ },
2372
+ "removeTemplateFields": {
2373
+ "body": {
2374
+ "mediaType": "application/json",
2375
+ "required": true,
2376
+ "schema": {
2377
+ "type": "object",
2378
+ "required": [
2379
+ "field_ids"
2380
+ ],
2381
+ "properties": {
2382
+ "field_ids": {
2383
+ "type": "array",
2384
+ "minItems": 1,
2385
+ "maxItems": 1000,
2386
+ "items": {
2387
+ "type": "integer"
2388
+ }
2389
+ }
2390
+ },
2391
+ "additionalProperties": false
2392
+ }
2393
+ }
2394
+ },
2395
+ "renameFolder": {
2396
+ "body": {
2397
+ "mediaType": "application/json",
2398
+ "required": true,
2399
+ "schema": {
2400
+ "type": "object",
2401
+ "properties": {
2402
+ "name": {
2403
+ "type": "string",
2404
+ "minLength": 1,
2405
+ "maxLength": 255,
2406
+ "pattern": "^[^/]*$",
2407
+ "x-pattern-message": "can't contain a slash (/)"
2408
+ }
2409
+ },
2410
+ "required": [
2411
+ "name"
2412
+ ],
2413
+ "additionalProperties": false
2414
+ }
2415
+ }
2416
+ },
2417
+ "reorderTemplateFields": {
2418
+ "body": {
2419
+ "mediaType": "application/json",
2420
+ "required": true,
2421
+ "schema": {
2422
+ "type": "object",
2423
+ "required": [
2424
+ "field_ids"
2425
+ ],
2426
+ "properties": {
2427
+ "field_ids": {
2428
+ "type": "array",
2429
+ "minItems": 1,
2430
+ "items": {
2431
+ "type": "integer"
2432
+ }
2433
+ }
2434
+ },
2435
+ "additionalProperties": false
2436
+ }
2437
+ }
2438
+ },
2439
+ "restoreTemplateVersion": {
2440
+ "body": {
2441
+ "mediaType": "application/json",
2442
+ "required": true,
2443
+ "schema": {
2444
+ "type": "object",
2445
+ "required": [
2446
+ "version"
2447
+ ],
2448
+ "properties": {
2449
+ "version": {
2450
+ "type": "string",
2451
+ "pattern": "^\\d+(\\.\\d+(\\.\\d+)?)?$",
2452
+ "x-pattern-message": "must be a published version like 1.2.3 or 1"
2453
+ }
2454
+ },
2455
+ "additionalProperties": false
2456
+ }
2457
+ }
2458
+ },
2459
+ "testAuthentication": {},
2460
+ "updateSignatureRequest": {
2461
+ "body": {
2462
+ "mediaType": "application/json",
2463
+ "required": true,
2464
+ "schema": {
2465
+ "type": "object",
2466
+ "properties": {
2467
+ "metadata": {
2468
+ "type": "object"
2469
+ },
2470
+ "auth_type": {
2471
+ "type": "string",
2472
+ "enum": [
2473
+ "password",
2474
+ "oauth",
2475
+ "email_link",
2476
+ "phone_number",
2477
+ "ldap",
2478
+ "saml"
2479
+ ]
2480
+ },
2481
+ "auth_second_factor_type": {
2482
+ "type": "string",
2483
+ "enum": [
2484
+ "none",
2485
+ "phone_number",
2486
+ "totp",
2487
+ "mobile_push",
2488
+ "security_key",
2489
+ "fingerprint"
2490
+ ]
2491
+ },
2492
+ "auth_provider": {
2493
+ "type": [
2494
+ "string",
2495
+ "null"
2496
+ ],
2497
+ "maxLength": 255
2498
+ },
2499
+ "auth_session_started_at": {
2500
+ "type": [
2501
+ "string",
2502
+ "null"
2503
+ ],
2504
+ "format": "date-time"
2505
+ },
2506
+ "auth_session_id_hash": {
2507
+ "type": [
2508
+ "string",
2509
+ "null"
2510
+ ]
2511
+ },
2512
+ "auth_user_id_hash": {
2513
+ "type": [
2514
+ "string",
2515
+ "null"
2516
+ ]
2517
+ },
2518
+ "auth_username_hash": {
2519
+ "type": [
2520
+ "string",
2521
+ "null"
2522
+ ]
2523
+ },
2524
+ "auth_phone_number_hash": {
2525
+ "type": [
2526
+ "string",
2527
+ "null"
2528
+ ]
2529
+ }
2530
+ },
2531
+ "additionalProperties": false
2532
+ }
2533
+ }
2534
+ },
2535
+ "updateTemplate": {
2536
+ "body": {
2537
+ "mediaType": "application/json",
2538
+ "required": true,
2539
+ "schema": {
2540
+ "type": "object",
2541
+ "properties": {
2542
+ "name": {
2543
+ "type": "string",
2544
+ "minLength": 1,
2545
+ "maxLength": 255
2546
+ },
2547
+ "description": {
2548
+ "type": [
2549
+ "string",
2550
+ "null"
2551
+ ]
2552
+ },
2553
+ "parent_folder_id": {
2554
+ "type": [
2555
+ "string",
2556
+ "null"
2557
+ ],
2558
+ "minLength": 1
2559
+ },
2560
+ "locked": {
2561
+ "type": "boolean"
2562
+ },
2563
+ "add_signature_request_submission_id_footers": {
2564
+ "type": "boolean"
2565
+ },
2566
+ "ai_field_naming_language": {
2567
+ "type": "string",
2568
+ "enum": [
2569
+ "auto",
2570
+ "english",
2571
+ "form_language"
2572
+ ]
2573
+ },
2574
+ "allow_additional_properties": {
2575
+ "type": "boolean"
2576
+ },
2577
+ "allow_skipping_optional_fields": {
2578
+ "type": "boolean"
2579
+ },
2580
+ "default_form_mode": {
2581
+ "type": "string",
2582
+ "enum": [
2583
+ "web",
2584
+ "visual",
2585
+ "dual"
2586
+ ]
2587
+ },
2588
+ "editable_submissions": {
2589
+ "type": "boolean"
2590
+ },
2591
+ "embed_domains": {
2592
+ "type": "array",
2593
+ "maxItems": 100,
2594
+ "items": {
2595
+ "type": "string",
2596
+ "minLength": 1,
2597
+ "maxLength": 255
2598
+ }
2599
+ },
2600
+ "embed_edit_allow_settings": {
2601
+ "type": "boolean"
2602
+ },
2603
+ "embed_edit_allow_versioning": {
2604
+ "type": "boolean"
2605
+ },
2606
+ "embed_edit_allow_document_replacement": {
2607
+ "type": "boolean"
2608
+ },
2609
+ "encrypt_pdfs": {
2610
+ "type": "boolean"
2611
+ },
2612
+ "encrypt_pdfs_password": {
2613
+ "type": [
2614
+ "string",
2615
+ "null"
2616
+ ]
2617
+ },
2618
+ "expire_submissions": {
2619
+ "type": "boolean"
2620
+ },
2621
+ "expire_after": {
2622
+ "type": "integer",
2623
+ "minimum": 1,
2624
+ "maximum": 5256000
2625
+ },
2626
+ "expiration_interval": {
2627
+ "type": "string",
2628
+ "enum": [
2629
+ "minutes",
2630
+ "hours",
2631
+ "days"
2632
+ ]
2633
+ },
2634
+ "merge_audit_trail_pdf": {
2635
+ "type": "boolean"
2636
+ },
2637
+ "parse_dates_using_template_date_format": {
2638
+ "type": "boolean"
2639
+ },
2640
+ "public_submissions": {
2641
+ "type": "boolean"
2642
+ },
2643
+ "public_web_form": {
2644
+ "type": "boolean"
2645
+ },
2646
+ "redirect_url": {
2647
+ "type": [
2648
+ "string",
2649
+ "null"
2650
+ ],
2651
+ "format": "uri"
2652
+ },
2653
+ "slack_webhook_url": {
2654
+ "type": [
2655
+ "string",
2656
+ "null"
2657
+ ],
2658
+ "format": "uri"
2659
+ },
2660
+ "defaults": {
2661
+ "type": "object",
2662
+ "properties": {
2663
+ "typeface": {
2664
+ "type": [
2665
+ "string",
2666
+ "null"
2667
+ ],
2668
+ "enum": [
2669
+ "Inconsolata",
2670
+ "Roboto Mono",
2671
+ "Ubuntu Mono",
2672
+ "Menlo",
2673
+ "Courier",
2674
+ "Helvetica",
2675
+ "Arial",
2676
+ "Calibri",
2677
+ "Open Sans",
2678
+ "Roboto",
2679
+ "Lato",
2680
+ "Poppins",
2681
+ "Public Sans",
2682
+ "Questrial",
2683
+ "Times New Roman",
2684
+ "Dancing Script",
2685
+ "Lovtony Script",
2686
+ null
2687
+ ]
2688
+ },
2689
+ "font_size": {
2690
+ "type": [
2691
+ "integer",
2692
+ "null"
2693
+ ],
2694
+ "minimum": 1
2695
+ },
2696
+ "character_spacing": {
2697
+ "type": [
2698
+ "number",
2699
+ "null"
2700
+ ],
2701
+ "minimum": 0,
2702
+ "maximum": 50
2703
+ },
2704
+ "color": {
2705
+ "type": [
2706
+ "string",
2707
+ "null"
2708
+ ],
2709
+ "pattern": "^[A-Fa-f0-9]{6}$",
2710
+ "x-pattern-message": "must be a 6-digit hex color without #, like FF0000"
2711
+ },
2712
+ "background_color": {
2713
+ "type": [
2714
+ "string",
2715
+ "null"
2716
+ ],
2717
+ "pattern": "^[A-Fa-f0-9]{6}$",
2718
+ "x-pattern-message": "must be a 6-digit hex color without #, like FF0000"
2719
+ },
2720
+ "bold": {
2721
+ "type": "boolean"
2722
+ },
2723
+ "uppercase": {
2724
+ "type": "boolean"
2725
+ },
2726
+ "alignment": {
2727
+ "type": "string",
2728
+ "enum": [
2729
+ "left",
2730
+ "center",
2731
+ "right",
2732
+ "justify"
2733
+ ]
2734
+ },
2735
+ "opacity": {
2736
+ "type": "number",
2737
+ "minimum": 0,
2738
+ "maximum": 1
2739
+ },
2740
+ "date_format": {
2741
+ "type": [
2742
+ "string",
2743
+ "null"
2744
+ ]
2745
+ },
2746
+ "date_time_format": {
2747
+ "type": [
2748
+ "string",
2749
+ "null"
2750
+ ]
2751
+ },
2752
+ "check_color": {
2753
+ "type": [
2754
+ "string",
2755
+ "null"
2756
+ ],
2757
+ "pattern": "^[A-Fa-f0-9]{6}$",
2758
+ "x-pattern-message": "must be a 6-digit hex color without #, like FF0000"
2759
+ },
2760
+ "check_character": {
2761
+ "type": [
2762
+ "string",
2763
+ "null"
2764
+ ],
2765
+ "enum": [
2766
+ "✓",
2767
+ "✔",
2768
+ "✖",
2769
+ "✗",
2770
+ "✘",
2771
+ null
2772
+ ]
2773
+ },
2774
+ "check_background_color": {
2775
+ "type": [
2776
+ "string",
2777
+ "null"
2778
+ ],
2779
+ "pattern": "^[A-Fa-f0-9]{6}$",
2780
+ "x-pattern-message": "must be a 6-digit hex color without #, like FF0000"
2781
+ },
2782
+ "required_field_background_color": {
2783
+ "type": [
2784
+ "string",
2785
+ "null"
2786
+ ],
2787
+ "pattern": "^[A-Fa-f0-9]{6}$",
2788
+ "x-pattern-message": "must be a 6-digit hex color without #, like FF0000"
2789
+ },
2790
+ "true_text": {
2791
+ "type": [
2792
+ "string",
2793
+ "null"
2794
+ ]
2795
+ },
2796
+ "false_text": {
2797
+ "type": [
2798
+ "string",
2799
+ "null"
2800
+ ]
2801
+ },
2802
+ "shape_fill_color": {
2803
+ "type": [
2804
+ "string",
2805
+ "null"
2806
+ ],
2807
+ "pattern": "^[A-Fa-f0-9]{6}$",
2808
+ "x-pattern-message": "must be a 6-digit hex color without #, like FF0000"
2809
+ },
2810
+ "shape_border_color": {
2811
+ "type": [
2812
+ "string",
2813
+ "null"
2814
+ ],
2815
+ "pattern": "^[A-Fa-f0-9]{6}$",
2816
+ "x-pattern-message": "must be a 6-digit hex color without #, like FF0000"
2817
+ },
2818
+ "shape_border_width": {
2819
+ "type": "integer",
2820
+ "minimum": 1
2821
+ }
2822
+ },
2823
+ "additionalProperties": false
2824
+ },
2825
+ "field_dependencies": {
2826
+ "type": "array",
2827
+ "items": {
2828
+ "type": "object",
2829
+ "properties": {
2830
+ "action": {
2831
+ "type": "string",
2832
+ "enum": [
2833
+ "require_and_show",
2834
+ "show",
2835
+ "require"
2836
+ ]
2837
+ },
2838
+ "match": {
2839
+ "type": "string",
2840
+ "enum": [
2841
+ "all",
2842
+ "any"
2843
+ ]
2844
+ },
2845
+ "conditions": {
2846
+ "type": "array",
2847
+ "items": {
2848
+ "oneOf": [
2849
+ {
2850
+ "$ref": "#/components/schemas/FieldPresenceCondition"
2851
+ },
2852
+ {
2853
+ "$ref": "#/components/schemas/FieldEqualsCondition"
2854
+ },
2855
+ {
2856
+ "$ref": "#/components/schemas/FieldInCondition"
2857
+ },
2858
+ {
2859
+ "$ref": "#/components/schemas/FieldComparisonCondition"
2860
+ },
2861
+ {
2862
+ "$ref": "#/components/schemas/FieldRangeCondition"
2863
+ }
2864
+ ],
2865
+ "discriminator": {
2866
+ "propertyName": "operator",
2867
+ "mapping": [
2868
+ [
2869
+ "present",
2870
+ "#/components/schemas/FieldPresenceCondition"
2871
+ ],
2872
+ [
2873
+ "blank",
2874
+ "#/components/schemas/FieldPresenceCondition"
2875
+ ],
2876
+ [
2877
+ "equals",
2878
+ "#/components/schemas/FieldEqualsCondition"
2879
+ ],
2880
+ [
2881
+ "not_equals",
2882
+ "#/components/schemas/FieldEqualsCondition"
2883
+ ],
2884
+ [
2885
+ "in",
2886
+ "#/components/schemas/FieldInCondition"
2887
+ ],
2888
+ [
2889
+ "gt",
2890
+ "#/components/schemas/FieldComparisonCondition"
2891
+ ],
2892
+ [
2893
+ "gte",
2894
+ "#/components/schemas/FieldComparisonCondition"
2895
+ ],
2896
+ [
2897
+ "lt",
2898
+ "#/components/schemas/FieldComparisonCondition"
2899
+ ],
2900
+ [
2901
+ "lte",
2902
+ "#/components/schemas/FieldComparisonCondition"
2903
+ ],
2904
+ [
2905
+ "range",
2906
+ "#/components/schemas/FieldRangeCondition"
2907
+ ]
2908
+ ]
2909
+ }
2910
+ }
2911
+ },
2912
+ "targets": {
2913
+ "type": "array",
2914
+ "minItems": 1,
2915
+ "items": {
2916
+ "type": "string",
2917
+ "minLength": 1
2918
+ }
2919
+ },
2920
+ "group": {
2921
+ "type": "string"
2922
+ }
2923
+ },
2924
+ "required": [
2925
+ "action",
2926
+ "conditions",
2927
+ "targets"
2928
+ ],
2929
+ "additionalProperties": false
2930
+ }
2931
+ },
2932
+ "field_groups": {
2933
+ "type": "array",
2934
+ "items": {
2935
+ "type": "object",
2936
+ "properties": {
2937
+ "name": {
2938
+ "type": "string",
2939
+ "minLength": 1
2940
+ },
2941
+ "title": {
2942
+ "type": "string"
2943
+ },
2944
+ "description": {
2945
+ "type": "string"
2946
+ },
2947
+ "metadata": {
2948
+ "type": "string"
2949
+ },
2950
+ "min_items": {
2951
+ "type": [
2952
+ "integer",
2953
+ "null"
2954
+ ],
2955
+ "minimum": 0
2956
+ },
2957
+ "max_items": {
2958
+ "type": [
2959
+ "integer",
2960
+ "null"
2961
+ ],
2962
+ "minimum": 1
2963
+ },
2964
+ "allow_additional_items": {
2965
+ "type": "boolean"
2966
+ }
2967
+ },
2968
+ "required": [
2969
+ "name"
2970
+ ],
2971
+ "additionalProperties": false
2972
+ }
2973
+ },
2974
+ "predefined_fields": {
2975
+ "type": "array",
2976
+ "items": {
2977
+ "type": "object",
2978
+ "required": [
2979
+ "name",
2980
+ "type"
2981
+ ],
2982
+ "properties": {
2983
+ "name": {
2984
+ "type": "string",
2985
+ "minLength": 1
2986
+ },
2987
+ "display_name": {
2988
+ "type": [
2989
+ "string",
2990
+ "null"
2991
+ ],
2992
+ "minLength": 1
2993
+ },
2994
+ "title": {
2995
+ "type": [
2996
+ "string",
2997
+ "null"
2998
+ ]
2999
+ },
3000
+ "type": {
3001
+ "type": "string",
3002
+ "enum": [
3003
+ "string",
3004
+ "number",
3005
+ "boolean",
3006
+ "date",
3007
+ "address",
3008
+ "country",
3009
+ "email",
3010
+ "url",
3011
+ "image",
3012
+ "signature",
3013
+ "initials",
3014
+ "barcode",
3015
+ "combined"
3016
+ ]
3017
+ },
3018
+ "option_list": {
3019
+ "type": [
3020
+ "string",
3021
+ "null"
3022
+ ]
3023
+ },
3024
+ "required_in_template": {
3025
+ "type": "boolean"
3026
+ },
3027
+ "field_required": {
3028
+ "type": "boolean"
3029
+ }
3030
+ },
3031
+ "additionalProperties": false
3032
+ }
3033
+ },
3034
+ "predefined_fields_sample_data": {
3035
+ "type": [
3036
+ "object",
3037
+ "null"
3038
+ ]
3039
+ },
3040
+ "html": {
3041
+ "type": [
3042
+ "string",
3043
+ "null"
3044
+ ]
3045
+ },
3046
+ "scss": {
3047
+ "type": [
3048
+ "string",
3049
+ "null"
3050
+ ]
3051
+ },
3052
+ "header_html": {
3053
+ "type": [
3054
+ "string",
3055
+ "null"
3056
+ ]
3057
+ },
3058
+ "footer_html": {
3059
+ "type": [
3060
+ "string",
3061
+ "null"
3062
+ ]
3063
+ },
3064
+ "html_engine_options": {
3065
+ "type": [
3066
+ "object",
3067
+ "null"
3068
+ ],
3069
+ "properties": {
3070
+ "format": {
3071
+ "type": "string",
3072
+ "enum": [
3073
+ "Letter",
3074
+ "Legal",
3075
+ "Tabloid",
3076
+ "Ledger",
3077
+ "CR80",
3078
+ "A0",
3079
+ "A1",
3080
+ "A2",
3081
+ "A3",
3082
+ "A4",
3083
+ "A5",
3084
+ "A6",
3085
+ "Custom"
3086
+ ]
3087
+ },
3088
+ "width": {
3089
+ "type": "string"
3090
+ },
3091
+ "height": {
3092
+ "type": "string"
3093
+ },
3094
+ "scale": {
3095
+ "type": "number",
3096
+ "exclusiveMinimum": 0
3097
+ },
3098
+ "landscape": {
3099
+ "type": "boolean"
3100
+ },
3101
+ "print_background": {
3102
+ "type": "boolean"
3103
+ },
3104
+ "margin_top": {
3105
+ "type": "string"
3106
+ },
3107
+ "margin_bottom": {
3108
+ "type": "string"
3109
+ },
3110
+ "margin_left": {
3111
+ "type": "string"
3112
+ },
3113
+ "margin_right": {
3114
+ "type": "string"
3115
+ }
3116
+ },
3117
+ "additionalProperties": false
3118
+ }
3119
+ },
3120
+ "additionalProperties": false
3121
+ }
3122
+ }
3123
+ },
3124
+ "updateTemplateDocument": {
3125
+ "query": {
3126
+ "wait": {
3127
+ "required": false,
3128
+ "schema": {
3129
+ "type": "boolean"
3130
+ }
3131
+ }
3132
+ },
3133
+ "body": {
3134
+ "mediaType": "application/json",
3135
+ "required": true,
3136
+ "schema": {
3137
+ "type": "object",
3138
+ "properties": {
3139
+ "cache_id": {
3140
+ "type": "string",
3141
+ "minLength": 1,
3142
+ "maxLength": 255
3143
+ },
3144
+ "document_url": {
3145
+ "type": "string",
3146
+ "minLength": 1,
3147
+ "maxLength": 2048,
3148
+ "pattern": "^https://",
3149
+ "x-pattern-message": "must be an https:// link"
3150
+ },
3151
+ "document_base64": {
3152
+ "type": "string",
3153
+ "minLength": 1
3154
+ },
3155
+ "filename": {
3156
+ "type": "string",
3157
+ "minLength": 1,
3158
+ "maxLength": 255
3159
+ },
3160
+ "reimport_fields": {
3161
+ "type": "boolean"
3162
+ }
3163
+ },
3164
+ "additionalProperties": false
3165
+ }
3166
+ }
3167
+ },
3168
+ "updateTemplateFields": {
3169
+ "body": {
3170
+ "mediaType": "application/json",
3171
+ "required": true,
3172
+ "schema": {
3173
+ "type": "object",
3174
+ "required": [
3175
+ "fields"
3176
+ ],
3177
+ "properties": {
3178
+ "fields": {
3179
+ "type": "array",
3180
+ "minItems": 1,
3181
+ "maxItems": 1000,
3182
+ "items": {
3183
+ "type": "object",
3184
+ "properties": {
3185
+ "name": {
3186
+ "type": [
3187
+ "string",
3188
+ "null"
3189
+ ]
3190
+ },
3191
+ "page": {
3192
+ "type": "integer",
3193
+ "minimum": 1
3194
+ },
3195
+ "type": {
3196
+ "type": "string",
3197
+ "enum": [
3198
+ "string",
3199
+ "number",
3200
+ "boolean",
3201
+ "date",
3202
+ "address",
3203
+ "country",
3204
+ "email",
3205
+ "url",
3206
+ "image",
3207
+ "signature",
3208
+ "initials",
3209
+ "barcode",
3210
+ "combined"
3211
+ ]
3212
+ },
3213
+ "static": {
3214
+ "type": "boolean"
3215
+ },
3216
+ "editable": {
3217
+ "type": "boolean"
3218
+ },
3219
+ "default": {
3220
+ "type": [
3221
+ "string",
3222
+ "null"
3223
+ ]
3224
+ },
3225
+ "title": {
3226
+ "type": "string"
3227
+ },
3228
+ "description": {
3229
+ "type": "string"
3230
+ },
3231
+ "placeholder": {
3232
+ "type": "string"
3233
+ },
3234
+ "metadata": {
3235
+ "type": "string"
3236
+ },
3237
+ "required": {
3238
+ "type": "boolean"
3239
+ },
3240
+ "option_list": {
3241
+ "type": [
3242
+ "string",
3243
+ "null"
3244
+ ]
3245
+ },
3246
+ "combined_field_names": {
3247
+ "type": "string"
3248
+ },
3249
+ "combined_field_type": {
3250
+ "type": "string",
3251
+ "enum": [
3252
+ "separator",
3253
+ "format"
3254
+ ]
3255
+ },
3256
+ "combined_field_separator": {
3257
+ "type": "string"
3258
+ },
3259
+ "combined_field_format": {
3260
+ "type": "string"
3261
+ },
3262
+ "integer": {
3263
+ "type": "boolean"
3264
+ },
3265
+ "minimum": {
3266
+ "type": [
3267
+ "number",
3268
+ "null"
3269
+ ]
3270
+ },
3271
+ "maximum": {
3272
+ "type": [
3273
+ "number",
3274
+ "null"
3275
+ ]
3276
+ },
3277
+ "exclusive_minimum": {
3278
+ "type": "boolean"
3279
+ },
3280
+ "exclusive_maximum": {
3281
+ "type": "boolean"
3282
+ },
3283
+ "include_time": {
3284
+ "type": [
3285
+ "boolean",
3286
+ "null"
3287
+ ]
3288
+ },
3289
+ "signature_allow_draw": {
3290
+ "type": "boolean"
3291
+ },
3292
+ "signature_allow_type": {
3293
+ "type": "boolean"
3294
+ },
3295
+ "barcode_symbology": {
3296
+ "type": "string",
3297
+ "enum": [
3298
+ "code_25",
3299
+ "code_39",
3300
+ "code_93",
3301
+ "code_128",
3302
+ "ean_13",
3303
+ "ean_8",
3304
+ "upc_a",
3305
+ "pdf417"
3306
+ ]
3307
+ },
3308
+ "hidden": {
3309
+ "type": "boolean"
3310
+ },
3311
+ "x": {
3312
+ "type": "number",
3313
+ "minimum": 0
3314
+ },
3315
+ "y": {
3316
+ "type": "number",
3317
+ "minimum": 0
3318
+ },
3319
+ "width": {
3320
+ "type": "number",
3321
+ "exclusiveMinimum": 0
3322
+ },
3323
+ "height": {
3324
+ "type": "number",
3325
+ "exclusiveMinimum": 0
3326
+ },
3327
+ "rotation": {
3328
+ "type": "number",
3329
+ "minimum": -360,
3330
+ "maximum": 360
3331
+ },
3332
+ "display_type": {
3333
+ "type": "string",
3334
+ "enum": [
3335
+ "text",
3336
+ "check",
3337
+ "qrcode",
3338
+ "barcode",
3339
+ "image",
3340
+ "shape"
3341
+ ]
3342
+ },
3343
+ "opacity": {
3344
+ "type": "number",
3345
+ "minimum": 0,
3346
+ "maximum": 1
3347
+ },
3348
+ "date_time_format": {
3349
+ "type": [
3350
+ "string",
3351
+ "null"
3352
+ ]
3353
+ },
3354
+ "typeface": {
3355
+ "type": [
3356
+ "string",
3357
+ "null"
3358
+ ],
3359
+ "enum": [
3360
+ "Inconsolata",
3361
+ "Roboto Mono",
3362
+ "Ubuntu Mono",
3363
+ "Menlo",
3364
+ "Courier",
3365
+ "Helvetica",
3366
+ "Arial",
3367
+ "Calibri",
3368
+ "Open Sans",
3369
+ "Roboto",
3370
+ "Lato",
3371
+ "Poppins",
3372
+ "Public Sans",
3373
+ "Questrial",
3374
+ "Times New Roman",
3375
+ "Dancing Script",
3376
+ "Lovtony Script",
3377
+ null
3378
+ ]
3379
+ },
3380
+ "font_size": {
3381
+ "type": [
3382
+ "integer",
3383
+ "null"
3384
+ ],
3385
+ "minimum": 1
3386
+ },
3387
+ "character_spacing": {
3388
+ "type": "number",
3389
+ "minimum": 0,
3390
+ "maximum": 50
3391
+ },
3392
+ "bold": {
3393
+ "type": "boolean"
3394
+ },
3395
+ "uppercase": {
3396
+ "type": "boolean"
3397
+ },
3398
+ "strikethrough": {
3399
+ "type": "boolean"
3400
+ },
3401
+ "keep_leading_spaces": {
3402
+ "type": "boolean"
3403
+ },
3404
+ "overflow": {
3405
+ "type": "string",
3406
+ "enum": [
3407
+ "shrink_to_fit",
3408
+ "truncate"
3409
+ ]
3410
+ },
3411
+ "multiline": {
3412
+ "type": "boolean"
3413
+ },
3414
+ "multiline_lines": {
3415
+ "type": [
3416
+ "integer",
3417
+ "null"
3418
+ ],
3419
+ "minimum": 1,
3420
+ "maximum": 300
3421
+ },
3422
+ "min_length": {
3423
+ "type": "number"
3424
+ },
3425
+ "max_length": {
3426
+ "type": [
3427
+ "integer",
3428
+ "null"
3429
+ ],
3430
+ "minimum": 0
3431
+ },
3432
+ "auto_calculate_max_length": {
3433
+ "type": "boolean"
3434
+ },
3435
+ "color": {
3436
+ "type": [
3437
+ "string",
3438
+ "null"
3439
+ ],
3440
+ "pattern": "^[A-Fa-f0-9]{6}$",
3441
+ "x-pattern-message": "must be a 6-digit hex color without #, like FF0000"
3442
+ },
3443
+ "color_field_name": {
3444
+ "type": [
3445
+ "string",
3446
+ "null"
3447
+ ]
3448
+ },
3449
+ "color_field_required": {
3450
+ "type": "boolean"
3451
+ },
3452
+ "background_color": {
3453
+ "type": [
3454
+ "string",
3455
+ "null"
3456
+ ],
3457
+ "pattern": "^[A-Fa-f0-9]{6}$",
3458
+ "x-pattern-message": "must be a 6-digit hex color without #, like FF0000"
3459
+ },
3460
+ "background_color_field_name": {
3461
+ "type": [
3462
+ "string",
3463
+ "null"
3464
+ ]
3465
+ },
3466
+ "background_color_field_required": {
3467
+ "type": "boolean"
3468
+ },
3469
+ "alignment": {
3470
+ "type": "string",
3471
+ "enum": [
3472
+ "left",
3473
+ "center",
3474
+ "right",
3475
+ "justify"
3476
+ ]
3477
+ },
3478
+ "v_alignment": {
3479
+ "type": "string",
3480
+ "enum": [
3481
+ "bottom",
3482
+ "center",
3483
+ "top"
3484
+ ]
3485
+ },
3486
+ "comb": {
3487
+ "type": "boolean"
3488
+ },
3489
+ "comb_number_of_cells": {
3490
+ "type": "integer",
3491
+ "minimum": 1
3492
+ },
3493
+ "comb_value_offset": {
3494
+ "type": "integer",
3495
+ "minimum": 0
3496
+ },
3497
+ "shape_type": {
3498
+ "type": "string",
3499
+ "enum": [
3500
+ "square",
3501
+ "rectangle",
3502
+ "circle",
3503
+ "ellipse",
3504
+ "triangle",
3505
+ "polygon"
3506
+ ]
3507
+ },
3508
+ "shape_sides": {
3509
+ "type": "integer",
3510
+ "minimum": 3,
3511
+ "maximum": 12
3512
+ },
3513
+ "shape_border_width": {
3514
+ "type": "integer",
3515
+ "minimum": 1
3516
+ },
3517
+ "shape_border_color": {
3518
+ "type": "string",
3519
+ "pattern": "^[A-Fa-f0-9]{6}$",
3520
+ "x-pattern-message": "must be a 6-digit hex color without #, like FF0000"
3521
+ },
3522
+ "shape_border_color_field_name": {
3523
+ "type": [
3524
+ "string",
3525
+ "null"
3526
+ ]
3527
+ },
3528
+ "shape_border_color_field_required": {
3529
+ "type": "boolean"
3530
+ },
3531
+ "shape_fill_color": {
3532
+ "type": [
3533
+ "string",
3534
+ "null"
3535
+ ],
3536
+ "pattern": "^[A-Fa-f0-9]{6}$",
3537
+ "x-pattern-message": "must be a 6-digit hex color without #, like FF0000"
3538
+ },
3539
+ "shape_fill_color_field_name": {
3540
+ "type": [
3541
+ "string",
3542
+ "null"
3543
+ ]
3544
+ },
3545
+ "shape_fill_color_field_required": {
3546
+ "type": "boolean"
3547
+ },
3548
+ "check_character": {
3549
+ "type": "string",
3550
+ "enum": [
3551
+ "✓",
3552
+ "✔",
3553
+ "✖",
3554
+ "✗",
3555
+ "✘"
3556
+ ]
3557
+ },
3558
+ "check_color": {
3559
+ "type": [
3560
+ "string",
3561
+ "null"
3562
+ ],
3563
+ "pattern": "^[A-Fa-f0-9]{6}$",
3564
+ "x-pattern-message": "must be a 6-digit hex color without #, like FF0000"
3565
+ },
3566
+ "check_color_field_name": {
3567
+ "type": [
3568
+ "string",
3569
+ "null"
3570
+ ]
3571
+ },
3572
+ "check_color_field_required": {
3573
+ "type": "boolean"
3574
+ },
3575
+ "qrcode_color": {
3576
+ "type": [
3577
+ "string",
3578
+ "null"
3579
+ ],
3580
+ "pattern": "^[A-Fa-f0-9]{6}$",
3581
+ "x-pattern-message": "must be a 6-digit hex color without #, like FF0000"
3582
+ },
3583
+ "qrcode_color_field_name": {
3584
+ "type": [
3585
+ "string",
3586
+ "null"
3587
+ ]
3588
+ },
3589
+ "qrcode_color_field_required": {
3590
+ "type": "boolean"
3591
+ },
3592
+ "true_text": {
3593
+ "type": [
3594
+ "string",
3595
+ "null"
3596
+ ]
3597
+ },
3598
+ "false_text": {
3599
+ "type": [
3600
+ "string",
3601
+ "null"
3602
+ ]
3603
+ },
3604
+ "condition": {
3605
+ "type": [
3606
+ "string",
3607
+ "null"
3608
+ ]
3609
+ },
3610
+ "string_condition_type": {
3611
+ "type": "string",
3612
+ "enum": [
3613
+ "equals",
3614
+ "contains",
3615
+ "starts_with",
3616
+ "ends_with",
3617
+ "regex"
3618
+ ]
3619
+ },
3620
+ "number_condition_type": {
3621
+ "type": "string",
3622
+ "enum": [
3623
+ "equals",
3624
+ "range",
3625
+ "gte",
3626
+ "gt",
3627
+ "lte",
3628
+ "lt"
3629
+ ]
3630
+ },
3631
+ "number_condition_range_min": {
3632
+ "type": [
3633
+ "number",
3634
+ "null"
3635
+ ]
3636
+ },
3637
+ "number_condition_range_max": {
3638
+ "type": [
3639
+ "number",
3640
+ "null"
3641
+ ]
3642
+ },
3643
+ "number_condition_range_exclusive_min": {
3644
+ "type": "boolean"
3645
+ },
3646
+ "number_condition_range_exclusive_max": {
3647
+ "type": "boolean"
3648
+ },
3649
+ "invert_boolean_condition": {
3650
+ "type": "boolean"
3651
+ },
3652
+ "currency": {
3653
+ "type": "boolean"
3654
+ },
3655
+ "decimal_places": {
3656
+ "type": [
3657
+ "integer",
3658
+ "null"
3659
+ ],
3660
+ "minimum": 0,
3661
+ "maximum": 99
3662
+ },
3663
+ "image_scale_type": {
3664
+ "type": "string",
3665
+ "enum": [
3666
+ "fit",
3667
+ "fill",
3668
+ "stretch"
3669
+ ]
3670
+ },
3671
+ "image_gravity": {
3672
+ "type": "string",
3673
+ "enum": [
3674
+ "NorthWest",
3675
+ "North",
3676
+ "NorthEast",
3677
+ "West",
3678
+ "Center",
3679
+ "East",
3680
+ "SouthWest",
3681
+ "South",
3682
+ "SouthEast"
3683
+ ]
3684
+ },
3685
+ "dependencies": {
3686
+ "type": [
3687
+ "object",
3688
+ "null"
3689
+ ],
3690
+ "required": [
3691
+ "action",
3692
+ "conditions"
3693
+ ],
3694
+ "properties": {
3695
+ "action": {
3696
+ "type": "string",
3697
+ "enum": [
3698
+ "require_and_show",
3699
+ "show",
3700
+ "require"
3701
+ ]
3702
+ },
3703
+ "match": {
3704
+ "type": "string",
3705
+ "enum": [
3706
+ "all",
3707
+ "any"
3708
+ ]
3709
+ },
3710
+ "conditions": {
3711
+ "type": "array",
3712
+ "items": {
3713
+ "oneOf": [
3714
+ {
3715
+ "$ref": "#/components/schemas/FieldPresenceCondition"
3716
+ },
3717
+ {
3718
+ "$ref": "#/components/schemas/FieldEqualsCondition"
3719
+ },
3720
+ {
3721
+ "$ref": "#/components/schemas/FieldInCondition"
3722
+ },
3723
+ {
3724
+ "$ref": "#/components/schemas/FieldComparisonCondition"
3725
+ },
3726
+ {
3727
+ "$ref": "#/components/schemas/FieldRangeCondition"
3728
+ }
3729
+ ],
3730
+ "discriminator": {
3731
+ "propertyName": "operator",
3732
+ "mapping": [
3733
+ [
3734
+ "present",
3735
+ "#/components/schemas/FieldPresenceCondition"
3736
+ ],
3737
+ [
3738
+ "blank",
3739
+ "#/components/schemas/FieldPresenceCondition"
3740
+ ],
3741
+ [
3742
+ "equals",
3743
+ "#/components/schemas/FieldEqualsCondition"
3744
+ ],
3745
+ [
3746
+ "not_equals",
3747
+ "#/components/schemas/FieldEqualsCondition"
3748
+ ],
3749
+ [
3750
+ "in",
3751
+ "#/components/schemas/FieldInCondition"
3752
+ ],
3753
+ [
3754
+ "gt",
3755
+ "#/components/schemas/FieldComparisonCondition"
3756
+ ],
3757
+ [
3758
+ "gte",
3759
+ "#/components/schemas/FieldComparisonCondition"
3760
+ ],
3761
+ [
3762
+ "lt",
3763
+ "#/components/schemas/FieldComparisonCondition"
3764
+ ],
3765
+ [
3766
+ "lte",
3767
+ "#/components/schemas/FieldComparisonCondition"
3768
+ ],
3769
+ [
3770
+ "range",
3771
+ "#/components/schemas/FieldRangeCondition"
3772
+ ]
3773
+ ]
3774
+ }
3775
+ }
3776
+ }
3777
+ },
3778
+ "additionalProperties": false
3779
+ },
3780
+ "id": {
3781
+ "type": "integer",
3782
+ "minimum": 0
3783
+ }
3784
+ },
3785
+ "additionalProperties": false
3786
+ }
3787
+ }
3788
+ },
3789
+ "additionalProperties": false
3790
+ }
3791
+ }
3792
+ },
3793
+ "updateWebhook": {
3794
+ "body": {
3795
+ "mediaType": "application/json",
3796
+ "required": true,
3797
+ "schema": {
3798
+ "type": "object",
3799
+ "properties": {
3800
+ "name": {
3801
+ "type": [
3802
+ "string",
3803
+ "null"
3804
+ ],
3805
+ "maxLength": 255
3806
+ },
3807
+ "url": {
3808
+ "type": "string",
3809
+ "format": "uri"
3810
+ },
3811
+ "enabled": {
3812
+ "type": "boolean"
3813
+ },
3814
+ "event_types": {
3815
+ "type": "array",
3816
+ "minItems": 1,
3817
+ "uniqueItems": true,
3818
+ "items": {
3819
+ "type": "string",
3820
+ "enum": [
3821
+ "submission.processed",
3822
+ "submission.failed",
3823
+ "submission.declined",
3824
+ "signature_request.viewed",
3825
+ "signature_request.completed",
3826
+ "signature_request.declined",
3827
+ "combined_pdf.processed",
3828
+ "combined_pdf.failed",
3829
+ "submission_batch.processed",
3830
+ "submission_batch.failed",
3831
+ "submission.created",
3832
+ "submission.updated",
3833
+ "submission.expired",
3834
+ "signature_request.updated",
3835
+ "combined_pdf.expired",
3836
+ "template.created",
3837
+ "template.updated",
3838
+ "template.deleted",
3839
+ "webhook.created",
3840
+ "webhook.updated",
3841
+ "webhook.deleted",
3842
+ "custom_file.created",
3843
+ "folder.created",
3844
+ "folder.updated",
3845
+ "folder.deleted"
3846
+ ]
3847
+ }
3848
+ },
3849
+ "mode": {
3850
+ "type": [
3851
+ "string",
3852
+ "null"
3853
+ ],
3854
+ "enum": [
3855
+ "test",
3856
+ "live",
3857
+ null
3858
+ ]
3859
+ },
3860
+ "api_token_ids": {
3861
+ "type": "array",
3862
+ "uniqueItems": true,
3863
+ "items": {
3864
+ "type": "string"
3865
+ }
3866
+ },
3867
+ "template_ids": {
3868
+ "type": "array",
3869
+ "uniqueItems": true,
3870
+ "items": {
3871
+ "type": "string"
3872
+ }
3873
+ },
3874
+ "folder_ids": {
3875
+ "type": "array",
3876
+ "uniqueItems": true,
3877
+ "items": {
3878
+ "type": "string"
3879
+ }
3880
+ },
3881
+ "include_submission_data": {
3882
+ "type": "boolean"
3883
+ },
3884
+ "strip_fields": {
3885
+ "type": "array",
3886
+ "items": {
3887
+ "type": "string"
3888
+ }
3889
+ },
3890
+ "headers": {
3891
+ "type": "object",
3892
+ "additionalProperties": {
3893
+ "type": "string"
3894
+ }
3895
+ }
3896
+ },
3897
+ "additionalProperties": false
3898
+ }
3899
+ }
3900
+ },
3901
+ "uploadTemplate": {
3902
+ "query": {
3903
+ "wait": {
3904
+ "required": false,
3905
+ "schema": {
3906
+ "type": "boolean"
3907
+ }
3908
+ }
3909
+ },
3910
+ "body": {
3911
+ "mediaType": "multipart/form-data",
3912
+ "required": true,
3913
+ "schema": {
3914
+ "type": "object",
3915
+ "required": [
3916
+ "document"
3917
+ ],
3918
+ "properties": {
3919
+ "document": {
3920
+ "type": "string",
3921
+ "format": "binary"
3922
+ },
3923
+ "name": {
3924
+ "type": "string",
3925
+ "minLength": 1,
3926
+ "maxLength": 255
3927
+ },
3928
+ "description": {
3929
+ "type": "string"
3930
+ },
3931
+ "parent_folder_id": {
3932
+ "type": "string",
3933
+ "minLength": 1
3934
+ },
3935
+ "ai_field_naming_language": {
3936
+ "type": "string",
3937
+ "enum": [
3938
+ "auto",
3939
+ "english",
3940
+ "form_language"
3941
+ ]
3942
+ },
3943
+ "detect_fields": {
3944
+ "type": "boolean"
3945
+ },
3946
+ "field_source": {
3947
+ "type": "string",
3948
+ "enum": [
3949
+ "auto",
3950
+ "pdf_detection",
3951
+ "pdf_form_fields"
3952
+ ]
3953
+ },
3954
+ "field_naming": {
3955
+ "type": "string",
3956
+ "enum": [
3957
+ "ai",
3958
+ "preserve"
3959
+ ]
3960
+ },
3961
+ "field_logic": {
3962
+ "type": "string",
3963
+ "enum": [
3964
+ "ai",
3965
+ "none"
3966
+ ]
3967
+ }
3968
+ },
3969
+ "additionalProperties": false
3970
+ }
3971
+ }
3972
+ },
3973
+ "uploadTemplateDocument": {
3974
+ "query": {
3975
+ "wait": {
3976
+ "required": false,
3977
+ "schema": {
3978
+ "type": "boolean"
3979
+ }
3980
+ }
3981
+ },
3982
+ "body": {
3983
+ "mediaType": "multipart/form-data",
3984
+ "required": true,
3985
+ "schema": {
3986
+ "type": "object",
3987
+ "required": [
3988
+ "document"
3989
+ ],
3990
+ "properties": {
3991
+ "document": {
3992
+ "type": "string",
3993
+ "format": "binary"
3994
+ },
3995
+ "reimport_fields": {
3996
+ "type": "boolean"
3997
+ }
3998
+ },
3999
+ "additionalProperties": false
4000
+ }
4001
+ }
4002
+ },
4003
+ "validateSubmission": {
4004
+ "query": {
4005
+ "version": {
4006
+ "required": false,
4007
+ "schema": {
4008
+ "type": "string",
4009
+ "pattern": "^(\\d+(\\.\\d+(\\.\\d+)?)?|latest|draft)$",
4010
+ "x-pattern-message": "must be a version like 1.2.3 or 1, or latest or draft"
4011
+ }
4012
+ }
4013
+ },
4014
+ "body": {
4015
+ "mediaType": "application/json",
4016
+ "required": true,
4017
+ "schema": {
4018
+ "type": "object",
4019
+ "properties": {
4020
+ "test": {
4021
+ "type": "boolean"
4022
+ },
4023
+ "editable": {
4024
+ "type": "boolean"
4025
+ },
4026
+ "data": {
4027
+ "type": "object"
4028
+ },
4029
+ "metadata": {
4030
+ "type": "object"
4031
+ },
4032
+ "password": {
4033
+ "type": "string",
4034
+ "minLength": 1
4035
+ },
4036
+ "output_formats": {
4037
+ "type": "array",
4038
+ "minItems": 1,
4039
+ "uniqueItems": true,
4040
+ "items": {
4041
+ "type": "string",
4042
+ "enum": [
4043
+ "pdf",
4044
+ "png"
4045
+ ]
4046
+ }
4047
+ },
4048
+ "expires_in": {
4049
+ "type": "integer",
4050
+ "minimum": 1,
4051
+ "maximum": 315360000
4052
+ },
4053
+ "field_overrides": {
4054
+ "type": "object",
4055
+ "additionalProperties": {
4056
+ "$ref": "#/components/schemas/FieldOverride"
4057
+ }
4058
+ },
4059
+ "html": {
4060
+ "type": "string"
4061
+ },
4062
+ "css": {
4063
+ "type": "string"
4064
+ },
4065
+ "signature_requests": {
4066
+ "type": "array",
4067
+ "maxItems": 100,
4068
+ "items": {
4069
+ "type": "object",
4070
+ "properties": {
4071
+ "name": {
4072
+ "type": [
4073
+ "string",
4074
+ "null"
4075
+ ],
4076
+ "maxLength": 255
4077
+ },
4078
+ "email": {
4079
+ "type": [
4080
+ "string",
4081
+ "null"
4082
+ ],
4083
+ "maxLength": 255
4084
+ },
4085
+ "fields": {
4086
+ "type": "array",
4087
+ "minItems": 1,
4088
+ "uniqueItems": true,
4089
+ "items": {
4090
+ "type": "string",
4091
+ "minLength": 1
4092
+ }
4093
+ },
4094
+ "metadata": {
4095
+ "type": "object"
4096
+ },
4097
+ "role": {
4098
+ "type": "string",
4099
+ "minLength": 1
4100
+ },
4101
+ "auth_type": {
4102
+ "type": "string",
4103
+ "enum": [
4104
+ "password",
4105
+ "oauth",
4106
+ "email_link",
4107
+ "phone_number",
4108
+ "ldap",
4109
+ "saml"
4110
+ ]
4111
+ },
4112
+ "auth_second_factor_type": {
4113
+ "type": "string",
4114
+ "enum": [
4115
+ "none",
4116
+ "phone_number",
4117
+ "totp",
4118
+ "mobile_push",
4119
+ "security_key",
4120
+ "fingerprint"
4121
+ ]
4122
+ },
4123
+ "auth_provider": {
4124
+ "type": [
4125
+ "string",
4126
+ "null"
4127
+ ],
4128
+ "maxLength": 255
4129
+ },
4130
+ "auth_session_started_at": {
4131
+ "type": [
4132
+ "string",
4133
+ "null"
4134
+ ],
4135
+ "format": "date-time"
4136
+ },
4137
+ "auth_session_id_hash": {
4138
+ "type": [
4139
+ "string",
4140
+ "null"
4141
+ ]
4142
+ },
4143
+ "auth_user_id_hash": {
4144
+ "type": [
4145
+ "string",
4146
+ "null"
4147
+ ]
4148
+ },
4149
+ "auth_username_hash": {
4150
+ "type": [
4151
+ "string",
4152
+ "null"
4153
+ ]
4154
+ },
4155
+ "auth_phone_number_hash": {
4156
+ "type": [
4157
+ "string",
4158
+ "null"
4159
+ ]
4160
+ },
4161
+ "ignore_unknown_fields": {
4162
+ "type": "boolean"
4163
+ },
4164
+ "prefilled_values_editable": {
4165
+ "type": "boolean"
4166
+ }
4167
+ },
4168
+ "required": [
4169
+ "fields",
4170
+ "auth_type"
4171
+ ],
4172
+ "additionalProperties": false
4173
+ }
4174
+ }
4175
+ },
4176
+ "additionalProperties": false
4177
+ }
4178
+ }
4179
+ }
4180
+ },
4181
+ "routes": {
4182
+ "DELETE /combined_pdfs/{combined_pdf_id}": "expireCombinedPdf",
4183
+ "DELETE /custom_files/{custom_file_id}": "deleteCustomFile",
4184
+ "DELETE /folders/{folder_id}": "deleteFolder",
4185
+ "DELETE /submissions/{submission_id}": "expireSubmission",
4186
+ "DELETE /templates/{template_id}": "deleteTemplate",
4187
+ "DELETE /webhooks/{webhook_id}": "deleteWebhook",
4188
+ "GET /authentication": "testAuthentication",
4189
+ "GET /combined_pdfs": "listCombinedPdfs",
4190
+ "GET /combined_pdfs/{combined_pdf_id}": "getCombinedPdf",
4191
+ "GET /custom_files": "listCustomFiles",
4192
+ "GET /custom_files/{custom_file_id}": "getCustomFile",
4193
+ "GET /folders": "listFolders",
4194
+ "GET /folders/{folder_id}": "getFolder",
4195
+ "GET /signature_requests/{signature_request_id}": "getSignatureRequest",
4196
+ "GET /submissions": "listSubmissions",
4197
+ "GET /submissions/batches/{submission_batch_id}": "getSubmissionBatch",
4198
+ "GET /submissions/{submission_id}": "getSubmission",
4199
+ "GET /templates": "listTemplates",
4200
+ "GET /templates/{template_id}": "getTemplate",
4201
+ "GET /templates/{template_id}/diff": "getTemplateDiff",
4202
+ "GET /templates/{template_id}/fields": "listTemplateFields",
4203
+ "GET /templates/{template_id}/model_code": "getTemplateModelCode",
4204
+ "GET /templates/{template_id}/page_images": "getTemplatePageImages",
4205
+ "GET /templates/{template_id}/schema": "getTemplateSchema",
4206
+ "GET /templates/{template_id}/submissions": "listTemplateSubmissions",
4207
+ "GET /uploads/presign": "getPresignUrl",
4208
+ "GET /webhooks": "listWebhooks",
4209
+ "GET /webhooks/{webhook_id}": "getWebhook",
4210
+ "POST /combined_pdfs": "createCombinedPdf",
4211
+ "POST /custom_files": "createCustomFileFromUpload",
4212
+ "POST /folders": "createFolder",
4213
+ "POST /folders/{folder_id}/move": "moveFolder",
4214
+ "POST /folders/{folder_id}/rename": "renameFolder",
4215
+ "POST /signature_requests/{signature_request_id}/events": "createSignatureRequestEvent",
4216
+ "POST /signature_requests/{signature_request_id}/tokens": "createSignatureRequestToken",
4217
+ "POST /submissions/batches": "createSubmissionBatch",
4218
+ "POST /submissions/{submission_id}/generate_files": "generateSubmissionFiles",
4219
+ "POST /submissions/{submission_id}/generate_preview": "generateSubmissionPreview",
4220
+ "POST /templates": "createTemplate",
4221
+ "POST /templates/upload": "uploadTemplate",
4222
+ "POST /templates/{template_id}/copy": "copyTemplate",
4223
+ "POST /templates/{template_id}/fields": "addTemplateFields",
4224
+ "POST /templates/{template_id}/fields/remove": "removeTemplateFields",
4225
+ "POST /templates/{template_id}/fields/reorder": "reorderTemplateFields",
4226
+ "POST /templates/{template_id}/move": "moveTemplate",
4227
+ "POST /templates/{template_id}/publish_version": "publishTemplateVersion",
4228
+ "POST /templates/{template_id}/restore_version": "restoreTemplateVersion",
4229
+ "POST /templates/{template_id}/submissions": "createSubmission",
4230
+ "POST /templates/{template_id}/submissions/validate": "validateSubmission",
4231
+ "POST /webhooks": "createWebhook",
4232
+ "PUT /signature_requests/{signature_request_id}": "updateSignatureRequest",
4233
+ "PUT /templates/{template_id}": "updateTemplate",
4234
+ "PUT /templates/{template_id}/document": "updateTemplateDocument",
4235
+ "PUT /templates/{template_id}/document/upload": "uploadTemplateDocument",
4236
+ "PUT /templates/{template_id}/fields": "updateTemplateFields",
4237
+ "PUT /webhooks/{webhook_id}": "updateWebhook"
4238
+ },
4239
+ "components": {
4240
+ "schemas": {
4241
+ "CombinedPdfSourcePdf": {
4242
+ "type": "object",
4243
+ "required": [
4244
+ "type",
4245
+ "id"
4246
+ ],
4247
+ "properties": {
4248
+ "type": {
4249
+ "type": "string",
4250
+ "const": "combined_pdf"
4251
+ },
4252
+ "id": {
4253
+ "type": "string",
4254
+ "minLength": 1
4255
+ }
4256
+ },
4257
+ "additionalProperties": false,
4258
+ "x-not-allowed-properties": {
4259
+ "url": "isn't used by 'combined_pdf' source PDFs. Remove it",
4260
+ "template_version": "isn't used by 'combined_pdf' source PDFs. Remove it",
4261
+ "processed": "isn't used by 'combined_pdf' source PDFs. Remove it"
4262
+ }
4263
+ },
4264
+ "CustomFileSourcePdf": {
4265
+ "type": "object",
4266
+ "required": [
4267
+ "type",
4268
+ "id"
4269
+ ],
4270
+ "properties": {
4271
+ "type": {
4272
+ "type": "string",
4273
+ "const": "custom_file"
4274
+ },
4275
+ "id": {
4276
+ "type": "string",
4277
+ "minLength": 1
4278
+ }
4279
+ },
4280
+ "additionalProperties": false,
4281
+ "x-not-allowed-properties": {
4282
+ "url": "isn't used by 'custom_file' source PDFs. Remove it",
4283
+ "template_version": "isn't used by 'custom_file' source PDFs. Remove it",
4284
+ "processed": "isn't used by 'custom_file' source PDFs. Remove it"
4285
+ }
4286
+ },
4287
+ "FieldComparisonCondition": {
4288
+ "type": "object",
4289
+ "required": [
4290
+ "field",
4291
+ "operator",
4292
+ "value"
4293
+ ],
4294
+ "properties": {
4295
+ "field": {
4296
+ "type": "string"
4297
+ },
4298
+ "operator": {
4299
+ "type": "string",
4300
+ "enum": [
4301
+ "gt",
4302
+ "gte",
4303
+ "lt",
4304
+ "lte"
4305
+ ]
4306
+ },
4307
+ "value": {
4308
+ "type": [
4309
+ "number",
4310
+ "string"
4311
+ ],
4312
+ "pattern": "^-?\\d+(\\.\\d+)?([eE][-+]?\\d+)?$",
4313
+ "x-pattern-message": "must be a number, like 10 or 2.5"
4314
+ }
4315
+ },
4316
+ "additionalProperties": false,
4317
+ "x-not-allowed-properties": {
4318
+ "range_max": "isn't used by 'gt', 'gte', 'lt' or 'lte' conditions. Remove it"
4319
+ }
4320
+ },
4321
+ "FieldEqualsCondition": {
4322
+ "type": "object",
4323
+ "required": [
4324
+ "field",
4325
+ "operator",
4326
+ "value"
4327
+ ],
4328
+ "properties": {
4329
+ "field": {
4330
+ "type": "string"
4331
+ },
4332
+ "operator": {
4333
+ "type": "string",
4334
+ "enum": [
4335
+ "equals",
4336
+ "not_equals"
4337
+ ]
4338
+ },
4339
+ "value": {
4340
+ "type": [
4341
+ "string",
4342
+ "number",
4343
+ "boolean"
4344
+ ]
4345
+ }
4346
+ },
4347
+ "additionalProperties": false,
4348
+ "x-not-allowed-properties": {
4349
+ "range_max": "isn't used by 'equals' or 'not_equals' conditions. Remove it"
4350
+ }
4351
+ },
4352
+ "FieldInCondition": {
4353
+ "type": "object",
4354
+ "required": [
4355
+ "field",
4356
+ "operator",
4357
+ "value"
4358
+ ],
4359
+ "properties": {
4360
+ "field": {
4361
+ "type": "string"
4362
+ },
4363
+ "operator": {
4364
+ "type": "string",
4365
+ "const": "in"
4366
+ },
4367
+ "value": {
4368
+ "type": "array",
4369
+ "minItems": 1,
4370
+ "items": {
4371
+ "type": [
4372
+ "string",
4373
+ "number",
4374
+ "boolean"
4375
+ ],
4376
+ "minLength": 1
4377
+ }
4378
+ }
4379
+ },
4380
+ "additionalProperties": false,
4381
+ "x-not-allowed-properties": {
4382
+ "range_max": "isn't used by 'in' conditions. Remove it"
4383
+ }
4384
+ },
4385
+ "FieldOverride": {
4386
+ "type": "object",
4387
+ "properties": {
4388
+ "static": {
4389
+ "type": "boolean"
4390
+ },
4391
+ "editable": {
4392
+ "type": "boolean"
4393
+ },
4394
+ "default": {
4395
+ "type": [
4396
+ "string",
4397
+ "null"
4398
+ ]
4399
+ },
4400
+ "title": {
4401
+ "type": "string"
4402
+ },
4403
+ "required": {
4404
+ "type": "boolean"
4405
+ },
4406
+ "option_list": {
4407
+ "type": [
4408
+ "string",
4409
+ "null"
4410
+ ]
4411
+ },
4412
+ "combined_field_names": {
4413
+ "type": "string"
4414
+ },
4415
+ "combined_field_type": {
4416
+ "type": "string",
4417
+ "enum": [
4418
+ "separator",
4419
+ "format"
4420
+ ]
4421
+ },
4422
+ "combined_field_separator": {
4423
+ "type": "string"
4424
+ },
4425
+ "combined_field_format": {
4426
+ "type": "string"
4427
+ },
4428
+ "integer": {
4429
+ "type": "boolean"
4430
+ },
4431
+ "include_time": {
4432
+ "type": [
4433
+ "boolean",
4434
+ "null"
4435
+ ]
4436
+ },
4437
+ "signature_allow_draw": {
4438
+ "type": "boolean"
4439
+ },
4440
+ "signature_allow_type": {
4441
+ "type": "boolean"
4442
+ },
4443
+ "barcode_symbology": {
4444
+ "type": "string",
4445
+ "enum": [
4446
+ "code_25",
4447
+ "code_39",
4448
+ "code_93",
4449
+ "code_128",
4450
+ "ean_13",
4451
+ "ean_8",
4452
+ "upc_a",
4453
+ "pdf417"
4454
+ ]
4455
+ },
4456
+ "hidden": {
4457
+ "type": "boolean"
4458
+ },
4459
+ "x": {
4460
+ "type": "number",
4461
+ "minimum": 0
4462
+ },
4463
+ "y": {
4464
+ "type": "number",
4465
+ "minimum": 0
4466
+ },
4467
+ "width": {
4468
+ "type": "number",
4469
+ "exclusiveMinimum": 0
4470
+ },
4471
+ "height": {
4472
+ "type": "number",
4473
+ "exclusiveMinimum": 0
4474
+ },
4475
+ "rotation": {
4476
+ "type": "number",
4477
+ "minimum": -360,
4478
+ "maximum": 360
4479
+ },
4480
+ "display_type": {
4481
+ "type": "string",
4482
+ "enum": [
4483
+ "text",
4484
+ "check",
4485
+ "qrcode",
4486
+ "barcode",
4487
+ "image",
4488
+ "shape"
4489
+ ]
4490
+ },
4491
+ "opacity": {
4492
+ "type": "number",
4493
+ "minimum": 0,
4494
+ "maximum": 1
4495
+ },
4496
+ "date_time_format": {
4497
+ "type": [
4498
+ "string",
4499
+ "null"
4500
+ ]
4501
+ },
4502
+ "typeface": {
4503
+ "type": [
4504
+ "string",
4505
+ "null"
4506
+ ],
4507
+ "enum": [
4508
+ "Inconsolata",
4509
+ "Roboto Mono",
4510
+ "Ubuntu Mono",
4511
+ "Menlo",
4512
+ "Courier",
4513
+ "Helvetica",
4514
+ "Arial",
4515
+ "Calibri",
4516
+ "Open Sans",
4517
+ "Roboto",
4518
+ "Lato",
4519
+ "Poppins",
4520
+ "Public Sans",
4521
+ "Questrial",
4522
+ "Times New Roman",
4523
+ "Dancing Script",
4524
+ "Lovtony Script",
4525
+ null
4526
+ ]
4527
+ },
4528
+ "font_size": {
4529
+ "type": [
4530
+ "integer",
4531
+ "null"
4532
+ ],
4533
+ "minimum": 1
4534
+ },
4535
+ "character_spacing": {
4536
+ "type": "number",
4537
+ "minimum": 0,
4538
+ "maximum": 50
4539
+ },
4540
+ "bold": {
4541
+ "type": "boolean"
4542
+ },
4543
+ "uppercase": {
4544
+ "type": "boolean"
4545
+ },
4546
+ "strikethrough": {
4547
+ "type": "boolean"
4548
+ },
4549
+ "keep_leading_spaces": {
4550
+ "type": "boolean"
4551
+ },
4552
+ "overflow": {
4553
+ "type": "string",
4554
+ "enum": [
4555
+ "shrink_to_fit",
4556
+ "truncate"
4557
+ ]
4558
+ },
4559
+ "multiline": {
4560
+ "type": "boolean"
4561
+ },
4562
+ "multiline_lines": {
4563
+ "type": [
4564
+ "integer",
4565
+ "null"
4566
+ ],
4567
+ "minimum": 1,
4568
+ "maximum": 300
4569
+ },
4570
+ "max_length": {
4571
+ "type": [
4572
+ "integer",
4573
+ "null"
4574
+ ],
4575
+ "minimum": 0
4576
+ },
4577
+ "color": {
4578
+ "type": [
4579
+ "string",
4580
+ "null"
4581
+ ],
4582
+ "pattern": "^[A-Fa-f0-9]{6}$",
4583
+ "x-pattern-message": "must be a 6-digit hex color without #, like FF0000"
4584
+ },
4585
+ "background_color": {
4586
+ "type": [
4587
+ "string",
4588
+ "null"
4589
+ ],
4590
+ "pattern": "^[A-Fa-f0-9]{6}$",
4591
+ "x-pattern-message": "must be a 6-digit hex color without #, like FF0000"
4592
+ },
4593
+ "alignment": {
4594
+ "type": "string",
4595
+ "enum": [
4596
+ "left",
4597
+ "center",
4598
+ "right",
4599
+ "justify"
4600
+ ]
4601
+ },
4602
+ "v_alignment": {
4603
+ "type": "string",
4604
+ "enum": [
4605
+ "bottom",
4606
+ "center",
4607
+ "top"
4608
+ ]
4609
+ },
4610
+ "comb": {
4611
+ "type": "boolean"
4612
+ },
4613
+ "comb_number_of_cells": {
4614
+ "type": "integer",
4615
+ "minimum": 1
4616
+ },
4617
+ "comb_value_offset": {
4618
+ "type": "integer",
4619
+ "minimum": 0
4620
+ },
4621
+ "shape_type": {
4622
+ "type": "string",
4623
+ "enum": [
4624
+ "square",
4625
+ "rectangle",
4626
+ "circle",
4627
+ "ellipse",
4628
+ "triangle",
4629
+ "polygon"
4630
+ ]
4631
+ },
4632
+ "shape_sides": {
4633
+ "type": "integer",
4634
+ "minimum": 3,
4635
+ "maximum": 12
4636
+ },
4637
+ "shape_border_width": {
4638
+ "type": "integer",
4639
+ "minimum": 1
4640
+ },
4641
+ "shape_border_color": {
4642
+ "type": "string",
4643
+ "pattern": "^[A-Fa-f0-9]{6}$",
4644
+ "x-pattern-message": "must be a 6-digit hex color without #, like FF0000"
4645
+ },
4646
+ "shape_fill_color": {
4647
+ "type": [
4648
+ "string",
4649
+ "null"
4650
+ ],
4651
+ "pattern": "^[A-Fa-f0-9]{6}$",
4652
+ "x-pattern-message": "must be a 6-digit hex color without #, like FF0000"
4653
+ },
4654
+ "check_character": {
4655
+ "type": "string",
4656
+ "enum": [
4657
+ "✓",
4658
+ "✔",
4659
+ "✖",
4660
+ "✗",
4661
+ "✘"
4662
+ ]
4663
+ },
4664
+ "check_color": {
4665
+ "type": [
4666
+ "string",
4667
+ "null"
4668
+ ],
4669
+ "pattern": "^[A-Fa-f0-9]{6}$",
4670
+ "x-pattern-message": "must be a 6-digit hex color without #, like FF0000"
4671
+ },
4672
+ "qrcode_color": {
4673
+ "type": [
4674
+ "string",
4675
+ "null"
4676
+ ],
4677
+ "pattern": "^[A-Fa-f0-9]{6}$",
4678
+ "x-pattern-message": "must be a 6-digit hex color without #, like FF0000"
4679
+ },
4680
+ "true_text": {
4681
+ "type": [
4682
+ "string",
4683
+ "null"
4684
+ ]
4685
+ },
4686
+ "false_text": {
4687
+ "type": [
4688
+ "string",
4689
+ "null"
4690
+ ]
4691
+ },
4692
+ "condition": {
4693
+ "type": [
4694
+ "string",
4695
+ "null"
4696
+ ]
4697
+ },
4698
+ "string_condition_type": {
4699
+ "type": "string",
4700
+ "enum": [
4701
+ "equals",
4702
+ "contains",
4703
+ "starts_with",
4704
+ "ends_with",
4705
+ "regex"
4706
+ ]
4707
+ },
4708
+ "number_condition_type": {
4709
+ "type": "string",
4710
+ "enum": [
4711
+ "equals",
4712
+ "range",
4713
+ "gte",
4714
+ "gt",
4715
+ "lte",
4716
+ "lt"
4717
+ ]
4718
+ },
4719
+ "number_condition_range_min": {
4720
+ "type": [
4721
+ "number",
4722
+ "null"
4723
+ ]
4724
+ },
4725
+ "number_condition_range_max": {
4726
+ "type": [
4727
+ "number",
4728
+ "null"
4729
+ ]
4730
+ },
4731
+ "number_condition_range_exclusive_min": {
4732
+ "type": "boolean"
4733
+ },
4734
+ "number_condition_range_exclusive_max": {
4735
+ "type": "boolean"
4736
+ },
4737
+ "invert_boolean_condition": {
4738
+ "type": "boolean"
4739
+ },
4740
+ "decimal_places": {
4741
+ "type": [
4742
+ "integer",
4743
+ "null"
4744
+ ],
4745
+ "minimum": 0,
4746
+ "maximum": 99
4747
+ },
4748
+ "image_scale_type": {
4749
+ "type": "string",
4750
+ "enum": [
4751
+ "fit",
4752
+ "fill",
4753
+ "stretch"
4754
+ ]
4755
+ },
4756
+ "image_gravity": {
4757
+ "type": "string",
4758
+ "enum": [
4759
+ "NorthWest",
4760
+ "North",
4761
+ "NorthEast",
4762
+ "West",
4763
+ "Center",
4764
+ "East",
4765
+ "SouthWest",
4766
+ "South",
4767
+ "SouthEast"
4768
+ ]
4769
+ }
4770
+ },
4771
+ "x-unknown-property-message": "isn't a field setting",
4772
+ "x-not-allowed-properties": {
4773
+ "id": "can't be changed for one submission. Change the field in the template",
4774
+ "name": "can't be changed for one submission. Change the field in the template",
4775
+ "type": "can't be changed for one submission. Change the field in the template",
4776
+ "field_count": "can't be changed for one submission. Change the field in the template",
4777
+ "fieldCount": "can't be changed for one submission. Change the field in the template",
4778
+ "dependencies": "can't be changed for one submission. Change the field in the template",
4779
+ "acroform_name": "can't be changed for one submission. Change the field in the template",
4780
+ "allow_additional_items": "can't be changed for one submission. Change the field in the template",
4781
+ "allowAdditionalItems": "can't be changed for one submission. Change the field in the template",
4782
+ "min_items": "can't be changed for one submission. Change the field in the template",
4783
+ "minItems": "can't be changed for one submission. Change the field in the template",
4784
+ "max_items": "can't be changed for one submission. Change the field in the template",
4785
+ "maxItems": "can't be changed for one submission. Change the field in the template",
4786
+ "description": "can't be changed for one submission: the template's setting always applies. Change it in the template",
4787
+ "placeholder": "can't be changed for one submission: the template's setting always applies. Change it in the template",
4788
+ "metadata": "can't be changed for one submission: the template's setting always applies. Change it in the template",
4789
+ "minimum": "can't be changed for one submission: the template's setting always applies. Change it in the template",
4790
+ "maximum": "can't be changed for one submission: the template's setting always applies. Change it in the template",
4791
+ "exclusive_minimum": "can't be changed for one submission: the template's setting always applies. Change it in the template",
4792
+ "exclusiveMinimum": "can't be changed for one submission: the template's setting always applies. Change it in the template",
4793
+ "exclusive_maximum": "can't be changed for one submission: the template's setting always applies. Change it in the template",
4794
+ "exclusiveMaximum": "can't be changed for one submission: the template's setting always applies. Change it in the template",
4795
+ "currency": "can't be changed for one submission: the template's setting always applies. Change it in the template",
4796
+ "min_length": "can't be changed for one submission: the template's setting always applies. Change it in the template",
4797
+ "minLength": "can't be changed for one submission: the template's setting always applies. Change it in the template",
4798
+ "auto_calculate_max_length": "can't be changed for one submission: the template's setting always applies. Change it in the template",
4799
+ "autoCalculateMaxLength": "can't be changed for one submission: the template's setting always applies. Change it in the template",
4800
+ "color_field_name": "can't be changed for one submission: the template's setting always applies. Change it in the template",
4801
+ "colorFieldName": "can't be changed for one submission: the template's setting always applies. Change it in the template",
4802
+ "color_field_required": "can't be changed for one submission: the template's setting always applies. Change it in the template",
4803
+ "colorFieldRequired": "can't be changed for one submission: the template's setting always applies. Change it in the template",
4804
+ "background_color_field_name": "can't be changed for one submission: the template's setting always applies. Change it in the template",
4805
+ "backgroundColorFieldName": "can't be changed for one submission: the template's setting always applies. Change it in the template",
4806
+ "background_color_field_required": "can't be changed for one submission: the template's setting always applies. Change it in the template",
4807
+ "backgroundColorFieldRequired": "can't be changed for one submission: the template's setting always applies. Change it in the template",
4808
+ "check_color_field_name": "can't be changed for one submission: the template's setting always applies. Change it in the template",
4809
+ "checkColorFieldName": "can't be changed for one submission: the template's setting always applies. Change it in the template",
4810
+ "check_color_field_required": "can't be changed for one submission: the template's setting always applies. Change it in the template",
4811
+ "checkColorFieldRequired": "can't be changed for one submission: the template's setting always applies. Change it in the template",
4812
+ "qrcode_color_field_name": "can't be changed for one submission: the template's setting always applies. Change it in the template",
4813
+ "qrcodeColorFieldName": "can't be changed for one submission: the template's setting always applies. Change it in the template",
4814
+ "qrcode_color_field_required": "can't be changed for one submission: the template's setting always applies. Change it in the template",
4815
+ "qrcodeColorFieldRequired": "can't be changed for one submission: the template's setting always applies. Change it in the template",
4816
+ "shape_border_color_field_name": "can't be changed for one submission: the template's setting always applies. Change it in the template",
4817
+ "shapeBorderColorFieldName": "can't be changed for one submission: the template's setting always applies. Change it in the template",
4818
+ "shape_border_color_field_required": "can't be changed for one submission: the template's setting always applies. Change it in the template",
4819
+ "shapeBorderColorFieldRequired": "can't be changed for one submission: the template's setting always applies. Change it in the template",
4820
+ "shape_fill_color_field_name": "can't be changed for one submission: the template's setting always applies. Change it in the template",
4821
+ "shapeFillColorFieldName": "can't be changed for one submission: the template's setting always applies. Change it in the template",
4822
+ "shape_fill_color_field_required": "can't be changed for one submission: the template's setting always applies. Change it in the template",
4823
+ "shapeFillColorFieldRequired": "can't be changed for one submission: the template's setting always applies. Change it in the template"
4824
+ },
4825
+ "additionalProperties": false
4826
+ },
4827
+ "FieldPresenceCondition": {
4828
+ "type": "object",
4829
+ "required": [
4830
+ "field",
4831
+ "operator"
4832
+ ],
4833
+ "properties": {
4834
+ "field": {
4835
+ "type": "string"
4836
+ },
4837
+ "operator": {
4838
+ "type": "string",
4839
+ "enum": [
4840
+ "present",
4841
+ "blank"
4842
+ ]
4843
+ }
4844
+ },
4845
+ "additionalProperties": false,
4846
+ "x-not-allowed-properties": {
4847
+ "value": "isn't used by 'present' or 'blank' conditions. Remove it",
4848
+ "range_max": "isn't used by 'present' or 'blank' conditions. Remove it"
4849
+ }
4850
+ },
4851
+ "FieldRangeCondition": {
4852
+ "type": "object",
4853
+ "required": [
4854
+ "field",
4855
+ "operator"
4856
+ ],
4857
+ "properties": {
4858
+ "field": {
4859
+ "type": "string"
4860
+ },
4861
+ "operator": {
4862
+ "type": "string",
4863
+ "const": "range"
4864
+ },
4865
+ "value": {
4866
+ "type": [
4867
+ "number",
4868
+ "string",
4869
+ "null"
4870
+ ],
4871
+ "pattern": "^-?\\d+(\\.\\d+)?([eE][-+]?\\d+)?$",
4872
+ "x-pattern-message": "must be a number, like 10 or 2.5"
4873
+ },
4874
+ "range_max": {
4875
+ "type": [
4876
+ "number",
4877
+ "string",
4878
+ "null"
4879
+ ],
4880
+ "pattern": "^-?\\d+(\\.\\d+)?([eE][-+]?\\d+)?$",
4881
+ "x-pattern-message": "must be a number, like 10 or 2.5"
4882
+ }
4883
+ },
4884
+ "additionalProperties": false
4885
+ },
4886
+ "SubmissionSourcePdf": {
4887
+ "type": "object",
4888
+ "required": [
4889
+ "type",
4890
+ "id"
4891
+ ],
4892
+ "properties": {
4893
+ "type": {
4894
+ "type": "string",
4895
+ "const": "submission"
4896
+ },
4897
+ "id": {
4898
+ "type": "string",
4899
+ "minLength": 1
4900
+ }
4901
+ },
4902
+ "additionalProperties": false,
4903
+ "x-not-allowed-properties": {
4904
+ "url": "isn't used by 'submission' source PDFs. Remove it",
4905
+ "template_version": "isn't used by 'submission' source PDFs. Remove it",
4906
+ "processed": "isn't used by 'submission' source PDFs. Remove it"
4907
+ }
4908
+ },
4909
+ "TemplateSourcePdf": {
4910
+ "type": "object",
4911
+ "required": [
4912
+ "type",
4913
+ "id"
4914
+ ],
4915
+ "properties": {
4916
+ "type": {
4917
+ "type": "string",
4918
+ "const": "template"
4919
+ },
4920
+ "id": {
4921
+ "type": "string",
4922
+ "minLength": 1
4923
+ },
4924
+ "template_version": {
4925
+ "type": "string",
4926
+ "pattern": "^(\\d+(\\.\\d+(\\.\\d+)?)?|latest|draft)$",
4927
+ "x-pattern-message": "must be a version like 1.2.3 or 1, or latest or draft"
4928
+ },
4929
+ "processed": {
4930
+ "type": "boolean"
4931
+ }
4932
+ },
4933
+ "additionalProperties": false,
4934
+ "x-not-allowed-properties": {
4935
+ "url": "isn't used by 'template' source PDFs. Remove it"
4936
+ }
4937
+ },
4938
+ "UrlSourcePdf": {
4939
+ "type": "object",
4940
+ "required": [
4941
+ "type",
4942
+ "url"
4943
+ ],
4944
+ "properties": {
4945
+ "type": {
4946
+ "type": "string",
4947
+ "const": "url"
4948
+ },
4949
+ "url": {
4950
+ "type": "string",
4951
+ "format": "uri"
4952
+ }
4953
+ },
4954
+ "additionalProperties": false,
4955
+ "x-not-allowed-properties": {
4956
+ "id": "isn't used by 'url' source PDFs. Remove it",
4957
+ "template_version": "isn't used by 'url' source PDFs. Remove it",
4958
+ "processed": "isn't used by 'url' source PDFs. Remove it"
4959
+ }
4960
+ }
4961
+ }
4962
+ },
4963
+ "formatMessages": {
4964
+ "uri": "must be a full URL, like https://example.com",
4965
+ "date-time": "must be a date and time in RFC 3339 format, like 2026-10-20T09:00:00Z"
4966
+ }
4967
+ }