lago-javascript-client 1.12.2 → 1.12.3

package/README.md

@@ -5,6 +5,13 @@ This is a JavaScript wrapper for Lago API. Works in Cloudflare Workers, Deno, an
 [![PyPI version](https://badge.fury.io/js/lago-javascript-client.svg)](https://badge.fury.io/js/lago-javascript-client)
 [![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](https://spdx.org/licenses/MIT.html)
 
+## Current Releases
+
+| Project            | Release Badge                                                                                       |
+|--------------------|-----------------------------------------------------------------------------------------------------|
+| **Lago**           | [![Lago Release](https://img.shields.io/github/v/release/getlago/lago)](https://github.com/getlago/lago/releases) |
+| **Lago JavaScript Client**     | [![Lago JavaScript Client Release](https://img.shields.io/github/v/release/getlago/lago-javascript-client)](https://github.com/getlago/lago-javascript-client/releases) |
+
 ## Installation
 
 For npm users:

package/esm/openapi/client.d.ts

@@ -560,8 +560,8 @@ export interface ChargeObject {
      * @example "2022-09-14T16:35:31Z"
      */
     created_at: string;
-    /** Specifies the pricing model used for the calculation of the final fee. It can be `standard`, `graduated`, `graduated_percentage`, `package`, `percentage` or `volume`. */
-    charge_model: "standard" | "graduated" | "graduated_percentage" | "package" | "percentage" | "volume";
+    /** Specifies the pricing model used for the calculation of the final fee. It can be `standard`, `graduated`, `graduated_percentage`, `package`, `percentage`, `volume` or `dynamic`. */
+    charge_model: "standard" | "graduated" | "graduated_percentage" | "package" | "percentage" | "volume" | "dynamic";
     /**
      * This field determines the billing timing for this specific usage-based charge. When set to `true`, the charge is due and invoiced immediately. Conversely, when set to `false`, the charge is due and invoiced at the end of each billing period.
      * @example true
@@ -2024,10 +2024,10 @@ export interface EventInput {
          */
         transaction_id: string;
         /**
-         * The unique identifier of the subscription within your application. It is a mandatory field when the customer possesses multiple subscriptions or when the `external_customer_id` is not provided.
+         * The unique identifier of the subscription in your application. This field is mandatory in order to link events to the correct customer subscription.
          * @example "sub_1234567890"
          */
-        external_subscription_id?: string;
+        external_subscription_id: string;
         /**
          * The code that identifies a targeted billable metric. It is essential that this code matches the `code` property of one of your active billable metrics. If the provided code does not correspond to any active billable metric, it will be ignored during the process.
          * @example "storage"
@@ -2040,6 +2040,11 @@ export interface EventInput {
          * @example "1651240791.123"
          */
         timestamp?: number | string;
+        /**
+         * The precise total amount in cents with precision used by the `dynamic` pricing model to compute the usage amount.
+         * @example "1234.56"
+         */
+        precise_total_amount_cents?: string | null;
         /**
          * This field represents additional properties associated with the event, which are utilized in the calculation of the final fee. This object becomes mandatory when the targeted billable metric employs a `sum_agg`, `max_agg`, or `unique_count_agg` aggregation method. However, when using a simple `count_agg`, this object is not required.
          * @example {"gb":10}
@@ -2076,6 +2081,11 @@ export interface EventObject {
      * @example "2022-04-29T08:59:51.123Z"
      */
     timestamp: string;
+    /**
+     * The precise total amount that was sent in the event payload. This filed is used by the `dynamic` pricing model.
+     * @example "1234.56"
+     */
+    precise_total_amount_cents?: string | null;
     /**
      * This field represents additional properties associated with the event, which are utilized in the calculation of the final fee. This object becomes mandatory when the targeted billable metric employs a `sum_agg`, `max_agg`, or `unique_count_agg` aggregation method. However, when using a simple `count_agg`, this object is not required.
      * @example {"gb":10}
@@ -3402,10 +3412,10 @@ export interface PlanCreateInput {
              */
             billable_metric_id?: string;
             /**
-             * Specifies the pricing model used for the calculation of the final fee. It can be `standard`, `graduated`, `graduated_percentage` `package`, `percentage` or `volume`.
+             * Specifies the pricing model used for the calculation of the final fee. It can be `standard`, `graduated`, `graduated_percentage` `package`, `percentage`, `volume` or `dynamic`.
              * @example "standard"
              */
-            charge_model?: "standard" | "graduated" | "graduated_percentage" | "package" | "percentage" | "volume";
+            charge_model?: "standard" | "graduated" | "graduated_percentage" | "package" | "percentage" | "volume" | "dynamic";
             /**
              * This field determines the billing timing for this specific usage-based charge. When set to `true`, the charge is due and invoiced immediately. Conversely, when set to false, the charge is due and invoiced at the end of each billing period.
              * @example false
@@ -3604,10 +3614,10 @@ export interface PlanUpdateInput {
              */
             billable_metric_id?: string;
             /**
-             * Specifies the pricing model used for the calculation of the final fee. It can be `standard`, `graduated`, `graduated_percentage`, `package`, `percentage` or `volume`.
+             * Specifies the pricing model used for the calculation of the final fee. It can be `standard`, `graduated`, `graduated_percentage`, `package`, `percentage`, `volume` or `dynamic`.
              * @example "standard"
              */
-            charge_model?: "standard" | "graduated" | "graduated_percentage" | "package" | "percentage" | "volume";
+            charge_model?: "standard" | "graduated" | "graduated_percentage" | "package" | "percentage" | "volume" | "dynamic";
             /**
              * This field determines the billing timing for this specific usage-based charge. When set to `true`, the charge is due and invoiced immediately. Conversely, when set to false, the charge is due and invoiced at the end of each billing period.
              * @example false
@@ -3924,6 +3934,18 @@ export interface SubscriptionObject {
      * @example "2022-08-08T00:00:00Z"
      */
     trial_ended_at?: string | null;
+    /**
+     * The date and time when the current billing period started, represented in ISO 8601 date format.
+     * @format date-time
+     * @example "2022-08-08T00:00:00Z"
+     */
+    current_billing_period_started_at?: string | null;
+    /**
+     * The date and time when the current billing period ends, represented in ISO 8601 date format.
+     * @format date-time
+     * @example "2022-09-08T00:00:00Z"
+     */
+    current_billing_period_ending_at?: string | null;
 }
 export type SubscriptionObjectExtended = SubscriptionObject & {
     plan?: PlanObject;
@@ -4741,7 +4763,7 @@ export declare class HttpClient<SecurityDataType = unknown> {
  * @title Lago API documentation
  * @version 1.12.2
  * @license AGPLv3
- * @baseUrl https://{region}.getlago.com/api/v1
+ * @baseUrl https://api{region}getlago.com/api/v1
  * @externalDocs https://github.com/getlago
  * @contact <tech@getlago.com>
  *
@@ -5354,6 +5376,52 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
          * @secure
          */
         createEvent: (data: EventInput, params?: RequestParams) => Promise<HttpResponse<Event, ApiErrorBadRequest | ApiErrorUnauthorized | ApiErrorUnprocessableEntity>>;
+        /**
+         * @description This endpoint is used for retrieving all events.
+         *
+         * @tags events
+         * @name FindAllEvents
+         * @summary List all events
+         * @request GET:/events
+         * @secure
+         */
+        findAllEvents: (query?: {
+            /**
+             * Page number.
+             * @example 1
+             */
+            page?: number;
+            /**
+             * Number of records per page.
+             * @example 20
+             */
+            per_page?: number;
+            /**
+             * External subscription ID
+             * @example "5eb02857-a71e-4ea2-bcf9-57d3a41bc6ba"
+             */
+            external_subscription_id?: string;
+            /**
+             * Filter events by its code.
+             * @example "event-123"
+             */
+            code?: string;
+            /**
+             * Filter events by timestamp starting from a specific date.
+             * @format date-time
+             * @example "2022-08-08T00:00:00Z"
+             */
+            timestamp_from?: string;
+            /**
+             * Filter events by timestamp up to a specific date.
+             * @format date-time
+             * @example "2022-08-08T00:00:00Z"
+             */
+            timestamp_to?: string;
+        }, params?: RequestParams) => Promise<HttpResponse<{
+            events: EventObject[];
+            meta: PaginationMeta;
+        }, ApiErrorUnauthorized>>;
         /**
          * @description This endpoint can be used to send a batch of usage records. Each request may include up to 100 events.
          *
@@ -5525,7 +5593,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
          */
         createInvoice: (data: InvoiceOneOffCreateInput, params?: RequestParams) => Promise<HttpResponse<Invoice, ApiErrorBadRequest | ApiErrorUnauthorized | ApiErrorUnprocessableEntity>>;
         /**
-         * @description This endpoint is used for retrievign all invoices.
+         * @description This endpoint is used for retrieving all invoices.
          *
          * @tags invoices
          * @name FindAllInvoices

package/esm/openapi/client.js

@@ -16,7 +16,7 @@ export var ContentType;
     ContentType["Text"] = "text/plain";
 })(ContentType || (ContentType = {}));
 export class HttpClient {
-    baseUrl = "https://{region}.getlago.com/api/v1";
+    baseUrl = "https://api{region}getlago.com/api/v1";
     securityData = null;
     securityWorker;
     abortControllers = new Map();
@@ -150,7 +150,7 @@ export class HttpClient {
  * @title Lago API documentation
  * @version 1.12.2
  * @license AGPLv3
- * @baseUrl https://{region}.getlago.com/api/v1
+ * @baseUrl https://api{region}getlago.com/api/v1
  * @externalDocs https://github.com/getlago
  * @contact <tech@getlago.com>
  *
@@ -833,6 +833,23 @@ export class Api extends HttpClient {
             format: "json",
             ...params,
         }),
+        /**
+         * @description This endpoint is used for retrieving all events.
+         *
+         * @tags events
+         * @name FindAllEvents
+         * @summary List all events
+         * @request GET:/events
+         * @secure
+         */
+        findAllEvents: (query, params = {}) => this.request({
+            path: `/events`,
+            method: "GET",
+            query: query,
+            secure: true,
+            format: "json",
+            ...params,
+        }),
         /**
          * @description This endpoint can be used to send a batch of usage records. Each request may include up to 100 events.
          *
@@ -974,7 +991,7 @@ export class Api extends HttpClient {
             ...params,
         }),
         /**
-         * @description This endpoint is used for retrievign all invoices.
+         * @description This endpoint is used for retrieving all invoices.
          *
          * @tags invoices
          * @name FindAllInvoices

package/package.json

@@ -3,7 +3,7 @@
   "main": "./script/mod.js",
   "name": "lago-javascript-client",
   "sideEffects": false,
-  "version": "v1.12.2",
+  "version": "v1.12.3",
   "description": "Lago JavaScript API Client",
   "repository": {
     "type": "git",

package/script/openapi/client.d.ts

@@ -560,8 +560,8 @@ export interface ChargeObject {
      * @example "2022-09-14T16:35:31Z"
      */
     created_at: string;
-    /** Specifies the pricing model used for the calculation of the final fee. It can be `standard`, `graduated`, `graduated_percentage`, `package`, `percentage` or `volume`. */
-    charge_model: "standard" | "graduated" | "graduated_percentage" | "package" | "percentage" | "volume";
+    /** Specifies the pricing model used for the calculation of the final fee. It can be `standard`, `graduated`, `graduated_percentage`, `package`, `percentage`, `volume` or `dynamic`. */
+    charge_model: "standard" | "graduated" | "graduated_percentage" | "package" | "percentage" | "volume" | "dynamic";
     /**
      * This field determines the billing timing for this specific usage-based charge. When set to `true`, the charge is due and invoiced immediately. Conversely, when set to `false`, the charge is due and invoiced at the end of each billing period.
      * @example true
@@ -2024,10 +2024,10 @@ export interface EventInput {
          */
         transaction_id: string;
         /**
-         * The unique identifier of the subscription within your application. It is a mandatory field when the customer possesses multiple subscriptions or when the `external_customer_id` is not provided.
+         * The unique identifier of the subscription in your application. This field is mandatory in order to link events to the correct customer subscription.
          * @example "sub_1234567890"
          */
-        external_subscription_id?: string;
+        external_subscription_id: string;
         /**
          * The code that identifies a targeted billable metric. It is essential that this code matches the `code` property of one of your active billable metrics. If the provided code does not correspond to any active billable metric, it will be ignored during the process.
          * @example "storage"
@@ -2040,6 +2040,11 @@ export interface EventInput {
          * @example "1651240791.123"
          */
         timestamp?: number | string;
+        /**
+         * The precise total amount in cents with precision used by the `dynamic` pricing model to compute the usage amount.
+         * @example "1234.56"
+         */
+        precise_total_amount_cents?: string | null;
         /**
          * This field represents additional properties associated with the event, which are utilized in the calculation of the final fee. This object becomes mandatory when the targeted billable metric employs a `sum_agg`, `max_agg`, or `unique_count_agg` aggregation method. However, when using a simple `count_agg`, this object is not required.
          * @example {"gb":10}
@@ -2076,6 +2081,11 @@ export interface EventObject {
      * @example "2022-04-29T08:59:51.123Z"
      */
     timestamp: string;
+    /**
+     * The precise total amount that was sent in the event payload. This filed is used by the `dynamic` pricing model.
+     * @example "1234.56"
+     */
+    precise_total_amount_cents?: string | null;
     /**
      * This field represents additional properties associated with the event, which are utilized in the calculation of the final fee. This object becomes mandatory when the targeted billable metric employs a `sum_agg`, `max_agg`, or `unique_count_agg` aggregation method. However, when using a simple `count_agg`, this object is not required.
      * @example {"gb":10}
@@ -3402,10 +3412,10 @@ export interface PlanCreateInput {
              */
             billable_metric_id?: string;
             /**
-             * Specifies the pricing model used for the calculation of the final fee. It can be `standard`, `graduated`, `graduated_percentage` `package`, `percentage` or `volume`.
+             * Specifies the pricing model used for the calculation of the final fee. It can be `standard`, `graduated`, `graduated_percentage` `package`, `percentage`, `volume` or `dynamic`.
              * @example "standard"
              */
-            charge_model?: "standard" | "graduated" | "graduated_percentage" | "package" | "percentage" | "volume";
+            charge_model?: "standard" | "graduated" | "graduated_percentage" | "package" | "percentage" | "volume" | "dynamic";
             /**
              * This field determines the billing timing for this specific usage-based charge. When set to `true`, the charge is due and invoiced immediately. Conversely, when set to false, the charge is due and invoiced at the end of each billing period.
              * @example false
@@ -3604,10 +3614,10 @@ export interface PlanUpdateInput {
              */
             billable_metric_id?: string;
             /**
-             * Specifies the pricing model used for the calculation of the final fee. It can be `standard`, `graduated`, `graduated_percentage`, `package`, `percentage` or `volume`.
+             * Specifies the pricing model used for the calculation of the final fee. It can be `standard`, `graduated`, `graduated_percentage`, `package`, `percentage`, `volume` or `dynamic`.
              * @example "standard"
              */
-            charge_model?: "standard" | "graduated" | "graduated_percentage" | "package" | "percentage" | "volume";
+            charge_model?: "standard" | "graduated" | "graduated_percentage" | "package" | "percentage" | "volume" | "dynamic";
             /**
              * This field determines the billing timing for this specific usage-based charge. When set to `true`, the charge is due and invoiced immediately. Conversely, when set to false, the charge is due and invoiced at the end of each billing period.
              * @example false
@@ -3924,6 +3934,18 @@ export interface SubscriptionObject {
      * @example "2022-08-08T00:00:00Z"
      */
     trial_ended_at?: string | null;
+    /**
+     * The date and time when the current billing period started, represented in ISO 8601 date format.
+     * @format date-time
+     * @example "2022-08-08T00:00:00Z"
+     */
+    current_billing_period_started_at?: string | null;
+    /**
+     * The date and time when the current billing period ends, represented in ISO 8601 date format.
+     * @format date-time
+     * @example "2022-09-08T00:00:00Z"
+     */
+    current_billing_period_ending_at?: string | null;
 }
 export type SubscriptionObjectExtended = SubscriptionObject & {
     plan?: PlanObject;
@@ -4741,7 +4763,7 @@ export declare class HttpClient<SecurityDataType = unknown> {
  * @title Lago API documentation
  * @version 1.12.2
  * @license AGPLv3
- * @baseUrl https://{region}.getlago.com/api/v1
+ * @baseUrl https://api{region}getlago.com/api/v1
  * @externalDocs https://github.com/getlago
  * @contact <tech@getlago.com>
  *
@@ -5354,6 +5376,52 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
          * @secure
          */
         createEvent: (data: EventInput, params?: RequestParams) => Promise<HttpResponse<Event, ApiErrorBadRequest | ApiErrorUnauthorized | ApiErrorUnprocessableEntity>>;
+        /**
+         * @description This endpoint is used for retrieving all events.
+         *
+         * @tags events
+         * @name FindAllEvents
+         * @summary List all events
+         * @request GET:/events
+         * @secure
+         */
+        findAllEvents: (query?: {
+            /**
+             * Page number.
+             * @example 1
+             */
+            page?: number;
+            /**
+             * Number of records per page.
+             * @example 20
+             */
+            per_page?: number;
+            /**
+             * External subscription ID
+             * @example "5eb02857-a71e-4ea2-bcf9-57d3a41bc6ba"
+             */
+            external_subscription_id?: string;
+            /**
+             * Filter events by its code.
+             * @example "event-123"
+             */
+            code?: string;
+            /**
+             * Filter events by timestamp starting from a specific date.
+             * @format date-time
+             * @example "2022-08-08T00:00:00Z"
+             */
+            timestamp_from?: string;
+            /**
+             * Filter events by timestamp up to a specific date.
+             * @format date-time
+             * @example "2022-08-08T00:00:00Z"
+             */
+            timestamp_to?: string;
+        }, params?: RequestParams) => Promise<HttpResponse<{
+            events: EventObject[];
+            meta: PaginationMeta;
+        }, ApiErrorUnauthorized>>;
         /**
          * @description This endpoint can be used to send a batch of usage records. Each request may include up to 100 events.
          *
@@ -5525,7 +5593,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
          */
         createInvoice: (data: InvoiceOneOffCreateInput, params?: RequestParams) => Promise<HttpResponse<Invoice, ApiErrorBadRequest | ApiErrorUnauthorized | ApiErrorUnprocessableEntity>>;
         /**
-         * @description This endpoint is used for retrievign all invoices.
+         * @description This endpoint is used for retrieving all invoices.
          *
          * @tags invoices
          * @name FindAllInvoices

package/script/openapi/client.js

@@ -19,7 +19,7 @@ var ContentType;
     ContentType["Text"] = "text/plain";
 })(ContentType = exports.ContentType || (exports.ContentType = {}));
 class HttpClient {
-    baseUrl = "https://{region}.getlago.com/api/v1";
+    baseUrl = "https://api{region}getlago.com/api/v1";
     securityData = null;
     securityWorker;
     abortControllers = new Map();
@@ -154,7 +154,7 @@ exports.HttpClient = HttpClient;
  * @title Lago API documentation
  * @version 1.12.2
  * @license AGPLv3
- * @baseUrl https://{region}.getlago.com/api/v1
+ * @baseUrl https://api{region}getlago.com/api/v1
  * @externalDocs https://github.com/getlago
  * @contact <tech@getlago.com>
  *
@@ -837,6 +837,23 @@ class Api extends HttpClient {
             format: "json",
             ...params,
         }),
+        /**
+         * @description This endpoint is used for retrieving all events.
+         *
+         * @tags events
+         * @name FindAllEvents
+         * @summary List all events
+         * @request GET:/events
+         * @secure
+         */
+        findAllEvents: (query, params = {}) => this.request({
+            path: `/events`,
+            method: "GET",
+            query: query,
+            secure: true,
+            format: "json",
+            ...params,
+        }),
         /**
          * @description This endpoint can be used to send a batch of usage records. Each request may include up to 100 events.
          *
@@ -978,7 +995,7 @@ class Api extends HttpClient {
             ...params,
         }),
         /**
-         * @description This endpoint is used for retrievign all invoices.
+         * @description This endpoint is used for retrieving all invoices.
          *
          * @tags invoices
          * @name FindAllInvoices