lark-billing 0.0.9 → 0.1.0

package/dist/esm/api/resources/usageEvents/client/Client.mjs

@@ -27,11 +27,14 @@ export class UsageEvents {
      *
      * @example
      *     await client.usageEvents.createUsageEvent({
-     *         idempotency_key: "idempotency_key",
-     *         event_name: "event_name",
-     *         subject_id: "subject_id",
+     *         idempotency_key: "6b4ef298-4566-427d-b2ca-cd8fbe38ec60",
+     *         event_name: "compute_hours",
+     *         subject_id: "subj_VyX6Q96h5avMho8O7QWlKeXE",
+     *         timestamp: "2025-10-31T20:29:47Z",
      *         data: {
-     *             "key": "value"
+     *             "compute_hours": 100,
+     *             "instance_type": "t2.micro",
+     *             "region": "us-east-1"
      *         }
      *     })
      */
@@ -86,74 +89,6 @@ export class UsageEvents {
             }
         });
     }
-    /**
-     * @param {Lark.CreateUsageEventSummaryRequest} request
-     * @param {UsageEvents.RequestOptions} requestOptions - Request-specific configuration.
-     *
-     * @throws {@link Lark.UnprocessableEntityError}
-     *
-     * @example
-     *     await client.usageEvents.createUsageEventSummary({
-     *         event_name: "event_name",
-     *         subject_id: "subject_id",
-     *         period: {
-     *             start: "2024-01-15T09:30:00Z",
-     *             end: "2024-01-15T09:30:00Z"
-     *         },
-     *         aggregation_type: "sum"
-     *     })
-     */
-    createUsageEventSummary(request, requestOptions) {
-        return core.HttpResponsePromise.fromPromise(this.__createUsageEventSummary(request, requestOptions));
-    }
-    __createUsageEventSummary(request, requestOptions) {
-        return __awaiter(this, void 0, void 0, function* () {
-            var _a, _b, _c;
-            let _headers = mergeHeaders((_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, mergeOnlyDefinedHeaders(Object.assign({}, (yield this._getCustomAuthorizationHeaders()))), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers);
-            const _response = yield core.fetcher({
-                url: core.url.join((_c = (_b = (yield core.Supplier.get(this._options.baseUrl))) !== null && _b !== void 0 ? _b : (yield core.Supplier.get(this._options.environment))) !== null && _c !== void 0 ? _c : environments.LarkEnvironment.Default, "usage-events/summary"),
-                method: "POST",
-                headers: _headers,
-                contentType: "application/json",
-                queryParameters: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams,
-                requestType: "json",
-                body: request,
-                timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
-                maxRetries: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries,
-                abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
-            });
-            if (_response.ok) {
-                return { data: _response.body, rawResponse: _response.rawResponse };
-            }
-            if (_response.error.reason === "status-code") {
-                switch (_response.error.statusCode) {
-                    case 422:
-                        throw new Lark.UnprocessableEntityError(_response.error.body, _response.rawResponse);
-                    default:
-                        throw new errors.LarkError({
-                            statusCode: _response.error.statusCode,
-                            body: _response.error.body,
-                            rawResponse: _response.rawResponse,
-                        });
-                }
-            }
-            switch (_response.error.reason) {
-                case "non-json":
-                    throw new errors.LarkError({
-                        statusCode: _response.error.statusCode,
-                        body: _response.error.rawBody,
-                        rawResponse: _response.rawResponse,
-                    });
-                case "timeout":
-                    throw new errors.LarkTimeoutError("Timeout exceeded when calling POST /usage-events/summary.");
-                case "unknown":
-                    throw new errors.LarkError({
-                        message: _response.error.errorMessage,
-                        rawResponse: _response.rawResponse,
-                    });
-            }
-        });
-    }
     _getCustomAuthorizationHeaders() {
         return __awaiter(this, void 0, void 0, function* () {
             const apiKeyValue = yield core.Supplier.get(this._options.apiKey);

package/dist/esm/api/resources/usageEvents/client/requests/CreateUsageEventRequest.d.mts

@@ -4,11 +4,14 @@
 /**
  * @example
  *     {
- *         idempotency_key: "idempotency_key",
- *         event_name: "event_name",
- *         subject_id: "subject_id",
+ *         idempotency_key: "6b4ef298-4566-427d-b2ca-cd8fbe38ec60",
+ *         event_name: "compute_hours",
+ *         subject_id: "subj_VyX6Q96h5avMho8O7QWlKeXE",
+ *         timestamp: "2025-10-31T20:29:47Z",
  *         data: {
- *             "key": "value"
+ *             "compute_hours": 100,
+ *             "instance_type": "t2.micro",
+ *             "region": "us-east-1"
  *         }
  *     }
  */
@@ -26,6 +29,6 @@ export interface CreateUsageEventRequest {
 }
 export declare namespace CreateUsageEventRequest {
     namespace Data {
-        type Value = string | number | number | boolean;
+        type Value = string | number;
     }
 }

package/dist/esm/api/resources/usageEvents/client/requests/index.d.mts

@@ -1,2 +1 @@
 export { type CreateUsageEventRequest } from "./CreateUsageEventRequest.mjs";
-export { type CreateUsageEventSummaryRequest } from "./CreateUsageEventSummaryRequest.mjs";

package/dist/esm/api/types/Aggregation.d.mts

@@ -2,11 +2,20 @@
  * This file was auto-generated by Fern from our API Definition.
  */
 import * as Lark from "../index.mjs";
-export type Aggregation = Lark.Aggregation.Count | Lark.Aggregation.Sum;
+/**
+ * The aggregation function used to compute the value of the pricing metric.
+ */
+export type Aggregation = Lark.Aggregation.Count | Lark.Aggregation.Last | Lark.Aggregation.Max | Lark.Aggregation.Sum;
 export declare namespace Aggregation {
     interface Count extends Lark.CountAggregationPricingMetricResource {
         aggregation_type: "count";
     }
+    interface Last extends Lark.LastAggregationPricingMetricResource {
+        aggregation_type: "last";
+    }
+    interface Max extends Lark.MaxAggregationPricingMetricResource {
+        aggregation_type: "max";
+    }
     interface Sum extends Lark.SumAggregationPricingMetricResource {
         aggregation_type: "sum";
     }

package/dist/esm/api/types/BillingStateResponse.d.mts

@@ -2,6 +2,8 @@
  * This file was auto-generated by Fern from our API Definition.
  */
 export interface BillingStateResponse {
+    /** Whether the subject has an active subscription. */
     has_active_subscription: boolean;
+    /** Whether the subject has exceeded the included usage (if any) on a usage-based rate they are subscribed to. */
     has_overage_for_usage: boolean;
 }

package/dist/esm/api/types/CountAggregationPricingMetricInterface.d.mts

@@ -1,5 +1,8 @@
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
+/**
+ * Computes the number of usage events with the specified `event_name`.
+ */
 export interface CountAggregationPricingMetricInterface {
 }

package/dist/esm/api/types/CustomAggregationPricingMetricInterface.d.mts

@@ -0,0 +1,10 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * Custom aggregation for use cases not supported by the other aggregation types. Please email team@uselark.ai to enable this feature.
+ */
+export interface CustomAggregationPricingMetricInterface {
+    /** Custom expression to compute the pricing metric. Please email team@uselark.ai to enable this feature. */
+    custom_expression: string;
+}

package/dist/esm/api/types/LastAggregationPricingMetricInterface.d.mts

@@ -0,0 +1,10 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * Computes the last value of the `value_field` over all usage events with the specified `event_name`.
+ */
+export interface LastAggregationPricingMetricInterface {
+    /** Field to get the last value of. */
+    value_field: string;
+}

package/dist/esm/api/types/LastAggregationPricingMetricResource.d.mts

@@ -0,0 +1,7 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export interface LastAggregationPricingMetricResource {
+    /** The field to get the last value of. */
+    value_field: string;
+}

package/dist/esm/api/types/LastAggregationPricingMetricResource.mjs

@@ -0,0 +1,4 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export {};

package/dist/esm/api/types/MaxAggregationPricingMetricInterface.d.mts

@@ -0,0 +1,10 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * Computes the max value of the `value_field` over all usage events with the specified `event_name`.
+ */
+export interface MaxAggregationPricingMetricInterface {
+    /** Field to get the max value of. */
+    value_field: string;
+}

package/dist/esm/api/types/MaxAggregationPricingMetricInterface.mjs

@@ -0,0 +1,4 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export {};

package/dist/esm/api/types/MaxAggregationPricingMetricResource.d.mts

@@ -0,0 +1,7 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export interface MaxAggregationPricingMetricResource {
+    /** The field to get the max value of. */
+    value_field: string;
+}

package/dist/esm/api/types/MaxAggregationPricingMetricResource.mjs

@@ -0,0 +1,4 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export {};

package/dist/esm/api/types/PricingMetricResource.d.mts

@@ -3,9 +3,14 @@
  */
 import * as Lark from "../index.mjs";
 export interface PricingMetricResource {
+    /** The ID of the pricing metric. */
     id: string;
+    /** The name of the pricing metric. */
     name: string;
+    /** The event name that the pricing metric is computed on. */
     event_name: string;
+    /** The aggregation function used to compute the value of the pricing metric. */
     aggregation: Lark.Aggregation;
+    /** The unit of the value computed by the pricing metric. */
     unit: string;
 }

package/dist/esm/api/types/PricingMetricSummaryResource.d.mts

@@ -0,0 +1,16 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Lark from "../index.mjs";
+export interface PricingMetricSummaryResource {
+    /** The ID of the pricing metric summary. */
+    id: string;
+    /** The ID of the pricing metric that the summary is for. */
+    pricing_metric_id: string;
+    /** The ID of the subject that the summary is for. */
+    subject_id: string;
+    /** The period that the summary is computed over. */
+    period: Lark.Period;
+    /** The computed value of the pricing metric for the period. If the pricing metric does not have any usage events for the period, this will be `null`. */
+    value?: string;
+}

package/dist/esm/api/types/PricingMetricSummaryResource.mjs

@@ -0,0 +1,4 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export {};

package/dist/esm/api/types/SumAggregationPricingMetricInterface.d.mts

@@ -1,6 +1,9 @@
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
+/**
+ * Computes the sum of the `value_field` over all usage events with the specified `event_name`.
+ */
 export interface SumAggregationPricingMetricInterface {
     /** Field to sum over. */
     value_field: string;

package/dist/esm/api/types/SumAggregationPricingMetricResource.d.mts

@@ -2,5 +2,6 @@
  * This file was auto-generated by Fern from our API Definition.
  */
 export interface SumAggregationPricingMetricResource {
+    /** The field to sum over. */
     value_field: string;
 }

package/dist/esm/api/types/index.d.mts

@@ -5,27 +5,30 @@ export * from "./CountAggregationPricingMetricResource.mjs";
 export * from "./CreateCustomerPortalSessionResponse.mjs";
 export * from "./Price.mjs";
 export * from "./CreateFixedRateRequest.mjs";
-export * from "./Aggregation.mjs";
-export * from "./CreatePricingMetricResponse.mjs";
 export * from "./CreateSimpleUsageBasedRateRequest.mjs";
 export * from "./CreateSubjectResponse.mjs";
 export * from "./CreateSubscriptionCheckoutSessionResponse.mjs";
-export * from "./CreateUsageEventSummaryResponse.mjs";
+export * from "./CustomAggregationPricingMetricInterface.mjs";
 export * from "./FixedRateInterface.mjs";
 export * from "./FlatPrice.mjs";
-export * from "./GetPricingMetricResponse.mjs";
 export * from "./HttpValidationError.mjs";
 export * from "./InvoiceLineItemResource.mjs";
 export * from "./InvoiceResource.mjs";
+export * from "./LastAggregationPricingMetricInterface.mjs";
+export * from "./LastAggregationPricingMetricResource.mjs";
 export * from "./ListInvoicesResponse.mjs";
 export * from "./ListPricingMetricsResponse.mjs";
 export * from "./ListRateCardsResponse.mjs";
 export * from "./ListSubjectsResponse.mjs";
 export * from "./ListSubscriptionsResponse.mjs";
+export * from "./MaxAggregationPricingMetricInterface.mjs";
+export * from "./MaxAggregationPricingMetricResource.mjs";
 export * from "./PackagePrice.mjs";
 export * from "./Period.mjs";
 export * from "./PeriodResource.mjs";
+export * from "./Aggregation.mjs";
 export * from "./PricingMetricResource.mjs";
+export * from "./PricingMetricSummaryResource.mjs";
 export * from "./RateCardResourceUsageBasedRatesItem.mjs";
 export * from "./RateCardResource.mjs";
 export * from "./SimpleUsageBasedRateInterface.mjs";

package/dist/esm/api/types/index.mjs

@@ -5,27 +5,30 @@ export * from "./CountAggregationPricingMetricResource.mjs";
 export * from "./CreateCustomerPortalSessionResponse.mjs";
 export * from "./Price.mjs";
 export * from "./CreateFixedRateRequest.mjs";
-export * from "./Aggregation.mjs";
-export * from "./CreatePricingMetricResponse.mjs";
 export * from "./CreateSimpleUsageBasedRateRequest.mjs";
 export * from "./CreateSubjectResponse.mjs";
 export * from "./CreateSubscriptionCheckoutSessionResponse.mjs";
-export * from "./CreateUsageEventSummaryResponse.mjs";
+export * from "./CustomAggregationPricingMetricInterface.mjs";
 export * from "./FixedRateInterface.mjs";
 export * from "./FlatPrice.mjs";
-export * from "./GetPricingMetricResponse.mjs";
 export * from "./HttpValidationError.mjs";
 export * from "./InvoiceLineItemResource.mjs";
 export * from "./InvoiceResource.mjs";
+export * from "./LastAggregationPricingMetricInterface.mjs";
+export * from "./LastAggregationPricingMetricResource.mjs";
 export * from "./ListInvoicesResponse.mjs";
 export * from "./ListPricingMetricsResponse.mjs";
 export * from "./ListRateCardsResponse.mjs";
 export * from "./ListSubjectsResponse.mjs";
 export * from "./ListSubscriptionsResponse.mjs";
+export * from "./MaxAggregationPricingMetricInterface.mjs";
+export * from "./MaxAggregationPricingMetricResource.mjs";
 export * from "./PackagePrice.mjs";
 export * from "./Period.mjs";
 export * from "./PeriodResource.mjs";
+export * from "./Aggregation.mjs";
 export * from "./PricingMetricResource.mjs";
+export * from "./PricingMetricSummaryResource.mjs";
 export * from "./RateCardResourceUsageBasedRatesItem.mjs";
 export * from "./RateCardResource.mjs";
 export * from "./SimpleUsageBasedRateInterface.mjs";

package/dist/esm/version.d.mts

@@ -1 +1 @@
-export declare const SDK_VERSION = "0.0.9";
+export declare const SDK_VERSION = "0.1.0";

package/dist/esm/version.mjs

@@ -1 +1 @@
-export const SDK_VERSION = "0.0.9";
+export const SDK_VERSION = "0.1.0";

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "lark-billing",
-    "version": "0.0.9",
+    "version": "0.1.0",
     "private": false,
     "repository": "github:fern-demo/lark-ts-sdk",
     "type": "commonjs",

package/reference.md

@@ -173,7 +173,37 @@ await client.rateCards.listRateCards({
 ```typescript
 await client.rateCards.createRateCard({
     name: "Pro Plan",
+    description: "For production applications with moderate usage.",
     billing_interval: "monthly",
+    fixed_rates: [
+        {
+            name: "Base Rate",
+            price: {
+                price_type: "flat",
+                amount: {
+                    value: "2500",
+                    currency_code: "usd",
+                },
+            },
+        },
+    ],
+    usage_based_rates: [
+        {
+            usage_based_rate_type: "simple",
+            name: "name",
+            price: {
+                price_type: "flat",
+                amount: {
+                    value: "2500",
+                    currency_code: "usd",
+                },
+            },
+            pricing_metric_id: "pricing_metric_id",
+        },
+    ],
+    metadata: {
+        key: "value",
+    },
 });
 ```
 
@@ -273,11 +303,14 @@ await client.rateCards.getRateCard("rate_card_id");
 
 ```typescript
 await client.usageEvents.createUsageEvent({
-    idempotency_key: "idempotency_key",
-    event_name: "event_name",
-    subject_id: "subject_id",
+    idempotency_key: "6b4ef298-4566-427d-b2ca-cd8fbe38ec60",
+    event_name: "compute_hours",
+    subject_id: "subj_VyX6Q96h5avMho8O7QWlKeXE",
+    timestamp: "2025-10-31T20:29:47Z",
     data: {
-        key: "value",
+        compute_hours: 100,
+        instance_type: "t2.micro",
+        region: "us-east-1",
     },
 });
 ```
@@ -314,62 +347,6 @@ await client.usageEvents.createUsageEvent({
 </dl>
 </details>
 
-<details><summary><code>client.usageEvents.<a href="/src/api/resources/usageEvents/client/Client.ts">createUsageEventSummary</a>({ ...params }) -> Lark.CreateUsageEventSummaryResponse</code></summary>
-<dl>
-<dd>
-
-#### 🔌 Usage
-
-<dl>
-<dd>
-
-<dl>
-<dd>
-
-```typescript
-await client.usageEvents.createUsageEventSummary({
-    event_name: "event_name",
-    subject_id: "subject_id",
-    period: {
-        start: "2024-01-15T09:30:00Z",
-        end: "2024-01-15T09:30:00Z",
-    },
-    aggregation_type: "sum",
-});
-```
-
-</dd>
-</dl>
-</dd>
-</dl>
-
-#### ⚙️ Parameters
-
-<dl>
-<dd>
-
-<dl>
-<dd>
-
-**request:** `Lark.CreateUsageEventSummaryRequest`
-
-</dd>
-</dl>
-
-<dl>
-<dd>
-
-**requestOptions:** `UsageEvents.RequestOptions`
-
-</dd>
-</dl>
-</dd>
-</dl>
-
-</dd>
-</dl>
-</details>
-
 ## Subscriptions
 
 <details><summary><code>client.subscriptions.<a href="/src/api/resources/subscriptions/client/Client.ts">listSubscriptions</a>({ ...params }) -> Lark.ListSubscriptionsResponse</code></summary>
@@ -703,7 +680,14 @@ await client.subjects.listSubjects({
 <dd>
 
 ```typescript
-await client.subjects.createSubject();
+await client.subjects.createSubject({
+    external_id: "user_1234567890",
+    name: "John Doe",
+    email: "john.doe@example.com",
+    metadata: {
+        key: "value",
+    },
+});
 ```
 
 </dd>
@@ -942,7 +926,7 @@ await client.pricingMetrics.listPricingMetrics({
 </dl>
 </details>
 
-<details><summary><code>client.pricingMetrics.<a href="/src/api/resources/pricingMetrics/client/Client.ts">createPricingMetric</a>({ ...params }) -> Lark.CreatePricingMetricResponse</code></summary>
+<details><summary><code>client.pricingMetrics.<a href="/src/api/resources/pricingMetrics/client/Client.ts">createPricingMetric</a>({ ...params }) -> Lark.PricingMetricResource</code></summary>
 <dl>
 <dd>
 
@@ -956,12 +940,13 @@ await client.pricingMetrics.listPricingMetrics({
 
 ```typescript
 await client.pricingMetrics.createPricingMetric({
-    name: "name",
-    event_name: "event_name",
+    name: "Compute Hours",
+    event_name: "job_completed",
     aggregation: {
-        aggregation_type: "count",
+        aggregation_type: "sum",
+        value_field: "value_field",
     },
-    unit: "unit",
+    unit: "hours",
 });
 ```
 
@@ -997,7 +982,7 @@ await client.pricingMetrics.createPricingMetric({
 </dl>
 </details>
 
-<details><summary><code>client.pricingMetrics.<a href="/src/api/resources/pricingMetrics/client/Client.ts">getPricingMetric</a>(pricingMetricId) -> Lark.GetPricingMetricResponse</code></summary>
+<details><summary><code>client.pricingMetrics.<a href="/src/api/resources/pricingMetrics/client/Client.ts">getPricingMetric</a>(pricingMetricId) -> Lark.PricingMetricResource</code></summary>
 <dl>
 <dd>
 
@@ -1045,6 +1030,68 @@ await client.pricingMetrics.getPricingMetric("pricing_metric_id");
 </dl>
 </details>
 
+<details><summary><code>client.pricingMetrics.<a href="/src/api/resources/pricingMetrics/client/Client.ts">createPricingMetricSummary</a>(pricingMetricId, { ...params }) -> Lark.PricingMetricSummaryResource</code></summary>
+<dl>
+<dd>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.pricingMetrics.createPricingMetricSummary("pricing_metric_id", {
+    subject_id: "subj_VyX6Q96h5avMho8O7QWlKeXE",
+    period: {
+        start: "2025-10-01T00:00:00Z",
+        end: "2025-11-01T00:00:00Z",
+    },
+});
+```
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**pricingMetricId:** `string`
+
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**request:** `Lark.CreatePricingMetricSummaryRequest`
+
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `PricingMetrics.RequestOptions`
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+</dd>
+</dl>
+</details>
+
 ## CustomerAccess
 
 <details><summary><code>client.customerAccess.<a href="/src/api/resources/customerAccess/client/Client.ts">getBillingState</a>(subjectId) -> Lark.BillingStateResponse</code></summary>

package/dist/cjs/api/resources/usageEvents/client/requests/CreateUsageEventSummaryRequest.d.ts

@@ -1,30 +0,0 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-import * as Lark from "../../../../index.js";
-/**
- * @example
- *     {
- *         event_name: "event_name",
- *         subject_id: "subject_id",
- *         period: {
- *             start: "2024-01-15T09:30:00Z",
- *             end: "2024-01-15T09:30:00Z"
- *         },
- *         aggregation_type: "sum"
- *     }
- */
-export interface CreateUsageEventSummaryRequest {
-    event_name: string;
-    subject_id: string;
-    period: Lark.Period;
-    aggregation_type: CreateUsageEventSummaryRequest.AggregationType;
-}
-export declare namespace CreateUsageEventSummaryRequest {
-    type AggregationType = "sum" | "count" | "max";
-    const AggregationType: {
-        readonly Sum: "sum";
-        readonly Count: "count";
-        readonly Max: "max";
-    };
-}