@scaleway/sdk 2.26.0 → 2.28.0

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

@@ -1,53 +1,63 @@
-import { isJSONObject } from '../../../helpers/json.js';
-import { unmarshalMoney } from '../../../scw/custom-marshalling.js';
-import { unmarshalArrayOfObject, unmarshalDate } from '../../../helpers/marshalling.js';
-
-// This file was automatically generated. DO NOT EDIT.
-// If you have any remark or suggestion do not hesitate to open an issue.
-const unmarshalGetConsumptionResponseConsumption = data => {
+import { isJSONObject } from "../../../helpers/json.js";
+import { unmarshalMoney } from "../../../scw/custom-marshalling.js";
+import { unmarshalArrayOfObject, unmarshalDate } from "../../../helpers/marshalling.js";
+const unmarshalGetConsumptionResponseConsumption = (data) => {
   if (!isJSONObject(data)) {
-    throw new TypeError(`Unmarshalling the type 'GetConsumptionResponseConsumption' failed as data isn't a dictionary.`);
+    throw new TypeError(
+      `Unmarshalling the type 'GetConsumptionResponseConsumption' failed as data isn't a dictionary.`
+    );
   }
   return {
     category: data.category,
     description: data.description,
     operationPath: data.operation_path,
     projectId: data.project_id,
-    value: data.value ? unmarshalMoney(data.value) : undefined
+    value: data.value ? unmarshalMoney(data.value) : void 0
   };
 };
-const unmarshalGetConsumptionResponse = data => {
+const unmarshalGetConsumptionResponse = (data) => {
   if (!isJSONObject(data)) {
-    throw new TypeError(`Unmarshalling the type 'GetConsumptionResponse' failed as data isn't a dictionary.`);
+    throw new TypeError(
+      `Unmarshalling the type 'GetConsumptionResponse' failed as data isn't a dictionary.`
+    );
   }
   return {
-    consumptions: unmarshalArrayOfObject(data.consumptions, unmarshalGetConsumptionResponseConsumption),
+    consumptions: unmarshalArrayOfObject(
+      data.consumptions,
+      unmarshalGetConsumptionResponseConsumption
+    ),
     updatedAt: unmarshalDate(data.updated_at)
   };
 };
-const unmarshalDiscountCoupon = data => {
+const unmarshalDiscountCoupon = (data) => {
   if (!isJSONObject(data)) {
-    throw new TypeError(`Unmarshalling the type 'DiscountCoupon' failed as data isn't a dictionary.`);
+    throw new TypeError(
+      `Unmarshalling the type 'DiscountCoupon' failed as data isn't a dictionary.`
+    );
   }
   return {
     description: data.description
   };
 };
-const unmarshalDiscountFilter = data => {
+const unmarshalDiscountFilter = (data) => {
   if (!isJSONObject(data)) {
-    throw new TypeError(`Unmarshalling the type 'DiscountFilter' failed as data isn't a dictionary.`);
+    throw new TypeError(
+      `Unmarshalling the type 'DiscountFilter' failed as data isn't a dictionary.`
+    );
   }
   return {
     type: data.type,
     value: data.value
   };
 };
-const unmarshalDiscount = data => {
+const unmarshalDiscount = (data) => {
   if (!isJSONObject(data)) {
-    throw new TypeError(`Unmarshalling the type 'Discount' failed as data isn't a dictionary.`);
+    throw new TypeError(
+      `Unmarshalling the type 'Discount' failed as data isn't a dictionary.`
+    );
   }
   return {
-    coupon: data.coupon ? unmarshalDiscountCoupon(data.coupon) : undefined,
+    coupon: data.coupon ? unmarshalDiscountCoupon(data.coupon) : void 0,
     creationDate: unmarshalDate(data.creation_date),
     description: data.description,
     filters: unmarshalArrayOfObject(data.filters, unmarshalDiscountFilter),
@@ -61,18 +71,22 @@ const unmarshalDiscount = data => {
     valueUsed: data.value_used
   };
 };
-const unmarshalListDiscountsResponse = data => {
+const unmarshalListDiscountsResponse = (data) => {
   if (!isJSONObject(data)) {
-    throw new TypeError(`Unmarshalling the type 'ListDiscountsResponse' failed as data isn't a dictionary.`);
+    throw new TypeError(
+      `Unmarshalling the type 'ListDiscountsResponse' failed as data isn't a dictionary.`
+    );
   }
   return {
     discounts: unmarshalArrayOfObject(data.discounts, unmarshalDiscount),
     totalCount: data.total_count
   };
 };
-const unmarshalInvoice = data => {
+const unmarshalInvoice = (data) => {
   if (!isJSONObject(data)) {
-    throw new TypeError(`Unmarshalling the type 'Invoice' failed as data isn't a dictionary.`);
+    throw new TypeError(
+      `Unmarshalling the type 'Invoice' failed as data isn't a dictionary.`
+    );
   }
   return {
     dueDate: unmarshalDate(data.due_date),
@@ -81,18 +95,23 @@ const unmarshalInvoice = data => {
     issuedDate: unmarshalDate(data.issued_date),
     number: data.number,
     startDate: unmarshalDate(data.start_date),
-    totalTaxed: data.total_taxed ? unmarshalMoney(data.total_taxed) : undefined,
-    totalUntaxed: data.total_untaxed ? unmarshalMoney(data.total_untaxed) : undefined
+    totalTaxed: data.total_taxed ? unmarshalMoney(data.total_taxed) : void 0,
+    totalUntaxed: data.total_untaxed ? unmarshalMoney(data.total_untaxed) : void 0
   };
 };
-const unmarshalListInvoicesResponse = data => {
+const unmarshalListInvoicesResponse = (data) => {
   if (!isJSONObject(data)) {
-    throw new TypeError(`Unmarshalling the type 'ListInvoicesResponse' failed as data isn't a dictionary.`);
+    throw new TypeError(
+      `Unmarshalling the type 'ListInvoicesResponse' failed as data isn't a dictionary.`
+    );
   }
   return {
     invoices: unmarshalArrayOfObject(data.invoices, unmarshalInvoice),
     totalCount: data.total_count
   };
 };
-
-export { unmarshalGetConsumptionResponse, unmarshalListDiscountsResponse, unmarshalListInvoicesResponse };
+export {
+  unmarshalGetConsumptionResponse,
+  unmarshalListDiscountsResponse,
+  unmarshalListInvoicesResponse
+};

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

@@ -0,0 +1,136 @@
+import type { Money } from '../../../bridge';
+export type DiscountDiscountMode = 'unknown_discount_mode' | 'discount_mode_rate' | 'discount_mode_value' | 'discount_mode_splittable';
+export type DiscountFilterType = 'unknown_type' | 'product_category' | 'product' | 'product_offer' | 'product_reference' | 'region' | 'zone';
+export type DownloadInvoiceRequestFileType = 'pdf';
+export type InvoiceType = 'unknown_type' | 'periodic' | 'purchase';
+export type ListDiscountsRequestOrderBy = 'creation_date_desc' | 'creation_date_asc';
+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 interface DiscountCoupon {
+    /** The description of the coupon. */
+    description?: string;
+}
+export interface DiscountFilter {
+    /** Type of the filter. */
+    type: DiscountFilterType;
+    /** Value of filter, it can be a product/range/region/zone value. */
+    value: string;
+}
+export interface GetConsumptionResponseConsumption {
+    /** Monetary value of the consumption. */
+    value?: Money;
+    /** Description of the consumption. */
+    description: string;
+    /** Project ID of the consumption. */
+    projectId: string;
+    /** Category of the consumption. */
+    category: string;
+    /** Unique identifier of the product. */
+    operationPath: string;
+}
+export interface Discount {
+    /** The ID of the discount. */
+    id: string;
+    /** The creation date of the discount. */
+    creationDate?: Date;
+    /** The organization ID of the discount. */
+    organizationId: string;
+    /** The description of the discount. */
+    description: string;
+    /** The initial value of the discount. */
+    value: number;
+    /** The value indicating how much of the discount has been used. */
+    valueUsed: number;
+    /** The remaining value of the discount. */
+    valueRemaining: number;
+    /** The mode of the discount. */
+    mode: DiscountDiscountMode;
+    /** The start date of the discount. */
+    startDate?: Date;
+    /** The stop date of the discount. */
+    stopDate?: Date;
+    /** The description of the coupon. */
+    coupon?: DiscountCoupon;
+    /** List of products/ranges/regions/zones to limit the usability of discounts. */
+    filters: DiscountFilter[];
+}
+export interface Invoice {
+    /** Invoice ID. */
+    id: string;
+    /** Start date of the billing period. */
+    startDate?: Date;
+    /** Date when the invoice was sent to the customer. */
+    issuedDate?: Date;
+    /** Payment time limit, set according to the Organization's payment conditions. */
+    dueDate?: Date;
+    /** Total amount, untaxed. */
+    totalUntaxed?: Money;
+    /** Total amount, taxed. */
+    totalTaxed?: Money;
+    /** Type of invoice. */
+    invoiceType: InvoiceType;
+    /** Invoice number. */
+    number: number;
+}
+export type DownloadInvoiceRequest = {
+    /** Invoice ID. */
+    invoiceId: string;
+    /** Wanted file type. */
+    fileType?: DownloadInvoiceRequestFileType;
+};
+export type GetConsumptionRequest = {
+    /** Filter by organization ID. */
+    organizationId?: string;
+};
+export interface GetConsumptionResponse {
+    /** Detailed consumption list. */
+    consumptions: GetConsumptionResponseConsumption[];
+    /** Last consumption update date. */
+    updatedAt?: Date;
+}
+export type ListDiscountsRequest = {
+    /** Order discounts in the response by their description. */
+    orderBy?: ListDiscountsRequestOrderBy;
+    /** 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.
+     */
+    pageSize?: number;
+    /** ID of the organization. */
+    organizationId?: string;
+};
+export interface ListDiscountsResponse {
+    /** Total number of discounts. */
+    totalCount: number;
+    /** Paginated returned discounts. */
+    discounts: Discount[];
+}
+export type ListInvoicesRequest = {
+    /**
+     * Organization ID to filter for, only invoices from this Organization will be
+     * returned.
+     */
+    organizationId?: string;
+    /** Invoice's `start_date` is greater or equal to `started_after`. */
+    startedAfter?: Date;
+    /** Invoice's `start_date` precedes `started_before`. */
+    startedBefore?: Date;
+    /** Invoice type. It can either be `periodic` or `purchase`. */
+    invoiceType?: InvoiceType;
+    /** 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.
+     */
+    pageSize?: number;
+    /** How invoices are ordered in the response. */
+    orderBy?: ListInvoicesRequestOrderBy;
+};
+export interface ListInvoicesResponse {
+    /** Total number of invoices. */
+    totalCount: number;
+    /** Paginated returned invoices. */
+    invoices: Invoice[];
+}

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

@@ -0,0 +1,175 @@
+"use strict";
+Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
+const api = require("../../../scw/api.cjs");
+const marshalling = require("../../../helpers/marshalling.cjs");
+const resourcePaginator = require("../../../scw/fetch/resource-paginator.cjs");
+const marshalling_gen = require("./marshalling.gen.cjs");
+class API extends api.API {
+  pageOfListConsumptions = (request = {}) => this.client.fetch(
+    {
+      method: "GET",
+      path: `/billing/v2beta1/consumptions`,
+      urlParams: marshalling.urlParams(
+        ["billing_period", request.billingPeriod],
+        ["category_name", request.categoryName],
+        ["order_by", request.orderBy],
+        ["page", request.page],
+        [
+          "page_size",
+          request.pageSize ?? this.client.settings.defaultPageSize
+        ],
+        ...Object.entries(
+          marshalling.resolveOneOf([
+            {
+              default: this.client.settings.defaultOrganizationId,
+              param: "organization_id",
+              value: request.organizationId
+            },
+            {
+              default: this.client.settings.defaultProjectId,
+              param: "project_id",
+              value: request.projectId
+            }
+          ])
+        )
+      )
+    },
+    marshalling_gen.unmarshalListConsumptionsResponse
+  );
+  /**
+   * 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
+   */
+  listConsumptions = (request = {}) => resourcePaginator.enrichForPagination("consumptions", this.pageOfListConsumptions, request);
+  pageOfListTaxes = (request = {}) => this.client.fetch(
+    {
+      method: "GET",
+      path: `/billing/v2beta1/taxes`,
+      urlParams: marshalling.urlParams(
+        ["billing_period", request.billingPeriod],
+        ["order_by", request.orderBy],
+        [
+          "organization_id",
+          request.organizationId ?? this.client.settings.defaultOrganizationId
+        ],
+        ["page", request.page],
+        [
+          "page_size",
+          request.pageSize ?? this.client.settings.defaultPageSize
+        ]
+      )
+    },
+    marshalling_gen.unmarshalListTaxesResponse
+  );
+  /**
+   * 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
+   */
+  listTaxes = (request = {}) => resourcePaginator.enrichForPagination("taxes", this.pageOfListTaxes, request);
+  pageOfListInvoices = (request = {}) => this.client.fetch(
+    {
+      method: "GET",
+      path: `/billing/v2beta1/invoices`,
+      urlParams: marshalling.urlParams(
+        ["billing_period_start_after", request.billingPeriodStartAfter],
+        ["billing_period_start_before", request.billingPeriodStartBefore],
+        ["invoice_type", request.invoiceType],
+        ["order_by", request.orderBy],
+        ["organization_id", request.organizationId],
+        ["page", request.page],
+        [
+          "page_size",
+          request.pageSize ?? this.client.settings.defaultPageSize
+        ]
+      )
+    },
+    marshalling_gen.unmarshalListInvoicesResponse
+  );
+  /**
+   * 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
+   */
+  listInvoices = (request = {}) => resourcePaginator.enrichForPagination("invoices", this.pageOfListInvoices, request);
+  /**
+   * Export invoices. Export invoices in a CSV file.
+   *
+   * @param request - The request {@link ExportInvoicesRequest}
+   * @returns A Promise of Blob
+   */
+  exportInvoices = (request = {}) => this.client.fetch({
+    method: "GET",
+    path: `/billing/v2beta1/export-invoices`,
+    urlParams: marshalling.urlParams(
+      ["dl", 1],
+      ["billing_period_start_after", request.billingPeriodStartAfter],
+      ["billing_period_start_before", request.billingPeriodStartBefore],
+      ["file_type", request.fileType],
+      ["invoice_type", request.invoiceType],
+      ["order_by", request.orderBy],
+      ["organization_id", request.organizationId],
+      ["page", request.page],
+      ["page_size", request.pageSize ?? this.client.settings.defaultPageSize]
+    ),
+    responseType: "blob"
+  });
+  /**
+   * Get an invoice. Get a specific invoice, specified by its ID.
+   *
+   * @param request - The request {@link GetInvoiceRequest}
+   * @returns A Promise of Invoice
+   */
+  getInvoice = (request) => this.client.fetch(
+    {
+      method: "GET",
+      path: `/billing/v2beta1/invoices/${marshalling.validatePathParam("invoiceId", request.invoiceId)}`
+    },
+    marshalling_gen.unmarshalInvoice
+  );
+  /**
+   * Download an invoice. Download a specific invoice, specified by its ID.
+   *
+   * @param request - The request {@link DownloadInvoiceRequest}
+   * @returns A Promise of Blob
+   */
+  downloadInvoice = (request) => this.client.fetch({
+    method: "GET",
+    path: `/billing/v2beta1/invoices/${marshalling.validatePathParam("invoiceId", request.invoiceId)}/download`,
+    urlParams: marshalling.urlParams(["dl", 1], ["file_type", request.fileType]),
+    responseType: "blob"
+  });
+  pageOfListDiscounts = (request = {}) => this.client.fetch(
+    {
+      method: "GET",
+      path: `/billing/v2beta1/discounts`,
+      urlParams: marshalling.urlParams(
+        ["order_by", request.orderBy],
+        ["organization_id", request.organizationId],
+        ["page", request.page],
+        [
+          "page_size",
+          request.pageSize ?? this.client.settings.defaultPageSize
+        ]
+      )
+    },
+    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.
+   *
+   * @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

@@ -0,0 +1,104 @@
+import { API as ParentAPI } from '../../../bridge';
+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.
+ */
+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.
+     *
+     * @param request - The request {@link ListConsumptionsRequest}
+     * @returns A Promise of ListConsumptionsResponse
+     */
+    listConsumptions: (request?: Readonly<ListConsumptionsRequest>) => Promise<ListConsumptionsResponse> & {
+        all: () => Promise<import("./types.gen").ListConsumptionsResponseConsumption[]>;
+        [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>;
+    /**
+     * 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
+     */
+    listTaxes: (request?: Readonly<ListTaxesRequest>) => Promise<ListTaxesResponse> & {
+        all: () => Promise<import("./types.gen").ListTaxesResponseTax[]>;
+        [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>;
+    /**
+     * 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
+     */
+    listInvoices: (request?: Readonly<ListInvoicesRequest>) => Promise<ListInvoicesResponse> & {
+        all: () => Promise<Invoice[]>;
+        [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.
+     *
+     * @param request - The request {@link ExportInvoicesRequest}
+     * @returns A Promise of Blob
+     */
+    exportInvoices: (request?: Readonly<ExportInvoicesRequest>) => Promise<Blob>;
+    /**
+     * Get an invoice. Get a specific invoice, specified by its ID.
+     *
+     * @param request - The request {@link GetInvoiceRequest}
+     * @returns A Promise of Invoice
+     */
+    getInvoice: (request: Readonly<GetInvoiceRequest>) => Promise<Invoice>;
+    /**
+     * Download an invoice. Download a specific invoice, specified by its ID.
+     *
+     * @param request - The request {@link DownloadInvoiceRequest}
+     * @returns A Promise of Blob
+     */
+    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.
+     *
+     * @param request - The request {@link ListDiscountsRequest}
+     * @returns A Promise of ListDiscountsResponse
+     */
+    listDiscounts: (request?: Readonly<ListDiscountsRequest>) => Promise<ListDiscountsResponse> & {
+        all: () => Promise<import("./types.gen").Discount[]>;
+        [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
+         */
+    };
+}