@scaleway/sdk 2.71.1 → 2.73.0

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

@@ -1,7 +1,8 @@
-import { API as API$1 } from "../../../scw/api.js";
-import { urlParams, resolveOneOf, validatePathParam } from "../../../helpers/marshalling.js";
-import "../../../vendor/base64/index.js";
-import { enrichForPagination } from "../../../scw/fetch/resource-paginator.js";
+import "../../../client/dist/internal/logger/index.js";
+import { API as API$1 } from "../../../client/dist/scw/api.js";
+import { urlParams, resolveOneOf, validatePathParam } from "../../../client/dist/helpers/marshalling.js";
+import "../../../client/dist/vendor/base64/index.js";
+import { enrichForPagination } from "../../../client/dist/scw/fetch/resource-paginator.js";
 import { unmarshalListConsumptionsResponse, unmarshalListTaxesResponse, unmarshalListInvoicesResponse, unmarshalInvoice, unmarshalListDiscountsResponse } from "./marshalling.gen.js";
 class API extends API$1 {
   pageOfListConsumptions = (request = {}) => this.client.fetch(
@@ -36,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
@@ -64,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
@@ -91,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
@@ -162,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 {

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

@@ -1,8 +1,9 @@
 "use strict";
 Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
-const json = require("../../../helpers/json.cjs");
-const customMarshalling = require("../../../scw/custom-marshalling.cjs");
-const marshalling = require("../../../helpers/marshalling.cjs");
+require("../../../client/dist/internal/logger/index.cjs");
+const json = require("../../../client/dist/helpers/json.cjs");
+const customMarshalling = require("../../../client/dist/scw/custom-marshalling.cjs");
+const marshalling = require("../../../client/dist/helpers/marshalling.cjs");
 const unmarshalInvoice = (data) => {
   if (!json.isJSONObject(data)) {
     throw new TypeError(

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

@@ -1,6 +1,7 @@
-import { isJSONObject } from "../../../helpers/json.js";
-import { unmarshalMoney } from "../../../scw/custom-marshalling.js";
-import { unmarshalDate, unmarshalArrayOfObject } from "../../../helpers/marshalling.js";
+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 { unmarshalDate, unmarshalArrayOfObject } from "../../../client/dist/helpers/marshalling.js";
 const unmarshalInvoice = (data) => {
   if (!isJSONObject(data)) {
     throw new TypeError(

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

@@ -1,4 +1,4 @@
-import type { Money } from '../../../bridge';
+import type { Money } from '@scaleway/sdk-client';
 export type DiscountDiscountMode = 'unknown_discount_mode' | 'discount_mode_rate' | 'discount_mode_value' | 'discount_mode_splittable';
 export type DiscountFilterType = 'unknown_type' | 'category_name' | 'product_name' | 'product_range' | 'resource_name' | 'region' | 'zone';
 export type DownloadInvoiceRequestFileType = 'pdf';
@@ -10,262 +10,391 @@ export type ListDiscountsRequestOrderBy = 'creation_date_desc' | 'creation_date_
 export type ListInvoicesRequestOrderBy = 'invoice_number_desc' | 'invoice_number_asc' | 'start_date_desc' | 'start_date_asc' | 'issued_date_desc' | 'issued_date_asc' | 'due_date_desc' | 'due_date_asc' | 'total_untaxed_desc' | 'total_untaxed_asc' | 'total_taxed_desc' | 'total_taxed_asc' | 'invoice_type_desc' | 'invoice_type_asc';
 export type ListTaxesRequestOrderBy = 'updated_at_desc' | 'updated_at_asc' | 'category_name_desc' | 'category_name_asc';
 export interface DiscountCoupon {
-    /** The description of the coupon. */
+    /**
+     * The description of the coupon.
+     */
     description?: string;
 }
 export interface DiscountFilter {
     /**
-     * Type of the filter (category name, product name, product range, resource
-     * name, region or zone).
+     * Type of the filter (category name, product name, product range, resource name, region or zone).
      */
     type: DiscountFilterType;
-    /** Value of filter. */
+    /**
+     * Value of filter.
+     */
     value: string;
-    /** Boolean to describe if filter is an excluding filter. */
+    /**
+     * Boolean to describe if filter is an excluding filter.
+     */
     exclude: boolean;
 }
 export interface ListConsumptionsResponseConsumption {
-    /** Monetary value of the consumption. */
+    /**
+     * Monetary value of the consumption.
+     */
     value?: Money;
     /**
-     * The product name. For example, "VPC Public Gateway S", "VPC Public Gateway
-     * M" for the VPC product.
+     * The product name. For example, "VPC Public Gateway S", "VPC Public Gateway M" for the VPC product.
      */
     productName: string;
-    /** Identifies the reference based on the category. */
+    /**
+     * Identifies the reference based on the category.
+     */
     resourceName: string;
-    /** Unique identifier of the product. */
+    /**
+     * Unique identifier of the product.
+     */
     sku: string;
-    /** Project ID of the consumption. */
+    /**
+     * Project ID of the consumption.
+     */
     projectId: string;
-    /** Name of consumption category. */
+    /**
+     * Name of consumption category.
+     */
     categoryName: string;
-    /** Unit of consumed quantity. */
+    /**
+     * Unit of consumed quantity.
+     */
     unit: string;
-    /** Consumed quantity. */
+    /**
+     * Consumed quantity.
+     */
     billedQuantity: string;
 }
 export interface Discount {
-    /** The ID of the discount. */
+    /**
+     * The ID of the discount.
+     */
     id: string;
-    /** The creation date of the discount. */
+    /**
+     * The creation date of the discount.
+     */
     creationDate?: Date;
-    /** The Organization ID of the discount. */
+    /**
+     * The Organization ID of the discount.
+     */
     organizationId: string;
-    /** The description of the discount. */
+    /**
+     * The description of the discount.
+     */
     description: string;
-    /** The initial value of the discount. */
+    /**
+     * The initial value of the discount.
+     */
     value: number;
-    /** The value indicating how much of the discount has been used. */
+    /**
+     * The value indicating how much of the discount has been used.
+     */
     valueUsed: number;
-    /** The remaining value of the discount. */
+    /**
+     * The remaining value of the discount.
+     */
     valueRemaining: number;
-    /** The mode of the discount. */
+    /**
+     * The mode of the discount.
+     */
     mode: DiscountDiscountMode;
-    /** The start date of the discount. */
+    /**
+     * The start date of the discount.
+     */
     startDate?: Date;
-    /** The stop date of the discount. */
+    /**
+     * The stop date of the discount.
+     */
     stopDate?: Date;
-    /** The description of the coupon. */
+    /**
+     * The description of the coupon.
+     */
     coupon?: DiscountCoupon;
-    /** List of the discount scopes. */
+    /**
+     * List of the discount scopes.
+     */
     filters: DiscountFilter[];
 }
 export interface Invoice {
-    /** Invoice ID. */
+    /**
+     * Invoice ID.
+     */
     id: string;
     organizationId: string;
     organizationName: string;
-    /** Start date of the billing period. */
+    /**
+     * Start date of the billing period.
+     */
     startDate?: Date;
     stopDate?: Date;
-    /** The billing period of the invoice in the YYYY-MM format. */
+    /**
+     * The billing period of the invoice in the YYYY-MM format.
+     */
     billingPeriod?: Date;
-    /** Date when the invoice was sent to the customer. */
+    /**
+     * Date when the invoice was sent to the customer.
+     */
     issuedDate?: Date;
-    /** Payment time limit, set according to the Organization's payment conditions. */
+    /**
+     * Payment time limit, set according to the Organization's payment conditions.
+     */
     dueDate?: Date;
-    /** Total amount, untaxed. */
+    /**
+     * Total amount, untaxed.
+     */
     totalUntaxed?: Money;
-    /** Total amount, taxed. */
+    /**
+     * Total amount, taxed.
+     */
     totalTaxed?: Money;
-    /** The total tax amount of the invoice. */
+    /**
+     * The total tax amount of the invoice.
+     */
     totalTax?: Money;
-    /** The total discount amount of the invoice. */
+    /**
+     * The total discount amount of the invoice.
+     */
     totalDiscount?: Money;
-    /** The total amount of the invoice before applying the discount. */
+    /**
+     * The total amount of the invoice before applying the discount.
+     */
     totalUndiscount?: Money;
-    /** Type of invoice, either periodic or purchase. */
+    /**
+     * Type of invoice, either periodic or purchase.
+     */
     type: InvoiceType;
-    /** The state of the Invoice. */
+    /**
+     * The state of the Invoice.
+     */
     state: string;
-    /** Invoice number. */
+    /**
+     * Invoice number.
+     */
     number: number;
-    /** The name of the seller (Scaleway). */
+    /**
+     * The name of the seller (Scaleway).
+     */
     sellerName: string;
 }
 export interface ListTaxesResponseTax {
-    /** Description of the tax applied. */
+    /**
+     * Description of the tax applied.
+     */
     description: string;
-    /** The three-letter currency code. */
+    /**
+     * The three-letter currency code.
+     */
     currency: string;
-    /** Applied tax rate (0.2 means a VAT of 20%). */
+    /**
+     * Applied tax rate (0.2 means a VAT of 20%).
+     */
     rate?: number;
-    /** The total tax value of the consumption. */
+    /**
+     * The total tax value of the consumption.
+     */
     totalTaxValue?: number;
 }
 export type DownloadInvoiceRequest = {
-    /** Invoice ID. */
+    /**
+     * Invoice ID.
+     */
     invoiceId: string;
-    /** File type. PDF by default. */
+    /**
+     * File type. PDF by default.
+     */
     fileType?: DownloadInvoiceRequestFileType;
 };
 export type ExportInvoicesRequest = {
     /**
-     * Organization ID. If specified, only invoices from this Organization will be
-     * returned.
+     * Organization ID. If specified, only invoices from this Organization will be returned.
      */
     organizationId?: string;
-    /** Return only invoice with start date greater than billing_period_start. */
+    /**
+     * Return only invoice with start date greater than billing_period_start.
+     */
     billingPeriodStartAfter?: Date;
-    /** Return only invoice with start date less than billing_period_start. */
+    /**
+     * Return only invoice with start date less than billing_period_start.
+     */
     billingPeriodStartBefore?: Date;
-    /** Invoice type. It can either be `periodic` or `purchase`. */
+    /**
+     * Invoice type. It can either be `periodic` or `purchase`.
+     */
     invoiceType?: InvoiceType;
-    /** Page number. */
+    /**
+     * Page number.
+     */
     page?: number;
     /**
-     * Positive integer lower or equal to 100 to select the number of items to
-     * return.
+     * Positive integer lower or equal to 100 to select the number of items to return.
      */
     pageSize?: number;
-    /** How invoices are ordered in the response. */
+    /**
+     * How invoices are ordered in the response.
+     */
     orderBy?: ExportInvoicesRequestOrderBy;
-    /** File format for exporting the invoice list. */
+    /**
+     * File format for exporting the invoice list.
+     */
     fileType?: ExportInvoicesRequestFileType;
 };
 export type GetInvoiceRequest = {
-    /** Invoice ID. */
+    /**
+     * Invoice ID.
+     */
     invoiceId: string;
 };
 export type ListConsumptionsRequest = {
-    /** Order consumptions list in the response by their update date. */
+    /**
+     * Order consumptions list in the response by their update date.
+     */
     orderBy?: ListConsumptionsRequestOrderBy;
-    /** Positive integer to choose the page to return. */
+    /**
+     * Positive integer to choose the page to return.
+     */
     page?: number;
     /**
-     * Positive integer lower or equal to 100 to select the number of items to
-     * return.
+     * Positive integer lower or equal to 100 to select the number of items to return.
      */
     pageSize?: number;
     /**
      * Filter by Organization ID.
      *
-     * One-of ('projectIdentifier'): at most one of 'organizationId', 'projectId'
-     * could be set.
+     * One-of ('projectIdentifier'): at most one of 'organizationId', 'projectId' could be set.
      */
     organizationId?: string;
     /**
      * Filter by Project ID.
      *
-     * One-of ('projectIdentifier'): at most one of 'organizationId', 'projectId'
-     * could be set.
+     * One-of ('projectIdentifier'): at most one of 'organizationId', 'projectId' could be set.
      */
     projectId?: string;
     /**
-     * Filter by name of a Category as they are shown in the invoice (Compute,
-     * Network, Observability).
+     * Filter by name of a Category as they are shown in the invoice (Compute, Network, Observability).
      */
     categoryName?: string;
     /**
-     * Filter by the billing period in the YYYY-MM format. If it is empty the
-     * current billing period will be used as default.
+     * Filter by the billing period in the YYYY-MM format. If it is empty the current billing period will be used as default.
      */
     billingPeriod?: string;
 };
 export interface ListConsumptionsResponse {
-    /** Detailed consumption list. */
+    /**
+     * Detailed consumption list.
+     */
     consumptions: ListConsumptionsResponseConsumption[];
-    /** Total number of returned items. */
+    /**
+     * Total number of returned items.
+     */
     totalCount: number;
     /**
-     * Sum of all discounts, displayed only when no category or project ID filter
-     * is applied.
+     * Sum of all discounts, displayed only when no category or project ID filter is applied.
      */
     totalDiscountUntaxedValue: number;
-    /** Last consumption update date. */
+    /**
+     * Last consumption update date.
+     */
     updatedAt?: Date;
 }
 export type ListDiscountsRequest = {
-    /** Order discounts in the response by their description. */
+    /**
+     * Order discounts in the response by their description.
+     */
     orderBy?: ListDiscountsRequestOrderBy;
-    /** Positive integer to choose the page to return. */
+    /**
+     * Positive integer to choose the page to return.
+     */
     page?: number;
     /**
-     * Positive integer lower or equal to 100 to select the number of items to
-     * return.
+     * Positive integer lower or equal to 100 to select the number of items to return.
      */
     pageSize?: number;
-    /** ID of the organization. */
+    /**
+     * ID of the organization.
+     */
     organizationId?: string;
 };
 export interface ListDiscountsResponse {
-    /** Total number of discounts. */
+    /**
+     * Total number of discounts.
+     */
     totalCount: number;
-    /** Paginated returned discounts. */
+    /**
+     * Paginated returned discounts.
+     */
     discounts: Discount[];
 }
 export type ListInvoicesRequest = {
     /**
-     * Organization ID. If specified, only invoices from this Organization will be
-     * returned.
+     * Organization ID. If specified, only invoices from this Organization will be returned.
      */
     organizationId?: string;
-    /** Return only invoice with start date greater than billing_period_start. */
+    /**
+     * Return only invoice with start date greater than billing_period_start.
+     */
     billingPeriodStartAfter?: Date;
-    /** Return only invoice with start date less than billing_period_start. */
+    /**
+     * Return only invoice with start date less than billing_period_start.
+     */
     billingPeriodStartBefore?: Date;
-    /** Invoice type. It can either be `periodic` or `purchase`. */
+    /**
+     * Invoice type. It can either be `periodic` or `purchase`.
+     */
     invoiceType?: InvoiceType;
-    /** Page number. */
+    /**
+     * Page number.
+     */
     page?: number;
     /**
-     * Positive integer lower or equal to 100 to select the number of items to
-     * return.
+     * Positive integer lower or equal to 100 to select the number of items to return.
      */
     pageSize?: number;
-    /** How invoices are ordered in the response. */
+    /**
+     * How invoices are ordered in the response.
+     */
     orderBy?: ListInvoicesRequestOrderBy;
 };
 export interface ListInvoicesResponse {
-    /** Total number of invoices. */
+    /**
+     * Total number of invoices.
+     */
     totalCount: number;
-    /** Paginated returned invoices. */
+    /**
+     * Paginated returned invoices.
+     */
     invoices: Invoice[];
 }
 export type ListTaxesRequest = {
-    /** Order consumed taxes list in the response by their update date. */
+    /**
+     * Order consumed taxes list in the response by their update date.
+     */
     orderBy?: ListTaxesRequestOrderBy;
-    /** Page number. */
+    /**
+     * Page number.
+     */
     page?: number;
     /**
-     * Positive integer lower or equal to 100 to select the number of items to
-     * return.
+     * Positive integer lower or equal to 100 to select the number of items to return.
      */
     pageSize?: number;
-    /** Filter by Organization ID. */
+    /**
+     * Filter by Organization ID.
+     */
     organizationId?: string;
     /**
-     * Filter by the billing period in the YYYY-MM format. If it is empty the
-     * current billing period will be used as default.
+     * Filter by the billing period in the YYYY-MM format. If it is empty the current billing period will be used as default.
      */
     billingPeriod?: string;
 };
 export interface ListTaxesResponse {
-    /** Detailed consumption tax. */
+    /**
+     * Detailed consumption tax.
+     */
     taxes: ListTaxesResponseTax[];
-    /** Total number of returned items. */
+    /**
+     * Total number of returned items.
+     */
     totalCount: number;
-    /** Last consumption update date. */
+    /**
+     * Last consumption update date.
+     */
     updatedAt?: Date;
 }

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

@@ -1,6 +1,6 @@
 /**
- * This file is automatically generated from /scripts/generate.js PLEASE DO NOT
- * EDIT HERE
+ * This file is automatically generated from /scripts/generate.js
+ * PLEASE DO NOT EDIT HERE
  */
 export * as v1 from './v1/index.gen.js';
 export * as v1alpha1 from './v1alpha1/index.gen.js';