@scaleway/sdk-billing 2.5.1 → 2.6.0

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

@@ -1,5 +1,5 @@
 import { API as ParentAPI } from '@scaleway/sdk-client';
-import type { Discount, DownloadInvoiceRequest, ExportInvoicesRequest, GetInvoiceRequest, Invoice, ListConsumptionsRequest, ListConsumptionsResponse, ListDiscountsRequest, ListDiscountsResponse, ListInvoicesRequest, ListInvoicesResponse, ListTaxesRequest, ListTaxesResponse, RedeemCouponRequest } from './types.gen.js';
+import type { Discount, DownloadInvoiceRequest, ExportInvoicesRequest, FinOpsApiListChargesRequest, GetInvoiceRequest, Invoice, ListChargesResponse, ListConsumptionsRequest, ListConsumptionsResponse, ListDiscountsRequest, ListDiscountsResponse, ListInvoicesRequest, ListInvoicesResponse, ListTaxesRequest, ListTaxesResponse, RedeemCouponRequest } from './types.gen.js';
 /**
  * Billing API.
 
@@ -82,3 +82,15 @@ export declare class API extends ParentAPI {
      */
     redeemCoupon: (request: Readonly<RedeemCouponRequest>) => Promise<Discount>;
 }
+/**
+ * Billing FinOps API.
+ */
+export declare class FinOpsAPI extends ParentAPI {
+    /**
+     * List charges. List charges for organizations or projects. You must specify at least `organization_ids` or `project_ids`.
+     *
+     * @param request - The request {@link FinOpsApiListChargesRequest}
+     * @returns A Promise of ListChargesResponse
+     */
+    listCharges: (request?: Readonly<FinOpsApiListChargesRequest>) => Promise<ListChargesResponse>;
+}

package/dist/v2beta1/api.gen.js

@@ -1,4 +1,4 @@
-import { unmarshalDiscount, unmarshalInvoice, unmarshalListConsumptionsResponse, unmarshalListDiscountsResponse, unmarshalListInvoicesResponse, unmarshalListTaxesResponse } from "./marshalling.gen.js";
+import { unmarshalDiscount, unmarshalInvoice, unmarshalListChargesResponse, unmarshalListConsumptionsResponse, unmarshalListDiscountsResponse, unmarshalListInvoicesResponse, unmarshalListTaxesResponse } from "./marshalling.gen.js";
 import { API as API$1, enrichForPagination, resolveOneOf, urlParams, validatePathParam } from "@scaleway/sdk-client";
 //#region src/v2beta1/api.gen.ts
 /**
@@ -64,5 +64,18 @@ var API = class extends API$1 {
 		}, unmarshalDiscount);
 	}
 };
+/**
+* Billing FinOps API.
+*/
+var FinOpsAPI = class extends API$1 {
+	constructor(..._args2) {
+		super(..._args2);
+		this.listCharges = (request = {}) => this.client.fetch({
+			method: "GET",
+			path: `/billing/v2beta1/charges`,
+			urlParams: urlParams(["clamp_to_time_range", request.clampToTimeRange], ["end_date_before", request.endDateBefore], ["invoice_ids", request.invoiceIds], ["order_by", request.orderBy], ["organization_id", request.organizationId ?? this.client.settings.defaultOrganizationId], ["page_size", request.pageSize ?? this.client.settings.defaultPageSize], ["page_token", request.pageToken], ["project_ids", request.projectIds], ["resource_ids", request.resourceIds], ["resource_names", request.resourceNames], ["skus", request.skus], ["start_date_after", request.startDateAfter])
+		}, unmarshalListChargesResponse);
+	}
+};
 //#endregion
-export { API };
+export { API, FinOpsAPI };

package/dist/v2beta1/index.gen.d.ts

@@ -1,3 +1,4 @@
-export { API, } from './api.gen.js';
+export { API, FinOpsAPI, } from './api.gen.js';
 export * from './marshalling.gen.js';
-export type { Discount, DiscountCoupon, DiscountDiscountMode, DiscountFilter, DiscountFilterType, DownloadInvoiceRequest, DownloadInvoiceRequestFileType, ExportInvoicesRequest, ExportInvoicesRequestFileType, ExportInvoicesRequestOrderBy, GetInvoiceRequest, Invoice, InvoiceType, ListConsumptionsRequest, ListConsumptionsRequestOrderBy, ListConsumptionsResponse, ListConsumptionsResponseConsumption, ListDiscountsRequest, ListDiscountsRequestOrderBy, ListDiscountsResponse, ListInvoicesRequest, ListInvoicesRequestOrderBy, ListInvoicesResponse, ListTaxesRequest, ListTaxesRequestOrderBy, ListTaxesResponse, ListTaxesResponseTax, RedeemCouponRequest, } from './types.gen.js';
+export type { Charge, Discount, DiscountCoupon, DiscountDiscountMode, DiscountFilter, DiscountFilterType, DownloadInvoiceRequest, DownloadInvoiceRequestFileType, ExportInvoicesRequest, ExportInvoicesRequestFileType, ExportInvoicesRequestOrderBy, FinOpsApiListChargesRequest, GetInvoiceRequest, Invoice, InvoiceType, ListChargesRequestOrderBy, ListChargesResponse, ListConsumptionsRequest, ListConsumptionsRequestOrderBy, ListConsumptionsResponse, ListConsumptionsResponseConsumption, ListDiscountsRequest, ListDiscountsRequestOrderBy, ListDiscountsResponse, ListInvoicesRequest, ListInvoicesRequestOrderBy, ListInvoicesResponse, ListTaxesRequest, ListTaxesRequestOrderBy, ListTaxesResponse, ListTaxesResponseTax, RedeemCouponRequest, } from './types.gen.js';
+export * as ValidationRules from './validation-rules.gen.js';

package/dist/v2beta1/index.gen.js

@@ -1,15 +1,19 @@
 import { __exportAll } from "../_virtual/_rolldown/runtime.js";
-import { unmarshalDiscount, unmarshalInvoice, unmarshalListConsumptionsResponse, unmarshalListDiscountsResponse, unmarshalListInvoicesResponse, unmarshalListTaxesResponse } from "./marshalling.gen.js";
-import { API } from "./api.gen.js";
+import { unmarshalDiscount, unmarshalInvoice, unmarshalListChargesResponse, unmarshalListConsumptionsResponse, unmarshalListDiscountsResponse, unmarshalListInvoicesResponse, unmarshalListTaxesResponse } from "./marshalling.gen.js";
+import { API, FinOpsAPI } from "./api.gen.js";
+import { validation_rules_gen_exports } from "./validation-rules.gen.js";
 //#region src/v2beta1/index.gen.ts
 var index_gen_exports = /* @__PURE__ */ __exportAll({
 	API: () => API,
+	FinOpsAPI: () => FinOpsAPI,
+	ValidationRules: () => validation_rules_gen_exports,
 	unmarshalDiscount: () => unmarshalDiscount,
 	unmarshalInvoice: () => unmarshalInvoice,
+	unmarshalListChargesResponse: () => unmarshalListChargesResponse,
 	unmarshalListConsumptionsResponse: () => unmarshalListConsumptionsResponse,
 	unmarshalListDiscountsResponse: () => unmarshalListDiscountsResponse,
 	unmarshalListInvoicesResponse: () => unmarshalListInvoicesResponse,
 	unmarshalListTaxesResponse: () => unmarshalListTaxesResponse
 });
 //#endregion
-export { API, index_gen_exports, unmarshalDiscount, unmarshalInvoice, unmarshalListConsumptionsResponse, unmarshalListDiscountsResponse, unmarshalListInvoicesResponse, unmarshalListTaxesResponse };
+export { API, FinOpsAPI, validation_rules_gen_exports as ValidationRules, index_gen_exports, unmarshalDiscount, unmarshalInvoice, unmarshalListChargesResponse, unmarshalListConsumptionsResponse, unmarshalListDiscountsResponse, unmarshalListInvoicesResponse, unmarshalListTaxesResponse };

package/dist/v2beta1/marshalling.gen.d.ts

@@ -1,6 +1,7 @@
-import type { Discount, Invoice, ListConsumptionsResponse, ListDiscountsResponse, ListInvoicesResponse, ListTaxesResponse } from './types.gen.js';
+import type { Discount, Invoice, ListChargesResponse, ListConsumptionsResponse, ListDiscountsResponse, ListInvoicesResponse, ListTaxesResponse } from './types.gen.js';
 export declare const unmarshalDiscount: (data: unknown) => Discount;
 export declare const unmarshalInvoice: (data: unknown) => Invoice;
+export declare const unmarshalListChargesResponse: (data: unknown) => ListChargesResponse;
 export declare const unmarshalListConsumptionsResponse: (data: unknown) => ListConsumptionsResponse;
 export declare const unmarshalListDiscountsResponse: (data: unknown) => ListDiscountsResponse;
 export declare const unmarshalListInvoicesResponse: (data: unknown) => ListInvoicesResponse;

package/dist/v2beta1/marshalling.gen.js

@@ -51,6 +51,28 @@ const unmarshalInvoice = (data) => {
 		type: data.type
 	};
 };
+const unmarshalCharge = (data) => {
+	if (!isJSONObject(data)) throw new TypeError(`Unmarshalling the type 'Charge' failed as data isn't a dictionary.`);
+	return {
+		endDate: unmarshalDate(data.end_date),
+		invoiceId: data.invoice_id,
+		organizationId: data.organization_id,
+		price: data.price ? unmarshalMoney(data.price) : void 0,
+		projectId: data.project_id,
+		resourceId: data.resource_id,
+		resourceName: data.resource_name,
+		sku: data.sku,
+		startDate: unmarshalDate(data.start_date),
+		updatedAt: unmarshalDate(data.updated_at)
+	};
+};
+const unmarshalListChargesResponse = (data) => {
+	if (!isJSONObject(data)) throw new TypeError(`Unmarshalling the type 'ListChargesResponse' failed as data isn't a dictionary.`);
+	return {
+		charges: unmarshalArrayOfObject(data.charges, unmarshalCharge),
+		nextPageToken: data.next_page_token
+	};
+};
 const unmarshalListConsumptionsResponseConsumption = (data) => {
 	if (!isJSONObject(data)) throw new TypeError(`Unmarshalling the type 'ListConsumptionsResponseConsumption' failed as data isn't a dictionary.`);
 	return {
@@ -106,4 +128,4 @@ const unmarshalListTaxesResponse = (data) => {
 	};
 };
 //#endregion
-export { unmarshalDiscount, unmarshalInvoice, unmarshalListConsumptionsResponse, unmarshalListDiscountsResponse, unmarshalListInvoicesResponse, unmarshalListTaxesResponse };
+export { unmarshalDiscount, unmarshalInvoice, unmarshalListChargesResponse, unmarshalListConsumptionsResponse, unmarshalListDiscountsResponse, unmarshalListInvoicesResponse, unmarshalListTaxesResponse };

package/dist/v2beta1/metadata.gen.d.ts

@@ -1,62 +1,77 @@
 export declare const queriesMetadata: {
-    readonly namespace: "billing";
-    readonly version: "v2beta1";
-    readonly folderName: "billingv2beta1";
+    readonly namespace: 'billing';
+    readonly version: 'v2beta1';
+    readonly folderName: 'billingv2beta1';
     readonly services: readonly [{
-        readonly apiClass: "API";
+        readonly apiClass: 'API';
         readonly methods: readonly [{
-            readonly methodName: "listConsumptions";
-            readonly protoName: "ListConsumptions";
-            readonly paramsType: "ListConsumptionsRequest";
-            readonly returnType: "ListConsumptionsResponse";
+            readonly methodName: 'listConsumptions';
+            readonly protoName: 'ListConsumptions';
+            readonly paramsType: 'ListConsumptionsRequest';
+            readonly returnType: 'ListConsumptionsResponse';
             readonly isList: true;
-            readonly paginationType: "offset";
-            readonly pageParamKey: "page";
-            readonly listItemType: "ListConsumptionsResponseConsumption";
+            readonly paginationType: 'offset';
+            readonly pageParamKey: 'page';
+            readonly listItemType: 'ListConsumptionsResponseConsumption';
             readonly isPrivate: false;
-            readonly description: "\"";
+            readonly description: '"';
         }, {
-            readonly methodName: "listTaxes";
-            readonly protoName: "ListTaxes";
-            readonly paramsType: "ListTaxesRequest";
-            readonly returnType: "ListTaxesResponse";
+            readonly methodName: 'listTaxes';
+            readonly protoName: 'ListTaxes';
+            readonly paramsType: 'ListTaxesRequest';
+            readonly returnType: 'ListTaxesResponse';
             readonly isList: true;
-            readonly paginationType: "offset";
-            readonly pageParamKey: "page";
-            readonly listItemType: "ListTaxesResponseTax";
+            readonly paginationType: 'offset';
+            readonly pageParamKey: 'page';
+            readonly listItemType: 'ListTaxesResponseTax';
             readonly isPrivate: false;
-            readonly description: "\"";
+            readonly description: '"';
         }, {
-            readonly methodName: "listInvoices";
-            readonly protoName: "ListInvoices";
-            readonly paramsType: "ListInvoicesRequest";
-            readonly returnType: "ListInvoicesResponse";
+            readonly methodName: 'listInvoices';
+            readonly protoName: 'ListInvoices';
+            readonly paramsType: 'ListInvoicesRequest';
+            readonly returnType: 'ListInvoicesResponse';
             readonly isList: true;
-            readonly paginationType: "offset";
-            readonly pageParamKey: "page";
-            readonly listItemType: "Invoice";
+            readonly paginationType: 'offset';
+            readonly pageParamKey: 'page';
+            readonly listItemType: 'Invoice';
             readonly isPrivate: false;
-            readonly description: "\"";
+            readonly description: '"';
         }, {
-            readonly methodName: "getInvoice";
-            readonly protoName: "GetInvoice";
-            readonly paramsType: "GetInvoiceRequest";
-            readonly returnType: "Invoice";
+            readonly methodName: 'getInvoice';
+            readonly protoName: 'GetInvoice';
+            readonly paramsType: 'GetInvoiceRequest';
+            readonly returnType: 'Invoice';
             readonly isList: false;
-            readonly paginationType: "none";
+            readonly paginationType: 'none';
             readonly isPrivate: false;
-            readonly description: "\"";
+            readonly description: '"';
         }, {
-            readonly methodName: "listDiscounts";
-            readonly protoName: "ListDiscounts";
-            readonly paramsType: "ListDiscountsRequest";
-            readonly returnType: "ListDiscountsResponse";
+            readonly methodName: 'listDiscounts';
+            readonly protoName: 'ListDiscounts';
+            readonly paramsType: 'ListDiscountsRequest';
+            readonly returnType: 'ListDiscountsResponse';
             readonly isList: true;
-            readonly paginationType: "offset";
-            readonly pageParamKey: "page";
-            readonly listItemType: "Discount";
+            readonly paginationType: 'offset';
+            readonly pageParamKey: 'page';
+            readonly listItemType: 'Discount';
             readonly isPrivate: false;
-            readonly description: "\"";
+            readonly description: '"';
+        }];
+    }, {
+        readonly apiClass: 'FinOpsAPI';
+        readonly methods: readonly [{
+            readonly methodName: 'listCharges';
+            readonly protoName: 'ListCharges';
+            readonly paramsType: 'FinOpsApiListChargesRequest';
+            readonly returnType: 'ListChargesResponse';
+            readonly isList: true;
+            readonly paginationType: 'cursor';
+            readonly pageParamKey: 'pageToken';
+            readonly listItemType: 'Charge';
+            readonly nextPageField: 'nextPageToken';
+            readonly isPrivate: false;
+            readonly description: '"';
         }];
     }];
 };

package/dist/v2beta1/metadata.gen.js

@@ -65,6 +65,21 @@ const queriesMetadata = {
 				description: "\""
 			}
 		]
+	}, {
+		apiClass: "FinOpsAPI",
+		methods: [{
+			methodName: "listCharges",
+			protoName: "ListCharges",
+			paramsType: "FinOpsApiListChargesRequest",
+			returnType: "ListChargesResponse",
+			isList: true,
+			paginationType: "cursor",
+			pageParamKey: "pageToken",
+			listItemType: "Charge",
+			nextPageField: "nextPageToken",
+			isPrivate: false,
+			description: "\""
+		}]
 	}]
 };
 //#endregion

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

@@ -5,6 +5,7 @@ export type DownloadInvoiceRequestFileType = 'pdf';
 export type ExportInvoicesRequestFileType = 'csv';
 export type ExportInvoicesRequestOrderBy = '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 InvoiceType = 'unknown_type' | 'periodic' | 'purchase';
+export type ListChargesRequestOrderBy = 'start_date_asc' | 'start_date_desc';
 export type ListConsumptionsRequestOrderBy = 'updated_at_desc' | 'updated_at_asc' | 'category_name_desc' | 'category_name_asc';
 export type ListDiscountsRequestOrderBy = 'creation_date_desc' | 'creation_date_asc' | 'start_date_desc' | 'start_date_asc' | 'stop_date_desc' | 'stop_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';
@@ -29,6 +30,48 @@ export interface DiscountFilter {
      */
     exclude: boolean;
 }
+export interface Charge {
+    /**
+     * ID of the charged organization.
+     */
+    organizationId: string;
+    /**
+     * ID of the charged project.
+     */
+    projectId: string;
+    /**
+     * ID of the SKU the charge is priced with.
+     */
+    sku: string;
+    /**
+     * ID of the invoice including the charge.
+     */
+    invoiceId: string;
+    /**
+     * ID of the resource that incurs the charge.
+     */
+    resourceId: string;
+    /**
+     * Optional display name assigned to the resource that incurs the charge.
+     */
+    resourceName?: string;
+    /**
+     * Price of the charge.
+     */
+    price?: Money;
+    /**
+     * Start date of the charge.
+     */
+    startDate?: Date;
+    /**
+     * End date of the charge, included.
+     */
+    endDate?: Date;
+    /**
+     * Date the charge was last updated.
+     */
+    updatedAt?: Date;
+}
 export interface ListConsumptionsResponseConsumption {
     /**
      * Monetary value of the consumption.
@@ -240,12 +283,72 @@ export type ExportInvoicesRequest = {
      */
     fileType?: ExportInvoicesRequestFileType;
 };
+export type FinOpsApiListChargesRequest = {
+    /**
+     * Sort order of charges in the response.
+     */
+    orderBy?: ListChargesRequestOrderBy;
+    /**
+     * Token returned by previous call to list next paginated charges, omitted for first page.
+     */
+    pageToken?: string;
+    /**
+     * Number of charges to return per page.
+     */
+    pageSize?: number;
+    /**
+     * Minimum start date of charges to filter for, defaults to the start of the billing period.
+     */
+    startDateAfter?: Date;
+    /**
+     * Maximum end date of charges to filter for, defaults to the end of the billing period.
+     */
+    endDateBefore?: Date;
+    /**
+     * Invoice IDs to filter for, only charges from these invoices will be returned.
+     */
+    invoiceIds?: string[];
+    /**
+     * Organization ID to filter for, only charges for this organization will be returned.
+     */
+    organizationId?: string;
+    /**
+     * Project IDs to filter for, only charges for these projects will be returned.
+     */
+    projectIds?: string[];
+    /**
+     * Resource IDs to filter for, only charges for these resources will be returned.
+     */
+    resourceIds?: string[];
+    /**
+     * Resource display names to filter for, only charges for these resources will be returned.
+     */
+    resourceNames?: string[];
+    /**
+     * SKU IDs to filter for, only charges for these SKUs will be returned.
+     */
+    skus?: string[];
+    /**
+     * Clamp charges to the requested time range.
+     */
+    clampToTimeRange?: boolean;
+};
 export type GetInvoiceRequest = {
     /**
      * Invoice ID.
      */
     invoiceId: string;
 };
+export interface ListChargesResponse {
+    /**
+     * Paginated matching charges.
+     */
+    charges: Charge[];
+    /**
+     * Page token to use with following call to keep listing charges if there are more.
+     */
+    nextPageToken?: string;
+}
 export type ListConsumptionsRequest = {
     /**
      * Order consumptions list in the response by their update date.

package/dist/v2beta1/validation-rules.gen.d.ts

@@ -0,0 +1,6 @@
+export declare const FinOpsApiListChargesRequest: {
+    pageSize: {
+        greaterThanOrEqual: number;
+        lessThanOrEqual: number;
+    };
+};

package/dist/v2beta1/validation-rules.gen.js

@@ -0,0 +1,9 @@
+import { __exportAll } from "../_virtual/_rolldown/runtime.js";
+//#region src/v2beta1/validation-rules.gen.ts
+var validation_rules_gen_exports = /* @__PURE__ */ __exportAll({ FinOpsApiListChargesRequest: () => FinOpsApiListChargesRequest });
+const FinOpsApiListChargesRequest = { pageSize: {
+	greaterThanOrEqual: 1,
+	lessThanOrEqual: 1e3
+} };
+//#endregion
+export { FinOpsApiListChargesRequest, validation_rules_gen_exports };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@scaleway/sdk-billing",
-  "version": "2.5.1",
+  "version": "2.6.0",
   "description": "Scaleway SDK billing",
   "license": "Apache-2.0",
   "repository": {
@@ -32,17 +32,17 @@
   },
   "dependencies": {
     "@scaleway/random-name": "5.1.4",
-    "@scaleway/sdk-std": "2.4.1"
+    "@scaleway/sdk-std": "2.4.2"
   },
   "devDependencies": {
-    "@repo/configs": "^0.1.1",
-    "@scaleway/sdk-client": "^2.3.1"
+    "@scaleway/sdk-client": "^2.4.0",
+    "@repo/configs": "^0.1.1"
   },
   "peerDependencies": {
-    "@scaleway/sdk-client": "^2.3.1"
+    "@scaleway/sdk-client": "^2.4.0"
   },
   "engines": {
-    "node": ">=20.19.6"
+    "node": ">=20.20.2"
   },
   "scripts": {
     "package:check": "pnpm publint",