@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
@@ -43,43 +43,59 @@ export declare class Devices extends APIResource {
43
43
  timezone: TimezoneAPI.Timezone;
44
44
  language: LanguageAPI.Language;
45
45
  /**
46
- * Provision a new device
46
+ * Requests a new device for the authenticated user from the device spec in the
47
+ * request body. Optional query parameters select the canonical device type, target
48
+ * country, billing mode, and a profile to use as the base spec; deprecated
49
+ * device-type aliases remain accepted only during the documented compatibility
50
+ * grace period. The response returns the device and its stream token.
47
51
  */
48
52
  create(params: DeviceCreateParams, options?: RequestOptions): APIPromise<Device>;
49
53
  /**
50
- * Get device info
54
+ * Returns the current state and metadata for a single device, including its
55
+ * lifecycle state, type, stream URL, billing strategy, and timestamps. A stream
56
+ * token is included while the device is active.
51
57
  */
52
58
  retrieve(deviceID: string, options?: RequestOptions): APIPromise<Device>;
53
59
  /**
54
- * List devices
60
+ * Returns a paginated list of the user's devices along with pagination metadata.
55
61
  */
56
62
  list(query?: DeviceListParams | null | undefined, options?: RequestOptions): APIPromise<DeviceListResponse>;
57
63
  /**
58
- * Count claimed devices
64
+ * Returns the number of claimed devices for the user, broken down by device type.
59
65
  */
60
66
  count(options?: RequestOptions): APIPromise<DeviceCountResponse>;
61
67
  /**
62
- * Device fingerprint snapshot
68
+ * Returns a live snapshot of the device's spoofed identity, including model,
69
+ * display, identifiers, and carrier. Devices without fingerprint support return an
70
+ * unsupported-feature error.
63
71
  */
64
72
  fingerprint(deviceID: string, params?: DeviceFingerprintParams | null | undefined, options?: RequestOptions): APIPromise<DeviceFingerprintResponse>;
65
73
  /**
66
- * Reboot a device
74
+ * Triggers a reboot of the device. The device transitions through its reboot
75
+ * lifecycle and becomes ready again once the restart completes.
67
76
  */
68
77
  reboot(deviceID: string, options?: RequestOptions): APIPromise<void>;
69
78
  /**
70
- * Reset a device to a fresh state
79
+ * Resets the device back to a clean state, clearing installed apps and user data
80
+ * accumulated during the session. The device transitions through its reset
81
+ * lifecycle before becoming ready again.
71
82
  */
72
83
  reset(deviceID: string, options?: RequestOptions): APIPromise<void>;
73
84
  /**
74
- * Update device name
85
+ * Sets the display name for a device from the name in the request body and returns
86
+ * the updated device.
75
87
  */
76
88
  setName(deviceID: string, body: DeviceSetNameParams, options?: RequestOptions): APIPromise<Device>;
77
89
  /**
78
- * Terminate a device
90
+ * Terminates the device and releases its resources. Termination can be scheduled
91
+ * for a future time or chained from a previous device via the request body, in
92
+ * which case a service key is required.
79
93
  */
80
94
  terminate(deviceID: string, body: DeviceTerminateParams, options?: RequestOptions): APIPromise<void>;
81
95
  /**
82
- * Wait for device to be ready
96
+ * Blocks until the device reaches the ready state, then returns the same payload
97
+ * as Get device info. The call returns early with an error if the wait is
98
+ * cancelled or times out.
83
99
  */
84
100
  waitReady(deviceID: string, options?: RequestOptions): APIPromise<Device>;
85
101
  }
@@ -100,8 +116,14 @@ export interface Device {
100
116
  * A URL to the JSON Schema for this object.
101
117
  */
102
118
  $schema?: string;
119
+ billingStrategy?: string;
120
+ createdBy?: string;
121
+ ownerId?: string;
103
122
  providerId?: string;
104
123
  streamToken?: string;
124
+ /**
125
+ * @deprecated Deprecated: use ownerId/createdBy.
126
+ */
105
127
  userId?: string;
106
128
  }
107
129
  export interface DeviceListResponse {
@@ -142,15 +164,26 @@ export declare namespace DeviceFingerprintResponse {
142
164
  }
143
165
  }
144
166
  export interface DeviceCreateParams {
167
+ /**
168
+ * Query param: Billing mode. 'auto' uses a subscription slot when available and
169
+ * otherwise bills per minute; 'subscription' requires an available subscription
170
+ * slot; 'minute' bills per minute. Only cloud phone and cloud emulator devices
171
+ * support per-minute billing.
172
+ */
173
+ billing?: 'auto' | 'subscription' | 'minute';
145
174
  /**
146
175
  * Query param: ISO 3166-1 alpha-2 country code. If omitted the system picks the
147
176
  * country with the most availability.
148
177
  */
149
178
  query_country?: string;
150
179
  /**
151
- * Query param
180
+ * Query param: Deprecated device type aliases are accepted during a compatibility
181
+ * grace period: dedicated_premium_device maps to android_cloud_phone,
182
+ * dedicated_physical_device maps to android_physical_phone, dedicated_ios_device
183
+ * maps to ios_stealth_phone, and dedicated_emulated_device maps to
184
+ * android_emulator.
152
185
  */
153
- deviceType?: 'dedicated_physical_device' | 'dedicated_premium_device' | 'dedicated_ios_device';
186
+ deviceType?: 'android_cloud_phone' | 'dedicated_premium_device' | 'dedicated_physical_device' | 'dedicated_ios_device' | 'dedicated_emulated_device';
154
187
  /**
155
188
  * Query param: Profile ID to use as device spec
156
189
  */
@@ -202,21 +235,50 @@ export interface DeviceCreateParams {
202
235
  }
203
236
  export declare namespace DeviceCreateParams {
204
237
  interface Proxy {
238
+ connect?: Proxy.Connect;
205
239
  name?: string;
206
240
  smartIp?: boolean;
207
241
  socks5?: Shared.Socks5;
208
242
  }
243
+ namespace Proxy {
244
+ interface Connect {
245
+ /**
246
+ * Existing Mobilerun Connect proxy id; its credentials are fetched server-side.
247
+ */
248
+ id?: string;
249
+ /**
250
+ * ISO 3166-1 alpha-2 country code; provisions (or reuses) a rotating residential
251
+ * Mobilerun Connect proxy for the device.
252
+ */
253
+ country?: string;
254
+ }
255
+ }
209
256
  }
210
257
  export interface DeviceListParams {
211
258
  country?: string;
259
+ /**
260
+ * Filter to devices created by this user id. Mutually exclusive with mine.
261
+ */
262
+ createdBy?: string;
263
+ /**
264
+ * When true, only return devices created by the calling user (resolved from
265
+ * X-User-ID, never a client-supplied id).
266
+ */
267
+ mine?: boolean;
212
268
  name?: string;
213
269
  orderBy?: 'id' | 'createdAt' | 'updatedAt' | 'assignedAt';
214
270
  orderByDirection?: 'asc' | 'desc';
215
271
  page?: number;
216
272
  pageSize?: number;
217
273
  providerId?: string;
218
- state?: Array<'creating' | 'assigned' | 'ready' | 'rebooting' | 'migrating' | 'resetting' | 'terminated' | 'maintenance' | 'unknown'> | null;
219
- type?: 'dedicated_physical_device' | 'dedicated_premium_device' | 'dedicated_ios_device';
274
+ state?: Array<'creating' | 'assigned' | 'ready' | 'rebooting' | 'migrating' | 'resetting' | 'terminated' | 'maintenance' | 'stopped' | 'unknown'> | null;
275
+ /**
276
+ * Deprecated device type aliases are accepted during a compatibility grace period:
277
+ * dedicated_premium_device maps to android_cloud_phone, dedicated_physical_device
278
+ * maps to android_physical_phone, dedicated_ios_device maps to ios_stealth_phone,
279
+ * and dedicated_emulated_device maps to android_emulator.
280
+ */
281
+ type?: 'android_cloud_phone' | 'dedicated_premium_device' | 'dedicated_physical_device' | 'dedicated_ios_device' | 'dedicated_emulated_device';
220
282
  }
221
283
  export interface DeviceFingerprintParams {
222
284
  'X-Device-Display-ID'?: number;
@@ -1 +1 @@
1
- {"version":3,"file":"devices.d.ts","sourceRoot":"","sources":["../../src/resources/devices/devices.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,+BAA4B;AAClD,OAAO,KAAK,MAAM,qBAAkB;AACpC,OAAO,KAAK,UAAU,qBAAkB;AACxC,OAAO,EACL,kBAAkB,EAClB,0BAA0B,EAC1B,4BAA4B,EAC5B,6BAA6B,EAC7B,iBAAiB,EACjB,eAAe,EACf,OAAO,EACR,qBAAkB;AACnB,OAAO,KAAK,OAAO,kBAAe;AAClC,OAAO,EACL,eAAe,EACf,gBAAgB,EAChB,aAAa,EACb,eAAe,EACf,cAAc,EACd,aAAa,EACb,IAAI,EACL,kBAAe;AAChB,OAAO,KAAK,OAAO,kBAAe;AAClC,OAAO,EACL,IAAI,EACJ,kBAAkB,EAClB,oBAAoB,EACpB,gBAAgB,EAChB,cAAc,EACd,gBAAgB,EAChB,gBAAgB,EACjB,kBAAe;AAChB,OAAO,KAAK,QAAQ,mBAAgB;AACpC,OAAO,EACL,gBAAgB,EAChB,kBAAkB,EAClB,oBAAoB,EACpB,QAAQ,EACR,cAAc,EACd,gBAAgB,EAChB,gBAAgB,EAChB,KAAK,EACN,mBAAgB;AACjB,OAAO,KAAK,WAAW,sBAAmB;AAC1C,OAAO,EAAE,QAAQ,EAAE,mBAAmB,EAAE,iBAAiB,EAAE,mBAAmB,EAAE,sBAAmB;AACnG,OAAO,KAAK,WAAW,sBAAmB;AAC1C,OAAO,EAAE,QAAQ,EAAE,iBAAiB,EAAE,mBAAmB,EAAE,iBAAiB,EAAE,sBAAmB;AACjG,OAAO,KAAK,WAAW,sBAAmB;AAC1C,OAAO,EAAE,QAAQ,EAAE,iBAAiB,EAAE,iBAAiB,EAAE,sBAAmB;AAC5E,OAAO,KAAK,WAAW,sBAAmB;AAC1C,OAAO,EAAE,iBAAiB,EAAE,mBAAmB,EAAE,QAAQ,EAAE,sBAAmB;AAC9E,OAAO,KAAK,UAAU,qBAAkB;AACxC,OAAO,EAAE,OAAO,EAAE,mBAAmB,EAAE,qBAAkB;AACzD,OAAO,KAAK,QAAQ,mBAAgB;AACpC,OAAO,EACL,KAAK,IAAI,aAAa,EACtB,kBAAkB,EAClB,qBAAqB,EACrB,iBAAiB,EACjB,mBAAmB,EACpB,mBAAgB;AACjB,OAAO,KAAK,QAAQ,mBAAgB;AACpC,OAAO,EACL,QAAQ,EACR,IAAI,EACJ,KAAK,EACL,qBAAqB,EACrB,uBAAuB,EACvB,eAAe,EACf,iBAAiB,EACjB,aAAa,EACb,eAAe,EAChB,mBAAgB;AACjB,OAAO,KAAK,QAAQ,mBAAgB;AACpC,OAAO,EAAE,cAAc,EAAE,gBAAgB,EAAE,KAAK,EAAE,mBAAgB;AAClE,OAAO,KAAK,WAAW,sBAAmB;AAC1C,OAAO,EAAE,QAAQ,EAAE,iBAAiB,EAAE,mBAAmB,EAAE,iBAAiB,EAAE,sBAAmB;AACjG,OAAO,EAAE,UAAU,EAAE,kCAA+B;AAEpD,OAAO,EAAE,cAAc,EAAE,0CAAuC;AAGhE,qBAAa,OAAQ,SAAQ,WAAW;IACtC,OAAO,EAAE,UAAU,CAAC,OAAO,CAAwC;IACnE,IAAI,EAAE,OAAO,CAAC,IAAI,CAAkC;IACpD,IAAI,EAAE,OAAO,CAAC,IAAI,CAAkC;IACpD,KAAK,EAAE,QAAQ,CAAC,KAAK,CAAoC;IACzD,QAAQ,EAAE,WAAW,CAAC,QAAQ,CAA0C;IACxE,QAAQ,EAAE,WAAW,CAAC,QAAQ,CAA0C;IACxE,QAAQ,EAAE,WAAW,CAAC,QAAQ,CAA0C;IACxE,OAAO,EAAE,UAAU,CAAC,OAAO,CAAwC;IACnE,KAAK,EAAE,QAAQ,CAAC,KAAK,CAAoC;IACzD,KAAK,EAAE,QAAQ,CAAC,KAAK,CAAoC;IACzD,KAAK,EAAE,QAAQ,CAAC,KAAK,CAAoC;IACzD,QAAQ,EAAE,WAAW,CAAC,QAAQ,CAA0C;IACxE,QAAQ,EAAE,WAAW,CAAC,QAAQ,CAA0C;IAExE;;OAEG;IACH,MAAM,CAAC,MAAM,EAAE,kBAAkB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,MAAM,CAAC;IAShF;;OAEG;IACH,QAAQ,CAAC,QAAQ,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,MAAM,CAAC;IAIxE;;OAEG;IACH,IAAI,CACF,KAAK,GAAE,gBAAgB,GAAG,IAAI,GAAG,SAAc,EAC/C,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,kBAAkB,CAAC;IAIjC;;OAEG;IACH,KAAK,CAAC,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,mBAAmB,CAAC;IAIhE;;OAEG;IACH,WAAW,CACT,QAAQ,EAAE,MAAM,EAChB,MAAM,GAAE,uBAAuB,GAAG,IAAI,GAAG,SAAc,EACvD,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,yBAAyB,CAAC;IAexC;;OAEG;IACH,MAAM,CAAC,QAAQ,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,IAAI,CAAC;IAOpE;;OAEG;IACH,KAAK,CAAC,QAAQ,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,IAAI,CAAC;IAOnE;;OAEG;IACH,OAAO,CAAC,QAAQ,EAAE,MAAM,EAAE,IAAI,EAAE,mBAAmB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,MAAM,CAAC;IAIlG;;OAEG;IACH,SAAS,CAAC,QAAQ,EAAE,MAAM,EAAE,IAAI,EAAE,qBAAqB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,IAAI,CAAC;IAQpG;;OAEG;IACH,SAAS,CAAC,QAAQ,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,MAAM,CAAC;CAG1E;AAED,MAAM,WAAW,MAAM;IACrB,EAAE,EAAE,MAAM,CAAC;IAEX,YAAY,EAAE,MAAM,CAAC;IAErB,UAAU,EAAE,MAAM,GAAG,IAAI,CAAC;IAE1B,SAAS,EAAE,MAAM,CAAC;IAElB,IAAI,EAAE,MAAM,CAAC;IAEb,KAAK,EAAE,MAAM,CAAC;IAEd,YAAY,EAAE,MAAM,CAAC;IAErB,SAAS,EAAE,MAAM,CAAC;IAElB,SAAS,EAAE,MAAM,CAAC;IAElB,YAAY,EAAE,MAAM,GAAG,IAAI,CAAC;IAE5B,IAAI,EAAE,MAAM,CAAC;IAEb,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AAED,MAAM,WAAW,kBAAkB;IACjC,KAAK,EAAE,KAAK,CAAC,MAAM,CAAC,GAAG,IAAI,CAAC;IAE5B,UAAU,EAAE,MAAM,CAAC,IAAI,CAAC;IAExB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB;AAED,MAAM,MAAM,mBAAmB,GAAG;IAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;CAAE,CAAC;AAE5D,MAAM,WAAW,yBAAyB;IACxC,OAAO,EAAE,MAAM,CAAC,aAAa,CAAC;IAE9B,OAAO,EAAE,yBAAyB,CAAC,OAAO,CAAC;IAE3C,WAAW,EAAE,MAAM,CAAC,iBAAiB,CAAC;IAEtC,KAAK,EAAE,yBAAyB,CAAC,KAAK,CAAC;IAEvC;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB;AAED,yBAAiB,yBAAyB,CAAC;IACzC,UAAiB,OAAO;QACtB,UAAU,CAAC,EAAE,MAAM,CAAC;QAEpB,MAAM,CAAC,EAAE,MAAM,CAAC;QAEhB,KAAK,CAAC,EAAE,MAAM,CAAC;KAChB;IAED,UAAiB,KAAK;QACpB,WAAW,CAAC,EAAE,MAAM,CAAC;QAErB,KAAK,CAAC,EAAE,MAAM,CAAC;QAEf,MAAM,CAAC,EAAE,MAAM,CAAC;QAEhB,QAAQ,CAAC,EAAE,MAAM,CAAC;QAElB,eAAe,CAAC,EAAE,MAAM,CAAC;QAEzB,YAAY,CAAC,EAAE,MAAM,CAAC;QAEtB,KAAK,CAAC,EAAE,MAAM,CAAC;KAChB;CACF;AAED,MAAM,WAAW,kBAAkB;IACjC;;;OAGG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;IAEvB;;OAEG;IACH,UAAU,CAAC,EAAE,2BAA2B,GAAG,0BAA0B,GAAG,sBAAsB,CAAC;IAE/F;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;IAExB;;OAEG;IACH,IAAI,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,GAAG,IAAI,CAAC;IAE5B;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC,aAAa,CAAC;IAE/B;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,KAAK,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,GAAG,IAAI,CAAC;IAE7B;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC,iBAAiB,CAAC;IAEvC;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC,QAAQ,CAAC;IAE3B;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,KAAK,CAAC,EAAE,kBAAkB,CAAC,KAAK,CAAC;IAEjC;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB;AAED,yBAAiB,kBAAkB,CAAC;IAClC,UAAiB,KAAK;QACpB,IAAI,CAAC,EAAE,MAAM,CAAC;QAEd,OAAO,CAAC,EAAE,OAAO,CAAC;QAElB,MAAM,CAAC,EAAE,MAAM,CAAC,MAAM,CAAC;KACxB;CACF;AAED,MAAM,WAAW,gBAAgB;IAC/B,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd,OAAO,CAAC,EAAE,IAAI,GAAG,WAAW,GAAG,WAAW,GAAG,YAAY,CAAC;IAE1D,gBAAgB,CAAC,EAAE,KAAK,GAAG,MAAM,CAAC;IAElC,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB,KAAK,CAAC,EAAE,KAAK,CACT,UAAU,GACV,UAAU,GACV,OAAO,GACP,WAAW,GACX,WAAW,GACX,WAAW,GACX,YAAY,GACZ,aAAa,GACb,SAAS,CACZ,GAAG,IAAI,CAAC;IAET,IAAI,CAAC,EAAE,2BAA2B,GAAG,0BAA0B,GAAG,sBAAsB,CAAC;CAC1F;AAED,MAAM,WAAW,uBAAuB;IACtC,qBAAqB,CAAC,EAAE,MAAM,CAAC;CAChC;AAED,MAAM,WAAW,mBAAmB;IAClC,IAAI,EAAE,MAAM,CAAC;CACd;AAED,MAAM,WAAW,qBAAqB;IACpC,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAE1B,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB;AAgBD,MAAM,CAAC,OAAO,WAAW,OAAO,CAAC;IAC/B,OAAO,EACL,KAAK,MAAM,IAAI,MAAM,EACrB,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,yBAAyB,IAAI,yBAAyB,EAC3D,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,gBAAgB,IAAI,gBAAgB,EACzC,KAAK,uBAAuB,IAAI,uBAAuB,EACvD,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,qBAAqB,IAAI,qBAAqB,GACpD,CAAC;IAEF,OAAO,EACL,OAAO,IAAI,OAAO,EAClB,KAAK,4BAA4B,IAAI,4BAA4B,EACjE,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,0BAA0B,IAAI,0BAA0B,EAC7D,KAAK,6BAA6B,IAAI,6BAA6B,EACnE,KAAK,iBAAiB,IAAI,iBAAiB,EAC3C,KAAK,eAAe,IAAI,eAAe,GACxC,CAAC;IAEF,OAAO,EACL,IAAI,IAAI,IAAI,EACZ,KAAK,eAAe,IAAI,eAAe,EACvC,KAAK,aAAa,IAAI,aAAa,EACnC,KAAK,eAAe,IAAI,eAAe,EACvC,KAAK,gBAAgB,IAAI,gBAAgB,EACzC,KAAK,cAAc,IAAI,cAAc,EACrC,KAAK,aAAa,IAAI,aAAa,GACpC,CAAC;IAEF,OAAO,EACL,IAAI,IAAI,IAAI,EACZ,KAAK,gBAAgB,IAAI,gBAAgB,EACzC,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,cAAc,IAAI,cAAc,EACrC,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,gBAAgB,IAAI,gBAAgB,EACzC,KAAK,gBAAgB,IAAI,gBAAgB,GAC1C,CAAC;IAEF,OAAO,EACL,KAAK,IAAI,KAAK,EACd,KAAK,QAAQ,IAAI,QAAQ,EACzB,KAAK,gBAAgB,IAAI,gBAAgB,EACzC,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,cAAc,IAAI,cAAc,EACrC,KAAK,gBAAgB,IAAI,gBAAgB,EACzC,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,gBAAgB,IAAI,gBAAgB,GAC1C,CAAC;IAEF,OAAO,EACL,QAAQ,IAAI,QAAQ,EACpB,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,iBAAiB,IAAI,iBAAiB,EAC3C,KAAK,mBAAmB,IAAI,mBAAmB,GAChD,CAAC;IAEF,OAAO,EACL,QAAQ,IAAI,QAAQ,EACpB,KAAK,iBAAiB,IAAI,iBAAiB,EAC3C,KAAK,iBAAiB,IAAI,iBAAiB,GAC5C,CAAC;IAEF,OAAO,EACL,QAAQ,IAAI,QAAQ,EACpB,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,iBAAiB,IAAI,iBAAiB,GAC5C,CAAC;IAEF,OAAO,EAAE,OAAO,IAAI,OAAO,EAAE,KAAK,mBAAmB,IAAI,mBAAmB,EAAE,CAAC;IAE/E,OAAO,EACL,aAAa,IAAI,KAAK,EACtB,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,iBAAiB,IAAI,iBAAiB,GAC5C,CAAC;IAEF,OAAO,EACL,KAAK,IAAI,KAAK,EACd,KAAK,QAAQ,IAAI,QAAQ,EACzB,KAAK,IAAI,IAAI,IAAI,EACjB,KAAK,uBAAuB,IAAI,uBAAuB,EACvD,KAAK,iBAAiB,IAAI,iBAAiB,EAC3C,KAAK,eAAe,IAAI,eAAe,EACvC,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,eAAe,IAAI,eAAe,EACvC,KAAK,aAAa,IAAI,aAAa,GACpC,CAAC;IAEF,OAAO,EAAE,KAAK,IAAI,KAAK,EAAE,KAAK,gBAAgB,IAAI,gBAAgB,EAAE,KAAK,cAAc,IAAI,cAAc,EAAE,CAAC;IAE5G,OAAO,EACL,QAAQ,IAAI,QAAQ,EACpB,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,iBAAiB,IAAI,iBAAiB,EAC3C,KAAK,iBAAiB,IAAI,iBAAiB,GAC5C,CAAC;IAEF,OAAO,EACL,QAAQ,IAAI,QAAQ,EACpB,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,iBAAiB,IAAI,iBAAiB,EAC3C,KAAK,iBAAiB,IAAI,iBAAiB,GAC5C,CAAC;CACH"}
1
+ {"version":3,"file":"devices.d.ts","sourceRoot":"","sources":["../../src/resources/devices/devices.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,+BAA4B;AAClD,OAAO,KAAK,MAAM,qBAAkB;AACpC,OAAO,KAAK,UAAU,qBAAkB;AACxC,OAAO,EACL,kBAAkB,EAClB,0BAA0B,EAC1B,4BAA4B,EAC5B,6BAA6B,EAC7B,iBAAiB,EACjB,eAAe,EACf,OAAO,EACR,qBAAkB;AACnB,OAAO,KAAK,OAAO,kBAAe;AAClC,OAAO,EACL,eAAe,EACf,gBAAgB,EAChB,aAAa,EACb,eAAe,EACf,cAAc,EACd,aAAa,EACb,IAAI,EACL,kBAAe;AAChB,OAAO,KAAK,OAAO,kBAAe;AAClC,OAAO,EACL,IAAI,EACJ,kBAAkB,EAClB,oBAAoB,EACpB,gBAAgB,EAChB,cAAc,EACd,gBAAgB,EAChB,gBAAgB,EACjB,kBAAe;AAChB,OAAO,KAAK,QAAQ,mBAAgB;AACpC,OAAO,EACL,gBAAgB,EAChB,kBAAkB,EAClB,oBAAoB,EACpB,QAAQ,EACR,cAAc,EACd,gBAAgB,EAChB,gBAAgB,EAChB,KAAK,EACN,mBAAgB;AACjB,OAAO,KAAK,WAAW,sBAAmB;AAC1C,OAAO,EAAE,QAAQ,EAAE,mBAAmB,EAAE,iBAAiB,EAAE,mBAAmB,EAAE,sBAAmB;AACnG,OAAO,KAAK,WAAW,sBAAmB;AAC1C,OAAO,EAAE,QAAQ,EAAE,iBAAiB,EAAE,mBAAmB,EAAE,iBAAiB,EAAE,sBAAmB;AACjG,OAAO,KAAK,WAAW,sBAAmB;AAC1C,OAAO,EAAE,QAAQ,EAAE,iBAAiB,EAAE,iBAAiB,EAAE,sBAAmB;AAC5E,OAAO,KAAK,WAAW,sBAAmB;AAC1C,OAAO,EAAE,iBAAiB,EAAE,mBAAmB,EAAE,QAAQ,EAAE,sBAAmB;AAC9E,OAAO,KAAK,UAAU,qBAAkB;AACxC,OAAO,EAAE,OAAO,EAAE,mBAAmB,EAAE,qBAAkB;AACzD,OAAO,KAAK,QAAQ,mBAAgB;AACpC,OAAO,EACL,KAAK,IAAI,aAAa,EACtB,kBAAkB,EAClB,qBAAqB,EACrB,iBAAiB,EACjB,mBAAmB,EACpB,mBAAgB;AACjB,OAAO,KAAK,QAAQ,mBAAgB;AACpC,OAAO,EACL,QAAQ,EACR,IAAI,EACJ,KAAK,EACL,qBAAqB,EACrB,uBAAuB,EACvB,eAAe,EACf,iBAAiB,EACjB,aAAa,EACb,eAAe,EAChB,mBAAgB;AACjB,OAAO,KAAK,QAAQ,mBAAgB;AACpC,OAAO,EAAE,cAAc,EAAE,gBAAgB,EAAE,KAAK,EAAE,mBAAgB;AAClE,OAAO,KAAK,WAAW,sBAAmB;AAC1C,OAAO,EAAE,QAAQ,EAAE,iBAAiB,EAAE,mBAAmB,EAAE,iBAAiB,EAAE,sBAAmB;AACjG,OAAO,EAAE,UAAU,EAAE,kCAA+B;AAEpD,OAAO,EAAE,cAAc,EAAE,0CAAuC;AAGhE,qBAAa,OAAQ,SAAQ,WAAW;IACtC,OAAO,EAAE,UAAU,CAAC,OAAO,CAAwC;IACnE,IAAI,EAAE,OAAO,CAAC,IAAI,CAAkC;IACpD,IAAI,EAAE,OAAO,CAAC,IAAI,CAAkC;IACpD,KAAK,EAAE,QAAQ,CAAC,KAAK,CAAoC;IACzD,QAAQ,EAAE,WAAW,CAAC,QAAQ,CAA0C;IACxE,QAAQ,EAAE,WAAW,CAAC,QAAQ,CAA0C;IACxE,QAAQ,EAAE,WAAW,CAAC,QAAQ,CAA0C;IACxE,OAAO,EAAE,UAAU,CAAC,OAAO,CAAwC;IACnE,KAAK,EAAE,QAAQ,CAAC,KAAK,CAAoC;IACzD,KAAK,EAAE,QAAQ,CAAC,KAAK,CAAoC;IACzD,KAAK,EAAE,QAAQ,CAAC,KAAK,CAAoC;IACzD,QAAQ,EAAE,WAAW,CAAC,QAAQ,CAA0C;IACxE,QAAQ,EAAE,WAAW,CAAC,QAAQ,CAA0C;IAExE;;;;;;OAMG;IACH,MAAM,CAAC,MAAM,EAAE,kBAAkB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,MAAM,CAAC;IAShF;;;;OAIG;IACH,QAAQ,CAAC,QAAQ,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,MAAM,CAAC;IAIxE;;OAEG;IACH,IAAI,CACF,KAAK,GAAE,gBAAgB,GAAG,IAAI,GAAG,SAAc,EAC/C,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,kBAAkB,CAAC;IAIjC;;OAEG;IACH,KAAK,CAAC,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,mBAAmB,CAAC;IAIhE;;;;OAIG;IACH,WAAW,CACT,QAAQ,EAAE,MAAM,EAChB,MAAM,GAAE,uBAAuB,GAAG,IAAI,GAAG,SAAc,EACvD,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,yBAAyB,CAAC;IAexC;;;OAGG;IACH,MAAM,CAAC,QAAQ,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,IAAI,CAAC;IAOpE;;;;OAIG;IACH,KAAK,CAAC,QAAQ,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,IAAI,CAAC;IAOnE;;;OAGG;IACH,OAAO,CAAC,QAAQ,EAAE,MAAM,EAAE,IAAI,EAAE,mBAAmB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,MAAM,CAAC;IAIlG;;;;OAIG;IACH,SAAS,CAAC,QAAQ,EAAE,MAAM,EAAE,IAAI,EAAE,qBAAqB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,IAAI,CAAC;IAQpG;;;;OAIG;IACH,SAAS,CAAC,QAAQ,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,MAAM,CAAC;CAG1E;AAED,MAAM,WAAW,MAAM;IACrB,EAAE,EAAE,MAAM,CAAC;IAEX,YAAY,EAAE,MAAM,CAAC;IAErB,UAAU,EAAE,MAAM,GAAG,IAAI,CAAC;IAE1B,SAAS,EAAE,MAAM,CAAC;IAElB,IAAI,EAAE,MAAM,CAAC;IAEb,KAAK,EAAE,MAAM,CAAC;IAEd,YAAY,EAAE,MAAM,CAAC;IAErB,SAAS,EAAE,MAAM,CAAC;IAElB,SAAS,EAAE,MAAM,CAAC;IAElB,YAAY,EAAE,MAAM,GAAG,IAAI,CAAC;IAE5B,IAAI,EAAE,MAAM,CAAC;IAEb,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB,eAAe,CAAC,EAAE,MAAM,CAAC;IAEzB,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AAED,MAAM,WAAW,kBAAkB;IACjC,KAAK,EAAE,KAAK,CAAC,MAAM,CAAC,GAAG,IAAI,CAAC;IAE5B,UAAU,EAAE,MAAM,CAAC,IAAI,CAAC;IAExB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB;AAED,MAAM,MAAM,mBAAmB,GAAG;IAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;CAAE,CAAC;AAE5D,MAAM,WAAW,yBAAyB;IACxC,OAAO,EAAE,MAAM,CAAC,aAAa,CAAC;IAE9B,OAAO,EAAE,yBAAyB,CAAC,OAAO,CAAC;IAE3C,WAAW,EAAE,MAAM,CAAC,iBAAiB,CAAC;IAEtC,KAAK,EAAE,yBAAyB,CAAC,KAAK,CAAC;IAEvC;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB;AAED,yBAAiB,yBAAyB,CAAC;IACzC,UAAiB,OAAO;QACtB,UAAU,CAAC,EAAE,MAAM,CAAC;QAEpB,MAAM,CAAC,EAAE,MAAM,CAAC;QAEhB,KAAK,CAAC,EAAE,MAAM,CAAC;KAChB;IAED,UAAiB,KAAK;QACpB,WAAW,CAAC,EAAE,MAAM,CAAC;QAErB,KAAK,CAAC,EAAE,MAAM,CAAC;QAEf,MAAM,CAAC,EAAE,MAAM,CAAC;QAEhB,QAAQ,CAAC,EAAE,MAAM,CAAC;QAElB,eAAe,CAAC,EAAE,MAAM,CAAC;QAEzB,YAAY,CAAC,EAAE,MAAM,CAAC;QAEtB,KAAK,CAAC,EAAE,MAAM,CAAC;KAChB;CACF;AAED,MAAM,WAAW,kBAAkB;IACjC;;;;;OAKG;IACH,OAAO,CAAC,EAAE,MAAM,GAAG,cAAc,GAAG,QAAQ,CAAC;IAE7C;;;OAGG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;IAEvB;;;;;;OAMG;IACH,UAAU,CAAC,EACP,qBAAqB,GACrB,0BAA0B,GAC1B,2BAA2B,GAC3B,sBAAsB,GACtB,2BAA2B,CAAC;IAEhC;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;IAExB;;OAEG;IACH,IAAI,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,GAAG,IAAI,CAAC;IAE5B;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC,aAAa,CAAC;IAE/B;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,KAAK,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,GAAG,IAAI,CAAC;IAE7B;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC,iBAAiB,CAAC;IAEvC;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC,QAAQ,CAAC;IAE3B;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,KAAK,CAAC,EAAE,kBAAkB,CAAC,KAAK,CAAC;IAEjC;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB;AAED,yBAAiB,kBAAkB,CAAC;IAClC,UAAiB,KAAK;QACpB,OAAO,CAAC,EAAE,KAAK,CAAC,OAAO,CAAC;QAExB,IAAI,CAAC,EAAE,MAAM,CAAC;QAEd,OAAO,CAAC,EAAE,OAAO,CAAC;QAElB,MAAM,CAAC,EAAE,MAAM,CAAC,MAAM,CAAC;KACxB;IAED,UAAiB,KAAK,CAAC;QACrB,UAAiB,OAAO;YACtB;;eAEG;YACH,EAAE,CAAC,EAAE,MAAM,CAAC;YAEZ;;;eAGG;YACH,OAAO,CAAC,EAAE,MAAM,CAAC;SAClB;KACF;CACF;AAED,MAAM,WAAW,gBAAgB;IAC/B,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;;OAGG;IACH,IAAI,CAAC,EAAE,OAAO,CAAC;IAEf,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd,OAAO,CAAC,EAAE,IAAI,GAAG,WAAW,GAAG,WAAW,GAAG,YAAY,CAAC;IAE1D,gBAAgB,CAAC,EAAE,KAAK,GAAG,MAAM,CAAC;IAElC,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB,KAAK,CAAC,EAAE,KAAK,CACT,UAAU,GACV,UAAU,GACV,OAAO,GACP,WAAW,GACX,WAAW,GACX,WAAW,GACX,YAAY,GACZ,aAAa,GACb,SAAS,GACT,SAAS,CACZ,GAAG,IAAI,CAAC;IAET;;;;;OAKG;IACH,IAAI,CAAC,EACD,qBAAqB,GACrB,0BAA0B,GAC1B,2BAA2B,GAC3B,sBAAsB,GACtB,2BAA2B,CAAC;CACjC;AAED,MAAM,WAAW,uBAAuB;IACtC,qBAAqB,CAAC,EAAE,MAAM,CAAC;CAChC;AAED,MAAM,WAAW,mBAAmB;IAClC,IAAI,EAAE,MAAM,CAAC;CACd;AAED,MAAM,WAAW,qBAAqB;IACpC,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAE1B,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB;AAgBD,MAAM,CAAC,OAAO,WAAW,OAAO,CAAC;IAC/B,OAAO,EACL,KAAK,MAAM,IAAI,MAAM,EACrB,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,yBAAyB,IAAI,yBAAyB,EAC3D,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,gBAAgB,IAAI,gBAAgB,EACzC,KAAK,uBAAuB,IAAI,uBAAuB,EACvD,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,qBAAqB,IAAI,qBAAqB,GACpD,CAAC;IAEF,OAAO,EACL,OAAO,IAAI,OAAO,EAClB,KAAK,4BAA4B,IAAI,4BAA4B,EACjE,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,0BAA0B,IAAI,0BAA0B,EAC7D,KAAK,6BAA6B,IAAI,6BAA6B,EACnE,KAAK,iBAAiB,IAAI,iBAAiB,EAC3C,KAAK,eAAe,IAAI,eAAe,GACxC,CAAC;IAEF,OAAO,EACL,IAAI,IAAI,IAAI,EACZ,KAAK,eAAe,IAAI,eAAe,EACvC,KAAK,aAAa,IAAI,aAAa,EACnC,KAAK,eAAe,IAAI,eAAe,EACvC,KAAK,gBAAgB,IAAI,gBAAgB,EACzC,KAAK,cAAc,IAAI,cAAc,EACrC,KAAK,aAAa,IAAI,aAAa,GACpC,CAAC;IAEF,OAAO,EACL,IAAI,IAAI,IAAI,EACZ,KAAK,gBAAgB,IAAI,gBAAgB,EACzC,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,cAAc,IAAI,cAAc,EACrC,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,gBAAgB,IAAI,gBAAgB,EACzC,KAAK,gBAAgB,IAAI,gBAAgB,GAC1C,CAAC;IAEF,OAAO,EACL,KAAK,IAAI,KAAK,EACd,KAAK,QAAQ,IAAI,QAAQ,EACzB,KAAK,gBAAgB,IAAI,gBAAgB,EACzC,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,cAAc,IAAI,cAAc,EACrC,KAAK,gBAAgB,IAAI,gBAAgB,EACzC,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,gBAAgB,IAAI,gBAAgB,GAC1C,CAAC;IAEF,OAAO,EACL,QAAQ,IAAI,QAAQ,EACpB,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,iBAAiB,IAAI,iBAAiB,EAC3C,KAAK,mBAAmB,IAAI,mBAAmB,GAChD,CAAC;IAEF,OAAO,EACL,QAAQ,IAAI,QAAQ,EACpB,KAAK,iBAAiB,IAAI,iBAAiB,EAC3C,KAAK,iBAAiB,IAAI,iBAAiB,GAC5C,CAAC;IAEF,OAAO,EACL,QAAQ,IAAI,QAAQ,EACpB,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,iBAAiB,IAAI,iBAAiB,GAC5C,CAAC;IAEF,OAAO,EAAE,OAAO,IAAI,OAAO,EAAE,KAAK,mBAAmB,IAAI,mBAAmB,EAAE,CAAC;IAE/E,OAAO,EACL,aAAa,IAAI,KAAK,EACtB,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,iBAAiB,IAAI,iBAAiB,GAC5C,CAAC;IAEF,OAAO,EACL,KAAK,IAAI,KAAK,EACd,KAAK,QAAQ,IAAI,QAAQ,EACzB,KAAK,IAAI,IAAI,IAAI,EACjB,KAAK,uBAAuB,IAAI,uBAAuB,EACvD,KAAK,iBAAiB,IAAI,iBAAiB,EAC3C,KAAK,eAAe,IAAI,eAAe,EACvC,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,eAAe,IAAI,eAAe,EACvC,KAAK,aAAa,IAAI,aAAa,GACpC,CAAC;IAEF,OAAO,EAAE,KAAK,IAAI,KAAK,EAAE,KAAK,gBAAgB,IAAI,gBAAgB,EAAE,KAAK,cAAc,IAAI,cAAc,EAAE,CAAC;IAE5G,OAAO,EACL,QAAQ,IAAI,QAAQ,EACpB,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,iBAAiB,IAAI,iBAAiB,EAC3C,KAAK,iBAAiB,IAAI,iBAAiB,GAC5C,CAAC;IAEF,OAAO,EACL,QAAQ,IAAI,QAAQ,EACpB,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,iBAAiB,IAAI,iBAAiB,EAC3C,KAAK,iBAAiB,IAAI,iBAAiB,GAC5C,CAAC;CACH"}
@@ -50,36 +50,44 @@ class Devices extends resource_1.APIResource {
50
50
  this.language = new LanguageAPI.Language(this._client);
51
51
  }
52
52
  /**
53
- * Provision a new device
53
+ * Requests a new device for the authenticated user from the device spec in the
54
+ * request body. Optional query parameters select the canonical device type, target
55
+ * country, billing mode, and a profile to use as the base spec; deprecated
56
+ * device-type aliases remain accepted only during the documented compatibility
57
+ * grace period. The response returns the device and its stream token.
54
58
  */
55
59
  create(params, options) {
56
- const { query_country, deviceType, profileId, ...body } = params;
60
+ const { billing, query_country, deviceType, profileId, ...body } = params;
57
61
  return this._client.post('/devices', {
58
- query: { country: query_country, deviceType, profileId },
62
+ query: { billing, country: query_country, deviceType, profileId },
59
63
  body,
60
64
  ...options,
61
65
  });
62
66
  }
63
67
  /**
64
- * Get device info
68
+ * Returns the current state and metadata for a single device, including its
69
+ * lifecycle state, type, stream URL, billing strategy, and timestamps. A stream
70
+ * token is included while the device is active.
65
71
  */
66
72
  retrieve(deviceID, options) {
67
73
  return this._client.get((0, path_1.path) `/devices/${deviceID}`, options);
68
74
  }
69
75
  /**
70
- * List devices
76
+ * Returns a paginated list of the user's devices along with pagination metadata.
71
77
  */
72
78
  list(query = {}, options) {
73
79
  return this._client.get('/devices', { query, ...options });
74
80
  }
75
81
  /**
76
- * Count claimed devices
82
+ * Returns the number of claimed devices for the user, broken down by device type.
77
83
  */
78
84
  count(options) {
79
85
  return this._client.get('/devices/count', options);
80
86
  }
81
87
  /**
82
- * Device fingerprint snapshot
88
+ * Returns a live snapshot of the device's spoofed identity, including model,
89
+ * display, identifiers, and carrier. Devices without fingerprint support return an
90
+ * unsupported-feature error.
83
91
  */
84
92
  fingerprint(deviceID, params = {}, options) {
85
93
  const { 'X-Device-Display-ID': xDeviceDisplayID } = params ?? {};
@@ -96,7 +104,8 @@ class Devices extends resource_1.APIResource {
96
104
  });
97
105
  }
98
106
  /**
99
- * Reboot a device
107
+ * Triggers a reboot of the device. The device transitions through its reboot
108
+ * lifecycle and becomes ready again once the restart completes.
100
109
  */
101
110
  reboot(deviceID, options) {
102
111
  return this._client.post((0, path_1.path) `/devices/${deviceID}/reboot`, {
@@ -105,7 +114,9 @@ class Devices extends resource_1.APIResource {
105
114
  });
106
115
  }
107
116
  /**
108
- * Reset a device to a fresh state
117
+ * Resets the device back to a clean state, clearing installed apps and user data
118
+ * accumulated during the session. The device transitions through its reset
119
+ * lifecycle before becoming ready again.
109
120
  */
110
121
  reset(deviceID, options) {
111
122
  return this._client.post((0, path_1.path) `/devices/${deviceID}/reset`, {
@@ -114,13 +125,16 @@ class Devices extends resource_1.APIResource {
114
125
  });
115
126
  }
116
127
  /**
117
- * Update device name
128
+ * Sets the display name for a device from the name in the request body and returns
129
+ * the updated device.
118
130
  */
119
131
  setName(deviceID, body, options) {
120
132
  return this._client.put((0, path_1.path) `/devices/${deviceID}/name`, { body, ...options });
121
133
  }
122
134
  /**
123
- * Terminate a device
135
+ * Terminates the device and releases its resources. Termination can be scheduled
136
+ * for a future time or chained from a previous device via the request body, in
137
+ * which case a service key is required.
124
138
  */
125
139
  terminate(deviceID, body, options) {
126
140
  return this._client.delete((0, path_1.path) `/devices/${deviceID}`, {
@@ -130,7 +144,9 @@ class Devices extends resource_1.APIResource {
130
144
  });
131
145
  }
132
146
  /**
133
- * Wait for device to be ready
147
+ * Blocks until the device reaches the ready state, then returns the same payload
148
+ * as Get device info. The call returns early with an error if the wait is
149
+ * cancelled or times out.
134
150
  */
135
151
  waitReady(deviceID, options) {
136
152
  return this._client.get((0, path_1.path) `/devices/${deviceID}/wait`, options);
@@ -1 +1 @@
1
- {"version":3,"file":"devices.js","sourceRoot":"","sources":["../../src/resources/devices/devices.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;;AAEtF,qDAAkD;AAElD,iEAAwC;AACxC,0CAQmB;AACnB,2DAAkC;AAClC,oCAQgB;AAChB,2DAAkC;AAClC,oCAQgB;AAChB,6DAAoC;AACpC,sCASiB;AACjB,mEAA0C;AAC1C,4CAAmG;AACnG,mEAA0C;AAC1C,4CAAiG;AACjG,mEAA0C;AAC1C,4CAA4E;AAC5E,mEAA0C;AAC1C,4CAA8E;AAC9E,iEAAwC;AACxC,0CAAyD;AACzD,6DAAoC;AACpC,sCAMiB;AACjB,6DAAoC;AACpC,sCAUiB;AACjB,6DAAoC;AACpC,sCAAkE;AAClE,mEAA0C;AAC1C,4CAAiG;AAEjG,uDAAsD;AAEtD,uDAAiD;AAEjD,MAAa,OAAQ,SAAQ,sBAAW;IAAxC;;QACE,YAAO,GAAuB,IAAI,UAAU,CAAC,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QACnE,SAAI,GAAiB,IAAI,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QACpD,SAAI,GAAiB,IAAI,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QACpD,UAAK,GAAmB,IAAI,QAAQ,CAAC,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QACzD,aAAQ,GAAyB,IAAI,WAAW,CAAC,QAAQ,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QACxE,aAAQ,GAAyB,IAAI,WAAW,CAAC,QAAQ,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QACxE,aAAQ,GAAyB,IAAI,WAAW,CAAC,QAAQ,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QACxE,YAAO,GAAuB,IAAI,UAAU,CAAC,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QACnE,UAAK,GAAmB,IAAI,QAAQ,CAAC,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QACzD,UAAK,GAAmB,IAAI,QAAQ,CAAC,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QACzD,UAAK,GAAmB,IAAI,QAAQ,CAAC,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QACzD,aAAQ,GAAyB,IAAI,WAAW,CAAC,QAAQ,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QACxE,aAAQ,GAAyB,IAAI,WAAW,CAAC,QAAQ,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IAwG1E,CAAC;IAtGC;;OAEG;IACH,MAAM,CAAC,MAA0B,EAAE,OAAwB;QACzD,MAAM,EAAE,aAAa,EAAE,UAAU,EAAE,SAAS,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,CAAC;QACjE,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,UAAU,EAAE;YACnC,KAAK,EAAE,EAAE,OAAO,EAAE,aAAa,EAAE,UAAU,EAAE,SAAS,EAAE;YACxD,IAAI;YACJ,GAAG,OAAO;SACX,CAAC,CAAC;IACL,CAAC;IAED;;OAEG;IACH,QAAQ,CAAC,QAAgB,EAAE,OAAwB;QACjD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,YAAY,QAAQ,EAAE,EAAE,OAAO,CAAC,CAAC;IAC/D,CAAC;IAED;;OAEG;IACH,IAAI,CACF,QAA6C,EAAE,EAC/C,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,UAAU,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC7D,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,OAAwB;QAC5B,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,gBAAgB,EAAE,OAAO,CAAC,CAAC;IACrD,CAAC;IAED;;OAEG;IACH,WAAW,CACT,QAAgB,EAChB,SAAqD,EAAE,EACvD,OAAwB;QAExB,MAAM,EAAE,qBAAqB,EAAE,gBAAgB,EAAE,GAAG,MAAM,IAAI,EAAE,CAAC;QACjE,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,YAAY,QAAQ,cAAc,EAAE;YAC9D,GAAG,OAAO;YACV,OAAO,EAAE,IAAA,sBAAY,EAAC;gBACpB;oBACE,GAAG,CAAC,gBAAgB,EAAE,QAAQ,EAAE,IAAI,IAAI,CAAC,CAAC;wBACxC,EAAE,qBAAqB,EAAE,gBAAgB,EAAE,QAAQ,EAAE,EAAE;wBACzD,CAAC,CAAC,SAAS,CAAC;iBACb;gBACD,OAAO,EAAE,OAAO;aACjB,CAAC;SACH,CAAC,CAAC;IACL,CAAC;IAED;;OAEG;IACH,MAAM,CAAC,QAAgB,EAAE,OAAwB;QAC/C,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAA,WAAI,EAAA,YAAY,QAAQ,SAAS,EAAE;YAC1D,GAAG,OAAO;YACV,OAAO,EAAE,IAAA,sBAAY,EAAC,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC;SAC7D,CAAC,CAAC;IACL,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,QAAgB,EAAE,OAAwB;QAC9C,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAA,WAAI,EAAA,YAAY,QAAQ,QAAQ,EAAE;YACzD,GAAG,OAAO;YACV,OAAO,EAAE,IAAA,sBAAY,EAAC,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC;SAC7D,CAAC,CAAC;IACL,CAAC;IAED;;OAEG;IACH,OAAO,CAAC,QAAgB,EAAE,IAAyB,EAAE,OAAwB;QAC3E,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,YAAY,QAAQ,OAAO,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACjF,CAAC;IAED;;OAEG;IACH,SAAS,CAAC,QAAgB,EAAE,IAA2B,EAAE,OAAwB;QAC/E,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAA,WAAI,EAAA,YAAY,QAAQ,EAAE,EAAE;YACrD,IAAI;YACJ,GAAG,OAAO;YACV,OAAO,EAAE,IAAA,sBAAY,EAAC,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC;SAC7D,CAAC,CAAC;IACL,CAAC;IAED;;OAEG;IACH,SAAS,CAAC,QAAgB,EAAE,OAAwB;QAClD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,YAAY,QAAQ,OAAO,EAAE,OAAO,CAAC,CAAC;IACpE,CAAC;CACF;AArHD,0BAqHC;AA4ND,OAAO,CAAC,OAAO,GAAG,iBAAO,CAAC;AAC1B,OAAO,CAAC,IAAI,GAAG,WAAI,CAAC;AACpB,OAAO,CAAC,IAAI,GAAG,WAAI,CAAC;AACpB,OAAO,CAAC,KAAK,GAAG,aAAK,CAAC;AACtB,OAAO,CAAC,QAAQ,GAAG,mBAAQ,CAAC;AAC5B,OAAO,CAAC,QAAQ,GAAG,mBAAQ,CAAC;AAC5B,OAAO,CAAC,QAAQ,GAAG,mBAAQ,CAAC;AAC5B,OAAO,CAAC,OAAO,GAAG,iBAAO,CAAC;AAC1B,OAAO,CAAC,KAAK,GAAG,aAAa,CAAC;AAC9B,OAAO,CAAC,KAAK,GAAG,aAAK,CAAC;AACtB,OAAO,CAAC,KAAK,GAAG,aAAK,CAAC;AACtB,OAAO,CAAC,QAAQ,GAAG,mBAAQ,CAAC;AAC5B,OAAO,CAAC,QAAQ,GAAG,mBAAQ,CAAC"}
1
+ {"version":3,"file":"devices.js","sourceRoot":"","sources":["../../src/resources/devices/devices.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;;AAEtF,qDAAkD;AAElD,iEAAwC;AACxC,0CAQmB;AACnB,2DAAkC;AAClC,oCAQgB;AAChB,2DAAkC;AAClC,oCAQgB;AAChB,6DAAoC;AACpC,sCASiB;AACjB,mEAA0C;AAC1C,4CAAmG;AACnG,mEAA0C;AAC1C,4CAAiG;AACjG,mEAA0C;AAC1C,4CAA4E;AAC5E,mEAA0C;AAC1C,4CAA8E;AAC9E,iEAAwC;AACxC,0CAAyD;AACzD,6DAAoC;AACpC,sCAMiB;AACjB,6DAAoC;AACpC,sCAUiB;AACjB,6DAAoC;AACpC,sCAAkE;AAClE,mEAA0C;AAC1C,4CAAiG;AAEjG,uDAAsD;AAEtD,uDAAiD;AAEjD,MAAa,OAAQ,SAAQ,sBAAW;IAAxC;;QACE,YAAO,GAAuB,IAAI,UAAU,CAAC,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QACnE,SAAI,GAAiB,IAAI,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QACpD,SAAI,GAAiB,IAAI,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QACpD,UAAK,GAAmB,IAAI,QAAQ,CAAC,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QACzD,aAAQ,GAAyB,IAAI,WAAW,CAAC,QAAQ,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QACxE,aAAQ,GAAyB,IAAI,WAAW,CAAC,QAAQ,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QACxE,aAAQ,GAAyB,IAAI,WAAW,CAAC,QAAQ,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QACxE,YAAO,GAAuB,IAAI,UAAU,CAAC,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QACnE,UAAK,GAAmB,IAAI,QAAQ,CAAC,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QACzD,UAAK,GAAmB,IAAI,QAAQ,CAAC,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QACzD,UAAK,GAAmB,IAAI,QAAQ,CAAC,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QACzD,aAAQ,GAAyB,IAAI,WAAW,CAAC,QAAQ,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QACxE,aAAQ,GAAyB,IAAI,WAAW,CAAC,QAAQ,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IAwH1E,CAAC;IAtHC;;;;;;OAMG;IACH,MAAM,CAAC,MAA0B,EAAE,OAAwB;QACzD,MAAM,EAAE,OAAO,EAAE,aAAa,EAAE,UAAU,EAAE,SAAS,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,CAAC;QAC1E,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,UAAU,EAAE;YACnC,KAAK,EAAE,EAAE,OAAO,EAAE,OAAO,EAAE,aAAa,EAAE,UAAU,EAAE,SAAS,EAAE;YACjE,IAAI;YACJ,GAAG,OAAO;SACX,CAAC,CAAC;IACL,CAAC;IAED;;;;OAIG;IACH,QAAQ,CAAC,QAAgB,EAAE,OAAwB;QACjD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,YAAY,QAAQ,EAAE,EAAE,OAAO,CAAC,CAAC;IAC/D,CAAC;IAED;;OAEG;IACH,IAAI,CACF,QAA6C,EAAE,EAC/C,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,UAAU,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC7D,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,OAAwB;QAC5B,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,gBAAgB,EAAE,OAAO,CAAC,CAAC;IACrD,CAAC;IAED;;;;OAIG;IACH,WAAW,CACT,QAAgB,EAChB,SAAqD,EAAE,EACvD,OAAwB;QAExB,MAAM,EAAE,qBAAqB,EAAE,gBAAgB,EAAE,GAAG,MAAM,IAAI,EAAE,CAAC;QACjE,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,YAAY,QAAQ,cAAc,EAAE;YAC9D,GAAG,OAAO;YACV,OAAO,EAAE,IAAA,sBAAY,EAAC;gBACpB;oBACE,GAAG,CAAC,gBAAgB,EAAE,QAAQ,EAAE,IAAI,IAAI,CAAC,CAAC;wBACxC,EAAE,qBAAqB,EAAE,gBAAgB,EAAE,QAAQ,EAAE,EAAE;wBACzD,CAAC,CAAC,SAAS,CAAC;iBACb;gBACD,OAAO,EAAE,OAAO;aACjB,CAAC;SACH,CAAC,CAAC;IACL,CAAC;IAED;;;OAGG;IACH,MAAM,CAAC,QAAgB,EAAE,OAAwB;QAC/C,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAA,WAAI,EAAA,YAAY,QAAQ,SAAS,EAAE;YAC1D,GAAG,OAAO;YACV,OAAO,EAAE,IAAA,sBAAY,EAAC,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC;SAC7D,CAAC,CAAC;IACL,CAAC;IAED;;;;OAIG;IACH,KAAK,CAAC,QAAgB,EAAE,OAAwB;QAC9C,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAA,WAAI,EAAA,YAAY,QAAQ,QAAQ,EAAE;YACzD,GAAG,OAAO;YACV,OAAO,EAAE,IAAA,sBAAY,EAAC,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC;SAC7D,CAAC,CAAC;IACL,CAAC;IAED;;;OAGG;IACH,OAAO,CAAC,QAAgB,EAAE,IAAyB,EAAE,OAAwB;QAC3E,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,YAAY,QAAQ,OAAO,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACjF,CAAC;IAED;;;;OAIG;IACH,SAAS,CAAC,QAAgB,EAAE,IAA2B,EAAE,OAAwB;QAC/E,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAA,WAAI,EAAA,YAAY,QAAQ,EAAE,EAAE;YACrD,IAAI;YACJ,GAAG,OAAO;YACV,OAAO,EAAE,IAAA,sBAAY,EAAC,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC;SAC7D,CAAC,CAAC;IACL,CAAC;IAED;;;;OAIG;IACH,SAAS,CAAC,QAAgB,EAAE,OAAwB;QAClD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,YAAY,QAAQ,OAAO,EAAE,OAAO,CAAC,CAAC;IACpE,CAAC;CACF;AArID,0BAqIC;AA8RD,OAAO,CAAC,OAAO,GAAG,iBAAO,CAAC;AAC1B,OAAO,CAAC,IAAI,GAAG,WAAI,CAAC;AACpB,OAAO,CAAC,IAAI,GAAG,WAAI,CAAC;AACpB,OAAO,CAAC,KAAK,GAAG,aAAK,CAAC;AACtB,OAAO,CAAC,QAAQ,GAAG,mBAAQ,CAAC;AAC5B,OAAO,CAAC,QAAQ,GAAG,mBAAQ,CAAC;AAC5B,OAAO,CAAC,QAAQ,GAAG,mBAAQ,CAAC;AAC5B,OAAO,CAAC,OAAO,GAAG,iBAAO,CAAC;AAC1B,OAAO,CAAC,KAAK,GAAG,aAAa,CAAC;AAC9B,OAAO,CAAC,KAAK,GAAG,aAAK,CAAC;AACtB,OAAO,CAAC,KAAK,GAAG,aAAK,CAAC;AACtB,OAAO,CAAC,QAAQ,GAAG,mBAAQ,CAAC;AAC5B,OAAO,CAAC,QAAQ,GAAG,mBAAQ,CAAC"}
@@ -46,36 +46,44 @@ export class Devices extends APIResource {
46
46
  this.language = new LanguageAPI.Language(this._client);
47
47
  }
48
48
  /**
49
- * Provision a new device
49
+ * Requests a new device for the authenticated user from the device spec in the
50
+ * request body. Optional query parameters select the canonical device type, target
51
+ * country, billing mode, and a profile to use as the base spec; deprecated
52
+ * device-type aliases remain accepted only during the documented compatibility
53
+ * grace period. The response returns the device and its stream token.
50
54
  */
51
55
  create(params, options) {
52
- const { query_country, deviceType, profileId, ...body } = params;
56
+ const { billing, query_country, deviceType, profileId, ...body } = params;
53
57
  return this._client.post('/devices', {
54
- query: { country: query_country, deviceType, profileId },
58
+ query: { billing, country: query_country, deviceType, profileId },
55
59
  body,
56
60
  ...options,
57
61
  });
58
62
  }
59
63
  /**
60
- * Get device info
64
+ * Returns the current state and metadata for a single device, including its
65
+ * lifecycle state, type, stream URL, billing strategy, and timestamps. A stream
66
+ * token is included while the device is active.
61
67
  */
62
68
  retrieve(deviceID, options) {
63
69
  return this._client.get(path `/devices/${deviceID}`, options);
64
70
  }
65
71
  /**
66
- * List devices
72
+ * Returns a paginated list of the user's devices along with pagination metadata.
67
73
  */
68
74
  list(query = {}, options) {
69
75
  return this._client.get('/devices', { query, ...options });
70
76
  }
71
77
  /**
72
- * Count claimed devices
78
+ * Returns the number of claimed devices for the user, broken down by device type.
73
79
  */
74
80
  count(options) {
75
81
  return this._client.get('/devices/count', options);
76
82
  }
77
83
  /**
78
- * Device fingerprint snapshot
84
+ * Returns a live snapshot of the device's spoofed identity, including model,
85
+ * display, identifiers, and carrier. Devices without fingerprint support return an
86
+ * unsupported-feature error.
79
87
  */
80
88
  fingerprint(deviceID, params = {}, options) {
81
89
  const { 'X-Device-Display-ID': xDeviceDisplayID } = params ?? {};
@@ -92,7 +100,8 @@ export class Devices extends APIResource {
92
100
  });
93
101
  }
94
102
  /**
95
- * Reboot a device
103
+ * Triggers a reboot of the device. The device transitions through its reboot
104
+ * lifecycle and becomes ready again once the restart completes.
96
105
  */
97
106
  reboot(deviceID, options) {
98
107
  return this._client.post(path `/devices/${deviceID}/reboot`, {
@@ -101,7 +110,9 @@ export class Devices extends APIResource {
101
110
  });
102
111
  }
103
112
  /**
104
- * Reset a device to a fresh state
113
+ * Resets the device back to a clean state, clearing installed apps and user data
114
+ * accumulated during the session. The device transitions through its reset
115
+ * lifecycle before becoming ready again.
105
116
  */
106
117
  reset(deviceID, options) {
107
118
  return this._client.post(path `/devices/${deviceID}/reset`, {
@@ -110,13 +121,16 @@ export class Devices extends APIResource {
110
121
  });
111
122
  }
112
123
  /**
113
- * Update device name
124
+ * Sets the display name for a device from the name in the request body and returns
125
+ * the updated device.
114
126
  */
115
127
  setName(deviceID, body, options) {
116
128
  return this._client.put(path `/devices/${deviceID}/name`, { body, ...options });
117
129
  }
118
130
  /**
119
- * Terminate a device
131
+ * Terminates the device and releases its resources. Termination can be scheduled
132
+ * for a future time or chained from a previous device via the request body, in
133
+ * which case a service key is required.
120
134
  */
121
135
  terminate(deviceID, body, options) {
122
136
  return this._client.delete(path `/devices/${deviceID}`, {
@@ -126,7 +140,9 @@ export class Devices extends APIResource {
126
140
  });
127
141
  }
128
142
  /**
129
- * Wait for device to be ready
143
+ * Blocks until the device reaches the ready state, then returns the same payload
144
+ * as Get device info. The call returns early with an error if the wait is
145
+ * cancelled or times out.
130
146
  */
131
147
  waitReady(deviceID, options) {
132
148
  return this._client.get(path `/devices/${deviceID}/wait`, options);
@@ -1 +1 @@
1
- {"version":3,"file":"devices.mjs","sourceRoot":"","sources":["../../src/resources/devices/devices.ts"],"names":[],"mappings":"AAAA,sFAAsF;AAEtF,OAAO,EAAE,WAAW,EAAE,gCAA4B;AAElD,OAAO,KAAK,UAAU,sBAAkB;AACxC,OAAO,EAOL,OAAO,GACR,sBAAkB;AACnB,OAAO,KAAK,OAAO,mBAAe;AAClC,OAAO,EAOL,IAAI,GACL,mBAAe;AAChB,OAAO,KAAK,OAAO,mBAAe;AAClC,OAAO,EACL,IAAI,GAOL,mBAAe;AAChB,OAAO,KAAK,QAAQ,oBAAgB;AACpC,OAAO,EAQL,KAAK,GACN,oBAAgB;AACjB,OAAO,KAAK,WAAW,uBAAmB;AAC1C,OAAO,EAAE,QAAQ,EAA+D,uBAAmB;AACnG,OAAO,KAAK,WAAW,uBAAmB;AAC1C,OAAO,EAAE,QAAQ,EAA6D,uBAAmB;AACjG,OAAO,KAAK,WAAW,uBAAmB;AAC1C,OAAO,EAAE,QAAQ,EAAwC,uBAAmB;AAC5E,OAAO,KAAK,WAAW,uBAAmB;AAC1C,OAAO,EAA0C,QAAQ,EAAE,uBAAmB;AAC9E,OAAO,KAAK,UAAU,sBAAkB;AACxC,OAAO,EAAE,OAAO,EAAuB,sBAAkB;AACzD,OAAO,KAAK,QAAQ,oBAAgB;AACpC,OAAO,EACL,KAAK,IAAI,aAAa,GAKvB,oBAAgB;AACjB,OAAO,KAAK,QAAQ,oBAAgB;AACpC,OAAO,EAGL,KAAK,GAON,oBAAgB;AACjB,OAAO,KAAK,QAAQ,oBAAgB;AACpC,OAAO,EAAoC,KAAK,EAAE,oBAAgB;AAClE,OAAO,KAAK,WAAW,uBAAmB;AAC1C,OAAO,EAAE,QAAQ,EAA6D,uBAAmB;AAEjG,OAAO,EAAE,YAAY,EAAE,mCAA+B;AAEtD,OAAO,EAAE,IAAI,EAAE,sCAAkC;AAEjD,MAAM,OAAO,OAAQ,SAAQ,WAAW;IAAxC;;QACE,YAAO,GAAuB,IAAI,UAAU,CAAC,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QACnE,SAAI,GAAiB,IAAI,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QACpD,SAAI,GAAiB,IAAI,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QACpD,UAAK,GAAmB,IAAI,QAAQ,CAAC,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QACzD,aAAQ,GAAyB,IAAI,WAAW,CAAC,QAAQ,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QACxE,aAAQ,GAAyB,IAAI,WAAW,CAAC,QAAQ,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QACxE,aAAQ,GAAyB,IAAI,WAAW,CAAC,QAAQ,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QACxE,YAAO,GAAuB,IAAI,UAAU,CAAC,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QACnE,UAAK,GAAmB,IAAI,QAAQ,CAAC,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QACzD,UAAK,GAAmB,IAAI,QAAQ,CAAC,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QACzD,UAAK,GAAmB,IAAI,QAAQ,CAAC,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QACzD,aAAQ,GAAyB,IAAI,WAAW,CAAC,QAAQ,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QACxE,aAAQ,GAAyB,IAAI,WAAW,CAAC,QAAQ,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IAwG1E,CAAC;IAtGC;;OAEG;IACH,MAAM,CAAC,MAA0B,EAAE,OAAwB;QACzD,MAAM,EAAE,aAAa,EAAE,UAAU,EAAE,SAAS,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,CAAC;QACjE,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,UAAU,EAAE;YACnC,KAAK,EAAE,EAAE,OAAO,EAAE,aAAa,EAAE,UAAU,EAAE,SAAS,EAAE;YACxD,IAAI;YACJ,GAAG,OAAO;SACX,CAAC,CAAC;IACL,CAAC;IAED;;OAEG;IACH,QAAQ,CAAC,QAAgB,EAAE,OAAwB;QACjD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,YAAY,QAAQ,EAAE,EAAE,OAAO,CAAC,CAAC;IAC/D,CAAC;IAED;;OAEG;IACH,IAAI,CACF,QAA6C,EAAE,EAC/C,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,UAAU,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC7D,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,OAAwB;QAC5B,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,gBAAgB,EAAE,OAAO,CAAC,CAAC;IACrD,CAAC;IAED;;OAEG;IACH,WAAW,CACT,QAAgB,EAChB,SAAqD,EAAE,EACvD,OAAwB;QAExB,MAAM,EAAE,qBAAqB,EAAE,gBAAgB,EAAE,GAAG,MAAM,IAAI,EAAE,CAAC;QACjE,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,YAAY,QAAQ,cAAc,EAAE;YAC9D,GAAG,OAAO;YACV,OAAO,EAAE,YAAY,CAAC;gBACpB;oBACE,GAAG,CAAC,gBAAgB,EAAE,QAAQ,EAAE,IAAI,IAAI,CAAC,CAAC;wBACxC,EAAE,qBAAqB,EAAE,gBAAgB,EAAE,QAAQ,EAAE,EAAE;wBACzD,CAAC,CAAC,SAAS,CAAC;iBACb;gBACD,OAAO,EAAE,OAAO;aACjB,CAAC;SACH,CAAC,CAAC;IACL,CAAC;IAED;;OAEG;IACH,MAAM,CAAC,QAAgB,EAAE,OAAwB;QAC/C,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAA,YAAY,QAAQ,SAAS,EAAE;YAC1D,GAAG,OAAO;YACV,OAAO,EAAE,YAAY,CAAC,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC;SAC7D,CAAC,CAAC;IACL,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,QAAgB,EAAE,OAAwB;QAC9C,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAA,YAAY,QAAQ,QAAQ,EAAE;YACzD,GAAG,OAAO;YACV,OAAO,EAAE,YAAY,CAAC,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC;SAC7D,CAAC,CAAC;IACL,CAAC;IAED;;OAEG;IACH,OAAO,CAAC,QAAgB,EAAE,IAAyB,EAAE,OAAwB;QAC3E,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,YAAY,QAAQ,OAAO,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACjF,CAAC;IAED;;OAEG;IACH,SAAS,CAAC,QAAgB,EAAE,IAA2B,EAAE,OAAwB;QAC/E,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,CAAA,YAAY,QAAQ,EAAE,EAAE;YACrD,IAAI;YACJ,GAAG,OAAO;YACV,OAAO,EAAE,YAAY,CAAC,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC;SAC7D,CAAC,CAAC;IACL,CAAC;IAED;;OAEG;IACH,SAAS,CAAC,QAAgB,EAAE,OAAwB;QAClD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,YAAY,QAAQ,OAAO,EAAE,OAAO,CAAC,CAAC;IACpE,CAAC;CACF;AA4ND,OAAO,CAAC,OAAO,GAAG,OAAO,CAAC;AAC1B,OAAO,CAAC,IAAI,GAAG,IAAI,CAAC;AACpB,OAAO,CAAC,IAAI,GAAG,IAAI,CAAC;AACpB,OAAO,CAAC,KAAK,GAAG,KAAK,CAAC;AACtB,OAAO,CAAC,QAAQ,GAAG,QAAQ,CAAC;AAC5B,OAAO,CAAC,QAAQ,GAAG,QAAQ,CAAC;AAC5B,OAAO,CAAC,QAAQ,GAAG,QAAQ,CAAC;AAC5B,OAAO,CAAC,OAAO,GAAG,OAAO,CAAC;AAC1B,OAAO,CAAC,KAAK,GAAG,aAAa,CAAC;AAC9B,OAAO,CAAC,KAAK,GAAG,KAAK,CAAC;AACtB,OAAO,CAAC,KAAK,GAAG,KAAK,CAAC;AACtB,OAAO,CAAC,QAAQ,GAAG,QAAQ,CAAC;AAC5B,OAAO,CAAC,QAAQ,GAAG,QAAQ,CAAC"}
1
+ {"version":3,"file":"devices.mjs","sourceRoot":"","sources":["../../src/resources/devices/devices.ts"],"names":[],"mappings":"AAAA,sFAAsF;AAEtF,OAAO,EAAE,WAAW,EAAE,gCAA4B;AAElD,OAAO,KAAK,UAAU,sBAAkB;AACxC,OAAO,EAOL,OAAO,GACR,sBAAkB;AACnB,OAAO,KAAK,OAAO,mBAAe;AAClC,OAAO,EAOL,IAAI,GACL,mBAAe;AAChB,OAAO,KAAK,OAAO,mBAAe;AAClC,OAAO,EACL,IAAI,GAOL,mBAAe;AAChB,OAAO,KAAK,QAAQ,oBAAgB;AACpC,OAAO,EAQL,KAAK,GACN,oBAAgB;AACjB,OAAO,KAAK,WAAW,uBAAmB;AAC1C,OAAO,EAAE,QAAQ,EAA+D,uBAAmB;AACnG,OAAO,KAAK,WAAW,uBAAmB;AAC1C,OAAO,EAAE,QAAQ,EAA6D,uBAAmB;AACjG,OAAO,KAAK,WAAW,uBAAmB;AAC1C,OAAO,EAAE,QAAQ,EAAwC,uBAAmB;AAC5E,OAAO,KAAK,WAAW,uBAAmB;AAC1C,OAAO,EAA0C,QAAQ,EAAE,uBAAmB;AAC9E,OAAO,KAAK,UAAU,sBAAkB;AACxC,OAAO,EAAE,OAAO,EAAuB,sBAAkB;AACzD,OAAO,KAAK,QAAQ,oBAAgB;AACpC,OAAO,EACL,KAAK,IAAI,aAAa,GAKvB,oBAAgB;AACjB,OAAO,KAAK,QAAQ,oBAAgB;AACpC,OAAO,EAGL,KAAK,GAON,oBAAgB;AACjB,OAAO,KAAK,QAAQ,oBAAgB;AACpC,OAAO,EAAoC,KAAK,EAAE,oBAAgB;AAClE,OAAO,KAAK,WAAW,uBAAmB;AAC1C,OAAO,EAAE,QAAQ,EAA6D,uBAAmB;AAEjG,OAAO,EAAE,YAAY,EAAE,mCAA+B;AAEtD,OAAO,EAAE,IAAI,EAAE,sCAAkC;AAEjD,MAAM,OAAO,OAAQ,SAAQ,WAAW;IAAxC;;QACE,YAAO,GAAuB,IAAI,UAAU,CAAC,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QACnE,SAAI,GAAiB,IAAI,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QACpD,SAAI,GAAiB,IAAI,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QACpD,UAAK,GAAmB,IAAI,QAAQ,CAAC,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QACzD,aAAQ,GAAyB,IAAI,WAAW,CAAC,QAAQ,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QACxE,aAAQ,GAAyB,IAAI,WAAW,CAAC,QAAQ,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QACxE,aAAQ,GAAyB,IAAI,WAAW,CAAC,QAAQ,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QACxE,YAAO,GAAuB,IAAI,UAAU,CAAC,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QACnE,UAAK,GAAmB,IAAI,QAAQ,CAAC,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QACzD,UAAK,GAAmB,IAAI,QAAQ,CAAC,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QACzD,UAAK,GAAmB,IAAI,QAAQ,CAAC,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QACzD,aAAQ,GAAyB,IAAI,WAAW,CAAC,QAAQ,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QACxE,aAAQ,GAAyB,IAAI,WAAW,CAAC,QAAQ,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IAwH1E,CAAC;IAtHC;;;;;;OAMG;IACH,MAAM,CAAC,MAA0B,EAAE,OAAwB;QACzD,MAAM,EAAE,OAAO,EAAE,aAAa,EAAE,UAAU,EAAE,SAAS,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,CAAC;QAC1E,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,UAAU,EAAE;YACnC,KAAK,EAAE,EAAE,OAAO,EAAE,OAAO,EAAE,aAAa,EAAE,UAAU,EAAE,SAAS,EAAE;YACjE,IAAI;YACJ,GAAG,OAAO;SACX,CAAC,CAAC;IACL,CAAC;IAED;;;;OAIG;IACH,QAAQ,CAAC,QAAgB,EAAE,OAAwB;QACjD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,YAAY,QAAQ,EAAE,EAAE,OAAO,CAAC,CAAC;IAC/D,CAAC;IAED;;OAEG;IACH,IAAI,CACF,QAA6C,EAAE,EAC/C,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,UAAU,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC7D,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,OAAwB;QAC5B,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,gBAAgB,EAAE,OAAO,CAAC,CAAC;IACrD,CAAC;IAED;;;;OAIG;IACH,WAAW,CACT,QAAgB,EAChB,SAAqD,EAAE,EACvD,OAAwB;QAExB,MAAM,EAAE,qBAAqB,EAAE,gBAAgB,EAAE,GAAG,MAAM,IAAI,EAAE,CAAC;QACjE,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,YAAY,QAAQ,cAAc,EAAE;YAC9D,GAAG,OAAO;YACV,OAAO,EAAE,YAAY,CAAC;gBACpB;oBACE,GAAG,CAAC,gBAAgB,EAAE,QAAQ,EAAE,IAAI,IAAI,CAAC,CAAC;wBACxC,EAAE,qBAAqB,EAAE,gBAAgB,EAAE,QAAQ,EAAE,EAAE;wBACzD,CAAC,CAAC,SAAS,CAAC;iBACb;gBACD,OAAO,EAAE,OAAO;aACjB,CAAC;SACH,CAAC,CAAC;IACL,CAAC;IAED;;;OAGG;IACH,MAAM,CAAC,QAAgB,EAAE,OAAwB;QAC/C,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAA,YAAY,QAAQ,SAAS,EAAE;YAC1D,GAAG,OAAO;YACV,OAAO,EAAE,YAAY,CAAC,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC;SAC7D,CAAC,CAAC;IACL,CAAC;IAED;;;;OAIG;IACH,KAAK,CAAC,QAAgB,EAAE,OAAwB;QAC9C,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAA,YAAY,QAAQ,QAAQ,EAAE;YACzD,GAAG,OAAO;YACV,OAAO,EAAE,YAAY,CAAC,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC;SAC7D,CAAC,CAAC;IACL,CAAC;IAED;;;OAGG;IACH,OAAO,CAAC,QAAgB,EAAE,IAAyB,EAAE,OAAwB;QAC3E,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,YAAY,QAAQ,OAAO,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACjF,CAAC;IAED;;;;OAIG;IACH,SAAS,CAAC,QAAgB,EAAE,IAA2B,EAAE,OAAwB;QAC/E,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,CAAA,YAAY,QAAQ,EAAE,EAAE;YACrD,IAAI;YACJ,GAAG,OAAO;YACV,OAAO,EAAE,YAAY,CAAC,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC;SAC7D,CAAC,CAAC;IACL,CAAC;IAED;;;;OAIG;IACH,SAAS,CAAC,QAAgB,EAAE,OAAwB;QAClD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,YAAY,QAAQ,OAAO,EAAE,OAAO,CAAC,CAAC;IACpE,CAAC;CACF;AA8RD,OAAO,CAAC,OAAO,GAAG,OAAO,CAAC;AAC1B,OAAO,CAAC,IAAI,GAAG,IAAI,CAAC;AACpB,OAAO,CAAC,IAAI,GAAG,IAAI,CAAC;AACpB,OAAO,CAAC,KAAK,GAAG,KAAK,CAAC;AACtB,OAAO,CAAC,QAAQ,GAAG,QAAQ,CAAC;AAC5B,OAAO,CAAC,QAAQ,GAAG,QAAQ,CAAC;AAC5B,OAAO,CAAC,QAAQ,GAAG,QAAQ,CAAC;AAC5B,OAAO,CAAC,OAAO,GAAG,OAAO,CAAC;AAC1B,OAAO,CAAC,KAAK,GAAG,aAAa,CAAC;AAC9B,OAAO,CAAC,KAAK,GAAG,KAAK,CAAC;AACtB,OAAO,CAAC,KAAK,GAAG,KAAK,CAAC;AACtB,OAAO,CAAC,QAAQ,GAAG,QAAQ,CAAC;AAC5B,OAAO,CAAC,QAAQ,GAAG,QAAQ,CAAC"}
@@ -3,19 +3,21 @@ import { APIPromise } from "../../core/api-promise.mjs";
3
3
  import { RequestOptions } from "../../internal/request-options.mjs";
4
4
  export declare class Esim extends APIResource {
5
5
  /**
6
- * List eSIM subscriptions
6
+ * Returns the eSIM subscriptions currently provisioned on the device.
7
7
  */
8
8
  list(deviceID: string, params?: EsimListParams | null | undefined, options?: RequestOptions): APIPromise<EsimListResponse | null>;
9
9
  /**
10
- * Configure eSIM (download profile and/or enable subscription)
10
+ * Download profile and/or enable subscription.
11
11
  */
12
12
  activate(deviceID: string, params: EsimActivateParams, options?: RequestOptions): APIPromise<EsimActivateResponse>;
13
13
  /**
14
- * Enable an eSIM subscription
14
+ * Enables the eSIM subscription identified by the subId in the request body so it
15
+ * becomes the active subscription.
15
16
  */
16
17
  enable(deviceID: string, params: EsimEnableParams, options?: RequestOptions): APIPromise<void>;
17
18
  /**
18
- * Delete eSIM subscription
19
+ * Deletes the eSIM subscription identified by the subId query parameter from the
20
+ * device.
19
21
  */
20
22
  remove(deviceID: string, params: EsimRemoveParams, options?: RequestOptions): APIPromise<void>;
21
23
  }
@@ -1 +1 @@
1
- {"version":3,"file":"esim.d.mts","sourceRoot":"","sources":["../../src/resources/devices/esim.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,gCAA4B;AAClD,OAAO,EAAE,UAAU,EAAE,mCAA+B;AAEpD,OAAO,EAAE,cAAc,EAAE,2CAAuC;AAGhE,qBAAa,IAAK,SAAQ,WAAW;IACnC;;OAEG;IACH,IAAI,CACF,QAAQ,EAAE,MAAM,EAChB,MAAM,GAAE,cAAc,GAAG,IAAI,GAAG,SAAc,EAC9C,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,gBAAgB,GAAG,IAAI,CAAC;IAetC;;OAEG;IACH,QAAQ,CACN,QAAQ,EAAE,MAAM,EAChB,MAAM,EAAE,kBAAkB,EAC1B,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,oBAAoB,CAAC;IAgBnC;;OAEG;IACH,MAAM,CAAC,QAAQ,EAAE,MAAM,EAAE,MAAM,EAAE,gBAAgB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,IAAI,CAAC;IAiB9F;;OAEG;IACH,MAAM,CAAC,QAAQ,EAAE,MAAM,EAAE,MAAM,EAAE,gBAAgB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,IAAI,CAAC;CAgB/F;AAED,MAAM,MAAM,gBAAgB,GAAG,KAAK,CAAC,gBAAgB,CAAC,oBAAoB,CAAC,CAAC;AAE5E,yBAAiB,gBAAgB,CAAC;IAChC,UAAiB,oBAAoB;QACnC,OAAO,EAAE,MAAM,CAAC;QAEhB,WAAW,EAAE,MAAM,CAAC;QAEpB,KAAK,EAAE,MAAM,CAAC;QAEd,UAAU,EAAE,OAAO,CAAC;QAEpB,IAAI,EAAE,MAAM,CAAC;QAEb,KAAK,EAAE,MAAM,CAAC;QAEd,IAAI,EAAE,MAAM,CAAC;QAEb;;WAEG;QACH,OAAO,CAAC,EAAE,MAAM,CAAC;KAClB;CACF;AAED,MAAM,WAAW,oBAAoB;IACnC,OAAO,EAAE,MAAM,CAAC;IAEhB,WAAW,EAAE,MAAM,CAAC;IAEpB,KAAK,EAAE,MAAM,CAAC;IAEd,UAAU,EAAE,OAAO,CAAC;IAEpB,IAAI,EAAE,MAAM,CAAC;IAEb,KAAK,EAAE,MAAM,CAAC;IAEd,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB;AAED,MAAM,WAAW,cAAc;IAC7B,qBAAqB,CAAC,EAAE,MAAM,CAAC;CAChC;AAED,MAAM,WAAW,kBAAkB;IACjC;;OAEG;IACH,MAAM,EAAE,OAAO,CAAC;IAEhB;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;;;OAIG;IACH,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAE1B;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,qBAAqB,CAAC,EAAE,MAAM,CAAC;CAChC;AAED,MAAM,WAAW,gBAAgB;IAC/B;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,qBAAqB,CAAC,EAAE,MAAM,CAAC;CAChC;AAED,MAAM,WAAW,gBAAgB;IAC/B;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,qBAAqB,CAAC,EAAE,MAAM,CAAC;CAChC;AAED,MAAM,CAAC,OAAO,WAAW,IAAI,CAAC;IAC5B,OAAO,EACL,KAAK,gBAAgB,IAAI,gBAAgB,EACzC,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,cAAc,IAAI,cAAc,EACrC,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,gBAAgB,IAAI,gBAAgB,EACzC,KAAK,gBAAgB,IAAI,gBAAgB,GAC1C,CAAC;CACH"}
1
+ {"version":3,"file":"esim.d.mts","sourceRoot":"","sources":["../../src/resources/devices/esim.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,gCAA4B;AAClD,OAAO,EAAE,UAAU,EAAE,mCAA+B;AAEpD,OAAO,EAAE,cAAc,EAAE,2CAAuC;AAGhE,qBAAa,IAAK,SAAQ,WAAW;IACnC;;OAEG;IACH,IAAI,CACF,QAAQ,EAAE,MAAM,EAChB,MAAM,GAAE,cAAc,GAAG,IAAI,GAAG,SAAc,EAC9C,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,gBAAgB,GAAG,IAAI,CAAC;IAetC;;OAEG;IACH,QAAQ,CACN,QAAQ,EAAE,MAAM,EAChB,MAAM,EAAE,kBAAkB,EAC1B,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,oBAAoB,CAAC;IAgBnC;;;OAGG;IACH,MAAM,CAAC,QAAQ,EAAE,MAAM,EAAE,MAAM,EAAE,gBAAgB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,IAAI,CAAC;IAiB9F;;;OAGG;IACH,MAAM,CAAC,QAAQ,EAAE,MAAM,EAAE,MAAM,EAAE,gBAAgB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,IAAI,CAAC;CAgB/F;AAED,MAAM,MAAM,gBAAgB,GAAG,KAAK,CAAC,gBAAgB,CAAC,oBAAoB,CAAC,CAAC;AAE5E,yBAAiB,gBAAgB,CAAC;IAChC,UAAiB,oBAAoB;QACnC,OAAO,EAAE,MAAM,CAAC;QAEhB,WAAW,EAAE,MAAM,CAAC;QAEpB,KAAK,EAAE,MAAM,CAAC;QAEd,UAAU,EAAE,OAAO,CAAC;QAEpB,IAAI,EAAE,MAAM,CAAC;QAEb,KAAK,EAAE,MAAM,CAAC;QAEd,IAAI,EAAE,MAAM,CAAC;QAEb;;WAEG;QACH,OAAO,CAAC,EAAE,MAAM,CAAC;KAClB;CACF;AAED,MAAM,WAAW,oBAAoB;IACnC,OAAO,EAAE,MAAM,CAAC;IAEhB,WAAW,EAAE,MAAM,CAAC;IAEpB,KAAK,EAAE,MAAM,CAAC;IAEd,UAAU,EAAE,OAAO,CAAC;IAEpB,IAAI,EAAE,MAAM,CAAC;IAEb,KAAK,EAAE,MAAM,CAAC;IAEd,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB;AAED,MAAM,WAAW,cAAc;IAC7B,qBAAqB,CAAC,EAAE,MAAM,CAAC;CAChC;AAED,MAAM,WAAW,kBAAkB;IACjC;;OAEG;IACH,MAAM,EAAE,OAAO,CAAC;IAEhB;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;;;OAIG;IACH,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAE1B;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,qBAAqB,CAAC,EAAE,MAAM,CAAC;CAChC;AAED,MAAM,WAAW,gBAAgB;IAC/B;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,qBAAqB,CAAC,EAAE,MAAM,CAAC;CAChC;AAED,MAAM,WAAW,gBAAgB;IAC/B;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,qBAAqB,CAAC,EAAE,MAAM,CAAC;CAChC;AAED,MAAM,CAAC,OAAO,WAAW,IAAI,CAAC;IAC5B,OAAO,EACL,KAAK,gBAAgB,IAAI,gBAAgB,EACzC,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,cAAc,IAAI,cAAc,EACrC,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,gBAAgB,IAAI,gBAAgB,EACzC,KAAK,gBAAgB,IAAI,gBAAgB,GAC1C,CAAC;CACH"}
@@ -3,19 +3,21 @@ import { APIPromise } from "../../core/api-promise.js";
3
3
  import { RequestOptions } from "../../internal/request-options.js";
4
4
  export declare class Esim extends APIResource {
5
5
  /**
6
- * List eSIM subscriptions
6
+ * Returns the eSIM subscriptions currently provisioned on the device.
7
7
  */
8
8
  list(deviceID: string, params?: EsimListParams | null | undefined, options?: RequestOptions): APIPromise<EsimListResponse | null>;
9
9
  /**
10
- * Configure eSIM (download profile and/or enable subscription)
10
+ * Download profile and/or enable subscription.
11
11
  */
12
12
  activate(deviceID: string, params: EsimActivateParams, options?: RequestOptions): APIPromise<EsimActivateResponse>;
13
13
  /**
14
- * Enable an eSIM subscription
14
+ * Enables the eSIM subscription identified by the subId in the request body so it
15
+ * becomes the active subscription.
15
16
  */
16
17
  enable(deviceID: string, params: EsimEnableParams, options?: RequestOptions): APIPromise<void>;
17
18
  /**
18
- * Delete eSIM subscription
19
+ * Deletes the eSIM subscription identified by the subId query parameter from the
20
+ * device.
19
21
  */
20
22
  remove(deviceID: string, params: EsimRemoveParams, options?: RequestOptions): APIPromise<void>;
21
23
  }
@@ -1 +1 @@
1
- {"version":3,"file":"esim.d.ts","sourceRoot":"","sources":["../../src/resources/devices/esim.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,+BAA4B;AAClD,OAAO,EAAE,UAAU,EAAE,kCAA+B;AAEpD,OAAO,EAAE,cAAc,EAAE,0CAAuC;AAGhE,qBAAa,IAAK,SAAQ,WAAW;IACnC;;OAEG;IACH,IAAI,CACF,QAAQ,EAAE,MAAM,EAChB,MAAM,GAAE,cAAc,GAAG,IAAI,GAAG,SAAc,EAC9C,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,gBAAgB,GAAG,IAAI,CAAC;IAetC;;OAEG;IACH,QAAQ,CACN,QAAQ,EAAE,MAAM,EAChB,MAAM,EAAE,kBAAkB,EAC1B,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,oBAAoB,CAAC;IAgBnC;;OAEG;IACH,MAAM,CAAC,QAAQ,EAAE,MAAM,EAAE,MAAM,EAAE,gBAAgB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,IAAI,CAAC;IAiB9F;;OAEG;IACH,MAAM,CAAC,QAAQ,EAAE,MAAM,EAAE,MAAM,EAAE,gBAAgB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,IAAI,CAAC;CAgB/F;AAED,MAAM,MAAM,gBAAgB,GAAG,KAAK,CAAC,gBAAgB,CAAC,oBAAoB,CAAC,CAAC;AAE5E,yBAAiB,gBAAgB,CAAC;IAChC,UAAiB,oBAAoB;QACnC,OAAO,EAAE,MAAM,CAAC;QAEhB,WAAW,EAAE,MAAM,CAAC;QAEpB,KAAK,EAAE,MAAM,CAAC;QAEd,UAAU,EAAE,OAAO,CAAC;QAEpB,IAAI,EAAE,MAAM,CAAC;QAEb,KAAK,EAAE,MAAM,CAAC;QAEd,IAAI,EAAE,MAAM,CAAC;QAEb;;WAEG;QACH,OAAO,CAAC,EAAE,MAAM,CAAC;KAClB;CACF;AAED,MAAM,WAAW,oBAAoB;IACnC,OAAO,EAAE,MAAM,CAAC;IAEhB,WAAW,EAAE,MAAM,CAAC;IAEpB,KAAK,EAAE,MAAM,CAAC;IAEd,UAAU,EAAE,OAAO,CAAC;IAEpB,IAAI,EAAE,MAAM,CAAC;IAEb,KAAK,EAAE,MAAM,CAAC;IAEd,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB;AAED,MAAM,WAAW,cAAc;IAC7B,qBAAqB,CAAC,EAAE,MAAM,CAAC;CAChC;AAED,MAAM,WAAW,kBAAkB;IACjC;;OAEG;IACH,MAAM,EAAE,OAAO,CAAC;IAEhB;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;;;OAIG;IACH,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAE1B;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,qBAAqB,CAAC,EAAE,MAAM,CAAC;CAChC;AAED,MAAM,WAAW,gBAAgB;IAC/B;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,qBAAqB,CAAC,EAAE,MAAM,CAAC;CAChC;AAED,MAAM,WAAW,gBAAgB;IAC/B;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,qBAAqB,CAAC,EAAE,MAAM,CAAC;CAChC;AAED,MAAM,CAAC,OAAO,WAAW,IAAI,CAAC;IAC5B,OAAO,EACL,KAAK,gBAAgB,IAAI,gBAAgB,EACzC,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,cAAc,IAAI,cAAc,EACrC,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,gBAAgB,IAAI,gBAAgB,EACzC,KAAK,gBAAgB,IAAI,gBAAgB,GAC1C,CAAC;CACH"}
1
+ {"version":3,"file":"esim.d.ts","sourceRoot":"","sources":["../../src/resources/devices/esim.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,+BAA4B;AAClD,OAAO,EAAE,UAAU,EAAE,kCAA+B;AAEpD,OAAO,EAAE,cAAc,EAAE,0CAAuC;AAGhE,qBAAa,IAAK,SAAQ,WAAW;IACnC;;OAEG;IACH,IAAI,CACF,QAAQ,EAAE,MAAM,EAChB,MAAM,GAAE,cAAc,GAAG,IAAI,GAAG,SAAc,EAC9C,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,gBAAgB,GAAG,IAAI,CAAC;IAetC;;OAEG;IACH,QAAQ,CACN,QAAQ,EAAE,MAAM,EAChB,MAAM,EAAE,kBAAkB,EAC1B,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,oBAAoB,CAAC;IAgBnC;;;OAGG;IACH,MAAM,CAAC,QAAQ,EAAE,MAAM,EAAE,MAAM,EAAE,gBAAgB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,IAAI,CAAC;IAiB9F;;;OAGG;IACH,MAAM,CAAC,QAAQ,EAAE,MAAM,EAAE,MAAM,EAAE,gBAAgB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,IAAI,CAAC;CAgB/F;AAED,MAAM,MAAM,gBAAgB,GAAG,KAAK,CAAC,gBAAgB,CAAC,oBAAoB,CAAC,CAAC;AAE5E,yBAAiB,gBAAgB,CAAC;IAChC,UAAiB,oBAAoB;QACnC,OAAO,EAAE,MAAM,CAAC;QAEhB,WAAW,EAAE,MAAM,CAAC;QAEpB,KAAK,EAAE,MAAM,CAAC;QAEd,UAAU,EAAE,OAAO,CAAC;QAEpB,IAAI,EAAE,MAAM,CAAC;QAEb,KAAK,EAAE,MAAM,CAAC;QAEd,IAAI,EAAE,MAAM,CAAC;QAEb;;WAEG;QACH,OAAO,CAAC,EAAE,MAAM,CAAC;KAClB;CACF;AAED,MAAM,WAAW,oBAAoB;IACnC,OAAO,EAAE,MAAM,CAAC;IAEhB,WAAW,EAAE,MAAM,CAAC;IAEpB,KAAK,EAAE,MAAM,CAAC;IAEd,UAAU,EAAE,OAAO,CAAC;IAEpB,IAAI,EAAE,MAAM,CAAC;IAEb,KAAK,EAAE,MAAM,CAAC;IAEd,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB;AAED,MAAM,WAAW,cAAc;IAC7B,qBAAqB,CAAC,EAAE,MAAM,CAAC;CAChC;AAED,MAAM,WAAW,kBAAkB;IACjC;;OAEG;IACH,MAAM,EAAE,OAAO,CAAC;IAEhB;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;;;OAIG;IACH,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAE1B;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,qBAAqB,CAAC,EAAE,MAAM,CAAC;CAChC;AAED,MAAM,WAAW,gBAAgB;IAC/B;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,qBAAqB,CAAC,EAAE,MAAM,CAAC;CAChC;AAED,MAAM,WAAW,gBAAgB;IAC/B;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,qBAAqB,CAAC,EAAE,MAAM,CAAC;CAChC;AAED,MAAM,CAAC,OAAO,WAAW,IAAI,CAAC;IAC5B,OAAO,EACL,KAAK,gBAAgB,IAAI,gBAAgB,EACzC,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,cAAc,IAAI,cAAc,EACrC,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,gBAAgB,IAAI,gBAAgB,EACzC,KAAK,gBAAgB,IAAI,gBAAgB,GAC1C,CAAC;CACH"}
@@ -7,7 +7,7 @@ const headers_1 = require("../../internal/headers.js");
7
7
  const path_1 = require("../../internal/utils/path.js");
8
8
  class Esim extends resource_1.APIResource {
9
9
  /**
10
- * List eSIM subscriptions
10
+ * Returns the eSIM subscriptions currently provisioned on the device.
11
11
  */
12
12
  list(deviceID, params = {}, options) {
13
13
  const { 'X-Device-Display-ID': xDeviceDisplayID } = params ?? {};
@@ -24,7 +24,7 @@ class Esim extends resource_1.APIResource {
24
24
  });
25
25
  }
26
26
  /**
27
- * Configure eSIM (download profile and/or enable subscription)
27
+ * Download profile and/or enable subscription.
28
28
  */
29
29
  activate(deviceID, params, options) {
30
30
  const { 'X-Device-Display-ID': xDeviceDisplayID, ...body } = params;
@@ -42,7 +42,8 @@ class Esim extends resource_1.APIResource {
42
42
  });
43
43
  }
44
44
  /**
45
- * Enable an eSIM subscription
45
+ * Enables the eSIM subscription identified by the subId in the request body so it
46
+ * becomes the active subscription.
46
47
  */
47
48
  enable(deviceID, params, options) {
48
49
  const { 'X-Device-Display-ID': xDeviceDisplayID, ...body } = params;
@@ -61,7 +62,8 @@ class Esim extends resource_1.APIResource {
61
62
  });
62
63
  }
63
64
  /**
64
- * Delete eSIM subscription
65
+ * Deletes the eSIM subscription identified by the subId query parameter from the
66
+ * device.
65
67
  */
66
68
  remove(deviceID, params, options) {
67
69
  const { subId, 'X-Device-Display-ID': xDeviceDisplayID } = params;
@@ -1 +1 @@
1
- {"version":3,"file":"esim.js","sourceRoot":"","sources":["../../src/resources/devices/esim.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,qDAAkD;AAElD,uDAAsD;AAEtD,uDAAiD;AAEjD,MAAa,IAAK,SAAQ,sBAAW;IACnC;;OAEG;IACH,IAAI,CACF,QAAgB,EAChB,SAA4C,EAAE,EAC9C,OAAwB;QAExB,MAAM,EAAE,qBAAqB,EAAE,gBAAgB,EAAE,GAAG,MAAM,IAAI,EAAE,CAAC;QACjE,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,YAAY,QAAQ,OAAO,EAAE;YACvD,GAAG,OAAO;YACV,OAAO,EAAE,IAAA,sBAAY,EAAC;gBACpB;oBACE,GAAG,CAAC,gBAAgB,EAAE,QAAQ,EAAE,IAAI,IAAI,CAAC,CAAC;wBACxC,EAAE,qBAAqB,EAAE,gBAAgB,EAAE,QAAQ,EAAE,EAAE;wBACzD,CAAC,CAAC,SAAS,CAAC;iBACb;gBACD,OAAO,EAAE,OAAO;aACjB,CAAC;SACH,CAAC,CAAC;IACL,CAAC;IAED;;OAEG;IACH,QAAQ,CACN,QAAgB,EAChB,MAA0B,EAC1B,OAAwB;QAExB,MAAM,EAAE,qBAAqB,EAAE,gBAAgB,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,CAAC;QACpE,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAA,WAAI,EAAA,YAAY,QAAQ,OAAO,EAAE;YACxD,IAAI;YACJ,GAAG,OAAO;YACV,OAAO,EAAE,IAAA,sBAAY,EAAC;gBACpB;oBACE,GAAG,CAAC,gBAAgB,EAAE,QAAQ,EAAE,IAAI,IAAI,CAAC,CAAC;wBACxC,EAAE,qBAAqB,EAAE,gBAAgB,EAAE,QAAQ,EAAE,EAAE;wBACzD,CAAC,CAAC,SAAS,CAAC;iBACb;gBACD,OAAO,EAAE,OAAO;aACjB,CAAC;SACH,CAAC,CAAC;IACL,CAAC;IAED;;OAEG;IACH,MAAM,CAAC,QAAgB,EAAE,MAAwB,EAAE,OAAwB;QACzE,MAAM,EAAE,qBAAqB,EAAE,gBAAgB,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,CAAC;QACpE,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,YAAY,QAAQ,OAAO,EAAE;YACvD,IAAI;YACJ,GAAG,OAAO;YACV,OAAO,EAAE,IAAA,sBAAY,EAAC;gBACpB;oBACE,MAAM,EAAE,KAAK;oBACb,GAAG,CAAC,gBAAgB,EAAE,QAAQ,EAAE,IAAI,IAAI,CAAC,CAAC;wBACxC,EAAE,qBAAqB,EAAE,gBAAgB,EAAE,QAAQ,EAAE,EAAE;wBACzD,CAAC,CAAC,SAAS,CAAC;iBACb;gBACD,OAAO,EAAE,OAAO;aACjB,CAAC;SACH,CAAC,CAAC;IACL,CAAC;IAED;;OAEG;IACH,MAAM,CAAC,QAAgB,EAAE,MAAwB,EAAE,OAAwB;QACzE,MAAM,EAAE,KAAK,EAAE,qBAAqB,EAAE,gBAAgB,EAAE,GAAG,MAAM,CAAC;QAClE,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAA,WAAI,EAAA,YAAY,QAAQ,OAAO,EAAE;YAC1D,KAAK,EAAE,EAAE,KAAK,EAAE;YAChB,GAAG,OAAO;YACV,OAAO,EAAE,IAAA,sBAAY,EAAC;gBACpB;oBACE,MAAM,EAAE,KAAK;oBACb,GAAG,CAAC,gBAAgB,EAAE,QAAQ,EAAE,IAAI,IAAI,CAAC,CAAC;wBACxC,EAAE,qBAAqB,EAAE,gBAAgB,EAAE,QAAQ,EAAE,EAAE;wBACzD,CAAC,CAAC,SAAS,CAAC;iBACb;gBACD,OAAO,EAAE,OAAO;aACjB,CAAC;SACH,CAAC,CAAC;IACL,CAAC;CACF;AArFD,oBAqFC"}
1
+ {"version":3,"file":"esim.js","sourceRoot":"","sources":["../../src/resources/devices/esim.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,qDAAkD;AAElD,uDAAsD;AAEtD,uDAAiD;AAEjD,MAAa,IAAK,SAAQ,sBAAW;IACnC;;OAEG;IACH,IAAI,CACF,QAAgB,EAChB,SAA4C,EAAE,EAC9C,OAAwB;QAExB,MAAM,EAAE,qBAAqB,EAAE,gBAAgB,EAAE,GAAG,MAAM,IAAI,EAAE,CAAC;QACjE,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,YAAY,QAAQ,OAAO,EAAE;YACvD,GAAG,OAAO;YACV,OAAO,EAAE,IAAA,sBAAY,EAAC;gBACpB;oBACE,GAAG,CAAC,gBAAgB,EAAE,QAAQ,EAAE,IAAI,IAAI,CAAC,CAAC;wBACxC,EAAE,qBAAqB,EAAE,gBAAgB,EAAE,QAAQ,EAAE,EAAE;wBACzD,CAAC,CAAC,SAAS,CAAC;iBACb;gBACD,OAAO,EAAE,OAAO;aACjB,CAAC;SACH,CAAC,CAAC;IACL,CAAC;IAED;;OAEG;IACH,QAAQ,CACN,QAAgB,EAChB,MAA0B,EAC1B,OAAwB;QAExB,MAAM,EAAE,qBAAqB,EAAE,gBAAgB,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,CAAC;QACpE,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAA,WAAI,EAAA,YAAY,QAAQ,OAAO,EAAE;YACxD,IAAI;YACJ,GAAG,OAAO;YACV,OAAO,EAAE,IAAA,sBAAY,EAAC;gBACpB;oBACE,GAAG,CAAC,gBAAgB,EAAE,QAAQ,EAAE,IAAI,IAAI,CAAC,CAAC;wBACxC,EAAE,qBAAqB,EAAE,gBAAgB,EAAE,QAAQ,EAAE,EAAE;wBACzD,CAAC,CAAC,SAAS,CAAC;iBACb;gBACD,OAAO,EAAE,OAAO;aACjB,CAAC;SACH,CAAC,CAAC;IACL,CAAC;IAED;;;OAGG;IACH,MAAM,CAAC,QAAgB,EAAE,MAAwB,EAAE,OAAwB;QACzE,MAAM,EAAE,qBAAqB,EAAE,gBAAgB,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,CAAC;QACpE,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,YAAY,QAAQ,OAAO,EAAE;YACvD,IAAI;YACJ,GAAG,OAAO;YACV,OAAO,EAAE,IAAA,sBAAY,EAAC;gBACpB;oBACE,MAAM,EAAE,KAAK;oBACb,GAAG,CAAC,gBAAgB,EAAE,QAAQ,EAAE,IAAI,IAAI,CAAC,CAAC;wBACxC,EAAE,qBAAqB,EAAE,gBAAgB,EAAE,QAAQ,EAAE,EAAE;wBACzD,CAAC,CAAC,SAAS,CAAC;iBACb;gBACD,OAAO,EAAE,OAAO;aACjB,CAAC;SACH,CAAC,CAAC;IACL,CAAC;IAED;;;OAGG;IACH,MAAM,CAAC,QAAgB,EAAE,MAAwB,EAAE,OAAwB;QACzE,MAAM,EAAE,KAAK,EAAE,qBAAqB,EAAE,gBAAgB,EAAE,GAAG,MAAM,CAAC;QAClE,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAA,WAAI,EAAA,YAAY,QAAQ,OAAO,EAAE;YAC1D,KAAK,EAAE,EAAE,KAAK,EAAE;YAChB,GAAG,OAAO;YACV,OAAO,EAAE,IAAA,sBAAY,EAAC;gBACpB;oBACE,MAAM,EAAE,KAAK;oBACb,GAAG,CAAC,gBAAgB,EAAE,QAAQ,EAAE,IAAI,IAAI,CAAC,CAAC;wBACxC,EAAE,qBAAqB,EAAE,gBAAgB,EAAE,QAAQ,EAAE,EAAE;wBACzD,CAAC,CAAC,SAAS,CAAC;iBACb;gBACD,OAAO,EAAE,OAAO;aACjB,CAAC;SACH,CAAC,CAAC;IACL,CAAC;CACF;AAvFD,oBAuFC"}
@@ -4,7 +4,7 @@ import { buildHeaders } from "../../internal/headers.mjs";
4
4
  import { path } from "../../internal/utils/path.mjs";
5
5
  export class Esim extends APIResource {
6
6
  /**
7
- * List eSIM subscriptions
7
+ * Returns the eSIM subscriptions currently provisioned on the device.
8
8
  */
9
9
  list(deviceID, params = {}, options) {
10
10
  const { 'X-Device-Display-ID': xDeviceDisplayID } = params ?? {};
@@ -21,7 +21,7 @@ export class Esim extends APIResource {
21
21
  });
22
22
  }
23
23
  /**
24
- * Configure eSIM (download profile and/or enable subscription)
24
+ * Download profile and/or enable subscription.
25
25
  */
26
26
  activate(deviceID, params, options) {
27
27
  const { 'X-Device-Display-ID': xDeviceDisplayID, ...body } = params;
@@ -39,7 +39,8 @@ export class Esim extends APIResource {
39
39
  });
40
40
  }
41
41
  /**
42
- * Enable an eSIM subscription
42
+ * Enables the eSIM subscription identified by the subId in the request body so it
43
+ * becomes the active subscription.
43
44
  */
44
45
  enable(deviceID, params, options) {
45
46
  const { 'X-Device-Display-ID': xDeviceDisplayID, ...body } = params;
@@ -58,7 +59,8 @@ export class Esim extends APIResource {
58
59
  });
59
60
  }
60
61
  /**
61
- * Delete eSIM subscription
62
+ * Deletes the eSIM subscription identified by the subId query parameter from the
63
+ * device.
62
64
  */
63
65
  remove(deviceID, params, options) {
64
66
  const { subId, 'X-Device-Display-ID': xDeviceDisplayID } = params;