@scaleway/sdk 2.63.0 → 2.65.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.
- package/dist/api/applesilicon/v1alpha1/api.gen.d.ts +3 -3
- package/dist/api/applesilicon/v1alpha1/types.gen.d.ts +20 -20
- package/dist/api/cockpit/v1/api.gen.cjs +19 -1
- package/dist/api/cockpit/v1/api.gen.d.ts +4 -3
- package/dist/api/cockpit/v1/api.gen.js +20 -2
- package/dist/api/cockpit/v1/index.gen.d.ts +1 -1
- package/dist/api/cockpit/v1/marshalling.gen.cjs +13 -0
- package/dist/api/cockpit/v1/marshalling.gen.d.ts +2 -1
- package/dist/api/cockpit/v1/marshalling.gen.js +13 -0
- package/dist/api/cockpit/v1/types.gen.d.ts +50 -31
- package/dist/api/edge_services/v1alpha1/types.gen.d.ts +3 -3
- package/dist/api/iam/v1alpha1/index.gen.d.ts +1 -1
- package/dist/api/iam/v1alpha1/marshalling.gen.cjs +16 -0
- package/dist/api/iam/v1alpha1/marshalling.gen.js +16 -0
- package/dist/api/iam/v1alpha1/types.gen.d.ts +48 -4
- package/dist/api/iam/v1alpha1/validation-rules.gen.cjs +7 -3
- package/dist/api/iam/v1alpha1/validation-rules.gen.d.ts +6 -3
- package/dist/api/iam/v1alpha1/validation-rules.gen.js +7 -3
- package/dist/api/inference/v1beta1/api.gen.d.ts +2 -2
- package/dist/api/inference/v1beta1/types.gen.d.ts +21 -21
- package/dist/api/instance/v1/api.gen.d.ts +2 -2
- package/dist/api/instance/v1/types.gen.d.ts +87 -87
- package/dist/api/instance/v1/types.private.gen.d.ts +5 -5
- package/dist/api/interlink/v1beta1/api.gen.cjs +5 -1
- package/dist/api/interlink/v1beta1/api.gen.d.ts +2 -2
- package/dist/api/interlink/v1beta1/api.gen.js +5 -1
- package/dist/api/interlink/v1beta1/marshalling.gen.cjs +1 -0
- package/dist/api/interlink/v1beta1/marshalling.gen.js +1 -0
- package/dist/api/interlink/v1beta1/types.gen.d.ts +29 -24
- package/dist/api/ipam/v1/api.gen.cjs +5 -1
- package/dist/api/ipam/v1/api.gen.d.ts +2 -2
- package/dist/api/ipam/v1/api.gen.js +5 -1
- package/dist/api/ipam/v1/types.gen.d.ts +13 -13
- package/dist/api/key_manager/v1alpha1/api.gen.cjs +41 -37
- package/dist/api/key_manager/v1alpha1/api.gen.d.ts +38 -38
- package/dist/api/key_manager/v1alpha1/api.gen.js +41 -37
- package/dist/api/key_manager/v1alpha1/types.gen.d.ts +31 -30
- package/dist/api/lb/v1/api.gen.cjs +5 -1
- package/dist/api/lb/v1/api.gen.d.ts +3 -3
- package/dist/api/lb/v1/api.gen.js +5 -1
- package/dist/api/lb/v1/types.gen.d.ts +116 -116
- package/dist/api/vpc/v2/api.gen.cjs +5 -21
- package/dist/api/vpc/v2/api.gen.d.ts +3 -13
- package/dist/api/vpc/v2/api.gen.js +6 -22
- package/dist/api/vpc/v2/index.gen.d.ts +1 -1
- package/dist/api/vpc/v2/marshalling.gen.cjs +0 -16
- package/dist/api/vpc/v2/marshalling.gen.d.ts +1 -2
- package/dist/api/vpc/v2/marshalling.gen.js +1 -17
- package/dist/api/vpc/v2/types.gen.d.ts +24 -49
- package/dist/api/webhosting/v1/api.gen.cjs +98 -10
- package/dist/api/webhosting/v1/api.gen.d.ts +40 -12
- package/dist/api/webhosting/v1/api.gen.js +100 -12
- package/dist/api/webhosting/v1/content.gen.cjs +4 -0
- package/dist/api/webhosting/v1/content.gen.d.ts +5 -1
- package/dist/api/webhosting/v1/content.gen.js +4 -0
- package/dist/api/webhosting/v1/index.gen.cjs +2 -0
- package/dist/api/webhosting/v1/index.gen.d.ts +1 -1
- package/dist/api/webhosting/v1/index.gen.js +3 -1
- package/dist/api/webhosting/v1/marshalling.gen.cjs +45 -0
- package/dist/api/webhosting/v1/marshalling.gen.d.ts +3 -1
- package/dist/api/webhosting/v1/marshalling.gen.js +45 -0
- package/dist/api/webhosting/v1/types.gen.d.ts +102 -36
- package/dist/api/webhosting/v1alpha1/api.gen.cjs +6 -2
- package/dist/api/webhosting/v1alpha1/api.gen.d.ts +3 -3
- package/dist/api/webhosting/v1alpha1/api.gen.js +6 -2
- package/dist/api/webhosting/v1alpha1/types.gen.d.ts +19 -19
- package/dist/scw/constants.cjs +1 -1
- package/dist/scw/constants.d.ts +2 -2
- package/dist/scw/constants.js +1 -1
- package/package.json +2 -2
|
@@ -1,11 +1,11 @@
|
|
|
1
|
-
import type { Zone } from '../../../bridge';
|
|
1
|
+
import type { Zone as ScwZone } from '../../../bridge';
|
|
2
2
|
import type { Arch, BootType, Image, PlacementGroup, PrivateNIC, SecurityGroup, SecurityGroupPolicy, SecurityGroupRule, SecurityGroupRuleAction, SecurityGroupRuleDirection, SecurityGroupRuleProtocol, SecurityGroupSummary, Server, ServerAction, ServerIp, ServerIpv6, ServerLocation, ServerMaintenance, ServerState, ServerSummary, Snapshot, SnapshotBaseVolume, SnapshotState, Volume, VolumeVolumeType } from './types.gen';
|
|
3
3
|
export interface SetImageResponse {
|
|
4
4
|
image?: Image;
|
|
5
5
|
}
|
|
6
6
|
export type SetSecurityGroupRequest = {
|
|
7
7
|
/** Zone to target. If none is passed will use default zone from the config. */
|
|
8
|
-
zone?:
|
|
8
|
+
zone?: ScwZone;
|
|
9
9
|
/** UUID of the security group. */
|
|
10
10
|
id: string;
|
|
11
11
|
/** Name of the security group. */
|
|
@@ -45,7 +45,7 @@ export interface SetSecurityGroupResponse {
|
|
|
45
45
|
}
|
|
46
46
|
export type SetSecurityGroupRuleRequest = {
|
|
47
47
|
/** Zone to target. If none is passed will use default zone from the config. */
|
|
48
|
-
zone?:
|
|
48
|
+
zone?: ScwZone;
|
|
49
49
|
securityGroupId: string;
|
|
50
50
|
securityGroupRuleId: string;
|
|
51
51
|
id: string;
|
|
@@ -63,7 +63,7 @@ export interface SetSecurityGroupRuleResponse {
|
|
|
63
63
|
}
|
|
64
64
|
export type SetServerRequest = {
|
|
65
65
|
/** Zone to target. If none is passed will use default zone from the config. */
|
|
66
|
-
zone?:
|
|
66
|
+
zone?: ScwZone;
|
|
67
67
|
/** Instance unique ID. */
|
|
68
68
|
id: string;
|
|
69
69
|
/** Instance name. */
|
|
@@ -153,7 +153,7 @@ export interface SetServerResponse {
|
|
|
153
153
|
}
|
|
154
154
|
export type SetSnapshotRequest = {
|
|
155
155
|
/** Zone to target. If none is passed will use default zone from the config. */
|
|
156
|
-
zone?:
|
|
156
|
+
zone?: ScwZone;
|
|
157
157
|
snapshotId: string;
|
|
158
158
|
id: string;
|
|
159
159
|
name: string;
|
|
@@ -10,7 +10,11 @@ const jsonContentHeaders = {
|
|
|
10
10
|
};
|
|
11
11
|
class API extends api.API {
|
|
12
12
|
/** Lists the available regions of the API. */
|
|
13
|
-
static LOCALITIES = [
|
|
13
|
+
static LOCALITIES = [
|
|
14
|
+
"fr-par",
|
|
15
|
+
"nl-ams",
|
|
16
|
+
"pl-waw"
|
|
17
|
+
];
|
|
14
18
|
pageOfListPartners = (request = {}) => this.client.fetch(
|
|
15
19
|
{
|
|
16
20
|
method: "GET",
|
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
import { API as ParentAPI } from '../../../bridge';
|
|
2
|
-
import type { Region } from '../../../bridge';
|
|
2
|
+
import type { Region as ScwRegion } from '../../../bridge';
|
|
3
3
|
import type { AttachRoutingPolicyRequest, AttachVpcRequest, CreateLinkRequest, CreateRoutingPolicyRequest, DeleteLinkRequest, DeleteRoutingPolicyRequest, DetachRoutingPolicyRequest, DetachVpcRequest, DisableRoutePropagationRequest, EnableRoutePropagationRequest, GetLinkRequest, GetPartnerRequest, GetPopRequest, GetRoutingPolicyRequest, Link, ListLinksRequest, ListLinksResponse, ListPartnersRequest, ListPartnersResponse, ListPopsRequest, ListPopsResponse, ListRoutingPoliciesRequest, ListRoutingPoliciesResponse, Partner, Pop, RoutingPolicy, UpdateLinkRequest, UpdateRoutingPolicyRequest } from './types.gen';
|
|
4
4
|
/**
|
|
5
5
|
* InterLink API.
|
|
@@ -9,7 +9,7 @@ import type { AttachRoutingPolicyRequest, AttachVpcRequest, CreateLinkRequest, C
|
|
|
9
9
|
*/
|
|
10
10
|
export declare class API extends ParentAPI {
|
|
11
11
|
/** Lists the available regions of the API. */
|
|
12
|
-
static readonly LOCALITIES:
|
|
12
|
+
static readonly LOCALITIES: ScwRegion[];
|
|
13
13
|
protected pageOfListPartners: (request?: Readonly<ListPartnersRequest>) => Promise<ListPartnersResponse>;
|
|
14
14
|
/**
|
|
15
15
|
* List available partners. List all available partners. By default, the
|
|
@@ -8,7 +8,11 @@ const jsonContentHeaders = {
|
|
|
8
8
|
};
|
|
9
9
|
class API extends API$1 {
|
|
10
10
|
/** Lists the available regions of the API. */
|
|
11
|
-
static LOCALITIES = [
|
|
11
|
+
static LOCALITIES = [
|
|
12
|
+
"fr-par",
|
|
13
|
+
"nl-ams",
|
|
14
|
+
"pl-waw"
|
|
15
|
+
];
|
|
12
16
|
pageOfListPartners = (request = {}) => this.client.fetch(
|
|
13
17
|
{
|
|
14
18
|
method: "GET",
|
|
@@ -14,6 +14,7 @@ const unmarshalLink = (data) => {
|
|
|
14
14
|
bgpV4Status: data.bgp_v4_status,
|
|
15
15
|
bgpV6Status: data.bgp_v6_status,
|
|
16
16
|
createdAt: marshalling.unmarshalDate(data.created_at),
|
|
17
|
+
disapprovedReason: data.disapproved_reason,
|
|
17
18
|
enableRoutePropagation: data.enable_route_propagation,
|
|
18
19
|
id: data.id,
|
|
19
20
|
name: data.name,
|
|
@@ -12,6 +12,7 @@ const unmarshalLink = (data) => {
|
|
|
12
12
|
bgpV4Status: data.bgp_v4_status,
|
|
13
13
|
bgpV6Status: data.bgp_v6_status,
|
|
14
14
|
createdAt: unmarshalDate(data.created_at),
|
|
15
|
+
disapprovedReason: data.disapproved_reason,
|
|
15
16
|
enableRoutePropagation: data.enable_route_propagation,
|
|
16
17
|
id: data.id,
|
|
17
18
|
name: data.name,
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import type { Region } from '../../../bridge';
|
|
1
|
+
import type { Region as ScwRegion } from '../../../bridge';
|
|
2
2
|
export type BgpStatus = 'unknown_bgp_status' | 'up' | 'down';
|
|
3
3
|
export type LinkStatus = 'unknown_link_status' | 'configuring' | 'failed' | 'requested' | 'refused' | 'expired' | 'provisioning' | 'active' | 'limited_connectivity' | 'all_down' | 'deprovisioning' | 'deleted' | 'locked';
|
|
4
4
|
export type ListLinksRequestOrderBy = 'created_at_asc' | 'created_at_desc' | 'name_asc' | 'name_desc' | 'status_asc' | 'status_desc';
|
|
@@ -43,8 +43,13 @@ export interface Link {
|
|
|
43
43
|
updatedAt?: Date;
|
|
44
44
|
/** Used to identify a link from a user or partner's point of view. */
|
|
45
45
|
pairingKey: string;
|
|
46
|
+
/**
|
|
47
|
+
* Reason given by partner to explain why they did not approve the request for
|
|
48
|
+
* a hosted link.
|
|
49
|
+
*/
|
|
50
|
+
disapprovedReason?: string;
|
|
46
51
|
/** Region of the link. */
|
|
47
|
-
region:
|
|
52
|
+
region: ScwRegion;
|
|
48
53
|
}
|
|
49
54
|
export interface Partner {
|
|
50
55
|
/** Unique identifier of the partner. */
|
|
@@ -84,7 +89,7 @@ export interface Pop {
|
|
|
84
89
|
*/
|
|
85
90
|
availableLinkBandwidthsMbps: number[];
|
|
86
91
|
/** Region of the PoP. */
|
|
87
|
-
region:
|
|
92
|
+
region: ScwRegion;
|
|
88
93
|
}
|
|
89
94
|
export interface RoutingPolicy {
|
|
90
95
|
/** Unique identifier of the routing policy. */
|
|
@@ -109,14 +114,14 @@ export interface RoutingPolicy {
|
|
|
109
114
|
/** Last modification date of the routing policy. */
|
|
110
115
|
updatedAt?: Date;
|
|
111
116
|
/** Region of the routing policy. */
|
|
112
|
-
region:
|
|
117
|
+
region: ScwRegion;
|
|
113
118
|
}
|
|
114
119
|
export type AttachRoutingPolicyRequest = {
|
|
115
120
|
/**
|
|
116
121
|
* Region to target. If none is passed will use default region from the
|
|
117
122
|
* config.
|
|
118
123
|
*/
|
|
119
|
-
region?:
|
|
124
|
+
region?: ScwRegion;
|
|
120
125
|
/** ID of the link to attach a routing policy to. */
|
|
121
126
|
linkId: string;
|
|
122
127
|
/** ID of the routing policy to be attached. */
|
|
@@ -127,7 +132,7 @@ export type AttachVpcRequest = {
|
|
|
127
132
|
* Region to target. If none is passed will use default region from the
|
|
128
133
|
* config.
|
|
129
134
|
*/
|
|
130
|
-
region?:
|
|
135
|
+
region?: ScwRegion;
|
|
131
136
|
/** ID of the link to attach VPC to. */
|
|
132
137
|
linkId: string;
|
|
133
138
|
/** ID of the VPC to attach. */
|
|
@@ -138,7 +143,7 @@ export type CreateLinkRequest = {
|
|
|
138
143
|
* Region to target. If none is passed will use default region from the
|
|
139
144
|
* config.
|
|
140
145
|
*/
|
|
141
|
-
region?:
|
|
146
|
+
region?: ScwRegion;
|
|
142
147
|
/** ID of the Project to create the link in. */
|
|
143
148
|
projectId?: string;
|
|
144
149
|
/** Name of the link. */
|
|
@@ -191,7 +196,7 @@ export type CreateRoutingPolicyRequest = {
|
|
|
191
196
|
* Region to target. If none is passed will use default region from the
|
|
192
197
|
* config.
|
|
193
198
|
*/
|
|
194
|
-
region?:
|
|
199
|
+
region?: ScwRegion;
|
|
195
200
|
/** ID of the Project to create the routing policy in. */
|
|
196
201
|
projectId?: string;
|
|
197
202
|
/** Name of the routing policy. */
|
|
@@ -211,7 +216,7 @@ export type DeleteLinkRequest = {
|
|
|
211
216
|
* Region to target. If none is passed will use default region from the
|
|
212
217
|
* config.
|
|
213
218
|
*/
|
|
214
|
-
region?:
|
|
219
|
+
region?: ScwRegion;
|
|
215
220
|
/** ID of the link to delete. */
|
|
216
221
|
linkId: string;
|
|
217
222
|
};
|
|
@@ -220,7 +225,7 @@ export type DeleteRoutingPolicyRequest = {
|
|
|
220
225
|
* Region to target. If none is passed will use default region from the
|
|
221
226
|
* config.
|
|
222
227
|
*/
|
|
223
|
-
region?:
|
|
228
|
+
region?: ScwRegion;
|
|
224
229
|
/** ID of the routing policy to delete. */
|
|
225
230
|
routingPolicyId: string;
|
|
226
231
|
};
|
|
@@ -229,7 +234,7 @@ export type DetachRoutingPolicyRequest = {
|
|
|
229
234
|
* Region to target. If none is passed will use default region from the
|
|
230
235
|
* config.
|
|
231
236
|
*/
|
|
232
|
-
region?:
|
|
237
|
+
region?: ScwRegion;
|
|
233
238
|
/** ID of the link to detach a routing policy from. */
|
|
234
239
|
linkId: string;
|
|
235
240
|
};
|
|
@@ -238,7 +243,7 @@ export type DetachVpcRequest = {
|
|
|
238
243
|
* Region to target. If none is passed will use default region from the
|
|
239
244
|
* config.
|
|
240
245
|
*/
|
|
241
|
-
region?:
|
|
246
|
+
region?: ScwRegion;
|
|
242
247
|
/** ID of the link to detach the VPC from. */
|
|
243
248
|
linkId: string;
|
|
244
249
|
};
|
|
@@ -247,7 +252,7 @@ export type DisableRoutePropagationRequest = {
|
|
|
247
252
|
* Region to target. If none is passed will use default region from the
|
|
248
253
|
* config.
|
|
249
254
|
*/
|
|
250
|
-
region?:
|
|
255
|
+
region?: ScwRegion;
|
|
251
256
|
/** ID of the link on which to disable route propagation. */
|
|
252
257
|
linkId: string;
|
|
253
258
|
};
|
|
@@ -256,7 +261,7 @@ export type EnableRoutePropagationRequest = {
|
|
|
256
261
|
* Region to target. If none is passed will use default region from the
|
|
257
262
|
* config.
|
|
258
263
|
*/
|
|
259
|
-
region?:
|
|
264
|
+
region?: ScwRegion;
|
|
260
265
|
/** ID of the link on which to enable route propagation. */
|
|
261
266
|
linkId: string;
|
|
262
267
|
};
|
|
@@ -265,7 +270,7 @@ export type GetLinkRequest = {
|
|
|
265
270
|
* Region to target. If none is passed will use default region from the
|
|
266
271
|
* config.
|
|
267
272
|
*/
|
|
268
|
-
region?:
|
|
273
|
+
region?: ScwRegion;
|
|
269
274
|
/** ID of the link to get. */
|
|
270
275
|
linkId: string;
|
|
271
276
|
};
|
|
@@ -274,7 +279,7 @@ export type GetPartnerRequest = {
|
|
|
274
279
|
* Region to target. If none is passed will use default region from the
|
|
275
280
|
* config.
|
|
276
281
|
*/
|
|
277
|
-
region?:
|
|
282
|
+
region?: ScwRegion;
|
|
278
283
|
/** ID of partner to get. */
|
|
279
284
|
partnerId: string;
|
|
280
285
|
};
|
|
@@ -283,7 +288,7 @@ export type GetPopRequest = {
|
|
|
283
288
|
* Region to target. If none is passed will use default region from the
|
|
284
289
|
* config.
|
|
285
290
|
*/
|
|
286
|
-
region?:
|
|
291
|
+
region?: ScwRegion;
|
|
287
292
|
/** ID of PoP to get. */
|
|
288
293
|
popId: string;
|
|
289
294
|
};
|
|
@@ -292,7 +297,7 @@ export type GetRoutingPolicyRequest = {
|
|
|
292
297
|
* Region to target. If none is passed will use default region from the
|
|
293
298
|
* config.
|
|
294
299
|
*/
|
|
295
|
-
region?:
|
|
300
|
+
region?: ScwRegion;
|
|
296
301
|
/** ID of the routing policy to get. */
|
|
297
302
|
routingPolicyId: string;
|
|
298
303
|
};
|
|
@@ -301,7 +306,7 @@ export type ListLinksRequest = {
|
|
|
301
306
|
* Region to target. If none is passed will use default region from the
|
|
302
307
|
* config.
|
|
303
308
|
*/
|
|
304
|
-
region?:
|
|
309
|
+
region?: ScwRegion;
|
|
305
310
|
/** Order in which to return results. */
|
|
306
311
|
orderBy?: ListLinksRequestOrderBy;
|
|
307
312
|
/** Page number to return. */
|
|
@@ -346,7 +351,7 @@ export type ListPartnersRequest = {
|
|
|
346
351
|
* Region to target. If none is passed will use default region from the
|
|
347
352
|
* config.
|
|
348
353
|
*/
|
|
349
|
-
region?:
|
|
354
|
+
region?: ScwRegion;
|
|
350
355
|
/** Order in which to return results. */
|
|
351
356
|
orderBy?: ListPartnersRequestOrderBy;
|
|
352
357
|
/** Page number to return. */
|
|
@@ -367,7 +372,7 @@ export type ListPopsRequest = {
|
|
|
367
372
|
* Region to target. If none is passed will use default region from the
|
|
368
373
|
* config.
|
|
369
374
|
*/
|
|
370
|
-
region?:
|
|
375
|
+
region?: ScwRegion;
|
|
371
376
|
/** Order in which to return results. */
|
|
372
377
|
orderBy?: ListPopsRequestOrderBy;
|
|
373
378
|
/** Page number to return. */
|
|
@@ -397,7 +402,7 @@ export type ListRoutingPoliciesRequest = {
|
|
|
397
402
|
* Region to target. If none is passed will use default region from the
|
|
398
403
|
* config.
|
|
399
404
|
*/
|
|
400
|
-
region?:
|
|
405
|
+
region?: ScwRegion;
|
|
401
406
|
/** Order in which to return results. */
|
|
402
407
|
orderBy?: ListRoutingPoliciesRequestOrderBy;
|
|
403
408
|
/** Page number to return. */
|
|
@@ -422,7 +427,7 @@ export type UpdateLinkRequest = {
|
|
|
422
427
|
* Region to target. If none is passed will use default region from the
|
|
423
428
|
* config.
|
|
424
429
|
*/
|
|
425
|
-
region?:
|
|
430
|
+
region?: ScwRegion;
|
|
426
431
|
/** ID of the link to update. */
|
|
427
432
|
linkId: string;
|
|
428
433
|
/** Name of the link. */
|
|
@@ -435,7 +440,7 @@ export type UpdateRoutingPolicyRequest = {
|
|
|
435
440
|
* Region to target. If none is passed will use default region from the
|
|
436
441
|
* config.
|
|
437
442
|
*/
|
|
438
|
-
region?:
|
|
443
|
+
region?: ScwRegion;
|
|
439
444
|
/** ID of the routing policy to update. */
|
|
440
445
|
routingPolicyId: string;
|
|
441
446
|
/** Name of the routing policy. */
|
|
@@ -10,7 +10,11 @@ const jsonContentHeaders = {
|
|
|
10
10
|
};
|
|
11
11
|
class API extends api.API {
|
|
12
12
|
/** Lists the available regions of the API. */
|
|
13
|
-
static LOCALITIES = [
|
|
13
|
+
static LOCALITIES = [
|
|
14
|
+
"fr-par",
|
|
15
|
+
"nl-ams",
|
|
16
|
+
"pl-waw"
|
|
17
|
+
];
|
|
14
18
|
/**
|
|
15
19
|
* Reserve a new IP. Reserve a new IP from the specified source. Currently IPs
|
|
16
20
|
* can only be reserved from a Private Network.
|
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
import { API as ParentAPI } from '../../../bridge';
|
|
2
|
-
import type { Region } from '../../../bridge';
|
|
2
|
+
import type { Region as ScwRegion } from '../../../bridge';
|
|
3
3
|
import type { AttachIPRequest, BookIPRequest, DetachIPRequest, GetIPRequest, IP, ListIPsRequest, ListIPsResponse, MoveIPRequest, ReleaseIPRequest, ReleaseIPSetRequest, UpdateIPRequest } from './types.gen';
|
|
4
4
|
/**
|
|
5
5
|
* IPAM API.
|
|
@@ -9,7 +9,7 @@ import type { AttachIPRequest, BookIPRequest, DetachIPRequest, GetIPRequest, IP,
|
|
|
9
9
|
*/
|
|
10
10
|
export declare class API extends ParentAPI {
|
|
11
11
|
/** Lists the available regions of the API. */
|
|
12
|
-
static readonly LOCALITIES:
|
|
12
|
+
static readonly LOCALITIES: ScwRegion[];
|
|
13
13
|
/**
|
|
14
14
|
* Reserve a new IP. Reserve a new IP from the specified source. Currently IPs
|
|
15
15
|
* can only be reserved from a Private Network.
|
|
@@ -8,7 +8,11 @@ const jsonContentHeaders = {
|
|
|
8
8
|
};
|
|
9
9
|
class API extends API$1 {
|
|
10
10
|
/** Lists the available regions of the API. */
|
|
11
|
-
static LOCALITIES = [
|
|
11
|
+
static LOCALITIES = [
|
|
12
|
+
"fr-par",
|
|
13
|
+
"nl-ams",
|
|
14
|
+
"pl-waw"
|
|
15
|
+
];
|
|
12
16
|
/**
|
|
13
17
|
* Reserve a new IP. Reserve a new IP from the specified source. Currently IPs
|
|
14
18
|
* can only be reserved from a Private Network.
|
|
@@ -1,6 +1,6 @@
|
|
|
1
|
-
import type { Region, Zone } from '../../../bridge';
|
|
1
|
+
import type { Region as ScwRegion, Zone as ScwZone } from '../../../bridge';
|
|
2
2
|
export type ListIPsRequestOrderBy = 'created_at_desc' | 'created_at_asc' | 'updated_at_desc' | 'updated_at_asc' | 'attached_at_desc' | 'attached_at_asc';
|
|
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';
|
|
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
5
|
/** Type of resource the IP is attached to. */
|
|
6
6
|
type: ResourceType;
|
|
@@ -74,16 +74,16 @@ export interface IP {
|
|
|
74
74
|
/** Array of reverses associated with the IP. */
|
|
75
75
|
reverses: Reverse[];
|
|
76
76
|
/** Region of the IP. */
|
|
77
|
-
region:
|
|
77
|
+
region: ScwRegion;
|
|
78
78
|
/** Zone of the IP, if zonal. */
|
|
79
|
-
zone?:
|
|
79
|
+
zone?: ScwZone;
|
|
80
80
|
}
|
|
81
81
|
export type AttachIPRequest = {
|
|
82
82
|
/**
|
|
83
83
|
* Region to target. If none is passed will use default region from the
|
|
84
84
|
* config.
|
|
85
85
|
*/
|
|
86
|
-
region?:
|
|
86
|
+
region?: ScwRegion;
|
|
87
87
|
/** IP ID. */
|
|
88
88
|
ipId: string;
|
|
89
89
|
/** Custom resource to be attached to the IP. */
|
|
@@ -94,7 +94,7 @@ export type BookIPRequest = {
|
|
|
94
94
|
* Region to target. If none is passed will use default region from the
|
|
95
95
|
* config.
|
|
96
96
|
*/
|
|
97
|
-
region?:
|
|
97
|
+
region?: ScwRegion;
|
|
98
98
|
/**
|
|
99
99
|
* When creating an IP in a Private Network, the Project must match the
|
|
100
100
|
* Private Network's Project.
|
|
@@ -128,7 +128,7 @@ export type DetachIPRequest = {
|
|
|
128
128
|
* Region to target. If none is passed will use default region from the
|
|
129
129
|
* config.
|
|
130
130
|
*/
|
|
131
|
-
region?:
|
|
131
|
+
region?: ScwRegion;
|
|
132
132
|
/** IP ID. */
|
|
133
133
|
ipId: string;
|
|
134
134
|
/** Custom resource currently attached to the IP. */
|
|
@@ -139,7 +139,7 @@ export type GetIPRequest = {
|
|
|
139
139
|
* Region to target. If none is passed will use default region from the
|
|
140
140
|
* config.
|
|
141
141
|
*/
|
|
142
|
-
region?:
|
|
142
|
+
region?: ScwRegion;
|
|
143
143
|
/** IP ID. */
|
|
144
144
|
ipId: string;
|
|
145
145
|
};
|
|
@@ -148,7 +148,7 @@ export type ListIPsRequest = {
|
|
|
148
148
|
* Region to target. If none is passed will use default region from the
|
|
149
149
|
* config.
|
|
150
150
|
*/
|
|
151
|
-
region?:
|
|
151
|
+
region?: ScwRegion;
|
|
152
152
|
/** Sort order of the returned IPs. */
|
|
153
153
|
orderBy?: ListIPsRequestOrderBy;
|
|
154
154
|
/** Page number to return, from the paginated results. */
|
|
@@ -240,7 +240,7 @@ export type MoveIPRequest = {
|
|
|
240
240
|
* Region to target. If none is passed will use default region from the
|
|
241
241
|
* config.
|
|
242
242
|
*/
|
|
243
|
-
region?:
|
|
243
|
+
region?: ScwRegion;
|
|
244
244
|
/** IP ID. */
|
|
245
245
|
ipId: string;
|
|
246
246
|
/** Custom resource currently attached to the IP. */
|
|
@@ -253,7 +253,7 @@ export type ReleaseIPRequest = {
|
|
|
253
253
|
* Region to target. If none is passed will use default region from the
|
|
254
254
|
* config.
|
|
255
255
|
*/
|
|
256
|
-
region?:
|
|
256
|
+
region?: ScwRegion;
|
|
257
257
|
/** IP ID. */
|
|
258
258
|
ipId: string;
|
|
259
259
|
};
|
|
@@ -262,7 +262,7 @@ export type ReleaseIPSetRequest = {
|
|
|
262
262
|
* Region to target. If none is passed will use default region from the
|
|
263
263
|
* config.
|
|
264
264
|
*/
|
|
265
|
-
region?:
|
|
265
|
+
region?: ScwRegion;
|
|
266
266
|
ipIds?: string[];
|
|
267
267
|
};
|
|
268
268
|
export type UpdateIPRequest = {
|
|
@@ -270,7 +270,7 @@ export type UpdateIPRequest = {
|
|
|
270
270
|
* Region to target. If none is passed will use default region from the
|
|
271
271
|
* config.
|
|
272
272
|
*/
|
|
273
|
-
region?:
|
|
273
|
+
region?: ScwRegion;
|
|
274
274
|
/** IP ID. */
|
|
275
275
|
ipId: string;
|
|
276
276
|
/** Tags for the IP. */
|
|
@@ -10,12 +10,16 @@ const jsonContentHeaders = {
|
|
|
10
10
|
};
|
|
11
11
|
class API extends api.API {
|
|
12
12
|
/** Lists the available regions of the API. */
|
|
13
|
-
static LOCALITIES = [
|
|
13
|
+
static LOCALITIES = [
|
|
14
|
+
"fr-par",
|
|
15
|
+
"nl-ams",
|
|
16
|
+
"pl-waw"
|
|
17
|
+
];
|
|
14
18
|
/**
|
|
15
19
|
* Create a key. Create a key in a given region specified by the `region`
|
|
16
20
|
* parameter. Keys only support symmetric encryption. You can use keys to
|
|
17
|
-
* encrypt or decrypt arbitrary payloads, or to generate data encryption keys
|
|
18
|
-
*
|
|
21
|
+
* encrypt or decrypt arbitrary payloads, or to generate data encryption keys.
|
|
22
|
+
* **Data encryption keys are not stored in Key Manager**.
|
|
19
23
|
*
|
|
20
24
|
* @param request - The request {@link CreateKeyRequest}
|
|
21
25
|
* @returns A Promise of Key
|
|
@@ -32,7 +36,7 @@ class API extends api.API {
|
|
|
32
36
|
marshalling_gen.unmarshalKey
|
|
33
37
|
);
|
|
34
38
|
/**
|
|
35
|
-
* Get key metadata. Retrieve
|
|
39
|
+
* Get key metadata. Retrieve metadata for a specified key using the `region`
|
|
36
40
|
* and `key_id` parameters.
|
|
37
41
|
*
|
|
38
42
|
* @param request - The request {@link GetKeyRequest}
|
|
@@ -46,7 +50,7 @@ class API extends api.API {
|
|
|
46
50
|
marshalling_gen.unmarshalKey
|
|
47
51
|
);
|
|
48
52
|
/**
|
|
49
|
-
* Update a key.
|
|
53
|
+
* Update a key. Modify a key's metadata including name, description and tags,
|
|
50
54
|
* specified by the `key_id` and `region` parameters.
|
|
51
55
|
*
|
|
52
56
|
* @param request - The request {@link UpdateKeyRequest}
|
|
@@ -64,10 +68,9 @@ class API extends api.API {
|
|
|
64
68
|
marshalling_gen.unmarshalKey
|
|
65
69
|
);
|
|
66
70
|
/**
|
|
67
|
-
* Delete a key.
|
|
68
|
-
* parameters.
|
|
69
|
-
*
|
|
70
|
-
* unusable.
|
|
71
|
+
* Delete a key. Permanently delete a key specified by the `region` and
|
|
72
|
+
* `key_id` parameters. This action is irreversible. Any data encrypted with
|
|
73
|
+
* this key, including data encryption keys, will no longer be decipherable.
|
|
71
74
|
*
|
|
72
75
|
* @param request - The request {@link DeleteKeyRequest}
|
|
73
76
|
*/
|
|
@@ -76,10 +79,10 @@ class API extends api.API {
|
|
|
76
79
|
path: `/key-manager/v1alpha1/regions/${marshalling.validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/keys/${marshalling.validatePathParam("keyId", request.keyId)}`
|
|
77
80
|
});
|
|
78
81
|
/**
|
|
79
|
-
* Rotate a key. Generate a new version of an existing key with
|
|
80
|
-
*
|
|
81
|
-
*
|
|
82
|
-
*
|
|
82
|
+
* Rotate a key. Generate a new version of an existing key with new key
|
|
83
|
+
* material. Previous key versions remain usable to decrypt previously
|
|
84
|
+
* encrypted data, but the key's new version will be used for subsequent
|
|
85
|
+
* encryption operations and data key generation.
|
|
83
86
|
*
|
|
84
87
|
* @param request - The request {@link RotateKeyRequest}
|
|
85
88
|
* @returns A Promise of Key
|
|
@@ -94,7 +97,7 @@ class API extends api.API {
|
|
|
94
97
|
marshalling_gen.unmarshalKey
|
|
95
98
|
);
|
|
96
99
|
/**
|
|
97
|
-
* Apply key protection. Apply
|
|
100
|
+
* Apply key protection. Apply protection to a given key specified by the
|
|
98
101
|
* `key_id` parameter. Applying key protection means that your key can be used
|
|
99
102
|
* and modified, but it cannot be deleted.
|
|
100
103
|
*
|
|
@@ -145,9 +148,9 @@ class API extends api.API {
|
|
|
145
148
|
marshalling_gen.unmarshalKey
|
|
146
149
|
);
|
|
147
150
|
/**
|
|
148
|
-
* Disable key. Disable a given key to be used for
|
|
149
|
-
* Disabling a key renders it unusable. You must
|
|
150
|
-
* `key_id` parameters.
|
|
151
|
+
* Disable key. Disable a given key, preventing it to be used for
|
|
152
|
+
* cryptographic operations. Disabling a key renders it unusable. You must
|
|
153
|
+
* specify the `region` and `key_id` parameters.
|
|
151
154
|
*
|
|
152
155
|
* @param request - The request {@link DisableKeyRequest}
|
|
153
156
|
* @returns A Promise of Key
|
|
@@ -181,25 +184,24 @@ class API extends api.API {
|
|
|
181
184
|
marshalling_gen.unmarshalListKeysResponse
|
|
182
185
|
);
|
|
183
186
|
/**
|
|
184
|
-
* List keys. Retrieve
|
|
185
|
-
*
|
|
186
|
-
*
|
|
187
|
+
* List keys. Retrieve a list of keys across all Projects in an Organization
|
|
188
|
+
* or within a specific Project. You must specify the `region`, and either the
|
|
189
|
+
* `organization_id` or the `project_id`.
|
|
187
190
|
*
|
|
188
191
|
* @param request - The request {@link ListKeysRequest}
|
|
189
192
|
* @returns A Promise of ListKeysResponse
|
|
190
193
|
*/
|
|
191
194
|
listKeys = (request = {}) => resourcePaginator.enrichForPagination("keys", this.pageOfListKeys, request);
|
|
192
195
|
/**
|
|
193
|
-
*
|
|
194
|
-
*
|
|
195
|
-
* does not store your data encryption key. The data encryption key is
|
|
196
|
+
* Create a data encryption key. Create a new data encryption key for
|
|
197
|
+
* cryptographic operations outside of Key Manager. The data encryption key is
|
|
196
198
|
* encrypted and must be decrypted using the key you have created in Key
|
|
197
|
-
* Manager.
|
|
198
|
-
* object, for immediate usage.
|
|
199
|
+
* Manager.
|
|
199
200
|
*
|
|
200
|
-
*
|
|
201
|
-
*
|
|
202
|
-
*
|
|
201
|
+
* The data encryption key is returned in plaintext and ciphertext but it
|
|
202
|
+
* should only be stored in its encrypted form (ciphertext). Key Manager does
|
|
203
|
+
* not store your data encryption key. To retrieve your key's plaintext, use
|
|
204
|
+
* the `Decrypt` method with your key's ID and ciphertext.
|
|
203
205
|
*
|
|
204
206
|
* @param request - The request {@link GenerateDataKeyRequest}
|
|
205
207
|
* @returns A Promise of DataKey
|
|
@@ -216,10 +218,10 @@ class API extends api.API {
|
|
|
216
218
|
marshalling_gen.unmarshalDataKey
|
|
217
219
|
);
|
|
218
220
|
/**
|
|
219
|
-
* Encrypt
|
|
220
|
-
* parameter. Only keys with a usage set to
|
|
221
|
-
* supported by this method. The maximum payload
|
|
222
|
-
*
|
|
221
|
+
* Encrypt a payload. Encrypt a payload using an existing key, specified by
|
|
222
|
+
* the `key_id` parameter. Only keys with a usage set to
|
|
223
|
+
* `symmetric_encryption` are supported by this method. The maximum payload
|
|
224
|
+
* size that can be encrypted is 64 KB of plaintext.
|
|
223
225
|
*
|
|
224
226
|
* @param request - The request {@link EncryptRequest}
|
|
225
227
|
* @returns A Promise of EncryptResponse
|
|
@@ -236,9 +238,10 @@ class API extends api.API {
|
|
|
236
238
|
marshalling_gen.unmarshalEncryptResponse
|
|
237
239
|
);
|
|
238
240
|
/**
|
|
239
|
-
* Decrypt
|
|
240
|
-
* parameter. The maximum payload size
|
|
241
|
-
* the
|
|
241
|
+
* Decrypt an encrypted payload. Decrypt an encrypted payload using an
|
|
242
|
+
* existing key, specified by the `key_id` parameter. The maximum payload size
|
|
243
|
+
* that can be decrypted is equivalent to the encrypted output of 64 KB of
|
|
244
|
+
* data (around 131 KB).
|
|
242
245
|
*
|
|
243
246
|
* @param request - The request {@link DecryptRequest}
|
|
244
247
|
* @returns A Promise of DecryptResponse
|
|
@@ -255,8 +258,9 @@ class API extends api.API {
|
|
|
255
258
|
marshalling_gen.unmarshalDecryptResponse
|
|
256
259
|
);
|
|
257
260
|
/**
|
|
258
|
-
* Import key material. Import key material
|
|
259
|
-
* cryptographic key. The key's origin must be
|
|
261
|
+
* Import key material. Import externally generated key material into Key
|
|
262
|
+
* Manager to derive a new cryptographic key. The key's origin must be
|
|
263
|
+
* `external`.
|
|
260
264
|
*
|
|
261
265
|
* @param request - The request {@link ImportKeyMaterialRequest}
|
|
262
266
|
* @returns A Promise of Key
|