lago-javascript-client 1.15.0 → 1.17.0

package/script/openapi/client.d.ts

@@ -19,7 +19,10 @@ export interface AddOnBaseInput {
      * @example 50000
      */
     amount_cents?: number;
-    /** The currency of the add-on. */
+    /**
+     * The currency of the add-on.
+     * @example "USD"
+     */
     amount_currency?: Currency;
     /**
      * The description of the add-on.
@@ -62,7 +65,10 @@ export interface AddOnObject {
      * @example 50000
      */
     amount_cents: number;
-    /** The currency of the add-on. */
+    /**
+     * The currency of the add-on.
+     * @example "USD"
+     */
     amount_currency: Currency;
     /**
      * The description of the add-on.
@@ -185,8 +191,11 @@ export interface AppliedCouponInput {
          * @example 2000
          */
         amount_cents?: number | null;
-        /** The currency of the coupon. This field is required only for coupon with `fixed_amount` type. */
-        amount_currency?: Currency;
+        /**
+         * The currency of the coupon. This field is required only for coupon with `fixed_amount` type.
+         * @example "EUR"
+         */
+        amount_currency?: Currency | null;
         /**
          * The percentage rate of the coupon. This field is required only for coupons with a `percentage` coupon type.
          * @pattern ^[0-9]+.?[0-9]*$
@@ -244,8 +253,11 @@ export interface AppliedCouponObject {
      * @example 50
      */
     amount_cents_remaining?: number | null;
-    /** The currency of the coupon. This field is required only for coupon with `fixed_amount` type. */
-    amount_currency?: Currency;
+    /**
+     * The currency of the coupon. This field is required only for coupon with `fixed_amount` type.
+     * @example "EUR"
+     */
+    amount_currency?: Currency | null;
     /**
      * The percentage rate of the coupon. This field is required only for coupons with a `percentage` coupon type.
      * @pattern ^[0-9]+.?[0-9]*$
@@ -348,7 +360,10 @@ export interface BaseAppliedTax {
      * @example 2000
      */
     amount_cents?: number;
-    /** Currency of the tax */
+    /**
+     * Currency of the tax
+     * @example "USD"
+     */
     amount_currency?: Currency;
     /**
      * The date and time when the applied tax was created. It is expressed in UTC format according to the ISO 8601 datetime standard. This field provides the timestamp for the exact moment when the applied tax was initially created.
@@ -358,7 +373,7 @@ export interface BaseAppliedTax {
     created_at?: string;
 }
 export interface BillableMetric {
-    billable_metric: BillableMetricObject;
+    billable_metric: BillableMetricObjectExtended;
 }
 export interface BillableMetricObject {
     /**
@@ -391,12 +406,27 @@ export interface BillableMetricObject {
      * @example false
      */
     recurring: boolean;
+    /**
+     * Refers to the numeric value or mathematical expression that will be rounded based on the calculated number of billing units. Possible values are `round`, `ceil` and `floor`.
+     * @example "round"
+     */
+    rounding_function?: "ceil" | "floor" | "round" | null;
+    /**
+     * Specifies the number of decimal places to which the `rounding_function` will be rounded. It can be a positive or negative value.
+     * @example 2
+     */
+    rounding_precision?: number | null;
     /**
      * Creation date of the billable metric.
      * @format date-time
      * @example "2022-09-14T16:35:31Z"
      */
     created_at: string;
+    /**
+     * Expression used to calculate the event units. The expression is evalutated for each event and the result is then used to calculate the total aggregated units.
+     * @example "round((ended_at - started_at) * units)"
+     */
+    expression?: string;
     /**
      * Property of the billable metric used for aggregating usage data. This field is not required for `count_agg`.
      * @example "gb"
@@ -415,20 +445,40 @@ export interface BillableMetricObject {
     filters?: BillableMetricFilterObject[];
     /**
      * Number of active subscriptions using this billable metric.
+     * @deprecated
      * @example 4
      */
     active_subscriptions_count: number;
     /**
      * Number of draft invoices for which this billable metric is listed as an invoice item.
+     * @deprecated
      * @example 10
      */
     draft_invoices_count: number;
     /**
      * Number of plans using this billable metric.
+     * @deprecated
      * @example 4
      */
     plans_count: number;
 }
+export type BillableMetricObjectExtended = BillableMetricObject & {
+    /**
+     * Number of active subscriptions using this billable metric.
+     * @example 4
+     */
+    active_subscriptions_count?: number;
+    /**
+     * Number of draft invoices for which this billable metric is listed as an invoice item.
+     * @example 10
+     */
+    draft_invoices_count?: number;
+    /**
+     * Number of plans using this billable metric.
+     * @example 4
+     */
+    plans_count?: number;
+};
 export interface BillableMetricBaseInput {
     /**
      * Name of the billable metric.
@@ -454,6 +504,23 @@ export interface BillableMetricBaseInput {
      * @example false
      */
     recurring?: boolean;
+    /**
+     * Expression used to calculate the event units. The expression is evalutated for each event and the result is then used to calculate the total aggregated units.
+     * Accepted function are `ceil`, `concat` and `round` as well as `+`, `-`, `\` and `*` operations.
+     * Round is accepting an optional second parameter to specify the number of decimal.
+     * @example "round((ended_at - started_at) * units)"
+     */
+    expression?: string | null;
+    /**
+     * Refers to the numeric value or mathematical expression that will be rounded based on the calculated number of billing units. Possible values are `round`, `ceil` and `floor`.
+     * @example "round"
+     */
+    rounding_function?: "ceil" | "floor" | "round" | null;
+    /**
+     * Specifies the number of decimal places to which the `rounding_function` will be rounded. It can be a positive or negative value.
+     * @example 2
+     */
+    rounding_precision?: number | null;
     /**
      * Property of the billable metric used for aggregating usage data. This field is not required for `count_agg`.
      * @example "gb"
@@ -474,6 +541,42 @@ export interface BillableMetricBaseInput {
 export interface BillableMetricCreateInput {
     billable_metric: BillableMetricBaseInput;
 }
+export interface BillableMetricEvaluateExpressionInput {
+    /**
+     * Expression used to calculate the event units. The expression is evalutated for each event and the result is then used to calculate the total aggregated units.
+     * Accepted function are `ceil`, `concat` and `round` as well as `+`, `-`, `\` and `*` operations.
+     * Round is accepting an optional second parameter to specify the number of decimal.
+     * @example "round((ended_at - started_at) * units)"
+     */
+    expression: string;
+    event: {
+        /**
+         * The code that identifies a targeted billable metric.
+         * @example "storage"
+         */
+        code: string;
+        /**
+         * This field captures the Unix timestamp in seconds indicating the occurrence of the event in Coordinated Universal Time (UTC).
+         * If this timestamp is not provided, the API will automatically set it to the time of event reception.
+         * @example "1651240791"
+         */
+        timestamp?: number | string;
+        /**
+         * This field represents additional properties associated with the event. They can be used when evaluating the expression.
+         * @example {"gb":10}
+         */
+        properties: Record<string, string | number>;
+    };
+}
+export interface BillableMetricEvaluateExpressionResult {
+    expression_result: {
+        /**
+         * Result of evaluating the expression
+         * @example 1
+         */
+        value: string | number;
+    };
+}
 /** Values used to apply differentiated pricing based on additional event properties. */
 export interface BillableMetricFilterInput {
     /**
@@ -776,8 +879,11 @@ export interface CouponBaseInput {
      * @example 5000
      */
     amount_cents?: number | null;
-    /** The currency of the coupon. This field is required only for coupon with `fixed_amount` type. */
-    amount_currency?: Currency;
+    /**
+     * The currency of the coupon. This field is required only for coupon with `fixed_amount` type.
+     * @example "USD"
+     */
+    amount_currency?: Currency | null;
     /**
      * Indicates whether the coupon can be reused or not. If set to `true`, the coupon is reusable, meaning it can be applied multiple times to the same customer. If set to `false`, the coupon can only be used once and is not reusable. If not specified, this field is set to `true` by default.
      * @example false
@@ -869,8 +975,11 @@ export interface CouponObject {
      * @example 5000
      */
     amount_cents?: number | null;
-    /** The currency of the coupon. This field is required only for coupon with `fixed_amount` type. */
-    amount_currency?: Currency;
+    /**
+     * The currency of the coupon. This field is required only for coupon with `fixed_amount` type.
+     * @example "USD"
+     */
+    amount_currency?: Currency | null;
     /**
      * Indicates whether the coupon can be reused or not. If set to `true`, the coupon is reusable, meaning it can be applied multiple times to the same customer. If set to `false`, the coupon can only be used once and is not reusable. If not specified, this field is set to `true` by default.
      * @example true
@@ -990,7 +1099,10 @@ export interface CreditNoteEstimated {
          * @example "LAG-1234"
          */
         invoice_number: string;
-        /** The currency of the credit note. */
+        /**
+         * The currency of the credit note.
+         * @example "EUR"
+         */
         currency: Currency;
         /**
          * The tax amount of the credit note, expressed in cents.
@@ -1070,7 +1182,10 @@ export interface CreditNoteEstimated {
              * @example 2000
              */
             amount_cents?: number;
-            /** Currency of the tax */
+            /**
+             * Currency of the tax
+             * @example "USD"
+             */
             amount_currency?: Currency;
         }[];
     };
@@ -1087,7 +1202,10 @@ export interface CreditObject {
      * @example 1200
      */
     amount_cents: number;
-    /** The currency of the credit. */
+    /**
+     * The currency of the credit.
+     * @example "EUR"
+     */
     amount_currency: Currency;
     /**
      * Indicates whether the credit is applied on the amount before taxes (coupons) or after taxes (credit notes). This flag helps determine the order in which credits are applied to the invoice calculation
@@ -1153,7 +1271,10 @@ export interface CreditNoteItemObject {
      * @example 100
      */
     amount_cents: number;
-    /** The credit note's item currency. */
+    /**
+     * The credit note's item currency.
+     * @example "EUR"
+     */
     amount_currency: Currency;
     /** The fee object related to the credit note item. */
     fee: FeeObject;
@@ -1221,7 +1342,10 @@ export interface CreditNoteObject {
      * @example "Free text"
      */
     description?: string | null;
-    /** The currency of the credit note. */
+    /**
+     * The currency of the credit note.
+     * @example "EUR"
+     */
     currency: Currency;
     /**
      * The total amount of the credit note, expressed in cents.
@@ -1370,8 +1494,11 @@ export interface Address {
      * @example "Woodland Hills"
      */
     city?: string | null;
-    /** Country code of the customer's billing address. Format must be ISO 3166 (alpha-2) */
-    country?: Country;
+    /**
+     * Country code of the customer's billing address. Format must be ISO 3166 (alpha-2)
+     * @example "US"
+     */
+    country?: Country | null;
     /**
      * The state of the customer's billing address
      * @example "CA"
@@ -1531,7 +1658,10 @@ export interface CustomerChargeUsageObject {
      * @example 123
      */
     amount_cents: number;
-    /** The currency of a usage item consumed by the customer. */
+    /**
+     * The currency of a usage item consumed by the customer.
+     * @example "EUR"
+     */
     amount_currency: Currency;
     /** Object listing all the properties for a specific charge item. */
     charge: {
@@ -1603,10 +1733,13 @@ export interface CustomerCreateInput {
          * @example "Woodland Hills"
          */
         city?: string | null;
-        /** Country code of the customer's billing address. Format must be ISO 3166 (alpha-2) */
-        country?: Country;
+        /**
+         * Country code of the customer's billing address. Format must be ISO 3166 (alpha-2)
+         * @example "US"
+         */
+        country?: Country | null;
         /** Currency of the customer. Format must be ISO 4217 */
-        currency?: Currency;
+        currency?: Currency | null;
         /**
          * The email of the customer
          * @format email
@@ -1670,7 +1803,7 @@ export interface CustomerCreateInput {
          */
         tax_identification_number?: string | null;
         /** The customer's timezone, used for billing purposes in their local time. Overrides the organization's timezone */
-        timezone?: Timezone;
+        timezone?: Timezone | null;
         /**
          * The custom website URL of the customer
          * @example "http://hooli.com"
@@ -1827,10 +1960,16 @@ export type CustomerObject = {
      * @example "Woodland Hills"
      */
     city?: string | null;
-    /** Country code of the customer's billing address. Format must be ISO 3166 (alpha-2) */
-    country?: Country;
-    /** Currency of the customer. Format must be ISO 4217 */
-    currency?: Currency;
+    /**
+     * Country code of the customer's billing address. Format must be ISO 3166 (alpha-2)
+     * @example "US"
+     */
+    country?: Country | null;
+    /**
+     * Currency of the customer. Format must be ISO 4217
+     * @example "USD"
+     */
+    currency?: Currency | null;
     /**
      * The email of the customer
      * @format email
@@ -1889,7 +2028,7 @@ export type CustomerObject = {
      */
     tax_identification_number?: string | null;
     /** The customer's timezone, used for billing purposes in their local time. Overrides the organization's timezone */
-    timezone?: Timezone;
+    timezone?: Timezone | null;
     /**
      * The custom website URL of the customer
      * @example "http://hooli.com"
@@ -1974,7 +2113,10 @@ export interface CustomerUsageObject {
      * @example "1a901a90-1a90-1a90-1a90-1a901a901a90"
      */
     lago_invoice_id?: string | null;
-    /** The currency of the customer's current usage. */
+    /**
+     * The currency of the customer's current usage.
+     * @example "EUR"
+     */
     currency?: Currency;
     /**
      * The amount in cents, tax excluded.
@@ -2203,7 +2345,10 @@ export interface FeeObject {
      * @example "1.0212"
      */
     precise_total_amount?: string;
-    /** The currency of this specific fee. It indicates the monetary unit in which the fee's cost is expressed. */
+    /**
+     * The currency of this specific fee. It indicates the monetary unit in which the fee's cost is expressed.
+     * @example "EUR"
+     */
     amount_currency: Currency;
     /**
      * The cost of the tax associated with this specific fee.
@@ -2235,7 +2380,10 @@ export interface FeeObject {
      * @example 120
      */
     total_amount_cents: number;
-    /** The currency of this specific fee, including any applicable taxes. */
+    /**
+     * The currency of this specific fee, including any applicable taxes.
+     * @example "EUR"
+     */
     total_amount_currency: Currency;
     /**
      * The number of events that have been sent and used to charge the customer. This field indicates the count or quantity of events that have been processed and considered in the charging process.
@@ -2542,7 +2690,10 @@ export interface GrossRevenueObject {
      * @example 50000
      */
     amount_cents: number;
-    /** The currency of revenue analytics. Format must be ISO 4217. */
+    /**
+     * The currency of revenue analytics. Format must be ISO 4217.
+     * @example "USD"
+     */
     currency: Currency;
     /**
      * Contains invoices count.
@@ -2702,7 +2853,10 @@ export interface MrrObject {
      * @example 50000
      */
     amount_cents?: number;
-    /** The currency of MRR analytics. Format must be ISO 4217. */
+    /**
+     * The currency of MRR analytics. Format must be ISO 4217.
+     * @example "USD"
+     */
     currency?: Currency;
 }
 export interface Mrrs {
@@ -2745,7 +2899,10 @@ export interface InvoiceCollectionObject {
      * @example 50000
      */
     amount_cents?: number;
-    /** The currency of revenue analytics. Format must be ISO 4217. */
+    /**
+     * The currency of revenue analytics. Format must be ISO 4217.
+     * @example "USD"
+     */
     currency?: Currency;
 }
 export interface InvoiceCollections {
@@ -2767,7 +2924,10 @@ export interface InvoicedUsageObject {
      * @example 50000
      */
     amount_cents: number;
-    /** The currency of revenue analytics. Format must be ISO 4217. */
+    /**
+     * The currency of revenue analytics. Format must be ISO 4217.
+     * @example "USD"
+     */
     currency: Currency;
 }
 export interface InvoicedUsages {
@@ -2864,7 +3024,10 @@ export type InvoiceObject = {
      * @example "succeeded"
      */
     payment_status: "pending" | "succeeded" | "failed";
-    /** The currency of the invoice issued. */
+    /**
+     * The currency of the invoice issued.
+     * @example "EUR"
+     */
     currency: Currency;
     /**
      * The total sum of fees amount in cents. It calculates the cumulative amount of all the fees associated with the invoice, providing a consolidated value.
@@ -2964,7 +3127,10 @@ export interface InvoiceOneOffCreateInput {
          * @example "hooli_1234"
          */
         external_customer_id: string;
-        /** The currency of the invoice. */
+        /**
+         * The currency of the invoice.
+         * @example "EUR"
+         */
         currency?: Currency;
         fees: {
             /**
@@ -3081,9 +3247,15 @@ export interface OrganizationObject {
      * @example ["https://webhook.brex.com","https://webhook2.brex.com"]
      */
     webhook_urls?: string[] | null;
-    /** The country of your organization. */
-    country?: Country;
-    /** The default currency of an organization. */
+    /**
+     * The country of your organization.
+     * @example "US"
+     */
+    country?: Country | null;
+    /**
+     * The default currency of an organization.
+     * @example "USD"
+     */
     default_currency?: Currency;
     /**
      * The first line of your organization's billing address.
@@ -3151,7 +3323,10 @@ export interface OrganizationObject {
      * @example "US123456789"
      */
     tax_identification_number?: string | null;
-    /** Your organization's timezone, used for billing purposes in your own local time. Can be overwritten by the customer's timezone. */
+    /**
+     * Your organization's timezone, used for billing purposes in your own local time. Can be overwritten by the customer's timezone.
+     * @example "America/New_York"
+     */
     timezone?: Timezone;
     /** The custom billing settings for your organization. */
     billing_configuration: OrganizationBillingConfiguration;
@@ -3170,9 +3345,15 @@ export interface OrganizationUpdateInput {
          * @example "https://webhook.brex.com"
          */
         webhook_url?: string | null;
-        /** The country of your organization. */
-        country?: Country;
-        /** The default currency of an organization. */
+        /**
+         * The country of your organization.
+         * @example "US"
+         */
+        country?: Country | null;
+        /**
+         * The default currency of an organization.
+         * @example "USD"
+         */
         default_currency?: Currency;
         /**
          * The first line of your organization's billing address.
@@ -3240,7 +3421,10 @@ export interface OrganizationUpdateInput {
          * @example "US123456789"
          */
         tax_identification_number?: string | null;
-        /** Your organization's timezone, used for billing purposes in your own local time. Can be overwritten by the customer's timezone. */
+        /**
+         * Your organization's timezone, used for billing purposes in your own local time. Can be overwritten by the customer's timezone.
+         * @example "America/New_York"
+         */
         timezone?: Timezone;
         /**
          * Represents the email settings of the organization. It allows you to define which documents are sent by email. The field value determines the types of documents that trigger email notifications. Possible values for are `invoice.finalized` and `credit_note.created`. By configuring this field, you can specify whether invoices, credit notes, or both should be sent to recipients via email.
@@ -3267,7 +3451,10 @@ export interface OverdueBalanceObject {
      * @example 50000
      */
     amount_cents: number;
-    /** The currency of revenue analytics. Format must be ISO 4217. */
+    /**
+     * The currency of revenue analytics. Format must be ISO 4217.
+     * @example "USD"
+     */
     currency: Currency;
     /**
      * The Lago invoice IDs associated with the revenue.
@@ -3323,7 +3510,10 @@ export interface PaymentRequestObject {
      * @example 100
      */
     amount_cents: number;
-    /** The currency of the payment request. */
+    /**
+     * The currency of the payment request.
+     * @example "EUR"
+     */
     amount_currency: Currency;
     /**
      * The status of the payment associated with the payment request. It can have one of the following values:
@@ -3382,7 +3572,10 @@ export interface PlanCreateInput {
          * @example 10000
          */
         amount_cents?: number;
-        /** The currency of the plan. It indicates the monetary unit in which the plan's cost, including taxes and usage-based charges, is expressed. */
+        /**
+         * The currency of the plan. It indicates the monetary unit in which the plan's cost, including taxes and usage-based charges, is expressed.
+         * @example "USD"
+         */
         amount_currency?: Currency;
         /**
          * The duration in days during which the base cost of the plan is offered for free.
@@ -3481,7 +3674,10 @@ export interface PlanOverridesObject {
      * @example 10000
      */
     amount_cents?: number;
-    /** The currency of the plan. It indicates the monetary unit in which the plan's cost, including taxes and usage-based charges, is expressed. */
+    /**
+     * The currency of the plan. It indicates the monetary unit in which the plan's cost, including taxes and usage-based charges, is expressed.
+     * @example "USD"
+     */
     amount_currency?: Currency;
     /**
      * The description on the plan.
@@ -3578,7 +3774,10 @@ export interface PlanUpdateInput {
          * @example 10000
          */
         amount_cents?: number;
-        /** The currency of the plan. It indicates the monetary unit in which the plan's cost, including taxes and usage-based charges, is expressed. */
+        /**
+         * The currency of the plan. It indicates the monetary unit in which the plan's cost, including taxes and usage-based charges, is expressed.
+         * @example "USD"
+         */
         amount_currency?: Currency;
         /**
          * The duration in days during which the base cost of the plan is offered for free.
@@ -3674,6 +3873,11 @@ export interface PlanUpdateInput {
         }[];
         /** List of usage thresholds to apply to the plan. */
         usage_thresholds?: UsageThresholdInput[];
+        /**
+         * This field determines whether the changes made to the plan should be cascaded to the children plans. When set to `true`, the changes will be cascaded into children. Conversely, when set to `false`, the changes will only be applied to the plan itself. If not defined in the request, default value is `false`.
+         * @example true
+         */
+        cascade_updates?: boolean;
     };
 }
 export interface PlanObject {
@@ -3719,7 +3923,10 @@ export interface PlanObject {
      * @example 10000
      */
     amount_cents: number;
-    /** The currency of the plan. It indicates the monetary unit in which the plan's cost, including taxes and usage-based charges, is expressed. */
+    /**
+     * The currency of the plan. It indicates the monetary unit in which the plan's cost, including taxes and usage-based charges, is expressed.
+     * @example "USD"
+     */
     amount_currency: Currency;
     /**
      * The duration in days during which the base cost of the plan is offered for free.
@@ -4136,7 +4343,10 @@ export interface WalletCreateInput {
          * @example "1.5"
          */
         rate_amount: string;
-        /** The currency of the wallet. */
+        /**
+         * The currency of the wallet.
+         * @example "USD"
+         */
         currency: Currency;
         /**
          * The number of paid credits. Required only if there is no granted credits.
@@ -4264,7 +4474,10 @@ export interface WalletObject {
      * @example "active"
      */
     status: "active" | "terminated";
-    /** The currency of the wallet. */
+    /**
+     * The currency of the wallet.
+     * @example "USD"
+     */
     currency: Currency;
     /**
      * The name of the wallet.
@@ -4767,7 +4980,7 @@ export declare class HttpClient<SecurityDataType = unknown> {
 }
 /**
  * @title Lago API documentation
- * @version 1.15.0
+ * @version 1.17.0
  * @license AGPLv3
  * @baseUrl https://api.getlago.com/api/v1
  * @externalDocs https://github.com/getlago
@@ -5023,6 +5236,16 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
              */
             per_page?: number;
         }, params?: RequestParams) => Promise<HttpResponse<BillableMetricsPaginated, ApiErrorUnauthorized>>;
+        /**
+         * @description Evaluate an expression for a billable metric creation by providing the expression and test data
+         *
+         * @tags billable_metrics
+         * @name EvaluateBillableMetricExpression
+         * @summary Evaluate an expression for a billable metric
+         * @request POST:/billable_metrics/evaluate_expression
+         * @secure
+         */
+        evaluateBillableMetricExpression: (data: BillableMetricEvaluateExpressionInput, params?: RequestParams) => Promise<HttpResponse<BillableMetricEvaluateExpressionResult, ApiErrorBadRequest | ApiErrorUnauthorized | ApiErrorUnprocessableEntity>>;
         /**
          * @description This endpoint updates an existing billable metric representing a pricing component of your application.
          *