@scaleway/sdk 2.73.0 → 2.74.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (89) hide show
  1. package/dist/api/account/v3/index.gen.d.ts +1 -1
  2. package/dist/api/account/v3/marshalling.gen.cjs +94 -65
  3. package/dist/api/account/v3/marshalling.gen.js +94 -65
  4. package/dist/api/account/v3/types.gen.d.ts +79 -61
  5. package/dist/api/baremetal/v1/types.gen.d.ts +1 -1
  6. package/dist/api/cockpit/v1/api.gen.cjs +35 -3
  7. package/dist/api/cockpit/v1/api.gen.d.ts +17 -5
  8. package/dist/api/cockpit/v1/api.gen.js +36 -4
  9. package/dist/api/cockpit/v1/index.gen.d.ts +1 -1
  10. package/dist/api/cockpit/v1/marshalling.gen.cjs +23 -0
  11. package/dist/api/cockpit/v1/marshalling.gen.d.ts +3 -1
  12. package/dist/api/cockpit/v1/marshalling.gen.js +23 -0
  13. package/dist/api/cockpit/v1/types.gen.d.ts +63 -2
  14. package/dist/api/dedibox/v1/types.gen.d.ts +3 -3
  15. package/dist/api/edge_services/v1beta1/api.gen.cjs +41 -22
  16. package/dist/api/edge_services/v1beta1/api.gen.d.ts +3 -2
  17. package/dist/api/edge_services/v1beta1/api.gen.js +41 -22
  18. package/dist/api/edge_services/v1beta1/index.gen.d.ts +1 -1
  19. package/dist/api/edge_services/v1beta1/types.gen.d.ts +7 -0
  20. package/dist/api/file/index.gen.cjs +4 -0
  21. package/dist/api/file/index.gen.d.ts +5 -0
  22. package/dist/api/file/index.gen.js +4 -0
  23. package/dist/api/file/v1alpha1/api.gen.cjs +142 -0
  24. package/dist/api/file/v1alpha1/api.gen.d.ts +73 -0
  25. package/dist/api/file/v1alpha1/api.gen.js +142 -0
  26. package/dist/api/file/v1alpha1/content.gen.cjs +7 -0
  27. package/dist/api/file/v1alpha1/content.gen.d.ts +3 -0
  28. package/dist/api/file/v1alpha1/content.gen.js +7 -0
  29. package/dist/api/file/v1alpha1/index.gen.cjs +8 -0
  30. package/dist/api/file/v1alpha1/index.gen.d.ts +4 -0
  31. package/dist/api/file/v1alpha1/index.gen.js +8 -0
  32. package/dist/api/file/v1alpha1/marshalling.gen.cjs +77 -0
  33. package/dist/api/file/v1alpha1/marshalling.gen.d.ts +7 -0
  34. package/dist/api/file/v1alpha1/marshalling.gen.js +77 -0
  35. package/dist/api/file/v1alpha1/types.gen.d.ts +239 -0
  36. package/dist/api/file/v1alpha1/validation-rules.gen.cjs +40 -0
  37. package/dist/api/file/v1alpha1/validation-rules.gen.d.ts +34 -0
  38. package/dist/api/file/v1alpha1/validation-rules.gen.js +40 -0
  39. package/dist/api/function/v1beta1/types.gen.d.ts +6 -6
  40. package/dist/api/iam/v1alpha1/api.gen.cjs +4 -4
  41. package/dist/api/iam/v1alpha1/api.gen.d.ts +4 -4
  42. package/dist/api/iam/v1alpha1/api.gen.js +4 -4
  43. package/dist/api/iam/v1alpha1/types.gen.d.ts +1 -1
  44. package/dist/api/index.gen.d.ts +3 -1
  45. package/dist/api/inference/v1beta1/api.gen.cjs +1 -1
  46. package/dist/api/inference/v1beta1/api.gen.d.ts +1 -1
  47. package/dist/api/inference/v1beta1/api.gen.js +1 -1
  48. package/dist/api/instance/v1/marshalling.gen.cjs +4 -1
  49. package/dist/api/instance/v1/marshalling.gen.js +4 -1
  50. package/dist/api/instance/v1/types.gen.d.ts +16 -1
  51. package/dist/api/interlink/v1beta1/api.gen.cjs +1 -1
  52. package/dist/api/interlink/v1beta1/api.gen.d.ts +1 -1
  53. package/dist/api/interlink/v1beta1/api.gen.js +1 -1
  54. package/dist/api/iot/v1/types.gen.d.ts +1 -1
  55. package/dist/api/lb/v1/marshalling.gen.cjs +4 -2
  56. package/dist/api/lb/v1/marshalling.gen.js +4 -2
  57. package/dist/api/lb/v1/types.gen.d.ts +4 -0
  58. package/dist/api/mongodb/v1alpha1/types.gen.d.ts +1 -1
  59. package/dist/api/product_catalog/index.gen.cjs +4 -0
  60. package/dist/api/product_catalog/index.gen.d.ts +5 -0
  61. package/dist/api/product_catalog/index.gen.js +4 -0
  62. package/dist/api/product_catalog/v2alpha1/api.gen.cjs +36 -0
  63. package/dist/api/product_catalog/v2alpha1/api.gen.d.ts +18 -0
  64. package/dist/api/product_catalog/v2alpha1/api.gen.js +36 -0
  65. package/dist/api/product_catalog/v2alpha1/index.gen.cjs +6 -0
  66. package/dist/api/product_catalog/v2alpha1/index.gen.d.ts +3 -0
  67. package/dist/api/product_catalog/v2alpha1/index.gen.js +6 -0
  68. package/dist/api/product_catalog/v2alpha1/marshalling.gen.cjs +230 -0
  69. package/dist/api/product_catalog/v2alpha1/marshalling.gen.d.ts +2 -0
  70. package/dist/api/product_catalog/v2alpha1/marshalling.gen.js +230 -0
  71. package/dist/api/product_catalog/v2alpha1/types.gen.d.ts +293 -0
  72. package/dist/api/product_catalog/v2alpha1/validation-rules.gen.cjs +11 -0
  73. package/dist/api/product_catalog/v2alpha1/validation-rules.gen.d.ts +8 -0
  74. package/dist/api/product_catalog/v2alpha1/validation-rules.gen.js +11 -0
  75. package/dist/api/qaas/v1alpha1/types.gen.d.ts +2 -2
  76. package/dist/api/rdb/v1/api.gen.cjs +1 -1
  77. package/dist/api/rdb/v1/api.gen.d.ts +1 -1
  78. package/dist/api/rdb/v1/api.gen.js +1 -1
  79. package/dist/api/rdb/v1/types.gen.d.ts +2 -2
  80. package/dist/api/redis/v1/api.gen.cjs +1 -1
  81. package/dist/api/redis/v1/api.gen.d.ts +1 -1
  82. package/dist/api/redis/v1/api.gen.js +1 -1
  83. package/dist/api/registry/v1/types.gen.d.ts +1 -1
  84. package/dist/api/vpcgw/v1/api.gen.cjs +37 -0
  85. package/dist/api/vpcgw/v1/api.gen.d.ts +37 -0
  86. package/dist/api/vpcgw/v1/api.gen.js +37 -0
  87. package/dist/index.cjs +36 -32
  88. package/dist/index.js +36 -32
  89. package/package.json +2 -2
@@ -48,6 +48,7 @@ class API extends api.API {
48
48
  /**
49
49
  * List Public Gateways. List Public Gateways in a given Scaleway Organization or Project. By default, results are displayed in ascending order of creation date.
50
50
  *
51
+ * @deprecated
51
52
  * @param request - The request {@link ListGatewaysRequest}
52
53
  * @returns A Promise of ListGatewaysResponse
53
54
  */
@@ -55,6 +56,7 @@ class API extends api.API {
55
56
  /**
56
57
  * Get a Public Gateway. Get details of a Public Gateway, specified by its gateway ID. The response object contains full details of the gateway, including its **name**, **type**, **status** and more.
57
58
  *
59
+ * @deprecated
58
60
  * @param request - The request {@link GetGatewayRequest}
59
61
  * @returns A Promise of Gateway
60
62
  */
@@ -83,6 +85,7 @@ class API extends api.API {
83
85
  /**
84
86
  * Create a Public Gateway. Create a new Public Gateway in the specified Scaleway Project, defining its **name**, **type** and other configuration details such as whether to enable SSH bastion.
85
87
  *
88
+ * @deprecated
86
89
  * @param request - The request {@link CreateGatewayRequest}
87
90
  * @returns A Promise of Gateway
88
91
  */
@@ -100,6 +103,7 @@ class API extends api.API {
100
103
  /**
101
104
  * Update a Public Gateway. Update the parameters of an existing Public Gateway, for example, its **name**, **tags**, **SSH bastion configuration**, and **DNS servers**.
102
105
  *
106
+ * @deprecated
103
107
  * @param request - The request {@link UpdateGatewayRequest}
104
108
  * @returns A Promise of Gateway
105
109
  */
@@ -117,6 +121,7 @@ class API extends api.API {
117
121
  /**
118
122
  * Delete a Public Gateway. Delete an existing Public Gateway, specified by its gateway ID. This action is irreversible.
119
123
  *
124
+ * @deprecated
120
125
  * @param request - The request {@link DeleteGatewayRequest}
121
126
  */
122
127
  deleteGateway = (request) => this.client.fetch({
@@ -127,6 +132,7 @@ class API extends api.API {
127
132
  /**
128
133
  * Upgrade a Public Gateway to the latest version and/or to a different commercial offer type. Upgrade a given Public Gateway to the newest software version or to a different commercial offer type. This applies the latest bugfixes and features to your Public Gateway. Note that gateway service will be interrupted during the update.
129
134
  *
135
+ * @deprecated
130
136
  * @param request - The request {@link UpgradeGatewayRequest}
131
137
  * @returns A Promise of Gateway
132
138
  */
@@ -144,6 +150,7 @@ class API extends api.API {
144
150
  /**
145
151
  * Upgrade a Public Gateway to IP mobility. Upgrade a Public Gateway to IP mobility (move from NAT IP to routed IP). This is idempotent: repeated calls after the first will return no error but have no effect.
146
152
  *
153
+ * @deprecated
147
154
  * @param request - The request {@link EnableIPMobilityRequest}
148
155
  */
149
156
  enableIPMobility = (request) => this.client.fetch({
@@ -175,6 +182,7 @@ class API extends api.API {
175
182
  /**
176
183
  * List Public Gateway connections to Private Networks. List the connections between Public Gateways and Private Networks (a connection = a GatewayNetwork). You can choose to filter by `gateway-id` to list all Private Networks attached to the specified Public Gateway, or by `private_network_id` to list all Public Gateways attached to the specified Private Network. Other query parameters are also available. The result is an array of GatewayNetwork objects, each giving details of the connection between a given Public Gateway and a given Private Network.
177
184
  *
185
+ * @deprecated
178
186
  * @param request - The request {@link ListGatewayNetworksRequest}
179
187
  * @returns A Promise of ListGatewayNetworksResponse
180
188
  */
@@ -186,6 +194,7 @@ class API extends api.API {
186
194
  /**
187
195
  * Get a Public Gateway connection to a Private Network. Get details of a given connection between a Public Gateway and a Private Network (this connection = a GatewayNetwork), specified by its `gateway_network_id`. The response object contains details of the connection including the IDs of the Public Gateway and Private Network, the dates the connection was created/updated and its configuration settings.
188
196
  *
197
+ * @deprecated
189
198
  * @param request - The request {@link GetGatewayNetworkRequest}
190
199
  * @returns A Promise of GatewayNetwork
191
200
  */
@@ -214,6 +223,7 @@ class API extends api.API {
214
223
  /**
215
224
  * Attach a Public Gateway to a Private Network. Attach a specific Public Gateway to a specific Private Network (create a GatewayNetwork). You can configure parameters for the connection including DHCP settings, whether to enable masquerade (dynamic NAT), and more.
216
225
  *
226
+ * @deprecated
217
227
  * @param request - The request {@link CreateGatewayNetworkRequest}
218
228
  * @returns A Promise of GatewayNetwork
219
229
  */
@@ -231,6 +241,7 @@ class API extends api.API {
231
241
  /**
232
242
  * Update a Public Gateway's connection to a Private Network. Update the configuration parameters of a connection between a given Public Gateway and Private Network (the connection = a GatewayNetwork). Updatable parameters include DHCP settings and whether to enable traffic masquerade (dynamic NAT).
233
243
  *
244
+ * @deprecated
234
245
  * @param request - The request {@link UpdateGatewayNetworkRequest}
235
246
  * @returns A Promise of GatewayNetwork
236
247
  */
@@ -248,6 +259,7 @@ class API extends api.API {
248
259
  /**
249
260
  * Detach a Public Gateway from a Private Network. Detach a given Public Gateway from a given Private Network, i.e. delete a GatewayNetwork specified by a gateway_network_id.
250
261
  *
262
+ * @deprecated
251
263
  * @param request - The request {@link DeleteGatewayNetworkRequest}
252
264
  */
253
265
  deleteGatewayNetwork = (request) => this.client.fetch({
@@ -277,6 +289,7 @@ class API extends api.API {
277
289
  /**
278
290
  * List DHCP configurations. List DHCP configurations, optionally filtering by Organization, Project, Public Gateway IP address or more. The response is an array of DHCP configuration objects, each identified by a DHCP ID and containing configuration settings for the assignment of IP addresses to devices on a Private Network attached to a Public Gateway. Note that the response does not contain the IDs of any Private Network / Public Gateway the configuration is attached to. Use the `List Public Gateway connections to Private Networks` method for that purpose, filtering on DHCP ID.
279
291
  *
292
+ * @deprecated
280
293
  * @param request - The request {@link ListDHCPsRequest}
281
294
  * @returns A Promise of ListDHCPsResponse
282
295
  */
@@ -284,6 +297,7 @@ class API extends api.API {
284
297
  /**
285
298
  * Get a DHCP configuration. Get a DHCP configuration object, identified by its DHCP ID. The response object contains configuration settings for the assignment of IP addresses to devices on a Private Network attached to a Public Gateway. Note that the response does not contain the IDs of any Private Network / Public Gateway the configuration is attached to. Use the `List Public Gateway connections to Private Networks` method for that purpose, filtering on DHCP ID.
286
299
  *
300
+ * @deprecated
287
301
  * @param request - The request {@link GetDHCPRequest}
288
302
  * @returns A Promise of DHCP
289
303
  */
@@ -297,6 +311,7 @@ class API extends api.API {
297
311
  /**
298
312
  * Create a DHCP configuration. Create a new DHCP configuration object, containing settings for the assignment of IP addresses to devices on a Private Network attached to a Public Gateway. The response object includes the ID of the DHCP configuration object. You can use this ID as part of a call to `Create a Public Gateway connection to a Private Network` or `Update a Public Gateway connection to a Private Network` to directly apply this DHCP configuration.
299
313
  *
314
+ * @deprecated
300
315
  * @param request - The request {@link CreateDHCPRequest}
301
316
  * @returns A Promise of DHCP
302
317
  */
@@ -314,6 +329,7 @@ class API extends api.API {
314
329
  /**
315
330
  * Update a DHCP configuration. Update a DHCP configuration object, identified by its DHCP ID.
316
331
  *
332
+ * @deprecated
317
333
  * @param request - The request {@link UpdateDHCPRequest}
318
334
  * @returns A Promise of DHCP
319
335
  */
@@ -331,6 +347,7 @@ class API extends api.API {
331
347
  /**
332
348
  * Delete a DHCP configuration. Delete a DHCP configuration object, identified by its DHCP ID. Note that you cannot delete a DHCP configuration object that is currently being used by a Gateway Network.
333
349
  *
350
+ * @deprecated
334
351
  * @param request - The request {@link DeleteDHCPRequest}
335
352
  */
336
353
  deleteDHCP = (request) => this.client.fetch({
@@ -360,6 +377,7 @@ class API extends api.API {
360
377
  /**
361
378
  * List DHCP entries. List DHCP entries, whether dynamically assigned and/or statically reserved. DHCP entries can be filtered by the Gateway Network they are on, their MAC address, IP address, type or hostname.
362
379
  *
380
+ * @deprecated
363
381
  * @param request - The request {@link ListDHCPEntriesRequest}
364
382
  * @returns A Promise of ListDHCPEntriesResponse
365
383
  */
@@ -367,6 +385,7 @@ class API extends api.API {
367
385
  /**
368
386
  * Get a DHCP entry. Get a DHCP entry, specified by its DHCP entry ID.
369
387
  *
388
+ * @deprecated
370
389
  * @param request - The request {@link GetDHCPEntryRequest}
371
390
  * @returns A Promise of DHCPEntry
372
391
  */
@@ -380,6 +399,7 @@ class API extends api.API {
380
399
  /**
381
400
  * Create a DHCP entry. Create a static DHCP reservation, specifying the Gateway Network for the reservation, the MAC address of the target device and the IP address to assign this device. The response is a DHCP entry object, confirming the ID and configuration details of the static DHCP reservation.
382
401
  *
402
+ * @deprecated
383
403
  * @param request - The request {@link CreateDHCPEntryRequest}
384
404
  * @returns A Promise of DHCPEntry
385
405
  */
@@ -397,6 +417,7 @@ class API extends api.API {
397
417
  /**
398
418
  * Update a DHCP entry. Update the IP address for a DHCP entry, specified by its DHCP entry ID. You can update an existing DHCP entry of any type (`reservation` (static), `lease` (dynamic) or `unknown`), but in manually updating the IP address the entry will necessarily be of type `reservation` after the update.
399
419
  *
420
+ * @deprecated
400
421
  * @param request - The request {@link UpdateDHCPEntryRequest}
401
422
  * @returns A Promise of DHCPEntry
402
423
  */
@@ -414,6 +435,7 @@ class API extends api.API {
414
435
  /**
415
436
  * Set all DHCP reservations on a Gateway Network. Set the list of DHCP reservations attached to a Gateway Network. Reservations are identified by their MAC address, and will sync the current DHCP entry list to the given list, creating, updating or deleting DHCP entries accordingly.
416
437
  *
438
+ * @deprecated
417
439
  * @param request - The request {@link SetDHCPEntriesRequest}
418
440
  * @returns A Promise of SetDHCPEntriesResponse
419
441
  */
@@ -431,6 +453,7 @@ class API extends api.API {
431
453
  /**
432
454
  * Delete a DHCP entry. Delete a static DHCP reservation, identified by its DHCP entry ID. Note that you cannot delete DHCP entries of type `lease`, these are deleted automatically when their time-to-live expires.
433
455
  *
456
+ * @deprecated
434
457
  * @param request - The request {@link DeleteDHCPEntryRequest}
435
458
  */
436
459
  deleteDHCPEntry = (request) => this.client.fetch({
@@ -458,6 +481,7 @@ class API extends api.API {
458
481
  /**
459
482
  * List PAT rules. List PAT rules. You can filter by gateway ID to list all PAT rules for a particular gateway, or filter for PAT rules targeting a specific IP address or using a specific protocol.
460
483
  *
484
+ * @deprecated
461
485
  * @param request - The request {@link ListPATRulesRequest}
462
486
  * @returns A Promise of ListPATRulesResponse
463
487
  */
@@ -465,6 +489,7 @@ class API extends api.API {
465
489
  /**
466
490
  * Get a PAT rule. Get a PAT rule, specified by its PAT rule ID. The response object gives full details of the PAT rule, including the Public Gateway it belongs to and the configuration settings in terms of public / private ports, private IP and protocol.
467
491
  *
492
+ * @deprecated
468
493
  * @param request - The request {@link GetPATRuleRequest}
469
494
  * @returns A Promise of PATRule
470
495
  */
@@ -478,6 +503,7 @@ class API extends api.API {
478
503
  /**
479
504
  * Create a PAT rule. Create a new PAT rule on a specified Public Gateway, defining the protocol to use, public port to listen on, and private port / IP address to map to.
480
505
  *
506
+ * @deprecated
481
507
  * @param request - The request {@link CreatePATRuleRequest}
482
508
  * @returns A Promise of PATRule
483
509
  */
@@ -495,6 +521,7 @@ class API extends api.API {
495
521
  /**
496
522
  * Update a PAT rule. Update a PAT rule, specified by its PAT rule ID. Configuration settings including private/public port, private IP address and protocol can all be updated.
497
523
  *
524
+ * @deprecated
498
525
  * @param request - The request {@link UpdatePATRuleRequest}
499
526
  * @returns A Promise of PATRule
500
527
  */
@@ -512,6 +539,7 @@ class API extends api.API {
512
539
  /**
513
540
  * Set all PAT rules. Set a definitive list of PAT rules attached to a Public Gateway. Each rule is identified by its public port and protocol. This will sync the current PAT rule list on the gateway with the new list, creating, updating or deleting PAT rules accordingly.
514
541
  *
542
+ * @deprecated
515
543
  * @param request - The request {@link SetPATRulesRequest}
516
544
  * @returns A Promise of SetPATRulesResponse
517
545
  */
@@ -529,6 +557,7 @@ class API extends api.API {
529
557
  /**
530
558
  * Delete a PAT rule. Delete a PAT rule, identified by its PAT rule ID. This action is irreversible.
531
559
  *
560
+ * @deprecated
532
561
  * @param request - The request {@link DeletePATRuleRequest}
533
562
  */
534
563
  deletePATRule = (request) => this.client.fetch({
@@ -538,6 +567,7 @@ class API extends api.API {
538
567
  /**
539
568
  * List Public Gateway types. List the different Public Gateway commercial offer types available at Scaleway. The response is an array of objects describing the name and technical details of each available gateway type.
540
569
  *
570
+ * @deprecated
541
571
  * @param request - The request {@link ListGatewayTypesRequest}
542
572
  * @returns A Promise of ListGatewayTypesResponse
543
573
  */
@@ -571,6 +601,7 @@ class API extends api.API {
571
601
  /**
572
602
  * List IPs. List Public Gateway flexible IP addresses. A number of filter options are available for limiting results in the response.
573
603
  *
604
+ * @deprecated
574
605
  * @param request - The request {@link ListIPsRequest}
575
606
  * @returns A Promise of ListIPsResponse
576
607
  */
@@ -578,6 +609,7 @@ class API extends api.API {
578
609
  /**
579
610
  * Get an IP. Get details of a Public Gateway flexible IP address, identified by its IP ID. The response object contains information including which (if any) Public Gateway using this IP address, the reverse and various other metadata.
580
611
  *
612
+ * @deprecated
581
613
  * @param request - The request {@link GetIPRequest}
582
614
  * @returns A Promise of IP
583
615
  */
@@ -591,6 +623,7 @@ class API extends api.API {
591
623
  /**
592
624
  * Reserve an IP. Create (reserve) a new flexible IP address that can be used for a Public Gateway in a specified Scaleway Project.
593
625
  *
626
+ * @deprecated
594
627
  * @param request - The request {@link CreateIPRequest}
595
628
  * @returns A Promise of IP
596
629
  */
@@ -608,6 +641,7 @@ class API extends api.API {
608
641
  /**
609
642
  * Update an IP. Update details of an existing flexible IP address, including its tags, reverse and the Public Gateway it is assigned to.
610
643
  *
644
+ * @deprecated
611
645
  * @param request - The request {@link UpdateIPRequest}
612
646
  * @returns A Promise of IP
613
647
  */
@@ -625,6 +659,7 @@ class API extends api.API {
625
659
  /**
626
660
  * Delete an IP. Delete a flexible IP address from your account. This action is irreversible.
627
661
  *
662
+ * @deprecated
628
663
  * @param request - The request {@link DeleteIPRequest}
629
664
  */
630
665
  deleteIP = (request) => this.client.fetch({
@@ -634,6 +669,7 @@ class API extends api.API {
634
669
  /**
635
670
  * Refresh a Public Gateway's SSH keys. Refresh the SSH keys of a given Public Gateway, specified by its gateway ID. This adds any new SSH keys in the gateway's Scaleway Project to the gateway itself.
636
671
  *
672
+ * @deprecated
637
673
  * @param request - The request {@link RefreshSSHKeysRequest}
638
674
  * @returns A Promise of Gateway
639
675
  */
@@ -649,6 +685,7 @@ class API extends api.API {
649
685
  /**
650
686
  * Put a Public Gateway in IPAM mode. Put a Public Gateway in IPAM mode, so that it can be used with the Public Gateways API v2. This call is idempotent.
651
687
  *
688
+ * @deprecated
652
689
  * @param request - The request {@link MigrateToV2Request}
653
690
  */
654
691
  migrateToV2 = (request) => this.client.fetch({
@@ -13,6 +13,7 @@ export declare class API extends ParentAPI {
13
13
  /**
14
14
  * List Public Gateways. List Public Gateways in a given Scaleway Organization or Project. By default, results are displayed in ascending order of creation date.
15
15
  *
16
+ * @deprecated
16
17
  * @param request - The request {@link ListGatewaysRequest}
17
18
  * @returns A Promise of ListGatewaysResponse
18
19
  */
@@ -23,6 +24,7 @@ export declare class API extends ParentAPI {
23
24
  /**
24
25
  * Get a Public Gateway. Get details of a Public Gateway, specified by its gateway ID. The response object contains full details of the gateway, including its **name**, **type**, **status** and more.
25
26
  *
27
+ * @deprecated
26
28
  * @param request - The request {@link GetGatewayRequest}
27
29
  * @returns A Promise of Gateway
28
30
  */
@@ -38,6 +40,7 @@ export declare class API extends ParentAPI {
38
40
  /**
39
41
  * Create a Public Gateway. Create a new Public Gateway in the specified Scaleway Project, defining its **name**, **type** and other configuration details such as whether to enable SSH bastion.
40
42
  *
43
+ * @deprecated
41
44
  * @param request - The request {@link CreateGatewayRequest}
42
45
  * @returns A Promise of Gateway
43
46
  */
@@ -45,6 +48,7 @@ export declare class API extends ParentAPI {
45
48
  /**
46
49
  * Update a Public Gateway. Update the parameters of an existing Public Gateway, for example, its **name**, **tags**, **SSH bastion configuration**, and **DNS servers**.
47
50
  *
51
+ * @deprecated
48
52
  * @param request - The request {@link UpdateGatewayRequest}
49
53
  * @returns A Promise of Gateway
50
54
  */
@@ -52,12 +56,14 @@ export declare class API extends ParentAPI {
52
56
  /**
53
57
  * Delete a Public Gateway. Delete an existing Public Gateway, specified by its gateway ID. This action is irreversible.
54
58
  *
59
+ * @deprecated
55
60
  * @param request - The request {@link DeleteGatewayRequest}
56
61
  */
57
62
  deleteGateway: (request: Readonly<DeleteGatewayRequest>) => Promise<void>;
58
63
  /**
59
64
  * Upgrade a Public Gateway to the latest version and/or to a different commercial offer type. Upgrade a given Public Gateway to the newest software version or to a different commercial offer type. This applies the latest bugfixes and features to your Public Gateway. Note that gateway service will be interrupted during the update.
60
65
  *
66
+ * @deprecated
61
67
  * @param request - The request {@link UpgradeGatewayRequest}
62
68
  * @returns A Promise of Gateway
63
69
  */
@@ -65,6 +71,7 @@ export declare class API extends ParentAPI {
65
71
  /**
66
72
  * Upgrade a Public Gateway to IP mobility. Upgrade a Public Gateway to IP mobility (move from NAT IP to routed IP). This is idempotent: repeated calls after the first will return no error but have no effect.
67
73
  *
74
+ * @deprecated
68
75
  * @param request - The request {@link EnableIPMobilityRequest}
69
76
  */
70
77
  enableIPMobility: (request: Readonly<EnableIPMobilityRequest>) => Promise<void>;
@@ -72,6 +79,7 @@ export declare class API extends ParentAPI {
72
79
  /**
73
80
  * List Public Gateway connections to Private Networks. List the connections between Public Gateways and Private Networks (a connection = a GatewayNetwork). You can choose to filter by `gateway-id` to list all Private Networks attached to the specified Public Gateway, or by `private_network_id` to list all Public Gateways attached to the specified Private Network. Other query parameters are also available. The result is an array of GatewayNetwork objects, each giving details of the connection between a given Public Gateway and a given Private Network.
74
81
  *
82
+ * @deprecated
75
83
  * @param request - The request {@link ListGatewayNetworksRequest}
76
84
  * @returns A Promise of ListGatewayNetworksResponse
77
85
  */
@@ -82,6 +90,7 @@ export declare class API extends ParentAPI {
82
90
  /**
83
91
  * Get a Public Gateway connection to a Private Network. Get details of a given connection between a Public Gateway and a Private Network (this connection = a GatewayNetwork), specified by its `gateway_network_id`. The response object contains details of the connection including the IDs of the Public Gateway and Private Network, the dates the connection was created/updated and its configuration settings.
84
92
  *
93
+ * @deprecated
85
94
  * @param request - The request {@link GetGatewayNetworkRequest}
86
95
  * @returns A Promise of GatewayNetwork
87
96
  */
@@ -97,6 +106,7 @@ export declare class API extends ParentAPI {
97
106
  /**
98
107
  * Attach a Public Gateway to a Private Network. Attach a specific Public Gateway to a specific Private Network (create a GatewayNetwork). You can configure parameters for the connection including DHCP settings, whether to enable masquerade (dynamic NAT), and more.
99
108
  *
109
+ * @deprecated
100
110
  * @param request - The request {@link CreateGatewayNetworkRequest}
101
111
  * @returns A Promise of GatewayNetwork
102
112
  */
@@ -104,6 +114,7 @@ export declare class API extends ParentAPI {
104
114
  /**
105
115
  * Update a Public Gateway's connection to a Private Network. Update the configuration parameters of a connection between a given Public Gateway and Private Network (the connection = a GatewayNetwork). Updatable parameters include DHCP settings and whether to enable traffic masquerade (dynamic NAT).
106
116
  *
117
+ * @deprecated
107
118
  * @param request - The request {@link UpdateGatewayNetworkRequest}
108
119
  * @returns A Promise of GatewayNetwork
109
120
  */
@@ -111,6 +122,7 @@ export declare class API extends ParentAPI {
111
122
  /**
112
123
  * Detach a Public Gateway from a Private Network. Detach a given Public Gateway from a given Private Network, i.e. delete a GatewayNetwork specified by a gateway_network_id.
113
124
  *
125
+ * @deprecated
114
126
  * @param request - The request {@link DeleteGatewayNetworkRequest}
115
127
  */
116
128
  deleteGatewayNetwork: (request: Readonly<DeleteGatewayNetworkRequest>) => Promise<void>;
@@ -118,6 +130,7 @@ export declare class API extends ParentAPI {
118
130
  /**
119
131
  * List DHCP configurations. List DHCP configurations, optionally filtering by Organization, Project, Public Gateway IP address or more. The response is an array of DHCP configuration objects, each identified by a DHCP ID and containing configuration settings for the assignment of IP addresses to devices on a Private Network attached to a Public Gateway. Note that the response does not contain the IDs of any Private Network / Public Gateway the configuration is attached to. Use the `List Public Gateway connections to Private Networks` method for that purpose, filtering on DHCP ID.
120
132
  *
133
+ * @deprecated
121
134
  * @param request - The request {@link ListDHCPsRequest}
122
135
  * @returns A Promise of ListDHCPsResponse
123
136
  */
@@ -128,6 +141,7 @@ export declare class API extends ParentAPI {
128
141
  /**
129
142
  * Get a DHCP configuration. Get a DHCP configuration object, identified by its DHCP ID. The response object contains configuration settings for the assignment of IP addresses to devices on a Private Network attached to a Public Gateway. Note that the response does not contain the IDs of any Private Network / Public Gateway the configuration is attached to. Use the `List Public Gateway connections to Private Networks` method for that purpose, filtering on DHCP ID.
130
143
  *
144
+ * @deprecated
131
145
  * @param request - The request {@link GetDHCPRequest}
132
146
  * @returns A Promise of DHCP
133
147
  */
@@ -135,6 +149,7 @@ export declare class API extends ParentAPI {
135
149
  /**
136
150
  * Create a DHCP configuration. Create a new DHCP configuration object, containing settings for the assignment of IP addresses to devices on a Private Network attached to a Public Gateway. The response object includes the ID of the DHCP configuration object. You can use this ID as part of a call to `Create a Public Gateway connection to a Private Network` or `Update a Public Gateway connection to a Private Network` to directly apply this DHCP configuration.
137
151
  *
152
+ * @deprecated
138
153
  * @param request - The request {@link CreateDHCPRequest}
139
154
  * @returns A Promise of DHCP
140
155
  */
@@ -142,6 +157,7 @@ export declare class API extends ParentAPI {
142
157
  /**
143
158
  * Update a DHCP configuration. Update a DHCP configuration object, identified by its DHCP ID.
144
159
  *
160
+ * @deprecated
145
161
  * @param request - The request {@link UpdateDHCPRequest}
146
162
  * @returns A Promise of DHCP
147
163
  */
@@ -149,6 +165,7 @@ export declare class API extends ParentAPI {
149
165
  /**
150
166
  * Delete a DHCP configuration. Delete a DHCP configuration object, identified by its DHCP ID. Note that you cannot delete a DHCP configuration object that is currently being used by a Gateway Network.
151
167
  *
168
+ * @deprecated
152
169
  * @param request - The request {@link DeleteDHCPRequest}
153
170
  */
154
171
  deleteDHCP: (request: Readonly<DeleteDHCPRequest>) => Promise<void>;
@@ -156,6 +173,7 @@ export declare class API extends ParentAPI {
156
173
  /**
157
174
  * List DHCP entries. List DHCP entries, whether dynamically assigned and/or statically reserved. DHCP entries can be filtered by the Gateway Network they are on, their MAC address, IP address, type or hostname.
158
175
  *
176
+ * @deprecated
159
177
  * @param request - The request {@link ListDHCPEntriesRequest}
160
178
  * @returns A Promise of ListDHCPEntriesResponse
161
179
  */
@@ -166,6 +184,7 @@ export declare class API extends ParentAPI {
166
184
  /**
167
185
  * Get a DHCP entry. Get a DHCP entry, specified by its DHCP entry ID.
168
186
  *
187
+ * @deprecated
169
188
  * @param request - The request {@link GetDHCPEntryRequest}
170
189
  * @returns A Promise of DHCPEntry
171
190
  */
@@ -173,6 +192,7 @@ export declare class API extends ParentAPI {
173
192
  /**
174
193
  * Create a DHCP entry. Create a static DHCP reservation, specifying the Gateway Network for the reservation, the MAC address of the target device and the IP address to assign this device. The response is a DHCP entry object, confirming the ID and configuration details of the static DHCP reservation.
175
194
  *
195
+ * @deprecated
176
196
  * @param request - The request {@link CreateDHCPEntryRequest}
177
197
  * @returns A Promise of DHCPEntry
178
198
  */
@@ -180,6 +200,7 @@ export declare class API extends ParentAPI {
180
200
  /**
181
201
  * Update a DHCP entry. Update the IP address for a DHCP entry, specified by its DHCP entry ID. You can update an existing DHCP entry of any type (`reservation` (static), `lease` (dynamic) or `unknown`), but in manually updating the IP address the entry will necessarily be of type `reservation` after the update.
182
202
  *
203
+ * @deprecated
183
204
  * @param request - The request {@link UpdateDHCPEntryRequest}
184
205
  * @returns A Promise of DHCPEntry
185
206
  */
@@ -187,6 +208,7 @@ export declare class API extends ParentAPI {
187
208
  /**
188
209
  * Set all DHCP reservations on a Gateway Network. Set the list of DHCP reservations attached to a Gateway Network. Reservations are identified by their MAC address, and will sync the current DHCP entry list to the given list, creating, updating or deleting DHCP entries accordingly.
189
210
  *
211
+ * @deprecated
190
212
  * @param request - The request {@link SetDHCPEntriesRequest}
191
213
  * @returns A Promise of SetDHCPEntriesResponse
192
214
  */
@@ -194,6 +216,7 @@ export declare class API extends ParentAPI {
194
216
  /**
195
217
  * Delete a DHCP entry. Delete a static DHCP reservation, identified by its DHCP entry ID. Note that you cannot delete DHCP entries of type `lease`, these are deleted automatically when their time-to-live expires.
196
218
  *
219
+ * @deprecated
197
220
  * @param request - The request {@link DeleteDHCPEntryRequest}
198
221
  */
199
222
  deleteDHCPEntry: (request: Readonly<DeleteDHCPEntryRequest>) => Promise<void>;
@@ -201,6 +224,7 @@ export declare class API extends ParentAPI {
201
224
  /**
202
225
  * List PAT rules. List PAT rules. You can filter by gateway ID to list all PAT rules for a particular gateway, or filter for PAT rules targeting a specific IP address or using a specific protocol.
203
226
  *
227
+ * @deprecated
204
228
  * @param request - The request {@link ListPATRulesRequest}
205
229
  * @returns A Promise of ListPATRulesResponse
206
230
  */
@@ -211,6 +235,7 @@ export declare class API extends ParentAPI {
211
235
  /**
212
236
  * Get a PAT rule. Get a PAT rule, specified by its PAT rule ID. The response object gives full details of the PAT rule, including the Public Gateway it belongs to and the configuration settings in terms of public / private ports, private IP and protocol.
213
237
  *
238
+ * @deprecated
214
239
  * @param request - The request {@link GetPATRuleRequest}
215
240
  * @returns A Promise of PATRule
216
241
  */
@@ -218,6 +243,7 @@ export declare class API extends ParentAPI {
218
243
  /**
219
244
  * Create a PAT rule. Create a new PAT rule on a specified Public Gateway, defining the protocol to use, public port to listen on, and private port / IP address to map to.
220
245
  *
246
+ * @deprecated
221
247
  * @param request - The request {@link CreatePATRuleRequest}
222
248
  * @returns A Promise of PATRule
223
249
  */
@@ -225,6 +251,7 @@ export declare class API extends ParentAPI {
225
251
  /**
226
252
  * Update a PAT rule. Update a PAT rule, specified by its PAT rule ID. Configuration settings including private/public port, private IP address and protocol can all be updated.
227
253
  *
254
+ * @deprecated
228
255
  * @param request - The request {@link UpdatePATRuleRequest}
229
256
  * @returns A Promise of PATRule
230
257
  */
@@ -232,6 +259,7 @@ export declare class API extends ParentAPI {
232
259
  /**
233
260
  * Set all PAT rules. Set a definitive list of PAT rules attached to a Public Gateway. Each rule is identified by its public port and protocol. This will sync the current PAT rule list on the gateway with the new list, creating, updating or deleting PAT rules accordingly.
234
261
  *
262
+ * @deprecated
235
263
  * @param request - The request {@link SetPATRulesRequest}
236
264
  * @returns A Promise of SetPATRulesResponse
237
265
  */
@@ -239,12 +267,14 @@ export declare class API extends ParentAPI {
239
267
  /**
240
268
  * Delete a PAT rule. Delete a PAT rule, identified by its PAT rule ID. This action is irreversible.
241
269
  *
270
+ * @deprecated
242
271
  * @param request - The request {@link DeletePATRuleRequest}
243
272
  */
244
273
  deletePATRule: (request: Readonly<DeletePATRuleRequest>) => Promise<void>;
245
274
  /**
246
275
  * List Public Gateway types. List the different Public Gateway commercial offer types available at Scaleway. The response is an array of objects describing the name and technical details of each available gateway type.
247
276
  *
277
+ * @deprecated
248
278
  * @param request - The request {@link ListGatewayTypesRequest}
249
279
  * @returns A Promise of ListGatewayTypesResponse
250
280
  */
@@ -253,6 +283,7 @@ export declare class API extends ParentAPI {
253
283
  /**
254
284
  * List IPs. List Public Gateway flexible IP addresses. A number of filter options are available for limiting results in the response.
255
285
  *
286
+ * @deprecated
256
287
  * @param request - The request {@link ListIPsRequest}
257
288
  * @returns A Promise of ListIPsResponse
258
289
  */
@@ -263,6 +294,7 @@ export declare class API extends ParentAPI {
263
294
  /**
264
295
  * Get an IP. Get details of a Public Gateway flexible IP address, identified by its IP ID. The response object contains information including which (if any) Public Gateway using this IP address, the reverse and various other metadata.
265
296
  *
297
+ * @deprecated
266
298
  * @param request - The request {@link GetIPRequest}
267
299
  * @returns A Promise of IP
268
300
  */
@@ -270,6 +302,7 @@ export declare class API extends ParentAPI {
270
302
  /**
271
303
  * Reserve an IP. Create (reserve) a new flexible IP address that can be used for a Public Gateway in a specified Scaleway Project.
272
304
  *
305
+ * @deprecated
273
306
  * @param request - The request {@link CreateIPRequest}
274
307
  * @returns A Promise of IP
275
308
  */
@@ -277,6 +310,7 @@ export declare class API extends ParentAPI {
277
310
  /**
278
311
  * Update an IP. Update details of an existing flexible IP address, including its tags, reverse and the Public Gateway it is assigned to.
279
312
  *
313
+ * @deprecated
280
314
  * @param request - The request {@link UpdateIPRequest}
281
315
  * @returns A Promise of IP
282
316
  */
@@ -284,12 +318,14 @@ export declare class API extends ParentAPI {
284
318
  /**
285
319
  * Delete an IP. Delete a flexible IP address from your account. This action is irreversible.
286
320
  *
321
+ * @deprecated
287
322
  * @param request - The request {@link DeleteIPRequest}
288
323
  */
289
324
  deleteIP: (request: Readonly<DeleteIPRequest>) => Promise<void>;
290
325
  /**
291
326
  * Refresh a Public Gateway's SSH keys. Refresh the SSH keys of a given Public Gateway, specified by its gateway ID. This adds any new SSH keys in the gateway's Scaleway Project to the gateway itself.
292
327
  *
328
+ * @deprecated
293
329
  * @param request - The request {@link RefreshSSHKeysRequest}
294
330
  * @returns A Promise of Gateway
295
331
  */
@@ -297,6 +333,7 @@ export declare class API extends ParentAPI {
297
333
  /**
298
334
  * Put a Public Gateway in IPAM mode. Put a Public Gateway in IPAM mode, so that it can be used with the Public Gateways API v2. This call is idempotent.
299
335
  *
336
+ * @deprecated
300
337
  * @param request - The request {@link MigrateToV2Request}
301
338
  */
302
339
  migrateToV2: (request: Readonly<MigrateToV2Request>) => Promise<void>;