docspring-ts 3.2.0 → 4.0.0

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