@scaleway/sdk 2.73.0 → 2.74.0

package/dist/api/product_catalog/v2alpha1/marshalling.gen.js

@@ -0,0 +1,230 @@
+import "../../../client/dist/internal/logger/index.js";
+import { isJSONObject } from "../../../client/dist/helpers/json.js";
+import { unmarshalMoney } from "../../../client/dist/scw/custom-marshalling.js";
+import { unmarshalArrayOfObject } from "../../../client/dist/helpers/marshalling.js";
+const unmarshalPublicCatalogProductPropertiesHardwareCPUPhysical = (data) => {
+  if (!isJSONObject(data)) {
+    throw new TypeError(
+      `Unmarshalling the type 'PublicCatalogProductPropertiesHardwareCPUPhysical' failed as data isn't a dictionary.`
+    );
+  }
+  return {
+    benchmark: data.benchmark,
+    coresPerSocket: data.cores_per_socket,
+    frequency: data.frequency,
+    sockets: data.sockets,
+    threadsPerCore: data.threads_per_core
+  };
+};
+const unmarshalPublicCatalogProductPropertiesHardwareCPUVirtual = (data) => {
+  if (!isJSONObject(data)) {
+    throw new TypeError(
+      `Unmarshalling the type 'PublicCatalogProductPropertiesHardwareCPUVirtual' failed as data isn't a dictionary.`
+    );
+  }
+  return {
+    count: data.count
+  };
+};
+const unmarshalPublicCatalogProductPropertiesHardwareCPU = (data) => {
+  if (!isJSONObject(data)) {
+    throw new TypeError(
+      `Unmarshalling the type 'PublicCatalogProductPropertiesHardwareCPU' failed as data isn't a dictionary.`
+    );
+  }
+  return {
+    arch: data.arch,
+    description: data.description,
+    physical: data.physical ? unmarshalPublicCatalogProductPropertiesHardwareCPUPhysical(
+      data.physical
+    ) : void 0,
+    threads: data.threads,
+    type: data.type,
+    virtual: data.virtual ? unmarshalPublicCatalogProductPropertiesHardwareCPUVirtual(data.virtual) : void 0
+  };
+};
+const unmarshalPublicCatalogProductPropertiesHardwareGPU = (data) => {
+  if (!isJSONObject(data)) {
+    throw new TypeError(
+      `Unmarshalling the type 'PublicCatalogProductPropertiesHardwareGPU' failed as data isn't a dictionary.`
+    );
+  }
+  return {
+    count: data.count,
+    description: data.description,
+    type: data.type
+  };
+};
+const unmarshalPublicCatalogProductPropertiesHardwareNetwork = (data) => {
+  if (!isJSONObject(data)) {
+    throw new TypeError(
+      `Unmarshalling the type 'PublicCatalogProductPropertiesHardwareNetwork' failed as data isn't a dictionary.`
+    );
+  }
+  return {
+    description: data.description,
+    internalBandwidth: data.internal_bandwidth,
+    maxPublicBandwidth: data.max_public_bandwidth,
+    publicBandwidth: data.public_bandwidth
+  };
+};
+const unmarshalPublicCatalogProductPropertiesHardwareRAM = (data) => {
+  if (!isJSONObject(data)) {
+    throw new TypeError(
+      `Unmarshalling the type 'PublicCatalogProductPropertiesHardwareRAM' failed as data isn't a dictionary.`
+    );
+  }
+  return {
+    description: data.description,
+    size: data.size,
+    type: data.type
+  };
+};
+const unmarshalPublicCatalogProductPropertiesHardwareStorage = (data) => {
+  if (!isJSONObject(data)) {
+    throw new TypeError(
+      `Unmarshalling the type 'PublicCatalogProductPropertiesHardwareStorage' failed as data isn't a dictionary.`
+    );
+  }
+  return {
+    description: data.description,
+    total: data.total
+  };
+};
+const unmarshalPublicCatalogProductPriceUnitOfMeasure = (data) => {
+  if (!isJSONObject(data)) {
+    throw new TypeError(
+      `Unmarshalling the type 'PublicCatalogProductPriceUnitOfMeasure' failed as data isn't a dictionary.`
+    );
+  }
+  return {
+    size: data.size,
+    unit: data.unit
+  };
+};
+const unmarshalPublicCatalogProductPropertiesAppleSilicon = (data) => {
+  if (!isJSONObject(data)) {
+    throw new TypeError(
+      `Unmarshalling the type 'PublicCatalogProductPropertiesAppleSilicon' failed as data isn't a dictionary.`
+    );
+  }
+  return {
+    range: data.range
+  };
+};
+const unmarshalPublicCatalogProductPropertiesDedibox = (data) => {
+  if (!isJSONObject(data)) {
+    throw new TypeError(
+      `Unmarshalling the type 'PublicCatalogProductPropertiesDedibox' failed as data isn't a dictionary.`
+    );
+  }
+  return {
+    range: data.range
+  };
+};
+const unmarshalPublicCatalogProductPropertiesElasticMetal = (data) => {
+  if (!isJSONObject(data)) {
+    throw new TypeError(
+      `Unmarshalling the type 'PublicCatalogProductPropertiesElasticMetal' failed as data isn't a dictionary.`
+    );
+  }
+  return {
+    range: data.range
+  };
+};
+const unmarshalPublicCatalogProductPropertiesHardware = (data) => {
+  if (!isJSONObject(data)) {
+    throw new TypeError(
+      `Unmarshalling the type 'PublicCatalogProductPropertiesHardware' failed as data isn't a dictionary.`
+    );
+  }
+  return {
+    cpu: data.cpu ? unmarshalPublicCatalogProductPropertiesHardwareCPU(data.cpu) : void 0,
+    gpu: data.gpu ? unmarshalPublicCatalogProductPropertiesHardwareGPU(data.gpu) : void 0,
+    network: data.network ? unmarshalPublicCatalogProductPropertiesHardwareNetwork(data.network) : void 0,
+    ram: data.ram ? unmarshalPublicCatalogProductPropertiesHardwareRAM(data.ram) : void 0,
+    storage: data.storage ? unmarshalPublicCatalogProductPropertiesHardwareStorage(data.storage) : void 0
+  };
+};
+const unmarshalPublicCatalogProductPropertiesInstance = (data) => {
+  if (!isJSONObject(data)) {
+    throw new TypeError(
+      `Unmarshalling the type 'PublicCatalogProductPropertiesInstance' failed as data isn't a dictionary.`
+    );
+  }
+  return {
+    range: data.range
+  };
+};
+const unmarshalPublicCatalogProductLocality = (data) => {
+  if (!isJSONObject(data)) {
+    throw new TypeError(
+      `Unmarshalling the type 'PublicCatalogProductLocality' failed as data isn't a dictionary.`
+    );
+  }
+  return {
+    datacenter: data.datacenter,
+    global: data.global,
+    region: data.region,
+    zone: data.zone
+  };
+};
+const unmarshalPublicCatalogProductPrice = (data) => {
+  if (!isJSONObject(data)) {
+    throw new TypeError(
+      `Unmarshalling the type 'PublicCatalogProductPrice' failed as data isn't a dictionary.`
+    );
+  }
+  return {
+    retailPrice: data.retail_price ? unmarshalMoney(data.retail_price) : void 0,
+    unitOfMeasure: data.unit_of_measure ? unmarshalPublicCatalogProductPriceUnitOfMeasure(data.unit_of_measure) : void 0
+  };
+};
+const unmarshalPublicCatalogProductProperties = (data) => {
+  if (!isJSONObject(data)) {
+    throw new TypeError(
+      `Unmarshalling the type 'PublicCatalogProductProperties' failed as data isn't a dictionary.`
+    );
+  }
+  return {
+    appleSilicon: data.apple_silicon ? unmarshalPublicCatalogProductPropertiesAppleSilicon(data.apple_silicon) : void 0,
+    dedibox: data.dedibox ? unmarshalPublicCatalogProductPropertiesDedibox(data.dedibox) : void 0,
+    elasticMetal: data.elastic_metal ? unmarshalPublicCatalogProductPropertiesElasticMetal(data.elastic_metal) : void 0,
+    hardware: data.hardware ? unmarshalPublicCatalogProductPropertiesHardware(data.hardware) : void 0,
+    instance: data.instance ? unmarshalPublicCatalogProductPropertiesInstance(data.instance) : void 0
+  };
+};
+const unmarshalPublicCatalogProduct = (data) => {
+  if (!isJSONObject(data)) {
+    throw new TypeError(
+      `Unmarshalling the type 'PublicCatalogProduct' failed as data isn't a dictionary.`
+    );
+  }
+  return {
+    description: data.description,
+    locality: data.locality ? unmarshalPublicCatalogProductLocality(data.locality) : void 0,
+    price: data.price ? unmarshalPublicCatalogProductPrice(data.price) : void 0,
+    product: data.product,
+    properties: data.properties ? unmarshalPublicCatalogProductProperties(data.properties) : void 0,
+    serviceCategory: data.service_category,
+    sku: data.sku,
+    variant: data.variant
+  };
+};
+const unmarshalListPublicCatalogProductsResponse = (data) => {
+  if (!isJSONObject(data)) {
+    throw new TypeError(
+      `Unmarshalling the type 'ListPublicCatalogProductsResponse' failed as data isn't a dictionary.`
+    );
+  }
+  return {
+    products: unmarshalArrayOfObject(
+      data.products,
+      unmarshalPublicCatalogProduct
+    ),
+    totalCount: data.total_count
+  };
+};
+export {
+  unmarshalListPublicCatalogProductsResponse
+};

package/dist/api/product_catalog/v2alpha1/types.gen.d.ts

@@ -0,0 +1,293 @@
+import type { Money, Region as ScwRegion, Zone as ScwZone } from '@scaleway/sdk-client';
+export type PublicCatalogProductPriceUnitOfMeasureCountableUnit = 'unknown_countable_unit' | 'chunk' | 'core' | 'currency' | 'device' | 'domain' | 'email' | 'gb_s' | 'gigabyte' | 'hour' | 'iops_gigabyte' | 'ip' | 'month' | 'node' | 'plan' | 'query' | 'request' | 'session' | 'vcpu_s' | 'version' | 'year' | 'key' | 'token' | 'minute' | 'setup' | 'day';
+export type PublicCatalogProductPropertiesHardwareCPUArch = 'unknown_arch' | 'x64' | 'arm64' | 'riscv' | 'apple_silicon';
+export interface PublicCatalogProductPropertiesHardwareCPUPhysical {
+    /**
+     * The number of sockets of the CPU.
+     */
+    sockets: number;
+    /**
+     * The number of cores per socket.
+     */
+    coresPerSocket: number;
+    /**
+     * The number of threads per core.
+     */
+    threadsPerCore: number;
+    /**
+     * The frequency of the CPU in Hertz.
+     */
+    frequency: number;
+    /**
+     * The benchmark score of the CPU.
+     */
+    benchmark: number;
+}
+export interface PublicCatalogProductPropertiesHardwareCPUVirtual {
+    /**
+     * The number of vCPUs.
+     */
+    count: number;
+}
+export interface PublicCatalogProductPropertiesHardwareCPU {
+    /**
+     * A human readable description of the CPU.
+     */
+    description: string;
+    /**
+     * The architecture of the CPU.
+     */
+    arch: PublicCatalogProductPropertiesHardwareCPUArch;
+    /**
+     * The type of the CPU.
+     */
+    type: string;
+    /**
+     * Properties if the CPU is virtual.
+     *
+     * One-of ('computeUnit'): at most one of 'virtual', 'physical' could be set.
+     */
+    virtual?: PublicCatalogProductPropertiesHardwareCPUVirtual;
+    /**
+     * Properties if the CPU is physical.
+     *
+     * One-of ('computeUnit'): at most one of 'virtual', 'physical' could be set.
+     */
+    physical?: PublicCatalogProductPropertiesHardwareCPUPhysical;
+    /**
+     * The total number of threads.
+     */
+    threads: number;
+}
+export interface PublicCatalogProductPropertiesHardwareGPU {
+    /**
+     * A human-readable description of the GPU.
+     */
+    description: string;
+    /**
+     * The number of GPUs.
+     */
+    count: number;
+    /**
+     * The type of the GPU.
+     */
+    type: string;
+}
+export interface PublicCatalogProductPropertiesHardwareNetwork {
+    /**
+     * A human-readable description of the network.
+     */
+    description: string;
+    /**
+     * The internal bandwidth in bits per second.
+     */
+    internalBandwidth: number;
+    /**
+     * The default public bandwidth in bits per second.
+     */
+    publicBandwidth: number;
+    /**
+     * The maximum public bandwidth in bits per second (may require subscription to options).
+     */
+    maxPublicBandwidth: number;
+}
+export interface PublicCatalogProductPropertiesHardwareRAM {
+    /**
+     * A human-readable description of the RAM.
+     */
+    description: string;
+    /**
+     * The size of the RAM in bytes.
+     */
+    size: number;
+    /**
+     * The type of the RAM.
+     */
+    type: string;
+}
+export interface PublicCatalogProductPropertiesHardwareStorage {
+    /**
+     * A human-readable description of the storage.
+     */
+    description: string;
+    /**
+     * The total size of the storage in bytes.
+     */
+    total: number;
+}
+export interface PublicCatalogProductPriceUnitOfMeasure {
+    /**
+     * The unit of measure.
+     */
+    unit: PublicCatalogProductPriceUnitOfMeasureCountableUnit;
+    /**
+     * The size of the unit.
+     */
+    size: number;
+}
+export interface PublicCatalogProductPropertiesAppleSilicon {
+    /**
+     * The range of the Apple Silicon server.
+     */
+    range: string;
+}
+export interface PublicCatalogProductPropertiesDedibox {
+    /**
+     * The range of the Dedibox server.
+     */
+    range: string;
+}
+export interface PublicCatalogProductPropertiesElasticMetal {
+    /**
+     * The range of the Elastic Metal server.
+     */
+    range: string;
+}
+export interface PublicCatalogProductPropertiesHardware {
+    /**
+     * The CPU hardware properties.
+     */
+    cpu?: PublicCatalogProductPropertiesHardwareCPU;
+    /**
+     * The RAM hardware properties.
+     */
+    ram?: PublicCatalogProductPropertiesHardwareRAM;
+    /**
+     * The storage hardware properties.
+     */
+    storage?: PublicCatalogProductPropertiesHardwareStorage;
+    /**
+     * The network hardware properties.
+     */
+    network?: PublicCatalogProductPropertiesHardwareNetwork;
+    /**
+     * The GPU hardware properties.
+     */
+    gpu?: PublicCatalogProductPropertiesHardwareGPU;
+}
+export interface PublicCatalogProductPropertiesInstance {
+    /**
+     * The range of the Instance server.
+     */
+    range: string;
+}
+export interface PublicCatalogProductLocality {
+    /**
+     * Whether or not the product is global.
+     *
+     * One-of ('locality'): at most one of 'global', 'region', 'zone', 'datacenter' could be set.
+     */
+    global?: boolean;
+    /**
+     * The region of the product.
+     *
+     * One-of ('locality'): at most one of 'global', 'region', 'zone', 'datacenter' could be set.
+     */
+    region?: ScwRegion;
+    /**
+     * The zone of the product.
+     *
+     * One-of ('locality'): at most one of 'global', 'region', 'zone', 'datacenter' could be set.
+     */
+    zone?: ScwZone;
+    /**
+     * The datacenter of the product.
+     *
+     * One-of ('locality'): at most one of 'global', 'region', 'zone', 'datacenter' could be set.
+     */
+    datacenter?: string;
+}
+export interface PublicCatalogProductPrice {
+    /**
+     * The retail price of the product.
+     */
+    retailPrice?: Money;
+    /**
+     * The unit of measure of the price.
+     */
+    unitOfMeasure?: PublicCatalogProductPriceUnitOfMeasure;
+}
+export interface PublicCatalogProductProperties {
+    /**
+     * The hardware properties of the product (if supported).
+     */
+    hardware?: PublicCatalogProductPropertiesHardware;
+    /**
+     * The properties of Dedibox products.
+     *
+     * One-of ('properties'): at most one of 'dedibox', 'elasticMetal', 'appleSilicon', 'instance' could be set.
+     */
+    dedibox?: PublicCatalogProductPropertiesDedibox;
+    /**
+     * The properties of Elastic Metal products.
+     *
+     * One-of ('properties'): at most one of 'dedibox', 'elasticMetal', 'appleSilicon', 'instance' could be set.
+     */
+    elasticMetal?: PublicCatalogProductPropertiesElasticMetal;
+    /**
+     * The properties of Apple Silicon products.
+     *
+     * One-of ('properties'): at most one of 'dedibox', 'elasticMetal', 'appleSilicon', 'instance' could be set.
+     */
+    appleSilicon?: PublicCatalogProductPropertiesAppleSilicon;
+    /**
+     * The properties of Instance products.
+     *
+     * One-of ('properties'): at most one of 'dedibox', 'elasticMetal', 'appleSilicon', 'instance' could be set.
+     */
+    instance?: PublicCatalogProductPropertiesInstance;
+}
+export interface PublicCatalogProduct {
+    /**
+     * The unique identifier of the product.
+     */
+    sku: string;
+    /**
+     * The category of the product.
+     */
+    serviceCategory: string;
+    /**
+     * The product name.
+     */
+    product: string;
+    /**
+     * The product variant.
+     */
+    variant: string;
+    /**
+     * The product description.
+     */
+    description: string;
+    /**
+     * The locality of the product.
+     */
+    locality?: PublicCatalogProductLocality;
+    /**
+     * The price of the product.
+     */
+    price?: PublicCatalogProductPrice;
+    /**
+     * The properties of the product.
+     */
+    properties?: PublicCatalogProductProperties;
+}
+export interface ListPublicCatalogProductsResponse {
+    /**
+     * The list of products.
+     */
+    products: PublicCatalogProduct[];
+    /**
+     * The total number of products in the catalog.
+     */
+    totalCount: number;
+}
+export type PublicCatalogApiListPublicCatalogProductsRequest = {
+    /**
+     * Number of the page. Value must be greater or equal to 1.
+     */
+    page?: number;
+    /**
+     * The number of products per page. Value must be greater or equal to 1.
+     */
+    pageSize?: number;
+};

package/dist/api/product_catalog/v2alpha1/validation-rules.gen.cjs

@@ -0,0 +1,11 @@
+"use strict";
+Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
+const PublicCatalogApiListPublicCatalogProductsRequest = {
+  page: {
+    greaterThanOrEqual: 1
+  },
+  pageSize: {
+    greaterThanOrEqual: 1
+  }
+};
+exports.PublicCatalogApiListPublicCatalogProductsRequest = PublicCatalogApiListPublicCatalogProductsRequest;

package/dist/api/product_catalog/v2alpha1/validation-rules.gen.d.ts

@@ -0,0 +1,8 @@
+export declare const PublicCatalogApiListPublicCatalogProductsRequest: {
+    page: {
+        greaterThanOrEqual: number;
+    };
+    pageSize: {
+        greaterThanOrEqual: number;
+    };
+};

package/dist/api/product_catalog/v2alpha1/validation-rules.gen.js

@@ -0,0 +1,11 @@
+const PublicCatalogApiListPublicCatalogProductsRequest = {
+  page: {
+    greaterThanOrEqual: 1
+  },
+  pageSize: {
+    greaterThanOrEqual: 1
+  }
+};
+export {
+  PublicCatalogApiListPublicCatalogProductsRequest
+};

package/dist/api/qaas/v1alpha1/types.gen.d.ts

@@ -148,7 +148,7 @@ export interface Platform {
      */
     id: string;
     /**
-     * Verison of the platform.
+     * Version of the platform.
      */
     version: string;
     /**
@@ -184,7 +184,7 @@ export interface Platform {
      */
     metadata: string;
     /**
-     * Price to be payed per hour (excluding free tiers).
+     * Price to be paid per hour (excluding free tiers).
      */
     pricePerHour?: Money;
     /**

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

@@ -620,7 +620,7 @@ class API extends api.API {
     marshalling_gen.unmarshalDeleteInstanceSettingsResponse
   );
   /**
-   * Set Database Instance advanced settings. Update an advanced setting for a Database Instance. Settings added upon database engine initalization can only be defined once, and cannot, therefore, be updated.
+   * Set Database Instance advanced settings. Update an advanced setting for a Database Instance. Settings added upon database engine initialization can only be defined once, and cannot, therefore, be updated.
    *
    * @param request - The request {@link SetInstanceSettingsRequest}
    * @returns A Promise of SetInstanceSettingsResponse

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

@@ -288,7 +288,7 @@ export declare class API extends ParentAPI {
      */
     deleteInstanceSettings: (request: Readonly<DeleteInstanceSettingsRequest>) => Promise<DeleteInstanceSettingsResponse>;
     /**
-     * Set Database Instance advanced settings. Update an advanced setting for a Database Instance. Settings added upon database engine initalization can only be defined once, and cannot, therefore, be updated.
+     * Set Database Instance advanced settings. Update an advanced setting for a Database Instance. Settings added upon database engine initialization can only be defined once, and cannot, therefore, be updated.
      *
      * @param request - The request {@link SetInstanceSettingsRequest}
      * @returns A Promise of SetInstanceSettingsResponse

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

@@ -618,7 +618,7 @@ class API extends API$1 {
     unmarshalDeleteInstanceSettingsResponse
   );
   /**
-   * Set Database Instance advanced settings. Update an advanced setting for a Database Instance. Settings added upon database engine initalization can only be defined once, and cannot, therefore, be updated.
+   * Set Database Instance advanced settings. Update an advanced setting for a Database Instance. Settings added upon database engine initialization can only be defined once, and cannot, therefore, be updated.
    *
    * @param request - The request {@link SetInstanceSettingsRequest}
    * @returns A Promise of SetInstanceSettingsResponse

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

@@ -308,7 +308,7 @@ export interface Volume {
 }
 export interface NodeTypeVolumeConstraintSizes {
     /**
-     * [deprecated] Mimimum size required for the Volume.
+     * [deprecated] Minimum size required for the Volume.
      */
     minSize: number;
     /**
@@ -326,7 +326,7 @@ export interface NodeTypeVolumeType {
      */
     description: string;
     /**
-     * Mimimum size required for the Volume.
+     * Minimum size required for the Volume.
      */
     minSize: number;
     /**

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

@@ -263,7 +263,7 @@ class API extends api.API {
     marshalling_gen.unmarshalCluster
   );
   /**
-   * Set advanced settings. Update an advanced setting for a Redis™ Database Instance (Redis™ cluster). Settings added upon database engine initalization can only be defined once, and cannot, therefore, be updated.
+   * Set advanced settings. Update an advanced setting for a Redis™ Database Instance (Redis™ cluster). Settings added upon database engine initialization can only be defined once, and cannot, therefore, be updated.
    *
    * @param request - The request {@link SetClusterSettingsRequest}
    * @returns A Promise of ClusterSettingsResponse

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

@@ -121,7 +121,7 @@ export declare class API extends ParentAPI {
      */
     deleteClusterSetting: (request: Readonly<DeleteClusterSettingRequest>) => Promise<Cluster>;
     /**
-     * Set advanced settings. Update an advanced setting for a Redis™ Database Instance (Redis™ cluster). Settings added upon database engine initalization can only be defined once, and cannot, therefore, be updated.
+     * Set advanced settings. Update an advanced setting for a Redis™ Database Instance (Redis™ cluster). Settings added upon database engine initialization can only be defined once, and cannot, therefore, be updated.
      *
      * @param request - The request {@link SetClusterSettingsRequest}
      * @returns A Promise of ClusterSettingsResponse

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

@@ -261,7 +261,7 @@ class API extends API$1 {
     unmarshalCluster
   );
   /**
-   * Set advanced settings. Update an advanced setting for a Redis™ Database Instance (Redis™ cluster). Settings added upon database engine initalization can only be defined once, and cannot, therefore, be updated.
+   * Set advanced settings. Update an advanced setting for a Redis™ Database Instance (Redis™ cluster). Settings added upon database engine initialization can only be defined once, and cannot, therefore, be updated.
    *
    * @param request - The request {@link SetClusterSettingsRequest}
    * @returns A Promise of ClusterSettingsResponse

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

@@ -54,7 +54,7 @@ export interface Namespace {
      */
     id: string;
     /**
-     * Name of the namespace, unique in a region accross all organizations.
+     * Name of the namespace, unique in a region across all organizations.
      */
     name: string;
     /**