lago-javascript-client 1.15.0 → 1.16.0

package/esm/openapi/client.d.ts

@@ -391,12 +391,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"
@@ -454,6 +469,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 +506,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 {
     /**
@@ -3674,6 +3742,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 {
@@ -4767,7 +4840,7 @@ export declare class HttpClient<SecurityDataType = unknown> {
 }
 /**
  * @title Lago API documentation
- * @version 1.15.0
+ * @version 1.16.0
  * @license AGPLv3
  * @baseUrl https://api.getlago.com/api/v1
  * @externalDocs https://github.com/getlago
@@ -5023,6 +5096,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.
          *

package/esm/openapi/client.js

@@ -148,7 +148,7 @@ export class HttpClient {
 }
 /**
  * @title Lago API documentation
- * @version 1.15.0
+ * @version 1.16.0
  * @license AGPLv3
  * @baseUrl https://api.getlago.com/api/v1
  * @externalDocs https://github.com/getlago
@@ -404,6 +404,24 @@ export class Api extends HttpClient {
             format: "json",
             ...params,
         }),
+        /**
+         * @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, params = {}) => this.request({
+            path: `/billable_metrics/evaluate_expression`,
+            method: "POST",
+            body: data,
+            secure: true,
+            type: ContentType.Json,
+            format: "json",
+            ...params,
+        }),
         /**
          * @description This endpoint updates an existing billable metric representing a pricing component of your application.
          *

package/package.json

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

package/script/openapi/client.d.ts

@@ -391,12 +391,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"
@@ -454,6 +469,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 +506,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 {
     /**
@@ -3674,6 +3742,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 {
@@ -4767,7 +4840,7 @@ export declare class HttpClient<SecurityDataType = unknown> {
 }
 /**
  * @title Lago API documentation
- * @version 1.15.0
+ * @version 1.16.0
  * @license AGPLv3
  * @baseUrl https://api.getlago.com/api/v1
  * @externalDocs https://github.com/getlago
@@ -5023,6 +5096,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.
          *

package/script/openapi/client.js

@@ -152,7 +152,7 @@ class HttpClient {
 exports.HttpClient = HttpClient;
 /**
  * @title Lago API documentation
- * @version 1.15.0
+ * @version 1.16.0
  * @license AGPLv3
  * @baseUrl https://api.getlago.com/api/v1
  * @externalDocs https://github.com/getlago
@@ -408,6 +408,24 @@ class Api extends HttpClient {
             format: "json",
             ...params,
         }),
+        /**
+         * @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, params = {}) => this.request({
+            path: `/billable_metrics/evaluate_expression`,
+            method: "POST",
+            body: data,
+            secure: true,
+            type: ContentType.Json,
+            format: "json",
+            ...params,
+        }),
         /**
          * @description This endpoint updates an existing billable metric representing a pricing component of your application.
          *