@scenario-labs/sdk 3.2.0 → 3.3.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 (516) hide show
  1. package/CHANGELOG.md +27 -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/generate.js +7 -7
  27. package/lib/generate.js.map +1 -1
  28. package/lib/generate.mjs +7 -7
  29. package/lib/generate.mjs.map +1 -1
  30. package/lib/job.d.mts +1 -1
  31. package/lib/job.d.mts.map +1 -1
  32. package/lib/job.d.ts +1 -1
  33. package/lib/job.d.ts.map +1 -1
  34. package/lib/job.js +5 -6
  35. package/lib/job.js.map +1 -1
  36. package/lib/job.mjs +6 -7
  37. package/lib/job.mjs.map +1 -1
  38. package/lib/models.d.mts.map +1 -1
  39. package/lib/models.d.ts.map +1 -1
  40. package/lib/models.js +7 -5
  41. package/lib/models.js.map +1 -1
  42. package/lib/models.mjs +8 -6
  43. package/lib/models.mjs.map +1 -1
  44. package/lib/query.d.mts +21 -0
  45. package/lib/query.d.mts.map +1 -0
  46. package/lib/query.d.ts +21 -0
  47. package/lib/query.d.ts.map +1 -0
  48. package/lib/query.js +36 -0
  49. package/lib/query.js.map +1 -0
  50. package/lib/query.mjs +33 -0
  51. package/lib/query.mjs.map +1 -0
  52. package/lib/scenario.d.mts +3 -0
  53. package/lib/scenario.d.mts.map +1 -1
  54. package/lib/scenario.d.ts +3 -0
  55. package/lib/scenario.d.ts.map +1 -1
  56. package/lib/scenario.js +6 -0
  57. package/lib/scenario.js.map +1 -1
  58. package/lib/scenario.mjs +6 -0
  59. package/lib/scenario.mjs.map +1 -1
  60. package/lib/scope.d.mts +27 -7
  61. package/lib/scope.d.mts.map +1 -1
  62. package/lib/scope.d.ts +27 -7
  63. package/lib/scope.d.ts.map +1 -1
  64. package/lib/scope.js +40 -7
  65. package/lib/scope.js.map +1 -1
  66. package/lib/scope.mjs +37 -7
  67. package/lib/scope.mjs.map +1 -1
  68. package/lib/upload.d.mts +1 -1
  69. package/lib/upload.d.mts.map +1 -1
  70. package/lib/upload.d.ts +1 -1
  71. package/lib/upload.d.ts.map +1 -1
  72. package/lib/upload.js +6 -7
  73. package/lib/upload.js.map +1 -1
  74. package/lib/upload.mjs +7 -8
  75. package/lib/upload.mjs.map +1 -1
  76. package/lib/workflow.d.mts.map +1 -1
  77. package/lib/workflow.d.ts.map +1 -1
  78. package/lib/workflow.js +8 -6
  79. package/lib/workflow.js.map +1 -1
  80. package/lib/workflow.mjs +9 -7
  81. package/lib/workflow.mjs.map +1 -1
  82. package/lib/workflow_validator.d.mts +5 -0
  83. package/lib/workflow_validator.d.mts.map +1 -1
  84. package/lib/workflow_validator.d.ts +5 -0
  85. package/lib/workflow_validator.d.ts.map +1 -1
  86. package/lib/workflow_validator.js +113 -0
  87. package/lib/workflow_validator.js.map +1 -1
  88. package/lib/workflow_validator.mjs +113 -0
  89. package/lib/workflow_validator.mjs.map +1 -1
  90. package/package.json +1 -1
  91. package/resources/assets/assets.d.mts +130 -31
  92. package/resources/assets/assets.d.mts.map +1 -1
  93. package/resources/assets/assets.d.ts +130 -31
  94. package/resources/assets/assets.d.ts.map +1 -1
  95. package/resources/assets/assets.js +34 -11
  96. package/resources/assets/assets.js.map +1 -1
  97. package/resources/assets/assets.mjs +34 -11
  98. package/resources/assets/assets.mjs.map +1 -1
  99. package/resources/assets/download.d.mts +24 -5
  100. package/resources/assets/download.d.mts.map +1 -1
  101. package/resources/assets/download.d.ts +24 -5
  102. package/resources/assets/download.d.ts.map +1 -1
  103. package/resources/assets/download.js +15 -3
  104. package/resources/assets/download.js.map +1 -1
  105. package/resources/assets/download.mjs +15 -3
  106. package/resources/assets/download.mjs.map +1 -1
  107. package/resources/collections/assets.d.mts.map +1 -1
  108. package/resources/collections/assets.d.ts.map +1 -1
  109. package/resources/collections/assets.js +3 -2
  110. package/resources/collections/assets.js.map +1 -1
  111. package/resources/collections/assets.mjs +3 -2
  112. package/resources/collections/assets.mjs.map +1 -1
  113. package/resources/collections/collections.d.mts.map +1 -1
  114. package/resources/collections/collections.d.ts.map +1 -1
  115. package/resources/collections/collections.js +20 -5
  116. package/resources/collections/collections.js.map +1 -1
  117. package/resources/collections/collections.mjs +20 -5
  118. package/resources/collections/collections.mjs.map +1 -1
  119. package/resources/collections/models.d.mts.map +1 -1
  120. package/resources/collections/models.d.ts.map +1 -1
  121. package/resources/collections/models.js +3 -2
  122. package/resources/collections/models.js.map +1 -1
  123. package/resources/collections/models.mjs +3 -2
  124. package/resources/collections/models.mjs.map +1 -1
  125. package/resources/generate.d.mts +1719 -225
  126. package/resources/generate.d.mts.map +1 -1
  127. package/resources/generate.d.ts +1719 -225
  128. package/resources/generate.d.ts.map +1 -1
  129. package/resources/generate.js +65 -8
  130. package/resources/generate.js.map +1 -1
  131. package/resources/generate.mjs +65 -8
  132. package/resources/generate.mjs.map +1 -1
  133. package/resources/index.d.mts +5 -2
  134. package/resources/index.d.mts.map +1 -1
  135. package/resources/index.d.ts +5 -2
  136. package/resources/index.d.ts.map +1 -1
  137. package/resources/index.js +7 -1
  138. package/resources/index.js.map +1 -1
  139. package/resources/index.mjs +3 -0
  140. package/resources/index.mjs.map +1 -1
  141. package/resources/jobs.d.mts +176 -74
  142. package/resources/jobs.d.mts.map +1 -1
  143. package/resources/jobs.d.ts +176 -74
  144. package/resources/jobs.d.ts.map +1 -1
  145. package/resources/jobs.js +16 -4
  146. package/resources/jobs.js.map +1 -1
  147. package/resources/jobs.mjs +16 -4
  148. package/resources/jobs.mjs.map +1 -1
  149. package/resources/models/description.d.mts +2 -2
  150. package/resources/models/description.d.mts.map +1 -1
  151. package/resources/models/description.d.ts +2 -2
  152. package/resources/models/description.d.ts.map +1 -1
  153. package/resources/models/description.js +6 -2
  154. package/resources/models/description.js.map +1 -1
  155. package/resources/models/description.mjs +6 -2
  156. package/resources/models/description.mjs.map +1 -1
  157. package/resources/models/examples.d.mts +120 -48
  158. package/resources/models/examples.d.mts.map +1 -1
  159. package/resources/models/examples.d.ts +120 -48
  160. package/resources/models/examples.d.ts.map +1 -1
  161. package/resources/models/examples.js +6 -2
  162. package/resources/models/examples.js.map +1 -1
  163. package/resources/models/examples.mjs +6 -2
  164. package/resources/models/examples.mjs.map +1 -1
  165. package/resources/models/index.d.mts +3 -0
  166. package/resources/models/index.d.mts.map +1 -1
  167. package/resources/models/index.d.ts +3 -0
  168. package/resources/models/index.d.ts.map +1 -1
  169. package/resources/models/index.js +7 -1
  170. package/resources/models/index.js.map +1 -1
  171. package/resources/models/index.mjs +3 -0
  172. package/resources/models/index.mjs.map +1 -1
  173. package/resources/models/models.d.mts +215 -77
  174. package/resources/models/models.d.mts.map +1 -1
  175. package/resources/models/models.d.ts +215 -77
  176. package/resources/models/models.d.ts.map +1 -1
  177. package/resources/models/models.js +52 -11
  178. package/resources/models/models.js.map +1 -1
  179. package/resources/models/models.mjs +52 -11
  180. package/resources/models/models.mjs.map +1 -1
  181. package/resources/models/presets.d.mts +1016 -0
  182. package/resources/models/presets.d.mts.map +1 -0
  183. package/resources/models/presets.d.ts +1016 -0
  184. package/resources/models/presets.d.ts.map +1 -0
  185. package/resources/models/presets.js +52 -0
  186. package/resources/models/presets.js.map +1 -0
  187. package/resources/models/presets.mjs +48 -0
  188. package/resources/models/presets.mjs.map +1 -0
  189. package/resources/models/prompt-guide.d.mts +64 -0
  190. package/resources/models/prompt-guide.d.mts.map +1 -0
  191. package/resources/models/prompt-guide.d.ts +64 -0
  192. package/resources/models/prompt-guide.d.ts.map +1 -0
  193. package/resources/models/prompt-guide.js +31 -0
  194. package/resources/models/prompt-guide.js.map +1 -0
  195. package/resources/models/prompt-guide.mjs +27 -0
  196. package/resources/models/prompt-guide.mjs.map +1 -0
  197. package/resources/models/scores.d.mts +278 -0
  198. package/resources/models/scores.d.mts.map +1 -0
  199. package/resources/models/scores.d.ts +278 -0
  200. package/resources/models/scores.d.ts.map +1 -0
  201. package/resources/models/scores.js +29 -0
  202. package/resources/models/scores.js.map +1 -0
  203. package/resources/models/scores.mjs +25 -0
  204. package/resources/models/scores.mjs.map +1 -0
  205. package/resources/models/train.d.mts +108 -45
  206. package/resources/models/train.d.mts.map +1 -1
  207. package/resources/models/train.d.ts +108 -45
  208. package/resources/models/train.d.ts.map +1 -1
  209. package/resources/models/train.js +3 -2
  210. package/resources/models/train.js.map +1 -1
  211. package/resources/models/train.mjs +3 -2
  212. package/resources/models/train.mjs.map +1 -1
  213. package/resources/models/training-images.d.mts.map +1 -1
  214. package/resources/models/training-images.d.ts.map +1 -1
  215. package/resources/models/training-images.js +5 -4
  216. package/resources/models/training-images.js.map +1 -1
  217. package/resources/models/training-images.mjs +5 -4
  218. package/resources/models/training-images.mjs.map +1 -1
  219. package/resources/projects/api-keys.d.mts +54 -0
  220. package/resources/projects/api-keys.d.mts.map +1 -0
  221. package/resources/projects/api-keys.d.ts +54 -0
  222. package/resources/projects/api-keys.d.ts.map +1 -0
  223. package/resources/projects/api-keys.js +23 -0
  224. package/resources/projects/api-keys.js.map +1 -0
  225. package/resources/projects/api-keys.mjs +19 -0
  226. package/resources/projects/api-keys.mjs.map +1 -0
  227. package/resources/projects/brief.d.mts +149 -0
  228. package/resources/projects/brief.d.mts.map +1 -0
  229. package/resources/projects/brief.d.ts +149 -0
  230. package/resources/projects/brief.d.ts.map +1 -0
  231. package/resources/projects/brief.js +28 -0
  232. package/resources/projects/brief.js.map +1 -0
  233. package/resources/projects/brief.mjs +24 -0
  234. package/resources/projects/brief.mjs.map +1 -0
  235. package/resources/projects/index.d.mts +9 -0
  236. package/resources/projects/index.d.mts.map +1 -0
  237. package/resources/projects/index.d.ts +9 -0
  238. package/resources/projects/index.d.ts.map +1 -0
  239. package/resources/projects/index.js +21 -0
  240. package/resources/projects/index.js.map +1 -0
  241. package/resources/projects/index.mjs +10 -0
  242. package/resources/projects/index.mjs.map +1 -0
  243. package/resources/projects/instructions.d.mts +102 -0
  244. package/resources/projects/instructions.d.mts.map +1 -0
  245. package/resources/projects/instructions.d.ts +102 -0
  246. package/resources/projects/instructions.d.ts.map +1 -0
  247. package/resources/projects/instructions.js +24 -0
  248. package/resources/projects/instructions.js.map +1 -0
  249. package/resources/projects/instructions.mjs +20 -0
  250. package/resources/projects/instructions.mjs.map +1 -0
  251. package/resources/projects/members.d.mts +788 -0
  252. package/resources/projects/members.d.mts.map +1 -0
  253. package/resources/projects/members.d.ts +788 -0
  254. package/resources/projects/members.d.ts.map +1 -0
  255. package/resources/projects/members.js +30 -0
  256. package/resources/projects/members.js.map +1 -0
  257. package/resources/projects/members.mjs +26 -0
  258. package/resources/projects/members.mjs.map +1 -0
  259. package/resources/projects/memory.d.mts +102 -0
  260. package/resources/projects/memory.d.mts.map +1 -0
  261. package/resources/projects/memory.d.ts +102 -0
  262. package/resources/projects/memory.d.ts.map +1 -0
  263. package/resources/projects/memory.js +24 -0
  264. package/resources/projects/memory.js.map +1 -0
  265. package/resources/projects/memory.mjs +20 -0
  266. package/resources/projects/memory.mjs.map +1 -0
  267. package/resources/projects/projects.d.mts +1129 -0
  268. package/resources/projects/projects.d.mts.map +1 -0
  269. package/resources/projects/projects.d.ts +1129 -0
  270. package/resources/projects/projects.d.ts.map +1 -0
  271. package/resources/projects/projects.js +79 -0
  272. package/resources/projects/projects.js.map +1 -0
  273. package/resources/projects/projects.mjs +74 -0
  274. package/resources/projects/projects.mjs.map +1 -0
  275. package/resources/projects/watermark.d.mts +459 -0
  276. package/resources/projects/watermark.d.mts.map +1 -0
  277. package/resources/projects/watermark.d.ts +459 -0
  278. package/resources/projects/watermark.d.ts.map +1 -0
  279. package/resources/projects/watermark.js +46 -0
  280. package/resources/projects/watermark.js.map +1 -0
  281. package/resources/projects/watermark.mjs +42 -0
  282. package/resources/projects/watermark.mjs.map +1 -0
  283. package/resources/projects/webhook-endpoints/events.d.mts +87 -0
  284. package/resources/projects/webhook-endpoints/events.d.mts.map +1 -0
  285. package/resources/projects/webhook-endpoints/events.d.ts +87 -0
  286. package/resources/projects/webhook-endpoints/events.d.ts.map +1 -0
  287. package/resources/projects/webhook-endpoints/events.js +28 -0
  288. package/resources/projects/webhook-endpoints/events.js.map +1 -0
  289. package/resources/projects/webhook-endpoints/events.mjs +24 -0
  290. package/resources/projects/webhook-endpoints/events.mjs.map +1 -0
  291. package/resources/projects/webhook-endpoints/index.d.mts +3 -0
  292. package/resources/projects/webhook-endpoints/index.d.mts.map +1 -0
  293. package/resources/projects/webhook-endpoints/index.d.ts +3 -0
  294. package/resources/projects/webhook-endpoints/index.d.ts.map +1 -0
  295. package/resources/projects/webhook-endpoints/index.js +9 -0
  296. package/resources/projects/webhook-endpoints/index.js.map +1 -0
  297. package/resources/projects/webhook-endpoints/index.mjs +4 -0
  298. package/resources/projects/webhook-endpoints/index.mjs.map +1 -0
  299. package/resources/projects/webhook-endpoints/webhook-endpoints.d.mts +249 -0
  300. package/resources/projects/webhook-endpoints/webhook-endpoints.d.mts.map +1 -0
  301. package/resources/projects/webhook-endpoints/webhook-endpoints.d.ts +249 -0
  302. package/resources/projects/webhook-endpoints/webhook-endpoints.d.ts.map +1 -0
  303. package/resources/projects/webhook-endpoints/webhook-endpoints.js +44 -0
  304. package/resources/projects/webhook-endpoints/webhook-endpoints.js.map +1 -0
  305. package/resources/projects/webhook-endpoints/webhook-endpoints.mjs +39 -0
  306. package/resources/projects/webhook-endpoints/webhook-endpoints.mjs.map +1 -0
  307. package/resources/projects/webhook-endpoints.d.mts +2 -0
  308. package/resources/projects/webhook-endpoints.d.mts.map +1 -0
  309. package/resources/projects/webhook-endpoints.d.ts +2 -0
  310. package/resources/projects/webhook-endpoints.d.ts.map +1 -0
  311. package/resources/projects/webhook-endpoints.js +6 -0
  312. package/resources/projects/webhook-endpoints.js.map +1 -0
  313. package/resources/projects/webhook-endpoints.mjs +3 -0
  314. package/resources/projects/webhook-endpoints.mjs.map +1 -0
  315. package/resources/projects.d.mts +2 -0
  316. package/resources/projects.d.mts.map +1 -0
  317. package/resources/projects.d.ts +2 -0
  318. package/resources/projects.d.ts.map +1 -0
  319. package/resources/projects.js +6 -0
  320. package/resources/projects.js.map +1 -0
  321. package/resources/projects.mjs +3 -0
  322. package/resources/projects.mjs.map +1 -0
  323. package/resources/recommendations.d.mts +1107 -0
  324. package/resources/recommendations.d.mts.map +1 -0
  325. package/resources/recommendations.d.ts +1107 -0
  326. package/resources/recommendations.d.ts.map +1 -0
  327. package/resources/recommendations.js +17 -0
  328. package/resources/recommendations.js.map +1 -0
  329. package/resources/recommendations.mjs +13 -0
  330. package/resources/recommendations.mjs.map +1 -0
  331. package/resources/search.d.mts.map +1 -1
  332. package/resources/search.d.ts.map +1 -1
  333. package/resources/search.js +4 -3
  334. package/resources/search.js.map +1 -1
  335. package/resources/search.mjs +4 -3
  336. package/resources/search.mjs.map +1 -1
  337. package/resources/tags.d.mts.map +1 -1
  338. package/resources/tags.d.ts.map +1 -1
  339. package/resources/tags.js +5 -1
  340. package/resources/tags.js.map +1 -1
  341. package/resources/tags.mjs +5 -1
  342. package/resources/tags.mjs.map +1 -1
  343. package/resources/teams/brief.d.mts +149 -0
  344. package/resources/teams/brief.d.mts.map +1 -0
  345. package/resources/teams/brief.d.ts +149 -0
  346. package/resources/teams/brief.d.ts.map +1 -0
  347. package/resources/teams/brief.js +28 -0
  348. package/resources/teams/brief.js.map +1 -0
  349. package/resources/teams/brief.mjs +24 -0
  350. package/resources/teams/brief.mjs.map +1 -0
  351. package/resources/teams/index.d.mts +7 -0
  352. package/resources/teams/index.d.mts.map +1 -0
  353. package/resources/teams/index.d.ts +7 -0
  354. package/resources/teams/index.d.ts.map +1 -0
  355. package/resources/teams/index.js +17 -0
  356. package/resources/teams/index.js.map +1 -0
  357. package/resources/teams/index.mjs +8 -0
  358. package/resources/teams/index.mjs.map +1 -0
  359. package/resources/teams/ip-filters.d.mts +115 -0
  360. package/resources/teams/ip-filters.d.mts.map +1 -0
  361. package/resources/teams/ip-filters.d.ts +115 -0
  362. package/resources/teams/ip-filters.d.ts.map +1 -0
  363. package/resources/teams/ip-filters.js +45 -0
  364. package/resources/teams/ip-filters.js.map +1 -0
  365. package/resources/teams/ip-filters.mjs +41 -0
  366. package/resources/teams/ip-filters.mjs.map +1 -0
  367. package/resources/teams/members.d.mts +204 -0
  368. package/resources/teams/members.d.mts.map +1 -0
  369. package/resources/teams/members.d.ts +204 -0
  370. package/resources/teams/members.d.ts.map +1 -0
  371. package/resources/teams/members.js +30 -0
  372. package/resources/teams/members.js.map +1 -0
  373. package/resources/teams/members.mjs +26 -0
  374. package/resources/teams/members.mjs.map +1 -0
  375. package/resources/teams/teams.d.mts +878 -0
  376. package/resources/teams/teams.d.mts.map +1 -0
  377. package/resources/teams/teams.d.ts +878 -0
  378. package/resources/teams/teams.d.ts.map +1 -0
  379. package/resources/teams/teams.js +66 -0
  380. package/resources/teams/teams.js.map +1 -0
  381. package/resources/teams/teams.mjs +61 -0
  382. package/resources/teams/teams.mjs.map +1 -0
  383. package/resources/teams/watermark.d.mts +459 -0
  384. package/resources/teams/watermark.d.mts.map +1 -0
  385. package/resources/teams/watermark.d.ts +459 -0
  386. package/resources/teams/watermark.d.ts.map +1 -0
  387. package/resources/teams/watermark.js +46 -0
  388. package/resources/teams/watermark.js.map +1 -0
  389. package/resources/teams/watermark.mjs +42 -0
  390. package/resources/teams/watermark.mjs.map +1 -0
  391. package/resources/teams/webhook-endpoints/events.d.mts +87 -0
  392. package/resources/teams/webhook-endpoints/events.d.mts.map +1 -0
  393. package/resources/teams/webhook-endpoints/events.d.ts +87 -0
  394. package/resources/teams/webhook-endpoints/events.d.ts.map +1 -0
  395. package/resources/teams/webhook-endpoints/events.js +28 -0
  396. package/resources/teams/webhook-endpoints/events.js.map +1 -0
  397. package/resources/teams/webhook-endpoints/events.mjs +24 -0
  398. package/resources/teams/webhook-endpoints/events.mjs.map +1 -0
  399. package/resources/teams/webhook-endpoints/index.d.mts +3 -0
  400. package/resources/teams/webhook-endpoints/index.d.mts.map +1 -0
  401. package/resources/teams/webhook-endpoints/index.d.ts +3 -0
  402. package/resources/teams/webhook-endpoints/index.d.ts.map +1 -0
  403. package/resources/teams/webhook-endpoints/index.js +9 -0
  404. package/resources/teams/webhook-endpoints/index.js.map +1 -0
  405. package/resources/teams/webhook-endpoints/index.mjs +4 -0
  406. package/resources/teams/webhook-endpoints/index.mjs.map +1 -0
  407. package/resources/teams/webhook-endpoints/webhook-endpoints.d.mts +250 -0
  408. package/resources/teams/webhook-endpoints/webhook-endpoints.d.mts.map +1 -0
  409. package/resources/teams/webhook-endpoints/webhook-endpoints.d.ts +250 -0
  410. package/resources/teams/webhook-endpoints/webhook-endpoints.d.ts.map +1 -0
  411. package/resources/teams/webhook-endpoints/webhook-endpoints.js +45 -0
  412. package/resources/teams/webhook-endpoints/webhook-endpoints.js.map +1 -0
  413. package/resources/teams/webhook-endpoints/webhook-endpoints.mjs +40 -0
  414. package/resources/teams/webhook-endpoints/webhook-endpoints.mjs.map +1 -0
  415. package/resources/teams/webhook-endpoints.d.mts +2 -0
  416. package/resources/teams/webhook-endpoints.d.mts.map +1 -0
  417. package/resources/teams/webhook-endpoints.d.ts +2 -0
  418. package/resources/teams/webhook-endpoints.d.ts.map +1 -0
  419. package/resources/teams/webhook-endpoints.js +6 -0
  420. package/resources/teams/webhook-endpoints.js.map +1 -0
  421. package/resources/teams/webhook-endpoints.mjs +3 -0
  422. package/resources/teams/webhook-endpoints.mjs.map +1 -0
  423. package/resources/teams.d.mts +2 -0
  424. package/resources/teams.d.mts.map +1 -0
  425. package/resources/teams.d.ts +2 -0
  426. package/resources/teams.d.ts.map +1 -0
  427. package/resources/teams.js +6 -0
  428. package/resources/teams.js.map +1 -0
  429. package/resources/teams.mjs +3 -0
  430. package/resources/teams.mjs.map +1 -0
  431. package/resources/uploads.d.mts.map +1 -1
  432. package/resources/uploads.d.ts.map +1 -1
  433. package/resources/uploads.js +15 -3
  434. package/resources/uploads.js.map +1 -1
  435. package/resources/uploads.mjs +15 -3
  436. package/resources/uploads.mjs.map +1 -1
  437. package/resources/usages.d.mts +51 -24
  438. package/resources/usages.d.mts.map +1 -1
  439. package/resources/usages.d.ts +51 -24
  440. package/resources/usages.d.ts.map +1 -1
  441. package/resources/usages.js +2 -1
  442. package/resources/usages.js.map +1 -1
  443. package/resources/usages.mjs +2 -1
  444. package/resources/usages.mjs.map +1 -1
  445. package/resources/workflows.d.mts +1381 -280
  446. package/resources/workflows.d.mts.map +1 -1
  447. package/resources/workflows.d.ts +1381 -280
  448. package/resources/workflows.d.ts.map +1 -1
  449. package/resources/workflows.js +39 -8
  450. package/resources/workflows.js.map +1 -1
  451. package/resources/workflows.mjs +39 -8
  452. package/resources/workflows.mjs.map +1 -1
  453. package/src/client.ts +101 -0
  454. package/src/core/pagination.ts +144 -0
  455. package/src/internal/utils/values.ts +10 -0
  456. package/src/lib/generate.ts +7 -7
  457. package/src/lib/job.ts +9 -7
  458. package/src/lib/models.ts +8 -6
  459. package/src/lib/query.ts +42 -0
  460. package/src/lib/scenario.ts +8 -0
  461. package/src/lib/scope.ts +42 -7
  462. package/src/lib/upload.ts +10 -8
  463. package/src/lib/workflow.ts +9 -7
  464. package/src/lib/workflow_validator.ts +115 -0
  465. package/src/resources/assets/assets.ts +192 -33
  466. package/src/resources/assets/download.ts +43 -8
  467. package/src/resources/collections/assets.ts +3 -2
  468. package/src/resources/collections/collections.ts +20 -5
  469. package/src/resources/collections/models.ts +3 -2
  470. package/src/resources/generate.ts +2350 -186
  471. package/src/resources/index.ts +34 -0
  472. package/src/resources/jobs.ts +204 -74
  473. package/src/resources/models/description.ts +10 -2
  474. package/src/resources/models/examples.ts +140 -46
  475. package/src/resources/models/index.ts +25 -0
  476. package/src/resources/models/models.ts +326 -88
  477. package/src/resources/models/presets.ts +1335 -0
  478. package/src/resources/models/prompt-guide.ts +102 -0
  479. package/src/resources/models/scores.ts +383 -0
  480. package/src/resources/models/train.ts +121 -46
  481. package/src/resources/models/training-images.ts +5 -4
  482. package/src/resources/projects/api-keys.ts +86 -0
  483. package/src/resources/projects/brief.ts +197 -0
  484. package/src/resources/projects/index.ts +71 -0
  485. package/src/resources/projects/instructions.ts +134 -0
  486. package/src/resources/projects/members.ts +958 -0
  487. package/src/resources/projects/memory.ts +134 -0
  488. package/src/resources/projects/projects.ts +1478 -0
  489. package/src/resources/projects/watermark.ts +590 -0
  490. package/src/resources/projects/webhook-endpoints/events.ts +179 -0
  491. package/src/resources/projects/webhook-endpoints/index.ts +19 -0
  492. package/src/resources/projects/webhook-endpoints/webhook-endpoints.ts +452 -0
  493. package/src/resources/projects/webhook-endpoints.ts +3 -0
  494. package/src/resources/projects.ts +3 -0
  495. package/src/resources/recommendations.ts +1502 -0
  496. package/src/resources/search.ts +4 -3
  497. package/src/resources/tags.ts +5 -1
  498. package/src/resources/teams/brief.ts +193 -0
  499. package/src/resources/teams/index.ts +62 -0
  500. package/src/resources/teams/ip-filters.ts +177 -0
  501. package/src/resources/teams/members.ts +282 -0
  502. package/src/resources/teams/teams.ts +1255 -0
  503. package/src/resources/teams/watermark.ts +590 -0
  504. package/src/resources/teams/webhook-endpoints/events.ts +179 -0
  505. package/src/resources/teams/webhook-endpoints/index.ts +19 -0
  506. package/src/resources/teams/webhook-endpoints/webhook-endpoints.ts +453 -0
  507. package/src/resources/teams/webhook-endpoints.ts +3 -0
  508. package/src/resources/teams.ts +3 -0
  509. package/src/resources/uploads.ts +15 -3
  510. package/src/resources/usages.ts +58 -23
  511. package/src/resources/workflows.ts +1707 -241
  512. package/src/version.ts +1 -1
  513. package/version.d.mts +1 -1
  514. package/version.d.ts +1 -1
  515. package/version.js +1 -1
  516. package/version.mjs +1 -1
@@ -39,6 +39,12 @@ export declare class Workflows extends APIResource {
39
39
  * cascades to the surrounding loop.
40
40
  */
41
41
  userApproval(workflowID: string, params: WorkflowUserApprovalParams, options?: RequestOptions): APIPromise<WorkflowUserApprovalResponse>;
42
+ /**
43
+ * Respond to a user-selection node in a workflow. Pass action="select" with
44
+ * selectedIndices to pick items and resume the workflow, or action="reject" to
45
+ * mark the node Rejected and cancel the workflow.
46
+ */
47
+ userSelection(workflowID: string, params: WorkflowUserSelectionParams, options?: RequestOptions): APIPromise<WorkflowUserSelectionResponse>;
42
48
  /**
43
49
  * @deprecated Use `userApproval()` instead
44
50
  */
@@ -171,7 +177,7 @@ export declare namespace WorkflowCreateResponse {
171
177
  /**
172
178
  * The type of the job for the node.
173
179
  */
174
- type: 'custom-model' | 'for-each' | 'generate-prompt' | 'list' | 'logic' | 'model' | 'remove-background' | 'transform' | 'user-approval' | 'workflow';
180
+ type: 'custom-model' | 'for-each' | 'generate-prompt' | 'list' | 'logic' | 'model' | 'remove-background' | 'transform' | 'user-approval' | 'user-selection' | 'workflow';
175
181
  /**
176
182
  * Fixed number of iterations for a ForEach node. When set, the loop runs exactly
177
183
  * `count` times regardless of array input. When not set, the loop iterates over
@@ -192,13 +198,14 @@ export declare namespace WorkflowCreateResponse {
192
198
  */
193
199
  includeOutputsInWorkflowJob?: true;
194
200
  /**
195
- * The inputs of the node.
201
+ * The inputs of the node. For a user-selection node, the array input's `min`/`max`
202
+ * bound how many items the user may pick (defaults: 1 and 100); conditional
203
+ * connections may be present as additional inputs.
196
204
  */
197
205
  inputs?: Array<Flow.Input>;
198
206
  /**
199
- * Statically-configured items for a List node. The node outputs this array as-is
200
- * when executed. Only available for List nodes. The values can be strings,
201
- * numbers, or asset IDs.
207
+ * Statically-configured items for a List node, or the frozen candidate list of a
208
+ * UserSelection node. The values can be strings, numbers, or asset IDs.
202
209
  */
203
210
  items?: Array<string>;
204
211
  /**
@@ -385,8 +392,7 @@ export declare namespace WorkflowCreateResponse {
385
392
  * - \`ifNotDefined\`: Input is required when another specified input is not
386
393
  * defined
387
394
  * - \`ifDefined\`: Input is required when another specified input is defined
388
- * - \`conditionalValues\`: Input is required when another input has a specific
389
- * value
395
+ * - \`conditional\`: Input is required when other inputs have specific values
390
396
  *
391
397
  * By default, the input is not required.
392
398
  */
@@ -547,8 +553,7 @@ export declare namespace WorkflowCreateResponse {
547
553
  * - \`ifNotDefined\`: Input is required when another specified input is not
548
554
  * defined
549
555
  * - \`ifDefined\`: Input is required when another specified input is defined
550
- * - \`conditionalValues\`: Input is required when another input has a specific
551
- * value
556
+ * - \`conditional\`: Input is required when other inputs have specific values
552
557
  *
553
558
  * By default, the input is not required.
554
559
  */
@@ -598,8 +603,7 @@ export declare namespace WorkflowCreateResponse {
598
603
  * - \`ifNotDefined\`: Input is required when another specified input is not
599
604
  * defined
600
605
  * - \`ifDefined\`: Input is required when another specified input is defined
601
- * - \`conditionalValues\`: Input is required when another input has a specific
602
- * value
606
+ * - \`conditional\`: Input is required when other inputs have specific values
603
607
  *
604
608
  * By default, the input is not required.
605
609
  */
@@ -609,12 +613,9 @@ export declare namespace WorkflowCreateResponse {
609
613
  */
610
614
  always?: boolean;
611
615
  /**
612
- * Makes this input required when another input has a specific value:
613
- *
614
- * - Key: name of the input to check
615
- * - Value: operation and allowed values that trigger the requirement
616
+ * Makes this input required when other inputs have one of the listed values
616
617
  */
617
- conditionalValues?: unknown;
618
+ conditional?: Required.Conditional;
618
619
  /**
619
620
  * Makes this input required when another input is defined:
620
621
  *
@@ -630,6 +631,24 @@ export declare namespace WorkflowCreateResponse {
630
631
  */
631
632
  ifNotDefined?: unknown;
632
633
  }
634
+ namespace Required {
635
+ /**
636
+ * Makes this input required when other inputs have one of the listed values
637
+ */
638
+ interface Conditional {
639
+ /**
640
+ * The conditions to check:
641
+ *
642
+ * - Key: name of the input to check
643
+ * - Value: values of that input that satisfy the condition
644
+ */
645
+ values: unknown;
646
+ /**
647
+ * How the conditions combine: \`and\` (all must match) or \`or\` (any must match)
648
+ */
649
+ operator?: 'and' | 'or';
650
+ }
651
+ }
633
652
  }
634
653
  /**
635
654
  * The reference to another input or output of the same workflow. Must have at
@@ -665,8 +684,7 @@ export declare namespace WorkflowCreateResponse {
665
684
  * - \`ifNotDefined\`: Input is required when another specified input is not
666
685
  * defined
667
686
  * - \`ifDefined\`: Input is required when another specified input is defined
668
- * - \`conditionalValues\`: Input is required when another input has a specific
669
- * value
687
+ * - \`conditional\`: Input is required when other inputs have specific values
670
688
  *
671
689
  * By default, the input is not required.
672
690
  */
@@ -676,12 +694,9 @@ export declare namespace WorkflowCreateResponse {
676
694
  */
677
695
  always?: boolean;
678
696
  /**
679
- * Makes this input required when another input has a specific value:
680
- *
681
- * - Key: name of the input to check
682
- * - Value: operation and allowed values that trigger the requirement
697
+ * Makes this input required when other inputs have one of the listed values
683
698
  */
684
- conditionalValues?: unknown;
699
+ conditional?: Required.Conditional;
685
700
  /**
686
701
  * Makes this input required when another input is defined:
687
702
  *
@@ -697,6 +712,24 @@ export declare namespace WorkflowCreateResponse {
697
712
  */
698
713
  ifNotDefined?: unknown;
699
714
  }
715
+ namespace Required {
716
+ /**
717
+ * Makes this input required when other inputs have one of the listed values
718
+ */
719
+ interface Conditional {
720
+ /**
721
+ * The conditions to check:
722
+ *
723
+ * - Key: name of the input to check
724
+ * - Value: values of that input that satisfy the condition
725
+ */
726
+ values: unknown;
727
+ /**
728
+ * How the conditions combine: \`and\` (all must match) or \`or\` (any must match)
729
+ */
730
+ operator?: 'and' | 'or';
731
+ }
732
+ }
700
733
  }
701
734
  /**
702
735
  * The logic of the node. Only available for logic nodes.
@@ -865,8 +898,7 @@ export declare namespace WorkflowCreateResponse {
865
898
  * - \`ifNotDefined\`: Input is required when another specified input is not
866
899
  * defined
867
900
  * - \`ifDefined\`: Input is required when another specified input is defined
868
- * - \`conditionalValues\`: Input is required when another input has a specific
869
- * value
901
+ * - \`conditional\`: Input is required when other inputs have specific values
870
902
  *
871
903
  * By default, the input is not required.
872
904
  */
@@ -884,8 +916,7 @@ export declare namespace WorkflowCreateResponse {
884
916
  * - \`ifNotDefined\`: Input is required when another specified input is not
885
917
  * defined
886
918
  * - \`ifDefined\`: Input is required when another specified input is defined
887
- * - \`conditionalValues\`: Input is required when another input has a specific
888
- * value
919
+ * - \`conditional\`: Input is required when other inputs have specific values
889
920
  *
890
921
  * By default, the input is not required.
891
922
  */
@@ -895,12 +926,9 @@ export declare namespace WorkflowCreateResponse {
895
926
  */
896
927
  always?: boolean;
897
928
  /**
898
- * Makes this input required when another input has a specific value:
899
- *
900
- * - Key: name of the input to check
901
- * - Value: operation and allowed values that trigger the requirement
929
+ * Makes this input required when other inputs have one of the listed values
902
930
  */
903
- conditionalValues?: unknown;
931
+ conditional?: Required.Conditional;
904
932
  /**
905
933
  * Makes this input required when another input is defined:
906
934
  *
@@ -916,6 +944,24 @@ export declare namespace WorkflowCreateResponse {
916
944
  */
917
945
  ifNotDefined?: unknown;
918
946
  }
947
+ namespace Required {
948
+ /**
949
+ * Makes this input required when other inputs have one of the listed values
950
+ */
951
+ interface Conditional {
952
+ /**
953
+ * The conditions to check:
954
+ *
955
+ * - Key: name of the input to check
956
+ * - Value: values of that input that satisfy the condition
957
+ */
958
+ values: unknown;
959
+ /**
960
+ * How the conditions combine: \`and\` (all must match) or \`or\` (any must match)
961
+ */
962
+ operator?: 'and' | 'or';
963
+ }
964
+ }
919
965
  }
920
966
  /**
921
967
  * A representation of an asset after being processed by the workflow
@@ -1200,7 +1246,7 @@ export declare namespace WorkflowRetrieveResponse {
1200
1246
  /**
1201
1247
  * The type of the job for the node.
1202
1248
  */
1203
- type: 'custom-model' | 'for-each' | 'generate-prompt' | 'list' | 'logic' | 'model' | 'remove-background' | 'transform' | 'user-approval' | 'workflow';
1249
+ type: 'custom-model' | 'for-each' | 'generate-prompt' | 'list' | 'logic' | 'model' | 'remove-background' | 'transform' | 'user-approval' | 'user-selection' | 'workflow';
1204
1250
  /**
1205
1251
  * Fixed number of iterations for a ForEach node. When set, the loop runs exactly
1206
1252
  * `count` times regardless of array input. When not set, the loop iterates over
@@ -1221,13 +1267,14 @@ export declare namespace WorkflowRetrieveResponse {
1221
1267
  */
1222
1268
  includeOutputsInWorkflowJob?: true;
1223
1269
  /**
1224
- * The inputs of the node.
1270
+ * The inputs of the node. For a user-selection node, the array input's `min`/`max`
1271
+ * bound how many items the user may pick (defaults: 1 and 100); conditional
1272
+ * connections may be present as additional inputs.
1225
1273
  */
1226
1274
  inputs?: Array<Flow.Input>;
1227
1275
  /**
1228
- * Statically-configured items for a List node. The node outputs this array as-is
1229
- * when executed. Only available for List nodes. The values can be strings,
1230
- * numbers, or asset IDs.
1276
+ * Statically-configured items for a List node, or the frozen candidate list of a
1277
+ * UserSelection node. The values can be strings, numbers, or asset IDs.
1231
1278
  */
1232
1279
  items?: Array<string>;
1233
1280
  /**
@@ -1414,8 +1461,7 @@ export declare namespace WorkflowRetrieveResponse {
1414
1461
  * - \`ifNotDefined\`: Input is required when another specified input is not
1415
1462
  * defined
1416
1463
  * - \`ifDefined\`: Input is required when another specified input is defined
1417
- * - \`conditionalValues\`: Input is required when another input has a specific
1418
- * value
1464
+ * - \`conditional\`: Input is required when other inputs have specific values
1419
1465
  *
1420
1466
  * By default, the input is not required.
1421
1467
  */
@@ -1576,8 +1622,7 @@ export declare namespace WorkflowRetrieveResponse {
1576
1622
  * - \`ifNotDefined\`: Input is required when another specified input is not
1577
1623
  * defined
1578
1624
  * - \`ifDefined\`: Input is required when another specified input is defined
1579
- * - \`conditionalValues\`: Input is required when another input has a specific
1580
- * value
1625
+ * - \`conditional\`: Input is required when other inputs have specific values
1581
1626
  *
1582
1627
  * By default, the input is not required.
1583
1628
  */
@@ -1627,8 +1672,7 @@ export declare namespace WorkflowRetrieveResponse {
1627
1672
  * - \`ifNotDefined\`: Input is required when another specified input is not
1628
1673
  * defined
1629
1674
  * - \`ifDefined\`: Input is required when another specified input is defined
1630
- * - \`conditionalValues\`: Input is required when another input has a specific
1631
- * value
1675
+ * - \`conditional\`: Input is required when other inputs have specific values
1632
1676
  *
1633
1677
  * By default, the input is not required.
1634
1678
  */
@@ -1638,12 +1682,9 @@ export declare namespace WorkflowRetrieveResponse {
1638
1682
  */
1639
1683
  always?: boolean;
1640
1684
  /**
1641
- * Makes this input required when another input has a specific value:
1642
- *
1643
- * - Key: name of the input to check
1644
- * - Value: operation and allowed values that trigger the requirement
1685
+ * Makes this input required when other inputs have one of the listed values
1645
1686
  */
1646
- conditionalValues?: unknown;
1687
+ conditional?: Required.Conditional;
1647
1688
  /**
1648
1689
  * Makes this input required when another input is defined:
1649
1690
  *
@@ -1659,6 +1700,24 @@ export declare namespace WorkflowRetrieveResponse {
1659
1700
  */
1660
1701
  ifNotDefined?: unknown;
1661
1702
  }
1703
+ namespace Required {
1704
+ /**
1705
+ * Makes this input required when other inputs have one of the listed values
1706
+ */
1707
+ interface Conditional {
1708
+ /**
1709
+ * The conditions to check:
1710
+ *
1711
+ * - Key: name of the input to check
1712
+ * - Value: values of that input that satisfy the condition
1713
+ */
1714
+ values: unknown;
1715
+ /**
1716
+ * How the conditions combine: \`and\` (all must match) or \`or\` (any must match)
1717
+ */
1718
+ operator?: 'and' | 'or';
1719
+ }
1720
+ }
1662
1721
  }
1663
1722
  /**
1664
1723
  * The reference to another input or output of the same workflow. Must have at
@@ -1694,8 +1753,7 @@ export declare namespace WorkflowRetrieveResponse {
1694
1753
  * - \`ifNotDefined\`: Input is required when another specified input is not
1695
1754
  * defined
1696
1755
  * - \`ifDefined\`: Input is required when another specified input is defined
1697
- * - \`conditionalValues\`: Input is required when another input has a specific
1698
- * value
1756
+ * - \`conditional\`: Input is required when other inputs have specific values
1699
1757
  *
1700
1758
  * By default, the input is not required.
1701
1759
  */
@@ -1705,12 +1763,9 @@ export declare namespace WorkflowRetrieveResponse {
1705
1763
  */
1706
1764
  always?: boolean;
1707
1765
  /**
1708
- * Makes this input required when another input has a specific value:
1709
- *
1710
- * - Key: name of the input to check
1711
- * - Value: operation and allowed values that trigger the requirement
1766
+ * Makes this input required when other inputs have one of the listed values
1712
1767
  */
1713
- conditionalValues?: unknown;
1768
+ conditional?: Required.Conditional;
1714
1769
  /**
1715
1770
  * Makes this input required when another input is defined:
1716
1771
  *
@@ -1726,6 +1781,24 @@ export declare namespace WorkflowRetrieveResponse {
1726
1781
  */
1727
1782
  ifNotDefined?: unknown;
1728
1783
  }
1784
+ namespace Required {
1785
+ /**
1786
+ * Makes this input required when other inputs have one of the listed values
1787
+ */
1788
+ interface Conditional {
1789
+ /**
1790
+ * The conditions to check:
1791
+ *
1792
+ * - Key: name of the input to check
1793
+ * - Value: values of that input that satisfy the condition
1794
+ */
1795
+ values: unknown;
1796
+ /**
1797
+ * How the conditions combine: \`and\` (all must match) or \`or\` (any must match)
1798
+ */
1799
+ operator?: 'and' | 'or';
1800
+ }
1801
+ }
1729
1802
  }
1730
1803
  /**
1731
1804
  * The logic of the node. Only available for logic nodes.
@@ -1894,8 +1967,7 @@ export declare namespace WorkflowRetrieveResponse {
1894
1967
  * - \`ifNotDefined\`: Input is required when another specified input is not
1895
1968
  * defined
1896
1969
  * - \`ifDefined\`: Input is required when another specified input is defined
1897
- * - \`conditionalValues\`: Input is required when another input has a specific
1898
- * value
1970
+ * - \`conditional\`: Input is required when other inputs have specific values
1899
1971
  *
1900
1972
  * By default, the input is not required.
1901
1973
  */
@@ -1913,8 +1985,7 @@ export declare namespace WorkflowRetrieveResponse {
1913
1985
  * - \`ifNotDefined\`: Input is required when another specified input is not
1914
1986
  * defined
1915
1987
  * - \`ifDefined\`: Input is required when another specified input is defined
1916
- * - \`conditionalValues\`: Input is required when another input has a specific
1917
- * value
1988
+ * - \`conditional\`: Input is required when other inputs have specific values
1918
1989
  *
1919
1990
  * By default, the input is not required.
1920
1991
  */
@@ -1924,12 +1995,9 @@ export declare namespace WorkflowRetrieveResponse {
1924
1995
  */
1925
1996
  always?: boolean;
1926
1997
  /**
1927
- * Makes this input required when another input has a specific value:
1928
- *
1929
- * - Key: name of the input to check
1930
- * - Value: operation and allowed values that trigger the requirement
1998
+ * Makes this input required when other inputs have one of the listed values
1931
1999
  */
1932
- conditionalValues?: unknown;
2000
+ conditional?: Required.Conditional;
1933
2001
  /**
1934
2002
  * Makes this input required when another input is defined:
1935
2003
  *
@@ -1945,6 +2013,24 @@ export declare namespace WorkflowRetrieveResponse {
1945
2013
  */
1946
2014
  ifNotDefined?: unknown;
1947
2015
  }
2016
+ namespace Required {
2017
+ /**
2018
+ * Makes this input required when other inputs have one of the listed values
2019
+ */
2020
+ interface Conditional {
2021
+ /**
2022
+ * The conditions to check:
2023
+ *
2024
+ * - Key: name of the input to check
2025
+ * - Value: values of that input that satisfy the condition
2026
+ */
2027
+ values: unknown;
2028
+ /**
2029
+ * How the conditions combine: \`and\` (all must match) or \`or\` (any must match)
2030
+ */
2031
+ operator?: 'and' | 'or';
2032
+ }
2033
+ }
1948
2034
  }
1949
2035
  /**
1950
2036
  * A representation of an asset after being processed by the workflow
@@ -2229,7 +2315,7 @@ export declare namespace WorkflowUpdateResponse {
2229
2315
  /**
2230
2316
  * The type of the job for the node.
2231
2317
  */
2232
- type: 'custom-model' | 'for-each' | 'generate-prompt' | 'list' | 'logic' | 'model' | 'remove-background' | 'transform' | 'user-approval' | 'workflow';
2318
+ type: 'custom-model' | 'for-each' | 'generate-prompt' | 'list' | 'logic' | 'model' | 'remove-background' | 'transform' | 'user-approval' | 'user-selection' | 'workflow';
2233
2319
  /**
2234
2320
  * Fixed number of iterations for a ForEach node. When set, the loop runs exactly
2235
2321
  * `count` times regardless of array input. When not set, the loop iterates over
@@ -2250,13 +2336,14 @@ export declare namespace WorkflowUpdateResponse {
2250
2336
  */
2251
2337
  includeOutputsInWorkflowJob?: true;
2252
2338
  /**
2253
- * The inputs of the node.
2339
+ * The inputs of the node. For a user-selection node, the array input's `min`/`max`
2340
+ * bound how many items the user may pick (defaults: 1 and 100); conditional
2341
+ * connections may be present as additional inputs.
2254
2342
  */
2255
2343
  inputs?: Array<Flow.Input>;
2256
2344
  /**
2257
- * Statically-configured items for a List node. The node outputs this array as-is
2258
- * when executed. Only available for List nodes. The values can be strings,
2259
- * numbers, or asset IDs.
2345
+ * Statically-configured items for a List node, or the frozen candidate list of a
2346
+ * UserSelection node. The values can be strings, numbers, or asset IDs.
2260
2347
  */
2261
2348
  items?: Array<string>;
2262
2349
  /**
@@ -2443,8 +2530,7 @@ export declare namespace WorkflowUpdateResponse {
2443
2530
  * - \`ifNotDefined\`: Input is required when another specified input is not
2444
2531
  * defined
2445
2532
  * - \`ifDefined\`: Input is required when another specified input is defined
2446
- * - \`conditionalValues\`: Input is required when another input has a specific
2447
- * value
2533
+ * - \`conditional\`: Input is required when other inputs have specific values
2448
2534
  *
2449
2535
  * By default, the input is not required.
2450
2536
  */
@@ -2605,8 +2691,7 @@ export declare namespace WorkflowUpdateResponse {
2605
2691
  * - \`ifNotDefined\`: Input is required when another specified input is not
2606
2692
  * defined
2607
2693
  * - \`ifDefined\`: Input is required when another specified input is defined
2608
- * - \`conditionalValues\`: Input is required when another input has a specific
2609
- * value
2694
+ * - \`conditional\`: Input is required when other inputs have specific values
2610
2695
  *
2611
2696
  * By default, the input is not required.
2612
2697
  */
@@ -2656,8 +2741,7 @@ export declare namespace WorkflowUpdateResponse {
2656
2741
  * - \`ifNotDefined\`: Input is required when another specified input is not
2657
2742
  * defined
2658
2743
  * - \`ifDefined\`: Input is required when another specified input is defined
2659
- * - \`conditionalValues\`: Input is required when another input has a specific
2660
- * value
2744
+ * - \`conditional\`: Input is required when other inputs have specific values
2661
2745
  *
2662
2746
  * By default, the input is not required.
2663
2747
  */
@@ -2667,12 +2751,9 @@ export declare namespace WorkflowUpdateResponse {
2667
2751
  */
2668
2752
  always?: boolean;
2669
2753
  /**
2670
- * Makes this input required when another input has a specific value:
2671
- *
2672
- * - Key: name of the input to check
2673
- * - Value: operation and allowed values that trigger the requirement
2754
+ * Makes this input required when other inputs have one of the listed values
2674
2755
  */
2675
- conditionalValues?: unknown;
2756
+ conditional?: Required.Conditional;
2676
2757
  /**
2677
2758
  * Makes this input required when another input is defined:
2678
2759
  *
@@ -2688,6 +2769,24 @@ export declare namespace WorkflowUpdateResponse {
2688
2769
  */
2689
2770
  ifNotDefined?: unknown;
2690
2771
  }
2772
+ namespace Required {
2773
+ /**
2774
+ * Makes this input required when other inputs have one of the listed values
2775
+ */
2776
+ interface Conditional {
2777
+ /**
2778
+ * The conditions to check:
2779
+ *
2780
+ * - Key: name of the input to check
2781
+ * - Value: values of that input that satisfy the condition
2782
+ */
2783
+ values: unknown;
2784
+ /**
2785
+ * How the conditions combine: \`and\` (all must match) or \`or\` (any must match)
2786
+ */
2787
+ operator?: 'and' | 'or';
2788
+ }
2789
+ }
2691
2790
  }
2692
2791
  /**
2693
2792
  * The reference to another input or output of the same workflow. Must have at
@@ -2723,8 +2822,7 @@ export declare namespace WorkflowUpdateResponse {
2723
2822
  * - \`ifNotDefined\`: Input is required when another specified input is not
2724
2823
  * defined
2725
2824
  * - \`ifDefined\`: Input is required when another specified input is defined
2726
- * - \`conditionalValues\`: Input is required when another input has a specific
2727
- * value
2825
+ * - \`conditional\`: Input is required when other inputs have specific values
2728
2826
  *
2729
2827
  * By default, the input is not required.
2730
2828
  */
@@ -2734,12 +2832,9 @@ export declare namespace WorkflowUpdateResponse {
2734
2832
  */
2735
2833
  always?: boolean;
2736
2834
  /**
2737
- * Makes this input required when another input has a specific value:
2738
- *
2739
- * - Key: name of the input to check
2740
- * - Value: operation and allowed values that trigger the requirement
2835
+ * Makes this input required when other inputs have one of the listed values
2741
2836
  */
2742
- conditionalValues?: unknown;
2837
+ conditional?: Required.Conditional;
2743
2838
  /**
2744
2839
  * Makes this input required when another input is defined:
2745
2840
  *
@@ -2755,6 +2850,24 @@ export declare namespace WorkflowUpdateResponse {
2755
2850
  */
2756
2851
  ifNotDefined?: unknown;
2757
2852
  }
2853
+ namespace Required {
2854
+ /**
2855
+ * Makes this input required when other inputs have one of the listed values
2856
+ */
2857
+ interface Conditional {
2858
+ /**
2859
+ * The conditions to check:
2860
+ *
2861
+ * - Key: name of the input to check
2862
+ * - Value: values of that input that satisfy the condition
2863
+ */
2864
+ values: unknown;
2865
+ /**
2866
+ * How the conditions combine: \`and\` (all must match) or \`or\` (any must match)
2867
+ */
2868
+ operator?: 'and' | 'or';
2869
+ }
2870
+ }
2758
2871
  }
2759
2872
  /**
2760
2873
  * The logic of the node. Only available for logic nodes.
@@ -2923,8 +3036,7 @@ export declare namespace WorkflowUpdateResponse {
2923
3036
  * - \`ifNotDefined\`: Input is required when another specified input is not
2924
3037
  * defined
2925
3038
  * - \`ifDefined\`: Input is required when another specified input is defined
2926
- * - \`conditionalValues\`: Input is required when another input has a specific
2927
- * value
3039
+ * - \`conditional\`: Input is required when other inputs have specific values
2928
3040
  *
2929
3041
  * By default, the input is not required.
2930
3042
  */
@@ -2942,8 +3054,7 @@ export declare namespace WorkflowUpdateResponse {
2942
3054
  * - \`ifNotDefined\`: Input is required when another specified input is not
2943
3055
  * defined
2944
3056
  * - \`ifDefined\`: Input is required when another specified input is defined
2945
- * - \`conditionalValues\`: Input is required when another input has a specific
2946
- * value
3057
+ * - \`conditional\`: Input is required when other inputs have specific values
2947
3058
  *
2948
3059
  * By default, the input is not required.
2949
3060
  */
@@ -2953,12 +3064,9 @@ export declare namespace WorkflowUpdateResponse {
2953
3064
  */
2954
3065
  always?: boolean;
2955
3066
  /**
2956
- * Makes this input required when another input has a specific value:
2957
- *
2958
- * - Key: name of the input to check
2959
- * - Value: operation and allowed values that trigger the requirement
3067
+ * Makes this input required when other inputs have one of the listed values
2960
3068
  */
2961
- conditionalValues?: unknown;
3069
+ conditional?: Required.Conditional;
2962
3070
  /**
2963
3071
  * Makes this input required when another input is defined:
2964
3072
  *
@@ -2974,6 +3082,24 @@ export declare namespace WorkflowUpdateResponse {
2974
3082
  */
2975
3083
  ifNotDefined?: unknown;
2976
3084
  }
3085
+ namespace Required {
3086
+ /**
3087
+ * Makes this input required when other inputs have one of the listed values
3088
+ */
3089
+ interface Conditional {
3090
+ /**
3091
+ * The conditions to check:
3092
+ *
3093
+ * - Key: name of the input to check
3094
+ * - Value: values of that input that satisfy the condition
3095
+ */
3096
+ values: unknown;
3097
+ /**
3098
+ * How the conditions combine: \`and\` (all must match) or \`or\` (any must match)
3099
+ */
3100
+ operator?: 'and' | 'or';
3101
+ }
3102
+ }
2977
3103
  }
2978
3104
  /**
2979
3105
  * A representation of an asset after being processed by the workflow
@@ -3396,8 +3522,7 @@ export declare namespace WorkflowListResponse {
3396
3522
  * - \`ifNotDefined\`: Input is required when another specified input is not
3397
3523
  * defined
3398
3524
  * - \`ifDefined\`: Input is required when another specified input is defined
3399
- * - \`conditionalValues\`: Input is required when another input has a specific
3400
- * value
3525
+ * - \`conditional\`: Input is required when other inputs have specific values
3401
3526
  *
3402
3527
  * By default, the input is not required.
3403
3528
  */
@@ -3415,8 +3540,7 @@ export declare namespace WorkflowListResponse {
3415
3540
  * - \`ifNotDefined\`: Input is required when another specified input is not
3416
3541
  * defined
3417
3542
  * - \`ifDefined\`: Input is required when another specified input is defined
3418
- * - \`conditionalValues\`: Input is required when another input has a specific
3419
- * value
3543
+ * - \`conditional\`: Input is required when other inputs have specific values
3420
3544
  *
3421
3545
  * By default, the input is not required.
3422
3546
  */
@@ -3426,12 +3550,9 @@ export declare namespace WorkflowListResponse {
3426
3550
  */
3427
3551
  always?: boolean;
3428
3552
  /**
3429
- * Makes this input required when another input has a specific value:
3430
- *
3431
- * - Key: name of the input to check
3432
- * - Value: operation and allowed values that trigger the requirement
3553
+ * Makes this input required when other inputs have one of the listed values
3433
3554
  */
3434
- conditionalValues?: unknown;
3555
+ conditional?: Required.Conditional;
3435
3556
  /**
3436
3557
  * Makes this input required when another input is defined:
3437
3558
  *
@@ -3447,6 +3568,24 @@ export declare namespace WorkflowListResponse {
3447
3568
  */
3448
3569
  ifNotDefined?: unknown;
3449
3570
  }
3571
+ namespace Required {
3572
+ /**
3573
+ * Makes this input required when other inputs have one of the listed values
3574
+ */
3575
+ interface Conditional {
3576
+ /**
3577
+ * The conditions to check:
3578
+ *
3579
+ * - Key: name of the input to check
3580
+ * - Value: values of that input that satisfy the condition
3581
+ */
3582
+ values: unknown;
3583
+ /**
3584
+ * How the conditions combine: \`and\` (all must match) or \`or\` (any must match)
3585
+ */
3586
+ operator?: 'and' | 'or';
3587
+ }
3588
+ }
3450
3589
  }
3451
3590
  /**
3452
3591
  * A representation of an asset after being processed by the workflow
@@ -3484,7 +3623,7 @@ export declare namespace WorkflowListResponse {
3484
3623
  /**
3485
3624
  * The type of the job for the node.
3486
3625
  */
3487
- type: 'custom-model' | 'for-each' | 'generate-prompt' | 'list' | 'logic' | 'model' | 'remove-background' | 'transform' | 'user-approval' | 'workflow';
3626
+ type: 'custom-model' | 'for-each' | 'generate-prompt' | 'list' | 'logic' | 'model' | 'remove-background' | 'transform' | 'user-approval' | 'user-selection' | 'workflow';
3488
3627
  /**
3489
3628
  * Fixed number of iterations for a ForEach node. When set, the loop runs exactly
3490
3629
  * `count` times regardless of array input. When not set, the loop iterates over
@@ -3505,13 +3644,14 @@ export declare namespace WorkflowListResponse {
3505
3644
  */
3506
3645
  includeOutputsInWorkflowJob?: true;
3507
3646
  /**
3508
- * The inputs of the node.
3647
+ * The inputs of the node. For a user-selection node, the array input's `min`/`max`
3648
+ * bound how many items the user may pick (defaults: 1 and 100); conditional
3649
+ * connections may be present as additional inputs.
3509
3650
  */
3510
3651
  inputs?: Array<Flow.Input>;
3511
3652
  /**
3512
- * Statically-configured items for a List node. The node outputs this array as-is
3513
- * when executed. Only available for List nodes. The values can be strings,
3514
- * numbers, or asset IDs.
3653
+ * Statically-configured items for a List node, or the frozen candidate list of a
3654
+ * UserSelection node. The values can be strings, numbers, or asset IDs.
3515
3655
  */
3516
3656
  items?: Array<string>;
3517
3657
  /**
@@ -3698,8 +3838,7 @@ export declare namespace WorkflowListResponse {
3698
3838
  * - \`ifNotDefined\`: Input is required when another specified input is not
3699
3839
  * defined
3700
3840
  * - \`ifDefined\`: Input is required when another specified input is defined
3701
- * - \`conditionalValues\`: Input is required when another input has a specific
3702
- * value
3841
+ * - \`conditional\`: Input is required when other inputs have specific values
3703
3842
  *
3704
3843
  * By default, the input is not required.
3705
3844
  */
@@ -3860,8 +3999,7 @@ export declare namespace WorkflowListResponse {
3860
3999
  * - \`ifNotDefined\`: Input is required when another specified input is not
3861
4000
  * defined
3862
4001
  * - \`ifDefined\`: Input is required when another specified input is defined
3863
- * - \`conditionalValues\`: Input is required when another input has a specific
3864
- * value
4002
+ * - \`conditional\`: Input is required when other inputs have specific values
3865
4003
  *
3866
4004
  * By default, the input is not required.
3867
4005
  */
@@ -3911,8 +4049,7 @@ export declare namespace WorkflowListResponse {
3911
4049
  * - \`ifNotDefined\`: Input is required when another specified input is not
3912
4050
  * defined
3913
4051
  * - \`ifDefined\`: Input is required when another specified input is defined
3914
- * - \`conditionalValues\`: Input is required when another input has a specific
3915
- * value
4052
+ * - \`conditional\`: Input is required when other inputs have specific values
3916
4053
  *
3917
4054
  * By default, the input is not required.
3918
4055
  */
@@ -3922,12 +4059,9 @@ export declare namespace WorkflowListResponse {
3922
4059
  */
3923
4060
  always?: boolean;
3924
4061
  /**
3925
- * Makes this input required when another input has a specific value:
3926
- *
3927
- * - Key: name of the input to check
3928
- * - Value: operation and allowed values that trigger the requirement
4062
+ * Makes this input required when other inputs have one of the listed values
3929
4063
  */
3930
- conditionalValues?: unknown;
4064
+ conditional?: Required.Conditional;
3931
4065
  /**
3932
4066
  * Makes this input required when another input is defined:
3933
4067
  *
@@ -3943,6 +4077,24 @@ export declare namespace WorkflowListResponse {
3943
4077
  */
3944
4078
  ifNotDefined?: unknown;
3945
4079
  }
4080
+ namespace Required {
4081
+ /**
4082
+ * Makes this input required when other inputs have one of the listed values
4083
+ */
4084
+ interface Conditional {
4085
+ /**
4086
+ * The conditions to check:
4087
+ *
4088
+ * - Key: name of the input to check
4089
+ * - Value: values of that input that satisfy the condition
4090
+ */
4091
+ values: unknown;
4092
+ /**
4093
+ * How the conditions combine: \`and\` (all must match) or \`or\` (any must match)
4094
+ */
4095
+ operator?: 'and' | 'or';
4096
+ }
4097
+ }
3946
4098
  }
3947
4099
  /**
3948
4100
  * The reference to another input or output of the same workflow. Must have at
@@ -3978,8 +4130,7 @@ export declare namespace WorkflowListResponse {
3978
4130
  * - \`ifNotDefined\`: Input is required when another specified input is not
3979
4131
  * defined
3980
4132
  * - \`ifDefined\`: Input is required when another specified input is defined
3981
- * - \`conditionalValues\`: Input is required when another input has a specific
3982
- * value
4133
+ * - \`conditional\`: Input is required when other inputs have specific values
3983
4134
  *
3984
4135
  * By default, the input is not required.
3985
4136
  */
@@ -3989,12 +4140,9 @@ export declare namespace WorkflowListResponse {
3989
4140
  */
3990
4141
  always?: boolean;
3991
4142
  /**
3992
- * Makes this input required when another input has a specific value:
3993
- *
3994
- * - Key: name of the input to check
3995
- * - Value: operation and allowed values that trigger the requirement
4143
+ * Makes this input required when other inputs have one of the listed values
3996
4144
  */
3997
- conditionalValues?: unknown;
4145
+ conditional?: Required.Conditional;
3998
4146
  /**
3999
4147
  * Makes this input required when another input is defined:
4000
4148
  *
@@ -4010,6 +4158,24 @@ export declare namespace WorkflowListResponse {
4010
4158
  */
4011
4159
  ifNotDefined?: unknown;
4012
4160
  }
4161
+ namespace Required {
4162
+ /**
4163
+ * Makes this input required when other inputs have one of the listed values
4164
+ */
4165
+ interface Conditional {
4166
+ /**
4167
+ * The conditions to check:
4168
+ *
4169
+ * - Key: name of the input to check
4170
+ * - Value: values of that input that satisfy the condition
4171
+ */
4172
+ values: unknown;
4173
+ /**
4174
+ * How the conditions combine: \`and\` (all must match) or \`or\` (any must match)
4175
+ */
4176
+ operator?: 'and' | 'or';
4177
+ }
4178
+ }
4013
4179
  }
4014
4180
  /**
4015
4181
  * The logic of the node. Only available for logic nodes.
@@ -4287,7 +4453,7 @@ export declare namespace WorkflowRunResponse {
4287
4453
  /**
4288
4454
  * The type of the job for the node.
4289
4455
  */
4290
- type: 'custom-model' | 'for-each' | 'generate-prompt' | 'list' | 'logic' | 'model' | 'remove-background' | 'transform' | 'user-approval' | 'workflow';
4456
+ type: 'custom-model' | 'for-each' | 'generate-prompt' | 'list' | 'logic' | 'model' | 'remove-background' | 'transform' | 'user-approval' | 'user-selection' | 'workflow';
4291
4457
  /**
4292
4458
  * List of produced assets for this node.
4293
4459
  */
@@ -4312,13 +4478,14 @@ export declare namespace WorkflowRunResponse {
4312
4478
  */
4313
4479
  includeOutputsInWorkflowJob?: true;
4314
4480
  /**
4315
- * The inputs of the node.
4481
+ * The inputs of the node. For a user-selection node, the array input's `min`/`max`
4482
+ * bound how many items the user may pick (defaults: 1 and 100); conditional
4483
+ * connections may be present as additional inputs.
4316
4484
  */
4317
4485
  inputs?: Array<Flow.Input>;
4318
4486
  /**
4319
- * Statically-configured items for a List node. The node outputs this array as-is
4320
- * when executed. Only available for List nodes. The values can be strings,
4321
- * numbers, or asset IDs.
4487
+ * Statically-configured items for a List node, or the frozen candidate list of a
4488
+ * UserSelection node. The values can be strings, numbers, or asset IDs.
4322
4489
  */
4323
4490
  items?: Array<string>;
4324
4491
  /**
@@ -4519,8 +4686,7 @@ export declare namespace WorkflowRunResponse {
4519
4686
  * - \`ifNotDefined\`: Input is required when another specified input is not
4520
4687
  * defined
4521
4688
  * - \`ifDefined\`: Input is required when another specified input is defined
4522
- * - \`conditionalValues\`: Input is required when another input has a specific
4523
- * value
4689
+ * - \`conditional\`: Input is required when other inputs have specific values
4524
4690
  *
4525
4691
  * By default, the input is not required.
4526
4692
  */
@@ -4681,8 +4847,7 @@ export declare namespace WorkflowRunResponse {
4681
4847
  * - \`ifNotDefined\`: Input is required when another specified input is not
4682
4848
  * defined
4683
4849
  * - \`ifDefined\`: Input is required when another specified input is defined
4684
- * - \`conditionalValues\`: Input is required when another input has a specific
4685
- * value
4850
+ * - \`conditional\`: Input is required when other inputs have specific values
4686
4851
  *
4687
4852
  * By default, the input is not required.
4688
4853
  */
@@ -4732,8 +4897,7 @@ export declare namespace WorkflowRunResponse {
4732
4897
  * - \`ifNotDefined\`: Input is required when another specified input is not
4733
4898
  * defined
4734
4899
  * - \`ifDefined\`: Input is required when another specified input is defined
4735
- * - \`conditionalValues\`: Input is required when another input has a specific
4736
- * value
4900
+ * - \`conditional\`: Input is required when other inputs have specific values
4737
4901
  *
4738
4902
  * By default, the input is not required.
4739
4903
  */
@@ -4743,12 +4907,9 @@ export declare namespace WorkflowRunResponse {
4743
4907
  */
4744
4908
  always?: boolean;
4745
4909
  /**
4746
- * Makes this input required when another input has a specific value:
4747
- *
4748
- * - Key: name of the input to check
4749
- * - Value: operation and allowed values that trigger the requirement
4910
+ * Makes this input required when other inputs have one of the listed values
4750
4911
  */
4751
- conditionalValues?: unknown;
4912
+ conditional?: Required.Conditional;
4752
4913
  /**
4753
4914
  * Makes this input required when another input is defined:
4754
4915
  *
@@ -4764,6 +4925,24 @@ export declare namespace WorkflowRunResponse {
4764
4925
  */
4765
4926
  ifNotDefined?: unknown;
4766
4927
  }
4928
+ namespace Required {
4929
+ /**
4930
+ * Makes this input required when other inputs have one of the listed values
4931
+ */
4932
+ interface Conditional {
4933
+ /**
4934
+ * The conditions to check:
4935
+ *
4936
+ * - Key: name of the input to check
4937
+ * - Value: values of that input that satisfy the condition
4938
+ */
4939
+ values: unknown;
4940
+ /**
4941
+ * How the conditions combine: \`and\` (all must match) or \`or\` (any must match)
4942
+ */
4943
+ operator?: 'and' | 'or';
4944
+ }
4945
+ }
4767
4946
  }
4768
4947
  /**
4769
4948
  * The reference to another input or output of the same workflow. Must have at
@@ -4799,8 +4978,7 @@ export declare namespace WorkflowRunResponse {
4799
4978
  * - \`ifNotDefined\`: Input is required when another specified input is not
4800
4979
  * defined
4801
4980
  * - \`ifDefined\`: Input is required when another specified input is defined
4802
- * - \`conditionalValues\`: Input is required when another input has a specific
4803
- * value
4981
+ * - \`conditional\`: Input is required when other inputs have specific values
4804
4982
  *
4805
4983
  * By default, the input is not required.
4806
4984
  */
@@ -4810,12 +4988,9 @@ export declare namespace WorkflowRunResponse {
4810
4988
  */
4811
4989
  always?: boolean;
4812
4990
  /**
4813
- * Makes this input required when another input has a specific value:
4814
- *
4815
- * - Key: name of the input to check
4816
- * - Value: operation and allowed values that trigger the requirement
4991
+ * Makes this input required when other inputs have one of the listed values
4817
4992
  */
4818
- conditionalValues?: unknown;
4993
+ conditional?: Required.Conditional;
4819
4994
  /**
4820
4995
  * Makes this input required when another input is defined:
4821
4996
  *
@@ -4831,6 +5006,24 @@ export declare namespace WorkflowRunResponse {
4831
5006
  */
4832
5007
  ifNotDefined?: unknown;
4833
5008
  }
5009
+ namespace Required {
5010
+ /**
5011
+ * Makes this input required when other inputs have one of the listed values
5012
+ */
5013
+ interface Conditional {
5014
+ /**
5015
+ * The conditions to check:
5016
+ *
5017
+ * - Key: name of the input to check
5018
+ * - Value: values of that input that satisfy the condition
5019
+ */
5020
+ values: unknown;
5021
+ /**
5022
+ * How the conditions combine: \`and\` (all must match) or \`or\` (any must match)
5023
+ */
5024
+ operator?: 'and' | 'or';
5025
+ }
5026
+ }
4834
5027
  }
4835
5028
  /**
4836
5029
  * The logic of the node. Only available for logic nodes.
@@ -5043,7 +5236,7 @@ export declare namespace WorkflowRunResponse {
5043
5236
  /**
5044
5237
  * The type of the job for the node.
5045
5238
  */
5046
- type: 'custom-model' | 'for-each' | 'generate-prompt' | 'list' | 'logic' | 'model' | 'remove-background' | 'transform' | 'user-approval' | 'workflow';
5239
+ type: 'custom-model' | 'for-each' | 'generate-prompt' | 'list' | 'logic' | 'model' | 'remove-background' | 'transform' | 'user-approval' | 'user-selection' | 'workflow';
5047
5240
  /**
5048
5241
  * Fixed number of iterations for a ForEach node. When set, the loop runs exactly
5049
5242
  * `count` times regardless of array input. When not set, the loop iterates over
@@ -5064,13 +5257,14 @@ export declare namespace WorkflowRunResponse {
5064
5257
  */
5065
5258
  includeOutputsInWorkflowJob?: true;
5066
5259
  /**
5067
- * The inputs of the node.
5260
+ * The inputs of the node. For a user-selection node, the array input's `min`/`max`
5261
+ * bound how many items the user may pick (defaults: 1 and 100); conditional
5262
+ * connections may be present as additional inputs.
5068
5263
  */
5069
5264
  inputs?: Array<Flow.Input>;
5070
5265
  /**
5071
- * Statically-configured items for a List node. The node outputs this array as-is
5072
- * when executed. Only available for List nodes. The values can be strings,
5073
- * numbers, or asset IDs.
5266
+ * Statically-configured items for a List node, or the frozen candidate list of a
5267
+ * UserSelection node. The values can be strings, numbers, or asset IDs.
5074
5268
  */
5075
5269
  items?: Array<string>;
5076
5270
  /**
@@ -5257,8 +5451,7 @@ export declare namespace WorkflowRunResponse {
5257
5451
  * - \`ifNotDefined\`: Input is required when another specified input is not
5258
5452
  * defined
5259
5453
  * - \`ifDefined\`: Input is required when another specified input is defined
5260
- * - \`conditionalValues\`: Input is required when another input has a specific
5261
- * value
5454
+ * - \`conditional\`: Input is required when other inputs have specific values
5262
5455
  *
5263
5456
  * By default, the input is not required.
5264
5457
  */
@@ -5419,8 +5612,7 @@ export declare namespace WorkflowRunResponse {
5419
5612
  * - \`ifNotDefined\`: Input is required when another specified input is not
5420
5613
  * defined
5421
5614
  * - \`ifDefined\`: Input is required when another specified input is defined
5422
- * - \`conditionalValues\`: Input is required when another input has a specific
5423
- * value
5615
+ * - \`conditional\`: Input is required when other inputs have specific values
5424
5616
  *
5425
5617
  * By default, the input is not required.
5426
5618
  */
@@ -5470,8 +5662,7 @@ export declare namespace WorkflowRunResponse {
5470
5662
  * - \`ifNotDefined\`: Input is required when another specified input is not
5471
5663
  * defined
5472
5664
  * - \`ifDefined\`: Input is required when another specified input is defined
5473
- * - \`conditionalValues\`: Input is required when another input has a specific
5474
- * value
5665
+ * - \`conditional\`: Input is required when other inputs have specific values
5475
5666
  *
5476
5667
  * By default, the input is not required.
5477
5668
  */
@@ -5481,12 +5672,9 @@ export declare namespace WorkflowRunResponse {
5481
5672
  */
5482
5673
  always?: boolean;
5483
5674
  /**
5484
- * Makes this input required when another input has a specific value:
5485
- *
5486
- * - Key: name of the input to check
5487
- * - Value: operation and allowed values that trigger the requirement
5675
+ * Makes this input required when other inputs have one of the listed values
5488
5676
  */
5489
- conditionalValues?: unknown;
5677
+ conditional?: Required.Conditional;
5490
5678
  /**
5491
5679
  * Makes this input required when another input is defined:
5492
5680
  *
@@ -5502,6 +5690,24 @@ export declare namespace WorkflowRunResponse {
5502
5690
  */
5503
5691
  ifNotDefined?: unknown;
5504
5692
  }
5693
+ namespace Required {
5694
+ /**
5695
+ * Makes this input required when other inputs have one of the listed values
5696
+ */
5697
+ interface Conditional {
5698
+ /**
5699
+ * The conditions to check:
5700
+ *
5701
+ * - Key: name of the input to check
5702
+ * - Value: values of that input that satisfy the condition
5703
+ */
5704
+ values: unknown;
5705
+ /**
5706
+ * How the conditions combine: \`and\` (all must match) or \`or\` (any must match)
5707
+ */
5708
+ operator?: 'and' | 'or';
5709
+ }
5710
+ }
5505
5711
  }
5506
5712
  /**
5507
5713
  * The reference to another input or output of the same workflow. Must have at
@@ -5537,8 +5743,7 @@ export declare namespace WorkflowRunResponse {
5537
5743
  * - \`ifNotDefined\`: Input is required when another specified input is not
5538
5744
  * defined
5539
5745
  * - \`ifDefined\`: Input is required when another specified input is defined
5540
- * - \`conditionalValues\`: Input is required when another input has a specific
5541
- * value
5746
+ * - \`conditional\`: Input is required when other inputs have specific values
5542
5747
  *
5543
5748
  * By default, the input is not required.
5544
5749
  */
@@ -5548,12 +5753,9 @@ export declare namespace WorkflowRunResponse {
5548
5753
  */
5549
5754
  always?: boolean;
5550
5755
  /**
5551
- * Makes this input required when another input has a specific value:
5552
- *
5553
- * - Key: name of the input to check
5554
- * - Value: operation and allowed values that trigger the requirement
5756
+ * Makes this input required when other inputs have one of the listed values
5555
5757
  */
5556
- conditionalValues?: unknown;
5758
+ conditional?: Required.Conditional;
5557
5759
  /**
5558
5760
  * Makes this input required when another input is defined:
5559
5761
  *
@@ -5569,6 +5771,24 @@ export declare namespace WorkflowRunResponse {
5569
5771
  */
5570
5772
  ifNotDefined?: unknown;
5571
5773
  }
5774
+ namespace Required {
5775
+ /**
5776
+ * Makes this input required when other inputs have one of the listed values
5777
+ */
5778
+ interface Conditional {
5779
+ /**
5780
+ * The conditions to check:
5781
+ *
5782
+ * - Key: name of the input to check
5783
+ * - Value: values of that input that satisfy the condition
5784
+ */
5785
+ values: unknown;
5786
+ /**
5787
+ * How the conditions combine: \`and\` (all must match) or \`or\` (any must match)
5788
+ */
5789
+ operator?: 'and' | 'or';
5790
+ }
5791
+ }
5572
5792
  }
5573
5793
  /**
5574
5794
  * The logic of the node. Only available for logic nodes.
@@ -5737,8 +5957,7 @@ export declare namespace WorkflowRunResponse {
5737
5957
  * - \`ifNotDefined\`: Input is required when another specified input is not
5738
5958
  * defined
5739
5959
  * - \`ifDefined\`: Input is required when another specified input is defined
5740
- * - \`conditionalValues\`: Input is required when another input has a specific
5741
- * value
5960
+ * - \`conditional\`: Input is required when other inputs have specific values
5742
5961
  *
5743
5962
  * By default, the input is not required.
5744
5963
  */
@@ -5756,8 +5975,7 @@ export declare namespace WorkflowRunResponse {
5756
5975
  * - \`ifNotDefined\`: Input is required when another specified input is not
5757
5976
  * defined
5758
5977
  * - \`ifDefined\`: Input is required when another specified input is defined
5759
- * - \`conditionalValues\`: Input is required when another input has a specific
5760
- * value
5978
+ * - \`conditional\`: Input is required when other inputs have specific values
5761
5979
  *
5762
5980
  * By default, the input is not required.
5763
5981
  */
@@ -5767,12 +5985,9 @@ export declare namespace WorkflowRunResponse {
5767
5985
  */
5768
5986
  always?: boolean;
5769
5987
  /**
5770
- * Makes this input required when another input has a specific value:
5771
- *
5772
- * - Key: name of the input to check
5773
- * - Value: operation and allowed values that trigger the requirement
5988
+ * Makes this input required when other inputs have one of the listed values
5774
5989
  */
5775
- conditionalValues?: unknown;
5990
+ conditional?: Required.Conditional;
5776
5991
  /**
5777
5992
  * Makes this input required when another input is defined:
5778
5993
  *
@@ -5788,6 +6003,24 @@ export declare namespace WorkflowRunResponse {
5788
6003
  */
5789
6004
  ifNotDefined?: unknown;
5790
6005
  }
6006
+ namespace Required {
6007
+ /**
6008
+ * Makes this input required when other inputs have one of the listed values
6009
+ */
6010
+ interface Conditional {
6011
+ /**
6012
+ * The conditions to check:
6013
+ *
6014
+ * - Key: name of the input to check
6015
+ * - Value: values of that input that satisfy the condition
6016
+ */
6017
+ values: unknown;
6018
+ /**
6019
+ * How the conditions combine: \`and\` (all must match) or \`or\` (any must match)
6020
+ */
6021
+ operator?: 'and' | 'or';
6022
+ }
6023
+ }
5791
6024
  }
5792
6025
  /**
5793
6026
  * A representation of an asset after being processed by the workflow
@@ -6058,7 +6291,7 @@ export declare namespace WorkflowUserApprovalResponse {
6058
6291
  /**
6059
6292
  * The type of the job for the node.
6060
6293
  */
6061
- type: 'custom-model' | 'for-each' | 'generate-prompt' | 'list' | 'logic' | 'model' | 'remove-background' | 'transform' | 'user-approval' | 'workflow';
6294
+ type: 'custom-model' | 'for-each' | 'generate-prompt' | 'list' | 'logic' | 'model' | 'remove-background' | 'transform' | 'user-approval' | 'user-selection' | 'workflow';
6062
6295
  /**
6063
6296
  * List of produced assets for this node.
6064
6297
  */
@@ -6083,13 +6316,14 @@ export declare namespace WorkflowUserApprovalResponse {
6083
6316
  */
6084
6317
  includeOutputsInWorkflowJob?: true;
6085
6318
  /**
6086
- * The inputs of the node.
6319
+ * The inputs of the node. For a user-selection node, the array input's `min`/`max`
6320
+ * bound how many items the user may pick (defaults: 1 and 100); conditional
6321
+ * connections may be present as additional inputs.
6087
6322
  */
6088
6323
  inputs?: Array<Flow.Input>;
6089
6324
  /**
6090
- * Statically-configured items for a List node. The node outputs this array as-is
6091
- * when executed. Only available for List nodes. The values can be strings,
6092
- * numbers, or asset IDs.
6325
+ * Statically-configured items for a List node, or the frozen candidate list of a
6326
+ * UserSelection node. The values can be strings, numbers, or asset IDs.
6093
6327
  */
6094
6328
  items?: Array<string>;
6095
6329
  /**
@@ -6290,8 +6524,7 @@ export declare namespace WorkflowUserApprovalResponse {
6290
6524
  * - \`ifNotDefined\`: Input is required when another specified input is not
6291
6525
  * defined
6292
6526
  * - \`ifDefined\`: Input is required when another specified input is defined
6293
- * - \`conditionalValues\`: Input is required when another input has a specific
6294
- * value
6527
+ * - \`conditional\`: Input is required when other inputs have specific values
6295
6528
  *
6296
6529
  * By default, the input is not required.
6297
6530
  */
@@ -6452,8 +6685,7 @@ export declare namespace WorkflowUserApprovalResponse {
6452
6685
  * - \`ifNotDefined\`: Input is required when another specified input is not
6453
6686
  * defined
6454
6687
  * - \`ifDefined\`: Input is required when another specified input is defined
6455
- * - \`conditionalValues\`: Input is required when another input has a specific
6456
- * value
6688
+ * - \`conditional\`: Input is required when other inputs have specific values
6457
6689
  *
6458
6690
  * By default, the input is not required.
6459
6691
  */
@@ -6503,8 +6735,7 @@ export declare namespace WorkflowUserApprovalResponse {
6503
6735
  * - \`ifNotDefined\`: Input is required when another specified input is not
6504
6736
  * defined
6505
6737
  * - \`ifDefined\`: Input is required when another specified input is defined
6506
- * - \`conditionalValues\`: Input is required when another input has a specific
6507
- * value
6738
+ * - \`conditional\`: Input is required when other inputs have specific values
6508
6739
  *
6509
6740
  * By default, the input is not required.
6510
6741
  */
@@ -6514,12 +6745,9 @@ export declare namespace WorkflowUserApprovalResponse {
6514
6745
  */
6515
6746
  always?: boolean;
6516
6747
  /**
6517
- * Makes this input required when another input has a specific value:
6518
- *
6519
- * - Key: name of the input to check
6520
- * - Value: operation and allowed values that trigger the requirement
6748
+ * Makes this input required when other inputs have one of the listed values
6521
6749
  */
6522
- conditionalValues?: unknown;
6750
+ conditional?: Required.Conditional;
6523
6751
  /**
6524
6752
  * Makes this input required when another input is defined:
6525
6753
  *
@@ -6535,6 +6763,24 @@ export declare namespace WorkflowUserApprovalResponse {
6535
6763
  */
6536
6764
  ifNotDefined?: unknown;
6537
6765
  }
6766
+ namespace Required {
6767
+ /**
6768
+ * Makes this input required when other inputs have one of the listed values
6769
+ */
6770
+ interface Conditional {
6771
+ /**
6772
+ * The conditions to check:
6773
+ *
6774
+ * - Key: name of the input to check
6775
+ * - Value: values of that input that satisfy the condition
6776
+ */
6777
+ values: unknown;
6778
+ /**
6779
+ * How the conditions combine: \`and\` (all must match) or \`or\` (any must match)
6780
+ */
6781
+ operator?: 'and' | 'or';
6782
+ }
6783
+ }
6538
6784
  }
6539
6785
  /**
6540
6786
  * The reference to another input or output of the same workflow. Must have at
@@ -6570,8 +6816,7 @@ export declare namespace WorkflowUserApprovalResponse {
6570
6816
  * - \`ifNotDefined\`: Input is required when another specified input is not
6571
6817
  * defined
6572
6818
  * - \`ifDefined\`: Input is required when another specified input is defined
6573
- * - \`conditionalValues\`: Input is required when another input has a specific
6574
- * value
6819
+ * - \`conditional\`: Input is required when other inputs have specific values
6575
6820
  *
6576
6821
  * By default, the input is not required.
6577
6822
  */
@@ -6581,12 +6826,9 @@ export declare namespace WorkflowUserApprovalResponse {
6581
6826
  */
6582
6827
  always?: boolean;
6583
6828
  /**
6584
- * Makes this input required when another input has a specific value:
6585
- *
6586
- * - Key: name of the input to check
6587
- * - Value: operation and allowed values that trigger the requirement
6829
+ * Makes this input required when other inputs have one of the listed values
6588
6830
  */
6589
- conditionalValues?: unknown;
6831
+ conditional?: Required.Conditional;
6590
6832
  /**
6591
6833
  * Makes this input required when another input is defined:
6592
6834
  *
@@ -6602,6 +6844,24 @@ export declare namespace WorkflowUserApprovalResponse {
6602
6844
  */
6603
6845
  ifNotDefined?: unknown;
6604
6846
  }
6847
+ namespace Required {
6848
+ /**
6849
+ * Makes this input required when other inputs have one of the listed values
6850
+ */
6851
+ interface Conditional {
6852
+ /**
6853
+ * The conditions to check:
6854
+ *
6855
+ * - Key: name of the input to check
6856
+ * - Value: values of that input that satisfy the condition
6857
+ */
6858
+ values: unknown;
6859
+ /**
6860
+ * How the conditions combine: \`and\` (all must match) or \`or\` (any must match)
6861
+ */
6862
+ operator?: 'and' | 'or';
6863
+ }
6864
+ }
6605
6865
  }
6606
6866
  /**
6607
6867
  * The logic of the node. Only available for logic nodes.
@@ -6693,48 +6953,822 @@ export declare namespace WorkflowUserApprovalResponse {
6693
6953
  }
6694
6954
  }
6695
6955
  }
6696
- export interface WorkflowCreateParams {
6697
- /**
6698
- * Body param
6699
- */
6700
- description: string;
6701
- /**
6702
- * Body param
6703
- */
6704
- name: string;
6705
- /**
6706
- * Query param: The projectId used for ownership resource management. Either to
6707
- * assert ownership or to set the owner of the resource(s)
6708
- */
6709
- projectId?: string;
6710
- }
6711
- export interface WorkflowRetrieveParams {
6712
- /**
6713
- * The projectId used for ownership resource management. Either to assert ownership
6714
- * or to set the owner of the resource(s)
6715
- */
6716
- projectId?: string;
6956
+ export interface WorkflowUserSelectionResponse {
6957
+ job: WorkflowUserSelectionResponse.Job;
6717
6958
  }
6718
- export interface WorkflowUpdateParams {
6719
- /**
6720
- * Query param: The projectId used for ownership resource management. Either to
6721
- * assert ownership or to set the owner of the resource(s)
6722
- */
6723
- projectId?: string;
6724
- /**
6725
- * Body param: The after asset of the workflow. Set to null to unset the after
6726
- * asset.
6727
- */
6728
- after?: string;
6729
- /**
6730
- * Body param: The before asset of the workflow. Set to null to unset the before
6731
- * asset.
6732
- */
6733
- before?: string;
6734
- /**
6735
- * Body param: Set to true to bypass the lock and save a locked workflow without
6736
- * unlocking it first. Only the author or a project admin can use this.
6737
- */
6959
+ export declare namespace WorkflowUserSelectionResponse {
6960
+ interface Job {
6961
+ /**
6962
+ * The job creation date as an ISO string (example: "2023-02-03T11:19:41.579Z")
6963
+ */
6964
+ createdAt: string;
6965
+ /**
6966
+ * The job ID (example: "job_ocZCnG1Df35XRL1QyCZSRxAG8")
6967
+ */
6968
+ jobId: string;
6969
+ /**
6970
+ * The type of job
6971
+ */
6972
+ jobType: 'assets-download' | 'canvas-export' | 'caption' | 'caption-llava' | 'custom' | 'describe-style' | 'detection' | 'embed' | 'flux' | 'flux-model-training' | 'generate-prompt' | 'image-generation' | 'image-prompt-editing' | 'inference' | 'mesh-preview-rendering' | 'model-download' | 'model-import' | 'model-training' | 'musubi-model-training' | 'openai-image-generation' | 'patch-image' | 'pixelate' | 'reframe' | 'remove-background' | 'repaint' | 'restyle' | 'segment' | 'skybox-3d' | 'skybox-base-360' | 'skybox-hdri' | 'skybox-upscale-360' | 'splat' | 'texture' | 'translate' | 'upload' | 'upscale' | 'upscale-skybox' | 'upscale-texture' | 'vectorize' | 'workflow';
6973
+ /**
6974
+ * Metadata of the job with some additional information
6975
+ */
6976
+ metadata: Job.Metadata;
6977
+ /**
6978
+ * Progress of the job (between 0 and 1)
6979
+ */
6980
+ progress: number;
6981
+ /**
6982
+ * The current status of the job
6983
+ */
6984
+ status: 'canceled' | 'failure' | 'finalizing' | 'in-progress' | 'pending' | 'queued' | 'success' | 'warming-up';
6985
+ /**
6986
+ * The history of the different statuses the job went through with the ISO string
6987
+ * date of when the job reached each statuses.
6988
+ */
6989
+ statusHistory: Array<Job.StatusHistory>;
6990
+ /**
6991
+ * The job last update date as an ISO string (example: "2023-02-03T11:19:41.579Z")
6992
+ */
6993
+ updatedAt: string;
6994
+ /**
6995
+ * The author user ID (example: "dcf121faaa1a0a0bbbd9ca1b73d62aea")
6996
+ */
6997
+ authorId?: string;
6998
+ /**
6999
+ * The billing of the job
7000
+ */
7001
+ billing?: Job.Billing;
7002
+ /**
7003
+ * The owner ID (example: "team_U3Qmc8PCdWXwAQJ4Dvw4tV6D")
7004
+ */
7005
+ ownerId?: string;
7006
+ }
7007
+ namespace Job {
7008
+ /**
7009
+ * Metadata of the job with some additional information
7010
+ */
7011
+ interface Metadata {
7012
+ /**
7013
+ * List of produced assets for this job
7014
+ */
7015
+ assetIds?: Array<string>;
7016
+ /**
7017
+ * Eventual error for the job
7018
+ */
7019
+ error?: string | null;
7020
+ /**
7021
+ * The flow of the job. Only available for workflow jobs.
7022
+ */
7023
+ flow?: Array<Metadata.Flow>;
7024
+ /**
7025
+ * Actionable hint for the user explaining what went wrong and how to resolve it.
7026
+ */
7027
+ hint?: string;
7028
+ /**
7029
+ * The inputs for the job
7030
+ */
7031
+ input?: {
7032
+ [key: string]: unknown;
7033
+ };
7034
+ /**
7035
+ * May contain the output of the job for specific custom models jobs. Only
7036
+ * available for custom models which generate non-assets outputs. Example: LLM text
7037
+ * results.
7038
+ */
7039
+ output?: {
7040
+ [key: string]: unknown;
7041
+ };
7042
+ /**
7043
+ * For voice-clone jobs: the ID of the model being trained.
7044
+ */
7045
+ outputModelId?: string;
7046
+ /**
7047
+ * The workflow ID of the job if job is part of a workflow.
7048
+ */
7049
+ workflowId?: string;
7050
+ /**
7051
+ * The workflow job ID of the job if job is part of a workflow job.
7052
+ */
7053
+ workflowJobId?: string;
7054
+ }
7055
+ namespace Metadata {
7056
+ interface Flow {
7057
+ /**
7058
+ * The id of the node.
7059
+ */
7060
+ id: string;
7061
+ /**
7062
+ * The status of the node. Only available for WorkflowJob nodes.
7063
+ */
7064
+ status: 'failure' | 'pending' | 'processing' | 'rejected' | 'skipped' | 'success';
7065
+ /**
7066
+ * The type of the job for the node.
7067
+ */
7068
+ type: 'custom-model' | 'for-each' | 'generate-prompt' | 'list' | 'logic' | 'model' | 'remove-background' | 'transform' | 'user-approval' | 'user-selection' | 'workflow';
7069
+ /**
7070
+ * List of produced assets for this node.
7071
+ */
7072
+ assets?: Array<Flow.Asset>;
7073
+ /**
7074
+ * Fixed number of iterations for a ForEach node. When set, the loop runs exactly
7075
+ * `count` times regardless of array input. When not set, the loop iterates over
7076
+ * the resolved array input. Only available for ForEach nodes.
7077
+ */
7078
+ count?: number;
7079
+ /**
7080
+ * The nodes that this node depends on. Only available for nodes that have
7081
+ * dependencies. Mainly used for user approval nodes.
7082
+ */
7083
+ dependsOn?: Array<string>;
7084
+ /**
7085
+ * If true, the outputs of this node will be included in the workflow job's final
7086
+ * output. Only applicable to producing nodes (custom-model, inference, etc.). By
7087
+ * default, only last nodes (nodes not referenced by other nodes) contribute to
7088
+ * outputs. Set this to true to also include intermediate nodes in the final
7089
+ * output. Note: This should only be set to `true` or left undefined.
7090
+ */
7091
+ includeOutputsInWorkflowJob?: true;
7092
+ /**
7093
+ * The inputs of the node. For a user-selection node, the array input's `min`/`max`
7094
+ * bound how many items the user may pick (defaults: 1 and 100); conditional
7095
+ * connections may be present as additional inputs.
7096
+ */
7097
+ inputs?: Array<Flow.Input>;
7098
+ /**
7099
+ * Statically-configured items for a List node, or the frozen candidate list of a
7100
+ * UserSelection node. The values can be strings, numbers, or asset IDs.
7101
+ */
7102
+ items?: Array<string>;
7103
+ /**
7104
+ * Zero-based index of the iteration this node copy belongs to. Set on
7105
+ * dynamically-created copies of loop body nodes.
7106
+ */
7107
+ iterationIndex?: number;
7108
+ /**
7109
+ * If the flow is part of a WorkflowJob, this is the jobId for the node. jobId is
7110
+ * only available for nodes started. A node "Pending" for a running workflow job is
7111
+ * not started.
7112
+ */
7113
+ jobId?: string;
7114
+ /**
7115
+ * The logic of the node. Only available for logic nodes.
7116
+ */
7117
+ logic?: Flow.Logic;
7118
+ /**
7119
+ * The type of the logic for the node. Only available for logic nodes.
7120
+ */
7121
+ logicType?: 'if-else';
7122
+ /**
7123
+ * IDs of the body template nodes that belong to this ForEach loop. At runtime
7124
+ * these templates are cloned once per iteration and marked Skipped. Only available
7125
+ * for ForEach nodes.
7126
+ */
7127
+ loopBodyNodeIds?: Array<string>;
7128
+ /**
7129
+ * ID of the ForEach node that spawned this iteration copy. Set on
7130
+ * dynamically-created copies of loop body nodes.
7131
+ */
7132
+ loopNodeId?: string;
7133
+ /**
7134
+ * The model id for the node. Mainly used for custom model tasks.
7135
+ */
7136
+ modelId?: string;
7137
+ /**
7138
+ * The output of the node. Only available for logic nodes.
7139
+ */
7140
+ output?: unknown;
7141
+ /**
7142
+ * The workflow id for the node. Mainly used for workflow tasks.
7143
+ */
7144
+ workflowId?: string;
7145
+ }
7146
+ namespace Flow {
7147
+ interface Asset {
7148
+ assetId: string;
7149
+ url: string;
7150
+ }
7151
+ /**
7152
+ * This is used to run the flow.
7153
+ */
7154
+ interface Input {
7155
+ /**
7156
+ * The name that must be user to call the model through the API
7157
+ */
7158
+ name: string;
7159
+ /**
7160
+ * The data type of the input
7161
+ */
7162
+ type: 'boolean' | 'file' | 'file_array' | 'inputs_array' | 'model' | 'model_array' | 'number' | 'number_array' | 'string' | 'string_array';
7163
+ /**
7164
+ * The allowed values for the input. For \`string\` or \`number\` types, creates a
7165
+ * single-select dropdown. For \`string_array\` type, creates a multi-select
7166
+ * dropdown.
7167
+ */
7168
+ allowedValues?: Array<unknown>;
7169
+ /**
7170
+ * Specifies the background behavior for the input. Only available for \`file\` and
7171
+ * \`file_array\` input types with kind \`image\`.
7172
+ */
7173
+ backgroundBehavior?: 'opaque' | 'transparent';
7174
+ /**
7175
+ * Whether the input is a color or not. Only available for \`string\` input type.
7176
+ */
7177
+ color?: boolean;
7178
+ /**
7179
+ * Whether this input affects the model's cost calculation
7180
+ */
7181
+ costImpact?: boolean;
7182
+ /**
7183
+ * The default value for the input
7184
+ */
7185
+ default?: unknown;
7186
+ /**
7187
+ * Help text displayed in the UI to provide additional information about the input
7188
+ */
7189
+ description?: string;
7190
+ /**
7191
+ * Used to visually group inputs together in the UI. Inputs with the same group
7192
+ * value appear consecutively in the UI.
7193
+ */
7194
+ group?: string;
7195
+ /**
7196
+ * Hint text displayed in the UI as a tooltip to guide the user
7197
+ */
7198
+ hint?: string;
7199
+ /**
7200
+ * The list of inputs which form an object within a container array. All inputs are
7201
+ * the same as the current object. This is only available for type inputs_array
7202
+ * inputs.
7203
+ */
7204
+ inputs?: Array<{
7205
+ [key: string]: unknown;
7206
+ }>;
7207
+ /**
7208
+ * The configured items for inputs_array type inputs. Each item is an array of
7209
+ * SubNodeInput that need ref/value resolution. Only available for inputs_array
7210
+ * type.
7211
+ */
7212
+ items?: Array<Array<Input.Item>>;
7213
+ /**
7214
+ * The asset kind of the input. Only taken into account for \`file\` and
7215
+ * \`file_array\` input types. If model provides multiple kinds, the input will be
7216
+ * not able to create the asset on the flight on API side with dataurl without
7217
+ * data:kind, prefix \`file\` and \`file_array\` inputs always expose a kind: when
7218
+ * a model does not declare one, \`image\` is returned, which is the kind used at
7219
+ * generation time.
7220
+ */
7221
+ kind?: '3d' | 'audio' | 'document' | 'image' | 'image-hdr' | 'json' | 'text' | 'video';
7222
+ /**
7223
+ * The label displayed in the UI for this input
7224
+ */
7225
+ label?: string;
7226
+ /**
7227
+ * The name of the file input field to use as the mask source
7228
+ */
7229
+ maskFrom?: string;
7230
+ /**
7231
+ * The maximum allowed value. Only available for \`number\` and \`array\` input
7232
+ * types.
7233
+ */
7234
+ max?: number;
7235
+ /**
7236
+ * The maximum allowed media duration in seconds. Only applies to \`file\` and
7237
+ * \`file_array\` input types for video and audio assets. Validated against
7238
+ * \`asset.properties.duration\` at job creation time.
7239
+ */
7240
+ maxDuration?: number;
7241
+ /**
7242
+ * The maximum allowed length for \`string\` and \`model\` inputs, in characters.
7243
+ * For the array types (\`string_array\`, \`model_array\`) it bounds the NUMBER OF
7244
+ * ITEMS instead — the length of each item is not constrained.
7245
+ */
7246
+ maxLength?: number;
7247
+ /**
7248
+ * The maximum allowed file size in bytes. Only applies to \`file\` and
7249
+ * \`file_array\` input types. Validated against \`asset.properties.size\` at job
7250
+ * creation time.
7251
+ */
7252
+ maxSize?: number;
7253
+ /**
7254
+ * The minimum allowed value. Only available for \`number\` and array input types.
7255
+ */
7256
+ min?: number;
7257
+ /**
7258
+ * The minimum allowed length for \`string\` and \`model\` inputs, in characters.
7259
+ * For the array types (\`string_array\`, \`model_array\`) it bounds the NUMBER OF
7260
+ * ITEMS instead — the length of each item is not constrained.
7261
+ */
7262
+ minLength?: number;
7263
+ /**
7264
+ * The allowed model types for this input. Example: \`["flux.1-lora"]\`. Only
7265
+ * available for \`model_array\` input type.
7266
+ */
7267
+ modelTypes?: Array<'custom' | 'elevenlabs-voice' | 'flux.1' | 'flux.1-composition' | 'flux.1-kontext-dev' | 'flux.1-kontext-lora' | 'flux.1-krea-dev' | 'flux.1-krea-lora' | 'flux.1-lora' | 'flux.1-pro' | 'flux.1.1-pro-ultra' | 'flux.2-dev-edit-lora' | 'flux.2-dev-lora' | 'flux.2-klein-4b-edit-lora' | 'flux.2-klein-4b-lora' | 'flux.2-klein-9b-edit-lora' | 'flux.2-klein-9b-lora' | 'flux.2-klein-base-4b-edit-lora' | 'flux.2-klein-base-4b-lora' | 'flux.2-klein-base-9b-edit-lora' | 'flux.2-klein-base-9b-lora' | 'flux1.1-pro' | 'gpt-image-1' | 'qwen-image-2512-lora' | 'qwen-image-edit-2509-lora' | 'qwen-image-edit-2511-lora' | 'qwen-image-edit-lora' | 'qwen-image-lora' | 'zimage-de-turbo-lora' | 'zimage-lora' | 'zimage-turbo-lora'>;
7268
+ /**
7269
+ * Whether this input represents a parent asset to assign to the produced assets.
7270
+ * Only available for \`file\` and \`file_array\` input types.
7271
+ *
7272
+ * For \`file_array\`, the parent asset is the first item in the array.
7273
+ */
7274
+ parent?: boolean;
7275
+ /**
7276
+ * Placeholder text for the input. Only available for 'string' input type.
7277
+ */
7278
+ placeholder?: string;
7279
+ /**
7280
+ * Whether the input is a prompt. When true, displays as a text area with prompt
7281
+ * spark feature. Only available for \`string\` input type.
7282
+ */
7283
+ prompt?: boolean;
7284
+ /**
7285
+ * Whether the input is used with prompt spark. Only available for \`string\` input
7286
+ * type.
7287
+ */
7288
+ promptSpark?: boolean;
7289
+ /**
7290
+ * The reference to another input or output of the same workflow. Must have at
7291
+ * least one of node or conditional.
7292
+ */
7293
+ ref?: Input.Ref;
7294
+ /**
7295
+ * Set of rules that describes when this input is required:
7296
+ *
7297
+ * - \`always\`: Input is always required
7298
+ * - \`ifNotDefined\`: Input is required when another specified input is not
7299
+ * defined
7300
+ * - \`ifDefined\`: Input is required when another specified input is defined
7301
+ * - \`conditional\`: Input is required when other inputs have specific values
7302
+ *
7303
+ * By default, the input is not required.
7304
+ */
7305
+ required?: Input.Required;
7306
+ /**
7307
+ * The step increment for numeric inputs. Only available for \`number\` input type.
7308
+ */
7309
+ step?: number;
7310
+ /**
7311
+ * The value of the input. This is the value of the input that will be used to run
7312
+ * the node. Only available for flows managed by a WorkflowJob.
7313
+ */
7314
+ value?: unknown;
7315
+ }
7316
+ namespace Input {
7317
+ /**
7318
+ * A sub-input within an inputs_array item. Same as NodeInput but without the
7319
+ * recursive items field.
7320
+ */
7321
+ interface Item {
7322
+ /**
7323
+ * The name that must be user to call the model through the API
7324
+ */
7325
+ name: string;
7326
+ /**
7327
+ * The data type of the input
7328
+ */
7329
+ type: 'boolean' | 'file' | 'file_array' | 'inputs_array' | 'model' | 'model_array' | 'number' | 'number_array' | 'string' | 'string_array';
7330
+ /**
7331
+ * The allowed values for the input. For \`string\` or \`number\` types, creates a
7332
+ * single-select dropdown. For \`string_array\` type, creates a multi-select
7333
+ * dropdown.
7334
+ */
7335
+ allowedValues?: Array<unknown>;
7336
+ /**
7337
+ * Specifies the background behavior for the input. Only available for \`file\` and
7338
+ * \`file_array\` input types with kind \`image\`.
7339
+ */
7340
+ backgroundBehavior?: 'opaque' | 'transparent';
7341
+ /**
7342
+ * Whether the input is a color or not. Only available for \`string\` input type.
7343
+ */
7344
+ color?: boolean;
7345
+ /**
7346
+ * Whether this input affects the model's cost calculation
7347
+ */
7348
+ costImpact?: boolean;
7349
+ /**
7350
+ * The default value for the input
7351
+ */
7352
+ default?: unknown;
7353
+ /**
7354
+ * Help text displayed in the UI to provide additional information about the input
7355
+ */
7356
+ description?: string;
7357
+ /**
7358
+ * Used to visually group inputs together in the UI. Inputs with the same group
7359
+ * value appear consecutively in the UI.
7360
+ */
7361
+ group?: string;
7362
+ /**
7363
+ * Hint text displayed in the UI as a tooltip to guide the user
7364
+ */
7365
+ hint?: string;
7366
+ /**
7367
+ * The list of inputs which form an object within a container array. All inputs are
7368
+ * the same as the current object. This is only available for type inputs_array
7369
+ * inputs.
7370
+ */
7371
+ inputs?: Array<{
7372
+ [key: string]: unknown;
7373
+ }>;
7374
+ /**
7375
+ * The asset kind of the input. Only taken into account for \`file\` and
7376
+ * \`file_array\` input types. If model provides multiple kinds, the input will be
7377
+ * not able to create the asset on the flight on API side with dataurl without
7378
+ * data:kind, prefix \`file\` and \`file_array\` inputs always expose a kind: when
7379
+ * a model does not declare one, \`image\` is returned, which is the kind used at
7380
+ * generation time.
7381
+ */
7382
+ kind?: '3d' | 'audio' | 'document' | 'image' | 'image-hdr' | 'json' | 'text' | 'video';
7383
+ /**
7384
+ * The label displayed in the UI for this input
7385
+ */
7386
+ label?: string;
7387
+ /**
7388
+ * The name of the file input field to use as the mask source
7389
+ */
7390
+ maskFrom?: string;
7391
+ /**
7392
+ * The maximum allowed value. Only available for \`number\` and \`array\` input
7393
+ * types.
7394
+ */
7395
+ max?: number;
7396
+ /**
7397
+ * The maximum allowed media duration in seconds. Only applies to \`file\` and
7398
+ * \`file_array\` input types for video and audio assets. Validated against
7399
+ * \`asset.properties.duration\` at job creation time.
7400
+ */
7401
+ maxDuration?: number;
7402
+ /**
7403
+ * The maximum allowed length for \`string\` and \`model\` inputs, in characters.
7404
+ * For the array types (\`string_array\`, \`model_array\`) it bounds the NUMBER OF
7405
+ * ITEMS instead — the length of each item is not constrained.
7406
+ */
7407
+ maxLength?: number;
7408
+ /**
7409
+ * The maximum allowed file size in bytes. Only applies to \`file\` and
7410
+ * \`file_array\` input types. Validated against \`asset.properties.size\` at job
7411
+ * creation time.
7412
+ */
7413
+ maxSize?: number;
7414
+ /**
7415
+ * The minimum allowed value. Only available for \`number\` and array input types.
7416
+ */
7417
+ min?: number;
7418
+ /**
7419
+ * The minimum allowed length for \`string\` and \`model\` inputs, in characters.
7420
+ * For the array types (\`string_array\`, \`model_array\`) it bounds the NUMBER OF
7421
+ * ITEMS instead — the length of each item is not constrained.
7422
+ */
7423
+ minLength?: number;
7424
+ /**
7425
+ * The allowed model types for this input. Example: \`["flux.1-lora"]\`. Only
7426
+ * available for \`model_array\` input type.
7427
+ */
7428
+ modelTypes?: Array<'custom' | 'elevenlabs-voice' | 'flux.1' | 'flux.1-composition' | 'flux.1-kontext-dev' | 'flux.1-kontext-lora' | 'flux.1-krea-dev' | 'flux.1-krea-lora' | 'flux.1-lora' | 'flux.1-pro' | 'flux.1.1-pro-ultra' | 'flux.2-dev-edit-lora' | 'flux.2-dev-lora' | 'flux.2-klein-4b-edit-lora' | 'flux.2-klein-4b-lora' | 'flux.2-klein-9b-edit-lora' | 'flux.2-klein-9b-lora' | 'flux.2-klein-base-4b-edit-lora' | 'flux.2-klein-base-4b-lora' | 'flux.2-klein-base-9b-edit-lora' | 'flux.2-klein-base-9b-lora' | 'flux1.1-pro' | 'gpt-image-1' | 'qwen-image-2512-lora' | 'qwen-image-edit-2509-lora' | 'qwen-image-edit-2511-lora' | 'qwen-image-edit-lora' | 'qwen-image-lora' | 'zimage-de-turbo-lora' | 'zimage-lora' | 'zimage-turbo-lora'>;
7429
+ /**
7430
+ * Whether this input represents a parent asset to assign to the produced assets.
7431
+ * Only available for \`file\` and \`file_array\` input types.
7432
+ *
7433
+ * For \`file_array\`, the parent asset is the first item in the array.
7434
+ */
7435
+ parent?: boolean;
7436
+ /**
7437
+ * Placeholder text for the input. Only available for 'string' input type.
7438
+ */
7439
+ placeholder?: string;
7440
+ /**
7441
+ * Whether the input is a prompt. When true, displays as a text area with prompt
7442
+ * spark feature. Only available for \`string\` input type.
7443
+ */
7444
+ prompt?: boolean;
7445
+ /**
7446
+ * Whether the input is used with prompt spark. Only available for \`string\` input
7447
+ * type.
7448
+ */
7449
+ promptSpark?: boolean;
7450
+ /**
7451
+ * The reference to another input or output of the same workflow. Must have at
7452
+ * least one of node or conditional.
7453
+ */
7454
+ ref?: Item.Ref;
7455
+ /**
7456
+ * Set of rules that describes when this input is required:
7457
+ *
7458
+ * - \`always\`: Input is always required
7459
+ * - \`ifNotDefined\`: Input is required when another specified input is not
7460
+ * defined
7461
+ * - \`ifDefined\`: Input is required when another specified input is defined
7462
+ * - \`conditional\`: Input is required when other inputs have specific values
7463
+ *
7464
+ * By default, the input is not required.
7465
+ */
7466
+ required?: Item.Required;
7467
+ /**
7468
+ * The step increment for numeric inputs. Only available for \`number\` input type.
7469
+ */
7470
+ step?: number;
7471
+ /**
7472
+ * The value of the input. This is the value of the input that will be used to run
7473
+ * the node. Only available for flows managed by a WorkflowJob.
7474
+ */
7475
+ value?: unknown;
7476
+ }
7477
+ namespace Item {
7478
+ /**
7479
+ * The reference to another input or output of the same workflow. Must have at
7480
+ * least one of node or conditional.
7481
+ */
7482
+ interface Ref {
7483
+ /**
7484
+ * The conditional nodes to reference. If the conditional nodes are successful, the
7485
+ * node will be successful. If the conditional nodes are skipped, the node will be
7486
+ * skipped. Contains an array of node ids used to check the status of the nodes.
7487
+ */
7488
+ conditional?: Array<string>;
7489
+ /**
7490
+ * This is the desired node output value if ref is an if/else node.
7491
+ */
7492
+ equal?: string;
7493
+ /**
7494
+ * The name of the input or output to reference. If the type is 'workflow', the
7495
+ * name is the name of the input of the workflow is required If the type is 'node',
7496
+ * the name is not mandatory, except if you want all outputs of the node. To get
7497
+ * all outputs of a node, you can use the name 'all'.
7498
+ */
7499
+ name?: string;
7500
+ /**
7501
+ * The node id or 'workflow' if the source is a workflow input.
7502
+ */
7503
+ node?: string;
7504
+ }
7505
+ /**
7506
+ * Set of rules that describes when this input is required:
7507
+ *
7508
+ * - \`always\`: Input is always required
7509
+ * - \`ifNotDefined\`: Input is required when another specified input is not
7510
+ * defined
7511
+ * - \`ifDefined\`: Input is required when another specified input is defined
7512
+ * - \`conditional\`: Input is required when other inputs have specific values
7513
+ *
7514
+ * By default, the input is not required.
7515
+ */
7516
+ interface Required {
7517
+ /**
7518
+ * Whether the input is always required
7519
+ */
7520
+ always?: boolean;
7521
+ /**
7522
+ * Makes this input required when other inputs have one of the listed values
7523
+ */
7524
+ conditional?: Required.Conditional;
7525
+ /**
7526
+ * Makes this input required when another input is defined:
7527
+ *
7528
+ * - Key: name of the input that must be defined
7529
+ * - Value: message to display when this input is required
7530
+ */
7531
+ ifDefined?: unknown;
7532
+ /**
7533
+ * Makes this input required when another input is not defined:
7534
+ *
7535
+ * - Key: name of the input that must be undefined
7536
+ * - Value: message to display when this input is required
7537
+ */
7538
+ ifNotDefined?: unknown;
7539
+ }
7540
+ namespace Required {
7541
+ /**
7542
+ * Makes this input required when other inputs have one of the listed values
7543
+ */
7544
+ interface Conditional {
7545
+ /**
7546
+ * The conditions to check:
7547
+ *
7548
+ * - Key: name of the input to check
7549
+ * - Value: values of that input that satisfy the condition
7550
+ */
7551
+ values: unknown;
7552
+ /**
7553
+ * How the conditions combine: \`and\` (all must match) or \`or\` (any must match)
7554
+ */
7555
+ operator?: 'and' | 'or';
7556
+ }
7557
+ }
7558
+ }
7559
+ /**
7560
+ * The reference to another input or output of the same workflow. Must have at
7561
+ * least one of node or conditional.
7562
+ */
7563
+ interface Ref {
7564
+ /**
7565
+ * The conditional nodes to reference. If the conditional nodes are successful, the
7566
+ * node will be successful. If the conditional nodes are skipped, the node will be
7567
+ * skipped. Contains an array of node ids used to check the status of the nodes.
7568
+ */
7569
+ conditional?: Array<string>;
7570
+ /**
7571
+ * This is the desired node output value if ref is an if/else node.
7572
+ */
7573
+ equal?: string;
7574
+ /**
7575
+ * The name of the input or output to reference. If the type is 'workflow', the
7576
+ * name is the name of the input of the workflow is required If the type is 'node',
7577
+ * the name is not mandatory, except if you want all outputs of the node. To get
7578
+ * all outputs of a node, you can use the name 'all'.
7579
+ */
7580
+ name?: string;
7581
+ /**
7582
+ * The node id or 'workflow' if the source is a workflow input.
7583
+ */
7584
+ node?: string;
7585
+ }
7586
+ /**
7587
+ * Set of rules that describes when this input is required:
7588
+ *
7589
+ * - \`always\`: Input is always required
7590
+ * - \`ifNotDefined\`: Input is required when another specified input is not
7591
+ * defined
7592
+ * - \`ifDefined\`: Input is required when another specified input is defined
7593
+ * - \`conditional\`: Input is required when other inputs have specific values
7594
+ *
7595
+ * By default, the input is not required.
7596
+ */
7597
+ interface Required {
7598
+ /**
7599
+ * Whether the input is always required
7600
+ */
7601
+ always?: boolean;
7602
+ /**
7603
+ * Makes this input required when other inputs have one of the listed values
7604
+ */
7605
+ conditional?: Required.Conditional;
7606
+ /**
7607
+ * Makes this input required when another input is defined:
7608
+ *
7609
+ * - Key: name of the input that must be defined
7610
+ * - Value: message to display when this input is required
7611
+ */
7612
+ ifDefined?: unknown;
7613
+ /**
7614
+ * Makes this input required when another input is not defined:
7615
+ *
7616
+ * - Key: name of the input that must be undefined
7617
+ * - Value: message to display when this input is required
7618
+ */
7619
+ ifNotDefined?: unknown;
7620
+ }
7621
+ namespace Required {
7622
+ /**
7623
+ * Makes this input required when other inputs have one of the listed values
7624
+ */
7625
+ interface Conditional {
7626
+ /**
7627
+ * The conditions to check:
7628
+ *
7629
+ * - Key: name of the input to check
7630
+ * - Value: values of that input that satisfy the condition
7631
+ */
7632
+ values: unknown;
7633
+ /**
7634
+ * How the conditions combine: \`and\` (all must match) or \`or\` (any must match)
7635
+ */
7636
+ operator?: 'and' | 'or';
7637
+ }
7638
+ }
7639
+ }
7640
+ /**
7641
+ * The logic of the node. Only available for logic nodes.
7642
+ */
7643
+ interface Logic {
7644
+ /**
7645
+ * The cases of the logic. Only available for if/else nodes.
7646
+ */
7647
+ cases?: Array<Logic.Case>;
7648
+ /**
7649
+ * The default case of the logic. Contains the id/output of the node to execute if
7650
+ * no case is matched. Only available for if/else nodes.
7651
+ */
7652
+ default?: string;
7653
+ /**
7654
+ * The transform of the logic. Only available for transform nodes.
7655
+ */
7656
+ transform?: string;
7657
+ }
7658
+ namespace Logic {
7659
+ interface Case {
7660
+ condition: string;
7661
+ value: string;
7662
+ }
7663
+ }
7664
+ }
7665
+ }
7666
+ interface StatusHistory {
7667
+ date: string;
7668
+ status: 'canceled' | 'failure' | 'finalizing' | 'in-progress' | 'pending' | 'queued' | 'success' | 'warming-up';
7669
+ }
7670
+ /**
7671
+ * The billing of the job
7672
+ */
7673
+ interface Billing {
7674
+ cuCost: number;
7675
+ cuDiscount: number;
7676
+ /**
7677
+ * Compute Units charged for the ADD-ONS of this job, per action — the fees paid on
7678
+ * top of the generation itself, such as `quality-gate`.
7679
+ *
7680
+ * `cuCost` above is the main action alone, so the job's total is `cuCost` plus the
7681
+ * values here.
7682
+ *
7683
+ * Two caveats when displaying it:
7684
+ *
7685
+ * - These are a remaining refundable balance, not a receipt: a job that failed or
7686
+ * was cancelled has had its add-ons refunded, so they read 0 while `cuCost`
7687
+ * still shows the main action's original charge.
7688
+ * - `ip-detection` is part of the shape but is never populated today: that fee is
7689
+ * charged outside the job and reported once, as
7690
+ * `ipDetection.creativeUnitsCharged`, in the response of the request that ran
7691
+ * it.
7692
+ *
7693
+ * Absent when the job paid for no add-on.
7694
+ */
7695
+ cuCostDetails?: Billing.CuCostDetails;
7696
+ /**
7697
+ * When true, the credits charged for this job are not automatically refunded if
7698
+ * the generation fails, because the model used does not support refund-on-failure.
7699
+ * Absent or false means a failed generation is refunded as usual.
7700
+ */
7701
+ disableRefund?: boolean;
7702
+ }
7703
+ namespace Billing {
7704
+ /**
7705
+ * Compute Units charged for the ADD-ONS of this job, per action — the fees paid on
7706
+ * top of the generation itself, such as `quality-gate`.
7707
+ *
7708
+ * `cuCost` above is the main action alone, so the job's total is `cuCost` plus the
7709
+ * values here.
7710
+ *
7711
+ * Two caveats when displaying it:
7712
+ *
7713
+ * - These are a remaining refundable balance, not a receipt: a job that failed or
7714
+ * was cancelled has had its add-ons refunded, so they read 0 while `cuCost`
7715
+ * still shows the main action's original charge.
7716
+ * - `ip-detection` is part of the shape but is never populated today: that fee is
7717
+ * charged outside the job and reported once, as
7718
+ * `ipDetection.creativeUnitsCharged`, in the response of the request that ran
7719
+ * it.
7720
+ *
7721
+ * Absent when the job paid for no add-on.
7722
+ */
7723
+ interface CuCostDetails {
7724
+ 'ip-detection'?: number;
7725
+ 'quality-gate'?: number;
7726
+ }
7727
+ }
7728
+ }
7729
+ }
7730
+ export interface WorkflowCreateParams {
7731
+ /**
7732
+ * Body param
7733
+ */
7734
+ description: string;
7735
+ /**
7736
+ * Body param
7737
+ */
7738
+ name: string;
7739
+ /**
7740
+ * Query param: The projectId used for ownership resource management. Either to
7741
+ * assert ownership or to set the owner of the resource(s)
7742
+ */
7743
+ projectId?: string;
7744
+ }
7745
+ export interface WorkflowRetrieveParams {
7746
+ /**
7747
+ * The projectId used for ownership resource management. Either to assert ownership
7748
+ * or to set the owner of the resource(s)
7749
+ */
7750
+ projectId?: string;
7751
+ }
7752
+ export interface WorkflowUpdateParams {
7753
+ /**
7754
+ * Query param: The projectId used for ownership resource management. Either to
7755
+ * assert ownership or to set the owner of the resource(s)
7756
+ */
7757
+ projectId?: string;
7758
+ /**
7759
+ * Body param: The after asset of the workflow. Set to null to unset the after
7760
+ * asset.
7761
+ */
7762
+ after?: string;
7763
+ /**
7764
+ * Body param: The before asset of the workflow. Set to null to unset the before
7765
+ * asset.
7766
+ */
7767
+ before?: string;
7768
+ /**
7769
+ * Body param: Set to true to bypass the lock and save a locked workflow without
7770
+ * unlocking it first. Only the author or a project admin can use this.
7771
+ */
6738
7772
  bypassLock?: boolean;
6739
7773
  /**
6740
7774
  * Body param: The description of the workflow.
@@ -6800,7 +7834,7 @@ export declare namespace WorkflowUpdateParams {
6800
7834
  /**
6801
7835
  * The type of the job for the node.
6802
7836
  */
6803
- type: 'custom-model' | 'for-each' | 'generate-prompt' | 'list' | 'logic' | 'model' | 'remove-background' | 'transform' | 'user-approval' | 'workflow';
7837
+ type: 'custom-model' | 'for-each' | 'generate-prompt' | 'list' | 'logic' | 'model' | 'remove-background' | 'transform' | 'user-approval' | 'user-selection' | 'workflow';
6804
7838
  /**
6805
7839
  * Fixed number of iterations for a ForEach node. When set, the loop runs exactly
6806
7840
  * `count` times regardless of array input. When not set, the loop iterates over
@@ -6821,13 +7855,14 @@ export declare namespace WorkflowUpdateParams {
6821
7855
  */
6822
7856
  includeOutputsInWorkflowJob?: true;
6823
7857
  /**
6824
- * The inputs of the node.
7858
+ * The inputs of the node. For a user-selection node, the array input's `min`/`max`
7859
+ * bound how many items the user may pick (defaults: 1 and 100); conditional
7860
+ * connections may be present as additional inputs.
6825
7861
  */
6826
7862
  inputs?: Array<Flow.Input>;
6827
7863
  /**
6828
- * Statically-configured items for a List node. The node outputs this array as-is
6829
- * when executed. Only available for List nodes. The values can be strings,
6830
- * numbers, or asset IDs.
7864
+ * Statically-configured items for a List node, or the frozen candidate list of a
7865
+ * UserSelection node. The values can be strings, numbers, or asset IDs.
6831
7866
  */
6832
7867
  items?: Array<string>;
6833
7868
  /**
@@ -7014,8 +8049,7 @@ export declare namespace WorkflowUpdateParams {
7014
8049
  * - \`ifNotDefined\`: Input is required when another specified input is not
7015
8050
  * defined
7016
8051
  * - \`ifDefined\`: Input is required when another specified input is defined
7017
- * - \`conditionalValues\`: Input is required when another input has a specific
7018
- * value
8052
+ * - \`conditional\`: Input is required when other inputs have specific values
7019
8053
  *
7020
8054
  * By default, the input is not required.
7021
8055
  */
@@ -7176,8 +8210,7 @@ export declare namespace WorkflowUpdateParams {
7176
8210
  * - \`ifNotDefined\`: Input is required when another specified input is not
7177
8211
  * defined
7178
8212
  * - \`ifDefined\`: Input is required when another specified input is defined
7179
- * - \`conditionalValues\`: Input is required when another input has a specific
7180
- * value
8213
+ * - \`conditional\`: Input is required when other inputs have specific values
7181
8214
  *
7182
8215
  * By default, the input is not required.
7183
8216
  */
@@ -7227,8 +8260,7 @@ export declare namespace WorkflowUpdateParams {
7227
8260
  * - \`ifNotDefined\`: Input is required when another specified input is not
7228
8261
  * defined
7229
8262
  * - \`ifDefined\`: Input is required when another specified input is defined
7230
- * - \`conditionalValues\`: Input is required when another input has a specific
7231
- * value
8263
+ * - \`conditional\`: Input is required when other inputs have specific values
7232
8264
  *
7233
8265
  * By default, the input is not required.
7234
8266
  */
@@ -7238,12 +8270,9 @@ export declare namespace WorkflowUpdateParams {
7238
8270
  */
7239
8271
  always?: boolean;
7240
8272
  /**
7241
- * Makes this input required when another input has a specific value:
7242
- *
7243
- * - Key: name of the input to check
7244
- * - Value: operation and allowed values that trigger the requirement
8273
+ * Makes this input required when other inputs have one of the listed values
7245
8274
  */
7246
- conditionalValues?: unknown;
8275
+ conditional?: Required.Conditional;
7247
8276
  /**
7248
8277
  * Makes this input required when another input is defined:
7249
8278
  *
@@ -7259,6 +8288,24 @@ export declare namespace WorkflowUpdateParams {
7259
8288
  */
7260
8289
  ifNotDefined?: unknown;
7261
8290
  }
8291
+ namespace Required {
8292
+ /**
8293
+ * Makes this input required when other inputs have one of the listed values
8294
+ */
8295
+ interface Conditional {
8296
+ /**
8297
+ * The conditions to check:
8298
+ *
8299
+ * - Key: name of the input to check
8300
+ * - Value: values of that input that satisfy the condition
8301
+ */
8302
+ values: unknown;
8303
+ /**
8304
+ * How the conditions combine: \`and\` (all must match) or \`or\` (any must match)
8305
+ */
8306
+ operator?: 'and' | 'or';
8307
+ }
8308
+ }
7262
8309
  }
7263
8310
  /**
7264
8311
  * The reference to another input or output of the same workflow. Must have at
@@ -7294,8 +8341,7 @@ export declare namespace WorkflowUpdateParams {
7294
8341
  * - \`ifNotDefined\`: Input is required when another specified input is not
7295
8342
  * defined
7296
8343
  * - \`ifDefined\`: Input is required when another specified input is defined
7297
- * - \`conditionalValues\`: Input is required when another input has a specific
7298
- * value
8344
+ * - \`conditional\`: Input is required when other inputs have specific values
7299
8345
  *
7300
8346
  * By default, the input is not required.
7301
8347
  */
@@ -7305,12 +8351,9 @@ export declare namespace WorkflowUpdateParams {
7305
8351
  */
7306
8352
  always?: boolean;
7307
8353
  /**
7308
- * Makes this input required when another input has a specific value:
7309
- *
7310
- * - Key: name of the input to check
7311
- * - Value: operation and allowed values that trigger the requirement
8354
+ * Makes this input required when other inputs have one of the listed values
7312
8355
  */
7313
- conditionalValues?: unknown;
8356
+ conditional?: Required.Conditional;
7314
8357
  /**
7315
8358
  * Makes this input required when another input is defined:
7316
8359
  *
@@ -7326,6 +8369,24 @@ export declare namespace WorkflowUpdateParams {
7326
8369
  */
7327
8370
  ifNotDefined?: unknown;
7328
8371
  }
8372
+ namespace Required {
8373
+ /**
8374
+ * Makes this input required when other inputs have one of the listed values
8375
+ */
8376
+ interface Conditional {
8377
+ /**
8378
+ * The conditions to check:
8379
+ *
8380
+ * - Key: name of the input to check
8381
+ * - Value: values of that input that satisfy the condition
8382
+ */
8383
+ values: unknown;
8384
+ /**
8385
+ * How the conditions combine: \`and\` (all must match) or \`or\` (any must match)
8386
+ */
8387
+ operator?: 'and' | 'or';
8388
+ }
8389
+ }
7329
8390
  }
7330
8391
  /**
7331
8392
  * The logic of the node. Only available for logic nodes.
@@ -7494,8 +8555,7 @@ export declare namespace WorkflowUpdateParams {
7494
8555
  * - \`ifNotDefined\`: Input is required when another specified input is not
7495
8556
  * defined
7496
8557
  * - \`ifDefined\`: Input is required when another specified input is defined
7497
- * - \`conditionalValues\`: Input is required when another input has a specific
7498
- * value
8558
+ * - \`conditional\`: Input is required when other inputs have specific values
7499
8559
  *
7500
8560
  * By default, the input is not required.
7501
8561
  */
@@ -7513,8 +8573,7 @@ export declare namespace WorkflowUpdateParams {
7513
8573
  * - \`ifNotDefined\`: Input is required when another specified input is not
7514
8574
  * defined
7515
8575
  * - \`ifDefined\`: Input is required when another specified input is defined
7516
- * - \`conditionalValues\`: Input is required when another input has a specific
7517
- * value
8576
+ * - \`conditional\`: Input is required when other inputs have specific values
7518
8577
  *
7519
8578
  * By default, the input is not required.
7520
8579
  */
@@ -7524,12 +8583,9 @@ export declare namespace WorkflowUpdateParams {
7524
8583
  */
7525
8584
  always?: boolean;
7526
8585
  /**
7527
- * Makes this input required when another input has a specific value:
7528
- *
7529
- * - Key: name of the input to check
7530
- * - Value: operation and allowed values that trigger the requirement
8586
+ * Makes this input required when other inputs have one of the listed values
7531
8587
  */
7532
- conditionalValues?: unknown;
8588
+ conditional?: Required.Conditional;
7533
8589
  /**
7534
8590
  * Makes this input required when another input is defined:
7535
8591
  *
@@ -7545,6 +8601,24 @@ export declare namespace WorkflowUpdateParams {
7545
8601
  */
7546
8602
  ifNotDefined?: unknown;
7547
8603
  }
8604
+ namespace Required {
8605
+ /**
8606
+ * Makes this input required when other inputs have one of the listed values
8607
+ */
8608
+ interface Conditional {
8609
+ /**
8610
+ * The conditions to check:
8611
+ *
8612
+ * - Key: name of the input to check
8613
+ * - Value: values of that input that satisfy the condition
8614
+ */
8615
+ values: unknown;
8616
+ /**
8617
+ * How the conditions combine: \`and\` (all must match) or \`or\` (any must match)
8618
+ */
8619
+ operator?: 'and' | 'or';
8620
+ }
8621
+ }
7548
8622
  }
7549
8623
  }
7550
8624
  export interface WorkflowListParams extends WorkflowsCursorParams {
@@ -7646,6 +8720,33 @@ export interface WorkflowUserApprovalParams {
7646
8720
  */
7647
8721
  action?: 'approve' | 'reject';
7648
8722
  }
8723
+ export interface WorkflowUserSelectionParams {
8724
+ /**
8725
+ * Query param: The projectId used for ownership resource management. Either to
8726
+ * assert ownership or to set the owner of the resource(s)
8727
+ */
8728
+ projectId: string;
8729
+ /**
8730
+ * Body param: Decision taken on the selection node. "select" persists the picked
8731
+ * items and advances the workflow; "reject" marks it Rejected and cancels the
8732
+ * workflow.
8733
+ */
8734
+ action: 'select' | 'reject';
8735
+ /**
8736
+ * Body param: The ID of the user selection node to act on in the workflow
8737
+ */
8738
+ nodeId: string;
8739
+ /**
8740
+ * Body param: The ID of the workflow job that contains the user selection node
8741
+ */
8742
+ workflowJobId: string;
8743
+ /**
8744
+ * Body param: Zero-based indices into the node's `items` (the candidate list
8745
+ * frozen when the node started processing). Required when action is "select".
8746
+ * Order is preserved in the node output.
8747
+ */
8748
+ selectedIndices?: Array<number>;
8749
+ }
7649
8750
  export interface WorkflowApproveUserParams {
7650
8751
  /**
7651
8752
  * Query param: The projectId used for ownership resource management. Either to
@@ -7669,6 +8770,6 @@ export interface WorkflowApproveUserParams {
7669
8770
  action?: 'approve' | 'reject';
7670
8771
  }
7671
8772
  export declare namespace Workflows {
7672
- export { type WorkflowCreateResponse as WorkflowCreateResponse, type WorkflowRetrieveResponse as WorkflowRetrieveResponse, type WorkflowUpdateResponse as WorkflowUpdateResponse, type WorkflowListResponse as WorkflowListResponse, type WorkflowDeleteResponse as WorkflowDeleteResponse, type WorkflowGetTagsResponse as WorkflowGetTagsResponse, type WorkflowRunResponse as WorkflowRunResponse, type WorkflowUserApprovalResponse as WorkflowUserApprovalResponse, type WorkflowListResponsesWorkflowsCursor as WorkflowListResponsesWorkflowsCursor, type WorkflowCreateParams as WorkflowCreateParams, type WorkflowRetrieveParams as WorkflowRetrieveParams, type WorkflowUpdateParams as WorkflowUpdateParams, type WorkflowListParams as WorkflowListParams, type WorkflowDeleteParams as WorkflowDeleteParams, type WorkflowGetTagsParams as WorkflowGetTagsParams, type WorkflowRunParams as WorkflowRunParams, type WorkflowUserApprovalParams as WorkflowUserApprovalParams, type WorkflowApproveUserParams as WorkflowApproveUserParams, };
8773
+ export { type WorkflowCreateResponse as WorkflowCreateResponse, type WorkflowRetrieveResponse as WorkflowRetrieveResponse, type WorkflowUpdateResponse as WorkflowUpdateResponse, type WorkflowListResponse as WorkflowListResponse, type WorkflowDeleteResponse as WorkflowDeleteResponse, type WorkflowGetTagsResponse as WorkflowGetTagsResponse, type WorkflowRunResponse as WorkflowRunResponse, type WorkflowUserApprovalResponse as WorkflowUserApprovalResponse, type WorkflowUserSelectionResponse as WorkflowUserSelectionResponse, type WorkflowListResponsesWorkflowsCursor as WorkflowListResponsesWorkflowsCursor, type WorkflowCreateParams as WorkflowCreateParams, type WorkflowRetrieveParams as WorkflowRetrieveParams, type WorkflowUpdateParams as WorkflowUpdateParams, type WorkflowListParams as WorkflowListParams, type WorkflowDeleteParams as WorkflowDeleteParams, type WorkflowGetTagsParams as WorkflowGetTagsParams, type WorkflowRunParams as WorkflowRunParams, type WorkflowUserApprovalParams as WorkflowUserApprovalParams, type WorkflowUserSelectionParams as WorkflowUserSelectionParams, type WorkflowApproveUserParams as WorkflowApproveUserParams, };
7673
8774
  }
7674
8775
  //# sourceMappingURL=workflows.d.ts.map