@fonderie/client 0.12.0 → 0.14.0

package/brain/signatures.md

@@ -183,12 +183,21 @@ new BillingClient(http: HttpClient, tokens: TokenStore): BillingClient
   .updatePlan(planId: string, input: Partial<ICreatePlanInput>): Promise<IApiResponse<IPlanResult>>
   .deletePlan(planId: string): Promise<IApiResponse<undefined>>
   .getSubscription(opts?: IReadOptions | undefined): Promise<IApiResponse<ISubscriptionResult>>
+  .cancelSubscription(input?: ICancelSubscriptionInput | undefined): Promise<IApiResponse<ISubscriptionChangeResult>>
+  .reactivateSubscription(): Promise<IApiResponse<ISubscriptionChangeResult>>
   .createCheckoutSession(input: ICheckoutInput): Promise<IApiResponse<ICheckoutUrlResult>>
   .createPortalSession(): Promise<IApiResponse<IPortalUrlResult>>
   .recordUsage(input: IRecordUsageInput): Promise<IApiResponse<undefined>>
   .getUsage(metric: string, opts?: IReadOptions | undefined): Promise<IApiResponse<IUsageResult>>
   .getWallet(opts?: IReadOptions | undefined): Promise<IApiResponse<IWalletResult>>
   .setWalletPreferences(input: IWalletPreferencesInput): Promise<IApiResponse<IWalletResult>>
+  .createWalletCheckout(input: IWalletCheckoutInput): Promise<IApiResponse<ICheckoutUrlResult>>
+  .getWalletTransactions(opts?: (IReadOptions & { cursor?: string; limit?: number; }) | undefined): Promise<IApiResponse<IWalletTransactionsResult>>
+  .getPaymentMethod(opts?: IReadOptions | undefined): Promise<IApiResponse<IPaymentMethodResult>>
+  .setupPaymentMethod(): Promise<IApiResponse<ISetupIntentResult>>
+  .savePaymentMethod(input: ISavePaymentMethodInput): Promise<IApiResponse<IPaymentMethodResult>>
+  .removePaymentMethod(): Promise<IApiResponse<IPaymentMethodResult>>
+  .listInvoices(opts?: IReadOptions | undefined): Promise<IApiResponse<IInvoicesResult>>
 
 interface IConfigAdminClientOptions {
     baseUrl: string;
@@ -516,6 +525,10 @@ interface IAuditPageResult {
     nextCursor: string | null;
 }
 
+interface ICancelSubscriptionInput {
+    atPeriodEnd?: boolean;
+}
+
 interface ICheckoutUrlResult {
     url: string;
 }
@@ -722,6 +735,22 @@ interface IInviteResult {
     }>;
 }
 
+interface IInvoiceDTO {
+    id: string;
+    number: string | null;
+    amountDue: string;
+    amountPaid: string;
+    currency: string;
+    status: string;
+    created: string;
+    hostedInvoiceUrl: string | null;
+    invoicePdf: string | null;
+}
+
+interface IInvoicesResult {
+    invoices: IInvoiceDTO[];
+}
+
 interface ILoginResult {
     tokens: ITokens;
     user: IUserDTO;
@@ -762,6 +791,17 @@ interface IMfaSetupResult {
     backupCodes: string[];
 }
 
+interface IPaymentMethodDTO {
+    brand: string;
+    last4: string;
+    expMonth: number;
+    expYear: number;
+}
+
+interface IPaymentMethodResult {
+    paymentMethod: IPaymentMethodDTO | null;
+}
+
 interface IPlanDTO {
     id: string;
     planId: string;
@@ -857,6 +897,12 @@ interface ISecretRevision {
     createdAt: string;
 }
 
+interface ISubscriptionChangeResult {
+    atPeriodEnd: boolean;
+    status: string;
+    currentPeriodEnd: string | null;
+}
+
 interface ISubscriptionDTO {
     id: string;
     subscriberType: SubscriberType;
@@ -954,6 +1000,10 @@ interface IVerifyEmailResult {
     email: string;
 }
 
+interface IWalletCheckoutInput {
+    packId: string;
+}
+
 interface IWalletDTO {
     balance: string;
     currency: string;
@@ -968,6 +1018,23 @@ interface IWalletResult {
     wallet: IWalletDTO;
 }
 
+interface IWalletTransactionDTO {
+    id: string;
+    type: string;
+    amount: string;
+    balanceAfter: string;
+    currency: string;
+    description: string | null;
+    providerTxId: string | null;
+    metadata: Record<string, unknown>;
+    createdAt: string;
+}
+
+interface IWalletTransactionsResult {
+    transactions: IWalletTransactionDTO[];
+    nextCursor: string | null;
+}
+
 interface IWebhookDeliveryDTO {
     id: string;
     eventId: string;

package/dist/index.cjs

@@ -456,6 +456,28 @@ var BillingClient = class {
       bust: opts?.bust
     });
   }
+  // First-party cancel — no portal round-trip. Default keeps access until the
+  // paid-through date; pass { atPeriodEnd: false } to end it immediately. 501
+  // when the provider has no first-party cancel (the portal remains a fallback).
+  cancelSubscription(input) {
+    return this.http.request({
+      method: "POST",
+      path: "/billing/subscription/cancel",
+      body: input ?? {},
+      token: this.tokens.get(),
+      workspaceId: this.workspaceId
+    });
+  }
+  // Un-cancel a subscription scheduled to cancel at period end. Idempotent; 409
+  // when the subscription is already fully canceled (start a new checkout).
+  reactivateSubscription() {
+    return this.http.request({
+      method: "POST",
+      path: "/billing/subscription/reactivate",
+      token: this.tokens.get(),
+      workspaceId: this.workspaceId
+    });
+  }
   // ── Checkout / portal ────────────────────────────────────────────────────────
   createCheckoutSession(input) {
     return this.http.request({
@@ -512,6 +534,86 @@ var BillingClient = class {
       workspaceId: this.workspaceId
     });
   }
+  // Start a one-time credit-pack purchase. Returns a hosted checkout URL to
+  // redirect the buyer to; the wallet is credited by the payment webhook.
+  createWalletCheckout(input) {
+    return this.http.request({
+      method: "POST",
+      path: "/billing/wallet/checkout",
+      body: input,
+      token: this.tokens.get(),
+      workspaceId: this.workspaceId
+    });
+  }
+  // The wallet ledger, newest first — every credit/debit with a running
+  // balanceAfter. Cursor-paginated: pass the previous result's `nextCursor`.
+  getWalletTransactions(opts) {
+    const params = new URLSearchParams();
+    if (opts?.cursor) params.set("cursor", opts.cursor);
+    if (opts?.limit !== void 0) params.set("limit", String(opts.limit));
+    const qs = params.toString();
+    return this.http.request({
+      method: "GET",
+      path: `/billing/wallet/transactions${qs ? "?" + qs : ""}`,
+      token: this.tokens.get(),
+      workspaceId: this.workspaceId,
+      bust: opts?.bust
+    });
+  }
+  // ── Account ──────────────────────────────────────────────────────────────────
+  // The customer's card on file (brand/last4/expiry), or { paymentMethod: null }
+  // when none is stored. 501 when the provider can't retrieve it.
+  getPaymentMethod(opts) {
+    return this.http.request({
+      method: "GET",
+      path: "/billing/payment-method",
+      token: this.tokens.get(),
+      workspaceId: this.workspaceId,
+      bust: opts?.bust
+    });
+  }
+  // Begin in-app card entry — returns a SetupIntent client secret for the
+  // provider's embedded card element (Stripe Payment Element); the user never
+  // leaves the site. 501 when the provider has no in-app card support.
+  setupPaymentMethod() {
+    return this.http.request({
+      method: "POST",
+      path: "/billing/payment-method/setup",
+      token: this.tokens.get(),
+      workspaceId: this.workspaceId
+    });
+  }
+  // Save the card after the client confirms the SetupIntent: makes it the
+  // default and records it. 422 when the card isn't attached to this customer.
+  savePaymentMethod(input) {
+    return this.http.request({
+      method: "PUT",
+      path: "/billing/payment-method",
+      body: input,
+      token: this.tokens.get(),
+      workspaceId: this.workspaceId
+    });
+  }
+  // Remove the saved card (detach at the provider + clear the record).
+  removePaymentMethod() {
+    return this.http.request({
+      method: "DELETE",
+      path: "/billing/payment-method",
+      token: this.tokens.get(),
+      workspaceId: this.workspaceId
+    });
+  }
+  // The customer's invoices, newest first — each links out to the hosted
+  // invoice / PDF. 501 when the provider can't list them.
+  listInvoices(opts) {
+    return this.http.request({
+      method: "GET",
+      path: "/billing/invoices",
+      token: this.tokens.get(),
+      workspaceId: this.workspaceId,
+      bust: opts?.bust
+    });
+  }
 };
 
 // src/modules/customers.ts