lago-javascript-client 1.2.0 → 1.3.0

package/esm/openapi/client.d.ts

@@ -3862,17 +3862,17 @@ export interface WalletCreateInput {
         /** List of recurring transaction rules. Currently, we only allow one recurring rule per wallet. */
         recurring_transaction_rules?: {
             /**
-             * The rule type. Possible values are `interval` or `threshold`.
+             * The trigger. Possible values are `interval` or `threshold`.
              * @example "interval"
              */
-            rule_type: "interval" | "threshold";
+            trigger: "interval" | "threshold";
             /**
-             * The interval used for recurring top-up. It represents the frequency at which automatic top-up occurs. The interval can be one of the following values: `weekly`, `monthly`, `quarterly` or `yearly`. Required only when rule type is `interval`.
+             * The interval used for recurring top-up. It represents the frequency at which automatic top-up occurs. The interval can be one of the following values: `weekly`, `monthly`, `quarterly` or `yearly`. Required only when trigger is `interval`.
              * @example "monthly"
              */
             interval?: "weekly" | "monthly" | "quarterly" | "yearly";
             /**
-             * The threshold for recurring top-ups is the value at which an automatic top-up is triggered. For example, if this threshold is set at 10 credits, an automatic top-up will occur whenever the wallet balance falls to or below 10 credits. Required only when rule type is set to `threshold`.
+             * The threshold for recurring top-ups is the value at which an automatic top-up is triggered. For example, if this threshold is set at 10 credits, an automatic top-up will occur whenever the wallet balance falls to or below 10 credits. Required only when trigger is set to `threshold`.
              * @pattern ^[0-9]+.?[0-9]*$
              * @example "20.0"
              */
@@ -3972,17 +3972,17 @@ export interface WalletObject {
          */
         lago_id: string;
         /**
-         * The rule type. Possible values are `interval` or `threshold`.
+         * The trigger. Possible values are `interval` or `threshold`.
          * @example "interval"
          */
-        rule_type: "interval" | "threshold";
+        trigger: "interval" | "threshold";
         /**
-         * The interval used for recurring top-up. It represents the frequency at which automatic top-up occurs. The interval can be one of the following values: `weekly`, `monthly`, `quarterly` or `yearly`. Required only if rule type is set to `interval`.
+         * The interval used for recurring top-up. It represents the frequency at which automatic top-up occurs. The interval can be one of the following values: `weekly`, `monthly`, `quarterly` or `yearly`. Required only if trigger is set to `interval`.
          * @example "monthly"
          */
         interval?: "weekly" | "monthly" | "quarterly" | "yearly";
         /**
-         * The threshold for recurring top-ups is the value at which an automatic top-up is triggered. For example, if this threshold is set at 10 credits, an automatic top-up will occur whenever the wallet balance falls to or below 10 credits. Required only when rule type is set to `threshold`.
+         * The threshold for recurring top-ups is the value at which an automatic top-up is triggered. For example, if this threshold is set at 10 credits, an automatic top-up will occur whenever the wallet balance falls to or below 10 credits. Required only when trigger is set to `threshold`.
          * @pattern ^[0-9]+.?[0-9]*$
          * @example "20.0"
          */
@@ -4042,17 +4042,23 @@ export interface WalletTransactionCreateInput {
          */
         wallet_id: string;
         /**
-         * The number of paid credits. Required only if there is no granted credits.
+         * The number of paid credits.
          * @pattern ^[0-9]+.?[0-9]*$
          * @example "20.0"
          */
         paid_credits?: string;
         /**
-         * The number of free granted credits. Required only if there is no paid credits.
+         * The number of free granted credits.
          * @pattern ^[0-9]+.?[0-9]*$
          * @example "10.0"
          */
         granted_credits?: string;
+        /**
+         * The number of voided credits.
+         * @pattern ^[0-9]+.?[0-9]*$
+         * @example "5.0"
+         */
+        voided_credits?: string;
     };
 }
 export interface WalletTransactionObject {
@@ -4073,6 +4079,11 @@ export interface WalletTransactionObject {
      * @example "settled"
      */
     status: "pending" | "settled";
+    /**
+     * The transaction status of the wallet transaction. Possible values are `purchased` (with pending or settled status), `granted` (without invoice_id), `voided` or `invoiced`.
+     * @example "purchased"
+     */
+    transaction_status: "purchased" | "granted" | "voided" | "invoiced";
     /**
      * The type of transaction. Possible values are `inbound` (increasing the balance) or `outbound` (decreasing the balance).
      * @example "inbound"
@@ -4131,17 +4142,17 @@ export interface WalletUpdateInput {
              */
             lago_id?: string;
             /**
-             * The rule type. Possible values are `interval` or `threshold`.
+             * The trigger. Possible values are `interval` or `threshold`.
              * @example "interval"
              */
-            rule_type?: "interval" | "threshold";
+            trigger?: "interval" | "threshold";
             /**
-             * The interval used for recurring top-up. It represents the frequency at which automatic top-up occurs. The interval can be one of the following values: `weekly`, `monthly`, `quarterly` or `yearly`. Required only when rule type is set to `interval`.
+             * The interval used for recurring top-up. It represents the frequency at which automatic top-up occurs. The interval can be one of the following values: `weekly`, `monthly`, `quarterly` or `yearly`. Required only when trigger is set to `interval`.
              * @example "monthly"
              */
             interval?: "weekly" | "monthly" | "quarterly" | "yearly";
             /**
-             * The threshold for recurring top-ups is the value at which an automatic top-up is triggered. For example, if this threshold is set at 10 credits, an automatic top-up will occur whenever the wallet balance falls to or below 10 credits. Required only when rule type is set to `threshold`.
+             * The threshold for recurring top-ups is the value at which an automatic top-up is triggered. For example, if this threshold is set at 10 credits, an automatic top-up will occur whenever the wallet balance falls to or below 10 credits. Required only when trigger is set to `threshold`.
              * @pattern ^[0-9]+.?[0-9]*$
              * @example "20.0"
              */
@@ -4286,7 +4297,7 @@ export declare class HttpClient<SecurityDataType = unknown> {
 }
 /**
  * @title Lago API documentation
- * @version 1.1.0
+ * @version 1.2.0
  * @license AGPLv3
  * @baseUrl https://api.getlago.com/api/v1
  * @externalDocs https://github.com/getlago
@@ -4376,6 +4387,11 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
              * @example "5eb02857-a71e-4ea2-bcf9-57d3a41bc6ba"
              */
             external_customer_id?: string;
+            /**
+             * Show data only for given number of months.
+             * @example 12
+             */
+            months?: number;
         }, params?: RequestParams) => Promise<HttpResponse<GrossRevenues, ApiErrorUnauthorized>>;
         /**
          * @description Represents a monthly aggregation, detailing both the total count and the cumulative amount of invoices that have been marked as `finalized`. This report sorts invoices categorically based on their `payment_status`.
@@ -4389,6 +4405,11 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
         findAllInvoiceCollections: (query?: {
             /** The currency of revenue analytics. Format must be ISO 4217. */
             currency?: Currency;
+            /**
+             * Show data only for given number of months.
+             * @example 12
+             */
+            months?: number;
         }, params?: RequestParams) => Promise<HttpResponse<InvoiceCollections, ApiErrorUnauthorized>>;
         /**
          * @description Reports a monthly analysis focused on the revenue generated from all usage-based fees. It exclusively accounts for revenue that has been formally invoiced. Importantly, this report does not include revenue related to the usage in the current billing period, limiting its scope to previously invoiced amounts.
@@ -4402,6 +4423,11 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
         findAllInvoicedUsages: (query?: {
             /** The currency of invoiced usage analytics. Format must be ISO 4217. */
             currency?: Currency;
+            /**
+             * Show data only for given number of months.
+             * @example 12
+             */
+            months?: number;
         }, params?: RequestParams) => Promise<HttpResponse<InvoicedUsages, ApiErrorUnauthorized>>;
         /**
          * @description This endpoint is used to list MRR.
@@ -5520,6 +5546,11 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
              * @example "pending"
              */
             status?: string;
+            /**
+             * The transaction status of the wallet transaction. Possible values are `purchased` (with pending or settled status), `granted` (without invoice_id), `voided` or `invoiced`.
+             * @example "purchased"
+             */
+            transaction_status?: string;
             /**
              * The transaction type of the wallet transaction. Possible values are `inbound` (increasing the wallet balance) or `outbound` (decreasing the wallet balance).
              * @example "inbound"

package/esm/openapi/client.js

@@ -148,7 +148,7 @@ export class HttpClient {
 }
 /**
  * @title Lago API documentation
- * @version 1.1.0
+ * @version 1.2.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.2.0",
+  "version": "v1.3.0",
   "description": "Lago JavaScript API Client",
   "repository": {
     "type": "git",

package/script/openapi/client.d.ts

@@ -3862,17 +3862,17 @@ export interface WalletCreateInput {
         /** List of recurring transaction rules. Currently, we only allow one recurring rule per wallet. */
         recurring_transaction_rules?: {
             /**
-             * The rule type. Possible values are `interval` or `threshold`.
+             * The trigger. Possible values are `interval` or `threshold`.
              * @example "interval"
              */
-            rule_type: "interval" | "threshold";
+            trigger: "interval" | "threshold";
             /**
-             * The interval used for recurring top-up. It represents the frequency at which automatic top-up occurs. The interval can be one of the following values: `weekly`, `monthly`, `quarterly` or `yearly`. Required only when rule type is `interval`.
+             * The interval used for recurring top-up. It represents the frequency at which automatic top-up occurs. The interval can be one of the following values: `weekly`, `monthly`, `quarterly` or `yearly`. Required only when trigger is `interval`.
              * @example "monthly"
              */
             interval?: "weekly" | "monthly" | "quarterly" | "yearly";
             /**
-             * The threshold for recurring top-ups is the value at which an automatic top-up is triggered. For example, if this threshold is set at 10 credits, an automatic top-up will occur whenever the wallet balance falls to or below 10 credits. Required only when rule type is set to `threshold`.
+             * The threshold for recurring top-ups is the value at which an automatic top-up is triggered. For example, if this threshold is set at 10 credits, an automatic top-up will occur whenever the wallet balance falls to or below 10 credits. Required only when trigger is set to `threshold`.
              * @pattern ^[0-9]+.?[0-9]*$
              * @example "20.0"
              */
@@ -3972,17 +3972,17 @@ export interface WalletObject {
          */
         lago_id: string;
         /**
-         * The rule type. Possible values are `interval` or `threshold`.
+         * The trigger. Possible values are `interval` or `threshold`.
          * @example "interval"
          */
-        rule_type: "interval" | "threshold";
+        trigger: "interval" | "threshold";
         /**
-         * The interval used for recurring top-up. It represents the frequency at which automatic top-up occurs. The interval can be one of the following values: `weekly`, `monthly`, `quarterly` or `yearly`. Required only if rule type is set to `interval`.
+         * The interval used for recurring top-up. It represents the frequency at which automatic top-up occurs. The interval can be one of the following values: `weekly`, `monthly`, `quarterly` or `yearly`. Required only if trigger is set to `interval`.
          * @example "monthly"
          */
         interval?: "weekly" | "monthly" | "quarterly" | "yearly";
         /**
-         * The threshold for recurring top-ups is the value at which an automatic top-up is triggered. For example, if this threshold is set at 10 credits, an automatic top-up will occur whenever the wallet balance falls to or below 10 credits. Required only when rule type is set to `threshold`.
+         * The threshold for recurring top-ups is the value at which an automatic top-up is triggered. For example, if this threshold is set at 10 credits, an automatic top-up will occur whenever the wallet balance falls to or below 10 credits. Required only when trigger is set to `threshold`.
          * @pattern ^[0-9]+.?[0-9]*$
          * @example "20.0"
          */
@@ -4042,17 +4042,23 @@ export interface WalletTransactionCreateInput {
          */
         wallet_id: string;
         /**
-         * The number of paid credits. Required only if there is no granted credits.
+         * The number of paid credits.
          * @pattern ^[0-9]+.?[0-9]*$
          * @example "20.0"
          */
         paid_credits?: string;
         /**
-         * The number of free granted credits. Required only if there is no paid credits.
+         * The number of free granted credits.
          * @pattern ^[0-9]+.?[0-9]*$
          * @example "10.0"
          */
         granted_credits?: string;
+        /**
+         * The number of voided credits.
+         * @pattern ^[0-9]+.?[0-9]*$
+         * @example "5.0"
+         */
+        voided_credits?: string;
     };
 }
 export interface WalletTransactionObject {
@@ -4073,6 +4079,11 @@ export interface WalletTransactionObject {
      * @example "settled"
      */
     status: "pending" | "settled";
+    /**
+     * The transaction status of the wallet transaction. Possible values are `purchased` (with pending or settled status), `granted` (without invoice_id), `voided` or `invoiced`.
+     * @example "purchased"
+     */
+    transaction_status: "purchased" | "granted" | "voided" | "invoiced";
     /**
      * The type of transaction. Possible values are `inbound` (increasing the balance) or `outbound` (decreasing the balance).
      * @example "inbound"
@@ -4131,17 +4142,17 @@ export interface WalletUpdateInput {
              */
             lago_id?: string;
             /**
-             * The rule type. Possible values are `interval` or `threshold`.
+             * The trigger. Possible values are `interval` or `threshold`.
              * @example "interval"
              */
-            rule_type?: "interval" | "threshold";
+            trigger?: "interval" | "threshold";
             /**
-             * The interval used for recurring top-up. It represents the frequency at which automatic top-up occurs. The interval can be one of the following values: `weekly`, `monthly`, `quarterly` or `yearly`. Required only when rule type is set to `interval`.
+             * The interval used for recurring top-up. It represents the frequency at which automatic top-up occurs. The interval can be one of the following values: `weekly`, `monthly`, `quarterly` or `yearly`. Required only when trigger is set to `interval`.
              * @example "monthly"
              */
             interval?: "weekly" | "monthly" | "quarterly" | "yearly";
             /**
-             * The threshold for recurring top-ups is the value at which an automatic top-up is triggered. For example, if this threshold is set at 10 credits, an automatic top-up will occur whenever the wallet balance falls to or below 10 credits. Required only when rule type is set to `threshold`.
+             * The threshold for recurring top-ups is the value at which an automatic top-up is triggered. For example, if this threshold is set at 10 credits, an automatic top-up will occur whenever the wallet balance falls to or below 10 credits. Required only when trigger is set to `threshold`.
              * @pattern ^[0-9]+.?[0-9]*$
              * @example "20.0"
              */
@@ -4286,7 +4297,7 @@ export declare class HttpClient<SecurityDataType = unknown> {
 }
 /**
  * @title Lago API documentation
- * @version 1.1.0
+ * @version 1.2.0
  * @license AGPLv3
  * @baseUrl https://api.getlago.com/api/v1
  * @externalDocs https://github.com/getlago
@@ -4376,6 +4387,11 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
              * @example "5eb02857-a71e-4ea2-bcf9-57d3a41bc6ba"
              */
             external_customer_id?: string;
+            /**
+             * Show data only for given number of months.
+             * @example 12
+             */
+            months?: number;
         }, params?: RequestParams) => Promise<HttpResponse<GrossRevenues, ApiErrorUnauthorized>>;
         /**
          * @description Represents a monthly aggregation, detailing both the total count and the cumulative amount of invoices that have been marked as `finalized`. This report sorts invoices categorically based on their `payment_status`.
@@ -4389,6 +4405,11 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
         findAllInvoiceCollections: (query?: {
             /** The currency of revenue analytics. Format must be ISO 4217. */
             currency?: Currency;
+            /**
+             * Show data only for given number of months.
+             * @example 12
+             */
+            months?: number;
         }, params?: RequestParams) => Promise<HttpResponse<InvoiceCollections, ApiErrorUnauthorized>>;
         /**
          * @description Reports a monthly analysis focused on the revenue generated from all usage-based fees. It exclusively accounts for revenue that has been formally invoiced. Importantly, this report does not include revenue related to the usage in the current billing period, limiting its scope to previously invoiced amounts.
@@ -4402,6 +4423,11 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
         findAllInvoicedUsages: (query?: {
             /** The currency of invoiced usage analytics. Format must be ISO 4217. */
             currency?: Currency;
+            /**
+             * Show data only for given number of months.
+             * @example 12
+             */
+            months?: number;
         }, params?: RequestParams) => Promise<HttpResponse<InvoicedUsages, ApiErrorUnauthorized>>;
         /**
          * @description This endpoint is used to list MRR.
@@ -5520,6 +5546,11 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
              * @example "pending"
              */
             status?: string;
+            /**
+             * The transaction status of the wallet transaction. Possible values are `purchased` (with pending or settled status), `granted` (without invoice_id), `voided` or `invoiced`.
+             * @example "purchased"
+             */
+            transaction_status?: string;
             /**
              * The transaction type of the wallet transaction. Possible values are `inbound` (increasing the wallet balance) or `outbound` (decreasing the wallet balance).
              * @example "inbound"

package/script/openapi/client.js

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