lark-billing 0.0.7 → 0.0.9

package/dist/cjs/api/resources/rateCards/types/index.js

@@ -0,0 +1,17 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./CreateRateCardRequestUsageBasedRatesItem.js"), exports);

package/dist/cjs/api/resources/subjects/client/requests/CreateSubjectRequest.d.ts

@@ -6,8 +6,12 @@
  *     {}
  */
 export interface CreateSubjectRequest {
+    /** The ID of the subject in your system. If provided, you may use pass it to the API in place of the subject ID. Must be unique. */
     external_id?: string;
+    /** The name of the subject. Used for display in the dashboard. */
     name?: string;
+    /** The email of the subject. Must be a valid email address. */
     email?: string;
+    /** Additional metadata about the subject. You may use this to store any custom data about the subject. */
     metadata?: Record<string, string>;
 }

package/dist/cjs/api/resources/subjects/client/requests/UpdateSubjectRequest.d.ts

@@ -6,8 +6,10 @@
  *     {}
  */
 export interface UpdateSubjectRequest {
-    external_id?: string;
+    /** The name of the subject. Used for display in the dashboard. */
     name?: string;
+    /** The email of the subject. Must be a valid email address. */
     email?: string;
+    /** Additional metadata about the subject. You may use this to store any custom data about the subject. */
     metadata?: Record<string, string | undefined>;
 }

package/dist/cjs/api/resources/subscriptions/client/Client.d.ts

@@ -52,8 +52,8 @@ export declare class Subscriptions {
      *
      * @example
      *     await client.subscriptions.createSubscription({
-     *         rate_card_id: "rate_card_id",
-     *         subject_id: "subject_id"
+     *         rate_card_id: "rc_AJWMxR81jxoRlli6p13uf3JB",
+     *         subject_id: "subj_VyX6Q96h5avMho8O7QWlKeXE"
      *     })
      */
     createSubscription(request: Lark.CreateSubscriptionRequest, requestOptions?: Subscriptions.RequestOptions): core.HttpResponsePromise<Lark.SubscriptionResource>;
@@ -69,6 +69,32 @@ export declare class Subscriptions {
      */
     getSubscription(subscriptionId: string, requestOptions?: Subscriptions.RequestOptions): core.HttpResponsePromise<Lark.SubscriptionResource>;
     private __getSubscription;
+    /**
+     * @param {string} subscriptionId
+     * @param {Lark.CancelSubscriptionRequest} request
+     * @param {Subscriptions.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Lark.UnprocessableEntityError}
+     *
+     * @example
+     *     await client.subscriptions.cancelSubscription("subscription_id")
+     */
+    cancelSubscription(subscriptionId: string, request?: Lark.CancelSubscriptionRequest, requestOptions?: Subscriptions.RequestOptions): core.HttpResponsePromise<Lark.SubscriptionResource>;
+    private __cancelSubscription;
+    /**
+     * @param {string} subscriptionId
+     * @param {Lark.ChangeSubscriptionRateCardRequest} request
+     * @param {Subscriptions.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Lark.UnprocessableEntityError}
+     *
+     * @example
+     *     await client.subscriptions.changeSubscriptionRateCard("subscription_id", {
+     *         rate_card_id: "rc_jQK2n0wutCj6bBcAIrL6o07g"
+     *     })
+     */
+    changeSubscriptionRateCard(subscriptionId: string, request: Lark.ChangeSubscriptionRateCardRequest, requestOptions?: Subscriptions.RequestOptions): core.HttpResponsePromise<Lark.SubscriptionResource>;
+    private __changeSubscriptionRateCard;
     protected _getCustomAuthorizationHeaders(): Promise<{
         "X-API-Key": string;
     }>;

package/dist/cjs/api/resources/subscriptions/client/Client.js

@@ -135,8 +135,8 @@ class Subscriptions {
      *
      * @example
      *     await client.subscriptions.createSubscription({
-     *         rate_card_id: "rate_card_id",
-     *         subject_id: "subject_id"
+     *         rate_card_id: "rc_AJWMxR81jxoRlli6p13uf3JB",
+     *         subject_id: "subj_VyX6Q96h5avMho8O7QWlKeXE"
      *     })
      */
     createSubscription(request, requestOptions) {
@@ -247,6 +247,130 @@ class Subscriptions {
             }
         });
     }
+    /**
+     * @param {string} subscriptionId
+     * @param {Lark.CancelSubscriptionRequest} request
+     * @param {Subscriptions.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Lark.UnprocessableEntityError}
+     *
+     * @example
+     *     await client.subscriptions.cancelSubscription("subscription_id")
+     */
+    cancelSubscription(subscriptionId, request = {}, requestOptions) {
+        return core.HttpResponsePromise.fromPromise(this.__cancelSubscription(subscriptionId, request, requestOptions));
+    }
+    __cancelSubscription(subscriptionId_1) {
+        return __awaiter(this, arguments, void 0, function* (subscriptionId, request = {}, requestOptions) {
+            var _a, _b, _c;
+            let _headers = (0, headers_js_1.mergeHeaders)((_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, (0, headers_js_1.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, `subscriptions/${encodeURIComponent(subscriptionId)}/cancel`),
+                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 /subscriptions/{subscription_id}/cancel.");
+                case "unknown":
+                    throw new errors.LarkError({
+                        message: _response.error.errorMessage,
+                        rawResponse: _response.rawResponse,
+                    });
+            }
+        });
+    }
+    /**
+     * @param {string} subscriptionId
+     * @param {Lark.ChangeSubscriptionRateCardRequest} request
+     * @param {Subscriptions.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Lark.UnprocessableEntityError}
+     *
+     * @example
+     *     await client.subscriptions.changeSubscriptionRateCard("subscription_id", {
+     *         rate_card_id: "rc_jQK2n0wutCj6bBcAIrL6o07g"
+     *     })
+     */
+    changeSubscriptionRateCard(subscriptionId, request, requestOptions) {
+        return core.HttpResponsePromise.fromPromise(this.__changeSubscriptionRateCard(subscriptionId, request, requestOptions));
+    }
+    __changeSubscriptionRateCard(subscriptionId, request, requestOptions) {
+        return __awaiter(this, void 0, void 0, function* () {
+            var _a, _b, _c;
+            let _headers = (0, headers_js_1.mergeHeaders)((_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, (0, headers_js_1.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, `subscriptions/${encodeURIComponent(subscriptionId)}/change-rate-card`),
+                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 /subscriptions/{subscription_id}/change-rate-card.");
+                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/cjs/api/resources/subscriptions/client/requests/CancelSubscriptionRequest.d.ts

@@ -0,0 +1,13 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * @example
+ *     {}
+ */
+export interface CancelSubscriptionRequest {
+    /** The reason for cancelling the subscription. */
+    reason?: string;
+    /** Whether to cancel the subscription at end of cycle. */
+    cancel_at_end_of_cycle?: boolean;
+}

package/dist/cjs/api/resources/subscriptions/client/requests/ChangeSubscriptionRateCardRequest.d.ts

@@ -0,0 +1,13 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * @example
+ *     {
+ *         rate_card_id: "rc_jQK2n0wutCj6bBcAIrL6o07g"
+ *     }
+ */
+export interface ChangeSubscriptionRateCardRequest {
+    /** The ID of the rate card to change the subscription to. */
+    rate_card_id: string;
+}

package/dist/cjs/api/resources/subscriptions/client/requests/CreateSubscriptionRequest.d.ts

@@ -4,12 +4,15 @@
 /**
  * @example
  *     {
- *         rate_card_id: "rate_card_id",
- *         subject_id: "subject_id"
+ *         rate_card_id: "rc_AJWMxR81jxoRlli6p13uf3JB",
+ *         subject_id: "subj_VyX6Q96h5avMho8O7QWlKeXE"
  *     }
  */
 export interface CreateSubscriptionRequest {
+    /** The ID of the rate card to use for the subscription. */
     rate_card_id: string;
+    /** The ID of the subject to create the subscription for. */
     subject_id: string;
-    metadata?: Record<string, string | undefined>;
+    /** Additional metadata about the subscription. You may use this to store any custom data about the subscription. */
+    metadata?: Record<string, string>;
 }

package/dist/cjs/api/resources/subscriptions/client/requests/index.d.ts

@@ -1,2 +1,4 @@
 export { type ListSubscriptionsSubscriptionsGetRequest } from "./ListSubscriptionsSubscriptionsGetRequest.js";
 export { type CreateSubscriptionRequest } from "./CreateSubscriptionRequest.js";
+export { type CancelSubscriptionRequest } from "./CancelSubscriptionRequest.js";
+export { type ChangeSubscriptionRateCardRequest } from "./ChangeSubscriptionRateCardRequest.js";

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

@@ -13,9 +13,19 @@
  *     }
  */
 export interface CreateUsageEventRequest {
+    /** The idempotency key for the usage event. This ensures that the same event is not processed multiple times. */
     idempotency_key: string;
+    /** The name of the event. This is used by pricing metrics to aggregate usage events. */
     event_name: string;
+    /** The ID of the subject that the usage event is for. */
     subject_id: string;
+    /** The timestamp of the usage event. It is highly recommended to provide a timestamp. If not provided, the current timestamp will be used. */
     timestamp?: string;
-    data: Record<string, unknown>;
+    /** The data of the usage event. This should contain any data that is needed to aggregate the usage event. */
+    data: Record<string, CreateUsageEventRequest.Data.Value>;
+}
+export declare namespace CreateUsageEventRequest {
+    namespace Data {
+        type Value = string | number | number | boolean;
+    }
 }

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

@@ -2,20 +2,11 @@
  * This file was auto-generated by Fern from our API Definition.
  */
 import * as Lark from "../index.js";
-export type Aggregation = Lark.Aggregation.Count | Lark.Aggregation.Custom | Lark.Aggregation.Last | Lark.Aggregation.Max | Lark.Aggregation.Sum;
+export type Aggregation = Lark.Aggregation.Count | Lark.Aggregation.Sum;
 export declare namespace Aggregation {
     interface Count extends Lark.CountAggregationPricingMetricResource {
         aggregation_type: "count";
     }
-    interface Custom extends Lark.CustomPricingMetricResource {
-        aggregation_type: "custom";
-    }
-    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/cjs/api/types/Amount.d.ts

@@ -4,5 +4,6 @@
 export interface Amount {
     /** The value of the amount in the smallest unit of the currency. */
     value: string;
+    /** The currency code of the amount. */
     currency_code: string;
 }

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

@@ -2,6 +2,8 @@
  * This file was auto-generated by Fern from our API Definition.
  */
 export interface CreateCustomerPortalSessionResponse {
+    /** The ID of the subject for the customer portal session. */
     subject_id: string;
+    /** The URL to redirect to the customer portal session. */
     url: string;
 }

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

@@ -0,0 +1,11 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Lark from "../index.js";
+export interface CreateFixedRateRequest {
+    /** The name of the rate displayed to the customer. */
+    name: string;
+    /** The description of the rate displayed to the customer. */
+    description?: string;
+    price: Lark.Price;
+}

package/dist/cjs/api/types/CreateFixedRateRequest.js

@@ -0,0 +1,5 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

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

@@ -0,0 +1,15 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Lark from "../index.js";
+export interface CreateSimpleUsageBasedRateRequest {
+    /** The name of the rate displayed to the customer. */
+    name: string;
+    /** The description of the rate displayed to the customer. */
+    description?: string;
+    price: Lark.Price;
+    /** The number of units included in the rate before the price is applied. */
+    included_units?: number;
+    /** The ID of the pricing metric to use for this rate. */
+    pricing_metric_id: string;
+}

package/dist/cjs/api/types/CreateSimpleUsageBasedRateRequest.js

@@ -0,0 +1,5 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

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

@@ -2,10 +2,16 @@
  * This file was auto-generated by Fern from our API Definition.
  */
 export interface CreateSubjectResponse {
+    /** The ID of the subject. */
     id: string;
+    /** The ID of the subject in your system. You may pass it to the API in place of the subject ID. */
     external_id?: string;
+    /** The name of the subject. Used for display in the dashboard. */
     name?: string;
+    /** The email of the subject. */
     email?: string;
+    /** Additional metadata about the subject. You may use this to store any custom data about the subject. */
     metadata: Record<string, string>;
+    /** The date and time the subject was created. */
     created_at: string;
 }

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

@@ -3,7 +3,10 @@
  */
 import * as Lark from "../index.js";
 export interface CreateSubscriptionCheckoutSessionResponse {
+    /** The ID of the checkout session. */
     id: string;
+    /** The amount of the checkout session. */
     amount: Lark.Amount;
+    /** The URL to redirect to the checkout session. */
     url: string;
 }

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

@@ -5,6 +5,6 @@ import * as Lark from "../index.js";
 export interface FixedRateInterface {
     id: string;
     name: string;
-    description: string;
+    description?: string;
     price: Lark.Price;
 }

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

@@ -0,0 +1,10 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Lark from "../index.js";
+export interface InvoiceLineItemResource {
+    amount: Lark.Amount;
+    description: string;
+    quantity: number;
+    price_in_unit_amount: Lark.Amount;
+}

package/dist/cjs/api/types/InvoiceLineItemResource.js

@@ -0,0 +1,5 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

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

@@ -0,0 +1,33 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Lark from "../index.js";
+export interface InvoiceResource {
+    /** The ID of the invoice. */
+    id: string;
+    /** The total amount of the invoice. */
+    total_amount: Lark.Amount;
+    /** The ID of the subject for the invoice. */
+    subject_id: string;
+    /** The date and time the invoice was created. */
+    created_at: string;
+    /** The status of the invoice. */
+    status: InvoiceResource.Status;
+    /** The URL of the hosted invoice. */
+    hosted_url?: string;
+    /** The line items of the invoice. */
+    line_items: Lark.InvoiceLineItemResource[];
+}
+export declare namespace InvoiceResource {
+    /**
+     * The status of the invoice.
+     */
+    type Status = "draft" | "open" | "paid" | "uncollectible" | "void";
+    const Status: {
+        readonly Draft: "draft";
+        readonly Open: "open";
+        readonly Paid: "paid";
+        readonly Uncollectible: "uncollectible";
+        readonly Void: "void";
+    };
+}

package/dist/cjs/api/types/InvoiceResource.js

@@ -0,0 +1,16 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.InvoiceResource = void 0;
+var InvoiceResource;
+(function (InvoiceResource) {
+    InvoiceResource.Status = {
+        Draft: "draft",
+        Open: "open",
+        Paid: "paid",
+        Uncollectible: "uncollectible",
+        Void: "void",
+    };
+})(InvoiceResource || (exports.InvoiceResource = InvoiceResource = {}));

package/dist/cjs/api/types/{CreateFixedRateInterface.d.ts → ListInvoicesResponse.d.ts}

@@ -2,8 +2,7 @@
  * This file was auto-generated by Fern from our API Definition.
  */
 import * as Lark from "../index.js";
-export interface CreateFixedRateInterface {
-    name?: string;
-    description?: string;
-    price: Lark.Price;
+export interface ListInvoicesResponse {
+    invoices: Lark.InvoiceResource[];
+    has_more: boolean;
 }

package/dist/cjs/api/types/ListInvoicesResponse.js

@@ -0,0 +1,5 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

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

@@ -0,0 +1,8 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Lark from "../index.js";
+export interface ListPricingMetricsResponse {
+    pricing_metrics: Lark.PricingMetricResource[];
+    has_more: boolean;
+}

package/dist/cjs/api/types/ListPricingMetricsResponse.js

@@ -0,0 +1,5 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

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

@@ -0,0 +1,9 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export interface PeriodResource {
+    inclusive_start?: boolean;
+    inclusive_end?: boolean;
+    start: string;
+    end: string;
+}

package/dist/cjs/api/types/PeriodResource.js

@@ -0,0 +1,5 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

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

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

package/dist/cjs/api/types/PricingMetricResource.js

@@ -0,0 +1,5 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

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

@@ -3,13 +3,20 @@
  */
 import * as Lark from "../index.js";
 export interface RateCardResource {
+    /** The ID of the rate card. */
     id: string;
+    /** The name of the rate card. */
     name: string;
-    description: string;
+    /** The description of the rate card. */
+    description?: string;
+    /** The usage based rates of the rate card. */
     usage_based_rates: Lark.RateCardResourceUsageBasedRatesItem[];
+    /** The fixed rates of the rate card. */
     fixed_rates: Lark.FixedRateInterface[];
     billing_interval: RateCardResource.BillingInterval;
+    /** The date and time the rate card was created. */
     created_at: string;
+    /** The date and time the rate card was last updated. */
     updated_at: string;
     metadata: Record<string, string>;
 }

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

@@ -4,10 +4,8 @@
 import * as Lark from "../index.js";
 export interface SimpleUsageBasedRateInterface {
     id: string;
-    /** Code of this rate to be used for overrides and external reference. */
-    code: string;
     name: string;
-    description: string;
+    description?: string;
     price: Lark.Price;
     included_units: number;
     pricing_metric_id: string;

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

@@ -2,10 +2,16 @@
  * This file was auto-generated by Fern from our API Definition.
  */
 export interface SubjectResource {
+    /** The ID of the subject. */
     id: string;
+    /** The ID of the subject in your system. You may pass it to the API in place of the subject ID. */
     external_id?: string;
+    /** The name of the subject. Used for display in the dashboard. */
     name?: string;
+    /** The email of the subject. */
     email?: string;
+    /** Additional metadata about the subject. You may use this to store any custom data about the subject. */
     metadata: Record<string, string>;
+    /** The date and time the subject was created. */
     created_at: string;
 }