@mobilerun/sdk 5.1.0 → 5.2.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 (374) hide show
  1. package/CHANGELOG.md +41 -0
  2. package/client.d.mts +4 -16
  3. package/client.d.mts.map +1 -1
  4. package/client.d.ts +4 -16
  5. package/client.d.ts.map +1 -1
  6. package/client.js +0 -12
  7. package/client.js.map +1 -1
  8. package/client.mjs +1 -13
  9. package/client.mjs.map +1 -1
  10. package/package.json +1 -1
  11. package/resources/apps.d.mts +12 -7
  12. package/resources/apps.d.mts.map +1 -1
  13. package/resources/apps.d.ts +12 -7
  14. package/resources/apps.d.ts.map +1 -1
  15. package/resources/apps.js +0 -4
  16. package/resources/apps.js.map +1 -1
  17. package/resources/apps.mjs +0 -4
  18. package/resources/apps.mjs.map +1 -1
  19. package/resources/carriers.d.mts +0 -3
  20. package/resources/carriers.d.mts.map +1 -1
  21. package/resources/carriers.d.ts +0 -3
  22. package/resources/carriers.d.ts.map +1 -1
  23. package/resources/carriers.js +0 -3
  24. package/resources/carriers.js.map +1 -1
  25. package/resources/carriers.mjs +0 -3
  26. package/resources/carriers.mjs.map +1 -1
  27. package/resources/connect/countries.d.mts +8 -3
  28. package/resources/connect/countries.d.mts.map +1 -1
  29. package/resources/connect/countries.d.ts +8 -3
  30. package/resources/connect/countries.d.ts.map +1 -1
  31. package/resources/connect/countries.js +6 -1
  32. package/resources/connect/countries.js.map +1 -1
  33. package/resources/connect/countries.mjs +6 -1
  34. package/resources/connect/countries.mjs.map +1 -1
  35. package/resources/connect/proxies.d.mts +11 -9
  36. package/resources/connect/proxies.d.mts.map +1 -1
  37. package/resources/connect/proxies.d.ts +11 -9
  38. package/resources/connect/proxies.d.ts.map +1 -1
  39. package/resources/connect/proxies.js +7 -5
  40. package/resources/connect/proxies.js.map +1 -1
  41. package/resources/connect/proxies.mjs +7 -5
  42. package/resources/connect/proxies.mjs.map +1 -1
  43. package/resources/connect/users.d.mts +7 -2
  44. package/resources/connect/users.d.mts.map +1 -1
  45. package/resources/connect/users.d.ts +7 -2
  46. package/resources/connect/users.d.ts.map +1 -1
  47. package/resources/connect/users.js +7 -2
  48. package/resources/connect/users.js.map +1 -1
  49. package/resources/connect/users.mjs +7 -2
  50. package/resources/connect/users.mjs.map +1 -1
  51. package/resources/credentials/credentials.d.mts +3 -4
  52. package/resources/credentials/credentials.d.mts.map +1 -1
  53. package/resources/credentials/credentials.d.ts +3 -4
  54. package/resources/credentials/credentials.d.ts.map +1 -1
  55. package/resources/credentials/credentials.js +3 -4
  56. package/resources/credentials/credentials.js.map +1 -1
  57. package/resources/credentials/credentials.mjs +3 -4
  58. package/resources/credentials/credentials.mjs.map +1 -1
  59. package/resources/credentials/packages/credentials/credentials.d.mts +14 -7
  60. package/resources/credentials/packages/credentials/credentials.d.mts.map +1 -1
  61. package/resources/credentials/packages/credentials/credentials.d.ts +14 -7
  62. package/resources/credentials/packages/credentials/credentials.d.ts.map +1 -1
  63. package/resources/credentials/packages/credentials/credentials.js +7 -6
  64. package/resources/credentials/packages/credentials/credentials.js.map +1 -1
  65. package/resources/credentials/packages/credentials/credentials.mjs +7 -6
  66. package/resources/credentials/packages/credentials/credentials.mjs.map +1 -1
  67. package/resources/credentials/packages/credentials/fields.d.mts +8 -6
  68. package/resources/credentials/packages/credentials/fields.d.mts.map +1 -1
  69. package/resources/credentials/packages/credentials/fields.d.ts +8 -6
  70. package/resources/credentials/packages/credentials/fields.d.ts.map +1 -1
  71. package/resources/credentials/packages/credentials/fields.js +8 -6
  72. package/resources/credentials/packages/credentials/fields.js.map +1 -1
  73. package/resources/credentials/packages/credentials/fields.mjs +8 -6
  74. package/resources/credentials/packages/credentials/fields.mjs.map +1 -1
  75. package/resources/credentials/packages/packages.d.mts +5 -5
  76. package/resources/credentials/packages/packages.d.mts.map +1 -1
  77. package/resources/credentials/packages/packages.d.ts +5 -5
  78. package/resources/credentials/packages/packages.d.ts.map +1 -1
  79. package/resources/credentials/packages/packages.js +5 -5
  80. package/resources/credentials/packages/packages.js.map +1 -1
  81. package/resources/credentials/packages/packages.mjs +5 -5
  82. package/resources/credentials/packages/packages.mjs.map +1 -1
  83. package/resources/devices/actions.d.mts +10 -5
  84. package/resources/devices/actions.d.mts.map +1 -1
  85. package/resources/devices/actions.d.ts +10 -5
  86. package/resources/devices/actions.d.ts.map +1 -1
  87. package/resources/devices/actions.js +10 -5
  88. package/resources/devices/actions.js.map +1 -1
  89. package/resources/devices/actions.mjs +10 -5
  90. package/resources/devices/actions.mjs.map +1 -1
  91. package/resources/devices/apps.d.mts +38 -5
  92. package/resources/devices/apps.d.mts.map +1 -1
  93. package/resources/devices/apps.d.ts +38 -5
  94. package/resources/devices/apps.d.ts.map +1 -1
  95. package/resources/devices/apps.js +21 -5
  96. package/resources/devices/apps.js.map +1 -1
  97. package/resources/devices/apps.mjs +21 -5
  98. package/resources/devices/apps.mjs.map +1 -1
  99. package/resources/devices/devices.d.mts +76 -14
  100. package/resources/devices/devices.d.mts.map +1 -1
  101. package/resources/devices/devices.d.ts +76 -14
  102. package/resources/devices/devices.d.ts.map +1 -1
  103. package/resources/devices/devices.js +28 -12
  104. package/resources/devices/devices.js.map +1 -1
  105. package/resources/devices/devices.mjs +28 -12
  106. package/resources/devices/devices.mjs.map +1 -1
  107. package/resources/devices/esim.d.mts +6 -4
  108. package/resources/devices/esim.d.mts.map +1 -1
  109. package/resources/devices/esim.d.ts +6 -4
  110. package/resources/devices/esim.d.ts.map +1 -1
  111. package/resources/devices/esim.js +6 -4
  112. package/resources/devices/esim.js.map +1 -1
  113. package/resources/devices/esim.mjs +6 -4
  114. package/resources/devices/esim.mjs.map +1 -1
  115. package/resources/devices/files.d.mts +7 -4
  116. package/resources/devices/files.d.mts.map +1 -1
  117. package/resources/devices/files.d.ts +7 -4
  118. package/resources/devices/files.d.ts.map +1 -1
  119. package/resources/devices/files.js +7 -4
  120. package/resources/devices/files.js.map +1 -1
  121. package/resources/devices/files.mjs +7 -4
  122. package/resources/devices/files.mjs.map +1 -1
  123. package/resources/devices/keyboard.d.mts +5 -3
  124. package/resources/devices/keyboard.d.mts.map +1 -1
  125. package/resources/devices/keyboard.d.ts +5 -3
  126. package/resources/devices/keyboard.d.ts.map +1 -1
  127. package/resources/devices/keyboard.js +5 -3
  128. package/resources/devices/keyboard.js.map +1 -1
  129. package/resources/devices/keyboard.mjs +5 -3
  130. package/resources/devices/keyboard.mjs.map +1 -1
  131. package/resources/devices/language.d.mts +4 -2
  132. package/resources/devices/language.d.mts.map +1 -1
  133. package/resources/devices/language.d.ts +4 -2
  134. package/resources/devices/language.d.ts.map +1 -1
  135. package/resources/devices/language.js +4 -2
  136. package/resources/devices/language.js.map +1 -1
  137. package/resources/devices/language.mjs +4 -2
  138. package/resources/devices/language.mjs.map +1 -1
  139. package/resources/devices/location.d.mts +4 -2
  140. package/resources/devices/location.d.mts.map +1 -1
  141. package/resources/devices/location.d.ts +4 -2
  142. package/resources/devices/location.d.ts.map +1 -1
  143. package/resources/devices/location.js +4 -2
  144. package/resources/devices/location.js.map +1 -1
  145. package/resources/devices/location.mjs +4 -2
  146. package/resources/devices/location.mjs.map +1 -1
  147. package/resources/devices/packages.d.mts +2 -1
  148. package/resources/devices/packages.d.mts.map +1 -1
  149. package/resources/devices/packages.d.ts +2 -1
  150. package/resources/devices/packages.d.ts.map +1 -1
  151. package/resources/devices/packages.js +2 -1
  152. package/resources/devices/packages.js.map +1 -1
  153. package/resources/devices/packages.mjs +2 -1
  154. package/resources/devices/packages.mjs.map +1 -1
  155. package/resources/devices/proxy.d.mts +29 -3
  156. package/resources/devices/proxy.d.mts.map +1 -1
  157. package/resources/devices/proxy.d.ts +29 -3
  158. package/resources/devices/proxy.d.ts.map +1 -1
  159. package/resources/devices/proxy.js +7 -3
  160. package/resources/devices/proxy.js.map +1 -1
  161. package/resources/devices/proxy.mjs +7 -3
  162. package/resources/devices/proxy.mjs.map +1 -1
  163. package/resources/devices/state.d.mts +7 -3
  164. package/resources/devices/state.d.mts.map +1 -1
  165. package/resources/devices/state.d.ts +7 -3
  166. package/resources/devices/state.d.ts.map +1 -1
  167. package/resources/devices/state.js +6 -3
  168. package/resources/devices/state.js.map +1 -1
  169. package/resources/devices/state.mjs +6 -3
  170. package/resources/devices/state.mjs.map +1 -1
  171. package/resources/devices/tasks.d.mts +4 -12
  172. package/resources/devices/tasks.d.mts.map +1 -1
  173. package/resources/devices/tasks.d.ts +4 -12
  174. package/resources/devices/tasks.d.ts.map +1 -1
  175. package/resources/devices/tasks.js +2 -4
  176. package/resources/devices/tasks.js.map +1 -1
  177. package/resources/devices/tasks.mjs +2 -4
  178. package/resources/devices/tasks.mjs.map +1 -1
  179. package/resources/devices/timezone.d.mts +4 -2
  180. package/resources/devices/timezone.d.mts.map +1 -1
  181. package/resources/devices/timezone.d.ts +4 -2
  182. package/resources/devices/timezone.d.ts.map +1 -1
  183. package/resources/devices/timezone.js +4 -2
  184. package/resources/devices/timezone.js.map +1 -1
  185. package/resources/devices/timezone.mjs +4 -2
  186. package/resources/devices/timezone.mjs.map +1 -1
  187. package/resources/hooks.d.mts +0 -239
  188. package/resources/hooks.d.mts.map +1 -1
  189. package/resources/hooks.d.ts +0 -239
  190. package/resources/hooks.d.ts.map +1 -1
  191. package/resources/hooks.js +0 -57
  192. package/resources/hooks.js.map +1 -1
  193. package/resources/hooks.mjs +0 -57
  194. package/resources/hooks.mjs.map +1 -1
  195. package/resources/index.d.mts +2 -2
  196. package/resources/index.d.mts.map +1 -1
  197. package/resources/index.d.ts +2 -2
  198. package/resources/index.d.ts.map +1 -1
  199. package/resources/index.js.map +1 -1
  200. package/resources/index.mjs +1 -1
  201. package/resources/index.mjs.map +1 -1
  202. package/resources/profiles.d.mts +69 -6
  203. package/resources/profiles.d.mts.map +1 -1
  204. package/resources/profiles.d.ts +69 -6
  205. package/resources/profiles.d.ts.map +1 -1
  206. package/resources/profiles.js.map +1 -1
  207. package/resources/profiles.mjs.map +1 -1
  208. package/resources/proxies.d.mts +14 -8
  209. package/resources/proxies.d.mts.map +1 -1
  210. package/resources/proxies.d.ts +14 -8
  211. package/resources/proxies.d.ts.map +1 -1
  212. package/resources/proxies.js +14 -8
  213. package/resources/proxies.js.map +1 -1
  214. package/resources/proxies.mjs +14 -8
  215. package/resources/proxies.mjs.map +1 -1
  216. package/resources/shared.d.mts +14 -0
  217. package/resources/shared.d.mts.map +1 -1
  218. package/resources/shared.d.ts +14 -0
  219. package/resources/shared.d.ts.map +1 -1
  220. package/resources/tasks/tasks.d.mts +159 -64
  221. package/resources/tasks/tasks.d.mts.map +1 -1
  222. package/resources/tasks/tasks.d.ts +159 -64
  223. package/resources/tasks/tasks.d.ts.map +1 -1
  224. package/resources/tasks/tasks.js +10 -2
  225. package/resources/tasks/tasks.js.map +1 -1
  226. package/resources/tasks/tasks.mjs +10 -2
  227. package/resources/tasks/tasks.mjs.map +1 -1
  228. package/resources/webhooks/deliveries.d.mts +38 -4
  229. package/resources/webhooks/deliveries.d.mts.map +1 -1
  230. package/resources/webhooks/deliveries.d.ts +38 -4
  231. package/resources/webhooks/deliveries.d.ts.map +1 -1
  232. package/resources/webhooks/deliveries.js +15 -4
  233. package/resources/webhooks/deliveries.js.map +1 -1
  234. package/resources/webhooks/deliveries.mjs +15 -4
  235. package/resources/webhooks/deliveries.mjs.map +1 -1
  236. package/resources/webhooks/webhooks.d.mts +67 -9
  237. package/resources/webhooks/webhooks.d.mts.map +1 -1
  238. package/resources/webhooks/webhooks.d.ts +67 -9
  239. package/resources/webhooks/webhooks.d.ts.map +1 -1
  240. package/resources/webhooks/webhooks.js +26 -8
  241. package/resources/webhooks/webhooks.js.map +1 -1
  242. package/resources/webhooks/webhooks.mjs +26 -8
  243. package/resources/webhooks/webhooks.mjs.map +1 -1
  244. package/resources/workflows/action-catalog.d.mts +5 -2
  245. package/resources/workflows/action-catalog.d.mts.map +1 -1
  246. package/resources/workflows/action-catalog.d.ts +5 -2
  247. package/resources/workflows/action-catalog.d.ts.map +1 -1
  248. package/resources/workflows/action-catalog.js +5 -2
  249. package/resources/workflows/action-catalog.js.map +1 -1
  250. package/resources/workflows/action-catalog.mjs +5 -2
  251. package/resources/workflows/action-catalog.mjs.map +1 -1
  252. package/resources/workflows/actions/actions.d.mts +15 -5
  253. package/resources/workflows/actions/actions.d.mts.map +1 -1
  254. package/resources/workflows/actions/actions.d.ts +15 -5
  255. package/resources/workflows/actions/actions.d.ts.map +1 -1
  256. package/resources/workflows/actions/actions.js +10 -5
  257. package/resources/workflows/actions/actions.js.map +1 -1
  258. package/resources/workflows/actions/actions.mjs +10 -5
  259. package/resources/workflows/actions/actions.mjs.map +1 -1
  260. package/resources/workflows/actions/services.d.mts +5 -2
  261. package/resources/workflows/actions/services.d.mts.map +1 -1
  262. package/resources/workflows/actions/services.d.ts +5 -2
  263. package/resources/workflows/actions/services.d.ts.map +1 -1
  264. package/resources/workflows/actions/services.js +5 -2
  265. package/resources/workflows/actions/services.js.map +1 -1
  266. package/resources/workflows/actions/services.mjs +5 -2
  267. package/resources/workflows/actions/services.mjs.map +1 -1
  268. package/resources/workflows/events/catalog.d.mts +0 -51
  269. package/resources/workflows/events/catalog.d.mts.map +1 -1
  270. package/resources/workflows/events/catalog.d.ts +0 -51
  271. package/resources/workflows/events/catalog.d.ts.map +1 -1
  272. package/resources/workflows/events/catalog.js +0 -12
  273. package/resources/workflows/events/catalog.js.map +1 -1
  274. package/resources/workflows/events/catalog.mjs +0 -12
  275. package/resources/workflows/events/catalog.mjs.map +1 -1
  276. package/resources/workflows/events/events.d.mts +10 -20
  277. package/resources/workflows/events/events.d.mts.map +1 -1
  278. package/resources/workflows/events/events.d.ts +10 -20
  279. package/resources/workflows/events/events.d.ts.map +1 -1
  280. package/resources/workflows/events/events.js.map +1 -1
  281. package/resources/workflows/events/events.mjs +1 -1
  282. package/resources/workflows/events/events.mjs.map +1 -1
  283. package/resources/workflows/events/index.d.mts +1 -1
  284. package/resources/workflows/events/index.d.mts.map +1 -1
  285. package/resources/workflows/events/index.d.ts +1 -1
  286. package/resources/workflows/events/index.d.ts.map +1 -1
  287. package/resources/workflows/events/index.js.map +1 -1
  288. package/resources/workflows/events/index.mjs +1 -1
  289. package/resources/workflows/events/index.mjs.map +1 -1
  290. package/resources/workflows/executions.d.mts +43 -5
  291. package/resources/workflows/executions.d.mts.map +1 -1
  292. package/resources/workflows/executions.d.ts +43 -5
  293. package/resources/workflows/executions.d.ts.map +1 -1
  294. package/resources/workflows/executions.js +8 -3
  295. package/resources/workflows/executions.js.map +1 -1
  296. package/resources/workflows/executions.mjs +8 -3
  297. package/resources/workflows/executions.mjs.map +1 -1
  298. package/resources/workflows/flows/actions.d.mts +12 -4
  299. package/resources/workflows/flows/actions.d.mts.map +1 -1
  300. package/resources/workflows/flows/actions.d.ts +12 -4
  301. package/resources/workflows/flows/actions.d.ts.map +1 -1
  302. package/resources/workflows/flows/actions.js +12 -4
  303. package/resources/workflows/flows/actions.js.map +1 -1
  304. package/resources/workflows/flows/actions.mjs +12 -4
  305. package/resources/workflows/flows/actions.mjs.map +1 -1
  306. package/resources/workflows/flows/flows.d.mts +33 -7
  307. package/resources/workflows/flows/flows.d.mts.map +1 -1
  308. package/resources/workflows/flows/flows.d.ts +33 -7
  309. package/resources/workflows/flows/flows.d.ts.map +1 -1
  310. package/resources/workflows/flows/flows.js +18 -6
  311. package/resources/workflows/flows/flows.js.map +1 -1
  312. package/resources/workflows/flows/flows.mjs +18 -6
  313. package/resources/workflows/flows/flows.mjs.map +1 -1
  314. package/resources/workflows/triggers.d.mts +75 -63
  315. package/resources/workflows/triggers.d.mts.map +1 -1
  316. package/resources/workflows/triggers.d.ts +75 -63
  317. package/resources/workflows/triggers.d.ts.map +1 -1
  318. package/resources/workflows/triggers.js +12 -5
  319. package/resources/workflows/triggers.js.map +1 -1
  320. package/resources/workflows/triggers.mjs +12 -5
  321. package/resources/workflows/triggers.mjs.map +1 -1
  322. package/resources/workflows/workflows.d.mts +15 -0
  323. package/resources/workflows/workflows.d.mts.map +1 -1
  324. package/resources/workflows/workflows.d.ts +15 -0
  325. package/resources/workflows/workflows.d.ts.map +1 -1
  326. package/resources/workflows/workflows.js.map +1 -1
  327. package/resources/workflows/workflows.mjs.map +1 -1
  328. package/src/client.ts +8 -46
  329. package/src/resources/apps.ts +16 -8
  330. package/src/resources/carriers.ts +0 -3
  331. package/src/resources/connect/countries.ts +8 -3
  332. package/src/resources/connect/proxies.ts +11 -9
  333. package/src/resources/connect/users.ts +7 -2
  334. package/src/resources/credentials/credentials.ts +3 -4
  335. package/src/resources/credentials/packages/credentials/credentials.ts +16 -7
  336. package/src/resources/credentials/packages/credentials/fields.ts +8 -6
  337. package/src/resources/credentials/packages/packages.ts +5 -5
  338. package/src/resources/devices/actions.ts +10 -5
  339. package/src/resources/devices/apps.ts +41 -5
  340. package/src/resources/devices/devices.ts +97 -15
  341. package/src/resources/devices/esim.ts +6 -4
  342. package/src/resources/devices/files.ts +7 -4
  343. package/src/resources/devices/keyboard.ts +5 -3
  344. package/src/resources/devices/language.ts +4 -2
  345. package/src/resources/devices/location.ts +4 -2
  346. package/src/resources/devices/packages.ts +2 -1
  347. package/src/resources/devices/proxy.ts +32 -3
  348. package/src/resources/devices/state.ts +8 -3
  349. package/src/resources/devices/tasks.ts +4 -15
  350. package/src/resources/devices/timezone.ts +4 -2
  351. package/src/resources/hooks.ts +1 -333
  352. package/src/resources/index.ts +4 -17
  353. package/src/resources/profiles.ts +105 -6
  354. package/src/resources/proxies.ts +14 -8
  355. package/src/resources/shared.ts +17 -0
  356. package/src/resources/tasks/tasks.ts +198 -78
  357. package/src/resources/webhooks/deliveries.ts +43 -4
  358. package/src/resources/webhooks/webhooks.ts +79 -9
  359. package/src/resources/workflows/action-catalog.ts +5 -2
  360. package/src/resources/workflows/actions/actions.ts +17 -5
  361. package/src/resources/workflows/actions/services.ts +5 -2
  362. package/src/resources/workflows/events/catalog.ts +1 -84
  363. package/src/resources/workflows/events/events.ts +14 -36
  364. package/src/resources/workflows/events/index.ts +1 -7
  365. package/src/resources/workflows/executions.ts +50 -5
  366. package/src/resources/workflows/flows/actions.ts +12 -4
  367. package/src/resources/workflows/flows/flows.ts +41 -7
  368. package/src/resources/workflows/triggers.ts +92 -75
  369. package/src/resources/workflows/workflows.ts +21 -0
  370. package/src/version.ts +1 -1
  371. package/version.d.mts +1 -1
  372. package/version.d.ts +1 -1
  373. package/version.js +1 -1
  374. package/version.mjs +1 -1
@@ -24,21 +24,28 @@ export class Flows extends APIResource {
24
24
  actions: ActionsAPI.Actions = new ActionsAPI.Actions(this._client);
25
25
 
26
26
  /**
27
- * Create a flow
27
+ * Create a flow that binds a trigger (`triggerId`) to an ordered list of actions,
28
+ * with at least one action required. Optional settings include target `deviceIds`,
29
+ * a cooldown (`cooldownSeconds`/`cooldownScope`), and webhook notifications on
30
+ * success or failure.
28
31
  */
29
32
  create(body: FlowCreateParams, options?: RequestOptions): APIPromise<FlowCreateResponse> {
30
33
  return this._client.post('/flows', { body, ...options });
31
34
  }
32
35
 
33
36
  /**
34
- * Get a flow
37
+ * Fetch a single flow by its ID, including its trigger binding, configuration, and
38
+ * current status. Returns 404 if no flow matches.
35
39
  */
36
40
  retrieve(flowID: string, options?: RequestOptions): APIPromise<FlowRetrieveResponse> {
37
41
  return this._client.get(path`/flows/${flowID}`, options);
38
42
  }
39
43
 
40
44
  /**
41
- * Update a flow
45
+ * Partially update a flow's settings — name, trigger binding, enabled state,
46
+ * target devices, cooldown, or notifications; all fields are optional. Actions are
47
+ * managed through the flow-actions endpoints, not here. Returns 404 if the flow
48
+ * does not exist.
42
49
  */
43
50
  update(
44
51
  flowID: string,
@@ -49,7 +56,10 @@ export class Flows extends APIResource {
49
56
  }
50
57
 
51
58
  /**
52
- * List flows
59
+ * Return a paginated list of flows. Supports filtering by `triggerId`, `enabled`,
60
+ * one or more health `status` values (healthy, failing, blocked), `mine` (flows
61
+ * created by the calling actor), `createdBy` (flows created by a given actor id —
62
+ * mutually exclusive with `mine`), plus free-text `search` and ordering.
53
63
  */
54
64
  list(
55
65
  query: FlowListParams | null | undefined = {},
@@ -59,14 +69,16 @@ export class Flows extends APIResource {
59
69
  }
60
70
 
61
71
  /**
62
- * Delete a flow
72
+ * Delete a flow by its ID. Returns 404 if no flow matches.
63
73
  */
64
74
  delete(flowID: string, options?: RequestOptions): APIPromise<FlowDeleteResponse> {
65
75
  return this._client.delete(path`/flows/${flowID}`, options);
66
76
  }
67
77
 
68
78
  /**
69
- * Clone a flow
79
+ * Create a copy of an existing flow, including its actions and settings. The
80
+ * optional body can override the new flow's `name` and target `deviceIds`. Returns
81
+ * 404 if the source flow does not exist.
70
82
  */
71
83
  clone(
72
84
  flowID: string,
@@ -148,11 +160,17 @@ export interface FlowCreateParams {
148
160
 
149
161
  enabled?: boolean;
150
162
 
163
+ healthMonitoringEnabled?: boolean;
164
+
151
165
  notifyOnFailure?: boolean;
152
166
 
153
167
  notifyOnSuccess?: boolean;
154
168
 
155
169
  notifyWebhookId?: string | null;
170
+
171
+ selfHealingEnabled?: boolean;
172
+
173
+ selfHealingMaxAttempts?: number;
156
174
  }
157
175
 
158
176
  export namespace FlowCreateParams {
@@ -182,6 +200,8 @@ export interface FlowUpdateParams {
182
200
 
183
201
  enabled?: boolean;
184
202
 
203
+ healthMonitoringEnabled?: boolean;
204
+
185
205
  name?: string;
186
206
 
187
207
  notifyOnFailure?: boolean;
@@ -190,11 +210,25 @@ export interface FlowUpdateParams {
190
210
 
191
211
  notifyWebhookId?: string | null;
192
212
 
213
+ selfHealingEnabled?: boolean;
214
+
215
+ selfHealingMaxAttempts?: number;
216
+
193
217
  triggerId?: string;
194
218
  }
195
219
 
196
220
  export interface FlowListParams {
197
- enabled?: boolean | null;
221
+ createdBy?: string;
222
+
223
+ /**
224
+ * Only include flows with this enabled state.
225
+ */
226
+ enabled?: 'true' | 'false';
227
+
228
+ /**
229
+ * Only include flows created by you.
230
+ */
231
+ mine?: 'true' | 'false';
198
232
 
199
233
  orderBy?: 'name' | 'createdAt' | 'updatedAt';
200
234
 
@@ -8,21 +8,27 @@ import { path } from '../../internal/utils/path';
8
8
 
9
9
  export class Triggers extends APIResource {
10
10
  /**
11
- * Create a trigger
11
+ * Create a trigger with an activation type of `event`, `schedule`, or `custom`.
12
+ * Each type requires its own fields (e.g. `eventType` and optional `conditions`
13
+ * for events, `scheduleRule` and `timezone` for schedules, `customPayloadSchema`
14
+ * for custom triggers); mismatched fields are rejected.
12
15
  */
13
16
  create(body: TriggerCreateParams, options?: RequestOptions): APIPromise<TriggerCreateResponse> {
14
17
  return this._client.post('/triggers', { body, ...options });
15
18
  }
16
19
 
17
20
  /**
18
- * Get a trigger
21
+ * Fetch a single trigger by its ID, including its activation type and
22
+ * type-specific configuration. Returns 404 if no trigger matches.
19
23
  */
20
24
  retrieve(triggerID: string, options?: RequestOptions): APIPromise<TriggerRetrieveResponse> {
21
25
  return this._client.get(path`/triggers/${triggerID}`, options);
22
26
  }
23
27
 
24
28
  /**
25
- * Update a trigger
29
+ * Partially update a trigger; all fields are optional. When `activation` is
30
+ * changed, the type-specific field rules are re-validated. Returns 404 if the
31
+ * trigger does not exist.
26
32
  */
27
33
  update(
28
34
  triggerID: string,
@@ -33,7 +39,8 @@ export class Triggers extends APIResource {
33
39
  }
34
40
 
35
41
  /**
36
- * List triggers
42
+ * Return a paginated list of triggers. Supports filtering by `activation` and
43
+ * `eventType`, free-text `search`, and ordering by name, createdAt, or updatedAt.
37
44
  */
38
45
  list(
39
46
  query: TriggerListParams | null | undefined = {},
@@ -43,7 +50,7 @@ export class Triggers extends APIResource {
43
50
  }
44
51
 
45
52
  /**
46
- * Delete a trigger
53
+ * Delete a trigger by its ID. Returns 404 if no trigger matches.
47
54
  */
48
55
  delete(triggerID: string, options?: RequestOptions): APIPromise<TriggerDeleteResponse> {
49
56
  return this._client.delete(path`/triggers/${triggerID}`, options);
@@ -89,6 +96,8 @@ export namespace TriggerCreateResponse {
89
96
 
90
97
  createdAt: string | null;
91
98
 
99
+ createdBy: string | null;
100
+
92
101
  customPayloadSchema: { [key: string]: unknown } | null;
93
102
 
94
103
  description: string | null;
@@ -97,12 +106,17 @@ export namespace TriggerCreateResponse {
97
106
 
98
107
  name: string;
99
108
 
109
+ ownerId: string;
110
+
100
111
  scheduleRule: Data.ScheduleRule;
101
112
 
102
113
  timezone: string | null;
103
114
 
104
115
  updatedAt: string | null;
105
116
 
117
+ /**
118
+ * @deprecated Deprecated: use ownerId (tenancy) / createdBy (actor).
119
+ */
106
120
  userId: string;
107
121
 
108
122
  conditions?: unknown;
@@ -124,11 +138,27 @@ export namespace TriggerCreateResponse {
124
138
  */
125
139
  expression?: string;
126
140
 
141
+ /**
142
+ * Optional per-occurrence random window around the nominal schedule time
143
+ */
144
+ jitter?: ScheduleRule.Jitter;
145
+
127
146
  /**
128
147
  * RRULE string (for type=recurring)
129
148
  */
130
149
  rrule?: string;
131
150
  }
151
+
152
+ export namespace ScheduleRule {
153
+ /**
154
+ * Optional per-occurrence random window around the nominal schedule time
155
+ */
156
+ export interface Jitter {
157
+ afterMinutes?: number;
158
+
159
+ beforeMinutes?: number;
160
+ }
161
+ }
132
162
  }
133
163
  }
134
164
 
@@ -144,6 +174,8 @@ export namespace TriggerRetrieveResponse {
144
174
 
145
175
  createdAt: string | null;
146
176
 
177
+ createdBy: string | null;
178
+
147
179
  customPayloadSchema: { [key: string]: unknown } | null;
148
180
 
149
181
  description: string | null;
@@ -152,39 +184,23 @@ export namespace TriggerRetrieveResponse {
152
184
 
153
185
  name: string;
154
186
 
155
- scheduleRule: Data.ScheduleRule | null;
187
+ ownerId: string;
188
+
189
+ scheduleRule: unknown;
156
190
 
157
191
  timezone: string | null;
158
192
 
159
193
  updatedAt: string | null;
160
194
 
195
+ /**
196
+ * @deprecated Deprecated: use ownerId (tenancy) / createdBy (actor).
197
+ */
161
198
  userId: string;
162
199
 
163
200
  conditions?: unknown;
164
201
 
165
202
  nextFireTime?: string | null;
166
203
  }
167
-
168
- export namespace Data {
169
- export interface ScheduleRule {
170
- type: 'once' | 'cron' | 'recurring';
171
-
172
- /**
173
- * ISO 8601 datetime (for type=once)
174
- */
175
- dateTime?: string;
176
-
177
- /**
178
- * Cron expression (for type=cron)
179
- */
180
- expression?: string;
181
-
182
- /**
183
- * RRULE string (for type=recurring)
184
- */
185
- rrule?: string;
186
- }
187
- }
188
204
  }
189
205
 
190
206
  export interface TriggerUpdateResponse {
@@ -199,6 +215,8 @@ export namespace TriggerUpdateResponse {
199
215
 
200
216
  createdAt: string | null;
201
217
 
218
+ createdBy: string | null;
219
+
202
220
  customPayloadSchema: { [key: string]: unknown } | null;
203
221
 
204
222
  description: string | null;
@@ -207,39 +225,23 @@ export namespace TriggerUpdateResponse {
207
225
 
208
226
  name: string;
209
227
 
210
- scheduleRule: Data.ScheduleRule | null;
228
+ ownerId: string;
229
+
230
+ scheduleRule: unknown;
211
231
 
212
232
  timezone: string | null;
213
233
 
214
234
  updatedAt: string | null;
215
235
 
236
+ /**
237
+ * @deprecated Deprecated: use ownerId (tenancy) / createdBy (actor).
238
+ */
216
239
  userId: string;
217
240
 
218
241
  conditions?: unknown;
219
242
 
220
243
  nextFireTime?: string | null;
221
244
  }
222
-
223
- export namespace Data {
224
- export interface ScheduleRule {
225
- type: 'once' | 'cron' | 'recurring';
226
-
227
- /**
228
- * ISO 8601 datetime (for type=once)
229
- */
230
- dateTime?: string;
231
-
232
- /**
233
- * Cron expression (for type=cron)
234
- */
235
- expression?: string;
236
-
237
- /**
238
- * RRULE string (for type=recurring)
239
- */
240
- rrule?: string;
241
- }
242
- }
243
245
  }
244
246
 
245
247
  export interface TriggerListResponse {
@@ -256,6 +258,8 @@ export namespace TriggerListResponse {
256
258
 
257
259
  createdAt: string | null;
258
260
 
261
+ createdBy: string | null;
262
+
259
263
  customPayloadSchema: { [key: string]: unknown } | null;
260
264
 
261
265
  description: string | null;
@@ -264,39 +268,23 @@ export namespace TriggerListResponse {
264
268
 
265
269
  name: string;
266
270
 
267
- scheduleRule: Item.ScheduleRule | null;
271
+ ownerId: string;
272
+
273
+ scheduleRule: unknown;
268
274
 
269
275
  timezone: string | null;
270
276
 
271
277
  updatedAt: string | null;
272
278
 
279
+ /**
280
+ * @deprecated Deprecated: use ownerId (tenancy) / createdBy (actor).
281
+ */
273
282
  userId: string;
274
283
 
275
284
  conditions?: unknown;
276
285
 
277
286
  nextFireTime?: string | null;
278
287
  }
279
-
280
- export namespace Item {
281
- export interface ScheduleRule {
282
- type: 'once' | 'cron' | 'recurring';
283
-
284
- /**
285
- * ISO 8601 datetime (for type=once)
286
- */
287
- dateTime?: string;
288
-
289
- /**
290
- * Cron expression (for type=cron)
291
- */
292
- expression?: string;
293
-
294
- /**
295
- * RRULE string (for type=recurring)
296
- */
297
- rrule?: string;
298
- }
299
- }
300
288
  }
301
289
 
302
290
  export interface TriggerDeleteResponse {
@@ -358,11 +346,27 @@ export namespace TriggerCreateParams {
358
346
  */
359
347
  expression?: string;
360
348
 
349
+ /**
350
+ * Optional per-occurrence random window around the nominal schedule time
351
+ */
352
+ jitter?: ScheduleRule.Jitter;
353
+
361
354
  /**
362
355
  * RRULE string (for type=recurring)
363
356
  */
364
357
  rrule?: string;
365
358
  }
359
+
360
+ export namespace ScheduleRule {
361
+ /**
362
+ * Optional per-occurrence random window around the nominal schedule time
363
+ */
364
+ export interface Jitter {
365
+ afterMinutes?: number;
366
+
367
+ beforeMinutes?: number;
368
+ }
369
+ }
366
370
  }
367
371
 
368
372
  export interface TriggerUpdateParams {
@@ -370,10 +374,7 @@ export interface TriggerUpdateParams {
370
374
 
371
375
  conditions?: TriggerUpdateParams.Conditions;
372
376
 
373
- /**
374
- * Optional JSON Schema for validating payloads sent to this custom trigger
375
- */
376
- customPayloadSchema?: { [key: string]: unknown } | null;
377
+ customPayloadSchema?: { [key: string]: unknown };
377
378
 
378
379
  description?: string;
379
380
 
@@ -406,11 +407,27 @@ export namespace TriggerUpdateParams {
406
407
  */
407
408
  expression?: string;
408
409
 
410
+ /**
411
+ * Optional per-occurrence random window around the nominal schedule time
412
+ */
413
+ jitter?: ScheduleRule.Jitter;
414
+
409
415
  /**
410
416
  * RRULE string (for type=recurring)
411
417
  */
412
418
  rrule?: string;
413
419
  }
420
+
421
+ export namespace ScheduleRule {
422
+ /**
423
+ * Optional per-occurrence random window around the nominal schedule time
424
+ */
425
+ export interface Jitter {
426
+ afterMinutes?: number;
427
+
428
+ beforeMinutes?: number;
429
+ }
430
+ }
414
431
  }
415
432
 
416
433
  export interface TriggerListParams {
@@ -97,12 +97,16 @@ export interface Flow {
97
97
 
98
98
  createdAt: string | null;
99
99
 
100
+ createdBy: string | null;
101
+
100
102
  description: string | null;
101
103
 
102
104
  deviceIds: Array<string>;
103
105
 
104
106
  enabled: boolean;
105
107
 
108
+ healthMonitoringEnabled: boolean;
109
+
106
110
  lastFailureAt: string | null;
107
111
 
108
112
  lastFailureCode:
@@ -124,12 +128,29 @@ export interface Flow {
124
128
 
125
129
  notifyWebhookId: string | null;
126
130
 
131
+ ownerId: string;
132
+
133
+ selfHealingEnabled: boolean;
134
+
135
+ selfHealingMaxAttempts: number;
136
+
127
137
  status: 'healthy' | 'failing' | 'blocked';
128
138
 
139
+ /**
140
+ * Template-resolver semantics this flow runs under (MVA-23). 1 = legacy
141
+ * (missing/forbidden/null all resolve to ''). 2 = typed (missing/forbidden throw,
142
+ * a whole-token null stays JSON null). Existing flows stay 1; new flows default
143
+ * to 2.
144
+ */
145
+ templateResolutionVersion: number;
146
+
129
147
  triggerId: string;
130
148
 
131
149
  updatedAt: string | null;
132
150
 
151
+ /**
152
+ * @deprecated Deprecated: use ownerId (tenancy) / createdBy (actor).
153
+ */
133
154
  userId: string;
134
155
  }
135
156
 
package/src/version.ts CHANGED
@@ -1 +1 @@
1
- export const VERSION = '5.1.0'; // x-release-please-version
1
+ export const VERSION = '5.2.0'; // x-release-please-version
package/version.d.mts CHANGED
@@ -1,2 +1,2 @@
1
- export declare const VERSION = "5.1.0";
1
+ export declare const VERSION = "5.2.0";
2
2
  //# sourceMappingURL=version.d.mts.map
package/version.d.ts CHANGED
@@ -1,2 +1,2 @@
1
- export declare const VERSION = "5.1.0";
1
+ export declare const VERSION = "5.2.0";
2
2
  //# sourceMappingURL=version.d.ts.map
package/version.js CHANGED
@@ -1,5 +1,5 @@
1
1
  "use strict";
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
3
  exports.VERSION = void 0;
4
- exports.VERSION = '5.1.0'; // x-release-please-version
4
+ exports.VERSION = '5.2.0'; // x-release-please-version
5
5
  //# sourceMappingURL=version.js.map
package/version.mjs CHANGED
@@ -1,2 +1,2 @@
1
- export const VERSION = '5.1.0'; // x-release-please-version
1
+ export const VERSION = '5.2.0'; // x-release-please-version
2
2
  //# sourceMappingURL=version.mjs.map