@cadenya/cadenya 0.40.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 (541) hide show
  1. package/CHANGELOG.md +664 -0
  2. package/LICENSE +201 -0
  3. package/README.md +398 -0
  4. package/api-promise.d.mts +2 -0
  5. package/api-promise.d.mts.map +1 -0
  6. package/api-promise.d.ts +2 -0
  7. package/api-promise.d.ts.map +1 -0
  8. package/api-promise.js +6 -0
  9. package/api-promise.js.map +1 -0
  10. package/api-promise.mjs +2 -0
  11. package/api-promise.mjs.map +1 -0
  12. package/client.d.mts +269 -0
  13. package/client.d.mts.map +1 -0
  14. package/client.d.ts +269 -0
  15. package/client.d.ts.map +1 -0
  16. package/client.js +550 -0
  17. package/client.js.map +1 -0
  18. package/client.mjs +546 -0
  19. package/client.mjs.map +1 -0
  20. package/core/api-promise.d.mts +46 -0
  21. package/core/api-promise.d.mts.map +1 -0
  22. package/core/api-promise.d.ts +46 -0
  23. package/core/api-promise.d.ts.map +1 -0
  24. package/core/api-promise.js +74 -0
  25. package/core/api-promise.js.map +1 -0
  26. package/core/api-promise.mjs +70 -0
  27. package/core/api-promise.mjs.map +1 -0
  28. package/core/error.d.mts +46 -0
  29. package/core/error.d.mts.map +1 -0
  30. package/core/error.d.ts +46 -0
  31. package/core/error.d.ts.map +1 -0
  32. package/core/error.js +113 -0
  33. package/core/error.js.map +1 -0
  34. package/core/error.mjs +97 -0
  35. package/core/error.mjs.map +1 -0
  36. package/core/pagination.d.mts +59 -0
  37. package/core/pagination.d.mts.map +1 -0
  38. package/core/pagination.d.ts +59 -0
  39. package/core/pagination.d.ts.map +1 -0
  40. package/core/pagination.js +101 -0
  41. package/core/pagination.js.map +1 -0
  42. package/core/pagination.mjs +95 -0
  43. package/core/pagination.mjs.map +1 -0
  44. package/core/resource.d.mts +6 -0
  45. package/core/resource.d.mts.map +1 -0
  46. package/core/resource.d.ts +6 -0
  47. package/core/resource.d.ts.map +1 -0
  48. package/core/resource.js +11 -0
  49. package/core/resource.js.map +1 -0
  50. package/core/resource.mjs +7 -0
  51. package/core/resource.mjs.map +1 -0
  52. package/core/uploads.d.mts +3 -0
  53. package/core/uploads.d.mts.map +1 -0
  54. package/core/uploads.d.ts +3 -0
  55. package/core/uploads.d.ts.map +1 -0
  56. package/core/uploads.js +6 -0
  57. package/core/uploads.js.map +1 -0
  58. package/core/uploads.mjs +2 -0
  59. package/core/uploads.mjs.map +1 -0
  60. package/error.d.mts +2 -0
  61. package/error.d.mts.map +1 -0
  62. package/error.d.ts +2 -0
  63. package/error.d.ts.map +1 -0
  64. package/error.js +6 -0
  65. package/error.js.map +1 -0
  66. package/error.mjs +2 -0
  67. package/error.mjs.map +1 -0
  68. package/index.d.mts +7 -0
  69. package/index.d.mts.map +1 -0
  70. package/index.d.ts +7 -0
  71. package/index.d.ts.map +1 -0
  72. package/index.js +32 -0
  73. package/index.js.map +1 -0
  74. package/index.mjs +8 -0
  75. package/index.mjs.map +1 -0
  76. package/internal/builtin-types.d.mts +73 -0
  77. package/internal/builtin-types.d.mts.map +1 -0
  78. package/internal/builtin-types.d.ts +73 -0
  79. package/internal/builtin-types.d.ts.map +1 -0
  80. package/internal/builtin-types.js +4 -0
  81. package/internal/builtin-types.js.map +1 -0
  82. package/internal/builtin-types.mjs +3 -0
  83. package/internal/builtin-types.mjs.map +1 -0
  84. package/internal/detect-platform.d.mts +15 -0
  85. package/internal/detect-platform.d.mts.map +1 -0
  86. package/internal/detect-platform.d.ts +15 -0
  87. package/internal/detect-platform.d.ts.map +1 -0
  88. package/internal/detect-platform.js +162 -0
  89. package/internal/detect-platform.js.map +1 -0
  90. package/internal/detect-platform.mjs +157 -0
  91. package/internal/detect-platform.mjs.map +1 -0
  92. package/internal/errors.d.mts +3 -0
  93. package/internal/errors.d.mts.map +1 -0
  94. package/internal/errors.d.ts +3 -0
  95. package/internal/errors.d.ts.map +1 -0
  96. package/internal/errors.js +41 -0
  97. package/internal/errors.js.map +1 -0
  98. package/internal/errors.mjs +36 -0
  99. package/internal/errors.mjs.map +1 -0
  100. package/internal/headers.d.mts +20 -0
  101. package/internal/headers.d.mts.map +1 -0
  102. package/internal/headers.d.ts +20 -0
  103. package/internal/headers.d.ts.map +1 -0
  104. package/internal/headers.js +79 -0
  105. package/internal/headers.js.map +1 -0
  106. package/internal/headers.mjs +74 -0
  107. package/internal/headers.mjs.map +1 -0
  108. package/internal/parse.d.mts +12 -0
  109. package/internal/parse.d.mts.map +1 -0
  110. package/internal/parse.d.ts +12 -0
  111. package/internal/parse.d.ts.map +1 -0
  112. package/internal/parse.js +40 -0
  113. package/internal/parse.js.map +1 -0
  114. package/internal/parse.mjs +37 -0
  115. package/internal/parse.mjs.map +1 -0
  116. package/internal/request-options.d.mts +75 -0
  117. package/internal/request-options.d.mts.map +1 -0
  118. package/internal/request-options.d.ts +75 -0
  119. package/internal/request-options.d.ts.map +1 -0
  120. package/internal/request-options.js +14 -0
  121. package/internal/request-options.js.map +1 -0
  122. package/internal/request-options.mjs +10 -0
  123. package/internal/request-options.mjs.map +1 -0
  124. package/internal/shim-types.d.mts +17 -0
  125. package/internal/shim-types.d.mts.map +1 -0
  126. package/internal/shim-types.d.ts +17 -0
  127. package/internal/shim-types.d.ts.map +1 -0
  128. package/internal/shim-types.js +4 -0
  129. package/internal/shim-types.js.map +1 -0
  130. package/internal/shim-types.mjs +3 -0
  131. package/internal/shim-types.mjs.map +1 -0
  132. package/internal/shims.d.mts +20 -0
  133. package/internal/shims.d.mts.map +1 -0
  134. package/internal/shims.d.ts +20 -0
  135. package/internal/shims.d.ts.map +1 -0
  136. package/internal/shims.js +92 -0
  137. package/internal/shims.js.map +1 -0
  138. package/internal/shims.mjs +85 -0
  139. package/internal/shims.mjs.map +1 -0
  140. package/internal/to-file.d.mts +45 -0
  141. package/internal/to-file.d.mts.map +1 -0
  142. package/internal/to-file.d.ts +45 -0
  143. package/internal/to-file.d.ts.map +1 -0
  144. package/internal/to-file.js +91 -0
  145. package/internal/to-file.js.map +1 -0
  146. package/internal/to-file.mjs +88 -0
  147. package/internal/to-file.mjs.map +1 -0
  148. package/internal/tslib.js +81 -0
  149. package/internal/tslib.mjs +17 -0
  150. package/internal/types.d.mts +69 -0
  151. package/internal/types.d.mts.map +1 -0
  152. package/internal/types.d.ts +69 -0
  153. package/internal/types.d.ts.map +1 -0
  154. package/internal/types.js +4 -0
  155. package/internal/types.js.map +1 -0
  156. package/internal/types.mjs +3 -0
  157. package/internal/types.mjs.map +1 -0
  158. package/internal/uploads.d.mts +42 -0
  159. package/internal/uploads.d.mts.map +1 -0
  160. package/internal/uploads.d.ts +42 -0
  161. package/internal/uploads.d.ts.map +1 -0
  162. package/internal/uploads.js +141 -0
  163. package/internal/uploads.js.map +1 -0
  164. package/internal/uploads.mjs +131 -0
  165. package/internal/uploads.mjs.map +1 -0
  166. package/internal/utils/base64.d.mts +3 -0
  167. package/internal/utils/base64.d.mts.map +1 -0
  168. package/internal/utils/base64.d.ts +3 -0
  169. package/internal/utils/base64.d.ts.map +1 -0
  170. package/internal/utils/base64.js +38 -0
  171. package/internal/utils/base64.js.map +1 -0
  172. package/internal/utils/base64.mjs +33 -0
  173. package/internal/utils/base64.mjs.map +1 -0
  174. package/internal/utils/bytes.d.mts +4 -0
  175. package/internal/utils/bytes.d.mts.map +1 -0
  176. package/internal/utils/bytes.d.ts +4 -0
  177. package/internal/utils/bytes.d.ts.map +1 -0
  178. package/internal/utils/bytes.js +31 -0
  179. package/internal/utils/bytes.js.map +1 -0
  180. package/internal/utils/bytes.mjs +26 -0
  181. package/internal/utils/bytes.mjs.map +1 -0
  182. package/internal/utils/env.d.mts +9 -0
  183. package/internal/utils/env.d.mts.map +1 -0
  184. package/internal/utils/env.d.ts +9 -0
  185. package/internal/utils/env.d.ts.map +1 -0
  186. package/internal/utils/env.js +22 -0
  187. package/internal/utils/env.js.map +1 -0
  188. package/internal/utils/env.mjs +18 -0
  189. package/internal/utils/env.mjs.map +1 -0
  190. package/internal/utils/log.d.mts +37 -0
  191. package/internal/utils/log.d.mts.map +1 -0
  192. package/internal/utils/log.d.ts +37 -0
  193. package/internal/utils/log.d.ts.map +1 -0
  194. package/internal/utils/log.js +85 -0
  195. package/internal/utils/log.js.map +1 -0
  196. package/internal/utils/log.mjs +79 -0
  197. package/internal/utils/log.mjs.map +1 -0
  198. package/internal/utils/path.d.mts +15 -0
  199. package/internal/utils/path.d.mts.map +1 -0
  200. package/internal/utils/path.d.ts +15 -0
  201. package/internal/utils/path.d.ts.map +1 -0
  202. package/internal/utils/path.js +79 -0
  203. package/internal/utils/path.js.map +1 -0
  204. package/internal/utils/path.mjs +74 -0
  205. package/internal/utils/path.mjs.map +1 -0
  206. package/internal/utils/query.d.mts +5 -0
  207. package/internal/utils/query.d.mts.map +1 -0
  208. package/internal/utils/query.d.ts +5 -0
  209. package/internal/utils/query.d.ts.map +1 -0
  210. package/internal/utils/query.js +23 -0
  211. package/internal/utils/query.js.map +1 -0
  212. package/internal/utils/query.mjs +20 -0
  213. package/internal/utils/query.mjs.map +1 -0
  214. package/internal/utils/sleep.d.mts +2 -0
  215. package/internal/utils/sleep.d.mts.map +1 -0
  216. package/internal/utils/sleep.d.ts +2 -0
  217. package/internal/utils/sleep.d.ts.map +1 -0
  218. package/internal/utils/sleep.js +7 -0
  219. package/internal/utils/sleep.js.map +1 -0
  220. package/internal/utils/sleep.mjs +3 -0
  221. package/internal/utils/sleep.mjs.map +1 -0
  222. package/internal/utils/uuid.d.mts +5 -0
  223. package/internal/utils/uuid.d.mts.map +1 -0
  224. package/internal/utils/uuid.d.ts +5 -0
  225. package/internal/utils/uuid.d.ts.map +1 -0
  226. package/internal/utils/uuid.js +19 -0
  227. package/internal/utils/uuid.js.map +1 -0
  228. package/internal/utils/uuid.mjs +15 -0
  229. package/internal/utils/uuid.mjs.map +1 -0
  230. package/internal/utils/values.d.mts +18 -0
  231. package/internal/utils/values.d.mts.map +1 -0
  232. package/internal/utils/values.d.ts +18 -0
  233. package/internal/utils/values.d.ts.map +1 -0
  234. package/internal/utils/values.js +112 -0
  235. package/internal/utils/values.js.map +1 -0
  236. package/internal/utils/values.mjs +94 -0
  237. package/internal/utils/values.mjs.map +1 -0
  238. package/internal/utils.d.mts +8 -0
  239. package/internal/utils.d.mts.map +1 -0
  240. package/internal/utils.d.ts +8 -0
  241. package/internal/utils.d.ts.map +1 -0
  242. package/internal/utils.js +12 -0
  243. package/internal/utils.js.map +1 -0
  244. package/internal/utils.mjs +9 -0
  245. package/internal/utils.mjs.map +1 -0
  246. package/package.json +159 -0
  247. package/pagination.d.mts +2 -0
  248. package/pagination.d.mts.map +1 -0
  249. package/pagination.d.ts +2 -0
  250. package/pagination.d.ts.map +1 -0
  251. package/pagination.js +6 -0
  252. package/pagination.js.map +1 -0
  253. package/pagination.mjs +2 -0
  254. package/pagination.mjs.map +1 -0
  255. package/resource.d.mts +2 -0
  256. package/resource.d.mts.map +1 -0
  257. package/resource.d.ts +2 -0
  258. package/resource.d.ts.map +1 -0
  259. package/resource.js +6 -0
  260. package/resource.js.map +1 -0
  261. package/resource.mjs +2 -0
  262. package/resource.mjs.map +1 -0
  263. package/resources/account.d.mts +72 -0
  264. package/resources/account.d.mts.map +1 -0
  265. package/resources/account.d.ts +72 -0
  266. package/resources/account.d.ts.map +1 -0
  267. package/resources/account.js +24 -0
  268. package/resources/account.js.map +1 -0
  269. package/resources/account.mjs +20 -0
  270. package/resources/account.mjs.map +1 -0
  271. package/resources/agents/agents.d.mts +175 -0
  272. package/resources/agents/agents.d.mts.map +1 -0
  273. package/resources/agents/agents.d.ts +175 -0
  274. package/resources/agents/agents.d.ts.map +1 -0
  275. package/resources/agents/agents.js +65 -0
  276. package/resources/agents/agents.js.map +1 -0
  277. package/resources/agents/agents.mjs +60 -0
  278. package/resources/agents/agents.mjs.map +1 -0
  279. package/resources/agents/index.d.mts +4 -0
  280. package/resources/agents/index.d.mts.map +1 -0
  281. package/resources/agents/index.d.ts +4 -0
  282. package/resources/agents/index.d.ts.map +1 -0
  283. package/resources/agents/index.js +11 -0
  284. package/resources/agents/index.js.map +1 -0
  285. package/resources/agents/index.mjs +5 -0
  286. package/resources/agents/index.mjs.map +1 -0
  287. package/resources/agents/variations.d.mts +276 -0
  288. package/resources/agents/variations.d.mts.map +1 -0
  289. package/resources/agents/variations.d.ts +276 -0
  290. package/resources/agents/variations.d.ts.map +1 -0
  291. package/resources/agents/variations.js +51 -0
  292. package/resources/agents/variations.js.map +1 -0
  293. package/resources/agents/variations.mjs +47 -0
  294. package/resources/agents/variations.mjs.map +1 -0
  295. package/resources/agents/webhook-deliveries.d.mts +80 -0
  296. package/resources/agents/webhook-deliveries.d.mts.map +1 -0
  297. package/resources/agents/webhook-deliveries.d.ts +80 -0
  298. package/resources/agents/webhook-deliveries.d.ts.map +1 -0
  299. package/resources/agents/webhook-deliveries.js +25 -0
  300. package/resources/agents/webhook-deliveries.js.map +1 -0
  301. package/resources/agents/webhook-deliveries.mjs +21 -0
  302. package/resources/agents/webhook-deliveries.mjs.map +1 -0
  303. package/resources/agents.d.mts +2 -0
  304. package/resources/agents.d.mts.map +1 -0
  305. package/resources/agents.d.ts +2 -0
  306. package/resources/agents.d.ts.map +1 -0
  307. package/resources/agents.js +6 -0
  308. package/resources/agents.js.map +1 -0
  309. package/resources/agents.mjs +3 -0
  310. package/resources/agents.mjs.map +1 -0
  311. package/resources/api-keys.d.mts +124 -0
  312. package/resources/api-keys.d.mts.map +1 -0
  313. package/resources/api-keys.d.ts +124 -0
  314. package/resources/api-keys.d.ts.map +1 -0
  315. package/resources/api-keys.js +59 -0
  316. package/resources/api-keys.js.map +1 -0
  317. package/resources/api-keys.mjs +55 -0
  318. package/resources/api-keys.mjs.map +1 -0
  319. package/resources/index.d.mts +11 -0
  320. package/resources/index.d.mts.map +1 -0
  321. package/resources/index.d.ts +11 -0
  322. package/resources/index.d.ts.map +1 -0
  323. package/resources/index.js +25 -0
  324. package/resources/index.js.map +1 -0
  325. package/resources/index.mjs +12 -0
  326. package/resources/index.mjs.map +1 -0
  327. package/resources/models.d.mts +93 -0
  328. package/resources/models.d.mts.map +1 -0
  329. package/resources/models.d.ts +93 -0
  330. package/resources/models.d.ts.map +1 -0
  331. package/resources/models.js +38 -0
  332. package/resources/models.js.map +1 -0
  333. package/resources/models.mjs +34 -0
  334. package/resources/models.mjs.map +1 -0
  335. package/resources/objectives/feedback.d.mts +74 -0
  336. package/resources/objectives/feedback.d.mts.map +1 -0
  337. package/resources/objectives/feedback.d.ts +74 -0
  338. package/resources/objectives/feedback.d.ts.map +1 -0
  339. package/resources/objectives/feedback.js +24 -0
  340. package/resources/objectives/feedback.js.map +1 -0
  341. package/resources/objectives/feedback.mjs +20 -0
  342. package/resources/objectives/feedback.mjs.map +1 -0
  343. package/resources/objectives/index.d.mts +6 -0
  344. package/resources/objectives/index.d.mts.map +1 -0
  345. package/resources/objectives/index.d.ts +6 -0
  346. package/resources/objectives/index.d.ts.map +1 -0
  347. package/resources/objectives/index.js +15 -0
  348. package/resources/objectives/index.js.map +1 -0
  349. package/resources/objectives/index.mjs +7 -0
  350. package/resources/objectives/index.mjs.map +1 -0
  351. package/resources/objectives/objectives.d.mts +497 -0
  352. package/resources/objectives/objectives.d.mts.map +1 -0
  353. package/resources/objectives/objectives.d.ts +497 -0
  354. package/resources/objectives/objectives.d.ts.map +1 -0
  355. package/resources/objectives/objectives.js +75 -0
  356. package/resources/objectives/objectives.js.map +1 -0
  357. package/resources/objectives/objectives.mjs +70 -0
  358. package/resources/objectives/objectives.mjs.map +1 -0
  359. package/resources/objectives/tasks.d.mts +66 -0
  360. package/resources/objectives/tasks.d.mts.map +1 -0
  361. package/resources/objectives/tasks.d.ts +66 -0
  362. package/resources/objectives/tasks.d.ts.map +1 -0
  363. package/resources/objectives/tasks.js +24 -0
  364. package/resources/objectives/tasks.js.map +1 -0
  365. package/resources/objectives/tasks.mjs +20 -0
  366. package/resources/objectives/tasks.mjs.map +1 -0
  367. package/resources/objectives/tool-calls.d.mts +116 -0
  368. package/resources/objectives/tool-calls.d.mts.map +1 -0
  369. package/resources/objectives/tool-calls.d.ts +116 -0
  370. package/resources/objectives/tool-calls.d.ts.map +1 -0
  371. package/resources/objectives/tool-calls.js +40 -0
  372. package/resources/objectives/tool-calls.js.map +1 -0
  373. package/resources/objectives/tool-calls.mjs +36 -0
  374. package/resources/objectives/tool-calls.mjs.map +1 -0
  375. package/resources/objectives/tools.d.mts +38 -0
  376. package/resources/objectives/tools.d.mts.map +1 -0
  377. package/resources/objectives/tools.d.ts +38 -0
  378. package/resources/objectives/tools.d.ts.map +1 -0
  379. package/resources/objectives/tools.js +17 -0
  380. package/resources/objectives/tools.js.map +1 -0
  381. package/resources/objectives/tools.mjs +13 -0
  382. package/resources/objectives/tools.mjs.map +1 -0
  383. package/resources/objectives.d.mts +2 -0
  384. package/resources/objectives.d.mts.map +1 -0
  385. package/resources/objectives.d.ts +2 -0
  386. package/resources/objectives.d.ts.map +1 -0
  387. package/resources/objectives.js +6 -0
  388. package/resources/objectives.js.map +1 -0
  389. package/resources/objectives.mjs +3 -0
  390. package/resources/objectives.mjs.map +1 -0
  391. package/resources/search.d.mts +24 -0
  392. package/resources/search.d.mts.map +1 -0
  393. package/resources/search.d.ts +24 -0
  394. package/resources/search.d.ts.map +1 -0
  395. package/resources/search.js +15 -0
  396. package/resources/search.js.map +1 -0
  397. package/resources/search.mjs +11 -0
  398. package/resources/search.mjs.map +1 -0
  399. package/resources/shared.d.mts +186 -0
  400. package/resources/shared.d.mts.map +1 -0
  401. package/resources/shared.d.ts +186 -0
  402. package/resources/shared.d.ts.map +1 -0
  403. package/resources/shared.js +4 -0
  404. package/resources/shared.js.map +1 -0
  405. package/resources/shared.mjs +3 -0
  406. package/resources/shared.mjs.map +1 -0
  407. package/resources/tool-sets/index.d.mts +3 -0
  408. package/resources/tool-sets/index.d.mts.map +1 -0
  409. package/resources/tool-sets/index.d.ts +3 -0
  410. package/resources/tool-sets/index.d.ts.map +1 -0
  411. package/resources/tool-sets/index.js +9 -0
  412. package/resources/tool-sets/index.js.map +1 -0
  413. package/resources/tool-sets/index.mjs +4 -0
  414. package/resources/tool-sets/index.mjs.map +1 -0
  415. package/resources/tool-sets/tool-sets.d.mts +290 -0
  416. package/resources/tool-sets/tool-sets.d.mts.map +1 -0
  417. package/resources/tool-sets/tool-sets.d.ts +290 -0
  418. package/resources/tool-sets/tool-sets.d.ts.map +1 -0
  419. package/resources/tool-sets/tool-sets.js +73 -0
  420. package/resources/tool-sets/tool-sets.js.map +1 -0
  421. package/resources/tool-sets/tool-sets.mjs +68 -0
  422. package/resources/tool-sets/tool-sets.mjs.map +1 -0
  423. package/resources/tool-sets/tools.d.mts +161 -0
  424. package/resources/tool-sets/tools.d.mts.map +1 -0
  425. package/resources/tool-sets/tools.d.ts +161 -0
  426. package/resources/tool-sets/tools.d.ts.map +1 -0
  427. package/resources/tool-sets/tools.js +62 -0
  428. package/resources/tool-sets/tools.js.map +1 -0
  429. package/resources/tool-sets/tools.mjs +58 -0
  430. package/resources/tool-sets/tools.mjs.map +1 -0
  431. package/resources/tool-sets.d.mts +2 -0
  432. package/resources/tool-sets.d.mts.map +1 -0
  433. package/resources/tool-sets.d.ts +2 -0
  434. package/resources/tool-sets.d.ts.map +1 -0
  435. package/resources/tool-sets.js +6 -0
  436. package/resources/tool-sets.js.map +1 -0
  437. package/resources/tool-sets.mjs +3 -0
  438. package/resources/tool-sets.mjs.map +1 -0
  439. package/resources/workspace-secrets.d.mts +92 -0
  440. package/resources/workspace-secrets.d.mts.map +1 -0
  441. package/resources/workspace-secrets.d.ts +92 -0
  442. package/resources/workspace-secrets.d.ts.map +1 -0
  443. package/resources/workspace-secrets.js +48 -0
  444. package/resources/workspace-secrets.js.map +1 -0
  445. package/resources/workspace-secrets.mjs +44 -0
  446. package/resources/workspace-secrets.mjs.map +1 -0
  447. package/resources/workspaces.d.mts +50 -0
  448. package/resources/workspaces.d.mts.map +1 -0
  449. package/resources/workspaces.d.ts +50 -0
  450. package/resources/workspaces.d.ts.map +1 -0
  451. package/resources/workspaces.js +31 -0
  452. package/resources/workspaces.js.map +1 -0
  453. package/resources/workspaces.mjs +27 -0
  454. package/resources/workspaces.mjs.map +1 -0
  455. package/resources.d.mts +2 -0
  456. package/resources.d.mts.map +1 -0
  457. package/resources.d.ts +2 -0
  458. package/resources.d.ts.map +1 -0
  459. package/resources.js +5 -0
  460. package/resources.js.map +1 -0
  461. package/resources.mjs +2 -0
  462. package/resources.mjs.map +1 -0
  463. package/src/api-promise.ts +2 -0
  464. package/src/client.ts +1067 -0
  465. package/src/core/README.md +3 -0
  466. package/src/core/api-promise.ts +92 -0
  467. package/src/core/error.ts +130 -0
  468. package/src/core/pagination.ts +163 -0
  469. package/src/core/resource.ts +11 -0
  470. package/src/core/uploads.ts +2 -0
  471. package/src/error.ts +2 -0
  472. package/src/index.ts +23 -0
  473. package/src/internal/README.md +3 -0
  474. package/src/internal/builtin-types.ts +93 -0
  475. package/src/internal/detect-platform.ts +196 -0
  476. package/src/internal/errors.ts +33 -0
  477. package/src/internal/headers.ts +97 -0
  478. package/src/internal/parse.ts +56 -0
  479. package/src/internal/request-options.ts +91 -0
  480. package/src/internal/shim-types.ts +26 -0
  481. package/src/internal/shims.ts +107 -0
  482. package/src/internal/to-file.ts +154 -0
  483. package/src/internal/types.ts +95 -0
  484. package/src/internal/uploads.ts +187 -0
  485. package/src/internal/utils/base64.ts +40 -0
  486. package/src/internal/utils/bytes.ts +32 -0
  487. package/src/internal/utils/env.ts +18 -0
  488. package/src/internal/utils/log.ts +126 -0
  489. package/src/internal/utils/path.ts +88 -0
  490. package/src/internal/utils/query.ts +23 -0
  491. package/src/internal/utils/sleep.ts +3 -0
  492. package/src/internal/utils/uuid.ts +17 -0
  493. package/src/internal/utils/values.ts +105 -0
  494. package/src/internal/utils.ts +9 -0
  495. package/src/lib/.keep +4 -0
  496. package/src/pagination.ts +2 -0
  497. package/src/resource.ts +2 -0
  498. package/src/resources/account.ts +93 -0
  499. package/src/resources/agents/agents.ts +296 -0
  500. package/src/resources/agents/index.ts +39 -0
  501. package/src/resources/agents/variations.ts +377 -0
  502. package/src/resources/agents/webhook-deliveries.ts +143 -0
  503. package/src/resources/agents.ts +3 -0
  504. package/src/resources/api-keys.ts +175 -0
  505. package/src/resources/index.ts +112 -0
  506. package/src/resources/models.ts +128 -0
  507. package/src/resources/objectives/feedback.ts +109 -0
  508. package/src/resources/objectives/index.ts +66 -0
  509. package/src/resources/objectives/objectives.ts +762 -0
  510. package/src/resources/objectives/tasks.ts +99 -0
  511. package/src/resources/objectives/tool-calls.ts +185 -0
  512. package/src/resources/objectives/tools.ts +59 -0
  513. package/src/resources/objectives.ts +3 -0
  514. package/src/resources/search.ts +39 -0
  515. package/src/resources/shared.ts +204 -0
  516. package/src/resources/tool-sets/index.ts +38 -0
  517. package/src/resources/tool-sets/tool-sets.ts +430 -0
  518. package/src/resources/tool-sets/tools.ts +240 -0
  519. package/src/resources/tool-sets.ts +3 -0
  520. package/src/resources/workspace-secrets.ts +147 -0
  521. package/src/resources/workspaces.ts +72 -0
  522. package/src/resources.ts +1 -0
  523. package/src/tsconfig.json +11 -0
  524. package/src/uploads.ts +2 -0
  525. package/src/version.ts +1 -0
  526. package/uploads.d.mts +2 -0
  527. package/uploads.d.mts.map +1 -0
  528. package/uploads.d.ts +2 -0
  529. package/uploads.d.ts.map +1 -0
  530. package/uploads.js +6 -0
  531. package/uploads.js.map +1 -0
  532. package/uploads.mjs +2 -0
  533. package/uploads.mjs.map +1 -0
  534. package/version.d.mts +2 -0
  535. package/version.d.mts.map +1 -0
  536. package/version.d.ts +2 -0
  537. package/version.d.ts.map +1 -0
  538. package/version.js +5 -0
  539. package/version.js.map +1 -0
  540. package/version.mjs +2 -0
  541. package/version.mjs.map +1 -0
@@ -0,0 +1,377 @@
1
+ // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
2
+
3
+ import { APIResource } from '../../core/resource';
4
+ import * as AccountAPI from '../account';
5
+ import * as Shared from '../shared';
6
+ import { APIPromise } from '../../core/api-promise';
7
+ import { CursorPagination, type CursorPaginationParams, PagePromise } from '../../core/pagination';
8
+ import { buildHeaders } from '../../internal/headers';
9
+ import { RequestOptions } from '../../internal/request-options';
10
+ import { path } from '../../internal/utils/path';
11
+
12
+ export class Variations extends APIResource {
13
+ /**
14
+ * Creates a new variation for an agent
15
+ */
16
+ create(agentID: string, body: VariationCreateParams, options?: RequestOptions): APIPromise<AgentVariation> {
17
+ return this._client.post(path`/v1/agents/${agentID}/variations`, { body, ...options });
18
+ }
19
+
20
+ /**
21
+ * Retrieves a variation by ID from an agent
22
+ */
23
+ retrieve(
24
+ id: string,
25
+ params: VariationRetrieveParams,
26
+ options?: RequestOptions,
27
+ ): APIPromise<AgentVariation> {
28
+ const { agentId } = params;
29
+ return this._client.get(path`/v1/agents/${agentId}/variations/${id}`, options);
30
+ }
31
+
32
+ /**
33
+ * Updates a variation for an agent
34
+ */
35
+ update(id: string, params: VariationUpdateParams, options?: RequestOptions): APIPromise<AgentVariation> {
36
+ const { agentId, ...body } = params;
37
+ return this._client.patch(path`/v1/agents/${agentId}/variations/${id}`, { body, ...options });
38
+ }
39
+
40
+ /**
41
+ * Lists all variations for an agent
42
+ */
43
+ list(
44
+ agentID: string,
45
+ query: VariationListParams | null | undefined = {},
46
+ options?: RequestOptions,
47
+ ): PagePromise<AgentVariationsCursorPagination, AgentVariation> {
48
+ return this._client.getAPIList(path`/v1/agents/${agentID}/variations`, CursorPagination<AgentVariation>, {
49
+ query,
50
+ ...options,
51
+ });
52
+ }
53
+
54
+ /**
55
+ * Deletes a variation from an agent
56
+ */
57
+ delete(id: string, params: VariationDeleteParams, options?: RequestOptions): APIPromise<void> {
58
+ const { agentId } = params;
59
+ return this._client.delete(path`/v1/agents/${agentId}/variations/${id}`, {
60
+ ...options,
61
+ headers: buildHeaders([{ Accept: '*/*' }, options?.headers]),
62
+ });
63
+ }
64
+ }
65
+
66
+ export type AgentVariationsCursorPagination = CursorPagination<AgentVariation>;
67
+
68
+ /**
69
+ * AgentVariation resource
70
+ */
71
+ export interface AgentVariation {
72
+ /**
73
+ * Standard metadata for persistent, named resources (e.g., agents, tools, prompts)
74
+ */
75
+ metadata: Shared.ResourceMetadata;
76
+
77
+ /**
78
+ * AgentVariationSpec defines the operational configuration for a variation
79
+ */
80
+ spec: AgentVariationSpec;
81
+
82
+ /**
83
+ * AgentVariationInfo provides read-only summary information about a variation
84
+ */
85
+ info?: AgentVariationInfo;
86
+ }
87
+
88
+ /**
89
+ * AgentVariationInfo provides read-only summary information about a variation
90
+ */
91
+ export interface AgentVariationInfo {
92
+ /**
93
+ * Profile represents a human user at the account level. Profiles are
94
+ * account-scoped resources that can be associated with multiple workspaces through
95
+ * the Actor model. Authentication for profiles is handled via SSO/OAuth (WorkOS).
96
+ */
97
+ createdBy?: AccountAPI.Profile;
98
+
99
+ /**
100
+ * Standard metadata for persistent, named resources (e.g., agents, tools, prompts)
101
+ */
102
+ model?: Shared.ResourceMetadata;
103
+
104
+ /**
105
+ * Number of sub-agents assigned to this variation
106
+ */
107
+ subAgentCount?: number;
108
+
109
+ /**
110
+ * Number of individual tools assigned to this variation
111
+ */
112
+ toolCount?: number;
113
+
114
+ /**
115
+ * Number of tool sets assigned to this variation
116
+ */
117
+ toolSetCount?: number;
118
+ }
119
+
120
+ /**
121
+ * AgentVariationSpec defines the operational configuration for a variation
122
+ */
123
+ export interface AgentVariationSpec {
124
+ /**
125
+ * Documents assigned to this variation. Can include individual documents or entire
126
+ * document namespaces (which include all documents in the namespace).
127
+ */
128
+ agentDocuments?: Array<AgentVariationSpecAgentDocument>;
129
+
130
+ /**
131
+ * Tools assigned to this variation
132
+ */
133
+ agentTools?: Array<AgentVariationSpecAgentTool>;
134
+
135
+ /**
136
+ * Execution constraints
137
+ */
138
+ constraints?: AgentVariationSpecConstraints;
139
+
140
+ /**
141
+ * Human-readable description of what this variation does or when it should be used
142
+ */
143
+ description?: string;
144
+
145
+ /**
146
+ * Enable episodic memory for objectives using this variation. When true, the
147
+ * system automatically creates a document namespace for each objective using the
148
+ * objective's episodic_key as the external_id, allowing the agent to store and
149
+ * retrieve documents specific to that episode.
150
+ */
151
+ enableEpisodicMemory?: boolean;
152
+
153
+ /**
154
+ * How long episodic memories should be retained. After this duration, episodic
155
+ * document namespaces can be automatically cleaned up. If not set, episodic
156
+ * memories are retained indefinitely.
157
+ */
158
+ episodicMemoryTtl?: number;
159
+
160
+ /**
161
+ * ModelConfig defines the model configuration for a variation
162
+ */
163
+ modelConfig?: AgentVariationSpecModelConfig;
164
+
165
+ /**
166
+ * The system prompt for this variation
167
+ */
168
+ prompt?: string;
169
+
170
+ /**
171
+ * Tool selection strategy
172
+ */
173
+ toolSelection?: AgentVariationSpecToolSelection;
174
+
175
+ /**
176
+ * Weight for weighted random selection (>= 0). P(v) = v.weight / sum(all_weights).
177
+ * Only used when the agent's variation_selection_mode is WEIGHTED. A weight of 0
178
+ * means never auto-selected, but can still be chosen explicitly via variation_id
179
+ * on CreateObjectiveRequest.
180
+ */
181
+ weight?: number;
182
+ }
183
+
184
+ export interface AgentVariationSpecAgentDocument {
185
+ documentId?: string;
186
+
187
+ /**
188
+ * Standard metadata for persistent, named resources (e.g., agents, tools, prompts)
189
+ */
190
+ documentMetadata?: Shared.ResourceMetadata;
191
+
192
+ documentNamespaceId?: string;
193
+
194
+ /**
195
+ * Standard metadata for persistent, named resources (e.g., agents, tools, prompts)
196
+ */
197
+ documentNamespaceMetadata?: Shared.ResourceMetadata;
198
+ }
199
+
200
+ export interface AgentVariationSpecAgentTool {
201
+ agentId?: string;
202
+
203
+ /**
204
+ * Standard metadata for persistent, named resources (e.g., agents, tools, prompts)
205
+ */
206
+ agentMetadata?: Shared.ResourceMetadata;
207
+
208
+ toolId?: string;
209
+
210
+ /**
211
+ * Standard metadata for persistent, named resources (e.g., agents, tools, prompts)
212
+ */
213
+ toolMetadata?: Shared.ResourceMetadata;
214
+
215
+ toolSetId?: string;
216
+
217
+ /**
218
+ * Standard metadata for persistent, named resources (e.g., agents, tools, prompts)
219
+ */
220
+ toolSetMetadata?: Shared.ResourceMetadata;
221
+ }
222
+
223
+ export interface AgentVariationSpecConstraints {
224
+ /**
225
+ * The maximum number of sub-objectives that can be created. 0 means no limit.
226
+ */
227
+ maxSubObjectives?: number;
228
+
229
+ /**
230
+ * The maximum number of tool calls that can be made. 0 means no limit.
231
+ */
232
+ maxToolCalls?: number;
233
+ }
234
+
235
+ /**
236
+ * ModelConfig defines the model configuration for a variation
237
+ */
238
+ export interface AgentVariationSpecModelConfig {
239
+ /**
240
+ * The model identifier in family/model format (e.g., "claude/opus-4.6",
241
+ * "claude/sonnet-4.5")
242
+ */
243
+ modelId?: string;
244
+
245
+ /**
246
+ * Sampling temperature for model inference (0.0 to 1.0) Lower values produce more
247
+ * deterministic outputs, higher values increase randomness
248
+ */
249
+ temperature?: number;
250
+ }
251
+
252
+ export interface AgentVariationSpecToolSelection {
253
+ /**
254
+ * AssignedTools is used to indicate that the agent should only use the tools/tool
255
+ * sets that are explicitly assigned to it. Allow discovery is used when the agent
256
+ * thinks it needs to discover more tools.
257
+ */
258
+ assignedTools?: ToolSelectionAssignedTools;
259
+
260
+ /**
261
+ * AutoDiscovery is used to indicate that the agent should automatically discover
262
+ * tools that are not explicitly assigned to it. Max tools is the maximum number of
263
+ * tools that can be discovered. Hints are optional hints for tool search. These
264
+ * are used in conjunction with the context-aware tool search and can help select
265
+ * the best tools for the task.
266
+ */
267
+ autoDiscovery?: ToolSelectionAutoDiscovery;
268
+ }
269
+
270
+ /**
271
+ * AssignedTools is used to indicate that the agent should only use the tools/tool
272
+ * sets that are explicitly assigned to it. Allow discovery is used when the agent
273
+ * thinks it needs to discover more tools.
274
+ */
275
+ export interface ToolSelectionAssignedTools {
276
+ allowDiscovery?: boolean;
277
+ }
278
+
279
+ /**
280
+ * AutoDiscovery is used to indicate that the agent should automatically discover
281
+ * tools that are not explicitly assigned to it. Max tools is the maximum number of
282
+ * tools that can be discovered. Hints are optional hints for tool search. These
283
+ * are used in conjunction with the context-aware tool search and can help select
284
+ * the best tools for the task.
285
+ */
286
+ export interface ToolSelectionAutoDiscovery {
287
+ hints?: Array<string>;
288
+
289
+ maxTools?: number;
290
+ }
291
+
292
+ export interface VariationCreateParams {
293
+ /**
294
+ * CreateResourceMetadata contains the user-provided fields for creating a
295
+ * workspace-scoped resource. Read-only fields (id, account_id, workspace_id,
296
+ * profile_id, created_at) are excluded since they are set by the server.
297
+ */
298
+ metadata: Shared.CreateResourceMetadata;
299
+
300
+ /**
301
+ * AgentVariationSpec defines the operational configuration for a variation
302
+ */
303
+ spec: AgentVariationSpec;
304
+ }
305
+
306
+ export interface VariationRetrieveParams {
307
+ /**
308
+ * Agent ID (from path)
309
+ */
310
+ agentId: string;
311
+ }
312
+
313
+ export interface VariationUpdateParams {
314
+ /**
315
+ * Path param: Agent ID (from path)
316
+ */
317
+ agentId: string;
318
+
319
+ /**
320
+ * Body param: UpdateResourceMetadata contains the user-provided fields for
321
+ * updating a workspace-scoped resource. Read-only fields (id, account_id,
322
+ * workspace_id, profile_id, created_at) are excluded since they are set by the
323
+ * server.
324
+ */
325
+ metadata?: Shared.UpdateResourceMetadata;
326
+
327
+ /**
328
+ * Body param: AgentVariationSpec defines the operational configuration for a
329
+ * variation
330
+ */
331
+ spec?: AgentVariationSpec;
332
+
333
+ /**
334
+ * Body param: Fields to update
335
+ */
336
+ updateMask?: string;
337
+ }
338
+
339
+ export interface VariationListParams extends CursorPaginationParams {
340
+ /**
341
+ * When set to true you may use more of your alloted API rate-limit
342
+ */
343
+ includeInfo?: boolean;
344
+
345
+ /**
346
+ * Sort order for results (asc or desc by creation time)
347
+ */
348
+ sortOrder?: string;
349
+ }
350
+
351
+ export interface VariationDeleteParams {
352
+ /**
353
+ * Agent ID (from path)
354
+ */
355
+ agentId: string;
356
+ }
357
+
358
+ export declare namespace Variations {
359
+ export {
360
+ type AgentVariation as AgentVariation,
361
+ type AgentVariationInfo as AgentVariationInfo,
362
+ type AgentVariationSpec as AgentVariationSpec,
363
+ type AgentVariationSpecAgentDocument as AgentVariationSpecAgentDocument,
364
+ type AgentVariationSpecAgentTool as AgentVariationSpecAgentTool,
365
+ type AgentVariationSpecConstraints as AgentVariationSpecConstraints,
366
+ type AgentVariationSpecModelConfig as AgentVariationSpecModelConfig,
367
+ type AgentVariationSpecToolSelection as AgentVariationSpecToolSelection,
368
+ type ToolSelectionAssignedTools as ToolSelectionAssignedTools,
369
+ type ToolSelectionAutoDiscovery as ToolSelectionAutoDiscovery,
370
+ type AgentVariationsCursorPagination as AgentVariationsCursorPagination,
371
+ type VariationCreateParams as VariationCreateParams,
372
+ type VariationRetrieveParams as VariationRetrieveParams,
373
+ type VariationUpdateParams as VariationUpdateParams,
374
+ type VariationListParams as VariationListParams,
375
+ type VariationDeleteParams as VariationDeleteParams,
376
+ };
377
+ }
@@ -0,0 +1,143 @@
1
+ // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
2
+
3
+ import { APIResource } from '../../core/resource';
4
+ import * as Shared from '../shared';
5
+ import { CursorPagination, type CursorPaginationParams, PagePromise } from '../../core/pagination';
6
+ import { RequestOptions } from '../../internal/request-options';
7
+ import { path } from '../../internal/utils/path';
8
+
9
+ /**
10
+ * AgentService manages AI agents at the WORKSPACE level.
11
+ * Agents are workspace-scoped resources that define AI behavior and tool access.
12
+ * All operations are implicitly scoped to the workspace determined by the JWT token.
13
+ *
14
+ * Authentication: Bearer token (JWT)
15
+ * Scope: Workspace-level operations
16
+ */
17
+ export class WebhookDeliveries extends APIResource {
18
+ /**
19
+ * Lists all webhook deliveries for an agent
20
+ */
21
+ list(
22
+ agentID: string,
23
+ query: WebhookDeliveryListParams | null | undefined = {},
24
+ options?: RequestOptions,
25
+ ): PagePromise<WebhookDeliveriesCursorPagination, WebhookDelivery> {
26
+ return this._client.getAPIList(
27
+ path`/v1/agents/${agentID}/webhook_deliveries`,
28
+ CursorPagination<WebhookDelivery>,
29
+ { query, ...options },
30
+ );
31
+ }
32
+ }
33
+
34
+ export type WebhookDeliveriesCursorPagination = CursorPagination<WebhookDelivery>;
35
+
36
+ export interface WebhookDelivery {
37
+ /**
38
+ * Webhook delivery data
39
+ */
40
+ data: WebhookDeliveryData;
41
+
42
+ /**
43
+ * Metadata for ephemeral operations and activities (e.g., objectives, executions,
44
+ * runs)
45
+ */
46
+ metadata: Shared.OperationMetadata;
47
+ }
48
+
49
+ export interface WebhookDeliveryData {
50
+ /**
51
+ * Related resources
52
+ */
53
+ agentId: string;
54
+
55
+ attemptCount: number;
56
+
57
+ /**
58
+ * The type of objective event that triggered this webhook delivery
59
+ */
60
+ eventType:
61
+ | 'OBJECTIVE_EVENT_TYPE_UNSPECIFIED'
62
+ | 'OBJECTIVE_EVENT_TYPE_USER_MESSAGE'
63
+ | 'OBJECTIVE_EVENT_TYPE_TOOL_APPROVAL_REQUESTED'
64
+ | 'OBJECTIVE_EVENT_TYPE_TOOL_APPROVED'
65
+ | 'OBJECTIVE_EVENT_TYPE_TOOL_DENIED'
66
+ | 'OBJECTIVE_EVENT_TYPE_TOOL_CALLED'
67
+ | 'OBJECTIVE_EVENT_TYPE_SUB_OBJECTIVE_CREATED'
68
+ | 'OBJECTIVE_EVENT_TYPE_ERROR'
69
+ | 'OBJECTIVE_EVENT_TYPE_ASSISTANT_MESSAGE'
70
+ | 'OBJECTIVE_EVENT_TYPE_TOOL_RESULT'
71
+ | 'OBJECTIVE_EVENT_TYPE_TOOL_ERROR';
72
+
73
+ /**
74
+ * Response details (no response_body to avoid storing large payloads)
75
+ */
76
+ httpStatusCode: number;
77
+
78
+ lastAttemptAt: string;
79
+
80
+ latencyMs: number;
81
+
82
+ objectiveEventId: string;
83
+
84
+ objectiveId: string;
85
+
86
+ /**
87
+ * Content length of the response body in bytes
88
+ */
89
+ responseContentLength: string;
90
+
91
+ status:
92
+ | 'WEBHOOK_DELIVERY_STATUS_UNSPECIFIED'
93
+ | 'WEBHOOK_DELIVERY_STATUS_PENDING'
94
+ | 'WEBHOOK_DELIVERY_STATUS_COMPLETED'
95
+ | 'WEBHOOK_DELIVERY_STATUS_FAILED'
96
+ | 'WEBHOOK_DELIVERY_STATUS_DISABLED';
97
+
98
+ webhookId: string;
99
+
100
+ /**
101
+ * Webhook delivery details
102
+ */
103
+ webhookUrl: string;
104
+
105
+ errorMessage?: string;
106
+
107
+ /**
108
+ * Response headers received from the webhook endpoint
109
+ */
110
+ responseHeaders?: { [key: string]: string };
111
+ }
112
+
113
+ export interface WebhookDeliveryListParams extends CursorPaginationParams {
114
+ /**
115
+ * Optional filter by event type
116
+ */
117
+ eventType?:
118
+ | 'OBJECTIVE_EVENT_TYPE_UNSPECIFIED'
119
+ | 'OBJECTIVE_EVENT_TYPE_USER_MESSAGE'
120
+ | 'OBJECTIVE_EVENT_TYPE_TOOL_APPROVAL_REQUESTED'
121
+ | 'OBJECTIVE_EVENT_TYPE_TOOL_APPROVED'
122
+ | 'OBJECTIVE_EVENT_TYPE_TOOL_DENIED'
123
+ | 'OBJECTIVE_EVENT_TYPE_TOOL_CALLED'
124
+ | 'OBJECTIVE_EVENT_TYPE_SUB_OBJECTIVE_CREATED'
125
+ | 'OBJECTIVE_EVENT_TYPE_ERROR'
126
+ | 'OBJECTIVE_EVENT_TYPE_ASSISTANT_MESSAGE'
127
+ | 'OBJECTIVE_EVENT_TYPE_TOOL_RESULT'
128
+ | 'OBJECTIVE_EVENT_TYPE_TOOL_ERROR';
129
+
130
+ /**
131
+ * Optional filter by objective ID
132
+ */
133
+ objectiveId?: string;
134
+ }
135
+
136
+ export declare namespace WebhookDeliveries {
137
+ export {
138
+ type WebhookDelivery as WebhookDelivery,
139
+ type WebhookDeliveryData as WebhookDeliveryData,
140
+ type WebhookDeliveriesCursorPagination as WebhookDeliveriesCursorPagination,
141
+ type WebhookDeliveryListParams as WebhookDeliveryListParams,
142
+ };
143
+ }
@@ -0,0 +1,3 @@
1
+ // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
2
+
3
+ export * from './agents/index';
@@ -0,0 +1,175 @@
1
+ // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
2
+
3
+ import { APIResource } from '../core/resource';
4
+ import * as AccountAPI from './account';
5
+ import * as Shared from './shared';
6
+ import { APIPromise } from '../core/api-promise';
7
+ import { CursorPagination, type CursorPaginationParams, PagePromise } from '../core/pagination';
8
+ import { buildHeaders } from '../internal/headers';
9
+ import { RequestOptions } from '../internal/request-options';
10
+ import { path } from '../internal/utils/path';
11
+
12
+ /**
13
+ * APIKeyService manages workspace-scoped API Keys.
14
+ * Each API key belongs to a single workspace, ensuring isolation between environments.
15
+ *
16
+ * Authentication: Bearer token (JWT)
17
+ * Scope: Workspace-level operations
18
+ */
19
+ export class APIKeys extends APIResource {
20
+ /**
21
+ * Creates a new API key in the workspace.
22
+ */
23
+ create(body: APIKeyCreateParams, options?: RequestOptions): APIPromise<APIKey> {
24
+ return this._client.post('/v1/api_keys', { body, ...options });
25
+ }
26
+
27
+ /**
28
+ * Retrieves an API key by ID from the workspace
29
+ */
30
+ retrieve(id: string, options?: RequestOptions): APIPromise<APIKey> {
31
+ return this._client.get(path`/v1/api_keys/${id}`, options);
32
+ }
33
+
34
+ /**
35
+ * Updates an API key in the workspace
36
+ */
37
+ update(id: string, body: APIKeyUpdateParams, options?: RequestOptions): APIPromise<APIKey> {
38
+ return this._client.patch(path`/v1/api_keys/${id}`, { body, ...options });
39
+ }
40
+
41
+ /**
42
+ * Lists all API keys in the workspace
43
+ */
44
+ list(
45
+ query: APIKeyListParams | null | undefined = {},
46
+ options?: RequestOptions,
47
+ ): PagePromise<APIKeysCursorPagination, APIKey> {
48
+ return this._client.getAPIList('/v1/api_keys', CursorPagination<APIKey>, { query, ...options });
49
+ }
50
+
51
+ /**
52
+ * Deletes an API key from the workspace
53
+ */
54
+ delete(id: string, options?: RequestOptions): APIPromise<void> {
55
+ return this._client.delete(path`/v1/api_keys/${id}`, {
56
+ ...options,
57
+ headers: buildHeaders([{ Accept: '*/*' }, options?.headers]),
58
+ });
59
+ }
60
+
61
+ /**
62
+ * Rotates an API Key and returns a new token. All previous API Key tokens in use
63
+ * will be invalidated.
64
+ */
65
+ rotate(id: string, options?: RequestOptions): APIPromise<APIKey> {
66
+ return this._client.put(path`/v1/api_keys/${id}/rotate`, options);
67
+ }
68
+ }
69
+
70
+ export type APIKeysCursorPagination = CursorPagination<APIKey>;
71
+
72
+ /**
73
+ * APIKey represents a workspace-scoped API key. Each API key belongs to exactly
74
+ * one workspace, ensuring workspace isolation. Authentication is handled via
75
+ * Cadenya-issued JWTs signed with the key's own signing secret.
76
+ */
77
+ export interface APIKey {
78
+ /**
79
+ * Standard metadata for persistent, named resources (e.g., agents, tools, prompts)
80
+ */
81
+ metadata: Shared.ResourceMetadata;
82
+
83
+ /**
84
+ * APIKeySpec contains the API Key-specific fields
85
+ */
86
+ spec: APIKeySpec;
87
+
88
+ info?: APIKeyInfo;
89
+ }
90
+
91
+ export interface APIKeyInfo {
92
+ /**
93
+ * Profile represents a human user at the account level. Profiles are
94
+ * account-scoped resources that can be associated with multiple workspaces through
95
+ * the Actor model. Authentication for profiles is handled via SSO/OAuth (WorkOS).
96
+ */
97
+ createdBy?: AccountAPI.Profile;
98
+ }
99
+
100
+ /**
101
+ * APIKeySpec contains the API Key-specific fields
102
+ */
103
+ export interface APIKeySpec {
104
+ /**
105
+ * The actual token value (only returned on creation and rotation, read-only)
106
+ */
107
+ token?: string;
108
+
109
+ /**
110
+ * Description of what this API Key is used for
111
+ */
112
+ description?: string;
113
+ }
114
+
115
+ export interface APIKeyCreateParams {
116
+ /**
117
+ * CreateResourceMetadata contains the user-provided fields for creating a
118
+ * workspace-scoped resource. Read-only fields (id, account_id, workspace_id,
119
+ * profile_id, created_at) are excluded since they are set by the server.
120
+ */
121
+ metadata: Shared.CreateResourceMetadata;
122
+
123
+ /**
124
+ * APIKeySpec contains the API Key-specific fields
125
+ */
126
+ spec: APIKeySpec;
127
+ }
128
+
129
+ export interface APIKeyUpdateParams {
130
+ /**
131
+ * UpdateResourceMetadata contains the user-provided fields for updating a
132
+ * workspace-scoped resource. Read-only fields (id, account_id, workspace_id,
133
+ * profile_id, created_at) are excluded since they are set by the server.
134
+ */
135
+ metadata?: Shared.UpdateResourceMetadata;
136
+
137
+ /**
138
+ * APIKeySpec contains the API Key-specific fields
139
+ */
140
+ spec?: APIKeySpec;
141
+
142
+ /**
143
+ * Fields to update
144
+ */
145
+ updateMask?: string;
146
+ }
147
+
148
+ export interface APIKeyListParams extends CursorPaginationParams {
149
+ /**
150
+ * When set to true you may use more of your alloted API rate-limit
151
+ */
152
+ includeInfo?: boolean;
153
+
154
+ /**
155
+ * Filter expression (query param: prefix)
156
+ */
157
+ prefix?: string;
158
+
159
+ /**
160
+ * Sort order for results (asc or desc by creation time)
161
+ */
162
+ sortOrder?: string;
163
+ }
164
+
165
+ export declare namespace APIKeys {
166
+ export {
167
+ type APIKey as APIKey,
168
+ type APIKeyInfo as APIKeyInfo,
169
+ type APIKeySpec as APIKeySpec,
170
+ type APIKeysCursorPagination as APIKeysCursorPagination,
171
+ type APIKeyCreateParams as APIKeyCreateParams,
172
+ type APIKeyUpdateParams as APIKeyUpdateParams,
173
+ type APIKeyListParams as APIKeyListParams,
174
+ };
175
+ }