lark-billing 0.0.6 → 0.0.8

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

@@ -10,6 +10,7 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
         step((generator = generator.apply(thisArg, _arguments || [])).next());
     });
 };
+import * as environments from "../../../../environments.mjs";
 import * as core from "../../../../core/index.mjs";
 import * as Lark from "../../../index.mjs";
 import { mergeHeaders, mergeOnlyDefinedHeaders } from "../../../../core/headers.mjs";
@@ -29,7 +30,6 @@ export class UsageEvents {
      *         idempotency_key: "idempotency_key",
      *         event_name: "event_name",
      *         subject_id: "subject_id",
-     *         timestamp: "2024-01-15T09:30:00Z",
      *         data: {
      *             "key": "value"
      *         }
@@ -40,10 +40,10 @@ export class UsageEvents {
     }
     __createUsageEvent(request, requestOptions) {
         return __awaiter(this, void 0, void 0, function* () {
-            var _a, _b;
+            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((_b = (yield core.Supplier.get(this._options.baseUrl))) !== null && _b !== void 0 ? _b : (yield core.Supplier.get(this._options.environment)), "usage-events"),
+                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"),
                 method: "POST",
                 headers: _headers,
                 contentType: "application/json",
@@ -108,10 +108,10 @@ export class UsageEvents {
     }
     __createUsageEventSummary(request, requestOptions) {
         return __awaiter(this, void 0, void 0, function* () {
-            var _a, _b;
+            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((_b = (yield core.Supplier.get(this._options.baseUrl))) !== null && _b !== void 0 ? _b : (yield core.Supplier.get(this._options.environment)), "usage-events/summary"),
+                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",

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

@@ -7,7 +7,6 @@
  *         idempotency_key: "idempotency_key",
  *         event_name: "event_name",
  *         subject_id: "subject_id",
- *         timestamp: "2024-01-15T09:30:00Z",
  *         data: {
  *             "key": "value"
  *         }
@@ -17,6 +16,6 @@ export interface CreateUsageEventRequest {
     idempotency_key: string;
     event_name: string;
     subject_id: string;
-    timestamp: string;
+    timestamp?: string;
     data: Record<string, unknown>;
 }

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

@@ -2,21 +2,12 @@
  * 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.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.CountAggregationPricingMetricInterface {
+    interface Count extends Lark.CountAggregationPricingMetricResource {
         aggregation_type: "count";
     }
-    interface Custom extends Lark.CustomAggregationPricingMetricInterface {
-        aggregation_type: "custom";
-    }
-    interface Last extends Lark.LastAggregationPricingMetricInterface {
-        aggregation_type: "last";
-    }
-    interface Max extends Lark.MaxAggregationPricingMetricInterface {
-        aggregation_type: "max";
-    }
-    interface Sum extends Lark.SumAggregationPricingMetricInterface {
+    interface Sum extends Lark.SumAggregationPricingMetricResource {
         aggregation_type: "sum";
     }
 }

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

@@ -2,6 +2,7 @@
  * This file was auto-generated by Fern from our API Definition.
  */
 export interface Amount {
-    value: number;
+    /** The value of the amount in the smallest unit of the currency. */
+    value: string;
     currency_code: string;
 }

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

@@ -0,0 +1,7 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export interface BillingStateResponse {
+    has_active_subscription: boolean;
+    has_overage_for_usage: boolean;
+}

package/dist/esm/api/types/{CreditGrantScheduleOneTimeResource.d.mts → CountAggregationPricingMetricResource.d.mts}

@@ -1,5 +1,5 @@
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
-export interface CreditGrantScheduleOneTimeResource {
+export interface CountAggregationPricingMetricResource {
 }

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

@@ -0,0 +1,7 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export interface CreateCustomerPortalSessionResponse {
+    subject_id: string;
+    url: string;
+}

package/dist/esm/api/types/{PricingMatrixInterface.d.mts → CreateFixedRateRequest.d.mts}

@@ -2,6 +2,8 @@
  * This file was auto-generated by Fern from our API Definition.
  */
 import * as Lark from "../index.mjs";
-export interface PricingMatrixInterface {
-    cells: Lark.PricingMatrixCellInterface[];
+export interface CreateFixedRateRequest {
+    name?: string;
+    description?: string;
+    price: Lark.Price;
 }

package/dist/esm/api/types/{PricingMetricInterface.d.mts → CreatePricingMetricResponse.d.mts}

@@ -2,11 +2,10 @@
  * This file was auto-generated by Fern from our API Definition.
  */
 import * as Lark from "../index.mjs";
-export interface PricingMetricInterface {
+export interface CreatePricingMetricResponse {
     id: string;
     name: string;
     event_name: string;
     aggregation: Lark.Aggregation;
-    /** Unit of the value computed by the pricing metric. */
     unit: string;
 }

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

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

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

@@ -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;
-    parent_subject_id?: 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/esm/api/types/CreateSubscriptionCheckoutSessionResponse.d.mts

@@ -5,6 +5,5 @@ import * as Lark from "../index.mjs";
 export interface CreateSubscriptionCheckoutSessionResponse {
     id: string;
     amount: Lark.Amount;
-    payment_intent_client_secret?: string;
-    setup_intent_client_secret?: string;
+    url: string;
 }

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

@@ -5,6 +5,6 @@ import * as Lark from "../index.mjs";
 export interface CreateUsageEventSummaryResponse {
     event_name: string;
     subject_id: string;
-    value?: number;
+    value?: string;
     period: Lark.Period;
 }

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

@@ -6,8 +6,5 @@ export interface FixedRateInterface {
     id: string;
     name: string;
     description: string;
-    price?: Lark.Price;
-    credit_grants: Lark.CreditGrantInterface[];
-    /** Code of this rate to be used for setting quantity. */
-    quantity_code?: string;
+    price: Lark.Price;
 }

package/dist/esm/api/types/{CreatePricingMetricInterface.d.mts → GetPricingMetricResponse.d.mts}

@@ -2,10 +2,10 @@
  * This file was auto-generated by Fern from our API Definition.
  */
 import * as Lark from "../index.mjs";
-export interface CreatePricingMetricInterface {
+export interface GetPricingMetricResponse {
+    id: string;
     name: string;
     event_name: string;
     aggregation: Lark.Aggregation;
-    /** Unit of the value computed by the pricing metric. */
     unit: string;
 }

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

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

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

@@ -0,0 +1,25 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Lark from "../index.mjs";
+export interface InvoiceResource {
+    id: string;
+    merchant_id: string;
+    bill_id?: string;
+    total_amount: Lark.Amount;
+    subject_id: string;
+    created_at: string;
+    status: InvoiceResource.Status;
+    hosted_url?: string;
+    line_items: Lark.InvoiceLineItemResource[];
+}
+export declare namespace InvoiceResource {
+    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/esm/api/types/InvoiceResource.mjs

@@ -0,0 +1,13 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export var InvoiceResource;
+(function (InvoiceResource) {
+    InvoiceResource.Status = {
+        Draft: "draft",
+        Open: "open",
+        Paid: "paid",
+        Uncollectible: "uncollectible",
+        Void: "void",
+    };
+})(InvoiceResource || (InvoiceResource = {}));

package/dist/esm/api/types/{CompleteSubscriptionCheckoutResponse.d.mts → ListInvoicesResponse.d.mts}

@@ -2,7 +2,7 @@
  * This file was auto-generated by Fern from our API Definition.
  */
 import * as Lark from "../index.mjs";
-export interface CompleteSubscriptionCheckoutResponse {
-    id: string;
-    amount: Lark.Amount;
+export interface ListInvoicesResponse {
+    invoices: Lark.InvoiceResource[];
+    has_more: boolean;
 }

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

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

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

@@ -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/esm/api/types/Price.d.mts

@@ -1,4 +1,13 @@
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
-export type Price = unknown;
+import * as Lark from "../index.mjs";
+export type Price = Lark.Price.Flat | Lark.Price.Package;
+export declare namespace Price {
+    interface Flat extends Lark.FlatPrice {
+        price_type: "flat";
+    }
+    interface Package extends Lark.PackagePrice {
+        price_type: "package";
+    }
+}

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

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

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

@@ -9,12 +9,8 @@ export interface RateCardResource {
     usage_based_rates: Lark.RateCardResourceUsageBasedRatesItem[];
     fixed_rates: Lark.FixedRateInterface[];
     billing_interval: RateCardResource.BillingInterval;
-    credit_grants: Lark.CreditGrantResource[];
     created_at: string;
     updated_at: string;
-    major_version: number;
-    minor_version: number;
-    feature_access: Lark.FeatureAccessResource[];
     metadata: Record<string, string>;
 }
 export declare namespace RateCardResource {

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

@@ -2,11 +2,8 @@
  * This file was auto-generated by Fern from our API Definition.
  */
 import * as Lark from "../index.mjs";
-export type RateCardResourceUsageBasedRatesItem = Lark.RateCardResourceUsageBasedRatesItem.Dimensional | Lark.RateCardResourceUsageBasedRatesItem.Simple;
+export type RateCardResourceUsageBasedRatesItem = Lark.RateCardResourceUsageBasedRatesItem.Simple;
 export declare namespace RateCardResourceUsageBasedRatesItem {
-    interface Dimensional extends Lark.DimensionalUsageBasedRateInterface {
-        usage_based_rate_type: "dimensional";
-    }
     interface Simple extends Lark.SimpleUsageBasedRateInterface {
         usage_based_rate_type: "simple";
     }

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

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

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

@@ -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;
-    parent_subject_id?: 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/esm/api/types/SubscriptionResource.d.mts

@@ -1,15 +1,17 @@
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
+import * as Lark from "../index.mjs";
 export interface SubscriptionResource {
     id: string;
     subject_id: string;
     rate_card_id: string;
     effective_at: string;
     cycles_next_at?: string;
-    variables?: Record<string, string | undefined>;
-    metadata?: Record<string, string | undefined>;
+    current_period?: Lark.PeriodResource;
+    metadata: Record<string, string>;
     status: SubscriptionResource.Status;
+    cancels_at_end_of_cycle: boolean;
 }
 export declare namespace SubscriptionResource {
     type Status = "active" | "cancelled" | "paused";

package/dist/esm/api/types/{MaxAggregationPricingMetricInterface.d.mts → SumAggregationPricingMetricResource.d.mts}

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

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

@@ -1,110 +1,36 @@
 export * from "./Amount.mjs";
-export * from "./CheckFeatureAccessRequest.mjs";
-export * from "./CheckFeatureAccessResponse.mjs";
-export * from "./CompleteSubscriptionCheckoutResponse.mjs";
+export * from "./BillingStateResponse.mjs";
 export * from "./CountAggregationPricingMetricInterface.mjs";
-export * from "./CreateCreditGrantInterfaceExpiration.mjs";
-export * from "./CreateCreditGrantInterface.mjs";
-export * from "./CreateDimensionCoordinateInterface.mjs";
-export * from "./CreateDimensionInterface.mjs";
-export * from "./CreateDimensionalUsageBasedRateInterface.mjs";
+export * from "./CountAggregationPricingMetricResource.mjs";
+export * from "./CreateCustomerPortalSessionResponse.mjs";
 export * from "./Price.mjs";
-export * from "./CreateFixedRateInterface.mjs";
-export * from "./CreatePricingMatrixCellInterface.mjs";
-export * from "./CreatePricingMatrixInterface.mjs";
+export * from "./CreateFixedRateRequest.mjs";
 export * from "./Aggregation.mjs";
-export * from "./CreatePricingMetricInterface.mjs";
-export * from "./CreateRateCardResponseUsageBasedRatesItem.mjs";
-export * from "./CreateRateCardResponse.mjs";
-export * from "./CreateRateCardVersionResponseUsageBasedRatesItem.mjs";
-export * from "./CreateRateCardVersionResponse.mjs";
-export * from "./CreateSimpleUsageBasedRateInterface.mjs";
+export * from "./CreatePricingMetricResponse.mjs";
+export * from "./CreateSimpleUsageBasedRateRequest.mjs";
 export * from "./CreateSubjectResponse.mjs";
 export * from "./CreateSubscriptionCheckoutSessionResponse.mjs";
 export * from "./CreateUsageEventSummaryResponse.mjs";
-export * from "./CreditGrantDateTimeExpirationInterface.mjs";
-export * from "./CreditGrantDateTimeExpirationResource.mjs";
-export * from "./CreditGrantDurationExpirationInterface.mjs";
-export * from "./CreditGrantDurationExpirationResource.mjs";
-export * from "./CreditGrantInterfaceInputExpiration.mjs";
-export * from "./CreditGrantInterface.mjs";
-export * from "./CreditGrantInterfaceOutputSchedule.mjs";
-export * from "./CreditGrantInterfaceOutputExpiration.mjs";
-export * from "./CreditGrantResourceInputSchedule.mjs";
-export * from "./CreditGrantResourceInputExpiration.mjs";
-export * from "./CreditGrantResource.mjs";
-export * from "./CreditGrantResourceOutputSchedule.mjs";
-export * from "./CreditGrantResourceOutputExpiration.mjs";
-export * from "./CreditGrantScheduleOneTimeInterface.mjs";
-export * from "./CreditGrantScheduleOneTimeResource.mjs";
-export * from "./CreditGrantScheduleRateCycleStartInterface.mjs";
-export * from "./CreditGrantScheduleRateCycleStartResource.mjs";
-export * from "./CreditGrantSubjectGrantingConfigInterface.mjs";
-export * from "./CustomAggregationPricingMetricInterface.mjs";
-export * from "./DimensionCoordinateInterface.mjs";
-export * from "./DimensionInterface.mjs";
-export * from "./DimensionalUsageBasedRateInterface.mjs";
-export * from "./FeatureAccessResource.mjs";
 export * from "./FixedRateInterface.mjs";
 export * from "./FlatPrice.mjs";
-export * from "./GetRateCardResponseUsageBasedRatesItem.mjs";
-export * from "./GetRateCardResponse.mjs";
+export * from "./GetPricingMetricResponse.mjs";
 export * from "./HttpValidationError.mjs";
-export * from "./LastAggregationPricingMetricInterface.mjs";
+export * from "./InvoiceLineItemResource.mjs";
+export * from "./InvoiceResource.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 "./PackagePrice.mjs";
 export * from "./Period.mjs";
-export * from "./PricingMatrixCellInterface.mjs";
-export * from "./PricingMatrixInterface.mjs";
-export * from "./PricingMetricInterface.mjs";
+export * from "./PeriodResource.mjs";
+export * from "./PricingMetricResource.mjs";
 export * from "./RateCardResourceUsageBasedRatesItem.mjs";
 export * from "./RateCardResource.mjs";
 export * from "./SimpleUsageBasedRateInterface.mjs";
-export * from "./SubjectGrantingConfigResource.mjs";
 export * from "./SubjectResource.mjs";
 export * from "./SubscriptionResource.mjs";
 export * from "./SumAggregationPricingMetricInterface.mjs";
+export * from "./SumAggregationPricingMetricResource.mjs";
 export * from "./ValidationError.mjs";
-export * from "./Subject.mjs";
-export * from "./UsageUnit.mjs";
-export * from "./CustomUnit.mjs";
-export * from "./MonetaryAmount.mjs";
-export * from "./CustomUnitAmount.mjs";
-export * from "./PricingTier.mjs";
-export * from "./TieredPrice.mjs";
-export * from "./TieredPriceWrapper.mjs";
-export * from "./PackagePriceWrapper.mjs";
-export * from "./CustomPricingMetric.mjs";
-export * from "./PricingMetric.mjs";
-export * from "./DimensionCoordinate.mjs";
-export * from "./DimensionCoordinateSet.mjs";
-export * from "./Dimension.mjs";
-export * from "./DimensionalRateMatrixCell.mjs";
-export * from "./DimensionalRateMatrix.mjs";
-export * from "./SimpleUsageBasedRate.mjs";
-export * from "./DimensionalUsageBasedRate.mjs";
-export * from "./UsageBasedRate.mjs";
-export * from "./LicenseBasedRate.mjs";
-export * from "./RateCardVersion.mjs";
-export * from "./RateCard.mjs";
-export * from "./CreditPoolRolloverConfig.mjs";
-export * from "./CreditPool.mjs";
-export * from "./SubjectGrantingConfig.mjs";
-export * from "./CreditGrantSchedule.mjs";
-export * from "./CreditGrant.mjs";
-export * from "./PricingPlan.mjs";
-export * from "./PricingPlanSubscription.mjs";
-export * from "./SimpleUsageBasedRateInput.mjs";
-export * from "./DimensionalUsageBasedRateInput.mjs";
-export * from "./UsageBasedRateInput.mjs";
-export * from "./LicenseBasedRateInput.mjs";
-export * from "./RateCardVersionInput.mjs";
-export * from "./CreatePricingPlanRequest.mjs";
-export * from "./UpdatePricingPlanRequest.mjs";
-export * from "./UpdateSubscriptionRequest.mjs";
-export * from "./CreateCreditPoolRequest.mjs";
-export * from "./GrantCreditsRequest.mjs";
-export * from "./UpdateRateCardRequest.mjs";