@scaleway/sdk 2.72.0 → 2.73.0

package/dist/api/baremetal/v3/api.gen.cjs

@@ -20,11 +20,9 @@ class PrivateNetworkAPI extends api.API {
     "pl-waw-3"
   ];
   /**
-   * Add a server to a Private Network. Add an Elastic Metal server to a Private
-   * Network.
+   * Add a server to a Private Network. Add an Elastic Metal server to a Private Network.
    *
-   * @param request - The request
-   *   {@link PrivateNetworkApiAddServerPrivateNetworkRequest}
+   * @param request - The request {@link PrivateNetworkApiAddServerPrivateNetworkRequest}
    * @returns A Promise of ServerPrivateNetwork
    */
   addServerPrivateNetwork = (request) => this.client.fetch(
@@ -42,11 +40,9 @@ class PrivateNetworkAPI extends api.API {
     marshalling_gen.unmarshalServerPrivateNetwork
   );
   /**
-   * Set multiple Private Networks on a server. Configure multiple Private
-   * Networks on an Elastic Metal server.
+   * Set multiple Private Networks on a server. Configure multiple Private Networks on an Elastic Metal server.
    *
-   * @param request - The request
-   *   {@link PrivateNetworkApiSetServerPrivateNetworksRequest}
+   * @param request - The request {@link PrivateNetworkApiSetServerPrivateNetworksRequest}
    * @returns A Promise of SetServerPrivateNetworksResponse
    */
   setServerPrivateNetworks = (request) => this.client.fetch(
@@ -84,11 +80,9 @@ class PrivateNetworkAPI extends api.API {
     marshalling_gen.unmarshalListServerPrivateNetworksResponse
   );
   /**
-   * List the Private Networks of a server. List the Private Networks of an
-   * Elastic Metal server.
+   * List the Private Networks of a server. List the Private Networks of an Elastic Metal server.
    *
-   * @param request - The request
-   *   {@link PrivateNetworkApiListServerPrivateNetworksRequest}
+   * @param request - The request {@link PrivateNetworkApiListServerPrivateNetworksRequest}
    * @returns A Promise of ListServerPrivateNetworksResponse
    */
   listServerPrivateNetworks = (request = {}) => resourcePaginator.enrichForPagination(
@@ -99,8 +93,7 @@ class PrivateNetworkAPI extends api.API {
   /**
    * Delete a Private Network.
    *
-   * @param request - The request
-   *   {@link PrivateNetworkApiDeleteServerPrivateNetworkRequest}
+   * @param request - The request {@link PrivateNetworkApiDeleteServerPrivateNetworkRequest}
    */
   deleteServerPrivateNetwork = (request) => this.client.fetch({
     method: "DELETE",

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

@@ -1,35 +1,31 @@
 import { API as ParentAPI } from '@scaleway/sdk-client';
 import type { Zone as ScwZone } from '@scaleway/sdk-client';
 import type { ListServerPrivateNetworksResponse, PrivateNetworkApiAddServerPrivateNetworkRequest, PrivateNetworkApiDeleteServerPrivateNetworkRequest, PrivateNetworkApiListServerPrivateNetworksRequest, PrivateNetworkApiSetServerPrivateNetworksRequest, ServerPrivateNetwork, SetServerPrivateNetworksResponse } from './types.gen';
-/** Elastic Metal - Private Networks API. */
+/**
+ * Elastic Metal - Private Networks API.
+ */
 export declare class PrivateNetworkAPI extends ParentAPI {
     /** Lists the available zones of the API. */
     static readonly LOCALITIES: ScwZone[];
     /**
-     * Add a server to a Private Network. Add an Elastic Metal server to a Private
-     * Network.
+     * Add a server to a Private Network. Add an Elastic Metal server to a Private Network.
      *
-     * @param request - The request
-     *   {@link PrivateNetworkApiAddServerPrivateNetworkRequest}
+     * @param request - The request {@link PrivateNetworkApiAddServerPrivateNetworkRequest}
      * @returns A Promise of ServerPrivateNetwork
      */
     addServerPrivateNetwork: (request: Readonly<PrivateNetworkApiAddServerPrivateNetworkRequest>) => Promise<ServerPrivateNetwork>;
     /**
-     * Set multiple Private Networks on a server. Configure multiple Private
-     * Networks on an Elastic Metal server.
+     * Set multiple Private Networks on a server. Configure multiple Private Networks on an Elastic Metal server.
      *
-     * @param request - The request
-     *   {@link PrivateNetworkApiSetServerPrivateNetworksRequest}
+     * @param request - The request {@link PrivateNetworkApiSetServerPrivateNetworksRequest}
      * @returns A Promise of SetServerPrivateNetworksResponse
      */
     setServerPrivateNetworks: (request: Readonly<PrivateNetworkApiSetServerPrivateNetworksRequest>) => Promise<SetServerPrivateNetworksResponse>;
     protected pageOfListServerPrivateNetworks: (request?: Readonly<PrivateNetworkApiListServerPrivateNetworksRequest>) => Promise<ListServerPrivateNetworksResponse>;
     /**
-     * List the Private Networks of a server. List the Private Networks of an
-     * Elastic Metal server.
+     * List the Private Networks of a server. List the Private Networks of an Elastic Metal server.
      *
-     * @param request - The request
-     *   {@link PrivateNetworkApiListServerPrivateNetworksRequest}
+     * @param request - The request {@link PrivateNetworkApiListServerPrivateNetworksRequest}
      * @returns A Promise of ListServerPrivateNetworksResponse
      */
     listServerPrivateNetworks: (request?: Readonly<PrivateNetworkApiListServerPrivateNetworksRequest>) => Promise<ListServerPrivateNetworksResponse> & {
@@ -39,8 +35,7 @@ export declare class PrivateNetworkAPI extends ParentAPI {
     /**
      * Delete a Private Network.
      *
-     * @param request - The request
-     *   {@link PrivateNetworkApiDeleteServerPrivateNetworkRequest}
+     * @param request - The request {@link PrivateNetworkApiDeleteServerPrivateNetworkRequest}
      */
     deleteServerPrivateNetwork: (request: Readonly<PrivateNetworkApiDeleteServerPrivateNetworkRequest>) => Promise<void>;
 }

package/dist/api/baremetal/v3/api.gen.js

@@ -18,11 +18,9 @@ class PrivateNetworkAPI extends API$1 {
     "pl-waw-3"
   ];
   /**
-   * Add a server to a Private Network. Add an Elastic Metal server to a Private
-   * Network.
+   * Add a server to a Private Network. Add an Elastic Metal server to a Private Network.
    *
-   * @param request - The request
-   *   {@link PrivateNetworkApiAddServerPrivateNetworkRequest}
+   * @param request - The request {@link PrivateNetworkApiAddServerPrivateNetworkRequest}
    * @returns A Promise of ServerPrivateNetwork
    */
   addServerPrivateNetwork = (request) => this.client.fetch(
@@ -40,11 +38,9 @@ class PrivateNetworkAPI extends API$1 {
     unmarshalServerPrivateNetwork
   );
   /**
-   * Set multiple Private Networks on a server. Configure multiple Private
-   * Networks on an Elastic Metal server.
+   * Set multiple Private Networks on a server. Configure multiple Private Networks on an Elastic Metal server.
    *
-   * @param request - The request
-   *   {@link PrivateNetworkApiSetServerPrivateNetworksRequest}
+   * @param request - The request {@link PrivateNetworkApiSetServerPrivateNetworksRequest}
    * @returns A Promise of SetServerPrivateNetworksResponse
    */
   setServerPrivateNetworks = (request) => this.client.fetch(
@@ -82,11 +78,9 @@ class PrivateNetworkAPI extends API$1 {
     unmarshalListServerPrivateNetworksResponse
   );
   /**
-   * List the Private Networks of a server. List the Private Networks of an
-   * Elastic Metal server.
+   * List the Private Networks of a server. List the Private Networks of an Elastic Metal server.
    *
-   * @param request - The request
-   *   {@link PrivateNetworkApiListServerPrivateNetworksRequest}
+   * @param request - The request {@link PrivateNetworkApiListServerPrivateNetworksRequest}
    * @returns A Promise of ListServerPrivateNetworksResponse
    */
   listServerPrivateNetworks = (request = {}) => enrichForPagination(
@@ -97,8 +91,7 @@ class PrivateNetworkAPI extends API$1 {
   /**
    * Delete a Private Network.
    *
-   * @param request - The request
-   *   {@link PrivateNetworkApiDeleteServerPrivateNetworkRequest}
+   * @param request - The request {@link PrivateNetworkApiDeleteServerPrivateNetworkRequest}
    */
   deleteServerPrivateNetwork = (request) => this.client.fetch({
     method: "DELETE",

package/dist/api/baremetal/v3/types.gen.d.ts

@@ -2,23 +2,41 @@ import type { Zone as ScwZone } from '@scaleway/sdk-client';
 export type ListServerPrivateNetworksRequestOrderBy = 'created_at_asc' | 'created_at_desc' | 'updated_at_asc' | 'updated_at_desc';
 export type ServerPrivateNetworkStatus = 'unknown_status' | 'attaching' | 'attached' | 'error' | 'detaching' | 'locked';
 export interface ServerPrivateNetwork {
-    /** UUID of the Server-to-Private Network mapping. */
+    /**
+     * UUID of the Server-to-Private Network mapping.
+     */
     id: string;
-    /** Private Network Project UUID. */
+    /**
+     * Private Network Project UUID.
+     */
     projectId: string;
-    /** Server UUID. */
+    /**
+     * Server UUID.
+     */
     serverId: string;
-    /** Private Network UUID. */
+    /**
+     * Private Network UUID.
+     */
     privateNetworkId: string;
-    /** VLAN UUID associated with the Private Network. */
+    /**
+     * VLAN UUID associated with the Private Network.
+     */
     vlan?: number;
-    /** Configuration status of the Private Network. */
+    /**
+     * Configuration status of the Private Network.
+     */
     status: ServerPrivateNetworkStatus;
-    /** Private Network creation date. */
+    /**
+     * Private Network creation date.
+     */
     createdAt?: Date;
-    /** Date the Private Network was last modified. */
+    /**
+     * Date the Private Network was last modified.
+     */
     updatedAt?: Date;
-    /** IPAM IP IDs of the server, if it has any. */
+    /**
+     * IPAM IP IDs of the server, if it has any.
+     */
     ipamIpIds: string[];
 }
 export interface ListServerPrivateNetworksResponse {
@@ -26,54 +44,86 @@ export interface ListServerPrivateNetworksResponse {
     totalCount: number;
 }
 export type PrivateNetworkApiAddServerPrivateNetworkRequest = {
-    /** Zone to target. If none is passed will use default zone from the config. */
+    /**
+     * Zone to target. If none is passed will use default zone from the config.
+     */
     zone?: ScwZone;
-    /** UUID of the server. */
+    /**
+     * UUID of the server.
+     */
     serverId: string;
-    /** UUID of the Private Network. */
+    /**
+     * UUID of the Private Network.
+     */
     privateNetworkId: string;
-    /** IPAM IDs of an IPs to attach to the server. */
+    /**
+     * IPAM IDs of an IPs to attach to the server.
+     */
     ipamIpIds?: string[];
 };
 export type PrivateNetworkApiDeleteServerPrivateNetworkRequest = {
-    /** Zone to target. If none is passed will use default zone from the config. */
+    /**
+     * Zone to target. If none is passed will use default zone from the config.
+     */
     zone?: ScwZone;
-    /** UUID of the server. */
+    /**
+     * UUID of the server.
+     */
     serverId: string;
-    /** UUID of the Private Network. */
+    /**
+     * UUID of the Private Network.
+     */
     privateNetworkId: string;
 };
 export type PrivateNetworkApiListServerPrivateNetworksRequest = {
-    /** Zone to target. If none is passed will use default zone from the config. */
+    /**
+     * Zone to target. If none is passed will use default zone from the config.
+     */
     zone?: ScwZone;
-    /** Sort order for the returned Private Networks. */
+    /**
+     * Sort order for the returned Private Networks.
+     */
     orderBy?: ListServerPrivateNetworksRequestOrderBy;
-    /** Page number for the returned Private Networks. */
+    /**
+     * Page number for the returned Private Networks.
+     */
     page?: number;
-    /** Maximum number of Private Networks per page. */
+    /**
+     * Maximum number of Private Networks per page.
+     */
     pageSize?: number;
-    /** Filter Private Networks by server UUID. */
+    /**
+     * Filter Private Networks by server UUID.
+     */
     serverId?: string;
-    /** Filter Private Networks by Private Network UUID. */
+    /**
+     * Filter Private Networks by Private Network UUID.
+     */
     privateNetworkId?: string;
-    /** Filter Private Networks by organization UUID. */
+    /**
+     * Filter Private Networks by organization UUID.
+     */
     organizationId?: string;
-    /** Filter Private Networks by project UUID. */
+    /**
+     * Filter Private Networks by project UUID.
+     */
     projectId?: string;
-    /** Filter Private Networks by IPAM IP UUIDs. */
+    /**
+     * Filter Private Networks by IPAM IP UUIDs.
+     */
     ipamIpIds?: string[];
 };
 export type PrivateNetworkApiSetServerPrivateNetworksRequest = {
-    /** Zone to target. If none is passed will use default zone from the config. */
+    /**
+     * Zone to target. If none is passed will use default zone from the config.
+     */
     zone?: ScwZone;
-    /** UUID of the server. */
+    /**
+     * UUID of the server.
+     */
     serverId: string;
     /**
-     * Object where the keys are the UUIDs of Private Networks and the values are
-     * arrays of IPAM IDs representing the IPs to assign to this Elastic Metal
-     * server on the Private Network. If the array supplied for a Private Network
-     * is empty, the next available IP from the Private Network's CIDR block will
-     * automatically be used for attachment.
+     * Object where the keys are the UUIDs of Private Networks and the values are arrays of IPAM IDs representing the IPs to assign to this Elastic Metal server on the Private Network. If the array supplied for a Private Network is empty, the next available IP from the Private Network's CIDR block will automatically be used for attachment.
      */
     perPrivateNetworkIpamIpIds: Record<string, string[]>;
 };

package/dist/api/billing/v2beta1/api.gen.cjs

@@ -39,8 +39,7 @@ class API extends api.API {
     marshalling_gen.unmarshalListConsumptionsResponse
   );
   /**
-   * Get monthly consumption. Consumption allows you to retrieve your past or
-   * current consumption cost, by project or category.
+   * Get monthly consumption. Consumption allows you to retrieve your past or current consumption cost, by project or category.
    *
    * @param request - The request {@link ListConsumptionsRequest}
    * @returns A Promise of ListConsumptionsResponse
@@ -67,8 +66,7 @@ class API extends api.API {
     marshalling_gen.unmarshalListTaxesResponse
   );
   /**
-   * Get monthly consumption taxes. Consumption Tax allows you to retrieve your
-   * past or current tax charges, by project or category.
+   * 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
@@ -94,8 +92,7 @@ class API extends api.API {
     marshalling_gen.unmarshalListInvoicesResponse
   );
   /**
-   * List invoices. List all your invoices, filtering by `start_date` and
-   * `invoice_type`. Each invoice has its own ID.
+   * List invoices. List all your invoices, filtering by `start_date` and `invoice_type`. Each invoice has its own ID.
    *
    * @param request - The request {@link ListInvoicesRequest}
    * @returns A Promise of ListInvoicesResponse
@@ -165,20 +162,14 @@ class API extends api.API {
     marshalling_gen.unmarshalListDiscountsResponse
   );
   /**
-   * List discounts. List all discounts for your Organization and usable
-   * categories, products, offers, references, regions and zones where the
-   * discount can be applied. As a reseller:
-   *
-   * - If you do not specify an `organization_id` you will list the discounts
-   *   applied to your own Organization and your customers
-   * - If you indicate your `organization_id` you will list only the discounts
-   *   applied to your Organization
-   * - If you indicate `the organization_id` of one of your customers, you will
-   *   list the discounts applied to their Organization.
-   *
-   * @param request - The request {@link ListDiscountsRequest}
-   * @returns A Promise of ListDiscountsResponse
-   */
+     * List discounts. List all discounts for your Organization and usable categories, products, offers, references, regions and zones where the discount can be applied. As a reseller:
+  - If you do not specify an `organization_id` you will list the discounts applied to your own Organization and your customers
+  - If you indicate your `organization_id` you will list only the discounts applied to your Organization
+  - If you indicate `the organization_id` of one of your customers, you will list the discounts applied to their Organization.
+     *
+     * @param request - The request {@link ListDiscountsRequest}
+     * @returns A Promise of ListDiscountsResponse
+     */
   listDiscounts = (request = {}) => resourcePaginator.enrichForPagination("discounts", this.pageOfListDiscounts, request);
 }
 exports.API = API;

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

@@ -2,15 +2,13 @@ import { API as ParentAPI } from '@scaleway/sdk-client';
 import type { DownloadInvoiceRequest, ExportInvoicesRequest, GetInvoiceRequest, Invoice, ListConsumptionsRequest, ListConsumptionsResponse, ListDiscountsRequest, ListDiscountsResponse, ListInvoicesRequest, ListInvoicesResponse, ListTaxesRequest, ListTaxesResponse } from './types.gen';
 /**
  * Billing API.
- *
- * This API allows you to manage and query your Scaleway billing and
- * 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>;
     /**
-     * Get monthly consumption. Consumption allows you to retrieve your past or
-     * current consumption cost, by project or category.
+     * Get monthly consumption. Consumption allows you to retrieve your past or current consumption cost, by project or category.
      *
      * @param request - The request {@link ListConsumptionsRequest}
      * @returns A Promise of ListConsumptionsResponse
@@ -21,8 +19,7 @@ export declare class API extends ParentAPI {
     };
     protected pageOfListTaxes: (request?: Readonly<ListTaxesRequest>) => Promise<ListTaxesResponse>;
     /**
-     * Get monthly consumption taxes. Consumption Tax allows you to retrieve your
-     * past or current tax charges, by project or category.
+     * 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
@@ -33,8 +30,7 @@ export declare class API extends ParentAPI {
     };
     protected pageOfListInvoices: (request?: Readonly<ListInvoicesRequest>) => Promise<ListInvoicesResponse>;
     /**
-     * List invoices. List all your invoices, filtering by `start_date` and
-     * `invoice_type`. Each invoice has its own ID.
+     * List invoices. List all your invoices, filtering by `start_date` and `invoice_type`. Each invoice has its own ID.
      *
      * @param request - The request {@link ListInvoicesRequest}
      * @returns A Promise of ListInvoicesResponse
@@ -66,16 +62,10 @@ export declare class API extends ParentAPI {
     downloadInvoice: (request: Readonly<DownloadInvoiceRequest>) => Promise<Blob>;
     protected pageOfListDiscounts: (request?: Readonly<ListDiscountsRequest>) => Promise<ListDiscountsResponse>;
     /**
-     * List discounts. List all discounts for your Organization and usable
-     * categories, products, offers, references, regions and zones where the
-     * discount can be applied. As a reseller:
-     *
-     * - If you do not specify an `organization_id` you will list the discounts
-     *   applied to your own Organization and your customers
-     * - If you indicate your `organization_id` you will list only the discounts
-     *   applied to your Organization
-     * - If you indicate `the organization_id` of one of your customers, you will
-     *   list the discounts applied to their Organization.
+     * List discounts. List all discounts for your Organization and usable categories, products, offers, references, regions and zones where the discount can be applied. As a reseller:
+  - If you do not specify an `organization_id` you will list the discounts applied to your own Organization and your customers
+  - If you indicate your `organization_id` you will list only the discounts applied to your Organization
+  - If you indicate `the organization_id` of one of your customers, you will list the discounts applied to their Organization.
      *
      * @param request - The request {@link ListDiscountsRequest}
      * @returns A Promise of ListDiscountsResponse

package/dist/api/billing/v2beta1/api.gen.js

@@ -37,8 +37,7 @@ class API extends API$1 {
     unmarshalListConsumptionsResponse
   );
   /**
-   * Get monthly consumption. Consumption allows you to retrieve your past or
-   * current consumption cost, by project or category.
+   * Get monthly consumption. Consumption allows you to retrieve your past or current consumption cost, by project or category.
    *
    * @param request - The request {@link ListConsumptionsRequest}
    * @returns A Promise of ListConsumptionsResponse
@@ -65,8 +64,7 @@ class API extends API$1 {
     unmarshalListTaxesResponse
   );
   /**
-   * Get monthly consumption taxes. Consumption Tax allows you to retrieve your
-   * past or current tax charges, by project or category.
+   * 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
@@ -92,8 +90,7 @@ class API extends API$1 {
     unmarshalListInvoicesResponse
   );
   /**
-   * List invoices. List all your invoices, filtering by `start_date` and
-   * `invoice_type`. Each invoice has its own ID.
+   * List invoices. List all your invoices, filtering by `start_date` and `invoice_type`. Each invoice has its own ID.
    *
    * @param request - The request {@link ListInvoicesRequest}
    * @returns A Promise of ListInvoicesResponse
@@ -163,20 +160,14 @@ class API extends API$1 {
     unmarshalListDiscountsResponse
   );
   /**
-   * List discounts. List all discounts for your Organization and usable
-   * categories, products, offers, references, regions and zones where the
-   * discount can be applied. As a reseller:
-   *
-   * - If you do not specify an `organization_id` you will list the discounts
-   *   applied to your own Organization and your customers
-   * - If you indicate your `organization_id` you will list only the discounts
-   *   applied to your Organization
-   * - If you indicate `the organization_id` of one of your customers, you will
-   *   list the discounts applied to their Organization.
-   *
-   * @param request - The request {@link ListDiscountsRequest}
-   * @returns A Promise of ListDiscountsResponse
-   */
+     * List discounts. List all discounts for your Organization and usable categories, products, offers, references, regions and zones where the discount can be applied. As a reseller:
+  - If you do not specify an `organization_id` you will list the discounts applied to your own Organization and your customers
+  - If you indicate your `organization_id` you will list only the discounts applied to your Organization
+  - If you indicate `the organization_id` of one of your customers, you will list the discounts applied to their Organization.
+     *
+     * @param request - The request {@link ListDiscountsRequest}
+     * @returns A Promise of ListDiscountsResponse
+     */
   listDiscounts = (request = {}) => enrichForPagination("discounts", this.pageOfListDiscounts, request);
 }
 export {