lark-billing 0.0.5 → 0.0.7

package/reference.md

@@ -2,7 +2,7 @@
 
 ## Checkout
 
-<details><summary><code>client.checkout.<a href="/src/api/resources/checkout/client/Client.ts">createRateCardCheckoutSession</a>({ ...params }) -> Lark.CreateRateCardCheckoutResponse</code></summary>
+<details><summary><code>client.checkout.<a href="/src/api/resources/checkout/client/Client.ts">createSubscriptionCheckoutSession</a>({ ...params }) -> Lark.CreateSubscriptionCheckoutSessionResponse</code></summary>
 <dl>
 <dd>
 
@@ -15,9 +15,10 @@
 <dd>
 
 ```typescript
-await client.checkout.createRateCardCheckoutSession({
+await client.checkout.createSubscriptionCheckoutSession({
     subject_id: "subject_id",
     rate_card_id: "rate_card_id",
+    callback_url: "callback_url",
 });
 ```
 
@@ -34,7 +35,7 @@ await client.checkout.createRateCardCheckoutSession({
 <dl>
 <dd>
 
-**request:** `Lark.CreateRateCardCheckoutRequest`
+**request:** `Lark.CreateSubscriptionCheckoutSessionRequest`
 
 </dd>
 </dl>
@@ -53,9 +54,9 @@ await client.checkout.createRateCardCheckoutSession({
 </dl>
 </details>
 
-## RateCards
+## CustomerPortal
 
-<details><summary><code>client.rateCards.<a href="/src/api/resources/rateCards/client/Client.ts">listRateCards</a>({ ...params }) -> Lark.ListRateCardsResponse</code></summary>
+<details><summary><code>client.customerPortal.<a href="/src/api/resources/customerPortal/client/Client.ts">createCustomerPortalSession</a>({ ...params }) -> Lark.CreateCustomerPortalSessionResponse</code></summary>
 <dl>
 <dd>
 
@@ -68,9 +69,8 @@ await client.checkout.createRateCardCheckoutSession({
 <dd>
 
 ```typescript
-await client.rateCards.listRateCards({
-    limit: 1,
-    offset: 1,
+await client.customerPortal.createCustomerPortalSession({
+    subject_id: "subject_id",
 });
 ```
 
@@ -87,7 +87,7 @@ await client.rateCards.listRateCards({
 <dl>
 <dd>
 
-**request:** `Lark.RateCardsListRateCardsRequest`
+**request:** `Lark.CreateCustomerPortalSessionRequest`
 
 </dd>
 </dl>
@@ -95,7 +95,7 @@ await client.rateCards.listRateCards({
 <dl>
 <dd>
 
-**requestOptions:** `RateCards.RequestOptions`
+**requestOptions:** `CustomerPortal.RequestOptions`
 
 </dd>
 </dl>
@@ -106,7 +106,9 @@ await client.rateCards.listRateCards({
 </dl>
 </details>
 
-<details><summary><code>client.rateCards.<a href="/src/api/resources/rateCards/client/Client.ts">createRateCard</a>({ ...params }) -> Lark.CreateRateCardResponse</code></summary>
+## RateCards
+
+<details><summary><code>client.rateCards.<a href="/src/api/resources/rateCards/client/Client.ts">listRateCards</a>({ ...params }) -> Lark.ListRateCardsResponse</code></summary>
 <dl>
 <dd>
 
@@ -119,49 +121,8 @@ await client.rateCards.listRateCards({
 <dd>
 
 ```typescript
-await client.rateCards.createRateCard({
-    name: "name",
-    description: "description",
-    usage_based_rates: [
-        {
-            usage_based_rate_type: "dimensional",
-            name: "name",
-            pricing_metric: {
-                name: "name",
-                event_name: "event_name",
-                aggregation: {
-                    aggregation_type: "count",
-                },
-                unit: "unit",
-            },
-            dimensions: [
-                {
-                    key: "key",
-                    values: ["values"],
-                },
-            ],
-            pricing_matrix: {
-                cells: [
-                    {
-                        dimension_coordinates: [
-                            {
-                                dimension_key: "dimension_key",
-                                value: "value",
-                            },
-                        ],
-                        price: {
-                            amount: {
-                                value: 1,
-                                currency_code: "currency_code",
-                            },
-                            price_type: "flat",
-                        },
-                    },
-                ],
-            },
-        },
-    ],
-    billing_interval: "monthly",
+await client.rateCards.listRateCards({
+    limit: 1,
 });
 ```
 
@@ -178,7 +139,7 @@ await client.rateCards.createRateCard({
 <dl>
 <dd>
 
-**request:** `Lark.CreateRateCardRequest`
+**request:** `Lark.ListRateCardsRateCardsGetRequest`
 
 </dd>
 </dl>
@@ -197,7 +158,7 @@ await client.rateCards.createRateCard({
 </dl>
 </details>
 
-<details><summary><code>client.rateCards.<a href="/src/api/resources/rateCards/client/Client.ts">getRateCard</a>(rateCardId) -> Lark.GetRateCardResponse</code></summary>
+<details><summary><code>client.rateCards.<a href="/src/api/resources/rateCards/client/Client.ts">createRateCard</a>({ ...params }) -> Lark.RateCardResource</code></summary>
 <dl>
 <dd>
 
@@ -210,7 +171,10 @@ await client.rateCards.createRateCard({
 <dd>
 
 ```typescript
-await client.rateCards.getRateCard("rate_card_id");
+await client.rateCards.createRateCard({
+    name: "name",
+    billing_interval: "monthly",
+});
 ```
 
 </dd>
@@ -226,7 +190,7 @@ await client.rateCards.getRateCard("rate_card_id");
 <dl>
 <dd>
 
-**rateCardId:** `string`
+**request:** `Lark.CreateRateCardRequest`
 
 </dd>
 </dl>
@@ -245,7 +209,7 @@ await client.rateCards.getRateCard("rate_card_id");
 </dl>
 </details>
 
-<details><summary><code>client.rateCards.<a href="/src/api/resources/rateCards/client/Client.ts">deleteRateCard</a>(rateCardId) -> void</code></summary>
+<details><summary><code>client.rateCards.<a href="/src/api/resources/rateCards/client/Client.ts">getRateCard</a>(rateCardId) -> Lark.RateCardResource</code></summary>
 <dl>
 <dd>
 
@@ -258,7 +222,7 @@ await client.rateCards.getRateCard("rate_card_id");
 <dd>
 
 ```typescript
-await client.rateCards.deleteRateCard("rate_card_id");
+await client.rateCards.getRateCard("rate_card_id");
 ```
 
 </dd>
@@ -293,55 +257,9 @@ await client.rateCards.deleteRateCard("rate_card_id");
 </dl>
 </details>
 
-<details><summary><code>client.rateCards.<a href="/src/api/resources/rateCards/client/Client.ts">updateRateCard</a>(rateCardId) -> void</code></summary>
-<dl>
-<dd>
-
-#### 🔌 Usage
-
-<dl>
-<dd>
-
-<dl>
-<dd>
-
-```typescript
-await client.rateCards.updateRateCard("rate_card_id");
-```
-
-</dd>
-</dl>
-</dd>
-</dl>
-
-#### ⚙️ Parameters
-
-<dl>
-<dd>
-
-<dl>
-<dd>
-
-**rateCardId:** `string`
-
-</dd>
-</dl>
-
-<dl>
-<dd>
-
-**requestOptions:** `RateCards.RequestOptions`
-
-</dd>
-</dl>
-</dd>
-</dl>
-
-</dd>
-</dl>
-</details>
+## UsageEvents
 
-<details><summary><code>client.rateCards.<a href="/src/api/resources/rateCards/client/Client.ts">createRateCardVersion</a>(rateCardId, { ...params }) -> Lark.CreateRateCardVersionResponse</code></summary>
+<details><summary><code>client.usageEvents.<a href="/src/api/resources/usageEvents/client/Client.ts">createUsageEvent</a>({ ...params }) -> unknown</code></summary>
 <dl>
 <dd>
 
@@ -354,51 +272,13 @@ await client.rateCards.updateRateCard("rate_card_id");
 <dd>
 
 ```typescript
-await client.rateCards.createRateCardVersion("rate_card_id", {
-    name: "name",
-    description: "description",
-    usage_based_rates: [
-        {
-            usage_based_rate_type: "dimensional",
-            name: "name",
-            description: "description",
-            included_units: 1,
-            pricing_metric: {
-                name: "name",
-                event_name: "event_name",
-                aggregation: {
-                    aggregation_type: "count",
-                },
-                unit: "unit",
-            },
-            dimensions: [
-                {
-                    key: "key",
-                    values: ["values"],
-                },
-            ],
-            pricing_matrix: {
-                cells: [
-                    {
-                        dimension_coordinates: [
-                            {
-                                dimension_key: "dimension_key",
-                                value: "value",
-                            },
-                        ],
-                        price: {
-                            amount: {
-                                value: 1,
-                                currency_code: "currency_code",
-                            },
-                            price_type: "flat",
-                        },
-                    },
-                ],
-            },
-        },
-    ],
-    version_type: "major",
+await client.usageEvents.createUsageEvent({
+    idempotency_key: "idempotency_key",
+    event_name: "event_name",
+    subject_id: "subject_id",
+    data: {
+        key: "value",
+    },
 });
 ```
 
@@ -415,15 +295,7 @@ await client.rateCards.createRateCardVersion("rate_card_id", {
 <dl>
 <dd>
 
-**rateCardId:** `string`
-
-</dd>
-</dl>
-
-<dl>
-<dd>
-
-**request:** `Lark.CreateRateCardVersionRequest`
+**request:** `Lark.CreateUsageEventRequest`
 
 </dd>
 </dl>
@@ -431,7 +303,7 @@ await client.rateCards.createRateCardVersion("rate_card_id", {
 <dl>
 <dd>
 
-**requestOptions:** `RateCards.RequestOptions`
+**requestOptions:** `UsageEvents.RequestOptions`
 
 </dd>
 </dl>
@@ -442,9 +314,7 @@ await client.rateCards.createRateCardVersion("rate_card_id", {
 </dl>
 </details>
 
-## UsageEvents
-
-<details><summary><code>client.usageEvents.<a href="/src/api/resources/usageEvents/client/Client.ts">createUsageEvent</a>({ ...params }) -> unknown</code></summary>
+<details><summary><code>client.usageEvents.<a href="/src/api/resources/usageEvents/client/Client.ts">createUsageEventSummary</a>({ ...params }) -> Lark.CreateUsageEventSummaryResponse</code></summary>
 <dl>
 <dd>
 
@@ -457,14 +327,14 @@ await client.rateCards.createRateCardVersion("rate_card_id", {
 <dd>
 
 ```typescript
-await client.usageEvents.createUsageEvent({
-    idempotency_key: "idempotency_key",
+await client.usageEvents.createUsageEventSummary({
     event_name: "event_name",
     subject_id: "subject_id",
-    timestamp: "2024-01-15T09:30:00Z",
-    data: {
-        key: "value",
+    period: {
+        start: "2024-01-15T09:30:00Z",
+        end: "2024-01-15T09:30:00Z",
     },
+    aggregation_type: "sum",
 });
 ```
 
@@ -481,7 +351,7 @@ await client.usageEvents.createUsageEvent({
 <dl>
 <dd>
 
-**request:** `Lark.CreateUsageEventRequest`
+**request:** `Lark.CreateUsageEventSummaryRequest`
 
 </dd>
 </dl>
@@ -517,7 +387,8 @@ await client.usageEvents.createUsageEvent({
 ```typescript
 await client.subscriptions.listSubscriptions({
     limit: 1,
-    offset: 1,
+    subject_id: "subject_id",
+    rate_card_id: "rate_card_id",
 });
 ```
 
@@ -534,7 +405,7 @@ await client.subscriptions.listSubscriptions({
 <dl>
 <dd>
 
-**request:** `Lark.SubscriptionsListSubscriptionsRequest`
+**request:** `Lark.ListSubscriptionsSubscriptionsGetRequest`
 
 </dd>
 </dl>
@@ -569,7 +440,6 @@ await client.subscriptions.listSubscriptions({
 await client.subscriptions.createSubscription({
     rate_card_id: "rate_card_id",
     subject_id: "subject_id",
-    effective_at: "2024-01-15T09:30:00Z",
 });
 ```
 
@@ -653,144 +523,6 @@ await client.subscriptions.getSubscription("subscription_id");
 </dl>
 </details>
 
-<details><summary><code>client.subscriptions.<a href="/src/api/resources/subscriptions/client/Client.ts">cancelSubscription</a>(subscriptionId) -> void</code></summary>
-<dl>
-<dd>
-
-#### 🔌 Usage
-
-<dl>
-<dd>
-
-<dl>
-<dd>
-
-```typescript
-await client.subscriptions.cancelSubscription("subscription_id");
-```
-
-</dd>
-</dl>
-</dd>
-</dl>
-
-#### ⚙️ Parameters
-
-<dl>
-<dd>
-
-<dl>
-<dd>
-
-**subscriptionId:** `string`
-
-</dd>
-</dl>
-
-<dl>
-<dd>
-
-**requestOptions:** `Subscriptions.RequestOptions`
-
-</dd>
-</dl>
-</dd>
-</dl>
-
-</dd>
-</dl>
-</details>
-
-<details><summary><code>client.subscriptions.<a href="/src/api/resources/subscriptions/client/Client.ts">updateSubscription</a>(subscriptionId) -> void</code></summary>
-<dl>
-<dd>
-
-#### 🔌 Usage
-
-<dl>
-<dd>
-
-<dl>
-<dd>
-
-```typescript
-await client.subscriptions.updateSubscription("subscription_id");
-```
-
-</dd>
-</dl>
-</dd>
-</dl>
-
-#### ⚙️ Parameters
-
-<dl>
-<dd>
-
-<dl>
-<dd>
-
-**subscriptionId:** `string`
-
-</dd>
-</dl>
-
-<dl>
-<dd>
-
-**requestOptions:** `Subscriptions.RequestOptions`
-
-</dd>
-</dl>
-</dd>
-</dl>
-
-</dd>
-</dl>
-</details>
-
-## FeatureAccess
-
-<details><summary><code>client.featureAccess.<a href="/src/api/resources/featureAccess/client/Client.ts">getFeatureAccess</a>() -> Lark.CheckFeatureAccessResponse</code></summary>
-<dl>
-<dd>
-
-#### 🔌 Usage
-
-<dl>
-<dd>
-
-<dl>
-<dd>
-
-```typescript
-await client.featureAccess.getFeatureAccess();
-```
-
-</dd>
-</dl>
-</dd>
-</dl>
-
-#### ⚙️ Parameters
-
-<dl>
-<dd>
-
-<dl>
-<dd>
-
-**requestOptions:** `FeatureAccess.RequestOptions`
-
-</dd>
-</dl>
-</dd>
-</dl>
-
-</dd>
-</dl>
-</details>
-
 ## Subjects
 
 <details><summary><code>client.subjects.<a href="/src/api/resources/subjects/client/Client.ts">listSubjects</a>({ ...params }) -> Lark.ListSubjectsResponse</code></summary>
@@ -825,7 +557,7 @@ await client.subjects.listSubjects({
 <dl>
 <dd>
 
-**request:** `Lark.SubjectsListSubjectsRequest`
+**request:** `Lark.ListSubjectsSubjectsGetRequest`
 
 </dd>
 </dl>
@@ -1044,137 +776,9 @@ await client.subjects.deleteSubject("subject_id");
 </dl>
 </details>
 
-## PricingPlans
-
-<details><summary><code>client.pricingPlans.<a href="/src/api/resources/pricingPlans/client/Client.ts">listPricingPlans</a>() -> void</code></summary>
-<dl>
-<dd>
-
-#### 🔌 Usage
-
-<dl>
-<dd>
-
-<dl>
-<dd>
-
-```typescript
-await client.pricingPlans.listPricingPlans();
-```
-
-</dd>
-</dl>
-</dd>
-</dl>
-
-#### ⚙️ Parameters
-
-<dl>
-<dd>
-
-<dl>
-<dd>
-
-**requestOptions:** `PricingPlans.RequestOptions`
-
-</dd>
-</dl>
-</dd>
-</dl>
-
-</dd>
-</dl>
-</details>
-
-<details><summary><code>client.pricingPlans.<a href="/src/api/resources/pricingPlans/client/Client.ts">createPricingPlan</a>() -> void</code></summary>
-<dl>
-<dd>
-
-#### 🔌 Usage
-
-<dl>
-<dd>
-
-<dl>
-<dd>
-
-```typescript
-await client.pricingPlans.createPricingPlan();
-```
-
-</dd>
-</dl>
-</dd>
-</dl>
-
-#### ⚙️ Parameters
-
-<dl>
-<dd>
-
-<dl>
-<dd>
-
-**requestOptions:** `PricingPlans.RequestOptions`
-
-</dd>
-</dl>
-</dd>
-</dl>
-
-</dd>
-</dl>
-</details>
-
-<details><summary><code>client.pricingPlans.<a href="/src/api/resources/pricingPlans/client/Client.ts">getPricingPlan</a>(planId) -> void</code></summary>
-<dl>
-<dd>
-
-#### 🔌 Usage
-
-<dl>
-<dd>
-
-<dl>
-<dd>
-
-```typescript
-await client.pricingPlans.getPricingPlan("plan_id");
-```
-
-</dd>
-</dl>
-</dd>
-</dl>
-
-#### ⚙️ Parameters
+## PricingMetrics
 
-<dl>
-<dd>
-
-<dl>
-<dd>
-
-**planId:** `string`
-
-</dd>
-</dl>
-
-<dl>
-<dd>
-
-**requestOptions:** `PricingPlans.RequestOptions`
-
-</dd>
-</dl>
-</dd>
-</dl>
-
-</dd>
-</dl>
-</details>
-
-<details><summary><code>client.pricingPlans.<a href="/src/api/resources/pricingPlans/client/Client.ts">updatePricingPlan</a>(planId) -> void</code></summary>
+<details><summary><code>client.pricingMetrics.<a href="/src/api/resources/pricingMetrics/client/Client.ts">createPricingMetric</a>({ ...params }) -> Lark.CreatePricingMetricResponse</code></summary>
 <dl>
 <dd>
 
@@ -1187,7 +791,14 @@ await client.pricingPlans.getPricingPlan("plan_id");
 <dd>
 
 ```typescript
-await client.pricingPlans.updatePricingPlan("plan_id");
+await client.pricingMetrics.createPricingMetric({
+    name: "name",
+    event_name: "event_name",
+    aggregation: {
+        aggregation_type: "count",
+    },
+    unit: "unit",
+});
 ```
 
 </dd>
@@ -1203,7 +814,7 @@ await client.pricingPlans.updatePricingPlan("plan_id");
 <dl>
 <dd>
 
-**planId:** `string`
+**request:** `Lark.CreatePricingMetricRequest`
 
 </dd>
 </dl>
@@ -1211,7 +822,7 @@ await client.pricingPlans.updatePricingPlan("plan_id");
 <dl>
 <dd>
 
-**requestOptions:** `PricingPlans.RequestOptions`
+**requestOptions:** `PricingMetrics.RequestOptions`
 
 </dd>
 </dl>
@@ -1222,7 +833,7 @@ await client.pricingPlans.updatePricingPlan("plan_id");
 </dl>
 </details>
 
-<details><summary><code>client.pricingPlans.<a href="/src/api/resources/pricingPlans/client/Client.ts">deletePricingPlan</a>(planId) -> void</code></summary>
+<details><summary><code>client.pricingMetrics.<a href="/src/api/resources/pricingMetrics/client/Client.ts">getPricingMetric</a>(pricingMetricId) -> Lark.GetPricingMetricResponse</code></summary>
 <dl>
 <dd>
 
@@ -1235,7 +846,7 @@ await client.pricingPlans.updatePricingPlan("plan_id");
 <dd>
 
 ```typescript
-await client.pricingPlans.deletePricingPlan("plan_id");
+await client.pricingMetrics.getPricingMetric("pricing_metric_id");
 ```
 
 </dd>
@@ -1251,7 +862,7 @@ await client.pricingPlans.deletePricingPlan("plan_id");
 <dl>
 <dd>
 
-**planId:** `string`
+**pricingMetricId:** `string`
 
 </dd>
 </dl>
@@ -1259,7 +870,7 @@ await client.pricingPlans.deletePricingPlan("plan_id");
 <dl>
 <dd>
 
-**requestOptions:** `PricingPlans.RequestOptions`
+**requestOptions:** `PricingMetrics.RequestOptions`
 
 </dd>
 </dl>
@@ -1270,9 +881,9 @@ await client.pricingPlans.deletePricingPlan("plan_id");
 </dl>
 </details>
 
-## CreditPools
+## CustomerAccess
 
-<details><summary><code>client.creditPools.<a href="/src/api/resources/creditPools/client/Client.ts">listCreditPools</a>() -> void</code></summary>
+<details><summary><code>client.customerAccess.<a href="/src/api/resources/customerAccess/client/Client.ts">getBillingState</a>(subjectId) -> Lark.BillingStateResponse</code></summary>
 <dl>
 <dd>
 
@@ -1285,7 +896,7 @@ await client.pricingPlans.deletePricingPlan("plan_id");
 <dd>
 
 ```typescript
-await client.creditPools.listCreditPools();
+await client.customerAccess.getBillingState("subject_id");
 ```
 
 </dd>
@@ -1301,87 +912,15 @@ await client.creditPools.listCreditPools();
 <dl>
 <dd>
 
-**requestOptions:** `CreditPools.RequestOptions`
-
-</dd>
-</dl>
-</dd>
-</dl>
-
-</dd>
-</dl>
-</details>
-
-<details><summary><code>client.creditPools.<a href="/src/api/resources/creditPools/client/Client.ts">createCreditPool</a>() -> void</code></summary>
-<dl>
-<dd>
-
-#### 🔌 Usage
-
-<dl>
-<dd>
-
-<dl>
-<dd>
-
-```typescript
-await client.creditPools.createCreditPool();
-```
-
-</dd>
-</dl>
-</dd>
-</dl>
-
-#### ⚙️ Parameters
-
-<dl>
-<dd>
-
-<dl>
-<dd>
-
-**requestOptions:** `CreditPools.RequestOptions`
-
-</dd>
-</dl>
-</dd>
-</dl>
-
-</dd>
-</dl>
-</details>
-
-<details><summary><code>client.creditPools.<a href="/src/api/resources/creditPools/client/Client.ts">grantCredits</a>() -> void</code></summary>
-<dl>
-<dd>
-
-#### 🔌 Usage
-
-<dl>
-<dd>
-
-<dl>
-<dd>
-
-```typescript
-await client.creditPools.grantCredits();
-```
+**subjectId:** `string`
 
 </dd>
 </dl>
-</dd>
-</dl>
-
-#### ⚙️ Parameters
-
-<dl>
-<dd>
 
 <dl>
 <dd>
 
-**requestOptions:** `CreditPools.RequestOptions`
+**requestOptions:** `CustomerAccess.RequestOptions`
 
 </dd>
 </dl>