@isnap/sdk 1.1.0-next.56 → 1.1.0-next.58

package/dist/generated/openapi.d.ts

@@ -2615,7 +2615,7 @@ export interface paths {
         get: {
             parameters: {
                 query?: {
-                    billing_tier?: "rental_iphone" | "rental_android" | "byod_imessage" | "byod_android" | "shared_pool";
+                    billing_tier?: "rental_iphone" | "rental_android" | "byod_imessage" | "byod_android" | "shared_pool" | "shared_imessage";
                     status?: string;
                     assigned?: boolean | null;
                     fulfillment?: "pending" | "fulfilled";
@@ -2657,7 +2657,7 @@ export interface paths {
                 query?: {
                     page?: number;
                     limit?: number;
-                    billing_tier?: "rental_iphone" | "rental_android" | "byod_imessage" | "byod_android" | "shared_pool";
+                    billing_tier?: "rental_iphone" | "rental_android" | "byod_imessage" | "byod_android" | "shared_pool" | "shared_imessage";
                 };
                 header?: never;
                 path?: never;
@@ -2778,14 +2778,16 @@ export interface paths {
         };
         get: {
             parameters: {
-                query?: never;
+                query?: {
+                    purpose?: "trial" | "shared";
+                };
                 header?: never;
                 path?: never;
                 cookie?: never;
             };
             requestBody?: never;
             responses: {
-                /** @description Pool fleet summary + per-line trial/usage metrics */
+                /** @description Pool fleet summary + per-line trial/binding/quota metrics + per-scope virtual/physical overcommit */
                 200: {
                     headers: {
                         [name: string]: unknown;
@@ -2827,6 +2829,82 @@ export interface paths {
         patch?: never;
         trace?: never;
     };
+    "/admin/lines/shared": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        get?: never;
+        put?: never;
+        post: {
+            parameters: {
+                query?: never;
+                header?: never;
+                path?: never;
+                cookie?: never;
+            };
+            requestBody?: {
+                content: {
+                    "application/json": components["schemas"]["AdminMintSharedLineBody"];
+                };
+            };
+            responses: {
+                /** @description Virtual shared line minted for the target customer */
+                201: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content: {
+                        "application/json": components["schemas"]["Line"];
+                    };
+                };
+            };
+        };
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/admin/pool-lines/{id}/demote": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        get?: never;
+        put?: never;
+        post: {
+            parameters: {
+                query?: never;
+                header?: never;
+                path: {
+                    id: string;
+                };
+                cookie?: never;
+            };
+            requestBody?: never;
+            responses: {
+                /** @description Pool line demoted to a rental line (blocked while live trials or active bindings exist) */
+                200: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content: {
+                        "application/json": components["schemas"]["DemotePoolLine"];
+                    };
+                };
+            };
+        };
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
     "/admin/activation-codes/{code}/status": {
         parameters: {
             query?: never;
@@ -4443,7 +4521,7 @@ export interface paths {
         get: {
             parameters: {
                 query?: {
-                    billing_tier?: "rental_iphone" | "rental_android" | "byod_imessage" | "byod_android" | "shared_pool";
+                    billing_tier?: "rental_iphone" | "rental_android" | "byod_imessage" | "byod_android" | "shared_pool" | "shared_imessage";
                     area_code?: string;
                     country_code?: string;
                     /** @description US state filter — 2-letter code or full name. */
@@ -4877,6 +4955,118 @@ export interface paths {
         patch?: never;
         trace?: never;
     };
+    "/v1/lines/shared": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        get?: never;
+        put?: never;
+        /**
+         * Mint a virtual shared-outbound line
+         * @description Mint a customer-owned VIRTUAL line on the shared-outbound plan (billing_tier `shared_imessage`): no dedicated hardware, no phone number of its own — sends are proxied onto the shared physical iMessage fleet, with a per-contact physical number resolved at send time. Minted directly `active` with no per-line Stripe subscription (wholesale is metered end-of-month on the active virtual-line count). Wholesale-partner only in v1; direct-customer callers get 402 until self-serve checkout ships (an admin can provision one for them in the meantime). Optional `metadata` is persisted and echoed on `line.*` webhooks. Supports `Idempotency-Key` — every mint creates a fresh billable line, so retries MUST carry the same key to avoid double-minting.
+         */
+        post: {
+            parameters: {
+                query?: never;
+                header?: never;
+                path?: never;
+                cookie?: never;
+            };
+            requestBody?: {
+                content: {
+                    "application/json": components["schemas"]["MintSharedLine"];
+                };
+            };
+            responses: {
+                /** @description Virtual shared line minted */
+                201: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content: {
+                        "application/json": {
+                            /** @enum {boolean} */
+                            success: true;
+                            data: components["schemas"]["Line"];
+                            trace_id: string;
+                            request_id: string;
+                        };
+                    };
+                };
+                /** @description Bad request — validation failed */
+                400: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content: {
+                        "application/json": components["schemas"]["ErrorEnvelope"];
+                    };
+                };
+                /** @description Unauthenticated — missing or invalid bearer token */
+                401: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content: {
+                        "application/json": components["schemas"]["ErrorEnvelope"];
+                    };
+                };
+                /** @description Payment required — no billing relationship entitles this call */
+                402: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content: {
+                        "application/json": components["schemas"]["ErrorEnvelope"];
+                    };
+                };
+                /** @description Forbidden — caller authenticated but not allowed */
+                403: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content: {
+                        "application/json": components["schemas"]["ErrorEnvelope"];
+                    };
+                };
+                /** @description Conflict — concurrent or terminal state */
+                409: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content: {
+                        "application/json": components["schemas"]["ErrorEnvelope"];
+                    };
+                };
+                /** @description Too many requests — rate limit exceeded */
+                429: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content: {
+                        "application/json": components["schemas"]["ErrorEnvelope"];
+                    };
+                };
+                /** @description Internal server error */
+                500: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content: {
+                        "application/json": components["schemas"]["ErrorEnvelope"];
+                    };
+                };
+            };
+        };
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
     "/v1/lines/{id}/reserve": {
         parameters: {
             query?: never;
@@ -8810,6 +9000,173 @@ export interface paths {
         patch?: never;
         trace?: never;
     };
+    "/v1/chats": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /**
+         * List chats
+         * @description Cursor-paginated list of the caller's conversations, newest activity first. Filter by `line_id`. On shared-plan (virtual) lines each chat carries `outbound_number` — the physical number currently serving that contact (null once the binding is released; the next outbound is assigned a fresh number). Non-shared lines always carry `outbound_number: null`. Accepts an API key (`isnap_*`) or a dashboard JWT; line-scoped API keys only see chats of the lines in their allowlist.
+         */
+        get: {
+            parameters: {
+                query?: {
+                    line_id?: string;
+                    limit?: number;
+                    cursor?: string;
+                    since?: string;
+                    until?: string;
+                };
+                header?: never;
+                path?: never;
+                cookie?: never;
+            };
+            requestBody?: never;
+            responses: {
+                /** @description Chat list */
+                200: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content: {
+                        "application/json": components["schemas"]["ChatListEnvelope"];
+                    };
+                };
+                /** @description Bad request — validation failed */
+                400: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content: {
+                        "application/json": components["schemas"]["ErrorEnvelope"];
+                    };
+                };
+                /** @description Unauthenticated — missing or invalid bearer token */
+                401: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content: {
+                        "application/json": components["schemas"]["ErrorEnvelope"];
+                    };
+                };
+                /** @description Too many requests — rate limit exceeded */
+                429: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content: {
+                        "application/json": components["schemas"]["ErrorEnvelope"];
+                    };
+                };
+                /** @description Internal server error */
+                500: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content: {
+                        "application/json": components["schemas"]["ErrorEnvelope"];
+                    };
+                };
+            };
+        };
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/v1/chats/{chat_id}": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /**
+         * Get a chat
+         * @description Fetch a single conversation by its `chat_<base62>` id. Same shape as the list items, including `outbound_number` for shared-plan lines. Cross-account and out-of-scope ids resolve 404 (no existence leak).
+         */
+        get: {
+            parameters: {
+                query?: never;
+                header?: never;
+                path: {
+                    chat_id: string;
+                };
+                cookie?: never;
+            };
+            requestBody?: never;
+            responses: {
+                /** @description Chat */
+                200: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content: {
+                        "application/json": components["schemas"]["ChatEnvelope"];
+                    };
+                };
+                /** @description Bad request — validation failed */
+                400: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content: {
+                        "application/json": components["schemas"]["ErrorEnvelope"];
+                    };
+                };
+                /** @description Unauthenticated — missing or invalid bearer token */
+                401: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content: {
+                        "application/json": components["schemas"]["ErrorEnvelope"];
+                    };
+                };
+                /** @description Not found */
+                404: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content: {
+                        "application/json": components["schemas"]["ErrorEnvelope"];
+                    };
+                };
+                /** @description Too many requests — rate limit exceeded */
+                429: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content: {
+                        "application/json": components["schemas"]["ErrorEnvelope"];
+                    };
+                };
+                /** @description Internal server error */
+                500: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content: {
+                        "application/json": components["schemas"]["ErrorEnvelope"];
+                    };
+                };
+            };
+        };
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
     "/v1/chats/{chat_id}/share-contact-card": {
         parameters: {
             query?: never;
@@ -10908,6 +11265,10 @@ export interface components {
             /** @enum {string} */
             ownership: "pool";
             /** @enum {string} */
+            pool_purpose: "trial" | "shared";
+            /** Format: uuid */
+            owner_user_id: string | null;
+            /** @enum {string} */
             platform: "imessage";
             status: string;
             monthly_price: number;
@@ -10920,10 +11281,53 @@ export interface components {
         CreatePoolLineBody: {
             /** Format: uuid */
             line_id?: string;
+            /**
+             * @default trial
+             * @enum {string}
+             */
+            purpose: "trial" | "shared";
+            /** Format: uuid */
+            owner_user_id?: string;
             phone_number?: string;
             area_code?: string;
             country_code?: string;
         };
+        Line: {
+            id: string;
+            phone_number: string;
+            area_code: string | null;
+            country_code: string | null;
+            state: string | null;
+            state_name: string | null;
+            /** @enum {string} */
+            billing_tier: "rental_iphone" | "rental_android" | "byod_imessage" | "byod_android" | "shared_pool" | "shared_imessage";
+            /** @description True when the customer owns the underlying hardware (BYOD billing tiers). BYOD lines expose the full line-health surface (offline/degraded events, GET /v1/lines/{id}/health). Rental lines (false) only emit durable, actionable events to keep customers out of transient infrastructure noise they cannot act on. */
+            byod: boolean;
+            /** @description True when the line is inbound-only: it may only message a handle that has messaged it first (a recipient who has never contacted the line is rejected with 403 outbound_first_forbidden). Inbound-only is a cheaper rental-tier variant (Bloo parity); always false on BYOD/pool lines. */
+            inbound_only: boolean;
+            capabilities?: unknown;
+            status: string;
+            monthly_price: number;
+            stripe_subscription_id: string | null;
+            activated_at: string | null;
+            expires_at: string | null;
+            created_at: string;
+            metadata: {
+                [key: string]: unknown;
+            } | null;
+            /** @description True when the line is an owner-provisioned test line (ownership=pool with a set owner) that backs the owner's own trial pool. Its monthly_price is the rental-equivalent, not the $0 global pool rate. */
+            test_line: boolean;
+            /** @description True when the line is a virtual shared-plan line (billing_tier shared_imessage): customer-owned, no dedicated hardware, phone_number empty — sends are proxied onto the shared physical iMessage fleet. Line-scoped API keys, webhooks and per-line quota apply to it like any other line. */
+            shared: boolean;
+            fulfillment_status?: string | null;
+        };
+        AdminMintSharedLineBody: {
+            metadata?: {
+                [key: string]: unknown;
+            };
+            /** Format: uuid */
+            user_id: string;
+        };
         PoolLinesMonitor: {
             summary: {
                 total_lines: number;
@@ -10932,14 +11336,20 @@ export interface components {
                 active_trials: number;
                 dormant_trials: number;
                 pairing_pending_trials: number;
+                active_bindings: number;
             };
             lines: components["schemas"]["PoolLineMonitorItem"][];
+            overcommit: components["schemas"]["PoolOvercommitScope"][];
         };
         PoolLineMonitorItem: {
             /** Format: uuid */
             id: string;
             public_id: string;
             phone_number: string | null;
+            /** @enum {string} */
+            purpose: "trial" | "shared";
+            /** Format: uuid */
+            owner_user_id: string | null;
             status: string;
             health_state: string;
             /** Format: uuid */
@@ -10948,9 +11358,36 @@ export interface components {
             active_trials: number;
             dormant_trials: number;
             pairing_pending_trials: number;
+            active_bindings: number;
+            daily_new_used: number;
+            daily_new_limit: number;
+            daily_new_headroom: number;
+            last_activity_at: string | null;
             messages_24h: number;
             created_at: string;
         };
+        PoolOvercommitScope: {
+            /** @enum {string} */
+            scope: "global" | "partner";
+            /** Format: uuid */
+            owner_user_id: string | null;
+            active_virtual_lines: number;
+            physical_lines: number;
+            ratio: number | null;
+        };
+        DemotePoolLine: {
+            /** Format: uuid */
+            id: string;
+            public_id: string;
+            /** @enum {string} */
+            ownership: "rental";
+            pool_purpose: unknown;
+            status: string;
+            monthly_price: number;
+            /** Format: uuid */
+            owner_user_id: string | null;
+            updated_at: string;
+        };
         ActivationCodeStatus: {
             consumed: boolean;
             consumedAt: string | null;
@@ -11325,33 +11762,6 @@ export interface components {
             page: number;
             limit: number;
         };
-        Line: {
-            id: string;
-            phone_number: string;
-            area_code: string | null;
-            country_code: string | null;
-            state: string | null;
-            state_name: string | null;
-            /** @enum {string} */
-            billing_tier: "rental_iphone" | "rental_android" | "byod_imessage" | "byod_android" | "shared_pool";
-            /** @description True when the customer owns the underlying hardware (BYOD billing tiers). BYOD lines expose the full line-health surface (offline/degraded events, GET /v1/lines/{id}/health). Rental lines (false) only emit durable, actionable events to keep customers out of transient infrastructure noise they cannot act on. */
-            byod: boolean;
-            /** @description True when the line is inbound-only: it may only message a handle that has messaged it first (a recipient who has never contacted the line is rejected with 403 outbound_first_forbidden). Inbound-only is a cheaper rental-tier variant (Bloo parity); always false on BYOD/pool lines. */
-            inbound_only: boolean;
-            capabilities?: unknown;
-            status: string;
-            monthly_price: number;
-            stripe_subscription_id: string | null;
-            activated_at: string | null;
-            expires_at: string | null;
-            created_at: string;
-            metadata: {
-                [key: string]: unknown;
-            } | null;
-            /** @description True when the line is an owner-provisioned test line (ownership=pool with a set owner) that backs the owner's own trial pool. Its monthly_price is the rental-equivalent, not the $0 global pool rate. */
-            test_line: boolean;
-            fulfillment_status?: string | null;
-        };
         MyLines: {
             lines: components["schemas"]["Line"][];
         };
@@ -11365,6 +11775,11 @@ export interface components {
                 [key: string]: unknown;
             };
         };
+        MintSharedLine: {
+            metadata?: {
+                [key: string]: unknown;
+            };
+        };
         ActivateLine: {
             inbound_only?: boolean;
         };
@@ -11779,7 +12194,7 @@ export interface components {
          * @description A concrete event type (e.g. `message.received`), a family wildcard (`line.*`), or the catch-all `*`.
          * @enum {string}
          */
-        WebhookEventName: "message.queued" | "message.sent" | "message.delivered" | "message.read" | "message.failed" | "message.received" | "message.scheduled" | "message.cancelled" | "message.fallback_triggered" | "reaction.added" | "reaction.received" | "reaction.removed" | "line.connected" | "line.disconnected" | "line.offline" | "line.degraded" | "line.apple_id_flagged" | "line.quota_warning" | "line.quota_exceeded" | "line.capability_changed" | "typing_indicator.started" | "typing_indicator.stopped" | "trial.linked" | "trial.dormant" | "trial.reactivated" | "trial.bind_conflict" | "pre_order.fulfilled" | "pre_order.cancelled" | "pre_order.refunded" | "webhook.test" | "*" | "message.*" | "reaction.*" | "line.*" | "typing_indicator.*" | "trial.*" | "webhook.*";
+        WebhookEventName: "message.queued" | "message.sent" | "message.delivered" | "message.read" | "message.failed" | "message.received" | "message.scheduled" | "message.cancelled" | "message.fallback_triggered" | "reaction.added" | "reaction.received" | "reaction.removed" | "line.connected" | "line.disconnected" | "line.offline" | "line.degraded" | "line.apple_id_flagged" | "line.quota_warning" | "line.quota_exceeded" | "line.capability_changed" | "typing_indicator.started" | "typing_indicator.stopped" | "trial.linked" | "trial.dormant" | "trial.reactivated" | "trial.bind_conflict" | "binding.released" | "pre_order.fulfilled" | "pre_order.cancelled" | "pre_order.refunded" | "webhook.test" | "*" | "message.*" | "reaction.*" | "line.*" | "typing_indicator.*" | "trial.*" | "binding.*" | "webhook.*";
         WebhookList: {
             webhooks: components["schemas"]["Webhook"][];
         };
@@ -11952,6 +12367,38 @@ export interface components {
             /** @example 1 */
             calling_code: string;
         };
+        ChatListEnvelope: {
+            /** @enum {boolean} */
+            success: true;
+            data: components["schemas"]["ChatList"];
+            trace_id: string;
+            request_id: string;
+        };
+        ChatList: {
+            items: components["schemas"]["Chat"][];
+            has_more: boolean;
+            next_cursor: string | null;
+        };
+        Chat: {
+            /** @example chat_5h7FqK2mNpQ8rT3vW9xY1zA4b */
+            id: string;
+            line_id: string;
+            contact_handle: string;
+            /** @description Shared-plan lines only: the physical number currently serving this contact (the active binding). Null when no binding is active — e.g. after inactivity release, in which case the next outbound is assigned a fresh number — and always null on non-shared lines. */
+            outbound_number: string | null;
+            last_message_at: string;
+            message_count: number;
+            unread_count: number;
+            created_at: string;
+            updated_at: string;
+        };
+        ChatEnvelope: {
+            /** @enum {boolean} */
+            success: true;
+            data: components["schemas"]["Chat"];
+            trace_id: string;
+            request_id: string;
+        };
         ShareContactCardEnvelope: {
             /** @enum {boolean} */
             success: true;
@@ -12018,6 +12465,11 @@ export interface components {
         TrialInitBody: {
             max_outbound_without_inbound?: number;
             welcome_message?: string;
+            /**
+             * @description Optional partner-supplied marketing footer appended to this trial's free pool-line outbounds, replacing the default iSnap footer. Omit to keep the iSnap default. Keep it short and GSM-7-safe — non-GSM characters force the SMS into UCS-2 (70 chars/segment) and cost extra segments.
+             * @example Sent free via Acme
+             */
+            footer?: string;
         };
         TrialStatusEnvelope: {
             /** @enum {boolean} */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@isnap/sdk",
-  "version": "1.1.0-next.56",
+  "version": "1.1.0-next.58",
   "description": "Official TypeScript SDK for the iSnap P2P telephony API",
   "license": "MIT",
   "type": "module",