lago-javascript-client 1.46.0 → 1.46.1

package/esm/openapi/client.d.ts

@@ -4584,7 +4584,7 @@ export type AlertThresholdObject = AlertThresholdBaseObject & {
      */
     value: string;
 };
-export interface AlertObject {
+export interface WalletAlertObject {
     /**
      * Unique identifier of the alert, created by Lago.
      * @format uuid
@@ -4597,46 +4597,36 @@ export interface AlertObject {
      * @example "1a901a90-1a90-1a90-1a90-1a901a901a90"
      */
     lago_organization_id: string;
-    /**
-     * The subscription external unique identifier (provided by your own application).
-     * @example "sub_1234567890"
-     */
-    external_subscription_id: string | null;
-    /**
-     * The customer external unique identifier (provided by your own application).
-     * @example "cus_0987654321"
-     */
-    external_customer_id: string;
+    external_subscription_id: null;
     /**
      * Unique identifier of the wallet, created by Lago.
      * @example "1a901a90-1a90-1a90-1a90-1a901a901a90"
      */
-    lago_wallet_id?: string | null;
+    lago_wallet_id?: string;
     /**
      * The wallet external unique identifier (provided by your own application).
      * @example "wallet_code"
      */
-    wallet_code?: string | null;
-    /** The billable metric associated with the alert. Only for alerts based on a billable metric. */
-    billable_metric: BillableMetricObject;
+    wallet_code?: string;
+    billable_metric: null;
     /**
      * The type of alert.
-     * @example "billable_metric_current_usage_amount"
+     * @example "wallet_balance_amount"
      */
-    alert_type: "current_usage_amount" | "billable_metric_current_usage_amount" | "billable_metric_current_usage_units" | "lifetime_usage_amount";
+    alert_type: "wallet_balance_amount" | "wallet_credits_balance" | "wallet_ongoing_balance_amount" | "wallet_credits_ongoing_balance";
     /**
      * Unique code used to identify the alert.
-     * @example "storage_threshold_alert"
+     * @example "wallet_balance_alert"
      */
     code: string;
     /**
      * The name of the alert.
-     * @example "Storage Usage Alert"
+     * @example "Wallet Balance Alert"
      */
     name: string | null;
     /**
      * Indicates whether the alert is triggered when the monitored metric goes above or below the threshold.
-     * @example "increasing"
+     * @example "decreasing"
      */
     direction?: "increasing" | "decreasing";
     /**
@@ -4659,8 +4649,8 @@ export interface AlertObject {
      */
     created_at: string;
 }
-export interface Alerts {
-    alerts: AlertObject[];
+export interface WalletAlerts {
+    alerts: WalletAlertObject[];
     meta?: PaginationMeta;
 }
 export type AlertThresholdInput = AlertThresholdBaseObject & {
@@ -4690,7 +4680,7 @@ export interface WalletAlertCreateInput {
          * The type of alert.
          * @example "wallet_balance_amount"
          */
-        alert_type: "wallet_balance_amount" | "wallet_credits_balance";
+        alert_type: "wallet_balance_amount" | "wallet_credits_balance" | "wallet_ongoing_balance_amount" | "wallet_credits_ongoing_balance";
         /**
          * Unique code used to identify the alert.
          * @example "wallet_balance_alert"
@@ -4710,7 +4700,7 @@ export interface WalletAlertBatchCreateInput {
          * The type of alert.
          * @example "wallet_balance_amount"
          */
-        alert_type: "wallet_balance_amount" | "wallet_credits_balance";
+        alert_type: "wallet_balance_amount" | "wallet_credits_balance" | "wallet_ongoing_balance_amount" | "wallet_credits_ongoing_balance";
         /**
          * Unique code used to identify the alert.
          * @example "wallet_balance_alert"
@@ -4723,8 +4713,8 @@ export interface WalletAlertBatchCreateInput {
         name?: string | null;
     })[];
 }
-export interface Alert {
-    alert: AlertObject;
+export interface WalletAlert {
+    alert: WalletAlertObject;
 }
 export interface WalletAlertUpdateInput {
     alert: AlertBaseInput & {
@@ -7812,6 +7802,72 @@ export interface LifetimeUsageInput {
         external_historical_usage_amount_cents: number;
     };
 }
+export interface AlertObject {
+    /**
+     * Unique identifier of the alert, created by Lago.
+     * @format uuid
+     * @example "1a901a90-1a90-1a90-1a90-1a901a901a90"
+     */
+    lago_id: string;
+    /**
+     * Unique identifier of the organization, created by Lago.
+     * @format uuid
+     * @example "1a901a90-1a90-1a90-1a90-1a901a901a90"
+     */
+    lago_organization_id: string;
+    /**
+     * The subscription external unique identifier (provided by your own application).
+     * @example "sub_1234567890"
+     */
+    external_subscription_id: string | null;
+    lago_wallet_id?: null;
+    wallet_code?: null;
+    /** The billable metric associated with the alert. Only for alerts based on a billable metric. */
+    billable_metric: BillableMetricObject;
+    /**
+     * The type of alert.
+     * @example "billable_metric_current_usage_amount"
+     */
+    alert_type: "current_usage_amount" | "billable_metric_current_usage_amount" | "billable_metric_current_usage_units" | "lifetime_usage_amount";
+    /**
+     * Unique code used to identify the alert.
+     * @example "storage_threshold_alert"
+     */
+    code: string;
+    /**
+     * The name of the alert.
+     * @example "Storage Usage Alert"
+     */
+    name: string | null;
+    /**
+     * Indicates whether the alert is triggered when the monitored metric goes above or below the threshold.
+     * @example "increasing"
+     */
+    direction?: "increasing" | "decreasing";
+    /**
+     * When the system checked if this alert should be triggered, this value was retrieved and checked against the thresholds.
+     * @example 1000
+     */
+    previous_value: number;
+    /**
+     * The date and time in UTC (ISO 8601) when the system checked if this alert should be triggered. Null until it's processed for the first time.
+     * @format date-time
+     * @example "2025-05-19T10:04:21Z"
+     */
+    last_processed_at: string | null;
+    /** Array of thresholds associated with the alert. */
+    thresholds: AlertThresholdObject[];
+    /**
+     * The date and time in UTC (ISO 8601) when the alert was created.
+     * @format date-time
+     * @example "2025-03-20T10:00:00Z"
+     */
+    created_at: string;
+}
+export interface Alerts {
+    alerts: AlertObject[];
+    meta?: PaginationMeta;
+}
 export interface AlertCreateInput {
     alert: AlertBaseInput & {
         /**
@@ -7844,8 +7900,16 @@ export interface AlertBatchCreateInput {
          * @example "storage_threshold_alert"
          */
         code: string;
+        /**
+         * The code of the billable metric associated with the alert. Only for alerts based on a billable metric.
+         * @example "storage_usage"
+         */
+        billable_metric_code?: string | null;
     })[];
 }
+export interface Alert {
+    alert: AlertObject;
+}
 export interface AlertUpdateInput {
     alert: AlertBaseInput & {
         /**
@@ -10166,7 +10230,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
          * @request GET:/customers/{external_customer_id}/wallets/{wallet_code}/alerts
          * @secure
          */
-        getCustomerWalletAlerts: (externalCustomerId: string, walletCode: string, params?: RequestParams) => Promise<HttpResponse<Alerts, ApiErrorUnauthorized | ApiErrorNotFound>>;
+        getCustomerWalletAlerts: (externalCustomerId: string, walletCode: string, params?: RequestParams) => Promise<HttpResponse<WalletAlerts, ApiErrorUnauthorized | ApiErrorNotFound>>;
         /**
          * @description This endpoint allows you to create new alerts for a wallet. Send a single alert object wrapped in `alert` key to create one alert, or an array of alert objects wrapped in `alerts` key to create multiple alerts atomically.
          *
@@ -10176,7 +10240,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
          * @request POST:/customers/{external_customer_id}/wallets/{wallet_code}/alerts
          * @secure
          */
-        createCustomerWalletAlert: (externalCustomerId: string, walletCode: string, data: WalletAlertCreateInput | WalletAlertBatchCreateInput, params?: RequestParams) => Promise<HttpResponse<Alerts | Alert, ApiErrorUnauthorized | ApiErrorUnprocessableEntity | ApiErrorBadRequest | ApiErrorNotFound>>;
+        createCustomerWalletAlert: (externalCustomerId: string, walletCode: string, data: WalletAlertCreateInput | WalletAlertBatchCreateInput, params?: RequestParams) => Promise<HttpResponse<WalletAlerts | WalletAlert, ApiErrorUnauthorized | ApiErrorUnprocessableEntity | ApiErrorBadRequest | ApiErrorNotFound>>;
         /**
          * @description This endpoint allows you to delete all alerts for a wallet.
          *
@@ -10196,7 +10260,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
          * @request GET:/customers/{external_customer_id}/wallets/{wallet_code}/alerts/{code}
          * @secure
          */
-        getCustomerWalletAlert: (externalCustomerId: string, walletCode: string, code: string, params?: RequestParams) => Promise<HttpResponse<Alert, ApiErrorUnauthorized | ApiErrorNotFound>>;
+        getCustomerWalletAlert: (externalCustomerId: string, walletCode: string, code: string, params?: RequestParams) => Promise<HttpResponse<WalletAlert, ApiErrorUnauthorized | ApiErrorNotFound>>;
         /**
          * @description This endpoint allows you to update an existing alert for a wallet.
          *
@@ -10206,7 +10270,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
          * @request PUT:/customers/{external_customer_id}/wallets/{wallet_code}/alerts/{code}
          * @secure
          */
-        updateCustomerWalletAlert: (externalCustomerId: string, walletCode: string, code: string, data: WalletAlertUpdateInput, params?: RequestParams) => Promise<HttpResponse<Alert, ApiErrorUnauthorized | ApiErrorUnprocessableEntity | ApiErrorBadRequest | ApiErrorNotFound>>;
+        updateCustomerWalletAlert: (externalCustomerId: string, walletCode: string, code: string, data: WalletAlertUpdateInput, params?: RequestParams) => Promise<HttpResponse<WalletAlert, ApiErrorUnauthorized | ApiErrorUnprocessableEntity | ApiErrorBadRequest | ApiErrorNotFound>>;
         /**
          * @description This endpoint allows you to delete an existing alert for a wallet.
          *
@@ -10216,7 +10280,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
          * @request DELETE:/customers/{external_customer_id}/wallets/{wallet_code}/alerts/{code}
          * @secure
          */
-        deleteCustomerWalletAlert: (externalCustomerId: string, walletCode: string, code: string, params?: RequestParams) => Promise<HttpResponse<Alert, ApiErrorUnauthorized | ApiErrorNotFound>>;
+        deleteCustomerWalletAlert: (externalCustomerId: string, walletCode: string, code: string, params?: RequestParams) => Promise<HttpResponse<WalletAlert, ApiErrorUnauthorized | ApiErrorNotFound>>;
         /**
          * @description This endpoint enables the retrieval of the usage-based billing data for a customer within the current period.
          *

package/package.json

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

package/script/openapi/client.d.ts

@@ -4584,7 +4584,7 @@ export type AlertThresholdObject = AlertThresholdBaseObject & {
      */
     value: string;
 };
-export interface AlertObject {
+export interface WalletAlertObject {
     /**
      * Unique identifier of the alert, created by Lago.
      * @format uuid
@@ -4597,46 +4597,36 @@ export interface AlertObject {
      * @example "1a901a90-1a90-1a90-1a90-1a901a901a90"
      */
     lago_organization_id: string;
-    /**
-     * The subscription external unique identifier (provided by your own application).
-     * @example "sub_1234567890"
-     */
-    external_subscription_id: string | null;
-    /**
-     * The customer external unique identifier (provided by your own application).
-     * @example "cus_0987654321"
-     */
-    external_customer_id: string;
+    external_subscription_id: null;
     /**
      * Unique identifier of the wallet, created by Lago.
      * @example "1a901a90-1a90-1a90-1a90-1a901a901a90"
      */
-    lago_wallet_id?: string | null;
+    lago_wallet_id?: string;
     /**
      * The wallet external unique identifier (provided by your own application).
      * @example "wallet_code"
      */
-    wallet_code?: string | null;
-    /** The billable metric associated with the alert. Only for alerts based on a billable metric. */
-    billable_metric: BillableMetricObject;
+    wallet_code?: string;
+    billable_metric: null;
     /**
      * The type of alert.
-     * @example "billable_metric_current_usage_amount"
+     * @example "wallet_balance_amount"
      */
-    alert_type: "current_usage_amount" | "billable_metric_current_usage_amount" | "billable_metric_current_usage_units" | "lifetime_usage_amount";
+    alert_type: "wallet_balance_amount" | "wallet_credits_balance" | "wallet_ongoing_balance_amount" | "wallet_credits_ongoing_balance";
     /**
      * Unique code used to identify the alert.
-     * @example "storage_threshold_alert"
+     * @example "wallet_balance_alert"
      */
     code: string;
     /**
      * The name of the alert.
-     * @example "Storage Usage Alert"
+     * @example "Wallet Balance Alert"
      */
     name: string | null;
     /**
      * Indicates whether the alert is triggered when the monitored metric goes above or below the threshold.
-     * @example "increasing"
+     * @example "decreasing"
      */
     direction?: "increasing" | "decreasing";
     /**
@@ -4659,8 +4649,8 @@ export interface AlertObject {
      */
     created_at: string;
 }
-export interface Alerts {
-    alerts: AlertObject[];
+export interface WalletAlerts {
+    alerts: WalletAlertObject[];
     meta?: PaginationMeta;
 }
 export type AlertThresholdInput = AlertThresholdBaseObject & {
@@ -4690,7 +4680,7 @@ export interface WalletAlertCreateInput {
          * The type of alert.
          * @example "wallet_balance_amount"
          */
-        alert_type: "wallet_balance_amount" | "wallet_credits_balance";
+        alert_type: "wallet_balance_amount" | "wallet_credits_balance" | "wallet_ongoing_balance_amount" | "wallet_credits_ongoing_balance";
         /**
          * Unique code used to identify the alert.
          * @example "wallet_balance_alert"
@@ -4710,7 +4700,7 @@ export interface WalletAlertBatchCreateInput {
          * The type of alert.
          * @example "wallet_balance_amount"
          */
-        alert_type: "wallet_balance_amount" | "wallet_credits_balance";
+        alert_type: "wallet_balance_amount" | "wallet_credits_balance" | "wallet_ongoing_balance_amount" | "wallet_credits_ongoing_balance";
         /**
          * Unique code used to identify the alert.
          * @example "wallet_balance_alert"
@@ -4723,8 +4713,8 @@ export interface WalletAlertBatchCreateInput {
         name?: string | null;
     })[];
 }
-export interface Alert {
-    alert: AlertObject;
+export interface WalletAlert {
+    alert: WalletAlertObject;
 }
 export interface WalletAlertUpdateInput {
     alert: AlertBaseInput & {
@@ -7812,6 +7802,72 @@ export interface LifetimeUsageInput {
         external_historical_usage_amount_cents: number;
     };
 }
+export interface AlertObject {
+    /**
+     * Unique identifier of the alert, created by Lago.
+     * @format uuid
+     * @example "1a901a90-1a90-1a90-1a90-1a901a901a90"
+     */
+    lago_id: string;
+    /**
+     * Unique identifier of the organization, created by Lago.
+     * @format uuid
+     * @example "1a901a90-1a90-1a90-1a90-1a901a901a90"
+     */
+    lago_organization_id: string;
+    /**
+     * The subscription external unique identifier (provided by your own application).
+     * @example "sub_1234567890"
+     */
+    external_subscription_id: string | null;
+    lago_wallet_id?: null;
+    wallet_code?: null;
+    /** The billable metric associated with the alert. Only for alerts based on a billable metric. */
+    billable_metric: BillableMetricObject;
+    /**
+     * The type of alert.
+     * @example "billable_metric_current_usage_amount"
+     */
+    alert_type: "current_usage_amount" | "billable_metric_current_usage_amount" | "billable_metric_current_usage_units" | "lifetime_usage_amount";
+    /**
+     * Unique code used to identify the alert.
+     * @example "storage_threshold_alert"
+     */
+    code: string;
+    /**
+     * The name of the alert.
+     * @example "Storage Usage Alert"
+     */
+    name: string | null;
+    /**
+     * Indicates whether the alert is triggered when the monitored metric goes above or below the threshold.
+     * @example "increasing"
+     */
+    direction?: "increasing" | "decreasing";
+    /**
+     * When the system checked if this alert should be triggered, this value was retrieved and checked against the thresholds.
+     * @example 1000
+     */
+    previous_value: number;
+    /**
+     * The date and time in UTC (ISO 8601) when the system checked if this alert should be triggered. Null until it's processed for the first time.
+     * @format date-time
+     * @example "2025-05-19T10:04:21Z"
+     */
+    last_processed_at: string | null;
+    /** Array of thresholds associated with the alert. */
+    thresholds: AlertThresholdObject[];
+    /**
+     * The date and time in UTC (ISO 8601) when the alert was created.
+     * @format date-time
+     * @example "2025-03-20T10:00:00Z"
+     */
+    created_at: string;
+}
+export interface Alerts {
+    alerts: AlertObject[];
+    meta?: PaginationMeta;
+}
 export interface AlertCreateInput {
     alert: AlertBaseInput & {
         /**
@@ -7844,8 +7900,16 @@ export interface AlertBatchCreateInput {
          * @example "storage_threshold_alert"
          */
         code: string;
+        /**
+         * The code of the billable metric associated with the alert. Only for alerts based on a billable metric.
+         * @example "storage_usage"
+         */
+        billable_metric_code?: string | null;
     })[];
 }
+export interface Alert {
+    alert: AlertObject;
+}
 export interface AlertUpdateInput {
     alert: AlertBaseInput & {
         /**
@@ -10166,7 +10230,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
          * @request GET:/customers/{external_customer_id}/wallets/{wallet_code}/alerts
          * @secure
          */
-        getCustomerWalletAlerts: (externalCustomerId: string, walletCode: string, params?: RequestParams) => Promise<HttpResponse<Alerts, ApiErrorUnauthorized | ApiErrorNotFound>>;
+        getCustomerWalletAlerts: (externalCustomerId: string, walletCode: string, params?: RequestParams) => Promise<HttpResponse<WalletAlerts, ApiErrorUnauthorized | ApiErrorNotFound>>;
         /**
          * @description This endpoint allows you to create new alerts for a wallet. Send a single alert object wrapped in `alert` key to create one alert, or an array of alert objects wrapped in `alerts` key to create multiple alerts atomically.
          *
@@ -10176,7 +10240,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
          * @request POST:/customers/{external_customer_id}/wallets/{wallet_code}/alerts
          * @secure
          */
-        createCustomerWalletAlert: (externalCustomerId: string, walletCode: string, data: WalletAlertCreateInput | WalletAlertBatchCreateInput, params?: RequestParams) => Promise<HttpResponse<Alerts | Alert, ApiErrorUnauthorized | ApiErrorUnprocessableEntity | ApiErrorBadRequest | ApiErrorNotFound>>;
+        createCustomerWalletAlert: (externalCustomerId: string, walletCode: string, data: WalletAlertCreateInput | WalletAlertBatchCreateInput, params?: RequestParams) => Promise<HttpResponse<WalletAlerts | WalletAlert, ApiErrorUnauthorized | ApiErrorUnprocessableEntity | ApiErrorBadRequest | ApiErrorNotFound>>;
         /**
          * @description This endpoint allows you to delete all alerts for a wallet.
          *
@@ -10196,7 +10260,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
          * @request GET:/customers/{external_customer_id}/wallets/{wallet_code}/alerts/{code}
          * @secure
          */
-        getCustomerWalletAlert: (externalCustomerId: string, walletCode: string, code: string, params?: RequestParams) => Promise<HttpResponse<Alert, ApiErrorUnauthorized | ApiErrorNotFound>>;
+        getCustomerWalletAlert: (externalCustomerId: string, walletCode: string, code: string, params?: RequestParams) => Promise<HttpResponse<WalletAlert, ApiErrorUnauthorized | ApiErrorNotFound>>;
         /**
          * @description This endpoint allows you to update an existing alert for a wallet.
          *
@@ -10206,7 +10270,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
          * @request PUT:/customers/{external_customer_id}/wallets/{wallet_code}/alerts/{code}
          * @secure
          */
-        updateCustomerWalletAlert: (externalCustomerId: string, walletCode: string, code: string, data: WalletAlertUpdateInput, params?: RequestParams) => Promise<HttpResponse<Alert, ApiErrorUnauthorized | ApiErrorUnprocessableEntity | ApiErrorBadRequest | ApiErrorNotFound>>;
+        updateCustomerWalletAlert: (externalCustomerId: string, walletCode: string, code: string, data: WalletAlertUpdateInput, params?: RequestParams) => Promise<HttpResponse<WalletAlert, ApiErrorUnauthorized | ApiErrorUnprocessableEntity | ApiErrorBadRequest | ApiErrorNotFound>>;
         /**
          * @description This endpoint allows you to delete an existing alert for a wallet.
          *
@@ -10216,7 +10280,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
          * @request DELETE:/customers/{external_customer_id}/wallets/{wallet_code}/alerts/{code}
          * @secure
          */
-        deleteCustomerWalletAlert: (externalCustomerId: string, walletCode: string, code: string, params?: RequestParams) => Promise<HttpResponse<Alert, ApiErrorUnauthorized | ApiErrorNotFound>>;
+        deleteCustomerWalletAlert: (externalCustomerId: string, walletCode: string, code: string, params?: RequestParams) => Promise<HttpResponse<WalletAlert, ApiErrorUnauthorized | ApiErrorNotFound>>;
         /**
          * @description This endpoint enables the retrieval of the usage-based billing data for a customer within the current period.
          *