@scaleway/sdk 2.29.0 → 2.31.0

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

@@ -1,6 +1,6 @@
 import { API as ParentAPI } from '../../../bridge';
 import type { Region } from '../../../bridge';
-import type { AddSubnetsRequest, AddSubnetsResponse, CreatePrivateNetworkRequest, CreateVPCRequest, DeletePrivateNetworkRequest, DeleteSubnetsRequest, DeleteSubnetsResponse, DeleteVPCRequest, EnableDHCPRequest, EnableRoutingRequest, GetPrivateNetworkRequest, GetVPCRequest, ListPrivateNetworksRequest, ListPrivateNetworksResponse, ListVPCsRequest, ListVPCsResponse, MigrateZonalPrivateNetworksRequest, PrivateNetwork, SetSubnetsRequest, SetSubnetsResponse, UpdatePrivateNetworkRequest, UpdateVPCRequest, VPC } from './types.gen';
+import type { AddSubnetsRequest, AddSubnetsResponse, CreatePrivateNetworkRequest, CreateVPCRequest, DeletePrivateNetworkRequest, DeleteSubnetsRequest, DeleteSubnetsResponse, DeleteVPCRequest, EnableDHCPRequest, EnableRoutingRequest, GetPrivateNetworkRequest, GetVPCRequest, ListPrivateNetworksRequest, ListPrivateNetworksResponse, ListSubnetsRequest, ListSubnetsResponse, ListVPCsRequest, ListVPCsResponse, MigrateZonalPrivateNetworksRequest, PrivateNetwork, SetSubnetsRequest, SetSubnetsResponse, UpdatePrivateNetworkRequest, UpdateVPCRequest, VPC } from './types.gen';
 /**
  * VPC API.
  *
@@ -121,8 +121,20 @@ export declare class API extends ParentAPI {
      * @returns A Promise of VPC
      */
     enableRouting: (request: Readonly<EnableRoutingRequest>) => Promise<VPC>;
+    protected pageOfListSubnets: (request?: Readonly<ListSubnetsRequest>) => Promise<ListSubnetsResponse>;
     /**
-     * Set the subnets of a Private Network. Set subnets for an existing Private
+     * List subnets. List any Private Network's subnets. See ListPrivateNetworks
+     * to list a specific Private Network's subnets.
+     *
+     * @param request - The request {@link ListSubnetsRequest}
+     * @returns A Promise of ListSubnetsResponse
+     */
+    listSubnets: (request?: Readonly<ListSubnetsRequest>) => Promise<ListSubnetsResponse> & {
+        all: () => Promise<import("./types.gen").Subnet[]>;
+        [Symbol.asyncIterator]: () => AsyncGenerator<import("./types.gen").Subnet[], void, void>;
+    };
+    /**
+     * Set a Private Network's subnets. Set subnets for an existing Private
      * Network. Note that the method is PUT and not PATCH. Any existing subnets
      * will be removed in favor of the new specified set of subnets.
      *

package/dist/api/vpc/v2/api.gen.js

@@ -1,7 +1,7 @@
 import { API as API$1 } from "../../../scw/api.js";
 import { validatePathParam, urlParams } from "../../../helpers/marshalling.js";
 import { enrichForPagination } from "../../../scw/fetch/resource-paginator.js";
-import { unmarshalListVPCsResponse, marshalCreateVPCRequest, unmarshalVPC, marshalUpdateVPCRequest, unmarshalListPrivateNetworksResponse, marshalCreatePrivateNetworkRequest, unmarshalPrivateNetwork, marshalUpdatePrivateNetworkRequest, marshalMigrateZonalPrivateNetworksRequest, marshalSetSubnetsRequest, unmarshalSetSubnetsResponse, marshalAddSubnetsRequest, unmarshalAddSubnetsResponse, marshalDeleteSubnetsRequest, unmarshalDeleteSubnetsResponse } from "./marshalling.gen.js";
+import { unmarshalListVPCsResponse, marshalCreateVPCRequest, unmarshalVPC, marshalUpdateVPCRequest, unmarshalListPrivateNetworksResponse, marshalCreatePrivateNetworkRequest, unmarshalPrivateNetwork, marshalUpdatePrivateNetworkRequest, marshalMigrateZonalPrivateNetworksRequest, unmarshalListSubnetsResponse, marshalSetSubnetsRequest, unmarshalSetSubnetsResponse, marshalAddSubnetsRequest, unmarshalAddSubnetsResponse, marshalDeleteSubnetsRequest, unmarshalDeleteSubnetsResponse } from "./marshalling.gen.js";
 const jsonContentHeaders = {
   "Content-Type": "application/json; charset=utf-8"
 };
@@ -242,8 +242,35 @@ class API extends API$1 {
     },
     unmarshalVPC
   );
+  pageOfListSubnets = (request = {}) => this.client.fetch(
+    {
+      method: "GET",
+      path: `/vpc/v2/regions/${validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/subnets`,
+      urlParams: urlParams(
+        ["order_by", request.orderBy],
+        ["organization_id", request.organizationId],
+        ["page", request.page],
+        [
+          "page_size",
+          request.pageSize ?? this.client.settings.defaultPageSize
+        ],
+        ["project_id", request.projectId],
+        ["subnet_ids", request.subnetIds],
+        ["vpc_id", request.vpcId]
+      )
+    },
+    unmarshalListSubnetsResponse
+  );
+  /**
+   * List subnets. List any Private Network's subnets. See ListPrivateNetworks
+   * to list a specific Private Network's subnets.
+   *
+   * @param request - The request {@link ListSubnetsRequest}
+   * @returns A Promise of ListSubnetsResponse
+   */
+  listSubnets = (request = {}) => enrichForPagination("subnets", this.pageOfListSubnets, request);
   /**
-   * Set the subnets of a Private Network. Set subnets for an existing Private
+   * Set a Private Network's subnets. Set subnets for an existing Private
    * Network. Note that the method is PUT and not PATCH. Any existing subnets
    * will be removed in favor of the new specified set of subnets.
    *

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

@@ -1,2 +1,2 @@
 export { API } from './api.gen';
-export type { AddSubnetsRequest, AddSubnetsResponse, CreatePrivateNetworkRequest, CreateVPCRequest, DeletePrivateNetworkRequest, DeleteSubnetsRequest, DeleteSubnetsResponse, DeleteVPCRequest, EnableDHCPRequest, EnableRoutingRequest, GetPrivateNetworkRequest, GetVPCRequest, ListPrivateNetworksRequest, ListPrivateNetworksRequestOrderBy, ListPrivateNetworksResponse, ListVPCsRequest, ListVPCsRequestOrderBy, ListVPCsResponse, MigrateZonalPrivateNetworksRequest, PrivateNetwork, SetSubnetsRequest, SetSubnetsResponse, Subnet, UpdatePrivateNetworkRequest, UpdateVPCRequest, VPC, } from './types.gen';
+export type { AddSubnetsRequest, AddSubnetsResponse, CreatePrivateNetworkRequest, CreateVPCRequest, DeletePrivateNetworkRequest, DeleteSubnetsRequest, DeleteSubnetsResponse, DeleteVPCRequest, EnableDHCPRequest, EnableRoutingRequest, GetPrivateNetworkRequest, GetVPCRequest, ListPrivateNetworksRequest, ListPrivateNetworksRequestOrderBy, ListPrivateNetworksResponse, ListSubnetsRequest, ListSubnetsRequestOrderBy, ListSubnetsResponse, ListVPCsRequest, ListVPCsRequestOrderBy, ListVPCsResponse, MigrateZonalPrivateNetworksRequest, PrivateNetwork, SetSubnetsRequest, SetSubnetsResponse, Subnet, UpdatePrivateNetworkRequest, UpdateVPCRequest, VPC, } from './types.gen';

package/dist/api/vpc/v2/marshalling.gen.cjs

@@ -12,8 +12,11 @@ const unmarshalSubnet = (data) => {
   return {
     createdAt: marshalling.unmarshalDate(data.created_at),
     id: data.id,
+    privateNetworkId: data.private_network_id,
+    projectId: data.project_id,
     subnet: data.subnet,
-    updatedAt: marshalling.unmarshalDate(data.updated_at)
+    updatedAt: marshalling.unmarshalDate(data.updated_at),
+    vpcId: data.vpc_id
   };
 };
 const unmarshalPrivateNetwork = (data) => {
@@ -90,6 +93,17 @@ const unmarshalListPrivateNetworksResponse = (data) => {
     totalCount: data.total_count
   };
 };
+const unmarshalListSubnetsResponse = (data) => {
+  if (!json.isJSONObject(data)) {
+    throw new TypeError(
+      `Unmarshalling the type 'ListSubnetsResponse' failed as data isn't a dictionary.`
+    );
+  }
+  return {
+    subnets: marshalling.unmarshalArrayOfObject(data.subnets, unmarshalSubnet),
+    totalCount: data.total_count
+  };
+};
 const unmarshalListVPCsResponse = (data) => {
   if (!json.isJSONObject(data)) {
     throw new TypeError(
@@ -167,6 +181,7 @@ exports.marshalUpdateVPCRequest = marshalUpdateVPCRequest;
 exports.unmarshalAddSubnetsResponse = unmarshalAddSubnetsResponse;
 exports.unmarshalDeleteSubnetsResponse = unmarshalDeleteSubnetsResponse;
 exports.unmarshalListPrivateNetworksResponse = unmarshalListPrivateNetworksResponse;
+exports.unmarshalListSubnetsResponse = unmarshalListSubnetsResponse;
 exports.unmarshalListVPCsResponse = unmarshalListVPCsResponse;
 exports.unmarshalPrivateNetwork = unmarshalPrivateNetwork;
 exports.unmarshalSetSubnetsResponse = unmarshalSetSubnetsResponse;

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

@@ -1,10 +1,11 @@
 import type { DefaultValues } from '../../../bridge';
-import type { AddSubnetsRequest, AddSubnetsResponse, CreatePrivateNetworkRequest, CreateVPCRequest, DeleteSubnetsRequest, DeleteSubnetsResponse, ListPrivateNetworksResponse, ListVPCsResponse, MigrateZonalPrivateNetworksRequest, PrivateNetwork, SetSubnetsRequest, SetSubnetsResponse, UpdatePrivateNetworkRequest, UpdateVPCRequest, VPC } from './types.gen';
+import type { AddSubnetsRequest, AddSubnetsResponse, CreatePrivateNetworkRequest, CreateVPCRequest, DeleteSubnetsRequest, DeleteSubnetsResponse, ListPrivateNetworksResponse, ListSubnetsResponse, ListVPCsResponse, MigrateZonalPrivateNetworksRequest, PrivateNetwork, SetSubnetsRequest, SetSubnetsResponse, UpdatePrivateNetworkRequest, UpdateVPCRequest, VPC } from './types.gen';
 export declare const unmarshalPrivateNetwork: (data: unknown) => PrivateNetwork;
 export declare const unmarshalVPC: (data: unknown) => VPC;
 export declare const unmarshalAddSubnetsResponse: (data: unknown) => AddSubnetsResponse;
 export declare const unmarshalDeleteSubnetsResponse: (data: unknown) => DeleteSubnetsResponse;
 export declare const unmarshalListPrivateNetworksResponse: (data: unknown) => ListPrivateNetworksResponse;
+export declare const unmarshalListSubnetsResponse: (data: unknown) => ListSubnetsResponse;
 export declare const unmarshalListVPCsResponse: (data: unknown) => ListVPCsResponse;
 export declare const unmarshalSetSubnetsResponse: (data: unknown) => SetSubnetsResponse;
 export declare const marshalAddSubnetsRequest: (request: AddSubnetsRequest, defaults: DefaultValues) => Record<string, unknown>;

package/dist/api/vpc/v2/marshalling.gen.js

@@ -10,8 +10,11 @@ const unmarshalSubnet = (data) => {
   return {
     createdAt: unmarshalDate(data.created_at),
     id: data.id,
+    privateNetworkId: data.private_network_id,
+    projectId: data.project_id,
     subnet: data.subnet,
-    updatedAt: unmarshalDate(data.updated_at)
+    updatedAt: unmarshalDate(data.updated_at),
+    vpcId: data.vpc_id
   };
 };
 const unmarshalPrivateNetwork = (data) => {
@@ -88,6 +91,17 @@ const unmarshalListPrivateNetworksResponse = (data) => {
     totalCount: data.total_count
   };
 };
+const unmarshalListSubnetsResponse = (data) => {
+  if (!isJSONObject(data)) {
+    throw new TypeError(
+      `Unmarshalling the type 'ListSubnetsResponse' failed as data isn't a dictionary.`
+    );
+  }
+  return {
+    subnets: unmarshalArrayOfObject(data.subnets, unmarshalSubnet),
+    totalCount: data.total_count
+  };
+};
 const unmarshalListVPCsResponse = (data) => {
   if (!isJSONObject(data)) {
     throw new TypeError(
@@ -166,6 +180,7 @@ export {
   unmarshalAddSubnetsResponse,
   unmarshalDeleteSubnetsResponse,
   unmarshalListPrivateNetworksResponse,
+  unmarshalListSubnetsResponse,
   unmarshalListVPCsResponse,
   unmarshalPrivateNetwork,
   unmarshalSetSubnetsResponse,

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

@@ -1,5 +1,6 @@
 import type { Region } from '../../../bridge';
 export type ListPrivateNetworksRequestOrderBy = 'created_at_asc' | 'created_at_desc' | 'name_asc' | 'name_desc';
+export type ListSubnetsRequestOrderBy = 'created_at_asc' | 'created_at_desc';
 export type ListVPCsRequestOrderBy = 'created_at_asc' | 'created_at_desc' | 'name_asc' | 'name_desc';
 export interface Subnet {
     /** ID of the subnet. */
@@ -10,6 +11,12 @@ export interface Subnet {
     updatedAt?: Date;
     /** Subnet CIDR. */
     subnet: string;
+    /** Scaleway Project the subnet belongs to. */
+    projectId: string;
+    /** Private Network the subnet belongs to. */
+    privateNetworkId: string;
+    /** VPC the subnet belongs to. */
+    vpcId: string;
 }
 export interface PrivateNetwork {
     /** Private Network ID. */
@@ -224,6 +231,40 @@ export interface ListPrivateNetworksResponse {
     privateNetworks: PrivateNetwork[];
     totalCount: number;
 }
+export type ListSubnetsRequest = {
+    /**
+     * Region to target. If none is passed will use default region from the
+     * config.
+     */
+    region?: Region;
+    /** Sort order of the returned subnets. */
+    orderBy?: ListSubnetsRequestOrderBy;
+    /** Page number to return, from the paginated results. */
+    page?: number;
+    /** Maximum number of Private Networks to return per page. */
+    pageSize?: number;
+    /**
+     * Organization ID to filter for. Only subnets belonging to this Organization
+     * will be returned.
+     */
+    organizationId?: string;
+    /**
+     * Project ID to filter for. Only subnets belonging to this Project will be
+     * returned.
+     */
+    projectId?: string;
+    /**
+     * Subnet IDs to filter for. Only subnets matching the specified IDs will be
+     * returned.
+     */
+    subnetIds?: string[];
+    /** VPC ID to filter for. Only subnets belonging to this VPC will be returned. */
+    vpcId?: string;
+};
+export interface ListSubnetsResponse {
+    subnets: Subnet[];
+    totalCount: number;
+}
 export type ListVPCsRequest = {
     /**
      * Region to target. If none is passed will use default region from the

package/dist/index.cjs

@@ -31,21 +31,22 @@ const index$h = require("./api/ipam/index.cjs");
 const index$i = require("./api/ipfs/index.cjs");
 const index$j = require("./api/jobs/index.cjs");
 const index$k = require("./api/k8s/index.cjs");
-const index$l = require("./api/lb/index.cjs");
-const index$m = require("./api/llm_inference/index.cjs");
-const index$n = require("./api/marketplace/index.cjs");
-const index$o = require("./api/mnq/index.cjs");
-const index$p = require("./api/rdb/index.cjs");
-const index$q = require("./api/redis/index.cjs");
-const index$r = require("./api/registry/index.cjs");
-const index$s = require("./api/secret/index.cjs");
-const index$t = require("./api/serverless_sqldb/index.cjs");
+const index$l = require("./api/key_manager/index.cjs");
+const index$m = require("./api/lb/index.cjs");
+const index$n = require("./api/llm_inference/index.cjs");
+const index$o = require("./api/marketplace/index.cjs");
+const index$p = require("./api/mnq/index.cjs");
+const index$q = require("./api/rdb/index.cjs");
+const index$r = require("./api/redis/index.cjs");
+const index$s = require("./api/registry/index.cjs");
+const index$t = require("./api/secret/index.cjs");
+const index$u = require("./api/serverless_sqldb/index.cjs");
 const index_gen = require("./api/std/index.gen.cjs");
-const index$u = require("./api/test/index.cjs");
-const index$v = require("./api/tem/index.cjs");
-const index$w = require("./api/vpc/index.cjs");
-const index$x = require("./api/vpcgw/index.cjs");
-const index$y = require("./api/webhosting/index.cjs");
+const index$v = require("./api/test/index.cjs");
+const index$w = require("./api/tem/index.cjs");
+const index$x = require("./api/vpc/index.cjs");
+const index$y = require("./api/vpcgw/index.cjs");
+const index$z = require("./api/webhosting/index.cjs");
 exports.enableConsoleLogger = index.enableConsoleLogger;
 exports.setLogger = index.setLogger;
 exports.createAdvancedClient = client.createAdvancedClient;
@@ -98,18 +99,19 @@ exports.IPAM = index$h;
 exports.IPFS = index$i;
 exports.Jobs = index$j;
 exports.K8S = index$k;
-exports.LB = index$l;
-exports.LLMInference = index$m;
-exports.Marketplace = index$n;
-exports.MNQ = index$o;
-exports.RDB = index$p;
-exports.Redis = index$q;
-exports.Registry = index$r;
-exports.Secret = index$s;
-exports.ServerlessSQLDB = index$t;
+exports.KeyManager = index$l;
+exports.LB = index$m;
+exports.LLMInference = index$n;
+exports.Marketplace = index$o;
+exports.MNQ = index$p;
+exports.RDB = index$q;
+exports.Redis = index$r;
+exports.Registry = index$s;
+exports.Secret = index$t;
+exports.ServerlessSQLDB = index$u;
 exports.Std = index_gen;
-exports.Test = index$u;
-exports.TransactionalEmail = index$v;
-exports.VPC = index$w;
-exports.VPCGW = index$x;
-exports.Webhosting = index$y;
+exports.Test = index$v;
+exports.TransactionalEmail = index$w;
+exports.VPC = index$x;
+exports.VPCGW = index$y;
+exports.Webhosting = index$z;

package/dist/index.js

@@ -29,21 +29,22 @@ import * as index$g from "./api/ipam/index.js";
 import * as index$h from "./api/ipfs/index.js";
 import * as index$i from "./api/jobs/index.js";
 import * as index$j from "./api/k8s/index.js";
-import * as index$k from "./api/lb/index.js";
-import * as index$l from "./api/llm_inference/index.js";
-import * as index$m from "./api/marketplace/index.js";
-import * as index$n from "./api/mnq/index.js";
-import * as index$o from "./api/rdb/index.js";
-import * as index$p from "./api/redis/index.js";
-import * as index$q from "./api/registry/index.js";
-import * as index$r from "./api/secret/index.js";
-import * as index$s from "./api/serverless_sqldb/index.js";
+import * as index$k from "./api/key_manager/index.js";
+import * as index$l from "./api/lb/index.js";
+import * as index$m from "./api/llm_inference/index.js";
+import * as index$n from "./api/marketplace/index.js";
+import * as index$o from "./api/mnq/index.js";
+import * as index$p from "./api/rdb/index.js";
+import * as index$q from "./api/redis/index.js";
+import * as index$r from "./api/registry/index.js";
+import * as index$s from "./api/secret/index.js";
+import * as index$t from "./api/serverless_sqldb/index.js";
 import * as index_gen from "./api/std/index.gen.js";
-import * as index$t from "./api/test/index.js";
-import * as index$u from "./api/tem/index.js";
-import * as index$v from "./api/vpc/index.js";
-import * as index$w from "./api/vpcgw/index.js";
-import * as index$x from "./api/webhosting/index.js";
+import * as index$u from "./api/test/index.js";
+import * as index$v from "./api/tem/index.js";
+import * as index$w from "./api/vpc/index.js";
+import * as index$x from "./api/vpcgw/index.js";
+import * as index$y from "./api/webhosting/index.js";
 export {
   API,
   index$1 as Account,
@@ -66,21 +67,22 @@ export {
   index$e as Instance,
   index$i as Jobs,
   index$j as K8S,
-  index$k as LB,
-  index$l as LLMInference,
-  index$n as MNQ,
-  index$m as Marketplace,
-  index$o as RDB,
-  index$p as Redis,
-  index$q as Registry,
-  index$r as Secret,
-  index$s as ServerlessSQLDB,
+  index$k as KeyManager,
+  index$l as LB,
+  index$m as LLMInference,
+  index$o as MNQ,
+  index$n as Marketplace,
+  index$p as RDB,
+  index$q as Redis,
+  index$r as Registry,
+  index$s as Secret,
+  index$t as ServerlessSQLDB,
   index_gen as Std,
-  index$t as Test,
-  index$u as TransactionalEmail,
-  index$v as VPC,
-  index$w as VPCGW,
-  index$x as Webhosting,
+  index$u as Test,
+  index$v as TransactionalEmail,
+  index$w as VPC,
+  index$x as VPCGW,
+  index$y as Webhosting,
   addAsyncHeaderInterceptor,
   authenticateWithSessionToken,
   createAdvancedClient,

package/dist/scw/constants.cjs

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
-const version = "v2.28.0";
+const version = "v2.30.0";
 const userAgent = `scaleway-sdk-js/${version}`;
 exports.userAgent = userAgent;
 exports.version = version;

package/dist/scw/constants.d.ts

@@ -1,2 +1,2 @@
-export declare const version = "v2.28.0";
-export declare const userAgent = "scaleway-sdk-js/v2.28.0";
+export declare const version = "v2.30.0";
+export declare const userAgent = "scaleway-sdk-js/v2.30.0";

package/dist/scw/constants.js

@@ -1,4 +1,4 @@
-const version = "v2.28.0";
+const version = "v2.30.0";
 const userAgent = `scaleway-sdk-js/${version}`;
 export {
   userAgent,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@scaleway/sdk",
-  "version": "2.29.0",
+  "version": "2.31.0",
   "license": "Apache-2.0",
   "description": "Scaleway SDK.",
   "keywords": [
@@ -39,5 +39,5 @@
   "bundledDependencies": [
     "@scaleway/random-name"
   ],
-  "gitHead": "2383bfeab75618f0d4a774d7722cbd11530e422c"
+  "gitHead": "a9fa1d2c895a7e630dc9d42513df022c3996ae50"
 }