@peable.to/sdk 0.2.7 → 0.3.0

package/dist/cjs/index.js

@@ -1,7 +1,10 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.ContributionsResource = exports.WebhooksResource = exports.WEBHOOK_SIGNATURE_HEADER = exports.PeableSignatureVerificationError = exports.PeableApiError = exports.PeablePermissionError = exports.PeableInvalidRequestError = exports.PeableAuthenticationError = exports.PeableError = exports.DEFAULT_OXY_API_URL = exports.DEFAULT_GATEWAY_BASE_URL = exports.Peable = void 0;
+exports.ContributionsResource = exports.WebhooksResource = exports.WEBHOOK_SIGNATURE_HEADER = exports.PeableSignatureVerificationError = exports.PeableApiError = exports.PeablePermissionError = exports.PeableInvalidRequestError = exports.PeableAuthenticationError = exports.PeableError = exports.DEFAULT_OXY_API_URL = exports.DEFAULT_GATEWAY_BASE_URL = exports.Peable = exports.PEABLE_BILLING_AUTHORITY_KEYS = void 0;
 const billing_1 = require("./resources/billing");
+/** Production Peable's pinned billing-authority public keys, by key id. */
+var shared_types_1 = require("@peable.to/shared-types");
+Object.defineProperty(exports, "PEABLE_BILLING_AUTHORITY_KEYS", { enumerable: true, get: function () { return shared_types_1.PEABLE_BILLING_AUTHORITY_KEYS; } });
 // Server entry (`@peable.to/sdk`) — the merchant-authed SDK. Configured with a
 // confidential `ApplicationCredential` (`{publicKey, secret}`), from which it
 // mints and caches an Oxy service token, or with a caller-supplied

package/dist/cjs/resources/billing.js

@@ -10,6 +10,13 @@ class BillingResource {
         this.invoiceAuthorityKeys = invoiceAuthorityKeys;
         this.taxQuoteAuthorityKeys = taxQuoteAuthorityKeys;
     }
+    /** The rails this merchant's payers can choose between (card and other fiat
+     * providers, FairCoin), default first, with each rail's offers. Pass the
+     * payer's choice as `rail` to `ensureCustomer`; the customer's rail then
+     * carries its checkouts, subscriptions and invoices. */
+    listRails() {
+        return this.client.request('GET', '/v1/billing/rails');
+    }
     ensureCustomer(params, options) {
         return this.client.request('POST', '/v1/billing/customers', {
             body: params,

package/dist/esm/index.js

@@ -1,4 +1,6 @@
 import { BillingResource } from './resources/billing.js';
+/** Production Peable's pinned billing-authority public keys, by key id. */
+export { PEABLE_BILLING_AUTHORITY_KEYS } from '@peable.to/shared-types';
 // Server entry (`@peable.to/sdk`) — the merchant-authed SDK. Configured with a
 // confidential `ApplicationCredential` (`{publicKey, secret}`), from which it
 // mints and caches an Oxy service token, or with a caller-supplied

package/dist/esm/resources/billing.js

@@ -7,6 +7,13 @@ export class BillingResource {
         this.invoiceAuthorityKeys = invoiceAuthorityKeys;
         this.taxQuoteAuthorityKeys = taxQuoteAuthorityKeys;
     }
+    /** The rails this merchant's payers can choose between (card and other fiat
+     * providers, FairCoin), default first, with each rail's offers. Pass the
+     * payer's choice as `rail` to `ensureCustomer`; the customer's rail then
+     * carries its checkouts, subscriptions and invoices. */
+    listRails() {
+        return this.client.request('GET', '/v1/billing/rails');
+    }
     ensureCustomer(params, options) {
         return this.client.request('POST', '/v1/billing/customers', {
             body: params,

package/dist/types/index.d.ts

@@ -1,6 +1,8 @@
 import { BillingResource } from './resources/billing';
 export type { BillingRequestOptions } from './resources/billing';
-export type { CreateBillingTaxQuoteParams, BillingTaxQuote, BillingInvoiceAuthoritySource, BillingFinalInvoice, BillingFinalInvoiceAuthority, BillingFaircoinRenewalChoice, BillingFaircoinRenewalConsent, BillingFaircoinRenewalRevocation, BillingObservation, BillingCustomer, BillingHostedSession, BillingCheckoutSession, BillingCheckoutObservation, RetrieveBillingCheckoutOperationParams, BillingCheckoutOperationSource, BillingCheckoutOperationRecovery, BillingPaidInvoice, BillingInvoiceState, BillingSubscription, CreateBillingCheckoutParams, CreateBillingPortalParams, EnsureBillingCustomerParams, } from '@peable.to/shared-types';
+export type { CreateBillingTaxQuoteParams, BillingTaxQuote, BillingInvoiceAuthoritySource, BillingFinalInvoice, BillingFinalInvoiceAuthority, BillingFaircoinRenewalChoice, BillingFaircoinRenewalConsent, BillingFaircoinRenewalRevocation, BillingObservation, BillingCustomer, BillingHostedSession, BillingCheckoutSession, BillingCheckoutObservation, RetrieveBillingCheckoutOperationParams, BillingCheckoutOperationSource, BillingCheckoutOperationRecovery, BillingPaidInvoice, BillingInvoiceState, BillingSubscription, CreateBillingCheckoutParams, CreateBillingPortalParams, EnsureBillingCustomerParams, BillingRail, BillingRailSettlement, BillingRailOffer, BillingRailOption, BillingRailList, } from '@peable.to/shared-types';
+/** Production Peable's pinned billing-authority public keys, by key id. */
+export { PEABLE_BILLING_AUTHORITY_KEYS } from '@peable.to/shared-types';
 import { type PeableConfig } from './core/config';
 import { PaymentIntentsResource } from './resources/paymentIntents';
 import { PaymentLinksResource } from './resources/paymentLinks';

package/dist/types/resources/billing.d.ts

@@ -1,4 +1,4 @@
-import type { BillingTaxQuote, RetrieveBillingCheckoutOperationParams, BillingCheckoutOperationRecovery, CreateBillingTaxQuoteParams, BillingFinalInvoiceAuthority, BillingCustomer, BillingHostedSession, BillingCheckoutSession, BillingCheckoutObservation, BillingPaidInvoice, BillingInvoiceState, BillingSubscription, CreateBillingCheckoutParams, CreateBillingPortalParams, EnsureBillingCustomerParams } from '@peable.to/shared-types';
+import type { BillingTaxQuote, RetrieveBillingCheckoutOperationParams, BillingCheckoutOperationRecovery, CreateBillingTaxQuoteParams, BillingFinalInvoiceAuthority, BillingCustomer, BillingRailList, BillingHostedSession, BillingCheckoutSession, BillingCheckoutObservation, BillingPaidInvoice, BillingInvoiceState, BillingSubscription, CreateBillingCheckoutParams, CreateBillingPortalParams, EnsureBillingCustomerParams } from '@peable.to/shared-types';
 import type { RestClient } from '../core/client';
 export interface BillingRequestOptions {
     idempotencyKey: string;
@@ -9,6 +9,11 @@ export declare class BillingResource {
     private readonly invoiceAuthorityKeys?;
     private readonly taxQuoteAuthorityKeys?;
     constructor(client: RestClient, invoiceAuthorityKeys?: Readonly<Record<string, string>> | undefined, taxQuoteAuthorityKeys?: Readonly<Record<string, string>> | undefined);
+    /** The rails this merchant's payers can choose between (card and other fiat
+     * providers, FairCoin), default first, with each rail's offers. Pass the
+     * payer's choice as `rail` to `ensureCustomer`; the customer's rail then
+     * carries its checkouts, subscriptions and invoices. */
+    listRails(): Promise<BillingRailList>;
     ensureCustomer(params: EnsureBillingCustomerParams, options: BillingRequestOptions): Promise<BillingCustomer>;
     /** Pass the complete signed taxQuote to opt into fiscal checkout. Peable validates
      * its pinned authority and retains immutable evidence before creating a session.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@peable.to/sdk",
-  "version": "0.2.7",
+  "version": "0.3.0",
   "description": "Peable SDK — a Stripe-ergonomics TypeScript client over the Peable Gateway REST + realtime contract. Server entry (`@peable.to/sdk`) mints Oxy service tokens from an ApplicationCredential and exposes paymentIntents/paymentLinks/checkout.sessions/webhooks; browser entry (`@peable.to/sdk/checkout`) is the anonymous payer-side client core.",
   "main": "dist/cjs/index.js",
   "module": "dist/esm/index.js",
@@ -90,7 +90,7 @@
     "prepublishOnly": "bun run clean && bun run build"
   },
   "dependencies": {
-    "@peable.to/shared-types": "0.3.4",
+    "@peable.to/shared-types": "0.4.0",
     "qrcode-generator": "^2.0.4",
     "socket.io-client": "^4.8.3",
     "@peable.to/contracts": "0.1.0",