@nirvana-labs/nirvana 1.0.4 → 1.1.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 (254) hide show
  1. package/CHANGELOG.md +27 -0
  2. package/README.md +1 -1
  3. package/api-promise.js +2 -15
  4. package/api-promise.js.map +1 -1
  5. package/bin/cli +52 -0
  6. package/bin/migration-config.json +110 -0
  7. package/client.d.mts +4 -1
  8. package/client.d.mts.map +1 -1
  9. package/client.d.ts +4 -1
  10. package/client.d.ts.map +1 -1
  11. package/client.js +25 -42
  12. package/client.js.map +1 -1
  13. package/client.mjs +18 -12
  14. package/client.mjs.map +1 -1
  15. package/core/api-promise.d.mts +0 -1
  16. package/core/api-promise.d.mts.map +1 -1
  17. package/core/api-promise.d.ts +0 -1
  18. package/core/api-promise.d.ts.map +1 -1
  19. package/core/api-promise.js +4 -14
  20. package/core/api-promise.js.map +1 -1
  21. package/core/api-promise.mjs +1 -11
  22. package/core/api-promise.mjs.map +1 -1
  23. package/core/error.d.mts +0 -1
  24. package/core/error.d.mts.map +1 -1
  25. package/core/error.d.ts +0 -1
  26. package/core/error.d.ts.map +1 -1
  27. package/core/error.js.map +1 -1
  28. package/core/error.mjs.map +1 -1
  29. package/error.js +2 -15
  30. package/error.js.map +1 -1
  31. package/internal/builtin-types.d.mts +0 -2
  32. package/internal/builtin-types.d.mts.map +1 -1
  33. package/internal/builtin-types.d.ts +0 -2
  34. package/internal/builtin-types.d.ts.map +1 -1
  35. package/internal/detect-platform.js.map +1 -1
  36. package/internal/detect-platform.mjs.map +1 -1
  37. package/internal/errors.d.mts.map +1 -1
  38. package/internal/errors.d.ts.map +1 -1
  39. package/internal/errors.js +2 -2
  40. package/internal/errors.js.map +1 -1
  41. package/internal/errors.mjs.map +1 -1
  42. package/internal/headers.d.mts +0 -1
  43. package/internal/headers.d.mts.map +1 -1
  44. package/internal/headers.d.ts +0 -1
  45. package/internal/headers.d.ts.map +1 -1
  46. package/internal/headers.js.map +1 -1
  47. package/internal/headers.mjs.map +1 -1
  48. package/internal/parse.d.mts +0 -1
  49. package/internal/parse.d.mts.map +1 -1
  50. package/internal/parse.d.ts +0 -1
  51. package/internal/parse.d.ts.map +1 -1
  52. package/internal/parse.js +1 -2
  53. package/internal/parse.js.map +1 -1
  54. package/internal/parse.mjs.map +1 -1
  55. package/internal/request-options.d.mts +0 -1
  56. package/internal/request-options.d.mts.map +1 -1
  57. package/internal/request-options.d.ts +0 -1
  58. package/internal/request-options.d.ts.map +1 -1
  59. package/internal/shims.js +5 -6
  60. package/internal/shims.js.map +1 -1
  61. package/internal/shims.mjs.map +1 -1
  62. package/internal/to-file.d.mts +0 -1
  63. package/internal/to-file.d.mts.map +1 -1
  64. package/internal/to-file.d.ts +0 -1
  65. package/internal/to-file.d.ts.map +1 -1
  66. package/internal/to-file.js +4 -4
  67. package/internal/to-file.js.map +1 -1
  68. package/internal/to-file.mjs +3 -2
  69. package/internal/to-file.mjs.map +1 -1
  70. package/internal/tslib.js +81 -0
  71. package/internal/tslib.mjs +17 -0
  72. package/internal/types.d.mts +0 -1
  73. package/internal/types.d.mts.map +1 -1
  74. package/internal/types.d.ts +0 -1
  75. package/internal/types.d.ts.map +1 -1
  76. package/internal/uploads.d.mts +1 -3
  77. package/internal/uploads.d.mts.map +1 -1
  78. package/internal/uploads.d.ts +1 -3
  79. package/internal/uploads.d.ts.map +1 -1
  80. package/internal/uploads.js +16 -6
  81. package/internal/uploads.js.map +1 -1
  82. package/internal/uploads.mjs +12 -3
  83. package/internal/uploads.mjs.map +1 -1
  84. package/internal/utils/base64.d.mts.map +1 -1
  85. package/internal/utils/base64.d.ts.map +1 -1
  86. package/internal/utils/base64.js.map +1 -1
  87. package/internal/utils/base64.mjs.map +1 -1
  88. package/internal/utils/bytes.d.mts +1 -1
  89. package/internal/utils/bytes.d.mts.map +1 -1
  90. package/internal/utils/bytes.d.ts +1 -1
  91. package/internal/utils/bytes.d.ts.map +1 -1
  92. package/internal/utils/bytes.js +3 -4
  93. package/internal/utils/bytes.js.map +1 -1
  94. package/internal/utils/bytes.mjs.map +1 -1
  95. package/internal/utils/env.d.mts.map +1 -1
  96. package/internal/utils/env.d.ts.map +1 -1
  97. package/internal/utils/env.js.map +1 -1
  98. package/internal/utils/env.mjs.map +1 -1
  99. package/internal/utils/log.d.mts +0 -1
  100. package/internal/utils/log.d.mts.map +1 -1
  101. package/internal/utils/log.d.ts +0 -1
  102. package/internal/utils/log.d.ts.map +1 -1
  103. package/internal/utils/log.js +2 -2
  104. package/internal/utils/log.js.map +1 -1
  105. package/internal/utils/log.mjs.map +1 -1
  106. package/internal/utils/path.d.mts.map +1 -1
  107. package/internal/utils/path.d.ts.map +1 -1
  108. package/internal/utils/path.js +2 -2
  109. package/internal/utils/path.js.map +1 -1
  110. package/internal/utils/path.mjs.map +1 -1
  111. package/internal/utils/sleep.d.mts.map +1 -1
  112. package/internal/utils/sleep.d.ts.map +1 -1
  113. package/internal/utils/uuid.d.mts +1 -1
  114. package/internal/utils/uuid.d.mts.map +1 -1
  115. package/internal/utils/uuid.d.ts +1 -1
  116. package/internal/utils/uuid.d.ts.map +1 -1
  117. package/internal/utils/uuid.js +1 -2
  118. package/internal/utils/uuid.js.map +1 -1
  119. package/internal/utils/uuid.mjs +1 -2
  120. package/internal/utils/uuid.mjs.map +1 -1
  121. package/internal/utils/values.d.mts.map +1 -1
  122. package/internal/utils/values.d.ts.map +1 -1
  123. package/internal/utils/values.js +5 -5
  124. package/internal/utils/values.js.map +1 -1
  125. package/internal/utils/values.mjs.map +1 -1
  126. package/internal/utils.js +7 -20
  127. package/internal/utils.js.map +1 -1
  128. package/package.json +8 -6
  129. package/resource.js +2 -15
  130. package/resource.js.map +1 -1
  131. package/resources/api-keys.d.mts +28 -0
  132. package/resources/api-keys.d.mts.map +1 -1
  133. package/resources/api-keys.d.ts +28 -0
  134. package/resources/api-keys.d.ts.map +1 -1
  135. package/resources/api-keys.js +28 -0
  136. package/resources/api-keys.js.map +1 -1
  137. package/resources/api-keys.mjs +28 -0
  138. package/resources/api-keys.mjs.map +1 -1
  139. package/resources/compute/compute.js +3 -25
  140. package/resources/compute/compute.js.map +1 -1
  141. package/resources/compute/vms/os-images.d.mts +5 -0
  142. package/resources/compute/vms/os-images.d.mts.map +1 -1
  143. package/resources/compute/vms/os-images.d.ts +5 -0
  144. package/resources/compute/vms/os-images.d.ts.map +1 -1
  145. package/resources/compute/vms/os-images.js +5 -0
  146. package/resources/compute/vms/os-images.js.map +1 -1
  147. package/resources/compute/vms/os-images.mjs +5 -0
  148. package/resources/compute/vms/os-images.mjs.map +1 -1
  149. package/resources/compute/vms/vms.d.mts +38 -0
  150. package/resources/compute/vms/vms.d.mts.map +1 -1
  151. package/resources/compute/vms/vms.d.ts +38 -0
  152. package/resources/compute/vms/vms.d.ts.map +1 -1
  153. package/resources/compute/vms/vms.js +41 -25
  154. package/resources/compute/vms/vms.js.map +1 -1
  155. package/resources/compute/vms/vms.mjs +38 -0
  156. package/resources/compute/vms/vms.mjs.map +1 -1
  157. package/resources/compute/vms/volumes.d.mts +7 -0
  158. package/resources/compute/vms/volumes.d.mts.map +1 -1
  159. package/resources/compute/vms/volumes.d.ts +7 -0
  160. package/resources/compute/vms/volumes.d.ts.map +1 -1
  161. package/resources/compute/vms/volumes.js +7 -0
  162. package/resources/compute/vms/volumes.js.map +1 -1
  163. package/resources/compute/vms/volumes.mjs +7 -0
  164. package/resources/compute/vms/volumes.mjs.map +1 -1
  165. package/resources/compute/vms.js +2 -15
  166. package/resources/compute/vms.js.map +1 -1
  167. package/resources/compute/volumes.d.mts +35 -0
  168. package/resources/compute/volumes.d.mts.map +1 -1
  169. package/resources/compute/volumes.d.ts +35 -0
  170. package/resources/compute/volumes.d.ts.map +1 -1
  171. package/resources/compute/volumes.js +35 -0
  172. package/resources/compute/volumes.js.map +1 -1
  173. package/resources/compute/volumes.mjs +35 -0
  174. package/resources/compute/volumes.mjs.map +1 -1
  175. package/resources/compute.js +2 -15
  176. package/resources/compute.js.map +1 -1
  177. package/resources/index.js +2 -15
  178. package/resources/index.js.map +1 -1
  179. package/resources/networking/firewall-rules.d.mts +45 -0
  180. package/resources/networking/firewall-rules.d.mts.map +1 -1
  181. package/resources/networking/firewall-rules.d.ts +45 -0
  182. package/resources/networking/firewall-rules.d.ts.map +1 -1
  183. package/resources/networking/firewall-rules.js +45 -0
  184. package/resources/networking/firewall-rules.js.map +1 -1
  185. package/resources/networking/firewall-rules.mjs +45 -0
  186. package/resources/networking/firewall-rules.mjs.map +1 -1
  187. package/resources/networking/networking.js +3 -25
  188. package/resources/networking/networking.js.map +1 -1
  189. package/resources/networking/vpcs.d.mts +33 -0
  190. package/resources/networking/vpcs.d.mts.map +1 -1
  191. package/resources/networking/vpcs.d.ts +33 -0
  192. package/resources/networking/vpcs.d.ts.map +1 -1
  193. package/resources/networking/vpcs.js +33 -0
  194. package/resources/networking/vpcs.js.map +1 -1
  195. package/resources/networking/vpcs.mjs +33 -0
  196. package/resources/networking/vpcs.mjs.map +1 -1
  197. package/resources/networking.js +2 -15
  198. package/resources/networking.js.map +1 -1
  199. package/resources.js +2 -15
  200. package/resources.js.map +1 -1
  201. package/src/client.ts +17 -0
  202. package/src/internal/to-file.ts +4 -2
  203. package/src/internal/uploads.ts +16 -4
  204. package/src/internal/utils/uuid.ts +1 -3
  205. package/src/resources/api-keys.ts +28 -0
  206. package/src/resources/compute/vms/os-images.ts +5 -0
  207. package/src/resources/compute/vms/vms.ts +38 -0
  208. package/src/resources/compute/vms/volumes.ts +7 -0
  209. package/src/resources/compute/volumes.ts +35 -0
  210. package/src/resources/networking/firewall-rules.ts +45 -0
  211. package/src/resources/networking/vpcs.ts +33 -0
  212. package/src/version.ts +1 -1
  213. package/uploads.js +2 -15
  214. package/uploads.js.map +1 -1
  215. package/version.d.mts +1 -1
  216. package/version.d.ts +1 -1
  217. package/version.js +1 -1
  218. package/version.mjs +1 -1
  219. package/internal/shims/crypto.d.mts +0 -13
  220. package/internal/shims/crypto.d.mts.map +0 -1
  221. package/internal/shims/crypto.d.ts +0 -13
  222. package/internal/shims/crypto.d.ts.map +0 -1
  223. package/internal/shims/crypto.js +0 -13
  224. package/internal/shims/crypto.js.map +0 -1
  225. package/internal/shims/crypto.mjs +0 -9
  226. package/internal/shims/crypto.mjs.map +0 -1
  227. package/internal/shims/file.d.mts +0 -23
  228. package/internal/shims/file.d.mts.map +0 -1
  229. package/internal/shims/file.d.ts +0 -23
  230. package/internal/shims/file.d.ts.map +0 -1
  231. package/internal/shims/file.js +0 -16
  232. package/internal/shims/file.js.map +0 -1
  233. package/internal/shims/file.mjs +0 -12
  234. package/internal/shims/file.mjs.map +0 -1
  235. package/internal/shims/getBuiltinModule.d.mts +0 -11
  236. package/internal/shims/getBuiltinModule.d.mts.map +0 -1
  237. package/internal/shims/getBuiltinModule.d.ts +0 -11
  238. package/internal/shims/getBuiltinModule.d.ts.map +0 -1
  239. package/internal/shims/getBuiltinModule.js +0 -71
  240. package/internal/shims/getBuiltinModule.js.map +0 -1
  241. package/internal/shims/getBuiltinModule.mjs +0 -67
  242. package/internal/shims/getBuiltinModule.mjs.map +0 -1
  243. package/internal/shims/nullGetBuiltinModule.d.mts +0 -2
  244. package/internal/shims/nullGetBuiltinModule.d.mts.map +0 -1
  245. package/internal/shims/nullGetBuiltinModule.d.ts +0 -2
  246. package/internal/shims/nullGetBuiltinModule.d.ts.map +0 -1
  247. package/internal/shims/nullGetBuiltinModule.js +0 -5
  248. package/internal/shims/nullGetBuiltinModule.js.map +0 -1
  249. package/internal/shims/nullGetBuiltinModule.mjs +0 -2
  250. package/internal/shims/nullGetBuiltinModule.mjs.map +0 -1
  251. package/src/internal/shims/crypto.ts +0 -18
  252. package/src/internal/shims/file.ts +0 -32
  253. package/src/internal/shims/getBuiltinModule.ts +0 -66
  254. package/src/internal/shims/nullGetBuiltinModule.ts +0 -1
@@ -5,24 +5,47 @@ import { path } from "../internal/utils/path.mjs";
5
5
  export class APIKeys extends APIResource {
6
6
  /**
7
7
  * Create a new API key
8
+ *
9
+ * @example
10
+ * ```ts
11
+ * const apiKey = await client.apiKeys.create({
12
+ * expires_at: '2025-12-31T23:59:59Z',
13
+ * name: 'my-api-key',
14
+ * });
15
+ * ```
8
16
  */
9
17
  create(body, options) {
10
18
  return this._client.post('/v1/api_keys', { body, ...options });
11
19
  }
12
20
  /**
13
21
  * Update an API key's name
22
+ *
23
+ * @example
24
+ * ```ts
25
+ * const apiKey = await client.apiKeys.update('api_key_id');
26
+ * ```
14
27
  */
15
28
  update(apiKeyID, body, options) {
16
29
  return this._client.patch(path `/v1/api_keys/${apiKeyID}`, { body, ...options });
17
30
  }
18
31
  /**
19
32
  * List all API keys you created
33
+ *
34
+ * @example
35
+ * ```ts
36
+ * const apiKeyList = await client.apiKeys.list();
37
+ * ```
20
38
  */
21
39
  list(options) {
22
40
  return this._client.get('/v1/api_keys', options);
23
41
  }
24
42
  /**
25
43
  * Delete an API key
44
+ *
45
+ * @example
46
+ * ```ts
47
+ * await client.apiKeys.delete('api_key_id');
48
+ * ```
26
49
  */
27
50
  delete(apiKeyID, options) {
28
51
  return this._client.delete(path `/v1/api_keys/${apiKeyID}`, {
@@ -32,6 +55,11 @@ export class APIKeys extends APIResource {
32
55
  }
33
56
  /**
34
57
  * Get details about an API key
58
+ *
59
+ * @example
60
+ * ```ts
61
+ * const apiKey = await client.apiKeys.get('api_key_id');
62
+ * ```
35
63
  */
36
64
  get(apiKeyID, options) {
37
65
  return this._client.get(path `/v1/api_keys/${apiKeyID}`, options);
@@ -1 +1 @@
1
- {"version":3,"file":"api-keys.mjs","sourceRoot":"","sources":["../src/resources/api-keys.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;OAEf,EAAE,YAAY,EAAE;OAEhB,EAAE,IAAI,EAAE;AAEf,MAAM,OAAO,OAAQ,SAAQ,WAAW;IACtC;;OAEG;IACH,MAAM,CAAC,IAAwB,EAAE,OAAwB;QACvD,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,cAAc,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACjE,CAAC;IAED;;OAEG;IACH,MAAM,CAAC,QAAgB,EAAE,IAAwB,EAAE,OAAwB;QACzE,OAAO,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,IAAI,CAAA,gBAAgB,QAAQ,EAAE,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAClF,CAAC;IAED;;OAEG;IACH,IAAI,CAAC,OAAwB;QAC3B,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,cAAc,EAAE,OAAO,CAAC,CAAC;IACnD,CAAC;IAED;;OAEG;IACH,MAAM,CAAC,QAAgB,EAAE,OAAwB;QAC/C,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,CAAA,gBAAgB,QAAQ,EAAE,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,GAAG,CAAC,QAAgB,EAAE,OAAwB;QAC5C,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,gBAAgB,QAAQ,EAAE,EAAE,OAAO,CAAC,CAAC;IACnE,CAAC;CACF"}
1
+ {"version":3,"file":"api-keys.mjs","sourceRoot":"","sources":["../src/resources/api-keys.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;OAEf,EAAE,YAAY,EAAE;OAEhB,EAAE,IAAI,EAAE;AAEf,MAAM,OAAO,OAAQ,SAAQ,WAAW;IACtC;;;;;;;;;;OAUG;IACH,MAAM,CAAC,IAAwB,EAAE,OAAwB;QACvD,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,cAAc,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACjE,CAAC;IAED;;;;;;;OAOG;IACH,MAAM,CAAC,QAAgB,EAAE,IAAwB,EAAE,OAAwB;QACzE,OAAO,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,IAAI,CAAA,gBAAgB,QAAQ,EAAE,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAClF,CAAC;IAED;;;;;;;OAOG;IACH,IAAI,CAAC,OAAwB;QAC3B,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,cAAc,EAAE,OAAO,CAAC,CAAC;IACnD,CAAC;IAED;;;;;;;OAOG;IACH,MAAM,CAAC,QAAgB,EAAE,OAAwB;QAC/C,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,CAAA,gBAAgB,QAAQ,EAAE,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;;;;;;;OAOG;IACH,GAAG,CAAC,QAAgB,EAAE,OAAwB;QAC5C,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,gBAAgB,QAAQ,EAAE,EAAE,OAAO,CAAC,CAAC;IACnE,CAAC;CACF"}
@@ -1,34 +1,12 @@
1
1
  "use strict";
2
2
  // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
3
- var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
4
- if (k2 === undefined) k2 = k;
5
- var desc = Object.getOwnPropertyDescriptor(m, k);
6
- if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
7
- desc = { enumerable: true, get: function() { return m[k]; } };
8
- }
9
- Object.defineProperty(o, k2, desc);
10
- }) : (function(o, m, k, k2) {
11
- if (k2 === undefined) k2 = k;
12
- o[k2] = m[k];
13
- }));
14
- var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
15
- Object.defineProperty(o, "default", { enumerable: true, value: v });
16
- }) : function(o, v) {
17
- o["default"] = v;
18
- });
19
- var __importStar = (this && this.__importStar) || function (mod) {
20
- if (mod && mod.__esModule) return mod;
21
- var result = {};
22
- if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
23
- __setModuleDefault(result, mod);
24
- return result;
25
- };
26
3
  Object.defineProperty(exports, "__esModule", { value: true });
27
4
  exports.Compute = void 0;
5
+ const tslib_1 = require("../../internal/tslib.js");
28
6
  const resource_1 = require("../../core/resource.js");
29
- const VolumesAPI = __importStar(require("./volumes.js"));
7
+ const VolumesAPI = tslib_1.__importStar(require("./volumes.js"));
30
8
  const volumes_1 = require("./volumes.js");
31
- const VMsAPI = __importStar(require("./vms/vms.js"));
9
+ const VMsAPI = tslib_1.__importStar(require("./vms/vms.js"));
32
10
  const vms_1 = require("./vms/vms.js");
33
11
  class Compute extends resource_1.APIResource {
34
12
  constructor() {
@@ -1 +1 @@
1
- {"version":3,"file":"compute.js","sourceRoot":"","sources":["../../src/resources/compute/compute.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;;;;;;;;;;;;;;;;;;;;;;;;AAEtF,qDAAkD;AAClD,yDAAwC;AACxC,0CAQmB;AACnB,qDAAoC;AACpC,sCAUmB;AAEnB,MAAa,OAAQ,SAAQ,sBAAW;IAAxC;;QACE,QAAG,GAAe,IAAI,MAAM,CAAC,GAAG,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QAC/C,YAAO,GAAuB,IAAI,UAAU,CAAC,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IACrE,CAAC;CAAA;AAHD,0BAGC;AAED,OAAO,CAAC,GAAG,GAAG,SAAG,CAAC;AAClB,OAAO,CAAC,OAAO,GAAG,iBAAO,CAAC"}
1
+ {"version":3,"file":"compute.js","sourceRoot":"","sources":["../../src/resources/compute/compute.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;;AAEtF,qDAAkD;AAClD,iEAAwC;AACxC,0CAQmB;AACnB,6DAAoC;AACpC,sCAUmB;AAEnB,MAAa,OAAQ,SAAQ,sBAAW;IAAxC;;QACE,QAAG,GAAe,IAAI,MAAM,CAAC,GAAG,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QAC/C,YAAO,GAAuB,IAAI,UAAU,CAAC,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IACrE,CAAC;CAAA;AAHD,0BAGC;AAED,OAAO,CAAC,GAAG,GAAG,SAAG,CAAC;AAClB,OAAO,CAAC,OAAO,GAAG,iBAAO,CAAC"}
@@ -5,6 +5,11 @@ import { RequestOptions } from "../../../internal/request-options.mjs";
5
5
  export declare class OSImages extends APIResource {
6
6
  /**
7
7
  * List all OS Images
8
+ *
9
+ * @example
10
+ * ```ts
11
+ * const osImages = await client.compute.vms.osImages.list();
12
+ * ```
8
13
  */
9
14
  list(options?: RequestOptions): APIPromise<OSImageListResponse>;
10
15
  }
@@ -1 +1 @@
1
- {"version":3,"file":"os-images.d.mts","sourceRoot":"","sources":["../../../src/resources/compute/vms/os-images.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,KAAK,MAAM;OACX,EAAE,UAAU,EAAE;OACd,EAAE,cAAc,EAAE;AAEzB,qBAAa,QAAS,SAAQ,WAAW;IACvC;;OAEG;IACH,IAAI,CAAC,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,mBAAmB,CAAC;CAGhE;AAED,MAAM,MAAM,mBAAmB,GAAG,KAAK,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;AAExD,MAAM,CAAC,OAAO,WAAW,QAAQ,CAAC;IAChC,OAAO,EAAE,KAAK,mBAAmB,IAAI,mBAAmB,EAAE,CAAC;CAC5D"}
1
+ {"version":3,"file":"os-images.d.mts","sourceRoot":"","sources":["../../../src/resources/compute/vms/os-images.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,KAAK,MAAM;OACX,EAAE,UAAU,EAAE;OACd,EAAE,cAAc,EAAE;AAEzB,qBAAa,QAAS,SAAQ,WAAW;IACvC;;;;;;;OAOG;IACH,IAAI,CAAC,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,mBAAmB,CAAC;CAGhE;AAED,MAAM,MAAM,mBAAmB,GAAG,KAAK,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;AAExD,MAAM,CAAC,OAAO,WAAW,QAAQ,CAAC;IAChC,OAAO,EAAE,KAAK,mBAAmB,IAAI,mBAAmB,EAAE,CAAC;CAC5D"}
@@ -5,6 +5,11 @@ import { RequestOptions } from "../../../internal/request-options.js";
5
5
  export declare class OSImages extends APIResource {
6
6
  /**
7
7
  * List all OS Images
8
+ *
9
+ * @example
10
+ * ```ts
11
+ * const osImages = await client.compute.vms.osImages.list();
12
+ * ```
8
13
  */
9
14
  list(options?: RequestOptions): APIPromise<OSImageListResponse>;
10
15
  }
@@ -1 +1 @@
1
- {"version":3,"file":"os-images.d.ts","sourceRoot":"","sources":["../../../src/resources/compute/vms/os-images.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,KAAK,MAAM;OACX,EAAE,UAAU,EAAE;OACd,EAAE,cAAc,EAAE;AAEzB,qBAAa,QAAS,SAAQ,WAAW;IACvC;;OAEG;IACH,IAAI,CAAC,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,mBAAmB,CAAC;CAGhE;AAED,MAAM,MAAM,mBAAmB,GAAG,KAAK,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;AAExD,MAAM,CAAC,OAAO,WAAW,QAAQ,CAAC;IAChC,OAAO,EAAE,KAAK,mBAAmB,IAAI,mBAAmB,EAAE,CAAC;CAC5D"}
1
+ {"version":3,"file":"os-images.d.ts","sourceRoot":"","sources":["../../../src/resources/compute/vms/os-images.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,KAAK,MAAM;OACX,EAAE,UAAU,EAAE;OACd,EAAE,cAAc,EAAE;AAEzB,qBAAa,QAAS,SAAQ,WAAW;IACvC;;;;;;;OAOG;IACH,IAAI,CAAC,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,mBAAmB,CAAC;CAGhE;AAED,MAAM,MAAM,mBAAmB,GAAG,KAAK,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;AAExD,MAAM,CAAC,OAAO,WAAW,QAAQ,CAAC;IAChC,OAAO,EAAE,KAAK,mBAAmB,IAAI,mBAAmB,EAAE,CAAC;CAC5D"}
@@ -6,6 +6,11 @@ const resource_1 = require("../../../core/resource.js");
6
6
  class OSImages extends resource_1.APIResource {
7
7
  /**
8
8
  * List all OS Images
9
+ *
10
+ * @example
11
+ * ```ts
12
+ * const osImages = await client.compute.vms.osImages.list();
13
+ * ```
9
14
  */
10
15
  list(options) {
11
16
  return this._client.get('/v1/compute/vms/os_images', options);
@@ -1 +1 @@
1
- {"version":3,"file":"os-images.js","sourceRoot":"","sources":["../../../src/resources/compute/vms/os-images.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,wDAAqD;AAKrD,MAAa,QAAS,SAAQ,sBAAW;IACvC;;OAEG;IACH,IAAI,CAAC,OAAwB;QAC3B,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,2BAA2B,EAAE,OAAO,CAAC,CAAC;IAChE,CAAC;CACF;AAPD,4BAOC"}
1
+ {"version":3,"file":"os-images.js","sourceRoot":"","sources":["../../../src/resources/compute/vms/os-images.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,wDAAqD;AAKrD,MAAa,QAAS,SAAQ,sBAAW;IACvC;;;;;;;OAOG;IACH,IAAI,CAAC,OAAwB;QAC3B,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,2BAA2B,EAAE,OAAO,CAAC,CAAC;IAChE,CAAC;CACF;AAZD,4BAYC"}
@@ -3,6 +3,11 @@ import { APIResource } from "../../../core/resource.mjs";
3
3
  export class OSImages extends APIResource {
4
4
  /**
5
5
  * List all OS Images
6
+ *
7
+ * @example
8
+ * ```ts
9
+ * const osImages = await client.compute.vms.osImages.list();
10
+ * ```
6
11
  */
7
12
  list(options) {
8
13
  return this._client.get('/v1/compute/vms/os_images', options);
@@ -1 +1 @@
1
- {"version":3,"file":"os-images.mjs","sourceRoot":"","sources":["../../../src/resources/compute/vms/os-images.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;AAKtB,MAAM,OAAO,QAAS,SAAQ,WAAW;IACvC;;OAEG;IACH,IAAI,CAAC,OAAwB;QAC3B,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,2BAA2B,EAAE,OAAO,CAAC,CAAC;IAChE,CAAC;CACF"}
1
+ {"version":3,"file":"os-images.mjs","sourceRoot":"","sources":["../../../src/resources/compute/vms/os-images.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;AAKtB,MAAM,OAAO,QAAS,SAAQ,WAAW;IACvC;;;;;;;OAOG;IACH,IAAI,CAAC,OAAwB;QAC3B,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,2BAA2B,EAAE,OAAO,CAAC,CAAC;IAChE,CAAC;CACF"}
@@ -12,22 +12,60 @@ export declare class VMs extends APIResource {
12
12
  osImages: OSImagesAPI.OSImages;
13
13
  /**
14
14
  * Create a VM
15
+ *
16
+ * @example
17
+ * ```ts
18
+ * const operation = await client.compute.vms.create({
19
+ * boot_volume: { size: 100 },
20
+ * cpu_config: { vcpu: 2 },
21
+ * memory_config: { size: 2 },
22
+ * name: 'my-vm',
23
+ * os_image_name: 'ubuntu-noble-2025-04-03',
24
+ * public_ip_enabled: true,
25
+ * region: 'us-wdc-1',
26
+ * ssh_key: {
27
+ * public_key:
28
+ * 'ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAAAgQDJiJabIUkXw7VrQG+yBohvhEsyoKEYvejZc4RFzV5maybqQei1punVsoe4r6gJttMM1Gr3cNr3OfepikCQAhAchw5ww94ZWqDsDYIqMrlDFbqhGTXDNzFAjeVIKptCOlz9k+7aM69YtLXJ6gFUCq1fbK9PjY+AK28UpMfKYUcyHQ== noname',
29
+ * },
30
+ * subnet_id: '123e4567-e89b-12d3-a456-426614174000',
31
+ * });
32
+ * ```
15
33
  */
16
34
  create(body: VMCreateParams, options?: RequestOptions): APIPromise<OperationsAPI.Operation>;
17
35
  /**
18
36
  * Update a VM
37
+ *
38
+ * @example
39
+ * ```ts
40
+ * const operation = await client.compute.vms.update('vm_id');
41
+ * ```
19
42
  */
20
43
  update(vmID: string, body: VMUpdateParams, options?: RequestOptions): APIPromise<OperationsAPI.Operation>;
21
44
  /**
22
45
  * List all VMs
46
+ *
47
+ * @example
48
+ * ```ts
49
+ * const vmList = await client.compute.vms.list();
50
+ * ```
23
51
  */
24
52
  list(options?: RequestOptions): APIPromise<VMList>;
25
53
  /**
26
54
  * Delete a VM
55
+ *
56
+ * @example
57
+ * ```ts
58
+ * const operation = await client.compute.vms.delete('vm_id');
59
+ * ```
27
60
  */
28
61
  delete(vmID: string, options?: RequestOptions): APIPromise<OperationsAPI.Operation>;
29
62
  /**
30
63
  * Get details about a VM
64
+ *
65
+ * @example
66
+ * ```ts
67
+ * const vm = await client.compute.vms.get('vm_id');
68
+ * ```
31
69
  */
32
70
  get(vmID: string, options?: RequestOptions): APIPromise<VM>;
33
71
  }
@@ -1 +1 @@
1
- {"version":3,"file":"vms.d.mts","sourceRoot":"","sources":["../../../src/resources/compute/vms/vms.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,KAAK,aAAa;OAClB,KAAK,MAAM;OACX,KAAK,WAAW;OAChB,EAAE,mBAAmB,EAAE,QAAQ,EAAE;OACjC,KAAK,UAAU;OACf,EAAE,OAAO,EAAE;OACX,EAAE,UAAU,EAAE;OACd,EAAE,cAAc,EAAE;AAGzB,qBAAa,GAAI,SAAQ,WAAW;IAClC,OAAO,EAAE,UAAU,CAAC,OAAO,CAAwC;IACnE,QAAQ,EAAE,WAAW,CAAC,QAAQ,CAA0C;IAExE;;OAEG;IACH,MAAM,CAAC,IAAI,EAAE,cAAc,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,aAAa,CAAC,SAAS,CAAC;IAI3F;;OAEG;IACH,MAAM,CAAC,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,cAAc,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,aAAa,CAAC,SAAS,CAAC;IAIzG;;OAEG;IACH,IAAI,CAAC,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,MAAM,CAAC;IAIlD;;OAEG;IACH,MAAM,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,aAAa,CAAC,SAAS,CAAC;IAInF;;OAEG;IACH,GAAG,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,EAAE,CAAC;CAG5D;AAED;;GAEG;AACH,MAAM,WAAW,SAAS;IACxB;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;CACd;AAED;;GAEG;AACH,MAAM,WAAW,YAAY;IAC3B;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;CACd;AAED;;GAEG;AACH,MAAM,WAAW,OAAO;IACtB;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,YAAY,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;CACd;AAED;;GAEG;AACH,MAAM,WAAW,MAAM;IACrB;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;CACpB;AAED;;GAEG;AACH,MAAM,WAAW,EAAE;IACjB;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,cAAc,EAAE,MAAM,CAAC;IAEvB;;OAEG;IACH,UAAU,EAAE,SAAS,CAAC;IAEtB;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,eAAe,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAE/B;;OAEG;IACH,aAAa,EAAE,YAAY,CAAC;IAE5B;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,UAAU,EAAE,MAAM,GAAG,IAAI,CAAC;IAE1B;;OAEG;IACH,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;IAEzB;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC,UAAU,CAAC;IAE1B;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC,cAAc,CAAC;IAE9B;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;CAClB;AAED,MAAM,WAAW,MAAM;IACrB,KAAK,EAAE,KAAK,CAAC,EAAE,CAAC,CAAC;CAClB;AAED,MAAM,WAAW,cAAc;IAC7B;;OAEG;IACH,WAAW,EAAE,cAAc,CAAC,UAAU,CAAC;IAEvC;;OAEG;IACH,UAAU,EAAE,SAAS,CAAC;IAEtB;;OAEG;IACH,aAAa,EAAE,YAAY,CAAC;IAE5B;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,aAAa,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,iBAAiB,EAAE,OAAO,CAAC;IAE3B;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC,UAAU,CAAC;IAE1B;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,YAAY,CAAC,EAAE,KAAK,CAAC,cAAc,CAAC,UAAU,CAAC,CAAC;CACjD;AAED,yBAAiB,cAAc,CAAC;IAC9B;;OAEG;IACH,UAAiB,UAAU;QACzB;;WAEG;QACH,IAAI,EAAE,MAAM,CAAC;KACd;IAED;;OAEG;IACH,UAAiB,UAAU;QACzB;;WAEG;QACH,IAAI,EAAE,MAAM,CAAC;QAEb;;WAEG;QACH,IAAI,EAAE,MAAM,CAAC;KACd;CACF;AAED,MAAM,WAAW,cAAc;IAC7B;;OAEG;IACH,UAAU,CAAC,EAAE,SAAS,CAAC;IAEvB;;OAEG;IACH,aAAa,CAAC,EAAE,YAAY,CAAC;IAE7B;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,iBAAiB,CAAC,EAAE,OAAO,CAAC;CAC7B;AAKD,MAAM,CAAC,OAAO,WAAW,GAAG,CAAC;IAC3B,OAAO,EACL,KAAK,SAAS,IAAI,SAAS,EAC3B,KAAK,YAAY,IAAI,YAAY,EACjC,KAAK,OAAO,IAAI,OAAO,EACvB,KAAK,MAAM,IAAI,MAAM,EACrB,KAAK,EAAE,IAAI,EAAE,EACb,KAAK,MAAM,IAAI,MAAM,EACrB,KAAK,cAAc,IAAI,cAAc,EACrC,KAAK,cAAc,IAAI,cAAc,GACtC,CAAC;IAEF,OAAO,EAAE,OAAO,IAAI,OAAO,EAAE,CAAC;IAE9B,OAAO,EAAE,QAAQ,IAAI,QAAQ,EAAE,KAAK,mBAAmB,IAAI,mBAAmB,EAAE,CAAC;CAClF"}
1
+ {"version":3,"file":"vms.d.mts","sourceRoot":"","sources":["../../../src/resources/compute/vms/vms.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,KAAK,aAAa;OAClB,KAAK,MAAM;OACX,KAAK,WAAW;OAChB,EAAE,mBAAmB,EAAE,QAAQ,EAAE;OACjC,KAAK,UAAU;OACf,EAAE,OAAO,EAAE;OACX,EAAE,UAAU,EAAE;OACd,EAAE,cAAc,EAAE;AAGzB,qBAAa,GAAI,SAAQ,WAAW;IAClC,OAAO,EAAE,UAAU,CAAC,OAAO,CAAwC;IACnE,QAAQ,EAAE,WAAW,CAAC,QAAQ,CAA0C;IAExE;;;;;;;;;;;;;;;;;;;;OAoBG;IACH,MAAM,CAAC,IAAI,EAAE,cAAc,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,aAAa,CAAC,SAAS,CAAC;IAI3F;;;;;;;OAOG;IACH,MAAM,CAAC,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,cAAc,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,aAAa,CAAC,SAAS,CAAC;IAIzG;;;;;;;OAOG;IACH,IAAI,CAAC,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,MAAM,CAAC;IAIlD;;;;;;;OAOG;IACH,MAAM,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,aAAa,CAAC,SAAS,CAAC;IAInF;;;;;;;OAOG;IACH,GAAG,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,EAAE,CAAC;CAG5D;AAED;;GAEG;AACH,MAAM,WAAW,SAAS;IACxB;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;CACd;AAED;;GAEG;AACH,MAAM,WAAW,YAAY;IAC3B;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;CACd;AAED;;GAEG;AACH,MAAM,WAAW,OAAO;IACtB;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,YAAY,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;CACd;AAED;;GAEG;AACH,MAAM,WAAW,MAAM;IACrB;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;CACpB;AAED;;GAEG;AACH,MAAM,WAAW,EAAE;IACjB;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,cAAc,EAAE,MAAM,CAAC;IAEvB;;OAEG;IACH,UAAU,EAAE,SAAS,CAAC;IAEtB;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,eAAe,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAE/B;;OAEG;IACH,aAAa,EAAE,YAAY,CAAC;IAE5B;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,UAAU,EAAE,MAAM,GAAG,IAAI,CAAC;IAE1B;;OAEG;IACH,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;IAEzB;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC,UAAU,CAAC;IAE1B;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC,cAAc,CAAC;IAE9B;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;CAClB;AAED,MAAM,WAAW,MAAM;IACrB,KAAK,EAAE,KAAK,CAAC,EAAE,CAAC,CAAC;CAClB;AAED,MAAM,WAAW,cAAc;IAC7B;;OAEG;IACH,WAAW,EAAE,cAAc,CAAC,UAAU,CAAC;IAEvC;;OAEG;IACH,UAAU,EAAE,SAAS,CAAC;IAEtB;;OAEG;IACH,aAAa,EAAE,YAAY,CAAC;IAE5B;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,aAAa,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,iBAAiB,EAAE,OAAO,CAAC;IAE3B;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC,UAAU,CAAC;IAE1B;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,YAAY,CAAC,EAAE,KAAK,CAAC,cAAc,CAAC,UAAU,CAAC,CAAC;CACjD;AAED,yBAAiB,cAAc,CAAC;IAC9B;;OAEG;IACH,UAAiB,UAAU;QACzB;;WAEG;QACH,IAAI,EAAE,MAAM,CAAC;KACd;IAED;;OAEG;IACH,UAAiB,UAAU;QACzB;;WAEG;QACH,IAAI,EAAE,MAAM,CAAC;QAEb;;WAEG;QACH,IAAI,EAAE,MAAM,CAAC;KACd;CACF;AAED,MAAM,WAAW,cAAc;IAC7B;;OAEG;IACH,UAAU,CAAC,EAAE,SAAS,CAAC;IAEvB;;OAEG;IACH,aAAa,CAAC,EAAE,YAAY,CAAC;IAE7B;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,iBAAiB,CAAC,EAAE,OAAO,CAAC;CAC7B;AAKD,MAAM,CAAC,OAAO,WAAW,GAAG,CAAC;IAC3B,OAAO,EACL,KAAK,SAAS,IAAI,SAAS,EAC3B,KAAK,YAAY,IAAI,YAAY,EACjC,KAAK,OAAO,IAAI,OAAO,EACvB,KAAK,MAAM,IAAI,MAAM,EACrB,KAAK,EAAE,IAAI,EAAE,EACb,KAAK,MAAM,IAAI,MAAM,EACrB,KAAK,cAAc,IAAI,cAAc,EACrC,KAAK,cAAc,IAAI,cAAc,GACtC,CAAC;IAEF,OAAO,EAAE,OAAO,IAAI,OAAO,EAAE,CAAC;IAE9B,OAAO,EAAE,QAAQ,IAAI,QAAQ,EAAE,KAAK,mBAAmB,IAAI,mBAAmB,EAAE,CAAC;CAClF"}
@@ -12,22 +12,60 @@ export declare class VMs extends APIResource {
12
12
  osImages: OSImagesAPI.OSImages;
13
13
  /**
14
14
  * Create a VM
15
+ *
16
+ * @example
17
+ * ```ts
18
+ * const operation = await client.compute.vms.create({
19
+ * boot_volume: { size: 100 },
20
+ * cpu_config: { vcpu: 2 },
21
+ * memory_config: { size: 2 },
22
+ * name: 'my-vm',
23
+ * os_image_name: 'ubuntu-noble-2025-04-03',
24
+ * public_ip_enabled: true,
25
+ * region: 'us-wdc-1',
26
+ * ssh_key: {
27
+ * public_key:
28
+ * 'ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAAAgQDJiJabIUkXw7VrQG+yBohvhEsyoKEYvejZc4RFzV5maybqQei1punVsoe4r6gJttMM1Gr3cNr3OfepikCQAhAchw5ww94ZWqDsDYIqMrlDFbqhGTXDNzFAjeVIKptCOlz9k+7aM69YtLXJ6gFUCq1fbK9PjY+AK28UpMfKYUcyHQ== noname',
29
+ * },
30
+ * subnet_id: '123e4567-e89b-12d3-a456-426614174000',
31
+ * });
32
+ * ```
15
33
  */
16
34
  create(body: VMCreateParams, options?: RequestOptions): APIPromise<OperationsAPI.Operation>;
17
35
  /**
18
36
  * Update a VM
37
+ *
38
+ * @example
39
+ * ```ts
40
+ * const operation = await client.compute.vms.update('vm_id');
41
+ * ```
19
42
  */
20
43
  update(vmID: string, body: VMUpdateParams, options?: RequestOptions): APIPromise<OperationsAPI.Operation>;
21
44
  /**
22
45
  * List all VMs
46
+ *
47
+ * @example
48
+ * ```ts
49
+ * const vmList = await client.compute.vms.list();
50
+ * ```
23
51
  */
24
52
  list(options?: RequestOptions): APIPromise<VMList>;
25
53
  /**
26
54
  * Delete a VM
55
+ *
56
+ * @example
57
+ * ```ts
58
+ * const operation = await client.compute.vms.delete('vm_id');
59
+ * ```
27
60
  */
28
61
  delete(vmID: string, options?: RequestOptions): APIPromise<OperationsAPI.Operation>;
29
62
  /**
30
63
  * Get details about a VM
64
+ *
65
+ * @example
66
+ * ```ts
67
+ * const vm = await client.compute.vms.get('vm_id');
68
+ * ```
31
69
  */
32
70
  get(vmID: string, options?: RequestOptions): APIPromise<VM>;
33
71
  }
@@ -1 +1 @@
1
- {"version":3,"file":"vms.d.ts","sourceRoot":"","sources":["../../../src/resources/compute/vms/vms.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,KAAK,aAAa;OAClB,KAAK,MAAM;OACX,KAAK,WAAW;OAChB,EAAE,mBAAmB,EAAE,QAAQ,EAAE;OACjC,KAAK,UAAU;OACf,EAAE,OAAO,EAAE;OACX,EAAE,UAAU,EAAE;OACd,EAAE,cAAc,EAAE;AAGzB,qBAAa,GAAI,SAAQ,WAAW;IAClC,OAAO,EAAE,UAAU,CAAC,OAAO,CAAwC;IACnE,QAAQ,EAAE,WAAW,CAAC,QAAQ,CAA0C;IAExE;;OAEG;IACH,MAAM,CAAC,IAAI,EAAE,cAAc,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,aAAa,CAAC,SAAS,CAAC;IAI3F;;OAEG;IACH,MAAM,CAAC,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,cAAc,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,aAAa,CAAC,SAAS,CAAC;IAIzG;;OAEG;IACH,IAAI,CAAC,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,MAAM,CAAC;IAIlD;;OAEG;IACH,MAAM,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,aAAa,CAAC,SAAS,CAAC;IAInF;;OAEG;IACH,GAAG,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,EAAE,CAAC;CAG5D;AAED;;GAEG;AACH,MAAM,WAAW,SAAS;IACxB;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;CACd;AAED;;GAEG;AACH,MAAM,WAAW,YAAY;IAC3B;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;CACd;AAED;;GAEG;AACH,MAAM,WAAW,OAAO;IACtB;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,YAAY,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;CACd;AAED;;GAEG;AACH,MAAM,WAAW,MAAM;IACrB;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;CACpB;AAED;;GAEG;AACH,MAAM,WAAW,EAAE;IACjB;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,cAAc,EAAE,MAAM,CAAC;IAEvB;;OAEG;IACH,UAAU,EAAE,SAAS,CAAC;IAEtB;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,eAAe,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAE/B;;OAEG;IACH,aAAa,EAAE,YAAY,CAAC;IAE5B;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,UAAU,EAAE,MAAM,GAAG,IAAI,CAAC;IAE1B;;OAEG;IACH,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;IAEzB;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC,UAAU,CAAC;IAE1B;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC,cAAc,CAAC;IAE9B;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;CAClB;AAED,MAAM,WAAW,MAAM;IACrB,KAAK,EAAE,KAAK,CAAC,EAAE,CAAC,CAAC;CAClB;AAED,MAAM,WAAW,cAAc;IAC7B;;OAEG;IACH,WAAW,EAAE,cAAc,CAAC,UAAU,CAAC;IAEvC;;OAEG;IACH,UAAU,EAAE,SAAS,CAAC;IAEtB;;OAEG;IACH,aAAa,EAAE,YAAY,CAAC;IAE5B;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,aAAa,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,iBAAiB,EAAE,OAAO,CAAC;IAE3B;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC,UAAU,CAAC;IAE1B;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,YAAY,CAAC,EAAE,KAAK,CAAC,cAAc,CAAC,UAAU,CAAC,CAAC;CACjD;AAED,yBAAiB,cAAc,CAAC;IAC9B;;OAEG;IACH,UAAiB,UAAU;QACzB;;WAEG;QACH,IAAI,EAAE,MAAM,CAAC;KACd;IAED;;OAEG;IACH,UAAiB,UAAU;QACzB;;WAEG;QACH,IAAI,EAAE,MAAM,CAAC;QAEb;;WAEG;QACH,IAAI,EAAE,MAAM,CAAC;KACd;CACF;AAED,MAAM,WAAW,cAAc;IAC7B;;OAEG;IACH,UAAU,CAAC,EAAE,SAAS,CAAC;IAEvB;;OAEG;IACH,aAAa,CAAC,EAAE,YAAY,CAAC;IAE7B;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,iBAAiB,CAAC,EAAE,OAAO,CAAC;CAC7B;AAKD,MAAM,CAAC,OAAO,WAAW,GAAG,CAAC;IAC3B,OAAO,EACL,KAAK,SAAS,IAAI,SAAS,EAC3B,KAAK,YAAY,IAAI,YAAY,EACjC,KAAK,OAAO,IAAI,OAAO,EACvB,KAAK,MAAM,IAAI,MAAM,EACrB,KAAK,EAAE,IAAI,EAAE,EACb,KAAK,MAAM,IAAI,MAAM,EACrB,KAAK,cAAc,IAAI,cAAc,EACrC,KAAK,cAAc,IAAI,cAAc,GACtC,CAAC;IAEF,OAAO,EAAE,OAAO,IAAI,OAAO,EAAE,CAAC;IAE9B,OAAO,EAAE,QAAQ,IAAI,QAAQ,EAAE,KAAK,mBAAmB,IAAI,mBAAmB,EAAE,CAAC;CAClF"}
1
+ {"version":3,"file":"vms.d.ts","sourceRoot":"","sources":["../../../src/resources/compute/vms/vms.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,KAAK,aAAa;OAClB,KAAK,MAAM;OACX,KAAK,WAAW;OAChB,EAAE,mBAAmB,EAAE,QAAQ,EAAE;OACjC,KAAK,UAAU;OACf,EAAE,OAAO,EAAE;OACX,EAAE,UAAU,EAAE;OACd,EAAE,cAAc,EAAE;AAGzB,qBAAa,GAAI,SAAQ,WAAW;IAClC,OAAO,EAAE,UAAU,CAAC,OAAO,CAAwC;IACnE,QAAQ,EAAE,WAAW,CAAC,QAAQ,CAA0C;IAExE;;;;;;;;;;;;;;;;;;;;OAoBG;IACH,MAAM,CAAC,IAAI,EAAE,cAAc,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,aAAa,CAAC,SAAS,CAAC;IAI3F;;;;;;;OAOG;IACH,MAAM,CAAC,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,cAAc,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,aAAa,CAAC,SAAS,CAAC;IAIzG;;;;;;;OAOG;IACH,IAAI,CAAC,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,MAAM,CAAC;IAIlD;;;;;;;OAOG;IACH,MAAM,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,aAAa,CAAC,SAAS,CAAC;IAInF;;;;;;;OAOG;IACH,GAAG,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,EAAE,CAAC;CAG5D;AAED;;GAEG;AACH,MAAM,WAAW,SAAS;IACxB;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;CACd;AAED;;GAEG;AACH,MAAM,WAAW,YAAY;IAC3B;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;CACd;AAED;;GAEG;AACH,MAAM,WAAW,OAAO;IACtB;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,YAAY,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;CACd;AAED;;GAEG;AACH,MAAM,WAAW,MAAM;IACrB;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;CACpB;AAED;;GAEG;AACH,MAAM,WAAW,EAAE;IACjB;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,cAAc,EAAE,MAAM,CAAC;IAEvB;;OAEG;IACH,UAAU,EAAE,SAAS,CAAC;IAEtB;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,eAAe,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAE/B;;OAEG;IACH,aAAa,EAAE,YAAY,CAAC;IAE5B;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,UAAU,EAAE,MAAM,GAAG,IAAI,CAAC;IAE1B;;OAEG;IACH,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;IAEzB;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC,UAAU,CAAC;IAE1B;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC,cAAc,CAAC;IAE9B;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;CAClB;AAED,MAAM,WAAW,MAAM;IACrB,KAAK,EAAE,KAAK,CAAC,EAAE,CAAC,CAAC;CAClB;AAED,MAAM,WAAW,cAAc;IAC7B;;OAEG;IACH,WAAW,EAAE,cAAc,CAAC,UAAU,CAAC;IAEvC;;OAEG;IACH,UAAU,EAAE,SAAS,CAAC;IAEtB;;OAEG;IACH,aAAa,EAAE,YAAY,CAAC;IAE5B;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,aAAa,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,iBAAiB,EAAE,OAAO,CAAC;IAE3B;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC,UAAU,CAAC;IAE1B;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,YAAY,CAAC,EAAE,KAAK,CAAC,cAAc,CAAC,UAAU,CAAC,CAAC;CACjD;AAED,yBAAiB,cAAc,CAAC;IAC9B;;OAEG;IACH,UAAiB,UAAU;QACzB;;WAEG;QACH,IAAI,EAAE,MAAM,CAAC;KACd;IAED;;OAEG;IACH,UAAiB,UAAU;QACzB;;WAEG;QACH,IAAI,EAAE,MAAM,CAAC;QAEb;;WAEG;QACH,IAAI,EAAE,MAAM,CAAC;KACd;CACF;AAED,MAAM,WAAW,cAAc;IAC7B;;OAEG;IACH,UAAU,CAAC,EAAE,SAAS,CAAC;IAEvB;;OAEG;IACH,aAAa,CAAC,EAAE,YAAY,CAAC;IAE7B;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,iBAAiB,CAAC,EAAE,OAAO,CAAC;CAC7B;AAKD,MAAM,CAAC,OAAO,WAAW,GAAG,CAAC;IAC3B,OAAO,EACL,KAAK,SAAS,IAAI,SAAS,EAC3B,KAAK,YAAY,IAAI,YAAY,EACjC,KAAK,OAAO,IAAI,OAAO,EACvB,KAAK,MAAM,IAAI,MAAM,EACrB,KAAK,EAAE,IAAI,EAAE,EACb,KAAK,MAAM,IAAI,MAAM,EACrB,KAAK,cAAc,IAAI,cAAc,EACrC,KAAK,cAAc,IAAI,cAAc,GACtC,CAAC;IAEF,OAAO,EAAE,OAAO,IAAI,OAAO,EAAE,CAAC;IAE9B,OAAO,EAAE,QAAQ,IAAI,QAAQ,EAAE,KAAK,mBAAmB,IAAI,mBAAmB,EAAE,CAAC;CAClF"}
@@ -1,34 +1,12 @@
1
1
  "use strict";
2
2
  // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
3
- var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
4
- if (k2 === undefined) k2 = k;
5
- var desc = Object.getOwnPropertyDescriptor(m, k);
6
- if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
7
- desc = { enumerable: true, get: function() { return m[k]; } };
8
- }
9
- Object.defineProperty(o, k2, desc);
10
- }) : (function(o, m, k, k2) {
11
- if (k2 === undefined) k2 = k;
12
- o[k2] = m[k];
13
- }));
14
- var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
15
- Object.defineProperty(o, "default", { enumerable: true, value: v });
16
- }) : function(o, v) {
17
- o["default"] = v;
18
- });
19
- var __importStar = (this && this.__importStar) || function (mod) {
20
- if (mod && mod.__esModule) return mod;
21
- var result = {};
22
- if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
23
- __setModuleDefault(result, mod);
24
- return result;
25
- };
26
3
  Object.defineProperty(exports, "__esModule", { value: true });
27
4
  exports.VMs = void 0;
5
+ const tslib_1 = require("../../../internal/tslib.js");
28
6
  const resource_1 = require("../../../core/resource.js");
29
- const OSImagesAPI = __importStar(require("./os-images.js"));
7
+ const OSImagesAPI = tslib_1.__importStar(require("./os-images.js"));
30
8
  const os_images_1 = require("./os-images.js");
31
- const VolumesAPI = __importStar(require("./volumes.js"));
9
+ const VolumesAPI = tslib_1.__importStar(require("./volumes.js"));
32
10
  const volumes_1 = require("./volumes.js");
33
11
  const path_1 = require("../../../internal/utils/path.js");
34
12
  class VMs extends resource_1.APIResource {
@@ -39,30 +17,68 @@ class VMs extends resource_1.APIResource {
39
17
  }
40
18
  /**
41
19
  * Create a VM
20
+ *
21
+ * @example
22
+ * ```ts
23
+ * const operation = await client.compute.vms.create({
24
+ * boot_volume: { size: 100 },
25
+ * cpu_config: { vcpu: 2 },
26
+ * memory_config: { size: 2 },
27
+ * name: 'my-vm',
28
+ * os_image_name: 'ubuntu-noble-2025-04-03',
29
+ * public_ip_enabled: true,
30
+ * region: 'us-wdc-1',
31
+ * ssh_key: {
32
+ * public_key:
33
+ * 'ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAAAgQDJiJabIUkXw7VrQG+yBohvhEsyoKEYvejZc4RFzV5maybqQei1punVsoe4r6gJttMM1Gr3cNr3OfepikCQAhAchw5ww94ZWqDsDYIqMrlDFbqhGTXDNzFAjeVIKptCOlz9k+7aM69YtLXJ6gFUCq1fbK9PjY+AK28UpMfKYUcyHQ== noname',
34
+ * },
35
+ * subnet_id: '123e4567-e89b-12d3-a456-426614174000',
36
+ * });
37
+ * ```
42
38
  */
43
39
  create(body, options) {
44
40
  return this._client.post('/v1/compute/vms', { body, ...options });
45
41
  }
46
42
  /**
47
43
  * Update a VM
44
+ *
45
+ * @example
46
+ * ```ts
47
+ * const operation = await client.compute.vms.update('vm_id');
48
+ * ```
48
49
  */
49
50
  update(vmID, body, options) {
50
51
  return this._client.patch((0, path_1.path) `/v1/compute/vms/${vmID}`, { body, ...options });
51
52
  }
52
53
  /**
53
54
  * List all VMs
55
+ *
56
+ * @example
57
+ * ```ts
58
+ * const vmList = await client.compute.vms.list();
59
+ * ```
54
60
  */
55
61
  list(options) {
56
62
  return this._client.get('/v1/compute/vms', options);
57
63
  }
58
64
  /**
59
65
  * Delete a VM
66
+ *
67
+ * @example
68
+ * ```ts
69
+ * const operation = await client.compute.vms.delete('vm_id');
70
+ * ```
60
71
  */
61
72
  delete(vmID, options) {
62
73
  return this._client.delete((0, path_1.path) `/v1/compute/vms/${vmID}`, options);
63
74
  }
64
75
  /**
65
76
  * Get details about a VM
77
+ *
78
+ * @example
79
+ * ```ts
80
+ * const vm = await client.compute.vms.get('vm_id');
81
+ * ```
66
82
  */
67
83
  get(vmID, options) {
68
84
  return this._client.get((0, path_1.path) `/v1/compute/vms/${vmID}`, options);
@@ -1 +1 @@
1
- {"version":3,"file":"vms.js","sourceRoot":"","sources":["../../../src/resources/compute/vms/vms.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;;;;;;;;;;;;;;;;;;;;;;;;AAEtF,wDAAqD;AAGrD,4DAA2C;AAC3C,8CAA4D;AAC5D,yDAAwC;AACxC,0CAAoC;AAGpC,0DAAoD;AAEpD,MAAa,GAAI,SAAQ,sBAAW;IAApC;;QACE,YAAO,GAAuB,IAAI,UAAU,CAAC,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QACnE,aAAQ,GAAyB,IAAI,WAAW,CAAC,QAAQ,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IAoC1E,CAAC;IAlCC;;OAEG;IACH,MAAM,CAAC,IAAoB,EAAE,OAAwB;QACnD,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,iBAAiB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACpE,CAAC;IAED;;OAEG;IACH,MAAM,CAAC,IAAY,EAAE,IAAoB,EAAE,OAAwB;QACjE,OAAO,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,IAAA,WAAI,EAAA,mBAAmB,IAAI,EAAE,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACjF,CAAC;IAED;;OAEG;IACH,IAAI,CAAC,OAAwB;QAC3B,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,iBAAiB,EAAE,OAAO,CAAC,CAAC;IACtD,CAAC;IAED;;OAEG;IACH,MAAM,CAAC,IAAY,EAAE,OAAwB;QAC3C,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAA,WAAI,EAAA,mBAAmB,IAAI,EAAE,EAAE,OAAO,CAAC,CAAC;IACrE,CAAC;IAED;;OAEG;IACH,GAAG,CAAC,IAAY,EAAE,OAAwB;QACxC,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,mBAAmB,IAAI,EAAE,EAAE,OAAO,CAAC,CAAC;IAClE,CAAC;CACF;AAtCD,kBAsCC;AA6OD,GAAG,CAAC,OAAO,GAAG,iBAAO,CAAC;AACtB,GAAG,CAAC,QAAQ,GAAG,oBAAQ,CAAC"}
1
+ {"version":3,"file":"vms.js","sourceRoot":"","sources":["../../../src/resources/compute/vms/vms.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;;AAEtF,wDAAqD;AAGrD,oEAA2C;AAC3C,8CAA4D;AAC5D,iEAAwC;AACxC,0CAAoC;AAGpC,0DAAoD;AAEpD,MAAa,GAAI,SAAQ,sBAAW;IAApC;;QACE,YAAO,GAAuB,IAAI,UAAU,CAAC,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QACnE,aAAQ,GAAyB,IAAI,WAAW,CAAC,QAAQ,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IA0E1E,CAAC;IAxEC;;;;;;;;;;;;;;;;;;;;OAoBG;IACH,MAAM,CAAC,IAAoB,EAAE,OAAwB;QACnD,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,iBAAiB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACpE,CAAC;IAED;;;;;;;OAOG;IACH,MAAM,CAAC,IAAY,EAAE,IAAoB,EAAE,OAAwB;QACjE,OAAO,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,IAAA,WAAI,EAAA,mBAAmB,IAAI,EAAE,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACjF,CAAC;IAED;;;;;;;OAOG;IACH,IAAI,CAAC,OAAwB;QAC3B,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,iBAAiB,EAAE,OAAO,CAAC,CAAC;IACtD,CAAC;IAED;;;;;;;OAOG;IACH,MAAM,CAAC,IAAY,EAAE,OAAwB;QAC3C,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAA,WAAI,EAAA,mBAAmB,IAAI,EAAE,EAAE,OAAO,CAAC,CAAC;IACrE,CAAC;IAED;;;;;;;OAOG;IACH,GAAG,CAAC,IAAY,EAAE,OAAwB;QACxC,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,mBAAmB,IAAI,EAAE,EAAE,OAAO,CAAC,CAAC;IAClE,CAAC;CACF;AA5ED,kBA4EC;AA6OD,GAAG,CAAC,OAAO,GAAG,iBAAO,CAAC;AACtB,GAAG,CAAC,QAAQ,GAAG,oBAAQ,CAAC"}
@@ -13,30 +13,68 @@ export class VMs extends APIResource {
13
13
  }
14
14
  /**
15
15
  * Create a VM
16
+ *
17
+ * @example
18
+ * ```ts
19
+ * const operation = await client.compute.vms.create({
20
+ * boot_volume: { size: 100 },
21
+ * cpu_config: { vcpu: 2 },
22
+ * memory_config: { size: 2 },
23
+ * name: 'my-vm',
24
+ * os_image_name: 'ubuntu-noble-2025-04-03',
25
+ * public_ip_enabled: true,
26
+ * region: 'us-wdc-1',
27
+ * ssh_key: {
28
+ * public_key:
29
+ * 'ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAAAgQDJiJabIUkXw7VrQG+yBohvhEsyoKEYvejZc4RFzV5maybqQei1punVsoe4r6gJttMM1Gr3cNr3OfepikCQAhAchw5ww94ZWqDsDYIqMrlDFbqhGTXDNzFAjeVIKptCOlz9k+7aM69YtLXJ6gFUCq1fbK9PjY+AK28UpMfKYUcyHQ== noname',
30
+ * },
31
+ * subnet_id: '123e4567-e89b-12d3-a456-426614174000',
32
+ * });
33
+ * ```
16
34
  */
17
35
  create(body, options) {
18
36
  return this._client.post('/v1/compute/vms', { body, ...options });
19
37
  }
20
38
  /**
21
39
  * Update a VM
40
+ *
41
+ * @example
42
+ * ```ts
43
+ * const operation = await client.compute.vms.update('vm_id');
44
+ * ```
22
45
  */
23
46
  update(vmID, body, options) {
24
47
  return this._client.patch(path `/v1/compute/vms/${vmID}`, { body, ...options });
25
48
  }
26
49
  /**
27
50
  * List all VMs
51
+ *
52
+ * @example
53
+ * ```ts
54
+ * const vmList = await client.compute.vms.list();
55
+ * ```
28
56
  */
29
57
  list(options) {
30
58
  return this._client.get('/v1/compute/vms', options);
31
59
  }
32
60
  /**
33
61
  * Delete a VM
62
+ *
63
+ * @example
64
+ * ```ts
65
+ * const operation = await client.compute.vms.delete('vm_id');
66
+ * ```
34
67
  */
35
68
  delete(vmID, options) {
36
69
  return this._client.delete(path `/v1/compute/vms/${vmID}`, options);
37
70
  }
38
71
  /**
39
72
  * Get details about a VM
73
+ *
74
+ * @example
75
+ * ```ts
76
+ * const vm = await client.compute.vms.get('vm_id');
77
+ * ```
40
78
  */
41
79
  get(vmID, options) {
42
80
  return this._client.get(path `/v1/compute/vms/${vmID}`, options);
@@ -1 +1 @@
1
- {"version":3,"file":"vms.mjs","sourceRoot":"","sources":["../../../src/resources/compute/vms/vms.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;OAGf,KAAK,WAAW;OAChB,EAAuB,QAAQ,EAAE;OACjC,KAAK,UAAU;OACf,EAAE,OAAO,EAAE;OAGX,EAAE,IAAI,EAAE;AAEf,MAAM,OAAO,GAAI,SAAQ,WAAW;IAApC;;QACE,YAAO,GAAuB,IAAI,UAAU,CAAC,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QACnE,aAAQ,GAAyB,IAAI,WAAW,CAAC,QAAQ,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IAoC1E,CAAC;IAlCC;;OAEG;IACH,MAAM,CAAC,IAAoB,EAAE,OAAwB;QACnD,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,iBAAiB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACpE,CAAC;IAED;;OAEG;IACH,MAAM,CAAC,IAAY,EAAE,IAAoB,EAAE,OAAwB;QACjE,OAAO,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,IAAI,CAAA,mBAAmB,IAAI,EAAE,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACjF,CAAC;IAED;;OAEG;IACH,IAAI,CAAC,OAAwB;QAC3B,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,iBAAiB,EAAE,OAAO,CAAC,CAAC;IACtD,CAAC;IAED;;OAEG;IACH,MAAM,CAAC,IAAY,EAAE,OAAwB;QAC3C,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,CAAA,mBAAmB,IAAI,EAAE,EAAE,OAAO,CAAC,CAAC;IACrE,CAAC;IAED;;OAEG;IACH,GAAG,CAAC,IAAY,EAAE,OAAwB;QACxC,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,mBAAmB,IAAI,EAAE,EAAE,OAAO,CAAC,CAAC;IAClE,CAAC;CACF;AA6OD,GAAG,CAAC,OAAO,GAAG,OAAO,CAAC;AACtB,GAAG,CAAC,QAAQ,GAAG,QAAQ,CAAC"}
1
+ {"version":3,"file":"vms.mjs","sourceRoot":"","sources":["../../../src/resources/compute/vms/vms.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;OAGf,KAAK,WAAW;OAChB,EAAuB,QAAQ,EAAE;OACjC,KAAK,UAAU;OACf,EAAE,OAAO,EAAE;OAGX,EAAE,IAAI,EAAE;AAEf,MAAM,OAAO,GAAI,SAAQ,WAAW;IAApC;;QACE,YAAO,GAAuB,IAAI,UAAU,CAAC,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QACnE,aAAQ,GAAyB,IAAI,WAAW,CAAC,QAAQ,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IA0E1E,CAAC;IAxEC;;;;;;;;;;;;;;;;;;;;OAoBG;IACH,MAAM,CAAC,IAAoB,EAAE,OAAwB;QACnD,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,iBAAiB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACpE,CAAC;IAED;;;;;;;OAOG;IACH,MAAM,CAAC,IAAY,EAAE,IAAoB,EAAE,OAAwB;QACjE,OAAO,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,IAAI,CAAA,mBAAmB,IAAI,EAAE,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACjF,CAAC;IAED;;;;;;;OAOG;IACH,IAAI,CAAC,OAAwB;QAC3B,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,iBAAiB,EAAE,OAAO,CAAC,CAAC;IACtD,CAAC;IAED;;;;;;;OAOG;IACH,MAAM,CAAC,IAAY,EAAE,OAAwB;QAC3C,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,CAAA,mBAAmB,IAAI,EAAE,EAAE,OAAO,CAAC,CAAC;IACrE,CAAC;IAED;;;;;;;OAOG;IACH,GAAG,CAAC,IAAY,EAAE,OAAwB;QACxC,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,mBAAmB,IAAI,EAAE,EAAE,OAAO,CAAC,CAAC;IAClE,CAAC;CACF;AA6OD,GAAG,CAAC,OAAO,GAAG,OAAO,CAAC;AACtB,GAAG,CAAC,QAAQ,GAAG,QAAQ,CAAC"}
@@ -5,6 +5,13 @@ import { RequestOptions } from "../../../internal/request-options.mjs";
5
5
  export declare class Volumes extends APIResource {
6
6
  /**
7
7
  * List VM's Volumes
8
+ *
9
+ * @example
10
+ * ```ts
11
+ * const volumeList = await client.compute.vms.volumes.list(
12
+ * 'vm_id',
13
+ * );
14
+ * ```
8
15
  */
9
16
  list(vmID: string, options?: RequestOptions): APIPromise<VolumesAPI.VolumeList>;
10
17
  }
@@ -1 +1 @@
1
- {"version":3,"file":"volumes.d.mts","sourceRoot":"","sources":["../../../src/resources/compute/vms/volumes.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,KAAK,UAAU;OACf,EAAE,UAAU,EAAE;OACd,EAAE,cAAc,EAAE;AAGzB,qBAAa,OAAQ,SAAQ,WAAW;IACtC;;OAEG;IACH,IAAI,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,UAAU,CAAC,UAAU,CAAC;CAGhF"}
1
+ {"version":3,"file":"volumes.d.mts","sourceRoot":"","sources":["../../../src/resources/compute/vms/volumes.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,KAAK,UAAU;OACf,EAAE,UAAU,EAAE;OACd,EAAE,cAAc,EAAE;AAGzB,qBAAa,OAAQ,SAAQ,WAAW;IACtC;;;;;;;;;OASG;IACH,IAAI,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,UAAU,CAAC,UAAU,CAAC;CAGhF"}
@@ -5,6 +5,13 @@ import { RequestOptions } from "../../../internal/request-options.js";
5
5
  export declare class Volumes extends APIResource {
6
6
  /**
7
7
  * List VM's Volumes
8
+ *
9
+ * @example
10
+ * ```ts
11
+ * const volumeList = await client.compute.vms.volumes.list(
12
+ * 'vm_id',
13
+ * );
14
+ * ```
8
15
  */
9
16
  list(vmID: string, options?: RequestOptions): APIPromise<VolumesAPI.VolumeList>;
10
17
  }
@@ -1 +1 @@
1
- {"version":3,"file":"volumes.d.ts","sourceRoot":"","sources":["../../../src/resources/compute/vms/volumes.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,KAAK,UAAU;OACf,EAAE,UAAU,EAAE;OACd,EAAE,cAAc,EAAE;AAGzB,qBAAa,OAAQ,SAAQ,WAAW;IACtC;;OAEG;IACH,IAAI,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,UAAU,CAAC,UAAU,CAAC;CAGhF"}
1
+ {"version":3,"file":"volumes.d.ts","sourceRoot":"","sources":["../../../src/resources/compute/vms/volumes.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,KAAK,UAAU;OACf,EAAE,UAAU,EAAE;OACd,EAAE,cAAc,EAAE;AAGzB,qBAAa,OAAQ,SAAQ,WAAW;IACtC;;;;;;;;;OASG;IACH,IAAI,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,UAAU,CAAC,UAAU,CAAC;CAGhF"}
@@ -7,6 +7,13 @@ const path_1 = require("../../../internal/utils/path.js");
7
7
  class Volumes extends resource_1.APIResource {
8
8
  /**
9
9
  * List VM's Volumes
10
+ *
11
+ * @example
12
+ * ```ts
13
+ * const volumeList = await client.compute.vms.volumes.list(
14
+ * 'vm_id',
15
+ * );
16
+ * ```
10
17
  */
11
18
  list(vmID, options) {
12
19
  return this._client.get((0, path_1.path) `/v1/compute/vms/${vmID}/volumes`, options);
@@ -1 +1 @@
1
- {"version":3,"file":"volumes.js","sourceRoot":"","sources":["../../../src/resources/compute/vms/volumes.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,wDAAqD;AAIrD,0DAAoD;AAEpD,MAAa,OAAQ,SAAQ,sBAAW;IACtC;;OAEG;IACH,IAAI,CAAC,IAAY,EAAE,OAAwB;QACzC,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,mBAAmB,IAAI,UAAU,EAAE,OAAO,CAAC,CAAC;IAC1E,CAAC;CACF;AAPD,0BAOC"}
1
+ {"version":3,"file":"volumes.js","sourceRoot":"","sources":["../../../src/resources/compute/vms/volumes.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,wDAAqD;AAIrD,0DAAoD;AAEpD,MAAa,OAAQ,SAAQ,sBAAW;IACtC;;;;;;;;;OASG;IACH,IAAI,CAAC,IAAY,EAAE,OAAwB;QACzC,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,mBAAmB,IAAI,UAAU,EAAE,OAAO,CAAC,CAAC;IAC1E,CAAC;CACF;AAdD,0BAcC"}
@@ -4,6 +4,13 @@ import { path } from "../../../internal/utils/path.mjs";
4
4
  export class Volumes extends APIResource {
5
5
  /**
6
6
  * List VM's Volumes
7
+ *
8
+ * @example
9
+ * ```ts
10
+ * const volumeList = await client.compute.vms.volumes.list(
11
+ * 'vm_id',
12
+ * );
13
+ * ```
7
14
  */
8
15
  list(vmID, options) {
9
16
  return this._client.get(path `/v1/compute/vms/${vmID}/volumes`, options);
@@ -1 +1 @@
1
- {"version":3,"file":"volumes.mjs","sourceRoot":"","sources":["../../../src/resources/compute/vms/volumes.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;OAIf,EAAE,IAAI,EAAE;AAEf,MAAM,OAAO,OAAQ,SAAQ,WAAW;IACtC;;OAEG;IACH,IAAI,CAAC,IAAY,EAAE,OAAwB;QACzC,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,mBAAmB,IAAI,UAAU,EAAE,OAAO,CAAC,CAAC;IAC1E,CAAC;CACF"}
1
+ {"version":3,"file":"volumes.mjs","sourceRoot":"","sources":["../../../src/resources/compute/vms/volumes.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;OAIf,EAAE,IAAI,EAAE;AAEf,MAAM,OAAO,OAAQ,SAAQ,WAAW;IACtC;;;;;;;;;OASG;IACH,IAAI,CAAC,IAAY,EAAE,OAAwB;QACzC,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,mBAAmB,IAAI,UAAU,EAAE,OAAO,CAAC,CAAC;IAC1E,CAAC;CACF"}
@@ -1,19 +1,6 @@
1
1
  "use strict";
2
2
  // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
3
- var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
4
- if (k2 === undefined) k2 = k;
5
- var desc = Object.getOwnPropertyDescriptor(m, k);
6
- if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
7
- desc = { enumerable: true, get: function() { return m[k]; } };
8
- }
9
- Object.defineProperty(o, k2, desc);
10
- }) : (function(o, m, k, k2) {
11
- if (k2 === undefined) k2 = k;
12
- o[k2] = m[k];
13
- }));
14
- var __exportStar = (this && this.__exportStar) || function(m, exports) {
15
- for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
16
- };
17
3
  Object.defineProperty(exports, "__esModule", { value: true });
18
- __exportStar(require("./vms/index.js"), exports);
4
+ const tslib_1 = require("../../internal/tslib.js");
5
+ tslib_1.__exportStar(require("./vms/index.js"), exports);
19
6
  //# sourceMappingURL=vms.js.map