@usebillow/sdk 0.11.0 → 0.13.0

package/dist/config.d.ts

@@ -1,10 +1,10 @@
 import { Billow } from './index.js';
-import { F as FeatureKind, M as MeterConfig, C as CreateProductInput, a as CreateCouponInput } from './billing-Bs10EcjR.js';
-import './index.d-DSEYhV2c.js';
+import { F as FeatureKind, M as MeterConfig, C as CreateProductInput, a as CreateCouponInput } from './billing-BEbVLGe9.js';
+import './index.d-D5v2ETKF.js';
 import 'zod';
 import './billing-status-DZkB0VPK.js';
 import './status.js';
-import './hosted-domains-BrnwkHqq.js';
+import './hosted-domains-DMgokjiv.js';
 
 /**
  * Code-as-config sync (ARCHITECTURE §12 "code-as-config sync"). Keep your catalog

package/dist/{hosted-domains-zWm2srOk.d.cts → hosted-domains-Cuk3j04R.d.cts}

@@ -1,4 +1,4 @@
-import { H as HostedDomainResponse } from './index.d-DSEYhV2c.cjs';
+import { H as HostedDomainResponse } from './index.d-D5v2ETKF.cjs';
 
 /**
  * Public SDK types for prepaid credits. Re-exported by ../types.ts.
@@ -168,8 +168,8 @@ interface CreditLedgerEntry {
     type: CreditTransactionType;
     /**
      * Why Billow posted it, as a system code (`api_grant`, `grant_expired`, `subscription_period`,
-     * `subscription_upgrade`, `subscription_canceled`, `subscription_charged_back`, ...); never free
-     * text.
+     * `subscription_upgrade`, `subscription_canceled`, `subscription_charged_back`, `sandbox_seed`,
+     * ...); never free text.
      */
     reason: string | null;
     /** How it moved the account's unheld credits (signed). */

package/dist/{hosted-domains-BrnwkHqq.d.ts → hosted-domains-DMgokjiv.d.ts}

@@ -1,4 +1,4 @@
-import { H as HostedDomainResponse } from './index.d-DSEYhV2c.js';
+import { H as HostedDomainResponse } from './index.d-D5v2ETKF.js';
 
 /**
  * Public SDK types for prepaid credits. Re-exported by ../types.ts.
@@ -168,8 +168,8 @@ interface CreditLedgerEntry {
     type: CreditTransactionType;
     /**
      * Why Billow posted it, as a system code (`api_grant`, `grant_expired`, `subscription_period`,
-     * `subscription_upgrade`, `subscription_canceled`, `subscription_charged_back`, ...); never free
-     * text.
+     * `subscription_upgrade`, `subscription_canceled`, `subscription_charged_back`, `sandbox_seed`,
+     * ...); never free text.
      */
     reason: string | null;
     /** How it moved the account's unheld credits (signed). */

package/dist/index.cjs

@@ -249,7 +249,9 @@ var BILLOW_ERROR_CODES = [
   "account_closed",
   "idempotency_conflict",
   "commit_exceeds_hold",
-  "reversal_exceeds_consumption"
+  "reversal_exceeds_consumption",
+  // Merchant custom domains (ADR-0039): a portal session asked for a host that cannot serve it.
+  "hosted_domain_unavailable"
 ];
 
 // src/money.ts
@@ -433,6 +435,16 @@ function createChargesResource(ctx) {
       `/v1/charges/${encodeURIComponent(chargeId)}/refunds/${encodeURIComponent(refundId)}/credit-note.pdf`,
       options
     ),
+    /**
+     * Download a credit note voided on a refund (one of its `voidedCreditNotes`), exactly as it was
+     * issued and badged VOID.
+     */
+    voidedCreditNote: (chargeId, refundId, creditNoteNumber, options) => apiRequestBinary(
+      ctx,
+      "GET",
+      `/v1/charges/${encodeURIComponent(chargeId)}/refunds/${encodeURIComponent(refundId)}/credit-note.pdf?number=${encodeURIComponent(creditNoteNumber)}`,
+      options
+    ),
     /**
      * Refund a succeeded charge: `{ amount }` (minor units) for a partial, `{}` for its whole
      * remaining balance. The `idempotencyKey` is required and must identify this one refund
@@ -476,7 +488,10 @@ function createChargesResource(ctx) {
     /**
      * Record the outcome you verified in the provider dashboard for a refund awaiting review
      * (`needsReview`): `succeeded` settles it with a credit note, `failed` releases its amount.
-     * A refund with a provider conflict (`providerConflictStatus`) resolves only as `succeeded`.
+     * A refund with a provider conflict (`providerConflictStatus`) recorded `failed` resolves only
+     * as `succeeded`; one recorded `succeeded` that the provider later reported failed (a reversal:
+     * the customer's bank returned the money) resolves either way, `failed` making its amount
+     * refundable again.
      */
     resolveRefund: (chargeId, refundId, input, options) => apiRequest(ctx, "POST", `${refundPath(chargeId, refundId)}/resolve`, input, options)
   };
@@ -753,7 +768,8 @@ function createCreditsResource(ctx) {
       /**
        * Publish a new Rate Card version: what each Credit Action costs, as
        * `ceil(units * unitPrice / perUnits)` microcredits a line. Versions are immutable - a price
-       * change is a new version - and take effect in order, at `effectiveAt` (now when omitted).
+       * change is a new version - and take effect in order, at `effectiveAt` (now when omitted),
+       * unless retracted before then.
        */
       publish: (input, options) => apiRequest(ctx, "POST", "/v1/credits/rate-cards", input, options),
       /** The version in effect now (`not_found` before the first takes effect). */
@@ -772,6 +788,20 @@ function createCreditsResource(ctx) {
         void 0,
         options
       ),
+      /**
+       * Retract a version before it takes effect: it never does (`retractedAt` is set), and
+       * versions published after it take effect in order after the last one not retracted - so a
+       * scheduled price change no longer holds back an earlier correction. Safe to retry: a
+       * retracted version answers as retracted. A version already in effect, current or
+       * superseded, throws `conflict` (409, `details.reason: "already_effective"`).
+       */
+      retract: (version, options) => apiRequest(
+        ctx,
+        "POST",
+        `/v1/credits/rate-cards/${encodeURIComponent(String(version))}/retract`,
+        void 0,
+        options
+      ),
       /**
        * The published versions, newest first. Auto-paginating by cursor: `await` the first page,
        * `for await (…)` every version, or `.listAll()` to collect them.
@@ -1890,7 +1920,7 @@ var BillowPortal = class {
     /** The plan being confirmed (product + base price). */
     get: (options) => apiRequest(this.#ctx, "GET", "/portal/checkout", void 0, options),
     /** Subscribe to the plan → returns the hosted Paymob checkout URL to redirect to. */
-    start: () => apiRequest(this.#ctx, "POST", "/portal/checkout")
+    start: (input = {}) => apiRequest(this.#ctx, "POST", "/portal/checkout", input)
   };
 };