@scaleway/sdk 2.72.0 → 2.73.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 (146) 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/types.gen.d.ts +187 -85
  5. package/dist/api/applesilicon/v1alpha1/api.gen.cjs +19 -46
  6. package/dist/api/applesilicon/v1alpha1/api.gen.d.ts +24 -49
  7. package/dist/api/applesilicon/v1alpha1/api.gen.js +19 -46
  8. package/dist/api/applesilicon/v1alpha1/types.gen.d.ts +310 -135
  9. package/dist/api/audit_trail/v1alpha1/api.gen.cjs +2 -5
  10. package/dist/api/audit_trail/v1alpha1/api.gen.d.ts +4 -8
  11. package/dist/api/audit_trail/v1alpha1/api.gen.js +2 -5
  12. package/dist/api/audit_trail/v1alpha1/types.gen.d.ts +110 -82
  13. package/dist/api/baremetal/v1/api.gen.cjs +28 -61
  14. package/dist/api/baremetal/v1/api.gen.d.ts +29 -60
  15. package/dist/api/baremetal/v1/api.gen.js +28 -61
  16. package/dist/api/baremetal/v1/types.gen.d.ts +802 -315
  17. package/dist/api/baremetal/v3/api.gen.cjs +7 -14
  18. package/dist/api/baremetal/v3/api.gen.d.ts +10 -15
  19. package/dist/api/baremetal/v3/api.gen.js +7 -14
  20. package/dist/api/baremetal/v3/types.gen.d.ts +82 -32
  21. package/dist/api/billing/v2beta1/api.gen.cjs +11 -20
  22. package/dist/api/billing/v2beta1/api.gen.d.ts +9 -19
  23. package/dist/api/billing/v2beta1/api.gen.js +11 -20
  24. package/dist/api/billing/v2beta1/types.gen.d.ts +231 -102
  25. package/dist/api/block/v1/api.gen.cjs +37 -55
  26. package/dist/api/block/v1/api.gen.d.ts +19 -37
  27. package/dist/api/block/v1/api.gen.js +37 -55
  28. package/dist/api/block/v1/types.gen.d.ts +306 -125
  29. package/dist/api/block/v1alpha1/api.gen.cjs +45 -64
  30. package/dist/api/block/v1alpha1/api.gen.d.ts +22 -41
  31. package/dist/api/block/v1alpha1/api.gen.js +45 -64
  32. package/dist/api/block/v1alpha1/types.gen.d.ts +327 -132
  33. package/dist/api/cockpit/v1/api.gen.cjs +100 -156
  34. package/dist/api/cockpit/v1/api.gen.d.ts +53 -112
  35. package/dist/api/cockpit/v1/api.gen.js +100 -156
  36. package/dist/api/cockpit/v1/types.gen.d.ts +567 -246
  37. package/dist/api/container/v1beta1/api.gen.cjs +7 -14
  38. package/dist/api/container/v1beta1/api.gen.d.ts +9 -16
  39. package/dist/api/container/v1beta1/api.gen.js +7 -14
  40. package/dist/api/container/v1beta1/types.gen.d.ts +648 -322
  41. package/dist/api/dedibox/v1/api.gen.cjs +45 -69
  42. package/dist/api/dedibox/v1/api.gen.d.ts +52 -62
  43. package/dist/api/dedibox/v1/api.gen.js +45 -69
  44. package/dist/api/dedibox/v1/types.gen.d.ts +1765 -645
  45. package/dist/api/domain/v2beta1/api.gen.cjs +119 -178
  46. package/dist/api/domain/v2beta1/api.gen.d.ts +71 -130
  47. package/dist/api/domain/v2beta1/api.gen.js +119 -178
  48. package/dist/api/domain/v2beta1/content.gen.d.ts +1 -4
  49. package/dist/api/domain/v2beta1/types.gen.d.ts +411 -199
  50. package/dist/api/flexibleip/v1alpha1/api.gen.cjs +10 -25
  51. package/dist/api/flexibleip/v1alpha1/api.gen.d.ts +12 -28
  52. package/dist/api/flexibleip/v1alpha1/api.gen.js +10 -25
  53. package/dist/api/flexibleip/v1alpha1/types.gen.d.ts +186 -78
  54. package/dist/api/inference/v1/api.gen.cjs +8 -11
  55. package/dist/api/inference/v1/api.gen.d.ts +6 -9
  56. package/dist/api/inference/v1/api.gen.js +8 -11
  57. package/dist/api/inference/v1/types.gen.d.ts +330 -150
  58. package/dist/api/inference/v1beta1/api.gen.cjs +8 -11
  59. package/dist/api/inference/v1beta1/api.gen.d.ts +6 -9
  60. package/dist/api/inference/v1beta1/api.gen.js +8 -11
  61. package/dist/api/inference/v1beta1/types.gen.d.ts +341 -154
  62. package/dist/api/instance/v1/api.gen.cjs +64 -113
  63. package/dist/api/instance/v1/api.gen.d.ts +54 -103
  64. package/dist/api/instance/v1/api.gen.js +64 -113
  65. package/dist/api/instance/v1/types.gen.d.ts +1351 -598
  66. package/dist/api/instance/v1/types.private.gen.d.ts +131 -59
  67. package/dist/api/interlink/v1beta1/api.gen.cjs +21 -67
  68. package/dist/api/interlink/v1beta1/api.gen.d.ts +23 -70
  69. package/dist/api/interlink/v1beta1/api.gen.js +21 -67
  70. package/dist/api/interlink/v1beta1/marshalling.gen.cjs +2 -0
  71. package/dist/api/interlink/v1beta1/marshalling.gen.js +2 -0
  72. package/dist/api/interlink/v1beta1/types.gen.d.ts +464 -216
  73. package/dist/api/interlink/v1beta1/validation-rules.gen.cjs +8 -0
  74. package/dist/api/interlink/v1beta1/validation-rules.gen.d.ts +8 -0
  75. package/dist/api/interlink/v1beta1/validation-rules.gen.js +8 -0
  76. package/dist/api/iot/v1/api.gen.cjs +37 -70
  77. package/dist/api/iot/v1/api.gen.d.ts +34 -67
  78. package/dist/api/iot/v1/api.gen.js +37 -70
  79. package/dist/api/iot/v1/types.gen.d.ts +566 -321
  80. package/dist/api/ipam/v1/api.gen.cjs +6 -26
  81. package/dist/api/ipam/v1/api.gen.d.ts +8 -29
  82. package/dist/api/ipam/v1/api.gen.js +6 -26
  83. package/dist/api/ipam/v1/types.gen.d.ts +146 -105
  84. package/dist/api/jobs/v1alpha1/api.gen.cjs +2 -4
  85. package/dist/api/jobs/v1alpha1/api.gen.d.ts +4 -6
  86. package/dist/api/jobs/v1alpha1/api.gen.js +2 -4
  87. package/dist/api/jobs/v1alpha1/types.gen.d.ts +165 -91
  88. package/dist/api/k8s/v1/api.gen.cjs +33 -78
  89. package/dist/api/k8s/v1/api.gen.d.ts +27 -72
  90. package/dist/api/k8s/v1/api.gen.js +33 -78
  91. package/dist/api/k8s/v1/types.gen.d.ts +743 -506
  92. package/dist/api/key_manager/v1alpha1/api.gen.cjs +21 -57
  93. package/dist/api/key_manager/v1alpha1/api.gen.d.ts +19 -56
  94. package/dist/api/key_manager/v1alpha1/api.gen.js +21 -57
  95. package/dist/api/key_manager/v1alpha1/types.gen.d.ts +196 -114
  96. package/dist/api/marketplace/v2/api.gen.cjs +8 -21
  97. package/dist/api/marketplace/v2/api.gen.d.ts +10 -24
  98. package/dist/api/marketplace/v2/api.gen.js +8 -21
  99. package/dist/api/marketplace/v2/types.gen.d.ts +94 -41
  100. package/dist/api/mnq/v1beta1/api.gen.cjs +24 -76
  101. package/dist/api/mnq/v1beta1/api.gen.d.ts +30 -82
  102. package/dist/api/mnq/v1beta1/api.gen.js +24 -76
  103. package/dist/api/mnq/v1beta1/types.gen.d.ts +342 -169
  104. package/dist/api/mongodb/v1alpha1/api.gen.cjs +19 -62
  105. package/dist/api/mongodb/v1alpha1/api.gen.d.ts +21 -64
  106. package/dist/api/mongodb/v1alpha1/api.gen.js +19 -62
  107. package/dist/api/mongodb/v1alpha1/types.gen.d.ts +443 -189
  108. package/dist/api/qaas/v1alpha1/api.gen.cjs +17 -34
  109. package/dist/api/qaas/v1alpha1/api.gen.d.ts +19 -36
  110. package/dist/api/qaas/v1alpha1/api.gen.js +17 -34
  111. package/dist/api/qaas/v1alpha1/types.gen.d.ts +502 -174
  112. package/dist/api/rdb/v1/api.gen.cjs +62 -202
  113. package/dist/api/rdb/v1/api.gen.d.ts +60 -201
  114. package/dist/api/rdb/v1/api.gen.js +62 -202
  115. package/dist/api/rdb/v1/types.gen.d.ts +1005 -524
  116. package/dist/api/redis/v1/api.gen.cjs +23 -83
  117. package/dist/api/redis/v1/api.gen.d.ts +25 -85
  118. package/dist/api/redis/v1/api.gen.js +23 -83
  119. package/dist/api/redis/v1/types.gen.d.ts +447 -170
  120. package/dist/api/registry/v1/api.gen.cjs +12 -40
  121. package/dist/api/registry/v1/api.gen.d.ts +14 -42
  122. package/dist/api/registry/v1/api.gen.js +12 -40
  123. package/dist/api/registry/v1/types.gen.d.ts +200 -116
  124. package/dist/api/secret/v1beta1/api.gen.cjs +19 -47
  125. package/dist/api/secret/v1beta1/api.gen.d.ts +21 -51
  126. package/dist/api/secret/v1beta1/api.gen.js +19 -47
  127. package/dist/api/secret/v1beta1/types.gen.d.ts +359 -224
  128. package/dist/api/serverless_sqldb/v1alpha1/api.gen.cjs +9 -27
  129. package/dist/api/serverless_sqldb/v1alpha1/api.gen.d.ts +11 -29
  130. package/dist/api/serverless_sqldb/v1alpha1/api.gen.js +9 -27
  131. package/dist/api/serverless_sqldb/v1alpha1/types.gen.d.ts +168 -76
  132. package/dist/api/tem/v1alpha1/api.gen.cjs +22 -58
  133. package/dist/api/tem/v1alpha1/api.gen.d.ts +24 -60
  134. package/dist/api/tem/v1alpha1/api.gen.js +22 -58
  135. package/dist/api/tem/v1alpha1/types.gen.d.ts +761 -338
  136. package/dist/api/test/v1/api.gen.cjs +8 -11
  137. package/dist/api/test/v1/api.gen.d.ts +6 -9
  138. package/dist/api/test/v1/api.gen.js +8 -11
  139. package/dist/api/test/v1/types.gen.d.ts +21 -10
  140. package/dist/client/dist/package.json.cjs +1 -1
  141. package/dist/client/dist/package.json.js +1 -1
  142. package/node_modules/@scaleway/sdk-client/dist/package.json.cjs +1 -1
  143. package/node_modules/@scaleway/sdk-client/dist/package.json.js +1 -1
  144. package/node_modules/@scaleway/sdk-client/package.json +1 -2
  145. package/package.json +2 -2
  146. package/node_modules/@scaleway/sdk-client/LICENSE +0 -191
@@ -17,8 +17,7 @@ class API extends api.API {
17
17
  "pl-waw"
18
18
  ];
19
19
  /**
20
- * Reserve a new IP. Reserve a new IP from the specified source. Currently IPs
21
- * can only be reserved from a Private Network.
20
+ * Reserve a new IP. Reserve a new IP from the specified source. Currently IPs can only be reserved from a Private Network.
22
21
  *
23
22
  * @param request - The request {@link BookIPRequest}
24
23
  * @returns A Promise of IP
@@ -35,8 +34,7 @@ class API extends api.API {
35
34
  marshalling_gen.unmarshalIP
36
35
  );
37
36
  /**
38
- * Release an IP. Release an IP not currently attached to a resource, and
39
- * returns it to the available IP pool.
37
+ * Release an IP. Release an IP not currently attached to a resource, and returns it to the available IP pool.
40
38
  *
41
39
  * @param request - The request {@link ReleaseIPRequest}
42
40
  */
@@ -120,23 +118,14 @@ class API extends api.API {
120
118
  marshalling_gen.unmarshalListIPsResponse
121
119
  );
122
120
  /**
123
- * List existing IPs. List existing IPs in the specified region using various
124
- * filters. For example, you can filter for IPs within a specified Private
125
- * Network, or for public IPs within a specified Project. By default, the IPs
126
- * returned in the list are ordered by creation date in ascending order,
127
- * though this can be modified via the order_by field.
121
+ * List existing IPs. List existing IPs in the specified region using various filters. For example, you can filter for IPs within a specified Private Network, or for public IPs within a specified Project. By default, the IPs returned in the list are ordered by creation date in ascending order, though this can be modified via the order_by field.
128
122
  *
129
123
  * @param request - The request {@link ListIPsRequest}
130
124
  * @returns A Promise of ListIPsResponse
131
125
  */
132
126
  listIPs = (request = {}) => resourcePaginator.enrichForPagination("ips", this.pageOfListIPs, request);
133
127
  /**
134
- * Attach IP to custom resource. Attach an existing reserved IP from a Private
135
- * Network subnet to a custom, named resource via its MAC address. An example
136
- * of a custom resource is a virtual machine hosted on an Elastic Metal
137
- * server. Do not use this method for attaching IP addresses to standard
138
- * Scaleway resources as it will fail - see the relevant product API for an
139
- * equivalent method.
128
+ * Attach IP to custom resource. Attach an existing reserved IP from a Private Network subnet to a custom, named resource via its MAC address. An example of a custom resource is a virtual machine hosted on an Elastic Metal server. Do not use this method for attaching IP addresses to standard Scaleway resources as it will fail - see the relevant product API for an equivalent method.
140
129
  *
141
130
  * @param request - The request {@link AttachIPRequest}
142
131
  * @returns A Promise of IP
@@ -153,11 +142,7 @@ class API extends api.API {
153
142
  marshalling_gen.unmarshalIP
154
143
  );
155
144
  /**
156
- * Detach IP from a custom resource. Detach a private IP from a custom
157
- * resource. An example of a custom resource is a virtual machine hosted on an
158
- * Elastic Metal server. Do not use this method for detaching IP addresses
159
- * from standard Scaleway resources (e.g. Instances, Load Balancers) as it
160
- * will fail - see the relevant product API for an equivalent method.
145
+ * Detach IP from a custom resource. Detach a private IP from a custom resource. An example of a custom resource is a virtual machine hosted on an Elastic Metal server. Do not use this method for detaching IP addresses from standard Scaleway resources (e.g. Instances, Load Balancers) as it will fail - see the relevant product API for an equivalent method.
161
146
  *
162
147
  * @param request - The request {@link DetachIPRequest}
163
148
  * @returns A Promise of IP
@@ -174,12 +159,7 @@ class API extends api.API {
174
159
  marshalling_gen.unmarshalIP
175
160
  );
176
161
  /**
177
- * Move IP to a custom resource. Move an existing reserved private IP from one
178
- * custom resource (e.g. a virtual machine hosted on an Elastic Metal server)
179
- * to another custom resource. This will detach it from the first resource,
180
- * and attach it to the second. Do not use this method for moving IP addresses
181
- * between standard Scaleway resources (e.g. Instances, Load Balancers) as it
182
- * will fail - see the relevant product API for an equivalent method.
162
+ * Move IP to a custom resource. Move an existing reserved private IP from one custom resource (e.g. a virtual machine hosted on an Elastic Metal server) to another custom resource. This will detach it from the first resource, and attach it to the second. Do not use this method for moving IP addresses between standard Scaleway resources (e.g. Instances, Load Balancers) as it will fail - see the relevant product API for an equivalent method.
183
163
  *
184
164
  * @param request - The request {@link MoveIPRequest}
185
165
  * @returns A Promise of IP
@@ -3,24 +3,21 @@ import type { Region as ScwRegion } from '@scaleway/sdk-client';
3
3
  import type { AttachIPRequest, BookIPRequest, DetachIPRequest, GetIPRequest, IP, ListIPsRequest, ListIPsResponse, MoveIPRequest, ReleaseIPRequest, ReleaseIPSetRequest, UpdateIPRequest } from './types.gen';
4
4
  /**
5
5
  * IPAM API.
6
- *
7
- * This API allows you to manage your Scaleway IP addresses with our IP Address
8
- * Management tool.
6
+
7
+ This API allows you to manage your Scaleway IP addresses with our IP Address Management tool.
9
8
  */
10
9
  export declare class API extends ParentAPI {
11
10
  /** Lists the available regions of the API. */
12
11
  static readonly LOCALITIES: ScwRegion[];
13
12
  /**
14
- * Reserve a new IP. Reserve a new IP from the specified source. Currently IPs
15
- * can only be reserved from a Private Network.
13
+ * Reserve a new IP. Reserve a new IP from the specified source. Currently IPs can only be reserved from a Private Network.
16
14
  *
17
15
  * @param request - The request {@link BookIPRequest}
18
16
  * @returns A Promise of IP
19
17
  */
20
18
  bookIP: (request: Readonly<BookIPRequest>) => Promise<IP>;
21
19
  /**
22
- * Release an IP. Release an IP not currently attached to a resource, and
23
- * returns it to the available IP pool.
20
+ * Release an IP. Release an IP not currently attached to a resource, and returns it to the available IP pool.
24
21
  *
25
22
  * @param request - The request {@link ReleaseIPRequest}
26
23
  */
@@ -42,11 +39,7 @@ export declare class API extends ParentAPI {
42
39
  updateIP: (request: Readonly<UpdateIPRequest>) => Promise<IP>;
43
40
  protected pageOfListIPs: (request?: Readonly<ListIPsRequest>) => Promise<ListIPsResponse>;
44
41
  /**
45
- * List existing IPs. List existing IPs in the specified region using various
46
- * filters. For example, you can filter for IPs within a specified Private
47
- * Network, or for public IPs within a specified Project. By default, the IPs
48
- * returned in the list are ordered by creation date in ascending order,
49
- * though this can be modified via the order_by field.
42
+ * List existing IPs. List existing IPs in the specified region using various filters. For example, you can filter for IPs within a specified Private Network, or for public IPs within a specified Project. By default, the IPs returned in the list are ordered by creation date in ascending order, though this can be modified via the order_by field.
50
43
  *
51
44
  * @param request - The request {@link ListIPsRequest}
52
45
  * @returns A Promise of ListIPsResponse
@@ -56,35 +49,21 @@ export declare class API extends ParentAPI {
56
49
  [Symbol.asyncIterator]: () => AsyncGenerator<IP[], void, void>;
57
50
  };
58
51
  /**
59
- * Attach IP to custom resource. Attach an existing reserved IP from a Private
60
- * Network subnet to a custom, named resource via its MAC address. An example
61
- * of a custom resource is a virtual machine hosted on an Elastic Metal
62
- * server. Do not use this method for attaching IP addresses to standard
63
- * Scaleway resources as it will fail - see the relevant product API for an
64
- * equivalent method.
52
+ * Attach IP to custom resource. Attach an existing reserved IP from a Private Network subnet to a custom, named resource via its MAC address. An example of a custom resource is a virtual machine hosted on an Elastic Metal server. Do not use this method for attaching IP addresses to standard Scaleway resources as it will fail - see the relevant product API for an equivalent method.
65
53
  *
66
54
  * @param request - The request {@link AttachIPRequest}
67
55
  * @returns A Promise of IP
68
56
  */
69
57
  attachIP: (request: Readonly<AttachIPRequest>) => Promise<IP>;
70
58
  /**
71
- * Detach IP from a custom resource. Detach a private IP from a custom
72
- * resource. An example of a custom resource is a virtual machine hosted on an
73
- * Elastic Metal server. Do not use this method for detaching IP addresses
74
- * from standard Scaleway resources (e.g. Instances, Load Balancers) as it
75
- * will fail - see the relevant product API for an equivalent method.
59
+ * Detach IP from a custom resource. Detach a private IP from a custom resource. An example of a custom resource is a virtual machine hosted on an Elastic Metal server. Do not use this method for detaching IP addresses from standard Scaleway resources (e.g. Instances, Load Balancers) as it will fail - see the relevant product API for an equivalent method.
76
60
  *
77
61
  * @param request - The request {@link DetachIPRequest}
78
62
  * @returns A Promise of IP
79
63
  */
80
64
  detachIP: (request: Readonly<DetachIPRequest>) => Promise<IP>;
81
65
  /**
82
- * Move IP to a custom resource. Move an existing reserved private IP from one
83
- * custom resource (e.g. a virtual machine hosted on an Elastic Metal server)
84
- * to another custom resource. This will detach it from the first resource,
85
- * and attach it to the second. Do not use this method for moving IP addresses
86
- * between standard Scaleway resources (e.g. Instances, Load Balancers) as it
87
- * will fail - see the relevant product API for an equivalent method.
66
+ * Move IP to a custom resource. Move an existing reserved private IP from one custom resource (e.g. a virtual machine hosted on an Elastic Metal server) to another custom resource. This will detach it from the first resource, and attach it to the second. Do not use this method for moving IP addresses between standard Scaleway resources (e.g. Instances, Load Balancers) as it will fail - see the relevant product API for an equivalent method.
88
67
  *
89
68
  * @param request - The request {@link MoveIPRequest}
90
69
  * @returns A Promise of IP
@@ -15,8 +15,7 @@ class API extends API$1 {
15
15
  "pl-waw"
16
16
  ];
17
17
  /**
18
- * Reserve a new IP. Reserve a new IP from the specified source. Currently IPs
19
- * can only be reserved from a Private Network.
18
+ * Reserve a new IP. Reserve a new IP from the specified source. Currently IPs can only be reserved from a Private Network.
20
19
  *
21
20
  * @param request - The request {@link BookIPRequest}
22
21
  * @returns A Promise of IP
@@ -33,8 +32,7 @@ class API extends API$1 {
33
32
  unmarshalIP
34
33
  );
35
34
  /**
36
- * Release an IP. Release an IP not currently attached to a resource, and
37
- * returns it to the available IP pool.
35
+ * Release an IP. Release an IP not currently attached to a resource, and returns it to the available IP pool.
38
36
  *
39
37
  * @param request - The request {@link ReleaseIPRequest}
40
38
  */
@@ -118,23 +116,14 @@ class API extends API$1 {
118
116
  unmarshalListIPsResponse
119
117
  );
120
118
  /**
121
- * List existing IPs. List existing IPs in the specified region using various
122
- * filters. For example, you can filter for IPs within a specified Private
123
- * Network, or for public IPs within a specified Project. By default, the IPs
124
- * returned in the list are ordered by creation date in ascending order,
125
- * though this can be modified via the order_by field.
119
+ * List existing IPs. List existing IPs in the specified region using various filters. For example, you can filter for IPs within a specified Private Network, or for public IPs within a specified Project. By default, the IPs returned in the list are ordered by creation date in ascending order, though this can be modified via the order_by field.
126
120
  *
127
121
  * @param request - The request {@link ListIPsRequest}
128
122
  * @returns A Promise of ListIPsResponse
129
123
  */
130
124
  listIPs = (request = {}) => enrichForPagination("ips", this.pageOfListIPs, request);
131
125
  /**
132
- * Attach IP to custom resource. Attach an existing reserved IP from a Private
133
- * Network subnet to a custom, named resource via its MAC address. An example
134
- * of a custom resource is a virtual machine hosted on an Elastic Metal
135
- * server. Do not use this method for attaching IP addresses to standard
136
- * Scaleway resources as it will fail - see the relevant product API for an
137
- * equivalent method.
126
+ * Attach IP to custom resource. Attach an existing reserved IP from a Private Network subnet to a custom, named resource via its MAC address. An example of a custom resource is a virtual machine hosted on an Elastic Metal server. Do not use this method for attaching IP addresses to standard Scaleway resources as it will fail - see the relevant product API for an equivalent method.
138
127
  *
139
128
  * @param request - The request {@link AttachIPRequest}
140
129
  * @returns A Promise of IP
@@ -151,11 +140,7 @@ class API extends API$1 {
151
140
  unmarshalIP
152
141
  );
153
142
  /**
154
- * Detach IP from a custom resource. Detach a private IP from a custom
155
- * resource. An example of a custom resource is a virtual machine hosted on an
156
- * Elastic Metal server. Do not use this method for detaching IP addresses
157
- * from standard Scaleway resources (e.g. Instances, Load Balancers) as it
158
- * will fail - see the relevant product API for an equivalent method.
143
+ * Detach IP from a custom resource. Detach a private IP from a custom resource. An example of a custom resource is a virtual machine hosted on an Elastic Metal server. Do not use this method for detaching IP addresses from standard Scaleway resources (e.g. Instances, Load Balancers) as it will fail - see the relevant product API for an equivalent method.
159
144
  *
160
145
  * @param request - The request {@link DetachIPRequest}
161
146
  * @returns A Promise of IP
@@ -172,12 +157,7 @@ class API extends API$1 {
172
157
  unmarshalIP
173
158
  );
174
159
  /**
175
- * Move IP to a custom resource. Move an existing reserved private IP from one
176
- * custom resource (e.g. a virtual machine hosted on an Elastic Metal server)
177
- * to another custom resource. This will detach it from the first resource,
178
- * and attach it to the second. Do not use this method for moving IP addresses
179
- * between standard Scaleway resources (e.g. Instances, Load Balancers) as it
180
- * will fail - see the relevant product API for an equivalent method.
160
+ * Move IP to a custom resource. Move an existing reserved private IP from one custom resource (e.g. a virtual machine hosted on an Elastic Metal server) to another custom resource. This will detach it from the first resource, and attach it to the second. Do not use this method for moving IP addresses between standard Scaleway resources (e.g. Instances, Load Balancers) as it will fail - see the relevant product API for an equivalent method.
181
161
  *
182
162
  * @param request - The request {@link MoveIPRequest}
183
163
  * @returns A Promise of IP
@@ -2,233 +2,267 @@ import type { Region as ScwRegion, Zone as ScwZone } from '@scaleway/sdk-client'
2
2
  export type ListIPsRequestOrderBy = 'created_at_desc' | 'created_at_asc' | 'updated_at_desc' | 'updated_at_asc' | 'attached_at_desc' | 'attached_at_asc';
3
3
  export type ResourceType = 'unknown_type' | 'custom' | 'instance_server' | 'instance_ip' | 'instance_private_nic' | 'lb_server' | 'fip_ip' | 'vpc_gateway' | 'vpc_gateway_network' | 'k8s_node' | 'k8s_cluster' | 'rdb_instance' | 'redis_cluster' | 'baremetal_server' | 'baremetal_private_nic' | 'llm_deployment' | 'mgdb_instance' | 'apple_silicon_server' | 'apple_silicon_private_nic' | 'serverless_container' | 'serverless_function';
4
4
  export interface Resource {
5
- /** Type of resource the IP is attached to. */
5
+ /**
6
+ * Type of resource the IP is attached to.
7
+ */
6
8
  type: ResourceType;
7
- /** ID of the resource the IP is attached to. */
9
+ /**
10
+ * ID of the resource the IP is attached to.
11
+ */
8
12
  id: string;
9
- /** MAC of the resource the IP is attached to. */
13
+ /**
14
+ * MAC of the resource the IP is attached to.
15
+ */
10
16
  macAddress?: string;
11
17
  /**
12
- * When the IP is in a Private Network, then a DNS record is available to
13
- * resolve the resource name to this IP.
18
+ * When the IP is in a Private Network, then a DNS record is available to resolve the resource name to this IP.
14
19
  */
15
20
  name?: string;
16
21
  }
17
22
  export interface Reverse {
18
- /** Reverse domain name. */
23
+ /**
24
+ * Reverse domain name.
25
+ */
19
26
  hostname: string;
20
- /** IP corresponding to the hostname. */
27
+ /**
28
+ * IP corresponding to the hostname.
29
+ */
21
30
  address?: string;
22
31
  }
23
32
  export interface Source {
24
33
  /**
25
34
  * This source is global.
26
35
  *
27
- * One-of ('source'): at most one of 'zonal', 'privateNetworkId', 'subnetId'
28
- * could be set.
36
+ * One-of ('source'): at most one of 'zonal', 'privateNetworkId', 'subnetId' could be set.
29
37
  */
30
38
  zonal?: string;
31
39
  /**
32
40
  * This source is specific.
33
41
  *
34
- * One-of ('source'): at most one of 'zonal', 'privateNetworkId', 'subnetId'
35
- * could be set.
42
+ * One-of ('source'): at most one of 'zonal', 'privateNetworkId', 'subnetId' could be set.
36
43
  */
37
44
  privateNetworkId?: string;
38
45
  /**
39
46
  * This source is specific.
40
47
  *
41
- * One-of ('source'): at most one of 'zonal', 'privateNetworkId', 'subnetId'
42
- * could be set.
48
+ * One-of ('source'): at most one of 'zonal', 'privateNetworkId', 'subnetId' could be set.
43
49
  */
44
50
  subnetId?: string;
45
51
  }
46
52
  export interface CustomResource {
47
- /** MAC address of the custom resource. */
53
+ /**
54
+ * MAC address of the custom resource.
55
+ */
48
56
  macAddress: string;
49
57
  /**
50
- * When the resource is in a Private Network, a DNS record is available to
51
- * resolve the resource name.
58
+ * When the resource is in a Private Network, a DNS record is available to resolve the resource name.
52
59
  */
53
60
  name?: string;
54
61
  }
55
62
  export interface IP {
56
- /** IP ID. */
63
+ /**
64
+ * IP ID.
65
+ */
57
66
  id: string;
58
- /** IPv4 or IPv6 address in CIDR notation. */
67
+ /**
68
+ * IPv4 or IPv6 address in CIDR notation.
69
+ */
59
70
  address: string;
60
- /** Scaleway Project the IP belongs to. */
71
+ /**
72
+ * Scaleway Project the IP belongs to.
73
+ */
61
74
  projectId: string;
62
- /** Defines whether the IP is an IPv6 (false = IPv4). */
75
+ /**
76
+ * Defines whether the IP is an IPv6 (false = IPv4).
77
+ */
63
78
  isIpv6: boolean;
64
- /** Date the IP was reserved. */
79
+ /**
80
+ * Date the IP was reserved.
81
+ */
65
82
  createdAt?: Date;
66
- /** Date the IP was last modified. */
83
+ /**
84
+ * Date the IP was last modified.
85
+ */
67
86
  updatedAt?: Date;
68
- /** Source pool where the IP was reserved in. */
87
+ /**
88
+ * Source pool where the IP was reserved in.
89
+ */
69
90
  source?: Source;
70
- /** Resource which the IP is attached to. */
91
+ /**
92
+ * Resource which the IP is attached to.
93
+ */
71
94
  resource?: Resource;
72
- /** Tags for the IP. */
95
+ /**
96
+ * Tags for the IP.
97
+ */
73
98
  tags: string[];
74
- /** Array of reverses associated with the IP. */
99
+ /**
100
+ * Array of reverses associated with the IP.
101
+ */
75
102
  reverses: Reverse[];
76
- /** Region of the IP. */
103
+ /**
104
+ * Region of the IP.
105
+ */
77
106
  region: ScwRegion;
78
- /** Zone of the IP, if zonal. */
107
+ /**
108
+ * Zone of the IP, if zonal.
109
+ */
79
110
  zone?: ScwZone;
80
111
  }
81
112
  export type AttachIPRequest = {
82
113
  /**
83
- * Region to target. If none is passed will use default region from the
84
- * config.
114
+ * Region to target. If none is passed will use default region from the config.
85
115
  */
86
116
  region?: ScwRegion;
87
- /** IP ID. */
117
+ /**
118
+ * IP ID.
119
+ */
88
120
  ipId: string;
89
- /** Custom resource to be attached to the IP. */
121
+ /**
122
+ * Custom resource to be attached to the IP.
123
+ */
90
124
  resource: CustomResource;
91
125
  };
92
126
  export type BookIPRequest = {
93
127
  /**
94
- * Region to target. If none is passed will use default region from the
95
- * config.
128
+ * Region to target. If none is passed will use default region from the config.
96
129
  */
97
130
  region?: ScwRegion;
98
131
  /**
99
- * When creating an IP in a Private Network, the Project must match the
100
- * Private Network's Project.
132
+ * When creating an IP in a Private Network, the Project must match the Private Network's Project.
101
133
  */
102
134
  projectId?: string;
103
135
  /**
104
- * Source in which to reserve the IP. Not all sources are available for
105
- * reservation.
136
+ * Source in which to reserve the IP. Not all sources are available for reservation.
106
137
  */
107
138
  source: Source;
108
- /** Request an IPv6 instead of an IPv4. */
139
+ /**
140
+ * Request an IPv6 instead of an IPv4.
141
+ */
109
142
  isIpv6: boolean;
110
143
  /**
111
- * The requested address should not include the subnet mask (/suffix). Note
112
- * that only the Private Network source allows you to pick a specific IP. If
113
- * the requested IP is already reserved, then the call will fail.
144
+ * The requested address should not include the subnet mask (/suffix). Note that only the Private Network source allows you to pick a specific IP. If the requested IP is already reserved, then the call will fail.
114
145
  */
115
146
  address?: string;
116
- /** Tags for the IP. */
147
+ /**
148
+ * Tags for the IP.
149
+ */
117
150
  tags?: string[];
118
151
  /**
119
- * Custom resource to attach to the IP being reserved. An example of a custom
120
- * resource is a virtual machine hosted on an Elastic Metal server. Do not use
121
- * this for attaching IP addresses to standard Scaleway resources, as it will
122
- * fail - instead, see the relevant product API for an equivalent method.
152
+ * Custom resource to attach to the IP being reserved. An example of a custom resource is a virtual machine hosted on an Elastic Metal server. Do not use this for attaching IP addresses to standard Scaleway resources, as it will fail - instead, see the relevant product API for an equivalent method.
123
153
  */
124
154
  resource?: CustomResource;
125
155
  };
126
156
  export type DetachIPRequest = {
127
157
  /**
128
- * Region to target. If none is passed will use default region from the
129
- * config.
158
+ * Region to target. If none is passed will use default region from the config.
130
159
  */
131
160
  region?: ScwRegion;
132
- /** IP ID. */
161
+ /**
162
+ * IP ID.
163
+ */
133
164
  ipId: string;
134
- /** Custom resource currently attached to the IP. */
165
+ /**
166
+ * Custom resource currently attached to the IP.
167
+ */
135
168
  resource: CustomResource;
136
169
  };
137
170
  export type GetIPRequest = {
138
171
  /**
139
- * Region to target. If none is passed will use default region from the
140
- * config.
172
+ * Region to target. If none is passed will use default region from the config.
141
173
  */
142
174
  region?: ScwRegion;
143
- /** IP ID. */
175
+ /**
176
+ * IP ID.
177
+ */
144
178
  ipId: string;
145
179
  };
146
180
  export type ListIPsRequest = {
147
181
  /**
148
- * Region to target. If none is passed will use default region from the
149
- * config.
182
+ * Region to target. If none is passed will use default region from the config.
150
183
  */
151
184
  region?: ScwRegion;
152
- /** Sort order of the returned IPs. */
185
+ /**
186
+ * Sort order of the returned IPs.
187
+ */
153
188
  orderBy?: ListIPsRequestOrderBy;
154
- /** Page number to return, from the paginated results. */
189
+ /**
190
+ * Page number to return, from the paginated results.
191
+ */
155
192
  page?: number;
156
- /** Maximum number of IPs to return per page. */
193
+ /**
194
+ * Maximum number of IPs to return per page.
195
+ */
157
196
  pageSize?: number;
158
197
  /**
159
- * Project ID to filter for. Only IPs belonging to this Project will be
160
- * returned.
198
+ * Project ID to filter for. Only IPs belonging to this Project will be returned.
161
199
  */
162
200
  projectId?: string;
163
201
  /**
164
- * Zone to filter for. Only IPs that are zonal, and in this zone, will be
165
- * returned.
202
+ * Zone to filter for. Only IPs that are zonal, and in this zone, will be returned.
166
203
  *
167
- * One-of ('source'): at most one of 'zonal', 'privateNetworkId', 'subnetId'
168
- * could be set.
204
+ * One-of ('source'): at most one of 'zonal', 'privateNetworkId', 'subnetId' could be set.
169
205
  */
170
206
  zonal?: string;
171
207
  /**
172
208
  * Only IPs that are private, and in this Private Network, will be returned.
173
209
  *
174
- * One-of ('source'): at most one of 'zonal', 'privateNetworkId', 'subnetId'
175
- * could be set.
210
+ * One-of ('source'): at most one of 'zonal', 'privateNetworkId', 'subnetId' could be set.
176
211
  */
177
212
  privateNetworkId?: string;
178
213
  /**
179
214
  * Only IPs inside this exact subnet will be returned.
180
215
  *
181
- * One-of ('source'): at most one of 'zonal', 'privateNetworkId', 'subnetId'
182
- * could be set.
216
+ * One-of ('source'): at most one of 'zonal', 'privateNetworkId', 'subnetId' could be set.
183
217
  */
184
218
  subnetId?: string;
185
- /** Only IPs owned by resources in this VPC will be returned. */
219
+ /**
220
+ * Only IPs owned by resources in this VPC will be returned.
221
+ */
186
222
  vpcId?: string;
187
- /** Defines whether to filter only for IPs which are attached to a resource. */
223
+ /**
224
+ * Defines whether to filter only for IPs which are attached to a resource.
225
+ */
188
226
  attached?: boolean;
189
227
  /**
190
- * Attached resource name to filter for, only IPs attached to a resource with
191
- * this string within their name will be returned.
228
+ * Attached resource name to filter for, only IPs attached to a resource with this string within their name will be returned.
192
229
  */
193
230
  resourceName?: string;
194
231
  /**
195
- * Resource ID to filter for. Only IPs attached to this resource will be
196
- * returned.
232
+ * Resource ID to filter for. Only IPs attached to this resource will be returned.
197
233
  */
198
234
  resourceId?: string;
199
235
  /**
200
- * Resource IDs to filter for. Only IPs attached to at least one of these
201
- * resources will be returned.
236
+ * Resource IDs to filter for. Only IPs attached to at least one of these resources will be returned.
202
237
  */
203
238
  resourceIds?: string[];
204
239
  /**
205
- * Resource type to filter for. Only IPs attached to this type of resource
206
- * will be returned.
240
+ * Resource type to filter for. Only IPs attached to this type of resource will be returned.
207
241
  */
208
242
  resourceType?: ResourceType;
209
243
  /**
210
- * Resource types to filter for. Only IPs attached to these types of resources
211
- * will be returned.
244
+ * Resource types to filter for. Only IPs attached to these types of resources will be returned.
212
245
  */
213
246
  resourceTypes?: ResourceType[];
214
247
  /**
215
- * MAC address to filter for. Only IPs attached to a resource with this MAC
216
- * address will be returned.
248
+ * MAC address to filter for. Only IPs attached to a resource with this MAC address will be returned.
217
249
  */
218
250
  macAddress?: string;
219
251
  /**
220
- * Tags to filter for, only IPs with one or more matching tags will be
221
- * returned.
252
+ * Tags to filter for, only IPs with one or more matching tags will be returned.
222
253
  */
223
254
  tags?: string[];
224
255
  /**
225
- * Organization ID to filter for. Only IPs belonging to this Organization will
226
- * be returned.
256
+ * Organization ID to filter for. Only IPs belonging to this Organization will be returned.
227
257
  */
228
258
  organizationId?: string;
229
- /** Defines whether to filter only for IPv4s or IPv6s. */
259
+ /**
260
+ * Defines whether to filter only for IPv4s or IPv6s.
261
+ */
230
262
  isIpv6?: boolean;
231
- /** IP IDs to filter for. Only IPs with these UUIDs will be returned. */
263
+ /**
264
+ * IP IDs to filter for. Only IPs with these UUIDs will be returned.
265
+ */
232
266
  ipIds?: string[];
233
267
  };
234
268
  export interface ListIPsResponse {
@@ -237,47 +271,54 @@ export interface ListIPsResponse {
237
271
  }
238
272
  export type MoveIPRequest = {
239
273
  /**
240
- * Region to target. If none is passed will use default region from the
241
- * config.
274
+ * Region to target. If none is passed will use default region from the config.
242
275
  */
243
276
  region?: ScwRegion;
244
- /** IP ID. */
277
+ /**
278
+ * IP ID.
279
+ */
245
280
  ipId: string;
246
- /** Custom resource currently attached to the IP. */
281
+ /**
282
+ * Custom resource currently attached to the IP.
283
+ */
247
284
  fromResource: CustomResource;
248
- /** Custom resource to be attached to the IP. */
285
+ /**
286
+ * Custom resource to be attached to the IP.
287
+ */
249
288
  toResource?: CustomResource;
250
289
  };
251
290
  export type ReleaseIPRequest = {
252
291
  /**
253
- * Region to target. If none is passed will use default region from the
254
- * config.
292
+ * Region to target. If none is passed will use default region from the config.
255
293
  */
256
294
  region?: ScwRegion;
257
- /** IP ID. */
295
+ /**
296
+ * IP ID.
297
+ */
258
298
  ipId: string;
259
299
  };
260
300
  export type ReleaseIPSetRequest = {
261
301
  /**
262
- * Region to target. If none is passed will use default region from the
263
- * config.
302
+ * Region to target. If none is passed will use default region from the config.
264
303
  */
265
304
  region?: ScwRegion;
266
305
  ipIds?: string[];
267
306
  };
268
307
  export type UpdateIPRequest = {
269
308
  /**
270
- * Region to target. If none is passed will use default region from the
271
- * config.
309
+ * Region to target. If none is passed will use default region from the config.
272
310
  */
273
311
  region?: ScwRegion;
274
- /** IP ID. */
312
+ /**
313
+ * IP ID.
314
+ */
275
315
  ipId: string;
276
- /** Tags for the IP. */
316
+ /**
317
+ * Tags for the IP.
318
+ */
277
319
  tags?: string[];
278
320
  /**
279
- * Array of reverse domain names associated with an IP in the subnet of the
280
- * current IP.
321
+ * Array of reverse domain names associated with an IP in the subnet of the current IP.
281
322
  */
282
323
  reverses?: Reverse[];
283
324
  };