@inkbox/sdk 0.4.6 → 0.4.8

package/dist/imessage/resources/imessages.js

@@ -0,0 +1,238 @@
+/**
+ * inkbox-imessage/resources/imessages.ts
+ *
+ * iMessage operations: send, list, conversations, reactions, read
+ * receipts, typing indicators, media upload.
+ *
+ * Unlike SMS, iMessage is not scoped to an org-owned phone number.
+ * Recipients are connected to an agent identity over a shared pool
+ * line by triage, so every method here keys off `conversationId` /
+ * `agentIdentityId` rather than a `phoneNumberId`.
+ */
+import { parseIMessage, parseIMessageAssignment, parseIMessageConversation, parseIMessageConversationSummary, parseIMessageReaction, parseIMessageTriageNumber, } from "../types.js";
+export class IMessagesResource {
+    http;
+    constructor(http) {
+        this.http = http;
+    }
+    /**
+     * Return the active triage line and the connect command.
+     *
+     * Recipients text the returned `connectCommand` (e.g.
+     * `connect @your-handle`) to the triage `number` to get connected to
+     * an agent identity. Resolve this at runtime instead of hardcoding
+     * the number — the line can change.
+     *
+     * @throws {InkboxAPIError} 404 when no triage line is active.
+     */
+    async getTriageNumber() {
+        const data = await this.http.get("/triage-number");
+        return parseIMessageTriageNumber(data);
+    }
+    /**
+     * Send an outbound iMessage through an existing assignment.
+     *
+     * Sends only work toward recipients that triage has already connected
+     * to the agent identity — there is no cold outreach over iMessage.
+     * Inbound replies and reactions arrive via identity-owned webhook
+     * subscriptions (`inkbox.webhooks.subscriptions.create({
+     * agentIdentityId, url, eventTypes: ["imessage.received", ...] })`).
+     *
+     * @param options.to - E.164 recipient number. Mutually exclusive with
+     *   `conversationId`.
+     * @param options.conversationId - Existing conversation UUID to reply into.
+     * @param options.text - Message body.
+     * @param options.mediaUrls - Media URLs (at most one). Use
+     *   {@link uploadMedia} to turn raw bytes into a sendable URL first.
+     * @param options.sendStyle - Optional expressive send style.
+     * @param options.agentIdentityId - Identity to send as. Required for
+     *   org-wide API keys when sending by `to`; ignored for
+     *   identity-scoped keys (the key's identity wins).
+     *
+     * @throws {InkboxAPIError} 400 when the identity is not
+     *   iMessage-enabled; 403 when the recipient is blocked by a contact
+     *   rule.
+     */
+    async send(options) {
+        const body = {};
+        if (options.to != null) {
+            body.to = options.to;
+        }
+        if (options.conversationId != null) {
+            body.conversation_id = options.conversationId;
+        }
+        if (options.text != null) {
+            body.text = options.text;
+        }
+        if (options.mediaUrls != null) {
+            body.media_urls = options.mediaUrls;
+        }
+        if (options.sendStyle != null) {
+            body.send_style = options.sendStyle;
+        }
+        const params = {};
+        if (options.agentIdentityId != null) {
+            params["agent_identity_id"] = options.agentIdentityId;
+        }
+        const data = await this.http.post("/messages", body, { params });
+        return parseIMessage(data.message);
+    }
+    /**
+     * List iMessages visible to the caller, newest first.
+     *
+     * Identity-scoped API keys never see contact-rule-blocked rows
+     * regardless of `isBlocked` (filtered server-side). Admin/JWT callers
+     * see everything by default.
+     *
+     * @param options.agentIdentityId - Narrow to one agent identity.
+     *   Ignored for identity-scoped keys (always their own identity).
+     * @param options.conversationId - Narrow to one conversation.
+     * @param options.limit - Max results (1–200). Defaults to 50.
+     * @param options.offset - Pagination offset. Defaults to 0.
+     * @param options.isRead - Filter by read state.
+     * @param options.isBlocked - Tri-state filter. `true` for only blocked,
+     *   `false` for only non-blocked, omit for all.
+     */
+    async list(options) {
+        const params = {
+            limit: options?.limit ?? 50,
+            offset: options?.offset ?? 0,
+        };
+        if (options?.agentIdentityId !== undefined) {
+            params["agent_identity_id"] = options.agentIdentityId;
+        }
+        if (options?.conversationId !== undefined) {
+            params["conversation_id"] = options.conversationId;
+        }
+        if (options?.isRead !== undefined) {
+            params["is_read"] = options.isRead;
+        }
+        if (options?.isBlocked !== undefined) {
+            params["is_blocked"] = options.isBlocked;
+        }
+        const data = await this.http.get("/messages", params);
+        return data.map(parseIMessage);
+    }
+    /**
+     * List active iMessage connections, newest first.
+     *
+     * One row per recipient currently connected to an agent identity
+     * through triage. Released connections are not returned.
+     *
+     * @param options.agentIdentityId - Narrow to one agent identity.
+     *   Ignored for identity-scoped keys (always their own identity).
+     * @param options.limit - Max results (1–200). Defaults to 50.
+     * @param options.offset - Pagination offset. Defaults to 0.
+     */
+    async listAssignments(options) {
+        const params = {
+            limit: options?.limit ?? 50,
+            offset: options?.offset ?? 0,
+        };
+        if (options?.agentIdentityId !== undefined) {
+            params["agent_identity_id"] = options.agentIdentityId;
+        }
+        const data = await this.http.get("/assignments", params);
+        return data.map(parseIMessageAssignment);
+    }
+    /**
+     * List iMessage conversations with latest-message preview.
+     *
+     * @param options.agentIdentityId - Narrow to one agent identity.
+     *   Ignored for identity-scoped keys (always their own identity).
+     * @param options.limit - Max results (1–200). Defaults to 50.
+     * @param options.offset - Pagination offset. Defaults to 0.
+     * @param options.isBlocked - Tri-state filter applied to the
+     *   underlying messages. `true` for only blocked, `false` for only
+     *   non-blocked, omit for all.
+     */
+    async listConversations(options) {
+        const params = {
+            limit: options?.limit ?? 50,
+            offset: options?.offset ?? 0,
+        };
+        if (options?.agentIdentityId !== undefined) {
+            params["agent_identity_id"] = options.agentIdentityId;
+        }
+        if (options?.isBlocked !== undefined) {
+            params["is_blocked"] = options.isBlocked;
+        }
+        const data = await this.http.get("/conversations", params);
+        return data.map(parseIMessageConversationSummary);
+    }
+    /**
+     * Get one iMessage conversation by ID.
+     *
+     * @param conversationId - UUID of the conversation.
+     * @param options.agentIdentityId - Optional identity assertion; 404s
+     *   when the conversation belongs to a different identity.
+     */
+    async getConversation(conversationId, options) {
+        const params = {};
+        if (options?.agentIdentityId !== undefined) {
+            params["agent_identity_id"] = options.agentIdentityId;
+        }
+        const data = await this.http.get(`/conversations/${conversationId}`, params);
+        return parseIMessageConversation(data);
+    }
+    /**
+     * Send a tapback reaction to a message.
+     *
+     * @param options.messageId - UUID of the message being reacted to.
+     * @param options.reaction - Tapback kind. Sends accept the classic
+     *   six; `custom` is inbound-only and rejected with 422.
+     * @param options.partIndex - Part of a multi-part message to react to.
+     *   Defaults to 0.
+     */
+    async sendReaction(options) {
+        const data = await this.http.post("/reactions", {
+            message_id: options.messageId,
+            reaction: options.reaction,
+            part_index: options.partIndex ?? 0,
+        });
+        return parseIMessageReaction(data);
+    }
+    /**
+     * Send a read receipt and mark inbound messages read locally.
+     *
+     * @param conversationId - UUID of the conversation.
+     * @returns Object with `conversationId` and `updatedCount`.
+     */
+    async markConversationRead(conversationId) {
+        const data = await this.http.post("/mark-read", { conversation_id: conversationId });
+        return {
+            conversationId: data.conversation_id,
+            updatedCount: data.updated_count,
+        };
+    }
+    /**
+     * Show a typing indicator to the conversation's recipient.
+     *
+     * @param conversationId - UUID of the conversation.
+     */
+    async sendTyping(conversationId) {
+        await this.http.post("/typing", { conversation_id: conversationId });
+    }
+    /**
+     * Upload media and get back a URL usable in `mediaUrls`.
+     *
+     * @param options.content - Raw file bytes (max 10 MiB).
+     * @param options.filename - Original filename, used for type inference.
+     * @param options.contentType - Optional MIME type; defaults
+     *   server-side to `application/octet-stream`.
+     */
+    async uploadMedia(options) {
+        const data = await this.http.postMultipart("/media", {
+            fieldName: "file",
+            filename: options.filename,
+            content: options.content,
+            contentType: options.contentType ?? "application/octet-stream",
+        });
+        return {
+            mediaUrl: data.media_url,
+            contentType: data.content_type ?? null,
+            size: data.size ?? null,
+        };
+    }
+}
+//# sourceMappingURL=imessages.js.map

package/dist/imessage/resources/imessages.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"imessages.js","sourceRoot":"","sources":["../../../src/imessage/resources/imessages.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;GAUG;AAGH,OAAO,EAiBL,aAAa,EACb,uBAAuB,EACvB,yBAAyB,EACzB,gCAAgC,EAChC,qBAAqB,EACrB,yBAAyB,GAC1B,MAAM,aAAa,CAAC;AAErB,MAAM,OAAO,iBAAiB;IACC;IAA7B,YAA6B,IAAmB;QAAnB,SAAI,GAAJ,IAAI,CAAe;IAAG,CAAC;IAEpD;;;;;;;;;OASG;IACH,KAAK,CAAC,eAAe;QACnB,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,IAAI,CAAC,GAAG,CAA0B,gBAAgB,CAAC,CAAC;QAC5E,OAAO,yBAAyB,CAAC,IAAI,CAAC,CAAC;IACzC,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;OAuBG;IACH,KAAK,CAAC,IAAI,CAAC,OAOV;QACC,MAAM,IAAI,GAMN,EAAE,CAAC;QACP,IAAI,OAAO,CAAC,EAAE,IAAI,IAAI,EAAE,CAAC;YACvB,IAAI,CAAC,EAAE,GAAG,OAAO,CAAC,EAAE,CAAC;QACvB,CAAC;QACD,IAAI,OAAO,CAAC,cAAc,IAAI,IAAI,EAAE,CAAC;YACnC,IAAI,CAAC,eAAe,GAAG,OAAO,CAAC,cAAc,CAAC;QAChD,CAAC;QACD,IAAI,OAAO,CAAC,IAAI,IAAI,IAAI,EAAE,CAAC;YACzB,IAAI,CAAC,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC;QAC3B,CAAC;QACD,IAAI,OAAO,CAAC,SAAS,IAAI,IAAI,EAAE,CAAC;YAC9B,IAAI,CAAC,UAAU,GAAG,OAAO,CAAC,SAAS,CAAC;QACtC,CAAC;QACD,IAAI,OAAO,CAAC,SAAS,IAAI,IAAI,EAAE,CAAC;YAC9B,IAAI,CAAC,UAAU,GAAG,OAAO,CAAC,SAAS,CAAC;QACtC,CAAC;QACD,MAAM,MAAM,GAA2B,EAAE,CAAC;QAC1C,IAAI,OAAO,CAAC,eAAe,IAAI,IAAI,EAAE,CAAC;YACpC,MAAM,CAAC,mBAAmB,CAAC,GAAG,OAAO,CAAC,eAAe,CAAC;QACxD,CAAC;QACD,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,IAAI,CAAC,IAAI,CAC/B,WAAW,EACX,IAAI,EACJ,EAAE,MAAM,EAAE,CACX,CAAC;QACF,OAAO,aAAa,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IACrC,CAAC;IAED;;;;;;;;;;;;;;;OAeG;IACH,KAAK,CAAC,IAAI,CACR,OAOC;QAED,MAAM,MAAM,GAA8C;YACxD,KAAK,EAAE,OAAO,EAAE,KAAK,IAAI,EAAE;YAC3B,MAAM,EAAE,OAAO,EAAE,MAAM,IAAI,CAAC;SAC7B,CAAC;QACF,IAAI,OAAO,EAAE,eAAe,KAAK,SAAS,EAAE,CAAC;YAC3C,MAAM,CAAC,mBAAmB,CAAC,GAAG,OAAO,CAAC,eAAe,CAAC;QACxD,CAAC;QACD,IAAI,OAAO,EAAE,cAAc,KAAK,SAAS,EAAE,CAAC;YAC1C,MAAM,CAAC,iBAAiB,CAAC,GAAG,OAAO,CAAC,cAAc,CAAC;QACrD,CAAC;QACD,IAAI,OAAO,EAAE,MAAM,KAAK,SAAS,EAAE,CAAC;YAClC,MAAM,CAAC,SAAS,CAAC,GAAG,OAAO,CAAC,MAAM,CAAC;QACrC,CAAC;QACD,IAAI,OAAO,EAAE,SAAS,KAAK,SAAS,EAAE,CAAC;YACrC,MAAM,CAAC,YAAY,CAAC,GAAG,OAAO,CAAC,SAAS,CAAC;QAC3C,CAAC;QACD,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,IAAI,CAAC,GAAG,CAAgB,WAAW,EAAE,MAAM,CAAC,CAAC;QACrE,OAAO,IAAI,CAAC,GAAG,CAAC,aAAa,CAAC,CAAC;IACjC,CAAC;IAED;;;;;;;;;;OAUG;IACH,KAAK,CAAC,eAAe,CACnB,OAIC;QAED,MAAM,MAAM,GAAoC;YAC9C,KAAK,EAAE,OAAO,EAAE,KAAK,IAAI,EAAE;YAC3B,MAAM,EAAE,OAAO,EAAE,MAAM,IAAI,CAAC;SAC7B,CAAC;QACF,IAAI,OAAO,EAAE,eAAe,KAAK,SAAS,EAAE,CAAC;YAC3C,MAAM,CAAC,mBAAmB,CAAC,GAAG,OAAO,CAAC,eAAe,CAAC;QACxD,CAAC;QACD,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,IAAI,CAAC,GAAG,CAA0B,cAAc,EAAE,MAAM,CAAC,CAAC;QAClF,OAAO,IAAI,CAAC,GAAG,CAAC,uBAAuB,CAAC,CAAC;IAC3C,CAAC;IAED;;;;;;;;;;OAUG;IACH,KAAK,CAAC,iBAAiB,CACrB,OAKC;QAED,MAAM,MAAM,GAA8C;YACxD,KAAK,EAAE,OAAO,EAAE,KAAK,IAAI,EAAE;YAC3B,MAAM,EAAE,OAAO,EAAE,MAAM,IAAI,CAAC;SAC7B,CAAC;QACF,IAAI,OAAO,EAAE,eAAe,KAAK,SAAS,EAAE,CAAC;YAC3C,MAAM,CAAC,mBAAmB,CAAC,GAAG,OAAO,CAAC,eAAe,CAAC;QACxD,CAAC;QACD,IAAI,OAAO,EAAE,SAAS,KAAK,SAAS,EAAE,CAAC;YACrC,MAAM,CAAC,YAAY,CAAC,GAAG,OAAO,CAAC,SAAS,CAAC;QAC3C,CAAC;QACD,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,IAAI,CAAC,GAAG,CAC9B,gBAAgB,EAChB,MAAM,CACP,CAAC;QACF,OAAO,IAAI,CAAC,GAAG,CAAC,gCAAgC,CAAC,CAAC;IACpD,CAAC;IAED;;;;;;OAMG;IACH,KAAK,CAAC,eAAe,CACnB,cAAsB,EACtB,OAAsC;QAEtC,MAAM,MAAM,GAA2B,EAAE,CAAC;QAC1C,IAAI,OAAO,EAAE,eAAe,KAAK,SAAS,EAAE,CAAC;YAC3C,MAAM,CAAC,mBAAmB,CAAC,GAAG,OAAO,CAAC,eAAe,CAAC;QACxD,CAAC;QACD,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,IAAI,CAAC,GAAG,CAC9B,kBAAkB,cAAc,EAAE,EAClC,MAAM,CACP,CAAC;QACF,OAAO,yBAAyB,CAAC,IAAI,CAAC,CAAC;IACzC,CAAC;IAED;;;;;;;;OAQG;IACH,KAAK,CAAC,YAAY,CAAC,OAIlB;QACC,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,IAAI,CAAC,IAAI,CAAsB,YAAY,EAAE;YACnE,UAAU,EAAE,OAAO,CAAC,SAAS;YAC7B,QAAQ,EAAE,OAAO,CAAC,QAAQ;YAC1B,UAAU,EAAE,OAAO,CAAC,SAAS,IAAI,CAAC;SACnC,CAAC,CAAC;QACH,OAAO,qBAAqB,CAAC,IAAI,CAAC,CAAC;IACrC,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,oBAAoB,CACxB,cAAsB;QAEtB,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,IAAI,CAAC,IAAI,CAG9B,YAAY,EAAE,EAAE,eAAe,EAAE,cAAc,EAAE,CAAC,CAAC;QACtD,OAAO;YACL,cAAc,EAAE,IAAI,CAAC,eAAe;YACpC,YAAY,EAAE,IAAI,CAAC,aAAa;SACjC,CAAC;IACJ,CAAC;IAED;;;;OAIG;IACH,KAAK,CAAC,UAAU,CAAC,cAAsB;QACrC,MAAM,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE,EAAE,eAAe,EAAE,cAAc,EAAE,CAAC,CAAC;IACvE,CAAC;IAED;;;;;;;OAOG;IACH,KAAK,CAAC,WAAW,CAAC,OAIjB;QACC,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,IAAI,CAAC,aAAa,CAIvC,QAAQ,EAAE;YACX,SAAS,EAAE,MAAM;YACjB,QAAQ,EAAE,OAAO,CAAC,QAAQ;YAC1B,OAAO,EAAE,OAAO,CAAC,OAAO;YACxB,WAAW,EAAE,OAAO,CAAC,WAAW,IAAI,0BAA0B;SAC/D,CAAC,CAAC;QACH,OAAO;YACL,QAAQ,EAAE,IAAI,CAAC,SAAS;YACxB,WAAW,EAAE,IAAI,CAAC,YAAY,IAAI,IAAI;YACtC,IAAI,EAAE,IAAI,CAAC,IAAI,IAAI,IAAI;SACxB,CAAC;IACJ,CAAC;CACF"}

package/dist/imessage/types.d.ts

@@ -0,0 +1,335 @@
+/**
+ * inkbox-imessage/types.ts
+ *
+ * Types mirroring the Inkbox iMessage API response models.
+ *
+ * iMessage routes by assignment, not by a number the org owns: a
+ * recipient is connected to an agent identity over a shared pool line,
+ * and every agent-facing shape is keyed by `conversationId` /
+ * `remoteNumber`. The local pool number is never exposed.
+ */
+import { ContactRuleStatus } from "../mail/types.js";
+/** Transport a message actually went over (iMessage may downgrade). */
+export declare enum IMessageService {
+    IMESSAGE = "imessage",
+    SMS = "sms",
+    RCS = "rcs"
+}
+/** Provider-facing delivery lifecycle for an iMessage. */
+export declare enum IMessageDeliveryStatus {
+    REGISTERED = "registered",
+    PENDING = "pending",
+    QUEUED = "queued",
+    ACCEPTED = "accepted",
+    SENT = "sent",
+    DELIVERED = "delivered",
+    DECLINED = "declined",
+    ERROR = "error",
+    RECEIVED = "received"
+}
+/**
+ * Tapback reaction kinds.
+ *
+ * `CUSTOM` is inbound-only: recipients can react with any emoji
+ * (carried in `customEmoji`), but sends accept the classic six.
+ */
+export declare enum IMessageReactionType {
+    LOVE = "love",
+    LIKE = "like",
+    DISLIKE = "dislike",
+    LAUGH = "laugh",
+    EMPHASIZE = "emphasize",
+    QUESTION = "question",
+    CUSTOM = "custom"
+}
+/** Expressive send style applied to an outbound iMessage. */
+export declare enum IMessageSendStyle {
+    CELEBRATION = "celebration",
+    SHOOTING_STAR = "shooting_star",
+    FIREWORKS = "fireworks",
+    LASERS = "lasers",
+    LOVE = "love",
+    CONFETTI = "confetti",
+    BALLOONS = "balloons",
+    SPOTLIGHT = "spotlight",
+    ECHO = "echo",
+    INVISIBLE = "invisible",
+    GENTLE = "gentle",
+    LOUD = "loud",
+    SLAM = "slam"
+}
+/** Lifecycle of a recipient's triage-created connection to an agent. */
+export declare enum IMessageAssignmentStatus {
+    ACTIVE = "active",
+    RELEASED = "released"
+}
+/** Whether a matching remote number is allowed through or blocked. */
+export declare enum IMessageRuleAction {
+    ALLOW = "allow",
+    BLOCK = "block"
+}
+/** What an iMessage contact rule matches on. */
+export declare enum IMessageRuleMatchType {
+    EXACT_NUMBER = "exact_number"
+}
+/** Media attachment on an iMessage. */
+export interface IMessageMediaItem {
+    url: string;
+    contentType: string | null;
+    size: number | null;
+}
+/** Per-recipient outbound delivery state for an iMessage. */
+export interface IMessageRecipient {
+    remoteNumber: string;
+    deliveryStatus: IMessageDeliveryStatus | null;
+    service: IMessageService | null;
+    errorCode: string | null;
+    errorMessage: string | null;
+    errorReason: string | null;
+    errorDetail: string | null;
+    sentAt: Date | null;
+    deliveredAt: Date | null;
+    failedAt: Date | null;
+}
+/** A live tapback attached to a message in read responses. */
+export interface IMessageMessageReaction {
+    id: string;
+    /** "inbound" | "outbound" */
+    direction: string;
+    reaction: IMessageReactionType;
+    /** Literal emoji when `reaction` is "custom"; null for the classic six. */
+    customEmoji: string | null;
+    remoteNumber: string;
+    partIndex: number;
+    createdAt: Date;
+}
+/**
+ * An iMessage in an assignment-routed conversation.
+ *
+ * There is no local-number field: shared pool lines are hidden from
+ * agents, so messages are identified by `conversationId` and the
+ * counterparty `remoteNumber` only.
+ */
+export interface IMessage {
+    id: string;
+    conversationId: string;
+    assignmentId: string;
+    /** "inbound" | "outbound" */
+    direction: string;
+    remoteNumber: string;
+    content: string | null;
+    /** "message" | "carousel" */
+    messageType: string;
+    service: IMessageService;
+    sendStyle: IMessageSendStyle | null;
+    media: IMessageMediaItem[] | null;
+    wasDowngraded: boolean | null;
+    status: IMessageDeliveryStatus | null;
+    errorCode: string | null;
+    errorMessage: string | null;
+    errorReason: string | null;
+    errorDetail: string | null;
+    isRead: boolean;
+    isBlocked: boolean;
+    recipients: IMessageRecipient[] | null;
+    /** Live (non-removed) tapbacks targeting this message, oldest first. */
+    reactions: IMessageMessageReaction[] | null;
+    createdAt: Date;
+    updatedAt: Date;
+}
+/**
+ * One assignment-scoped iMessage conversation.
+ *
+ * `assignmentStatus` reflects the current connection: non-active means
+ * the recipient is disconnected and the agent cannot reply until they
+ * reconnect through triage.
+ */
+export interface IMessageConversation {
+    id: string;
+    assignmentId: string;
+    assignmentStatus: IMessageAssignmentStatus;
+    remoteNumber: string;
+    createdAt: Date;
+    updatedAt: Date;
+}
+/** Conversation list row with latest-message preview. */
+export interface IMessageConversationSummary {
+    id: string;
+    assignmentId: string;
+    assignmentStatus: IMessageAssignmentStatus;
+    remoteNumber: string;
+    latestText: string | null;
+    latestMessageAt: Date | null;
+    latestDirection: string | null;
+    latestHasMedia: boolean;
+    unreadCount: number;
+    totalCount: number;
+}
+/** A tapback reaction on an iMessage. */
+export interface IMessageReaction {
+    id: string;
+    conversationId: string;
+    assignmentId: string;
+    targetMessageId: string;
+    /** "inbound" | "outbound" */
+    direction: string;
+    reaction: IMessageReactionType;
+    /** Literal emoji when `reaction` is "custom"; null for the classic six. */
+    customEmoji: string | null;
+    remoteNumber: string;
+    partIndex: number;
+    createdAt: Date;
+    updatedAt: Date;
+}
+/** An active connection between one recipient and one agent identity. */
+export interface IMessageAssignment {
+    id: string;
+    remoteNumber: string;
+    agentIdentityId: string;
+    organizationId: string;
+    status: IMessageAssignmentStatus;
+    releasedAt: Date | null;
+    createdAt: Date;
+    updatedAt: Date;
+}
+/** The active triage line and how recipients start a connection. */
+export interface IMessageTriageNumber {
+    number: string;
+    connectCommand: string;
+}
+/** Result of marking a conversation's inbound messages read. */
+export interface IMessageMarkReadResult {
+    conversationId: string;
+    updatedCount: number;
+}
+/** A reusable media URL returned by the iMessage media upload. */
+export interface IMessageMediaUpload {
+    mediaUrl: string;
+    contentType: string | null;
+    size: number | null;
+}
+/** An allow/block rule scoped to an agent identity for iMessage. */
+export interface IMessageContactRule {
+    id: string;
+    agentIdentityId: string;
+    action: IMessageRuleAction;
+    matchType: IMessageRuleMatchType;
+    matchTarget: string;
+    status: ContactRuleStatus;
+    createdAt: Date;
+    updatedAt: Date;
+}
+export interface RawIMessageMediaItem {
+    url: string;
+    content_type?: string | null;
+    size?: number | null;
+}
+export interface RawIMessageRecipient {
+    remote_number: string;
+    delivery_status?: string | null;
+    service?: string | null;
+    error_code?: string | null;
+    error_message?: string | null;
+    error_reason?: string | null;
+    error_detail?: string | null;
+    sent_at?: string | null;
+    delivered_at?: string | null;
+    failed_at?: string | null;
+}
+export interface RawIMessageMessageReaction {
+    id: string;
+    direction: string;
+    reaction: string;
+    custom_emoji?: string | null;
+    remote_number: string;
+    part_index?: number;
+    created_at: string;
+}
+export interface RawIMessage {
+    id: string;
+    conversation_id: string;
+    assignment_id: string;
+    direction: string;
+    remote_number: string;
+    content?: string | null;
+    message_type: string;
+    service: string;
+    send_style?: string | null;
+    media?: RawIMessageMediaItem[] | null;
+    was_downgraded?: boolean | null;
+    status?: string | null;
+    error_code?: string | null;
+    error_message?: string | null;
+    error_reason?: string | null;
+    error_detail?: string | null;
+    is_read: boolean;
+    is_blocked?: boolean;
+    recipients?: RawIMessageRecipient[] | null;
+    reactions?: RawIMessageMessageReaction[] | null;
+    created_at: string;
+    updated_at: string;
+}
+export interface RawIMessageConversation {
+    id: string;
+    assignment_id: string;
+    assignment_status?: string | null;
+    remote_number: string;
+    created_at: string;
+    updated_at: string;
+}
+export interface RawIMessageAssignment {
+    id: string;
+    remote_number: string;
+    agent_identity_id: string;
+    organization_id: string;
+    status: string;
+    released_at?: string | null;
+    created_at: string;
+    updated_at: string;
+}
+export interface RawIMessageConversationSummary extends RawIMessageConversation {
+    latest_text?: string | null;
+    latest_message_at?: string | null;
+    latest_direction?: string | null;
+    latest_has_media?: boolean;
+    unread_count?: number;
+    total_count?: number;
+}
+export interface RawIMessageReaction {
+    id: string;
+    conversation_id: string;
+    assignment_id: string;
+    target_message_id: string;
+    direction: string;
+    reaction: string;
+    custom_emoji?: string | null;
+    remote_number: string;
+    part_index?: number;
+    created_at: string;
+    updated_at: string;
+}
+export interface RawIMessageTriageNumber {
+    number: string;
+    connect_command: string;
+}
+export interface RawIMessageContactRule {
+    id: string;
+    agent_identity_id: string;
+    action: string;
+    match_type: string;
+    match_target: string;
+    status: string;
+    created_at: string;
+    updated_at: string;
+}
+export declare function parseIMessageMediaItem(r: RawIMessageMediaItem): IMessageMediaItem;
+export declare function parseIMessageRecipient(r: RawIMessageRecipient): IMessageRecipient;
+export declare function parseIMessageMessageReaction(r: RawIMessageMessageReaction): IMessageMessageReaction;
+export declare function parseIMessage(r: RawIMessage): IMessage;
+export declare function parseIMessageConversation(r: RawIMessageConversation): IMessageConversation;
+export declare function parseIMessageAssignment(r: RawIMessageAssignment): IMessageAssignment;
+export declare function parseIMessageConversationSummary(r: RawIMessageConversationSummary): IMessageConversationSummary;
+export declare function parseIMessageReaction(r: RawIMessageReaction): IMessageReaction;
+export declare function parseIMessageTriageNumber(r: RawIMessageTriageNumber): IMessageTriageNumber;
+export declare function parseIMessageContactRule(r: RawIMessageContactRule): IMessageContactRule;
+//# sourceMappingURL=types.d.ts.map

package/dist/imessage/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../src/imessage/types.ts"],"names":[],"mappings":"AAAA;;;;;;;;;GASG;AAEH,OAAO,EAAE,iBAAiB,EAAE,MAAM,kBAAkB,CAAC;AAErD,uEAAuE;AACvE,oBAAY,eAAe;IACzB,QAAQ,aAAa;IACrB,GAAG,QAAQ;IACX,GAAG,QAAQ;CACZ;AAED,0DAA0D;AAC1D,oBAAY,sBAAsB;IAChC,UAAU,eAAe;IACzB,OAAO,YAAY;IACnB,MAAM,WAAW;IACjB,QAAQ,aAAa;IACrB,IAAI,SAAS;IACb,SAAS,cAAc;IACvB,QAAQ,aAAa;IACrB,KAAK,UAAU;IACf,QAAQ,aAAa;CACtB;AAED;;;;;GAKG;AACH,oBAAY,oBAAoB;IAC9B,IAAI,SAAS;IACb,IAAI,SAAS;IACb,OAAO,YAAY;IACnB,KAAK,UAAU;IACf,SAAS,cAAc;IACvB,QAAQ,aAAa;IACrB,MAAM,WAAW;CAClB;AAED,6DAA6D;AAC7D,oBAAY,iBAAiB;IAC3B,WAAW,gBAAgB;IAC3B,aAAa,kBAAkB;IAC/B,SAAS,cAAc;IACvB,MAAM,WAAW;IACjB,IAAI,SAAS;IACb,QAAQ,aAAa;IACrB,QAAQ,aAAa;IACrB,SAAS,cAAc;IACvB,IAAI,SAAS;IACb,SAAS,cAAc;IACvB,MAAM,WAAW;IACjB,IAAI,SAAS;IACb,IAAI,SAAS;CACd;AAED,wEAAwE;AACxE,oBAAY,wBAAwB;IAClC,MAAM,WAAW;IACjB,QAAQ,aAAa;CACtB;AAED,sEAAsE;AACtE,oBAAY,kBAAkB;IAC5B,KAAK,UAAU;IACf,KAAK,UAAU;CAChB;AAED,gDAAgD;AAChD,oBAAY,qBAAqB;IAC/B,YAAY,iBAAiB;CAC9B;AAED,uCAAuC;AACvC,MAAM,WAAW,iBAAiB;IAChC,GAAG,EAAE,MAAM,CAAC;IACZ,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;IAC3B,IAAI,EAAE,MAAM,GAAG,IAAI,CAAC;CACrB;AAED,6DAA6D;AAC7D,MAAM,WAAW,iBAAiB;IAChC,YAAY,EAAE,MAAM,CAAC;IACrB,cAAc,EAAE,sBAAsB,GAAG,IAAI,CAAC;IAC9C,OAAO,EAAE,eAAe,GAAG,IAAI,CAAC;IAChC,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;IACzB,YAAY,EAAE,MAAM,GAAG,IAAI,CAAC;IAC5B,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;IAC3B,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;IAC3B,MAAM,EAAE,IAAI,GAAG,IAAI,CAAC;IACpB,WAAW,EAAE,IAAI,GAAG,IAAI,CAAC;IACzB,QAAQ,EAAE,IAAI,GAAG,IAAI,CAAC;CACvB;AAED,8DAA8D;AAC9D,MAAM,WAAW,uBAAuB;IACtC,EAAE,EAAE,MAAM,CAAC;IACX,6BAA6B;IAC7B,SAAS,EAAE,MAAM,CAAC;IAClB,QAAQ,EAAE,oBAAoB,CAAC;IAC/B,2EAA2E;IAC3E,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;IAC3B,YAAY,EAAE,MAAM,CAAC;IACrB,SAAS,EAAE,MAAM,CAAC;IAClB,SAAS,EAAE,IAAI,CAAC;CACjB;AAED;;;;;;GAMG;AACH,MAAM,WAAW,QAAQ;IACvB,EAAE,EAAE,MAAM,CAAC;IACX,cAAc,EAAE,MAAM,CAAC;IACvB,YAAY,EAAE,MAAM,CAAC;IACrB,6BAA6B;IAC7B,SAAS,EAAE,MAAM,CAAC;IAClB,YAAY,EAAE,MAAM,CAAC;IACrB,OAAO,EAAE,MAAM,GAAG,IAAI,CAAC;IACvB,6BAA6B;IAC7B,WAAW,EAAE,MAAM,CAAC;IACpB,OAAO,EAAE,eAAe,CAAC;IACzB,SAAS,EAAE,iBAAiB,GAAG,IAAI,CAAC;IACpC,KAAK,EAAE,iBAAiB,EAAE,GAAG,IAAI,CAAC;IAClC,aAAa,EAAE,OAAO,GAAG,IAAI,CAAC;IAC9B,MAAM,EAAE,sBAAsB,GAAG,IAAI,CAAC;IACtC,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;IACzB,YAAY,EAAE,MAAM,GAAG,IAAI,CAAC;IAC5B,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;IAC3B,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;IAC3B,MAAM,EAAE,OAAO,CAAC;IAChB,SAAS,EAAE,OAAO,CAAC;IACnB,UAAU,EAAE,iBAAiB,EAAE,GAAG,IAAI,CAAC;IACvC,wEAAwE;IACxE,SAAS,EAAE,uBAAuB,EAAE,GAAG,IAAI,CAAC;IAC5C,SAAS,EAAE,IAAI,CAAC;IAChB,SAAS,EAAE,IAAI,CAAC;CACjB;AAED;;;;;;GAMG;AACH,MAAM,WAAW,oBAAoB;IACnC,EAAE,EAAE,MAAM,CAAC;IACX,YAAY,EAAE,MAAM,CAAC;IACrB,gBAAgB,EAAE,wBAAwB,CAAC;IAC3C,YAAY,EAAE,MAAM,CAAC;IACrB,SAAS,EAAE,IAAI,CAAC;IAChB,SAAS,EAAE,IAAI,CAAC;CACjB;AAED,yDAAyD;AACzD,MAAM,WAAW,2BAA2B;IAC1C,EAAE,EAAE,MAAM,CAAC;IACX,YAAY,EAAE,MAAM,CAAC;IACrB,gBAAgB,EAAE,wBAAwB,CAAC;IAC3C,YAAY,EAAE,MAAM,CAAC;IACrB,UAAU,EAAE,MAAM,GAAG,IAAI,CAAC;IAC1B,eAAe,EAAE,IAAI,GAAG,IAAI,CAAC;IAC7B,eAAe,EAAE,MAAM,GAAG,IAAI,CAAC;IAC/B,cAAc,EAAE,OAAO,CAAC;IACxB,WAAW,EAAE,MAAM,CAAC;IACpB,UAAU,EAAE,MAAM,CAAC;CACpB;AAED,yCAAyC;AACzC,MAAM,WAAW,gBAAgB;IAC/B,EAAE,EAAE,MAAM,CAAC;IACX,cAAc,EAAE,MAAM,CAAC;IACvB,YAAY,EAAE,MAAM,CAAC;IACrB,eAAe,EAAE,MAAM,CAAC;IACxB,6BAA6B;IAC7B,SAAS,EAAE,MAAM,CAAC;IAClB,QAAQ,EAAE,oBAAoB,CAAC;IAC/B,2EAA2E;IAC3E,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;IAC3B,YAAY,EAAE,MAAM,CAAC;IACrB,SAAS,EAAE,MAAM,CAAC;IAClB,SAAS,EAAE,IAAI,CAAC;IAChB,SAAS,EAAE,IAAI,CAAC;CACjB;AAED,yEAAyE;AACzE,MAAM,WAAW,kBAAkB;IACjC,EAAE,EAAE,MAAM,CAAC;IACX,YAAY,EAAE,MAAM,CAAC;IACrB,eAAe,EAAE,MAAM,CAAC;IACxB,cAAc,EAAE,MAAM,CAAC;IACvB,MAAM,EAAE,wBAAwB,CAAC;IACjC,UAAU,EAAE,IAAI,GAAG,IAAI,CAAC;IACxB,SAAS,EAAE,IAAI,CAAC;IAChB,SAAS,EAAE,IAAI,CAAC;CACjB;AAED,oEAAoE;AACpE,MAAM,WAAW,oBAAoB;IACnC,MAAM,EAAE,MAAM,CAAC;IACf,cAAc,EAAE,MAAM,CAAC;CACxB;AAED,gEAAgE;AAChE,MAAM,WAAW,sBAAsB;IACrC,cAAc,EAAE,MAAM,CAAC;IACvB,YAAY,EAAE,MAAM,CAAC;CACtB;AAED,kEAAkE;AAClE,MAAM,WAAW,mBAAmB;IAClC,QAAQ,EAAE,MAAM,CAAC;IACjB,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;IAC3B,IAAI,EAAE,MAAM,GAAG,IAAI,CAAC;CACrB;AAED,oEAAoE;AACpE,MAAM,WAAW,mBAAmB;IAClC,EAAE,EAAE,MAAM,CAAC;IACX,eAAe,EAAE,MAAM,CAAC;IACxB,MAAM,EAAE,kBAAkB,CAAC;IAC3B,SAAS,EAAE,qBAAqB,CAAC;IACjC,WAAW,EAAE,MAAM,CAAC;IACpB,MAAM,EAAE,iBAAiB,CAAC;IAC1B,SAAS,EAAE,IAAI,CAAC;IAChB,SAAS,EAAE,IAAI,CAAC;CACjB;AAID,MAAM,WAAW,oBAAoB;IACnC,GAAG,EAAE,MAAM,CAAC;IACZ,YAAY,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC7B,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACtB;AAED,MAAM,WAAW,oBAAoB;IACnC,aAAa,EAAE,MAAM,CAAC;IACtB,eAAe,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAChC,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACxB,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC3B,aAAa,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC9B,YAAY,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC7B,YAAY,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC7B,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACxB,YAAY,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC7B,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAC3B;AAED,MAAM,WAAW,0BAA0B;IACzC,EAAE,EAAE,MAAM,CAAC;IACX,SAAS,EAAE,MAAM,CAAC;IAClB,QAAQ,EAAE,MAAM,CAAC;IACjB,YAAY,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC7B,aAAa,EAAE,MAAM,CAAC;IACtB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,UAAU,EAAE,MAAM,CAAC;CACpB;AAED,MAAM,WAAW,WAAW;IAC1B,EAAE,EAAE,MAAM,CAAC;IACX,eAAe,EAAE,MAAM,CAAC;IACxB,aAAa,EAAE,MAAM,CAAC;IACtB,SAAS,EAAE,MAAM,CAAC;IAClB,aAAa,EAAE,MAAM,CAAC;IACtB,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACxB,YAAY,EAAE,MAAM,CAAC;IACrB,OAAO,EAAE,MAAM,CAAC;IAChB,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC3B,KAAK,CAAC,EAAE,oBAAoB,EAAE,GAAG,IAAI,CAAC;IACtC,cAAc,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;IAChC,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACvB,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC3B,aAAa,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC9B,YAAY,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC7B,YAAY,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC7B,OAAO,EAAE,OAAO,CAAC;IACjB,UAAU,CAAC,EAAE,OAAO,CAAC;IACrB,UAAU,CAAC,EAAE,oBAAoB,EAAE,GAAG,IAAI,CAAC;IAC3C,SAAS,CAAC,EAAE,0BAA0B,EAAE,GAAG,IAAI,CAAC;IAChD,UAAU,EAAE,MAAM,CAAC;IACnB,UAAU,EAAE,MAAM,CAAC;CACpB;AAED,MAAM,WAAW,uBAAuB;IACtC,EAAE,EAAE,MAAM,CAAC;IACX,aAAa,EAAE,MAAM,CAAC;IACtB,iBAAiB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAClC,aAAa,EAAE,MAAM,CAAC;IACtB,UAAU,EAAE,MAAM,CAAC;IACnB,UAAU,EAAE,MAAM,CAAC;CACpB;AAED,MAAM,WAAW,qBAAqB;IACpC,EAAE,EAAE,MAAM,CAAC;IACX,aAAa,EAAE,MAAM,CAAC;IACtB,iBAAiB,EAAE,MAAM,CAAC;IAC1B,eAAe,EAAE,MAAM,CAAC;IACxB,MAAM,EAAE,MAAM,CAAC;IACf,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC5B,UAAU,EAAE,MAAM,CAAC;IACnB,UAAU,EAAE,MAAM,CAAC;CACpB;AAED,MAAM,WAAW,8BAA+B,SAAQ,uBAAuB;IAC7E,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC5B,iBAAiB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAClC,gBAAgB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACjC,gBAAgB,CAAC,EAAE,OAAO,CAAC;IAC3B,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB;AAED,MAAM,WAAW,mBAAmB;IAClC,EAAE,EAAE,MAAM,CAAC;IACX,eAAe,EAAE,MAAM,CAAC;IACxB,aAAa,EAAE,MAAM,CAAC;IACtB,iBAAiB,EAAE,MAAM,CAAC;IAC1B,SAAS,EAAE,MAAM,CAAC;IAClB,QAAQ,EAAE,MAAM,CAAC;IACjB,YAAY,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC7B,aAAa,EAAE,MAAM,CAAC;IACtB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,UAAU,EAAE,MAAM,CAAC;IACnB,UAAU,EAAE,MAAM,CAAC;CACpB;AAED,MAAM,WAAW,uBAAuB;IACtC,MAAM,EAAE,MAAM,CAAC;IACf,eAAe,EAAE,MAAM,CAAC;CACzB;AAED,MAAM,WAAW,sBAAsB;IACrC,EAAE,EAAE,MAAM,CAAC;IACX,iBAAiB,EAAE,MAAM,CAAC;IAC1B,MAAM,EAAE,MAAM,CAAC;IACf,UAAU,EAAE,MAAM,CAAC;IACnB,YAAY,EAAE,MAAM,CAAC;IACrB,MAAM,EAAE,MAAM,CAAC;IACf,UAAU,EAAE,MAAM,CAAC;IACnB,UAAU,EAAE,MAAM,CAAC;CACpB;AAID,wBAAgB,sBAAsB,CAAC,CAAC,EAAE,oBAAoB,GAAG,iBAAiB,CAMjF;AAED,wBAAgB,sBAAsB,CAAC,CAAC,EAAE,oBAAoB,GAAG,iBAAiB,CAajF;AAED,wBAAgB,4BAA4B,CAC1C,CAAC,EAAE,0BAA0B,GAC5B,uBAAuB,CAUzB;AAED,wBAAgB,aAAa,CAAC,CAAC,EAAE,WAAW,GAAG,QAAQ,CAyBtD;AAED,wBAAgB,yBAAyB,CACvC,CAAC,EAAE,uBAAuB,GACzB,oBAAoB,CAUtB;AAED,wBAAgB,uBAAuB,CAAC,CAAC,EAAE,qBAAqB,GAAG,kBAAkB,CAWpF;AAED,wBAAgB,gCAAgC,CAC9C,CAAC,EAAE,8BAA8B,GAChC,2BAA2B,CAc7B;AAED,wBAAgB,qBAAqB,CAAC,CAAC,EAAE,mBAAmB,GAAG,gBAAgB,CAc9E;AAED,wBAAgB,yBAAyB,CACvC,CAAC,EAAE,uBAAuB,GACzB,oBAAoB,CAKtB;AAED,wBAAgB,wBAAwB,CACtC,CAAC,EAAE,sBAAsB,GACxB,mBAAmB,CAWrB"}