@scaleway/sdk 1.7.0 → 1.8.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.js +4 -3
- package/dist/api/baremetal/v1/api.gen.js +5 -5
- package/dist/api/cockpit/v1beta1/api.gen.js +2 -3
- package/dist/api/container/v1beta1/api.gen.js +1 -5
- package/dist/api/container/v1beta1/marshalling.gen.js +2 -0
- package/dist/api/domain/v2beta1/api.gen.js +61 -52
- package/dist/api/flexibleip/v1alpha1/api.gen.js +27 -14
- package/dist/api/instance/v1/api.gen.js +2 -2
- package/dist/api/iot/v1/api.gen.js +67 -35
- package/dist/api/k8s/v1/api.gen.js +1 -1
- package/dist/api/mnq/v1alpha1/api.gen.js +3 -3
- package/dist/api/mnq/v1alpha1/marshalling.gen.js +3 -9
- package/dist/api/registry/v1/api.gen.js +41 -19
- package/dist/api/secret/v1alpha1/api.gen.js +3 -3
- package/dist/api/tem/v1alpha1/api.gen.js +1 -5
- package/dist/index.cjs +223 -159
- package/dist/index.d.ts +603 -495
- package/dist/scw/constants.js +1 -1
- package/package.json +2 -2
|
@@ -11,9 +11,9 @@ const jsonContentHeaders = {
|
|
|
11
11
|
};
|
|
12
12
|
|
|
13
13
|
/**
|
|
14
|
-
* IoT API.
|
|
14
|
+
* IoT Hub API.
|
|
15
15
|
*
|
|
16
|
-
* This API allows you to manage IoT hubs and devices. IoT API.
|
|
16
|
+
* This API allows you to manage IoT hubs and devices. IoT Hub API.
|
|
17
17
|
*/
|
|
18
18
|
class API extends API$1 {
|
|
19
19
|
constructor() {
|
|
@@ -31,7 +31,9 @@ class API extends API$1 {
|
|
|
31
31
|
}, unmarshalListHubsResponse);
|
|
32
32
|
};
|
|
33
33
|
/**
|
|
34
|
-
* List hubs.
|
|
34
|
+
* List hubs. List all Hubs in the specified zone. By default, returned Hubs
|
|
35
|
+
* are ordered by creation date in ascending order, though this can be
|
|
36
|
+
* modified via the `order_by` field.
|
|
35
37
|
*
|
|
36
38
|
* @param request - The request {@link ListHubsRequest}
|
|
37
39
|
* @returns A Promise of ListHubsResponse
|
|
@@ -43,7 +45,8 @@ class API extends API$1 {
|
|
|
43
45
|
return enrichForPagination('hubs', _this.pageOfListHubs, request);
|
|
44
46
|
};
|
|
45
47
|
/**
|
|
46
|
-
* Create a hub.
|
|
48
|
+
* Create a hub. Create a new Hub in the targeted region, specifying its
|
|
49
|
+
* configuration including name and product plan.
|
|
47
50
|
*
|
|
48
51
|
* @param request - The request {@link CreateHubRequest}
|
|
49
52
|
* @returns A Promise of Hub
|
|
@@ -55,7 +58,9 @@ class API extends API$1 {
|
|
|
55
58
|
path: `/iot/v1/regions/${validatePathParam('region', request.region ?? this.client.settings.defaultRegion)}/hubs`
|
|
56
59
|
}, unmarshalHub);
|
|
57
60
|
/**
|
|
58
|
-
* Get a hub.
|
|
61
|
+
* Get a hub. Retrieve information about an existing IoT Hub, specified by its
|
|
62
|
+
* Hub ID. Its full details, including name, status and endpoint, are returned
|
|
63
|
+
* in the response object.
|
|
59
64
|
*
|
|
60
65
|
* @param request - The request {@link GetHubRequest}
|
|
61
66
|
* @returns A Promise of Hub
|
|
@@ -73,7 +78,8 @@ class API extends API$1 {
|
|
|
73
78
|
*/
|
|
74
79
|
this.waitForHub = (request, options) => waitForResource(options?.stop ?? (res => Promise.resolve(!HUB_TRANSIENT_STATUSES.includes(res.status))), this.getHub, request, options);
|
|
75
80
|
/**
|
|
76
|
-
* Update a hub.
|
|
81
|
+
* Update a hub. Update the parameters of an existing IoT Hub, specified by
|
|
82
|
+
* its Hub ID.
|
|
77
83
|
*
|
|
78
84
|
* @param request - The request {@link UpdateHubRequest}
|
|
79
85
|
* @returns A Promise of Hub
|
|
@@ -85,7 +91,7 @@ class API extends API$1 {
|
|
|
85
91
|
path: `/iot/v1/regions/${validatePathParam('region', request.region ?? this.client.settings.defaultRegion)}/hubs/${validatePathParam('hubId', request.hubId)}`
|
|
86
92
|
}, unmarshalHub);
|
|
87
93
|
/**
|
|
88
|
-
* Enable a hub.
|
|
94
|
+
* Enable a hub. Enable an existing IoT Hub, specified by its Hub ID.
|
|
89
95
|
*
|
|
90
96
|
* @param request - The request {@link EnableHubRequest}
|
|
91
97
|
* @returns A Promise of Hub
|
|
@@ -97,7 +103,7 @@ class API extends API$1 {
|
|
|
97
103
|
path: `/iot/v1/regions/${validatePathParam('region', request.region ?? this.client.settings.defaultRegion)}/hubs/${validatePathParam('hubId', request.hubId)}/enable`
|
|
98
104
|
}, unmarshalHub);
|
|
99
105
|
/**
|
|
100
|
-
* Disable a hub.
|
|
106
|
+
* Disable a hub. Disable an existing IoT Hub, specified by its Hub ID.
|
|
101
107
|
*
|
|
102
108
|
* @param request - The request {@link DisableHubRequest}
|
|
103
109
|
* @returns A Promise of Hub
|
|
@@ -109,7 +115,8 @@ class API extends API$1 {
|
|
|
109
115
|
path: `/iot/v1/regions/${validatePathParam('region', request.region ?? this.client.settings.defaultRegion)}/hubs/${validatePathParam('hubId', request.hubId)}/disable`
|
|
110
116
|
}, unmarshalHub);
|
|
111
117
|
/**
|
|
112
|
-
* Delete a hub.
|
|
118
|
+
* Delete a hub. Delete an existing IoT Hub, specified by its Hub ID. Deleting
|
|
119
|
+
* a Hub is permanent, and cannot be undone.
|
|
113
120
|
*
|
|
114
121
|
* @param request - The request {@link DeleteHubRequest}
|
|
115
122
|
*/
|
|
@@ -119,7 +126,8 @@ class API extends API$1 {
|
|
|
119
126
|
urlParams: urlParams(['delete_devices', request.deleteDevices])
|
|
120
127
|
});
|
|
121
128
|
/**
|
|
122
|
-
* Get a hub's metrics.
|
|
129
|
+
* Get a hub's metrics. Get the metrics of an existing IoT Hub, specified by
|
|
130
|
+
* its Hub ID.
|
|
123
131
|
*
|
|
124
132
|
* @deprecated
|
|
125
133
|
* @param request - The request {@link GetHubMetricsRequest}
|
|
@@ -131,7 +139,8 @@ class API extends API$1 {
|
|
|
131
139
|
urlParams: urlParams(['start_date', request.startDate])
|
|
132
140
|
}, unmarshalGetHubMetricsResponse);
|
|
133
141
|
/**
|
|
134
|
-
* Set the certificate authority of a hub.
|
|
142
|
+
* Set the certificate authority of a hub. Set a particular PEM-encoded
|
|
143
|
+
* certificate, specified by the Hub ID.
|
|
135
144
|
*
|
|
136
145
|
* @param request - The request {@link SetHubCARequest}
|
|
137
146
|
* @returns A Promise of Hub
|
|
@@ -143,7 +152,8 @@ class API extends API$1 {
|
|
|
143
152
|
path: `/iot/v1/regions/${validatePathParam('region', request.region ?? this.client.settings.defaultRegion)}/hubs/${validatePathParam('hubId', request.hubId)}/ca`
|
|
144
153
|
}, unmarshalHub);
|
|
145
154
|
/**
|
|
146
|
-
* Get the certificate authority of a hub.
|
|
155
|
+
* Get the certificate authority of a hub. Get information for a particular
|
|
156
|
+
* PEM-encoded certificate, specified by the Hub ID.
|
|
147
157
|
*
|
|
148
158
|
* @param request - The request {@link GetHubCARequest}
|
|
149
159
|
* @returns A Promise of GetHubCAResponse
|
|
@@ -163,7 +173,9 @@ class API extends API$1 {
|
|
|
163
173
|
}, unmarshalListDevicesResponse);
|
|
164
174
|
};
|
|
165
175
|
/**
|
|
166
|
-
* List devices.
|
|
176
|
+
* List devices. List all devices in the specified region. By default,
|
|
177
|
+
* returned devices are ordered by creation date in ascending order, though
|
|
178
|
+
* this can be modified via the `order_by` field.
|
|
167
179
|
*
|
|
168
180
|
* @param request - The request {@link ListDevicesRequest}
|
|
169
181
|
* @returns A Promise of ListDevicesResponse
|
|
@@ -175,7 +187,7 @@ class API extends API$1 {
|
|
|
175
187
|
return enrichForPagination('devices', _this.pageOfListDevices, request);
|
|
176
188
|
};
|
|
177
189
|
/**
|
|
178
|
-
* Add a device.
|
|
190
|
+
* Add a device. Attach a device to a given Hub.
|
|
179
191
|
*
|
|
180
192
|
* @param request - The request {@link CreateDeviceRequest}
|
|
181
193
|
* @returns A Promise of CreateDeviceResponse
|
|
@@ -187,7 +199,9 @@ class API extends API$1 {
|
|
|
187
199
|
path: `/iot/v1/regions/${validatePathParam('region', request.region ?? this.client.settings.defaultRegion)}/devices`
|
|
188
200
|
}, unmarshalCreateDeviceResponse);
|
|
189
201
|
/**
|
|
190
|
-
* Get a device.
|
|
202
|
+
* Get a device. Retrieve information about an existing device, specified by
|
|
203
|
+
* its device ID. Its full details, including name, status and ID, are
|
|
204
|
+
* returned in the response object.
|
|
191
205
|
*
|
|
192
206
|
* @param request - The request {@link GetDeviceRequest}
|
|
193
207
|
* @returns A Promise of Device
|
|
@@ -197,7 +211,8 @@ class API extends API$1 {
|
|
|
197
211
|
path: `/iot/v1/regions/${validatePathParam('region', request.region ?? this.client.settings.defaultRegion)}/devices/${validatePathParam('deviceId', request.deviceId)}`
|
|
198
212
|
}, unmarshalDevice);
|
|
199
213
|
/**
|
|
200
|
-
* Update a device.
|
|
214
|
+
* Update a device. Update the parameters of an existing device, specified by
|
|
215
|
+
* its device ID.
|
|
201
216
|
*
|
|
202
217
|
* @param request - The request {@link UpdateDeviceRequest}
|
|
203
218
|
* @returns A Promise of Device
|
|
@@ -209,7 +224,7 @@ class API extends API$1 {
|
|
|
209
224
|
path: `/iot/v1/regions/${validatePathParam('region', request.region ?? this.client.settings.defaultRegion)}/devices/${validatePathParam('deviceId', request.deviceId)}`
|
|
210
225
|
}, unmarshalDevice);
|
|
211
226
|
/**
|
|
212
|
-
* Enable a device.
|
|
227
|
+
* Enable a device. Enable a specific device, specified by its device ID.
|
|
213
228
|
*
|
|
214
229
|
* @param request - The request {@link EnableDeviceRequest}
|
|
215
230
|
* @returns A Promise of Device
|
|
@@ -221,7 +236,7 @@ class API extends API$1 {
|
|
|
221
236
|
path: `/iot/v1/regions/${validatePathParam('region', request.region ?? this.client.settings.defaultRegion)}/devices/${validatePathParam('deviceId', request.deviceId)}/enable`
|
|
222
237
|
}, unmarshalDevice);
|
|
223
238
|
/**
|
|
224
|
-
* Disable a device.
|
|
239
|
+
* Disable a device. Disable an existing device, specified by its device ID.
|
|
225
240
|
*
|
|
226
241
|
* @param request - The request {@link DisableDeviceRequest}
|
|
227
242
|
* @returns A Promise of Device
|
|
@@ -233,7 +248,8 @@ class API extends API$1 {
|
|
|
233
248
|
path: `/iot/v1/regions/${validatePathParam('region', request.region ?? this.client.settings.defaultRegion)}/devices/${validatePathParam('deviceId', request.deviceId)}/disable`
|
|
234
249
|
}, unmarshalDevice);
|
|
235
250
|
/**
|
|
236
|
-
* Renew a device certificate.
|
|
251
|
+
* Renew a device certificate. Renew the certificate of an existing device,
|
|
252
|
+
* specified by its device ID.
|
|
237
253
|
*
|
|
238
254
|
* @param request - The request {@link RenewDeviceCertificateRequest}
|
|
239
255
|
* @returns A Promise of RenewDeviceCertificateResponse
|
|
@@ -245,7 +261,8 @@ class API extends API$1 {
|
|
|
245
261
|
path: `/iot/v1/regions/${validatePathParam('region', request.region ?? this.client.settings.defaultRegion)}/devices/${validatePathParam('deviceId', request.deviceId)}/renew-certificate`
|
|
246
262
|
}, unmarshalRenewDeviceCertificateResponse);
|
|
247
263
|
/**
|
|
248
|
-
* Set a custom certificate on a device.
|
|
264
|
+
* Set a custom certificate on a device. Switch the existing certificate of a
|
|
265
|
+
* given device with an EM-encoded custom certificate.
|
|
249
266
|
*
|
|
250
267
|
* @param request - The request {@link SetDeviceCertificateRequest}
|
|
251
268
|
* @returns A Promise of SetDeviceCertificateResponse
|
|
@@ -257,7 +274,9 @@ class API extends API$1 {
|
|
|
257
274
|
path: `/iot/v1/regions/${validatePathParam('region', request.region ?? this.client.settings.defaultRegion)}/devices/${validatePathParam('deviceId', request.deviceId)}/certificate`
|
|
258
275
|
}, unmarshalSetDeviceCertificateResponse);
|
|
259
276
|
/**
|
|
260
|
-
* Get a device's certificate.
|
|
277
|
+
* Get a device's certificate. Get information for a particular PEM-encoded
|
|
278
|
+
* certificate, specified by the device ID. The response returns full details
|
|
279
|
+
* of the device, including its type of certificate.
|
|
261
280
|
*
|
|
262
281
|
* @param request - The request {@link GetDeviceCertificateRequest}
|
|
263
282
|
* @returns A Promise of GetDeviceCertificateResponse
|
|
@@ -267,7 +286,8 @@ class API extends API$1 {
|
|
|
267
286
|
path: `/iot/v1/regions/${validatePathParam('region', request.region ?? this.client.settings.defaultRegion)}/devices/${validatePathParam('deviceId', request.deviceId)}/certificate`
|
|
268
287
|
}, unmarshalGetDeviceCertificateResponse);
|
|
269
288
|
/**
|
|
270
|
-
* Remove a device.
|
|
289
|
+
* Remove a device. Remove a specific device from the specific Hub it is
|
|
290
|
+
* attached to.
|
|
271
291
|
*
|
|
272
292
|
* @param request - The request {@link DeleteDeviceRequest}
|
|
273
293
|
*/
|
|
@@ -276,7 +296,8 @@ class API extends API$1 {
|
|
|
276
296
|
path: `/iot/v1/regions/${validatePathParam('region', request.region ?? this.client.settings.defaultRegion)}/devices/${validatePathParam('deviceId', request.deviceId)}`
|
|
277
297
|
});
|
|
278
298
|
/**
|
|
279
|
-
* Get a device's metrics.
|
|
299
|
+
* Get a device's metrics. Get the metrics of an existing device, specified by
|
|
300
|
+
* its device ID.
|
|
280
301
|
*
|
|
281
302
|
* @deprecated
|
|
282
303
|
* @param request - The request {@link GetDeviceMetricsRequest}
|
|
@@ -298,7 +319,9 @@ class API extends API$1 {
|
|
|
298
319
|
}, unmarshalListRoutesResponse);
|
|
299
320
|
};
|
|
300
321
|
/**
|
|
301
|
-
* List routes.
|
|
322
|
+
* List routes. List all routes in the specified region. By default, returned
|
|
323
|
+
* routes are ordered by creation date in ascending order, though this can be
|
|
324
|
+
* modified via the `order_by` field.
|
|
302
325
|
*
|
|
303
326
|
* @param request - The request {@link ListRoutesRequest}
|
|
304
327
|
* @returns A Promise of ListRoutesResponse
|
|
@@ -310,15 +333,15 @@ class API extends API$1 {
|
|
|
310
333
|
return enrichForPagination('routes', _this.pageOfListRoutes, request);
|
|
311
334
|
};
|
|
312
335
|
/**
|
|
313
|
-
* Create a route. Multiple
|
|
336
|
+
* Create a route. Multiple kinds of routes can be created, such as:
|
|
314
337
|
*
|
|
315
|
-
* - Database Route
|
|
338
|
+
* - Database Route Create a route that will record subscribed MQTT messages
|
|
316
339
|
* into your database. <b>You need to manage the database by yourself</b>.
|
|
317
340
|
* - REST Route. Create a route that will call a REST API on received subscribed
|
|
318
341
|
* MQTT messages.
|
|
319
342
|
* - S3 Routes. Create a route that will put subscribed MQTT messages into an S3
|
|
320
|
-
* bucket. You need to create the bucket yourself and grant
|
|
321
|
-
*
|
|
343
|
+
* bucket. You need to create the bucket yourself and grant write access.
|
|
344
|
+
* Granting can be done with s3cmd (`s3cmd setacl s3://<my-bucket>
|
|
322
345
|
* --acl-grant=write:555c69c3-87d0-4bf8-80f1-99a2f757d031:555c69c3-87d0-4bf8-80f1-99a2f757d031`).
|
|
323
346
|
*
|
|
324
347
|
* @param request - The request {@link CreateRouteRequest}
|
|
@@ -331,7 +354,8 @@ class API extends API$1 {
|
|
|
331
354
|
path: `/iot/v1/regions/${validatePathParam('region', request.region ?? this.client.settings.defaultRegion)}/routes`
|
|
332
355
|
}, unmarshalRoute);
|
|
333
356
|
/**
|
|
334
|
-
* Update a route.
|
|
357
|
+
* Update a route. Update the parameters of an existing route, specified by
|
|
358
|
+
* its route ID.
|
|
335
359
|
*
|
|
336
360
|
* @param request - The request {@link UpdateRouteRequest}
|
|
337
361
|
* @returns A Promise of Route
|
|
@@ -343,7 +367,9 @@ class API extends API$1 {
|
|
|
343
367
|
path: `/iot/v1/regions/${validatePathParam('region', request.region ?? this.client.settings.defaultRegion)}/routes/${validatePathParam('routeId', request.routeId)}`
|
|
344
368
|
}, unmarshalRoute);
|
|
345
369
|
/**
|
|
346
|
-
* Get a route.
|
|
370
|
+
* Get a route. Get information for a particular route, specified by the route
|
|
371
|
+
* ID. The response returns full details of the route, including its type, the
|
|
372
|
+
* topic it subscribes to and its configuration.
|
|
347
373
|
*
|
|
348
374
|
* @param request - The request {@link GetRouteRequest}
|
|
349
375
|
* @returns A Promise of Route
|
|
@@ -353,7 +379,8 @@ class API extends API$1 {
|
|
|
353
379
|
path: `/iot/v1/regions/${validatePathParam('region', request.region ?? this.client.settings.defaultRegion)}/routes/${validatePathParam('routeId', request.routeId)}`
|
|
354
380
|
}, unmarshalRoute);
|
|
355
381
|
/**
|
|
356
|
-
* Delete a route.
|
|
382
|
+
* Delete a route. Delete an existing route, specified by its route ID.
|
|
383
|
+
* Deleting a route is permanent, and cannot be undone.
|
|
357
384
|
*
|
|
358
385
|
* @param request - The request {@link DeleteRouteRequest}
|
|
359
386
|
*/
|
|
@@ -372,7 +399,7 @@ class API extends API$1 {
|
|
|
372
399
|
}, unmarshalListNetworksResponse);
|
|
373
400
|
};
|
|
374
401
|
/**
|
|
375
|
-
* List the
|
|
402
|
+
* List the networks.
|
|
376
403
|
*
|
|
377
404
|
* @param request - The request {@link ListNetworksRequest}
|
|
378
405
|
* @returns A Promise of ListNetworksResponse
|
|
@@ -384,7 +411,9 @@ class API extends API$1 {
|
|
|
384
411
|
return enrichForPagination('networks', _this.pageOfListNetworks, request);
|
|
385
412
|
};
|
|
386
413
|
/**
|
|
387
|
-
* Create a new
|
|
414
|
+
* Create a new network. Create a new network for an existing hub. Beside the
|
|
415
|
+
* default network, you can add networks for different data providers.
|
|
416
|
+
* Possible network types are Sigfox and REST.
|
|
388
417
|
*
|
|
389
418
|
* @param request - The request {@link CreateNetworkRequest}
|
|
390
419
|
* @returns A Promise of CreateNetworkResponse
|
|
@@ -396,7 +425,9 @@ class API extends API$1 {
|
|
|
396
425
|
path: `/iot/v1/regions/${validatePathParam('region', request.region ?? this.client.settings.defaultRegion)}/networks`
|
|
397
426
|
}, unmarshalCreateNetworkResponse);
|
|
398
427
|
/**
|
|
399
|
-
* Retrieve a specific
|
|
428
|
+
* Retrieve a specific network. Retrieve an existing network, specified by its
|
|
429
|
+
* network ID. The response returns full details of the network, including its
|
|
430
|
+
* type, the topic prefix and its endpoint.
|
|
400
431
|
*
|
|
401
432
|
* @param request - The request {@link GetNetworkRequest}
|
|
402
433
|
* @returns A Promise of Network
|
|
@@ -406,7 +437,8 @@ class API extends API$1 {
|
|
|
406
437
|
path: `/iot/v1/regions/${validatePathParam('region', request.region ?? this.client.settings.defaultRegion)}/networks/${validatePathParam('networkId', request.networkId)}`
|
|
407
438
|
}, unmarshalNetwork);
|
|
408
439
|
/**
|
|
409
|
-
* Delete a Network.
|
|
440
|
+
* Delete a Network. Delete an existing network, specified by its network ID.
|
|
441
|
+
* Deleting a network is permanent, and cannot be undone.
|
|
410
442
|
*
|
|
411
443
|
* @param request - The request {@link DeleteNetworkRequest}
|
|
412
444
|
*/
|
|
@@ -9,10 +9,10 @@ const jsonContentHeaders = {
|
|
|
9
9
|
};
|
|
10
10
|
|
|
11
11
|
/**
|
|
12
|
-
*
|
|
12
|
+
* Messaging and Queuing API.
|
|
13
13
|
*
|
|
14
|
-
* This API allows you to manage Scaleway Messaging and Queueing brokers.
|
|
15
|
-
* API
|
|
14
|
+
* This API allows you to manage Scaleway Messaging and Queueing brokers.
|
|
15
|
+
* Messaging and Queuing API.
|
|
16
16
|
*/
|
|
17
17
|
class API extends API$1 {
|
|
18
18
|
constructor() {
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
import randomName from '../../../node_modules/.pnpm/@scaleway_random-name@4.0.1/node_modules/@scaleway/random-name/dist/index.js';
|
|
2
2
|
import { isJSONObject } from '../../../helpers/json.js';
|
|
3
|
-
import { unmarshalDate, unmarshalArrayOfObject
|
|
3
|
+
import { unmarshalDate, unmarshalArrayOfObject } from '../../../helpers/marshalling.js';
|
|
4
4
|
|
|
5
5
|
// This file was automatically generated. DO NOT EDIT.
|
|
6
6
|
const unmarshalPermissions = data => {
|
|
@@ -106,10 +106,7 @@ const marshalPermissions = (request, defaults) => ({
|
|
|
106
106
|
const marshalCreateCredentialRequest = (request, defaults) => ({
|
|
107
107
|
name: request.name || randomName('mnq'),
|
|
108
108
|
namespace_id: request.namespaceId,
|
|
109
|
-
|
|
110
|
-
param: 'permissions',
|
|
111
|
-
value: request.permissions ? marshalPermissions(request.permissions) : undefined
|
|
112
|
-
}])
|
|
109
|
+
permissions: request.permissions ? marshalPermissions(request.permissions) : undefined
|
|
113
110
|
});
|
|
114
111
|
const marshalCreateNamespaceRequest = (request, defaults) => ({
|
|
115
112
|
name: request.name || randomName('mnq'),
|
|
@@ -118,10 +115,7 @@ const marshalCreateNamespaceRequest = (request, defaults) => ({
|
|
|
118
115
|
});
|
|
119
116
|
const marshalUpdateCredentialRequest = (request, defaults) => ({
|
|
120
117
|
name: request.name,
|
|
121
|
-
|
|
122
|
-
param: 'permissions',
|
|
123
|
-
value: request.permissions ? marshalPermissions(request.permissions) : undefined
|
|
124
|
-
}])
|
|
118
|
+
permissions: request.permissions ? marshalPermissions(request.permissions) : undefined
|
|
125
119
|
});
|
|
126
120
|
const marshalUpdateNamespaceRequest = (request, defaults) => ({
|
|
127
121
|
name: request.name,
|
|
@@ -10,11 +10,7 @@ const jsonContentHeaders = {
|
|
|
10
10
|
'Content-Type': 'application/json; charset=utf-8'
|
|
11
11
|
};
|
|
12
12
|
|
|
13
|
-
/**
|
|
14
|
-
* Registry API.
|
|
15
|
-
*
|
|
16
|
-
* Container registry API. Registry API.
|
|
17
|
-
*/
|
|
13
|
+
/** Container Registry API. */
|
|
18
14
|
class API extends API$1 {
|
|
19
15
|
constructor() {
|
|
20
16
|
var _this;
|
|
@@ -31,7 +27,11 @@ class API extends API$1 {
|
|
|
31
27
|
}, unmarshalListNamespacesResponse);
|
|
32
28
|
};
|
|
33
29
|
/**
|
|
34
|
-
* List all
|
|
30
|
+
* List namespaces. List all namespaces in a specified region. By default, the
|
|
31
|
+
* namespaces listed are ordered by creation date in ascending order. This can
|
|
32
|
+
* be modified via the order_by field. You can also define additional
|
|
33
|
+
* parameters for your query, such as the `instance_id` and `project_id`
|
|
34
|
+
* parameters.
|
|
35
35
|
*
|
|
36
36
|
* @param request - The request {@link ListNamespacesRequest}
|
|
37
37
|
* @returns A Promise of ListNamespacesResponse
|
|
@@ -43,7 +43,10 @@ class API extends API$1 {
|
|
|
43
43
|
return enrichForPagination('namespaces', _this.pageOfListNamespaces, request);
|
|
44
44
|
};
|
|
45
45
|
/**
|
|
46
|
-
* Get a namespace.
|
|
46
|
+
* Get a namespace. Retrieve information about a given namespace, specified by
|
|
47
|
+
* its `namespace_id` and region. Full details about the namespace, such as
|
|
48
|
+
* `description`, `project_id`, `status`, `endpoint`, `is_public`, `size`, and
|
|
49
|
+
* `image_count` are returned in the response.
|
|
47
50
|
*
|
|
48
51
|
* @param request - The request {@link GetNamespaceRequest}
|
|
49
52
|
* @returns A Promise of Namespace
|
|
@@ -61,7 +64,10 @@ class API extends API$1 {
|
|
|
61
64
|
*/
|
|
62
65
|
this.waitForNamespace = (request, options) => waitForResource(options?.stop ?? (res => Promise.resolve(!NAMESPACE_TRANSIENT_STATUSES.includes(res.status))), this.getNamespace, request, options);
|
|
63
66
|
/**
|
|
64
|
-
* Create a new namespace.
|
|
67
|
+
* Create a namespace. Create a new Container Registry namespace. You must
|
|
68
|
+
* specify the namespace name and region in which you want it to be created.
|
|
69
|
+
* Optionally, you can specify the `project_id` and `is_public` in the request
|
|
70
|
+
* payload.
|
|
65
71
|
*
|
|
66
72
|
* @param request - The request {@link CreateNamespaceRequest}
|
|
67
73
|
* @returns A Promise of Namespace
|
|
@@ -73,8 +79,9 @@ class API extends API$1 {
|
|
|
73
79
|
path: `/registry/v1/regions/${validatePathParam('region', request.region ?? this.client.settings.defaultRegion)}/namespaces`
|
|
74
80
|
}, unmarshalNamespace);
|
|
75
81
|
/**
|
|
76
|
-
* Update
|
|
77
|
-
*
|
|
82
|
+
* Update a namespace. Update the parameters of a given namespace, specified
|
|
83
|
+
* by its `namespace_id` and `region`. You can update the `description` and
|
|
84
|
+
* `is_public` parameters.
|
|
78
85
|
*
|
|
79
86
|
* @param request - The request {@link UpdateNamespaceRequest}
|
|
80
87
|
* @returns A Promise of Namespace
|
|
@@ -86,8 +93,9 @@ class API extends API$1 {
|
|
|
86
93
|
path: `/registry/v1/regions/${validatePathParam('region', request.region ?? this.client.settings.defaultRegion)}/namespaces/${validatePathParam('namespaceId', request.namespaceId)}`
|
|
87
94
|
}, unmarshalNamespace);
|
|
88
95
|
/**
|
|
89
|
-
* Delete
|
|
90
|
-
*
|
|
96
|
+
* Delete a namespace. Delete a given namespace. You must specify, in the
|
|
97
|
+
* endpoint, the `region` and `namespace_id` parameters of the namespace you
|
|
98
|
+
* want to delete.
|
|
91
99
|
*
|
|
92
100
|
* @param request - The request {@link DeleteNamespaceRequest}
|
|
93
101
|
* @returns A Promise of Namespace
|
|
@@ -107,7 +115,10 @@ class API extends API$1 {
|
|
|
107
115
|
}, unmarshalListImagesResponse);
|
|
108
116
|
};
|
|
109
117
|
/**
|
|
110
|
-
* List all
|
|
118
|
+
* List images. List all images in a specified region. By default, the images
|
|
119
|
+
* listed are ordered by creation date in ascending order. This can be
|
|
120
|
+
* modified via the order_by field. You can also define additional parameters
|
|
121
|
+
* for your query, such as the `namespace_id` and `project_id` parameters.
|
|
111
122
|
*
|
|
112
123
|
* @param request - The request {@link ListImagesRequest}
|
|
113
124
|
* @returns A Promise of ListImagesResponse
|
|
@@ -119,7 +130,10 @@ class API extends API$1 {
|
|
|
119
130
|
return enrichForPagination('images', _this.pageOfListImages, request);
|
|
120
131
|
};
|
|
121
132
|
/**
|
|
122
|
-
* Get
|
|
133
|
+
* Get an image. Retrieve information about a given container image, specified
|
|
134
|
+
* by its `image_id` and region. Full details about the image, such as `name`,
|
|
135
|
+
* `namespace_id`, `status`, `visibility`, and `size` are returned in the
|
|
136
|
+
* response.
|
|
123
137
|
*
|
|
124
138
|
* @param request - The request {@link GetImageRequest}
|
|
125
139
|
* @returns A Promise of Image
|
|
@@ -137,7 +151,8 @@ class API extends API$1 {
|
|
|
137
151
|
*/
|
|
138
152
|
this.waitForImage = (request, options) => waitForResource(options?.stop ?? (res => Promise.resolve(!IMAGE_TRANSIENT_STATUSES.includes(res.status))), this.getImage, request, options);
|
|
139
153
|
/**
|
|
140
|
-
* Update an
|
|
154
|
+
* Update an image. Update the parameters of a given image, specified by its
|
|
155
|
+
* `image_id` and `region`. You can update the `visibility` parameter.
|
|
141
156
|
*
|
|
142
157
|
* @param request - The request {@link UpdateImageRequest}
|
|
143
158
|
* @returns A Promise of Image
|
|
@@ -149,7 +164,8 @@ class API extends API$1 {
|
|
|
149
164
|
path: `/registry/v1/regions/${validatePathParam('region', request.region ?? this.client.settings.defaultRegion)}/images/${validatePathParam('imageId', request.imageId)}`
|
|
150
165
|
}, unmarshalImage);
|
|
151
166
|
/**
|
|
152
|
-
* Delete an image. Delete
|
|
167
|
+
* Delete an image. Delete a given image. You must specify, in the endpoint,
|
|
168
|
+
* the `region` and `image_id` parameters of the image you want to delete.
|
|
153
169
|
*
|
|
154
170
|
* @param request - The request {@link DeleteImageRequest}
|
|
155
171
|
* @returns A Promise of Image
|
|
@@ -164,14 +180,19 @@ class API extends API$1 {
|
|
|
164
180
|
urlParams: urlParams(['name', request.name], ['order_by', request.orderBy ?? 'created_at_asc'], ['page', request.page], ['page_size', request.pageSize ?? this.client.settings.defaultPageSize])
|
|
165
181
|
}, unmarshalListTagsResponse);
|
|
166
182
|
/**
|
|
167
|
-
* List all
|
|
183
|
+
* List tags. List all tags for a given image, specified by region. By
|
|
184
|
+
* default, the tags listed are ordered by creation date in ascending order.
|
|
185
|
+
* This can be modified via the order_by field. You can also define additional
|
|
186
|
+
* parameters for your query, such as the `name`.
|
|
168
187
|
*
|
|
169
188
|
* @param request - The request {@link ListTagsRequest}
|
|
170
189
|
* @returns A Promise of ListTagsResponse
|
|
171
190
|
*/
|
|
172
191
|
this.listTags = request => enrichForPagination('tags', this.pageOfListTags, request);
|
|
173
192
|
/**
|
|
174
|
-
* Get a tag.
|
|
193
|
+
* Get a tag. Retrieve information about a given image tag, specified by its
|
|
194
|
+
* `tag_id` and region. Full details about the tag, such as `name`,
|
|
195
|
+
* `image_id`, `status`, and `digest` are returned in the response.
|
|
175
196
|
*
|
|
176
197
|
* @param request - The request {@link GetTagRequest}
|
|
177
198
|
* @returns A Promise of Tag
|
|
@@ -189,7 +210,8 @@ class API extends API$1 {
|
|
|
189
210
|
*/
|
|
190
211
|
this.waitForTag = (request, options) => waitForResource(options?.stop ?? (res => Promise.resolve(!TAG_TRANSIENT_STATUSES.includes(res.status))), this.getTag, request, options);
|
|
191
212
|
/**
|
|
192
|
-
* Delete a tag. Delete
|
|
213
|
+
* Delete a tag. Delete a given image tag. You must specify, in the endpoint,
|
|
214
|
+
* the `region` and `tag_id` parameters of the tag you want to delete.
|
|
193
215
|
*
|
|
194
216
|
* @param request - The request {@link DeleteTagRequest}
|
|
195
217
|
* @returns A Promise of Tag
|
|
@@ -9,10 +9,10 @@ const jsonContentHeaders = {
|
|
|
9
9
|
};
|
|
10
10
|
|
|
11
11
|
/**
|
|
12
|
-
* Secret Manager API
|
|
12
|
+
* Secret Manager API.
|
|
13
13
|
*
|
|
14
|
-
* This API allows you to conveniently store, access and
|
|
15
|
-
*
|
|
14
|
+
* Secret Manager API. This API allows you to conveniently store, access and
|
|
15
|
+
* share sensitive data.
|
|
16
16
|
*/
|
|
17
17
|
class API extends API$1 {
|
|
18
18
|
constructor() {
|
|
@@ -10,11 +10,7 @@ const jsonContentHeaders = {
|
|
|
10
10
|
'Content-Type': 'application/json; charset=utf-8'
|
|
11
11
|
};
|
|
12
12
|
|
|
13
|
-
/**
|
|
14
|
-
* Transactional Email API documentation.
|
|
15
|
-
*
|
|
16
|
-
* Tem. Transactional Email API documentation.
|
|
17
|
-
*/
|
|
13
|
+
/** Transactional Email API. */
|
|
18
14
|
class API extends API$1 {
|
|
19
15
|
constructor() {
|
|
20
16
|
var _this;
|