@nirvana-labs/nirvana 1.0.5 → 1.1.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (148) hide show
  1. package/CHANGELOG.md +26 -0
  2. package/README.md +1 -1
  3. package/client.d.mts +4 -0
  4. package/client.d.mts.map +1 -1
  5. package/client.d.ts +4 -0
  6. package/client.d.ts.map +1 -1
  7. package/client.js +16 -0
  8. package/client.js.map +1 -1
  9. package/client.mjs +16 -0
  10. package/client.mjs.map +1 -1
  11. package/internal/headers.js +1 -1
  12. package/internal/headers.js.map +1 -1
  13. package/internal/headers.mjs +1 -1
  14. package/internal/headers.mjs.map +1 -1
  15. package/internal/to-file.d.mts +0 -1
  16. package/internal/to-file.d.mts.map +1 -1
  17. package/internal/to-file.d.ts +0 -1
  18. package/internal/to-file.d.ts.map +1 -1
  19. package/internal/to-file.js +3 -2
  20. package/internal/to-file.js.map +1 -1
  21. package/internal/to-file.mjs +3 -2
  22. package/internal/to-file.mjs.map +1 -1
  23. package/internal/uploads.d.mts +1 -1
  24. package/internal/uploads.d.mts.map +1 -1
  25. package/internal/uploads.d.ts +1 -1
  26. package/internal/uploads.d.ts.map +1 -1
  27. package/internal/uploads.js +14 -4
  28. package/internal/uploads.js.map +1 -1
  29. package/internal/uploads.mjs +12 -3
  30. package/internal/uploads.mjs.map +1 -1
  31. package/internal/utils/uuid.d.mts +1 -1
  32. package/internal/utils/uuid.d.mts.map +1 -1
  33. package/internal/utils/uuid.d.ts +1 -1
  34. package/internal/utils/uuid.d.ts.map +1 -1
  35. package/internal/utils/uuid.js +1 -2
  36. package/internal/utils/uuid.js.map +1 -1
  37. package/internal/utils/uuid.mjs +1 -2
  38. package/internal/utils/uuid.mjs.map +1 -1
  39. package/package.json +4 -5
  40. package/resources/api-keys.d.mts +28 -0
  41. package/resources/api-keys.d.mts.map +1 -1
  42. package/resources/api-keys.d.ts +28 -0
  43. package/resources/api-keys.d.ts.map +1 -1
  44. package/resources/api-keys.js +28 -0
  45. package/resources/api-keys.js.map +1 -1
  46. package/resources/api-keys.mjs +28 -0
  47. package/resources/api-keys.mjs.map +1 -1
  48. package/resources/compute/vms/os-images.d.mts +5 -0
  49. package/resources/compute/vms/os-images.d.mts.map +1 -1
  50. package/resources/compute/vms/os-images.d.ts +5 -0
  51. package/resources/compute/vms/os-images.d.ts.map +1 -1
  52. package/resources/compute/vms/os-images.js +5 -0
  53. package/resources/compute/vms/os-images.js.map +1 -1
  54. package/resources/compute/vms/os-images.mjs +5 -0
  55. package/resources/compute/vms/os-images.mjs.map +1 -1
  56. package/resources/compute/vms/vms.d.mts +38 -0
  57. package/resources/compute/vms/vms.d.mts.map +1 -1
  58. package/resources/compute/vms/vms.d.ts +38 -0
  59. package/resources/compute/vms/vms.d.ts.map +1 -1
  60. package/resources/compute/vms/vms.js +38 -0
  61. package/resources/compute/vms/vms.js.map +1 -1
  62. package/resources/compute/vms/vms.mjs +38 -0
  63. package/resources/compute/vms/vms.mjs.map +1 -1
  64. package/resources/compute/vms/volumes.d.mts +7 -0
  65. package/resources/compute/vms/volumes.d.mts.map +1 -1
  66. package/resources/compute/vms/volumes.d.ts +7 -0
  67. package/resources/compute/vms/volumes.d.ts.map +1 -1
  68. package/resources/compute/vms/volumes.js +7 -0
  69. package/resources/compute/vms/volumes.js.map +1 -1
  70. package/resources/compute/vms/volumes.mjs +7 -0
  71. package/resources/compute/vms/volumes.mjs.map +1 -1
  72. package/resources/compute/volumes.d.mts +35 -0
  73. package/resources/compute/volumes.d.mts.map +1 -1
  74. package/resources/compute/volumes.d.ts +35 -0
  75. package/resources/compute/volumes.d.ts.map +1 -1
  76. package/resources/compute/volumes.js +35 -0
  77. package/resources/compute/volumes.js.map +1 -1
  78. package/resources/compute/volumes.mjs +35 -0
  79. package/resources/compute/volumes.mjs.map +1 -1
  80. package/resources/networking/firewall-rules.d.mts +45 -0
  81. package/resources/networking/firewall-rules.d.mts.map +1 -1
  82. package/resources/networking/firewall-rules.d.ts +45 -0
  83. package/resources/networking/firewall-rules.d.ts.map +1 -1
  84. package/resources/networking/firewall-rules.js +45 -0
  85. package/resources/networking/firewall-rules.js.map +1 -1
  86. package/resources/networking/firewall-rules.mjs +45 -0
  87. package/resources/networking/firewall-rules.mjs.map +1 -1
  88. package/resources/networking/vpcs.d.mts +33 -0
  89. package/resources/networking/vpcs.d.mts.map +1 -1
  90. package/resources/networking/vpcs.d.ts +33 -0
  91. package/resources/networking/vpcs.d.ts.map +1 -1
  92. package/resources/networking/vpcs.js +33 -0
  93. package/resources/networking/vpcs.js.map +1 -1
  94. package/resources/networking/vpcs.mjs +33 -0
  95. package/resources/networking/vpcs.mjs.map +1 -1
  96. package/src/client.ts +17 -0
  97. package/src/internal/headers.ts +1 -1
  98. package/src/internal/to-file.ts +4 -2
  99. package/src/internal/uploads.ts +16 -4
  100. package/src/internal/utils/uuid.ts +1 -3
  101. package/src/resources/api-keys.ts +28 -0
  102. package/src/resources/compute/vms/os-images.ts +5 -0
  103. package/src/resources/compute/vms/vms.ts +38 -0
  104. package/src/resources/compute/vms/volumes.ts +7 -0
  105. package/src/resources/compute/volumes.ts +35 -0
  106. package/src/resources/networking/firewall-rules.ts +45 -0
  107. package/src/resources/networking/vpcs.ts +33 -0
  108. package/src/version.ts +1 -1
  109. package/version.d.mts +1 -1
  110. package/version.d.ts +1 -1
  111. package/version.js +1 -1
  112. package/version.mjs +1 -1
  113. package/internal/shims/crypto.d.mts +0 -13
  114. package/internal/shims/crypto.d.mts.map +0 -1
  115. package/internal/shims/crypto.d.ts +0 -13
  116. package/internal/shims/crypto.d.ts.map +0 -1
  117. package/internal/shims/crypto.js +0 -13
  118. package/internal/shims/crypto.js.map +0 -1
  119. package/internal/shims/crypto.mjs +0 -9
  120. package/internal/shims/crypto.mjs.map +0 -1
  121. package/internal/shims/file.d.mts +0 -22
  122. package/internal/shims/file.d.mts.map +0 -1
  123. package/internal/shims/file.d.ts +0 -22
  124. package/internal/shims/file.d.ts.map +0 -1
  125. package/internal/shims/file.js +0 -16
  126. package/internal/shims/file.js.map +0 -1
  127. package/internal/shims/file.mjs +0 -12
  128. package/internal/shims/file.mjs.map +0 -1
  129. package/internal/shims/getBuiltinModule.d.mts +0 -11
  130. package/internal/shims/getBuiltinModule.d.mts.map +0 -1
  131. package/internal/shims/getBuiltinModule.d.ts +0 -11
  132. package/internal/shims/getBuiltinModule.d.ts.map +0 -1
  133. package/internal/shims/getBuiltinModule.js +0 -71
  134. package/internal/shims/getBuiltinModule.js.map +0 -1
  135. package/internal/shims/getBuiltinModule.mjs +0 -67
  136. package/internal/shims/getBuiltinModule.mjs.map +0 -1
  137. package/internal/shims/nullGetBuiltinModule.d.mts +0 -2
  138. package/internal/shims/nullGetBuiltinModule.d.mts.map +0 -1
  139. package/internal/shims/nullGetBuiltinModule.d.ts +0 -2
  140. package/internal/shims/nullGetBuiltinModule.d.ts.map +0 -1
  141. package/internal/shims/nullGetBuiltinModule.js +0 -5
  142. package/internal/shims/nullGetBuiltinModule.js.map +0 -1
  143. package/internal/shims/nullGetBuiltinModule.mjs +0 -2
  144. package/internal/shims/nullGetBuiltinModule.mjs.map +0 -1
  145. package/src/internal/shims/crypto.ts +0 -18
  146. package/src/internal/shims/file.ts +0 -32
  147. package/src/internal/shims/getBuiltinModule.ts +0 -66
  148. package/src/internal/shims/nullGetBuiltinModule.ts +0 -1
@@ -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"}
@@ -17,30 +17,68 @@ class VMs extends resource_1.APIResource {
17
17
  }
18
18
  /**
19
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
+ * ```
20
38
  */
21
39
  create(body, options) {
22
40
  return this._client.post('/v1/compute/vms', { body, ...options });
23
41
  }
24
42
  /**
25
43
  * Update a VM
44
+ *
45
+ * @example
46
+ * ```ts
47
+ * const operation = await client.compute.vms.update('vm_id');
48
+ * ```
26
49
  */
27
50
  update(vmID, body, options) {
28
51
  return this._client.patch((0, path_1.path) `/v1/compute/vms/${vmID}`, { body, ...options });
29
52
  }
30
53
  /**
31
54
  * List all VMs
55
+ *
56
+ * @example
57
+ * ```ts
58
+ * const vmList = await client.compute.vms.list();
59
+ * ```
32
60
  */
33
61
  list(options) {
34
62
  return this._client.get('/v1/compute/vms', options);
35
63
  }
36
64
  /**
37
65
  * Delete a VM
66
+ *
67
+ * @example
68
+ * ```ts
69
+ * const operation = await client.compute.vms.delete('vm_id');
70
+ * ```
38
71
  */
39
72
  delete(vmID, options) {
40
73
  return this._client.delete((0, path_1.path) `/v1/compute/vms/${vmID}`, options);
41
74
  }
42
75
  /**
43
76
  * Get details about a VM
77
+ *
78
+ * @example
79
+ * ```ts
80
+ * const vm = await client.compute.vms.get('vm_id');
81
+ * ```
44
82
  */
45
83
  get(vmID, options) {
46
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,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;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"}
@@ -6,22 +6,57 @@ import { RequestOptions } from "../../internal/request-options.mjs";
6
6
  export declare class Volumes extends APIResource {
7
7
  /**
8
8
  * Create a Volume. Only data volumes can be created.
9
+ *
10
+ * @example
11
+ * ```ts
12
+ * const operation = await client.compute.volumes.create({
13
+ * name: 'my-data-volume',
14
+ * size: 100,
15
+ * vm_id: 'vm_id',
16
+ * });
17
+ * ```
9
18
  */
10
19
  create(body: VolumeCreateParams, options?: RequestOptions): APIPromise<OperationsAPI.Operation>;
11
20
  /**
12
21
  * Update a Volume. Boot or data volumes can be updated.
22
+ *
23
+ * @example
24
+ * ```ts
25
+ * const operation = await client.compute.volumes.update(
26
+ * 'volume_id',
27
+ * );
28
+ * ```
13
29
  */
14
30
  update(volumeID: string, body: VolumeUpdateParams, options?: RequestOptions): APIPromise<OperationsAPI.Operation>;
15
31
  /**
16
32
  * List all volumes
33
+ *
34
+ * @example
35
+ * ```ts
36
+ * const volumeList = await client.compute.volumes.list();
37
+ * ```
17
38
  */
18
39
  list(options?: RequestOptions): APIPromise<VolumeList>;
19
40
  /**
20
41
  * Delete a Volume. Boot or data volumes can be deleted.
42
+ *
43
+ * @example
44
+ * ```ts
45
+ * const operation = await client.compute.volumes.delete(
46
+ * 'volume_id',
47
+ * );
48
+ * ```
21
49
  */
22
50
  delete(volumeID: string, options?: RequestOptions): APIPromise<OperationsAPI.Operation>;
23
51
  /**
24
52
  * Get a Volume.
53
+ *
54
+ * @example
55
+ * ```ts
56
+ * const volume = await client.compute.volumes.get(
57
+ * 'volume_id',
58
+ * );
59
+ * ```
25
60
  */
26
61
  get(volumeID: string, options?: RequestOptions): APIPromise<Volume>;
27
62
  }
@@ -1 +1 @@
1
- {"version":3,"file":"volumes.d.mts","sourceRoot":"","sources":["../../src/resources/compute/volumes.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,KAAK,aAAa;OAClB,KAAK,MAAM;OACX,EAAE,UAAU,EAAE;OACd,EAAE,cAAc,EAAE;AAGzB,qBAAa,OAAQ,SAAQ,WAAW;IACtC;;OAEG;IACH,MAAM,CAAC,IAAI,EAAE,kBAAkB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,aAAa,CAAC,SAAS,CAAC;IAI/F;;OAEG;IACH,MAAM,CACJ,QAAQ,EAAE,MAAM,EAChB,IAAI,EAAE,kBAAkB,EACxB,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,aAAa,CAAC,SAAS,CAAC;IAItC;;OAEG;IACH,IAAI,CAAC,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,UAAU,CAAC;IAItD;;OAEG;IACH,MAAM,CAAC,QAAQ,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,aAAa,CAAC,SAAS,CAAC;IAIvF;;OAEG;IACH,GAAG,CAAC,QAAQ,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,MAAM,CAAC;CAGpE;AAED;;GAEG;AACH,MAAM,MAAM,WAAW,GAAG,MAAM,CAAC;AAEjC;;GAEG;AACH,MAAM,WAAW,MAAM;IACrB;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,IAAI,EAAE,UAAU,CAAC;IAEjB;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC,cAAc,CAAC;IAE9B;;OAEG;IACH,IAAI,EAAE,WAAW,CAAC;IAElB;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,KAAK,EAAE,MAAM,GAAG,IAAI,CAAC;IAErB;;OAEG;IACH,OAAO,EAAE,MAAM,GAAG,IAAI,CAAC;CACxB;AAED;;GAEG;AACH,MAAM,MAAM,UAAU,GAAG,MAAM,GAAG,MAAM,CAAC;AAEzC,MAAM,WAAW,UAAU;IACzB,KAAK,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;CACtB;AAED,MAAM,WAAW,kBAAkB;IACjC;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;CACf;AAED,MAAM,WAAW,kBAAkB;IACjC;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;CACf;AAED,MAAM,CAAC,OAAO,WAAW,OAAO,CAAC;IAC/B,OAAO,EACL,KAAK,WAAW,IAAI,WAAW,EAC/B,KAAK,MAAM,IAAI,MAAM,EACrB,KAAK,UAAU,IAAI,UAAU,EAC7B,KAAK,UAAU,IAAI,UAAU,EAC7B,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,kBAAkB,IAAI,kBAAkB,GAC9C,CAAC;CACH"}
1
+ {"version":3,"file":"volumes.d.mts","sourceRoot":"","sources":["../../src/resources/compute/volumes.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,KAAK,aAAa;OAClB,KAAK,MAAM;OACX,EAAE,UAAU,EAAE;OACd,EAAE,cAAc,EAAE;AAGzB,qBAAa,OAAQ,SAAQ,WAAW;IACtC;;;;;;;;;;;OAWG;IACH,MAAM,CAAC,IAAI,EAAE,kBAAkB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,aAAa,CAAC,SAAS,CAAC;IAI/F;;;;;;;;;OASG;IACH,MAAM,CACJ,QAAQ,EAAE,MAAM,EAChB,IAAI,EAAE,kBAAkB,EACxB,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,aAAa,CAAC,SAAS,CAAC;IAItC;;;;;;;OAOG;IACH,IAAI,CAAC,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,UAAU,CAAC;IAItD;;;;;;;;;OASG;IACH,MAAM,CAAC,QAAQ,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,aAAa,CAAC,SAAS,CAAC;IAIvF;;;;;;;;;OASG;IACH,GAAG,CAAC,QAAQ,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,MAAM,CAAC;CAGpE;AAED;;GAEG;AACH,MAAM,MAAM,WAAW,GAAG,MAAM,CAAC;AAEjC;;GAEG;AACH,MAAM,WAAW,MAAM;IACrB;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,IAAI,EAAE,UAAU,CAAC;IAEjB;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC,cAAc,CAAC;IAE9B;;OAEG;IACH,IAAI,EAAE,WAAW,CAAC;IAElB;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,KAAK,EAAE,MAAM,GAAG,IAAI,CAAC;IAErB;;OAEG;IACH,OAAO,EAAE,MAAM,GAAG,IAAI,CAAC;CACxB;AAED;;GAEG;AACH,MAAM,MAAM,UAAU,GAAG,MAAM,GAAG,MAAM,CAAC;AAEzC,MAAM,WAAW,UAAU;IACzB,KAAK,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;CACtB;AAED,MAAM,WAAW,kBAAkB;IACjC;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;CACf;AAED,MAAM,WAAW,kBAAkB;IACjC;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;CACf;AAED,MAAM,CAAC,OAAO,WAAW,OAAO,CAAC;IAC/B,OAAO,EACL,KAAK,WAAW,IAAI,WAAW,EAC/B,KAAK,MAAM,IAAI,MAAM,EACrB,KAAK,UAAU,IAAI,UAAU,EAC7B,KAAK,UAAU,IAAI,UAAU,EAC7B,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,kBAAkB,IAAI,kBAAkB,GAC9C,CAAC;CACH"}
@@ -6,22 +6,57 @@ import { RequestOptions } from "../../internal/request-options.js";
6
6
  export declare class Volumes extends APIResource {
7
7
  /**
8
8
  * Create a Volume. Only data volumes can be created.
9
+ *
10
+ * @example
11
+ * ```ts
12
+ * const operation = await client.compute.volumes.create({
13
+ * name: 'my-data-volume',
14
+ * size: 100,
15
+ * vm_id: 'vm_id',
16
+ * });
17
+ * ```
9
18
  */
10
19
  create(body: VolumeCreateParams, options?: RequestOptions): APIPromise<OperationsAPI.Operation>;
11
20
  /**
12
21
  * Update a Volume. Boot or data volumes can be updated.
22
+ *
23
+ * @example
24
+ * ```ts
25
+ * const operation = await client.compute.volumes.update(
26
+ * 'volume_id',
27
+ * );
28
+ * ```
13
29
  */
14
30
  update(volumeID: string, body: VolumeUpdateParams, options?: RequestOptions): APIPromise<OperationsAPI.Operation>;
15
31
  /**
16
32
  * List all volumes
33
+ *
34
+ * @example
35
+ * ```ts
36
+ * const volumeList = await client.compute.volumes.list();
37
+ * ```
17
38
  */
18
39
  list(options?: RequestOptions): APIPromise<VolumeList>;
19
40
  /**
20
41
  * Delete a Volume. Boot or data volumes can be deleted.
42
+ *
43
+ * @example
44
+ * ```ts
45
+ * const operation = await client.compute.volumes.delete(
46
+ * 'volume_id',
47
+ * );
48
+ * ```
21
49
  */
22
50
  delete(volumeID: string, options?: RequestOptions): APIPromise<OperationsAPI.Operation>;
23
51
  /**
24
52
  * Get a Volume.
53
+ *
54
+ * @example
55
+ * ```ts
56
+ * const volume = await client.compute.volumes.get(
57
+ * 'volume_id',
58
+ * );
59
+ * ```
25
60
  */
26
61
  get(volumeID: string, options?: RequestOptions): APIPromise<Volume>;
27
62
  }
@@ -1 +1 @@
1
- {"version":3,"file":"volumes.d.ts","sourceRoot":"","sources":["../../src/resources/compute/volumes.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,KAAK,aAAa;OAClB,KAAK,MAAM;OACX,EAAE,UAAU,EAAE;OACd,EAAE,cAAc,EAAE;AAGzB,qBAAa,OAAQ,SAAQ,WAAW;IACtC;;OAEG;IACH,MAAM,CAAC,IAAI,EAAE,kBAAkB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,aAAa,CAAC,SAAS,CAAC;IAI/F;;OAEG;IACH,MAAM,CACJ,QAAQ,EAAE,MAAM,EAChB,IAAI,EAAE,kBAAkB,EACxB,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,aAAa,CAAC,SAAS,CAAC;IAItC;;OAEG;IACH,IAAI,CAAC,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,UAAU,CAAC;IAItD;;OAEG;IACH,MAAM,CAAC,QAAQ,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,aAAa,CAAC,SAAS,CAAC;IAIvF;;OAEG;IACH,GAAG,CAAC,QAAQ,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,MAAM,CAAC;CAGpE;AAED;;GAEG;AACH,MAAM,MAAM,WAAW,GAAG,MAAM,CAAC;AAEjC;;GAEG;AACH,MAAM,WAAW,MAAM;IACrB;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,IAAI,EAAE,UAAU,CAAC;IAEjB;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC,cAAc,CAAC;IAE9B;;OAEG;IACH,IAAI,EAAE,WAAW,CAAC;IAElB;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,KAAK,EAAE,MAAM,GAAG,IAAI,CAAC;IAErB;;OAEG;IACH,OAAO,EAAE,MAAM,GAAG,IAAI,CAAC;CACxB;AAED;;GAEG;AACH,MAAM,MAAM,UAAU,GAAG,MAAM,GAAG,MAAM,CAAC;AAEzC,MAAM,WAAW,UAAU;IACzB,KAAK,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;CACtB;AAED,MAAM,WAAW,kBAAkB;IACjC;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;CACf;AAED,MAAM,WAAW,kBAAkB;IACjC;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;CACf;AAED,MAAM,CAAC,OAAO,WAAW,OAAO,CAAC;IAC/B,OAAO,EACL,KAAK,WAAW,IAAI,WAAW,EAC/B,KAAK,MAAM,IAAI,MAAM,EACrB,KAAK,UAAU,IAAI,UAAU,EAC7B,KAAK,UAAU,IAAI,UAAU,EAC7B,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,kBAAkB,IAAI,kBAAkB,GAC9C,CAAC;CACH"}
1
+ {"version":3,"file":"volumes.d.ts","sourceRoot":"","sources":["../../src/resources/compute/volumes.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,KAAK,aAAa;OAClB,KAAK,MAAM;OACX,EAAE,UAAU,EAAE;OACd,EAAE,cAAc,EAAE;AAGzB,qBAAa,OAAQ,SAAQ,WAAW;IACtC;;;;;;;;;;;OAWG;IACH,MAAM,CAAC,IAAI,EAAE,kBAAkB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,aAAa,CAAC,SAAS,CAAC;IAI/F;;;;;;;;;OASG;IACH,MAAM,CACJ,QAAQ,EAAE,MAAM,EAChB,IAAI,EAAE,kBAAkB,EACxB,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,aAAa,CAAC,SAAS,CAAC;IAItC;;;;;;;OAOG;IACH,IAAI,CAAC,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,UAAU,CAAC;IAItD;;;;;;;;;OASG;IACH,MAAM,CAAC,QAAQ,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,aAAa,CAAC,SAAS,CAAC;IAIvF;;;;;;;;;OASG;IACH,GAAG,CAAC,QAAQ,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,MAAM,CAAC;CAGpE;AAED;;GAEG;AACH,MAAM,MAAM,WAAW,GAAG,MAAM,CAAC;AAEjC;;GAEG;AACH,MAAM,WAAW,MAAM;IACrB;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,IAAI,EAAE,UAAU,CAAC;IAEjB;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC,cAAc,CAAC;IAE9B;;OAEG;IACH,IAAI,EAAE,WAAW,CAAC;IAElB;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,KAAK,EAAE,MAAM,GAAG,IAAI,CAAC;IAErB;;OAEG;IACH,OAAO,EAAE,MAAM,GAAG,IAAI,CAAC;CACxB;AAED;;GAEG;AACH,MAAM,MAAM,UAAU,GAAG,MAAM,GAAG,MAAM,CAAC;AAEzC,MAAM,WAAW,UAAU;IACzB,KAAK,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;CACtB;AAED,MAAM,WAAW,kBAAkB;IACjC;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;CACf;AAED,MAAM,WAAW,kBAAkB;IACjC;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;CACf;AAED,MAAM,CAAC,OAAO,WAAW,OAAO,CAAC;IAC/B,OAAO,EACL,KAAK,WAAW,IAAI,WAAW,EAC/B,KAAK,MAAM,IAAI,MAAM,EACrB,KAAK,UAAU,IAAI,UAAU,EAC7B,KAAK,UAAU,IAAI,UAAU,EAC7B,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,kBAAkB,IAAI,kBAAkB,GAC9C,CAAC;CACH"}
@@ -7,30 +7,65 @@ const path_1 = require("../../internal/utils/path.js");
7
7
  class Volumes extends resource_1.APIResource {
8
8
  /**
9
9
  * Create a Volume. Only data volumes can be created.
10
+ *
11
+ * @example
12
+ * ```ts
13
+ * const operation = await client.compute.volumes.create({
14
+ * name: 'my-data-volume',
15
+ * size: 100,
16
+ * vm_id: 'vm_id',
17
+ * });
18
+ * ```
10
19
  */
11
20
  create(body, options) {
12
21
  return this._client.post('/v1/compute/volumes', { body, ...options });
13
22
  }
14
23
  /**
15
24
  * Update a Volume. Boot or data volumes can be updated.
25
+ *
26
+ * @example
27
+ * ```ts
28
+ * const operation = await client.compute.volumes.update(
29
+ * 'volume_id',
30
+ * );
31
+ * ```
16
32
  */
17
33
  update(volumeID, body, options) {
18
34
  return this._client.patch((0, path_1.path) `/v1/compute/volumes/${volumeID}`, { body, ...options });
19
35
  }
20
36
  /**
21
37
  * List all volumes
38
+ *
39
+ * @example
40
+ * ```ts
41
+ * const volumeList = await client.compute.volumes.list();
42
+ * ```
22
43
  */
23
44
  list(options) {
24
45
  return this._client.get('/v1/compute/volumes', options);
25
46
  }
26
47
  /**
27
48
  * Delete a Volume. Boot or data volumes can be deleted.
49
+ *
50
+ * @example
51
+ * ```ts
52
+ * const operation = await client.compute.volumes.delete(
53
+ * 'volume_id',
54
+ * );
55
+ * ```
28
56
  */
29
57
  delete(volumeID, options) {
30
58
  return this._client.delete((0, path_1.path) `/v1/compute/volumes/${volumeID}`, options);
31
59
  }
32
60
  /**
33
61
  * Get a Volume.
62
+ *
63
+ * @example
64
+ * ```ts
65
+ * const volume = await client.compute.volumes.get(
66
+ * 'volume_id',
67
+ * );
68
+ * ```
34
69
  */
35
70
  get(volumeID, options) {
36
71
  return this._client.get((0, path_1.path) `/v1/compute/volumes/${volumeID}`, options);
@@ -1 +1 @@
1
- {"version":3,"file":"volumes.js","sourceRoot":"","sources":["../../src/resources/compute/volumes.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,qDAAkD;AAKlD,uDAAiD;AAEjD,MAAa,OAAQ,SAAQ,sBAAW;IACtC;;OAEG;IACH,MAAM,CAAC,IAAwB,EAAE,OAAwB;QACvD,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,qBAAqB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACxE,CAAC;IAED;;OAEG;IACH,MAAM,CACJ,QAAgB,EAChB,IAAwB,EACxB,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,IAAA,WAAI,EAAA,uBAAuB,QAAQ,EAAE,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACzF,CAAC;IAED;;OAEG;IACH,IAAI,CAAC,OAAwB;QAC3B,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,qBAAqB,EAAE,OAAO,CAAC,CAAC;IAC1D,CAAC;IAED;;OAEG;IACH,MAAM,CAAC,QAAgB,EAAE,OAAwB;QAC/C,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAA,WAAI,EAAA,uBAAuB,QAAQ,EAAE,EAAE,OAAO,CAAC,CAAC;IAC7E,CAAC;IAED;;OAEG;IACH,GAAG,CAAC,QAAgB,EAAE,OAAwB;QAC5C,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,uBAAuB,QAAQ,EAAE,EAAE,OAAO,CAAC,CAAC;IAC1E,CAAC;CACF;AAvCD,0BAuCC"}
1
+ {"version":3,"file":"volumes.js","sourceRoot":"","sources":["../../src/resources/compute/volumes.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,qDAAkD;AAKlD,uDAAiD;AAEjD,MAAa,OAAQ,SAAQ,sBAAW;IACtC;;;;;;;;;;;OAWG;IACH,MAAM,CAAC,IAAwB,EAAE,OAAwB;QACvD,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,qBAAqB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACxE,CAAC;IAED;;;;;;;;;OASG;IACH,MAAM,CACJ,QAAgB,EAChB,IAAwB,EACxB,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,IAAA,WAAI,EAAA,uBAAuB,QAAQ,EAAE,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACzF,CAAC;IAED;;;;;;;OAOG;IACH,IAAI,CAAC,OAAwB;QAC3B,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,qBAAqB,EAAE,OAAO,CAAC,CAAC;IAC1D,CAAC;IAED;;;;;;;;;OASG;IACH,MAAM,CAAC,QAAgB,EAAE,OAAwB;QAC/C,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAA,WAAI,EAAA,uBAAuB,QAAQ,EAAE,EAAE,OAAO,CAAC,CAAC;IAC7E,CAAC;IAED;;;;;;;;;OASG;IACH,GAAG,CAAC,QAAgB,EAAE,OAAwB;QAC5C,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,uBAAuB,QAAQ,EAAE,EAAE,OAAO,CAAC,CAAC;IAC1E,CAAC;CACF;AA1ED,0BA0EC"}
@@ -4,30 +4,65 @@ import { path } from "../../internal/utils/path.mjs";
4
4
  export class Volumes extends APIResource {
5
5
  /**
6
6
  * Create a Volume. Only data volumes can be created.
7
+ *
8
+ * @example
9
+ * ```ts
10
+ * const operation = await client.compute.volumes.create({
11
+ * name: 'my-data-volume',
12
+ * size: 100,
13
+ * vm_id: 'vm_id',
14
+ * });
15
+ * ```
7
16
  */
8
17
  create(body, options) {
9
18
  return this._client.post('/v1/compute/volumes', { body, ...options });
10
19
  }
11
20
  /**
12
21
  * Update a Volume. Boot or data volumes can be updated.
22
+ *
23
+ * @example
24
+ * ```ts
25
+ * const operation = await client.compute.volumes.update(
26
+ * 'volume_id',
27
+ * );
28
+ * ```
13
29
  */
14
30
  update(volumeID, body, options) {
15
31
  return this._client.patch(path `/v1/compute/volumes/${volumeID}`, { body, ...options });
16
32
  }
17
33
  /**
18
34
  * List all volumes
35
+ *
36
+ * @example
37
+ * ```ts
38
+ * const volumeList = await client.compute.volumes.list();
39
+ * ```
19
40
  */
20
41
  list(options) {
21
42
  return this._client.get('/v1/compute/volumes', options);
22
43
  }
23
44
  /**
24
45
  * Delete a Volume. Boot or data volumes can be deleted.
46
+ *
47
+ * @example
48
+ * ```ts
49
+ * const operation = await client.compute.volumes.delete(
50
+ * 'volume_id',
51
+ * );
52
+ * ```
25
53
  */
26
54
  delete(volumeID, options) {
27
55
  return this._client.delete(path `/v1/compute/volumes/${volumeID}`, options);
28
56
  }
29
57
  /**
30
58
  * Get a Volume.
59
+ *
60
+ * @example
61
+ * ```ts
62
+ * const volume = await client.compute.volumes.get(
63
+ * 'volume_id',
64
+ * );
65
+ * ```
31
66
  */
32
67
  get(volumeID, options) {
33
68
  return this._client.get(path `/v1/compute/volumes/${volumeID}`, options);
@@ -1 +1 @@
1
- {"version":3,"file":"volumes.mjs","sourceRoot":"","sources":["../../src/resources/compute/volumes.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;OAKf,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,qBAAqB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACxE,CAAC;IAED;;OAEG;IACH,MAAM,CACJ,QAAgB,EAChB,IAAwB,EACxB,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,IAAI,CAAA,uBAAuB,QAAQ,EAAE,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACzF,CAAC;IAED;;OAEG;IACH,IAAI,CAAC,OAAwB;QAC3B,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,qBAAqB,EAAE,OAAO,CAAC,CAAC;IAC1D,CAAC;IAED;;OAEG;IACH,MAAM,CAAC,QAAgB,EAAE,OAAwB;QAC/C,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,CAAA,uBAAuB,QAAQ,EAAE,EAAE,OAAO,CAAC,CAAC;IAC7E,CAAC;IAED;;OAEG;IACH,GAAG,CAAC,QAAgB,EAAE,OAAwB;QAC5C,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,uBAAuB,QAAQ,EAAE,EAAE,OAAO,CAAC,CAAC;IAC1E,CAAC;CACF"}
1
+ {"version":3,"file":"volumes.mjs","sourceRoot":"","sources":["../../src/resources/compute/volumes.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;OAKf,EAAE,IAAI,EAAE;AAEf,MAAM,OAAO,OAAQ,SAAQ,WAAW;IACtC;;;;;;;;;;;OAWG;IACH,MAAM,CAAC,IAAwB,EAAE,OAAwB;QACvD,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,qBAAqB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACxE,CAAC;IAED;;;;;;;;;OASG;IACH,MAAM,CACJ,QAAgB,EAChB,IAAwB,EACxB,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,IAAI,CAAA,uBAAuB,QAAQ,EAAE,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACzF,CAAC;IAED;;;;;;;OAOG;IACH,IAAI,CAAC,OAAwB;QAC3B,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,qBAAqB,EAAE,OAAO,CAAC,CAAC;IAC1D,CAAC;IAED;;;;;;;;;OASG;IACH,MAAM,CAAC,QAAgB,EAAE,OAAwB;QAC/C,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,CAAA,uBAAuB,QAAQ,EAAE,EAAE,OAAO,CAAC,CAAC;IAC7E,CAAC;IAED;;;;;;;;;OASG;IACH,GAAG,CAAC,QAAgB,EAAE,OAAwB;QAC5C,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,uBAAuB,QAAQ,EAAE,EAAE,OAAO,CAAC,CAAC;IAC1E,CAAC;CACF"}