lark-billing 0.0.9 → 0.1.1

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "lark-billing",
-    "version": "0.0.9",
+    "version": "0.1.1",
     "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: "f283b3d1-41b2-43b1-9d00-dd7935cb6263",
+    event_name: "compute_hours",
+    subject_id: "subj_VyX6Q96h5avMho8O7QWlKeXE",
+    timestamp: "2025-11-03T18:37:02Z",
     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";
-    };
-}

package/dist/cjs/api/resources/usageEvents/client/requests/CreateUsageEventSummaryRequest.js

@@ -1,14 +0,0 @@
-"use strict";
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.CreateUsageEventSummaryRequest = void 0;
-var CreateUsageEventSummaryRequest;
-(function (CreateUsageEventSummaryRequest) {
-    CreateUsageEventSummaryRequest.AggregationType = {
-        Sum: "sum",
-        Count: "count",
-        Max: "max",
-    };
-})(CreateUsageEventSummaryRequest || (exports.CreateUsageEventSummaryRequest = CreateUsageEventSummaryRequest = {}));

package/dist/cjs/api/types/CreatePricingMetricResponse.d.ts

@@ -1,11 +0,0 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-import * as Lark from "../index.js";
-export interface CreatePricingMetricResponse {
-    id: string;
-    name: string;
-    event_name: string;
-    aggregation: Lark.Aggregation;
-    unit: string;
-}

package/dist/cjs/api/types/CreateUsageEventSummaryResponse.d.ts

@@ -1,10 +0,0 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-import * as Lark from "../index.js";
-export interface CreateUsageEventSummaryResponse {
-    event_name: string;
-    subject_id: string;
-    value?: string;
-    period: Lark.Period;
-}

package/dist/cjs/api/types/GetPricingMetricResponse.d.ts

@@ -1,11 +0,0 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-import * as Lark from "../index.js";
-export interface GetPricingMetricResponse {
-    id: string;
-    name: string;
-    event_name: string;
-    aggregation: Lark.Aggregation;
-    unit: string;
-}

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

@@ -1,30 +0,0 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-import * as Lark from "../../../../index.mjs";
-/**
- * @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";
-    };
-}

package/dist/esm/api/resources/usageEvents/client/requests/CreateUsageEventSummaryRequest.mjs

@@ -1,11 +0,0 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-export var CreateUsageEventSummaryRequest;
-(function (CreateUsageEventSummaryRequest) {
-    CreateUsageEventSummaryRequest.AggregationType = {
-        Sum: "sum",
-        Count: "count",
-        Max: "max",
-    };
-})(CreateUsageEventSummaryRequest || (CreateUsageEventSummaryRequest = {}));

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

@@ -1,11 +0,0 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-import * as Lark from "../index.mjs";
-export interface CreatePricingMetricResponse {
-    id: string;
-    name: string;
-    event_name: string;
-    aggregation: Lark.Aggregation;
-    unit: string;
-}

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

@@ -1,10 +0,0 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-import * as Lark from "../index.mjs";
-export interface CreateUsageEventSummaryResponse {
-    event_name: string;
-    subject_id: string;
-    value?: string;
-    period: Lark.Period;
-}

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

@@ -1,11 +0,0 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-import * as Lark from "../index.mjs";
-export interface GetPricingMetricResponse {
-    id: string;
-    name: string;
-    event_name: string;
-    aggregation: Lark.Aggregation;
-    unit: string;
-}