@scenario-labs/sdk 3.2.0 → 3.3.1

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 (530) hide show
  1. package/CHANGELOG.md +36 -0
  2. package/client.d.mts +20 -5
  3. package/client.d.mts.map +1 -1
  4. package/client.d.ts +20 -5
  5. package/client.d.ts.map +1 -1
  6. package/client.js +9 -0
  7. package/client.js.map +1 -1
  8. package/client.mjs +9 -0
  9. package/client.mjs.map +1 -1
  10. package/core/pagination.d.mts +42 -0
  11. package/core/pagination.d.mts.map +1 -1
  12. package/core/pagination.d.ts +42 -0
  13. package/core/pagination.d.ts.map +1 -1
  14. package/core/pagination.js +79 -1
  15. package/core/pagination.js.map +1 -1
  16. package/core/pagination.mjs +75 -0
  17. package/core/pagination.mjs.map +1 -1
  18. package/internal/utils/values.d.mts +6 -0
  19. package/internal/utils/values.d.mts.map +1 -1
  20. package/internal/utils/values.d.ts +6 -0
  21. package/internal/utils/values.d.ts.map +1 -1
  22. package/internal/utils/values.js +11 -0
  23. package/internal/utils/values.js.map +1 -1
  24. package/internal/utils/values.mjs +10 -0
  25. package/internal/utils/values.mjs.map +1 -1
  26. package/lib/asset.d.mts +1 -1
  27. package/lib/asset.d.ts +1 -1
  28. package/lib/asset.js +1 -1
  29. package/lib/asset.mjs +1 -1
  30. package/lib/generate.js +7 -7
  31. package/lib/generate.js.map +1 -1
  32. package/lib/generate.mjs +7 -7
  33. package/lib/generate.mjs.map +1 -1
  34. package/lib/job.d.mts +1 -1
  35. package/lib/job.d.mts.map +1 -1
  36. package/lib/job.d.ts +1 -1
  37. package/lib/job.d.ts.map +1 -1
  38. package/lib/job.js +5 -6
  39. package/lib/job.js.map +1 -1
  40. package/lib/job.mjs +6 -7
  41. package/lib/job.mjs.map +1 -1
  42. package/lib/models.d.mts.map +1 -1
  43. package/lib/models.d.ts.map +1 -1
  44. package/lib/models.js +7 -5
  45. package/lib/models.js.map +1 -1
  46. package/lib/models.mjs +8 -6
  47. package/lib/models.mjs.map +1 -1
  48. package/lib/query.d.mts +21 -0
  49. package/lib/query.d.mts.map +1 -0
  50. package/lib/query.d.ts +21 -0
  51. package/lib/query.d.ts.map +1 -0
  52. package/lib/query.js +36 -0
  53. package/lib/query.js.map +1 -0
  54. package/lib/query.mjs +33 -0
  55. package/lib/query.mjs.map +1 -0
  56. package/lib/scenario.d.mts +3 -0
  57. package/lib/scenario.d.mts.map +1 -1
  58. package/lib/scenario.d.ts +3 -0
  59. package/lib/scenario.d.ts.map +1 -1
  60. package/lib/scenario.js +6 -0
  61. package/lib/scenario.js.map +1 -1
  62. package/lib/scenario.mjs +6 -0
  63. package/lib/scenario.mjs.map +1 -1
  64. package/lib/scope.d.mts +27 -7
  65. package/lib/scope.d.mts.map +1 -1
  66. package/lib/scope.d.ts +27 -7
  67. package/lib/scope.d.ts.map +1 -1
  68. package/lib/scope.js +40 -7
  69. package/lib/scope.js.map +1 -1
  70. package/lib/scope.mjs +37 -7
  71. package/lib/scope.mjs.map +1 -1
  72. package/lib/upload.d.mts +11 -6
  73. package/lib/upload.d.mts.map +1 -1
  74. package/lib/upload.d.ts +11 -6
  75. package/lib/upload.d.ts.map +1 -1
  76. package/lib/upload.js +6 -7
  77. package/lib/upload.js.map +1 -1
  78. package/lib/upload.mjs +7 -8
  79. package/lib/upload.mjs.map +1 -1
  80. package/lib/workflow.d.mts +4 -2
  81. package/lib/workflow.d.mts.map +1 -1
  82. package/lib/workflow.d.ts +4 -2
  83. package/lib/workflow.d.ts.map +1 -1
  84. package/lib/workflow.js +13 -7
  85. package/lib/workflow.js.map +1 -1
  86. package/lib/workflow.mjs +14 -8
  87. package/lib/workflow.mjs.map +1 -1
  88. package/lib/workflow_converter.d.mts.map +1 -1
  89. package/lib/workflow_converter.d.ts.map +1 -1
  90. package/lib/workflow_converter.js +1 -1
  91. package/lib/workflow_converter.js.map +1 -1
  92. package/lib/workflow_converter.mjs +1 -1
  93. package/lib/workflow_converter.mjs.map +1 -1
  94. package/lib/workflow_validator.d.mts +5 -0
  95. package/lib/workflow_validator.d.mts.map +1 -1
  96. package/lib/workflow_validator.d.ts +5 -0
  97. package/lib/workflow_validator.d.ts.map +1 -1
  98. package/lib/workflow_validator.js +113 -0
  99. package/lib/workflow_validator.js.map +1 -1
  100. package/lib/workflow_validator.mjs +113 -0
  101. package/lib/workflow_validator.mjs.map +1 -1
  102. package/package.json +1 -1
  103. package/resources/assets/assets.d.mts +130 -31
  104. package/resources/assets/assets.d.mts.map +1 -1
  105. package/resources/assets/assets.d.ts +130 -31
  106. package/resources/assets/assets.d.ts.map +1 -1
  107. package/resources/assets/assets.js +34 -11
  108. package/resources/assets/assets.js.map +1 -1
  109. package/resources/assets/assets.mjs +34 -11
  110. package/resources/assets/assets.mjs.map +1 -1
  111. package/resources/assets/download.d.mts +24 -5
  112. package/resources/assets/download.d.mts.map +1 -1
  113. package/resources/assets/download.d.ts +24 -5
  114. package/resources/assets/download.d.ts.map +1 -1
  115. package/resources/assets/download.js +15 -3
  116. package/resources/assets/download.js.map +1 -1
  117. package/resources/assets/download.mjs +15 -3
  118. package/resources/assets/download.mjs.map +1 -1
  119. package/resources/collections/assets.d.mts.map +1 -1
  120. package/resources/collections/assets.d.ts.map +1 -1
  121. package/resources/collections/assets.js +3 -2
  122. package/resources/collections/assets.js.map +1 -1
  123. package/resources/collections/assets.mjs +3 -2
  124. package/resources/collections/assets.mjs.map +1 -1
  125. package/resources/collections/collections.d.mts.map +1 -1
  126. package/resources/collections/collections.d.ts.map +1 -1
  127. package/resources/collections/collections.js +20 -5
  128. package/resources/collections/collections.js.map +1 -1
  129. package/resources/collections/collections.mjs +20 -5
  130. package/resources/collections/collections.mjs.map +1 -1
  131. package/resources/collections/models.d.mts.map +1 -1
  132. package/resources/collections/models.d.ts.map +1 -1
  133. package/resources/collections/models.js +3 -2
  134. package/resources/collections/models.js.map +1 -1
  135. package/resources/collections/models.mjs +3 -2
  136. package/resources/collections/models.mjs.map +1 -1
  137. package/resources/generate.d.mts +1719 -225
  138. package/resources/generate.d.mts.map +1 -1
  139. package/resources/generate.d.ts +1719 -225
  140. package/resources/generate.d.ts.map +1 -1
  141. package/resources/generate.js +65 -8
  142. package/resources/generate.js.map +1 -1
  143. package/resources/generate.mjs +65 -8
  144. package/resources/generate.mjs.map +1 -1
  145. package/resources/index.d.mts +5 -2
  146. package/resources/index.d.mts.map +1 -1
  147. package/resources/index.d.ts +5 -2
  148. package/resources/index.d.ts.map +1 -1
  149. package/resources/index.js +7 -1
  150. package/resources/index.js.map +1 -1
  151. package/resources/index.mjs +3 -0
  152. package/resources/index.mjs.map +1 -1
  153. package/resources/jobs.d.mts +176 -74
  154. package/resources/jobs.d.mts.map +1 -1
  155. package/resources/jobs.d.ts +176 -74
  156. package/resources/jobs.d.ts.map +1 -1
  157. package/resources/jobs.js +16 -4
  158. package/resources/jobs.js.map +1 -1
  159. package/resources/jobs.mjs +16 -4
  160. package/resources/jobs.mjs.map +1 -1
  161. package/resources/models/description.d.mts +2 -2
  162. package/resources/models/description.d.mts.map +1 -1
  163. package/resources/models/description.d.ts +2 -2
  164. package/resources/models/description.d.ts.map +1 -1
  165. package/resources/models/description.js +6 -2
  166. package/resources/models/description.js.map +1 -1
  167. package/resources/models/description.mjs +6 -2
  168. package/resources/models/description.mjs.map +1 -1
  169. package/resources/models/examples.d.mts +120 -48
  170. package/resources/models/examples.d.mts.map +1 -1
  171. package/resources/models/examples.d.ts +120 -48
  172. package/resources/models/examples.d.ts.map +1 -1
  173. package/resources/models/examples.js +6 -2
  174. package/resources/models/examples.js.map +1 -1
  175. package/resources/models/examples.mjs +6 -2
  176. package/resources/models/examples.mjs.map +1 -1
  177. package/resources/models/index.d.mts +3 -0
  178. package/resources/models/index.d.mts.map +1 -1
  179. package/resources/models/index.d.ts +3 -0
  180. package/resources/models/index.d.ts.map +1 -1
  181. package/resources/models/index.js +7 -1
  182. package/resources/models/index.js.map +1 -1
  183. package/resources/models/index.mjs +3 -0
  184. package/resources/models/index.mjs.map +1 -1
  185. package/resources/models/models.d.mts +215 -77
  186. package/resources/models/models.d.mts.map +1 -1
  187. package/resources/models/models.d.ts +215 -77
  188. package/resources/models/models.d.ts.map +1 -1
  189. package/resources/models/models.js +52 -11
  190. package/resources/models/models.js.map +1 -1
  191. package/resources/models/models.mjs +52 -11
  192. package/resources/models/models.mjs.map +1 -1
  193. package/resources/models/presets.d.mts +1016 -0
  194. package/resources/models/presets.d.mts.map +1 -0
  195. package/resources/models/presets.d.ts +1016 -0
  196. package/resources/models/presets.d.ts.map +1 -0
  197. package/resources/models/presets.js +52 -0
  198. package/resources/models/presets.js.map +1 -0
  199. package/resources/models/presets.mjs +48 -0
  200. package/resources/models/presets.mjs.map +1 -0
  201. package/resources/models/prompt-guide.d.mts +64 -0
  202. package/resources/models/prompt-guide.d.mts.map +1 -0
  203. package/resources/models/prompt-guide.d.ts +64 -0
  204. package/resources/models/prompt-guide.d.ts.map +1 -0
  205. package/resources/models/prompt-guide.js +31 -0
  206. package/resources/models/prompt-guide.js.map +1 -0
  207. package/resources/models/prompt-guide.mjs +27 -0
  208. package/resources/models/prompt-guide.mjs.map +1 -0
  209. package/resources/models/scores.d.mts +278 -0
  210. package/resources/models/scores.d.mts.map +1 -0
  211. package/resources/models/scores.d.ts +278 -0
  212. package/resources/models/scores.d.ts.map +1 -0
  213. package/resources/models/scores.js +29 -0
  214. package/resources/models/scores.js.map +1 -0
  215. package/resources/models/scores.mjs +25 -0
  216. package/resources/models/scores.mjs.map +1 -0
  217. package/resources/models/train.d.mts +108 -45
  218. package/resources/models/train.d.mts.map +1 -1
  219. package/resources/models/train.d.ts +108 -45
  220. package/resources/models/train.d.ts.map +1 -1
  221. package/resources/models/train.js +3 -2
  222. package/resources/models/train.js.map +1 -1
  223. package/resources/models/train.mjs +3 -2
  224. package/resources/models/train.mjs.map +1 -1
  225. package/resources/models/training-images.d.mts.map +1 -1
  226. package/resources/models/training-images.d.ts.map +1 -1
  227. package/resources/models/training-images.js +5 -4
  228. package/resources/models/training-images.js.map +1 -1
  229. package/resources/models/training-images.mjs +5 -4
  230. package/resources/models/training-images.mjs.map +1 -1
  231. package/resources/projects/api-keys.d.mts +54 -0
  232. package/resources/projects/api-keys.d.mts.map +1 -0
  233. package/resources/projects/api-keys.d.ts +54 -0
  234. package/resources/projects/api-keys.d.ts.map +1 -0
  235. package/resources/projects/api-keys.js +23 -0
  236. package/resources/projects/api-keys.js.map +1 -0
  237. package/resources/projects/api-keys.mjs +19 -0
  238. package/resources/projects/api-keys.mjs.map +1 -0
  239. package/resources/projects/brief.d.mts +149 -0
  240. package/resources/projects/brief.d.mts.map +1 -0
  241. package/resources/projects/brief.d.ts +149 -0
  242. package/resources/projects/brief.d.ts.map +1 -0
  243. package/resources/projects/brief.js +28 -0
  244. package/resources/projects/brief.js.map +1 -0
  245. package/resources/projects/brief.mjs +24 -0
  246. package/resources/projects/brief.mjs.map +1 -0
  247. package/resources/projects/index.d.mts +9 -0
  248. package/resources/projects/index.d.mts.map +1 -0
  249. package/resources/projects/index.d.ts +9 -0
  250. package/resources/projects/index.d.ts.map +1 -0
  251. package/resources/projects/index.js +21 -0
  252. package/resources/projects/index.js.map +1 -0
  253. package/resources/projects/index.mjs +10 -0
  254. package/resources/projects/index.mjs.map +1 -0
  255. package/resources/projects/instructions.d.mts +102 -0
  256. package/resources/projects/instructions.d.mts.map +1 -0
  257. package/resources/projects/instructions.d.ts +102 -0
  258. package/resources/projects/instructions.d.ts.map +1 -0
  259. package/resources/projects/instructions.js +24 -0
  260. package/resources/projects/instructions.js.map +1 -0
  261. package/resources/projects/instructions.mjs +20 -0
  262. package/resources/projects/instructions.mjs.map +1 -0
  263. package/resources/projects/members.d.mts +788 -0
  264. package/resources/projects/members.d.mts.map +1 -0
  265. package/resources/projects/members.d.ts +788 -0
  266. package/resources/projects/members.d.ts.map +1 -0
  267. package/resources/projects/members.js +30 -0
  268. package/resources/projects/members.js.map +1 -0
  269. package/resources/projects/members.mjs +26 -0
  270. package/resources/projects/members.mjs.map +1 -0
  271. package/resources/projects/memory.d.mts +102 -0
  272. package/resources/projects/memory.d.mts.map +1 -0
  273. package/resources/projects/memory.d.ts +102 -0
  274. package/resources/projects/memory.d.ts.map +1 -0
  275. package/resources/projects/memory.js +24 -0
  276. package/resources/projects/memory.js.map +1 -0
  277. package/resources/projects/memory.mjs +20 -0
  278. package/resources/projects/memory.mjs.map +1 -0
  279. package/resources/projects/projects.d.mts +1129 -0
  280. package/resources/projects/projects.d.mts.map +1 -0
  281. package/resources/projects/projects.d.ts +1129 -0
  282. package/resources/projects/projects.d.ts.map +1 -0
  283. package/resources/projects/projects.js +79 -0
  284. package/resources/projects/projects.js.map +1 -0
  285. package/resources/projects/projects.mjs +74 -0
  286. package/resources/projects/projects.mjs.map +1 -0
  287. package/resources/projects/watermark.d.mts +459 -0
  288. package/resources/projects/watermark.d.mts.map +1 -0
  289. package/resources/projects/watermark.d.ts +459 -0
  290. package/resources/projects/watermark.d.ts.map +1 -0
  291. package/resources/projects/watermark.js +46 -0
  292. package/resources/projects/watermark.js.map +1 -0
  293. package/resources/projects/watermark.mjs +42 -0
  294. package/resources/projects/watermark.mjs.map +1 -0
  295. package/resources/projects/webhook-endpoints/events.d.mts +87 -0
  296. package/resources/projects/webhook-endpoints/events.d.mts.map +1 -0
  297. package/resources/projects/webhook-endpoints/events.d.ts +87 -0
  298. package/resources/projects/webhook-endpoints/events.d.ts.map +1 -0
  299. package/resources/projects/webhook-endpoints/events.js +28 -0
  300. package/resources/projects/webhook-endpoints/events.js.map +1 -0
  301. package/resources/projects/webhook-endpoints/events.mjs +24 -0
  302. package/resources/projects/webhook-endpoints/events.mjs.map +1 -0
  303. package/resources/projects/webhook-endpoints/index.d.mts +3 -0
  304. package/resources/projects/webhook-endpoints/index.d.mts.map +1 -0
  305. package/resources/projects/webhook-endpoints/index.d.ts +3 -0
  306. package/resources/projects/webhook-endpoints/index.d.ts.map +1 -0
  307. package/resources/projects/webhook-endpoints/index.js +9 -0
  308. package/resources/projects/webhook-endpoints/index.js.map +1 -0
  309. package/resources/projects/webhook-endpoints/index.mjs +4 -0
  310. package/resources/projects/webhook-endpoints/index.mjs.map +1 -0
  311. package/resources/projects/webhook-endpoints/webhook-endpoints.d.mts +249 -0
  312. package/resources/projects/webhook-endpoints/webhook-endpoints.d.mts.map +1 -0
  313. package/resources/projects/webhook-endpoints/webhook-endpoints.d.ts +249 -0
  314. package/resources/projects/webhook-endpoints/webhook-endpoints.d.ts.map +1 -0
  315. package/resources/projects/webhook-endpoints/webhook-endpoints.js +44 -0
  316. package/resources/projects/webhook-endpoints/webhook-endpoints.js.map +1 -0
  317. package/resources/projects/webhook-endpoints/webhook-endpoints.mjs +39 -0
  318. package/resources/projects/webhook-endpoints/webhook-endpoints.mjs.map +1 -0
  319. package/resources/projects/webhook-endpoints.d.mts +2 -0
  320. package/resources/projects/webhook-endpoints.d.mts.map +1 -0
  321. package/resources/projects/webhook-endpoints.d.ts +2 -0
  322. package/resources/projects/webhook-endpoints.d.ts.map +1 -0
  323. package/resources/projects/webhook-endpoints.js +6 -0
  324. package/resources/projects/webhook-endpoints.js.map +1 -0
  325. package/resources/projects/webhook-endpoints.mjs +3 -0
  326. package/resources/projects/webhook-endpoints.mjs.map +1 -0
  327. package/resources/projects.d.mts +2 -0
  328. package/resources/projects.d.mts.map +1 -0
  329. package/resources/projects.d.ts +2 -0
  330. package/resources/projects.d.ts.map +1 -0
  331. package/resources/projects.js +6 -0
  332. package/resources/projects.js.map +1 -0
  333. package/resources/projects.mjs +3 -0
  334. package/resources/projects.mjs.map +1 -0
  335. package/resources/recommendations.d.mts +1107 -0
  336. package/resources/recommendations.d.mts.map +1 -0
  337. package/resources/recommendations.d.ts +1107 -0
  338. package/resources/recommendations.d.ts.map +1 -0
  339. package/resources/recommendations.js +17 -0
  340. package/resources/recommendations.js.map +1 -0
  341. package/resources/recommendations.mjs +13 -0
  342. package/resources/recommendations.mjs.map +1 -0
  343. package/resources/search.d.mts.map +1 -1
  344. package/resources/search.d.ts.map +1 -1
  345. package/resources/search.js +4 -3
  346. package/resources/search.js.map +1 -1
  347. package/resources/search.mjs +4 -3
  348. package/resources/search.mjs.map +1 -1
  349. package/resources/tags.d.mts.map +1 -1
  350. package/resources/tags.d.ts.map +1 -1
  351. package/resources/tags.js +5 -1
  352. package/resources/tags.js.map +1 -1
  353. package/resources/tags.mjs +5 -1
  354. package/resources/tags.mjs.map +1 -1
  355. package/resources/teams/brief.d.mts +149 -0
  356. package/resources/teams/brief.d.mts.map +1 -0
  357. package/resources/teams/brief.d.ts +149 -0
  358. package/resources/teams/brief.d.ts.map +1 -0
  359. package/resources/teams/brief.js +28 -0
  360. package/resources/teams/brief.js.map +1 -0
  361. package/resources/teams/brief.mjs +24 -0
  362. package/resources/teams/brief.mjs.map +1 -0
  363. package/resources/teams/index.d.mts +7 -0
  364. package/resources/teams/index.d.mts.map +1 -0
  365. package/resources/teams/index.d.ts +7 -0
  366. package/resources/teams/index.d.ts.map +1 -0
  367. package/resources/teams/index.js +17 -0
  368. package/resources/teams/index.js.map +1 -0
  369. package/resources/teams/index.mjs +8 -0
  370. package/resources/teams/index.mjs.map +1 -0
  371. package/resources/teams/ip-filters.d.mts +115 -0
  372. package/resources/teams/ip-filters.d.mts.map +1 -0
  373. package/resources/teams/ip-filters.d.ts +115 -0
  374. package/resources/teams/ip-filters.d.ts.map +1 -0
  375. package/resources/teams/ip-filters.js +45 -0
  376. package/resources/teams/ip-filters.js.map +1 -0
  377. package/resources/teams/ip-filters.mjs +41 -0
  378. package/resources/teams/ip-filters.mjs.map +1 -0
  379. package/resources/teams/members.d.mts +204 -0
  380. package/resources/teams/members.d.mts.map +1 -0
  381. package/resources/teams/members.d.ts +204 -0
  382. package/resources/teams/members.d.ts.map +1 -0
  383. package/resources/teams/members.js +30 -0
  384. package/resources/teams/members.js.map +1 -0
  385. package/resources/teams/members.mjs +26 -0
  386. package/resources/teams/members.mjs.map +1 -0
  387. package/resources/teams/teams.d.mts +878 -0
  388. package/resources/teams/teams.d.mts.map +1 -0
  389. package/resources/teams/teams.d.ts +878 -0
  390. package/resources/teams/teams.d.ts.map +1 -0
  391. package/resources/teams/teams.js +66 -0
  392. package/resources/teams/teams.js.map +1 -0
  393. package/resources/teams/teams.mjs +61 -0
  394. package/resources/teams/teams.mjs.map +1 -0
  395. package/resources/teams/watermark.d.mts +459 -0
  396. package/resources/teams/watermark.d.mts.map +1 -0
  397. package/resources/teams/watermark.d.ts +459 -0
  398. package/resources/teams/watermark.d.ts.map +1 -0
  399. package/resources/teams/watermark.js +46 -0
  400. package/resources/teams/watermark.js.map +1 -0
  401. package/resources/teams/watermark.mjs +42 -0
  402. package/resources/teams/watermark.mjs.map +1 -0
  403. package/resources/teams/webhook-endpoints/events.d.mts +87 -0
  404. package/resources/teams/webhook-endpoints/events.d.mts.map +1 -0
  405. package/resources/teams/webhook-endpoints/events.d.ts +87 -0
  406. package/resources/teams/webhook-endpoints/events.d.ts.map +1 -0
  407. package/resources/teams/webhook-endpoints/events.js +28 -0
  408. package/resources/teams/webhook-endpoints/events.js.map +1 -0
  409. package/resources/teams/webhook-endpoints/events.mjs +24 -0
  410. package/resources/teams/webhook-endpoints/events.mjs.map +1 -0
  411. package/resources/teams/webhook-endpoints/index.d.mts +3 -0
  412. package/resources/teams/webhook-endpoints/index.d.mts.map +1 -0
  413. package/resources/teams/webhook-endpoints/index.d.ts +3 -0
  414. package/resources/teams/webhook-endpoints/index.d.ts.map +1 -0
  415. package/resources/teams/webhook-endpoints/index.js +9 -0
  416. package/resources/teams/webhook-endpoints/index.js.map +1 -0
  417. package/resources/teams/webhook-endpoints/index.mjs +4 -0
  418. package/resources/teams/webhook-endpoints/index.mjs.map +1 -0
  419. package/resources/teams/webhook-endpoints/webhook-endpoints.d.mts +250 -0
  420. package/resources/teams/webhook-endpoints/webhook-endpoints.d.mts.map +1 -0
  421. package/resources/teams/webhook-endpoints/webhook-endpoints.d.ts +250 -0
  422. package/resources/teams/webhook-endpoints/webhook-endpoints.d.ts.map +1 -0
  423. package/resources/teams/webhook-endpoints/webhook-endpoints.js +45 -0
  424. package/resources/teams/webhook-endpoints/webhook-endpoints.js.map +1 -0
  425. package/resources/teams/webhook-endpoints/webhook-endpoints.mjs +40 -0
  426. package/resources/teams/webhook-endpoints/webhook-endpoints.mjs.map +1 -0
  427. package/resources/teams/webhook-endpoints.d.mts +2 -0
  428. package/resources/teams/webhook-endpoints.d.mts.map +1 -0
  429. package/resources/teams/webhook-endpoints.d.ts +2 -0
  430. package/resources/teams/webhook-endpoints.d.ts.map +1 -0
  431. package/resources/teams/webhook-endpoints.js +6 -0
  432. package/resources/teams/webhook-endpoints.js.map +1 -0
  433. package/resources/teams/webhook-endpoints.mjs +3 -0
  434. package/resources/teams/webhook-endpoints.mjs.map +1 -0
  435. package/resources/teams.d.mts +2 -0
  436. package/resources/teams.d.mts.map +1 -0
  437. package/resources/teams.d.ts +2 -0
  438. package/resources/teams.d.ts.map +1 -0
  439. package/resources/teams.js +6 -0
  440. package/resources/teams.js.map +1 -0
  441. package/resources/teams.mjs +3 -0
  442. package/resources/teams.mjs.map +1 -0
  443. package/resources/uploads.d.mts.map +1 -1
  444. package/resources/uploads.d.ts.map +1 -1
  445. package/resources/uploads.js +15 -3
  446. package/resources/uploads.js.map +1 -1
  447. package/resources/uploads.mjs +15 -3
  448. package/resources/uploads.mjs.map +1 -1
  449. package/resources/usages.d.mts +51 -24
  450. package/resources/usages.d.mts.map +1 -1
  451. package/resources/usages.d.ts +51 -24
  452. package/resources/usages.d.ts.map +1 -1
  453. package/resources/usages.js +2 -1
  454. package/resources/usages.js.map +1 -1
  455. package/resources/usages.mjs +2 -1
  456. package/resources/usages.mjs.map +1 -1
  457. package/resources/workflows.d.mts +1381 -280
  458. package/resources/workflows.d.mts.map +1 -1
  459. package/resources/workflows.d.ts +1381 -280
  460. package/resources/workflows.d.ts.map +1 -1
  461. package/resources/workflows.js +39 -8
  462. package/resources/workflows.js.map +1 -1
  463. package/resources/workflows.mjs +39 -8
  464. package/resources/workflows.mjs.map +1 -1
  465. package/src/client.ts +101 -0
  466. package/src/core/pagination.ts +144 -0
  467. package/src/internal/utils/values.ts +10 -0
  468. package/src/lib/asset.ts +1 -1
  469. package/src/lib/generate.ts +7 -7
  470. package/src/lib/job.ts +9 -7
  471. package/src/lib/models.ts +8 -6
  472. package/src/lib/query.ts +42 -0
  473. package/src/lib/scenario.ts +8 -0
  474. package/src/lib/scope.ts +42 -7
  475. package/src/lib/upload.ts +20 -13
  476. package/src/lib/workflow.ts +21 -8
  477. package/src/lib/workflow_converter.ts +4 -2
  478. package/src/lib/workflow_validator.ts +115 -0
  479. package/src/resources/assets/assets.ts +192 -33
  480. package/src/resources/assets/download.ts +43 -8
  481. package/src/resources/collections/assets.ts +3 -2
  482. package/src/resources/collections/collections.ts +20 -5
  483. package/src/resources/collections/models.ts +3 -2
  484. package/src/resources/generate.ts +2350 -186
  485. package/src/resources/index.ts +34 -0
  486. package/src/resources/jobs.ts +204 -74
  487. package/src/resources/models/description.ts +10 -2
  488. package/src/resources/models/examples.ts +140 -46
  489. package/src/resources/models/index.ts +25 -0
  490. package/src/resources/models/models.ts +326 -88
  491. package/src/resources/models/presets.ts +1335 -0
  492. package/src/resources/models/prompt-guide.ts +102 -0
  493. package/src/resources/models/scores.ts +383 -0
  494. package/src/resources/models/train.ts +121 -46
  495. package/src/resources/models/training-images.ts +5 -4
  496. package/src/resources/projects/api-keys.ts +86 -0
  497. package/src/resources/projects/brief.ts +197 -0
  498. package/src/resources/projects/index.ts +71 -0
  499. package/src/resources/projects/instructions.ts +134 -0
  500. package/src/resources/projects/members.ts +958 -0
  501. package/src/resources/projects/memory.ts +134 -0
  502. package/src/resources/projects/projects.ts +1478 -0
  503. package/src/resources/projects/watermark.ts +590 -0
  504. package/src/resources/projects/webhook-endpoints/events.ts +179 -0
  505. package/src/resources/projects/webhook-endpoints/index.ts +19 -0
  506. package/src/resources/projects/webhook-endpoints/webhook-endpoints.ts +452 -0
  507. package/src/resources/projects/webhook-endpoints.ts +3 -0
  508. package/src/resources/projects.ts +3 -0
  509. package/src/resources/recommendations.ts +1502 -0
  510. package/src/resources/search.ts +4 -3
  511. package/src/resources/tags.ts +5 -1
  512. package/src/resources/teams/brief.ts +193 -0
  513. package/src/resources/teams/index.ts +62 -0
  514. package/src/resources/teams/ip-filters.ts +177 -0
  515. package/src/resources/teams/members.ts +282 -0
  516. package/src/resources/teams/teams.ts +1255 -0
  517. package/src/resources/teams/watermark.ts +590 -0
  518. package/src/resources/teams/webhook-endpoints/events.ts +179 -0
  519. package/src/resources/teams/webhook-endpoints/index.ts +19 -0
  520. package/src/resources/teams/webhook-endpoints/webhook-endpoints.ts +453 -0
  521. package/src/resources/teams/webhook-endpoints.ts +3 -0
  522. package/src/resources/teams.ts +3 -0
  523. package/src/resources/uploads.ts +15 -3
  524. package/src/resources/usages.ts +58 -23
  525. package/src/resources/workflows.ts +1707 -241
  526. package/src/version.ts +1 -1
  527. package/version.d.mts +1 -1
  528. package/version.d.ts +1 -1
  529. package/version.js +1 -1
  530. package/version.mjs +1 -1
@@ -0,0 +1,1255 @@
1
+ // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
2
+
3
+ import { APIResource } from '../../core/resource';
4
+ import * as BriefAPI from './brief';
5
+ import {
6
+ Brief,
7
+ BriefDeleteResponse,
8
+ BriefRetrieveResponse,
9
+ BriefUpdateParams,
10
+ BriefUpdateResponse,
11
+ } from './brief';
12
+ import * as IPFiltersAPI from './ip-filters';
13
+ import {
14
+ IPFilterCreateParams,
15
+ IPFilterCreateResponse,
16
+ IPFilterDeleteParams,
17
+ IPFilterDeleteResponse,
18
+ IPFilterDraftInstructionParams,
19
+ IPFilterDraftInstructionResponse,
20
+ IPFilterListResponse,
21
+ IPFilterUpdateParams,
22
+ IPFilterUpdateResponse,
23
+ IPFilters,
24
+ } from './ip-filters';
25
+ import * as MembersAPI from './members';
26
+ import {
27
+ MemberCreateParams,
28
+ MemberCreateResponse,
29
+ MemberDeleteParams,
30
+ MemberDeleteResponse,
31
+ MemberUpdateParams,
32
+ MemberUpdateResponse,
33
+ Members,
34
+ } from './members';
35
+ import * as WatermarkAPI from './watermark';
36
+ import {
37
+ Watermark,
38
+ WatermarkDeleteLogoResponse,
39
+ WatermarkDeleteResponse,
40
+ WatermarkPreviewParams,
41
+ WatermarkPreviewResponse,
42
+ WatermarkRetrieveResponse,
43
+ WatermarkUpdateLogoParams,
44
+ WatermarkUpdateLogoResponse,
45
+ WatermarkUpdateParams,
46
+ WatermarkUpdateResponse,
47
+ } from './watermark';
48
+ import * as WebhookEndpointsAPI from './webhook-endpoints/webhook-endpoints';
49
+ import {
50
+ WebhookEndpointCreateParams,
51
+ WebhookEndpointCreateResponse,
52
+ WebhookEndpointDeleteParams,
53
+ WebhookEndpointDeleteResponse,
54
+ WebhookEndpointListResponse,
55
+ WebhookEndpointUpdateParams,
56
+ WebhookEndpointUpdateResponse,
57
+ WebhookEndpoints,
58
+ } from './webhook-endpoints/webhook-endpoints';
59
+ import { APIPromise } from '../../core/api-promise';
60
+ import { RequestOptions } from '../../internal/request-options';
61
+ import { path } from '../../internal/utils/path';
62
+ import { omitUndefined } from '../../internal/utils/values';
63
+
64
+ export class Teams extends APIResource {
65
+ brief: BriefAPI.Brief = new BriefAPI.Brief(this._client);
66
+ ipFilters: IPFiltersAPI.IPFilters = new IPFiltersAPI.IPFilters(this._client);
67
+ members: MembersAPI.Members = new MembersAPI.Members(this._client);
68
+ watermark: WatermarkAPI.Watermark = new WatermarkAPI.Watermark(this._client);
69
+ webhookEndpoints: WebhookEndpointsAPI.WebhookEndpoints = new WebhookEndpointsAPI.WebhookEndpoints(
70
+ this._client,
71
+ );
72
+
73
+ /**
74
+ * Get the details of a team
75
+ */
76
+ retrieve(teamID: string, options?: RequestOptions): APIPromise<TeamRetrieveResponse> {
77
+ return this._client.get(path`/teams/${teamID}`, options);
78
+ }
79
+
80
+ /**
81
+ * Update a particular team
82
+ */
83
+ update(teamID: string, body: TeamUpdateParams, options?: RequestOptions): APIPromise<TeamUpdateResponse> {
84
+ return this._client.put(path`/teams/${teamID}`, { body, ...options });
85
+ }
86
+
87
+ /**
88
+ * List the teams the user belongs to
89
+ */
90
+ list(options?: RequestOptions): APIPromise<TeamListResponse> {
91
+ return this._client.get('/teams', options);
92
+ }
93
+
94
+ /**
95
+ * Withdraw a user invitation on the team
96
+ */
97
+ deleteInvitations(
98
+ teamID: string,
99
+ params: TeamDeleteInvitationsParams,
100
+ options?: RequestOptions,
101
+ ): APIPromise<unknown> {
102
+ const { email } = params;
103
+ return this._client.delete(path`/teams/${teamID}/invitations`, {
104
+ ...options,
105
+ query: { email, ...omitUndefined(options?.query) },
106
+ });
107
+ }
108
+
109
+ /**
110
+ * Retrieve current limits for a team
111
+ */
112
+ retrieveLimits(teamID: string, options?: RequestOptions): APIPromise<TeamRetrieveLimitsResponse> {
113
+ return this._client.get(path`/teams/${teamID}/limits`, options);
114
+ }
115
+ }
116
+
117
+ export interface TeamRetrieveResponse {
118
+ team: TeamRetrieveResponse.Team;
119
+ }
120
+
121
+ export namespace TeamRetrieveResponse {
122
+ export interface Team {
123
+ /**
124
+ * The team ID (example: "eyVcnFJcR92BxBkz7N6g5w")
125
+ */
126
+ id: string;
127
+
128
+ /**
129
+ * The team creation date as an ISO string (example: "2023-02-03T11:19:41.579Z")
130
+ */
131
+ createdAt: string;
132
+
133
+ /**
134
+ * The list of pending invitations
135
+ */
136
+ invitations: Array<Team.Invitation>;
137
+
138
+ /**
139
+ * The list of API keys
140
+ */
141
+ keys: Array<Team.Key>;
142
+
143
+ /**
144
+ * The team name (example: "Scenario")
145
+ */
146
+ name: string;
147
+
148
+ /**
149
+ * The paymentStatus for the team
150
+ */
151
+ paymentStatus: 'failed' | 'succeeded';
152
+
153
+ /**
154
+ * The team plan
155
+ */
156
+ plan:
157
+ | 'cu-basic'
158
+ | 'cu-creator'
159
+ | 'cu-max'
160
+ | 'cu-pro'
161
+ | 'cu-pro-q3-25'
162
+ | 'cu-team'
163
+ | 'cu-team-v2'
164
+ | 'enterprise'
165
+ | 'essential'
166
+ | 'free'
167
+ | 'premium'
168
+ | 'pro';
169
+
170
+ /**
171
+ * Projects of the team
172
+ */
173
+ projects: Array<Team.Project>;
174
+
175
+ /**
176
+ * The search host for the team
177
+ */
178
+ searchHost: string;
179
+
180
+ /**
181
+ * The search indexes for the team
182
+ */
183
+ searchIndexes: Team.SearchIndexes;
184
+
185
+ /**
186
+ * The team type
187
+ */
188
+ type: 'personal' | 'shared';
189
+
190
+ /**
191
+ * The team update date as an ISO string (example: "2023-02-03T11:19:41.579Z")
192
+ */
193
+ updatedAt: string;
194
+
195
+ /**
196
+ * The list of teams members and their role
197
+ */
198
+ users: Array<Team.User>;
199
+
200
+ /**
201
+ * The team's avatar
202
+ */
203
+ avatar?: Team.Avatar;
204
+
205
+ /**
206
+ * BYOK pricing override. Admin-only — omitted for non-admin callers.
207
+ */
208
+ byok?: Team.Byok;
209
+
210
+ /**
211
+ * Team-wide default max consumption (CU) applied to every member over the billing
212
+ * period, unless overridden per member. Absent when no team-wide default is set.
213
+ */
214
+ defaultUserMaxConsumption?: number;
215
+
216
+ /**
217
+ * The IP detection enforcement posture for the team. 'disabled': IP detection is
218
+ * not performed. 'active-fail-open': IP detection runs; on detector error the
219
+ * request is allowed through. 'active-fail-closed': IP detection runs; on detector
220
+ * error the request is blocked.
221
+ */
222
+ ipDetectionEnforcement?: 'active-fail-closed' | 'active-fail-open' | 'disabled';
223
+
224
+ /**
225
+ * Quality Gate auto-detection default for the team.
226
+ */
227
+ qualityGateAutoDetect?: boolean;
228
+
229
+ /**
230
+ * Team settings. Returned on `GET` and `PUT /teams/{teamId}`, absent from the
231
+ * teams list.
232
+ */
233
+ settings?: Team.Settings;
234
+
235
+ /**
236
+ * The subscriptionStatus for the team
237
+ */
238
+ subscriptionStatus?: 'active' | 'inactive' | 'paused';
239
+ }
240
+
241
+ export namespace Team {
242
+ export interface Invitation {
243
+ /**
244
+ * The user creation date as an ISO string (example: "2023-02-03T11:19:41.579Z")
245
+ */
246
+ createdAt: string;
247
+
248
+ /**
249
+ * The invited user email (example: "herve@scenario.com")
250
+ */
251
+ email: string;
252
+
253
+ /**
254
+ * The role of the invited user inside the team
255
+ */
256
+ role: 'admin' | 'key' | 'member';
257
+
258
+ /**
259
+ * The status of the invitation
260
+ */
261
+ status: 'accepted' | 'expired' | 'pending' | 'withdrawn';
262
+
263
+ /**
264
+ * The link the invited user opens to accept the invitation, as sent by email
265
+ */
266
+ url: string;
267
+
268
+ /**
269
+ * The list of project IDs for which the user is invited
270
+ */
271
+ projectIds?: Array<string>;
272
+ }
273
+
274
+ export interface Key {
275
+ /**
276
+ * The key's member id (its API user id, `apiu_...`), taken by the member and usage
277
+ * routes (example: "apiu_eyVcnFJcR92BxBkz7N6g5w")
278
+ */
279
+ id: string;
280
+
281
+ /**
282
+ * The API key id (`api_...`), taken by the api-keys routes (example:
283
+ * "api_eyVcnFJcR92BxBkz7N6g5w")
284
+ */
285
+ apiKeyId: string;
286
+
287
+ /**
288
+ * The status of the API key
289
+ */
290
+ apiKeyStatus: 'active' | 'inactive';
291
+
292
+ /**
293
+ * The API key creation date as an ISO string (example: "2023-02-03T11:19:41.579Z")
294
+ */
295
+ createdAt: string;
296
+
297
+ /**
298
+ * The API key name (example: "eurv-scenario")
299
+ */
300
+ name: string;
301
+
302
+ /**
303
+ * The scope of the API key: 'project' for project-scoped keys, 'team' for
304
+ * team-scoped keys
305
+ */
306
+ scope: 'project' | 'team';
307
+
308
+ /**
309
+ * The API key last update date as an ISO string (example:
310
+ * "2023-02-03T11:19:41.579Z")
311
+ */
312
+ updatedAt: string;
313
+
314
+ /**
315
+ * The member who created the key: a human, or the member id (`apiu_...`) of the
316
+ * team API key that created it.
317
+ */
318
+ authorId?: string;
319
+
320
+ /**
321
+ * Consumption (CU) used by this key over the current billing period.
322
+ */
323
+ consumption?: number;
324
+
325
+ /**
326
+ * The date the API key was last used to authenticate a request, as an ISO string
327
+ * (example: "2023-02-03T11:19:41.579Z"). Absent if the key has never been used.
328
+ */
329
+ lastUsedAt?: string;
330
+
331
+ /**
332
+ * The key's effective consumption (CU) cap for the period (per-key override, else
333
+ * the team-wide default). Absent when the key is uncapped.
334
+ */
335
+ maxConsumption?: number;
336
+
337
+ /**
338
+ * For a PROJECT key: the project it was created on (the team id on some legacy
339
+ * keys). Absent for team keys.
340
+ */
341
+ ownerId?: string;
342
+
343
+ /**
344
+ * For a PROJECT key: the projects it has access to and its role on each. Empty
345
+ * when the key is currently not a member of any (live) project. Absent for team
346
+ * keys.
347
+ */
348
+ projects?: Array<Key.Project>;
349
+
350
+ /**
351
+ * The key's role. For a TEAM key: its effective team-plane scopes as a
352
+ * `;`-separated list (e.g. `"team.read;team.usage.read"`). Project keys carry
353
+ * their project-plane role(s) per project in `projects` instead.
354
+ */
355
+ role?: string;
356
+ }
357
+
358
+ export namespace Key {
359
+ /**
360
+ * A project a `project`-scoped API key has access to, with its role on that
361
+ * project. A key can be granted roles on several projects, potentially with
362
+ * different roles — one entry per project.
363
+ */
364
+ export interface Project {
365
+ /**
366
+ * The project the key has a role on
367
+ */
368
+ projectId: string;
369
+
370
+ /**
371
+ * The key's role on this project: a built-in role (`admin`/`editor`/`reader`) or a
372
+ * custom `;`-separated scope list (example: `"asset.read;model.read"`).
373
+ */
374
+ role: string;
375
+ }
376
+ }
377
+
378
+ export interface Project {
379
+ id: string;
380
+
381
+ createdAt: string;
382
+
383
+ name: string;
384
+
385
+ updatedAt: string;
386
+
387
+ avatar?: Project.Avatar;
388
+
389
+ /**
390
+ * When true, IP detection is switched off for this project.
391
+ */
392
+ disableIpDetection?: boolean;
393
+
394
+ /**
395
+ * Whether Quality Gate auto-detection runs on generation for this project.
396
+ */
397
+ qualityGateAutoDetect?: boolean;
398
+ }
399
+
400
+ export namespace Project {
401
+ export interface Avatar {
402
+ /**
403
+ * ID of the asset used as thumbnail if provided, otherwise undefined
404
+ */
405
+ assetId?: string;
406
+
407
+ /**
408
+ * Signed URL of the assetId or free url if assetId is undefined
409
+ */
410
+ url?: string;
411
+ }
412
+ }
413
+
414
+ /**
415
+ * The search indexes for the team
416
+ */
417
+ export interface SearchIndexes {
418
+ assets: SearchIndexes.Assets;
419
+
420
+ models: SearchIndexes.Models;
421
+
422
+ workflows: SearchIndexes.Workflows;
423
+ }
424
+
425
+ export namespace SearchIndexes {
426
+ export interface Assets {
427
+ /**
428
+ * The private search index for the team
429
+ */
430
+ private: string;
431
+
432
+ /**
433
+ * The public search index for the team
434
+ */
435
+ public: string;
436
+ }
437
+
438
+ export interface Models {
439
+ /**
440
+ * The private search index for the team
441
+ */
442
+ private: string;
443
+
444
+ /**
445
+ * The public search index for the team
446
+ */
447
+ public: string;
448
+ }
449
+
450
+ export interface Workflows {
451
+ /**
452
+ * The private search index for the team
453
+ */
454
+ private: string;
455
+
456
+ /**
457
+ * The public search index for the team
458
+ */
459
+ public: string;
460
+ }
461
+ }
462
+
463
+ export interface User {
464
+ /**
465
+ * The user ID (example: "eyVcnFJcR92BxBkz7N6g5w")
466
+ */
467
+ id: string;
468
+
469
+ /**
470
+ * The user creation date as an ISO string (example: "2023-02-03T11:19:41.579Z")
471
+ */
472
+ createdAt: string;
473
+
474
+ /**
475
+ * The user email (example: "herve@scenario.com")
476
+ */
477
+ email: string;
478
+
479
+ /**
480
+ * The role of the user inside the team
481
+ */
482
+ role: 'admin' | 'key' | 'member';
483
+
484
+ /**
485
+ * The user last update date as an ISO string (example: "2023-02-03T11:19:41.579Z")
486
+ */
487
+ updatedAt: string;
488
+
489
+ /**
490
+ * The user's avatar
491
+ */
492
+ avatar?: User.Avatar;
493
+
494
+ /**
495
+ * Consumption (CU) used by this member over the current billing period.
496
+ */
497
+ consumption?: number;
498
+
499
+ /**
500
+ * The member's effective consumption (CU) cap for the period (per-user override,
501
+ * else the team-wide default). Absent when the member is uncapped.
502
+ */
503
+ maxConsumption?: number;
504
+ }
505
+
506
+ export namespace User {
507
+ /**
508
+ * The user's avatar
509
+ */
510
+ export interface Avatar {
511
+ /**
512
+ * ID of the asset used as thumbnail if provided, otherwise undefined
513
+ */
514
+ assetId?: string;
515
+
516
+ /**
517
+ * Signed URL of the assetId or free url if assetId is undefined
518
+ */
519
+ url?: string;
520
+ }
521
+ }
522
+
523
+ /**
524
+ * The team's avatar
525
+ */
526
+ export interface Avatar {
527
+ /**
528
+ * ID of the asset used as thumbnail if provided, otherwise undefined
529
+ */
530
+ assetId?: string;
531
+
532
+ /**
533
+ * Signed URL of the assetId or free url if assetId is undefined
534
+ */
535
+ url?: string;
536
+ }
537
+
538
+ /**
539
+ * BYOK pricing override. Admin-only — omitted for non-admin callers.
540
+ */
541
+ export interface Byok {
542
+ markupMultiplier: number;
543
+
544
+ /**
545
+ * ISO timestamp of the last update. Optional — legacy rows may lack it.
546
+ */
547
+ updatedAt?: string;
548
+
549
+ /**
550
+ * Human-readable handle of who last updated the markup (display name).
551
+ */
552
+ updatedBy?: string;
553
+ }
554
+
555
+ /**
556
+ * Team settings. Returned on `GET` and `PUT /teams/{teamId}`, absent from the
557
+ * teams list.
558
+ */
559
+ export interface Settings {
560
+ /**
561
+ * Published homepage layout.
562
+ */
563
+ homepage?: { [key: string]: unknown };
564
+ }
565
+ }
566
+ }
567
+
568
+ export interface TeamUpdateResponse {
569
+ /**
570
+ * The updated team.
571
+ */
572
+ team: TeamUpdateResponse.Team;
573
+ }
574
+
575
+ export namespace TeamUpdateResponse {
576
+ /**
577
+ * The updated team.
578
+ */
579
+ export interface Team {
580
+ /**
581
+ * The team ID (example: "eyVcnFJcR92BxBkz7N6g5w")
582
+ */
583
+ id: string;
584
+
585
+ /**
586
+ * The context of the team for the current authenticated user
587
+ */
588
+ context: Team.Context;
589
+
590
+ /**
591
+ * The team creation date as an ISO string (example: "2023-02-03T11:19:41.579Z")
592
+ */
593
+ createdAt: string;
594
+
595
+ /**
596
+ * The team name (example: "Scenario")
597
+ */
598
+ name: string;
599
+
600
+ /**
601
+ * The team plan
602
+ */
603
+ plan:
604
+ | 'cu-basic'
605
+ | 'cu-creator'
606
+ | 'cu-max'
607
+ | 'cu-pro'
608
+ | 'cu-pro-q3-25'
609
+ | 'cu-team'
610
+ | 'cu-team-v2'
611
+ | 'enterprise'
612
+ | 'essential'
613
+ | 'free'
614
+ | 'premium'
615
+ | 'pro';
616
+
617
+ /**
618
+ * Projects of the team
619
+ */
620
+ projects: Array<Team.Project>;
621
+
622
+ /**
623
+ * The team type
624
+ */
625
+ type: 'personal' | 'shared';
626
+
627
+ /**
628
+ * The team update date as an ISO string (example: "2023-02-03T11:19:41.579Z")
629
+ */
630
+ updatedAt: string;
631
+
632
+ /**
633
+ * The team's avatar
634
+ */
635
+ avatar?: Team.Avatar;
636
+
637
+ /**
638
+ * BYOK pricing override. Admin-only — omitted for non-admin callers.
639
+ */
640
+ byok?: Team.Byok;
641
+
642
+ /**
643
+ * Team-wide default max consumption (CU) applied to every member over the billing
644
+ * period, unless overridden per member. Absent when no team-wide default is set.
645
+ */
646
+ defaultUserMaxConsumption?: number;
647
+
648
+ /**
649
+ * The IP detection enforcement posture for the team. 'disabled': IP detection is
650
+ * not performed. 'active-fail-open': IP detection runs; on detector error the
651
+ * request is allowed through. 'active-fail-closed': IP detection runs; on detector
652
+ * error the request is blocked.
653
+ */
654
+ ipDetectionEnforcement?: 'active-fail-closed' | 'active-fail-open' | 'disabled';
655
+
656
+ /**
657
+ * Quality Gate auto-detection default for the team.
658
+ */
659
+ qualityGateAutoDetect?: boolean;
660
+
661
+ /**
662
+ * Team settings.
663
+ */
664
+ settings?: Team.Settings;
665
+ }
666
+
667
+ export namespace Team {
668
+ /**
669
+ * The context of the team for the current authenticated user
670
+ */
671
+ export interface Context {
672
+ /**
673
+ * The number of invitations on this team
674
+ */
675
+ invitationsCount: number;
676
+
677
+ /**
678
+ * The number of API keys on this team
679
+ */
680
+ keysCount: number;
681
+
682
+ /**
683
+ * The authenticated user's role for this team
684
+ */
685
+ userRole: 'admin' | 'key' | 'member';
686
+
687
+ /**
688
+ * The number of users on this team
689
+ */
690
+ usersCount: number;
691
+ }
692
+
693
+ export interface Project {
694
+ id: string;
695
+
696
+ createdAt: string;
697
+
698
+ name: string;
699
+
700
+ updatedAt: string;
701
+
702
+ avatar?: Project.Avatar;
703
+
704
+ /**
705
+ * When true, IP detection is switched off for this project.
706
+ */
707
+ disableIpDetection?: boolean;
708
+
709
+ /**
710
+ * Whether Quality Gate auto-detection runs on generation for this project.
711
+ */
712
+ qualityGateAutoDetect?: boolean;
713
+ }
714
+
715
+ export namespace Project {
716
+ export interface Avatar {
717
+ /**
718
+ * ID of the asset used as thumbnail if provided, otherwise undefined
719
+ */
720
+ assetId?: string;
721
+
722
+ /**
723
+ * Signed URL of the assetId or free url if assetId is undefined
724
+ */
725
+ url?: string;
726
+ }
727
+ }
728
+
729
+ /**
730
+ * The team's avatar
731
+ */
732
+ export interface Avatar {
733
+ /**
734
+ * ID of the asset used as thumbnail if provided, otherwise undefined
735
+ */
736
+ assetId?: string;
737
+
738
+ /**
739
+ * Signed URL of the assetId or free url if assetId is undefined
740
+ */
741
+ url?: string;
742
+ }
743
+
744
+ /**
745
+ * BYOK pricing override. Admin-only — omitted for non-admin callers.
746
+ */
747
+ export interface Byok {
748
+ markupMultiplier: number;
749
+
750
+ /**
751
+ * ISO timestamp of the last update. Optional — legacy rows may lack it.
752
+ */
753
+ updatedAt?: string;
754
+
755
+ /**
756
+ * Human-readable handle of who last updated the markup (display name).
757
+ */
758
+ updatedBy?: string;
759
+ }
760
+
761
+ /**
762
+ * Team settings.
763
+ */
764
+ export interface Settings {
765
+ /**
766
+ * Published homepage layout.
767
+ */
768
+ homepage?: { [key: string]: unknown };
769
+ }
770
+ }
771
+ }
772
+
773
+ export interface TeamListResponse {
774
+ /**
775
+ * A list of the teams the user belongs to
776
+ */
777
+ teams: Array<TeamListResponse.Team>;
778
+ }
779
+
780
+ export namespace TeamListResponse {
781
+ export interface Team {
782
+ /**
783
+ * The team ID (example: "eyVcnFJcR92BxBkz7N6g5w")
784
+ */
785
+ id: string;
786
+
787
+ /**
788
+ * The context of the team for the current authenticated user
789
+ */
790
+ context: Team.Context;
791
+
792
+ /**
793
+ * The team creation date as an ISO string (example: "2023-02-03T11:19:41.579Z")
794
+ */
795
+ createdAt: string;
796
+
797
+ /**
798
+ * The team name (example: "Scenario")
799
+ */
800
+ name: string;
801
+
802
+ /**
803
+ * The team plan
804
+ */
805
+ plan:
806
+ | 'cu-basic'
807
+ | 'cu-creator'
808
+ | 'cu-max'
809
+ | 'cu-pro'
810
+ | 'cu-pro-q3-25'
811
+ | 'cu-team'
812
+ | 'cu-team-v2'
813
+ | 'enterprise'
814
+ | 'essential'
815
+ | 'free'
816
+ | 'premium'
817
+ | 'pro';
818
+
819
+ /**
820
+ * Projects of the team
821
+ */
822
+ projects: Array<Team.Project>;
823
+
824
+ /**
825
+ * The team type
826
+ */
827
+ type: 'personal' | 'shared';
828
+
829
+ /**
830
+ * The team update date as an ISO string (example: "2023-02-03T11:19:41.579Z")
831
+ */
832
+ updatedAt: string;
833
+
834
+ /**
835
+ * The team's avatar
836
+ */
837
+ avatar?: Team.Avatar;
838
+
839
+ /**
840
+ * BYOK pricing override. Admin-only — omitted for non-admin callers.
841
+ */
842
+ byok?: Team.Byok;
843
+
844
+ /**
845
+ * Team-wide default max consumption (CU) applied to every member over the billing
846
+ * period, unless overridden per member. Absent when no team-wide default is set.
847
+ */
848
+ defaultUserMaxConsumption?: number;
849
+
850
+ /**
851
+ * The IP detection enforcement posture for the team. 'disabled': IP detection is
852
+ * not performed. 'active-fail-open': IP detection runs; on detector error the
853
+ * request is allowed through. 'active-fail-closed': IP detection runs; on detector
854
+ * error the request is blocked.
855
+ */
856
+ ipDetectionEnforcement?: 'active-fail-closed' | 'active-fail-open' | 'disabled';
857
+
858
+ /**
859
+ * Quality Gate auto-detection default for the team.
860
+ */
861
+ qualityGateAutoDetect?: boolean;
862
+ }
863
+
864
+ export namespace Team {
865
+ /**
866
+ * The context of the team for the current authenticated user
867
+ */
868
+ export interface Context {
869
+ /**
870
+ * The number of invitations on this team
871
+ */
872
+ invitationsCount: number;
873
+
874
+ /**
875
+ * The number of API keys on this team
876
+ */
877
+ keysCount: number;
878
+
879
+ /**
880
+ * The authenticated user's role for this team
881
+ */
882
+ userRole: 'admin' | 'key' | 'member';
883
+
884
+ /**
885
+ * The number of users on this team
886
+ */
887
+ usersCount: number;
888
+ }
889
+
890
+ export interface Project {
891
+ id: string;
892
+
893
+ createdAt: string;
894
+
895
+ name: string;
896
+
897
+ updatedAt: string;
898
+
899
+ avatar?: Project.Avatar;
900
+
901
+ /**
902
+ * When true, IP detection is switched off for this project.
903
+ */
904
+ disableIpDetection?: boolean;
905
+
906
+ /**
907
+ * Whether Quality Gate auto-detection runs on generation for this project.
908
+ */
909
+ qualityGateAutoDetect?: boolean;
910
+ }
911
+
912
+ export namespace Project {
913
+ export interface Avatar {
914
+ /**
915
+ * ID of the asset used as thumbnail if provided, otherwise undefined
916
+ */
917
+ assetId?: string;
918
+
919
+ /**
920
+ * Signed URL of the assetId or free url if assetId is undefined
921
+ */
922
+ url?: string;
923
+ }
924
+ }
925
+
926
+ /**
927
+ * The team's avatar
928
+ */
929
+ export interface Avatar {
930
+ /**
931
+ * ID of the asset used as thumbnail if provided, otherwise undefined
932
+ */
933
+ assetId?: string;
934
+
935
+ /**
936
+ * Signed URL of the assetId or free url if assetId is undefined
937
+ */
938
+ url?: string;
939
+ }
940
+
941
+ /**
942
+ * BYOK pricing override. Admin-only — omitted for non-admin callers.
943
+ */
944
+ export interface Byok {
945
+ markupMultiplier: number;
946
+
947
+ /**
948
+ * ISO timestamp of the last update. Optional — legacy rows may lack it.
949
+ */
950
+ updatedAt?: string;
951
+
952
+ /**
953
+ * Human-readable handle of who last updated the markup (display name).
954
+ */
955
+ updatedBy?: string;
956
+ }
957
+ }
958
+ }
959
+
960
+ export type TeamDeleteInvitationsResponse = unknown;
961
+
962
+ export interface TeamRetrieveLimitsResponse {
963
+ /**
964
+ * The actual billing limits values related to the plan
965
+ */
966
+ limits: TeamRetrieveLimitsResponse.Limits;
967
+
968
+ /**
969
+ * The list of one-shot Compute Units
970
+ *
971
+ * Can be empty if the team has no one-shot Compute Units
972
+ */
973
+ oneShotCreativeUnits: Array<TeamRetrieveLimitsResponse.OneShotCreativeUnit>;
974
+
975
+ /**
976
+ * The actual billing period start and end dates ISO strings
977
+ */
978
+ period: TeamRetrieveLimitsResponse.Period;
979
+
980
+ /**
981
+ * The actual plan of the team
982
+ */
983
+ plan:
984
+ | 'cu-basic'
985
+ | 'cu-creator'
986
+ | 'cu-max'
987
+ | 'cu-pro'
988
+ | 'cu-pro-q3-25'
989
+ | 'cu-team'
990
+ | 'cu-team-v2'
991
+ | 'enterprise'
992
+ | 'essential'
993
+ | 'free'
994
+ | 'premium'
995
+ | 'pro';
996
+
997
+ /**
998
+ * The current value for each relevant limit in the billing period
999
+ */
1000
+ values: TeamRetrieveLimitsResponse.Values;
1001
+ }
1002
+
1003
+ export namespace TeamRetrieveLimitsResponse {
1004
+ /**
1005
+ * The actual billing limits values related to the plan
1006
+ */
1007
+ export interface Limits {
1008
+ apiKeys: number;
1009
+
1010
+ canvasAssetLayers: number;
1011
+
1012
+ canvasAssets: number;
1013
+
1014
+ collections: number;
1015
+
1016
+ /**
1017
+ * The amount of Compute Units available for the plan
1018
+ */
1019
+ creativeUnits: number;
1020
+
1021
+ defaultSeats: number;
1022
+
1023
+ downloadAssets: number;
1024
+
1025
+ downloadModel: number;
1026
+
1027
+ inferenceBatchSize: number;
1028
+
1029
+ /**
1030
+ * The maximum cooldown applied in case of over head
1031
+ */
1032
+ maxCooldown: number;
1033
+
1034
+ maxTrainingDatasets: number;
1035
+
1036
+ /**
1037
+ * The minimum cooldown applied in case of over head
1038
+ */
1039
+ minCooldown: number;
1040
+
1041
+ /**
1042
+ * The maximum models a project can have (train/upload/copy/transfer/...)
1043
+ */
1044
+ models: number;
1045
+
1046
+ OTPSessions: number;
1047
+
1048
+ parallelCustomJobs: number;
1049
+
1050
+ parallelInferences: number;
1051
+
1052
+ parallelTraining: number;
1053
+
1054
+ parallelWorkflowRuns: number;
1055
+
1056
+ premiumGenerationSamples: number;
1057
+
1058
+ /**
1059
+ * The maximum projects a team can have
1060
+ */
1061
+ projects: number;
1062
+
1063
+ scalingFactor: number;
1064
+
1065
+ seats: number;
1066
+
1067
+ snapshotsRetention: number;
1068
+
1069
+ upload: number;
1070
+ }
1071
+
1072
+ export interface OneShotCreativeUnit {
1073
+ /**
1074
+ * The Compute Units amount bought
1075
+ */
1076
+ amount: number;
1077
+
1078
+ /**
1079
+ * The creation date of the Compute Units (buy date) ISO string
1080
+ */
1081
+ createdAt: string;
1082
+
1083
+ /**
1084
+ * The expiration date of the Compute Units ISO string
1085
+ */
1086
+ expiration: string;
1087
+
1088
+ /**
1089
+ * The remaining Compute Units available
1090
+ */
1091
+ remaining: number;
1092
+
1093
+ /**
1094
+ * The last update date of the Compute Units (use date) ISO string
1095
+ */
1096
+ updatedAt: string;
1097
+ }
1098
+
1099
+ /**
1100
+ * The actual billing period start and end dates ISO strings
1101
+ */
1102
+ export interface Period {
1103
+ end: string;
1104
+
1105
+ start: string;
1106
+ }
1107
+
1108
+ /**
1109
+ * The current value for each relevant limit in the billing period
1110
+ */
1111
+ export interface Values {
1112
+ apiKeys: number;
1113
+
1114
+ canvasAssets: number;
1115
+
1116
+ collections: number;
1117
+
1118
+ creativeUnits: number;
1119
+
1120
+ projects: number;
1121
+
1122
+ seats: number;
1123
+ }
1124
+ }
1125
+
1126
+ export interface TeamUpdateParams {
1127
+ /**
1128
+ * The team's avatar asset ID (must be kind image)
1129
+ */
1130
+ avatarAssetId?: string;
1131
+
1132
+ /**
1133
+ * Team-wide default max consumption (CU) applied to every member over the billing
1134
+ * period, overridable per member. Set to null to remove the default.
1135
+ */
1136
+ defaultUserMaxConsumption?: number;
1137
+
1138
+ /**
1139
+ * The IP detection enforcement posture for the team. 'disabled': IP detection is
1140
+ * not performed. 'active-fail-open': IP detection runs; on detector error the
1141
+ * request is allowed through. 'active-fail-closed': IP detection runs; on detector
1142
+ * error the request is blocked.
1143
+ */
1144
+ ipDetectionEnforcement?: 'active-fail-closed' | 'active-fail-open' | 'disabled';
1145
+
1146
+ /**
1147
+ * The team name (example: "Scenario")
1148
+ */
1149
+ name?: string;
1150
+
1151
+ /**
1152
+ * Enable Quality Gate auto-detection on generation for this team (projects can
1153
+ * override). Set to null to clear the default.
1154
+ */
1155
+ qualityGateAutoDetect?: boolean;
1156
+
1157
+ /**
1158
+ * Team settings. Set `homepage` to a layout object to publish it, or to `null` to
1159
+ * unpublish it. Team-admin only.
1160
+ */
1161
+ settings?: TeamUpdateParams.Settings;
1162
+ }
1163
+
1164
+ export namespace TeamUpdateParams {
1165
+ /**
1166
+ * Team settings. Set `homepage` to a layout object to publish it, or to `null` to
1167
+ * unpublish it. Team-admin only.
1168
+ */
1169
+ export interface Settings {
1170
+ /**
1171
+ * Homepage layout. An object publishes it; `null` unpublishes it.
1172
+ */
1173
+ homepage?: unknown;
1174
+ }
1175
+ }
1176
+
1177
+ export interface TeamDeleteInvitationsParams {
1178
+ /**
1179
+ * The invitation email to withdraw from the team
1180
+ */
1181
+ email: string;
1182
+ }
1183
+
1184
+ Teams.Brief = Brief;
1185
+ Teams.IPFilters = IPFilters;
1186
+ Teams.Members = Members;
1187
+ Teams.Watermark = Watermark;
1188
+ Teams.WebhookEndpoints = WebhookEndpoints;
1189
+
1190
+ export declare namespace Teams {
1191
+ export {
1192
+ type TeamRetrieveResponse as TeamRetrieveResponse,
1193
+ type TeamUpdateResponse as TeamUpdateResponse,
1194
+ type TeamListResponse as TeamListResponse,
1195
+ type TeamDeleteInvitationsResponse as TeamDeleteInvitationsResponse,
1196
+ type TeamRetrieveLimitsResponse as TeamRetrieveLimitsResponse,
1197
+ type TeamUpdateParams as TeamUpdateParams,
1198
+ type TeamDeleteInvitationsParams as TeamDeleteInvitationsParams,
1199
+ };
1200
+
1201
+ export {
1202
+ Brief as Brief,
1203
+ type BriefRetrieveResponse as BriefRetrieveResponse,
1204
+ type BriefUpdateResponse as BriefUpdateResponse,
1205
+ type BriefDeleteResponse as BriefDeleteResponse,
1206
+ type BriefUpdateParams as BriefUpdateParams,
1207
+ };
1208
+
1209
+ export {
1210
+ IPFilters as IPFilters,
1211
+ type IPFilterCreateResponse as IPFilterCreateResponse,
1212
+ type IPFilterUpdateResponse as IPFilterUpdateResponse,
1213
+ type IPFilterListResponse as IPFilterListResponse,
1214
+ type IPFilterDeleteResponse as IPFilterDeleteResponse,
1215
+ type IPFilterDraftInstructionResponse as IPFilterDraftInstructionResponse,
1216
+ type IPFilterCreateParams as IPFilterCreateParams,
1217
+ type IPFilterUpdateParams as IPFilterUpdateParams,
1218
+ type IPFilterDeleteParams as IPFilterDeleteParams,
1219
+ type IPFilterDraftInstructionParams as IPFilterDraftInstructionParams,
1220
+ };
1221
+
1222
+ export {
1223
+ Members as Members,
1224
+ type MemberCreateResponse as MemberCreateResponse,
1225
+ type MemberUpdateResponse as MemberUpdateResponse,
1226
+ type MemberDeleteResponse as MemberDeleteResponse,
1227
+ type MemberCreateParams as MemberCreateParams,
1228
+ type MemberUpdateParams as MemberUpdateParams,
1229
+ type MemberDeleteParams as MemberDeleteParams,
1230
+ };
1231
+
1232
+ export {
1233
+ Watermark as Watermark,
1234
+ type WatermarkRetrieveResponse as WatermarkRetrieveResponse,
1235
+ type WatermarkUpdateResponse as WatermarkUpdateResponse,
1236
+ type WatermarkDeleteResponse as WatermarkDeleteResponse,
1237
+ type WatermarkDeleteLogoResponse as WatermarkDeleteLogoResponse,
1238
+ type WatermarkPreviewResponse as WatermarkPreviewResponse,
1239
+ type WatermarkUpdateLogoResponse as WatermarkUpdateLogoResponse,
1240
+ type WatermarkUpdateParams as WatermarkUpdateParams,
1241
+ type WatermarkPreviewParams as WatermarkPreviewParams,
1242
+ type WatermarkUpdateLogoParams as WatermarkUpdateLogoParams,
1243
+ };
1244
+
1245
+ export {
1246
+ WebhookEndpoints as WebhookEndpoints,
1247
+ type WebhookEndpointCreateResponse as WebhookEndpointCreateResponse,
1248
+ type WebhookEndpointUpdateResponse as WebhookEndpointUpdateResponse,
1249
+ type WebhookEndpointListResponse as WebhookEndpointListResponse,
1250
+ type WebhookEndpointDeleteResponse as WebhookEndpointDeleteResponse,
1251
+ type WebhookEndpointCreateParams as WebhookEndpointCreateParams,
1252
+ type WebhookEndpointUpdateParams as WebhookEndpointUpdateParams,
1253
+ type WebhookEndpointDeleteParams as WebhookEndpointDeleteParams,
1254
+ };
1255
+ }