@usebillow/sdk 0.6.0 → 0.8.0

package/dist/index.d.cts

@@ -6,8 +6,8 @@ import { SubscriptionStatus } from './status.cjs';
 export { ACTIVE_SUBSCRIPTION_STATUSES, NEVER_ACTIVATED_SUBSCRIPTION_STATUSES, SUBSCRIPTION_STATUSES, TERMINAL_SUBSCRIPTION_STATUSES, grantsAccess, isTerminal } from './status.cjs';
 import { c as TaxBehavior, d as Customer, U as UnappliedPaymentReason, e as CreateChargeInput, R as RequestOptions, f as Charge, g as CreateMerchantInitiatedChargeInput, I as IdempotentRequestOptions, h as CallOptions, C as CreateProductInput, i as UpdateProductInput, j as MigrationResult, k as CreateSubscriptionInput, B as BillowOptions, a as CreateCouponInput, l as Coupon, F as FeatureKind, M as MeterConfig, m as Feature, n as UpdateFeatureInput, o as UsageAlert, p as CreateUsageAlertInput, b as CheckResult, T as TrackResult, E as EntitlementView, A as AttachResult } from './billing-B-VyZCXV.cjs';
 export { q as ActivatedSubscriptionResult, r as BillingInterval, s as CouponDuration, t as CouponKind, u as CreateSubscriptionResult, v as EntitlementInput, w as MeterAggregation, x as MeterFilter, y as MeterRoundingMode, z as PendingSubscriptionCheckoutResult, D as PriceInput, P as Product, G as ProductEntitlement, H as ProductPrice, S as Subscription, J as SubscriptionDetail, K as SubscriptionItem, L as UpdatePriceInput, N as UsageAlertKind, O as UsageAlertMetric, Q as UsageModel, V as UsageTier } from './billing-B-VyZCXV.cjs';
-import { a as CreditThresholdLevel, e as CreditGrant, f as CreditTopUp, g as CreateCreditGrantInput, h as CreditGrantRequestResult, i as CreditPacks, j as CreateCreditPackInput, k as CreditPack, U as UpdateCreditPackInput, l as CreateCreditTopUpInput, m as CreditTopUpRequestResult, n as CreditTopUpListParams, o as CreditBalance, p as CreditLedgerEntry, q as CreditUsageParams, r as CreditUsage } from './hosted-domains-BtCd-Rur.cjs';
-export { s as CreditAccountStatus, C as CreditGrantKind, t as CreditMoney, u as CreditPackListItem, v as CreditTopUpStatus, w as CreditTransactionType, x as CreditUsageGroupBy, H as HostedDomainActivatedData, d as HostedDomainDisabledData, b as HostedDomainDnsFailingData, y as HostedDomainEventBase, c as HostedDomainReassignmentPendingData, z as HostedDomainStatus, A as HostedDomainStatusReason } from './hosted-domains-BtCd-Rur.cjs';
+import { a as CreditThresholdLevel, e as CreditGrant, f as CreditTopUp, g as CreateCreditGrantInput, h as CreditGrantRequestResult, i as CreditPacks, j as CreateCreditPackInput, k as CreditPack, U as UpdateCreditPackInput, l as CreateCreditIncludedRuleInput, m as CreditIncludedRule, n as UpdateCreditIncludedRuleInput, o as CreateCreditTopUpInput, p as CreditTopUpRequestResult, q as CreditTopUpListParams, r as CreditBalance, s as CreditLedgerEntry, t as CreditUsageParams, u as CreditUsage } from './hosted-domains-BbuyxnuH.cjs';
+export { v as CreditAccountStatus, w as CreditAllocationInterval, C as CreditGrantKind, x as CreditMoney, y as CreditPackBreakdown, z as CreditPackListItem, A as CreditTopUpStatus, B as CreditTransactionType, D as CreditUsageGroupBy, H as HostedDomainActivatedData, d as HostedDomainDisabledData, b as HostedDomainDnsFailingData, E as HostedDomainEventBase, c as HostedDomainReassignmentPendingData, F as HostedDomainStatus, G as HostedDomainStatusReason } from './hosted-domains-BbuyxnuH.cjs';
 import 'zod';
 
 /**
@@ -261,9 +261,9 @@ interface CursorPaginated<T> {
  * The return type of a cursor-paginated `.list()`: like {@link ListPromise}, BOTH a Promise for
  * the first page AND async-iterable across ALL pages (`for await`, or `.listAll()`). The walk
  * follows `nextCursor` until it is null, so rows arriving at the head meanwhile never make it skip
- * or repeat a row.
+ * or repeat a row. `Page` is the first page's type, for a list whose pages carry more than rows.
  */
-interface CursorListPromise<T> extends Promise<CursorPaginated<T>>, AsyncIterable<T> {
+interface CursorListPromise<T, Page extends CursorPaginated<T> = CursorPaginated<T>> extends Promise<Page>, AsyncIterable<T> {
     /** Page through the entire list and collect every item into one array. */
     listAll(): Promise<T[]>;
 }
@@ -716,6 +716,7 @@ interface Whoami {
  * Every credit quantity - and every count of units - is a `string` of a whole number, e.g.
  * `"5000000"` for 5 credits: never a `number`, which would silently round past 2^53.
  */
+
 /** One Credit Action's price in a Rate Card version: `ceil(units * unitPrice / perUnits)` a line. */
 interface CreditRateCardItem {
     /** The Credit Action key, e.g. `send_message`. */
@@ -829,6 +830,29 @@ interface CreditReservation {
     metadata: Record<string, string> | null;
     createdAt: string;
 }
+/** Narrow the project's reservations list. */
+interface CreditReservationListParams {
+    /** Page size: 1 to 100 (default 25); the server clamps a larger one. */
+    limit?: number;
+    /** A `nextCursor` to continue from; omit to start at the oldest reservation. */
+    cursor?: string;
+    status?: CreditReservationStatus;
+    /** Only this customer's reservations (by external id). */
+    customer?: string;
+    /**
+     * Only reservations protected more than this many seconds ago, whatever their status now (with
+     * `status: "protected"`, the ones still waiting). A reservation never protected never matches.
+     */
+    protectedLongerThan?: number;
+}
+/** A page of the project's reservations, oldest first. */
+interface CreditReservationPage extends CursorPaginated<CreditReservation> {
+    /**
+     * Your project's protected-hold maximum, in seconds (7 days unless configured): a protected hold
+     * never expires, so one protected longer than this needs your decision - commit or release it.
+     */
+    protectedHoldMaxSeconds: number;
+}
 /** What a reservation holds for and how it is identified; give `quoteId` or `items`. */
 interface CreateCreditReservationBase {
     /** The customer's external id. */
@@ -902,10 +926,18 @@ interface CreatePortalSessionInput {
     flow?: PortalSessionFlow;
     /** Product slug to subscribe to — required when `flow` is `checkout`. */
     productId?: string;
-    /** Where the surface returns the Customer when they finish or exit. */
+    /**
+     * Where the surface returns the Customer when they finish or exit: an absolute `https` URL
+     * without credentials (and, in live, without a port other than 443). A loopback host such as
+     * `localhost` is also accepted over `http`, on any port, in either environment.
+     */
     returnUrl?: string;
 }
-/** The minted portal session: redirect the Customer to `url` (it carries the bearer). */
+/**
+ * The minted portal session: redirect the Customer to `url` at once. Its token is a single-use
+ * entry token - Billow's hosted portal exchanges it on first open, after which the link works
+ * only for the browser that opened it.
+ */
 interface PortalSession {
     id: string;
     url: string;
@@ -913,6 +945,21 @@ interface PortalSession {
     /** ISO-8601 expiry — the session (and its URL) stop working after this. */
     expiresAt: string;
 }
+/** The single-use entry exchange's input (`BillowPortal.exchange`). */
+interface PortalSessionExchangeInput {
+    /** The `Host` the link was opened on: it must be the host the session is bound to. */
+    host: string;
+    /** The session token the browser already holds, if any: a revisit by the browser that
+     *  exchanged the link lands on its own session, and only that browser's. */
+    sessionToken?: string;
+}
+/** What the exchange returns: the session's bearer from now on, and its unchanged expiry. */
+interface PortalSessionExchange {
+    sessionToken: string;
+    flow: PortalSessionFlow;
+    /** ISO-8601 expiry of the session, set when it was minted. */
+    expiresAt: string;
+}
 /**
  * The portal shell: the session's flow + return URL, the merchant's
  * customer-facing brand, and the Customer's identity. The lightweight payload a
@@ -1422,6 +1469,33 @@ declare function createCreditsResource(ctx: RequestContext): {
         /** Edit a pack's terms or Price, or archive it; top-ups already made keep their terms. */
         update: (packId: string, input: UpdateCreditPackInput, options?: CallOptions) => Promise<CreditPack>;
     };
+    includedRules: {
+        /**
+         * Configure an Included Credit Rule on a recurring base Price: the credits a subscription on
+         * it includes for each period Billow grants it - per billing period, or per month of a Price
+         * billed for longer than a month - and for a trial. Configuration, so no idempotency key:
+         * a second live rule for the same Price throws `conflict` (409,
+         * `details.reason: "included_rule_exists"`, with the live rule's `ruleId`). Throws
+         * `validation_error` (422) with `details.reason: "not_a_base_price"` for a Price that is not
+         * a recurring base Price, or `"allocation_not_shorter_than_billing"` for a monthly
+         * allocation on a Price not billed for longer than a month.
+         */
+        create: (input: CreateCreditIncludedRuleInput, options?: CallOptions) => Promise<CreditIncludedRule>;
+        /** A rule, archived or not. */
+        get: (ruleId: string, options?: CallOptions) => Promise<CreditIncludedRule>;
+        /**
+         * Every rule, archived ones included, newest first. Auto-paginating by cursor: `await` the
+         * first page, `for await (…)` every rule, or `.listAll()` to collect them.
+         */
+        list: (params?: CursorListParams, options?: CallOptions) => CursorListPromise<CreditIncludedRule>;
+        /**
+         * Edit a rule's credits, per-seat choice, trial credits or allocation interval, or archive
+         * it (`archived: false` brings it back). It takes effect from the next period granted;
+         * periods already granted keep what they were granted. A rule left live is judged against
+         * its Price as it is now, with the same errors as `create`.
+         */
+        update: (ruleId: string, input: UpdateCreditIncludedRuleInput, options?: CallOptions) => Promise<CreditIncludedRule>;
+    };
     topUps: {
         /**
          * Buy a Credit Pack for a customer: answers the top-up with `checkoutUrl`, the hosted
@@ -1512,6 +1586,15 @@ declare function createCreditsResource(ctx: RequestContext): {
         create: (input: CreateCreditReservationInput, options: IdempotentRequestOptions) => Promise<CreditReservationRequestResult>;
         /** A reservation as it now stands. */
         get: (reservationId: string, options?: CallOptions) => Promise<CreditReservation>;
+        /**
+         * Your project's reservations, oldest first, optionally of one `status`, one `customer` (by
+         * external id), or protected more than `protectedLongerThan` seconds ago - with
+         * `{ status: "protected", protectedLongerThan: page.protectedHoldMaxSeconds }`, the paid
+         * operations waiting past your maximum for a decision (commit or release each). Every page
+         * carries `protectedHoldMaxSeconds`. Auto-paginating by cursor: `await` the first page,
+         * `for await (…)` every reservation, or `.listAll()` to collect them.
+         */
+        list: (params?: CreditReservationListParams, options?: CallOptions) => CursorListPromise<CreditReservation, CreditReservationPage>;
         /**
          * A customer's reservation (by external id) made with `operationKey` - how to find one whose
          * reply was lost. Throws `not_found` (404) when there is none.
@@ -2803,6 +2886,13 @@ declare class BillowPortal {
      *  the lightweight payload the hosting app frames every page with, and the
      *  validate-and-route check at login. */
     session(options?: CallOptions): Promise<PortalSessionInfo>;
+    /**
+     * The single-use entry exchange (ADR-0039): on a client built with a minted link's entry
+     * token, trade it for the session token to use from now on. Succeeds once per link, and
+     * afterwards only for the browser presenting that exchange's `sessionToken`; anything else is
+     * a 401. For a hosted surface; an integrator's own surface may keep using the entry token.
+     */
+    exchange(input: PortalSessionExchangeInput, options?: CallOptions): Promise<PortalSessionExchange>;
     /** The self-serve home payload: identity + subscriptions + usage + saved cards. */
     me(options?: CallOptions): Promise<PortalView>;
     invoices: {
@@ -2810,6 +2900,8 @@ declare class BillowPortal {
         list: (params?: ListParams & {
             status?: InvoiceListItem["status"];
         }, options?: CallOptions) => ListPromise<InvoiceListItem>;
+        /** One of the Customer's invoices, in the list's shape. */
+        get: (id: string, options?: CallOptions) => Promise<InvoiceListItem>;
         /** Open or resume checkout for this customer's outstanding invoice. */
         pay: (id: string, input?: PayInvoiceInput, options?: CallOptions) => Promise<{
             invoiceId: string;
@@ -2881,4 +2973,4 @@ declare class BillowPortal {
     };
 }
 
-export { AttachResult, BILLOW_ERROR_CODES, Billow, BillowApiError, type BillowErrorCode, BillowOptions, BillowPortal, BillowPublishable, type BusinessProfile, CallOptions, type CatalogItem, Charge, type ChargeListItem, type ChargeListParams, type ChargeSearchHit, ChargeStatus, CheckResult, type CheckoutMethodInfo, type ConfigField, type ConfigFieldOption, type ConfigFieldType, Coupon, CreateChargeInput, CreateCouponInput, CreateCreditGrantInput, CreateCreditPackInput, type CreateCreditQuoteInput, type CreateCreditReservationInput, CreateCreditTopUpInput, CreateHostedDomainInput, CreateMerchantInitiatedChargeInput, type CreatePortalSessionInput, CreateProductInput, CreateSubscriptionInput, CreateUsageAlertInput, type CreateWebhookEndpointInput, type CredentialSet, CreditBalance, type CreditDimensions, CreditGrant, CreditGrantRequestResult, CreditLedgerEntry, type CreditLineItem, CreditPack, CreditPacks, type CreditPricedLine, type CreditQuote, type CreditRateCard, type CreditRateCardItem, type CreditReservation, type CreditReservationRequestResult, type CreditReservationStatus, type CreditReversal, type CreditReversalRequestResult, CreditThresholdLevel, CreditTopUp, CreditTopUpListParams, CreditTopUpRequestResult, CreditUsage, CreditUsageParams, type CursorListParams, type CursorListPromise, type CursorPaginated, Customer, type CustomerAnonymizationResult, type CustomerCreditsExport, type CustomerDataExport, type CustomerListItem, type CustomerListParams, type CustomerOverview, type CustomerSearchHit, type CustomerUsage, type CustomerUsageDetail, type EmailDeliveryListItem, type EmailDeliveryListParams, type EmailDeliveryStatus, type EmailTemplateSetting, EntitlementView, type ExchangeRate, type ExportJsonValue, type ExternalPaymentMethod, type ExternalPaymentResult, Feature, FeatureKind, IdempotentRequestOptions, type InboundWebhookListItem, type InboundWebhookListParams, type InboundWebhookOutcome, type IntegrationDefinition, type IntegrationKind, type IntegrationTier, type Invoice, type InvoiceDetail, type InvoiceLineItem, type InvoiceListItem, type InvoiceListParams, type InvoiceSearchHit, InvoiceStatus, type ListParams, type ListPromise, MeterConfig, type MetricsOverview, type MetricsParams, type MetricsRollup, MigrationResult, type OutboxEventListItem, type OutboxEventListParams, type OutboxEventStatus, type Paginated, PayInvoiceInput, type PaymentMethod, PaymentMethodStatus, type PaymentProviderDefinition, type PortalCardSetupResult, type PortalCheckout, type PortalPlanChange, type PortalSession, type PortalSessionFlow, type PortalSessionInfo, type PortalSubscriptionStatus, type PortalView, type ProviderCredentialSummary, type ProviderVerifyResult, type ProviderVerifyTarget, type ProviderVerifyTargetResult, type PublishCreditRateCardInput, type RecordExternalPaymentInput, type Refund, type RefundChargeInput, type RefundRequestResult, type RefundReviewReason, RefundStatus, RequestOptions, type ResolveRefundInput, type ReverseCreditConsumptionInput, SavedPaymentMethod, type ScheduledSubscriptionChange, type SearchResults, type SubscriptionListItem, type SubscriptionListParams, type SubscriptionSearchHit, SubscriptionStatus, TaxBehavior, type TimeseriesInterval, type TimeseriesMetric, type TimeseriesParams, type TimeseriesPoint, type TimeseriesResult, TrackResult, UnappliedPaymentReason, type UpdateBusinessProfileInput, UpdateCreditPackInput, type UpdateEmailTemplateInput, UpdateFeatureInput, UpdateProductInput, type UpdateWebhookEndpointInput, type UpsertCredentialsInput, UsageAlert, type WebhookDelivery, WebhookDeliveryStatus, type WebhookEndpoint, type WebhookEndpointWithSecret, type Whoami, currencyExponent, formatMoney, isSecretField, toMajorUnits, toMinorUnits };
+export { AttachResult, BILLOW_ERROR_CODES, Billow, BillowApiError, type BillowErrorCode, BillowOptions, BillowPortal, BillowPublishable, type BusinessProfile, CallOptions, type CatalogItem, Charge, type ChargeListItem, type ChargeListParams, type ChargeSearchHit, ChargeStatus, CheckResult, type CheckoutMethodInfo, type ConfigField, type ConfigFieldOption, type ConfigFieldType, Coupon, CreateChargeInput, CreateCouponInput, CreateCreditGrantInput, CreateCreditIncludedRuleInput, CreateCreditPackInput, type CreateCreditQuoteInput, type CreateCreditReservationInput, CreateCreditTopUpInput, CreateHostedDomainInput, CreateMerchantInitiatedChargeInput, type CreatePortalSessionInput, CreateProductInput, CreateSubscriptionInput, CreateUsageAlertInput, type CreateWebhookEndpointInput, type CredentialSet, CreditBalance, type CreditDimensions, CreditGrant, CreditGrantRequestResult, CreditIncludedRule, CreditLedgerEntry, type CreditLineItem, CreditPack, CreditPacks, type CreditPricedLine, type CreditQuote, type CreditRateCard, type CreditRateCardItem, type CreditReservation, type CreditReservationListParams, type CreditReservationPage, type CreditReservationRequestResult, type CreditReservationStatus, type CreditReversal, type CreditReversalRequestResult, CreditThresholdLevel, CreditTopUp, CreditTopUpListParams, CreditTopUpRequestResult, CreditUsage, CreditUsageParams, type CursorListParams, type CursorListPromise, type CursorPaginated, Customer, type CustomerAnonymizationResult, type CustomerCreditsExport, type CustomerDataExport, type CustomerListItem, type CustomerListParams, type CustomerOverview, type CustomerSearchHit, type CustomerUsage, type CustomerUsageDetail, type EmailDeliveryListItem, type EmailDeliveryListParams, type EmailDeliveryStatus, type EmailTemplateSetting, EntitlementView, type ExchangeRate, type ExportJsonValue, type ExternalPaymentMethod, type ExternalPaymentResult, Feature, FeatureKind, IdempotentRequestOptions, type InboundWebhookListItem, type InboundWebhookListParams, type InboundWebhookOutcome, type IntegrationDefinition, type IntegrationKind, type IntegrationTier, type Invoice, type InvoiceDetail, type InvoiceLineItem, type InvoiceListItem, type InvoiceListParams, type InvoiceSearchHit, InvoiceStatus, type ListParams, type ListPromise, MeterConfig, type MetricsOverview, type MetricsParams, type MetricsRollup, MigrationResult, type OutboxEventListItem, type OutboxEventListParams, type OutboxEventStatus, type Paginated, PayInvoiceInput, type PaymentMethod, PaymentMethodStatus, type PaymentProviderDefinition, type PortalCardSetupResult, type PortalCheckout, type PortalPlanChange, type PortalSession, type PortalSessionExchange, type PortalSessionExchangeInput, type PortalSessionFlow, type PortalSessionInfo, type PortalSubscriptionStatus, type PortalView, type ProviderCredentialSummary, type ProviderVerifyResult, type ProviderVerifyTarget, type ProviderVerifyTargetResult, type PublishCreditRateCardInput, type RecordExternalPaymentInput, type Refund, type RefundChargeInput, type RefundRequestResult, type RefundReviewReason, RefundStatus, RequestOptions, type ResolveRefundInput, type ReverseCreditConsumptionInput, SavedPaymentMethod, type ScheduledSubscriptionChange, type SearchResults, type SubscriptionListItem, type SubscriptionListParams, type SubscriptionSearchHit, SubscriptionStatus, TaxBehavior, type TimeseriesInterval, type TimeseriesMetric, type TimeseriesParams, type TimeseriesPoint, type TimeseriesResult, TrackResult, UnappliedPaymentReason, type UpdateBusinessProfileInput, UpdateCreditIncludedRuleInput, UpdateCreditPackInput, type UpdateEmailTemplateInput, UpdateFeatureInput, UpdateProductInput, type UpdateWebhookEndpointInput, type UpsertCredentialsInput, UsageAlert, type WebhookDelivery, WebhookDeliveryStatus, type WebhookEndpoint, type WebhookEndpointWithSecret, type Whoami, currencyExponent, formatMoney, isSecretField, toMajorUnits, toMinorUnits };

package/dist/index.d.ts

@@ -6,8 +6,8 @@ import { SubscriptionStatus } from './status.js';
 export { ACTIVE_SUBSCRIPTION_STATUSES, NEVER_ACTIVATED_SUBSCRIPTION_STATUSES, SUBSCRIPTION_STATUSES, TERMINAL_SUBSCRIPTION_STATUSES, grantsAccess, isTerminal } from './status.js';
 import { c as TaxBehavior, d as Customer, U as UnappliedPaymentReason, e as CreateChargeInput, R as RequestOptions, f as Charge, g as CreateMerchantInitiatedChargeInput, I as IdempotentRequestOptions, h as CallOptions, C as CreateProductInput, i as UpdateProductInput, j as MigrationResult, k as CreateSubscriptionInput, B as BillowOptions, a as CreateCouponInput, l as Coupon, F as FeatureKind, M as MeterConfig, m as Feature, n as UpdateFeatureInput, o as UsageAlert, p as CreateUsageAlertInput, b as CheckResult, T as TrackResult, E as EntitlementView, A as AttachResult } from './billing-CgjcWmvb.js';
 export { q as ActivatedSubscriptionResult, r as BillingInterval, s as CouponDuration, t as CouponKind, u as CreateSubscriptionResult, v as EntitlementInput, w as MeterAggregation, x as MeterFilter, y as MeterRoundingMode, z as PendingSubscriptionCheckoutResult, D as PriceInput, P as Product, G as ProductEntitlement, H as ProductPrice, S as Subscription, J as SubscriptionDetail, K as SubscriptionItem, L as UpdatePriceInput, N as UsageAlertKind, O as UsageAlertMetric, Q as UsageModel, V as UsageTier } from './billing-CgjcWmvb.js';
-import { a as CreditThresholdLevel, e as CreditGrant, f as CreditTopUp, g as CreateCreditGrantInput, h as CreditGrantRequestResult, i as CreditPacks, j as CreateCreditPackInput, k as CreditPack, U as UpdateCreditPackInput, l as CreateCreditTopUpInput, m as CreditTopUpRequestResult, n as CreditTopUpListParams, o as CreditBalance, p as CreditLedgerEntry, q as CreditUsageParams, r as CreditUsage } from './hosted-domains-CrVDsk2i.js';
-export { s as CreditAccountStatus, C as CreditGrantKind, t as CreditMoney, u as CreditPackListItem, v as CreditTopUpStatus, w as CreditTransactionType, x as CreditUsageGroupBy, H as HostedDomainActivatedData, d as HostedDomainDisabledData, b as HostedDomainDnsFailingData, y as HostedDomainEventBase, c as HostedDomainReassignmentPendingData, z as HostedDomainStatus, A as HostedDomainStatusReason } from './hosted-domains-CrVDsk2i.js';
+import { a as CreditThresholdLevel, e as CreditGrant, f as CreditTopUp, g as CreateCreditGrantInput, h as CreditGrantRequestResult, i as CreditPacks, j as CreateCreditPackInput, k as CreditPack, U as UpdateCreditPackInput, l as CreateCreditIncludedRuleInput, m as CreditIncludedRule, n as UpdateCreditIncludedRuleInput, o as CreateCreditTopUpInput, p as CreditTopUpRequestResult, q as CreditTopUpListParams, r as CreditBalance, s as CreditLedgerEntry, t as CreditUsageParams, u as CreditUsage } from './hosted-domains-BP91tg9P.js';
+export { v as CreditAccountStatus, w as CreditAllocationInterval, C as CreditGrantKind, x as CreditMoney, y as CreditPackBreakdown, z as CreditPackListItem, A as CreditTopUpStatus, B as CreditTransactionType, D as CreditUsageGroupBy, H as HostedDomainActivatedData, d as HostedDomainDisabledData, b as HostedDomainDnsFailingData, E as HostedDomainEventBase, c as HostedDomainReassignmentPendingData, F as HostedDomainStatus, G as HostedDomainStatusReason } from './hosted-domains-BP91tg9P.js';
 import 'zod';
 
 /**
@@ -261,9 +261,9 @@ interface CursorPaginated<T> {
  * The return type of a cursor-paginated `.list()`: like {@link ListPromise}, BOTH a Promise for
  * the first page AND async-iterable across ALL pages (`for await`, or `.listAll()`). The walk
  * follows `nextCursor` until it is null, so rows arriving at the head meanwhile never make it skip
- * or repeat a row.
+ * or repeat a row. `Page` is the first page's type, for a list whose pages carry more than rows.
  */
-interface CursorListPromise<T> extends Promise<CursorPaginated<T>>, AsyncIterable<T> {
+interface CursorListPromise<T, Page extends CursorPaginated<T> = CursorPaginated<T>> extends Promise<Page>, AsyncIterable<T> {
     /** Page through the entire list and collect every item into one array. */
     listAll(): Promise<T[]>;
 }
@@ -716,6 +716,7 @@ interface Whoami {
  * Every credit quantity - and every count of units - is a `string` of a whole number, e.g.
  * `"5000000"` for 5 credits: never a `number`, which would silently round past 2^53.
  */
+
 /** One Credit Action's price in a Rate Card version: `ceil(units * unitPrice / perUnits)` a line. */
 interface CreditRateCardItem {
     /** The Credit Action key, e.g. `send_message`. */
@@ -829,6 +830,29 @@ interface CreditReservation {
     metadata: Record<string, string> | null;
     createdAt: string;
 }
+/** Narrow the project's reservations list. */
+interface CreditReservationListParams {
+    /** Page size: 1 to 100 (default 25); the server clamps a larger one. */
+    limit?: number;
+    /** A `nextCursor` to continue from; omit to start at the oldest reservation. */
+    cursor?: string;
+    status?: CreditReservationStatus;
+    /** Only this customer's reservations (by external id). */
+    customer?: string;
+    /**
+     * Only reservations protected more than this many seconds ago, whatever their status now (with
+     * `status: "protected"`, the ones still waiting). A reservation never protected never matches.
+     */
+    protectedLongerThan?: number;
+}
+/** A page of the project's reservations, oldest first. */
+interface CreditReservationPage extends CursorPaginated<CreditReservation> {
+    /**
+     * Your project's protected-hold maximum, in seconds (7 days unless configured): a protected hold
+     * never expires, so one protected longer than this needs your decision - commit or release it.
+     */
+    protectedHoldMaxSeconds: number;
+}
 /** What a reservation holds for and how it is identified; give `quoteId` or `items`. */
 interface CreateCreditReservationBase {
     /** The customer's external id. */
@@ -902,10 +926,18 @@ interface CreatePortalSessionInput {
     flow?: PortalSessionFlow;
     /** Product slug to subscribe to — required when `flow` is `checkout`. */
     productId?: string;
-    /** Where the surface returns the Customer when they finish or exit. */
+    /**
+     * Where the surface returns the Customer when they finish or exit: an absolute `https` URL
+     * without credentials (and, in live, without a port other than 443). A loopback host such as
+     * `localhost` is also accepted over `http`, on any port, in either environment.
+     */
     returnUrl?: string;
 }
-/** The minted portal session: redirect the Customer to `url` (it carries the bearer). */
+/**
+ * The minted portal session: redirect the Customer to `url` at once. Its token is a single-use
+ * entry token - Billow's hosted portal exchanges it on first open, after which the link works
+ * only for the browser that opened it.
+ */
 interface PortalSession {
     id: string;
     url: string;
@@ -913,6 +945,21 @@ interface PortalSession {
     /** ISO-8601 expiry — the session (and its URL) stop working after this. */
     expiresAt: string;
 }
+/** The single-use entry exchange's input (`BillowPortal.exchange`). */
+interface PortalSessionExchangeInput {
+    /** The `Host` the link was opened on: it must be the host the session is bound to. */
+    host: string;
+    /** The session token the browser already holds, if any: a revisit by the browser that
+     *  exchanged the link lands on its own session, and only that browser's. */
+    sessionToken?: string;
+}
+/** What the exchange returns: the session's bearer from now on, and its unchanged expiry. */
+interface PortalSessionExchange {
+    sessionToken: string;
+    flow: PortalSessionFlow;
+    /** ISO-8601 expiry of the session, set when it was minted. */
+    expiresAt: string;
+}
 /**
  * The portal shell: the session's flow + return URL, the merchant's
  * customer-facing brand, and the Customer's identity. The lightweight payload a
@@ -1422,6 +1469,33 @@ declare function createCreditsResource(ctx: RequestContext): {
         /** Edit a pack's terms or Price, or archive it; top-ups already made keep their terms. */
         update: (packId: string, input: UpdateCreditPackInput, options?: CallOptions) => Promise<CreditPack>;
     };
+    includedRules: {
+        /**
+         * Configure an Included Credit Rule on a recurring base Price: the credits a subscription on
+         * it includes for each period Billow grants it - per billing period, or per month of a Price
+         * billed for longer than a month - and for a trial. Configuration, so no idempotency key:
+         * a second live rule for the same Price throws `conflict` (409,
+         * `details.reason: "included_rule_exists"`, with the live rule's `ruleId`). Throws
+         * `validation_error` (422) with `details.reason: "not_a_base_price"` for a Price that is not
+         * a recurring base Price, or `"allocation_not_shorter_than_billing"` for a monthly
+         * allocation on a Price not billed for longer than a month.
+         */
+        create: (input: CreateCreditIncludedRuleInput, options?: CallOptions) => Promise<CreditIncludedRule>;
+        /** A rule, archived or not. */
+        get: (ruleId: string, options?: CallOptions) => Promise<CreditIncludedRule>;
+        /**
+         * Every rule, archived ones included, newest first. Auto-paginating by cursor: `await` the
+         * first page, `for await (…)` every rule, or `.listAll()` to collect them.
+         */
+        list: (params?: CursorListParams, options?: CallOptions) => CursorListPromise<CreditIncludedRule>;
+        /**
+         * Edit a rule's credits, per-seat choice, trial credits or allocation interval, or archive
+         * it (`archived: false` brings it back). It takes effect from the next period granted;
+         * periods already granted keep what they were granted. A rule left live is judged against
+         * its Price as it is now, with the same errors as `create`.
+         */
+        update: (ruleId: string, input: UpdateCreditIncludedRuleInput, options?: CallOptions) => Promise<CreditIncludedRule>;
+    };
     topUps: {
         /**
          * Buy a Credit Pack for a customer: answers the top-up with `checkoutUrl`, the hosted
@@ -1512,6 +1586,15 @@ declare function createCreditsResource(ctx: RequestContext): {
         create: (input: CreateCreditReservationInput, options: IdempotentRequestOptions) => Promise<CreditReservationRequestResult>;
         /** A reservation as it now stands. */
         get: (reservationId: string, options?: CallOptions) => Promise<CreditReservation>;
+        /**
+         * Your project's reservations, oldest first, optionally of one `status`, one `customer` (by
+         * external id), or protected more than `protectedLongerThan` seconds ago - with
+         * `{ status: "protected", protectedLongerThan: page.protectedHoldMaxSeconds }`, the paid
+         * operations waiting past your maximum for a decision (commit or release each). Every page
+         * carries `protectedHoldMaxSeconds`. Auto-paginating by cursor: `await` the first page,
+         * `for await (…)` every reservation, or `.listAll()` to collect them.
+         */
+        list: (params?: CreditReservationListParams, options?: CallOptions) => CursorListPromise<CreditReservation, CreditReservationPage>;
         /**
          * A customer's reservation (by external id) made with `operationKey` - how to find one whose
          * reply was lost. Throws `not_found` (404) when there is none.
@@ -2803,6 +2886,13 @@ declare class BillowPortal {
      *  the lightweight payload the hosting app frames every page with, and the
      *  validate-and-route check at login. */
     session(options?: CallOptions): Promise<PortalSessionInfo>;
+    /**
+     * The single-use entry exchange (ADR-0039): on a client built with a minted link's entry
+     * token, trade it for the session token to use from now on. Succeeds once per link, and
+     * afterwards only for the browser presenting that exchange's `sessionToken`; anything else is
+     * a 401. For a hosted surface; an integrator's own surface may keep using the entry token.
+     */
+    exchange(input: PortalSessionExchangeInput, options?: CallOptions): Promise<PortalSessionExchange>;
     /** The self-serve home payload: identity + subscriptions + usage + saved cards. */
     me(options?: CallOptions): Promise<PortalView>;
     invoices: {
@@ -2810,6 +2900,8 @@ declare class BillowPortal {
         list: (params?: ListParams & {
             status?: InvoiceListItem["status"];
         }, options?: CallOptions) => ListPromise<InvoiceListItem>;
+        /** One of the Customer's invoices, in the list's shape. */
+        get: (id: string, options?: CallOptions) => Promise<InvoiceListItem>;
         /** Open or resume checkout for this customer's outstanding invoice. */
         pay: (id: string, input?: PayInvoiceInput, options?: CallOptions) => Promise<{
             invoiceId: string;
@@ -2881,4 +2973,4 @@ declare class BillowPortal {
     };
 }
 
-export { AttachResult, BILLOW_ERROR_CODES, Billow, BillowApiError, type BillowErrorCode, BillowOptions, BillowPortal, BillowPublishable, type BusinessProfile, CallOptions, type CatalogItem, Charge, type ChargeListItem, type ChargeListParams, type ChargeSearchHit, ChargeStatus, CheckResult, type CheckoutMethodInfo, type ConfigField, type ConfigFieldOption, type ConfigFieldType, Coupon, CreateChargeInput, CreateCouponInput, CreateCreditGrantInput, CreateCreditPackInput, type CreateCreditQuoteInput, type CreateCreditReservationInput, CreateCreditTopUpInput, CreateHostedDomainInput, CreateMerchantInitiatedChargeInput, type CreatePortalSessionInput, CreateProductInput, CreateSubscriptionInput, CreateUsageAlertInput, type CreateWebhookEndpointInput, type CredentialSet, CreditBalance, type CreditDimensions, CreditGrant, CreditGrantRequestResult, CreditLedgerEntry, type CreditLineItem, CreditPack, CreditPacks, type CreditPricedLine, type CreditQuote, type CreditRateCard, type CreditRateCardItem, type CreditReservation, type CreditReservationRequestResult, type CreditReservationStatus, type CreditReversal, type CreditReversalRequestResult, CreditThresholdLevel, CreditTopUp, CreditTopUpListParams, CreditTopUpRequestResult, CreditUsage, CreditUsageParams, type CursorListParams, type CursorListPromise, type CursorPaginated, Customer, type CustomerAnonymizationResult, type CustomerCreditsExport, type CustomerDataExport, type CustomerListItem, type CustomerListParams, type CustomerOverview, type CustomerSearchHit, type CustomerUsage, type CustomerUsageDetail, type EmailDeliveryListItem, type EmailDeliveryListParams, type EmailDeliveryStatus, type EmailTemplateSetting, EntitlementView, type ExchangeRate, type ExportJsonValue, type ExternalPaymentMethod, type ExternalPaymentResult, Feature, FeatureKind, IdempotentRequestOptions, type InboundWebhookListItem, type InboundWebhookListParams, type InboundWebhookOutcome, type IntegrationDefinition, type IntegrationKind, type IntegrationTier, type Invoice, type InvoiceDetail, type InvoiceLineItem, type InvoiceListItem, type InvoiceListParams, type InvoiceSearchHit, InvoiceStatus, type ListParams, type ListPromise, MeterConfig, type MetricsOverview, type MetricsParams, type MetricsRollup, MigrationResult, type OutboxEventListItem, type OutboxEventListParams, type OutboxEventStatus, type Paginated, PayInvoiceInput, type PaymentMethod, PaymentMethodStatus, type PaymentProviderDefinition, type PortalCardSetupResult, type PortalCheckout, type PortalPlanChange, type PortalSession, type PortalSessionFlow, type PortalSessionInfo, type PortalSubscriptionStatus, type PortalView, type ProviderCredentialSummary, type ProviderVerifyResult, type ProviderVerifyTarget, type ProviderVerifyTargetResult, type PublishCreditRateCardInput, type RecordExternalPaymentInput, type Refund, type RefundChargeInput, type RefundRequestResult, type RefundReviewReason, RefundStatus, RequestOptions, type ResolveRefundInput, type ReverseCreditConsumptionInput, SavedPaymentMethod, type ScheduledSubscriptionChange, type SearchResults, type SubscriptionListItem, type SubscriptionListParams, type SubscriptionSearchHit, SubscriptionStatus, TaxBehavior, type TimeseriesInterval, type TimeseriesMetric, type TimeseriesParams, type TimeseriesPoint, type TimeseriesResult, TrackResult, UnappliedPaymentReason, type UpdateBusinessProfileInput, UpdateCreditPackInput, type UpdateEmailTemplateInput, UpdateFeatureInput, UpdateProductInput, type UpdateWebhookEndpointInput, type UpsertCredentialsInput, UsageAlert, type WebhookDelivery, WebhookDeliveryStatus, type WebhookEndpoint, type WebhookEndpointWithSecret, type Whoami, currencyExponent, formatMoney, isSecretField, toMajorUnits, toMinorUnits };
+export { AttachResult, BILLOW_ERROR_CODES, Billow, BillowApiError, type BillowErrorCode, BillowOptions, BillowPortal, BillowPublishable, type BusinessProfile, CallOptions, type CatalogItem, Charge, type ChargeListItem, type ChargeListParams, type ChargeSearchHit, ChargeStatus, CheckResult, type CheckoutMethodInfo, type ConfigField, type ConfigFieldOption, type ConfigFieldType, Coupon, CreateChargeInput, CreateCouponInput, CreateCreditGrantInput, CreateCreditIncludedRuleInput, CreateCreditPackInput, type CreateCreditQuoteInput, type CreateCreditReservationInput, CreateCreditTopUpInput, CreateHostedDomainInput, CreateMerchantInitiatedChargeInput, type CreatePortalSessionInput, CreateProductInput, CreateSubscriptionInput, CreateUsageAlertInput, type CreateWebhookEndpointInput, type CredentialSet, CreditBalance, type CreditDimensions, CreditGrant, CreditGrantRequestResult, CreditIncludedRule, CreditLedgerEntry, type CreditLineItem, CreditPack, CreditPacks, type CreditPricedLine, type CreditQuote, type CreditRateCard, type CreditRateCardItem, type CreditReservation, type CreditReservationListParams, type CreditReservationPage, type CreditReservationRequestResult, type CreditReservationStatus, type CreditReversal, type CreditReversalRequestResult, CreditThresholdLevel, CreditTopUp, CreditTopUpListParams, CreditTopUpRequestResult, CreditUsage, CreditUsageParams, type CursorListParams, type CursorListPromise, type CursorPaginated, Customer, type CustomerAnonymizationResult, type CustomerCreditsExport, type CustomerDataExport, type CustomerListItem, type CustomerListParams, type CustomerOverview, type CustomerSearchHit, type CustomerUsage, type CustomerUsageDetail, type EmailDeliveryListItem, type EmailDeliveryListParams, type EmailDeliveryStatus, type EmailTemplateSetting, EntitlementView, type ExchangeRate, type ExportJsonValue, type ExternalPaymentMethod, type ExternalPaymentResult, Feature, FeatureKind, IdempotentRequestOptions, type InboundWebhookListItem, type InboundWebhookListParams, type InboundWebhookOutcome, type IntegrationDefinition, type IntegrationKind, type IntegrationTier, type Invoice, type InvoiceDetail, type InvoiceLineItem, type InvoiceListItem, type InvoiceListParams, type InvoiceSearchHit, InvoiceStatus, type ListParams, type ListPromise, MeterConfig, type MetricsOverview, type MetricsParams, type MetricsRollup, MigrationResult, type OutboxEventListItem, type OutboxEventListParams, type OutboxEventStatus, type Paginated, PayInvoiceInput, type PaymentMethod, PaymentMethodStatus, type PaymentProviderDefinition, type PortalCardSetupResult, type PortalCheckout, type PortalPlanChange, type PortalSession, type PortalSessionExchange, type PortalSessionExchangeInput, type PortalSessionFlow, type PortalSessionInfo, type PortalSubscriptionStatus, type PortalView, type ProviderCredentialSummary, type ProviderVerifyResult, type ProviderVerifyTarget, type ProviderVerifyTargetResult, type PublishCreditRateCardInput, type RecordExternalPaymentInput, type Refund, type RefundChargeInput, type RefundRequestResult, type RefundReviewReason, RefundStatus, RequestOptions, type ResolveRefundInput, type ReverseCreditConsumptionInput, SavedPaymentMethod, type ScheduledSubscriptionChange, type SearchResults, type SubscriptionListItem, type SubscriptionListParams, type SubscriptionSearchHit, SubscriptionStatus, TaxBehavior, type TimeseriesInterval, type TimeseriesMetric, type TimeseriesParams, type TimeseriesPoint, type TimeseriesResult, TrackResult, UnappliedPaymentReason, type UpdateBusinessProfileInput, UpdateCreditIncludedRuleInput, UpdateCreditPackInput, type UpdateEmailTemplateInput, UpdateFeatureInput, UpdateProductInput, type UpdateWebhookEndpointInput, type UpsertCredentialsInput, UsageAlert, type WebhookDelivery, WebhookDeliveryStatus, type WebhookEndpoint, type WebhookEndpointWithSecret, type Whoami, currencyExponent, formatMoney, isSecretField, toMajorUnits, toMinorUnits };

package/dist/index.js

@@ -1,4 +1,4 @@
-export { BILLOW_ERROR_CODES, Billow, BillowApiError, BillowPortal, BillowPublishable, currencyExponent, formatMoney, isSecretField, toMajorUnits, toMinorUnits } from './chunk-DYWGZRE2.js';
+export { BILLOW_ERROR_CODES, Billow, BillowApiError, BillowPortal, BillowPublishable, currencyExponent, formatMoney, isSecretField, toMajorUnits, toMinorUnits } from './chunk-J6JIZGWB.js';
 export { ACTIVE_SUBSCRIPTION_STATUSES, CHARGE_STATUSES, INVOICE_STATUSES, NEVER_ACTIVATED_SUBSCRIPTION_STATUSES, PAYMENT_METHOD_STATUSES, REFUND_STATUSES, SUBSCRIPTION_STATUSES, TERMINAL_SUBSCRIPTION_STATUSES, WEBHOOK_DELIVERY_STATUSES, grantsAccess, isTerminal } from './chunk-CCG4F5FK.js';
 //# sourceMappingURL=index.js.map
 //# sourceMappingURL=index.js.map

package/dist/ingestion.d.cts

@@ -4,7 +4,7 @@ import 'zod';
 import './billing-status-BZQN_gm7.cjs';
 import './status.cjs';
 import './billing-B-VyZCXV.cjs';
-import './hosted-domains-BtCd-Rur.cjs';
+import './hosted-domains-BbuyxnuH.cjs';
 
 /**
  * Auto-metering (PRD-16): ingestion strategies that call billow's `track()` for you,

package/dist/ingestion.d.ts

@@ -4,7 +4,7 @@ import 'zod';
 import './billing-status-BZQN_gm7.js';
 import './status.js';
 import './billing-CgjcWmvb.js';
-import './hosted-domains-CrVDsk2i.js';
+import './hosted-domains-BP91tg9P.js';
 
 /**
  * Auto-metering (PRD-16): ingestion strategies that call billow's `track()` for you,