@modelrelay/sdk 1.28.0 → 1.36.0

package/dist/billing/index.cjs

@@ -0,0 +1,151 @@
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+
+// src/billing/index.ts
+var billing_exports = {};
+__export(billing_exports, {
+  BillingClient: () => BillingClient
+});
+module.exports = __toCommonJS(billing_exports);
+var BillingClient = class {
+  constructor(http, accessToken) {
+    this.http = http;
+    this.accessToken = accessToken;
+  }
+  /**
+   * Get the authenticated customer's profile.
+   *
+   * Returns customer details including ID, email, external ID, and metadata.
+   *
+   * @returns Customer profile with optional subscription and tier
+   */
+  async me() {
+    const response = await this.http.json("/customers/me", {
+      method: "GET",
+      accessToken: this.accessToken
+    });
+    return response.customer;
+  }
+  /**
+   * Get the authenticated customer's subscription details.
+   *
+   * Returns subscription status, tier information, and billing provider.
+   *
+   * @returns Subscription details
+   */
+  async subscription() {
+    const response = await this.http.json("/customers/me/subscription", {
+      method: "GET",
+      accessToken: this.accessToken
+    });
+    return response.subscription;
+  }
+  /**
+   * Get the authenticated customer's usage metrics.
+   *
+   * Returns token usage, request counts, and cost for the current billing window.
+   *
+   * @returns Usage metrics
+   */
+  async usage() {
+    const response = await this.http.json("/customers/me/usage", {
+      method: "GET",
+      accessToken: this.accessToken
+    });
+    return response.usage;
+  }
+  /**
+   * Get the authenticated customer's credit balance.
+   *
+   * For PAYGO (pay-as-you-go) subscriptions, returns the current balance
+   * and reserved amount.
+   *
+   * @returns Balance information
+   */
+  async balance() {
+    return await this.http.json("/customers/me/balance", {
+      method: "GET",
+      accessToken: this.accessToken
+    });
+  }
+  /**
+   * Get the authenticated customer's balance transaction history.
+   *
+   * Returns a list of ledger entries showing credits and debits.
+   *
+   * @returns Ledger entries
+   */
+  async balanceHistory() {
+    return await this.http.json("/customers/me/balance/history", {
+      method: "GET",
+      accessToken: this.accessToken
+    });
+  }
+  /**
+   * Create a top-up checkout session.
+   *
+   * For PAYGO subscriptions, creates a Stripe Checkout session to add credits.
+   *
+   * @param request - Top-up request with amount and redirect URLs
+   * @returns Checkout session with redirect URL
+   */
+  async topup(request) {
+    return await this.http.json("/customers/me/topup", {
+      method: "POST",
+      body: request,
+      accessToken: this.accessToken
+    });
+  }
+  /**
+   * Change the authenticated customer's subscription tier.
+   *
+   * Switches to a different tier within the same project.
+   *
+   * @param tierCode - The tier code to switch to
+   * @returns Updated subscription details
+   */
+  async changeTier(tierCode) {
+    const request = { tier_code: tierCode };
+    const response = await this.http.json("/customers/me/change-tier", {
+      method: "POST",
+      body: request,
+      accessToken: this.accessToken
+    });
+    return response.subscription;
+  }
+  /**
+   * Create a subscription checkout session.
+   *
+   * Creates a Stripe Checkout session for subscribing to a tier.
+   *
+   * @param request - Checkout request with tier and redirect URLs
+   * @returns Checkout session with redirect URL
+   */
+  async checkout(request) {
+    return await this.http.json("/customers/me/checkout", {
+      method: "POST",
+      body: request,
+      accessToken: this.accessToken
+    });
+  }
+};
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  BillingClient
+});

package/dist/billing/index.d.cts

@@ -0,0 +1,178 @@
+import { c as components } from '../api-jqOwvH6O.cjs';
+
+/**
+ * Billing client for customer self-service operations.
+ *
+ * This module provides helpers for customer billing operations like viewing
+ * subscription status, usage metrics, balance, and managing subscriptions.
+ *
+ * Requires a customer bearer token for authentication (not API keys).
+ *
+ * @example
+ * ```typescript
+ * import { ModelRelay } from "@modelrelay/sdk";
+ * import { BillingClient } from "@modelrelay/sdk/billing";
+ *
+ * // Customer token from device flow or OIDC exchange
+ * const client = new ModelRelay({ token: customerToken });
+ * const billing = new BillingClient(client.http);
+ *
+ * // Get customer info
+ * const me = await billing.me();
+ * console.log("Customer:", me.customer.email);
+ * console.log("Tier:", me.tier?.code);
+ *
+ * // Get usage metrics
+ * const usage = await billing.usage();
+ * console.log("Tokens used:", usage.total_tokens);
+ * ```
+ */
+
+/**
+ * Customer profile returned by GET /customers/me.
+ */
+type CustomerMe = components["schemas"]["CustomerMe"];
+/**
+ * Customer usage metrics.
+ */
+type CustomerMeUsage = components["schemas"]["CustomerMeUsage"];
+/**
+ * Customer subscription details.
+ */
+type CustomerMeSubscription = components["schemas"]["CustomerMeSubscription"];
+/**
+ * Customer credit balance.
+ */
+type CustomerBalanceResponse = components["schemas"]["CustomerBalanceResponse"];
+/**
+ * Customer ledger entry for balance history.
+ */
+type CustomerLedgerEntry = components["schemas"]["CustomerLedgerEntry"];
+/**
+ * Customer ledger response with transaction history.
+ */
+type CustomerLedgerResponse = components["schemas"]["CustomerLedgerResponse"];
+/**
+ * Request to create a top-up checkout session.
+ */
+type CustomerTopupRequest = components["schemas"]["CustomerTopupRequest"];
+/**
+ * Response from top-up checkout session creation.
+ */
+type CustomerTopupResponse = components["schemas"]["CustomerTopupResponse"];
+/**
+ * Request to change subscription tier.
+ */
+type ChangeTierRequest = components["schemas"]["ChangeTierRequest"];
+/**
+ * Request to create a subscription checkout session.
+ */
+type CustomerMeCheckoutRequest = components["schemas"]["CustomerMeCheckoutRequest"];
+/**
+ * Response from checkout session creation.
+ */
+type CheckoutSessionResponse = components["schemas"]["CheckoutSessionResponse"];
+/**
+ * Minimal HTTP client interface for billing operations.
+ */
+interface HTTPClientLike {
+    json<T>(path: string, options: {
+        method: string;
+        body?: unknown;
+        accessToken?: string;
+    }): Promise<T>;
+}
+/**
+ * Client for customer billing self-service operations.
+ *
+ * These endpoints require a customer bearer token (from device flow or OIDC exchange).
+ * API keys are not accepted.
+ *
+ * @example
+ * ```typescript
+ * import { ModelRelay } from "@modelrelay/sdk";
+ * import { BillingClient } from "@modelrelay/sdk/billing";
+ *
+ * const client = new ModelRelay({ token: customerToken });
+ * const billing = new BillingClient(client.http);
+ *
+ * const me = await billing.me();
+ * const usage = await billing.usage();
+ * const subscription = await billing.subscription();
+ * ```
+ */
+declare class BillingClient {
+    private readonly http;
+    private readonly accessToken?;
+    constructor(http: HTTPClientLike, accessToken?: string);
+    /**
+     * Get the authenticated customer's profile.
+     *
+     * Returns customer details including ID, email, external ID, and metadata.
+     *
+     * @returns Customer profile with optional subscription and tier
+     */
+    me(): Promise<CustomerMe>;
+    /**
+     * Get the authenticated customer's subscription details.
+     *
+     * Returns subscription status, tier information, and billing provider.
+     *
+     * @returns Subscription details
+     */
+    subscription(): Promise<CustomerMeSubscription>;
+    /**
+     * Get the authenticated customer's usage metrics.
+     *
+     * Returns token usage, request counts, and cost for the current billing window.
+     *
+     * @returns Usage metrics
+     */
+    usage(): Promise<CustomerMeUsage>;
+    /**
+     * Get the authenticated customer's credit balance.
+     *
+     * For PAYGO (pay-as-you-go) subscriptions, returns the current balance
+     * and reserved amount.
+     *
+     * @returns Balance information
+     */
+    balance(): Promise<CustomerBalanceResponse>;
+    /**
+     * Get the authenticated customer's balance transaction history.
+     *
+     * Returns a list of ledger entries showing credits and debits.
+     *
+     * @returns Ledger entries
+     */
+    balanceHistory(): Promise<CustomerLedgerResponse>;
+    /**
+     * Create a top-up checkout session.
+     *
+     * For PAYGO subscriptions, creates a Stripe Checkout session to add credits.
+     *
+     * @param request - Top-up request with amount and redirect URLs
+     * @returns Checkout session with redirect URL
+     */
+    topup(request: CustomerTopupRequest): Promise<CustomerTopupResponse>;
+    /**
+     * Change the authenticated customer's subscription tier.
+     *
+     * Switches to a different tier within the same project.
+     *
+     * @param tierCode - The tier code to switch to
+     * @returns Updated subscription details
+     */
+    changeTier(tierCode: string): Promise<CustomerMeSubscription>;
+    /**
+     * Create a subscription checkout session.
+     *
+     * Creates a Stripe Checkout session for subscribing to a tier.
+     *
+     * @param request - Checkout request with tier and redirect URLs
+     * @returns Checkout session with redirect URL
+     */
+    checkout(request: CustomerMeCheckoutRequest): Promise<CheckoutSessionResponse>;
+}
+
+export { BillingClient, type ChangeTierRequest, type CheckoutSessionResponse, type CustomerBalanceResponse, type CustomerLedgerEntry, type CustomerLedgerResponse, type CustomerMe, type CustomerMeCheckoutRequest, type CustomerMeSubscription, type CustomerMeUsage, type CustomerTopupRequest, type CustomerTopupResponse };

package/dist/billing/index.d.ts

@@ -0,0 +1,178 @@
+import { c as components } from '../api-jqOwvH6O.js';
+
+/**
+ * Billing client for customer self-service operations.
+ *
+ * This module provides helpers for customer billing operations like viewing
+ * subscription status, usage metrics, balance, and managing subscriptions.
+ *
+ * Requires a customer bearer token for authentication (not API keys).
+ *
+ * @example
+ * ```typescript
+ * import { ModelRelay } from "@modelrelay/sdk";
+ * import { BillingClient } from "@modelrelay/sdk/billing";
+ *
+ * // Customer token from device flow or OIDC exchange
+ * const client = new ModelRelay({ token: customerToken });
+ * const billing = new BillingClient(client.http);
+ *
+ * // Get customer info
+ * const me = await billing.me();
+ * console.log("Customer:", me.customer.email);
+ * console.log("Tier:", me.tier?.code);
+ *
+ * // Get usage metrics
+ * const usage = await billing.usage();
+ * console.log("Tokens used:", usage.total_tokens);
+ * ```
+ */
+
+/**
+ * Customer profile returned by GET /customers/me.
+ */
+type CustomerMe = components["schemas"]["CustomerMe"];
+/**
+ * Customer usage metrics.
+ */
+type CustomerMeUsage = components["schemas"]["CustomerMeUsage"];
+/**
+ * Customer subscription details.
+ */
+type CustomerMeSubscription = components["schemas"]["CustomerMeSubscription"];
+/**
+ * Customer credit balance.
+ */
+type CustomerBalanceResponse = components["schemas"]["CustomerBalanceResponse"];
+/**
+ * Customer ledger entry for balance history.
+ */
+type CustomerLedgerEntry = components["schemas"]["CustomerLedgerEntry"];
+/**
+ * Customer ledger response with transaction history.
+ */
+type CustomerLedgerResponse = components["schemas"]["CustomerLedgerResponse"];
+/**
+ * Request to create a top-up checkout session.
+ */
+type CustomerTopupRequest = components["schemas"]["CustomerTopupRequest"];
+/**
+ * Response from top-up checkout session creation.
+ */
+type CustomerTopupResponse = components["schemas"]["CustomerTopupResponse"];
+/**
+ * Request to change subscription tier.
+ */
+type ChangeTierRequest = components["schemas"]["ChangeTierRequest"];
+/**
+ * Request to create a subscription checkout session.
+ */
+type CustomerMeCheckoutRequest = components["schemas"]["CustomerMeCheckoutRequest"];
+/**
+ * Response from checkout session creation.
+ */
+type CheckoutSessionResponse = components["schemas"]["CheckoutSessionResponse"];
+/**
+ * Minimal HTTP client interface for billing operations.
+ */
+interface HTTPClientLike {
+    json<T>(path: string, options: {
+        method: string;
+        body?: unknown;
+        accessToken?: string;
+    }): Promise<T>;
+}
+/**
+ * Client for customer billing self-service operations.
+ *
+ * These endpoints require a customer bearer token (from device flow or OIDC exchange).
+ * API keys are not accepted.
+ *
+ * @example
+ * ```typescript
+ * import { ModelRelay } from "@modelrelay/sdk";
+ * import { BillingClient } from "@modelrelay/sdk/billing";
+ *
+ * const client = new ModelRelay({ token: customerToken });
+ * const billing = new BillingClient(client.http);
+ *
+ * const me = await billing.me();
+ * const usage = await billing.usage();
+ * const subscription = await billing.subscription();
+ * ```
+ */
+declare class BillingClient {
+    private readonly http;
+    private readonly accessToken?;
+    constructor(http: HTTPClientLike, accessToken?: string);
+    /**
+     * Get the authenticated customer's profile.
+     *
+     * Returns customer details including ID, email, external ID, and metadata.
+     *
+     * @returns Customer profile with optional subscription and tier
+     */
+    me(): Promise<CustomerMe>;
+    /**
+     * Get the authenticated customer's subscription details.
+     *
+     * Returns subscription status, tier information, and billing provider.
+     *
+     * @returns Subscription details
+     */
+    subscription(): Promise<CustomerMeSubscription>;
+    /**
+     * Get the authenticated customer's usage metrics.
+     *
+     * Returns token usage, request counts, and cost for the current billing window.
+     *
+     * @returns Usage metrics
+     */
+    usage(): Promise<CustomerMeUsage>;
+    /**
+     * Get the authenticated customer's credit balance.
+     *
+     * For PAYGO (pay-as-you-go) subscriptions, returns the current balance
+     * and reserved amount.
+     *
+     * @returns Balance information
+     */
+    balance(): Promise<CustomerBalanceResponse>;
+    /**
+     * Get the authenticated customer's balance transaction history.
+     *
+     * Returns a list of ledger entries showing credits and debits.
+     *
+     * @returns Ledger entries
+     */
+    balanceHistory(): Promise<CustomerLedgerResponse>;
+    /**
+     * Create a top-up checkout session.
+     *
+     * For PAYGO subscriptions, creates a Stripe Checkout session to add credits.
+     *
+     * @param request - Top-up request with amount and redirect URLs
+     * @returns Checkout session with redirect URL
+     */
+    topup(request: CustomerTopupRequest): Promise<CustomerTopupResponse>;
+    /**
+     * Change the authenticated customer's subscription tier.
+     *
+     * Switches to a different tier within the same project.
+     *
+     * @param tierCode - The tier code to switch to
+     * @returns Updated subscription details
+     */
+    changeTier(tierCode: string): Promise<CustomerMeSubscription>;
+    /**
+     * Create a subscription checkout session.
+     *
+     * Creates a Stripe Checkout session for subscribing to a tier.
+     *
+     * @param request - Checkout request with tier and redirect URLs
+     * @returns Checkout session with redirect URL
+     */
+    checkout(request: CustomerMeCheckoutRequest): Promise<CheckoutSessionResponse>;
+}
+
+export { BillingClient, type ChangeTierRequest, type CheckoutSessionResponse, type CustomerBalanceResponse, type CustomerLedgerEntry, type CustomerLedgerResponse, type CustomerMe, type CustomerMeCheckoutRequest, type CustomerMeSubscription, type CustomerMeUsage, type CustomerTopupRequest, type CustomerTopupResponse };

package/dist/billing/index.js

@@ -0,0 +1,128 @@
+import "../chunk-MLKGABMK.js";
+
+// src/billing/index.ts
+var BillingClient = class {
+  constructor(http, accessToken) {
+    this.http = http;
+    this.accessToken = accessToken;
+  }
+  /**
+   * Get the authenticated customer's profile.
+   *
+   * Returns customer details including ID, email, external ID, and metadata.
+   *
+   * @returns Customer profile with optional subscription and tier
+   */
+  async me() {
+    const response = await this.http.json("/customers/me", {
+      method: "GET",
+      accessToken: this.accessToken
+    });
+    return response.customer;
+  }
+  /**
+   * Get the authenticated customer's subscription details.
+   *
+   * Returns subscription status, tier information, and billing provider.
+   *
+   * @returns Subscription details
+   */
+  async subscription() {
+    const response = await this.http.json("/customers/me/subscription", {
+      method: "GET",
+      accessToken: this.accessToken
+    });
+    return response.subscription;
+  }
+  /**
+   * Get the authenticated customer's usage metrics.
+   *
+   * Returns token usage, request counts, and cost for the current billing window.
+   *
+   * @returns Usage metrics
+   */
+  async usage() {
+    const response = await this.http.json("/customers/me/usage", {
+      method: "GET",
+      accessToken: this.accessToken
+    });
+    return response.usage;
+  }
+  /**
+   * Get the authenticated customer's credit balance.
+   *
+   * For PAYGO (pay-as-you-go) subscriptions, returns the current balance
+   * and reserved amount.
+   *
+   * @returns Balance information
+   */
+  async balance() {
+    return await this.http.json("/customers/me/balance", {
+      method: "GET",
+      accessToken: this.accessToken
+    });
+  }
+  /**
+   * Get the authenticated customer's balance transaction history.
+   *
+   * Returns a list of ledger entries showing credits and debits.
+   *
+   * @returns Ledger entries
+   */
+  async balanceHistory() {
+    return await this.http.json("/customers/me/balance/history", {
+      method: "GET",
+      accessToken: this.accessToken
+    });
+  }
+  /**
+   * Create a top-up checkout session.
+   *
+   * For PAYGO subscriptions, creates a Stripe Checkout session to add credits.
+   *
+   * @param request - Top-up request with amount and redirect URLs
+   * @returns Checkout session with redirect URL
+   */
+  async topup(request) {
+    return await this.http.json("/customers/me/topup", {
+      method: "POST",
+      body: request,
+      accessToken: this.accessToken
+    });
+  }
+  /**
+   * Change the authenticated customer's subscription tier.
+   *
+   * Switches to a different tier within the same project.
+   *
+   * @param tierCode - The tier code to switch to
+   * @returns Updated subscription details
+   */
+  async changeTier(tierCode) {
+    const request = { tier_code: tierCode };
+    const response = await this.http.json("/customers/me/change-tier", {
+      method: "POST",
+      body: request,
+      accessToken: this.accessToken
+    });
+    return response.subscription;
+  }
+  /**
+   * Create a subscription checkout session.
+   *
+   * Creates a Stripe Checkout session for subscribing to a tier.
+   *
+   * @param request - Checkout request with tier and redirect URLs
+   * @returns Checkout session with redirect URL
+   */
+  async checkout(request) {
+    return await this.http.json("/customers/me/checkout", {
+      method: "POST",
+      body: request,
+      accessToken: this.accessToken
+    });
+  }
+};
+export {
+  BillingClient
+};