@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
@@ -14,6 +14,10 @@ const CreateLinkRequest = {
14
14
  name: {
15
15
  maxLength: 255,
16
16
  minLength: 1
17
+ },
18
+ peerAsn: {
19
+ greaterThanOrEqual: 1,
20
+ lessThanOrEqual: 65534
17
21
  }
18
22
  };
19
23
  const CreateRoutingPolicyRequest = {
@@ -100,6 +104,10 @@ const UpdateLinkRequest = {
100
104
  name: {
101
105
  maxLength: 255,
102
106
  minLength: 1
107
+ },
108
+ peerAsn: {
109
+ greaterThanOrEqual: 1,
110
+ lessThanOrEqual: 65534
103
111
  }
104
112
  };
105
113
  const UpdateRoutingPolicyRequest = {
@@ -13,6 +13,10 @@ export declare const CreateLinkRequest: {
13
13
  maxLength: number;
14
14
  minLength: number;
15
15
  };
16
+ peerAsn: {
17
+ greaterThanOrEqual: number;
18
+ lessThanOrEqual: number;
19
+ };
16
20
  };
17
21
  export declare const CreateRoutingPolicyRequest: {
18
22
  name: {
@@ -99,6 +103,10 @@ export declare const UpdateLinkRequest: {
99
103
  maxLength: number;
100
104
  minLength: number;
101
105
  };
106
+ peerAsn: {
107
+ greaterThanOrEqual: number;
108
+ lessThanOrEqual: number;
109
+ };
102
110
  };
103
111
  export declare const UpdateRoutingPolicyRequest: {
104
112
  name: {
@@ -12,6 +12,10 @@ const CreateLinkRequest = {
12
12
  name: {
13
13
  maxLength: 255,
14
14
  minLength: 1
15
+ },
16
+ peerAsn: {
17
+ greaterThanOrEqual: 1,
18
+ lessThanOrEqual: 65534
15
19
  }
16
20
  };
17
21
  const CreateRoutingPolicyRequest = {
@@ -98,6 +102,10 @@ const UpdateLinkRequest = {
98
102
  name: {
99
103
  maxLength: 255,
100
104
  minLength: 1
105
+ },
106
+ peerAsn: {
107
+ greaterThanOrEqual: 1,
108
+ lessThanOrEqual: 65534
101
109
  }
102
110
  };
103
111
  const UpdateRoutingPolicyRequest = {
@@ -33,17 +33,14 @@ class API extends api.API {
33
33
  marshalling_gen.unmarshalListHubsResponse
34
34
  );
35
35
  /**
36
- * List hubs. List all Hubs in the specified zone. By default, returned Hubs
37
- * are ordered by creation date in ascending order, though this can be
38
- * modified via the `order_by` field.
36
+ * List hubs. List all Hubs in the specified zone. By default, returned Hubs are ordered by creation date in ascending order, though this can be modified via the `order_by` field.
39
37
  *
40
38
  * @param request - The request {@link ListHubsRequest}
41
39
  * @returns A Promise of ListHubsResponse
42
40
  */
43
41
  listHubs = (request = {}) => resourcePaginator.enrichForPagination("hubs", this.pageOfListHubs, request);
44
42
  /**
45
- * Create a hub. Create a new Hub in the targeted region, specifying its
46
- * configuration including name and product plan.
43
+ * Create a hub. Create a new Hub in the targeted region, specifying its configuration including name and product plan.
47
44
  *
48
45
  * @param request - The request {@link CreateHubRequest}
49
46
  * @returns A Promise of Hub
@@ -60,9 +57,7 @@ class API extends api.API {
60
57
  marshalling_gen.unmarshalHub
61
58
  );
62
59
  /**
63
- * Get a hub. Retrieve information about an existing IoT Hub, specified by its
64
- * Hub ID. Its full details, including name, status and endpoint, are returned
65
- * in the response object.
60
+ * Get a hub. Retrieve information about an existing IoT Hub, specified by its Hub ID. Its full details, including name, status and endpoint, are returned in the response object.
66
61
  *
67
62
  * @param request - The request {@link GetHubRequest}
68
63
  * @returns A Promise of Hub
@@ -88,8 +83,7 @@ class API extends api.API {
88
83
  options
89
84
  );
90
85
  /**
91
- * Update a hub. Update the parameters of an existing IoT Hub, specified by
92
- * its Hub ID.
86
+ * Update a hub. Update the parameters of an existing IoT Hub, specified by its Hub ID.
93
87
  *
94
88
  * @param request - The request {@link UpdateHubRequest}
95
89
  * @returns A Promise of Hub
@@ -136,8 +130,7 @@ class API extends api.API {
136
130
  marshalling_gen.unmarshalHub
137
131
  );
138
132
  /**
139
- * Delete a hub. Delete an existing IoT Hub, specified by its Hub ID. Deleting
140
- * a Hub is permanent, and cannot be undone.
133
+ * Delete a hub. Delete an existing IoT Hub, specified by its Hub ID. Deleting a Hub is permanent, and cannot be undone.
141
134
  *
142
135
  * @param request - The request {@link DeleteHubRequest}
143
136
  */
@@ -147,8 +140,7 @@ class API extends api.API {
147
140
  urlParams: marshalling.urlParams(["delete_devices", request.deleteDevices])
148
141
  });
149
142
  /**
150
- * Get a hub's metrics. Get the metrics of an existing IoT Hub, specified by
151
- * its Hub ID.
143
+ * Get a hub's metrics. Get the metrics of an existing IoT Hub, specified by its Hub ID.
152
144
  *
153
145
  * @deprecated
154
146
  * @param request - The request {@link GetHubMetricsRequest}
@@ -163,8 +155,7 @@ class API extends api.API {
163
155
  marshalling_gen.unmarshalGetHubMetricsResponse
164
156
  );
165
157
  /**
166
- * Set the certificate authority of a hub. Set a particular PEM-encoded
167
- * certificate, specified by the Hub ID.
158
+ * Set the certificate authority of a hub. Set a particular PEM-encoded certificate, specified by the Hub ID.
168
159
  *
169
160
  * @param request - The request {@link SetHubCARequest}
170
161
  * @returns A Promise of Hub
@@ -181,8 +172,7 @@ class API extends api.API {
181
172
  marshalling_gen.unmarshalHub
182
173
  );
183
174
  /**
184
- * Get the certificate authority of a hub. Get information for a particular
185
- * PEM-encoded certificate, specified by the Hub ID.
175
+ * Get the certificate authority of a hub. Get information for a particular PEM-encoded certificate, specified by the Hub ID.
186
176
  *
187
177
  * @param request - The request {@link GetHubCARequest}
188
178
  * @returns A Promise of GetHubCAResponse
@@ -214,9 +204,7 @@ class API extends api.API {
214
204
  marshalling_gen.unmarshalListDevicesResponse
215
205
  );
216
206
  /**
217
- * List devices. List all devices in the specified region. By default,
218
- * returned devices are ordered by creation date in ascending order, though
219
- * this can be modified via the `order_by` field.
207
+ * List devices. List all devices in the specified region. By default, returned devices are ordered by creation date in ascending order, though this can be modified via the `order_by` field.
220
208
  *
221
209
  * @param request - The request {@link ListDevicesRequest}
222
210
  * @returns A Promise of ListDevicesResponse
@@ -240,9 +228,7 @@ class API extends api.API {
240
228
  marshalling_gen.unmarshalCreateDeviceResponse
241
229
  );
242
230
  /**
243
- * Get a device. Retrieve information about an existing device, specified by
244
- * its device ID. Its full details, including name, status and ID, are
245
- * returned in the response object.
231
+ * Get a device. Retrieve information about an existing device, specified by its device ID. Its full details, including name, status and ID, are returned in the response object.
246
232
  *
247
233
  * @param request - The request {@link GetDeviceRequest}
248
234
  * @returns A Promise of Device
@@ -255,8 +241,7 @@ class API extends api.API {
255
241
  marshalling_gen.unmarshalDevice
256
242
  );
257
243
  /**
258
- * Update a device. Update the parameters of an existing device, specified by
259
- * its device ID.
244
+ * Update a device. Update the parameters of an existing device, specified by its device ID.
260
245
  *
261
246
  * @param request - The request {@link UpdateDeviceRequest}
262
247
  * @returns A Promise of Device
@@ -303,8 +288,7 @@ class API extends api.API {
303
288
  marshalling_gen.unmarshalDevice
304
289
  );
305
290
  /**
306
- * Renew a device certificate. Renew the certificate of an existing device,
307
- * specified by its device ID.
291
+ * Renew a device certificate. Renew the certificate of an existing device, specified by its device ID.
308
292
  *
309
293
  * @param request - The request {@link RenewDeviceCertificateRequest}
310
294
  * @returns A Promise of RenewDeviceCertificateResponse
@@ -319,8 +303,7 @@ class API extends api.API {
319
303
  marshalling_gen.unmarshalRenewDeviceCertificateResponse
320
304
  );
321
305
  /**
322
- * Set a custom certificate on a device. Switch the existing certificate of a
323
- * given device with an EM-encoded custom certificate.
306
+ * Set a custom certificate on a device. Switch the existing certificate of a given device with an EM-encoded custom certificate.
324
307
  *
325
308
  * @param request - The request {@link SetDeviceCertificateRequest}
326
309
  * @returns A Promise of SetDeviceCertificateResponse
@@ -337,9 +320,7 @@ class API extends api.API {
337
320
  marshalling_gen.unmarshalSetDeviceCertificateResponse
338
321
  );
339
322
  /**
340
- * Get a device's certificate. Get information for a particular PEM-encoded
341
- * certificate, specified by the device ID. The response returns full details
342
- * of the device, including its type of certificate.
323
+ * Get a device's certificate. Get information for a particular PEM-encoded certificate, specified by the device ID. The response returns full details of the device, including its type of certificate.
343
324
  *
344
325
  * @param request - The request {@link GetDeviceCertificateRequest}
345
326
  * @returns A Promise of GetDeviceCertificateResponse
@@ -352,8 +333,7 @@ class API extends api.API {
352
333
  marshalling_gen.unmarshalGetDeviceCertificateResponse
353
334
  );
354
335
  /**
355
- * Remove a device. Remove a specific device from the specific Hub it is
356
- * attached to.
336
+ * Remove a device. Remove a specific device from the specific Hub it is attached to.
357
337
  *
358
338
  * @param request - The request {@link DeleteDeviceRequest}
359
339
  */
@@ -362,8 +342,7 @@ class API extends api.API {
362
342
  path: `/iot/v1/regions/${marshalling.validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/devices/${marshalling.validatePathParam("deviceId", request.deviceId)}`
363
343
  });
364
344
  /**
365
- * Get a device's metrics. Get the metrics of an existing device, specified by
366
- * its device ID.
345
+ * Get a device's metrics. Get the metrics of an existing device, specified by its device ID.
367
346
  *
368
347
  * @deprecated
369
348
  * @param request - The request {@link GetDeviceMetricsRequest}
@@ -395,30 +374,27 @@ class API extends api.API {
395
374
  marshalling_gen.unmarshalListRoutesResponse
396
375
  );
397
376
  /**
398
- * List routes. List all routes in the specified region. By default, returned
399
- * routes are ordered by creation date in ascending order, though this can be
400
- * modified via the `order_by` field.
377
+ * List routes. List all routes in the specified region. By default, returned routes are ordered by creation date in ascending order, though this can be modified via the `order_by` field.
401
378
  *
402
379
  * @param request - The request {@link ListRoutesRequest}
403
380
  * @returns A Promise of ListRoutesResponse
404
381
  */
405
382
  listRoutes = (request = {}) => resourcePaginator.enrichForPagination("routes", this.pageOfListRoutes, request);
406
383
  /**
407
- * Create a route. Multiple kinds of routes can be created, such as:
408
- *
409
- * - Database Route Create a route that will record subscribed MQTT messages
410
- * into your database. <b>You need to manage the database by yourself</b>.
411
- * - REST Route. Create a route that will call a REST API on received subscribed
412
- * MQTT messages.
413
- * - Amazon S3 Routes. Create a route that will put subscribed MQTT messages
414
- * into an Object Storage bucket. You need to create the bucket yourself and
415
- * grant write access. Granting can be done with s3cmd (`s3cmd setacl
416
- * s3://<my-bucket>
417
- * --acl-grant=write:555c69c3-87d0-4bf8-80f1-99a2f757d031:555c69c3-87d0-4bf8-80f1-99a2f757d031`).
418
- *
419
- * @param request - The request {@link CreateRouteRequest}
420
- * @returns A Promise of Route
421
- */
384
+ * Create a route. Multiple kinds of routes can be created, such as:
385
+ - Database Route
386
+ Create a route that will record subscribed MQTT messages into your database.
387
+ <b>You need to manage the database by yourself</b>.
388
+ - REST Route.
389
+ Create a route that will call a REST API on received subscribed MQTT messages.
390
+ - Amazon S3 Routes.
391
+ Create a route that will put subscribed MQTT messages into an Object Storage bucket.
392
+ You need to create the bucket yourself and grant write access.
393
+ Granting can be done with s3cmd (`s3cmd setacl s3://<my-bucket> --acl-grant=write:555c69c3-87d0-4bf8-80f1-99a2f757d031:555c69c3-87d0-4bf8-80f1-99a2f757d031`).
394
+ *
395
+ * @param request - The request {@link CreateRouteRequest}
396
+ * @returns A Promise of Route
397
+ */
422
398
  createRoute = (request) => this.client.fetch(
423
399
  {
424
400
  body: JSON.stringify(
@@ -431,8 +407,7 @@ class API extends api.API {
431
407
  marshalling_gen.unmarshalRoute
432
408
  );
433
409
  /**
434
- * Update a route. Update the parameters of an existing route, specified by
435
- * its route ID.
410
+ * Update a route. Update the parameters of an existing route, specified by its route ID.
436
411
  *
437
412
  * @param request - The request {@link UpdateRouteRequest}
438
413
  * @returns A Promise of Route
@@ -449,9 +424,7 @@ class API extends api.API {
449
424
  marshalling_gen.unmarshalRoute
450
425
  );
451
426
  /**
452
- * Get a route. Get information for a particular route, specified by the route
453
- * ID. The response returns full details of the route, including its type, the
454
- * topic it subscribes to and its configuration.
427
+ * Get a route. Get information for a particular route, specified by the route ID. The response returns full details of the route, including its type, the topic it subscribes to and its configuration.
455
428
  *
456
429
  * @param request - The request {@link GetRouteRequest}
457
430
  * @returns A Promise of Route
@@ -464,8 +437,7 @@ class API extends api.API {
464
437
  marshalling_gen.unmarshalRoute
465
438
  );
466
439
  /**
467
- * Delete a route. Delete an existing route, specified by its route ID.
468
- * Deleting a route is permanent, and cannot be undone.
440
+ * Delete a route. Delete an existing route, specified by its route ID. Deleting a route is permanent, and cannot be undone.
469
441
  *
470
442
  * @param request - The request {@link DeleteRouteRequest}
471
443
  */
@@ -499,9 +471,7 @@ class API extends api.API {
499
471
  */
500
472
  listNetworks = (request = {}) => resourcePaginator.enrichForPagination("networks", this.pageOfListNetworks, request);
501
473
  /**
502
- * Create a new network. Create a new network for an existing hub. Beside the
503
- * default network, you can add networks for different data providers.
504
- * Possible network types are Sigfox and REST.
474
+ * Create a new network. Create a new network for an existing hub. Beside the default network, you can add networks for different data providers. Possible network types are Sigfox and REST.
505
475
  *
506
476
  * @param request - The request {@link CreateNetworkRequest}
507
477
  * @returns A Promise of CreateNetworkResponse
@@ -518,9 +488,7 @@ class API extends api.API {
518
488
  marshalling_gen.unmarshalCreateNetworkResponse
519
489
  );
520
490
  /**
521
- * Retrieve a specific network. Retrieve an existing network, specified by its
522
- * network ID. The response returns full details of the network, including its
523
- * type, the topic prefix and its endpoint.
491
+ * Retrieve a specific network. Retrieve an existing network, specified by its network ID. The response returns full details of the network, including its type, the topic prefix and its endpoint.
524
492
  *
525
493
  * @param request - The request {@link GetNetworkRequest}
526
494
  * @returns A Promise of Network
@@ -533,8 +501,7 @@ class API extends api.API {
533
501
  marshalling_gen.unmarshalNetwork
534
502
  );
535
503
  /**
536
- * Delete a Network. Delete an existing network, specified by its network ID.
537
- * Deleting a network is permanent, and cannot be undone.
504
+ * Delete a Network. Delete an existing network, specified by its network ID. Deleting a network is permanent, and cannot be undone.
538
505
  *
539
506
  * @param request - The request {@link DeleteNetworkRequest}
540
507
  */
@@ -3,17 +3,15 @@ import type { Region as ScwRegion, WaitForOptions } from '@scaleway/sdk-client';
3
3
  import type { CreateDeviceRequest, CreateDeviceResponse, CreateHubRequest, CreateNetworkRequest, CreateNetworkResponse, CreateRouteRequest, DeleteDeviceRequest, DeleteHubRequest, DeleteNetworkRequest, DeleteRouteRequest, DeleteTwinDocumentRequest, DeleteTwinDocumentsRequest, Device, DisableDeviceRequest, DisableHubRequest, EnableDeviceRequest, EnableHubRequest, GetDeviceCertificateRequest, GetDeviceCertificateResponse, GetDeviceMetricsRequest, GetDeviceMetricsResponse, GetDeviceRequest, GetHubCARequest, GetHubCAResponse, GetHubMetricsRequest, GetHubMetricsResponse, GetHubRequest, GetNetworkRequest, GetRouteRequest, GetTwinDocumentRequest, Hub, ListDevicesRequest, ListDevicesResponse, ListHubsRequest, ListHubsResponse, ListNetworksRequest, ListNetworksResponse, ListRoutesRequest, ListRoutesResponse, ListTwinDocumentsRequest, ListTwinDocumentsResponse, Network, PatchTwinDocumentRequest, PutTwinDocumentRequest, RenewDeviceCertificateRequest, RenewDeviceCertificateResponse, Route, SetDeviceCertificateRequest, SetDeviceCertificateResponse, SetHubCARequest, TwinDocument, UpdateDeviceRequest, UpdateHubRequest, UpdateRouteRequest } from './types.gen';
4
4
  /**
5
5
  * IoT Hub API.
6
- *
7
- * This API allows you to manage your IoT hubs and devices.
6
+
7
+ This API allows you to manage your IoT hubs and devices.
8
8
  */
9
9
  export declare class API extends ParentAPI {
10
10
  /** Lists the available regions of the API. */
11
11
  static readonly LOCALITIES: ScwRegion[];
12
12
  protected pageOfListHubs: (request?: Readonly<ListHubsRequest>) => Promise<ListHubsResponse>;
13
13
  /**
14
- * List hubs. List all Hubs in the specified zone. By default, returned Hubs
15
- * are ordered by creation date in ascending order, though this can be
16
- * modified via the `order_by` field.
14
+ * List hubs. List all Hubs in the specified zone. By default, returned Hubs are ordered by creation date in ascending order, though this can be modified via the `order_by` field.
17
15
  *
18
16
  * @param request - The request {@link ListHubsRequest}
19
17
  * @returns A Promise of ListHubsResponse
@@ -23,17 +21,14 @@ export declare class API extends ParentAPI {
23
21
  [Symbol.asyncIterator]: () => AsyncGenerator<Hub[], void, void>;
24
22
  };
25
23
  /**
26
- * Create a hub. Create a new Hub in the targeted region, specifying its
27
- * configuration including name and product plan.
24
+ * Create a hub. Create a new Hub in the targeted region, specifying its configuration including name and product plan.
28
25
  *
29
26
  * @param request - The request {@link CreateHubRequest}
30
27
  * @returns A Promise of Hub
31
28
  */
32
29
  createHub: (request: Readonly<CreateHubRequest>) => Promise<Hub>;
33
30
  /**
34
- * Get a hub. Retrieve information about an existing IoT Hub, specified by its
35
- * Hub ID. Its full details, including name, status and endpoint, are returned
36
- * in the response object.
31
+ * Get a hub. Retrieve information about an existing IoT Hub, specified by its Hub ID. Its full details, including name, status and endpoint, are returned in the response object.
37
32
  *
38
33
  * @param request - The request {@link GetHubRequest}
39
34
  * @returns A Promise of Hub
@@ -48,8 +43,7 @@ export declare class API extends ParentAPI {
48
43
  */
49
44
  waitForHub: (request: Readonly<GetHubRequest>, options?: Readonly<WaitForOptions<Hub>>) => Promise<Hub>;
50
45
  /**
51
- * Update a hub. Update the parameters of an existing IoT Hub, specified by
52
- * its Hub ID.
46
+ * Update a hub. Update the parameters of an existing IoT Hub, specified by its Hub ID.
53
47
  *
54
48
  * @param request - The request {@link UpdateHubRequest}
55
49
  * @returns A Promise of Hub
@@ -70,15 +64,13 @@ export declare class API extends ParentAPI {
70
64
  */
71
65
  disableHub: (request: Readonly<DisableHubRequest>) => Promise<Hub>;
72
66
  /**
73
- * Delete a hub. Delete an existing IoT Hub, specified by its Hub ID. Deleting
74
- * a Hub is permanent, and cannot be undone.
67
+ * Delete a hub. Delete an existing IoT Hub, specified by its Hub ID. Deleting a Hub is permanent, and cannot be undone.
75
68
  *
76
69
  * @param request - The request {@link DeleteHubRequest}
77
70
  */
78
71
  deleteHub: (request: Readonly<DeleteHubRequest>) => Promise<void>;
79
72
  /**
80
- * Get a hub's metrics. Get the metrics of an existing IoT Hub, specified by
81
- * its Hub ID.
73
+ * Get a hub's metrics. Get the metrics of an existing IoT Hub, specified by its Hub ID.
82
74
  *
83
75
  * @deprecated
84
76
  * @param request - The request {@link GetHubMetricsRequest}
@@ -86,16 +78,14 @@ export declare class API extends ParentAPI {
86
78
  */
87
79
  getHubMetrics: (request: Readonly<GetHubMetricsRequest>) => Promise<GetHubMetricsResponse>;
88
80
  /**
89
- * Set the certificate authority of a hub. Set a particular PEM-encoded
90
- * certificate, specified by the Hub ID.
81
+ * Set the certificate authority of a hub. Set a particular PEM-encoded certificate, specified by the Hub ID.
91
82
  *
92
83
  * @param request - The request {@link SetHubCARequest}
93
84
  * @returns A Promise of Hub
94
85
  */
95
86
  setHubCA: (request: Readonly<SetHubCARequest>) => Promise<Hub>;
96
87
  /**
97
- * Get the certificate authority of a hub. Get information for a particular
98
- * PEM-encoded certificate, specified by the Hub ID.
88
+ * Get the certificate authority of a hub. Get information for a particular PEM-encoded certificate, specified by the Hub ID.
99
89
  *
100
90
  * @param request - The request {@link GetHubCARequest}
101
91
  * @returns A Promise of GetHubCAResponse
@@ -103,9 +93,7 @@ export declare class API extends ParentAPI {
103
93
  getHubCA: (request: Readonly<GetHubCARequest>) => Promise<GetHubCAResponse>;
104
94
  protected pageOfListDevices: (request?: Readonly<ListDevicesRequest>) => Promise<ListDevicesResponse>;
105
95
  /**
106
- * List devices. List all devices in the specified region. By default,
107
- * returned devices are ordered by creation date in ascending order, though
108
- * this can be modified via the `order_by` field.
96
+ * List devices. List all devices in the specified region. By default, returned devices are ordered by creation date in ascending order, though this can be modified via the `order_by` field.
109
97
  *
110
98
  * @param request - The request {@link ListDevicesRequest}
111
99
  * @returns A Promise of ListDevicesResponse
@@ -122,17 +110,14 @@ export declare class API extends ParentAPI {
122
110
  */
123
111
  createDevice: (request: Readonly<CreateDeviceRequest>) => Promise<CreateDeviceResponse>;
124
112
  /**
125
- * Get a device. Retrieve information about an existing device, specified by
126
- * its device ID. Its full details, including name, status and ID, are
127
- * returned in the response object.
113
+ * Get a device. Retrieve information about an existing device, specified by its device ID. Its full details, including name, status and ID, are returned in the response object.
128
114
  *
129
115
  * @param request - The request {@link GetDeviceRequest}
130
116
  * @returns A Promise of Device
131
117
  */
132
118
  getDevice: (request: Readonly<GetDeviceRequest>) => Promise<Device>;
133
119
  /**
134
- * Update a device. Update the parameters of an existing device, specified by
135
- * its device ID.
120
+ * Update a device. Update the parameters of an existing device, specified by its device ID.
136
121
  *
137
122
  * @param request - The request {@link UpdateDeviceRequest}
138
123
  * @returns A Promise of Device
@@ -153,40 +138,34 @@ export declare class API extends ParentAPI {
153
138
  */
154
139
  disableDevice: (request: Readonly<DisableDeviceRequest>) => Promise<Device>;
155
140
  /**
156
- * Renew a device certificate. Renew the certificate of an existing device,
157
- * specified by its device ID.
141
+ * Renew a device certificate. Renew the certificate of an existing device, specified by its device ID.
158
142
  *
159
143
  * @param request - The request {@link RenewDeviceCertificateRequest}
160
144
  * @returns A Promise of RenewDeviceCertificateResponse
161
145
  */
162
146
  renewDeviceCertificate: (request: Readonly<RenewDeviceCertificateRequest>) => Promise<RenewDeviceCertificateResponse>;
163
147
  /**
164
- * Set a custom certificate on a device. Switch the existing certificate of a
165
- * given device with an EM-encoded custom certificate.
148
+ * Set a custom certificate on a device. Switch the existing certificate of a given device with an EM-encoded custom certificate.
166
149
  *
167
150
  * @param request - The request {@link SetDeviceCertificateRequest}
168
151
  * @returns A Promise of SetDeviceCertificateResponse
169
152
  */
170
153
  setDeviceCertificate: (request: Readonly<SetDeviceCertificateRequest>) => Promise<SetDeviceCertificateResponse>;
171
154
  /**
172
- * Get a device's certificate. Get information for a particular PEM-encoded
173
- * certificate, specified by the device ID. The response returns full details
174
- * of the device, including its type of certificate.
155
+ * Get a device's certificate. Get information for a particular PEM-encoded certificate, specified by the device ID. The response returns full details of the device, including its type of certificate.
175
156
  *
176
157
  * @param request - The request {@link GetDeviceCertificateRequest}
177
158
  * @returns A Promise of GetDeviceCertificateResponse
178
159
  */
179
160
  getDeviceCertificate: (request: Readonly<GetDeviceCertificateRequest>) => Promise<GetDeviceCertificateResponse>;
180
161
  /**
181
- * Remove a device. Remove a specific device from the specific Hub it is
182
- * attached to.
162
+ * Remove a device. Remove a specific device from the specific Hub it is attached to.
183
163
  *
184
164
  * @param request - The request {@link DeleteDeviceRequest}
185
165
  */
186
166
  deleteDevice: (request: Readonly<DeleteDeviceRequest>) => Promise<void>;
187
167
  /**
188
- * Get a device's metrics. Get the metrics of an existing device, specified by
189
- * its device ID.
168
+ * Get a device's metrics. Get the metrics of an existing device, specified by its device ID.
190
169
  *
191
170
  * @deprecated
192
171
  * @param request - The request {@link GetDeviceMetricsRequest}
@@ -195,9 +174,7 @@ export declare class API extends ParentAPI {
195
174
  getDeviceMetrics: (request: Readonly<GetDeviceMetricsRequest>) => Promise<GetDeviceMetricsResponse>;
196
175
  protected pageOfListRoutes: (request?: Readonly<ListRoutesRequest>) => Promise<ListRoutesResponse>;
197
176
  /**
198
- * List routes. List all routes in the specified region. By default, returned
199
- * routes are ordered by creation date in ascending order, though this can be
200
- * modified via the `order_by` field.
177
+ * List routes. List all routes in the specified region. By default, returned routes are ordered by creation date in ascending order, though this can be modified via the `order_by` field.
201
178
  *
202
179
  * @param request - The request {@link ListRoutesRequest}
203
180
  * @returns A Promise of ListRoutesResponse
@@ -208,41 +185,36 @@ export declare class API extends ParentAPI {
208
185
  };
209
186
  /**
210
187
  * Create a route. Multiple kinds of routes can be created, such as:
211
- *
212
- * - Database Route Create a route that will record subscribed MQTT messages
213
- * into your database. <b>You need to manage the database by yourself</b>.
214
- * - REST Route. Create a route that will call a REST API on received subscribed
215
- * MQTT messages.
216
- * - Amazon S3 Routes. Create a route that will put subscribed MQTT messages
217
- * into an Object Storage bucket. You need to create the bucket yourself and
218
- * grant write access. Granting can be done with s3cmd (`s3cmd setacl
219
- * s3://<my-bucket>
220
- * --acl-grant=write:555c69c3-87d0-4bf8-80f1-99a2f757d031:555c69c3-87d0-4bf8-80f1-99a2f757d031`).
188
+ - Database Route
189
+ Create a route that will record subscribed MQTT messages into your database.
190
+ <b>You need to manage the database by yourself</b>.
191
+ - REST Route.
192
+ Create a route that will call a REST API on received subscribed MQTT messages.
193
+ - Amazon S3 Routes.
194
+ Create a route that will put subscribed MQTT messages into an Object Storage bucket.
195
+ You need to create the bucket yourself and grant write access.
196
+ Granting can be done with s3cmd (`s3cmd setacl s3://<my-bucket> --acl-grant=write:555c69c3-87d0-4bf8-80f1-99a2f757d031:555c69c3-87d0-4bf8-80f1-99a2f757d031`).
221
197
  *
222
198
  * @param request - The request {@link CreateRouteRequest}
223
199
  * @returns A Promise of Route
224
200
  */
225
201
  createRoute: (request: Readonly<CreateRouteRequest>) => Promise<Route>;
226
202
  /**
227
- * Update a route. Update the parameters of an existing route, specified by
228
- * its route ID.
203
+ * Update a route. Update the parameters of an existing route, specified by its route ID.
229
204
  *
230
205
  * @param request - The request {@link UpdateRouteRequest}
231
206
  * @returns A Promise of Route
232
207
  */
233
208
  updateRoute: (request: Readonly<UpdateRouteRequest>) => Promise<Route>;
234
209
  /**
235
- * Get a route. Get information for a particular route, specified by the route
236
- * ID. The response returns full details of the route, including its type, the
237
- * topic it subscribes to and its configuration.
210
+ * Get a route. Get information for a particular route, specified by the route ID. The response returns full details of the route, including its type, the topic it subscribes to and its configuration.
238
211
  *
239
212
  * @param request - The request {@link GetRouteRequest}
240
213
  * @returns A Promise of Route
241
214
  */
242
215
  getRoute: (request: Readonly<GetRouteRequest>) => Promise<Route>;
243
216
  /**
244
- * Delete a route. Delete an existing route, specified by its route ID.
245
- * Deleting a route is permanent, and cannot be undone.
217
+ * Delete a route. Delete an existing route, specified by its route ID. Deleting a route is permanent, and cannot be undone.
246
218
  *
247
219
  * @param request - The request {@link DeleteRouteRequest}
248
220
  */
@@ -259,26 +231,21 @@ export declare class API extends ParentAPI {
259
231
  [Symbol.asyncIterator]: () => AsyncGenerator<Network[], void, void>;
260
232
  };
261
233
  /**
262
- * Create a new network. Create a new network for an existing hub. Beside the
263
- * default network, you can add networks for different data providers.
264
- * Possible network types are Sigfox and REST.
234
+ * Create a new network. Create a new network for an existing hub. Beside the default network, you can add networks for different data providers. Possible network types are Sigfox and REST.
265
235
  *
266
236
  * @param request - The request {@link CreateNetworkRequest}
267
237
  * @returns A Promise of CreateNetworkResponse
268
238
  */
269
239
  createNetwork: (request: Readonly<CreateNetworkRequest>) => Promise<CreateNetworkResponse>;
270
240
  /**
271
- * Retrieve a specific network. Retrieve an existing network, specified by its
272
- * network ID. The response returns full details of the network, including its
273
- * type, the topic prefix and its endpoint.
241
+ * Retrieve a specific network. Retrieve an existing network, specified by its network ID. The response returns full details of the network, including its type, the topic prefix and its endpoint.
274
242
  *
275
243
  * @param request - The request {@link GetNetworkRequest}
276
244
  * @returns A Promise of Network
277
245
  */
278
246
  getNetwork: (request: Readonly<GetNetworkRequest>) => Promise<Network>;
279
247
  /**
280
- * Delete a Network. Delete an existing network, specified by its network ID.
281
- * Deleting a network is permanent, and cannot be undone.
248
+ * Delete a Network. Delete an existing network, specified by its network ID. Deleting a network is permanent, and cannot be undone.
282
249
  *
283
250
  * @param request - The request {@link DeleteNetworkRequest}
284
251
  */