lark-billing 0.2.0 → 0.4.0

package/src/client.ts

@@ -165,7 +165,7 @@ export class Lark {
   baseURL: string;
   maxRetries: number;
   timeout: number;
-  logger: Logger | undefined;
+  logger: Logger;
   logLevel: LogLevel | undefined;
   fetchOptions: MergedRequestInit | undefined;
 
@@ -178,7 +178,7 @@ export class Lark {
    * API Client for interfacing with the Lark API.
    *
    * @param {string | undefined} [opts.apiKey=process.env['LARK_API_KEY'] ?? undefined]
-   * @param {string} [opts.baseURL=process.env['LARK_BASE_URL'] ?? https://api.example.com] - Override the default base URL for the API.
+   * @param {string} [opts.baseURL=process.env['LARK_BASE_URL'] ?? https://api.uselark.ai] - Override the default base URL for the API.
    * @param {number} [opts.timeout=1 minute] - The maximum amount of time (in milliseconds) the client will wait for a response before timing out.
    * @param {MergedRequestInit} [opts.fetchOptions] - Additional `RequestInit` options to be passed to `fetch` calls.
    * @param {Fetch} [opts.fetch] - Specify a custom `fetch` function implementation.
@@ -200,7 +200,7 @@ export class Lark {
     const options: ClientOptions = {
       apiKey,
       ...opts,
-      baseURL: baseURL || `https://api.example.com`,
+      baseURL: baseURL || `https://api.uselark.ai`,
     };
 
     this.baseURL = options.baseURL!;
@@ -246,7 +246,7 @@ export class Lark {
    * Check whether the base URL is set to its default.
    */
   #baseURLOverridden(): boolean {
-    return this.baseURL !== 'https://api.example.com';
+    return this.baseURL !== 'https://api.uselark.ai';
   }
 
   protected defaultQuery(): Record<string, string | undefined> | undefined {

package/src/resources/customer-access.ts

@@ -8,6 +8,14 @@ import { path } from '../internal/utils/path';
 export class CustomerAccess extends APIResource {
   /**
    * Get Billing State
+   *
+   * @example
+   * ```ts
+   * const response =
+   *   await client.customerAccess.retrieveBillingState(
+   *     'user_1234567890',
+   *   );
+   * ```
    */
   retrieveBillingState(
     subjectID: string,

package/src/resources/invoices.ts

@@ -8,6 +8,13 @@ import { RequestOptions } from '../internal/request-options';
 export class Invoices extends APIResource {
   /**
    * List Invoices
+   *
+   * @example
+   * ```ts
+   * const invoices = await client.invoices.list({
+   *   subject_id: 'user_1234567890',
+   * });
+   * ```
    */
   list(query: InvoiceListParams, options?: RequestOptions): APIPromise<InvoiceListResponse> {
     return this._client.get('/invoices', { query, ...options });

package/src/resources/pricing-metrics.ts

@@ -61,11 +61,11 @@ export class PricingMetrics extends APIResource {
    * @example
    * ```ts
    * const response = await client.pricingMetrics.createSummary(
-   *   'pricing_metric_id',
+   *   'pmtr_GlX5Tcm2HOn00CoRTFxw2Amw',
    *   {
    *     period: {
-   *       end: '2025-11-01T00:00:00Z',
    *       start: '2025-10-01T00:00:00Z',
+   *       end: '2025-11-01T00:00:00Z',
    *     },
    *     subject_id: 'subj_VyX6Q96h5avMho8O7QWlKeXE',
    *   },
@@ -120,6 +120,11 @@ export interface PricingMetricResource {
    * The unit of the value computed by the pricing metric.
    */
   unit: string;
+
+  /**
+   * The dimensions by which the events are grouped to compute the pricing metric.
+   */
+  dimensions?: Array<string> | null;
 }
 
 export namespace PricingMetricResource {
@@ -214,6 +219,11 @@ export interface PricingMetricCreateParams {
    * Unit of measurement for the pricing metric.
    */
   unit: string;
+
+  /**
+   * The dimensions by which the events are grouped to compute the pricing metric.
+   */
+  dimensions?: Array<string> | null;
 }
 
 export namespace PricingMetricCreateParams {

package/src/resources/rate-cards.ts

@@ -10,6 +10,38 @@ import { path } from '../internal/utils/path';
 export class RateCards extends APIResource {
   /**
    * Create Rate Card
+   *
+   * @example
+   * ```ts
+   * const rateCardResource = await client.rateCards.create({
+   *   billing_interval: 'monthly',
+   *   name: 'Pro Plan',
+   *   description:
+   *     'For production applicatidddons with moderate usage.',
+   *   fixed_rates: [
+   *     {
+   *       name: 'Base Rate',
+   *       price: {
+   *         price_type: 'flat',
+   *         amount: { value: 2500, currency_code: 'usd' },
+   *       },
+   *     },
+   *   ],
+   *   metadata: {},
+   *   usage_based_rates: [
+   *     {
+   *       usage_based_rate_type: 'simple',
+   *       name: 'Compute Hours',
+   *       price: {
+   *         price_type: 'flat',
+   *         amount: { value: 100, currency_code: 'usd' },
+   *       },
+   *       included_units: 30,
+   *       pricing_metric_id: 'pmtr_GlX5Tcm2HOn00CoRTFxw2Amw',
+   *     },
+   *   ],
+   * });
+   * ```
    */
   create(body: RateCardCreateParams, options?: RequestOptions): APIPromise<RateCardResource> {
     return this._client.post('/rate-cards', { body, ...options });
@@ -17,6 +49,13 @@ export class RateCards extends APIResource {
 
   /**
    * Get Rate Card
+   *
+   * @example
+   * ```ts
+   * const rateCardResource = await client.rateCards.retrieve(
+   *   'rate_card_id',
+   * );
+   * ```
    */
   retrieve(rateCardID: string, options?: RequestOptions): APIPromise<RateCardResource> {
     return this._client.get(path`/rate-cards/${rateCardID}`, options);
@@ -24,6 +63,11 @@ export class RateCards extends APIResource {
 
   /**
    * List Rate Cards
+   *
+   * @example
+   * ```ts
+   * const rateCards = await client.rateCards.list();
+   * ```
    */
   list(
     query: RateCardListParams | null | undefined = {},
@@ -99,6 +143,9 @@ export interface RateCardResource {
    */
   id: string;
 
+  /**
+   * How often the customer will be billed for this rate card.
+   */
   billing_interval: 'monthly' | 'yearly';
 
   /**
@@ -111,6 +158,10 @@ export interface RateCardResource {
    */
   fixed_rates: Array<RateCardResource.FixedRate>;
 
+  /**
+   * Additional metadata about the rate card. You may use this to store any custom
+   * data about the rate card.
+   */
   metadata: { [key: string]: string };
 
   /**
@@ -126,7 +177,9 @@ export interface RateCardResource {
   /**
    * The usage based rates of the rate card.
    */
-  usage_based_rates: Array<RateCardResource.UsageBasedRate>;
+  usage_based_rates: Array<
+    RateCardResource.SimpleUsageBasedRateInterface | RateCardResource.DimensionalUsageBasedRateInterface
+  >;
 
   /**
    * The description of the rate card.
@@ -148,7 +201,7 @@ export namespace RateCardResource {
     price: RateCardsAPI.FlatPriceOutput | RateCardsAPI.PackagePriceOutput;
   }
 
-  export interface UsageBasedRate {
+  export interface SimpleUsageBasedRateInterface {
     id: string;
 
     description: string | null;
@@ -166,6 +219,49 @@ export namespace RateCardResource {
 
     usage_based_rate_type?: 'simple';
   }
+
+  export interface DimensionalUsageBasedRateInterface {
+    id: string;
+
+    description: string | null;
+
+    dimensions: Array<DimensionalUsageBasedRateInterface.Dimension>;
+
+    included_units: number;
+
+    name: string;
+
+    pricing_matrix: DimensionalUsageBasedRateInterface.PricingMatrix;
+
+    pricing_metric_id: string;
+
+    usage_based_rate_type?: 'dimensional';
+  }
+
+  export namespace DimensionalUsageBasedRateInterface {
+    export interface Dimension {
+      description: string | null;
+
+      key: string;
+
+      values: Array<string>;
+    }
+
+    export interface PricingMatrix {
+      cells: Array<PricingMatrix.Cell>;
+    }
+
+    export namespace PricingMatrix {
+      export interface Cell {
+        dimension_coordinates: { [key: string]: string };
+
+        /**
+         * Flat price is a price that linearly scales with the quantity.
+         */
+        price: RateCardsAPI.FlatPriceOutput | RateCardsAPI.PackagePriceOutput;
+      }
+    }
+  }
 }
 
 export interface RateCardListResponse {
@@ -202,7 +298,10 @@ export interface RateCardCreateParams {
    * The usage based rates of the rate card. These are billed at the end of each
    * billing cycle.
    */
-  usage_based_rates?: Array<RateCardCreateParams.UsageBasedRate>;
+  usage_based_rates?: Array<
+    | RateCardCreateParams.CreateSimpleUsageBasedRateRequest
+    | RateCardCreateParams.CreateDimensionalUsageBasedRateRequest
+  >;
 }
 
 export namespace RateCardCreateParams {
@@ -223,7 +322,7 @@ export namespace RateCardCreateParams {
     description?: string | null;
   }
 
-  export interface UsageBasedRate {
+  export interface CreateSimpleUsageBasedRateRequest {
     /**
      * The name of the rate displayed to the customer.
      */
@@ -251,6 +350,82 @@ export namespace RateCardCreateParams {
      */
     included_units?: number;
   }
+
+  export interface CreateDimensionalUsageBasedRateRequest {
+    /**
+     * The dimensions of the rate.
+     */
+    dimensions: Array<CreateDimensionalUsageBasedRateRequest.Dimension>;
+
+    /**
+     * The name of the rate displayed to the customer.
+     */
+    name: string;
+
+    /**
+     * The pricing matrix of the rate.
+     */
+    pricing_matrix: CreateDimensionalUsageBasedRateRequest.PricingMatrix;
+
+    /**
+     * The ID of the pricing metric to use for this rate.
+     */
+    pricing_metric_id: string;
+
+    usage_based_rate_type: 'dimensional';
+
+    /**
+     * The description of the rate displayed to the customer.
+     */
+    description?: string | null;
+
+    /**
+     * The number of units included in the rate before the price is applied.
+     */
+    included_units?: number;
+  }
+
+  export namespace CreateDimensionalUsageBasedRateRequest {
+    export interface Dimension {
+      /**
+       * The name of the dimension. This is used to identify the dimension in the pricing
+       * matrix.
+       */
+      key: string;
+
+      /**
+       * A list of possible values for the dimension.
+       */
+      values: Array<string>;
+
+      /**
+       * The description of the dimension.
+       */
+      description?: string | null;
+    }
+
+    /**
+     * The pricing matrix of the rate.
+     */
+    export interface PricingMatrix {
+      cells: Array<PricingMatrix.Cell>;
+    }
+
+    export namespace PricingMatrix {
+      export interface Cell {
+        /**
+         * A key-value mapping of dimension keys and values to identify the price for a
+         * given set of dimension values.
+         */
+        dimension_coordinates: { [key: string]: string };
+
+        /**
+         * The price for the cell.
+         */
+        price: RateCardsAPI.FlatPriceInput | RateCardsAPI.PackagePriceInput;
+      }
+    }
+  }
 }
 
 export interface RateCardListParams {

package/src/resources/subjects.ts

@@ -11,7 +11,12 @@ export class Subjects extends APIResource {
    *
    * @example
    * ```ts
-   * const subject = await client.subjects.create();
+   * const subject = await client.subjects.create({
+   *   email: 'john.doe@example.com',
+   *   external_id: 'user_1234567890',
+   *   metadata: {},
+   *   name: 'John Doe',
+   * });
    * ```
    */
   create(body: SubjectCreateParams, options?: RequestOptions): APIPromise<SubjectCreateResponse> {
@@ -41,7 +46,7 @@ export class Subjects extends APIResource {
    *   'subject_id',
    *   {
    *     email: 'john.doe@example.com',
-   *     metadata: { foo: 'string' },
+   *     metadata: {},
    *     name: 'John Doe',
    *   },
    * );

package/src/resources/subscriptions.ts

@@ -14,11 +14,12 @@ export class Subscriptions extends APIResource {
    * ```ts
    * const subscription = await client.subscriptions.create({
    *   checkout_callback_urls: {
-   *     cancelled_url: 'https://example.com/callback',
-   *     success_url: 'https://example.com/callback',
+   *     cancelled_url: 'https://example.com/try-again',
+   *     success_url: 'https://example.com/welcome',
    *   },
    *   rate_card_id: 'rc_AJWMxR81jxoRlli6p13uf3JB',
    *   subject_id: 'subj_VyX6Q96h5avMho8O7QWlKeXE',
+   *   metadata: {},
    * });
    * ```
    */
@@ -60,7 +61,9 @@ export class Subscriptions extends APIResource {
    * @example
    * ```ts
    * const subscriptionResource =
-   *   await client.subscriptions.cancel('subscription_id');
+   *   await client.subscriptions.cancel('subscription_id', {
+   *     cancel_at_end_of_cycle: true,
+   *   });
    * ```
    */
   cancel(
@@ -80,10 +83,11 @@ export class Subscriptions extends APIResource {
    *   'subscription_id',
    *   {
    *     checkout_callback_urls: {
-   *       cancelled_url: 'https://example.com/callback',
-   *       success_url: 'https://example.com/callback',
+   *       cancelled_url: 'https://example.com/try-again',
+   *       success_url: 'https://example.com/completed',
    *     },
    *     rate_card_id: 'rc_jQK2n0wutCj6bBcAIrL6o07g',
+   *     upgrade_behavior: 'prorate',
    *   },
    * );
    * ```

package/src/resources/usage-events.ts

@@ -12,13 +12,14 @@ export class UsageEvents extends APIResource {
    * ```ts
    * const usageEvent = await client.usageEvents.create({
    *   data: {
-   *     compute_hours: 100,
+   *     compute_hours: '100.5',
    *     instance_type: 't2.micro',
    *     region: 'us-east-1',
    *   },
-   *   event_name: 'compute_hours',
-   *   idempotency_key: 'dd187757-47af-4a69-8a89-6285b9fe1cb6',
+   *   event_name: 'job_completed',
+   *   idempotency_key: '168fbd3a-4d39-4db3-a204-15e014857d10',
    *   subject_id: 'subj_VyX6Q96h5avMho8O7QWlKeXE',
+   *   timestamp: '2025-12-03T22:13:28.294419+00:00',
    * });
    * ```
    */

package/src/version.ts

@@ -1 +1 @@
-export const VERSION = '0.2.0'; // x-release-please-version
+export const VERSION = '0.4.0'; // x-release-please-version

package/version.d.mts

@@ -1,2 +1,2 @@
-export declare const VERSION = "0.2.0";
+export declare const VERSION = "0.4.0";
 //# sourceMappingURL=version.d.mts.map

package/version.d.ts

@@ -1,2 +1,2 @@
-export declare const VERSION = "0.2.0";
+export declare const VERSION = "0.4.0";
 //# sourceMappingURL=version.d.ts.map

package/version.js

@@ -1,5 +1,5 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.VERSION = void 0;
-exports.VERSION = '0.2.0'; // x-release-please-version
+exports.VERSION = '0.4.0'; // x-release-please-version
 //# sourceMappingURL=version.js.map

package/version.mjs

@@ -1,2 +1,2 @@
-export const VERSION = '0.2.0'; // x-release-please-version
+export const VERSION = '0.4.0'; // x-release-please-version
 //# sourceMappingURL=version.mjs.map