lark-billing 0.0.6 → 0.0.7

package/reference.md

@@ -18,6 +18,7 @@
 await client.checkout.createSubscriptionCheckoutSession({
     subject_id: "subject_id",
     rate_card_id: "rate_card_id",
+    callback_url: "callback_url",
 });
 ```
 
@@ -53,7 +54,9 @@ await client.checkout.createSubscriptionCheckoutSession({
 </dl>
 </details>
 
-<details><summary><code>client.checkout.<a href="/src/api/resources/checkout/client/Client.ts">completeSubscriptionCheckout</a>(checkoutId) -> Lark.CompleteSubscriptionCheckoutResponse</code></summary>
+## CustomerPortal
+
+<details><summary><code>client.customerPortal.<a href="/src/api/resources/customerPortal/client/Client.ts">createCustomerPortalSession</a>({ ...params }) -> Lark.CreateCustomerPortalSessionResponse</code></summary>
 <dl>
 <dd>
 
@@ -66,7 +69,9 @@ await client.checkout.createSubscriptionCheckoutSession({
 <dd>
 
 ```typescript
-await client.checkout.completeSubscriptionCheckout("checkout_id");
+await client.customerPortal.createCustomerPortalSession({
+    subject_id: "subject_id",
+});
 ```
 
 </dd>
@@ -82,7 +87,7 @@ await client.checkout.completeSubscriptionCheckout("checkout_id");
 <dl>
 <dd>
 
-**checkoutId:** `string`
+**request:** `Lark.CreateCustomerPortalSessionRequest`
 
 </dd>
 </dl>
@@ -90,7 +95,7 @@ await client.checkout.completeSubscriptionCheckout("checkout_id");
 <dl>
 <dd>
 
-**requestOptions:** `Checkout.RequestOptions`
+**requestOptions:** `CustomerPortal.RequestOptions`
 
 </dd>
 </dl>
@@ -118,7 +123,6 @@ await client.checkout.completeSubscriptionCheckout("checkout_id");
 ```typescript
 await client.rateCards.listRateCards({
     limit: 1,
-    offset: 1,
 });
 ```
 
@@ -135,7 +139,7 @@ await client.rateCards.listRateCards({
 <dl>
 <dd>
 
-**request:** `Lark.RateCardsListRateCardsRequest`
+**request:** `Lark.ListRateCardsRateCardsGetRequest`
 
 </dd>
 </dl>
@@ -154,7 +158,7 @@ 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>
+<details><summary><code>client.rateCards.<a href="/src/api/resources/rateCards/client/Client.ts">createRateCard</a>({ ...params }) -> Lark.RateCardResource</code></summary>
 <dl>
 <dd>
 
@@ -169,47 +173,6 @@ await client.rateCards.listRateCards({
 ```typescript
 await client.rateCards.createRateCard({
     name: "name",
-    description: "description",
-    usage_based_rates: [
-        {
-            usage_based_rate_type: "dimensional",
-            code: "code",
-            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",
 });
 ```
@@ -246,7 +209,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">getRateCard</a>(rateCardId) -> Lark.RateCardResource</code></summary>
 <dl>
 <dd>
 
@@ -294,206 +257,6 @@ 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>
-<dl>
-<dd>
-
-#### 🔌 Usage
-
-<dl>
-<dd>
-
-<dl>
-<dd>
-
-```typescript
-await client.rateCards.deleteRateCard("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>
-
-<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>
-
-<details><summary><code>client.rateCards.<a href="/src/api/resources/rateCards/client/Client.ts">createRateCardVersion</a>(rateCardId, { ...params }) -> Lark.CreateRateCardVersionResponse</code></summary>
-<dl>
-<dd>
-
-#### 🔌 Usage
-
-<dl>
-<dd>
-
-<dl>
-<dd>
-
-```typescript
-await client.rateCards.createRateCardVersion("rate_card_id", {
-    name: "name",
-    description: "description",
-    usage_based_rates: [
-        {
-            usage_based_rate_type: "dimensional",
-            id: "id",
-            code: "code",
-            name: "name",
-            description: "description",
-            included_units: 1,
-            pricing_metric: {
-                id: "id",
-                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",
-});
-```
-
-</dd>
-</dl>
-</dd>
-</dl>
-
-#### ⚙️ Parameters
-
-<dl>
-<dd>
-
-<dl>
-<dd>
-
-**rateCardId:** `string`
-
-</dd>
-</dl>
-
-<dl>
-<dd>
-
-**request:** `Lark.CreateRateCardVersionRequest`
-
-</dd>
-</dl>
-
-<dl>
-<dd>
-
-**requestOptions:** `RateCards.RequestOptions`
-
-</dd>
-</dl>
-</dd>
-</dl>
-
-</dd>
-</dl>
-</details>
-
 ## UsageEvents
 
 <details><summary><code>client.usageEvents.<a href="/src/api/resources/usageEvents/client/Client.ts">createUsageEvent</a>({ ...params }) -> unknown</code></summary>
@@ -513,7 +276,6 @@ await client.usageEvents.createUsageEvent({
     idempotency_key: "idempotency_key",
     event_name: "event_name",
     subject_id: "subject_id",
-    timestamp: "2024-01-15T09:30:00Z",
     data: {
         key: "value",
     },
@@ -625,7 +387,8 @@ await client.usageEvents.createUsageEventSummary({
 ```typescript
 await client.subscriptions.listSubscriptions({
     limit: 1,
-    offset: 1,
+    subject_id: "subject_id",
+    rate_card_id: "rate_card_id",
 });
 ```
 
@@ -642,7 +405,7 @@ await client.subscriptions.listSubscriptions({
 <dl>
 <dd>
 
-**request:** `Lark.SubscriptionsListSubscriptionsRequest`
+**request:** `Lark.ListSubscriptionsSubscriptionsGetRequest`
 
 </dd>
 </dl>
@@ -677,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",
 });
 ```
 
@@ -761,7 +523,9 @@ 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>
+## Subjects
+
+<details><summary><code>client.subjects.<a href="/src/api/resources/subjects/client/Client.ts">listSubjects</a>({ ...params }) -> Lark.ListSubjectsResponse</code></summary>
 <dl>
 <dd>
 
@@ -774,7 +538,10 @@ await client.subscriptions.getSubscription("subscription_id");
 <dd>
 
 ```typescript
-await client.subscriptions.cancelSubscription("subscription_id");
+await client.subjects.listSubjects({
+    limit: 1,
+    offset: 1,
+});
 ```
 
 </dd>
@@ -790,7 +557,7 @@ await client.subscriptions.cancelSubscription("subscription_id");
 <dl>
 <dd>
 
-**subscriptionId:** `string`
+**request:** `Lark.ListSubjectsSubjectsGetRequest`
 
 </dd>
 </dl>
@@ -798,7 +565,7 @@ await client.subscriptions.cancelSubscription("subscription_id");
 <dl>
 <dd>
 
-**requestOptions:** `Subscriptions.RequestOptions`
+**requestOptions:** `Subjects.RequestOptions`
 
 </dd>
 </dl>
@@ -809,7 +576,7 @@ await client.subscriptions.cancelSubscription("subscription_id");
 </dl>
 </details>
 
-<details><summary><code>client.subscriptions.<a href="/src/api/resources/subscriptions/client/Client.ts">updateSubscription</a>(subscriptionId) -> void</code></summary>
+<details><summary><code>client.subjects.<a href="/src/api/resources/subjects/client/Client.ts">createSubject</a>({ ...params }) -> Lark.CreateSubjectResponse</code></summary>
 <dl>
 <dd>
 
@@ -822,7 +589,7 @@ await client.subscriptions.cancelSubscription("subscription_id");
 <dd>
 
 ```typescript
-await client.subscriptions.updateSubscription("subscription_id");
+await client.subjects.createSubject();
 ```
 
 </dd>
@@ -838,7 +605,7 @@ await client.subscriptions.updateSubscription("subscription_id");
 <dl>
 <dd>
 
-**subscriptionId:** `string`
+**request:** `Lark.CreateSubjectRequest`
 
 </dd>
 </dl>
@@ -846,7 +613,7 @@ await client.subscriptions.updateSubscription("subscription_id");
 <dl>
 <dd>
 
-**requestOptions:** `Subscriptions.RequestOptions`
+**requestOptions:** `Subjects.RequestOptions`
 
 </dd>
 </dl>
@@ -857,9 +624,7 @@ await client.subscriptions.updateSubscription("subscription_id");
 </dl>
 </details>
 
-## FeatureAccess
-
-<details><summary><code>client.featureAccess.<a href="/src/api/resources/featureAccess/client/Client.ts">getFeatureAccess</a>() -> Lark.CheckFeatureAccessResponse</code></summary>
+<details><summary><code>client.subjects.<a href="/src/api/resources/subjects/client/Client.ts">getSubject</a>(subjectId) -> Lark.SubjectResource</code></summary>
 <dl>
 <dd>
 
@@ -872,7 +637,7 @@ await client.subscriptions.updateSubscription("subscription_id");
 <dd>
 
 ```typescript
-await client.featureAccess.getFeatureAccess();
+await client.subjects.getSubject("subject_id");
 ```
 
 </dd>
@@ -888,7 +653,15 @@ await client.featureAccess.getFeatureAccess();
 <dl>
 <dd>
 
-**requestOptions:** `FeatureAccess.RequestOptions`
+**subjectId:** `string`
+
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `Subjects.RequestOptions`
 
 </dd>
 </dl>
@@ -899,9 +672,7 @@ await client.featureAccess.getFeatureAccess();
 </dl>
 </details>
 
-## Subjects
-
-<details><summary><code>client.subjects.<a href="/src/api/resources/subjects/client/Client.ts">listSubjects</a>({ ...params }) -> Lark.ListSubjectsResponse</code></summary>
+<details><summary><code>client.subjects.<a href="/src/api/resources/subjects/client/Client.ts">updateSubject</a>(subjectId, { ...params }) -> Lark.SubjectResource</code></summary>
 <dl>
 <dd>
 
@@ -914,10 +685,7 @@ await client.featureAccess.getFeatureAccess();
 <dd>
 
 ```typescript
-await client.subjects.listSubjects({
-    limit: 1,
-    offset: 1,
-});
+await client.subjects.updateSubject("subject_id");
 ```
 
 </dd>
@@ -933,7 +701,15 @@ await client.subjects.listSubjects({
 <dl>
 <dd>
 
-**request:** `Lark.SubjectsListSubjectsRequest`
+**subjectId:** `string`
+
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**request:** `Lark.UpdateSubjectRequest`
 
 </dd>
 </dl>
@@ -952,7 +728,7 @@ await client.subjects.listSubjects({
 </dl>
 </details>
 
-<details><summary><code>client.subjects.<a href="/src/api/resources/subjects/client/Client.ts">createSubject</a>({ ...params }) -> Lark.CreateSubjectResponse</code></summary>
+<details><summary><code>client.subjects.<a href="/src/api/resources/subjects/client/Client.ts">deleteSubject</a>(subjectId) -> unknown</code></summary>
 <dl>
 <dd>
 
@@ -965,7 +741,7 @@ await client.subjects.listSubjects({
 <dd>
 
 ```typescript
-await client.subjects.createSubject();
+await client.subjects.deleteSubject("subject_id");
 ```
 
 </dd>
@@ -981,7 +757,7 @@ await client.subjects.createSubject();
 <dl>
 <dd>
 
-**request:** `Lark.CreateSubjectRequest`
+**subjectId:** `string`
 
 </dd>
 </dl>
@@ -1000,7 +776,9 @@ await client.subjects.createSubject();
 </dl>
 </details>
 
-<details><summary><code>client.subjects.<a href="/src/api/resources/subjects/client/Client.ts">getSubject</a>(subjectId) -> Lark.SubjectResource</code></summary>
+## PricingMetrics
+
+<details><summary><code>client.pricingMetrics.<a href="/src/api/resources/pricingMetrics/client/Client.ts">createPricingMetric</a>({ ...params }) -> Lark.CreatePricingMetricResponse</code></summary>
 <dl>
 <dd>
 
@@ -1013,7 +791,14 @@ await client.subjects.createSubject();
 <dd>
 
 ```typescript
-await client.subjects.getSubject("subject_id");
+await client.pricingMetrics.createPricingMetric({
+    name: "name",
+    event_name: "event_name",
+    aggregation: {
+        aggregation_type: "count",
+    },
+    unit: "unit",
+});
 ```
 
 </dd>
@@ -1029,7 +814,7 @@ await client.subjects.getSubject("subject_id");
 <dl>
 <dd>
 
-**subjectId:** `string`
+**request:** `Lark.CreatePricingMetricRequest`
 
 </dd>
 </dl>
@@ -1037,7 +822,7 @@ await client.subjects.getSubject("subject_id");
 <dl>
 <dd>
 
-**requestOptions:** `Subjects.RequestOptions`
+**requestOptions:** `PricingMetrics.RequestOptions`
 
 </dd>
 </dl>
@@ -1048,7 +833,7 @@ await client.subjects.getSubject("subject_id");
 </dl>
 </details>
 
-<details><summary><code>client.subjects.<a href="/src/api/resources/subjects/client/Client.ts">updateSubject</a>(subjectId, { ...params }) -> Lark.SubjectResource</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>
 
@@ -1061,7 +846,7 @@ await client.subjects.getSubject("subject_id");
 <dd>
 
 ```typescript
-await client.subjects.updateSubject("subject_id");
+await client.pricingMetrics.getPricingMetric("pricing_metric_id");
 ```
 
 </dd>
@@ -1077,15 +862,7 @@ await client.subjects.updateSubject("subject_id");
 <dl>
 <dd>
 
-**subjectId:** `string`
-
-</dd>
-</dl>
-
-<dl>
-<dd>
-
-**request:** `Lark.UpdateSubjectRequest`
+**pricingMetricId:** `string`
 
 </dd>
 </dl>
@@ -1093,7 +870,7 @@ await client.subjects.updateSubject("subject_id");
 <dl>
 <dd>
 
-**requestOptions:** `Subjects.RequestOptions`
+**requestOptions:** `PricingMetrics.RequestOptions`
 
 </dd>
 </dl>
@@ -1104,7 +881,9 @@ await client.subjects.updateSubject("subject_id");
 </dl>
 </details>
 
-<details><summary><code>client.subjects.<a href="/src/api/resources/subjects/client/Client.ts">deleteSubject</a>(subjectId) -> unknown</code></summary>
+## CustomerAccess
+
+<details><summary><code>client.customerAccess.<a href="/src/api/resources/customerAccess/client/Client.ts">getBillingState</a>(subjectId) -> Lark.BillingStateResponse</code></summary>
 <dl>
 <dd>
 
@@ -1117,7 +896,7 @@ await client.subjects.updateSubject("subject_id");
 <dd>
 
 ```typescript
-await client.subjects.deleteSubject("subject_id");
+await client.customerAccess.getBillingState("subject_id");
 ```
 
 </dd>
@@ -1141,7 +920,7 @@ await client.subjects.deleteSubject("subject_id");
 <dl>
 <dd>
 
-**requestOptions:** `Subjects.RequestOptions`
+**requestOptions:** `CustomerAccess.RequestOptions`
 
 </dd>
 </dl>