@vellumcharter/sdk 0.6.0 → 0.7.0

package/dist/index.d.ts

@@ -86,16 +86,46 @@ export interface CreateCustomerParams {
     customerId: string;
     email?: string;
 }
+/** One pack to buy in a multi-denomination cart. */
+export interface CreditCheckoutItem {
+    creditTypeId: string;
+    packId: string;
+    /** How many of this pack to buy (default 1); grants grantQty × quantity. */
+    quantity?: number;
+}
 export interface CreditCheckoutParams {
     accountId: string;
     customerId: string;
-    creditTypeId: string;
-    packId: string;
-    /** How many packs to buy at once (default 1); grants grantQty × quantity. */
+    /**
+     * Single-pack form: the pack to buy. Ignored when `items` is given. Use this
+     * or `items`, not both.
+     */
+    creditTypeId?: string;
+    packId?: string;
+    /** Single-pack form: how many packs to buy at once (default 1). */
     quantity?: number;
+    /**
+     * Multi-denomination form: buy several packs (denominations and credit types
+     * may be mixed) in one Checkout. Takes precedence over the single-pack fields.
+     */
+    items?: CreditCheckoutItem[];
     successUrl: string;
     cancelUrl: string;
 }
+export interface CreditType {
+    creditTypeId: string;
+    name: string;
+}
+export interface CreditPack {
+    creditTypeId: string;
+    packId: string;
+    name: string;
+    /** Credits granted per unit purchased. */
+    grantQty: number;
+    /** Price in the currency's minor units (e.g. cents). */
+    amount?: number;
+    currency?: string;
+}
 export interface CreditBalance {
     creditTypeId: string;
     balance: number;
@@ -220,10 +250,18 @@ export declare class VellumCharterClient {
     listInvoices(accountId: string, customerId?: string): Promise<Invoice[]>;
     /** Resolve the hosted-PDF URL for an invoice (follows the 302 `Location`). */
     invoicePdfUrl(accountId: string, invoiceId: string): Promise<string>;
-    /** Create a one-time Checkout session to buy a credit pack for a customer. */
+    /**
+     * Create a one-time Checkout session to buy credit packs for a customer. Pass a
+     * single `creditTypeId` + `packId` (+ optional `quantity`), or `items` to buy
+     * several packs at once (multi-denomination; types may be mixed).
+     */
     createCreditCheckout(params: CreditCheckoutParams): Promise<{
         url: string;
     }>;
+    /** The tenant's credit types (the catalog of what can be bought). */
+    listCreditTypes(): Promise<CreditType[]>;
+    /** The packs (denominations) for sale within a credit type, with grant size + price. */
+    listCreditPacks(creditTypeId: string): Promise<CreditPack[]>;
     /** All of a customer's prepaid credit balances. */
     listCredits(customerId: string): Promise<CreditBalance[]>;
     /** One credit balance (0 if the customer has never bought this type). */

package/dist/index.js

@@ -204,7 +204,11 @@ class VellumCharterClient {
     // Prepaid one-time-use credits. Uncached (a balance changes out-of-band via
     // purchase/consume, unlike getEntitlements). consume is idempotent on the
     // caller-supplied key and all-or-nothing.
-    /** Create a one-time Checkout session to buy a credit pack for a customer. */
+    /**
+     * Create a one-time Checkout session to buy credit packs for a customer. Pass a
+     * single `creditTypeId` + `packId` (+ optional `quantity`), or `items` to buy
+     * several packs at once (multi-denomination; types may be mixed).
+     */
     async createCreditCheckout(params) {
         const { accountId, ...body } = params;
         const res = await this.billingFetch(`/accounts/${enc(accountId)}/credit-checkout`, {
@@ -213,6 +217,16 @@ class VellumCharterClient {
         });
         return this.parse(res);
     }
+    /** The tenant's credit types (the catalog of what can be bought). */
+    async listCreditTypes() {
+        const res = await this.billingFetch('/credit-types');
+        return (await this.parse(res)).creditTypes;
+    }
+    /** The packs (denominations) for sale within a credit type, with grant size + price. */
+    async listCreditPacks(creditTypeId) {
+        const res = await this.billingFetch(`/credit-types/${enc(creditTypeId)}/packs`);
+        return (await this.parse(res)).packs;
+    }
     /** All of a customer's prepaid credit balances. */
     async listCredits(customerId) {
         const res = await this.billingFetch(`/customers/${enc(customerId)}/credits`);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@vellumcharter/sdk",
-  "version": "0.6.0",
+  "version": "0.7.0",
   "description": "Thin HTTP client for the VellumCharter entitlements + billing API",
   "license": "MIT",
   "author": "Todd Esposito",