@scaleway/sdk 2.72.0 → 2.74.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 (209) hide show
  1. package/dist/api/account/v3/api.gen.cjs +13 -32
  2. package/dist/api/account/v3/api.gen.d.ts +17 -36
  3. package/dist/api/account/v3/api.gen.js +13 -32
  4. package/dist/api/account/v3/index.gen.d.ts +1 -1
  5. package/dist/api/account/v3/marshalling.gen.cjs +94 -65
  6. package/dist/api/account/v3/marshalling.gen.js +94 -65
  7. package/dist/api/account/v3/types.gen.d.ts +224 -104
  8. package/dist/api/applesilicon/v1alpha1/api.gen.cjs +19 -46
  9. package/dist/api/applesilicon/v1alpha1/api.gen.d.ts +24 -49
  10. package/dist/api/applesilicon/v1alpha1/api.gen.js +19 -46
  11. package/dist/api/applesilicon/v1alpha1/types.gen.d.ts +310 -135
  12. package/dist/api/audit_trail/v1alpha1/api.gen.cjs +2 -5
  13. package/dist/api/audit_trail/v1alpha1/api.gen.d.ts +4 -8
  14. package/dist/api/audit_trail/v1alpha1/api.gen.js +2 -5
  15. package/dist/api/audit_trail/v1alpha1/types.gen.d.ts +110 -82
  16. package/dist/api/baremetal/v1/api.gen.cjs +28 -61
  17. package/dist/api/baremetal/v1/api.gen.d.ts +29 -60
  18. package/dist/api/baremetal/v1/api.gen.js +28 -61
  19. package/dist/api/baremetal/v1/types.gen.d.ts +802 -315
  20. package/dist/api/baremetal/v3/api.gen.cjs +7 -14
  21. package/dist/api/baremetal/v3/api.gen.d.ts +10 -15
  22. package/dist/api/baremetal/v3/api.gen.js +7 -14
  23. package/dist/api/baremetal/v3/types.gen.d.ts +82 -32
  24. package/dist/api/billing/v2beta1/api.gen.cjs +11 -20
  25. package/dist/api/billing/v2beta1/api.gen.d.ts +9 -19
  26. package/dist/api/billing/v2beta1/api.gen.js +11 -20
  27. package/dist/api/billing/v2beta1/types.gen.d.ts +231 -102
  28. package/dist/api/block/v1/api.gen.cjs +37 -55
  29. package/dist/api/block/v1/api.gen.d.ts +19 -37
  30. package/dist/api/block/v1/api.gen.js +37 -55
  31. package/dist/api/block/v1/types.gen.d.ts +306 -125
  32. package/dist/api/block/v1alpha1/api.gen.cjs +45 -64
  33. package/dist/api/block/v1alpha1/api.gen.d.ts +22 -41
  34. package/dist/api/block/v1alpha1/api.gen.js +45 -64
  35. package/dist/api/block/v1alpha1/types.gen.d.ts +327 -132
  36. package/dist/api/cockpit/v1/api.gen.cjs +132 -156
  37. package/dist/api/cockpit/v1/api.gen.d.ts +66 -113
  38. package/dist/api/cockpit/v1/api.gen.js +133 -157
  39. package/dist/api/cockpit/v1/index.gen.d.ts +1 -1
  40. package/dist/api/cockpit/v1/marshalling.gen.cjs +23 -0
  41. package/dist/api/cockpit/v1/marshalling.gen.d.ts +3 -1
  42. package/dist/api/cockpit/v1/marshalling.gen.js +23 -0
  43. package/dist/api/cockpit/v1/types.gen.d.ts +628 -246
  44. package/dist/api/container/v1beta1/api.gen.cjs +7 -14
  45. package/dist/api/container/v1beta1/api.gen.d.ts +9 -16
  46. package/dist/api/container/v1beta1/api.gen.js +7 -14
  47. package/dist/api/container/v1beta1/types.gen.d.ts +648 -322
  48. package/dist/api/dedibox/v1/api.gen.cjs +45 -69
  49. package/dist/api/dedibox/v1/api.gen.d.ts +52 -62
  50. package/dist/api/dedibox/v1/api.gen.js +45 -69
  51. package/dist/api/dedibox/v1/types.gen.d.ts +1765 -645
  52. package/dist/api/domain/v2beta1/api.gen.cjs +119 -178
  53. package/dist/api/domain/v2beta1/api.gen.d.ts +71 -130
  54. package/dist/api/domain/v2beta1/api.gen.js +119 -178
  55. package/dist/api/domain/v2beta1/content.gen.d.ts +1 -4
  56. package/dist/api/domain/v2beta1/types.gen.d.ts +411 -199
  57. package/dist/api/edge_services/v1beta1/api.gen.cjs +41 -22
  58. package/dist/api/edge_services/v1beta1/api.gen.d.ts +3 -2
  59. package/dist/api/edge_services/v1beta1/api.gen.js +41 -22
  60. package/dist/api/edge_services/v1beta1/index.gen.d.ts +1 -1
  61. package/dist/api/edge_services/v1beta1/types.gen.d.ts +7 -0
  62. package/dist/api/file/index.gen.cjs +4 -0
  63. package/dist/api/file/index.gen.d.ts +5 -0
  64. package/dist/api/file/index.gen.js +4 -0
  65. package/dist/api/file/v1alpha1/api.gen.cjs +142 -0
  66. package/dist/api/file/v1alpha1/api.gen.d.ts +73 -0
  67. package/dist/api/file/v1alpha1/api.gen.js +142 -0
  68. package/dist/api/file/v1alpha1/content.gen.cjs +7 -0
  69. package/dist/api/file/v1alpha1/content.gen.d.ts +3 -0
  70. package/dist/api/file/v1alpha1/content.gen.js +7 -0
  71. package/dist/api/file/v1alpha1/index.gen.cjs +8 -0
  72. package/dist/api/file/v1alpha1/index.gen.d.ts +4 -0
  73. package/dist/api/file/v1alpha1/index.gen.js +8 -0
  74. package/dist/api/file/v1alpha1/marshalling.gen.cjs +77 -0
  75. package/dist/api/file/v1alpha1/marshalling.gen.d.ts +7 -0
  76. package/dist/api/file/v1alpha1/marshalling.gen.js +77 -0
  77. package/dist/api/file/v1alpha1/types.gen.d.ts +239 -0
  78. package/dist/api/file/v1alpha1/validation-rules.gen.cjs +40 -0
  79. package/dist/api/file/v1alpha1/validation-rules.gen.d.ts +34 -0
  80. package/dist/api/file/v1alpha1/validation-rules.gen.js +40 -0
  81. package/dist/api/flexibleip/v1alpha1/api.gen.cjs +10 -25
  82. package/dist/api/flexibleip/v1alpha1/api.gen.d.ts +12 -28
  83. package/dist/api/flexibleip/v1alpha1/api.gen.js +10 -25
  84. package/dist/api/flexibleip/v1alpha1/types.gen.d.ts +186 -78
  85. package/dist/api/function/v1beta1/types.gen.d.ts +6 -6
  86. package/dist/api/iam/v1alpha1/api.gen.cjs +4 -4
  87. package/dist/api/iam/v1alpha1/api.gen.d.ts +4 -4
  88. package/dist/api/iam/v1alpha1/api.gen.js +4 -4
  89. package/dist/api/iam/v1alpha1/types.gen.d.ts +1 -1
  90. package/dist/api/index.gen.d.ts +3 -1
  91. package/dist/api/inference/v1/api.gen.cjs +8 -11
  92. package/dist/api/inference/v1/api.gen.d.ts +6 -9
  93. package/dist/api/inference/v1/api.gen.js +8 -11
  94. package/dist/api/inference/v1/types.gen.d.ts +330 -150
  95. package/dist/api/inference/v1beta1/api.gen.cjs +9 -12
  96. package/dist/api/inference/v1beta1/api.gen.d.ts +7 -10
  97. package/dist/api/inference/v1beta1/api.gen.js +9 -12
  98. package/dist/api/inference/v1beta1/types.gen.d.ts +341 -154
  99. package/dist/api/instance/v1/api.gen.cjs +64 -113
  100. package/dist/api/instance/v1/api.gen.d.ts +54 -103
  101. package/dist/api/instance/v1/api.gen.js +64 -113
  102. package/dist/api/instance/v1/marshalling.gen.cjs +4 -1
  103. package/dist/api/instance/v1/marshalling.gen.js +4 -1
  104. package/dist/api/instance/v1/types.gen.d.ts +1368 -600
  105. package/dist/api/instance/v1/types.private.gen.d.ts +131 -59
  106. package/dist/api/interlink/v1beta1/api.gen.cjs +21 -67
  107. package/dist/api/interlink/v1beta1/api.gen.d.ts +23 -70
  108. package/dist/api/interlink/v1beta1/api.gen.js +21 -67
  109. package/dist/api/interlink/v1beta1/marshalling.gen.cjs +2 -0
  110. package/dist/api/interlink/v1beta1/marshalling.gen.js +2 -0
  111. package/dist/api/interlink/v1beta1/types.gen.d.ts +464 -216
  112. package/dist/api/interlink/v1beta1/validation-rules.gen.cjs +8 -0
  113. package/dist/api/interlink/v1beta1/validation-rules.gen.d.ts +8 -0
  114. package/dist/api/interlink/v1beta1/validation-rules.gen.js +8 -0
  115. package/dist/api/iot/v1/api.gen.cjs +37 -70
  116. package/dist/api/iot/v1/api.gen.d.ts +34 -67
  117. package/dist/api/iot/v1/api.gen.js +37 -70
  118. package/dist/api/iot/v1/types.gen.d.ts +566 -321
  119. package/dist/api/ipam/v1/api.gen.cjs +6 -26
  120. package/dist/api/ipam/v1/api.gen.d.ts +8 -29
  121. package/dist/api/ipam/v1/api.gen.js +6 -26
  122. package/dist/api/ipam/v1/types.gen.d.ts +146 -105
  123. package/dist/api/jobs/v1alpha1/api.gen.cjs +2 -4
  124. package/dist/api/jobs/v1alpha1/api.gen.d.ts +4 -6
  125. package/dist/api/jobs/v1alpha1/api.gen.js +2 -4
  126. package/dist/api/jobs/v1alpha1/types.gen.d.ts +165 -91
  127. package/dist/api/k8s/v1/api.gen.cjs +33 -78
  128. package/dist/api/k8s/v1/api.gen.d.ts +27 -72
  129. package/dist/api/k8s/v1/api.gen.js +33 -78
  130. package/dist/api/k8s/v1/types.gen.d.ts +743 -506
  131. package/dist/api/key_manager/v1alpha1/api.gen.cjs +21 -57
  132. package/dist/api/key_manager/v1alpha1/api.gen.d.ts +19 -56
  133. package/dist/api/key_manager/v1alpha1/api.gen.js +21 -57
  134. package/dist/api/key_manager/v1alpha1/types.gen.d.ts +196 -114
  135. package/dist/api/lb/v1/marshalling.gen.cjs +4 -2
  136. package/dist/api/lb/v1/marshalling.gen.js +4 -2
  137. package/dist/api/lb/v1/types.gen.d.ts +4 -0
  138. package/dist/api/marketplace/v2/api.gen.cjs +8 -21
  139. package/dist/api/marketplace/v2/api.gen.d.ts +10 -24
  140. package/dist/api/marketplace/v2/api.gen.js +8 -21
  141. package/dist/api/marketplace/v2/types.gen.d.ts +94 -41
  142. package/dist/api/mnq/v1beta1/api.gen.cjs +24 -76
  143. package/dist/api/mnq/v1beta1/api.gen.d.ts +30 -82
  144. package/dist/api/mnq/v1beta1/api.gen.js +24 -76
  145. package/dist/api/mnq/v1beta1/types.gen.d.ts +342 -169
  146. package/dist/api/mongodb/v1alpha1/api.gen.cjs +19 -62
  147. package/dist/api/mongodb/v1alpha1/api.gen.d.ts +21 -64
  148. package/dist/api/mongodb/v1alpha1/api.gen.js +19 -62
  149. package/dist/api/mongodb/v1alpha1/types.gen.d.ts +443 -189
  150. package/dist/api/product_catalog/index.gen.cjs +4 -0
  151. package/dist/api/product_catalog/index.gen.d.ts +5 -0
  152. package/dist/api/product_catalog/index.gen.js +4 -0
  153. package/dist/api/product_catalog/v2alpha1/api.gen.cjs +36 -0
  154. package/dist/api/product_catalog/v2alpha1/api.gen.d.ts +18 -0
  155. package/dist/api/product_catalog/v2alpha1/api.gen.js +36 -0
  156. package/dist/api/product_catalog/v2alpha1/index.gen.cjs +6 -0
  157. package/dist/api/product_catalog/v2alpha1/index.gen.d.ts +3 -0
  158. package/dist/api/product_catalog/v2alpha1/index.gen.js +6 -0
  159. package/dist/api/product_catalog/v2alpha1/marshalling.gen.cjs +230 -0
  160. package/dist/api/product_catalog/v2alpha1/marshalling.gen.d.ts +2 -0
  161. package/dist/api/product_catalog/v2alpha1/marshalling.gen.js +230 -0
  162. package/dist/api/product_catalog/v2alpha1/types.gen.d.ts +293 -0
  163. package/dist/api/product_catalog/v2alpha1/validation-rules.gen.cjs +11 -0
  164. package/dist/api/product_catalog/v2alpha1/validation-rules.gen.d.ts +8 -0
  165. package/dist/api/product_catalog/v2alpha1/validation-rules.gen.js +11 -0
  166. package/dist/api/qaas/v1alpha1/api.gen.cjs +17 -34
  167. package/dist/api/qaas/v1alpha1/api.gen.d.ts +19 -36
  168. package/dist/api/qaas/v1alpha1/api.gen.js +17 -34
  169. package/dist/api/qaas/v1alpha1/types.gen.d.ts +502 -174
  170. package/dist/api/rdb/v1/api.gen.cjs +62 -202
  171. package/dist/api/rdb/v1/api.gen.d.ts +60 -201
  172. package/dist/api/rdb/v1/api.gen.js +62 -202
  173. package/dist/api/rdb/v1/types.gen.d.ts +1005 -524
  174. package/dist/api/redis/v1/api.gen.cjs +23 -83
  175. package/dist/api/redis/v1/api.gen.d.ts +25 -85
  176. package/dist/api/redis/v1/api.gen.js +23 -83
  177. package/dist/api/redis/v1/types.gen.d.ts +447 -170
  178. package/dist/api/registry/v1/api.gen.cjs +12 -40
  179. package/dist/api/registry/v1/api.gen.d.ts +14 -42
  180. package/dist/api/registry/v1/api.gen.js +12 -40
  181. package/dist/api/registry/v1/types.gen.d.ts +200 -116
  182. package/dist/api/secret/v1beta1/api.gen.cjs +19 -47
  183. package/dist/api/secret/v1beta1/api.gen.d.ts +21 -51
  184. package/dist/api/secret/v1beta1/api.gen.js +19 -47
  185. package/dist/api/secret/v1beta1/types.gen.d.ts +359 -224
  186. package/dist/api/serverless_sqldb/v1alpha1/api.gen.cjs +9 -27
  187. package/dist/api/serverless_sqldb/v1alpha1/api.gen.d.ts +11 -29
  188. package/dist/api/serverless_sqldb/v1alpha1/api.gen.js +9 -27
  189. package/dist/api/serverless_sqldb/v1alpha1/types.gen.d.ts +168 -76
  190. package/dist/api/tem/v1alpha1/api.gen.cjs +22 -58
  191. package/dist/api/tem/v1alpha1/api.gen.d.ts +24 -60
  192. package/dist/api/tem/v1alpha1/api.gen.js +22 -58
  193. package/dist/api/tem/v1alpha1/types.gen.d.ts +761 -338
  194. package/dist/api/test/v1/api.gen.cjs +8 -11
  195. package/dist/api/test/v1/api.gen.d.ts +6 -9
  196. package/dist/api/test/v1/api.gen.js +8 -11
  197. package/dist/api/test/v1/types.gen.d.ts +21 -10
  198. package/dist/api/vpcgw/v1/api.gen.cjs +37 -0
  199. package/dist/api/vpcgw/v1/api.gen.d.ts +37 -0
  200. package/dist/api/vpcgw/v1/api.gen.js +37 -0
  201. package/dist/client/dist/package.json.cjs +1 -1
  202. package/dist/client/dist/package.json.js +1 -1
  203. package/dist/index.cjs +36 -32
  204. package/dist/index.js +36 -32
  205. package/node_modules/@scaleway/sdk-client/dist/package.json.cjs +1 -1
  206. package/node_modules/@scaleway/sdk-client/dist/package.json.js +1 -1
  207. package/node_modules/@scaleway/sdk-client/package.json +1 -2
  208. package/package.json +2 -2
  209. package/node_modules/@scaleway/sdk-client/LICENSE +0 -191
@@ -3,25 +3,21 @@ import type { Zone as ScwZone, WaitForOptions } from '@scaleway/sdk-client';
3
3
  import type { AttachFlexibleIPRequest, AttachFlexibleIPsResponse, CreateFlexibleIPRequest, DeleteFlexibleIPRequest, DeleteMACAddrRequest, DetachFlexibleIPRequest, DetachFlexibleIPsResponse, DuplicateMACAddrRequest, FlexibleIP, GenerateMACAddrRequest, GetFlexibleIPRequest, ListFlexibleIPsRequest, ListFlexibleIPsResponse, MoveMACAddrRequest, UpdateFlexibleIPRequest } from './types.gen';
4
4
  /**
5
5
  * Elastic Metal - Flexible IP API.
6
- *
7
- * This API allows you to manage your Elastic Metal servers' flexible public IP
8
- * addresses.
6
+
7
+ This API allows you to manage your Elastic Metal servers' flexible public IP addresses.
9
8
  */
10
9
  export declare class API extends ParentAPI {
11
10
  /** Lists the available zones of the API. */
12
11
  static readonly LOCALITIES: ScwZone[];
13
12
  /**
14
- * Create a new flexible IP. Generate a new flexible IP within a given zone,
15
- * specifying its configuration including Project ID and description.
13
+ * Create a new flexible IP. Generate a new flexible IP within a given zone, specifying its configuration including Project ID and description.
16
14
  *
17
15
  * @param request - The request {@link CreateFlexibleIPRequest}
18
16
  * @returns A Promise of FlexibleIP
19
17
  */
20
18
  createFlexibleIP: (request: Readonly<CreateFlexibleIPRequest>) => Promise<FlexibleIP>;
21
19
  /**
22
- * Get an existing flexible IP. Retrieve information about an existing
23
- * flexible IP, specified by its ID and zone. Its full details, including
24
- * Project ID, description and status, are returned in the response object.
20
+ * Get an existing flexible IP. Retrieve information about an existing flexible IP, specified by its ID and zone. Its full details, including Project ID, description and status, are returned in the response object.
25
21
  *
26
22
  * @param request - The request {@link GetFlexibleIPRequest}
27
23
  * @returns A Promise of FlexibleIP
@@ -47,67 +43,55 @@ export declare class API extends ParentAPI {
47
43
  [Symbol.asyncIterator]: () => AsyncGenerator<FlexibleIP[], void, void>;
48
44
  };
49
45
  /**
50
- * Update an existing flexible IP. Update the parameters of an existing
51
- * flexible IP, specified by its ID and zone. These parameters include tags
52
- * and description.
46
+ * Update an existing flexible IP. Update the parameters of an existing flexible IP, specified by its ID and zone. These parameters include tags and description.
53
47
  *
54
48
  * @param request - The request {@link UpdateFlexibleIPRequest}
55
49
  * @returns A Promise of FlexibleIP
56
50
  */
57
51
  updateFlexibleIP: (request: Readonly<UpdateFlexibleIPRequest>) => Promise<FlexibleIP>;
58
52
  /**
59
- * Delete an existing flexible IP. Delete an existing flexible IP, specified
60
- * by its ID and zone. Note that deleting a flexible IP is permanent and
61
- * cannot be undone.
53
+ * Delete an existing flexible IP. Delete an existing flexible IP, specified by its ID and zone. Note that deleting a flexible IP is permanent and cannot be undone.
62
54
  *
63
55
  * @param request - The request {@link DeleteFlexibleIPRequest}
64
56
  */
65
57
  deleteFlexibleIP: (request: Readonly<DeleteFlexibleIPRequest>) => Promise<void>;
66
58
  /**
67
- * Attach an existing flexible IP to a server. Attach an existing flexible IP
68
- * to a specified Elastic Metal server.
59
+ * Attach an existing flexible IP to a server. Attach an existing flexible IP to a specified Elastic Metal server.
69
60
  *
70
61
  * @param request - The request {@link AttachFlexibleIPRequest}
71
62
  * @returns A Promise of AttachFlexibleIPsResponse
72
63
  */
73
64
  attachFlexibleIP: (request: Readonly<AttachFlexibleIPRequest>) => Promise<AttachFlexibleIPsResponse>;
74
65
  /**
75
- * Detach an existing flexible IP from a server. Detach an existing flexible
76
- * IP from a specified Elastic Metal server.
66
+ * Detach an existing flexible IP from a server. Detach an existing flexible IP from a specified Elastic Metal server.
77
67
  *
78
68
  * @param request - The request {@link DetachFlexibleIPRequest}
79
69
  * @returns A Promise of DetachFlexibleIPsResponse
80
70
  */
81
71
  detachFlexibleIP: (request: Readonly<DetachFlexibleIPRequest>) => Promise<DetachFlexibleIPsResponse>;
82
72
  /**
83
- * Generate a virtual MAC address on an existing flexible IP. Generate a
84
- * virtual MAC (Media Access Control) address on an existing flexible IP.
73
+ * Generate a virtual MAC address on an existing flexible IP. Generate a virtual MAC (Media Access Control) address on an existing flexible IP.
85
74
  *
86
75
  * @param request - The request {@link GenerateMACAddrRequest}
87
76
  * @returns A Promise of FlexibleIP
88
77
  */
89
78
  generateMACAddr: (request: Readonly<GenerateMACAddrRequest>) => Promise<FlexibleIP>;
90
79
  /**
91
- * Duplicate a virtual MAC address to another flexible IP. Duplicate a virtual
92
- * MAC address from a given flexible IP to another flexible IP attached to the
93
- * same server.
80
+ * Duplicate a virtual MAC address to another flexible IP. Duplicate a virtual MAC address from a given flexible IP to another flexible IP attached to the same server.
94
81
  *
95
82
  * @param request - The request {@link DuplicateMACAddrRequest}
96
83
  * @returns A Promise of FlexibleIP
97
84
  */
98
85
  duplicateMACAddr: (request: Readonly<DuplicateMACAddrRequest>) => Promise<FlexibleIP>;
99
86
  /**
100
- * Relocate an existing virtual MAC address to a different flexible IP.
101
- * Relocate a virtual MAC (Media Access Control) address from an existing
102
- * flexible IP to a different flexible IP.
87
+ * Relocate an existing virtual MAC address to a different flexible IP. Relocate a virtual MAC (Media Access Control) address from an existing flexible IP to a different flexible IP.
103
88
  *
104
89
  * @param request - The request {@link MoveMACAddrRequest}
105
90
  * @returns A Promise of FlexibleIP
106
91
  */
107
92
  moveMACAddr: (request: Readonly<MoveMACAddrRequest>) => Promise<FlexibleIP>;
108
93
  /**
109
- * Detach a given virtual MAC address from an existing flexible IP. Detach a
110
- * given MAC (Media Access Control) address from an existing flexible IP.
94
+ * Detach a given virtual MAC address from an existing flexible IP. Detach a given MAC (Media Access Control) address from an existing flexible IP.
111
95
  *
112
96
  * @param request - The request {@link DeleteMACAddrRequest}
113
97
  */
@@ -20,8 +20,7 @@ class API extends API$1 {
20
20
  "pl-waw-3"
21
21
  ];
22
22
  /**
23
- * Create a new flexible IP. Generate a new flexible IP within a given zone,
24
- * specifying its configuration including Project ID and description.
23
+ * Create a new flexible IP. Generate a new flexible IP within a given zone, specifying its configuration including Project ID and description.
25
24
  *
26
25
  * @param request - The request {@link CreateFlexibleIPRequest}
27
26
  * @returns A Promise of FlexibleIP
@@ -38,9 +37,7 @@ class API extends API$1 {
38
37
  unmarshalFlexibleIP
39
38
  );
40
39
  /**
41
- * Get an existing flexible IP. Retrieve information about an existing
42
- * flexible IP, specified by its ID and zone. Its full details, including
43
- * Project ID, description and status, are returned in the response object.
40
+ * Get an existing flexible IP. Retrieve information about an existing flexible IP, specified by its ID and zone. Its full details, including Project ID, description and status, are returned in the response object.
44
41
  *
45
42
  * @param request - The request {@link GetFlexibleIPRequest}
46
43
  * @returns A Promise of FlexibleIP
@@ -95,9 +92,7 @@ class API extends API$1 {
95
92
  */
96
93
  listFlexibleIPs = (request = {}) => enrichForPagination("flexibleIps", this.pageOfListFlexibleIPs, request);
97
94
  /**
98
- * Update an existing flexible IP. Update the parameters of an existing
99
- * flexible IP, specified by its ID and zone. These parameters include tags
100
- * and description.
95
+ * Update an existing flexible IP. Update the parameters of an existing flexible IP, specified by its ID and zone. These parameters include tags and description.
101
96
  *
102
97
  * @param request - The request {@link UpdateFlexibleIPRequest}
103
98
  * @returns A Promise of FlexibleIP
@@ -114,9 +109,7 @@ class API extends API$1 {
114
109
  unmarshalFlexibleIP
115
110
  );
116
111
  /**
117
- * Delete an existing flexible IP. Delete an existing flexible IP, specified
118
- * by its ID and zone. Note that deleting a flexible IP is permanent and
119
- * cannot be undone.
112
+ * Delete an existing flexible IP. Delete an existing flexible IP, specified by its ID and zone. Note that deleting a flexible IP is permanent and cannot be undone.
120
113
  *
121
114
  * @param request - The request {@link DeleteFlexibleIPRequest}
122
115
  */
@@ -125,8 +118,7 @@ class API extends API$1 {
125
118
  path: `/flexible-ip/v1alpha1/zones/${validatePathParam("zone", request.zone ?? this.client.settings.defaultZone)}/fips/${validatePathParam("fipId", request.fipId)}`
126
119
  });
127
120
  /**
128
- * Attach an existing flexible IP to a server. Attach an existing flexible IP
129
- * to a specified Elastic Metal server.
121
+ * Attach an existing flexible IP to a server. Attach an existing flexible IP to a specified Elastic Metal server.
130
122
  *
131
123
  * @param request - The request {@link AttachFlexibleIPRequest}
132
124
  * @returns A Promise of AttachFlexibleIPsResponse
@@ -143,8 +135,7 @@ class API extends API$1 {
143
135
  unmarshalAttachFlexibleIPsResponse
144
136
  );
145
137
  /**
146
- * Detach an existing flexible IP from a server. Detach an existing flexible
147
- * IP from a specified Elastic Metal server.
138
+ * Detach an existing flexible IP from a server. Detach an existing flexible IP from a specified Elastic Metal server.
148
139
  *
149
140
  * @param request - The request {@link DetachFlexibleIPRequest}
150
141
  * @returns A Promise of DetachFlexibleIPsResponse
@@ -161,8 +152,7 @@ class API extends API$1 {
161
152
  unmarshalDetachFlexibleIPsResponse
162
153
  );
163
154
  /**
164
- * Generate a virtual MAC address on an existing flexible IP. Generate a
165
- * virtual MAC (Media Access Control) address on an existing flexible IP.
155
+ * Generate a virtual MAC address on an existing flexible IP. Generate a virtual MAC (Media Access Control) address on an existing flexible IP.
166
156
  *
167
157
  * @param request - The request {@link GenerateMACAddrRequest}
168
158
  * @returns A Promise of FlexibleIP
@@ -179,9 +169,7 @@ class API extends API$1 {
179
169
  unmarshalFlexibleIP
180
170
  );
181
171
  /**
182
- * Duplicate a virtual MAC address to another flexible IP. Duplicate a virtual
183
- * MAC address from a given flexible IP to another flexible IP attached to the
184
- * same server.
172
+ * Duplicate a virtual MAC address to another flexible IP. Duplicate a virtual MAC address from a given flexible IP to another flexible IP attached to the same server.
185
173
  *
186
174
  * @param request - The request {@link DuplicateMACAddrRequest}
187
175
  * @returns A Promise of FlexibleIP
@@ -198,9 +186,7 @@ class API extends API$1 {
198
186
  unmarshalFlexibleIP
199
187
  );
200
188
  /**
201
- * Relocate an existing virtual MAC address to a different flexible IP.
202
- * Relocate a virtual MAC (Media Access Control) address from an existing
203
- * flexible IP to a different flexible IP.
189
+ * Relocate an existing virtual MAC address to a different flexible IP. Relocate a virtual MAC (Media Access Control) address from an existing flexible IP to a different flexible IP.
204
190
  *
205
191
  * @param request - The request {@link MoveMACAddrRequest}
206
192
  * @returns A Promise of FlexibleIP
@@ -217,8 +203,7 @@ class API extends API$1 {
217
203
  unmarshalFlexibleIP
218
204
  );
219
205
  /**
220
- * Detach a given virtual MAC address from an existing flexible IP. Detach a
221
- * given MAC (Media Access Control) address from an existing flexible IP.
206
+ * Detach a given virtual MAC address from an existing flexible IP. Detach a given MAC (Media Access Control) address from an existing flexible IP.
222
207
  *
223
208
  * @param request - The request {@link DeleteMACAddrRequest}
224
209
  */
@@ -4,193 +4,301 @@ export type ListFlexibleIPsRequestOrderBy = 'created_at_asc' | 'created_at_desc'
4
4
  export type MACAddressStatus = 'unknown' | 'ready' | 'updating' | 'used' | 'error' | 'deleting';
5
5
  export type MACAddressType = 'unknown_type' | 'vmware' | 'xen' | 'kvm';
6
6
  export interface MACAddress {
7
- /** ID of the flexible IP. */
7
+ /**
8
+ * ID of the flexible IP.
9
+ */
8
10
  id: string;
9
- /** MAC address of the Virtual MAC. */
11
+ /**
12
+ * MAC address of the Virtual MAC.
13
+ */
10
14
  macAddress: string;
11
- /** Type of virtual MAC. */
15
+ /**
16
+ * Type of virtual MAC.
17
+ */
12
18
  macType: MACAddressType;
13
- /** Status of virtual MAC. */
19
+ /**
20
+ * Status of virtual MAC.
21
+ */
14
22
  status: MACAddressStatus;
15
- /** Date on which the virtual MAC was last updated. */
23
+ /**
24
+ * Date on which the virtual MAC was last updated.
25
+ */
16
26
  updatedAt?: Date;
17
- /** Date on which the virtual MAC was created. */
27
+ /**
28
+ * Date on which the virtual MAC was created.
29
+ */
18
30
  createdAt?: Date;
19
- /** MAC address IP Availability Zone. */
31
+ /**
32
+ * MAC address IP Availability Zone.
33
+ */
20
34
  zone: ScwZone;
21
35
  }
22
36
  export interface FlexibleIP {
23
- /** ID of the flexible IP. */
37
+ /**
38
+ * ID of the flexible IP.
39
+ */
24
40
  id: string;
25
- /** ID of the Organization the flexible IP is attached to. */
41
+ /**
42
+ * ID of the Organization the flexible IP is attached to.
43
+ */
26
44
  organizationId: string;
27
- /** ID of the Project the flexible IP is attached to. */
45
+ /**
46
+ * ID of the Project the flexible IP is attached to.
47
+ */
28
48
  projectId: string;
29
- /** Flexible IP description. */
49
+ /**
50
+ * Flexible IP description.
51
+ */
30
52
  description: string;
31
- /** Flexible IP tags. */
53
+ /**
54
+ * Flexible IP tags.
55
+ */
32
56
  tags: string[];
33
- /** Date on which the flexible IP was last updated. */
57
+ /**
58
+ * Date on which the flexible IP was last updated.
59
+ */
34
60
  updatedAt?: Date;
35
- /** Date on which the flexible IP was created. */
61
+ /**
62
+ * Date on which the flexible IP was created.
63
+ */
36
64
  createdAt?: Date;
37
65
  /**
38
- * - Ready : flexible IP is created and ready to be attached to a server or to
39
- * be associated with a virtual MAC.
40
- * - Updating: flexible IP is being attached to a server or a virtual MAC
41
- * operation is ongoing
42
- * - Attached: flexible IP is attached to a server
43
- * - Error: a flexible IP operation resulted in an error
44
- * - Detaching: flexible IP is being detached from a server
45
- * - Locked: the resource of the flexible IP is locked.
66
+ * - ready : flexible IP is created and ready to be attached to a server or to be associated with a virtual MAC.
67
+ - updating: flexible IP is being attached to a server or a virtual MAC operation is ongoing
68
+ - attached: flexible IP is attached to a server
69
+ - error: a flexible IP operation resulted in an error
70
+ - detaching: flexible IP is being detached from a server
71
+ - locked: the resource of the flexible IP is locked.
46
72
  */
47
73
  status: FlexibleIPStatus;
48
- /** IP of the flexible IP. */
74
+ /**
75
+ * IP of the flexible IP.
76
+ */
49
77
  ipAddress: string;
50
- /** MAC address of the flexible IP. */
78
+ /**
79
+ * MAC address of the flexible IP.
80
+ */
51
81
  macAddress?: MACAddress;
52
- /** ID of the server linked to the flexible IP. */
82
+ /**
83
+ * ID of the server linked to the flexible IP.
84
+ */
53
85
  serverId?: string;
54
- /** Reverse DNS value. */
86
+ /**
87
+ * Reverse DNS value.
88
+ */
55
89
  reverse: string;
56
- /** Availability Zone of the flexible IP. */
90
+ /**
91
+ * Availability Zone of the flexible IP.
92
+ */
57
93
  zone: ScwZone;
58
94
  }
59
95
  export type AttachFlexibleIPRequest = {
60
- /** Zone to target. If none is passed will use default zone from the config. */
96
+ /**
97
+ * Zone to target. If none is passed will use default zone from the config.
98
+ */
61
99
  zone?: ScwZone;
62
100
  /**
63
- * Multiple IDs can be provided, but note that flexible IPs must belong to the
64
- * same MAC group (see details about MAC groups).
101
+ * Multiple IDs can be provided, but note that flexible IPs must belong to the same MAC group (see details about MAC groups).
65
102
  */
66
103
  fipsIds: string[];
67
- /** ID of the server on which to attach the flexible IPs. */
104
+ /**
105
+ * ID of the server on which to attach the flexible IPs.
106
+ */
68
107
  serverId: string;
69
108
  };
70
109
  export interface AttachFlexibleIPsResponse {
71
- /** Total count of flexible IPs that are being updated. */
110
+ /**
111
+ * Total count of flexible IPs that are being updated.
112
+ */
72
113
  totalCount: number;
73
- /** List of flexible IPs in an updating state. */
114
+ /**
115
+ * List of flexible IPs in an updating state.
116
+ */
74
117
  flexibleIps: FlexibleIP[];
75
118
  }
76
119
  export type CreateFlexibleIPRequest = {
77
- /** Zone to target. If none is passed will use default zone from the config. */
120
+ /**
121
+ * Zone to target. If none is passed will use default zone from the config.
122
+ */
78
123
  zone?: ScwZone;
79
- /** ID of the project to associate with the Flexible IP. */
124
+ /**
125
+ * ID of the project to associate with the Flexible IP.
126
+ */
80
127
  projectId?: string;
81
- /** Flexible IP description (max. of 255 characters). */
128
+ /**
129
+ * Flexible IP description (max. of 255 characters).
130
+ */
82
131
  description: string;
83
- /** Tags to associate to the flexible IP. */
132
+ /**
133
+ * Tags to associate to the flexible IP.
134
+ */
84
135
  tags?: string[];
85
- /** ID of the server to which the newly created flexible IP will be attached. */
136
+ /**
137
+ * ID of the server to which the newly created flexible IP will be attached.
138
+ */
86
139
  serverId?: string;
87
- /** Value of the reverse DNS. */
140
+ /**
141
+ * Value of the reverse DNS.
142
+ */
88
143
  reverse?: string;
89
- /** Defines whether the flexible IP has an IPv6 address. */
144
+ /**
145
+ * Defines whether the flexible IP has an IPv6 address.
146
+ */
90
147
  isIpv6: boolean;
91
148
  };
92
149
  export type DeleteFlexibleIPRequest = {
93
- /** Zone to target. If none is passed will use default zone from the config. */
150
+ /**
151
+ * Zone to target. If none is passed will use default zone from the config.
152
+ */
94
153
  zone?: ScwZone;
95
- /** ID of the flexible IP to delete. */
154
+ /**
155
+ * ID of the flexible IP to delete.
156
+ */
96
157
  fipId: string;
97
158
  };
98
159
  export type DeleteMACAddrRequest = {
99
- /** Zone to target. If none is passed will use default zone from the config. */
160
+ /**
161
+ * Zone to target. If none is passed will use default zone from the config.
162
+ */
100
163
  zone?: ScwZone;
101
164
  /**
102
- * If the flexible IP belongs to a MAC group, the MAC will be removed from
103
- * both the MAC group and flexible IP.
165
+ * If the flexible IP belongs to a MAC group, the MAC will be removed from both the MAC group and flexible IP.
104
166
  */
105
167
  fipId: string;
106
168
  };
107
169
  export type DetachFlexibleIPRequest = {
108
- /** Zone to target. If none is passed will use default zone from the config. */
170
+ /**
171
+ * Zone to target. If none is passed will use default zone from the config.
172
+ */
109
173
  zone?: ScwZone;
110
174
  /**
111
- * List of flexible IP IDs to detach from a server. Multiple IDs can be
112
- * provided. Note that flexible IPs must belong to the same MAC group.
175
+ * List of flexible IP IDs to detach from a server. Multiple IDs can be provided. Note that flexible IPs must belong to the same MAC group.
113
176
  */
114
177
  fipsIds: string[];
115
178
  };
116
179
  export interface DetachFlexibleIPsResponse {
117
- /** Total count of flexible IPs that are being detached. */
180
+ /**
181
+ * Total count of flexible IPs that are being detached.
182
+ */
118
183
  totalCount: number;
119
- /** List of flexible IPs in a detaching state. */
184
+ /**
185
+ * List of flexible IPs in a detaching state.
186
+ */
120
187
  flexibleIps: FlexibleIP[];
121
188
  }
122
189
  export type DuplicateMACAddrRequest = {
123
- /** Zone to target. If none is passed will use default zone from the config. */
190
+ /**
191
+ * Zone to target. If none is passed will use default zone from the config.
192
+ */
124
193
  zone?: ScwZone;
125
- /** Note that the flexible IPs need to be attached to the same server. */
194
+ /**
195
+ * Note that the flexible IPs need to be attached to the same server.
196
+ */
126
197
  fipId: string;
127
- /** Note that flexible IPs need to be attached to the same server. */
198
+ /**
199
+ * Note that flexible IPs need to be attached to the same server.
200
+ */
128
201
  duplicateFromFipId: string;
129
202
  };
130
203
  export type GenerateMACAddrRequest = {
131
- /** Zone to target. If none is passed will use default zone from the config. */
204
+ /**
205
+ * Zone to target. If none is passed will use default zone from the config.
206
+ */
132
207
  zone?: ScwZone;
133
- /** ID of the flexible IP for which to generate a virtual MAC. */
208
+ /**
209
+ * ID of the flexible IP for which to generate a virtual MAC.
210
+ */
134
211
  fipId: string;
135
- /** TODO. */
212
+ /**
213
+ * TODO.
214
+ */
136
215
  macType: MACAddressType;
137
216
  };
138
217
  export type GetFlexibleIPRequest = {
139
- /** Zone to target. If none is passed will use default zone from the config. */
218
+ /**
219
+ * Zone to target. If none is passed will use default zone from the config.
220
+ */
140
221
  zone?: ScwZone;
141
- /** ID of the flexible IP. */
222
+ /**
223
+ * ID of the flexible IP.
224
+ */
142
225
  fipId: string;
143
226
  };
144
227
  export type ListFlexibleIPsRequest = {
145
- /** Zone to target. If none is passed will use default zone from the config. */
228
+ /**
229
+ * Zone to target. If none is passed will use default zone from the config.
230
+ */
146
231
  zone?: ScwZone;
147
- /** Sort order of the returned flexible IPs. */
232
+ /**
233
+ * Sort order of the returned flexible IPs.
234
+ */
148
235
  orderBy?: ListFlexibleIPsRequestOrderBy;
149
- /** Page number. */
236
+ /**
237
+ * Page number.
238
+ */
150
239
  page?: number;
151
- /** Maximum number of flexible IPs per page. */
240
+ /**
241
+ * Maximum number of flexible IPs per page.
242
+ */
152
243
  pageSize?: number;
153
244
  /**
154
- * Filter by tag, only flexible IPs with one or more matching tags will be
155
- * returned.
245
+ * Filter by tag, only flexible IPs with one or more matching tags will be returned.
156
246
  */
157
247
  tags?: string[];
158
- /** Filter by status, only flexible IPs with this status will be returned. */
248
+ /**
249
+ * Filter by status, only flexible IPs with this status will be returned.
250
+ */
159
251
  status?: FlexibleIPStatus[];
160
252
  /**
161
- * Filter by server IDs, only flexible IPs with these server IDs will be
162
- * returned.
253
+ * Filter by server IDs, only flexible IPs with these server IDs will be returned.
163
254
  */
164
255
  serverIds?: string[];
165
256
  /**
166
- * Filter by Organization ID, only flexible IPs from this Organization will be
167
- * returned.
257
+ * Filter by Organization ID, only flexible IPs from this Organization will be returned.
168
258
  */
169
259
  organizationId?: string;
170
- /** Filter by Project ID, only flexible IPs from this Project will be returned. */
260
+ /**
261
+ * Filter by Project ID, only flexible IPs from this Project will be returned.
262
+ */
171
263
  projectId?: string;
172
264
  };
173
265
  export interface ListFlexibleIPsResponse {
174
- /** Total count of matching flexible IPs. */
266
+ /**
267
+ * Total count of matching flexible IPs.
268
+ */
175
269
  totalCount: number;
176
- /** List of all flexible IPs. */
270
+ /**
271
+ * List of all flexible IPs.
272
+ */
177
273
  flexibleIps: FlexibleIP[];
178
274
  }
179
275
  export type MoveMACAddrRequest = {
180
- /** Zone to target. If none is passed will use default zone from the config. */
276
+ /**
277
+ * Zone to target. If none is passed will use default zone from the config.
278
+ */
181
279
  zone?: ScwZone;
182
280
  fipId: string;
183
281
  dstFipId: string;
184
282
  };
185
283
  export type UpdateFlexibleIPRequest = {
186
- /** Zone to target. If none is passed will use default zone from the config. */
284
+ /**
285
+ * Zone to target. If none is passed will use default zone from the config.
286
+ */
187
287
  zone?: ScwZone;
188
- /** ID of the flexible IP to update. */
288
+ /**
289
+ * ID of the flexible IP to update.
290
+ */
189
291
  fipId: string;
190
- /** Flexible IP description (max. 255 characters). */
292
+ /**
293
+ * Flexible IP description (max. 255 characters).
294
+ */
191
295
  description?: string;
192
- /** Tags associated with the flexible IP. */
296
+ /**
297
+ * Tags associated with the flexible IP.
298
+ */
193
299
  tags?: string[];
194
- /** Value of the reverse DNS. */
300
+ /**
301
+ * Value of the reverse DNS.
302
+ */
195
303
  reverse?: string;
196
304
  };
@@ -352,7 +352,7 @@ export interface Token {
352
352
  */
353
353
  functionId?: string;
354
354
  /**
355
- * UUID of the namespace the token is assoicated with.
355
+ * UUID of the namespace the token is associated with.
356
356
  *
357
357
  * One-of ('scope'): at most one of 'functionId', 'namespaceId' could be set.
358
358
  */
@@ -480,7 +480,7 @@ export type CreateFunctionRequest = {
480
480
  */
481
481
  environmentVariables?: Record<string, string>;
482
482
  /**
483
- * Minumum number of instances to scale the function to.
483
+ * Minimum number of instances to scale the function to.
484
484
  */
485
485
  minScale?: number;
486
486
  /**
@@ -820,7 +820,7 @@ export type ListDomainsRequest = {
820
820
  */
821
821
  orderBy?: ListDomainsRequestOrderBy;
822
822
  /**
823
- * UUID of the function the domain is assoicated with.
823
+ * UUID of the function the domain is associated with.
824
824
  */
825
825
  functionId: string;
826
826
  };
@@ -876,7 +876,7 @@ export type ListFunctionsRequest = {
876
876
  */
877
877
  name?: string;
878
878
  /**
879
- * UUID of the Organziation the function belongs to.
879
+ * UUID of the Organization the function belongs to.
880
880
  */
881
881
  organizationId?: string;
882
882
  /**
@@ -949,7 +949,7 @@ export type ListTokensRequest = {
949
949
  */
950
950
  orderBy?: ListTokensRequestOrderBy;
951
951
  /**
952
- * UUID of the function the token is assoicated with.
952
+ * UUID of the function the token is associated with.
953
953
  */
954
954
  functionId?: string;
955
955
  /**
@@ -1047,7 +1047,7 @@ export type UpdateFunctionRequest = {
1047
1047
  */
1048
1048
  environmentVariables?: Record<string, string>;
1049
1049
  /**
1050
- * Minumum number of instances to scale the function to.
1050
+ * Minimum number of instances to scale the function to.
1051
1051
  */
1052
1052
  minScale?: number;
1053
1053
  /**
@@ -441,7 +441,7 @@ class API extends api.API {
441
441
  marshalling_gen.unmarshalGroup
442
442
  );
443
443
  /**
444
- * Get a group. Retrive information about a given group, specified by the `group_id` parameter. The group's full details, including `user_ids` and `application_ids` are returned in the response.
444
+ * Get a group. Retrieve information about a given group, specified by the `group_id` parameter. The group's full details, including `user_ids` and `application_ids` are returned in the response.
445
445
  *
446
446
  * @param request - The request {@link GetGroupRequest}
447
447
  * @returns A Promise of Group
@@ -778,7 +778,7 @@ class API extends api.API {
778
778
  marshalling_gen.unmarshalAPIKey
779
779
  );
780
780
  /**
781
- * Get an API key. Retrive information about an API key, specified by the `access_key` parameter. The API key's details, including either the `user_id` or `application_id` of its bearer are returned in the response. Note that the string value for the `secret_key` is nullable, and therefore is not displayed in the response. The `secret_key` value is only displayed upon API key creation.
781
+ * Get an API key. Retrieve information about an API key, specified by the `access_key` parameter. The API key's details, including either the `user_id` or `application_id` of its bearer are returned in the response. Note that the string value for the `secret_key` is nullable, and therefore is not displayed in the response. The `secret_key` value is only displayed upon API key creation.
782
782
  *
783
783
  * @param request - The request {@link GetAPIKeyRequest}
784
784
  * @returns A Promise of APIKey
@@ -860,7 +860,7 @@ class API extends api.API {
860
860
  },
861
861
  marshalling_gen.unmarshalQuotum
862
862
  );
863
- pageOfListJWTs = (request = {}) => this.client.fetch(
863
+ pageOfListJWTs = (request) => this.client.fetch(
864
864
  {
865
865
  method: "GET",
866
866
  path: `/iam/v1alpha1/jwts`,
@@ -883,7 +883,7 @@ class API extends api.API {
883
883
  * @param request - The request {@link ListJWTsRequest}
884
884
  * @returns A Promise of ListJWTsResponse
885
885
  */
886
- listJWTs = (request = {}) => resourcePaginator.enrichForPagination("jwts", this.pageOfListJWTs, request);
886
+ listJWTs = (request) => resourcePaginator.enrichForPagination("jwts", this.pageOfListJWTs, request);
887
887
  /**
888
888
  * Create a JWT.
889
889
  *