@isnap/sdk 1.3.0-next.99 → 1.4.0-next.203

package/dist/resources/lines.js

@@ -54,10 +54,18 @@ export class LinesResource extends BaseResource {
     }
     /**
      * `POST /v1/lines/{id}/activate` — commit a reserved line to `active`.
-     * Wholesale partners use this as the second phase of reserve→activate (no
-     * Stripe checkout, EOM-metered) and may pick the inbound-only rental variant
-     * via `body.inbound_only`. Direct callers get the mock-sub test/dev shortcut
-     * and `inbound_only` is ignored.
+     * **Wholesale partners only**: the second phase of reserve→activate (no
+     * Stripe checkout, EOM-metered), which may pick the inbound-only rental
+     * variant via `body.inbound_only`. Direct customers get `402
+     * checkout_required` — their line activates when the Stripe Checkout session
+     * from `billing.checkout()` is paid, and their `inbound_only` comes from the
+     * price they paid.
+     *
+     * `body.billing_anchor_at` states the date the customer who pays for this
+     * line is billed on — every line that customer holds then moves together: one
+     * full month at each occurrence, with a credit at the first occurrence for
+     * the days the activation month had already paid for past it. Omit it and the
+     * line is billed on its activation instant.
      */
     activate(id, body = {}, opts) {
         return this.client.request('POST', `/v1/lines/${encodeURIComponent(id)}/activate`, body, opts);
@@ -66,6 +74,100 @@ export class LinesResource extends BaseResource {
     release(id, opts) {
         return this.client.request('POST', `/v1/lines/${encodeURIComponent(id)}/release`, undefined, opts);
     }
+    /**
+     * `POST /v1/lines/{id}/terminate` — permanently END a line you own. The
+     * self-serve counterpart to the admin terminate, and the verb to call when
+     * your own customer cancels: `release()` only returns a *reserved*
+     * marketplace line to the shelf, while this ends a live `rental` line or a
+     * virtual `shared` line for good.
+     *
+     * The line comes back at the terminal `cancelled` status, keeping its owner.
+     * Queued messages fail, shared-fleet bindings release, device sessions are
+     * revoked, and `line.disconnected` fires with `reason: "customer_initiated"`.
+     * Billing stops in both shapes — a per-line Stripe subscription is cancelled
+     * immediately, and a wholesale partner's end-of-month active-line count drops
+     * the line in the same breath.
+     *
+     * **Idempotent.** Terminating an already-terminated line resolves with the
+     * unchanged line (200), never a `ConflictError` — so a retry after a timeout
+     * is always safe and no `opts.idempotencyKey` is needed for it.
+     *
+     * Refusals: `BadRequestError` (400 `byod_not_customer_terminable`) — a BYOD
+     * line is your own hardware, billed per device slot by `/v1/byod/*`;
+     * `PermissionDeniedError` (403 `pool_line_not_terminable`) — an owned test
+     * line must go through `convertFromTest()` first; `NotFoundError` (404) — a
+     * line that does not exist, or one you do not own (the same code for both, so
+     * nothing leaks).
+     *
+     * `body` defaults to `{}` (not `undefined`) so the request always carries
+     * `Content-Type: application/json`; the route's body is optional and the
+     * handler treats a missing body as `{}`.
+     */
+    terminate(id, body = {}, opts) {
+        return this.client.request('POST', `/v1/lines/${encodeURIComponent(id)}/terminate`, body, opts);
+    }
+    /**
+     * `POST /v1/lines/{id}/cancel` — schedule the END of a line you own for its
+     * next billing anniversary, and keep using it until then.
+     *
+     * This is the verb for "my own customer cancelled". The month is already paid
+     * for and iSnap never prorates, so `terminate()` — which ends the line on the
+     * spot — throws away days you have bought. The line stays fully `active` and
+     * bills exactly as before; iSnap ends it itself when `cancel_at` arrives and
+     * fires `line.terminated` with `origin: "scheduled_cancellation"`.
+     *
+     * The resolved line carries `cancel_at`: the next occurrence of its
+     * `anniversary_at` strictly after now, clamped to the last day of a shorter
+     * month (a line taken on the 31st renews on the 28th in February and on the
+     * 31st again in March — the clamp never sticks).
+     *
+     * **Idempotent, and in the way that matters here.** Cancelling an
+     * already-cancelled line resolves with the SAME `cancel_at`, never a
+     * recomputed one — so a retry that happens to land after the stored date has
+     * passed cannot push your own cancellation a month into the future.
+     *
+     * Refusals: `ConflictError` (409 `line_has_no_anniversary`) — the line has no
+     * anniversary to cancel at; state it with `setAnniversary()`, or end the line
+     * now with `terminate()`. `ConflictError` (409
+     * `line_not_customer_cancellable`) — only an `active` or `suspended` line can
+     * be cancelled. `BadRequestError` (400 `byod_not_customer_cancellable`) and
+     * `PermissionDeniedError` (403 `pool_line_not_cancellable`) — those tiers have
+     * no per-line anniversary. `NotFoundError` (404) — a line that does not exist,
+     * or one you do not own (the same code for both, so nothing leaks).
+     */
+    cancel(id, opts) {
+        return this.client.request('POST', `/v1/lines/${encodeURIComponent(id)}/cancel`, undefined, opts);
+    }
+    /**
+     * `POST /v1/lines/{id}/uncancel` — undo a scheduled cancellation. `cancel_at`
+     * goes back to `null` and the line resumes renewing at its anniversary.
+     *
+     * **A no-op on a line that is not cancelled**: resolves 200 with the line and
+     * `cancel_at: null`, never an error — so a reconciliation loop that asserts
+     * "this line must not be cancelled" can run unconditionally.
+     *
+     * Refusal: `ConflictError` (409 `line_already_terminated`) once the
+     * anniversary has passed and iSnap has ended the line. That cannot be undone.
+     */
+    uncancel(id, opts) {
+        return this.client.request('POST', `/v1/lines/${encodeURIComponent(id)}/uncancel`, undefined, opts);
+    }
+    /**
+     * `POST /v1/lines/{id}/anniversary` — state the instant you took this line,
+     * which becomes the day of the month it renews on and the date `cancel()`
+     * waits for.
+     *
+     * **For lines migrated from your own system**, whose real start date iSnap
+     * cannot know. A line taken through the iSnap API is stamped automatically at
+     * activation and needs no call.
+     *
+     * Refusal: `ConflictError` (409 `line_cancellation_pending`) while a
+     * cancellation is scheduled — that `cancel_at` was computed from the
+     * anniversary you are replacing, so uncancel, set the date, and cancel again.
+     */
+    setAnniversary(id, body, opts) {
+        return this.client.request('POST', `/v1/lines/${encodeURIComponent(id)}/anniversary`, body, opts);
+    }
     /**
      * `POST /v1/lines/{id}/transfer-ownership` — reassign a line to a
      * different end-user account without re-pairing the underlying device.
@@ -92,8 +194,115 @@ export class LinesResource extends BaseResource {
         return this.client.request('POST', `/v1/lines/${encodeURIComponent(id)}/convert-from-test`, undefined, opts);
     }
     /**
-     * `PATCH /v1/lines/{id}` — merge-patch the line's free-form metadata
-     * object. Null-valued keys delete those keys from the stored object.
+     * `POST /v1/lines/{id}/variant` — move a rental line you own between the
+     * INBOUND product (`inbound_only: true`) and the TWO-WAY product, **keeping
+     * the same phone number**, the same hardware and the same device session.
+     *
+     * `inbound_only` is not "receive-only": the line converses normally, it
+     * simply cannot OPEN a conversation. It may message only a handle that has
+     * messaged it first, and once that handle has, the exchange is unrestricted
+     * in both directions for good. A send that breaks the rule is a
+     * `PermissionDeniedError` (403 `outbound_first_forbidden`).
+     *
+     * **Idempotent on the value.** Asking for the variant the line already has
+     * resolves with the line and writes nothing — no audit row, no
+     * `line.variant_changed` event — so a retry after a timeout is safe and is
+     * not a second change. It is not a toggle: state the value you want.
+     *
+     * `body.effective` says WHEN, and defaults to `'now'` — the only behaviour
+     * before the field existed, so an existing call is unchanged.
+     *
+     * - `'now'`: as above. Use it for an UPGRADE, which the customer has just
+     *   paid for and which must apply to the very next send.
+     * - `'next_anchor'`: store the change against the line's next billing
+     *   anchor. Nothing moves today — `inbound_only` keeps its current value and
+     *   the line keeps serving the product it is being billed for — and the
+     *   resolved line carries `pending_variant: { inbound_only, effective_at }`.
+     *   Use it for a DOWNGRADE, so the customer keeps the two-way product
+     *   through the month they have already bought. iSnap applies it at the
+     *   anchor and fires `line.variant_changed` with `data.scheduled: true`;
+     *   cancel it beforehand with {@link LinesResource.cancelVariantChange}.
+     *
+     * `body.not_before` (ISO instant, `'next_anchor'` only, defaults to now) is
+     * the earliest instant the change may take effect. iSnap resolves it to the
+     * FIRST anchor occurrence at or after it, applying the anchor's own
+     * day-of-month clamp — so state your customer's paid-period end and let
+     * iSnap pick the occurrence rather than computing one yourself. A monthly
+     * customer needs nothing here; a QUARTERLY or ANNUAL customer does, because
+     * without it the change would land on the next anchor and take back
+     * capability they have already paid for. The resolved instant comes back as
+     * `pending_variant.effective_at`. An instant in the past is a
+     * `BadRequestError` (400 `not_before_in_the_past`) — it is refused rather
+     * than clamped, because for a long-period customer the silent repair and the
+     * correct answer differ by months of the product they bought.
+     *
+     * Scheduling is idempotent on the PENDING value the same way an immediate
+     * change is on the live one: re-scheduling the change already pending
+     * resolves with the line and the date it was already given, and writes
+     * nothing. A DIFFERENT pending change is a `ConflictError` (409
+     * `variant_change_already_pending`) — cancel it first, because there is no
+     * honest way to merge two answers to "what is this line at the anchor".
+     *
+     * **A scheduled call can legitimately resolve with `pending_variant: null`,
+     * and that is not a failure.** Scheduling the variant the line ALREADY
+     * carries writes nothing, because nothing is pending — the line will still
+     * be on that variant at the anchor. Do not retry it. Tell it apart from a
+     * silently-dropped `effective` (see the deploy-order warning below) by
+     * reading the top-level `inbound_only`: equal to what you asked for means
+     * already-at-target; different means the field never reached the server and
+     * the change was applied immediately.
+     *
+     * ⚠️ **Adopt `effective` and `not_before` only against a deployment that has
+     * them.** iSnap STRIPS unknown request properties rather than rejecting
+     * them, so an early call gets no 400 — it gets the field dropped and an
+     * ordinary immediate flip, applying a downgrade on the spot. Check
+     * `client.version()` before sending either field.
+     *
+     * An immediate change does NOT cancel a scheduled one: they are separate
+     * acts, and a partner who needs an urgent upgrade must not have their
+     * standing downgrade withdrawn by it. Use `cancelVariantChange` for that.
+     *
+     * Refusals: `ConflictError` (409) — `not_a_rental_line` (byod / pool /
+     * shared have no variant), `line_not_active` (the line must be in service),
+     * `variant_bound_to_stripe_price` (the line carries an iSnap Stripe
+     * subscription, whose price IS its variant; change the subscription
+     * instead). A line the caller does not own is a masked `NotFoundError`
+     * (404), like every other per-line verb.
+     */
+    setVariant(id, body, opts) {
+        return this.client.request('POST', `/v1/lines/${encodeURIComponent(id)}/variant`, body, opts);
+    }
+    /**
+     * `DELETE /v1/lines/{id}/variant` — call off the variant change scheduled
+     * for this line's next billing anchor.
+     *
+     * The line's live `inbound_only` is never touched: the scheduling did not
+     * move it either, so the only effect is that `pending_variant` becomes
+     * `null` and nothing happens at the anchor.
+     *
+     * A line with no pending change is a `NotFoundError` (404
+     * `no_pending_variant_change`), which includes a change the anchor has
+     * already applied — there is nothing left to cancel, and the line's own
+     * `inbound_only` now carries the answer. A change applied while this request
+     * was in flight is a `ConflictError` (409 `variant_change_already_applied`),
+     * so the two outcomes are distinguishable from the code alone.
+     *
+     * Succeeds on a suspended or cancelled line: withdrawing an instruction must
+     * never be blocked by the state that made it moot.
+     */
+    cancelVariantChange(id, opts) {
+        return this.client.request('DELETE', `/v1/lines/${encodeURIComponent(id)}/variant`, undefined, opts);
+    }
+    /**
+     * `PATCH /v1/lines/{id}` — update the line's free-form metadata object, its
+     * billing anchor, or both.
+     *
+     * `metadata` is a MERGE: null-valued keys delete those keys from the stored
+     * object. `billing_anchor_at` is the date the customer who pays for this line
+     * is billed on — a change takes effect at the NEXT occurrence and never
+     * rewrites a period already billed, and `null` clears it so the line falls
+     * back to its activation instant. Send at least one of the two; a body that
+     * states neither is refused with `no_fields_to_patch`.
      */
     patch(id, body, opts) {
         return this.client.request('PATCH', `/v1/lines/${encodeURIComponent(id)}`, body, opts);

package/dist/resources/lines.js.map

@@ -1 +1 @@
-{"version":3,"file":"lines.js","sourceRoot":"","sources":["../../src/resources/lines.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,YAAY,EAAE,MAAM,WAAW,CAAA;AAqBxC,MAAM,OAAO,aAAc,SAAQ,YAAY;IAC7C;;;;;OAKG;IACH,IAAI,CAAC,QAAwB,EAAE,EAAE,IAAqB;QACpD,OAAO,IAAI,CAAC,MAAM,CAAC,OAAO,CAAW,KAAK,EAAE,WAAW,EAAE,SAAS,EAAE;YAClE,GAAG,IAAI;YACP,KAAK,EAAE,EAAE,GAAG,IAAI,EAAE,KAAK,EAAE,GAAG,KAAK,EAAE;SACpC,CAAC,CAAA;IACJ,CAAC;IAED,uEAAuE;IACvE,QAAQ,CAAC,IAAqB;QAC5B,OAAO,IAAI,CAAC,MAAM,CAAC,OAAO,CAAU,KAAK,EAAE,cAAc,EAAE,SAAS,EAAE,IAAI,CAAC,CAAA;IAC7E,CAAC;IAED,qFAAqF;IACrF,GAAG,CAAC,EAAU,EAAE,IAAqB;QACnC,OAAO,IAAI,CAAC,MAAM,CAAC,OAAO,CAAO,KAAK,EAAE,aAAa,kBAAkB,CAAC,EAAE,CAAC,EAAE,EAAE,SAAS,EAAE,IAAI,CAAC,CAAA;IACjG,CAAC;IAED;;;;OAIG;IACH,MAAM,CAAC,IAAoB,EAAE,IAAqB;QAChD,OAAO,IAAI,CAAC,MAAM,CAAC,OAAO,CAAO,MAAM,EAAE,kBAAkB,EAAE,IAAI,EAAE,IAAI,CAAC,CAAA;IAC1E,CAAC;IAED;;;;;;;;;;;;;;;;OAgBG;IACH,UAAU,CAAC,OAA2B,EAAE,EAAE,IAAqB;QAC7D,OAAO,IAAI,CAAC,MAAM,CAAC,OAAO,CAAO,MAAM,EAAE,kBAAkB,EAAE,IAAI,EAAE,IAAI,CAAC,CAAA;IAC1E,CAAC;IAED,mFAAmF;IACnF,OAAO,CAAC,EAAU,EAAE,IAAqB;QACvC,OAAO,IAAI,CAAC,MAAM,CAAC,OAAO,CACxB,MAAM,EACN,aAAa,kBAAkB,CAAC,EAAE,CAAC,UAAU,EAC7C,SAAS,EACT,IAAI,CACL,CAAA;IACH,CAAC;IAED;;;;;;OAMG;IACH,QAAQ,CAAC,EAAU,EAAE,OAAyB,EAAE,EAAE,IAAqB;QACrE,OAAO,IAAI,CAAC,MAAM,CAAC,OAAO,CACxB,MAAM,EACN,aAAa,kBAAkB,CAAC,EAAE,CAAC,WAAW,EAC9C,IAAI,EACJ,IAAI,CACL,CAAA;IACH,CAAC;IAED,2FAA2F;IAC3F,OAAO,CAAC,EAAU,EAAE,IAAqB;QACvC,OAAO,IAAI,CAAC,MAAM,CAAC,OAAO,CACxB,MAAM,EACN,aAAa,kBAAkB,CAAC,EAAE,CAAC,UAAU,EAC7C,SAAS,EACT,IAAI,CACL,CAAA;IACH,CAAC;IAED;;;OAGG;IACH,iBAAiB,CACf,EAAU,EACV,IAA2B,EAC3B,IAAqB;QAErB,OAAO,IAAI,CAAC,MAAM,CAAC,OAAO,CACxB,MAAM,EACN,aAAa,kBAAkB,CAAC,EAAE,CAAC,qBAAqB,EACxD,IAAI,EACJ,IAAI,CACL,CAAA;IACH,CAAC;IAED;;;;;OAKG;IACH,aAAa,CAAC,EAAU,EAAE,IAAqB;QAC7C,OAAO,IAAI,CAAC,MAAM,CAAC,OAAO,CACxB,MAAM,EACN,aAAa,kBAAkB,CAAC,EAAE,CAAC,kBAAkB,EACrD,SAAS,EACT,IAAI,CACL,CAAA;IACH,CAAC;IAED;;;;;OAKG;IACH,eAAe,CAAC,EAAU,EAAE,IAAqB;QAC/C,OAAO,IAAI,CAAC,MAAM,CAAC,OAAO,CACxB,MAAM,EACN,aAAa,kBAAkB,CAAC,EAAE,CAAC,oBAAoB,EACvD,SAAS,EACT,IAAI,CACL,CAAA;IACH,CAAC;IAED;;;OAGG;IACH,KAAK,CAAC,EAAU,EAAE,IAAmB,EAAE,IAAqB;QAC1D,OAAO,IAAI,CAAC,MAAM,CAAC,OAAO,CACxB,OAAO,EACP,aAAa,kBAAkB,CAAC,EAAE,CAAC,EAAE,EACrC,IAAI,EACJ,IAAI,CACL,CAAA;IACH,CAAC;IAED,+EAA+E;IAC/E,KAAK,CAAC,EAAU,EAAE,IAAqB;QACrC,OAAO,IAAI,CAAC,MAAM,CAAC,OAAO,CACxB,KAAK,EACL,aAAa,kBAAkB,CAAC,EAAE,CAAC,QAAQ,EAC3C,SAAS,EACT,IAAI,CACL,CAAA;IACH,CAAC;IAED,qFAAqF;IACrF,KAAK,CACH,EAAU,EACV,QAAwB,EAAE,EAC1B,IAAqB;QAErB,OAAO,IAAI,CAAC,MAAM,CAAC,OAAO,CACxB,KAAK,EACL,aAAa,kBAAkB,CAAC,EAAE,CAAC,QAAQ,EAC3C,SAAS,EACT,EAAE,GAAG,IAAI,EAAE,KAAK,EAAE,EAAE,GAAG,IAAI,EAAE,KAAK,EAAE,GAAG,KAAK,EAAE,EAAE,CACjD,CAAA;IACH,CAAC;IAED;;;;;;;;OAQG;IACH,MAAM,CAAC,EAAU,EAAE,IAAqB;QACtC,OAAO,IAAI,CAAC,MAAM,CAAC,OAAO,CACxB,KAAK,EACL,aAAa,kBAAkB,CAAC,EAAE,CAAC,SAAS,EAC5C,SAAS,EACT,IAAI,CACL,CAAA;IACH,CAAC;IAED,6FAA6F;IAC7F,SAAS,CAAC,EAAU,EAAE,IAAqB;QACzC,OAAO,IAAI,CAAC,MAAM,CAAC,OAAO,CACxB,KAAK,EACL,aAAa,kBAAkB,CAAC,EAAE,CAAC,SAAS,EAC5C,SAAS,EACT,IAAI,CACL,CAAA;IACH,CAAC;IAED;;;;OAIG;IACH,YAAY,CACV,EAAU,EACV,IAAqB,EACrB,IAAqB;QAErB,OAAO,IAAI,CAAC,MAAM,CAAC,OAAO,CACxB,OAAO,EACP,aAAa,kBAAkB,CAAC,EAAE,CAAC,SAAS,EAC5C,IAAI,EACJ,IAAI,CACL,CAAA;IACH,CAAC;CACF"}
+{"version":3,"file":"lines.js","sourceRoot":"","sources":["../../src/resources/lines.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,YAAY,EAAE,MAAM,WAAW,CAAA;AAwBxC,MAAM,OAAO,aAAc,SAAQ,YAAY;IAC7C;;;;;OAKG;IACH,IAAI,CAAC,QAAwB,EAAE,EAAE,IAAqB;QACpD,OAAO,IAAI,CAAC,MAAM,CAAC,OAAO,CAAW,KAAK,EAAE,WAAW,EAAE,SAAS,EAAE;YAClE,GAAG,IAAI;YACP,KAAK,EAAE,EAAE,GAAG,IAAI,EAAE,KAAK,EAAE,GAAG,KAAK,EAAE;SACpC,CAAC,CAAA;IACJ,CAAC;IAED,uEAAuE;IACvE,QAAQ,CAAC,IAAqB;QAC5B,OAAO,IAAI,CAAC,MAAM,CAAC,OAAO,CAAU,KAAK,EAAE,cAAc,EAAE,SAAS,EAAE,IAAI,CAAC,CAAA;IAC7E,CAAC;IAED,qFAAqF;IACrF,GAAG,CAAC,EAAU,EAAE,IAAqB;QACnC,OAAO,IAAI,CAAC,MAAM,CAAC,OAAO,CAAO,KAAK,EAAE,aAAa,kBAAkB,CAAC,EAAE,CAAC,EAAE,EAAE,SAAS,EAAE,IAAI,CAAC,CAAA;IACjG,CAAC;IAED;;;;OAIG;IACH,MAAM,CAAC,IAAoB,EAAE,IAAqB;QAChD,OAAO,IAAI,CAAC,MAAM,CAAC,OAAO,CAAO,MAAM,EAAE,kBAAkB,EAAE,IAAI,EAAE,IAAI,CAAC,CAAA;IAC1E,CAAC;IAED;;;;;;;;;;;;;;;;OAgBG;IACH,UAAU,CAAC,OAA2B,EAAE,EAAE,IAAqB;QAC7D,OAAO,IAAI,CAAC,MAAM,CAAC,OAAO,CAAO,MAAM,EAAE,kBAAkB,EAAE,IAAI,EAAE,IAAI,CAAC,CAAA;IAC1E,CAAC;IAED,mFAAmF;IACnF,OAAO,CAAC,EAAU,EAAE,IAAqB;QACvC,OAAO,IAAI,CAAC,MAAM,CAAC,OAAO,CACxB,MAAM,EACN,aAAa,kBAAkB,CAAC,EAAE,CAAC,UAAU,EAC7C,SAAS,EACT,IAAI,CACL,CAAA;IACH,CAAC;IAED;;;;;;;;;;;;;;OAcG;IACH,QAAQ,CAAC,EAAU,EAAE,OAAyB,EAAE,EAAE,IAAqB;QACrE,OAAO,IAAI,CAAC,MAAM,CAAC,OAAO,CACxB,MAAM,EACN,aAAa,kBAAkB,CAAC,EAAE,CAAC,WAAW,EAC9C,IAAI,EACJ,IAAI,CACL,CAAA;IACH,CAAC;IAED,2FAA2F;IAC3F,OAAO,CAAC,EAAU,EAAE,IAAqB;QACvC,OAAO,IAAI,CAAC,MAAM,CAAC,OAAO,CACxB,MAAM,EACN,aAAa,kBAAkB,CAAC,EAAE,CAAC,UAAU,EAC7C,SAAS,EACT,IAAI,CACL,CAAA;IACH,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA4BG;IACH,SAAS,CAAC,EAAU,EAAE,OAA0B,EAAE,EAAE,IAAqB;QACvE,OAAO,IAAI,CAAC,MAAM,CAAC,OAAO,CACxB,MAAM,EACN,aAAa,kBAAkB,CAAC,EAAE,CAAC,YAAY,EAC/C,IAAI,EACJ,IAAI,CACL,CAAA;IACH,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA4BG;IACH,MAAM,CAAC,EAAU,EAAE,IAAqB;QACtC,OAAO,IAAI,CAAC,MAAM,CAAC,OAAO,CACxB,MAAM,EACN,aAAa,kBAAkB,CAAC,EAAE,CAAC,SAAS,EAC5C,SAAS,EACT,IAAI,CACL,CAAA;IACH,CAAC;IAED;;;;;;;;;;OAUG;IACH,QAAQ,CAAC,EAAU,EAAE,IAAqB;QACxC,OAAO,IAAI,CAAC,MAAM,CAAC,OAAO,CACxB,MAAM,EACN,aAAa,kBAAkB,CAAC,EAAE,CAAC,WAAW,EAC9C,SAAS,EACT,IAAI,CACL,CAAA;IACH,CAAC;IAED;;;;;;;;;;;;OAYG;IACH,cAAc,CACZ,EAAU,EACV,IAA4B,EAC5B,IAAqB;QAErB,OAAO,IAAI,CAAC,MAAM,CAAC,OAAO,CACxB,MAAM,EACN,aAAa,kBAAkB,CAAC,EAAE,CAAC,cAAc,EACjD,IAAI,EACJ,IAAI,CACL,CAAA;IACH,CAAC;IAED;;;OAGG;IACH,iBAAiB,CACf,EAAU,EACV,IAA2B,EAC3B,IAAqB;QAErB,OAAO,IAAI,CAAC,MAAM,CAAC,OAAO,CACxB,MAAM,EACN,aAAa,kBAAkB,CAAC,EAAE,CAAC,qBAAqB,EACxD,IAAI,EACJ,IAAI,CACL,CAAA;IACH,CAAC;IAED;;;;;OAKG;IACH,aAAa,CAAC,EAAU,EAAE,IAAqB;QAC7C,OAAO,IAAI,CAAC,MAAM,CAAC,OAAO,CACxB,MAAM,EACN,aAAa,kBAAkB,CAAC,EAAE,CAAC,kBAAkB,EACrD,SAAS,EACT,IAAI,CACL,CAAA;IACH,CAAC;IAED;;;;;OAKG;IACH,eAAe,CAAC,EAAU,EAAE,IAAqB;QAC/C,OAAO,IAAI,CAAC,MAAM,CAAC,OAAO,CACxB,MAAM,EACN,aAAa,kBAAkB,CAAC,EAAE,CAAC,oBAAoB,EACvD,SAAS,EACT,IAAI,CACL,CAAA;IACH,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA2EG;IACH,UAAU,CAAC,EAAU,EAAE,IAAwB,EAAE,IAAqB;QACpE,OAAO,IAAI,CAAC,MAAM,CAAC,OAAO,CACxB,MAAM,EACN,aAAa,kBAAkB,CAAC,EAAE,CAAC,UAAU,EAC7C,IAAI,EACJ,IAAI,CACL,CAAA;IACH,CAAC;IAED;;;;;;;;;;;;;;;;;OAiBG;IACH,mBAAmB,CAAC,EAAU,EAAE,IAAqB;QACnD,OAAO,IAAI,CAAC,MAAM,CAAC,OAAO,CACxB,QAAQ,EACR,aAAa,kBAAkB,CAAC,EAAE,CAAC,UAAU,EAC7C,SAAS,EACT,IAAI,CACL,CAAA;IACH,CAAC;IAED;;;;;;;;;;OAUG;IACH,KAAK,CAAC,EAAU,EAAE,IAAmB,EAAE,IAAqB;QAC1D,OAAO,IAAI,CAAC,MAAM,CAAC,OAAO,CACxB,OAAO,EACP,aAAa,kBAAkB,CAAC,EAAE,CAAC,EAAE,EACrC,IAAI,EACJ,IAAI,CACL,CAAA;IACH,CAAC;IAED,+EAA+E;IAC/E,KAAK,CAAC,EAAU,EAAE,IAAqB;QACrC,OAAO,IAAI,CAAC,MAAM,CAAC,OAAO,CACxB,KAAK,EACL,aAAa,kBAAkB,CAAC,EAAE,CAAC,QAAQ,EAC3C,SAAS,EACT,IAAI,CACL,CAAA;IACH,CAAC;IAED,qFAAqF;IACrF,KAAK,CACH,EAAU,EACV,QAAwB,EAAE,EAC1B,IAAqB;QAErB,OAAO,IAAI,CAAC,MAAM,CAAC,OAAO,CACxB,KAAK,EACL,aAAa,kBAAkB,CAAC,EAAE,CAAC,QAAQ,EAC3C,SAAS,EACT,EAAE,GAAG,IAAI,EAAE,KAAK,EAAE,EAAE,GAAG,IAAI,EAAE,KAAK,EAAE,GAAG,KAAK,EAAE,EAAE,CACjD,CAAA;IACH,CAAC;IAED;;;;;;;;OAQG;IACH,MAAM,CAAC,EAAU,EAAE,IAAqB;QACtC,OAAO,IAAI,CAAC,MAAM,CAAC,OAAO,CACxB,KAAK,EACL,aAAa,kBAAkB,CAAC,EAAE,CAAC,SAAS,EAC5C,SAAS,EACT,IAAI,CACL,CAAA;IACH,CAAC;IAED,6FAA6F;IAC7F,SAAS,CAAC,EAAU,EAAE,IAAqB;QACzC,OAAO,IAAI,CAAC,MAAM,CAAC,OAAO,CACxB,KAAK,EACL,aAAa,kBAAkB,CAAC,EAAE,CAAC,SAAS,EAC5C,SAAS,EACT,IAAI,CACL,CAAA;IACH,CAAC;IAED;;;;OAIG;IACH,YAAY,CACV,EAAU,EACV,IAAqB,EACrB,IAAqB;QAErB,OAAO,IAAI,CAAC,MAAM,CAAC,OAAO,CACxB,OAAO,EACP,aAAa,kBAAkB,CAAC,EAAE,CAAC,SAAS,EAC5C,IAAI,EACJ,IAAI,CACL,CAAA;IACH,CAAC;CACF"}

package/dist/resources/macos-sessions.d.ts

@@ -0,0 +1,48 @@
+import type { components } from '../generated/openapi.js';
+import type { RequestOptions } from '../types.js';
+import { BaseResource } from './base.js';
+export type MacosSession = components['schemas']['MacosSession'];
+/**
+ * Hosted macOS sessions rented on a wholesale partner's account (contract §2.16).
+ *
+ * A session is a macOS environment the partner runs their own iPhone's bridge
+ * against, with their OWN Apple ID signed into it. It is NOT a line: it carries
+ * no number and originates no messages, so nothing here has a direction, a
+ * platform or a capability.
+ *
+ * Direct customers do not use this resource — they buy sessions through
+ * `POST /v1/billing/mac-checkout` and every method here answers `403
+ * not_a_wholesale_partner` for them.
+ */
+export declare class MacosSessionsResource extends BaseResource {
+    /**
+     * `POST /v1/macos-sessions/rent` — take one session out of iSnap stock.
+     *
+     * The tenancy starts immediately and `anniversary_at` is the day it was taken:
+     * that day of the month is what the session bills on, clamped to the last day
+     * of shorter months. Throws `ConflictError` (`409 no_macos_session_in_stock`)
+     * when no session is free — iSnap provisions one and attaches it, so the call
+     * does not need to be retried on a schedule.
+     *
+     * One call rents one session; rent three by calling three times.
+     */
+    rent(opts?: RequestOptions): Promise<MacosSession>;
+    /**
+     * `POST /v1/macos-sessions/{id}/cancel` — end the tenancy at its next anniversary.
+     *
+     * The session stays usable and keeps billing until `cancel_at`, the next
+     * occurrence of `anniversary_at` strictly after the call. Idempotent: a second
+     * call returns the `cancel_at` the first one set rather than pushing it a
+     * month further out.
+     */
+    cancel(id: string, opts?: RequestOptions): Promise<MacosSession>;
+    /**
+     * `POST /v1/macos-sessions/{id}/uncancel` — withdraw a pending cancellation.
+     *
+     * Clears `cancel_at` and leaves `anniversary_at` untouched, so the billing day
+     * does not move. Idempotent on a session that is not cancelled, and `404` once
+     * the release has already returned the session to stock.
+     */
+    uncancel(id: string, opts?: RequestOptions): Promise<MacosSession>;
+}
+//# sourceMappingURL=macos-sessions.d.ts.map

package/dist/resources/macos-sessions.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"macos-sessions.d.ts","sourceRoot":"","sources":["../../src/resources/macos-sessions.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,yBAAyB,CAAA;AACzD,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,aAAa,CAAA;AACjD,OAAO,EAAE,YAAY,EAAE,MAAM,WAAW,CAAA;AAExC,MAAM,MAAM,YAAY,GAAG,UAAU,CAAC,SAAS,CAAC,CAAC,cAAc,CAAC,CAAA;AAEhE;;;;;;;;;;;GAWG;AACH,qBAAa,qBAAsB,SAAQ,YAAY;IACrD;;;;;;;;;;OAUG;IACH,IAAI,CAAC,IAAI,CAAC,EAAE,cAAc,GAAG,OAAO,CAAC,YAAY,CAAC;IAIlD;;;;;;;OAOG;IACH,MAAM,CAAC,EAAE,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,cAAc,GAAG,OAAO,CAAC,YAAY,CAAC;IAShE;;;;;;OAMG;IACH,QAAQ,CAAC,EAAE,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,cAAc,GAAG,OAAO,CAAC,YAAY,CAAC;CAQnE"}

package/dist/resources/macos-sessions.js

@@ -0,0 +1,51 @@
+import { BaseResource } from './base.js';
+/**
+ * Hosted macOS sessions rented on a wholesale partner's account (contract §2.16).
+ *
+ * A session is a macOS environment the partner runs their own iPhone's bridge
+ * against, with their OWN Apple ID signed into it. It is NOT a line: it carries
+ * no number and originates no messages, so nothing here has a direction, a
+ * platform or a capability.
+ *
+ * Direct customers do not use this resource — they buy sessions through
+ * `POST /v1/billing/mac-checkout` and every method here answers `403
+ * not_a_wholesale_partner` for them.
+ */
+export class MacosSessionsResource extends BaseResource {
+    /**
+     * `POST /v1/macos-sessions/rent` — take one session out of iSnap stock.
+     *
+     * The tenancy starts immediately and `anniversary_at` is the day it was taken:
+     * that day of the month is what the session bills on, clamped to the last day
+     * of shorter months. Throws `ConflictError` (`409 no_macos_session_in_stock`)
+     * when no session is free — iSnap provisions one and attaches it, so the call
+     * does not need to be retried on a schedule.
+     *
+     * One call rents one session; rent three by calling three times.
+     */
+    rent(opts) {
+        return this.client.request('POST', '/v1/macos-sessions/rent', undefined, opts);
+    }
+    /**
+     * `POST /v1/macos-sessions/{id}/cancel` — end the tenancy at its next anniversary.
+     *
+     * The session stays usable and keeps billing until `cancel_at`, the next
+     * occurrence of `anniversary_at` strictly after the call. Idempotent: a second
+     * call returns the `cancel_at` the first one set rather than pushing it a
+     * month further out.
+     */
+    cancel(id, opts) {
+        return this.client.request('POST', `/v1/macos-sessions/${encodeURIComponent(id)}/cancel`, undefined, opts);
+    }
+    /**
+     * `POST /v1/macos-sessions/{id}/uncancel` — withdraw a pending cancellation.
+     *
+     * Clears `cancel_at` and leaves `anniversary_at` untouched, so the billing day
+     * does not move. Idempotent on a session that is not cancelled, and `404` once
+     * the release has already returned the session to stock.
+     */
+    uncancel(id, opts) {
+        return this.client.request('POST', `/v1/macos-sessions/${encodeURIComponent(id)}/uncancel`, undefined, opts);
+    }
+}
+//# sourceMappingURL=macos-sessions.js.map

package/dist/resources/macos-sessions.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"macos-sessions.js","sourceRoot":"","sources":["../../src/resources/macos-sessions.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,YAAY,EAAE,MAAM,WAAW,CAAA;AAIxC;;;;;;;;;;;GAWG;AACH,MAAM,OAAO,qBAAsB,SAAQ,YAAY;IACrD;;;;;;;;;;OAUG;IACH,IAAI,CAAC,IAAqB;QACxB,OAAO,IAAI,CAAC,MAAM,CAAC,OAAO,CAAe,MAAM,EAAE,yBAAyB,EAAE,SAAS,EAAE,IAAI,CAAC,CAAA;IAC9F,CAAC;IAED;;;;;;;OAOG;IACH,MAAM,CAAC,EAAU,EAAE,IAAqB;QACtC,OAAO,IAAI,CAAC,MAAM,CAAC,OAAO,CACxB,MAAM,EACN,sBAAsB,kBAAkB,CAAC,EAAE,CAAC,SAAS,EACrD,SAAS,EACT,IAAI,CACL,CAAA;IACH,CAAC;IAED;;;;;;OAMG;IACH,QAAQ,CAAC,EAAU,EAAE,IAAqB;QACxC,OAAO,IAAI,CAAC,MAAM,CAAC,OAAO,CACxB,MAAM,EACN,sBAAsB,kBAAkB,CAAC,EAAE,CAAC,WAAW,EACvD,SAAS,EACT,IAAI,CACL,CAAA;IACH,CAAC;CACF"}

package/dist/resources/preorders.d.ts

@@ -10,22 +10,45 @@ export declare class PreOrdersResource extends BaseResource {
     /**
      * `POST /v1/pre-orders` — place a pre-order for a rental tier with no
      * in-stock inventory. Set `inbound_only: true` to request the inbound-only
-     * rental variant. Returns a `provisioning` pre-order; ops procures the
-     * hardware and the partner is notified via the `pre_order.fulfilled` webhook
-     * when a matching line is ready. Direct customers get a Stripe
-     * `stripe_client_secret` to confirm the first-month charge; wholesale
-     * partners are billed EOM (no per-line Stripe sub).
+     * rental variant. `billing_tier` is optional and ORTHOGONAL to that plan —
+     * omitting it means `rental_iphone`, the only tier this flow mints, and
+     * `rental_iphone` covers BOTH rental products (`inbound_only` is what picks
+     * between them), so naming both is never a contradiction. When named it is
+     * answered rather than discarded (WHA-2949): `rental_android` is a
+     * `400 android_rental_not_purchasable` — no Android product exists in the
+     * Stripe catalogue — and a BYOD / virtual-shared / pool tier is a
+     * `400 tier_not_pre_orderable` whose message names the endpoint that
+     * acquires it instead. Returns a `draft` pre-order and NOTHING else: no
+     * line, no fulfillment task, no ops notification, no Stripe charge, and
+     * `stripe_client_secret` is always `null`. A draft costs nothing to place
+     * and binds nobody — call `confirm()` to engage the month and start
+     * procurement.
      */
     create(body: CreatePreOrderBody, opts?: RequestOptions): Promise<PreOrder>;
     /**
      * `POST /v1/pre-orders/{id}/confirm` — confirm a `draft` pre-order. The
      * binding step: engages the one-month commitment (full month, no proration)
      * and triggers procurement (mints the provisioning line + fulfillment task,
-     * notifies ops, and for direct customers returns the first-month
-     * `stripe_client_secret`). Only a draft can be confirmed.
+     * notifies ops). Returns the pre-order in `provisioning`; ops procures the
+     * hardware and the partner is notified via the `pre_order.fulfilled` webhook
+     * when a matching line is ready. Direct customers get a Stripe
+     * `stripe_client_secret` to confirm the first-month charge; wholesale
+     * partners are billed EOM (no per-line Stripe sub). Only a draft can be
+     * confirmed.
      */
     confirm(id: string, opts?: RequestOptions): Promise<PreOrder>;
-    /** `GET /v1/pre-orders` — cursor-paginated list of the caller's pre-orders. */
+    /**
+     * `GET /v1/pre-orders` — returns ONE PAGE of the caller's pre-orders.
+     *
+     * The endpoint is cursor-paginated; this method is not. Unlike `messages.list` and `chats.list`,
+     * which return an `AsyncIterable` via `paginate()`, this hands back a single page plus `has_more`
+     * / `next_cursor` for the caller to drive. Saying only "cursor-paginated" was true of the ENDPOINT
+     * and false of the METHOD, and a partner reading the docstring alone writes a `for await` and gets
+     * a runtime `TypeError` — the same class of break §5.2 was corrected for (WHA-2278).
+     *
+     * Iterate it yourself by passing the returned `next_cursor` back in `query.cursor` until
+     * `has_more` is false.
+     */
     list(query?: ListPreOrdersQuery, opts?: RequestOptions): Promise<PreOrderListData>;
     /** `GET /v1/pre-orders/{id}` — fetch a single pre-order by id. */
     get(id: string, opts?: RequestOptions): Promise<PreOrder>;

package/dist/resources/preorders.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"preorders.d.ts","sourceRoot":"","sources":["../../src/resources/preorders.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,UAAU,EAAE,KAAK,EAAE,MAAM,yBAAyB,CAAA;AAChE,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,aAAa,CAAA;AACjD,OAAO,EAAE,YAAY,EAAE,MAAM,WAAW,CAAA;AAExC,MAAM,MAAM,QAAQ,GAAG,UAAU,CAAC,SAAS,CAAC,CAAC,UAAU,CAAC,CAAA;AACxD,MAAM,MAAM,cAAc,GAAG,UAAU,CAAC,SAAS,CAAC,CAAC,gBAAgB,CAAC,CAAA;AAIpE,MAAM,MAAM,gBAAgB,GAAG,UAAU,CAAC,SAAS,CAAC,CAAC,cAAc,CAAC,CAAC,MAAM,CAAC,CAAA;AAE5E,MAAM,MAAM,kBAAkB,GAAG,WAAW,CAC1C,KAAK,CAAC,gBAAgB,CAAC,CAAC,MAAM,CAAC,CAAC,aAAa,CAAC,CAC/C,CAAC,SAAS,CAAC,CAAC,kBAAkB,CAAC,CAAA;AAChC,MAAM,MAAM,kBAAkB,GAAG,WAAW,CAC1C,KAAK,CAAC,gBAAgB,CAAC,CAAC,KAAK,CAAC,CAAC,YAAY,CAAC,CAAC,OAAO,CAAC,CACtD,CAAA;AAED,qBAAa,iBAAkB,SAAQ,YAAY;IACjD;;;;;;;;OAQG;IACH,MAAM,CAAC,IAAI,EAAE,kBAAkB,EAAE,IAAI,CAAC,EAAE,cAAc,GAAG,OAAO,CAAC,QAAQ,CAAC;IAI1E;;;;;;OAMG;IACH,OAAO,CAAC,EAAE,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,cAAc,GAAG,OAAO,CAAC,QAAQ,CAAC;IAS7D,+EAA+E;IAC/E,IAAI,CAAC,KAAK,GAAE,kBAAuB,EAAE,IAAI,CAAC,EAAE,cAAc,GAAG,OAAO,CAAC,gBAAgB,CAAC;IAOtF,kEAAkE;IAClE,GAAG,CAAC,EAAE,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,cAAc,GAAG,OAAO,CAAC,QAAQ,CAAC;IASzD;;;;OAIG;IACH,MAAM,CAAC,EAAE,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,cAAc,GAAG,OAAO,CAAC,QAAQ,CAAC;CAQ7D"}
+{"version":3,"file":"preorders.d.ts","sourceRoot":"","sources":["../../src/resources/preorders.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,UAAU,EAAE,KAAK,EAAE,MAAM,yBAAyB,CAAA;AAChE,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,aAAa,CAAA;AACjD,OAAO,EAAE,YAAY,EAAE,MAAM,WAAW,CAAA;AAExC,MAAM,MAAM,QAAQ,GAAG,UAAU,CAAC,SAAS,CAAC,CAAC,UAAU,CAAC,CAAA;AACxD,MAAM,MAAM,cAAc,GAAG,UAAU,CAAC,SAAS,CAAC,CAAC,gBAAgB,CAAC,CAAA;AAIpE,MAAM,MAAM,gBAAgB,GAAG,UAAU,CAAC,SAAS,CAAC,CAAC,cAAc,CAAC,CAAC,MAAM,CAAC,CAAA;AAE5E,MAAM,MAAM,kBAAkB,GAAG,WAAW,CAC1C,KAAK,CAAC,gBAAgB,CAAC,CAAC,MAAM,CAAC,CAAC,aAAa,CAAC,CAC/C,CAAC,SAAS,CAAC,CAAC,kBAAkB,CAAC,CAAA;AAChC,MAAM,MAAM,kBAAkB,GAAG,WAAW,CAAC,KAAK,CAAC,gBAAgB,CAAC,CAAC,KAAK,CAAC,CAAC,YAAY,CAAC,CAAC,OAAO,CAAC,CAAC,CAAA;AAEnG,qBAAa,iBAAkB,SAAQ,YAAY;IACjD;;;;;;;;;;;;;;;;OAgBG;IACH,MAAM,CAAC,IAAI,EAAE,kBAAkB,EAAE,IAAI,CAAC,EAAE,cAAc,GAAG,OAAO,CAAC,QAAQ,CAAC;IAI1E;;;;;;;;;;OAUG;IACH,OAAO,CAAC,EAAE,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,cAAc,GAAG,OAAO,CAAC,QAAQ,CAAC;IAS7D;;;;;;;;;;;OAWG;IACH,IAAI,CAAC,KAAK,GAAE,kBAAuB,EAAE,IAAI,CAAC,EAAE,cAAc,GAAG,OAAO,CAAC,gBAAgB,CAAC;IAOtF,kEAAkE;IAClE,GAAG,CAAC,EAAE,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,cAAc,GAAG,OAAO,CAAC,QAAQ,CAAC;IASzD;;;;OAIG;IACH,MAAM,CAAC,EAAE,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,cAAc,GAAG,OAAO,CAAC,QAAQ,CAAC;CAQ7D"}

package/dist/resources/preorders.js

@@ -3,11 +3,19 @@ export class PreOrdersResource extends BaseResource {
     /**
      * `POST /v1/pre-orders` — place a pre-order for a rental tier with no
      * in-stock inventory. Set `inbound_only: true` to request the inbound-only
-     * rental variant. Returns a `provisioning` pre-order; ops procures the
-     * hardware and the partner is notified via the `pre_order.fulfilled` webhook
-     * when a matching line is ready. Direct customers get a Stripe
-     * `stripe_client_secret` to confirm the first-month charge; wholesale
-     * partners are billed EOM (no per-line Stripe sub).
+     * rental variant. `billing_tier` is optional and ORTHOGONAL to that plan —
+     * omitting it means `rental_iphone`, the only tier this flow mints, and
+     * `rental_iphone` covers BOTH rental products (`inbound_only` is what picks
+     * between them), so naming both is never a contradiction. When named it is
+     * answered rather than discarded (WHA-2949): `rental_android` is a
+     * `400 android_rental_not_purchasable` — no Android product exists in the
+     * Stripe catalogue — and a BYOD / virtual-shared / pool tier is a
+     * `400 tier_not_pre_orderable` whose message names the endpoint that
+     * acquires it instead. Returns a `draft` pre-order and NOTHING else: no
+     * line, no fulfillment task, no ops notification, no Stripe charge, and
+     * `stripe_client_secret` is always `null`. A draft costs nothing to place
+     * and binds nobody — call `confirm()` to engage the month and start
+     * procurement.
      */
     create(body, opts) {
         return this.client.request('POST', '/v1/pre-orders', body, opts);
@@ -16,13 +24,28 @@ export class PreOrdersResource extends BaseResource {
      * `POST /v1/pre-orders/{id}/confirm` — confirm a `draft` pre-order. The
      * binding step: engages the one-month commitment (full month, no proration)
      * and triggers procurement (mints the provisioning line + fulfillment task,
-     * notifies ops, and for direct customers returns the first-month
-     * `stripe_client_secret`). Only a draft can be confirmed.
+     * notifies ops). Returns the pre-order in `provisioning`; ops procures the
+     * hardware and the partner is notified via the `pre_order.fulfilled` webhook
+     * when a matching line is ready. Direct customers get a Stripe
+     * `stripe_client_secret` to confirm the first-month charge; wholesale
+     * partners are billed EOM (no per-line Stripe sub). Only a draft can be
+     * confirmed.
      */
     confirm(id, opts) {
         return this.client.request('POST', `/v1/pre-orders/${encodeURIComponent(id)}/confirm`, undefined, opts);
     }
-    /** `GET /v1/pre-orders` — cursor-paginated list of the caller's pre-orders. */
+    /**
+     * `GET /v1/pre-orders` — returns ONE PAGE of the caller's pre-orders.
+     *
+     * The endpoint is cursor-paginated; this method is not. Unlike `messages.list` and `chats.list`,
+     * which return an `AsyncIterable` via `paginate()`, this hands back a single page plus `has_more`
+     * / `next_cursor` for the caller to drive. Saying only "cursor-paginated" was true of the ENDPOINT
+     * and false of the METHOD, and a partner reading the docstring alone writes a `for await` and gets
+     * a runtime `TypeError` — the same class of break §5.2 was corrected for (WHA-2278).
+     *
+     * Iterate it yourself by passing the returned `next_cursor` back in `query.cursor` until
+     * `has_more` is false.
+     */
     list(query = {}, opts) {
         return this.client.request('GET', '/v1/pre-orders', undefined, {
             ...opts,

package/dist/resources/preorders.js.map

@@ -1 +1 @@
-{"version":3,"file":"preorders.js","sourceRoot":"","sources":["../../src/resources/preorders.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,YAAY,EAAE,MAAM,WAAW,CAAA;AAgBxC,MAAM,OAAO,iBAAkB,SAAQ,YAAY;IACjD;;;;;;;;OAQG;IACH,MAAM,CAAC,IAAwB,EAAE,IAAqB;QACpD,OAAO,IAAI,CAAC,MAAM,CAAC,OAAO,CAAW,MAAM,EAAE,gBAAgB,EAAE,IAAI,EAAE,IAAI,CAAC,CAAA;IAC5E,CAAC;IAED;;;;;;OAMG;IACH,OAAO,CAAC,EAAU,EAAE,IAAqB;QACvC,OAAO,IAAI,CAAC,MAAM,CAAC,OAAO,CACxB,MAAM,EACN,kBAAkB,kBAAkB,CAAC,EAAE,CAAC,UAAU,EAClD,SAAS,EACT,IAAI,CACL,CAAA;IACH,CAAC;IAED,+EAA+E;IAC/E,IAAI,CAAC,QAA4B,EAAE,EAAE,IAAqB;QACxD,OAAO,IAAI,CAAC,MAAM,CAAC,OAAO,CAAmB,KAAK,EAAE,gBAAgB,EAAE,SAAS,EAAE;YAC/E,GAAG,IAAI;YACP,KAAK,EAAE,EAAE,GAAG,IAAI,EAAE,KAAK,EAAE,GAAG,KAAK,EAAE;SACpC,CAAC,CAAA;IACJ,CAAC;IAED,kEAAkE;IAClE,GAAG,CAAC,EAAU,EAAE,IAAqB;QACnC,OAAO,IAAI,CAAC,MAAM,CAAC,OAAO,CACxB,KAAK,EACL,kBAAkB,kBAAkB,CAAC,EAAE,CAAC,EAAE,EAC1C,SAAS,EACT,IAAI,CACL,CAAA;IACH,CAAC;IAED;;;;OAIG;IACH,MAAM,CAAC,EAAU,EAAE,IAAqB;QACtC,OAAO,IAAI,CAAC,MAAM,CAAC,OAAO,CACxB,MAAM,EACN,kBAAkB,kBAAkB,CAAC,EAAE,CAAC,SAAS,EACjD,SAAS,EACT,IAAI,CACL,CAAA;IACH,CAAC;CACF"}
+{"version":3,"file":"preorders.js","sourceRoot":"","sources":["../../src/resources/preorders.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,YAAY,EAAE,MAAM,WAAW,CAAA;AAcxC,MAAM,OAAO,iBAAkB,SAAQ,YAAY;IACjD;;;;;;;;;;;;;;;;OAgBG;IACH,MAAM,CAAC,IAAwB,EAAE,IAAqB;QACpD,OAAO,IAAI,CAAC,MAAM,CAAC,OAAO,CAAW,MAAM,EAAE,gBAAgB,EAAE,IAAI,EAAE,IAAI,CAAC,CAAA;IAC5E,CAAC;IAED;;;;;;;;;;OAUG;IACH,OAAO,CAAC,EAAU,EAAE,IAAqB;QACvC,OAAO,IAAI,CAAC,MAAM,CAAC,OAAO,CACxB,MAAM,EACN,kBAAkB,kBAAkB,CAAC,EAAE,CAAC,UAAU,EAClD,SAAS,EACT,IAAI,CACL,CAAA;IACH,CAAC;IAED;;;;;;;;;;;OAWG;IACH,IAAI,CAAC,QAA4B,EAAE,EAAE,IAAqB;QACxD,OAAO,IAAI,CAAC,MAAM,CAAC,OAAO,CAAmB,KAAK,EAAE,gBAAgB,EAAE,SAAS,EAAE;YAC/E,GAAG,IAAI;YACP,KAAK,EAAE,EAAE,GAAG,IAAI,EAAE,KAAK,EAAE,GAAG,KAAK,EAAE;SACpC,CAAC,CAAA;IACJ,CAAC;IAED,kEAAkE;IAClE,GAAG,CAAC,EAAU,EAAE,IAAqB;QACnC,OAAO,IAAI,CAAC,MAAM,CAAC,OAAO,CACxB,KAAK,EACL,kBAAkB,kBAAkB,CAAC,EAAE,CAAC,EAAE,EAC1C,SAAS,EACT,IAAI,CACL,CAAA;IACH,CAAC;IAED;;;;OAIG;IACH,MAAM,CAAC,EAAU,EAAE,IAAqB;QACtC,OAAO,IAAI,CAAC,MAAM,CAAC,OAAO,CACxB,MAAM,EACN,kBAAkB,kBAAkB,CAAC,EAAE,CAAC,SAAS,EACjD,SAAS,EACT,IAAI,CACL,CAAA;IACH,CAAC;CACF"}

package/dist/resources/webhooks.d.ts

@@ -27,7 +27,7 @@ export declare class WebhooksResource extends BaseResource {
     /** `DELETE /v1/webhooks/{id}` — delete a subscription. Returns 204. */
     delete(id: string, opts?: RequestOptions): Promise<void>;
     /**
-     * `POST /v1/webhooks/{id}/rotate-secret` — mint a new `whs_*` secret.
+     * `POST /v1/webhooks/{id}/rotate-secret` — mint a new `whsec_*` secret.
      * Old secret stays valid for 5 minutes (`old_secret_expires_at`) so the
      * caller can roll their verification code without dropping events.
      * Plaintext secret is returned ONCE.

package/dist/resources/webhooks.js

@@ -26,7 +26,7 @@ export class WebhooksResource extends BaseResource {
         return this.client.request('DELETE', `/v1/webhooks/${encodeURIComponent(id)}`, undefined, opts);
     }
     /**
-     * `POST /v1/webhooks/{id}/rotate-secret` — mint a new `whs_*` secret.
+     * `POST /v1/webhooks/{id}/rotate-secret` — mint a new `whsec_*` secret.
      * Old secret stays valid for 5 minutes (`old_secret_expires_at`) so the
      * caller can roll their verification code without dropping events.
      * Plaintext secret is returned ONCE.

package/dist/version.d.ts

@@ -1,3 +1,3 @@
-export declare const SDK_VERSION = "1.3.0";
-export declare const MIN_API_VERSION = "1.0.0";
+export declare const SDK_VERSION = "1.4.0";
+export declare const MIN_API_VERSION = "2.0.0";
 //# sourceMappingURL=version.d.ts.map

package/dist/version.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"version.d.ts","sourceRoot":"","sources":["../src/version.ts"],"names":[],"mappings":"AAMA,eAAO,MAAM,WAAW,UAAU,CAAA;AAiBlC,eAAO,MAAM,eAAe,UAAU,CAAA"}
+{"version":3,"file":"version.d.ts","sourceRoot":"","sources":["../src/version.ts"],"names":[],"mappings":"AAMA,eAAO,MAAM,WAAW,UAAU,CAAA;AAyBlC,eAAO,MAAM,eAAe,UAAU,CAAA"}

package/dist/version.js

@@ -4,7 +4,7 @@
 // contract surface. Hand-maintained: no build or publish step derives this
 // from `package.json`, so it MUST be bumped in the same commit as the
 // `version` field there. `src/version.test.ts` fails CI when they disagree.
-export const SDK_VERSION = '1.3.0';
+export const SDK_VERSION = '1.4.0';
 // Minimum API version the SDK considers compatible. Reference-only
 // today: the client exposes `client.version()` to read `/v1/version` on
 // demand, but does NOT call it automatically at first request as a
@@ -17,8 +17,16 @@ export const SDK_VERSION = '1.3.0';
 // Bump this when the SDK starts using a feature that requires a specific
 // backend version (e.g. a new endpoint added in API minor X.Y.0 — the
 // SDK that wraps it sets MIN_API_VERSION to X.Y.0). Within a major
-// version (1.x), the API stays additive (oasdiff
-// `--deprecation-days-stable 30` enforced in CI), so a 1.0.0 SDK keeps
-// working against any 1.x backend without raising the floor.
-export const MIN_API_VERSION = '1.0.0';
+// version, the API stays additive (oasdiff `--deprecation-days-stable 30`
+// enforced in CI), so an SDK keeps working against any backend of the same
+// major without raising the floor.
+//
+// WHA-2644 — raised from `1.0.0` to `2.0.0`. The premise the old value rested
+// on ("within 1.x the API stays additive") is precisely what the pre-order
+// strip broke: `PreOrder` lost `amount`, `billing_tier` and
+// `stripe_payment_intent_id`, so the generated types in this package no longer
+// describe ANY 1.x backend. Leaving the floor at `1.0.0` would have been the
+// same class of defect the change removes — a field that says something the
+// code does not do.
+export const MIN_API_VERSION = '2.0.0';
 //# sourceMappingURL=version.js.map

package/dist/version.js.map

@@ -1 +1 @@
-{"version":3,"file":"version.js","sourceRoot":"","sources":["../src/version.ts"],"names":[],"mappings":"AAAA,oEAAoE;AACpE,yEAAyE;AACzE,wEAAwE;AACxE,2EAA2E;AAC3E,sEAAsE;AACtE,4EAA4E;AAC5E,MAAM,CAAC,MAAM,WAAW,GAAG,OAAO,CAAA;AAElC,mEAAmE;AACnE,wEAAwE;AACxE,mEAAmE;AACnE,wEAAwE;AACxE,2EAA2E;AAC3E,gEAAgE;AAChE,uEAAuE;AACvE,oBAAoB;AACpB,EAAE;AACF,yEAAyE;AACzE,sEAAsE;AACtE,mEAAmE;AACnE,iDAAiD;AACjD,uEAAuE;AACvE,6DAA6D;AAC7D,MAAM,CAAC,MAAM,eAAe,GAAG,OAAO,CAAA"}
+{"version":3,"file":"version.js","sourceRoot":"","sources":["../src/version.ts"],"names":[],"mappings":"AAAA,oEAAoE;AACpE,yEAAyE;AACzE,wEAAwE;AACxE,2EAA2E;AAC3E,sEAAsE;AACtE,4EAA4E;AAC5E,MAAM,CAAC,MAAM,WAAW,GAAG,OAAO,CAAA;AAElC,mEAAmE;AACnE,wEAAwE;AACxE,mEAAmE;AACnE,wEAAwE;AACxE,2EAA2E;AAC3E,gEAAgE;AAChE,uEAAuE;AACvE,oBAAoB;AACpB,EAAE;AACF,yEAAyE;AACzE,sEAAsE;AACtE,mEAAmE;AACnE,0EAA0E;AAC1E,2EAA2E;AAC3E,mCAAmC;AACnC,EAAE;AACF,8EAA8E;AAC9E,2EAA2E;AAC3E,4DAA4D;AAC5D,+EAA+E;AAC/E,6EAA6E;AAC7E,4EAA4E;AAC5E,oBAAoB;AACpB,MAAM,CAAC,MAAM,eAAe,GAAG,OAAO,CAAA"}