lago-javascript-client 1.33.4 → 1.36.0

package/esm/openapi/client.d.ts

@@ -2093,6 +2093,11 @@ export interface FeeObject {
      * @example "312.5"
      */
     precise_unit_amount: string;
+    /**
+     * The total number of units that have been aggregated for this specific fee.
+     * @example "0.32"
+     */
+    total_aggregated_units: string;
     /**
      * The cost of this specific fee, including any applicable taxes.
      * @example 120
@@ -2240,7 +2245,7 @@ export interface FeeObject {
          */
         lago_item_id: string;
         /**
-         * The type of the fee item. Possible values are `AddOn`, `BillableMetric`, `WalletTransaction`, `Subscription` or `Commitment`.
+         * The type of the fee item. Possible values are `AddOn`, `BillableMetric`, `WalletTransaction`, `Subscription`.
          * @example "Subscription"
          */
         item_type: "AddOn" | "BillableMetric" | "Subscription" | "WalletTransaction";
@@ -3876,6 +3881,11 @@ export interface WalletRecurringTransactionRule {
      * @example "Tokens for models 'high-fidelity-boost'"
      */
     transaction_name: string | null;
+    /**
+     * When true, allows rule to topped up wallet with transactions that exceed the paid top-up limits. Defaults to false.
+     * @example false
+     */
+    ignore_paid_top_up_limits: boolean;
 }
 export interface WalletObject {
     /**
@@ -4005,6 +4015,16 @@ export interface WalletObject {
      * @example "2.0"
      */
     credits_ongoing_usage_balance: string;
+    /**
+     * Minimum amount of cents that can be top-up with a single paid transaction.
+     * @example 100
+     */
+    paid_top_up_min_amount_cents?: number | null;
+    /**
+     * Maximum amount of cents that can be top-up with a single paid transaction.
+     * @example 1000
+     */
+    paid_top_up_max_amount_cents?: number | null;
 }
 export interface WalletsPaginated {
     wallets: WalletObject[];
@@ -4036,6 +4056,12 @@ export type CustomerChargeFiltersUsageObject = {
      * @example "0.9"
      */
     units?: string;
+    /**
+     * The total number of units consumed by the customer for a specific charge item, aggregated across all usage events.
+     * @pattern ^[0-9]+.?[0-9]*$
+     * @example "1.0"
+     */
+    total_aggregated_units?: string;
     /**
      * The amount in cents, tax excluded, consumed for a specific charge filter related to a charge item.
      * @example 1000
@@ -4077,6 +4103,12 @@ export type CustomerChargeGroupedUsageObject = {
      * @example "0.9"
      */
     units?: string;
+    /**
+     * The total number of units consumed by the customer for a specific charge item, aggregated across all usage events.
+     * @pattern ^[0-9]+.?[0-9]*$
+     * @example "1.0"
+     */
+    total_aggregated_units?: string;
     /** Details about the pricing unit used for charge usage. */
     pricing_unit_details?: UsagePricingUnitDetailsObject;
     /** Key value list of event properties aggregated by the charge model */
@@ -4091,6 +4123,12 @@ export interface CustomerChargeUsageObject {
      * @example "1.0"
      */
     units: string;
+    /**
+     * The total number of units consumed by the customer for a specific charge item, aggregated across all usage events.
+     * @pattern ^[0-9]+.?[0-9]*$
+     * @example "1.0"
+     */
+    total_aggregated_units: string;
     /**
      * The quantity of usage events that have been recorded for a particular charge during the specified time period. These events may also be referred to as the number of transactions in some contexts.
      * @example 10
@@ -6156,28 +6194,28 @@ export interface PlanOverridesObject {
     usage_thresholds?: UsageThresholdInput[];
 }
 export interface SubscriptionCreateInput {
-    subscription: {
+    /**
+     * Optionally, you can create a pre-authorization on the customer's card before creating a subscription. This process places a temporary hold (capture) for a specified amount on the customer's account, but does not actually withdraw the funds.
+     *
+     * Important notes:
+     *   - The final amount due for the subscription is not known at the time of creation; it is determined only after the invoice is finalized.
+     *   - The payment intent generated for pre-authorization cannot be reused, as the final invoice amount may exceed the authorized amount.
+     *   - The payment intent is canceled immediately after creation, but this cancellation occurs asynchronously.
+     *   - For these reasons, it is recommended to use a small amount (such as $1) for pre-authorization. While this does not guarantee sufficient funds for the final payment, it helps reduce the likelihood of payment errors.
+     */
+    authorization?: {
         /**
-         * Optionally, you can create a pre-authorization on the customer's card before creating a subscription. This process places a temporary hold (capture) for a specified amount on the customer's account, but does not actually withdraw the funds.
-         *
-         * Important notes:
-         *   - The final amount due for the subscription is not known at the time of creation; it is determined only after the invoice is finalized.
-         *   - The payment intent generated for pre-authorization cannot be reused, as the final invoice amount may exceed the authorized amount.
-         *   - The payment intent is canceled immediately after creation, but this cancellation occurs asynchronously.
-         *   - For these reasons, it is recommended to use a small amount (such as $1) for pre-authorization. While this does not guarantee sufficient funds for the final payment, it helps reduce the likelihood of payment errors.
+         * The amount of the authorization in cents.
+         * @example 1000
          */
-        authorization?: {
-            /**
-             * The amount of the authorization in cents.
-             * @example 1000
-             */
-            amount_cents: number;
-            /**
-             * The currency of the authorization.
-             * @example "USD"
-             */
-            amount_currency: string;
-        };
+        amount_cents: number;
+        /**
+         * The currency of the authorization.
+         * @example "USD"
+         */
+        amount_currency: string;
+    };
+    subscription: {
         /**
          * The code of the billing entity to be used for the subscription. If not provided, the default billing entity will be used.
          * @example "default"
@@ -6625,6 +6663,21 @@ export interface WalletCreateInput {
              */
             billable_metric_codes?: any[] | null;
         };
+        /**
+         * Minimum amount of cents that can be top-up with a single paid transaction.
+         * @example 100
+         */
+        paid_top_up_min_amount_cents?: number | null;
+        /**
+         * Maximum amount of cents that can be top-up with a single paid transaction.
+         * @example 1000
+         */
+        paid_top_up_max_amount_cents?: number | null;
+        /**
+         * If set to true, the wallet will ignore paid top-up limits on creation.
+         * @example false
+         */
+        ignore_paid_top_up_limits_on_creation?: boolean | null;
         /** List of recurring transaction rules. Currently, we only allow one recurring rule per wallet. */
         recurring_transaction_rules?: any[] | null;
     };
@@ -6783,6 +6836,11 @@ export interface WalletTransactionCreateInput {
          * @example false
          */
         invoice_requires_successful_payment?: boolean;
+        /**
+         * When true, allows topping up the wallet with transactions that exceed the paid top-up limits. Defaults to false.
+         * @example false
+         */
+        ignore_paid_top_up_limits?: boolean;
         /**
          * This optional field allows you to store a list of key-value pairs that hold additional information or custom attributes related to the data.
          * @example [{"key":"example key","value":"example value"},{"key":"another key","value":"another value"}]
@@ -7468,7 +7526,7 @@ export declare class HttpClient<SecurityDataType = unknown> {
 }
 /**
  * @title Lago API documentation
- * @version 1.33.3
+ * @version 1.36.0
  * @license AGPLv3
  * @baseUrl https://api.getlago.com/api/v1
  * @externalDocs https://github.com/getlago
@@ -8344,6 +8402,51 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
              * @example ["billing_entity_code_1","billing_entity_code_2"]
              */
             "billing_entity_codes[]"?: string[];
+            /**
+             * Filter customers by search term. This will filter all customers whose name, firstname, lastname, legal name, external id or email contain the search term.
+             * @example "John Doe"
+             */
+            search_term?: string;
+            /**
+             * Filter customers by countries. Possible values are the ISO 3166-1 alpha-2 codes.
+             * @example ["US","FR"]
+             */
+            "countries[]"?: Country[];
+            /**
+             * Filter customers by states.
+             * @example ["CA","Paris"]
+             */
+            "states[]"?: string[];
+            /**
+             * Filter customers by zipcodes.
+             * @example ["10115","75001"]
+             */
+            "zipcodes[]"?: string[];
+            /**
+             * Filter customers by currencies.
+             * @example ["USD","EUR"]
+             */
+            "currencies[]"?: Currency[];
+            /**
+             * Filter customers by whether they have a tax identification number or not.
+             * @example true
+             */
+            has_tax_identification_number?: boolean;
+            /**
+             * Filter customers by metadata. Replace `key` with the actual metadata key you want to match, and provide the corresponding value. Providing empty value will search for customers without given metadata key. For example, `metadata[is_synced]=true&metadata[last_synced_at]=`.
+             * @example "value"
+             */
+            "metadata[key]"?: string;
+            /**
+             * Filter customers by customer type.
+             * @example "company"
+             */
+            customer_type?: "company" | "individual";
+            /**
+             * Filter customers by whether they have a customer type or not.
+             * @example true
+             */
+            has_customer_type?: boolean;
         }, params?: RequestParams) => Promise<HttpResponse<CustomersPaginated, ApiErrorUnauthorized>>;
         /**
          * @description This endpoint retrieves an existing customer.
@@ -8799,6 +8902,11 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
              * @example "event-123"
              */
             code?: string;
+            /**
+             * Requires `external_subscription_id` to be set. Filter events by timestamp after the subscription started at datetime.
+             * @example true
+             */
+            timestamp_from_started_at?: boolean;
             /**
              * Filter events by timestamp starting from a specific date.
              * @format date-time

package/esm/openapi/client.js

@@ -148,7 +148,7 @@ export class HttpClient {
 }
 /**
  * @title Lago API documentation
- * @version 1.33.3
+ * @version 1.36.0
  * @license AGPLv3
  * @baseUrl https://api.getlago.com/api/v1
  * @externalDocs https://github.com/getlago

package/package.json

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

package/script/openapi/client.d.ts

@@ -2093,6 +2093,11 @@ export interface FeeObject {
      * @example "312.5"
      */
     precise_unit_amount: string;
+    /**
+     * The total number of units that have been aggregated for this specific fee.
+     * @example "0.32"
+     */
+    total_aggregated_units: string;
     /**
      * The cost of this specific fee, including any applicable taxes.
      * @example 120
@@ -2240,7 +2245,7 @@ export interface FeeObject {
          */
         lago_item_id: string;
         /**
-         * The type of the fee item. Possible values are `AddOn`, `BillableMetric`, `WalletTransaction`, `Subscription` or `Commitment`.
+         * The type of the fee item. Possible values are `AddOn`, `BillableMetric`, `WalletTransaction`, `Subscription`.
          * @example "Subscription"
          */
         item_type: "AddOn" | "BillableMetric" | "Subscription" | "WalletTransaction";
@@ -3876,6 +3881,11 @@ export interface WalletRecurringTransactionRule {
      * @example "Tokens for models 'high-fidelity-boost'"
      */
     transaction_name: string | null;
+    /**
+     * When true, allows rule to topped up wallet with transactions that exceed the paid top-up limits. Defaults to false.
+     * @example false
+     */
+    ignore_paid_top_up_limits: boolean;
 }
 export interface WalletObject {
     /**
@@ -4005,6 +4015,16 @@ export interface WalletObject {
      * @example "2.0"
      */
     credits_ongoing_usage_balance: string;
+    /**
+     * Minimum amount of cents that can be top-up with a single paid transaction.
+     * @example 100
+     */
+    paid_top_up_min_amount_cents?: number | null;
+    /**
+     * Maximum amount of cents that can be top-up with a single paid transaction.
+     * @example 1000
+     */
+    paid_top_up_max_amount_cents?: number | null;
 }
 export interface WalletsPaginated {
     wallets: WalletObject[];
@@ -4036,6 +4056,12 @@ export type CustomerChargeFiltersUsageObject = {
      * @example "0.9"
      */
     units?: string;
+    /**
+     * The total number of units consumed by the customer for a specific charge item, aggregated across all usage events.
+     * @pattern ^[0-9]+.?[0-9]*$
+     * @example "1.0"
+     */
+    total_aggregated_units?: string;
     /**
      * The amount in cents, tax excluded, consumed for a specific charge filter related to a charge item.
      * @example 1000
@@ -4077,6 +4103,12 @@ export type CustomerChargeGroupedUsageObject = {
      * @example "0.9"
      */
     units?: string;
+    /**
+     * The total number of units consumed by the customer for a specific charge item, aggregated across all usage events.
+     * @pattern ^[0-9]+.?[0-9]*$
+     * @example "1.0"
+     */
+    total_aggregated_units?: string;
     /** Details about the pricing unit used for charge usage. */
     pricing_unit_details?: UsagePricingUnitDetailsObject;
     /** Key value list of event properties aggregated by the charge model */
@@ -4091,6 +4123,12 @@ export interface CustomerChargeUsageObject {
      * @example "1.0"
      */
     units: string;
+    /**
+     * The total number of units consumed by the customer for a specific charge item, aggregated across all usage events.
+     * @pattern ^[0-9]+.?[0-9]*$
+     * @example "1.0"
+     */
+    total_aggregated_units: string;
     /**
      * The quantity of usage events that have been recorded for a particular charge during the specified time period. These events may also be referred to as the number of transactions in some contexts.
      * @example 10
@@ -6156,28 +6194,28 @@ export interface PlanOverridesObject {
     usage_thresholds?: UsageThresholdInput[];
 }
 export interface SubscriptionCreateInput {
-    subscription: {
+    /**
+     * Optionally, you can create a pre-authorization on the customer's card before creating a subscription. This process places a temporary hold (capture) for a specified amount on the customer's account, but does not actually withdraw the funds.
+     *
+     * Important notes:
+     *   - The final amount due for the subscription is not known at the time of creation; it is determined only after the invoice is finalized.
+     *   - The payment intent generated for pre-authorization cannot be reused, as the final invoice amount may exceed the authorized amount.
+     *   - The payment intent is canceled immediately after creation, but this cancellation occurs asynchronously.
+     *   - For these reasons, it is recommended to use a small amount (such as $1) for pre-authorization. While this does not guarantee sufficient funds for the final payment, it helps reduce the likelihood of payment errors.
+     */
+    authorization?: {
         /**
-         * Optionally, you can create a pre-authorization on the customer's card before creating a subscription. This process places a temporary hold (capture) for a specified amount on the customer's account, but does not actually withdraw the funds.
-         *
-         * Important notes:
-         *   - The final amount due for the subscription is not known at the time of creation; it is determined only after the invoice is finalized.
-         *   - The payment intent generated for pre-authorization cannot be reused, as the final invoice amount may exceed the authorized amount.
-         *   - The payment intent is canceled immediately after creation, but this cancellation occurs asynchronously.
-         *   - For these reasons, it is recommended to use a small amount (such as $1) for pre-authorization. While this does not guarantee sufficient funds for the final payment, it helps reduce the likelihood of payment errors.
+         * The amount of the authorization in cents.
+         * @example 1000
          */
-        authorization?: {
-            /**
-             * The amount of the authorization in cents.
-             * @example 1000
-             */
-            amount_cents: number;
-            /**
-             * The currency of the authorization.
-             * @example "USD"
-             */
-            amount_currency: string;
-        };
+        amount_cents: number;
+        /**
+         * The currency of the authorization.
+         * @example "USD"
+         */
+        amount_currency: string;
+    };
+    subscription: {
         /**
          * The code of the billing entity to be used for the subscription. If not provided, the default billing entity will be used.
          * @example "default"
@@ -6625,6 +6663,21 @@ export interface WalletCreateInput {
              */
             billable_metric_codes?: any[] | null;
         };
+        /**
+         * Minimum amount of cents that can be top-up with a single paid transaction.
+         * @example 100
+         */
+        paid_top_up_min_amount_cents?: number | null;
+        /**
+         * Maximum amount of cents that can be top-up with a single paid transaction.
+         * @example 1000
+         */
+        paid_top_up_max_amount_cents?: number | null;
+        /**
+         * If set to true, the wallet will ignore paid top-up limits on creation.
+         * @example false
+         */
+        ignore_paid_top_up_limits_on_creation?: boolean | null;
         /** List of recurring transaction rules. Currently, we only allow one recurring rule per wallet. */
         recurring_transaction_rules?: any[] | null;
     };
@@ -6783,6 +6836,11 @@ export interface WalletTransactionCreateInput {
          * @example false
          */
         invoice_requires_successful_payment?: boolean;
+        /**
+         * When true, allows topping up the wallet with transactions that exceed the paid top-up limits. Defaults to false.
+         * @example false
+         */
+        ignore_paid_top_up_limits?: boolean;
         /**
          * This optional field allows you to store a list of key-value pairs that hold additional information or custom attributes related to the data.
          * @example [{"key":"example key","value":"example value"},{"key":"another key","value":"another value"}]
@@ -7468,7 +7526,7 @@ export declare class HttpClient<SecurityDataType = unknown> {
 }
 /**
  * @title Lago API documentation
- * @version 1.33.3
+ * @version 1.36.0
  * @license AGPLv3
  * @baseUrl https://api.getlago.com/api/v1
  * @externalDocs https://github.com/getlago
@@ -8344,6 +8402,51 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
              * @example ["billing_entity_code_1","billing_entity_code_2"]
              */
             "billing_entity_codes[]"?: string[];
+            /**
+             * Filter customers by search term. This will filter all customers whose name, firstname, lastname, legal name, external id or email contain the search term.
+             * @example "John Doe"
+             */
+            search_term?: string;
+            /**
+             * Filter customers by countries. Possible values are the ISO 3166-1 alpha-2 codes.
+             * @example ["US","FR"]
+             */
+            "countries[]"?: Country[];
+            /**
+             * Filter customers by states.
+             * @example ["CA","Paris"]
+             */
+            "states[]"?: string[];
+            /**
+             * Filter customers by zipcodes.
+             * @example ["10115","75001"]
+             */
+            "zipcodes[]"?: string[];
+            /**
+             * Filter customers by currencies.
+             * @example ["USD","EUR"]
+             */
+            "currencies[]"?: Currency[];
+            /**
+             * Filter customers by whether they have a tax identification number or not.
+             * @example true
+             */
+            has_tax_identification_number?: boolean;
+            /**
+             * Filter customers by metadata. Replace `key` with the actual metadata key you want to match, and provide the corresponding value. Providing empty value will search for customers without given metadata key. For example, `metadata[is_synced]=true&metadata[last_synced_at]=`.
+             * @example "value"
+             */
+            "metadata[key]"?: string;
+            /**
+             * Filter customers by customer type.
+             * @example "company"
+             */
+            customer_type?: "company" | "individual";
+            /**
+             * Filter customers by whether they have a customer type or not.
+             * @example true
+             */
+            has_customer_type?: boolean;
         }, params?: RequestParams) => Promise<HttpResponse<CustomersPaginated, ApiErrorUnauthorized>>;
         /**
          * @description This endpoint retrieves an existing customer.
@@ -8799,6 +8902,11 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
              * @example "event-123"
              */
             code?: string;
+            /**
+             * Requires `external_subscription_id` to be set. Filter events by timestamp after the subscription started at datetime.
+             * @example true
+             */
+            timestamp_from_started_at?: boolean;
             /**
              * Filter events by timestamp starting from a specific date.
              * @format date-time

package/script/openapi/client.js

@@ -152,7 +152,7 @@ class HttpClient {
 exports.HttpClient = HttpClient;
 /**
  * @title Lago API documentation
- * @version 1.33.3
+ * @version 1.36.0
  * @license AGPLv3
  * @baseUrl https://api.getlago.com/api/v1
  * @externalDocs https://github.com/getlago