@scaleway/sdk-vpcgw 1.2.0 → 2.1.1

package/README.md

@@ -0,0 +1,96 @@
+# @scaleway/sdk-vpcgw
+
+[![npm version](https://img.shields.io/npm/v/@scaleway/sdk-vpcgw.svg)](https://www.npmjs.com/package/@scaleway/sdk-vpcgw)
+[![npm downloads](https://img.shields.io/npm/dm/@scaleway/sdk-vpcgw.svg)](https://www.npmjs.com/package/@scaleway/sdk-vpcgw)
+[![license](https://img.shields.io/npm/l/@scaleway/sdk-vpcgw.svg)](https://github.com/scaleway/scaleway-sdk-js/blob/master/LICENSE)
+
+Scaleway SDK for Vpcgw API.
+
+> **Note**  
+> This is an automatically generated package that is part of the [Scaleway SDK for JavaScript](https://github.com/scaleway/scaleway-sdk-js).
+
+## Installation
+
+```bash
+npm install @scaleway/sdk-vpcgw @scaleway/sdk-client
+```
+
+or with pnpm:
+
+```bash
+pnpm add @scaleway/sdk-vpcgw @scaleway/sdk-client
+```
+
+or with yarn:
+
+```bash
+yarn add @scaleway/sdk-vpcgw @scaleway/sdk-client
+```
+
+## Getting Started
+
+You'll need a pair of access and secret keys to connect to Scaleway API. Please check the [documentation](https://www.scaleway.com/en/docs/identity-and-access-management/iam/how-to/create-api-keys/) on how to retrieve them.
+
+### Basic Usage
+
+```typescript
+import { createClient } from '@scaleway/sdk-client'
+import { Vpcgw } from '@scaleway/sdk-vpcgw'
+
+const client = createClient({
+  accessKey: 'SCWXXXXXXXXXXXXXXXXX',
+  secretKey: 'xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx',
+  defaultProjectId: 'xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx',
+  defaultRegion: 'fr-par',
+  defaultZone: 'fr-par-1',
+})
+
+const api = new Vpcgw.v1.API(client)
+
+// Use the API
+// Example: await api.listServers()
+```
+
+### Using Configuration Loader
+
+For a simpler setup, you can load credentials from the configuration file or environment variables:
+
+```typescript
+import { createClient } from '@scaleway/sdk-client'
+import { loadProfileFromConfigurationFile } from '@scaleway/configuration-loader'
+import { Vpcgw } from '@scaleway/sdk-vpcgw'
+
+const profile = loadProfileFromConfigurationFile()
+const client = createClient(profile)
+const api = new Vpcgw.v1.API(client)
+```
+
+## Documentation
+
+- 📚 [Scaleway SDK Reference Documentation](https://scaleway.github.io/scaleway-sdk-js)
+- 🌐 [Scaleway Vpcgw API Documentation](https://www.scaleway.com/en/developers/api/vpcgw/)
+- 📖 [Main Repository](https://github.com/scaleway/scaleway-sdk-js)
+- 💡 [Example Projects](https://github.com/scaleway/scaleway-sdk-js/tree/master/examples)
+
+## Features
+
+- ✅ Full TypeScript support with complete type definitions
+- ✅ Promise-based API
+- ✅ Automatic pagination helpers
+- ✅ Built-in error handling
+- ✅ Compatible with Node.js ≥ 20
+
+## Support
+
+We love feedback! Feel free to reach us on:
+- [Scaleway Slack community](https://slack.scaleway.com/) - Join us on [#opensource](https://scaleway-community.slack.com/app_redirect?channel=opensource)
+- [GitHub Issues](https://github.com/scaleway/scaleway-sdk-js/issues)
+
+## Contributing
+
+This repository is at its early stage and is still in active development. If you are looking for a way to contribute, please read [CONTRIBUTING.md](https://github.com/scaleway/scaleway-sdk-js/blob/master/CONTRIBUTING.md).
+
+## License
+
+This project is Apache 2.0 licensed. See the [LICENSE](https://github.com/scaleway/scaleway-sdk-js/blob/master/LICENSE) file for details.
+

package/dist/v1/api.gen.d.ts

@@ -1,6 +1,6 @@
-import { API as ParentAPI } from '@scaleway/sdk-client';
 import type { ApiLocality, WaitForOptions } from '@scaleway/sdk-client';
-import type { CreateDHCPEntryRequest, CreateDHCPRequest, CreateGatewayNetworkRequest, CreateGatewayRequest, CreateIPRequest, CreatePATRuleRequest, DHCP, DHCPEntry, DeleteDHCPEntryRequest, DeleteDHCPRequest, DeleteGatewayNetworkRequest, DeleteGatewayRequest, DeleteIPRequest, DeletePATRuleRequest, EnableIPMobilityRequest, Gateway, GatewayNetwork, GetDHCPEntryRequest, GetDHCPRequest, GetGatewayNetworkRequest, GetGatewayRequest, GetIPRequest, GetPATRuleRequest, IP, ListDHCPEntriesRequest, ListDHCPEntriesResponse, ListDHCPsRequest, ListDHCPsResponse, ListGatewayNetworksRequest, ListGatewayNetworksResponse, ListGatewayTypesRequest, ListGatewayTypesResponse, ListGatewaysRequest, ListGatewaysResponse, ListIPsRequest, ListIPsResponse, ListPATRulesRequest, ListPATRulesResponse, MigrateToV2Request, PATRule, RefreshSSHKeysRequest, SetDHCPEntriesRequest, SetDHCPEntriesResponse, SetPATRulesRequest, SetPATRulesResponse, UpdateDHCPEntryRequest, UpdateDHCPRequest, UpdateGatewayNetworkRequest, UpdateGatewayRequest, UpdateIPRequest, UpdatePATRuleRequest, UpgradeGatewayRequest } from './types.gen.js';
+import { API as ParentAPI } from '@scaleway/sdk-client';
+import type { CreateDHCPEntryRequest, CreateDHCPRequest, CreateGatewayNetworkRequest, CreateGatewayRequest, CreateIPRequest, CreatePATRuleRequest, DeleteDHCPEntryRequest, DeleteDHCPRequest, DeleteGatewayNetworkRequest, DeleteGatewayRequest, DeleteIPRequest, DeletePATRuleRequest, DHCP, DHCPEntry, EnableIPMobilityRequest, Gateway, GatewayNetwork, GetDHCPEntryRequest, GetDHCPRequest, GetGatewayNetworkRequest, GetGatewayRequest, GetIPRequest, GetPATRuleRequest, IP, ListDHCPEntriesRequest, ListDHCPEntriesResponse, ListDHCPsRequest, ListDHCPsResponse, ListGatewayNetworksRequest, ListGatewayNetworksResponse, ListGatewaysRequest, ListGatewaysResponse, ListGatewayTypesRequest, ListGatewayTypesResponse, ListIPsRequest, ListIPsResponse, ListPATRulesRequest, ListPATRulesResponse, MigrateToV2Request, PATRule, RefreshSSHKeysRequest, SetDHCPEntriesRequest, SetDHCPEntriesResponse, SetPATRulesRequest, SetPATRulesResponse, UpdateDHCPEntryRequest, UpdateDHCPRequest, UpdateGatewayNetworkRequest, UpdateGatewayRequest, UpdateIPRequest, UpdatePATRuleRequest, UpgradeGatewayRequest } from './types.gen.js';
 /**
  * Public Gateways API.
 

package/dist/v1/api.gen.js

@@ -30,10 +30,7 @@ class API extends API$1 {
         ["order_by", request.orderBy],
         ["organization_id", request.organizationId],
         ["page", request.page],
-        [
-          "page_size",
-          request.pageSize ?? this.client.settings.defaultPageSize
-        ],
+        ["page_size", request.pageSize ?? this.client.settings.defaultPageSize],
         ["private_network_id", request.privateNetworkId],
         ["project_id", request.projectId],
         ["status", request.status],
@@ -73,9 +70,7 @@ class API extends API$1 {
    * @returns A Promise of Gateway
    */
   waitForGateway = (request, options) => waitForResource(
-    options?.stop ?? ((res) => Promise.resolve(
-      !GATEWAY_TRANSIENT_STATUSES.includes(res.status)
-    )),
+    options?.stop ?? ((res) => Promise.resolve(!GATEWAY_TRANSIENT_STATUSES.includes(res.status))),
     this.getGateway,
     request,
     options
@@ -122,11 +117,15 @@ class API extends API$1 {
    * @deprecated
    * @param request - The request {@link DeleteGatewayRequest}
    */
-  deleteGateway = (request) => this.client.fetch({
-    method: "DELETE",
-    path: `/vpc-gw/v1/zones/${validatePathParam("zone", request.zone ?? this.client.settings.defaultZone)}/gateways/${validatePathParam("gatewayId", request.gatewayId)}`,
-    urlParams: urlParams(["cleanup_dhcp", request.cleanupDhcp])
-  });
+  deleteGateway = (request) => this.client.fetch(
+    {
+      method: "DELETE",
+      path: `/vpc-gw/v1/zones/${validatePathParam("zone", request.zone ?? this.client.settings.defaultZone)}/gateways/${validatePathParam("gatewayId", request.gatewayId)}`,
+      urlParams: urlParams(
+        ["cleanup_dhcp", request.cleanupDhcp]
+      )
+    }
+  );
   /**
    * 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.
    *
@@ -151,12 +150,14 @@ class API extends API$1 {
    * @deprecated
    * @param request - The request {@link EnableIPMobilityRequest}
    */
-  enableIPMobility = (request) => this.client.fetch({
-    body: "{}",
-    headers: jsonContentHeaders,
-    method: "POST",
-    path: `/vpc-gw/v1/zones/${validatePathParam("zone", request.zone ?? this.client.settings.defaultZone)}/gateways/${validatePathParam("gatewayId", request.gatewayId)}/enable-ip-mobility`
-  });
+  enableIPMobility = (request) => this.client.fetch(
+    {
+      body: "{}",
+      headers: jsonContentHeaders,
+      method: "POST",
+      path: `/vpc-gw/v1/zones/${validatePathParam("zone", request.zone ?? this.client.settings.defaultZone)}/gateways/${validatePathParam("gatewayId", request.gatewayId)}/enable-ip-mobility`
+    }
+  );
   pageOfListGatewayNetworks = (request = {}) => this.client.fetch(
     {
       method: "GET",
@@ -167,10 +168,7 @@ class API extends API$1 {
         ["gateway_id", request.gatewayId],
         ["order_by", request.orderBy],
         ["page", request.page],
-        [
-          "page_size",
-          request.pageSize ?? this.client.settings.defaultPageSize
-        ],
+        ["page_size", request.pageSize ?? this.client.settings.defaultPageSize],
         ["private_network_id", request.privateNetworkId],
         ["status", request.status]
       )
@@ -184,11 +182,7 @@ class API extends API$1 {
    * @param request - The request {@link ListGatewayNetworksRequest}
    * @returns A Promise of ListGatewayNetworksResponse
    */
-  listGatewayNetworks = (request = {}) => enrichForPagination(
-    "gatewayNetworks",
-    this.pageOfListGatewayNetworks,
-    request
-  );
+  listGatewayNetworks = (request = {}) => enrichForPagination("gatewayNetworks", this.pageOfListGatewayNetworks, request);
   /**
    * 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.
    *
@@ -211,9 +205,7 @@ class API extends API$1 {
    * @returns A Promise of GatewayNetwork
    */
   waitForGatewayNetwork = (request, options) => waitForResource(
-    options?.stop ?? ((res) => Promise.resolve(
-      !GATEWAY_NETWORK_TRANSIENT_STATUSES.includes(res.status)
-    )),
+    options?.stop ?? ((res) => Promise.resolve(!GATEWAY_NETWORK_TRANSIENT_STATUSES.includes(res.status))),
     this.getGatewayNetwork,
     request,
     options
@@ -260,11 +252,15 @@ class API extends API$1 {
    * @deprecated
    * @param request - The request {@link DeleteGatewayNetworkRequest}
    */
-  deleteGatewayNetwork = (request) => this.client.fetch({
-    method: "DELETE",
-    path: `/vpc-gw/v1/zones/${validatePathParam("zone", request.zone ?? this.client.settings.defaultZone)}/gateway-networks/${validatePathParam("gatewayNetworkId", request.gatewayNetworkId)}`,
-    urlParams: urlParams(["cleanup_dhcp", request.cleanupDhcp])
-  });
+  deleteGatewayNetwork = (request) => this.client.fetch(
+    {
+      method: "DELETE",
+      path: `/vpc-gw/v1/zones/${validatePathParam("zone", request.zone ?? this.client.settings.defaultZone)}/gateway-networks/${validatePathParam("gatewayNetworkId", request.gatewayNetworkId)}`,
+      urlParams: urlParams(
+        ["cleanup_dhcp", request.cleanupDhcp]
+      )
+    }
+  );
   pageOfListDHCPs = (request = {}) => this.client.fetch(
     {
       method: "GET",
@@ -275,10 +271,7 @@ class API extends API$1 {
         ["order_by", request.orderBy],
         ["organization_id", request.organizationId],
         ["page", request.page],
-        [
-          "page_size",
-          request.pageSize ?? this.client.settings.defaultPageSize
-        ],
+        ["page_size", request.pageSize ?? this.client.settings.defaultPageSize],
         ["project_id", request.projectId]
       )
     },
@@ -348,10 +341,12 @@ class API extends API$1 {
    * @deprecated
    * @param request - The request {@link DeleteDHCPRequest}
    */
-  deleteDHCP = (request) => this.client.fetch({
-    method: "DELETE",
-    path: `/vpc-gw/v1/zones/${validatePathParam("zone", request.zone ?? this.client.settings.defaultZone)}/dhcps/${validatePathParam("dhcpId", request.dhcpId)}`
-  });
+  deleteDHCP = (request) => this.client.fetch(
+    {
+      method: "DELETE",
+      path: `/vpc-gw/v1/zones/${validatePathParam("zone", request.zone ?? this.client.settings.defaultZone)}/dhcps/${validatePathParam("dhcpId", request.dhcpId)}`
+    }
+  );
   pageOfListDHCPEntries = (request = {}) => this.client.fetch(
     {
       method: "GET",
@@ -363,10 +358,7 @@ class API extends API$1 {
         ["mac_address", request.macAddress],
         ["order_by", request.orderBy],
         ["page", request.page],
-        [
-          "page_size",
-          request.pageSize ?? this.client.settings.defaultPageSize
-        ],
+        ["page_size", request.pageSize ?? this.client.settings.defaultPageSize],
         ["type", request.type]
       )
     },
@@ -454,10 +446,12 @@ class API extends API$1 {
    * @deprecated
    * @param request - The request {@link DeleteDHCPEntryRequest}
    */
-  deleteDHCPEntry = (request) => this.client.fetch({
-    method: "DELETE",
-    path: `/vpc-gw/v1/zones/${validatePathParam("zone", request.zone ?? this.client.settings.defaultZone)}/dhcp-entries/${validatePathParam("dhcpEntryId", request.dhcpEntryId)}`
-  });
+  deleteDHCPEntry = (request) => this.client.fetch(
+    {
+      method: "DELETE",
+      path: `/vpc-gw/v1/zones/${validatePathParam("zone", request.zone ?? this.client.settings.defaultZone)}/dhcp-entries/${validatePathParam("dhcpEntryId", request.dhcpEntryId)}`
+    }
+  );
   pageOfListPATRules = (request = {}) => this.client.fetch(
     {
       method: "GET",
@@ -466,10 +460,7 @@ class API extends API$1 {
         ["gateway_id", request.gatewayId],
         ["order_by", request.orderBy],
         ["page", request.page],
-        [
-          "page_size",
-          request.pageSize ?? this.client.settings.defaultPageSize
-        ],
+        ["page_size", request.pageSize ?? this.client.settings.defaultPageSize],
         ["private_ip", request.privateIp],
         ["protocol", request.protocol]
       )
@@ -558,10 +549,12 @@ class API extends API$1 {
    * @deprecated
    * @param request - The request {@link DeletePATRuleRequest}
    */
-  deletePATRule = (request) => this.client.fetch({
-    method: "DELETE",
-    path: `/vpc-gw/v1/zones/${validatePathParam("zone", request.zone ?? this.client.settings.defaultZone)}/pat-rules/${validatePathParam("patRuleId", request.patRuleId)}`
-  });
+  deletePATRule = (request) => this.client.fetch(
+    {
+      method: "DELETE",
+      path: `/vpc-gw/v1/zones/${validatePathParam("zone", request.zone ?? this.client.settings.defaultZone)}/pat-rules/${validatePathParam("patRuleId", request.patRuleId)}`
+    }
+  );
   /**
    * 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.
    *
@@ -585,10 +578,7 @@ class API extends API$1 {
         ["order_by", request.orderBy],
         ["organization_id", request.organizationId],
         ["page", request.page],
-        [
-          "page_size",
-          request.pageSize ?? this.client.settings.defaultPageSize
-        ],
+        ["page_size", request.pageSize ?? this.client.settings.defaultPageSize],
         ["project_id", request.projectId],
         ["reverse", request.reverse],
         ["tags", request.tags]
@@ -660,10 +650,12 @@ class API extends API$1 {
    * @deprecated
    * @param request - The request {@link DeleteIPRequest}
    */
-  deleteIP = (request) => this.client.fetch({
-    method: "DELETE",
-    path: `/vpc-gw/v1/zones/${validatePathParam("zone", request.zone ?? this.client.settings.defaultZone)}/ips/${validatePathParam("ipId", request.ipId)}`
-  });
+  deleteIP = (request) => this.client.fetch(
+    {
+      method: "DELETE",
+      path: `/vpc-gw/v1/zones/${validatePathParam("zone", request.zone ?? this.client.settings.defaultZone)}/ips/${validatePathParam("ipId", request.ipId)}`
+    }
+  );
   /**
    * 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.
    *
@@ -686,12 +678,14 @@ class API extends API$1 {
    * @deprecated
    * @param request - The request {@link MigrateToV2Request}
    */
-  migrateToV2 = (request) => this.client.fetch({
-    body: "{}",
-    headers: jsonContentHeaders,
-    method: "POST",
-    path: `/vpc-gw/v1/zones/${validatePathParam("zone", request.zone ?? this.client.settings.defaultZone)}/gateways/${validatePathParam("gatewayId", request.gatewayId)}/migrate-to-v2`
-  });
+  migrateToV2 = (request) => this.client.fetch(
+    {
+      body: "{}",
+      headers: jsonContentHeaders,
+      method: "POST",
+      path: `/vpc-gw/v1/zones/${validatePathParam("zone", request.zone ?? this.client.settings.defaultZone)}/gateways/${validatePathParam("gatewayId", request.gatewayId)}/migrate-to-v2`
+    }
+  );
 }
 export {
   API

package/dist/v1/index.gen.d.ts

@@ -1,4 +1,4 @@
-export { API } from './api.gen.js';
+export { API, } from './api.gen.js';
 export * from './content.gen.js';
 export * from './marshalling.gen.js';
-export type { CreateDHCPEntryRequest, CreateDHCPRequest, CreateGatewayNetworkRequest, CreateGatewayNetworkRequestIpamConfig, CreateGatewayRequest, CreateIPRequest, CreatePATRuleRequest, DHCP, DHCPEntry, DHCPEntryType, DeleteDHCPEntryRequest, DeleteDHCPRequest, DeleteGatewayNetworkRequest, DeleteGatewayRequest, DeleteIPRequest, DeletePATRuleRequest, EnableIPMobilityRequest, Gateway, GatewayNetwork, GatewayNetworkStatus, GatewayStatus, GatewayType, GetDHCPEntryRequest, GetDHCPRequest, GetGatewayNetworkRequest, GetGatewayRequest, GetIPRequest, GetPATRuleRequest, IP, IpamConfig, ListDHCPEntriesRequest, ListDHCPEntriesRequestOrderBy, ListDHCPEntriesResponse, ListDHCPsRequest, ListDHCPsRequestOrderBy, ListDHCPsResponse, ListGatewayNetworksRequest, ListGatewayNetworksRequestOrderBy, ListGatewayNetworksResponse, ListGatewayTypesRequest, ListGatewayTypesResponse, ListGatewaysRequest, ListGatewaysRequestOrderBy, ListGatewaysResponse, ListIPsRequest, ListIPsRequestOrderBy, ListIPsResponse, ListPATRulesRequest, ListPATRulesRequestOrderBy, ListPATRulesResponse, MigrateToV2Request, PATRule, PATRuleProtocol, RefreshSSHKeysRequest, SetDHCPEntriesRequest, SetDHCPEntriesRequestEntry, SetDHCPEntriesResponse, SetPATRulesRequest, SetPATRulesRequestRule, SetPATRulesResponse, UpdateDHCPEntryRequest, UpdateDHCPRequest, UpdateGatewayNetworkRequest, UpdateGatewayNetworkRequestIpamConfig, UpdateGatewayRequest, UpdateIPRequest, UpdatePATRuleRequest, UpgradeGatewayRequest, } from './types.gen.js';
+export type { CreateDHCPEntryRequest, CreateDHCPRequest, CreateGatewayNetworkRequest, CreateGatewayNetworkRequestIpamConfig, CreateGatewayRequest, CreateIPRequest, CreatePATRuleRequest, DeleteDHCPEntryRequest, DeleteDHCPRequest, DeleteGatewayNetworkRequest, DeleteGatewayRequest, DeleteIPRequest, DeletePATRuleRequest, DHCP, DHCPEntry, DHCPEntryType, EnableIPMobilityRequest, Gateway, GatewayNetwork, GatewayNetworkStatus, GatewayStatus, GatewayType, GetDHCPEntryRequest, GetDHCPRequest, GetGatewayNetworkRequest, GetGatewayRequest, GetIPRequest, GetPATRuleRequest, IP, IpamConfig, ListDHCPEntriesRequest, ListDHCPEntriesRequestOrderBy, ListDHCPEntriesResponse, ListDHCPsRequest, ListDHCPsRequestOrderBy, ListDHCPsResponse, ListGatewayNetworksRequest, ListGatewayNetworksRequestOrderBy, ListGatewayNetworksResponse, ListGatewaysRequest, ListGatewaysRequestOrderBy, ListGatewaysResponse, ListGatewayTypesRequest, ListGatewayTypesResponse, ListIPsRequest, ListIPsRequestOrderBy, ListIPsResponse, ListPATRulesRequest, ListPATRulesRequestOrderBy, ListPATRulesResponse, MigrateToV2Request, PATRule, PATRuleProtocol, RefreshSSHKeysRequest, SetDHCPEntriesRequest, SetDHCPEntriesRequestEntry, SetDHCPEntriesResponse, SetPATRulesRequest, SetPATRulesRequestRule, SetPATRulesResponse, UpdateDHCPEntryRequest, UpdateDHCPRequest, UpdateGatewayNetworkRequest, UpdateGatewayNetworkRequestIpamConfig, UpdateGatewayRequest, UpdateIPRequest, UpdatePATRuleRequest, UpgradeGatewayRequest, } from './types.gen.js';

package/dist/v1/marshalling.gen.d.ts

@@ -1,5 +1,5 @@
 import type { DefaultValues } from '@scaleway/sdk-client';
-import type { CreateDHCPEntryRequest, CreateDHCPRequest, CreateGatewayNetworkRequest, CreateGatewayRequest, CreateIPRequest, CreatePATRuleRequest, DHCP, DHCPEntry, Gateway, GatewayNetwork, IP, ListDHCPEntriesResponse, ListDHCPsResponse, ListGatewayNetworksResponse, ListGatewayTypesResponse, ListGatewaysResponse, ListIPsResponse, ListPATRulesResponse, PATRule, SetDHCPEntriesRequest, SetDHCPEntriesResponse, SetPATRulesRequest, SetPATRulesResponse, UpdateDHCPEntryRequest, UpdateDHCPRequest, UpdateGatewayNetworkRequest, UpdateGatewayRequest, UpdateIPRequest, UpdatePATRuleRequest, UpgradeGatewayRequest } from './types.gen.js';
+import type { CreateDHCPEntryRequest, CreateDHCPRequest, CreateGatewayNetworkRequest, CreateGatewayRequest, CreateIPRequest, CreatePATRuleRequest, DHCP, DHCPEntry, Gateway, GatewayNetwork, IP, ListDHCPEntriesResponse, ListDHCPsResponse, ListGatewayNetworksResponse, ListGatewaysResponse, ListGatewayTypesResponse, ListIPsResponse, ListPATRulesResponse, PATRule, SetDHCPEntriesRequest, SetDHCPEntriesResponse, SetPATRulesRequest, SetPATRulesResponse, UpdateDHCPEntryRequest, UpdateDHCPRequest, UpdateGatewayNetworkRequest, UpdateGatewayRequest, UpdateIPRequest, UpdatePATRuleRequest, UpgradeGatewayRequest } from './types.gen.js';
 export declare const unmarshalDHCP: (data: unknown) => DHCP;
 export declare const unmarshalGatewayNetwork: (data: unknown) => GatewayNetwork;
 export declare const unmarshalIP: (data: unknown) => IP;

package/dist/v1/marshalling.gen.js

@@ -121,10 +121,7 @@ const unmarshalGateway = (data) => {
     bastionPort: data.bastion_port,
     canUpgradeTo: data.can_upgrade_to,
     createdAt: unmarshalDate(data.created_at),
-    gatewayNetworks: unmarshalArrayOfObject(
-      data.gateway_networks,
-      unmarshalGatewayNetwork
-    ),
+    gatewayNetworks: unmarshalArrayOfObject(data.gateway_networks, unmarshalGatewayNetwork),
     id: data.id,
     ip: data.ip ? unmarshalIP(data.ip) : void 0,
     ipMobilityEnabled: data.ip_mobility_enabled,
@@ -189,10 +186,7 @@ const unmarshalListGatewayNetworksResponse = (data) => {
     );
   }
   return {
-    gatewayNetworks: unmarshalArrayOfObject(
-      data.gateway_networks,
-      unmarshalGatewayNetwork
-    ),
+    gatewayNetworks: unmarshalArrayOfObject(data.gateway_networks, unmarshalGatewayNetwork),
     totalCount: data.total_count
   };
 };
@@ -290,17 +284,21 @@ const marshalCreateGatewayNetworkRequest = (request, defaults) => ({
   gateway_id: request.gatewayId,
   private_network_id: request.privateNetworkId,
   ...resolveOneOf([
-    { param: "dhcp_id", value: request.dhcpId },
+    {
+      param: "dhcp_id",
+      value: request.dhcpId
+    },
     {
       param: "dhcp",
       value: request.dhcp !== void 0 ? marshalCreateDHCPRequest(request.dhcp, defaults) : void 0
     },
-    { param: "address", value: request.address },
+    {
+      param: "address",
+      value: request.address
+    },
     {
       param: "ipam_config",
-      value: request.ipamConfig !== void 0 ? marshalCreateGatewayNetworkRequestIpamConfig(
-        request.ipamConfig
-      ) : void 0
+      value: request.ipamConfig !== void 0 ? marshalCreateGatewayNetworkRequestIpamConfig(request.ipamConfig) : void 0
     }
   ])
 });
@@ -331,9 +329,7 @@ const marshalSetDHCPEntriesRequestEntry = (request, defaults) => ({
   mac_address: request.macAddress
 });
 const marshalSetDHCPEntriesRequest = (request, defaults) => ({
-  dhcp_entries: request.dhcpEntries !== void 0 ? request.dhcpEntries.map(
-    (elt) => marshalSetDHCPEntriesRequestEntry(elt)
-  ) : void 0,
+  dhcp_entries: request.dhcpEntries !== void 0 ? request.dhcpEntries.map((elt) => marshalSetDHCPEntriesRequestEntry(elt)) : void 0,
   gateway_network_id: request.gatewayNetworkId
 });
 const marshalSetPATRulesRequestRule = (request, defaults) => ({
@@ -344,9 +340,7 @@ const marshalSetPATRulesRequestRule = (request, defaults) => ({
 });
 const marshalSetPATRulesRequest = (request, defaults) => ({
   gateway_id: request.gatewayId,
-  pat_rules: request.patRules.map(
-    (elt) => marshalSetPATRulesRequestRule(elt)
-  )
+  pat_rules: request.patRules.map((elt) => marshalSetPATRulesRequestRule(elt))
 });
 const marshalUpdateDHCPEntryRequest = (request, defaults) => ({
   ip_address: request.ipAddress
@@ -374,13 +368,17 @@ const marshalUpdateGatewayNetworkRequest = (request, defaults) => ({
   enable_dhcp: request.enableDhcp,
   enable_masquerade: request.enableMasquerade,
   ...resolveOneOf([
-    { param: "dhcp_id", value: request.dhcpId },
-    { param: "address", value: request.address },
+    {
+      param: "dhcp_id",
+      value: request.dhcpId
+    },
+    {
+      param: "address",
+      value: request.address
+    },
     {
       param: "ipam_config",
-      value: request.ipamConfig !== void 0 ? marshalUpdateGatewayNetworkRequestIpamConfig(
-        request.ipamConfig
-      ) : void 0
+      value: request.ipamConfig !== void 0 ? marshalUpdateGatewayNetworkRequestIpamConfig(request.ipamConfig) : void 0
     }
   ])
 });

package/dist/v2/api.gen.d.ts

@@ -1,6 +1,6 @@
-import { API as ParentAPI } from '@scaleway/sdk-client';
 import type { ApiLocality, WaitForOptions } from '@scaleway/sdk-client';
-import type { AddBastionAllowedIPsRequest, AddBastionAllowedIPsResponse, CreateGatewayNetworkRequest, CreateGatewayRequest, CreateIPRequest, CreatePatRuleRequest, DeleteBastionAllowedIPsRequest, DeleteGatewayNetworkRequest, DeleteGatewayRequest, DeleteIPRequest, DeletePatRuleRequest, Gateway, GatewayNetwork, GetGatewayNetworkRequest, GetGatewayRequest, GetIPRequest, GetPatRuleRequest, IP, ListGatewayNetworksRequest, ListGatewayNetworksResponse, ListGatewayTypesRequest, ListGatewayTypesResponse, ListGatewaysRequest, ListGatewaysResponse, ListIPsRequest, ListIPsResponse, ListPatRulesRequest, ListPatRulesResponse, PatRule, RefreshSSHKeysRequest, SetBastionAllowedIPsRequest, SetBastionAllowedIPsResponse, SetPatRulesRequest, SetPatRulesResponse, UpdateGatewayNetworkRequest, UpdateGatewayRequest, UpdateIPRequest, UpdatePatRuleRequest, UpgradeGatewayRequest } from './types.gen.js';
+import { API as ParentAPI } from '@scaleway/sdk-client';
+import type { AddBastionAllowedIPsRequest, AddBastionAllowedIPsResponse, CreateGatewayNetworkRequest, CreateGatewayRequest, CreateIPRequest, CreatePatRuleRequest, DeleteBastionAllowedIPsRequest, DeleteGatewayNetworkRequest, DeleteGatewayRequest, DeleteIPRequest, DeletePatRuleRequest, Gateway, GatewayNetwork, GetGatewayNetworkRequest, GetGatewayRequest, GetIPRequest, GetPatRuleRequest, IP, ListGatewayNetworksRequest, ListGatewayNetworksResponse, ListGatewaysRequest, ListGatewaysResponse, ListGatewayTypesRequest, ListGatewayTypesResponse, ListIPsRequest, ListIPsResponse, ListPatRulesRequest, ListPatRulesResponse, PatRule, RefreshSSHKeysRequest, SetBastionAllowedIPsRequest, SetBastionAllowedIPsResponse, SetPatRulesRequest, SetPatRulesResponse, UpdateGatewayNetworkRequest, UpdateGatewayRequest, UpdateIPRequest, UpdatePatRuleRequest, UpgradeGatewayRequest } from './types.gen.js';
 /**
  * Public Gateways API.
 

package/dist/v2/api.gen.js

@@ -31,10 +31,7 @@ class API extends API$1 {
         ["order_by", request.orderBy],
         ["organization_id", request.organizationId],
         ["page", request.page],
-        [
-          "page_size",
-          request.pageSize ?? this.client.settings.defaultPageSize
-        ],
+        ["page_size", request.pageSize ?? this.client.settings.defaultPageSize],
         ["private_network_ids", request.privateNetworkIds],
         ["project_id", request.projectId],
         ["status", request.status],
@@ -72,9 +69,7 @@ class API extends API$1 {
    * @returns A Promise of Gateway
    */
   waitForGateway = (request, options) => waitForResource(
-    options?.stop ?? ((res) => Promise.resolve(
-      !GATEWAY_TRANSIENT_STATUSES.includes(res.status)
-    )),
+    options?.stop ?? ((res) => Promise.resolve(!GATEWAY_TRANSIENT_STATUSES.includes(res.status))),
     this.getGateway,
     request,
     options
@@ -123,7 +118,9 @@ class API extends API$1 {
     {
       method: "DELETE",
       path: `/vpc-gw/v2/zones/${validatePathParam("zone", request.zone ?? this.client.settings.defaultZone)}/gateways/${validatePathParam("gatewayId", request.gatewayId)}`,
-      urlParams: urlParams(["delete_ip", request.deleteIp])
+      urlParams: urlParams(
+        ["delete_ip", request.deleteIp]
+      )
     },
     unmarshalGateway
   );
@@ -153,10 +150,7 @@ class API extends API$1 {
         ["masquerade_enabled", request.masqueradeEnabled],
         ["order_by", request.orderBy],
         ["page", request.page],
-        [
-          "page_size",
-          request.pageSize ?? this.client.settings.defaultPageSize
-        ],
+        ["page_size", request.pageSize ?? this.client.settings.defaultPageSize],
         ["private_network_ids", request.privateNetworkIds],
         ["status", request.status]
       )
@@ -169,11 +163,7 @@ class API extends API$1 {
    * @param request - The request {@link ListGatewayNetworksRequest}
    * @returns A Promise of ListGatewayNetworksResponse
    */
-  listGatewayNetworks = (request = {}) => enrichForPagination(
-    "gatewayNetworks",
-    this.pageOfListGatewayNetworks,
-    request
-  );
+  listGatewayNetworks = (request = {}) => enrichForPagination("gatewayNetworks", this.pageOfListGatewayNetworks, request);
   /**
    * 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.
    *
@@ -195,9 +185,7 @@ class API extends API$1 {
    * @returns A Promise of GatewayNetwork
    */
   waitForGatewayNetwork = (request, options) => waitForResource(
-    options?.stop ?? ((res) => Promise.resolve(
-      !GATEWAY_NETWORK_TRANSIENT_STATUSES.includes(res.status)
-    )),
+    options?.stop ?? ((res) => Promise.resolve(!GATEWAY_NETWORK_TRANSIENT_STATUSES.includes(res.status))),
     this.getGatewayNetwork,
     request,
     options
@@ -257,10 +245,7 @@ class API extends API$1 {
         ["gateway_ids", request.gatewayIds],
         ["order_by", request.orderBy],
         ["page", request.page],
-        [
-          "page_size",
-          request.pageSize ?? this.client.settings.defaultPageSize
-        ],
+        ["page_size", request.pageSize ?? this.client.settings.defaultPageSize],
         ["private_ips", request.privateIps],
         ["protocol", request.protocol]
       )
@@ -343,10 +328,12 @@ class API extends API$1 {
    *
    * @param request - The request {@link DeletePatRuleRequest}
    */
-  deletePatRule = (request) => this.client.fetch({
-    method: "DELETE",
-    path: `/vpc-gw/v2/zones/${validatePathParam("zone", request.zone ?? this.client.settings.defaultZone)}/pat-rules/${validatePathParam("patRuleId", request.patRuleId)}`
-  });
+  deletePatRule = (request) => this.client.fetch(
+    {
+      method: "DELETE",
+      path: `/vpc-gw/v2/zones/${validatePathParam("zone", request.zone ?? this.client.settings.defaultZone)}/pat-rules/${validatePathParam("patRuleId", request.patRuleId)}`
+    }
+  );
   /**
    * 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.
    *
@@ -369,10 +356,7 @@ class API extends API$1 {
         ["order_by", request.orderBy],
         ["organization_id", request.organizationId],
         ["page", request.page],
-        [
-          "page_size",
-          request.pageSize ?? this.client.settings.defaultPageSize
-        ],
+        ["page_size", request.pageSize ?? this.client.settings.defaultPageSize],
         ["project_id", request.projectId],
         ["reverse", request.reverse],
         ["tags", request.tags]
@@ -439,10 +423,12 @@ class API extends API$1 {
    *
    * @param request - The request {@link DeleteIPRequest}
    */
-  deleteIP = (request) => this.client.fetch({
-    method: "DELETE",
-    path: `/vpc-gw/v2/zones/${validatePathParam("zone", request.zone ?? this.client.settings.defaultZone)}/ips/${validatePathParam("ipId", request.ipId)}`
-  });
+  deleteIP = (request) => this.client.fetch(
+    {
+      method: "DELETE",
+      path: `/vpc-gw/v2/zones/${validatePathParam("zone", request.zone ?? this.client.settings.defaultZone)}/ips/${validatePathParam("ipId", request.ipId)}`
+    }
+  );
   /**
    * 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.
    *
@@ -497,10 +483,12 @@ class API extends API$1 {
    *
    * @param request - The request {@link DeleteBastionAllowedIPsRequest}
    */
-  deleteBastionAllowedIPs = (request) => this.client.fetch({
-    method: "DELETE",
-    path: `/vpc-gw/v2/zones/${validatePathParam("zone", request.zone ?? this.client.settings.defaultZone)}/gateways/${validatePathParam("gatewayId", request.gatewayId)}/bastion-allowed-ips/${validatePathParam("ipRange", request.ipRange)}`
-  });
+  deleteBastionAllowedIPs = (request) => this.client.fetch(
+    {
+      method: "DELETE",
+      path: `/vpc-gw/v2/zones/${validatePathParam("zone", request.zone ?? this.client.settings.defaultZone)}/gateways/${validatePathParam("gatewayId", request.gatewayId)}/bastion-allowed-ips/${validatePathParam("ipRange", request.ipRange)}`
+    }
+  );
 }
 export {
   API

package/dist/v2/index.gen.d.ts

@@ -1,4 +1,4 @@
-export { API } from './api.gen.js';
+export { API, } from './api.gen.js';
 export * from './content.gen.js';
 export * from './marshalling.gen.js';
-export type { AddBastionAllowedIPsRequest, AddBastionAllowedIPsResponse, CreateGatewayNetworkRequest, CreateGatewayRequest, CreateIPRequest, CreatePatRuleRequest, DeleteBastionAllowedIPsRequest, DeleteGatewayNetworkRequest, DeleteGatewayRequest, DeleteIPRequest, DeletePatRuleRequest, Gateway, GatewayNetwork, GatewayNetworkStatus, GatewayStatus, GatewayType, GetGatewayNetworkRequest, GetGatewayRequest, GetIPRequest, GetPatRuleRequest, IP, ListGatewayNetworksRequest, ListGatewayNetworksRequestOrderBy, ListGatewayNetworksResponse, ListGatewayTypesRequest, ListGatewayTypesResponse, ListGatewaysRequest, ListGatewaysRequestOrderBy, ListGatewaysResponse, ListIPsRequest, ListIPsRequestOrderBy, ListIPsResponse, ListPatRulesRequest, ListPatRulesRequestOrderBy, ListPatRulesResponse, PatRule, PatRuleProtocol, RefreshSSHKeysRequest, SetBastionAllowedIPsRequest, SetBastionAllowedIPsResponse, SetPatRulesRequest, SetPatRulesRequestRule, SetPatRulesResponse, UpdateGatewayNetworkRequest, UpdateGatewayRequest, UpdateIPRequest, UpdatePatRuleRequest, UpgradeGatewayRequest, } from './types.gen.js';
+export type { AddBastionAllowedIPsRequest, AddBastionAllowedIPsResponse, CreateGatewayNetworkRequest, CreateGatewayRequest, CreateIPRequest, CreatePatRuleRequest, DeleteBastionAllowedIPsRequest, DeleteGatewayNetworkRequest, DeleteGatewayRequest, DeleteIPRequest, DeletePatRuleRequest, Gateway, GatewayNetwork, GatewayNetworkStatus, GatewayStatus, GatewayType, GetGatewayNetworkRequest, GetGatewayRequest, GetIPRequest, GetPatRuleRequest, IP, ListGatewayNetworksRequest, ListGatewayNetworksRequestOrderBy, ListGatewayNetworksResponse, ListGatewaysRequest, ListGatewaysRequestOrderBy, ListGatewaysResponse, ListGatewayTypesRequest, ListGatewayTypesResponse, ListIPsRequest, ListIPsRequestOrderBy, ListIPsResponse, ListPatRulesRequest, ListPatRulesRequestOrderBy, ListPatRulesResponse, PatRule, PatRuleProtocol, RefreshSSHKeysRequest, SetBastionAllowedIPsRequest, SetBastionAllowedIPsResponse, SetPatRulesRequest, SetPatRulesRequestRule, SetPatRulesResponse, UpdateGatewayNetworkRequest, UpdateGatewayRequest, UpdateIPRequest, UpdatePatRuleRequest, UpgradeGatewayRequest, } from './types.gen.js';