@boelabs/billete-sdk 0.3.0

package/dist/errors-oT7VMFhd.d.ts

@@ -0,0 +1,450 @@
+import { Et as Timestamp, F as PaymentStatus, M as PaymentFailure, Q as SubmitLabel, St as Metadata, T as FeatureReset, Tt as TaxBehavior, U as QuantitySettings, V as ProductCategory, ct as ApiErrorType, d as CheckoutItem, f as CheckoutPurpose, ft as AddressInput, g as CustomField, gt as Currency, jt as Environment, mt as BillingMonths, o as AfterCompletion, ot as ApiErrorBody, p as CollectSettings, r as EventType, v as CustomerDetails, vt as GracePeriodDays, z as PlanPrice } from "./events-BJuSt_4W.js";
+//#region ../contracts/src/client.d.ts
+/** Browser-safe view of a checkout: everything needed to render and pay it, nothing internal. */
+interface PublicCheckout {
+  id: string;
+  object: "checkout";
+  environment: Environment;
+  status: "open" | "completed" | "expired";
+  purpose: CheckoutPurpose;
+  merchant: {
+    name: string;
+    supportEmail: string | null;
+    supportPhone: string | null;
+  };
+  email: string | null;
+  items: CheckoutItem[];
+  currency: Currency;
+  subtotal: number;
+  discount: number;
+  tax: number;
+  total: number;
+  taxBehavior: TaxBehavior;
+  trialDays: number | null;
+  couponCode: string | null;
+  allowCoupons: boolean;
+  /** Present when the customer may change the quantity of the single item. */
+  quantity: QuantitySettings | null;
+  /** Billing cycles the customer may switch between for a plan checkout. */
+  cycles: Array<{
+    months: BillingMonths;
+    amount: number;
+  }> | null;
+  collect: CollectSettings;
+  customFields: CustomField[];
+  customerDetails: CustomerDetails;
+  submitLabel: SubmitLabel;
+  afterCompletion: AfterCompletion;
+  successUrl: string | null;
+  expiresAt: Timestamp;
+  payment: {
+    id: string;
+    status: PaymentStatus;
+    method: string | null;
+    failure: PaymentFailure | null;
+  } | null;
+}
+interface PaymentMethodField {
+  key: string;
+  label: string;
+  type: "text" | "tel" | "date" | "select";
+  required: boolean;
+  placeholder: string | null;
+  options: Array<{
+    value: string;
+    label: string;
+  }> | null;
+}
+/** Where the payer must send the money before confirming (e.g. the Pago Móvil beneficiary). */
+interface PaymentInstructions {
+  type: "transfer";
+  recipient: {
+    name: string | null;
+    taxId: string | null;
+    phone: string | null;
+    bankCode: string | null;
+    bankName: string | null;
+    accountNumber: string | null;
+  };
+  notes: string | null;
+}
+/** Deterministic inputs that trigger each outcome in the test environment. */
+interface PaymentTestScenario {
+  outcome: "succeeded" | "failed" | "pending";
+  description: string;
+  fields: Record<string, string>;
+}
+interface CheckoutPaymentMethod {
+  id: string;
+  name: string;
+  description: string | null;
+  /** Amount the payer must send, in the currency the method charges. */
+  amount: number;
+  currency: Currency;
+  exchangeRate: string | null;
+  fields: PaymentMethodField[];
+  instructions: PaymentInstructions | null;
+  testScenarios: PaymentTestScenario[] | null;
+}
+/** Browser-safe view of a payment link, used to render its page before a checkout exists. */
+interface PublicPaymentLink {
+  id: string;
+  object: "payment_link";
+  retired: boolean;
+  environment: Environment;
+  type: "product" | "plan";
+  /** `false` when the link was deactivated or reached its payment limit. */
+  available: boolean;
+  merchant: {
+    name: string;
+    supportEmail: string | null;
+    supportPhone: string | null;
+  };
+  product: {
+    name: string;
+    description: string | null;
+    imageUrl: string | null;
+    category: ProductCategory;
+    currency: Currency;
+    amount: number | null;
+    stock: number | null;
+    variants: Array<{
+      id: string;
+      name: string;
+      attributes: Record<string, string>;
+      amount: number;
+      stock: number | null;
+      isDefault: boolean;
+    }>;
+  } | null;
+  plan: {
+    name: string;
+    description: string | null;
+    highlights: string[];
+    currency: Currency;
+    trialDays: number;
+    cycles: PlanPrice[];
+  } | null;
+  quantity: QuantitySettings | null;
+  collect: CollectSettings;
+  customFields: CustomField[];
+  allowCoupons: boolean;
+  submitLabel: SubmitLabel;
+}
+//#endregion
+//#region ../contracts/src/inputs.d.ts
+/** Identifiers merchants choose and use in code: `ai_tokens`, `export-pdf`. */
+declare const KEY_PATTERN: RegExp;
+interface CustomerCreate {
+  email: string;
+  name?: string;
+  phone?: string;
+  externalId?: string;
+  address?: AddressInput;
+  metadata?: Metadata;
+}
+interface CustomerUpdate {
+  email?: string;
+  name?: string | null;
+  phone?: string | null;
+  externalId?: string | null;
+  address?: AddressInput | null;
+  metadata?: Metadata;
+}
+/** An existing customer (`cus_…` or your `externalId`), or one to create or update on the fly. */
+type CustomerInput = string | CustomerCreate;
+interface RetireInput {
+  reason?: string;
+}
+interface VariantInput {
+  /** Set to update a saved variant; omit to create one. */
+  id?: string;
+  name: string;
+  /** Free-form descriptors such as `{ color: "Rojo", talla: "M" }`. */
+  attributes?: Record<string, string>;
+  amount: number;
+  /** `null` or omitted means unlimited. */
+  stock?: number | null;
+  isDefault?: boolean;
+  active?: boolean;
+}
+interface ProductCreate {
+  name: string;
+  description?: string;
+  imageUrl?: string;
+  category?: ProductCategory;
+  currency: Currency;
+  /** Required without variants; with variants, each variant has its price. */
+  amount?: number | null;
+  stock?: number | null;
+  taxBehavior?: TaxBehavior;
+  variants?: VariantInput[];
+  metadata?: Metadata;
+}
+interface ProductUpdate {
+  name?: string;
+  description?: string | null;
+  imageUrl?: string | null;
+  category?: ProductCategory;
+  currency?: Currency;
+  amount?: number | null;
+  stock?: number | null;
+  taxBehavior?: TaxBehavior;
+  /**
+   * Updates existing variants and creates new ones. Retire saved variants explicitly before
+   * omitting them.
+   */
+  variants?: VariantInput[];
+  active?: boolean;
+  metadata?: Metadata;
+}
+type FeatureCreate = {
+  key: string;
+  name: string;
+  type: "boolean";
+} | {
+  key: string;
+  name: string;
+  type: "metered";
+  unit?: string;
+  reset: FeatureReset;
+} | {
+  key: string;
+  name: string;
+  type: "count";
+  unit?: string;
+} | {
+  key: string;
+  name: string;
+  type: "number";
+  unit?: string;
+};
+/**
+ * The key and type are fixed once created (code and usage depend on them). Changing `reset`
+ * (only `metered`) starts a new usage period now.
+ */
+interface FeatureUpdate {
+  name?: string;
+  unit?: string | null;
+  reset?: FeatureReset;
+}
+/** A grant per feature key: see `PlanFeatureValues`. */
+type PlanFeaturesInput = Record<string, boolean | number | null>;
+interface PlanPriceInput {
+  months: BillingMonths;
+  amount: number;
+}
+interface PlanCreate {
+  name: string;
+  description?: string;
+  currency: Currency;
+  prices: PlanPriceInput[];
+  trialDays?: number;
+  gracePeriodDays?: GracePeriodDays;
+  taxBehavior?: TaxBehavior;
+  highlights?: string[];
+  features?: PlanFeaturesInput;
+  metadata?: Metadata;
+}
+interface PlanUpdate {
+  name?: string;
+  description?: string | null;
+  /** New prices apply to new subscriptions; existing ones keep the price they signed up with. */
+  prices?: PlanPriceInput[];
+  trialDays?: number;
+  gracePeriodDays?: GracePeriodDays;
+  taxBehavior?: TaxBehavior;
+  highlights?: string[];
+  /** Replaces the plan feature grants. Takes effect immediately for every subscriber. */
+  features?: PlanFeaturesInput;
+  active?: boolean;
+  metadata?: Metadata;
+}
+interface SubscriptionCreate {
+  customer: CustomerInput;
+  plan: string;
+  months: BillingMonths;
+  /** Defaults to the plan trial. A subscription created through the API always starts in trial. */
+  trialDays?: number;
+  metadata?: Metadata;
+}
+interface SubscriptionUpdate {
+  plan?: string;
+  months?: BillingMonths;
+  metadata?: Metadata;
+}
+interface SubscriptionCancel {
+  /** `false` ends the subscription immediately. */
+  atPeriodEnd?: boolean;
+}
+/** Exactly one of `percentOff` and `amountOff`; `amountOff` needs a `currency`. */
+interface CouponCreate {
+  code: string;
+  name?: string;
+  percentOff?: number;
+  amountOff?: number;
+  currency?: Currency;
+  duration?: "once" | "forever";
+  appliesTo?: "all" | "products" | "plans";
+  maxRedemptions?: number;
+  expiresAt?: string;
+}
+interface CouponUpdate {
+  name?: string | null;
+  active?: boolean;
+  maxRedemptions?: number | null;
+  expiresAt?: string | null;
+}
+interface CollectInput {
+  name?: boolean;
+  phone?: boolean;
+  address?: boolean;
+}
+interface CustomFieldInput {
+  key: string;
+  label: string;
+  type: "text" | "number" | "select";
+  required?: boolean;
+  /** Only, and required, for `select`. */
+  options?: string[];
+}
+type AfterCompletionInput = {
+  type: "message";
+  message?: string;
+} | {
+  type: "redirect";
+  url: string;
+};
+interface QuantityInput {
+  adjustable?: boolean;
+  min?: number;
+  max?: number;
+}
+interface PaymentLinkFields {
+  collect?: CollectInput;
+  customFields?: CustomFieldInput[];
+  allowCoupons?: boolean;
+  submitLabel?: SubmitLabel;
+  afterCompletion?: AfterCompletionInput;
+  maxPayments?: number;
+  metadata?: Metadata;
+}
+interface ProductLinkCreate extends PaymentLinkFields {
+  type: "product";
+  product: string;
+  variants?: string[];
+  quantity?: QuantityInput;
+}
+interface PlanLinkCreate extends PaymentLinkFields {
+  type: "plan";
+  plan: string;
+  months?: BillingMonths[];
+}
+type PaymentLinkCreate = ProductLinkCreate | PlanLinkCreate;
+interface PaymentLinkUpdate {
+  collect?: CollectInput;
+  customFields?: CustomFieldInput[];
+  allowCoupons?: boolean;
+  submitLabel?: SubmitLabel;
+  afterCompletion?: AfterCompletionInput;
+  maxPayments?: number | null;
+  active?: boolean;
+  metadata?: Metadata;
+}
+interface CheckoutFields {
+  customer?: CustomerInput;
+  coupon?: string;
+  collect?: CollectInput;
+  successUrl?: string;
+  expiresInMinutes?: number;
+  metadata?: Metadata;
+}
+interface CheckoutItemInput {
+  product: string;
+  variant?: string;
+  quantity?: number;
+}
+interface ProductCheckoutCreate extends CheckoutFields {
+  items: CheckoutItemInput[];
+}
+interface PlanCheckoutCreate extends CheckoutFields {
+  plan: string;
+  months: BillingMonths;
+}
+type CheckoutCreate = ProductCheckoutCreate | PlanCheckoutCreate;
+interface ClientLinkCheckout {
+  variant?: string;
+  quantity?: number;
+  months?: BillingMonths;
+  coupon?: string;
+}
+interface RefundCreate {
+  /** Defaults to the remaining refundable amount, in the settlement currency. */
+  amount?: number;
+  reason?: string;
+}
+/** An event type, or `*` for every event. */
+type EventSelector = "*" | EventType;
+interface WebhookEndpointCreate {
+  url: string;
+  events: EventSelector[];
+}
+interface WebhookEndpointUpdate {
+  url?: string;
+  events?: EventSelector[];
+  enabled?: boolean;
+}
+interface CustomerSessionCreate {
+  customer: string;
+  expiresInMinutes?: number;
+}
+interface ClientCheckoutUpdate {
+  quantity?: number;
+  variant?: string;
+  months?: BillingMonths;
+  /** `null` removes the applied coupon. */
+  coupon?: string | null;
+}
+interface ClientCheckoutPay {
+  /** Omit only when the checkout total is 0 (free trial, full discount). */
+  method?: string;
+  fields?: Record<string, string>;
+  email?: string;
+  name?: string;
+  phone?: string;
+  address?: AddressInput;
+  customFields?: Record<string, string | number>;
+}
+//#endregion
+//#region src/http.d.ts
+interface TransportOptions {
+  /** Defaults to `BILLETE_BASE_URL` on the server, then `https://api.billete.run`. Use
+   * `http://localhost:9999` in development. */
+  baseUrl?: string;
+  /** Custom fetch (tests, proxies). Defaults to the global fetch. */
+  fetch?: typeof globalThis.fetch;
+  timeoutMs?: number;
+  /** Retries for network errors, 429, 5xx and in-progress duplicates. Mutations retry safely. */
+  maxRetries?: number;
+}
+interface RequestOptions {
+  /** Reuse to make a mutation safe to retry; generated automatically when omitted. */
+  idempotencyKey?: string;
+  signal?: AbortSignal;
+}
+//#endregion
+//#region src/errors.d.ts
+/** Any failed Billete request. `type`/`code` are stable and safe to branch on. */
+declare class BilleteError extends Error {
+  readonly type: ApiErrorType | "network";
+  readonly code: string;
+  readonly status: number;
+  readonly param?: string;
+  readonly requestId?: string;
+  constructor(body: Omit<ApiErrorBody, "type"> & {
+    type: ApiErrorType | "network";
+  }, status: number);
+}
+//#endregion
+export { ProductCheckoutCreate as A, VariantInput as B, PaymentLinkUpdate as C, PlanLinkCreate as D, PlanFeaturesInput as E, RefundCreate as F, PaymentMethodField as G, WebhookEndpointUpdate as H, RetireInput as I, PublicPaymentLink as J, PaymentTestScenario as K, SubscriptionCancel as L, ProductLinkCreate as M, ProductUpdate as N, PlanPriceInput as O, QuantityInput as P, SubscriptionCreate as R, PaymentLinkCreate as S, PlanCreate as T, CheckoutPaymentMethod as U, WebhookEndpointCreate as V, PaymentInstructions as W, CustomerUpdate as _, CheckoutCreate as a, FeatureUpdate as b, ClientCheckoutUpdate as c, CouponCreate as d, CouponUpdate as f, CustomerSessionCreate as g, CustomerInput as h, AfterCompletionInput as i, ProductCreate as j, PlanUpdate as k, ClientLinkCheckout as l, CustomerCreate as m, RequestOptions as n, CheckoutItemInput as o, CustomFieldInput as p, PublicCheckout as q, TransportOptions as r, ClientCheckoutPay as s, BilleteError as t, CollectInput as u, EventSelector as v, PlanCheckoutCreate as w, KEY_PATTERN as x, FeatureCreate as y, SubscriptionUpdate as z };
+//# sourceMappingURL=errors-oT7VMFhd.d.ts.map