@epilot/sdk 2.4.2 → 2.4.4-alpha.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (364) hide show
  1. package/README.md +1 -0
  2. package/definitions/app-runtime.json +1 -1
  3. package/definitions/app.json +346 -10
  4. package/definitions/automation.json +42 -0
  5. package/definitions/calendar-runtime.json +1 -0
  6. package/definitions/calendar.json +675 -0
  7. package/definitions/customer-portal.json +29 -0
  8. package/definitions/notes.json +175 -130
  9. package/definitions/pricing-runtime.json +1 -1
  10. package/definitions/pricing.json +163 -84
  11. package/dist/README-46VYEGGW.js +7 -0
  12. package/dist/README-IVBISSWB.cjs +7 -0
  13. package/dist/{_index-HE4B6FOA.js → _index-5FB6F5YY.js} +3 -0
  14. package/dist/{_index-55HAH24D.cjs → _index-DB2VV4PQ.cjs} +4 -1
  15. package/dist/apis/_registry.d.ts +8 -0
  16. package/dist/apis/access-token.cjs +6 -6
  17. package/dist/apis/access-token.d.ts +9 -12
  18. package/dist/apis/access-token.js +1 -1
  19. package/dist/apis/address-suggestions.cjs +6 -6
  20. package/dist/apis/address-suggestions.d.ts +9 -12
  21. package/dist/apis/address-suggestions.js +1 -1
  22. package/dist/apis/address.cjs +6 -6
  23. package/dist/apis/address.d.ts +9 -12
  24. package/dist/apis/address.js +1 -1
  25. package/dist/apis/ai-agents.cjs +6 -6
  26. package/dist/apis/ai-agents.d.ts +9 -12
  27. package/dist/apis/ai-agents.js +1 -1
  28. package/dist/apis/app.cjs +6 -6
  29. package/dist/apis/app.d.ts +9 -12
  30. package/dist/apis/app.js +1 -1
  31. package/dist/apis/audit-logs.cjs +6 -6
  32. package/dist/apis/audit-logs.d.ts +9 -12
  33. package/dist/apis/audit-logs.js +1 -1
  34. package/dist/apis/automation.cjs +6 -6
  35. package/dist/apis/automation.d.ts +9 -12
  36. package/dist/apis/automation.js +1 -1
  37. package/dist/apis/billing.cjs +6 -6
  38. package/dist/apis/billing.d.ts +9 -12
  39. package/dist/apis/billing.js +1 -1
  40. package/dist/apis/blueprint-manifest.cjs +6 -6
  41. package/dist/apis/blueprint-manifest.d.ts +9 -12
  42. package/dist/apis/blueprint-manifest.js +1 -1
  43. package/dist/apis/calendar.cjs +38 -0
  44. package/dist/apis/calendar.d.ts +15 -0
  45. package/dist/apis/calendar.js +38 -0
  46. package/dist/apis/configuration-hub.cjs +6 -6
  47. package/dist/apis/configuration-hub.d.ts +9 -12
  48. package/dist/apis/configuration-hub.js +1 -1
  49. package/dist/apis/consent.cjs +6 -6
  50. package/dist/apis/consent.d.ts +9 -12
  51. package/dist/apis/consent.js +1 -1
  52. package/dist/apis/customer-portal.cjs +6 -6
  53. package/dist/apis/customer-portal.d.ts +9 -12
  54. package/dist/apis/customer-portal.js +1 -1
  55. package/dist/apis/dashboard.cjs +6 -6
  56. package/dist/apis/dashboard.d.ts +9 -12
  57. package/dist/apis/dashboard.js +1 -1
  58. package/dist/apis/data-governance.cjs +6 -6
  59. package/dist/apis/data-governance.d.ts +9 -12
  60. package/dist/apis/data-governance.js +1 -1
  61. package/dist/apis/deduplication.cjs +6 -6
  62. package/dist/apis/deduplication.d.ts +9 -12
  63. package/dist/apis/deduplication.js +1 -1
  64. package/dist/apis/design.cjs +6 -6
  65. package/dist/apis/design.d.ts +9 -12
  66. package/dist/apis/design.js +1 -1
  67. package/dist/apis/document.cjs +6 -6
  68. package/dist/apis/document.d.ts +9 -12
  69. package/dist/apis/document.js +1 -1
  70. package/dist/apis/email-settings.cjs +6 -6
  71. package/dist/apis/email-settings.d.ts +9 -12
  72. package/dist/apis/email-settings.js +1 -1
  73. package/dist/apis/email-template.cjs +6 -6
  74. package/dist/apis/email-template.d.ts +9 -12
  75. package/dist/apis/email-template.js +1 -1
  76. package/dist/apis/entity-mapping.cjs +6 -6
  77. package/dist/apis/entity-mapping.d.ts +9 -12
  78. package/dist/apis/entity-mapping.js +1 -1
  79. package/dist/apis/entity.cjs +6 -6
  80. package/dist/apis/entity.d.ts +9 -12
  81. package/dist/apis/entity.js +1 -1
  82. package/dist/apis/environments.cjs +6 -6
  83. package/dist/apis/environments.d.ts +9 -12
  84. package/dist/apis/environments.js +1 -1
  85. package/dist/apis/event-catalog.cjs +6 -6
  86. package/dist/apis/event-catalog.d.ts +9 -12
  87. package/dist/apis/event-catalog.js +1 -1
  88. package/dist/apis/file.cjs +6 -6
  89. package/dist/apis/file.d.ts +9 -12
  90. package/dist/apis/file.js +1 -1
  91. package/dist/apis/iban.cjs +6 -6
  92. package/dist/apis/iban.d.ts +9 -12
  93. package/dist/apis/iban.js +1 -1
  94. package/dist/apis/integration-toolkit.cjs +6 -6
  95. package/dist/apis/integration-toolkit.d.ts +9 -12
  96. package/dist/apis/integration-toolkit.js +1 -1
  97. package/dist/apis/journey.cjs +6 -6
  98. package/dist/apis/journey.d.ts +9 -12
  99. package/dist/apis/journey.js +1 -1
  100. package/dist/apis/kanban.cjs +6 -6
  101. package/dist/apis/kanban.d.ts +9 -12
  102. package/dist/apis/kanban.js +1 -1
  103. package/dist/apis/message.cjs +6 -6
  104. package/dist/apis/message.d.ts +9 -12
  105. package/dist/apis/message.js +1 -1
  106. package/dist/apis/metering.cjs +6 -6
  107. package/dist/apis/metering.d.ts +9 -12
  108. package/dist/apis/metering.js +1 -1
  109. package/dist/apis/notes.cjs +6 -6
  110. package/dist/apis/notes.d.ts +9 -12
  111. package/dist/apis/notes.js +1 -1
  112. package/dist/apis/notification.cjs +6 -6
  113. package/dist/apis/notification.d.ts +9 -12
  114. package/dist/apis/notification.js +1 -1
  115. package/dist/apis/organization.cjs +6 -6
  116. package/dist/apis/organization.d.ts +9 -12
  117. package/dist/apis/organization.js +1 -1
  118. package/dist/apis/partner-directory.cjs +6 -6
  119. package/dist/apis/partner-directory.d.ts +9 -12
  120. package/dist/apis/partner-directory.js +1 -1
  121. package/dist/apis/permissions.cjs +6 -6
  122. package/dist/apis/permissions.d.ts +9 -12
  123. package/dist/apis/permissions.js +1 -1
  124. package/dist/apis/pricing-tier.cjs +6 -6
  125. package/dist/apis/pricing-tier.d.ts +9 -12
  126. package/dist/apis/pricing-tier.js +1 -1
  127. package/dist/apis/pricing.cjs +8 -8
  128. package/dist/apis/pricing.d.ts +9 -12
  129. package/dist/apis/pricing.js +2 -2
  130. package/dist/apis/purpose.cjs +6 -6
  131. package/dist/apis/purpose.d.ts +9 -12
  132. package/dist/apis/purpose.js +1 -1
  133. package/dist/apis/query.cjs +6 -6
  134. package/dist/apis/query.d.ts +9 -12
  135. package/dist/apis/query.js +1 -1
  136. package/dist/apis/sandbox.cjs +6 -6
  137. package/dist/apis/sandbox.d.ts +9 -12
  138. package/dist/apis/sandbox.js +1 -1
  139. package/dist/apis/sharing.cjs +6 -6
  140. package/dist/apis/sharing.d.ts +9 -12
  141. package/dist/apis/sharing.js +1 -1
  142. package/dist/apis/submission.cjs +6 -6
  143. package/dist/apis/submission.d.ts +9 -12
  144. package/dist/apis/submission.js +1 -1
  145. package/dist/apis/target.cjs +6 -6
  146. package/dist/apis/target.d.ts +9 -591
  147. package/dist/apis/target.js +1 -1
  148. package/dist/apis/targeting.cjs +6 -6
  149. package/dist/apis/targeting.d.ts +9 -12
  150. package/dist/apis/targeting.js +1 -1
  151. package/dist/apis/template-variables.cjs +6 -6
  152. package/dist/apis/template-variables.d.ts +9 -12
  153. package/dist/apis/template-variables.js +1 -1
  154. package/dist/apis/user.cjs +6 -6
  155. package/dist/apis/user.d.ts +9 -12
  156. package/dist/apis/user.js +1 -1
  157. package/dist/apis/validation-rules.cjs +6 -6
  158. package/dist/apis/validation-rules.d.ts +9 -12
  159. package/dist/apis/validation-rules.js +1 -1
  160. package/dist/apis/webhooks.cjs +6 -6
  161. package/dist/apis/webhooks.d.ts +9 -12
  162. package/dist/apis/webhooks.js +1 -1
  163. package/dist/apis/workflow-definition.cjs +6 -6
  164. package/dist/apis/workflow-definition.d.ts +9 -12
  165. package/dist/apis/workflow-definition.js +1 -1
  166. package/dist/apis/workflow.cjs +6 -6
  167. package/dist/apis/workflow.d.ts +9 -12
  168. package/dist/apis/workflow.js +1 -1
  169. package/dist/authorize.d.ts +3 -0
  170. package/dist/automation-BMO7ZFTN.cjs +7 -0
  171. package/dist/automation-MEZTSUR3.js +7 -0
  172. package/dist/bin/cli.d.ts +1 -0
  173. package/dist/bin/cli.js +1 -1
  174. package/dist/calendar-2YDAYG7S.cjs +7 -0
  175. package/dist/calendar-ACFIHQ2N.js +7 -0
  176. package/dist/calendar-runtime-6CMMEQMG.js +5 -0
  177. package/dist/calendar-runtime-G4SN5PDY.cjs +5 -0
  178. package/dist/{chunk-MEUS7LCE.js → chunk-63BFJKWV.js} +1 -1
  179. package/dist/{chunk-YLJD7G7H.cjs → chunk-CD4OX2U6.cjs} +7 -5
  180. package/dist/chunk-CKLEBO4K.cjs +14 -0
  181. package/dist/chunk-JNH37UUH.js +14 -0
  182. package/dist/{chunk-JXJC6WEW.cjs → chunk-KP7H52BF.cjs} +1 -1
  183. package/dist/{chunk-CQ3AKMIJ.js → chunk-TSV242UN.js} +7 -5
  184. package/dist/client-factory.d.ts +9 -0
  185. package/dist/client-map.d.ts +102 -0
  186. package/dist/compact.d.ts +22 -0
  187. package/dist/help.d.ts +12 -0
  188. package/dist/index.cjs +27 -19
  189. package/dist/index.d.ts +12 -180
  190. package/dist/index.js +22 -14
  191. package/dist/{js-yaml-DLCVPJ7G.js → js-yaml-UPZKYVRY.js} +15 -17
  192. package/dist/large-response.d.ts +9 -0
  193. package/dist/openapi.d.ts +12 -0
  194. package/dist/overrides.d.ts +9 -0
  195. package/dist/pricing-G67CH3XH.js +7 -0
  196. package/dist/pricing-XAET4G7T.cjs +7 -0
  197. package/dist/{pricing-runtime-JRR4FWFI.js → pricing-runtime-2YKEJJMZ.js} +1 -1
  198. package/dist/{pricing-runtime-6XNS4EOF.cjs → pricing-runtime-XDCOKL47.cjs} +2 -2
  199. package/dist/proxy.d.ts +14 -0
  200. package/dist/registry.d.ts +19 -0
  201. package/dist/retry.d.ts +11 -0
  202. package/dist/sdk.d.ts +29 -0
  203. package/dist/types.d.ts +53 -0
  204. package/docs/automation.md +42 -5
  205. package/docs/calendar.md +441 -0
  206. package/docs/pricing.md +39 -15
  207. package/package.json +10 -1
  208. package/dist/README-6MG272KM.cjs +0 -7
  209. package/dist/README-7N542PBL.js +0 -7
  210. package/dist/access-token.d-CnmUTOlq.d.cts +0 -552
  211. package/dist/access-token.d-CnmUTOlq.d.ts +0 -552
  212. package/dist/address-suggestions.d-_YwTOR-9.d.cts +0 -339
  213. package/dist/address-suggestions.d-_YwTOR-9.d.ts +0 -339
  214. package/dist/address.d-CwAPOVxa.d.cts +0 -437
  215. package/dist/address.d-CwAPOVxa.d.ts +0 -437
  216. package/dist/ai-agents.d-OkXfr2bz.d.cts +0 -1339
  217. package/dist/ai-agents.d-OkXfr2bz.d.ts +0 -1339
  218. package/dist/apis/access-token.d.cts +0 -18
  219. package/dist/apis/address-suggestions.d.cts +0 -18
  220. package/dist/apis/address.d.cts +0 -18
  221. package/dist/apis/ai-agents.d.cts +0 -18
  222. package/dist/apis/app.d.cts +0 -18
  223. package/dist/apis/audit-logs.d.cts +0 -18
  224. package/dist/apis/automation.d.cts +0 -18
  225. package/dist/apis/billing.d.cts +0 -18
  226. package/dist/apis/blueprint-manifest.d.cts +0 -18
  227. package/dist/apis/configuration-hub.d.cts +0 -18
  228. package/dist/apis/consent.d.cts +0 -18
  229. package/dist/apis/customer-portal.d.cts +0 -18
  230. package/dist/apis/dashboard.d.cts +0 -18
  231. package/dist/apis/data-governance.d.cts +0 -18
  232. package/dist/apis/deduplication.d.cts +0 -18
  233. package/dist/apis/design.d.cts +0 -18
  234. package/dist/apis/document.d.cts +0 -18
  235. package/dist/apis/email-settings.d.cts +0 -18
  236. package/dist/apis/email-template.d.cts +0 -18
  237. package/dist/apis/entity-mapping.d.cts +0 -18
  238. package/dist/apis/entity.d.cts +0 -18
  239. package/dist/apis/environments.d.cts +0 -18
  240. package/dist/apis/event-catalog.d.cts +0 -18
  241. package/dist/apis/file.d.cts +0 -18
  242. package/dist/apis/iban.d.cts +0 -18
  243. package/dist/apis/integration-toolkit.d.cts +0 -18
  244. package/dist/apis/journey.d.cts +0 -18
  245. package/dist/apis/kanban.d.cts +0 -18
  246. package/dist/apis/message.d.cts +0 -18
  247. package/dist/apis/metering.d.cts +0 -18
  248. package/dist/apis/notes.d.cts +0 -18
  249. package/dist/apis/notification.d.cts +0 -18
  250. package/dist/apis/organization.d.cts +0 -18
  251. package/dist/apis/partner-directory.d.cts +0 -18
  252. package/dist/apis/permissions.d.cts +0 -18
  253. package/dist/apis/pricing-tier.d.cts +0 -18
  254. package/dist/apis/pricing.d.cts +0 -18
  255. package/dist/apis/purpose.d.cts +0 -18
  256. package/dist/apis/query.d.cts +0 -18
  257. package/dist/apis/sandbox.d.cts +0 -18
  258. package/dist/apis/sharing.d.cts +0 -18
  259. package/dist/apis/submission.d.cts +0 -18
  260. package/dist/apis/target.d.cts +0 -597
  261. package/dist/apis/targeting.d.cts +0 -18
  262. package/dist/apis/template-variables.d.cts +0 -18
  263. package/dist/apis/user.d.cts +0 -18
  264. package/dist/apis/validation-rules.d.cts +0 -18
  265. package/dist/apis/webhooks.d.cts +0 -18
  266. package/dist/apis/workflow-definition.d.cts +0 -18
  267. package/dist/apis/workflow.d.cts +0 -18
  268. package/dist/app.d-u7Dq42kU.d.cts +0 -3391
  269. package/dist/app.d-u7Dq42kU.d.ts +0 -3391
  270. package/dist/audit-logs.d-BRToFqeX.d.cts +0 -287
  271. package/dist/audit-logs.d-BRToFqeX.d.ts +0 -287
  272. package/dist/automation-GFNNLSIN.js +0 -7
  273. package/dist/automation-IOCVCTKR.cjs +0 -7
  274. package/dist/automation.d-CzhG2m4L.d.cts +0 -5252
  275. package/dist/automation.d-CzhG2m4L.d.ts +0 -5252
  276. package/dist/billing.d-Bs8Ku9qE.d.cts +0 -993
  277. package/dist/billing.d-Bs8Ku9qE.d.ts +0 -993
  278. package/dist/blueprint-manifest.d-BPyzoR0X.d.cts +0 -4343
  279. package/dist/blueprint-manifest.d-BPyzoR0X.d.ts +0 -4343
  280. package/dist/configuration-hub.d-Cqaq2F-W.d.cts +0 -478
  281. package/dist/configuration-hub.d-Cqaq2F-W.d.ts +0 -478
  282. package/dist/consent.d-C2PROHhX.d.cts +0 -265
  283. package/dist/consent.d-C2PROHhX.d.ts +0 -265
  284. package/dist/customer-portal.d-DyZ2n2dW.d.cts +0 -16728
  285. package/dist/customer-portal.d-DyZ2n2dW.d.ts +0 -16728
  286. package/dist/dashboard.d-CsGcA74I.d.cts +0 -440
  287. package/dist/dashboard.d-CsGcA74I.d.ts +0 -440
  288. package/dist/data-governance.d-BbZ466j5.d.cts +0 -1178
  289. package/dist/data-governance.d-BbZ466j5.d.ts +0 -1178
  290. package/dist/deduplication.d-D5GYddVu.d.cts +0 -218
  291. package/dist/deduplication.d-D5GYddVu.d.ts +0 -218
  292. package/dist/design.d-BRre8iLg.d.cts +0 -2346
  293. package/dist/design.d-BRre8iLg.d.ts +0 -2346
  294. package/dist/document.d-DN37pjdx.d.cts +0 -648
  295. package/dist/document.d-DN37pjdx.d.ts +0 -648
  296. package/dist/email-settings.d-B7Q_xT25.d.cts +0 -2417
  297. package/dist/email-settings.d-B7Q_xT25.d.ts +0 -2417
  298. package/dist/email-template.d-gtQkdaXM.d.cts +0 -1188
  299. package/dist/email-template.d-gtQkdaXM.d.ts +0 -1188
  300. package/dist/entity-mapping.d-DKSW3sfy.d.cts +0 -1092
  301. package/dist/entity-mapping.d-DKSW3sfy.d.ts +0 -1092
  302. package/dist/entity.d-BHR9dEon.d.cts +0 -18479
  303. package/dist/entity.d-BHR9dEon.d.ts +0 -18479
  304. package/dist/environments.d-BvqvN-PD.d.cts +0 -382
  305. package/dist/environments.d-BvqvN-PD.d.ts +0 -382
  306. package/dist/event-catalog.d-ENw6HO-w.d.cts +0 -1511
  307. package/dist/event-catalog.d-ENw6HO-w.d.ts +0 -1511
  308. package/dist/file.d-DcTJxjp7.d.cts +0 -2992
  309. package/dist/file.d-DcTJxjp7.d.ts +0 -2992
  310. package/dist/iban.d-BwdiGbxi.d.cts +0 -70
  311. package/dist/iban.d-BwdiGbxi.d.ts +0 -70
  312. package/dist/index.d.cts +0 -180
  313. package/dist/integration-toolkit.d-Ry-KC9ow.d.cts +0 -5796
  314. package/dist/integration-toolkit.d-Ry-KC9ow.d.ts +0 -5796
  315. package/dist/journey.d-ClXO0xK8.d.cts +0 -1931
  316. package/dist/journey.d-ClXO0xK8.d.ts +0 -1931
  317. package/dist/kanban.d-BHnSRCYW.d.cts +0 -760
  318. package/dist/kanban.d-BHnSRCYW.d.ts +0 -760
  319. package/dist/message.d-B5UuSqgw.d.cts +0 -3811
  320. package/dist/message.d-B5UuSqgw.d.ts +0 -3811
  321. package/dist/metering.d-DvtPv7wk.d.cts +0 -1841
  322. package/dist/metering.d-DvtPv7wk.d.ts +0 -1841
  323. package/dist/notes.d-BC-scR42.d.cts +0 -1046
  324. package/dist/notes.d-BC-scR42.d.ts +0 -1046
  325. package/dist/notification.d-BfBL3lga.d.cts +0 -1147
  326. package/dist/notification.d-BfBL3lga.d.ts +0 -1147
  327. package/dist/organization.d-DqwnNxMg.d.cts +0 -1271
  328. package/dist/organization.d-DqwnNxMg.d.ts +0 -1271
  329. package/dist/partner-directory.d-BCIjHoGs.d.cts +0 -2337
  330. package/dist/partner-directory.d-BCIjHoGs.d.ts +0 -2337
  331. package/dist/permissions.d-l6AT8SYP.d.cts +0 -1279
  332. package/dist/permissions.d-l6AT8SYP.d.ts +0 -1279
  333. package/dist/pricing-4Z4TOETA.cjs +0 -7
  334. package/dist/pricing-C65DTZSX.js +0 -7
  335. package/dist/pricing-tier.d-Cg0jl6n_.d.cts +0 -81
  336. package/dist/pricing-tier.d-Cg0jl6n_.d.ts +0 -81
  337. package/dist/pricing.d-Cv39plGm.d.cts +0 -12200
  338. package/dist/pricing.d-Cv39plGm.d.ts +0 -12200
  339. package/dist/purpose.d-CbIYfTua.d.cts +0 -372
  340. package/dist/purpose.d-CbIYfTua.d.ts +0 -372
  341. package/dist/query.d-Cmp78IhZ.d.cts +0 -2375
  342. package/dist/query.d-Cmp78IhZ.d.ts +0 -2375
  343. package/dist/sandbox.d-BdbOFzDu.d.cts +0 -465
  344. package/dist/sandbox.d-BdbOFzDu.d.ts +0 -465
  345. package/dist/sharing.d-sOXq-gtz.d.cts +0 -571
  346. package/dist/sharing.d-sOXq-gtz.d.ts +0 -571
  347. package/dist/submission.d-BamwfhXw.d.cts +0 -469
  348. package/dist/submission.d-BamwfhXw.d.ts +0 -469
  349. package/dist/targeting.d-BNmcVsNS.d.cts +0 -2057
  350. package/dist/targeting.d-BNmcVsNS.d.ts +0 -2057
  351. package/dist/template-variables.d-Ble9TSBa.d.cts +0 -1320
  352. package/dist/template-variables.d-Ble9TSBa.d.ts +0 -1320
  353. package/dist/types-ChU9Acbv.d.cts +0 -37
  354. package/dist/types-ChU9Acbv.d.ts +0 -37
  355. package/dist/user.d-D18fe97W.d.cts +0 -2270
  356. package/dist/user.d-D18fe97W.d.ts +0 -2270
  357. package/dist/validation-rules.d-Db5c5zTf.d.cts +0 -807
  358. package/dist/validation-rules.d-Db5c5zTf.d.ts +0 -807
  359. package/dist/webhooks.d-pLHIL_io.d.cts +0 -1256
  360. package/dist/webhooks.d-pLHIL_io.d.ts +0 -1256
  361. package/dist/workflow-definition.d-DOeb0KVV.d.cts +0 -1922
  362. package/dist/workflow-definition.d-DOeb0KVV.d.ts +0 -1922
  363. package/dist/workflow.d-CMSKt8oN.d.cts +0 -3151
  364. package/dist/workflow.d-CMSKt8oN.d.ts +0 -3151
@@ -1,372 +0,0 @@
1
- import { OpenAPIClient, Parameters, UnknownParamsObject, AxiosRequestConfig, OperationResponse } from 'openapi-client-axios';
2
-
3
- /* Auto-copied from purpose-client */
4
- /* eslint-disable */
5
-
6
-
7
-
8
- declare namespace Components {
9
- namespace Parameters {
10
- export type PurposeIdPathParam = string;
11
- export type QueryParam = string;
12
- export type SizeParam = number;
13
- }
14
- export interface PathParameters {
15
- PurposeIdPathParam?: Parameters.PurposeIdPathParam;
16
- }
17
- export interface QueryParameters {
18
- QueryParam?: Parameters.QueryParam;
19
- SizeParam?: Parameters.SizeParam;
20
- }
21
- namespace RequestBodies {
22
- export type BatchGetPurposesRequest = /* Input for batch getting purposes */ Schemas.BatchGetPurposesInput;
23
- export type CreatePurposeRequest = /* Input for creating a new purpose */ Schemas.CreatePurposeInput;
24
- export type UpdatePurposeRequest = /* Input for updating an existing purpose */ Schemas.UpdatePurposeInput;
25
- }
26
- namespace Responses {
27
- export type ClientErrorResponse = Schemas.Error;
28
- export type ConflictResponse = Schemas.Error;
29
- export type ForbiddenResponse = Schemas.Error;
30
- export type NotFoundResponse = Schemas.Error;
31
- export interface PurposeListResponse {
32
- results?: /* A purpose used to tag and organize entities */ Schemas.Purpose[];
33
- /**
34
- * Total number of results
35
- */
36
- hits?: number;
37
- }
38
- export type PurposeResponse = /* A purpose used to tag and organize entities */ Schemas.Purpose;
39
- export interface PurposeSearchResponse {
40
- results?: /* A purpose used to tag and organize entities */ Schemas.Purpose[];
41
- }
42
- export type ServerErrorResponse = Schemas.Error;
43
- export type UnauthorizedResponse = Schemas.Error;
44
- }
45
- namespace Schemas {
46
- /**
47
- * Input for batch getting purposes
48
- */
49
- export interface BatchGetPurposesInput {
50
- /**
51
- * List of purpose IDs to fetch
52
- * example:
53
- * [
54
- * "123e4567-e89b-12d3-a456-426614174000"
55
- * ]
56
- */
57
- purposeIds: string[];
58
- }
59
- /**
60
- * Input for creating a new purpose
61
- */
62
- export interface CreatePurposeInput {
63
- /**
64
- * Human-readable name
65
- * example:
66
- * Electricity Contract
67
- */
68
- name: string;
69
- }
70
- export interface Error {
71
- /**
72
- * HTTP status code
73
- */
74
- status?: number;
75
- /**
76
- * Error message
77
- */
78
- error?: string;
79
- }
80
- /**
81
- * A purpose used to tag and organize entities
82
- */
83
- export interface Purpose {
84
- /**
85
- * Unique identifier
86
- * example:
87
- * 123e4567-e89b-12d3-a456-426614174000
88
- */
89
- id: string; // uuid
90
- /**
91
- * Human-readable name
92
- * example:
93
- * Electricity Contract
94
- */
95
- name: string;
96
- /**
97
- * ISO timestamp of creation
98
- */
99
- created_at?: string; // date-time
100
- /**
101
- * ISO timestamp of last update
102
- */
103
- updated_at?: string; // date-time
104
- }
105
- /**
106
- * Input for updating an existing purpose
107
- */
108
- export interface UpdatePurposeInput {
109
- /**
110
- * Human-readable name
111
- */
112
- name?: string;
113
- }
114
- }
115
- }
116
- declare namespace Paths {
117
- namespace BatchGetPurposes {
118
- export type RequestBody = Components.RequestBodies.BatchGetPurposesRequest;
119
- namespace Responses {
120
- export type $200 = Components.Responses.PurposeListResponse;
121
- export type $400 = Components.Responses.ClientErrorResponse;
122
- export type $401 = Components.Responses.UnauthorizedResponse;
123
- export type $500 = Components.Responses.ServerErrorResponse;
124
- }
125
- }
126
- namespace CreatePurpose {
127
- export type RequestBody = Components.RequestBodies.CreatePurposeRequest;
128
- namespace Responses {
129
- export type $201 = Components.Responses.PurposeResponse;
130
- export type $400 = Components.Responses.ClientErrorResponse;
131
- export type $401 = Components.Responses.UnauthorizedResponse;
132
- export type $403 = Components.Responses.ForbiddenResponse;
133
- export type $409 = Components.Responses.ConflictResponse;
134
- export type $500 = Components.Responses.ServerErrorResponse;
135
- }
136
- }
137
- namespace DeletePurpose {
138
- namespace Parameters {
139
- export type PurposeId = string;
140
- }
141
- export interface PathParameters {
142
- purposeId: Parameters.PurposeId;
143
- }
144
- namespace Responses {
145
- export type $200 = Components.Responses.PurposeResponse;
146
- export type $401 = Components.Responses.UnauthorizedResponse;
147
- export type $403 = Components.Responses.ForbiddenResponse;
148
- export type $404 = Components.Responses.NotFoundResponse;
149
- export type $500 = Components.Responses.ServerErrorResponse;
150
- }
151
- }
152
- namespace GetPurpose {
153
- namespace Parameters {
154
- export type PurposeId = string;
155
- }
156
- export interface PathParameters {
157
- purposeId: Parameters.PurposeId;
158
- }
159
- namespace Responses {
160
- export type $200 = Components.Responses.PurposeResponse;
161
- export type $401 = Components.Responses.UnauthorizedResponse;
162
- export type $404 = Components.Responses.NotFoundResponse;
163
- export type $500 = Components.Responses.ServerErrorResponse;
164
- }
165
- }
166
- namespace SearchPurposes {
167
- namespace Parameters {
168
- export type Query = string;
169
- export type Size = number;
170
- }
171
- export interface QueryParameters {
172
- query?: Parameters.Query;
173
- size?: Parameters.Size;
174
- }
175
- namespace Responses {
176
- export type $200 = Components.Responses.PurposeSearchResponse;
177
- export type $401 = Components.Responses.UnauthorizedResponse;
178
- export type $500 = Components.Responses.ServerErrorResponse;
179
- }
180
- }
181
- namespace UpdatePurpose {
182
- namespace Parameters {
183
- export type PurposeId = string;
184
- }
185
- export interface PathParameters {
186
- purposeId: Parameters.PurposeId;
187
- }
188
- export type RequestBody = Components.RequestBodies.UpdatePurposeRequest;
189
- namespace Responses {
190
- export type $200 = Components.Responses.PurposeResponse;
191
- export type $400 = Components.Responses.ClientErrorResponse;
192
- export type $401 = Components.Responses.UnauthorizedResponse;
193
- export type $403 = Components.Responses.ForbiddenResponse;
194
- export type $404 = Components.Responses.NotFoundResponse;
195
- export type $500 = Components.Responses.ServerErrorResponse;
196
- }
197
- }
198
- }
199
-
200
-
201
- interface OperationMethods {
202
- /**
203
- * createPurpose - Create Purpose
204
- *
205
- * Create a new purpose
206
- */
207
- 'createPurpose'(
208
- parameters?: Parameters<UnknownParamsObject> | null,
209
- data?: Paths.CreatePurpose.RequestBody,
210
- config?: AxiosRequestConfig
211
- ): OperationResponse<Paths.CreatePurpose.Responses.$201>
212
- /**
213
- * searchPurposes - Search Purposes
214
- *
215
- * Search purposes using fuzzy matching.
216
- *
217
- */
218
- 'searchPurposes'(
219
- parameters?: Parameters<Paths.SearchPurposes.QueryParameters> | null,
220
- data?: any,
221
- config?: AxiosRequestConfig
222
- ): OperationResponse<Paths.SearchPurposes.Responses.$200>
223
- /**
224
- * batchGetPurposes - Batch Get Purposes
225
- *
226
- * Fetch multiple purposes by their known IDs in a single request.
227
- *
228
- * **Use this for:**
229
- * - Hydrating purpose references from entities
230
- * - Resolving a list of purpose IDs to full objects
231
- *
232
- * **Do NOT use this for:**
233
- * - Browsing/discovering purposes (use `searchPurposes` instead)
234
- * - Autocomplete (use `searchPurposes` instead)
235
- *
236
- * **Examples:**
237
- * - Entity has `_purposes: ["uuid-1", "uuid-2"]` → fetch full purpose objects
238
- * - Display purpose names for a list of tagged entities
239
- *
240
- */
241
- 'batchGetPurposes'(
242
- parameters?: Parameters<UnknownParamsObject> | null,
243
- data?: Paths.BatchGetPurposes.RequestBody,
244
- config?: AxiosRequestConfig
245
- ): OperationResponse<Paths.BatchGetPurposes.Responses.$200>
246
- /**
247
- * getPurpose - Get Purpose
248
- *
249
- * Get a single purpose by ID
250
- */
251
- 'getPurpose'(
252
- parameters?: Parameters<Paths.GetPurpose.PathParameters> | null,
253
- data?: any,
254
- config?: AxiosRequestConfig
255
- ): OperationResponse<Paths.GetPurpose.Responses.$200>
256
- /**
257
- * updatePurpose - Update Purpose
258
- *
259
- * Update an existing purpose
260
- */
261
- 'updatePurpose'(
262
- parameters?: Parameters<Paths.UpdatePurpose.PathParameters> | null,
263
- data?: Paths.UpdatePurpose.RequestBody,
264
- config?: AxiosRequestConfig
265
- ): OperationResponse<Paths.UpdatePurpose.Responses.$200>
266
- /**
267
- * deletePurpose - Delete Purpose
268
- *
269
- * Permanently delete a purpose
270
- */
271
- 'deletePurpose'(
272
- parameters?: Parameters<Paths.DeletePurpose.PathParameters> | null,
273
- data?: any,
274
- config?: AxiosRequestConfig
275
- ): OperationResponse<Paths.DeletePurpose.Responses.$200>
276
- }
277
-
278
- interface PathsDictionary {
279
- ['/v1/purpose']: {
280
- /**
281
- * createPurpose - Create Purpose
282
- *
283
- * Create a new purpose
284
- */
285
- 'post'(
286
- parameters?: Parameters<UnknownParamsObject> | null,
287
- data?: Paths.CreatePurpose.RequestBody,
288
- config?: AxiosRequestConfig
289
- ): OperationResponse<Paths.CreatePurpose.Responses.$201>
290
- }
291
- ['/v1/purpose:search']: {
292
- /**
293
- * searchPurposes - Search Purposes
294
- *
295
- * Search purposes using fuzzy matching.
296
- *
297
- */
298
- 'get'(
299
- parameters?: Parameters<Paths.SearchPurposes.QueryParameters> | null,
300
- data?: any,
301
- config?: AxiosRequestConfig
302
- ): OperationResponse<Paths.SearchPurposes.Responses.$200>
303
- }
304
- ['/v1/purpose:batchGet']: {
305
- /**
306
- * batchGetPurposes - Batch Get Purposes
307
- *
308
- * Fetch multiple purposes by their known IDs in a single request.
309
- *
310
- * **Use this for:**
311
- * - Hydrating purpose references from entities
312
- * - Resolving a list of purpose IDs to full objects
313
- *
314
- * **Do NOT use this for:**
315
- * - Browsing/discovering purposes (use `searchPurposes` instead)
316
- * - Autocomplete (use `searchPurposes` instead)
317
- *
318
- * **Examples:**
319
- * - Entity has `_purposes: ["uuid-1", "uuid-2"]` → fetch full purpose objects
320
- * - Display purpose names for a list of tagged entities
321
- *
322
- */
323
- 'post'(
324
- parameters?: Parameters<UnknownParamsObject> | null,
325
- data?: Paths.BatchGetPurposes.RequestBody,
326
- config?: AxiosRequestConfig
327
- ): OperationResponse<Paths.BatchGetPurposes.Responses.$200>
328
- }
329
- ['/v1/purpose/{purposeId}']: {
330
- /**
331
- * getPurpose - Get Purpose
332
- *
333
- * Get a single purpose by ID
334
- */
335
- 'get'(
336
- parameters?: Parameters<Paths.GetPurpose.PathParameters> | null,
337
- data?: any,
338
- config?: AxiosRequestConfig
339
- ): OperationResponse<Paths.GetPurpose.Responses.$200>
340
- /**
341
- * updatePurpose - Update Purpose
342
- *
343
- * Update an existing purpose
344
- */
345
- 'put'(
346
- parameters?: Parameters<Paths.UpdatePurpose.PathParameters> | null,
347
- data?: Paths.UpdatePurpose.RequestBody,
348
- config?: AxiosRequestConfig
349
- ): OperationResponse<Paths.UpdatePurpose.Responses.$200>
350
- /**
351
- * deletePurpose - Delete Purpose
352
- *
353
- * Permanently delete a purpose
354
- */
355
- 'delete'(
356
- parameters?: Parameters<Paths.DeletePurpose.PathParameters> | null,
357
- data?: any,
358
- config?: AxiosRequestConfig
359
- ): OperationResponse<Paths.DeletePurpose.Responses.$200>
360
- }
361
- }
362
-
363
- type Client = OpenAPIClient<OperationMethods, PathsDictionary>
364
-
365
-
366
- type BatchGetPurposesInput = Components.Schemas.BatchGetPurposesInput;
367
- type CreatePurposeInput = Components.Schemas.CreatePurposeInput;
368
- type Error = Components.Schemas.Error;
369
- type Purpose = Components.Schemas.Purpose;
370
- type UpdatePurposeInput = Components.Schemas.UpdatePurposeInput;
371
-
372
- export { type BatchGetPurposesInput as B, type Client as C, type Error as E, type OperationMethods as O, Paths as P, type UpdatePurposeInput as U, Components as a, type PathsDictionary as b, type CreatePurposeInput as c, type Purpose as d };