@factify/sdk 0.3.13 → 0.3.14-rc.10

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 (902) hide show
  1. package/FUNCTIONS.md +4 -4
  2. package/README.md +87 -49
  3. package/dist/commonjs/funcs/apiKeysCreate.d.ts +1 -1
  4. package/dist/commonjs/funcs/apiKeysCreate.d.ts.map +1 -1
  5. package/dist/commonjs/funcs/apiKeysCreate.js +1 -1
  6. package/dist/commonjs/funcs/apiKeysCreate.js.map +1 -1
  7. package/dist/commonjs/funcs/apiKeysList.d.ts +1 -1
  8. package/dist/commonjs/funcs/apiKeysList.d.ts.map +1 -1
  9. package/dist/commonjs/funcs/apiKeysList.js +1 -1
  10. package/dist/commonjs/funcs/apiKeysList.js.map +1 -1
  11. package/dist/commonjs/funcs/apiKeysRevoke.d.ts +1 -1
  12. package/dist/commonjs/funcs/apiKeysRevoke.d.ts.map +1 -1
  13. package/dist/commonjs/funcs/apiKeysRevoke.js +1 -1
  14. package/dist/commonjs/funcs/apiKeysRevoke.js.map +1 -1
  15. package/dist/commonjs/funcs/documentsCreate.d.ts +1 -1
  16. package/dist/commonjs/funcs/documentsCreate.d.ts.map +1 -1
  17. package/dist/commonjs/funcs/documentsCreate.js +1 -1
  18. package/dist/commonjs/funcs/documentsCreate.js.map +1 -1
  19. package/dist/commonjs/funcs/documentsGet.d.ts +1 -1
  20. package/dist/commonjs/funcs/documentsGet.d.ts.map +1 -1
  21. package/dist/commonjs/funcs/documentsGet.js +1 -1
  22. package/dist/commonjs/funcs/documentsGet.js.map +1 -1
  23. package/dist/commonjs/funcs/documentsList.d.ts +1 -1
  24. package/dist/commonjs/funcs/documentsList.d.ts.map +1 -1
  25. package/dist/commonjs/funcs/documentsList.js +1 -1
  26. package/dist/commonjs/funcs/documentsList.js.map +1 -1
  27. package/dist/commonjs/funcs/documentsUpdate.d.ts +1 -1
  28. package/dist/commonjs/funcs/documentsUpdate.d.ts.map +1 -1
  29. package/dist/commonjs/funcs/documentsUpdate.js +1 -1
  30. package/dist/commonjs/funcs/documentsUpdate.js.map +1 -1
  31. package/dist/commonjs/funcs/entryPagesGenerate.d.ts +1 -1
  32. package/dist/commonjs/funcs/entryPagesGenerate.d.ts.map +1 -1
  33. package/dist/commonjs/funcs/entryPagesGenerate.js +1 -1
  34. package/dist/commonjs/funcs/entryPagesGenerate.js.map +1 -1
  35. package/dist/commonjs/funcs/organizationsAcceptOrganizationInvite.d.ts +18 -0
  36. package/dist/commonjs/funcs/organizationsAcceptOrganizationInvite.d.ts.map +1 -0
  37. package/dist/commonjs/funcs/organizationsAcceptOrganizationInvite.js +127 -0
  38. package/dist/commonjs/funcs/organizationsAcceptOrganizationInvite.js.map +1 -0
  39. package/dist/commonjs/funcs/organizationsCreate.d.ts +1 -1
  40. package/dist/commonjs/funcs/organizationsCreate.d.ts.map +1 -1
  41. package/dist/commonjs/funcs/organizationsCreate.js +1 -1
  42. package/dist/commonjs/funcs/organizationsCreate.js.map +1 -1
  43. package/dist/commonjs/funcs/organizationsGet.d.ts +1 -1
  44. package/dist/commonjs/funcs/organizationsGet.d.ts.map +1 -1
  45. package/dist/commonjs/funcs/organizationsGet.js +1 -1
  46. package/dist/commonjs/funcs/organizationsGet.js.map +1 -1
  47. package/dist/commonjs/funcs/organizationsInvitesCreate.d.ts +18 -0
  48. package/dist/commonjs/funcs/organizationsInvitesCreate.d.ts.map +1 -0
  49. package/dist/commonjs/funcs/organizationsInvitesCreate.js +127 -0
  50. package/dist/commonjs/funcs/organizationsInvitesCreate.js.map +1 -0
  51. package/dist/commonjs/funcs/organizationsInvitesList.d.ts +21 -0
  52. package/dist/commonjs/funcs/organizationsInvitesList.d.ts.map +1 -0
  53. package/dist/commonjs/funcs/organizationsInvitesList.js +161 -0
  54. package/dist/commonjs/funcs/organizationsInvitesList.js.map +1 -0
  55. package/dist/commonjs/funcs/organizationsList.d.ts +1 -1
  56. package/dist/commonjs/funcs/organizationsList.d.ts.map +1 -1
  57. package/dist/commonjs/funcs/organizationsList.js +2 -1
  58. package/dist/commonjs/funcs/organizationsList.js.map +1 -1
  59. package/dist/commonjs/funcs/organizationsResendOrganizationInvite.d.ts +18 -0
  60. package/dist/commonjs/funcs/organizationsResendOrganizationInvite.d.ts.map +1 -0
  61. package/dist/commonjs/funcs/organizationsResendOrganizationInvite.js +131 -0
  62. package/dist/commonjs/funcs/organizationsResendOrganizationInvite.js.map +1 -0
  63. package/dist/commonjs/funcs/organizationsRevokeOrganizationInvite.d.ts +18 -0
  64. package/dist/commonjs/funcs/organizationsRevokeOrganizationInvite.d.ts.map +1 -0
  65. package/dist/commonjs/funcs/organizationsRevokeOrganizationInvite.js +131 -0
  66. package/dist/commonjs/funcs/organizationsRevokeOrganizationInvite.js.map +1 -0
  67. package/dist/commonjs/funcs/policiesAttach.d.ts +1 -1
  68. package/dist/commonjs/funcs/policiesAttach.d.ts.map +1 -1
  69. package/dist/commonjs/funcs/policiesAttach.js +1 -1
  70. package/dist/commonjs/funcs/policiesAttach.js.map +1 -1
  71. package/dist/commonjs/funcs/policiesDetach.d.ts +1 -1
  72. package/dist/commonjs/funcs/policiesDetach.d.ts.map +1 -1
  73. package/dist/commonjs/funcs/policiesDetach.js +1 -1
  74. package/dist/commonjs/funcs/policiesDetach.js.map +1 -1
  75. package/dist/commonjs/funcs/policiesList.d.ts +1 -1
  76. package/dist/commonjs/funcs/policiesList.d.ts.map +1 -1
  77. package/dist/commonjs/funcs/policiesList.js +1 -1
  78. package/dist/commonjs/funcs/policiesList.js.map +1 -1
  79. package/dist/commonjs/funcs/quotasQuotaServiceDeleteOrganizationQuota.d.ts +20 -0
  80. package/dist/commonjs/funcs/quotasQuotaServiceDeleteOrganizationQuota.d.ts.map +1 -0
  81. package/dist/commonjs/funcs/quotasQuotaServiceDeleteOrganizationQuota.js +123 -0
  82. package/dist/commonjs/funcs/quotasQuotaServiceDeleteOrganizationQuota.js.map +1 -0
  83. package/dist/commonjs/funcs/quotasQuotaServiceSetOrganizationQuota.d.ts +19 -0
  84. package/dist/commonjs/funcs/quotasQuotaServiceSetOrganizationQuota.d.ts.map +1 -0
  85. package/dist/commonjs/funcs/quotasQuotaServiceSetOrganizationQuota.js +122 -0
  86. package/dist/commonjs/funcs/quotasQuotaServiceSetOrganizationQuota.js.map +1 -0
  87. package/dist/commonjs/funcs/usageDeleteAPIKeyQuota.d.ts +18 -0
  88. package/dist/commonjs/funcs/usageDeleteAPIKeyQuota.d.ts.map +1 -0
  89. package/dist/commonjs/funcs/usageDeleteAPIKeyQuota.js +130 -0
  90. package/dist/commonjs/funcs/usageDeleteAPIKeyQuota.js.map +1 -0
  91. package/dist/commonjs/funcs/usageGetOrganizationQuota.d.ts +18 -0
  92. package/dist/commonjs/funcs/usageGetOrganizationQuota.d.ts.map +1 -0
  93. package/dist/commonjs/funcs/usageGetOrganizationQuota.js +124 -0
  94. package/dist/commonjs/funcs/usageGetOrganizationQuota.js.map +1 -0
  95. package/dist/commonjs/funcs/usageGetUsageHistory.d.ts +18 -0
  96. package/dist/commonjs/funcs/usageGetUsageHistory.d.ts.map +1 -0
  97. package/dist/commonjs/funcs/usageGetUsageHistory.js +125 -0
  98. package/dist/commonjs/funcs/usageGetUsageHistory.js.map +1 -0
  99. package/dist/commonjs/funcs/usageListAPIKeyQuotas.d.ts +18 -0
  100. package/dist/commonjs/funcs/usageListAPIKeyQuotas.d.ts.map +1 -0
  101. package/dist/commonjs/funcs/usageListAPIKeyQuotas.js +124 -0
  102. package/dist/commonjs/funcs/usageListAPIKeyQuotas.js.map +1 -0
  103. package/dist/commonjs/funcs/usageSetAPIKeyQuota.d.ts +18 -0
  104. package/dist/commonjs/funcs/usageSetAPIKeyQuota.d.ts.map +1 -0
  105. package/dist/commonjs/funcs/usageSetAPIKeyQuota.js +127 -0
  106. package/dist/commonjs/funcs/usageSetAPIKeyQuota.js.map +1 -0
  107. package/dist/commonjs/funcs/versionsCreate.d.ts +1 -1
  108. package/dist/commonjs/funcs/versionsCreate.d.ts.map +1 -1
  109. package/dist/commonjs/funcs/versionsCreate.js +1 -4
  110. package/dist/commonjs/funcs/versionsCreate.js.map +1 -1
  111. package/dist/commonjs/funcs/versionsGet.d.ts +1 -1
  112. package/dist/commonjs/funcs/versionsGet.d.ts.map +1 -1
  113. package/dist/commonjs/funcs/versionsGet.js +1 -1
  114. package/dist/commonjs/funcs/versionsGet.js.map +1 -1
  115. package/dist/commonjs/funcs/versionsList.d.ts +1 -1
  116. package/dist/commonjs/funcs/versionsList.d.ts.map +1 -1
  117. package/dist/commonjs/funcs/versionsList.js +1 -1
  118. package/dist/commonjs/funcs/versionsList.js.map +1 -1
  119. package/dist/commonjs/funcs/versionsUpdate.d.ts +1 -1
  120. package/dist/commonjs/funcs/versionsUpdate.d.ts.map +1 -1
  121. package/dist/commonjs/funcs/versionsUpdate.js +1 -1
  122. package/dist/commonjs/funcs/versionsUpdate.js.map +1 -1
  123. package/dist/commonjs/lib/config.d.ts +3 -3
  124. package/dist/commonjs/lib/config.js +3 -3
  125. package/dist/commonjs/lib/config.js.map +1 -1
  126. package/dist/commonjs/models/components/acceptorganizationinviteresponse.d.ts +17 -0
  127. package/dist/commonjs/models/components/acceptorganizationinviteresponse.d.ts.map +1 -0
  128. package/dist/commonjs/models/components/acceptorganizationinviteresponse.js +51 -0
  129. package/dist/commonjs/models/components/acceptorganizationinviteresponse.js.map +1 -0
  130. package/dist/commonjs/models/components/apikeyquota.d.ts +32 -0
  131. package/dist/commonjs/models/components/apikeyquota.d.ts.map +1 -0
  132. package/dist/commonjs/models/components/{error.js → apikeyquota.js} +15 -27
  133. package/dist/commonjs/models/components/apikeyquota.js.map +1 -0
  134. package/dist/commonjs/models/components/connecterror.d.ts +56 -0
  135. package/dist/commonjs/models/components/connecterror.d.ts.map +1 -0
  136. package/dist/commonjs/models/components/connecterror.js +78 -0
  137. package/dist/commonjs/models/components/connecterror.js.map +1 -0
  138. package/dist/commonjs/models/components/connecterrordetailsany.d.ts +38 -0
  139. package/dist/commonjs/models/components/connecterrordetailsany.d.ts.map +1 -0
  140. package/dist/commonjs/models/components/connecterrordetailsany.js +60 -0
  141. package/dist/commonjs/models/components/connecterrordetailsany.js.map +1 -0
  142. package/dist/commonjs/models/components/createorganizationinviteresponse.d.ts +20 -0
  143. package/dist/commonjs/models/components/createorganizationinviteresponse.d.ts.map +1 -0
  144. package/dist/commonjs/models/components/createorganizationinviteresponse.js +51 -0
  145. package/dist/commonjs/models/components/createorganizationinviteresponse.js.map +1 -0
  146. package/dist/commonjs/models/components/createversionrequest.d.ts +0 -8
  147. package/dist/commonjs/models/components/createversionrequest.d.ts.map +1 -1
  148. package/dist/commonjs/models/components/createversionrequest.js +2 -8
  149. package/dist/commonjs/models/components/createversionrequest.js.map +1 -1
  150. package/dist/commonjs/models/components/dailyusage.d.ts +20 -0
  151. package/dist/commonjs/models/components/dailyusage.d.ts.map +1 -0
  152. package/dist/commonjs/models/components/dailyusage.js +58 -0
  153. package/dist/commonjs/models/components/dailyusage.js.map +1 -0
  154. package/dist/commonjs/models/components/deleteapikeyquotaresponse.d.ts +11 -0
  155. package/dist/commonjs/models/components/deleteapikeyquotaresponse.d.ts.map +1 -0
  156. package/dist/commonjs/models/components/deleteapikeyquotaresponse.js +48 -0
  157. package/dist/commonjs/models/components/deleteapikeyquotaresponse.js.map +1 -0
  158. package/dist/commonjs/models/components/deleteorganizationquotarequest.d.ts +18 -0
  159. package/dist/commonjs/models/components/deleteorganizationquotarequest.d.ts.map +1 -0
  160. package/dist/commonjs/models/components/deleteorganizationquotarequest.js +54 -0
  161. package/dist/commonjs/models/components/deleteorganizationquotarequest.js.map +1 -0
  162. package/dist/commonjs/models/components/deleteorganizationquotaresponse.d.ts +11 -0
  163. package/dist/commonjs/models/components/deleteorganizationquotaresponse.d.ts.map +1 -0
  164. package/dist/commonjs/models/components/deleteorganizationquotaresponse.js +48 -0
  165. package/dist/commonjs/models/components/deleteorganizationquotaresponse.js.map +1 -0
  166. package/dist/commonjs/models/components/errordetail.d.ts +54 -0
  167. package/dist/commonjs/models/components/errordetail.d.ts.map +1 -0
  168. package/dist/commonjs/models/components/errordetail.js +89 -0
  169. package/dist/commonjs/models/components/errordetail.js.map +1 -0
  170. package/dist/commonjs/models/components/errorresponse.d.ts +53 -0
  171. package/dist/commonjs/models/components/errorresponse.d.ts.map +1 -0
  172. package/dist/commonjs/models/components/errorresponse.js +74 -0
  173. package/dist/commonjs/models/components/errorresponse.js.map +1 -0
  174. package/dist/commonjs/models/components/getorganizationquotaresponse.d.ts +17 -0
  175. package/dist/commonjs/models/components/getorganizationquotaresponse.d.ts.map +1 -0
  176. package/dist/commonjs/models/components/getorganizationquotaresponse.js +52 -0
  177. package/dist/commonjs/models/components/getorganizationquotaresponse.js.map +1 -0
  178. package/dist/commonjs/models/components/getusagehistoryresponse.d.ts +25 -0
  179. package/dist/commonjs/models/components/getusagehistoryresponse.d.ts.map +1 -0
  180. package/dist/commonjs/models/components/getusagehistoryresponse.js +61 -0
  181. package/dist/commonjs/models/components/getusagehistoryresponse.js.map +1 -0
  182. package/dist/commonjs/models/components/index.d.ts +26 -1
  183. package/dist/commonjs/models/components/index.d.ts.map +1 -1
  184. package/dist/commonjs/models/components/index.js +26 -1
  185. package/dist/commonjs/models/components/index.js.map +1 -1
  186. package/dist/commonjs/models/components/listapikeyquotasresponse.d.ts +17 -0
  187. package/dist/commonjs/models/components/listapikeyquotasresponse.d.ts.map +1 -0
  188. package/dist/commonjs/models/components/listapikeyquotasresponse.js +52 -0
  189. package/dist/commonjs/models/components/listapikeyquotasresponse.js.map +1 -0
  190. package/dist/commonjs/models/components/listorganizationinvitesresponse.d.ts +25 -0
  191. package/dist/commonjs/models/components/listorganizationinvitesresponse.d.ts.map +1 -0
  192. package/dist/commonjs/models/components/listorganizationinvitesresponse.js +54 -0
  193. package/dist/commonjs/models/components/listorganizationinvitesresponse.js.map +1 -0
  194. package/dist/commonjs/models/components/organizationinvite.d.ts +57 -0
  195. package/dist/commonjs/models/components/organizationinvite.d.ts.map +1 -0
  196. package/dist/commonjs/models/components/organizationinvite.js +71 -0
  197. package/dist/commonjs/models/components/organizationinvite.js.map +1 -0
  198. package/dist/commonjs/models/components/organizationinvitestatus.d.ts +14 -0
  199. package/dist/commonjs/models/components/organizationinvitestatus.d.ts.map +1 -0
  200. package/dist/commonjs/models/components/organizationinvitestatus.js +51 -0
  201. package/dist/commonjs/models/components/organizationinvitestatus.js.map +1 -0
  202. package/dist/commonjs/models/components/organizationquota.d.ts +52 -0
  203. package/dist/commonjs/models/components/organizationquota.d.ts.map +1 -0
  204. package/dist/commonjs/models/components/organizationquota.js +71 -0
  205. package/dist/commonjs/models/components/organizationquota.js.map +1 -0
  206. package/dist/commonjs/models/components/organizationquotaconfig.d.ts +37 -0
  207. package/dist/commonjs/models/components/organizationquotaconfig.d.ts.map +1 -0
  208. package/dist/commonjs/models/components/organizationquotaconfig.js +65 -0
  209. package/dist/commonjs/models/components/organizationquotaconfig.js.map +1 -0
  210. package/dist/commonjs/models/components/organizationrole.d.ts +11 -0
  211. package/dist/commonjs/models/components/organizationrole.d.ts.map +1 -0
  212. package/dist/commonjs/models/components/organizationrole.js +48 -0
  213. package/dist/commonjs/models/components/organizationrole.js.map +1 -0
  214. package/dist/commonjs/models/components/quotatier.d.ts +19 -0
  215. package/dist/commonjs/models/components/quotatier.d.ts.map +1 -0
  216. package/dist/commonjs/models/components/quotatier.js +53 -0
  217. package/dist/commonjs/models/components/quotatier.js.map +1 -0
  218. package/dist/commonjs/models/components/resendorganizationinviteresponse.d.ts +20 -0
  219. package/dist/commonjs/models/components/resendorganizationinviteresponse.d.ts.map +1 -0
  220. package/dist/commonjs/models/components/resendorganizationinviteresponse.js +51 -0
  221. package/dist/commonjs/models/components/resendorganizationinviteresponse.js.map +1 -0
  222. package/dist/commonjs/models/components/revokeorganizationinviteresponse.d.ts +20 -0
  223. package/dist/commonjs/models/components/revokeorganizationinviteresponse.d.ts.map +1 -0
  224. package/dist/commonjs/models/components/revokeorganizationinviteresponse.js +51 -0
  225. package/dist/commonjs/models/components/revokeorganizationinviteresponse.js.map +1 -0
  226. package/dist/commonjs/models/components/setapikeyquotaresponse.d.ts +17 -0
  227. package/dist/commonjs/models/components/setapikeyquotaresponse.d.ts.map +1 -0
  228. package/dist/commonjs/models/components/setapikeyquotaresponse.js +52 -0
  229. package/dist/commonjs/models/components/setapikeyquotaresponse.js.map +1 -0
  230. package/dist/commonjs/models/components/setorganizationquotarequest.d.ts +32 -0
  231. package/dist/commonjs/models/components/setorganizationquotarequest.d.ts.map +1 -0
  232. package/dist/commonjs/models/components/setorganizationquotarequest.js +57 -0
  233. package/dist/commonjs/models/components/setorganizationquotarequest.js.map +1 -0
  234. package/dist/commonjs/models/components/setorganizationquotaresponse.d.ts +17 -0
  235. package/dist/commonjs/models/components/setorganizationquotaresponse.d.ts.map +1 -0
  236. package/dist/commonjs/models/components/setorganizationquotaresponse.js +52 -0
  237. package/dist/commonjs/models/components/setorganizationquotaresponse.js.map +1 -0
  238. package/dist/commonjs/models/errors/errorresponse.d.ts +70 -0
  239. package/dist/commonjs/models/errors/errorresponse.d.ts.map +1 -0
  240. package/dist/commonjs/models/errors/{error.js → errorresponse.js} +15 -11
  241. package/dist/commonjs/models/errors/errorresponse.js.map +1 -0
  242. package/dist/commonjs/models/errors/index.d.ts +1 -1
  243. package/dist/commonjs/models/errors/index.d.ts.map +1 -1
  244. package/dist/commonjs/models/errors/index.js +1 -1
  245. package/dist/commonjs/models/errors/index.js.map +1 -1
  246. package/dist/commonjs/models/operations/acceptorganizationinvite.d.ts +49 -0
  247. package/dist/commonjs/models/operations/acceptorganizationinvite.d.ts.map +1 -0
  248. package/dist/commonjs/models/operations/acceptorganizationinvite.js +81 -0
  249. package/dist/commonjs/models/operations/acceptorganizationinvite.js.map +1 -0
  250. package/dist/commonjs/models/operations/attachdocumentpolicy.d.ts +0 -3
  251. package/dist/commonjs/models/operations/attachdocumentpolicy.d.ts.map +1 -1
  252. package/dist/commonjs/models/operations/attachdocumentpolicy.js +0 -2
  253. package/dist/commonjs/models/operations/attachdocumentpolicy.js.map +1 -1
  254. package/dist/commonjs/models/operations/createapikey.d.ts +0 -3
  255. package/dist/commonjs/models/operations/createapikey.d.ts.map +1 -1
  256. package/dist/commonjs/models/operations/createapikey.js +0 -2
  257. package/dist/commonjs/models/operations/createapikey.js.map +1 -1
  258. package/dist/commonjs/models/operations/createdocument.d.ts +0 -3
  259. package/dist/commonjs/models/operations/createdocument.d.ts.map +1 -1
  260. package/dist/commonjs/models/operations/createdocument.js +0 -2
  261. package/dist/commonjs/models/operations/createdocument.js.map +1 -1
  262. package/dist/commonjs/models/operations/createdocumentversion.d.ts +0 -3
  263. package/dist/commonjs/models/operations/createdocumentversion.d.ts.map +1 -1
  264. package/dist/commonjs/models/operations/createdocumentversion.js +0 -2
  265. package/dist/commonjs/models/operations/createdocumentversion.js.map +1 -1
  266. package/dist/commonjs/models/operations/createorganization.d.ts +0 -3
  267. package/dist/commonjs/models/operations/createorganization.d.ts.map +1 -1
  268. package/dist/commonjs/models/operations/createorganization.js +0 -2
  269. package/dist/commonjs/models/operations/createorganization.js.map +1 -1
  270. package/dist/commonjs/models/operations/createorganizationinvite.d.ts +63 -0
  271. package/dist/commonjs/models/operations/createorganizationinvite.d.ts.map +1 -0
  272. package/dist/commonjs/models/operations/createorganizationinvite.js +87 -0
  273. package/dist/commonjs/models/operations/createorganizationinvite.js.map +1 -0
  274. package/dist/commonjs/models/operations/deleteapikeyquota.d.ts +33 -0
  275. package/dist/commonjs/models/operations/deleteapikeyquota.d.ts.map +1 -0
  276. package/dist/commonjs/models/operations/deleteapikeyquota.js +73 -0
  277. package/dist/commonjs/models/operations/deleteapikeyquota.js.map +1 -0
  278. package/dist/commonjs/models/operations/detachdocumentpolicy.d.ts +0 -3
  279. package/dist/commonjs/models/operations/detachdocumentpolicy.d.ts.map +1 -1
  280. package/dist/commonjs/models/operations/detachdocumentpolicy.js +0 -2
  281. package/dist/commonjs/models/operations/detachdocumentpolicy.js.map +1 -1
  282. package/dist/commonjs/models/operations/generatedocumententrypage.d.ts +0 -3
  283. package/dist/commonjs/models/operations/generatedocumententrypage.d.ts.map +1 -1
  284. package/dist/commonjs/models/operations/generatedocumententrypage.js +0 -2
  285. package/dist/commonjs/models/operations/generatedocumententrypage.js.map +1 -1
  286. package/dist/commonjs/models/operations/getdocument.d.ts +0 -3
  287. package/dist/commonjs/models/operations/getdocument.d.ts.map +1 -1
  288. package/dist/commonjs/models/operations/getdocument.js +0 -2
  289. package/dist/commonjs/models/operations/getdocument.js.map +1 -1
  290. package/dist/commonjs/models/operations/getorganization.d.ts +0 -3
  291. package/dist/commonjs/models/operations/getorganization.d.ts.map +1 -1
  292. package/dist/commonjs/models/operations/getorganization.js +0 -2
  293. package/dist/commonjs/models/operations/getorganization.js.map +1 -1
  294. package/dist/commonjs/models/operations/getorganizationquota.d.ts +31 -0
  295. package/dist/commonjs/models/operations/getorganizationquota.d.ts.map +1 -0
  296. package/dist/commonjs/models/operations/getorganizationquota.js +71 -0
  297. package/dist/commonjs/models/operations/getorganizationquota.js.map +1 -0
  298. package/dist/commonjs/models/operations/getusagehistory.d.ts +33 -0
  299. package/dist/commonjs/models/operations/getusagehistory.d.ts.map +1 -0
  300. package/dist/commonjs/models/operations/getusagehistory.js +73 -0
  301. package/dist/commonjs/models/operations/getusagehistory.js.map +1 -0
  302. package/dist/commonjs/models/operations/getversion.d.ts +0 -3
  303. package/dist/commonjs/models/operations/getversion.d.ts.map +1 -1
  304. package/dist/commonjs/models/operations/getversion.js +0 -2
  305. package/dist/commonjs/models/operations/getversion.js.map +1 -1
  306. package/dist/commonjs/models/operations/index.d.ts +12 -0
  307. package/dist/commonjs/models/operations/index.d.ts.map +1 -1
  308. package/dist/commonjs/models/operations/index.js +12 -0
  309. package/dist/commonjs/models/operations/index.js.map +1 -1
  310. package/dist/commonjs/models/operations/listapikeyquotas.d.ts +28 -0
  311. package/dist/commonjs/models/operations/listapikeyquotas.d.ts.map +1 -0
  312. package/dist/commonjs/models/operations/listapikeyquotas.js +71 -0
  313. package/dist/commonjs/models/operations/listapikeyquotas.js.map +1 -0
  314. package/dist/commonjs/models/operations/listapikeys.d.ts +0 -3
  315. package/dist/commonjs/models/operations/listapikeys.d.ts.map +1 -1
  316. package/dist/commonjs/models/operations/listapikeys.js +0 -2
  317. package/dist/commonjs/models/operations/listapikeys.js.map +1 -1
  318. package/dist/commonjs/models/operations/listdocumentpolicies.d.ts +0 -3
  319. package/dist/commonjs/models/operations/listdocumentpolicies.d.ts.map +1 -1
  320. package/dist/commonjs/models/operations/listdocumentpolicies.js +0 -2
  321. package/dist/commonjs/models/operations/listdocumentpolicies.js.map +1 -1
  322. package/dist/commonjs/models/operations/listdocuments.d.ts +0 -3
  323. package/dist/commonjs/models/operations/listdocuments.d.ts.map +1 -1
  324. package/dist/commonjs/models/operations/listdocuments.js +0 -2
  325. package/dist/commonjs/models/operations/listdocuments.js.map +1 -1
  326. package/dist/commonjs/models/operations/listdocumentversions.d.ts +0 -3
  327. package/dist/commonjs/models/operations/listdocumentversions.d.ts.map +1 -1
  328. package/dist/commonjs/models/operations/listdocumentversions.js +0 -2
  329. package/dist/commonjs/models/operations/listdocumentversions.js.map +1 -1
  330. package/dist/commonjs/models/operations/listorganizationinvites.d.ts +80 -0
  331. package/dist/commonjs/models/operations/listorganizationinvites.d.ts.map +1 -0
  332. package/dist/commonjs/models/operations/listorganizationinvites.js +84 -0
  333. package/dist/commonjs/models/operations/listorganizationinvites.js.map +1 -0
  334. package/dist/commonjs/models/operations/listorganizations.d.ts +9 -3
  335. package/dist/commonjs/models/operations/listorganizations.d.ts.map +1 -1
  336. package/dist/commonjs/models/operations/listorganizations.js +1 -2
  337. package/dist/commonjs/models/operations/listorganizations.js.map +1 -1
  338. package/dist/commonjs/models/operations/quotaservicedeleteorganizationquota.d.ts +33 -0
  339. package/dist/commonjs/models/operations/quotaservicedeleteorganizationquota.d.ts.map +1 -0
  340. package/dist/commonjs/models/operations/quotaservicedeleteorganizationquota.js +76 -0
  341. package/dist/commonjs/models/operations/quotaservicedeleteorganizationquota.js.map +1 -0
  342. package/dist/commonjs/models/operations/quotaservicesetorganizationquota.d.ts +33 -0
  343. package/dist/commonjs/models/operations/quotaservicesetorganizationquota.d.ts.map +1 -0
  344. package/dist/commonjs/models/operations/quotaservicesetorganizationquota.js +76 -0
  345. package/dist/commonjs/models/operations/quotaservicesetorganizationquota.js.map +1 -0
  346. package/dist/commonjs/models/operations/resendorganizationinvite.d.ts +50 -0
  347. package/dist/commonjs/models/operations/resendorganizationinvite.d.ts.map +1 -0
  348. package/dist/commonjs/models/operations/resendorganizationinvite.js +81 -0
  349. package/dist/commonjs/models/operations/resendorganizationinvite.js.map +1 -0
  350. package/dist/commonjs/models/operations/revokeapikey.d.ts +0 -3
  351. package/dist/commonjs/models/operations/revokeapikey.d.ts.map +1 -1
  352. package/dist/commonjs/models/operations/revokeapikey.js +0 -2
  353. package/dist/commonjs/models/operations/revokeapikey.js.map +1 -1
  354. package/dist/commonjs/models/operations/revokeorganizationinvite.d.ts +50 -0
  355. package/dist/commonjs/models/operations/revokeorganizationinvite.d.ts.map +1 -0
  356. package/dist/commonjs/models/operations/revokeorganizationinvite.js +81 -0
  357. package/dist/commonjs/models/operations/revokeorganizationinvite.js.map +1 -0
  358. package/dist/commonjs/models/operations/setapikeyquota.d.ts +51 -0
  359. package/dist/commonjs/models/operations/setapikeyquota.d.ts.map +1 -0
  360. package/dist/commonjs/models/operations/setapikeyquota.js +85 -0
  361. package/dist/commonjs/models/operations/setapikeyquota.js.map +1 -0
  362. package/dist/commonjs/models/operations/updatedocument.d.ts +0 -3
  363. package/dist/commonjs/models/operations/updatedocument.d.ts.map +1 -1
  364. package/dist/commonjs/models/operations/updatedocument.js +0 -2
  365. package/dist/commonjs/models/operations/updatedocument.js.map +1 -1
  366. package/dist/commonjs/models/operations/updateversion.d.ts +0 -3
  367. package/dist/commonjs/models/operations/updateversion.d.ts.map +1 -1
  368. package/dist/commonjs/models/operations/updateversion.js +0 -2
  369. package/dist/commonjs/models/operations/updateversion.js.map +1 -1
  370. package/dist/commonjs/sdk/invites.d.ts +22 -0
  371. package/dist/commonjs/sdk/invites.d.ts.map +1 -0
  372. package/dist/commonjs/sdk/invites.js +33 -0
  373. package/dist/commonjs/sdk/invites.js.map +1 -0
  374. package/dist/commonjs/sdk/organizations.d.ts +24 -0
  375. package/dist/commonjs/sdk/organizations.d.ts.map +1 -1
  376. package/dist/commonjs/sdk/organizations.js +34 -0
  377. package/dist/commonjs/sdk/organizations.js.map +1 -1
  378. package/dist/commonjs/sdk/quotas.d.ts +22 -0
  379. package/dist/commonjs/sdk/quotas.d.ts.map +1 -0
  380. package/dist/commonjs/sdk/quotas.js +35 -0
  381. package/dist/commonjs/sdk/quotas.js.map +1 -0
  382. package/dist/commonjs/sdk/sdk.d.ts +6 -0
  383. package/dist/commonjs/sdk/sdk.d.ts.map +1 -1
  384. package/dist/commonjs/sdk/sdk.js +8 -0
  385. package/dist/commonjs/sdk/sdk.js.map +1 -1
  386. package/dist/commonjs/sdk/usage.d.ts +40 -0
  387. package/dist/commonjs/sdk/usage.d.ts.map +1 -0
  388. package/dist/commonjs/sdk/usage.js +62 -0
  389. package/dist/commonjs/sdk/usage.js.map +1 -0
  390. package/dist/commonjs/types/smartUnion.js +7 -0
  391. package/dist/commonjs/types/smartUnion.js.map +1 -1
  392. package/dist/esm/funcs/apiKeysCreate.d.ts +1 -1
  393. package/dist/esm/funcs/apiKeysCreate.d.ts.map +1 -1
  394. package/dist/esm/funcs/apiKeysCreate.js +1 -1
  395. package/dist/esm/funcs/apiKeysCreate.js.map +1 -1
  396. package/dist/esm/funcs/apiKeysList.d.ts +1 -1
  397. package/dist/esm/funcs/apiKeysList.d.ts.map +1 -1
  398. package/dist/esm/funcs/apiKeysList.js +1 -1
  399. package/dist/esm/funcs/apiKeysList.js.map +1 -1
  400. package/dist/esm/funcs/apiKeysRevoke.d.ts +1 -1
  401. package/dist/esm/funcs/apiKeysRevoke.d.ts.map +1 -1
  402. package/dist/esm/funcs/apiKeysRevoke.js +1 -1
  403. package/dist/esm/funcs/apiKeysRevoke.js.map +1 -1
  404. package/dist/esm/funcs/documentsCreate.d.ts +1 -1
  405. package/dist/esm/funcs/documentsCreate.d.ts.map +1 -1
  406. package/dist/esm/funcs/documentsCreate.js +1 -1
  407. package/dist/esm/funcs/documentsCreate.js.map +1 -1
  408. package/dist/esm/funcs/documentsGet.d.ts +1 -1
  409. package/dist/esm/funcs/documentsGet.d.ts.map +1 -1
  410. package/dist/esm/funcs/documentsGet.js +1 -1
  411. package/dist/esm/funcs/documentsGet.js.map +1 -1
  412. package/dist/esm/funcs/documentsList.d.ts +1 -1
  413. package/dist/esm/funcs/documentsList.d.ts.map +1 -1
  414. package/dist/esm/funcs/documentsList.js +1 -1
  415. package/dist/esm/funcs/documentsList.js.map +1 -1
  416. package/dist/esm/funcs/documentsUpdate.d.ts +1 -1
  417. package/dist/esm/funcs/documentsUpdate.d.ts.map +1 -1
  418. package/dist/esm/funcs/documentsUpdate.js +1 -1
  419. package/dist/esm/funcs/documentsUpdate.js.map +1 -1
  420. package/dist/esm/funcs/entryPagesGenerate.d.ts +1 -1
  421. package/dist/esm/funcs/entryPagesGenerate.d.ts.map +1 -1
  422. package/dist/esm/funcs/entryPagesGenerate.js +1 -1
  423. package/dist/esm/funcs/entryPagesGenerate.js.map +1 -1
  424. package/dist/esm/funcs/organizationsAcceptOrganizationInvite.d.ts +18 -0
  425. package/dist/esm/funcs/organizationsAcceptOrganizationInvite.d.ts.map +1 -0
  426. package/dist/esm/funcs/organizationsAcceptOrganizationInvite.js +91 -0
  427. package/dist/esm/funcs/organizationsAcceptOrganizationInvite.js.map +1 -0
  428. package/dist/esm/funcs/organizationsCreate.d.ts +1 -1
  429. package/dist/esm/funcs/organizationsCreate.d.ts.map +1 -1
  430. package/dist/esm/funcs/organizationsCreate.js +1 -1
  431. package/dist/esm/funcs/organizationsCreate.js.map +1 -1
  432. package/dist/esm/funcs/organizationsGet.d.ts +1 -1
  433. package/dist/esm/funcs/organizationsGet.d.ts.map +1 -1
  434. package/dist/esm/funcs/organizationsGet.js +1 -1
  435. package/dist/esm/funcs/organizationsGet.js.map +1 -1
  436. package/dist/esm/funcs/organizationsInvitesCreate.d.ts +18 -0
  437. package/dist/esm/funcs/organizationsInvitesCreate.d.ts.map +1 -0
  438. package/dist/esm/funcs/organizationsInvitesCreate.js +91 -0
  439. package/dist/esm/funcs/organizationsInvitesCreate.js.map +1 -0
  440. package/dist/esm/funcs/organizationsInvitesList.d.ts +21 -0
  441. package/dist/esm/funcs/organizationsInvitesList.d.ts.map +1 -0
  442. package/dist/esm/funcs/organizationsInvitesList.js +125 -0
  443. package/dist/esm/funcs/organizationsInvitesList.js.map +1 -0
  444. package/dist/esm/funcs/organizationsList.d.ts +1 -1
  445. package/dist/esm/funcs/organizationsList.d.ts.map +1 -1
  446. package/dist/esm/funcs/organizationsList.js +2 -1
  447. package/dist/esm/funcs/organizationsList.js.map +1 -1
  448. package/dist/esm/funcs/organizationsResendOrganizationInvite.d.ts +18 -0
  449. package/dist/esm/funcs/organizationsResendOrganizationInvite.d.ts.map +1 -0
  450. package/dist/esm/funcs/organizationsResendOrganizationInvite.js +95 -0
  451. package/dist/esm/funcs/organizationsResendOrganizationInvite.js.map +1 -0
  452. package/dist/esm/funcs/organizationsRevokeOrganizationInvite.d.ts +18 -0
  453. package/dist/esm/funcs/organizationsRevokeOrganizationInvite.d.ts.map +1 -0
  454. package/dist/esm/funcs/organizationsRevokeOrganizationInvite.js +95 -0
  455. package/dist/esm/funcs/organizationsRevokeOrganizationInvite.js.map +1 -0
  456. package/dist/esm/funcs/policiesAttach.d.ts +1 -1
  457. package/dist/esm/funcs/policiesAttach.d.ts.map +1 -1
  458. package/dist/esm/funcs/policiesAttach.js +1 -1
  459. package/dist/esm/funcs/policiesAttach.js.map +1 -1
  460. package/dist/esm/funcs/policiesDetach.d.ts +1 -1
  461. package/dist/esm/funcs/policiesDetach.d.ts.map +1 -1
  462. package/dist/esm/funcs/policiesDetach.js +1 -1
  463. package/dist/esm/funcs/policiesDetach.js.map +1 -1
  464. package/dist/esm/funcs/policiesList.d.ts +1 -1
  465. package/dist/esm/funcs/policiesList.d.ts.map +1 -1
  466. package/dist/esm/funcs/policiesList.js +1 -1
  467. package/dist/esm/funcs/policiesList.js.map +1 -1
  468. package/dist/esm/funcs/quotasQuotaServiceDeleteOrganizationQuota.d.ts +20 -0
  469. package/dist/esm/funcs/quotasQuotaServiceDeleteOrganizationQuota.d.ts.map +1 -0
  470. package/dist/esm/funcs/quotasQuotaServiceDeleteOrganizationQuota.js +87 -0
  471. package/dist/esm/funcs/quotasQuotaServiceDeleteOrganizationQuota.js.map +1 -0
  472. package/dist/esm/funcs/quotasQuotaServiceSetOrganizationQuota.d.ts +19 -0
  473. package/dist/esm/funcs/quotasQuotaServiceSetOrganizationQuota.d.ts.map +1 -0
  474. package/dist/esm/funcs/quotasQuotaServiceSetOrganizationQuota.js +86 -0
  475. package/dist/esm/funcs/quotasQuotaServiceSetOrganizationQuota.js.map +1 -0
  476. package/dist/esm/funcs/usageDeleteAPIKeyQuota.d.ts +18 -0
  477. package/dist/esm/funcs/usageDeleteAPIKeyQuota.d.ts.map +1 -0
  478. package/dist/esm/funcs/usageDeleteAPIKeyQuota.js +94 -0
  479. package/dist/esm/funcs/usageDeleteAPIKeyQuota.js.map +1 -0
  480. package/dist/esm/funcs/usageGetOrganizationQuota.d.ts +18 -0
  481. package/dist/esm/funcs/usageGetOrganizationQuota.d.ts.map +1 -0
  482. package/dist/esm/funcs/usageGetOrganizationQuota.js +88 -0
  483. package/dist/esm/funcs/usageGetOrganizationQuota.js.map +1 -0
  484. package/dist/esm/funcs/usageGetUsageHistory.d.ts +18 -0
  485. package/dist/esm/funcs/usageGetUsageHistory.d.ts.map +1 -0
  486. package/dist/esm/funcs/usageGetUsageHistory.js +89 -0
  487. package/dist/esm/funcs/usageGetUsageHistory.js.map +1 -0
  488. package/dist/esm/funcs/usageListAPIKeyQuotas.d.ts +18 -0
  489. package/dist/esm/funcs/usageListAPIKeyQuotas.d.ts.map +1 -0
  490. package/dist/esm/funcs/usageListAPIKeyQuotas.js +88 -0
  491. package/dist/esm/funcs/usageListAPIKeyQuotas.js.map +1 -0
  492. package/dist/esm/funcs/usageSetAPIKeyQuota.d.ts +18 -0
  493. package/dist/esm/funcs/usageSetAPIKeyQuota.d.ts.map +1 -0
  494. package/dist/esm/funcs/usageSetAPIKeyQuota.js +91 -0
  495. package/dist/esm/funcs/usageSetAPIKeyQuota.js.map +1 -0
  496. package/dist/esm/funcs/versionsCreate.d.ts +1 -1
  497. package/dist/esm/funcs/versionsCreate.d.ts.map +1 -1
  498. package/dist/esm/funcs/versionsCreate.js +1 -4
  499. package/dist/esm/funcs/versionsCreate.js.map +1 -1
  500. package/dist/esm/funcs/versionsGet.d.ts +1 -1
  501. package/dist/esm/funcs/versionsGet.d.ts.map +1 -1
  502. package/dist/esm/funcs/versionsGet.js +1 -1
  503. package/dist/esm/funcs/versionsGet.js.map +1 -1
  504. package/dist/esm/funcs/versionsList.d.ts +1 -1
  505. package/dist/esm/funcs/versionsList.d.ts.map +1 -1
  506. package/dist/esm/funcs/versionsList.js +1 -1
  507. package/dist/esm/funcs/versionsList.js.map +1 -1
  508. package/dist/esm/funcs/versionsUpdate.d.ts +1 -1
  509. package/dist/esm/funcs/versionsUpdate.d.ts.map +1 -1
  510. package/dist/esm/funcs/versionsUpdate.js +1 -1
  511. package/dist/esm/funcs/versionsUpdate.js.map +1 -1
  512. package/dist/esm/lib/config.d.ts +3 -3
  513. package/dist/esm/lib/config.js +3 -3
  514. package/dist/esm/lib/config.js.map +1 -1
  515. package/dist/esm/models/components/acceptorganizationinviteresponse.d.ts +17 -0
  516. package/dist/esm/models/components/acceptorganizationinviteresponse.d.ts.map +1 -0
  517. package/dist/esm/models/components/acceptorganizationinviteresponse.js +14 -0
  518. package/dist/esm/models/components/acceptorganizationinviteresponse.js.map +1 -0
  519. package/dist/esm/models/components/apikeyquota.d.ts +32 -0
  520. package/dist/esm/models/components/apikeyquota.d.ts.map +1 -0
  521. package/dist/esm/models/components/apikeyquota.js +26 -0
  522. package/dist/esm/models/components/apikeyquota.js.map +1 -0
  523. package/dist/esm/models/components/connecterror.d.ts +56 -0
  524. package/dist/esm/models/components/connecterror.d.ts.map +1 -0
  525. package/dist/esm/models/components/connecterror.js +41 -0
  526. package/dist/esm/models/components/connecterror.js.map +1 -0
  527. package/dist/esm/models/components/connecterrordetailsany.d.ts +38 -0
  528. package/dist/esm/models/components/connecterrordetailsany.d.ts.map +1 -0
  529. package/dist/esm/models/components/connecterrordetailsany.js +22 -0
  530. package/dist/esm/models/components/connecterrordetailsany.js.map +1 -0
  531. package/dist/esm/models/components/createorganizationinviteresponse.d.ts +20 -0
  532. package/dist/esm/models/components/createorganizationinviteresponse.d.ts.map +1 -0
  533. package/dist/esm/models/components/createorganizationinviteresponse.js +14 -0
  534. package/dist/esm/models/components/createorganizationinviteresponse.js.map +1 -0
  535. package/dist/esm/models/components/createversionrequest.d.ts +0 -8
  536. package/dist/esm/models/components/createversionrequest.d.ts.map +1 -1
  537. package/dist/esm/models/components/createversionrequest.js +2 -8
  538. package/dist/esm/models/components/createversionrequest.js.map +1 -1
  539. package/dist/esm/models/components/dailyusage.d.ts +20 -0
  540. package/dist/esm/models/components/dailyusage.d.ts.map +1 -0
  541. package/dist/esm/models/components/dailyusage.js +21 -0
  542. package/dist/esm/models/components/dailyusage.js.map +1 -0
  543. package/dist/esm/models/components/deleteapikeyquotaresponse.d.ts +11 -0
  544. package/dist/esm/models/components/deleteapikeyquotaresponse.d.ts.map +1 -0
  545. package/dist/esm/models/components/deleteapikeyquotaresponse.js +11 -0
  546. package/dist/esm/models/components/deleteapikeyquotaresponse.js.map +1 -0
  547. package/dist/esm/models/components/deleteorganizationquotarequest.d.ts +18 -0
  548. package/dist/esm/models/components/deleteorganizationquotarequest.d.ts.map +1 -0
  549. package/dist/esm/models/components/deleteorganizationquotarequest.js +17 -0
  550. package/dist/esm/models/components/deleteorganizationquotarequest.js.map +1 -0
  551. package/dist/esm/models/components/deleteorganizationquotaresponse.d.ts +11 -0
  552. package/dist/esm/models/components/deleteorganizationquotaresponse.d.ts.map +1 -0
  553. package/dist/esm/models/components/deleteorganizationquotaresponse.js +11 -0
  554. package/dist/esm/models/components/deleteorganizationquotaresponse.js.map +1 -0
  555. package/dist/esm/models/components/errordetail.d.ts +54 -0
  556. package/dist/esm/models/components/errordetail.d.ts.map +1 -0
  557. package/dist/esm/models/components/errordetail.js +52 -0
  558. package/dist/esm/models/components/errordetail.js.map +1 -0
  559. package/dist/esm/models/components/errorresponse.d.ts +53 -0
  560. package/dist/esm/models/components/errorresponse.d.ts.map +1 -0
  561. package/dist/esm/models/components/errorresponse.js +38 -0
  562. package/dist/esm/models/components/errorresponse.js.map +1 -0
  563. package/dist/esm/models/components/getorganizationquotaresponse.d.ts +17 -0
  564. package/dist/esm/models/components/getorganizationquotaresponse.d.ts.map +1 -0
  565. package/dist/esm/models/components/getorganizationquotaresponse.js +15 -0
  566. package/dist/esm/models/components/getorganizationquotaresponse.js.map +1 -0
  567. package/dist/esm/models/components/getusagehistoryresponse.d.ts +25 -0
  568. package/dist/esm/models/components/getusagehistoryresponse.d.ts.map +1 -0
  569. package/dist/esm/models/components/getusagehistoryresponse.js +24 -0
  570. package/dist/esm/models/components/getusagehistoryresponse.js.map +1 -0
  571. package/dist/esm/models/components/index.d.ts +26 -1
  572. package/dist/esm/models/components/index.d.ts.map +1 -1
  573. package/dist/esm/models/components/index.js +26 -1
  574. package/dist/esm/models/components/index.js.map +1 -1
  575. package/dist/esm/models/components/listapikeyquotasresponse.d.ts +17 -0
  576. package/dist/esm/models/components/listapikeyquotasresponse.d.ts.map +1 -0
  577. package/dist/esm/models/components/listapikeyquotasresponse.js +15 -0
  578. package/dist/esm/models/components/listapikeyquotasresponse.js.map +1 -0
  579. package/dist/esm/models/components/listorganizationinvitesresponse.d.ts +25 -0
  580. package/dist/esm/models/components/listorganizationinvitesresponse.d.ts.map +1 -0
  581. package/dist/esm/models/components/listorganizationinvitesresponse.js +17 -0
  582. package/dist/esm/models/components/listorganizationinvitesresponse.js.map +1 -0
  583. package/dist/esm/models/components/organizationinvite.d.ts +57 -0
  584. package/dist/esm/models/components/organizationinvite.d.ts.map +1 -0
  585. package/dist/esm/models/components/organizationinvite.js +34 -0
  586. package/dist/esm/models/components/organizationinvite.js.map +1 -0
  587. package/dist/esm/models/components/organizationinvitestatus.d.ts +14 -0
  588. package/dist/esm/models/components/organizationinvitestatus.d.ts.map +1 -0
  589. package/dist/esm/models/components/organizationinvitestatus.js +15 -0
  590. package/dist/esm/models/components/organizationinvitestatus.js.map +1 -0
  591. package/dist/esm/models/components/organizationquota.d.ts +52 -0
  592. package/dist/esm/models/components/organizationquota.d.ts.map +1 -0
  593. package/dist/esm/models/components/organizationquota.js +34 -0
  594. package/dist/esm/models/components/organizationquota.js.map +1 -0
  595. package/dist/esm/models/components/organizationquotaconfig.d.ts +37 -0
  596. package/dist/esm/models/components/organizationquotaconfig.d.ts.map +1 -0
  597. package/dist/esm/models/components/organizationquotaconfig.js +28 -0
  598. package/dist/esm/models/components/organizationquotaconfig.js.map +1 -0
  599. package/dist/esm/models/components/organizationrole.d.ts +11 -0
  600. package/dist/esm/models/components/organizationrole.d.ts.map +1 -0
  601. package/dist/esm/models/components/organizationrole.js +12 -0
  602. package/dist/esm/models/components/organizationrole.js.map +1 -0
  603. package/dist/esm/models/components/quotatier.d.ts +19 -0
  604. package/dist/esm/models/components/quotatier.d.ts.map +1 -0
  605. package/dist/esm/models/components/quotatier.js +17 -0
  606. package/dist/esm/models/components/quotatier.js.map +1 -0
  607. package/dist/esm/models/components/resendorganizationinviteresponse.d.ts +20 -0
  608. package/dist/esm/models/components/resendorganizationinviteresponse.d.ts.map +1 -0
  609. package/dist/esm/models/components/resendorganizationinviteresponse.js +14 -0
  610. package/dist/esm/models/components/resendorganizationinviteresponse.js.map +1 -0
  611. package/dist/esm/models/components/revokeorganizationinviteresponse.d.ts +20 -0
  612. package/dist/esm/models/components/revokeorganizationinviteresponse.d.ts.map +1 -0
  613. package/dist/esm/models/components/revokeorganizationinviteresponse.js +14 -0
  614. package/dist/esm/models/components/revokeorganizationinviteresponse.js.map +1 -0
  615. package/dist/esm/models/components/setapikeyquotaresponse.d.ts +17 -0
  616. package/dist/esm/models/components/setapikeyquotaresponse.d.ts.map +1 -0
  617. package/dist/esm/models/components/setapikeyquotaresponse.js +15 -0
  618. package/dist/esm/models/components/setapikeyquotaresponse.js.map +1 -0
  619. package/dist/esm/models/components/setorganizationquotarequest.d.ts +32 -0
  620. package/dist/esm/models/components/setorganizationquotarequest.d.ts.map +1 -0
  621. package/dist/esm/models/components/setorganizationquotarequest.js +20 -0
  622. package/dist/esm/models/components/setorganizationquotarequest.js.map +1 -0
  623. package/dist/esm/models/components/setorganizationquotaresponse.d.ts +17 -0
  624. package/dist/esm/models/components/setorganizationquotaresponse.d.ts.map +1 -0
  625. package/dist/esm/models/components/setorganizationquotaresponse.js +15 -0
  626. package/dist/esm/models/components/setorganizationquotaresponse.js.map +1 -0
  627. package/dist/esm/models/errors/errorresponse.d.ts +70 -0
  628. package/dist/esm/models/errors/errorresponse.d.ts.map +1 -0
  629. package/dist/esm/models/errors/{error.js → errorresponse.js} +13 -9
  630. package/dist/esm/models/errors/errorresponse.js.map +1 -0
  631. package/dist/esm/models/errors/index.d.ts +1 -1
  632. package/dist/esm/models/errors/index.d.ts.map +1 -1
  633. package/dist/esm/models/errors/index.js +1 -1
  634. package/dist/esm/models/errors/index.js.map +1 -1
  635. package/dist/esm/models/operations/acceptorganizationinvite.d.ts +49 -0
  636. package/dist/esm/models/operations/acceptorganizationinvite.d.ts.map +1 -0
  637. package/dist/esm/models/operations/acceptorganizationinvite.js +42 -0
  638. package/dist/esm/models/operations/acceptorganizationinvite.js.map +1 -0
  639. package/dist/esm/models/operations/attachdocumentpolicy.d.ts +0 -3
  640. package/dist/esm/models/operations/attachdocumentpolicy.d.ts.map +1 -1
  641. package/dist/esm/models/operations/attachdocumentpolicy.js +0 -2
  642. package/dist/esm/models/operations/attachdocumentpolicy.js.map +1 -1
  643. package/dist/esm/models/operations/createapikey.d.ts +0 -3
  644. package/dist/esm/models/operations/createapikey.d.ts.map +1 -1
  645. package/dist/esm/models/operations/createapikey.js +0 -2
  646. package/dist/esm/models/operations/createapikey.js.map +1 -1
  647. package/dist/esm/models/operations/createdocument.d.ts +0 -3
  648. package/dist/esm/models/operations/createdocument.d.ts.map +1 -1
  649. package/dist/esm/models/operations/createdocument.js +0 -2
  650. package/dist/esm/models/operations/createdocument.js.map +1 -1
  651. package/dist/esm/models/operations/createdocumentversion.d.ts +0 -3
  652. package/dist/esm/models/operations/createdocumentversion.d.ts.map +1 -1
  653. package/dist/esm/models/operations/createdocumentversion.js +0 -2
  654. package/dist/esm/models/operations/createdocumentversion.js.map +1 -1
  655. package/dist/esm/models/operations/createorganization.d.ts +0 -3
  656. package/dist/esm/models/operations/createorganization.d.ts.map +1 -1
  657. package/dist/esm/models/operations/createorganization.js +0 -2
  658. package/dist/esm/models/operations/createorganization.js.map +1 -1
  659. package/dist/esm/models/operations/createorganizationinvite.d.ts +63 -0
  660. package/dist/esm/models/operations/createorganizationinvite.d.ts.map +1 -0
  661. package/dist/esm/models/operations/createorganizationinvite.js +48 -0
  662. package/dist/esm/models/operations/createorganizationinvite.js.map +1 -0
  663. package/dist/esm/models/operations/deleteapikeyquota.d.ts +33 -0
  664. package/dist/esm/models/operations/deleteapikeyquota.d.ts.map +1 -0
  665. package/dist/esm/models/operations/deleteapikeyquota.js +35 -0
  666. package/dist/esm/models/operations/deleteapikeyquota.js.map +1 -0
  667. package/dist/esm/models/operations/detachdocumentpolicy.d.ts +0 -3
  668. package/dist/esm/models/operations/detachdocumentpolicy.d.ts.map +1 -1
  669. package/dist/esm/models/operations/detachdocumentpolicy.js +0 -2
  670. package/dist/esm/models/operations/detachdocumentpolicy.js.map +1 -1
  671. package/dist/esm/models/operations/generatedocumententrypage.d.ts +0 -3
  672. package/dist/esm/models/operations/generatedocumententrypage.d.ts.map +1 -1
  673. package/dist/esm/models/operations/generatedocumententrypage.js +0 -2
  674. package/dist/esm/models/operations/generatedocumententrypage.js.map +1 -1
  675. package/dist/esm/models/operations/getdocument.d.ts +0 -3
  676. package/dist/esm/models/operations/getdocument.d.ts.map +1 -1
  677. package/dist/esm/models/operations/getdocument.js +0 -2
  678. package/dist/esm/models/operations/getdocument.js.map +1 -1
  679. package/dist/esm/models/operations/getorganization.d.ts +0 -3
  680. package/dist/esm/models/operations/getorganization.d.ts.map +1 -1
  681. package/dist/esm/models/operations/getorganization.js +0 -2
  682. package/dist/esm/models/operations/getorganization.js.map +1 -1
  683. package/dist/esm/models/operations/getorganizationquota.d.ts +31 -0
  684. package/dist/esm/models/operations/getorganizationquota.d.ts.map +1 -0
  685. package/dist/esm/models/operations/getorganizationquota.js +33 -0
  686. package/dist/esm/models/operations/getorganizationquota.js.map +1 -0
  687. package/dist/esm/models/operations/getusagehistory.d.ts +33 -0
  688. package/dist/esm/models/operations/getusagehistory.d.ts.map +1 -0
  689. package/dist/esm/models/operations/getusagehistory.js +35 -0
  690. package/dist/esm/models/operations/getusagehistory.js.map +1 -0
  691. package/dist/esm/models/operations/getversion.d.ts +0 -3
  692. package/dist/esm/models/operations/getversion.d.ts.map +1 -1
  693. package/dist/esm/models/operations/getversion.js +0 -2
  694. package/dist/esm/models/operations/getversion.js.map +1 -1
  695. package/dist/esm/models/operations/index.d.ts +12 -0
  696. package/dist/esm/models/operations/index.d.ts.map +1 -1
  697. package/dist/esm/models/operations/index.js +12 -0
  698. package/dist/esm/models/operations/index.js.map +1 -1
  699. package/dist/esm/models/operations/listapikeyquotas.d.ts +28 -0
  700. package/dist/esm/models/operations/listapikeyquotas.d.ts.map +1 -0
  701. package/dist/esm/models/operations/listapikeyquotas.js +33 -0
  702. package/dist/esm/models/operations/listapikeyquotas.js.map +1 -0
  703. package/dist/esm/models/operations/listapikeys.d.ts +0 -3
  704. package/dist/esm/models/operations/listapikeys.d.ts.map +1 -1
  705. package/dist/esm/models/operations/listapikeys.js +0 -2
  706. package/dist/esm/models/operations/listapikeys.js.map +1 -1
  707. package/dist/esm/models/operations/listdocumentpolicies.d.ts +0 -3
  708. package/dist/esm/models/operations/listdocumentpolicies.d.ts.map +1 -1
  709. package/dist/esm/models/operations/listdocumentpolicies.js +0 -2
  710. package/dist/esm/models/operations/listdocumentpolicies.js.map +1 -1
  711. package/dist/esm/models/operations/listdocuments.d.ts +0 -3
  712. package/dist/esm/models/operations/listdocuments.d.ts.map +1 -1
  713. package/dist/esm/models/operations/listdocuments.js +0 -2
  714. package/dist/esm/models/operations/listdocuments.js.map +1 -1
  715. package/dist/esm/models/operations/listdocumentversions.d.ts +0 -3
  716. package/dist/esm/models/operations/listdocumentversions.d.ts.map +1 -1
  717. package/dist/esm/models/operations/listdocumentversions.js +0 -2
  718. package/dist/esm/models/operations/listdocumentversions.js.map +1 -1
  719. package/dist/esm/models/operations/listorganizationinvites.d.ts +80 -0
  720. package/dist/esm/models/operations/listorganizationinvites.d.ts.map +1 -0
  721. package/dist/esm/models/operations/listorganizationinvites.js +46 -0
  722. package/dist/esm/models/operations/listorganizationinvites.js.map +1 -0
  723. package/dist/esm/models/operations/listorganizations.d.ts +9 -3
  724. package/dist/esm/models/operations/listorganizations.d.ts.map +1 -1
  725. package/dist/esm/models/operations/listorganizations.js +1 -2
  726. package/dist/esm/models/operations/listorganizations.js.map +1 -1
  727. package/dist/esm/models/operations/quotaservicedeleteorganizationquota.d.ts +33 -0
  728. package/dist/esm/models/operations/quotaservicedeleteorganizationquota.d.ts.map +1 -0
  729. package/dist/esm/models/operations/quotaservicedeleteorganizationquota.js +38 -0
  730. package/dist/esm/models/operations/quotaservicedeleteorganizationquota.js.map +1 -0
  731. package/dist/esm/models/operations/quotaservicesetorganizationquota.d.ts +33 -0
  732. package/dist/esm/models/operations/quotaservicesetorganizationquota.d.ts.map +1 -0
  733. package/dist/esm/models/operations/quotaservicesetorganizationquota.js +38 -0
  734. package/dist/esm/models/operations/quotaservicesetorganizationquota.js.map +1 -0
  735. package/dist/esm/models/operations/resendorganizationinvite.d.ts +50 -0
  736. package/dist/esm/models/operations/resendorganizationinvite.d.ts.map +1 -0
  737. package/dist/esm/models/operations/resendorganizationinvite.js +42 -0
  738. package/dist/esm/models/operations/resendorganizationinvite.js.map +1 -0
  739. package/dist/esm/models/operations/revokeapikey.d.ts +0 -3
  740. package/dist/esm/models/operations/revokeapikey.d.ts.map +1 -1
  741. package/dist/esm/models/operations/revokeapikey.js +0 -2
  742. package/dist/esm/models/operations/revokeapikey.js.map +1 -1
  743. package/dist/esm/models/operations/revokeorganizationinvite.d.ts +50 -0
  744. package/dist/esm/models/operations/revokeorganizationinvite.d.ts.map +1 -0
  745. package/dist/esm/models/operations/revokeorganizationinvite.js +42 -0
  746. package/dist/esm/models/operations/revokeorganizationinvite.js.map +1 -0
  747. package/dist/esm/models/operations/setapikeyquota.d.ts +51 -0
  748. package/dist/esm/models/operations/setapikeyquota.d.ts.map +1 -0
  749. package/dist/esm/models/operations/setapikeyquota.js +46 -0
  750. package/dist/esm/models/operations/setapikeyquota.js.map +1 -0
  751. package/dist/esm/models/operations/updatedocument.d.ts +0 -3
  752. package/dist/esm/models/operations/updatedocument.d.ts.map +1 -1
  753. package/dist/esm/models/operations/updatedocument.js +0 -2
  754. package/dist/esm/models/operations/updatedocument.js.map +1 -1
  755. package/dist/esm/models/operations/updateversion.d.ts +0 -3
  756. package/dist/esm/models/operations/updateversion.d.ts.map +1 -1
  757. package/dist/esm/models/operations/updateversion.js +0 -2
  758. package/dist/esm/models/operations/updateversion.js.map +1 -1
  759. package/dist/esm/sdk/invites.d.ts +22 -0
  760. package/dist/esm/sdk/invites.d.ts.map +1 -0
  761. package/dist/esm/sdk/invites.js +29 -0
  762. package/dist/esm/sdk/invites.js.map +1 -0
  763. package/dist/esm/sdk/organizations.d.ts +24 -0
  764. package/dist/esm/sdk/organizations.d.ts.map +1 -1
  765. package/dist/esm/sdk/organizations.js +34 -0
  766. package/dist/esm/sdk/organizations.js.map +1 -1
  767. package/dist/esm/sdk/quotas.d.ts +22 -0
  768. package/dist/esm/sdk/quotas.d.ts.map +1 -0
  769. package/dist/esm/sdk/quotas.js +31 -0
  770. package/dist/esm/sdk/quotas.js.map +1 -0
  771. package/dist/esm/sdk/sdk.d.ts +6 -0
  772. package/dist/esm/sdk/sdk.d.ts.map +1 -1
  773. package/dist/esm/sdk/sdk.js +8 -0
  774. package/dist/esm/sdk/sdk.js.map +1 -1
  775. package/dist/esm/sdk/usage.d.ts +40 -0
  776. package/dist/esm/sdk/usage.d.ts.map +1 -0
  777. package/dist/esm/sdk/usage.js +58 -0
  778. package/dist/esm/sdk/usage.js.map +1 -0
  779. package/dist/esm/types/smartUnion.js +7 -0
  780. package/dist/esm/types/smartUnion.js.map +1 -1
  781. package/examples/{apiKeysList.example.ts → documentsList.example.ts} +4 -3
  782. package/jsr.json +1 -1
  783. package/package.json +3 -3
  784. package/src/funcs/apiKeysCreate.ts +6 -6
  785. package/src/funcs/apiKeysList.ts +7 -7
  786. package/src/funcs/apiKeysRevoke.ts +6 -6
  787. package/src/funcs/documentsCreate.ts +6 -6
  788. package/src/funcs/documentsGet.ts +6 -6
  789. package/src/funcs/documentsList.ts +8 -8
  790. package/src/funcs/documentsUpdate.ts +6 -6
  791. package/src/funcs/entryPagesGenerate.ts +6 -6
  792. package/src/funcs/organizationsAcceptOrganizationInvite.ts +184 -0
  793. package/src/funcs/organizationsCreate.ts +6 -6
  794. package/src/funcs/organizationsGet.ts +6 -6
  795. package/src/funcs/organizationsInvitesCreate.ts +184 -0
  796. package/src/funcs/organizationsInvitesList.ts +256 -0
  797. package/src/funcs/organizationsList.ts +9 -8
  798. package/src/funcs/organizationsResendOrganizationInvite.ts +188 -0
  799. package/src/funcs/organizationsRevokeOrganizationInvite.ts +188 -0
  800. package/src/funcs/policiesAttach.ts +6 -6
  801. package/src/funcs/policiesDetach.ts +6 -6
  802. package/src/funcs/policiesList.ts +7 -7
  803. package/src/funcs/quotasQuotaServiceDeleteOrganizationQuota.ts +199 -0
  804. package/src/funcs/quotasQuotaServiceSetOrganizationQuota.ts +198 -0
  805. package/src/funcs/usageDeleteAPIKeyQuota.ts +186 -0
  806. package/src/funcs/usageGetOrganizationQuota.ts +182 -0
  807. package/src/funcs/usageGetUsageHistory.ts +183 -0
  808. package/src/funcs/usageListAPIKeyQuotas.ts +182 -0
  809. package/src/funcs/usageSetAPIKeyQuota.ts +181 -0
  810. package/src/funcs/versionsCreate.ts +6 -9
  811. package/src/funcs/versionsGet.ts +6 -6
  812. package/src/funcs/versionsList.ts +7 -7
  813. package/src/funcs/versionsUpdate.ts +6 -6
  814. package/src/lib/config.ts +3 -3
  815. package/src/models/components/acceptorganizationinviteresponse.ts +37 -0
  816. package/src/models/components/apikeyquota.ts +65 -0
  817. package/src/models/components/connecterror.ts +94 -0
  818. package/src/models/components/connecterrordetailsany.ts +80 -0
  819. package/src/models/components/createorganizationinviteresponse.ts +43 -0
  820. package/src/models/components/createversionrequest.ts +8 -25
  821. package/src/models/components/dailyusage.ts +48 -0
  822. package/src/models/components/deleteapikeyquotaresponse.ts +29 -0
  823. package/src/models/components/deleteorganizationquotarequest.ts +46 -0
  824. package/src/models/components/deleteorganizationquotaresponse.ts +29 -0
  825. package/src/models/components/errordetail.ts +87 -0
  826. package/src/models/components/errorresponse.ts +62 -0
  827. package/src/models/components/getorganizationquotaresponse.ts +41 -0
  828. package/src/models/components/getusagehistoryresponse.ts +58 -0
  829. package/src/models/components/index.ts +26 -1
  830. package/src/models/components/listapikeyquotasresponse.ts +38 -0
  831. package/src/models/components/listorganizationinvitesresponse.ts +50 -0
  832. package/src/models/components/organizationinvite.ts +102 -0
  833. package/src/models/components/organizationinvitestatus.ts +28 -0
  834. package/src/models/components/organizationquota.ts +95 -0
  835. package/src/models/components/organizationquotaconfig.ts +74 -0
  836. package/src/models/components/organizationrole.ts +18 -0
  837. package/src/models/components/quotatier.ts +27 -0
  838. package/src/models/components/resendorganizationinviteresponse.ts +43 -0
  839. package/src/models/components/revokeorganizationinviteresponse.ts +43 -0
  840. package/src/models/components/setapikeyquotaresponse.ts +38 -0
  841. package/src/models/components/setorganizationquotarequest.ts +62 -0
  842. package/src/models/components/setorganizationquotaresponse.ts +41 -0
  843. package/src/models/errors/errorresponse.ts +111 -0
  844. package/src/models/errors/index.ts +1 -1
  845. package/src/models/operations/acceptorganizationinvite.ts +129 -0
  846. package/src/models/operations/attachdocumentpolicy.ts +0 -3
  847. package/src/models/operations/createapikey.ts +0 -3
  848. package/src/models/operations/createdocument.ts +0 -3
  849. package/src/models/operations/createdocumentversion.ts +0 -3
  850. package/src/models/operations/createorganization.ts +0 -3
  851. package/src/models/operations/createorganizationinvite.ts +152 -0
  852. package/src/models/operations/deleteapikeyquota.ts +90 -0
  853. package/src/models/operations/detachdocumentpolicy.ts +0 -3
  854. package/src/models/operations/generatedocumententrypage.ts +0 -3
  855. package/src/models/operations/getdocument.ts +0 -3
  856. package/src/models/operations/getorganization.ts +0 -3
  857. package/src/models/operations/getorganizationquota.ts +90 -0
  858. package/src/models/operations/getusagehistory.ts +90 -0
  859. package/src/models/operations/getversion.ts +0 -3
  860. package/src/models/operations/index.ts +12 -0
  861. package/src/models/operations/listapikeyquotas.ts +83 -0
  862. package/src/models/operations/listapikeys.ts +0 -3
  863. package/src/models/operations/listdocumentpolicies.ts +0 -3
  864. package/src/models/operations/listdocuments.ts +0 -3
  865. package/src/models/operations/listdocumentversions.ts +0 -3
  866. package/src/models/operations/listorganizationinvites.ts +156 -0
  867. package/src/models/operations/listorganizations.ts +10 -3
  868. package/src/models/operations/quotaservicedeleteorganizationquota.ts +103 -0
  869. package/src/models/operations/quotaservicesetorganizationquota.ts +103 -0
  870. package/src/models/operations/resendorganizationinvite.ts +131 -0
  871. package/src/models/operations/revokeapikey.ts +0 -3
  872. package/src/models/operations/revokeorganizationinvite.ts +131 -0
  873. package/src/models/operations/setapikeyquota.ts +132 -0
  874. package/src/models/operations/updatedocument.ts +0 -3
  875. package/src/models/operations/updateversion.ts +0 -3
  876. package/src/sdk/invites.ts +48 -0
  877. package/src/sdk/organizations.ts +60 -0
  878. package/src/sdk/quotas.ts +48 -0
  879. package/src/sdk/sdk.ts +12 -0
  880. package/src/sdk/usage.ts +99 -0
  881. package/src/types/smartUnion.ts +8 -0
  882. package/_speakeasy/.github/action-inputs-config.json +0 -53
  883. package/_speakeasy/.github/action-security-config.json +0 -88
  884. package/dist/commonjs/models/components/error.d.ts +0 -47
  885. package/dist/commonjs/models/components/error.d.ts.map +0 -1
  886. package/dist/commonjs/models/components/error.js.map +0 -1
  887. package/dist/commonjs/models/errors/error.d.ts +0 -26
  888. package/dist/commonjs/models/errors/error.d.ts.map +0 -1
  889. package/dist/commonjs/models/errors/error.js.map +0 -1
  890. package/dist/esm/models/components/error.d.ts +0 -47
  891. package/dist/esm/models/components/error.d.ts.map +0 -1
  892. package/dist/esm/models/components/error.js +0 -38
  893. package/dist/esm/models/components/error.js.map +0 -1
  894. package/dist/esm/models/errors/error.d.ts +0 -26
  895. package/dist/esm/models/errors/error.d.ts.map +0 -1
  896. package/dist/esm/models/errors/error.js.map +0 -1
  897. package/examples/package-lock.json +0 -611
  898. package/examples/package.json +0 -18
  899. package/openapi.json +0 -2941
  900. package/src/models/components/error.ts +0 -81
  901. package/src/models/errors/error.ts +0 -61
  902. package/tsconfig.json +0 -40
package/openapi.json DELETED
@@ -1,2941 +0,0 @@
1
- {
2
- "components": {
3
- "responses": {
4
- "BadRequest": {
5
- "content": {
6
- "application/json": {
7
- "examples": {
8
- "validation_error": {
9
- "value": {
10
- "error": {
11
- "code": "missing_required_field",
12
- "message": "Document title cannot be empty",
13
- "param": "title",
14
- "retry_after": null,
15
- "type": "invalid_request_error"
16
- }
17
- }
18
- }
19
- },
20
- "schema": {
21
- "$ref": "#/components/schemas/Error"
22
- }
23
- }
24
- },
25
- "description": "Invalid request parameters"
26
- },
27
- "Forbidden": {
28
- "content": {
29
- "application/json": {
30
- "examples": {
31
- "insufficient_permissions": {
32
- "value": {
33
- "error": {
34
- "code": "insufficient_permissions",
35
- "message": "You do not have permission to access this resource",
36
- "param": null,
37
- "retry_after": null,
38
- "type": "authorization_error"
39
- }
40
- }
41
- }
42
- },
43
- "schema": {
44
- "$ref": "#/components/schemas/Error"
45
- }
46
- }
47
- },
48
- "description": "Authorization failed - valid key but insufficient permissions"
49
- },
50
- "InternalServerError": {
51
- "content": {
52
- "application/json": {
53
- "examples": {
54
- "internal_error": {
55
- "value": {
56
- "error": {
57
- "code": "internal_error",
58
- "message": "An unexpected error occurred. Please try again later.",
59
- "param": null,
60
- "retry_after": null,
61
- "type": "api_error"
62
- }
63
- }
64
- }
65
- },
66
- "schema": {
67
- "$ref": "#/components/schemas/Error"
68
- }
69
- }
70
- },
71
- "description": "Internal server error"
72
- },
73
- "NotFound": {
74
- "content": {
75
- "application/json": {
76
- "examples": {
77
- "resource_not_found": {
78
- "value": {
79
- "error": {
80
- "code": "resource_not_found",
81
- "message": "Document not found",
82
- "param": null,
83
- "retry_after": null,
84
- "type": "not_found_error"
85
- }
86
- }
87
- }
88
- },
89
- "schema": {
90
- "$ref": "#/components/schemas/Error"
91
- }
92
- }
93
- },
94
- "description": "Resource not found"
95
- },
96
- "RateLimitExceeded": {
97
- "content": {
98
- "application/json": {
99
- "examples": {
100
- "rate_limit": {
101
- "value": {
102
- "error": {
103
- "code": "rate_limit_exceeded",
104
- "message": "Too many requests. Retry after 30 seconds.",
105
- "param": null,
106
- "retry_after": 30,
107
- "type": "rate_limit_error"
108
- }
109
- }
110
- }
111
- },
112
- "schema": {
113
- "$ref": "#/components/schemas/Error"
114
- }
115
- }
116
- },
117
- "description": "Too many requests",
118
- "headers": {
119
- "X-RateLimit-Limit": {
120
- "description": "Request limit per minute",
121
- "schema": {
122
- "type": "integer"
123
- }
124
- },
125
- "X-RateLimit-Remaining": {
126
- "description": "Remaining requests in current window",
127
- "schema": {
128
- "type": "integer"
129
- }
130
- },
131
- "X-RateLimit-Reset": {
132
- "description": "Unix timestamp when rate limit resets",
133
- "schema": {
134
- "type": "integer"
135
- }
136
- }
137
- }
138
- },
139
- "Unauthorized": {
140
- "content": {
141
- "application/json": {
142
- "examples": {
143
- "missing_key": {
144
- "value": {
145
- "error": {
146
- "code": "missing_api_key",
147
- "message": "No API key provided",
148
- "param": null,
149
- "retry_after": null,
150
- "type": "authentication_error"
151
- }
152
- }
153
- }
154
- },
155
- "schema": {
156
- "$ref": "#/components/schemas/Error"
157
- }
158
- }
159
- },
160
- "description": "Authentication failed - missing or invalid API key"
161
- }
162
- },
163
- "schemas": {
164
- "AccessLevel": {
165
- "enum": [
166
- "private",
167
- "organization",
168
- "public"
169
- ]
170
- },
171
- "ApiKey": {
172
- "additionalProperties": false,
173
- "description": "ApiKey represents an authentication credential for programmatic API access.",
174
- "properties": {
175
- "created_at": {
176
- "description": "Timestamp when the key was created.",
177
- "format": "date-time",
178
- "title": "created_at",
179
- "type": "string"
180
- },
181
- "expires_at": {
182
- "description": "Expiration timestamp. If set, the key becomes invalid after this time.",
183
- "format": "date-time",
184
- "title": "expires_at",
185
- "type": "string"
186
- },
187
- "id": {
188
- "description": "Unique ID for the API key.\n Pattern: key_[0-9a-hjkmnp-tv-z]{26}",
189
- "example": "key_01jd4h5mck9gq6zrp8bn2t4w3x",
190
- "pattern": "^key_[0-9a-hjkmnp-tv-z]{26}$",
191
- "title": "id",
192
- "type": "string"
193
- },
194
- "is_active": {
195
- "description": "Whether the key is currently active (not revoked and not expired).\n Computed: is_active = (revoked_at == null) \u0026\u0026 (expires_at == null || expires_at \u003e now())",
196
- "readOnly": true,
197
- "title": "is_active",
198
- "type": "boolean"
199
- },
200
- "key_prefix": {
201
- "description": "Truncated key prefix for identification in UI (e.g., \"ffy_prod_01jd4h5...\").\n Shows the first 16 characters for better uniqueness while maintaining security.",
202
- "example": "ffy_prod_01jd4h5...",
203
- "maxLength": 20,
204
- "minLength": 16,
205
- "title": "key_prefix",
206
- "type": "string"
207
- },
208
- "name": {
209
- "description": "Human-readable name for the key (e.g., \"Production\", \"Staging\").",
210
- "example": "Production",
211
- "maxLength": 63,
212
- "minLength": 1,
213
- "title": "name",
214
- "type": "string"
215
- },
216
- "organization_id": {
217
- "description": "ID of the organization this key belongs to.\n Pattern: org_[0-9a-hjkmnp-tv-z]{26}",
218
- "example": "org_01h2xcejqtf2nbrexx3vqjhp41",
219
- "pattern": "^org_[0-9a-hjkmnp-tv-z]{26}$",
220
- "title": "organization_id",
221
- "type": "string"
222
- },
223
- "revoked_at": {
224
- "description": "Timestamp when the key was revoked. Null if the key has not been revoked.",
225
- "format": "date-time",
226
- "readOnly": true,
227
- "title": "revoked_at",
228
- "type": "string"
229
- }
230
- },
231
- "required": [
232
- "id",
233
- "name",
234
- "organization_id",
235
- "created_at",
236
- "is_active",
237
- "key_prefix"
238
- ],
239
- "title": "ApiKey",
240
- "type": "object"
241
- },
242
- "AttachPolicyRequest": {
243
- "additionalProperties": false,
244
- "description": "AttachPolicyRequest specifies a policy to attach to a document.",
245
- "properties": {
246
- "document_id": {
247
- "description": "Document ID.\n Pattern: doc_[0-9a-hjkmnp-tv-z]{26}",
248
- "pattern": "^doc_[0-9a-hjkmnp-tv-z]{26}$",
249
- "title": "document_id",
250
- "type": "string"
251
- },
252
- "policy_id": {
253
- "description": "Policy ID to attach.\n Pattern: pol_[0-9a-hjkmnp-tv-z]{26}",
254
- "pattern": "^pol_[0-9a-hjkmnp-tv-z]{26}$",
255
- "title": "policy_id",
256
- "type": "string"
257
- }
258
- },
259
- "required": [
260
- "policy_id"
261
- ],
262
- "title": "AttachPolicyRequest",
263
- "type": "object"
264
- },
265
- "CreateApiKeyRequest": {
266
- "additionalProperties": false,
267
- "description": "CreateApiKeyRequest contains the data needed to create a new API key.",
268
- "properties": {
269
- "expires_at": {
270
- "description": "Expiration timestamp. If not set, the key does not expire.\n When set, must be in the future and within 1 year.\n Security note: Keys without expiration should be rotated periodically.\ntimestamp.gt_now = true\ntimestamp.within = 8760h0m0s\n",
271
- "format": "date-time",
272
- "title": "expires_at",
273
- "type": "string"
274
- },
275
- "name": {
276
- "description": "Human-readable name for the key (e.g., \"Production\", \"Staging\").",
277
- "maxLength": 63,
278
- "minLength": 1,
279
- "title": "name",
280
- "type": "string"
281
- },
282
- "organization_id": {
283
- "description": "Organization ID to create the key for.\n Pattern: org_[0-9a-hjkmnp-tv-z]{26}",
284
- "pattern": "^org_[0-9a-hjkmnp-tv-z]{26}$",
285
- "title": "organization_id",
286
- "type": "string"
287
- }
288
- },
289
- "required": [
290
- "organization_id",
291
- "name"
292
- ],
293
- "title": "CreateApiKeyRequest",
294
- "type": "object"
295
- },
296
- "CreateApiKeyResponse": {
297
- "additionalProperties": false,
298
- "description": "CreateApiKeyResponse contains the newly created API key and its secret.",
299
- "properties": {
300
- "api_key": {
301
- "$ref": "#/components/schemas/ApiKey",
302
- "description": "The created API key metadata.",
303
- "title": "api_key"
304
- },
305
- "secret": {
306
- "description": "The API key secret. This is only returned once and cannot be retrieved later.\n Format: ffy_{env}_{base32_uuid7}{base62_random}\n - env: \"prod\" or \"test\"\n - base32_uuid7: 26 chars (TypeID base32 alphabet: 0-9a-hjkmnp-tv-z)\n - base62_random: 43 chars (0-9A-Za-z)\n Store this value securely - it will not be shown again.\n SECURITY WARNING: This field must NEVER be logged. Handlers must redact secrets from all logs.",
307
- "example": "ffy_prod_01h2xcejqtf2nbrexx3vqjhp41KJ8f3mNpQrStUvWxYz0123456789ABCDEFGHIJKLmNo",
308
- "minLength": 78,
309
- "pattern": "^ffy_(prod|test)_[A-Za-z0-9]+$",
310
- "title": "secret",
311
- "type": "string"
312
- }
313
- },
314
- "required": [
315
- "api_key",
316
- "secret"
317
- ],
318
- "title": "CreateApiKeyResponse",
319
- "type": "object"
320
- },
321
- "CreateDocumentRequest": {
322
- "additionalProperties": false,
323
- "description": "CreateDocumentRequest contains the file and metadata for creating a document.",
324
- "properties": {
325
- "access_level": {
326
- "$ref": "#/components/schemas/AccessLevel",
327
- "description": "Document access level. Defaults to organization if user belongs to an org, otherwise private.",
328
- "nullable": true,
329
- "title": "access_level"
330
- },
331
- "description": {
332
- "description": "Optional document description.",
333
- "maxLength": 2000,
334
- "nullable": true,
335
- "title": "description",
336
- "type": "string"
337
- },
338
- "document_id": {
339
- "description": "Pre-generated document ID (set by server)",
340
- "readOnly": true,
341
- "title": "document_id",
342
- "type": "string"
343
- },
344
- "payload": {
345
- "description": "PDF file to upload",
346
- "format": "binary",
347
- "title": "payload",
348
- "type": "string"
349
- },
350
- "payload_key": {
351
- "description": "Storage key for uploaded file (set by server)",
352
- "readOnly": true,
353
- "title": "payload_key",
354
- "type": "string"
355
- },
356
- "title": {
357
- "description": "Document title.",
358
- "maxLength": 255,
359
- "minLength": 1,
360
- "title": "title",
361
- "type": "string"
362
- },
363
- "version_id": {
364
- "description": "Pre-generated version ID (set by server)",
365
- "readOnly": true,
366
- "title": "version_id",
367
- "type": "string"
368
- }
369
- },
370
- "required": [
371
- "payload",
372
- "title"
373
- ],
374
- "title": "CreateDocumentRequest",
375
- "type": "object"
376
- },
377
- "CreateDocumentResponse": {
378
- "additionalProperties": false,
379
- "description": "CreateDocumentResponse contains the newly created document.",
380
- "properties": {
381
- "document": {
382
- "$ref": "#/components/schemas/Document",
383
- "description": "The created document.",
384
- "title": "document"
385
- }
386
- },
387
- "required": [
388
- "document"
389
- ],
390
- "title": "CreateDocumentResponse",
391
- "type": "object"
392
- },
393
- "CreateOrganizationRequest": {
394
- "additionalProperties": false,
395
- "description": "CreateOrganizationRequest contains the data needed to create a new organization.",
396
- "properties": {
397
- "name": {
398
- "description": "Human-readable organization name.",
399
- "maxLength": 255,
400
- "minLength": 1,
401
- "title": "name",
402
- "type": "string"
403
- },
404
- "owner_user_id": {
405
- "description": "Owner user ID. If not provided, the authenticated user becomes the owner.\n Authorization: Specifying a different user requires system maintainer role.\n Required when the caller is a service account (service accounts cannot own organizations).\n Pattern: user_[0-9a-hjkmnp-tv-z]{26}",
406
- "nullable": true,
407
- "pattern": "^user_[0-9a-hjkmnp-tv-z]{26}$",
408
- "title": "owner_user_id",
409
- "type": "string"
410
- }
411
- },
412
- "required": [
413
- "name"
414
- ],
415
- "title": "CreateOrganizationRequest",
416
- "type": "object"
417
- },
418
- "CreateOrganizationResponse": {
419
- "additionalProperties": false,
420
- "description": "CreateOrganizationResponse contains the newly created organization.",
421
- "properties": {
422
- "organization": {
423
- "$ref": "#/components/schemas/Organization",
424
- "description": "The created organization.",
425
- "title": "organization"
426
- }
427
- },
428
- "required": [
429
- "organization"
430
- ],
431
- "title": "CreateOrganizationResponse",
432
- "type": "object"
433
- },
434
- "CreateVersionRequest": {
435
- "additionalProperties": false,
436
- "description": "CreateVersionRequest contains the file and metadata for creating a version.",
437
- "properties": {
438
- "description": {
439
- "description": "Description of changes in this version.",
440
- "nullable": true,
441
- "title": "description",
442
- "type": "string"
443
- },
444
- "document_id": {
445
- "description": "Document ID to create version for.\n Pattern: doc_[0-9a-hjkmnp-tv-z]{26}",
446
- "pattern": "^doc_[0-9a-hjkmnp-tv-z]{26}$",
447
- "title": "document_id",
448
- "type": "string"
449
- },
450
- "payload": {
451
- "description": "PDF file for new version",
452
- "format": "binary",
453
- "title": "payload",
454
- "type": "string"
455
- },
456
- "payload_key": {
457
- "description": "Storage key for uploaded file (set by server)",
458
- "readOnly": true,
459
- "title": "payload_key",
460
- "type": "string"
461
- },
462
- "title": {
463
- "description": "Optional version title.",
464
- "maxLength": 255,
465
- "nullable": true,
466
- "title": "title",
467
- "type": "string"
468
- },
469
- "version_id": {
470
- "description": "Pre-generated version ID (set by server)",
471
- "readOnly": true,
472
- "title": "version_id",
473
- "type": "string"
474
- }
475
- },
476
- "required": [
477
- "payload"
478
- ],
479
- "title": "CreateVersionRequest",
480
- "type": "object"
481
- },
482
- "DetachPolicyRequest": {
483
- "additionalProperties": false,
484
- "description": "DetachPolicyRequest identifies a policy to detach from a document.",
485
- "properties": {
486
- "document_id": {
487
- "description": "Document ID.\n Pattern: doc_[0-9a-hjkmnp-tv-z]{26}",
488
- "pattern": "^doc_[0-9a-hjkmnp-tv-z]{26}$",
489
- "title": "document_id",
490
- "type": "string"
491
- },
492
- "policy_id": {
493
- "description": "Policy ID to detach.\n Pattern: pol_[0-9a-hjkmnp-tv-z]{26}",
494
- "pattern": "^pol_[0-9a-hjkmnp-tv-z]{26}$",
495
- "title": "policy_id",
496
- "type": "string"
497
- }
498
- },
499
- "title": "DetachPolicyRequest",
500
- "type": "object"
501
- },
502
- "Document": {
503
- "additionalProperties": false,
504
- "description": "Document represents a Factify document.",
505
- "properties": {
506
- "access_level": {
507
- "$ref": "#/components/schemas/AccessLevel",
508
- "description": "Document access level.",
509
- "title": "access_level"
510
- },
511
- "created_at": {
512
- "description": "Timestamp when document was created.",
513
- "format": "date-time",
514
- "title": "created_at",
515
- "type": "string"
516
- },
517
- "created_by": {
518
- "$ref": "#/components/schemas/User",
519
- "description": "User who created the document.",
520
- "title": "created_by"
521
- },
522
- "current_version": {
523
- "$ref": "#/components/schemas/VersionRef",
524
- "description": "Reference to the current version, if any.",
525
- "nullable": true,
526
- "title": "current_version"
527
- },
528
- "description": {
529
- "description": "Optional document description.",
530
- "example": "Quarterly financial report for Q4 2024",
531
- "maxLength": 2000,
532
- "nullable": true,
533
- "title": "description",
534
- "type": "string"
535
- },
536
- "id": {
537
- "description": "Unique ID for the document.\n Pattern: doc_[0-9a-hjkmnp-tv-z]{26}",
538
- "example": "doc_01h2xcejqtf2nbrexx3vqjhp41",
539
- "pattern": "^doc_[0-9a-hjkmnp-tv-z]{26}$",
540
- "title": "id",
541
- "type": "string"
542
- },
543
- "processing_status": {
544
- "$ref": "#/components/schemas/ProcessingStatus",
545
- "description": "Processing status.",
546
- "title": "processing_status"
547
- },
548
- "title": {
549
- "description": "Document title.",
550
- "example": "Q4 2024 Financial Report",
551
- "maxLength": 255,
552
- "minLength": 1,
553
- "title": "title",
554
- "type": "string"
555
- },
556
- "url": {
557
- "description": "URL for accessing the document on Factify.",
558
- "example": "https://d.factify.com/d/01h2xcejqtf2nbrexx3vqjhp41",
559
- "format": "uri",
560
- "title": "url",
561
- "type": "string"
562
- }
563
- },
564
- "required": [
565
- "id",
566
- "url",
567
- "title",
568
- "access_level",
569
- "processing_status",
570
- "created_at",
571
- "created_by"
572
- ],
573
- "title": "Document",
574
- "type": "object"
575
- },
576
- "DocumentPolicy": {
577
- "additionalProperties": false,
578
- "description": "DocumentPolicy represents a policy attached to a document.",
579
- "properties": {
580
- "attached_at": {
581
- "description": "Timestamp when policy was attached.",
582
- "format": "date-time",
583
- "title": "attached_at",
584
- "type": "string"
585
- },
586
- "attached_by": {
587
- "$ref": "#/components/schemas/User",
588
- "description": "User who attached the policy.",
589
- "title": "attached_by"
590
- },
591
- "document_id": {
592
- "description": "Document ID this policy is attached to.\n Pattern: doc_[0-9a-hjkmnp-tv-z]{26}",
593
- "example": "doc_01h2xcejqtf2nbrexx3vqjhp41",
594
- "pattern": "^doc_[0-9a-hjkmnp-tv-z]{26}$",
595
- "title": "document_id",
596
- "type": "string"
597
- },
598
- "policy": {
599
- "$ref": "#/components/schemas/Policy",
600
- "description": "The policy details.",
601
- "title": "policy"
602
- }
603
- },
604
- "required": [
605
- "document_id",
606
- "attached_at",
607
- "attached_by",
608
- "policy"
609
- ],
610
- "title": "DocumentPolicy",
611
- "type": "object"
612
- },
613
- "Empty": {
614
- "description": "A generic empty message that you can re-use to avoid defining duplicated\n empty messages in your APIs. A typical example is to use it as the request\n or the response type of an API method. For instance:\n\n service Foo {\n rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);\n }",
615
- "type": "object"
616
- },
617
- "Error": {
618
- "properties": {
619
- "error": {
620
- "properties": {
621
- "code": {
622
- "description": "Specific error code for detailed handling",
623
- "type": "string"
624
- },
625
- "message": {
626
- "description": "Human-readable error message",
627
- "type": "string"
628
- },
629
- "param": {
630
- "description": "Parameter that caused the error (for validation errors)",
631
- "type": [
632
- "string",
633
- "null"
634
- ]
635
- },
636
- "retry_after": {
637
- "description": "Seconds to wait before retrying (for rate limit errors)",
638
- "type": [
639
- "integer",
640
- "null"
641
- ]
642
- },
643
- "type": {
644
- "description": "Error type for programmatic handling",
645
- "enum": [
646
- "invalid_request_error",
647
- "authentication_error",
648
- "authorization_error",
649
- "not_found_error",
650
- "rate_limit_error",
651
- "api_error"
652
- ],
653
- "type": "string"
654
- }
655
- },
656
- "required": [
657
- "type",
658
- "message",
659
- "code",
660
- "param",
661
- "retry_after"
662
- ],
663
- "type": "object"
664
- }
665
- },
666
- "required": [
667
- "error"
668
- ],
669
- "type": "object"
670
- },
671
- "GenerateEntryPageRequest": {
672
- "additionalProperties": false,
673
- "description": "GenerateEntryPageRequest identifies a document to generate an entry page for.",
674
- "properties": {
675
- "document_id": {
676
- "description": "Document ID.\n Pattern: doc_[0-9a-hjkmnp-tv-z]{26}",
677
- "pattern": "^doc_[0-9a-hjkmnp-tv-z]{26}$",
678
- "title": "document_id",
679
- "type": "string"
680
- }
681
- },
682
- "title": "GenerateEntryPageRequest",
683
- "type": "object"
684
- },
685
- "GenerateEntryPageResponse": {
686
- "additionalProperties": false,
687
- "description": "GenerateEntryPageResponse contains the download URL for the entry page.",
688
- "properties": {
689
- "download_url": {
690
- "description": "Temporary download URL for the entry page PDF.",
691
- "example": "https://storage.factify.com/entry-pages/abc123.pdf?token=xyz",
692
- "format": "uri",
693
- "title": "download_url",
694
- "type": "string"
695
- }
696
- },
697
- "required": [
698
- "download_url"
699
- ],
700
- "title": "GenerateEntryPageResponse",
701
- "type": "object"
702
- },
703
- "GetDocumentRequest": {
704
- "additionalProperties": false,
705
- "description": "GetDocumentRequest identifies a document to retrieve.",
706
- "properties": {
707
- "document_id": {
708
- "description": "Document ID.\n Pattern: doc_[0-9a-hjkmnp-tv-z]{26}",
709
- "pattern": "^doc_[0-9a-hjkmnp-tv-z]{26}$",
710
- "title": "document_id",
711
- "type": "string"
712
- }
713
- },
714
- "title": "GetDocumentRequest",
715
- "type": "object"
716
- },
717
- "GetDocumentResponse": {
718
- "additionalProperties": false,
719
- "description": "GetDocumentResponse contains the requested document.",
720
- "properties": {
721
- "document": {
722
- "$ref": "#/components/schemas/Document",
723
- "description": "The requested document.",
724
- "title": "document"
725
- }
726
- },
727
- "required": [
728
- "document"
729
- ],
730
- "title": "GetDocumentResponse",
731
- "type": "object"
732
- },
733
- "GetOrganizationRequest": {
734
- "additionalProperties": false,
735
- "description": "GetOrganizationRequest identifies an organization to retrieve.",
736
- "properties": {
737
- "organization_id": {
738
- "description": "Organization ID.\n Pattern: org_[0-9a-hjkmnp-tv-z]{26}",
739
- "pattern": "^org_[0-9a-hjkmnp-tv-z]{26}$",
740
- "title": "organization_id",
741
- "type": "string"
742
- }
743
- },
744
- "required": [
745
- "organization_id"
746
- ],
747
- "title": "GetOrganizationRequest",
748
- "type": "object"
749
- },
750
- "GetOrganizationResponse": {
751
- "additionalProperties": false,
752
- "description": "GetOrganizationResponse contains the requested organization.",
753
- "properties": {
754
- "organization": {
755
- "$ref": "#/components/schemas/Organization",
756
- "description": "The requested organization.",
757
- "title": "organization"
758
- }
759
- },
760
- "required": [
761
- "organization"
762
- ],
763
- "title": "GetOrganizationResponse",
764
- "type": "object"
765
- },
766
- "GetVersionRequest": {
767
- "additionalProperties": false,
768
- "description": "GetVersionRequest identifies a specific version to retrieve.",
769
- "properties": {
770
- "version_id": {
771
- "description": "Version ID to retrieve.\n Pattern: ver_[0-9a-hjkmnp-tv-z]{26}",
772
- "pattern": "^ver_[0-9a-hjkmnp-tv-z]{26}$",
773
- "title": "version_id",
774
- "type": "string"
775
- }
776
- },
777
- "title": "GetVersionRequest",
778
- "type": "object"
779
- },
780
- "ListApiKeysRequest": {
781
- "additionalProperties": false,
782
- "description": "ListApiKeysRequest specifies filters and pagination for listing API keys.",
783
- "properties": {
784
- "include_revoked": {
785
- "description": "Whether to include revoked keys in the response.\n Default: false (only active and expired-but-not-revoked keys are returned).\n When true, all keys including revoked ones are returned.\n Note: Expired keys are always included unless also revoked; use is_active to filter.",
786
- "title": "include_revoked",
787
- "type": "boolean"
788
- },
789
- "organization_id": {
790
- "description": "Organization ID to list keys for.\n Pattern: org_[0-9a-hjkmnp-tv-z]{26}",
791
- "pattern": "^org_[0-9a-hjkmnp-tv-z]{26}$",
792
- "title": "organization_id",
793
- "type": "string"
794
- },
795
- "page_size": {
796
- "description": "Maximum number of items to return per page (1-100). Default: 50.",
797
- "format": "int32",
798
- "maximum": 100,
799
- "minimum": 1,
800
- "nullable": true,
801
- "title": "page_size",
802
- "type": "integer"
803
- },
804
- "page_token": {
805
- "description": "Opaque pagination token from a previous response.",
806
- "title": "page_token",
807
- "type": "string"
808
- }
809
- },
810
- "required": [
811
- "organization_id"
812
- ],
813
- "title": "ListApiKeysRequest",
814
- "type": "object"
815
- },
816
- "ListApiKeysResponse": {
817
- "additionalProperties": false,
818
- "description": "ListApiKeysResponse contains a page of API keys.",
819
- "properties": {
820
- "items": {
821
- "description": "List of API keys (secrets are never included).",
822
- "items": {
823
- "$ref": "#/components/schemas/ApiKey"
824
- },
825
- "title": "items",
826
- "type": "array"
827
- },
828
- "pagination": {
829
- "$ref": "#/components/schemas/Pagination",
830
- "description": "Pagination metadata.",
831
- "title": "pagination"
832
- }
833
- },
834
- "required": [
835
- "pagination"
836
- ],
837
- "title": "ListApiKeysResponse",
838
- "type": "object"
839
- },
840
- "ListDocumentPoliciesRequest": {
841
- "additionalProperties": false,
842
- "description": "ListDocumentPoliciesRequest specifies pagination for listing document policies.\n Follows Google AIP-158 for pagination field naming.",
843
- "properties": {
844
- "document_id": {
845
- "description": "Document ID.\n Pattern: doc_[0-9a-hjkmnp-tv-z]{26}",
846
- "pattern": "^doc_[0-9a-hjkmnp-tv-z]{26}$",
847
- "title": "document_id",
848
- "type": "string"
849
- },
850
- "page_size": {
851
- "description": "Maximum number of items to return per page (1-100). Default: 50.",
852
- "format": "int32",
853
- "maximum": 100,
854
- "minimum": 1,
855
- "nullable": true,
856
- "title": "page_size",
857
- "type": "integer"
858
- },
859
- "page_token": {
860
- "description": "Opaque pagination token from a previous response.\n Pass next_page_token or prev_page_token from a previous response to continue pagination.\n Empty or omitted for the first page.",
861
- "example": "eyJpZCI6InBvbF8wMWgyeGNlanF0ZjJuYnJleHgzdnFqaHA0MSIsImQiOiJuZXh0IiwiZiI6eyJkb2NfaWQiOiJkb2NfMDFoMnhjZWpxdGYybmJyZXh4M3ZxamhwNDEifX0",
862
- "title": "page_token",
863
- "type": "string"
864
- }
865
- },
866
- "title": "ListDocumentPoliciesRequest",
867
- "type": "object"
868
- },
869
- "ListDocumentPoliciesResponse": {
870
- "additionalProperties": false,
871
- "description": "ListDocumentPoliciesResponse contains a page of policy attachments.",
872
- "properties": {
873
- "items": {
874
- "description": "List of policy attachments.",
875
- "items": {
876
- "$ref": "#/components/schemas/DocumentPolicy"
877
- },
878
- "title": "items",
879
- "type": "array"
880
- },
881
- "pagination": {
882
- "$ref": "#/components/schemas/Pagination",
883
- "description": "Pagination metadata.",
884
- "title": "pagination"
885
- }
886
- },
887
- "required": [
888
- "pagination"
889
- ],
890
- "title": "ListDocumentPoliciesResponse",
891
- "type": "object"
892
- },
893
- "ListDocumentsRequest": {
894
- "additionalProperties": false,
895
- "description": "ListDocumentsRequest specifies filters and pagination for listing documents.\n Follows Google AIP-158 for pagination field naming.\n Uses Vanguard-compatible dot notation for nested filters: ?created.after=...\u0026created.before=...\ncreated_time_range // created.after must be before created.before\n",
896
- "properties": {
897
- "access_level": {
898
- "description": "Filter by access level(s). Returns documents matching ANY of the specified levels.\n Accepts single value or comma-separated list.\n REST: ?access_level=private or ?access_level=private,organization\n Accepts clean enum names (case-insensitive): \"private\", \"organization\", \"public\"",
899
- "nullable": true,
900
- "title": "access_level",
901
- "type": "string"
902
- },
903
- "created": {
904
- "description": "Filter by creation time range.\n REST: ?created.after=2024-01-01T00:00:00Z\u0026created.before=2024-12-31T23:59:59Z",
905
- "format": "date-time",
906
- "nullable": true,
907
- "title": "created",
908
- "type": "string"
909
- },
910
- "created_by_id": {
911
- "description": "Filter by creator ID(s) (user or service account). Returns documents matching ANY of the specified IDs.\n Accepts single value or comma-separated list.\n REST: ?created_by_id=user_01h2xcejqtf2nbrexx3vqjhp41 or ?created_by_id=user_xxx,svc_yyy",
912
- "nullable": true,
913
- "title": "created_by_id",
914
- "type": "string"
915
- },
916
- "page_size": {
917
- "description": "Maximum number of items to return per page (1-100). Default: 50.",
918
- "format": "int32",
919
- "maximum": 100,
920
- "minimum": 1,
921
- "nullable": true,
922
- "title": "page_size",
923
- "type": "integer"
924
- },
925
- "page_token": {
926
- "description": "Opaque pagination token from a previous response.\n Pass next_page_token or prev_page_token from a previous response to continue pagination.\n Empty or omitted for the first page.",
927
- "example": "eyJpZCI6ImRvY18wMWgyeGNlanF0ZjJuYnJleHgzdnFqaHA0MSIsImQiOiJuZXh0In0",
928
- "title": "page_token",
929
- "type": "string"
930
- },
931
- "processing_status": {
932
- "description": "Filter by processing status(es). Returns documents matching ANY of the specified statuses.\n Accepts single value or comma-separated list.\n REST: ?processing_status=ready or ?processing_status=processing,ready,failed\n Accepts clean enum names (case-insensitive): \"processing\", \"ready\", \"failed\"",
933
- "nullable": true,
934
- "title": "processing_status",
935
- "type": "string"
936
- }
937
- },
938
- "title": "ListDocumentsRequest",
939
- "type": "object"
940
- },
941
- "ListDocumentsResponse": {
942
- "additionalProperties": false,
943
- "description": "ListDocumentsResponse contains a page of documents.",
944
- "properties": {
945
- "items": {
946
- "description": "List of documents.",
947
- "items": {
948
- "$ref": "#/components/schemas/Document"
949
- },
950
- "title": "items",
951
- "type": "array"
952
- },
953
- "pagination": {
954
- "$ref": "#/components/schemas/Pagination",
955
- "description": "Pagination metadata.",
956
- "title": "pagination"
957
- }
958
- },
959
- "required": [
960
- "pagination"
961
- ],
962
- "title": "ListDocumentsResponse",
963
- "type": "object"
964
- },
965
- "ListOrganizationsRequest": {
966
- "additionalProperties": false,
967
- "description": "ListOrganizationsRequest specifies pagination for listing organizations.",
968
- "properties": {
969
- "page_size": {
970
- "description": "Maximum number of items to return per page (1-100). Default: 50.",
971
- "format": "int32",
972
- "maximum": 100,
973
- "minimum": 1,
974
- "nullable": true,
975
- "title": "page_size",
976
- "type": "integer"
977
- },
978
- "page_token": {
979
- "description": "Opaque pagination token from a previous response.",
980
- "title": "page_token",
981
- "type": "string"
982
- }
983
- },
984
- "title": "ListOrganizationsRequest",
985
- "type": "object"
986
- },
987
- "ListOrganizationsResponse": {
988
- "additionalProperties": false,
989
- "description": "ListOrganizationsResponse contains a page of organizations.",
990
- "properties": {
991
- "items": {
992
- "description": "List of organizations.",
993
- "items": {
994
- "$ref": "#/components/schemas/Organization"
995
- },
996
- "title": "items",
997
- "type": "array"
998
- },
999
- "pagination": {
1000
- "$ref": "#/components/schemas/Pagination",
1001
- "description": "Pagination metadata.",
1002
- "title": "pagination"
1003
- }
1004
- },
1005
- "required": [
1006
- "pagination"
1007
- ],
1008
- "title": "ListOrganizationsResponse",
1009
- "type": "object"
1010
- },
1011
- "ListVersionsRequest": {
1012
- "additionalProperties": false,
1013
- "description": "ListVersionsRequest specifies filters and pagination for listing versions.\n Follows Google AIP-158 for pagination field naming.",
1014
- "properties": {
1015
- "document_id": {
1016
- "description": "Document ID to list versions for.\n Pattern: doc_[0-9a-hjkmnp-tv-z]{26}",
1017
- "pattern": "^doc_[0-9a-hjkmnp-tv-z]{26}$",
1018
- "title": "document_id",
1019
- "type": "string"
1020
- },
1021
- "page_size": {
1022
- "description": "Maximum number of items to return per page (1-100). Default: 50.",
1023
- "format": "int32",
1024
- "maximum": 100,
1025
- "minimum": 1,
1026
- "nullable": true,
1027
- "title": "page_size",
1028
- "type": "integer"
1029
- },
1030
- "page_token": {
1031
- "description": "Opaque pagination token from a previous response.\n Pass next_page_token or prev_page_token from a previous response to continue pagination.\n Empty or omitted for the first page.",
1032
- "example": "eyJpZCI6InZlcl8wMWgyYWJjZDEyMzRlZmdoNTY3OGprbW5wdCIsImQiOiJuZXh0IiwiZiI6eyJkb2NfaWQiOiJkb2NfMDFoMnhjZWpxdGYybmJyZXh4M3ZxamhwNDEifX0",
1033
- "title": "page_token",
1034
- "type": "string"
1035
- }
1036
- },
1037
- "title": "ListVersionsRequest",
1038
- "type": "object"
1039
- },
1040
- "ListVersionsResponse": {
1041
- "additionalProperties": false,
1042
- "description": "ListVersionsResponse contains a page of versions.",
1043
- "properties": {
1044
- "items": {
1045
- "description": "List of versions.",
1046
- "items": {
1047
- "$ref": "#/components/schemas/Version"
1048
- },
1049
- "title": "items",
1050
- "type": "array"
1051
- },
1052
- "pagination": {
1053
- "$ref": "#/components/schemas/Pagination",
1054
- "description": "Pagination metadata.",
1055
- "title": "pagination"
1056
- }
1057
- },
1058
- "required": [
1059
- "pagination"
1060
- ],
1061
- "title": "ListVersionsResponse",
1062
- "type": "object"
1063
- },
1064
- "Organization": {
1065
- "additionalProperties": false,
1066
- "description": "Organization represents a Factify organization.",
1067
- "properties": {
1068
- "created_at": {
1069
- "description": "Timestamp when the organization was created.",
1070
- "format": "date-time",
1071
- "title": "created_at",
1072
- "type": "string"
1073
- },
1074
- "id": {
1075
- "description": "Unique ID for the organization.\n Pattern: org_[0-9a-hjkmnp-tv-z]{26}",
1076
- "example": "org_01h2xcejqtf2nbrexx3vqjhp41",
1077
- "pattern": "^org_[0-9a-hjkmnp-tv-z]{26}$",
1078
- "title": "id",
1079
- "type": "string"
1080
- },
1081
- "name": {
1082
- "description": "Human-readable organization name.",
1083
- "example": "Acme Corporation",
1084
- "maxLength": 255,
1085
- "minLength": 1,
1086
- "title": "name",
1087
- "type": "string"
1088
- }
1089
- },
1090
- "required": [
1091
- "id",
1092
- "name",
1093
- "created_at"
1094
- ],
1095
- "title": "Organization",
1096
- "type": "object"
1097
- },
1098
- "Pagination": {
1099
- "additionalProperties": false,
1100
- "description": "Pagination contains cursor-based pagination metadata.\n Follows Google AIP-158 for pagination field naming.",
1101
- "properties": {
1102
- "has_more": {
1103
- "description": "Whether there are more results in the forward direction.",
1104
- "title": "has_more",
1105
- "type": "boolean"
1106
- },
1107
- "next_page_token": {
1108
- "description": "Token to retrieve the next page of results.\n Empty if there are no more results in the forward direction.",
1109
- "example": "eyJpZCI6ImRvY18wMWgyeGNlanF0ZjJuYnJleHgzdnFqaHA0MSIsImQiOiJuZXh0In0",
1110
- "title": "next_page_token",
1111
- "type": "string"
1112
- },
1113
- "prev_page_token": {
1114
- "description": "Token to retrieve the previous page of results.\n Empty if this is the first page.",
1115
- "example": "eyJpZCI6ImRvY18wMWgyeGNlanF0ZjJuYnJleHgzdnFqaHA0MSIsImQiOiJwcmV2In0",
1116
- "title": "prev_page_token",
1117
- "type": "string"
1118
- }
1119
- },
1120
- "title": "Pagination",
1121
- "type": "object"
1122
- },
1123
- "Policy": {
1124
- "additionalProperties": false,
1125
- "description": "Policy represents a governance policy.",
1126
- "properties": {
1127
- "created_at": {
1128
- "description": "Timestamp when policy was created.",
1129
- "format": "date-time",
1130
- "title": "created_at",
1131
- "type": "string"
1132
- },
1133
- "id": {
1134
- "description": "Unique ID for the policy.\n Pattern: pol_[0-9a-hjkmnp-tv-z]{26}",
1135
- "example": "pol_01h2xcejqtf2nbrexx3vqjhp41",
1136
- "pattern": "^pol_[0-9a-hjkmnp-tv-z]{26}$",
1137
- "title": "id",
1138
- "type": "string"
1139
- },
1140
- "name": {
1141
- "description": "Policy name.",
1142
- "example": "GDPR Compliance Policy",
1143
- "minLength": 1,
1144
- "title": "name",
1145
- "type": "string"
1146
- }
1147
- },
1148
- "required": [
1149
- "id",
1150
- "name",
1151
- "created_at"
1152
- ],
1153
- "title": "Policy",
1154
- "type": "object"
1155
- },
1156
- "ProcessingStatus": {
1157
- "enum": [
1158
- "processing",
1159
- "ready",
1160
- "failed"
1161
- ]
1162
- },
1163
- "RevokeApiKeyRequest": {
1164
- "additionalProperties": false,
1165
- "description": "RevokeApiKeyRequest identifies an API key to revoke.",
1166
- "properties": {
1167
- "api_key_id": {
1168
- "description": "API key ID to revoke.\n Pattern: key_[0-9a-hjkmnp-tv-z]{26}",
1169
- "pattern": "^key_[0-9a-hjkmnp-tv-z]{26}$",
1170
- "title": "api_key_id",
1171
- "type": "string"
1172
- },
1173
- "reason": {
1174
- "description": "Optional reason for revocation (for audit purposes).\n The revoking user's identity and timestamp are captured in audit logs separately.",
1175
- "maxLength": 500,
1176
- "minLength": 1,
1177
- "nullable": true,
1178
- "title": "reason",
1179
- "type": "string"
1180
- }
1181
- },
1182
- "required": [
1183
- "api_key_id"
1184
- ],
1185
- "title": "RevokeApiKeyRequest",
1186
- "type": "object"
1187
- },
1188
- "RevokeApiKeyResponse": {
1189
- "additionalProperties": false,
1190
- "description": "RevokeApiKeyResponse contains the revoked API key.",
1191
- "properties": {
1192
- "api_key": {
1193
- "$ref": "#/components/schemas/ApiKey",
1194
- "description": "The revoked API key with updated revoked_at timestamp.",
1195
- "title": "api_key"
1196
- }
1197
- },
1198
- "required": [
1199
- "api_key"
1200
- ],
1201
- "title": "RevokeApiKeyResponse",
1202
- "type": "object"
1203
- },
1204
- "TimestampFilter": {
1205
- "additionalProperties": false,
1206
- "description": "TimestampFilter specifies a time range for filtering.\n Used with Vanguard dot notation: ?created.after=...\u0026created.before=...",
1207
- "properties": {
1208
- "after": {
1209
- "description": "Return results after this timestamp (inclusive).",
1210
- "format": "date-time",
1211
- "nullable": true,
1212
- "title": "after",
1213
- "type": "string"
1214
- },
1215
- "before": {
1216
- "description": "Return results before this timestamp (inclusive).",
1217
- "format": "date-time",
1218
- "nullable": true,
1219
- "title": "before",
1220
- "type": "string"
1221
- }
1222
- },
1223
- "title": "TimestampFilter",
1224
- "type": "object"
1225
- },
1226
- "UpdateDocumentRequest": {
1227
- "additionalProperties": false,
1228
- "description": "UpdateDocumentRequest specifies fields to update on a document.",
1229
- "properties": {
1230
- "description": {
1231
- "description": "New description (max 2000 characters).",
1232
- "maxLength": 2000,
1233
- "nullable": true,
1234
- "title": "description",
1235
- "type": "string"
1236
- },
1237
- "document_id": {
1238
- "description": "Document ID to update.\n Pattern: doc_[0-9a-hjkmnp-tv-z]{26}",
1239
- "pattern": "^doc_[0-9a-hjkmnp-tv-z]{26}$",
1240
- "title": "document_id",
1241
- "type": "string"
1242
- },
1243
- "title": {
1244
- "description": "New title (1-255 characters).",
1245
- "maxLength": 255,
1246
- "minLength": 1,
1247
- "nullable": true,
1248
- "title": "title",
1249
- "type": "string"
1250
- }
1251
- },
1252
- "title": "UpdateDocumentRequest",
1253
- "type": "object"
1254
- },
1255
- "UpdateDocumentResponse": {
1256
- "additionalProperties": false,
1257
- "description": "UpdateDocumentResponse contains the updated document.",
1258
- "properties": {
1259
- "document": {
1260
- "$ref": "#/components/schemas/Document",
1261
- "description": "The updated document.",
1262
- "title": "document"
1263
- }
1264
- },
1265
- "required": [
1266
- "document"
1267
- ],
1268
- "title": "UpdateDocumentResponse",
1269
- "type": "object"
1270
- },
1271
- "UpdateVersionRequest": {
1272
- "additionalProperties": false,
1273
- "description": "UpdateVersionRequest specifies fields to update on a version.",
1274
- "properties": {
1275
- "description": {
1276
- "description": "New description.",
1277
- "nullable": true,
1278
- "title": "description",
1279
- "type": "string"
1280
- },
1281
- "title": {
1282
- "description": "New title (max 255 characters).",
1283
- "maxLength": 255,
1284
- "nullable": true,
1285
- "title": "title",
1286
- "type": "string"
1287
- },
1288
- "version_id": {
1289
- "description": "Version ID to update.\n Pattern: ver_[0-9a-hjkmnp-tv-z]{26}",
1290
- "pattern": "^ver_[0-9a-hjkmnp-tv-z]{26}$",
1291
- "title": "version_id",
1292
- "type": "string"
1293
- }
1294
- },
1295
- "title": "UpdateVersionRequest",
1296
- "type": "object"
1297
- },
1298
- "User": {
1299
- "additionalProperties": false,
1300
- "description": "User represents a user or service account.",
1301
- "properties": {
1302
- "id": {
1303
- "description": "Unique ID for the user or service account.\n Pattern: user_[0-9a-hjkmnp-tv-z]{26} for users, svc_[0-9a-hjkmnp-tv-z]{26} for service accounts",
1304
- "example": "user_01h2xcejqtf2nbrexx3vqjhp41",
1305
- "pattern": "^(user|svc)_[0-9a-hjkmnp-tv-z]{26}$",
1306
- "title": "id",
1307
- "type": "string"
1308
- },
1309
- "name": {
1310
- "description": "Display name of the user or service account.",
1311
- "example": "John Doe",
1312
- "minLength": 1,
1313
- "title": "name",
1314
- "type": "string"
1315
- },
1316
- "type": {
1317
- "$ref": "#/components/schemas/UserType",
1318
- "description": "User type discriminator.",
1319
- "title": "type"
1320
- }
1321
- },
1322
- "required": [
1323
- "id",
1324
- "type",
1325
- "name"
1326
- ],
1327
- "title": "User",
1328
- "type": "object"
1329
- },
1330
- "UserType": {
1331
- "enum": [
1332
- "user_account",
1333
- "service_account"
1334
- ]
1335
- },
1336
- "Version": {
1337
- "additionalProperties": false,
1338
- "description": "Version represents a document version.",
1339
- "properties": {
1340
- "created_at": {
1341
- "description": "Timestamp when version was created.",
1342
- "format": "date-time",
1343
- "title": "created_at",
1344
- "type": "string"
1345
- },
1346
- "created_by": {
1347
- "$ref": "#/components/schemas/User",
1348
- "description": "User who created the version.",
1349
- "title": "created_by"
1350
- },
1351
- "description": {
1352
- "description": "Description of changes in this version.",
1353
- "nullable": true,
1354
- "title": "description",
1355
- "type": "string"
1356
- },
1357
- "document_id": {
1358
- "description": "Parent document ID.\n Pattern: doc_[0-9a-hjkmnp-tv-z]{26}",
1359
- "example": "doc_01h2xcejqtf2nbrexx3vqjhp41",
1360
- "pattern": "^doc_[0-9a-hjkmnp-tv-z]{26}$",
1361
- "title": "document_id",
1362
- "type": "string"
1363
- },
1364
- "id": {
1365
- "description": "Unique ID for the version.\n Pattern: ver_[0-9a-hjkmnp-tv-z]{26}",
1366
- "example": "ver_01h2abcd1234efgh5678jkmnpt",
1367
- "pattern": "^ver_[0-9a-hjkmnp-tv-z]{26}$",
1368
- "title": "id",
1369
- "type": "string"
1370
- },
1371
- "processing_status": {
1372
- "$ref": "#/components/schemas/ProcessingStatus",
1373
- "description": "Processing status.",
1374
- "title": "processing_status"
1375
- },
1376
- "title": {
1377
- "description": "Optional version title.",
1378
- "example": "Version 2.0",
1379
- "maxLength": 255,
1380
- "nullable": true,
1381
- "title": "title",
1382
- "type": "string"
1383
- },
1384
- "url": {
1385
- "description": "URL for accessing this version on Factify.",
1386
- "example": "https://d.factify.com/d/01h2xcejqtf2nbrexx3vqjhp41/v/1",
1387
- "format": "uri",
1388
- "title": "url",
1389
- "type": "string"
1390
- }
1391
- },
1392
- "required": [
1393
- "id",
1394
- "document_id",
1395
- "url",
1396
- "processing_status",
1397
- "created_at",
1398
- "created_by"
1399
- ],
1400
- "title": "Version",
1401
- "type": "object"
1402
- },
1403
- "VersionRef": {
1404
- "additionalProperties": false,
1405
- "description": "VersionRef is a lightweight reference to a version.",
1406
- "properties": {
1407
- "id": {
1408
- "description": "Version ID.\n Pattern: ver_[0-9a-hjkmnp-tv-z]{26}",
1409
- "example": "ver_01h2abcd1234efgh5678jkmnpt",
1410
- "pattern": "^ver_[0-9a-hjkmnp-tv-z]{26}$",
1411
- "title": "id",
1412
- "type": "string"
1413
- }
1414
- },
1415
- "required": [
1416
- "id"
1417
- ],
1418
- "title": "VersionRef",
1419
- "type": "object"
1420
- }
1421
- },
1422
- "securitySchemes": {
1423
- "bearerAuth": {
1424
- "bearerFormat": "API Key",
1425
- "description": "Bearer authentication header of the form Bearer \u003ctoken\u003e, where \u003ctoken\u003e is your auth token.",
1426
- "scheme": "bearer",
1427
- "type": "http"
1428
- }
1429
- }
1430
- },
1431
- "info": {
1432
- "contact": {
1433
- "email": "api@factify.com",
1434
- "name": "Factify API Support",
1435
- "url": "https://factify.com/support"
1436
- },
1437
- "description": "Factify API enables you to create, manage, and control access to legally-binding documents that replace PDFs.\n\n## Authentication\n\nBearer authentication header of the form Bearer \u003ctoken\u003e, where \u003ctoken\u003e is your auth token.\n\n```\nAuthorization: Bearer ffy...\n```\n\n## Rate Limiting\n\n- 1000 requests per minute per API key\n- 100 requests per minute for resource creation (POST)\n\n## Errors\n\nFactify uses conventional HTTP status codes and returns structured error responses:\n\n```json\n{\n \"error\": {\n \"type\": \"invalid_request_error\",\n \"message\": \"Document title cannot be empty\",\n \"param\": \"title\",\n \"code\": \"missing_required_field\"\n }\n}\n```\n",
1438
- "license": {
1439
- "name": "Proprietary",
1440
- "url": "https://factify.com/terms"
1441
- },
1442
- "title": "Factify API",
1443
- "version": "1.0.0"
1444
- },
1445
- "openapi": "3.1.0",
1446
- "paths": {
1447
- "/v1beta/api-keys": {
1448
- "get": {
1449
- "description": "Lists API keys for an organization.",
1450
- "operationId": "listApiKeys",
1451
- "parameters": [
1452
- {
1453
- "description": "Organization ID to list keys for.\n Pattern: org_[0-9a-hjkmnp-tv-z]{26}",
1454
- "in": "query",
1455
- "name": "organization_id",
1456
- "required": true,
1457
- "schema": {
1458
- "description": "Organization ID to list keys for.\n Pattern: org_[0-9a-hjkmnp-tv-z]{26}",
1459
- "pattern": "^org_[0-9a-hjkmnp-tv-z]{26}$",
1460
- "title": "organization_id",
1461
- "type": "string"
1462
- }
1463
- },
1464
- {
1465
- "description": "Whether to include revoked keys in the response.\n Default: false (only active and expired-but-not-revoked keys are returned).\n When true, all keys including revoked ones are returned.\n Note: Expired keys are always included unless also revoked; use is_active to filter.",
1466
- "in": "query",
1467
- "name": "include_revoked",
1468
- "schema": {
1469
- "description": "Whether to include revoked keys in the response.\n Default: false (only active and expired-but-not-revoked keys are returned).\n When true, all keys including revoked ones are returned.\n Note: Expired keys are always included unless also revoked; use is_active to filter.",
1470
- "title": "include_revoked",
1471
- "type": "boolean"
1472
- }
1473
- },
1474
- {
1475
- "description": "Opaque pagination token from a previous response.",
1476
- "in": "query",
1477
- "name": "page_token",
1478
- "schema": {
1479
- "description": "Opaque pagination token from a previous response.",
1480
- "title": "page_token",
1481
- "type": "string"
1482
- }
1483
- },
1484
- {
1485
- "description": "Maximum number of items to return per page (1-100). Default: 50.",
1486
- "in": "query",
1487
- "name": "page_size",
1488
- "schema": {
1489
- "description": "Maximum number of items to return per page (1-100). Default: 50.",
1490
- "format": "int32",
1491
- "maximum": 100,
1492
- "minimum": 1,
1493
- "title": "page_size",
1494
- "type": "integer"
1495
- }
1496
- }
1497
- ],
1498
- "responses": {
1499
- "200": {
1500
- "content": {
1501
- "application/json": {
1502
- "schema": {
1503
- "$ref": "#/components/schemas/ListApiKeysResponse"
1504
- }
1505
- }
1506
- },
1507
- "description": "Success"
1508
- },
1509
- "400": {
1510
- "$ref": "#/components/responses/BadRequest"
1511
- },
1512
- "401": {
1513
- "$ref": "#/components/responses/Unauthorized"
1514
- },
1515
- "403": {
1516
- "$ref": "#/components/responses/Forbidden"
1517
- },
1518
- "404": {
1519
- "$ref": "#/components/responses/NotFound"
1520
- },
1521
- "429": {
1522
- "$ref": "#/components/responses/RateLimitExceeded"
1523
- },
1524
- "500": {
1525
- "$ref": "#/components/responses/InternalServerError"
1526
- }
1527
- },
1528
- "summary": "List API keys",
1529
- "tags": [
1530
- "API Keys"
1531
- ],
1532
- "x-speakeasy-pagination": {
1533
- "inputs": [
1534
- {
1535
- "in": "parameters",
1536
- "name": "page_token",
1537
- "type": "cursor"
1538
- }
1539
- ],
1540
- "outputs": {
1541
- "nextCursor": "$.pagination.next_page_token"
1542
- },
1543
- "type": "cursor"
1544
- },
1545
- "x-speakeasy-name-override": "list",
1546
- "x-codeSamples": [
1547
- {
1548
- "lang": "typescript",
1549
- "label": "listApiKeys",
1550
- "source": "import { Factify } from \"@factify/sdk\";\n\nconst factify = new Factify({\n bearerAuth: \"\u003cYOUR_BEARER_TOKEN_HERE\u003e\",\n});\n\nasync function run() {\n const result = await factify.apiKeys.list({\n organizationId: \"\u003cid\u003e\",\n });\n\n for await (const page of result) {\n console.log(page);\n }\n}\n\nrun();"
1551
- }
1552
- ]
1553
- },
1554
- "post": {
1555
- "description": "Creates a new API key for the specified organization. The secret is only returned once in the response and cannot be retrieved later.",
1556
- "operationId": "createApiKey",
1557
- "requestBody": {
1558
- "content": {
1559
- "application/json": {
1560
- "schema": {
1561
- "$ref": "#/components/schemas/CreateApiKeyRequest"
1562
- }
1563
- }
1564
- },
1565
- "required": true
1566
- },
1567
- "responses": {
1568
- "200": {
1569
- "content": {
1570
- "application/json": {
1571
- "schema": {
1572
- "$ref": "#/components/schemas/CreateApiKeyResponse"
1573
- }
1574
- }
1575
- },
1576
- "description": "Success"
1577
- },
1578
- "400": {
1579
- "$ref": "#/components/responses/BadRequest"
1580
- },
1581
- "401": {
1582
- "$ref": "#/components/responses/Unauthorized"
1583
- },
1584
- "403": {
1585
- "$ref": "#/components/responses/Forbidden"
1586
- },
1587
- "404": {
1588
- "$ref": "#/components/responses/NotFound"
1589
- },
1590
- "429": {
1591
- "$ref": "#/components/responses/RateLimitExceeded"
1592
- },
1593
- "500": {
1594
- "$ref": "#/components/responses/InternalServerError"
1595
- }
1596
- },
1597
- "summary": "Create an API key",
1598
- "tags": [
1599
- "API Keys"
1600
- ],
1601
- "x-speakeasy-name-override": "create",
1602
- "x-codeSamples": [
1603
- {
1604
- "lang": "typescript",
1605
- "label": "createApiKey",
1606
- "source": "import { Factify } from \"@factify/sdk\";\n\nconst factify = new Factify({\n bearerAuth: \"\u003cYOUR_BEARER_TOKEN_HERE\u003e\",\n});\n\nasync function run() {\n const result = await factify.apiKeys.create({\n name: \"\u003cvalue\u003e\",\n organizationId: \"\u003cid\u003e\",\n });\n\n console.log(result);\n}\n\nrun();"
1607
- }
1608
- ]
1609
- }
1610
- },
1611
- "/v1beta/api-keys/{api_key_id}/revoke": {
1612
- "post": {
1613
- "description": "Revokes an API key, immediately preventing it from being used for authentication.",
1614
- "operationId": "revokeApiKey",
1615
- "parameters": [
1616
- {
1617
- "description": "API key ID to revoke.\n Pattern: key_[0-9a-hjkmnp-tv-z]{26}",
1618
- "in": "path",
1619
- "name": "api_key_id",
1620
- "required": true,
1621
- "schema": {
1622
- "description": "API key ID to revoke.\n Pattern: key_[0-9a-hjkmnp-tv-z]{26}",
1623
- "pattern": "^key_[0-9a-hjkmnp-tv-z]{26}$",
1624
- "title": "api_key_id",
1625
- "type": "string"
1626
- }
1627
- }
1628
- ],
1629
- "requestBody": {
1630
- "content": {
1631
- "application/json": {
1632
- "schema": {
1633
- "additionalProperties": false,
1634
- "description": "RevokeApiKeyRequest identifies an API key to revoke.",
1635
- "properties": {
1636
- "reason": {
1637
- "description": "Optional reason for revocation (for audit purposes).\n The revoking user's identity and timestamp are captured in audit logs separately.",
1638
- "maxLength": 500,
1639
- "minLength": 1,
1640
- "nullable": true,
1641
- "title": "reason",
1642
- "type": "string"
1643
- }
1644
- },
1645
- "required": [],
1646
- "title": "RevokeApiKeyRequest",
1647
- "type": "object"
1648
- }
1649
- }
1650
- },
1651
- "required": true
1652
- },
1653
- "responses": {
1654
- "200": {
1655
- "content": {
1656
- "application/json": {
1657
- "schema": {
1658
- "$ref": "#/components/schemas/RevokeApiKeyResponse"
1659
- }
1660
- }
1661
- },
1662
- "description": "Success"
1663
- },
1664
- "400": {
1665
- "$ref": "#/components/responses/BadRequest"
1666
- },
1667
- "401": {
1668
- "$ref": "#/components/responses/Unauthorized"
1669
- },
1670
- "403": {
1671
- "$ref": "#/components/responses/Forbidden"
1672
- },
1673
- "404": {
1674
- "$ref": "#/components/responses/NotFound"
1675
- },
1676
- "429": {
1677
- "$ref": "#/components/responses/RateLimitExceeded"
1678
- },
1679
- "500": {
1680
- "$ref": "#/components/responses/InternalServerError"
1681
- }
1682
- },
1683
- "summary": "Revoke an API key",
1684
- "tags": [
1685
- "API Keys"
1686
- ],
1687
- "x-speakeasy-name-override": "revoke",
1688
- "x-codeSamples": [
1689
- {
1690
- "lang": "typescript",
1691
- "label": "revokeApiKey",
1692
- "source": "import { Factify } from \"@factify/sdk\";\n\nconst factify = new Factify({\n bearerAuth: \"\u003cYOUR_BEARER_TOKEN_HERE\u003e\",\n});\n\nasync function run() {\n const result = await factify.apiKeys.revoke({\n apiKeyId: \"\u003cid\u003e\",\n body: {},\n });\n\n console.log(result);\n}\n\nrun();"
1693
- }
1694
- ]
1695
- }
1696
- },
1697
- "/v1beta/documents": {
1698
- "get": {
1699
- "description": "List documents with cursor-based pagination.",
1700
- "operationId": "listDocuments",
1701
- "parameters": [
1702
- {
1703
- "description": "Opaque pagination token from a previous response.\n Pass next_page_token or prev_page_token from a previous response to continue pagination.\n Empty or omitted for the first page.",
1704
- "in": "query",
1705
- "name": "page_token",
1706
- "schema": {
1707
- "description": "Opaque pagination token from a previous response.\n Pass next_page_token or prev_page_token from a previous response to continue pagination.\n Empty or omitted for the first page.",
1708
- "example": "eyJpZCI6ImRvY18wMWgyeGNlanF0ZjJuYnJleHgzdnFqaHA0MSIsImQiOiJuZXh0In0",
1709
- "title": "page_token",
1710
- "type": "string"
1711
- }
1712
- },
1713
- {
1714
- "description": "Maximum number of items to return per page (1-100). Default: 50.",
1715
- "in": "query",
1716
- "name": "page_size",
1717
- "schema": {
1718
- "description": "Maximum number of items to return per page (1-100). Default: 50.",
1719
- "format": "int32",
1720
- "maximum": 100,
1721
- "minimum": 1,
1722
- "title": "page_size",
1723
- "type": "integer"
1724
- }
1725
- },
1726
- {
1727
- "description": "Filter by creator ID(s). Returns documents matching ANY of the specified IDs.",
1728
- "explode": false,
1729
- "in": "query",
1730
- "name": "created_by_id",
1731
- "required": false,
1732
- "schema": {
1733
- "items": {
1734
- "description": "User or service account TypeID (e.g., user_xxx, svc_yyy)",
1735
- "type": "string"
1736
- },
1737
- "type": "array"
1738
- },
1739
- "style": "form"
1740
- },
1741
- {
1742
- "description": "Filter by access level(s). Returns documents matching ANY of the specified levels.",
1743
- "explode": false,
1744
- "in": "query",
1745
- "name": "access_level",
1746
- "required": false,
1747
- "schema": {
1748
- "items": {
1749
- "description": "Access level",
1750
- "enum": [
1751
- "private",
1752
- "organization",
1753
- "public"
1754
- ],
1755
- "type": "string"
1756
- },
1757
- "type": "array"
1758
- },
1759
- "style": "form"
1760
- },
1761
- {
1762
- "description": "Filter by processing status(es). Returns documents matching ANY of the specified statuses.",
1763
- "explode": false,
1764
- "in": "query",
1765
- "name": "processing_status",
1766
- "required": false,
1767
- "schema": {
1768
- "items": {
1769
- "description": "Processing status",
1770
- "enum": [
1771
- "processing",
1772
- "ready",
1773
- "failed"
1774
- ],
1775
- "type": "string"
1776
- },
1777
- "type": "array"
1778
- },
1779
- "style": "form"
1780
- },
1781
- {
1782
- "description": "Filter by created.after (RFC 3339 format, e.g., 2024-01-15T09:30:00Z)",
1783
- "in": "query",
1784
- "name": "created.after",
1785
- "schema": {
1786
- "format": "date-time",
1787
- "type": "string"
1788
- }
1789
- }
1790
- ],
1791
- "responses": {
1792
- "200": {
1793
- "content": {
1794
- "application/json": {
1795
- "schema": {
1796
- "$ref": "#/components/schemas/ListDocumentsResponse"
1797
- }
1798
- }
1799
- },
1800
- "description": "Success"
1801
- },
1802
- "400": {
1803
- "$ref": "#/components/responses/BadRequest"
1804
- },
1805
- "401": {
1806
- "$ref": "#/components/responses/Unauthorized"
1807
- },
1808
- "403": {
1809
- "$ref": "#/components/responses/Forbidden"
1810
- },
1811
- "404": {
1812
- "$ref": "#/components/responses/NotFound"
1813
- },
1814
- "429": {
1815
- "$ref": "#/components/responses/RateLimitExceeded"
1816
- },
1817
- "500": {
1818
- "$ref": "#/components/responses/InternalServerError"
1819
- }
1820
- },
1821
- "summary": "List documents",
1822
- "tags": [
1823
- "Documents"
1824
- ],
1825
- "x-speakeasy-pagination": {
1826
- "inputs": [
1827
- {
1828
- "in": "parameters",
1829
- "name": "page_token",
1830
- "type": "cursor"
1831
- }
1832
- ],
1833
- "outputs": {
1834
- "nextCursor": "$.pagination.next_page_token"
1835
- },
1836
- "type": "cursor"
1837
- },
1838
- "x-speakeasy-name-override": "list",
1839
- "x-codeSamples": [
1840
- {
1841
- "lang": "typescript",
1842
- "label": "listDocuments",
1843
- "source": "import { Factify } from \"@factify/sdk\";\n\nconst factify = new Factify({\n bearerAuth: \"\u003cYOUR_BEARER_TOKEN_HERE\u003e\",\n});\n\nasync function run() {\n const result = await factify.documents.list({\n pageToken: \"eyJpZCI6ImRvY18wMWgyeGNlanF0ZjJuYnJleHgzdnFqaHA0MSIsImQiOiJuZXh0In0\",\n });\n\n for await (const page of result) {\n console.log(page);\n }\n}\n\nrun();"
1844
- }
1845
- ]
1846
- },
1847
- "post": {
1848
- "description": "Creates a new document by uploading a PDF file.",
1849
- "operationId": "createDocument",
1850
- "requestBody": {
1851
- "content": {
1852
- "multipart/form-data": {
1853
- "schema": {
1854
- "$ref": "#/components/schemas/CreateDocumentRequest"
1855
- }
1856
- }
1857
- },
1858
- "required": true
1859
- },
1860
- "responses": {
1861
- "200": {
1862
- "content": {
1863
- "application/json": {
1864
- "schema": {
1865
- "$ref": "#/components/schemas/CreateDocumentResponse"
1866
- }
1867
- }
1868
- },
1869
- "description": "Success"
1870
- },
1871
- "400": {
1872
- "$ref": "#/components/responses/BadRequest"
1873
- },
1874
- "401": {
1875
- "$ref": "#/components/responses/Unauthorized"
1876
- },
1877
- "403": {
1878
- "$ref": "#/components/responses/Forbidden"
1879
- },
1880
- "404": {
1881
- "$ref": "#/components/responses/NotFound"
1882
- },
1883
- "429": {
1884
- "$ref": "#/components/responses/RateLimitExceeded"
1885
- },
1886
- "500": {
1887
- "$ref": "#/components/responses/InternalServerError"
1888
- }
1889
- },
1890
- "summary": "Create a document",
1891
- "tags": [
1892
- "Documents"
1893
- ],
1894
- "x-speakeasy-name-override": "create",
1895
- "x-codeSamples": [
1896
- {
1897
- "lang": "typescript",
1898
- "label": "createDocument",
1899
- "source": "import { Factify } from \"@factify/sdk\";\nimport { openAsBlob } from \"node:fs\";\n\nconst factify = new Factify({\n bearerAuth: \"\u003cYOUR_BEARER_TOKEN_HERE\u003e\",\n});\n\nasync function run() {\n const result = await factify.documents.create({\n payload: await openAsBlob(\"example.file\"),\n title: \"\u003cvalue\u003e\",\n });\n\n console.log(result);\n}\n\nrun();"
1900
- }
1901
- ]
1902
- }
1903
- },
1904
- "/v1beta/documents/{document_id}": {
1905
- "get": {
1906
- "description": "Retrieve a document by ID.",
1907
- "operationId": "getDocument",
1908
- "parameters": [
1909
- {
1910
- "description": "Document ID.\n Pattern: doc_[0-9a-hjkmnp-tv-z]{26}",
1911
- "in": "path",
1912
- "name": "document_id",
1913
- "required": true,
1914
- "schema": {
1915
- "description": "Document ID.\n Pattern: doc_[0-9a-hjkmnp-tv-z]{26}",
1916
- "pattern": "^doc_[0-9a-hjkmnp-tv-z]{26}$",
1917
- "title": "document_id",
1918
- "type": "string"
1919
- }
1920
- }
1921
- ],
1922
- "responses": {
1923
- "200": {
1924
- "content": {
1925
- "application/json": {
1926
- "schema": {
1927
- "$ref": "#/components/schemas/GetDocumentResponse"
1928
- }
1929
- }
1930
- },
1931
- "description": "Success"
1932
- },
1933
- "400": {
1934
- "$ref": "#/components/responses/BadRequest"
1935
- },
1936
- "401": {
1937
- "$ref": "#/components/responses/Unauthorized"
1938
- },
1939
- "403": {
1940
- "$ref": "#/components/responses/Forbidden"
1941
- },
1942
- "404": {
1943
- "$ref": "#/components/responses/NotFound"
1944
- },
1945
- "429": {
1946
- "$ref": "#/components/responses/RateLimitExceeded"
1947
- },
1948
- "500": {
1949
- "$ref": "#/components/responses/InternalServerError"
1950
- }
1951
- },
1952
- "summary": "Retrieve a document",
1953
- "tags": [
1954
- "Documents"
1955
- ],
1956
- "x-speakeasy-name-override": "get",
1957
- "x-codeSamples": [
1958
- {
1959
- "lang": "typescript",
1960
- "label": "getDocument",
1961
- "source": "import { Factify } from \"@factify/sdk\";\n\nconst factify = new Factify({\n bearerAuth: \"\u003cYOUR_BEARER_TOKEN_HERE\u003e\",\n});\n\nasync function run() {\n const result = await factify.documents.get({\n documentId: \"\u003cid\u003e\",\n });\n\n console.log(result);\n}\n\nrun();"
1962
- }
1963
- ]
1964
- },
1965
- "patch": {
1966
- "description": "Update document title and description.",
1967
- "operationId": "updateDocument",
1968
- "parameters": [
1969
- {
1970
- "description": "Document ID to update.\n Pattern: doc_[0-9a-hjkmnp-tv-z]{26}",
1971
- "in": "path",
1972
- "name": "document_id",
1973
- "required": true,
1974
- "schema": {
1975
- "description": "Document ID to update.\n Pattern: doc_[0-9a-hjkmnp-tv-z]{26}",
1976
- "pattern": "^doc_[0-9a-hjkmnp-tv-z]{26}$",
1977
- "title": "document_id",
1978
- "type": "string"
1979
- }
1980
- }
1981
- ],
1982
- "requestBody": {
1983
- "content": {
1984
- "application/json": {
1985
- "schema": {
1986
- "additionalProperties": false,
1987
- "description": "UpdateDocumentRequest specifies fields to update on a document.",
1988
- "properties": {
1989
- "description": {
1990
- "description": "New description (max 2000 characters).",
1991
- "maxLength": 2000,
1992
- "nullable": true,
1993
- "title": "description",
1994
- "type": "string"
1995
- },
1996
- "title": {
1997
- "description": "New title (1-255 characters).",
1998
- "maxLength": 255,
1999
- "minLength": 1,
2000
- "nullable": true,
2001
- "title": "title",
2002
- "type": "string"
2003
- }
2004
- },
2005
- "title": "UpdateDocumentRequest",
2006
- "type": "object"
2007
- }
2008
- }
2009
- },
2010
- "required": true
2011
- },
2012
- "responses": {
2013
- "200": {
2014
- "content": {
2015
- "application/json": {
2016
- "schema": {
2017
- "$ref": "#/components/schemas/UpdateDocumentResponse"
2018
- }
2019
- }
2020
- },
2021
- "description": "Success"
2022
- },
2023
- "400": {
2024
- "$ref": "#/components/responses/BadRequest"
2025
- },
2026
- "401": {
2027
- "$ref": "#/components/responses/Unauthorized"
2028
- },
2029
- "403": {
2030
- "$ref": "#/components/responses/Forbidden"
2031
- },
2032
- "404": {
2033
- "$ref": "#/components/responses/NotFound"
2034
- },
2035
- "429": {
2036
- "$ref": "#/components/responses/RateLimitExceeded"
2037
- },
2038
- "500": {
2039
- "$ref": "#/components/responses/InternalServerError"
2040
- }
2041
- },
2042
- "summary": "Update a document",
2043
- "tags": [
2044
- "Documents"
2045
- ],
2046
- "x-speakeasy-name-override": "update",
2047
- "x-codeSamples": [
2048
- {
2049
- "lang": "typescript",
2050
- "label": "updateDocument",
2051
- "source": "import { Factify } from \"@factify/sdk\";\n\nconst factify = new Factify({\n bearerAuth: \"\u003cYOUR_BEARER_TOKEN_HERE\u003e\",\n});\n\nasync function run() {\n const result = await factify.documents.update({\n documentId: \"\u003cid\u003e\",\n body: {},\n });\n\n console.log(result);\n}\n\nrun();"
2052
- }
2053
- ]
2054
- }
2055
- },
2056
- "/v1beta/documents/{document_id}/entry_page": {
2057
- "post": {
2058
- "description": "Generate and return a temporary downloadable URL for the document entry page PDF.",
2059
- "operationId": "generateDocumentEntryPage",
2060
- "parameters": [
2061
- {
2062
- "description": "Document ID.\n Pattern: doc_[0-9a-hjkmnp-tv-z]{26}",
2063
- "in": "path",
2064
- "name": "document_id",
2065
- "required": true,
2066
- "schema": {
2067
- "description": "Document ID.\n Pattern: doc_[0-9a-hjkmnp-tv-z]{26}",
2068
- "pattern": "^doc_[0-9a-hjkmnp-tv-z]{26}$",
2069
- "title": "document_id",
2070
- "type": "string"
2071
- }
2072
- }
2073
- ],
2074
- "responses": {
2075
- "200": {
2076
- "content": {
2077
- "application/json": {
2078
- "schema": {
2079
- "$ref": "#/components/schemas/GenerateEntryPageResponse"
2080
- }
2081
- }
2082
- },
2083
- "description": "Success"
2084
- },
2085
- "400": {
2086
- "$ref": "#/components/responses/BadRequest"
2087
- },
2088
- "401": {
2089
- "$ref": "#/components/responses/Unauthorized"
2090
- },
2091
- "403": {
2092
- "$ref": "#/components/responses/Forbidden"
2093
- },
2094
- "404": {
2095
- "$ref": "#/components/responses/NotFound"
2096
- },
2097
- "429": {
2098
- "$ref": "#/components/responses/RateLimitExceeded"
2099
- },
2100
- "500": {
2101
- "$ref": "#/components/responses/InternalServerError"
2102
- }
2103
- },
2104
- "summary": "Generate entry page",
2105
- "tags": [
2106
- "Sharing \u0026 Distribution"
2107
- ],
2108
- "x-speakeasy-group": "entryPages",
2109
- "x-speakeasy-name-override": "generate",
2110
- "x-codeSamples": [
2111
- {
2112
- "lang": "typescript",
2113
- "label": "generateDocumentEntryPage",
2114
- "source": "import { Factify } from \"@factify/sdk\";\n\nconst factify = new Factify({\n bearerAuth: \"\u003cYOUR_BEARER_TOKEN_HERE\u003e\",\n});\n\nasync function run() {\n const result = await factify.entryPages.generate({\n documentId: \"\u003cid\u003e\",\n });\n\n console.log(result);\n}\n\nrun();"
2115
- }
2116
- ]
2117
- }
2118
- },
2119
- "/v1beta/documents/{document_id}/policies": {
2120
- "get": {
2121
- "description": "List policies attached to a document.",
2122
- "operationId": "listDocumentPolicies",
2123
- "parameters": [
2124
- {
2125
- "description": "Document ID.\n Pattern: doc_[0-9a-hjkmnp-tv-z]{26}",
2126
- "in": "path",
2127
- "name": "document_id",
2128
- "required": true,
2129
- "schema": {
2130
- "description": "Document ID.\n Pattern: doc_[0-9a-hjkmnp-tv-z]{26}",
2131
- "pattern": "^doc_[0-9a-hjkmnp-tv-z]{26}$",
2132
- "title": "document_id",
2133
- "type": "string"
2134
- }
2135
- },
2136
- {
2137
- "description": "Opaque pagination token from a previous response.\n Pass next_page_token or prev_page_token from a previous response to continue pagination.\n Empty or omitted for the first page.",
2138
- "in": "query",
2139
- "name": "page_token",
2140
- "schema": {
2141
- "description": "Opaque pagination token from a previous response.\n Pass next_page_token or prev_page_token from a previous response to continue pagination.\n Empty or omitted for the first page.",
2142
- "example": "eyJpZCI6InBvbF8wMWgyeGNlanF0ZjJuYnJleHgzdnFqaHA0MSIsImQiOiJuZXh0IiwiZiI6eyJkb2NfaWQiOiJkb2NfMDFoMnhjZWpxdGYybmJyZXh4M3ZxamhwNDEifX0",
2143
- "title": "page_token",
2144
- "type": "string"
2145
- }
2146
- },
2147
- {
2148
- "description": "Maximum number of items to return per page (1-100). Default: 50.",
2149
- "in": "query",
2150
- "name": "page_size",
2151
- "schema": {
2152
- "description": "Maximum number of items to return per page (1-100). Default: 50.",
2153
- "format": "int32",
2154
- "maximum": 100,
2155
- "minimum": 1,
2156
- "title": "page_size",
2157
- "type": "integer"
2158
- }
2159
- }
2160
- ],
2161
- "responses": {
2162
- "200": {
2163
- "content": {
2164
- "application/json": {
2165
- "schema": {
2166
- "$ref": "#/components/schemas/ListDocumentPoliciesResponse"
2167
- }
2168
- }
2169
- },
2170
- "description": "Success"
2171
- },
2172
- "400": {
2173
- "$ref": "#/components/responses/BadRequest"
2174
- },
2175
- "401": {
2176
- "$ref": "#/components/responses/Unauthorized"
2177
- },
2178
- "403": {
2179
- "$ref": "#/components/responses/Forbidden"
2180
- },
2181
- "404": {
2182
- "$ref": "#/components/responses/NotFound"
2183
- },
2184
- "429": {
2185
- "$ref": "#/components/responses/RateLimitExceeded"
2186
- },
2187
- "500": {
2188
- "$ref": "#/components/responses/InternalServerError"
2189
- }
2190
- },
2191
- "summary": "List document policies",
2192
- "tags": [
2193
- "Policies"
2194
- ],
2195
- "x-speakeasy-pagination": {
2196
- "inputs": [
2197
- {
2198
- "in": "parameters",
2199
- "name": "page_token",
2200
- "type": "cursor"
2201
- }
2202
- ],
2203
- "outputs": {
2204
- "nextCursor": "$.pagination.next_page_token"
2205
- },
2206
- "type": "cursor"
2207
- },
2208
- "x-speakeasy-name-override": "list",
2209
- "x-codeSamples": [
2210
- {
2211
- "lang": "typescript",
2212
- "label": "listDocumentPolicies",
2213
- "source": "import { Factify } from \"@factify/sdk\";\n\nconst factify = new Factify({\n bearerAuth: \"\u003cYOUR_BEARER_TOKEN_HERE\u003e\",\n});\n\nasync function run() {\n const result = await factify.policies.list({\n documentId: \"\u003cid\u003e\",\n pageToken: \"eyJpZCI6InBvbF8wMWgyeGNlanF0ZjJuYnJleHgzdnFqaHA0MSIsImQiOiJuZXh0IiwiZiI6eyJkb2NfaWQiOiJkb2NfMDFoMnhjZWpxdGYybmJyZXh4M3ZxamhwNDEifX0\",\n });\n\n for await (const page of result) {\n console.log(page);\n }\n}\n\nrun();"
2214
- }
2215
- ]
2216
- },
2217
- "post": {
2218
- "description": "Attach a policy to a document.",
2219
- "operationId": "attachDocumentPolicy",
2220
- "parameters": [
2221
- {
2222
- "description": "Document ID.\n Pattern: doc_[0-9a-hjkmnp-tv-z]{26}",
2223
- "in": "path",
2224
- "name": "document_id",
2225
- "required": true,
2226
- "schema": {
2227
- "description": "Document ID.\n Pattern: doc_[0-9a-hjkmnp-tv-z]{26}",
2228
- "pattern": "^doc_[0-9a-hjkmnp-tv-z]{26}$",
2229
- "title": "document_id",
2230
- "type": "string"
2231
- }
2232
- }
2233
- ],
2234
- "requestBody": {
2235
- "content": {
2236
- "application/json": {
2237
- "schema": {
2238
- "additionalProperties": false,
2239
- "description": "AttachPolicyRequest specifies a policy to attach to a document.",
2240
- "properties": {
2241
- "policy_id": {
2242
- "description": "Policy ID to attach.\n Pattern: pol_[0-9a-hjkmnp-tv-z]{26}",
2243
- "pattern": "^pol_[0-9a-hjkmnp-tv-z]{26}$",
2244
- "title": "policy_id",
2245
- "type": "string"
2246
- }
2247
- },
2248
- "required": [
2249
- "policy_id"
2250
- ],
2251
- "title": "AttachPolicyRequest",
2252
- "type": "object"
2253
- }
2254
- }
2255
- },
2256
- "required": true
2257
- },
2258
- "responses": {
2259
- "200": {
2260
- "content": {
2261
- "application/json": {
2262
- "schema": {
2263
- "$ref": "#/components/schemas/DocumentPolicy"
2264
- }
2265
- }
2266
- },
2267
- "description": "Success"
2268
- },
2269
- "400": {
2270
- "$ref": "#/components/responses/BadRequest"
2271
- },
2272
- "401": {
2273
- "$ref": "#/components/responses/Unauthorized"
2274
- },
2275
- "403": {
2276
- "$ref": "#/components/responses/Forbidden"
2277
- },
2278
- "404": {
2279
- "$ref": "#/components/responses/NotFound"
2280
- },
2281
- "429": {
2282
- "$ref": "#/components/responses/RateLimitExceeded"
2283
- },
2284
- "500": {
2285
- "$ref": "#/components/responses/InternalServerError"
2286
- }
2287
- },
2288
- "summary": "Attach a policy",
2289
- "tags": [
2290
- "Policies"
2291
- ],
2292
- "x-speakeasy-name-override": "attach",
2293
- "x-codeSamples": [
2294
- {
2295
- "lang": "typescript",
2296
- "label": "attachDocumentPolicy",
2297
- "source": "import { Factify } from \"@factify/sdk\";\n\nconst factify = new Factify({\n bearerAuth: \"\u003cYOUR_BEARER_TOKEN_HERE\u003e\",\n});\n\nasync function run() {\n const result = await factify.policies.attach({\n documentId: \"\u003cid\u003e\",\n body: {\n policyId: \"\u003cid\u003e\",\n },\n });\n\n console.log(result);\n}\n\nrun();"
2298
- }
2299
- ]
2300
- }
2301
- },
2302
- "/v1beta/documents/{document_id}/policies/{policy_id}": {
2303
- "delete": {
2304
- "description": "Detach a policy from a document.",
2305
- "operationId": "detachDocumentPolicy",
2306
- "parameters": [
2307
- {
2308
- "description": "Document ID.\n Pattern: doc_[0-9a-hjkmnp-tv-z]{26}",
2309
- "in": "path",
2310
- "name": "document_id",
2311
- "required": true,
2312
- "schema": {
2313
- "description": "Document ID.\n Pattern: doc_[0-9a-hjkmnp-tv-z]{26}",
2314
- "pattern": "^doc_[0-9a-hjkmnp-tv-z]{26}$",
2315
- "title": "document_id",
2316
- "type": "string"
2317
- }
2318
- },
2319
- {
2320
- "description": "Policy ID to detach.\n Pattern: pol_[0-9a-hjkmnp-tv-z]{26}",
2321
- "in": "path",
2322
- "name": "policy_id",
2323
- "required": true,
2324
- "schema": {
2325
- "description": "Policy ID to detach.\n Pattern: pol_[0-9a-hjkmnp-tv-z]{26}",
2326
- "pattern": "^pol_[0-9a-hjkmnp-tv-z]{26}$",
2327
- "title": "policy_id",
2328
- "type": "string"
2329
- }
2330
- }
2331
- ],
2332
- "responses": {
2333
- "200": {
2334
- "content": {
2335
- "application/json": {
2336
- "schema": {
2337
- "$ref": "#/components/schemas/Empty"
2338
- }
2339
- }
2340
- },
2341
- "description": "Success"
2342
- },
2343
- "400": {
2344
- "$ref": "#/components/responses/BadRequest"
2345
- },
2346
- "401": {
2347
- "$ref": "#/components/responses/Unauthorized"
2348
- },
2349
- "403": {
2350
- "$ref": "#/components/responses/Forbidden"
2351
- },
2352
- "404": {
2353
- "$ref": "#/components/responses/NotFound"
2354
- },
2355
- "429": {
2356
- "$ref": "#/components/responses/RateLimitExceeded"
2357
- },
2358
- "500": {
2359
- "$ref": "#/components/responses/InternalServerError"
2360
- }
2361
- },
2362
- "summary": "Detach a policy",
2363
- "tags": [
2364
- "Policies"
2365
- ],
2366
- "x-speakeasy-name-override": "detach",
2367
- "x-codeSamples": [
2368
- {
2369
- "lang": "typescript",
2370
- "label": "detachDocumentPolicy",
2371
- "source": "import { Factify } from \"@factify/sdk\";\n\nconst factify = new Factify({\n bearerAuth: \"\u003cYOUR_BEARER_TOKEN_HERE\u003e\",\n});\n\nasync function run() {\n const result = await factify.policies.detach({\n documentId: \"\u003cid\u003e\",\n policyId: \"\u003cid\u003e\",\n });\n\n console.log(result);\n}\n\nrun();"
2372
- }
2373
- ]
2374
- }
2375
- },
2376
- "/v1beta/documents/{document_id}/versions": {
2377
- "get": {
2378
- "description": "List versions for a document with cursor-based pagination.",
2379
- "operationId": "listDocumentVersions",
2380
- "parameters": [
2381
- {
2382
- "description": "Document ID to list versions for.\n Pattern: doc_[0-9a-hjkmnp-tv-z]{26}",
2383
- "in": "path",
2384
- "name": "document_id",
2385
- "required": true,
2386
- "schema": {
2387
- "description": "Document ID to list versions for.\n Pattern: doc_[0-9a-hjkmnp-tv-z]{26}",
2388
- "pattern": "^doc_[0-9a-hjkmnp-tv-z]{26}$",
2389
- "title": "document_id",
2390
- "type": "string"
2391
- }
2392
- },
2393
- {
2394
- "description": "Opaque pagination token from a previous response.\n Pass next_page_token or prev_page_token from a previous response to continue pagination.\n Empty or omitted for the first page.",
2395
- "in": "query",
2396
- "name": "page_token",
2397
- "schema": {
2398
- "description": "Opaque pagination token from a previous response.\n Pass next_page_token or prev_page_token from a previous response to continue pagination.\n Empty or omitted for the first page.",
2399
- "example": "eyJpZCI6InZlcl8wMWgyYWJjZDEyMzRlZmdoNTY3OGprbW5wdCIsImQiOiJuZXh0IiwiZiI6eyJkb2NfaWQiOiJkb2NfMDFoMnhjZWpxdGYybmJyZXh4M3ZxamhwNDEifX0",
2400
- "title": "page_token",
2401
- "type": "string"
2402
- }
2403
- },
2404
- {
2405
- "description": "Maximum number of items to return per page (1-100). Default: 50.",
2406
- "in": "query",
2407
- "name": "page_size",
2408
- "schema": {
2409
- "description": "Maximum number of items to return per page (1-100). Default: 50.",
2410
- "format": "int32",
2411
- "maximum": 100,
2412
- "minimum": 1,
2413
- "title": "page_size",
2414
- "type": "integer"
2415
- }
2416
- }
2417
- ],
2418
- "responses": {
2419
- "200": {
2420
- "content": {
2421
- "application/json": {
2422
- "schema": {
2423
- "$ref": "#/components/schemas/ListVersionsResponse"
2424
- }
2425
- }
2426
- },
2427
- "description": "Success"
2428
- },
2429
- "400": {
2430
- "$ref": "#/components/responses/BadRequest"
2431
- },
2432
- "401": {
2433
- "$ref": "#/components/responses/Unauthorized"
2434
- },
2435
- "403": {
2436
- "$ref": "#/components/responses/Forbidden"
2437
- },
2438
- "404": {
2439
- "$ref": "#/components/responses/NotFound"
2440
- },
2441
- "429": {
2442
- "$ref": "#/components/responses/RateLimitExceeded"
2443
- },
2444
- "500": {
2445
- "$ref": "#/components/responses/InternalServerError"
2446
- }
2447
- },
2448
- "summary": "List document versions",
2449
- "tags": [
2450
- "Versions"
2451
- ],
2452
- "x-speakeasy-pagination": {
2453
- "inputs": [
2454
- {
2455
- "in": "parameters",
2456
- "name": "page_token",
2457
- "type": "cursor"
2458
- }
2459
- ],
2460
- "outputs": {
2461
- "nextCursor": "$.pagination.next_page_token"
2462
- },
2463
- "type": "cursor"
2464
- },
2465
- "x-speakeasy-name-override": "list",
2466
- "x-codeSamples": [
2467
- {
2468
- "lang": "typescript",
2469
- "label": "listDocumentVersions",
2470
- "source": "import { Factify } from \"@factify/sdk\";\n\nconst factify = new Factify({\n bearerAuth: \"\u003cYOUR_BEARER_TOKEN_HERE\u003e\",\n});\n\nasync function run() {\n const result = await factify.versions.list({\n documentId: \"\u003cid\u003e\",\n pageToken: \"eyJpZCI6InZlcl8wMWgyYWJjZDEyMzRlZmdoNTY3OGprbW5wdCIsImQiOiJuZXh0IiwiZiI6eyJkb2NfaWQiOiJkb2NfMDFoMnhjZWpxdGYybmJyZXh4M3ZxamhwNDEifX0\",\n });\n\n for await (const page of result) {\n console.log(page);\n }\n}\n\nrun();"
2471
- }
2472
- ]
2473
- },
2474
- "post": {
2475
- "description": "Creates a new version by uploading a PDF file.",
2476
- "operationId": "createDocumentVersion",
2477
- "parameters": [
2478
- {
2479
- "description": "Document ID to create version for.\n Pattern: doc_[0-9a-hjkmnp-tv-z]{26}",
2480
- "in": "path",
2481
- "name": "document_id",
2482
- "required": true,
2483
- "schema": {
2484
- "description": "Document ID to create version for.\n Pattern: doc_[0-9a-hjkmnp-tv-z]{26}",
2485
- "pattern": "^doc_[0-9a-hjkmnp-tv-z]{26}$",
2486
- "title": "document_id",
2487
- "type": "string"
2488
- }
2489
- }
2490
- ],
2491
- "requestBody": {
2492
- "content": {
2493
- "multipart/form-data": {
2494
- "schema": {
2495
- "$ref": "#/components/schemas/CreateVersionRequest"
2496
- }
2497
- }
2498
- },
2499
- "required": true
2500
- },
2501
- "responses": {
2502
- "200": {
2503
- "content": {
2504
- "application/json": {
2505
- "schema": {
2506
- "$ref": "#/components/schemas/Version"
2507
- }
2508
- }
2509
- },
2510
- "description": "Success"
2511
- },
2512
- "400": {
2513
- "$ref": "#/components/responses/BadRequest"
2514
- },
2515
- "401": {
2516
- "$ref": "#/components/responses/Unauthorized"
2517
- },
2518
- "403": {
2519
- "$ref": "#/components/responses/Forbidden"
2520
- },
2521
- "404": {
2522
- "$ref": "#/components/responses/NotFound"
2523
- },
2524
- "429": {
2525
- "$ref": "#/components/responses/RateLimitExceeded"
2526
- },
2527
- "500": {
2528
- "$ref": "#/components/responses/InternalServerError"
2529
- }
2530
- },
2531
- "summary": "Create a new version",
2532
- "tags": [
2533
- "Versions"
2534
- ],
2535
- "x-speakeasy-name-override": "create",
2536
- "x-codeSamples": [
2537
- {
2538
- "lang": "typescript",
2539
- "label": "createDocumentVersion",
2540
- "source": "import { Factify } from \"@factify/sdk\";\nimport { openAsBlob } from \"node:fs\";\n\nconst factify = new Factify({\n bearerAuth: \"\u003cYOUR_BEARER_TOKEN_HERE\u003e\",\n});\n\nasync function run() {\n const result = await factify.versions.create({\n documentId: \"\u003cid\u003e\",\n body: {\n payload: await openAsBlob(\"example.file\"),\n },\n });\n\n console.log(result);\n}\n\nrun();"
2541
- }
2542
- ]
2543
- }
2544
- },
2545
- "/v1beta/organizations": {
2546
- "get": {
2547
- "description": "List organizations the caller has access to.",
2548
- "operationId": "listOrganizations",
2549
- "parameters": [
2550
- {
2551
- "description": "Opaque pagination token from a previous response.",
2552
- "in": "query",
2553
- "name": "page_token",
2554
- "schema": {
2555
- "description": "Opaque pagination token from a previous response.",
2556
- "title": "page_token",
2557
- "type": "string"
2558
- }
2559
- },
2560
- {
2561
- "description": "Maximum number of items to return per page (1-100). Default: 50.",
2562
- "in": "query",
2563
- "name": "page_size",
2564
- "schema": {
2565
- "description": "Maximum number of items to return per page (1-100). Default: 50.",
2566
- "format": "int32",
2567
- "maximum": 100,
2568
- "minimum": 1,
2569
- "title": "page_size",
2570
- "type": "integer"
2571
- }
2572
- }
2573
- ],
2574
- "responses": {
2575
- "200": {
2576
- "content": {
2577
- "application/json": {
2578
- "schema": {
2579
- "$ref": "#/components/schemas/ListOrganizationsResponse"
2580
- }
2581
- }
2582
- },
2583
- "description": "Success"
2584
- },
2585
- "400": {
2586
- "$ref": "#/components/responses/BadRequest"
2587
- },
2588
- "401": {
2589
- "$ref": "#/components/responses/Unauthorized"
2590
- },
2591
- "403": {
2592
- "$ref": "#/components/responses/Forbidden"
2593
- },
2594
- "404": {
2595
- "$ref": "#/components/responses/NotFound"
2596
- },
2597
- "429": {
2598
- "$ref": "#/components/responses/RateLimitExceeded"
2599
- },
2600
- "500": {
2601
- "$ref": "#/components/responses/InternalServerError"
2602
- }
2603
- },
2604
- "summary": "List organizations",
2605
- "tags": [
2606
- "Organizations"
2607
- ],
2608
- "x-speakeasy-pagination": {
2609
- "inputs": [
2610
- {
2611
- "in": "parameters",
2612
- "name": "page_token",
2613
- "type": "cursor"
2614
- }
2615
- ],
2616
- "outputs": {
2617
- "nextCursor": "$.pagination.next_page_token"
2618
- },
2619
- "type": "cursor"
2620
- },
2621
- "x-speakeasy-name-override": "list",
2622
- "x-codeSamples": [
2623
- {
2624
- "lang": "typescript",
2625
- "label": "listOrganizations",
2626
- "source": "import { Factify } from \"@factify/sdk\";\n\nconst factify = new Factify({\n bearerAuth: \"\u003cYOUR_BEARER_TOKEN_HERE\u003e\",\n});\n\nasync function run() {\n const result = await factify.organizations.list();\n\n for await (const page of result) {\n console.log(page);\n }\n}\n\nrun();"
2627
- }
2628
- ]
2629
- },
2630
- "post": {
2631
- "description": "Creates a new organization. The authenticated user becomes the organization owner.",
2632
- "operationId": "createOrganization",
2633
- "requestBody": {
2634
- "content": {
2635
- "application/json": {
2636
- "schema": {
2637
- "$ref": "#/components/schemas/CreateOrganizationRequest"
2638
- }
2639
- }
2640
- },
2641
- "required": true
2642
- },
2643
- "responses": {
2644
- "200": {
2645
- "content": {
2646
- "application/json": {
2647
- "schema": {
2648
- "$ref": "#/components/schemas/CreateOrganizationResponse"
2649
- }
2650
- }
2651
- },
2652
- "description": "Success"
2653
- },
2654
- "400": {
2655
- "$ref": "#/components/responses/BadRequest"
2656
- },
2657
- "401": {
2658
- "$ref": "#/components/responses/Unauthorized"
2659
- },
2660
- "403": {
2661
- "$ref": "#/components/responses/Forbidden"
2662
- },
2663
- "404": {
2664
- "$ref": "#/components/responses/NotFound"
2665
- },
2666
- "429": {
2667
- "$ref": "#/components/responses/RateLimitExceeded"
2668
- },
2669
- "500": {
2670
- "$ref": "#/components/responses/InternalServerError"
2671
- }
2672
- },
2673
- "summary": "Create an organization",
2674
- "tags": [
2675
- "Organizations"
2676
- ],
2677
- "x-speakeasy-name-override": "create",
2678
- "x-codeSamples": [
2679
- {
2680
- "lang": "typescript",
2681
- "label": "createOrganization",
2682
- "source": "import { Factify } from \"@factify/sdk\";\n\nconst factify = new Factify({\n bearerAuth: \"\u003cYOUR_BEARER_TOKEN_HERE\u003e\",\n});\n\nasync function run() {\n const result = await factify.organizations.create({\n name: \"\u003cvalue\u003e\",\n });\n\n console.log(result);\n}\n\nrun();"
2683
- }
2684
- ]
2685
- }
2686
- },
2687
- "/v1beta/organizations/{organization_id}": {
2688
- "get": {
2689
- "description": "Retrieve an organization by ID.",
2690
- "operationId": "getOrganization",
2691
- "parameters": [
2692
- {
2693
- "description": "Organization ID.\n Pattern: org_[0-9a-hjkmnp-tv-z]{26}",
2694
- "in": "path",
2695
- "name": "organization_id",
2696
- "required": true,
2697
- "schema": {
2698
- "description": "Organization ID.\n Pattern: org_[0-9a-hjkmnp-tv-z]{26}",
2699
- "pattern": "^org_[0-9a-hjkmnp-tv-z]{26}$",
2700
- "title": "organization_id",
2701
- "type": "string"
2702
- }
2703
- }
2704
- ],
2705
- "responses": {
2706
- "200": {
2707
- "content": {
2708
- "application/json": {
2709
- "schema": {
2710
- "$ref": "#/components/schemas/GetOrganizationResponse"
2711
- }
2712
- }
2713
- },
2714
- "description": "Success"
2715
- },
2716
- "400": {
2717
- "$ref": "#/components/responses/BadRequest"
2718
- },
2719
- "401": {
2720
- "$ref": "#/components/responses/Unauthorized"
2721
- },
2722
- "403": {
2723
- "$ref": "#/components/responses/Forbidden"
2724
- },
2725
- "404": {
2726
- "$ref": "#/components/responses/NotFound"
2727
- },
2728
- "429": {
2729
- "$ref": "#/components/responses/RateLimitExceeded"
2730
- },
2731
- "500": {
2732
- "$ref": "#/components/responses/InternalServerError"
2733
- }
2734
- },
2735
- "summary": "Retrieve an organization",
2736
- "tags": [
2737
- "Organizations"
2738
- ],
2739
- "x-speakeasy-name-override": "get",
2740
- "x-codeSamples": [
2741
- {
2742
- "lang": "typescript",
2743
- "label": "getOrganization",
2744
- "source": "import { Factify } from \"@factify/sdk\";\n\nconst factify = new Factify({\n bearerAuth: \"\u003cYOUR_BEARER_TOKEN_HERE\u003e\",\n});\n\nasync function run() {\n const result = await factify.organizations.get({\n organizationId: \"\u003cid\u003e\",\n });\n\n console.log(result);\n}\n\nrun();"
2745
- }
2746
- ]
2747
- }
2748
- },
2749
- "/v1beta/versions/{version_id}": {
2750
- "get": {
2751
- "description": "Retrieve a specific version by ID.",
2752
- "operationId": "getVersion",
2753
- "parameters": [
2754
- {
2755
- "description": "Version ID to retrieve.\n Pattern: ver_[0-9a-hjkmnp-tv-z]{26}",
2756
- "in": "path",
2757
- "name": "version_id",
2758
- "required": true,
2759
- "schema": {
2760
- "description": "Version ID to retrieve.\n Pattern: ver_[0-9a-hjkmnp-tv-z]{26}",
2761
- "pattern": "^ver_[0-9a-hjkmnp-tv-z]{26}$",
2762
- "title": "version_id",
2763
- "type": "string"
2764
- }
2765
- }
2766
- ],
2767
- "responses": {
2768
- "200": {
2769
- "content": {
2770
- "application/json": {
2771
- "schema": {
2772
- "$ref": "#/components/schemas/Version"
2773
- }
2774
- }
2775
- },
2776
- "description": "Success"
2777
- },
2778
- "400": {
2779
- "$ref": "#/components/responses/BadRequest"
2780
- },
2781
- "401": {
2782
- "$ref": "#/components/responses/Unauthorized"
2783
- },
2784
- "403": {
2785
- "$ref": "#/components/responses/Forbidden"
2786
- },
2787
- "404": {
2788
- "$ref": "#/components/responses/NotFound"
2789
- },
2790
- "429": {
2791
- "$ref": "#/components/responses/RateLimitExceeded"
2792
- },
2793
- "500": {
2794
- "$ref": "#/components/responses/InternalServerError"
2795
- }
2796
- },
2797
- "summary": "Retrieve a version",
2798
- "tags": [
2799
- "Versions"
2800
- ],
2801
- "x-speakeasy-name-override": "get",
2802
- "x-codeSamples": [
2803
- {
2804
- "lang": "typescript",
2805
- "label": "getVersion",
2806
- "source": "import { Factify } from \"@factify/sdk\";\n\nconst factify = new Factify({\n bearerAuth: \"\u003cYOUR_BEARER_TOKEN_HERE\u003e\",\n});\n\nasync function run() {\n const result = await factify.versions.get({\n versionId: \"\u003cid\u003e\",\n });\n\n console.log(result);\n}\n\nrun();"
2807
- }
2808
- ]
2809
- },
2810
- "patch": {
2811
- "description": "Update version title and description.",
2812
- "operationId": "updateVersion",
2813
- "parameters": [
2814
- {
2815
- "description": "Version ID to update.\n Pattern: ver_[0-9a-hjkmnp-tv-z]{26}",
2816
- "in": "path",
2817
- "name": "version_id",
2818
- "required": true,
2819
- "schema": {
2820
- "description": "Version ID to update.\n Pattern: ver_[0-9a-hjkmnp-tv-z]{26}",
2821
- "pattern": "^ver_[0-9a-hjkmnp-tv-z]{26}$",
2822
- "title": "version_id",
2823
- "type": "string"
2824
- }
2825
- }
2826
- ],
2827
- "requestBody": {
2828
- "content": {
2829
- "application/json": {
2830
- "schema": {
2831
- "additionalProperties": false,
2832
- "description": "UpdateVersionRequest specifies fields to update on a version.",
2833
- "properties": {
2834
- "description": {
2835
- "description": "New description.",
2836
- "nullable": true,
2837
- "title": "description",
2838
- "type": "string"
2839
- },
2840
- "title": {
2841
- "description": "New title (max 255 characters).",
2842
- "maxLength": 255,
2843
- "nullable": true,
2844
- "title": "title",
2845
- "type": "string"
2846
- }
2847
- },
2848
- "title": "UpdateVersionRequest",
2849
- "type": "object"
2850
- }
2851
- }
2852
- },
2853
- "required": true
2854
- },
2855
- "responses": {
2856
- "200": {
2857
- "content": {
2858
- "application/json": {
2859
- "schema": {
2860
- "$ref": "#/components/schemas/Version"
2861
- }
2862
- }
2863
- },
2864
- "description": "Success"
2865
- },
2866
- "400": {
2867
- "$ref": "#/components/responses/BadRequest"
2868
- },
2869
- "401": {
2870
- "$ref": "#/components/responses/Unauthorized"
2871
- },
2872
- "403": {
2873
- "$ref": "#/components/responses/Forbidden"
2874
- },
2875
- "404": {
2876
- "$ref": "#/components/responses/NotFound"
2877
- },
2878
- "429": {
2879
- "$ref": "#/components/responses/RateLimitExceeded"
2880
- },
2881
- "500": {
2882
- "$ref": "#/components/responses/InternalServerError"
2883
- }
2884
- },
2885
- "summary": "Update a version",
2886
- "tags": [
2887
- "Versions"
2888
- ],
2889
- "x-speakeasy-name-override": "update",
2890
- "x-codeSamples": [
2891
- {
2892
- "lang": "typescript",
2893
- "label": "updateVersion",
2894
- "source": "import { Factify } from \"@factify/sdk\";\n\nconst factify = new Factify({\n bearerAuth: \"\u003cYOUR_BEARER_TOKEN_HERE\u003e\",\n});\n\nasync function run() {\n const result = await factify.versions.update({\n versionId: \"\u003cid\u003e\",\n body: {},\n });\n\n console.log(result);\n}\n\nrun();"
2895
- }
2896
- ]
2897
- }
2898
- }
2899
- },
2900
- "security": [
2901
- {
2902
- "bearerAuth": []
2903
- }
2904
- ],
2905
- "servers": [
2906
- {
2907
- "description": "Production",
2908
- "url": "https://api.factify.com"
2909
- },
2910
- {
2911
- "description": "Development (internal only)",
2912
- "url": "https://api.factify-dev.com"
2913
- }
2914
- ],
2915
- "tags": [
2916
- {
2917
- "description": "Create, retrieve, update, and manage documents.",
2918
- "name": "Documents"
2919
- },
2920
- {
2921
- "description": "Manage document versions and version history.",
2922
- "name": "Versions"
2923
- },
2924
- {
2925
- "description": "Create and manage organizations.",
2926
- "name": "Organizations"
2927
- },
2928
- {
2929
- "description": "Generate and manage API keys for authentication.",
2930
- "name": "API Keys"
2931
- },
2932
- {
2933
- "description": "Attach and manage access policies for documents.",
2934
- "name": "Policies"
2935
- },
2936
- {
2937
- "description": "Generate shareable entry pages for documents.",
2938
- "name": "Sharing \u0026 Distribution"
2939
- }
2940
- ]
2941
- }