lark-billing 0.1.3 → 0.1.5

package/src/resources/checkout.ts

@@ -0,0 +1,81 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../core/resource';
+import { APIPromise } from '../core/api-promise';
+import { RequestOptions } from '../internal/request-options';
+
+export class Checkout extends APIResource {
+  /**
+   * Create Subscription Checkout Session
+   */
+  create(body: CheckoutCreateParams, options?: RequestOptions): APIPromise<CheckoutCreateResponse> {
+    return this._client.post('/checkout', { body, ...options });
+  }
+}
+
+export interface AmountOutput {
+  /**
+   * The currency code of the amount.
+   */
+  currency_code: string;
+
+  /**
+   * The value of the amount in the smallest unit of the currency.
+   */
+  value: string;
+}
+
+export interface CheckoutCallback {
+  /**
+   * The URL to redirect to after the checkout is cancelled.
+   */
+  cancelled_url: string;
+
+  /**
+   * The URL to redirect to after the checkout is successful.
+   */
+  success_url: string;
+}
+
+export interface CheckoutCreateResponse {
+  /**
+   * The ID of the checkout session.
+   */
+  id: string;
+
+  /**
+   * The amount of the checkout session.
+   */
+  amount: AmountOutput;
+
+  /**
+   * The URL to redirect to the checkout session.
+   */
+  url: string;
+}
+
+export interface CheckoutCreateParams {
+  /**
+   * The URLs to redirect to after the checkout is completed or cancelled.
+   */
+  checkout_callback_urls: CheckoutCallback;
+
+  /**
+   * The ID of the rate card to subscribe to.
+   */
+  rate_card_id: string;
+
+  /**
+   * The ID or external ID of the subject to create the checkout for.
+   */
+  subject_id: string;
+}
+
+export declare namespace Checkout {
+  export {
+    type AmountOutput as AmountOutput,
+    type CheckoutCallback as CheckoutCallback,
+    type CheckoutCreateResponse as CheckoutCreateResponse,
+    type CheckoutCreateParams as CheckoutCreateParams,
+  };
+}

package/src/resources/customer-access.ts

@@ -0,0 +1,63 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../core/resource';
+import { APIPromise } from '../core/api-promise';
+import { RequestOptions } from '../internal/request-options';
+import { path } from '../internal/utils/path';
+
+export class CustomerAccess extends APIResource {
+  /**
+   * Get Billing State
+   */
+  retrieveBillingState(
+    subjectID: string,
+    options?: RequestOptions,
+  ): APIPromise<CustomerAccessRetrieveBillingStateResponse> {
+    return this._client.get(path`/customer-access/${subjectID}/billing-state`, options);
+  }
+}
+
+export interface CustomerAccessRetrieveBillingStateResponse {
+  /**
+   * List of active subscriptions the subject is subscribed to.
+   */
+  active_subscriptions: Array<CustomerAccessRetrieveBillingStateResponse.ActiveSubscription>;
+
+  /**
+   * Whether the subject has an active subscription.
+   */
+  has_active_subscription: boolean;
+
+  /**
+   * Whether the subject has exceeded the included usage (if any) on a usage-based
+   * rate they are subscribed to.
+   */
+  has_overage_for_usage: boolean;
+
+  /**
+   * The usage data for the usage-based rates the subject is subscribed to.
+   */
+  usage_data: Array<CustomerAccessRetrieveBillingStateResponse.UsageData>;
+}
+
+export namespace CustomerAccessRetrieveBillingStateResponse {
+  export interface ActiveSubscription {
+    rate_card_id: string;
+
+    subscription_id: string;
+  }
+
+  export interface UsageData {
+    included_units: number;
+
+    pricing_metric_id: string;
+
+    rate_name: string;
+
+    used_units: string;
+  }
+}
+
+export declare namespace CustomerAccess {
+  export { type CustomerAccessRetrieveBillingStateResponse as CustomerAccessRetrieveBillingStateResponse };
+}

package/src/resources/customer-portal.ts

@@ -0,0 +1,48 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../core/resource';
+import { APIPromise } from '../core/api-promise';
+import { RequestOptions } from '../internal/request-options';
+
+export class CustomerPortal extends APIResource {
+  /**
+   * Create Customer Portal Session
+   */
+  createSession(
+    body: CustomerPortalCreateSessionParams,
+    options?: RequestOptions,
+  ): APIPromise<CustomerPortalCreateSessionResponse> {
+    return this._client.post('/customer-portal/sessions', { body, ...options });
+  }
+}
+
+export interface CustomerPortalCreateSessionResponse {
+  /**
+   * The date and time the customer portal session expires.
+   */
+  expires_at: string;
+
+  /**
+   * The ID of the subject for the customer portal session.
+   */
+  subject_id: string;
+
+  /**
+   * The URL to redirect to the customer portal session.
+   */
+  url: string;
+}
+
+export interface CustomerPortalCreateSessionParams {
+  /**
+   * The ID or external ID of the subject to create the customer portal session for.
+   */
+  subject_id: string;
+}
+
+export declare namespace CustomerPortal {
+  export {
+    type CustomerPortalCreateSessionResponse as CustomerPortalCreateSessionResponse,
+    type CustomerPortalCreateSessionParams as CustomerPortalCreateSessionParams,
+  };
+}

package/src/resources/index.ts

@@ -0,0 +1,59 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+export {
+  Checkout,
+  type AmountOutput,
+  type CheckoutCallback,
+  type CheckoutCreateResponse,
+  type CheckoutCreateParams,
+} from './checkout';
+export { CustomerAccess, type CustomerAccessRetrieveBillingStateResponse } from './customer-access';
+export {
+  CustomerPortal,
+  type CustomerPortalCreateSessionResponse,
+  type CustomerPortalCreateSessionParams,
+} from './customer-portal';
+export { Invoices, type InvoiceListResponse, type InvoiceListParams } from './invoices';
+export {
+  PricingMetrics,
+  type Period,
+  type PricingMetric,
+  type PricingMetricListResponse,
+  type PricingMetricCreateSummaryResponse,
+  type PricingMetricCreateParams,
+  type PricingMetricListParams,
+  type PricingMetricCreateSummaryParams,
+} from './pricing-metrics';
+export {
+  RateCards,
+  type AmountInput,
+  type FlatPriceInput,
+  type FlatPriceOutput,
+  type PackagePriceInput,
+  type PackagePriceOutput,
+  type RateCardResource,
+  type RateCardListResponse,
+  type RateCardCreateParams,
+  type RateCardListParams,
+} from './rate-cards';
+export {
+  Subjects,
+  type SubjectResource,
+  type SubjectCreateResponse,
+  type SubjectListResponse,
+  type SubjectDeleteResponse,
+  type SubjectCreateParams,
+  type SubjectUpdateParams,
+  type SubjectListParams,
+} from './subjects';
+export {
+  Subscriptions,
+  type SubscriptionResource,
+  type SubscriptionListResponse,
+  type SubscriptionChangeRateCardResponse,
+  type SubscriptionCreateParams,
+  type SubscriptionListParams,
+  type SubscriptionCancelParams,
+  type SubscriptionChangeRateCardParams,
+} from './subscriptions';
+export { UsageEvents, type UsageEventCreateResponse, type UsageEventCreateParams } from './usage-events';

package/src/resources/invoices.ts

@@ -0,0 +1,87 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../core/resource';
+import * as CheckoutAPI from './checkout';
+import { APIPromise } from '../core/api-promise';
+import { RequestOptions } from '../internal/request-options';
+
+export class Invoices extends APIResource {
+  /**
+   * List Invoices
+   */
+  list(query: InvoiceListParams, options?: RequestOptions): APIPromise<InvoiceListResponse> {
+    return this._client.get('/invoices', { query, ...options });
+  }
+}
+
+export interface InvoiceListResponse {
+  has_more: boolean;
+
+  invoices: Array<InvoiceListResponse.Invoice>;
+}
+
+export namespace InvoiceListResponse {
+  export interface Invoice {
+    /**
+     * The ID of the invoice.
+     */
+    id: string;
+
+    /**
+     * The date and time the invoice was created.
+     */
+    created_at: string;
+
+    /**
+     * The URL of the hosted invoice.
+     */
+    hosted_url: string | null;
+
+    /**
+     * The line items of the invoice.
+     */
+    line_items: Array<Invoice.LineItem>;
+
+    /**
+     * The status of the invoice.
+     */
+    status: 'draft' | 'open' | 'paid' | 'uncollectible' | 'void';
+
+    /**
+     * The ID of the subject for the invoice.
+     */
+    subject_id: string;
+
+    /**
+     * The total amount of the invoice.
+     */
+    total_amount: CheckoutAPI.AmountOutput;
+  }
+
+  export namespace Invoice {
+    export interface LineItem {
+      amount: CheckoutAPI.AmountOutput;
+
+      description: string;
+
+      price_in_unit_amount: CheckoutAPI.AmountOutput;
+
+      quantity: number;
+    }
+  }
+}
+
+export interface InvoiceListParams {
+  /**
+   * The ID or external ID of the subject to list invoices for.
+   */
+  subject_id: string;
+
+  limit?: number;
+
+  offset?: number;
+}
+
+export declare namespace Invoices {
+  export { type InvoiceListResponse as InvoiceListResponse, type InvoiceListParams as InvoiceListParams };
+}

package/src/resources/pricing-metrics.ts

@@ -0,0 +1,307 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../core/resource';
+import { APIPromise } from '../core/api-promise';
+import { RequestOptions } from '../internal/request-options';
+import { path } from '../internal/utils/path';
+
+export class PricingMetrics extends APIResource {
+  /**
+   * Create Pricing Metric
+   *
+   * @example
+   * ```ts
+   * const pricingMetric = await client.pricingMetrics.create({
+   *   aggregation: {
+   *     aggregation_type: 'sum',
+   *     value_field: 'compute_hours',
+   *   },
+   *   event_name: 'job_completed',
+   *   name: 'Compute Hours',
+   *   unit: 'hours',
+   * });
+   * ```
+   */
+  create(body: PricingMetricCreateParams, options?: RequestOptions): APIPromise<PricingMetric> {
+    return this._client.post('/pricing-metrics', { body, ...options });
+  }
+
+  /**
+   * Get Pricing Metric
+   *
+   * @example
+   * ```ts
+   * const pricingMetric = await client.pricingMetrics.retrieve(
+   *   'pricing_metric_id',
+   * );
+   * ```
+   */
+  retrieve(pricingMetricID: string, options?: RequestOptions): APIPromise<PricingMetric> {
+    return this._client.get(path`/pricing-metrics/${pricingMetricID}`, options);
+  }
+
+  /**
+   * List Pricing Metrics
+   *
+   * @example
+   * ```ts
+   * const pricingMetrics = await client.pricingMetrics.list();
+   * ```
+   */
+  list(
+    query: PricingMetricListParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<PricingMetricListResponse> {
+    return this._client.get('/pricing-metrics', { query, ...options });
+  }
+
+  /**
+   * Create Pricing Metric Summary
+   *
+   * @example
+   * ```ts
+   * const response = await client.pricingMetrics.createSummary(
+   *   'pricing_metric_id',
+   *   {
+   *     period: {
+   *       end: '2025-11-01T00:00:00Z',
+   *       start: '2025-10-01T00:00:00Z',
+   *     },
+   *     subject_id: 'subj_VyX6Q96h5avMho8O7QWlKeXE',
+   *   },
+   * );
+   * ```
+   */
+  createSummary(
+    pricingMetricID: string,
+    body: PricingMetricCreateSummaryParams,
+    options?: RequestOptions,
+  ): APIPromise<PricingMetricCreateSummaryResponse> {
+    return this._client.post(path`/pricing-metrics/${pricingMetricID}/summary`, { body, ...options });
+  }
+}
+
+export interface Period {
+  end: string;
+
+  start: string;
+
+  inclusive_end?: boolean;
+
+  inclusive_start?: boolean;
+}
+
+export interface PricingMetric {
+  /**
+   * The ID of the pricing metric.
+   */
+  id: string;
+
+  /**
+   * The aggregation function used to compute the value of the pricing metric.
+   */
+  aggregation:
+    | PricingMetric.SumAggregationPricingMetricResource
+    | PricingMetric.CountAggregationPricingMetricResource
+    | PricingMetric.MaxAggregationPricingMetricResource
+    | PricingMetric.LastAggregationPricingMetricResource;
+
+  /**
+   * The event name that the pricing metric is computed on.
+   */
+  event_name: string;
+
+  /**
+   * The name of the pricing metric.
+   */
+  name: string;
+
+  /**
+   * The unit of the value computed by the pricing metric.
+   */
+  unit: string;
+}
+
+export namespace PricingMetric {
+  export interface SumAggregationPricingMetricResource {
+    aggregation_type: 'sum';
+
+    /**
+     * The field to sum over.
+     */
+    value_field: string;
+  }
+
+  export interface CountAggregationPricingMetricResource {
+    aggregation_type: 'count';
+  }
+
+  export interface MaxAggregationPricingMetricResource {
+    aggregation_type: 'max';
+
+    /**
+     * The field to get the max value of.
+     */
+    value_field: string;
+  }
+
+  export interface LastAggregationPricingMetricResource {
+    aggregation_type: 'last';
+
+    /**
+     * The field to get the last value of.
+     */
+    value_field: string;
+  }
+}
+
+export interface PricingMetricListResponse {
+  has_more: boolean;
+
+  pricing_metrics: Array<PricingMetric>;
+}
+
+export interface PricingMetricCreateSummaryResponse {
+  /**
+   * The ID of the pricing metric summary.
+   */
+  id: string;
+
+  /**
+   * The period that the summary is computed over.
+   */
+  period: Period;
+
+  /**
+   * The ID of the pricing metric that the summary is for.
+   */
+  pricing_metric_id: string;
+
+  /**
+   * The ID of the subject that the summary is for.
+   */
+  subject_id: string;
+
+  /**
+   * The computed value of the pricing metric for the period. If the pricing metric
+   * does not have any usage events for the period, this will be `null`.
+   */
+  value: string | null;
+}
+
+export interface PricingMetricCreateParams {
+  /**
+   * The aggregation function used to compute the value of the pricing metric.
+   */
+  aggregation:
+    | PricingMetricCreateParams.SumAggregationPricingMetricInterface
+    | PricingMetricCreateParams.CountAggregationPricingMetricInterface
+    | PricingMetricCreateParams.MaxAggregationPricingMetricInterface
+    | PricingMetricCreateParams.LastAggregationPricingMetricInterface
+    | PricingMetricCreateParams.CustomAggregationPricingMetricInterface;
+
+  /**
+   * The name of the event that the pricing metric is computed on.
+   */
+  event_name: string;
+
+  /**
+   * The name of the pricing metric.
+   */
+  name: string;
+
+  /**
+   * Unit of measurement for the pricing metric.
+   */
+  unit: string;
+}
+
+export namespace PricingMetricCreateParams {
+  /**
+   * Computes the sum of the `value_field` over all usage events with the specified
+   * `event_name`.
+   */
+  export interface SumAggregationPricingMetricInterface {
+    aggregation_type: 'sum';
+
+    /**
+     * Field to sum over.
+     */
+    value_field: string;
+  }
+
+  /**
+   * Computes the number of usage events with the specified `event_name`.
+   */
+  export interface CountAggregationPricingMetricInterface {
+    aggregation_type: 'count';
+  }
+
+  /**
+   * Computes the max value of the `value_field` over all usage events with the
+   * specified `event_name`.
+   */
+  export interface MaxAggregationPricingMetricInterface {
+    aggregation_type: 'max';
+
+    /**
+     * Field to get the max value of.
+     */
+    value_field: string;
+  }
+
+  /**
+   * Computes the last value of the `value_field` over all usage events with the
+   * specified `event_name`.
+   */
+  export interface LastAggregationPricingMetricInterface {
+    aggregation_type: 'last';
+
+    /**
+     * Field to get the last value of.
+     */
+    value_field: string;
+  }
+
+  /**
+   * Custom aggregation for use cases not supported by the other aggregation types.
+   * Please email team@uselark.ai to enable this feature.
+   */
+  export interface CustomAggregationPricingMetricInterface {
+    aggregation_type: 'custom';
+
+    /**
+     * Custom expression to compute the pricing metric. Please email team@uselark.ai to
+     * enable this feature.
+     */
+    custom_expression: string;
+  }
+}
+
+export interface PricingMetricListParams {
+  limit?: number;
+}
+
+export interface PricingMetricCreateSummaryParams {
+  /**
+   * The period that the summary should be computed over.
+   */
+  period: Period;
+
+  /**
+   * The ID or external ID of the subject that the summary should be computed for.
+   */
+  subject_id: string;
+}
+
+export declare namespace PricingMetrics {
+  export {
+    type Period as Period,
+    type PricingMetric as PricingMetric,
+    type PricingMetricListResponse as PricingMetricListResponse,
+    type PricingMetricCreateSummaryResponse as PricingMetricCreateSummaryResponse,
+    type PricingMetricCreateParams as PricingMetricCreateParams,
+    type PricingMetricListParams as PricingMetricListParams,
+    type PricingMetricCreateSummaryParams as PricingMetricCreateSummaryParams,
+  };
+}