@scaleway/sdk 2.27.0 → 2.28.0

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

@@ -3,7 +3,7 @@ import type { CreateProjectRequest, DeleteProjectRequest, GetProjectRequest, Lis
 /**
  * Account API.
  *
- * User related data. This API allows you to manage projects.
+ * This API allows you to manage your Scaleway Projects.
  */
 export declare class API extends ParentAPI {
     /**

package/dist/api/account/v3/api.gen.d.ts

@@ -3,7 +3,7 @@ import type { ListProjectsResponse, Project, ProjectApiCreateProjectRequest, Pro
 /**
  * Account API.
  *
- * This API allows you to manage projects.
+ * This API allows you to manage your Scaleway Projects.
  */
 export declare class ProjectAPI extends ParentAPI {
     /**

package/dist/api/applesilicon/v1alpha1/api.gen.d.ts

@@ -1,7 +1,11 @@
 import { API as ParentAPI } from '../../../bridge';
 import type { WaitForOptions, Zone } from '../../../bridge';
 import type { CreateServerRequest, DeleteServerRequest, GetOSRequest, GetServerRequest, GetServerTypeRequest, ListOSRequest, ListOSResponse, ListServerTypesRequest, ListServerTypesResponse, ListServersRequest, ListServersResponse, OS, RebootServerRequest, ReinstallServerRequest, Server, ServerType, UpdateServerRequest } from './types.gen';
-/** Apple silicon API. */
+/**
+ * Apple silicon API.
+ *
+ * This API allows you to manage your Apple silicon machines.
+ */
 export declare class API extends ParentAPI {
     /** Lists the available zones of the API. */
     static readonly LOCALITIES: Zone[];

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

@@ -4,7 +4,7 @@ import type { AddOptionServerRequest, BMCAccess, CreateServerRequest, DeleteOpti
 /**
  * Elastic Metal API.
  *
- * This API allows to manage your Elastic Metal server.
+ * This API allows you to manage your Elastic Metal servers.
  */
 export declare class API extends ParentAPI {
     /** Lists the available zones of the API. */

package/dist/api/billing/v2alpha1/api.gen.d.ts

@@ -3,7 +3,8 @@ import type { DownloadInvoiceRequest, GetConsumptionRequest, GetConsumptionRespo
 /**
  * Billing API.
  *
- * This API allows you to query your consumption.
+ * This API allows you to manage and query your Scaleway billing and
+ * consumption.
  */
 export declare class API extends ParentAPI {
     /**

package/dist/api/billing/v2beta1/api.gen.d.ts

@@ -3,7 +3,8 @@ import type { DownloadInvoiceRequest, ExportInvoicesRequest, GetInvoiceRequest,
 /**
  * Billing API.
  *
- * This API allows you to query your consumption.
+ * This API allows you to manage and query your Scaleway billing and
+ * consumption.
  */
 export declare class API extends ParentAPI {
     protected pageOfListConsumptions: (request?: Readonly<ListConsumptionsRequest>) => Promise<ListConsumptionsResponse>;
@@ -16,7 +17,13 @@ export declare class API extends ParentAPI {
      */
     listConsumptions: (request?: Readonly<ListConsumptionsRequest>) => Promise<ListConsumptionsResponse> & {
         all: () => Promise<import("./types.gen").ListConsumptionsResponseConsumption[]>;
-        [Symbol.asyncIterator]: () => AsyncGenerator<import("./types.gen").ListConsumptionsResponseConsumption[], void, void>;
+        [Symbol.asyncIterator]: () => AsyncGenerator<import("./types.gen").ListConsumptionsResponseConsumption[], void, void>; /**
+         * Get monthly consumption taxes. Consumption Tax allows you to retrieve your
+         * past or current tax charges, by project or category.
+         *
+         * @param request - The request {@link ListTaxesRequest}
+         * @returns A Promise of ListTaxesResponse
+         */
     };
     protected pageOfListTaxes: (request?: Readonly<ListTaxesRequest>) => Promise<ListTaxesResponse>;
     /**
@@ -28,7 +35,13 @@ export declare class API extends ParentAPI {
      */
     listTaxes: (request?: Readonly<ListTaxesRequest>) => Promise<ListTaxesResponse> & {
         all: () => Promise<import("./types.gen").ListTaxesResponseTax[]>;
-        [Symbol.asyncIterator]: () => AsyncGenerator<import("./types.gen").ListTaxesResponseTax[], void, void>;
+        [Symbol.asyncIterator]: () => AsyncGenerator<import("./types.gen").ListTaxesResponseTax[], void, void>; /**
+         * Get monthly consumption taxes. Consumption Tax allows you to retrieve your
+         * past or current tax charges, by project or category.
+         *
+         * @param request - The request {@link ListTaxesRequest}
+         * @returns A Promise of ListTaxesResponse
+         */
     };
     protected pageOfListInvoices: (request?: Readonly<ListInvoicesRequest>) => Promise<ListInvoicesResponse>;
     /**
@@ -40,7 +53,13 @@ export declare class API extends ParentAPI {
      */
     listInvoices: (request?: Readonly<ListInvoicesRequest>) => Promise<ListInvoicesResponse> & {
         all: () => Promise<Invoice[]>;
-        [Symbol.asyncIterator]: () => AsyncGenerator<Invoice[], void, void>;
+        [Symbol.asyncIterator]: () => AsyncGenerator<Invoice[], void, void>; /**
+         * Get monthly consumption taxes. Consumption Tax allows you to retrieve your
+         * past or current tax charges, by project or category.
+         *
+         * @param request - The request {@link ListTaxesRequest}
+         * @returns A Promise of ListTaxesResponse
+         */
     };
     /**
      * Export invoices. Export invoices in a CSV file.
@@ -74,6 +93,12 @@ export declare class API extends ParentAPI {
      */
     listDiscounts: (request?: Readonly<ListDiscountsRequest>) => Promise<ListDiscountsResponse> & {
         all: () => Promise<import("./types.gen").Discount[]>;
-        [Symbol.asyncIterator]: () => AsyncGenerator<import("./types.gen").Discount[], void, void>;
+        [Symbol.asyncIterator]: () => AsyncGenerator<import("./types.gen").Discount[], void, void>; /**
+         * Get monthly consumption taxes. Consumption Tax allows you to retrieve your
+         * past or current tax charges, by project or category.
+         *
+         * @param request - The request {@link ListTaxesRequest}
+         * @returns A Promise of ListTaxesResponse
+         */
     };
 }

package/dist/api/block/v1alpha1/api.gen.d.ts

@@ -4,7 +4,7 @@ import type { CreateSnapshotRequest, CreateVolumeRequest, DeleteSnapshotRequest,
 /**
  * Scaleway Block Storage API.
  *
- * This API allows you to use and manage your Block Storage volumes.
+ * This API allows you to manage your Block Storage volumes.
  */
 export declare class API extends ParentAPI {
     /** Lists the available zones of the API. */

package/dist/api/cockpit/v1beta1/api.gen.d.ts

@@ -4,9 +4,8 @@ import type { ActivateCockpitRequest, Cockpit, CockpitMetrics, ContactPoint, Cre
 /**
  * Cockpit API.
  *
- * The Cockpit API allows you to activate your Cockpit to store metrics and
- * logs. It also provides you with a dedicated Grafana for dashboarding to
- * visualize your metrics and logs.
+ * This API allows you to manage your Scaleway Cockpit, for storing and
+ * visualizing metrics and logs.
  */
 export declare class API extends ParentAPI {
     /**

package/dist/api/container/v1beta1/api.gen.d.ts

@@ -1,7 +1,11 @@
 import { API as ParentAPI } from '../../../bridge';
 import type { Region, WaitForOptions } from '../../../bridge';
 import type { Container, CreateContainerRequest, CreateCronRequest, CreateDomainRequest, CreateNamespaceRequest, CreateTokenRequest, CreateTriggerRequest, Cron, DeleteContainerRequest, DeleteCronRequest, DeleteDomainRequest, DeleteNamespaceRequest, DeleteTokenRequest, DeleteTriggerRequest, DeployContainerRequest, Domain, GetContainerRequest, GetCronRequest, GetDomainRequest, GetNamespaceRequest, GetTokenRequest, GetTriggerRequest, IssueJWTRequest, ListContainersRequest, ListContainersResponse, ListCronsRequest, ListCronsResponse, ListDomainsRequest, ListDomainsResponse, ListNamespacesRequest, ListNamespacesResponse, ListTokensRequest, ListTokensResponse, ListTriggersRequest, ListTriggersResponse, Namespace, Token, Trigger, UpdateContainerRequest, UpdateCronRequest, UpdateNamespaceRequest, UpdateTriggerRequest } from './types.gen';
-/** Serverless Containers API. */
+/**
+ * Serverless Containers API.
+ *
+ * This API allows you to manage your Serverless Containers.
+ */
 export declare class API extends ParentAPI {
     /** Lists the available regions of the API. */
     static readonly LOCALITIES: Region[];

package/dist/api/document_db/v1beta1/api.gen.d.ts

@@ -1,7 +1,11 @@
 import { API as ParentAPI } from '../../../bridge';
 import type { Region, WaitForOptions } from '../../../bridge';
 import type { AddInstanceACLRulesRequest, AddInstanceACLRulesResponse, AddInstanceSettingsRequest, AddInstanceSettingsResponse, ApplyInstanceMaintenanceRequest, CloneInstanceRequest, CreateDatabaseRequest, CreateEndpointRequest, CreateInstanceFromSnapshotRequest, CreateInstanceRequest, CreateReadReplicaEndpointRequest, CreateReadReplicaRequest, CreateSnapshotRequest, CreateUserRequest, Database, DeleteDatabaseRequest, DeleteEndpointRequest, DeleteInstanceACLRulesRequest, DeleteInstanceACLRulesResponse, DeleteInstanceRequest, DeleteInstanceSettingsRequest, DeleteInstanceSettingsResponse, DeleteReadReplicaRequest, DeleteSnapshotRequest, DeleteUserRequest, Endpoint, GetEndpointRequest, GetInstanceCertificateRequest, GetInstanceLogRequest, GetInstanceMetricsRequest, GetInstanceRequest, GetReadReplicaRequest, GetSnapshotRequest, Instance, InstanceLog, InstanceMetrics, ListDatabaseEnginesRequest, ListDatabaseEnginesResponse, ListDatabasesRequest, ListDatabasesResponse, ListInstanceACLRulesRequest, ListInstanceACLRulesResponse, ListInstanceLogsDetailsRequest, ListInstanceLogsDetailsResponse, ListInstanceLogsRequest, ListInstanceLogsResponse, ListInstancesRequest, ListInstancesResponse, ListNodeTypesRequest, ListNodeTypesResponse, ListPrivilegesRequest, ListPrivilegesResponse, ListSnapshotsRequest, ListSnapshotsResponse, ListUsersRequest, ListUsersResponse, Maintenance, MigrateEndpointRequest, Privilege, PromoteReadReplicaRequest, PurgeInstanceLogsRequest, ReadReplica, RenewInstanceCertificateRequest, ResetReadReplicaRequest, RestartInstanceRequest, SetInstanceACLRulesRequest, SetInstanceACLRulesResponse, SetInstanceSettingsRequest, SetInstanceSettingsResponse, SetPrivilegeRequest, Snapshot, UpdateInstanceRequest, UpdateSnapshotRequest, UpdateUserRequest, UpgradeInstanceRequest, User } from './types.gen';
-/** Managed Document Databases API. */
+/**
+ * Managed Document Databases API.
+ *
+ * This API allows you to manage your Document Databases.
+ */
 export declare class API extends ParentAPI {
     /** Lists the available regions of the API. */
     static readonly LOCALITIES: Region[];

package/dist/api/domain/v2beta1/api.gen.d.ts

@@ -4,7 +4,7 @@ import type { CheckContactsCompatibilityResponse, ClearDNSZoneRecordsRequest, Cl
 /**
  * Domains and DNS API.
  *
- * Manage your domains, DNS zones and records with the Domains and DNS API.
+ * This API allows you to manage your domains, DNS zones and records.
  */
 export declare class API extends ParentAPI {
     protected pageOfListDNSZones: (request: Readonly<ListDNSZonesRequest>) => Promise<ListDNSZonesResponse>;

package/dist/api/flexibleip/v1alpha1/api.gen.d.ts

@@ -1,7 +1,12 @@
 import { API as ParentAPI } from '../../../bridge';
 import type { WaitForOptions, Zone } from '../../../bridge';
 import type { AttachFlexibleIPRequest, AttachFlexibleIPsResponse, CreateFlexibleIPRequest, DeleteFlexibleIPRequest, DeleteMACAddrRequest, DetachFlexibleIPRequest, DetachFlexibleIPsResponse, DuplicateMACAddrRequest, FlexibleIP, GenerateMACAddrRequest, GetFlexibleIPRequest, ListFlexibleIPsRequest, ListFlexibleIPsResponse, MoveMACAddrRequest, UpdateFlexibleIPRequest } from './types.gen';
-/** Elastic Metal - Flexible IP API. */
+/**
+ * Elastic Metal - Flexible IP API.
+ *
+ * This API allows you to manage your Elastic Metal servers' flexible public IP
+ * addresses.
+ */
 export declare class API extends ParentAPI {
     /** Lists the available zones of the API. */
     static readonly LOCALITIES: Zone[];
@@ -38,13 +43,6 @@ export declare class API extends ParentAPI {
      * @returns A Promise of ListFlexibleIPsResponse
      */
     listFlexibleIPs: (request?: Readonly<ListFlexibleIPsRequest>) => Promise<ListFlexibleIPsResponse> & {
-        /**
-         * Waits for {@link FlexibleIP} to be in a final state.
-         *
-         * @param request - The request {@link GetFlexibleIPRequest}
-         * @param options - The waiting options
-         * @returns A Promise of FlexibleIP
-         */
         all: () => Promise<FlexibleIP[]>;
         [Symbol.asyncIterator]: () => AsyncGenerator<FlexibleIP[], void, void>;
     };

package/dist/api/function/v1beta1/api.gen.d.ts

@@ -1,7 +1,11 @@
 import { API as ParentAPI } from '../../../bridge';
 import type { Region, WaitForOptions } from '../../../bridge';
 import type { CreateCronRequest, CreateDomainRequest, CreateFunctionRequest, CreateNamespaceRequest, CreateTokenRequest, CreateTriggerRequest, Cron, DeleteCronRequest, DeleteDomainRequest, DeleteFunctionRequest, DeleteNamespaceRequest, DeleteTokenRequest, DeleteTriggerRequest, DeployFunctionRequest, Domain, DownloadURL, Function, GetCronRequest, GetDomainRequest, GetFunctionDownloadURLRequest, GetFunctionRequest, GetFunctionUploadURLRequest, GetNamespaceRequest, GetTokenRequest, GetTriggerRequest, IssueJWTRequest, ListCronsRequest, ListCronsResponse, ListDomainsRequest, ListDomainsResponse, ListFunctionRuntimesRequest, ListFunctionRuntimesResponse, ListFunctionsRequest, ListFunctionsResponse, ListNamespacesRequest, ListNamespacesResponse, ListTokensRequest, ListTokensResponse, ListTriggersRequest, ListTriggersResponse, Namespace, Token, Trigger, UpdateCronRequest, UpdateFunctionRequest, UpdateNamespaceRequest, UpdateTriggerRequest, UploadURL } from './types.gen';
-/** Serverless Functions API. */
+/**
+ * Serverless Functions API.
+ *
+ * This API allows you to manage your Serverless Functions.
+ */
 export declare class API extends ParentAPI {
     /** Lists the available regions of the API. */
     static readonly LOCALITIES: Region[];

package/dist/api/iam/v1alpha1/api.gen.d.ts

@@ -1,6 +1,11 @@
 import { API as ParentAPI } from '../../../bridge';
 import type { APIKey, AddGroupMemberRequest, AddGroupMembersRequest, Application, ClonePolicyRequest, CreateAPIKeyRequest, CreateApplicationRequest, CreateGroupRequest, CreateJWTRequest, CreatePolicyRequest, CreateSSHKeyRequest, CreateUserRequest, DeleteAPIKeyRequest, DeleteApplicationRequest, DeleteGroupRequest, DeleteJWTRequest, DeletePolicyRequest, DeleteSSHKeyRequest, DeleteUserRequest, EncodedJWT, GetAPIKeyRequest, GetApplicationRequest, GetGroupRequest, GetJWTRequest, GetLogRequest, GetPolicyRequest, GetQuotumRequest, GetSSHKeyRequest, GetUserRequest, Group, JWT, ListAPIKeysRequest, ListAPIKeysResponse, ListApplicationsRequest, ListApplicationsResponse, ListGroupsRequest, ListGroupsResponse, ListJWTsRequest, ListJWTsResponse, ListLogsRequest, ListLogsResponse, ListPermissionSetsRequest, ListPermissionSetsResponse, ListPoliciesRequest, ListPoliciesResponse, ListQuotaRequest, ListQuotaResponse, ListRulesRequest, ListRulesResponse, ListSSHKeysRequest, ListSSHKeysResponse, ListUsersRequest, ListUsersResponse, Log, Policy, Quotum, RemoveGroupMemberRequest, SSHKey, SetGroupMembersRequest, SetRulesRequest, SetRulesResponse, UpdateAPIKeyRequest, UpdateApplicationRequest, UpdateGroupRequest, UpdatePolicyRequest, UpdateSSHKeyRequest, UpdateUserRequest, User } from './types.gen';
-/** IAM API. */
+/**
+ * IAM API.
+ *
+ * This API allows you to manage Identity and Access Management (IAM) across
+ * your Scaleway Organizations, Projects and resources.
+ */
 export declare class API extends ParentAPI {
     protected pageOfListSSHKeys: (request?: Readonly<ListSSHKeysRequest>) => Promise<ListSSHKeysResponse>;
     /**

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

@@ -2,7 +2,11 @@ import { API as ParentAPI } from '../../../bridge';
 import type { Zone } from '../../../bridge';
 import type { ApplyBlockMigrationRequest, AttachServerVolumeRequest, AttachServerVolumeResponse, CreateImageRequest, CreateImageResponse, CreateIpRequest, CreateIpResponse, CreatePlacementGroupRequest, CreatePlacementGroupResponse, CreatePrivateNICRequest, CreatePrivateNICResponse, CreateSecurityGroupRequest, CreateSecurityGroupResponse, CreateSecurityGroupRuleRequest, CreateSecurityGroupRuleResponse, CreateServerRequest, CreateServerResponse, CreateSnapshotRequest, CreateSnapshotResponse, CreateVolumeRequest, CreateVolumeResponse, DeleteImageRequest, DeleteIpRequest, DeletePlacementGroupRequest, DeletePrivateNICRequest, DeleteSecurityGroupRequest, DeleteSecurityGroupRuleRequest, DeleteServerRequest, DeleteServerUserDataRequest, DeleteSnapshotRequest, DeleteVolumeRequest, DetachServerVolumeRequest, DetachServerVolumeResponse, ExportSnapshotRequest, ExportSnapshotResponse, GetBootscriptRequest, GetBootscriptResponse, GetDashboardRequest, GetDashboardResponse, GetImageRequest, GetImageResponse, GetIpRequest, GetIpResponse, GetPlacementGroupRequest, GetPlacementGroupResponse, GetPlacementGroupServersRequest, GetPlacementGroupServersResponse, GetPrivateNICRequest, GetPrivateNICResponse, GetSecurityGroupRequest, GetSecurityGroupResponse, GetSecurityGroupRuleRequest, GetSecurityGroupRuleResponse, GetServerRequest, GetServerResponse, GetServerTypesAvailabilityRequest, GetServerTypesAvailabilityResponse, GetSnapshotRequest, GetSnapshotResponse, GetVolumeRequest, GetVolumeResponse, ListBootscriptsRequest, ListBootscriptsResponse, ListDefaultSecurityGroupRulesRequest, ListImagesRequest, ListImagesResponse, ListIpsRequest, ListIpsResponse, ListPlacementGroupsRequest, ListPlacementGroupsResponse, ListPrivateNICsRequest, ListPrivateNICsResponse, ListSecurityGroupRulesRequest, ListSecurityGroupRulesResponse, ListSecurityGroupsRequest, ListSecurityGroupsResponse, ListServerActionsRequest, ListServerActionsResponse, ListServerUserDataRequest, ListServerUserDataResponse, ListServersRequest, ListServersResponse, ListServersTypesRequest, ListServersTypesResponse, ListSnapshotsRequest, ListSnapshotsResponse, ListVolumesRequest, ListVolumesResponse, ListVolumesTypesRequest, ListVolumesTypesResponse, MigrationPlan, PlanBlockMigrationRequest, PrivateNIC, ServerActionRequest, ServerActionResponse, SetImageRequest, SetPlacementGroupRequest, SetPlacementGroupResponse, SetPlacementGroupServersRequest, SetPlacementGroupServersResponse, SetSecurityGroupRulesRequest, SetSecurityGroupRulesResponse, UpdateImageRequest, UpdateImageResponse, UpdateIpRequest, UpdateIpResponse, UpdatePlacementGroupRequest, UpdatePlacementGroupResponse, UpdatePlacementGroupServersRequest, UpdatePlacementGroupServersResponse, UpdatePrivateNICRequest, UpdateSecurityGroupRequest, UpdateSecurityGroupResponse, UpdateSecurityGroupRuleRequest, UpdateSecurityGroupRuleResponse, UpdateServerRequest, UpdateServerResponse, UpdateSnapshotRequest, UpdateSnapshotResponse, UpdateVolumeRequest, UpdateVolumeResponse } from './types.gen';
 import type { SetImageResponse, SetSecurityGroupRequest, SetSecurityGroupResponse, SetSecurityGroupRuleRequest, SetSecurityGroupRuleResponse, SetServerRequest, SetServerResponse, SetSnapshotRequest, SetSnapshotResponse } from './types.private.gen';
-/** Instance API. */
+/**
+ * Instance API.
+ *
+ * This API allows you to manage your Instances.
+ */
 export declare class API extends ParentAPI {
     /** Lists the available zones of the API. */
     static readonly LOCALITIES: Zone[];

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

@@ -4,7 +4,7 @@ import type { CreateDeviceRequest, CreateDeviceResponse, CreateHubRequest, Creat
 /**
  * IoT Hub API.
  *
- * This API allows you to manage IoT hubs and devices.
+ * This API allows you to manage your IoT hubs and devices.
  */
 export declare class API extends ParentAPI {
     /** Lists the available regions of the API. */

package/dist/api/ipam/v1/api.gen.cjs

@@ -90,10 +90,12 @@ class API extends api.API {
         ["resource_name", request.resourceName],
         ["resource_type", request.resourceType],
         ["tags", request.tags],
+        ["vpc_id", request.vpcId],
         ...Object.entries(
           marshalling.resolveOneOf([
             { param: "zonal", value: request.zonal },
-            { param: "private_network_id", value: request.privateNetworkId }
+            { param: "private_network_id", value: request.privateNetworkId },
+            { param: "subnet_id", value: request.subnetId }
           ])
         )
       )

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

@@ -4,7 +4,7 @@ import type { BookIPRequest, GetIPRequest, IP, ListIPsRequest, ListIPsResponse,
 /**
  * IPAM API.
  *
- * This API allows you to manage IP addresses with Scaleway's IP Address
+ * This API allows you to manage your Scaleway IP addresses with our IP Address
  * Management tool.
  */
 export declare class API extends ParentAPI {

package/dist/api/ipam/v1/api.gen.js

@@ -88,10 +88,12 @@ class API extends API$1 {
         ["resource_name", request.resourceName],
         ["resource_type", request.resourceType],
         ["tags", request.tags],
+        ["vpc_id", request.vpcId],
         ...Object.entries(
           resolveOneOf([
             { param: "zonal", value: request.zonal },
-            { param: "private_network_id", value: request.privateNetworkId }
+            { param: "private_network_id", value: request.privateNetworkId },
+            { param: "subnet_id", value: request.subnetId }
           ])
         )
       )

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

@@ -123,15 +123,26 @@ export type ListIPsRequest = {
      * Zone to filter for. Only IPs that are zonal, and in this zone, will be
      * returned.
      *
-     * One-of ('source'): at most one of 'zonal', 'privateNetworkId' could be set.
+     * One-of ('source'): at most one of 'zonal', 'privateNetworkId', 'subnetId'
+     * could be set.
      */
     zonal?: string;
     /**
      * Only IPs that are private, and in this Private Network, will be returned.
      *
-     * One-of ('source'): at most one of 'zonal', 'privateNetworkId' could be set.
+     * One-of ('source'): at most one of 'zonal', 'privateNetworkId', 'subnetId'
+     * could be set.
      */
     privateNetworkId?: string;
+    /**
+     * Only IPs inside this exact subnet will be returned.
+     *
+     * One-of ('source'): at most one of 'zonal', 'privateNetworkId', 'subnetId'
+     * could be set.
+     */
+    subnetId?: string;
+    /** Only IPs owned by resources in this VPC will be returned. */
+    vpcId?: string;
     /** Defines whether to filter only for IPs which are attached to a resource. */
     attached?: boolean;
     /**

package/dist/api/jobs/v1alpha1/api.gen.d.ts

@@ -1,7 +1,11 @@
 import { API as ParentAPI } from '../../../bridge';
 import type { Region } from '../../../bridge';
 import type { CreateJobDefinitionRequest, DeleteJobDefinitionRequest, GetJobDefinitionRequest, GetJobRunRequest, JobDefinition, JobRun, ListJobDefinitionsRequest, ListJobDefinitionsResponse, ListJobRunsRequest, ListJobRunsResponse, StartJobDefinitionRequest, StartJobDefinitionResponse, StopJobRunRequest, UpdateJobDefinitionRequest } from './types.gen';
-/** Serverless Jobs API. */
+/**
+ * Serverless Jobs API.
+ *
+ * This API allows you to manage your Serverless Jobs.
+ */
 export declare class API extends ParentAPI {
     /** Lists the available regions of the API. */
     static readonly LOCALITIES: Region[];

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

@@ -1,7 +1,11 @@
 import { API as ParentAPI } from '../../../bridge';
 import type { Region, WaitForOptions } from '../../../bridge';
 import type { Cluster, CreateClusterRequest, CreateExternalNodeRequest, CreatePoolRequest, DeleteClusterRequest, DeleteNodeRequest, DeletePoolRequest, ExternalNode, GetClusterKubeConfigRequest, GetClusterRequest, GetNodeRequest, GetPoolRequest, GetVersionRequest, ListClusterAvailableTypesRequest, ListClusterAvailableTypesResponse, ListClusterAvailableVersionsRequest, ListClusterAvailableVersionsResponse, ListClusterTypesRequest, ListClusterTypesResponse, ListClustersRequest, ListClustersResponse, ListNodesRequest, ListNodesResponse, ListPoolsRequest, ListPoolsResponse, ListVersionsRequest, ListVersionsResponse, MigrateClusterToRoutedIPsRequest, MigrateToPrivateNetworkClusterRequest, Node, Pool, RebootNodeRequest, ReplaceNodeRequest, ResetClusterAdminTokenRequest, SetClusterTypeRequest, UpdateClusterRequest, UpdatePoolRequest, UpgradeClusterRequest, UpgradePoolRequest, Version } from './types.gen';
-/** Kubernetes API. */
+/**
+ * Kubernetes API.
+ *
+ * This API allows you to manage Kubernetes Kapsule and Kosmos clusters.
+ */
 export declare class API extends ParentAPI {
     /** Lists the available regions of the API. */
     static readonly LOCALITIES: Region[];

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

@@ -558,7 +558,7 @@ export declare class ZonedAPI extends ParentAPI {
 /**
  * Load balancer API.
  *
- * This API allows you to manage your load balancer service.
+ * This API allows you to manage your Load Balancers.
  */
 export declare class API extends ParentAPI {
     /** Lists the available regions of the API. */

package/dist/api/llm_inference/v1beta1/api.gen.d.ts

@@ -1,7 +1,11 @@
 import { API as ParentAPI } from '../../../bridge';
 import type { Region, WaitForOptions } from '../../../bridge';
 import type { AddDeploymentACLRulesRequest, AddDeploymentACLRulesResponse, CreateDeploymentRequest, CreateEndpointRequest, DeleteDeploymentACLRuleRequest, DeleteDeploymentRequest, DeleteEndpointRequest, Deployment, Endpoint, Eula, GetDeploymentCertificateRequest, GetDeploymentRequest, GetModelEulaRequest, GetModelRequest, ListDeploymentACLRulesRequest, ListDeploymentACLRulesResponse, ListDeploymentsRequest, ListDeploymentsResponse, ListModelsRequest, ListModelsResponse, ListNodeTypesRequest, ListNodeTypesResponse, Model, SetDeploymentACLRulesRequest, SetDeploymentACLRulesResponse, UpdateDeploymentRequest, UpdateEndpointRequest } from './types.gen';
-/** LLM Inference API. */
+/**
+ * LLM Inference API.
+ *
+ * This API allows you to manage your LLM Inference services.
+ */
 export declare class API extends ParentAPI {
     /** Lists the available regions of the API. */
     static readonly LOCALITIES: Region[];

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

@@ -1,6 +1,11 @@
 import { API as ParentAPI } from '../../../bridge';
 import type { Category, GetCategoryRequest, GetImageRequest, GetLocalImageRequest, GetVersionRequest, Image, ListCategoriesRequest, ListCategoriesResponse, ListImagesRequest, ListImagesResponse, ListLocalImagesRequest, ListLocalImagesResponse, ListVersionsRequest, ListVersionsResponse, LocalImage, Version } from './types.gen';
-/** Marketplace API. */
+/**
+ * Marketplace API.
+ *
+ * This API allows you to find available images for use when launching a
+ * Scaleway Instance.
+ */
 export declare class API extends ParentAPI {
     protected pageOfListImages: (request: Readonly<ListImagesRequest>) => Promise<ListImagesResponse>;
     /**

package/dist/api/mnq/v1beta1/api.gen.d.ts

@@ -4,7 +4,7 @@ import type { ListNatsAccountsResponse, ListNatsCredentialsResponse, ListSnsCred
 /**
  * Messaging and Queuing NATS API.
  *
- * This API allows you to manage Scaleway Messaging and Queueing NATS accounts.
+ * This API allows you to manage Scaleway Messaging and Queuing NATS accounts.
  */
 export declare class NatsAPI extends ParentAPI {
     /** Lists the available regions of the API. */
@@ -101,7 +101,8 @@ export declare class NatsAPI extends ParentAPI {
 /**
  * Messaging and Queuing SNS API.
  *
- * This API allows you to manage Scaleway Messaging and Queueing SNS brokers.
+ * This API allows you to manage your Scaleway Messaging and Queuing SNS
+ * brokers.
  */
 export declare class SnsAPI extends ParentAPI {
     /** Lists the available regions of the API. */
@@ -183,7 +184,8 @@ export declare class SnsAPI extends ParentAPI {
 /**
  * Messaging and Queuing SQS API.
  *
- * This API allows you to manage Scaleway Messaging and Queueing SQS brokers.
+ * This API allows you to manage your Scaleway Messaging and Queuing SQS
+ * brokers.
  */
 export declare class SqsAPI extends ParentAPI {
     /** Lists the available regions of the API. */

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

@@ -1,7 +1,12 @@
 import { API as ParentAPI } from '../../../bridge';
 import type { Region, WaitForOptions } from '../../../bridge';
 import type { AddInstanceACLRulesRequest, AddInstanceACLRulesResponse, AddInstanceSettingsRequest, AddInstanceSettingsResponse, ApplyInstanceMaintenanceRequest, CloneInstanceRequest, CreateDatabaseBackupRequest, CreateDatabaseRequest, CreateEndpointRequest, CreateInstanceFromSnapshotRequest, CreateInstanceRequest, CreateReadReplicaEndpointRequest, CreateReadReplicaRequest, CreateSnapshotRequest, CreateUserRequest, Database, DatabaseBackup, DeleteDatabaseBackupRequest, DeleteDatabaseRequest, DeleteEndpointRequest, DeleteInstanceACLRulesRequest, DeleteInstanceACLRulesResponse, DeleteInstanceRequest, DeleteInstanceSettingsRequest, DeleteInstanceSettingsResponse, DeleteReadReplicaRequest, DeleteSnapshotRequest, DeleteUserRequest, Endpoint, ExportDatabaseBackupRequest, GetDatabaseBackupRequest, GetEndpointRequest, GetInstanceCertificateRequest, GetInstanceLogRequest, GetInstanceMetricsRequest, GetInstanceRequest, GetReadReplicaRequest, GetSnapshotRequest, Instance, InstanceLog, InstanceMetrics, ListDatabaseBackupsRequest, ListDatabaseBackupsResponse, ListDatabaseEnginesRequest, ListDatabaseEnginesResponse, ListDatabasesRequest, ListDatabasesResponse, ListInstanceACLRulesRequest, ListInstanceACLRulesResponse, ListInstanceLogsDetailsRequest, ListInstanceLogsDetailsResponse, ListInstanceLogsRequest, ListInstanceLogsResponse, ListInstancesRequest, ListInstancesResponse, ListNodeTypesRequest, ListNodeTypesResponse, ListPrivilegesRequest, ListPrivilegesResponse, ListSnapshotsRequest, ListSnapshotsResponse, ListUsersRequest, ListUsersResponse, Maintenance, MigrateEndpointRequest, PrepareInstanceLogsRequest, PrepareInstanceLogsResponse, Privilege, PromoteReadReplicaRequest, PurgeInstanceLogsRequest, ReadReplica, RenewInstanceCertificateRequest, ResetReadReplicaRequest, RestartInstanceRequest, RestoreDatabaseBackupRequest, SetInstanceACLRulesRequest, SetInstanceACLRulesResponse, SetInstanceSettingsRequest, SetInstanceSettingsResponse, SetPrivilegeRequest, Snapshot, UpdateDatabaseBackupRequest, UpdateInstanceRequest, UpdateSnapshotRequest, UpdateUserRequest, UpgradeInstanceRequest, User } from './types.gen';
-/** Managed Database for PostgreSQL and MySQL API. */
+/**
+ * Managed Database for PostgreSQL and MySQL API.
+ *
+ * This API allows you to manage your Managed Databases for PostgreSQL and
+ * MySQL.
+ */
 export declare class API extends ParentAPI {
     /** Lists the available regions of the API. */
     static readonly LOCALITIES: Region[];

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

@@ -1,7 +1,11 @@
 import { API as ParentAPI } from '../../../bridge';
 import type { WaitForOptions, Zone } from '../../../bridge';
 import type { ACLRule, AddAclRulesRequest, AddAclRulesResponse, AddClusterSettingsRequest, AddEndpointsRequest, AddEndpointsResponse, Cluster, ClusterMetricsResponse, ClusterSettingsResponse, CreateClusterRequest, DeleteAclRuleRequest, DeleteClusterRequest, DeleteClusterSettingRequest, DeleteEndpointRequest, Endpoint, GetAclRuleRequest, GetClusterCertificateRequest, GetClusterMetricsRequest, GetClusterRequest, GetEndpointRequest, ListClusterVersionsRequest, ListClusterVersionsResponse, ListClustersRequest, ListClustersResponse, ListNodeTypesRequest, ListNodeTypesResponse, MigrateClusterRequest, RenewClusterCertificateRequest, SetAclRulesRequest, SetAclRulesResponse, SetClusterSettingsRequest, SetEndpointsRequest, SetEndpointsResponse, UpdateClusterRequest, UpdateEndpointRequest } from './types.gen';
-/** Managed Database for Redis™ API. */
+/**
+ * Managed Database for Redis™ API.
+ *
+ * This API allows you to manage your Managed Databases for Redis™.
+ */
 export declare class API extends ParentAPI {
     /** Lists the available zones of the API. */
     static readonly LOCALITIES: Zone[];

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

@@ -1,7 +1,11 @@
 import { API as ParentAPI } from '../../../bridge';
 import type { Region, WaitForOptions } from '../../../bridge';
 import type { CreateNamespaceRequest, DeleteImageRequest, DeleteNamespaceRequest, DeleteTagRequest, GetImageRequest, GetNamespaceRequest, GetTagRequest, Image, ListImagesRequest, ListImagesResponse, ListNamespacesRequest, ListNamespacesResponse, ListTagsRequest, ListTagsResponse, Namespace, Tag, UpdateImageRequest, UpdateNamespaceRequest } from './types.gen';
-/** Container Registry API. */
+/**
+ * Container Registry API.
+ *
+ * This API allows you to manage your Container Registry resources.
+ */
 export declare class API extends ParentAPI {
     /** Lists the available regions of the API. */
     static readonly LOCALITIES: Region[];

package/dist/api/secret/v1alpha1/api.gen.d.ts

@@ -4,8 +4,9 @@ import type { AccessSecretVersionByNameRequest, AccessSecretVersionRequest, Acce
 /**
  * Secret Manager API.
  *
- * Secret Manager API. This API allows you to conveniently store, access and
- * share sensitive data.
+ * This API allows you to manage your Secret Manager services, for storing,
+ * accessing and sharing sensitive data such as passwords, API keys and
+ * certificates.
  */
 export declare class API extends ParentAPI {
     /** Lists the available regions of the API. */

package/dist/api/secret/v1beta1/api.gen.d.ts

@@ -4,8 +4,9 @@ import type { AccessSecretVersionByPathRequest, AccessSecretVersionRequest, Acce
 /**
  * Secret Manager API.
  *
- * This API allows you to conveniently store, access and share sensitive data
- * such as passwords, API keys and certificates.
+ * This API allows you to manage your Secret Manager services, for storing,
+ * accessing and sharing sensitive data such as passwords, API keys and
+ * certificates.
  */
 export declare class API extends ParentAPI {
     /** Lists the available regions of the API. */

package/dist/api/serverless_sqldb/v1alpha1/api.gen.d.ts

@@ -4,7 +4,7 @@ import type { CreateDatabaseRequest, Database, DatabaseBackup, DeleteDatabaseReq
 /**
  * Serverless SQL Databases API.
  *
- * This API allows you to manage your Serverless SQL DB databases.
+ * This API allows you to manage your Serverless SQL Databases.
  */
 export declare class API extends ParentAPI {
     /** Lists the available regions of the API. */

package/dist/api/tem/v1alpha1/api.gen.d.ts

@@ -1,7 +1,11 @@
 import { API as ParentAPI } from '../../../bridge';
 import type { Region, WaitForOptions } from '../../../bridge';
 import type { CancelEmailRequest, CheckDomainRequest, CreateDomainRequest, CreateEmailRequest, CreateEmailResponse, Domain, DomainLastStatus, Email, GetDomainLastStatusRequest, GetDomainRequest, GetEmailRequest, GetStatisticsRequest, ListDomainsRequest, ListDomainsResponse, ListEmailsRequest, ListEmailsResponse, RevokeDomainRequest, Statistics } from './types.gen';
-/** Transactional Email API. */
+/**
+ * Transactional Email API.
+ *
+ * This API allows you to manage your Transactional Email services.
+ */
 export declare class API extends ParentAPI {
     /** Lists the available regions of the API. */
     static readonly LOCALITIES: Region[];

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

@@ -1,7 +1,12 @@
 import { API as ParentAPI } from '../../../bridge';
 import type { Zone } from '../../../bridge';
 import type { CreatePrivateNetworkRequest, DeletePrivateNetworkRequest, GetPrivateNetworkRequest, ListPrivateNetworksRequest, ListPrivateNetworksResponse, PrivateNetwork, UpdatePrivateNetworkRequest } from './types.gen';
-/** VPC API. */
+/**
+ * VPC API.
+ *
+ * This API allows you to manage your Virtual Private Clouds (VPCs) and Private
+ * Networks.
+ */
 export declare class API extends ParentAPI {
     /** Lists the available zones of the API. */
     static readonly LOCALITIES: Zone[];

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

@@ -1,7 +1,12 @@
 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';
-/** VPC API. */
+/**
+ * VPC API.
+ *
+ * This API allows you to manage your Virtual Private Clouds (VPCs) and Private
+ * Networks.
+ */
 export declare class API extends ParentAPI {
     /** Lists the available regions of the API. */
     static readonly LOCALITIES: Region[];

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

@@ -1,7 +1,11 @@
 import { API as ParentAPI } from '../../../bridge';
 import type { WaitForOptions, Zone } from '../../../bridge';
 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, PATRule, RefreshSSHKeysRequest, SetDHCPEntriesRequest, SetDHCPEntriesResponse, SetPATRulesRequest, SetPATRulesResponse, UpdateDHCPEntryRequest, UpdateDHCPRequest, UpdateGatewayNetworkRequest, UpdateGatewayRequest, UpdateIPRequest, UpdatePATRuleRequest, UpgradeGatewayRequest } from './types.gen';
-/** Public Gateways API. */
+/**
+ * Public Gateways API.
+ *
+ * This API allows you to manage your Public Gateways.
+ */
 export declare class API extends ParentAPI {
     /** Lists the available zones of the API. */
     static readonly LOCALITIES: Zone[];

package/dist/api/webhosting/v1alpha1/api.gen.d.ts

@@ -1,7 +1,11 @@
 import { API as ParentAPI } from '../../../bridge';
 import type { Region, WaitForOptions } from '../../../bridge';
 import type { CreateHostingRequest, CreateSessionRequest, DeleteHostingRequest, DnsRecords, GetDomainDnsRecordsRequest, GetHostingRequest, Hosting, ListControlPanelsRequest, ListControlPanelsResponse, ListHostingsRequest, ListHostingsResponse, ListOffersRequest, ListOffersResponse, ResetHostingPasswordRequest, ResetHostingPasswordResponse, RestoreHostingRequest, Session, UpdateHostingRequest } from './types.gen';
-/** Web Hosting API. */
+/**
+ * Web Hosting API.
+ *
+ * This API allows you to manage your Web Hosting services.
+ */
 export declare class API extends ParentAPI {
     /** Lists the available regions of the API. */
     static readonly LOCALITIES: Region[];

package/dist/scw/constants.cjs

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
-const version = "v2.26.0";
+const version = "v2.27.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.26.0";
-export declare const userAgent = "scaleway-sdk-js/v2.26.0";
+export declare const version = "v2.27.0";
+export declare const userAgent = "scaleway-sdk-js/v2.27.0";

package/dist/scw/constants.js

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

package/dist/scw/custom-types.d.ts

@@ -0,0 +1,65 @@
+/**
+ * Represents API metadata.
+ *
+ * @remarks These metadata are only here for debugging. Do not rely on these values.
+ *
+ * @internal
+ */
+export interface ServiceInfo {
+    /** Name of the API */
+    name: string;
+    /** Human readable description for the API. */
+    description: string;
+    /** Version of the API. */
+    version: string;
+    /** Web url where the documentation of the API can be found. */
+    documentationUrl?: string;
+}
+/**
+ * Represents an amount of money with its currency type.
+ */
+export interface Money {
+    /** 3-letter currency code defined in ISO 4217. */
+    currencyCode: string;
+    /**
+     * Whole units of the amount.
+     *
+     * For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
+     */
+    units: number;
+    /**
+     * Number of nano (10^-9) units of the amount.
+     *
+     * The value must be between -999,999,999 and +999,999,999 inclusive.
+     * If `units` is positive, `nanos` must be positive or zero.
+     * If `units` is zero, `nanos` can be positive, zero, or negative.
+     * If `units` is negative, `nanos` must be negative or zero.
+     * For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
+     */
+    nanos: number;
+}
+/** Represents a point in a TimeSeries. */
+export interface TimeSeriesPoint {
+    /** Date of the point. */
+    timestamp?: Date;
+    /** Value of the point. */
+    value: number;
+}
+/** Represents a time series that could be used for graph purposes. */
+export interface TimeSeries {
+    /** Name of the metric. */
+    name: string;
+    /** Points contains all the points that composed the series. */
+    points: TimeSeriesPoint[];
+    /** Metadata contains some string metadata related to a metric. */
+    metadata: Record<string, string>;
+}
+/** Represents a Scaleway file. */
+export interface ScwFile {
+    /** Name of the file. */
+    name: string;
+    /** Content-type of the file. */
+    contentType: string;
+    /** Content of the file in base64. */
+    content: string;
+}

package/dist/scw/errors/scw-error-from-json.d.ts

@@ -0,0 +1,10 @@
+import type { JSONObject } from '../../helpers/json';
+import type { ScalewayError } from './scw-error';
+/**
+ * Interface with static method that initialize {@link ScalewayError} from JSON.
+ *
+ * @internal
+ */
+export interface ScalewayErrorFromJSONInitializer {
+    fromJSON(status: number, obj: Readonly<JSONObject>): ScalewayError | null;
+}

package/dist/scw/fetch/types.d.ts

@@ -0,0 +1,16 @@
+/** Scaleway Request. */
+export type ScwRequest = {
+    method: 'GET' | 'POST' | 'PUT' | 'DELETE' | 'PATCH';
+    path: string;
+    headers?: Record<string, string>;
+    body?: string;
+    urlParams?: URLSearchParams;
+    responseType?: 'json' | 'text' | 'blob';
+};
+/**
+ * A factory to unmarshal a response.
+ *
+ * @param obj - The input object.
+ * @returns The output object
+ */
+export type ResponseUnmarshaller<T> = (obj: unknown) => T;

package/dist/scw/locality.d.ts

@@ -0,0 +1,2 @@
+export type Region = 'fr-par' | 'nl-ams' | 'pl-waw' | (string & {});
+export type Zone = 'fr-par-1' | 'fr-par-2' | 'fr-par-3' | 'nl-ams-1' | 'nl-ams-2' | 'nl-ams-3' | 'pl-waw-1' | 'pl-waw-2' | (string & {});

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@scaleway/sdk",
-  "version": "2.27.0",
+  "version": "2.28.0",
   "license": "Apache-2.0",
   "description": "Scaleway SDK.",
   "keywords": [
@@ -39,5 +39,5 @@
   "bundledDependencies": [
     "@scaleway/random-name"
   ],
-  "gitHead": "454991493a602594b9a252adc2329bd3a25f5023"
+  "gitHead": "a7d80e98eaa7977ce6ac697f3003823972f5c52f"
 }