telnyx 7.12.0 → 7.14.0

package/resources/email-inboxes/threads/labels.d.ts

@@ -0,0 +1,99 @@
+import { APIResource } from "../../../core/resource.js";
+import { APIPromise } from "../../../core/api-promise.js";
+import { RequestOptions } from "../../../internal/request-options.js";
+/**
+ * Create and manage agent inboxes, retrieve inbound messages and threads, and reply to or forward messages.
+ */
+export declare class Labels extends APIResource {
+    /**
+     * Removes one or more labels from a thread. Idempotent — removing a label the
+     * thread does not carry is a no-op and still returns 200.
+     *
+     * @example
+     * ```ts
+     * const response =
+     *   await client.emailInboxes.threads.labels.deleteAll(
+     *     '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
+     *     {
+     *       inbox_id: '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
+     *       labels: ['needs_review'],
+     *     },
+     *   );
+     * ```
+     */
+    deleteAll(threadID: string, params: LabelDeleteAllParams, options?: RequestOptions): APIPromise<LabelDeleteAllResponse>;
+    /**
+     * Adds one or more mutable labels to a thread, letting an agent mark a whole
+     * conversation (for example `needs_review`) without labelling each message
+     * individually.
+     *
+     * Thread labels are independent of message labels: labelling a thread does not
+     * label its messages, and labelling a message does not label its thread.
+     * Idempotent and case-sensitive.
+     *
+     * @example
+     * ```ts
+     * const label =
+     *   await client.emailInboxes.threads.labels.create(
+     *     '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
+     *     {
+     *       inbox_id: '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
+     *       labels: ['needs_review'],
+     *     },
+     *   );
+     * ```
+     */
+    create(threadID: string, params: LabelCreateParams, options?: RequestOptions): APIPromise<LabelCreateResponse>;
+}
+export interface LabelCreateResponse {
+    data: LabelCreateResponse.Data;
+}
+export declare namespace LabelCreateResponse {
+    interface Data {
+        id: string;
+        labels: Array<string>;
+        record_type: 'email_thread';
+        inbox_id?: string;
+    }
+}
+export interface LabelDeleteAllResponse {
+    data: LabelDeleteAllResponse.Data;
+}
+export declare namespace LabelDeleteAllResponse {
+    interface Data {
+        id: string;
+        labels: Array<string>;
+        record_type: 'email_thread';
+        inbox_id?: string;
+    }
+}
+export interface LabelDeleteAllParams {
+    /**
+     * Path param: Email inbox UUID.
+     */
+    inbox_id: string;
+    /**
+     * Body param: One or more labels. Each label is a freeform, case-sensitive string
+     * of at most 255 characters; a message or thread may carry at most 50 labels. The
+     * `telnyx:` prefix is a reserved system namespace and is rejected on customer
+     * writes.
+     */
+    labels: Array<string>;
+}
+export interface LabelCreateParams {
+    /**
+     * Path param: Email inbox UUID.
+     */
+    inbox_id: string;
+    /**
+     * Body param: One or more labels. Each label is a freeform, case-sensitive string
+     * of at most 255 characters; a message or thread may carry at most 50 labels. The
+     * `telnyx:` prefix is a reserved system namespace and is rejected on customer
+     * writes.
+     */
+    labels: Array<string>;
+}
+export declare namespace Labels {
+    export { type LabelCreateResponse as LabelCreateResponse, type LabelDeleteAllResponse as LabelDeleteAllResponse, type LabelDeleteAllParams as LabelDeleteAllParams, type LabelCreateParams as LabelCreateParams, };
+}
+//# sourceMappingURL=labels.d.ts.map

package/resources/email-inboxes/threads/labels.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"labels.d.ts","sourceRoot":"","sources":["../../../src/resources/email-inboxes/threads/labels.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,kCAA+B;AACrD,OAAO,EAAE,UAAU,EAAE,qCAAkC;AACvD,OAAO,EAAE,cAAc,EAAE,6CAA0C;AAGnE;;GAEG;AACH,qBAAa,MAAO,SAAQ,WAAW;IACrC;;;;;;;;;;;;;;;OAeG;IACH,SAAS,CACP,QAAQ,EAAE,MAAM,EAChB,MAAM,EAAE,oBAAoB,EAC5B,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,sBAAsB,CAAC;IAQrC;;;;;;;;;;;;;;;;;;;;OAoBG;IACH,MAAM,CACJ,QAAQ,EAAE,MAAM,EAChB,MAAM,EAAE,iBAAiB,EACzB,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,mBAAmB,CAAC;CAOnC;AAED,MAAM,WAAW,mBAAmB;IAClC,IAAI,EAAE,mBAAmB,CAAC,IAAI,CAAC;CAChC;AAED,yBAAiB,mBAAmB,CAAC;IACnC,UAAiB,IAAI;QACnB,EAAE,EAAE,MAAM,CAAC;QAEX,MAAM,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;QAEtB,WAAW,EAAE,cAAc,CAAC;QAE5B,QAAQ,CAAC,EAAE,MAAM,CAAC;KACnB;CACF;AAED,MAAM,WAAW,sBAAsB;IACrC,IAAI,EAAE,sBAAsB,CAAC,IAAI,CAAC;CACnC;AAED,yBAAiB,sBAAsB,CAAC;IACtC,UAAiB,IAAI;QACnB,EAAE,EAAE,MAAM,CAAC;QAEX,MAAM,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;QAEtB,WAAW,EAAE,cAAc,CAAC;QAE5B,QAAQ,CAAC,EAAE,MAAM,CAAC;KACnB;CACF;AAED,MAAM,WAAW,oBAAoB;IACnC;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;;;;OAKG;IACH,MAAM,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;CACvB;AAED,MAAM,WAAW,iBAAiB;IAChC;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;;;;OAKG;IACH,MAAM,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;CACvB;AAED,MAAM,CAAC,OAAO,WAAW,MAAM,CAAC;IAC9B,OAAO,EACL,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,iBAAiB,IAAI,iBAAiB,GAC5C,CAAC;CACH"}

package/resources/email-inboxes/threads/labels.js

@@ -0,0 +1,64 @@
+"use strict";
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Labels = void 0;
+const resource_1 = require("../../../core/resource.js");
+const path_1 = require("../../../internal/utils/path.js");
+/**
+ * Create and manage agent inboxes, retrieve inbound messages and threads, and reply to or forward messages.
+ */
+class Labels extends resource_1.APIResource {
+    /**
+     * Removes one or more labels from a thread. Idempotent — removing a label the
+     * thread does not carry is a no-op and still returns 200.
+     *
+     * @example
+     * ```ts
+     * const response =
+     *   await client.emailInboxes.threads.labels.deleteAll(
+     *     '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
+     *     {
+     *       inbox_id: '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
+     *       labels: ['needs_review'],
+     *     },
+     *   );
+     * ```
+     */
+    deleteAll(threadID, params, options) {
+        const { inbox_id, ...body } = params;
+        return this._client.delete((0, path_1.path) `/email_inboxes/${inbox_id}/threads/${threadID}/labels`, {
+            body,
+            ...options,
+        });
+    }
+    /**
+     * Adds one or more mutable labels to a thread, letting an agent mark a whole
+     * conversation (for example `needs_review`) without labelling each message
+     * individually.
+     *
+     * Thread labels are independent of message labels: labelling a thread does not
+     * label its messages, and labelling a message does not label its thread.
+     * Idempotent and case-sensitive.
+     *
+     * @example
+     * ```ts
+     * const label =
+     *   await client.emailInboxes.threads.labels.create(
+     *     '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
+     *     {
+     *       inbox_id: '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
+     *       labels: ['needs_review'],
+     *     },
+     *   );
+     * ```
+     */
+    create(threadID, params, options) {
+        const { inbox_id, ...body } = params;
+        return this._client.post((0, path_1.path) `/email_inboxes/${inbox_id}/threads/${threadID}/labels`, {
+            body,
+            ...options,
+        });
+    }
+}
+exports.Labels = Labels;
+//# sourceMappingURL=labels.js.map

package/resources/email-inboxes/threads/labels.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"labels.js","sourceRoot":"","sources":["../../../src/resources/email-inboxes/threads/labels.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,wDAAqD;AAGrD,0DAAoD;AAEpD;;GAEG;AACH,MAAa,MAAO,SAAQ,sBAAW;IACrC;;;;;;;;;;;;;;;OAeG;IACH,SAAS,CACP,QAAgB,EAChB,MAA4B,EAC5B,OAAwB;QAExB,MAAM,EAAE,QAAQ,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,CAAC;QACrC,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAA,WAAI,EAAA,kBAAkB,QAAQ,YAAY,QAAQ,SAAS,EAAE;YACtF,IAAI;YACJ,GAAG,OAAO;SACX,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;;;;;;;;;OAoBG;IACH,MAAM,CACJ,QAAgB,EAChB,MAAyB,EACzB,OAAwB;QAExB,MAAM,EAAE,QAAQ,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,CAAC;QACrC,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAA,WAAI,EAAA,kBAAkB,QAAQ,YAAY,QAAQ,SAAS,EAAE;YACpF,IAAI;YACJ,GAAG,OAAO;SACX,CAAC,CAAC;IACL,CAAC;CACF;AA7DD,wBA6DC"}

package/resources/email-inboxes/threads/labels.mjs

@@ -0,0 +1,60 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+import { APIResource } from "../../../core/resource.mjs";
+import { path } from "../../../internal/utils/path.mjs";
+/**
+ * Create and manage agent inboxes, retrieve inbound messages and threads, and reply to or forward messages.
+ */
+export class Labels extends APIResource {
+    /**
+     * Removes one or more labels from a thread. Idempotent — removing a label the
+     * thread does not carry is a no-op and still returns 200.
+     *
+     * @example
+     * ```ts
+     * const response =
+     *   await client.emailInboxes.threads.labels.deleteAll(
+     *     '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
+     *     {
+     *       inbox_id: '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
+     *       labels: ['needs_review'],
+     *     },
+     *   );
+     * ```
+     */
+    deleteAll(threadID, params, options) {
+        const { inbox_id, ...body } = params;
+        return this._client.delete(path `/email_inboxes/${inbox_id}/threads/${threadID}/labels`, {
+            body,
+            ...options,
+        });
+    }
+    /**
+     * Adds one or more mutable labels to a thread, letting an agent mark a whole
+     * conversation (for example `needs_review`) without labelling each message
+     * individually.
+     *
+     * Thread labels are independent of message labels: labelling a thread does not
+     * label its messages, and labelling a message does not label its thread.
+     * Idempotent and case-sensitive.
+     *
+     * @example
+     * ```ts
+     * const label =
+     *   await client.emailInboxes.threads.labels.create(
+     *     '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
+     *     {
+     *       inbox_id: '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
+     *       labels: ['needs_review'],
+     *     },
+     *   );
+     * ```
+     */
+    create(threadID, params, options) {
+        const { inbox_id, ...body } = params;
+        return this._client.post(path `/email_inboxes/${inbox_id}/threads/${threadID}/labels`, {
+            body,
+            ...options,
+        });
+    }
+}
+//# sourceMappingURL=labels.mjs.map

package/resources/email-inboxes/threads/labels.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"labels.mjs","sourceRoot":"","sources":["../../../src/resources/email-inboxes/threads/labels.ts"],"names":[],"mappings":"AAAA,sFAAsF;AAEtF,OAAO,EAAE,WAAW,EAAE,mCAA+B;AAGrD,OAAO,EAAE,IAAI,EAAE,yCAAqC;AAEpD;;GAEG;AACH,MAAM,OAAO,MAAO,SAAQ,WAAW;IACrC;;;;;;;;;;;;;;;OAeG;IACH,SAAS,CACP,QAAgB,EAChB,MAA4B,EAC5B,OAAwB;QAExB,MAAM,EAAE,QAAQ,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,CAAC;QACrC,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,CAAA,kBAAkB,QAAQ,YAAY,QAAQ,SAAS,EAAE;YACtF,IAAI;YACJ,GAAG,OAAO;SACX,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;;;;;;;;;OAoBG;IACH,MAAM,CACJ,QAAgB,EAChB,MAAyB,EACzB,OAAwB;QAExB,MAAM,EAAE,QAAQ,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,CAAC;QACrC,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAA,kBAAkB,QAAQ,YAAY,QAAQ,SAAS,EAAE;YACpF,IAAI;YACJ,GAAG,OAAO;SACX,CAAC,CAAC;IACL,CAAC;CACF"}

package/resources/email-inboxes/threads/threads.d.mts

@@ -0,0 +1,199 @@
+import { APIResource } from "../../../core/resource.mjs";
+import * as LabelsAPI from "./labels.mjs";
+import { LabelCreateParams, LabelCreateResponse, LabelDeleteAllParams, LabelDeleteAllResponse, Labels } from "./labels.mjs";
+import { APIPromise } from "../../../core/api-promise.mjs";
+import { RequestOptions } from "../../../internal/request-options.mjs";
+/**
+ * Create and manage agent inboxes, retrieve inbound messages and threads, and reply to or forward messages.
+ */
+export declare class Threads extends APIResource {
+    labels: LabelsAPI.Labels;
+    /**
+     * Lists thread summaries newest first using stable cursor pagination.
+     *
+     * @example
+     * ```ts
+     * const inboundThreadListResponse =
+     *   await client.emailInboxes.threads.list(
+     *     '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
+     *   );
+     * ```
+     */
+    list(inboxID: string, query?: ThreadListParams | null | undefined, options?: RequestOptions): APIPromise<InboundThreadListResponse>;
+    /**
+     * Returns a bounded page of inbound and outbound thread messages interleaved in
+     * chronological order using stable cursor pagination.
+     *
+     * @example
+     * ```ts
+     * const thread = await client.emailInboxes.threads.retrieve(
+     *   '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
+     *   { inbox_id: '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e' },
+     * );
+     * ```
+     */
+    retrieve(threadID: string, params: ThreadRetrieveParams, options?: RequestOptions): APIPromise<ThreadRetrieveResponse>;
+}
+export interface EmailPaginationMeta {
+    page_size: number;
+    /**
+     * Cursor for the next page, when more results are available.
+     */
+    page_cursor?: string;
+}
+export interface InboundEmailAddress {
+    email: string;
+    name?: string;
+}
+export interface InboundThread {
+    id: string;
+    created_at: string;
+    inbox_id: string;
+    /**
+     * Mutable thread labels used for agent workflow state. Independent of the labels
+     * on the thread's messages, and distinct from the send-time `tags` on outbound
+     * messages.
+     */
+    labels: Array<string>;
+    last_message_at: string;
+    last_message_id: string;
+    /**
+     * Total inbound and outbound messages in the thread.
+     */
+    message_count: number;
+    preview: string | null;
+    record_type: 'email_thread';
+    subject: string | null;
+    /**
+     * Unread inbound messages; outbound messages never increment this count.
+     */
+    unread_count: number;
+    updated_at: string;
+}
+export interface InboundThreadDetail extends InboundThread {
+    messages: Array<ThreadMessage>;
+}
+export interface InboundThreadListResponse {
+    data: Array<InboundThread>;
+    meta: EmailPaginationMeta;
+}
+export interface ThreadMessage {
+    id: string;
+    attachments: Array<{
+        [key: string]: unknown;
+    }>;
+    bcc: Array<InboundEmailAddress>;
+    cc: Array<InboundEmailAddress>;
+    created_at: string;
+    direction: 'inbound' | 'outbound';
+    from: InboundEmailAddress;
+    /**
+     * Whether conservative plain-text extraction detected a quoted tail. False does
+     * not prove that the source contains no quoted content.
+     */
+    has_quoted_text: boolean;
+    headers: {
+        [key: string]: unknown;
+    };
+    /**
+     * URL for an offloaded HTML body. Null means the body is not offloaded to a URL;
+     * an inline HTML body may still exist but is not returned on list reads. Reply
+     * extraction uses only the plain-text body during ingest.
+     */
+    html_body_url: string | null;
+    in_reply_to: string | null;
+    inbox_id: string;
+    inline_files: Array<{
+        [key: string]: unknown;
+    }>;
+    /**
+     * Mutable message labels used for agent workflow state (for example `spam`,
+     * `needs_review`, `processed`). Distinct from the immutable send-time `tags` on
+     * outbound messages: labels are never propagated to Email Detail Records or
+     * Mission Control reporting. Always empty for outbound messages. Labels on a
+     * message are independent of the labels on its thread.
+     */
+    labels: Array<string>;
+    /**
+     * RFC Message-ID header. Null is possible for legacy outbound messages.
+     */
+    message_id: string | null;
+    /**
+     * Time the inbound message was marked read. Null means unread.
+     */
+    read_at: string | null;
+    /**
+     * Receipt time for inbound messages; null for outbound messages.
+     */
+    received_at: string | null;
+    record_type: 'email_message';
+    /**
+     * Ordered RFC Message-ID values from the References header.
+     */
+    references: Array<string>;
+    /**
+     * Conservatively extracted new-reply content persisted from the plain-text body
+     * during ingest. Null means no plain-text extraction input was available or
+     * extraction was skipped or failed; HTML bodies are not parsed.
+     */
+    reply_text: string | null;
+    reply_to: Array<InboundEmailAddress>;
+    /**
+     * Creation/send-acceptance time for outbound messages; null for inbound messages.
+     */
+    sent_at: string | null;
+    /**
+     * Received for inbound messages; the current send status for outbound messages.
+     */
+    status: string;
+    subject: string | null;
+    /**
+     * URL for an offloaded plain-text body. Null means the body is not offloaded to a
+     * URL; an inline plain-text body may still exist but is not returned on list
+     * reads. `reply_text` and `has_quoted_text` are persisted during ingest before any
+     * body offload.
+     */
+    text_body_url: string | null;
+    thread_id: string;
+    to: Array<InboundEmailAddress>;
+    updated_at: string;
+}
+export interface ThreadRetrieveResponse {
+    data: InboundThreadDetail;
+    meta: EmailPaginationMeta;
+}
+export interface ThreadListParams {
+    /**
+     * Returns only threads carrying this label. Thread labels are independent of the
+     * labels on the thread's messages.
+     */
+    'filter[label]'?: string;
+    /**
+     * Opaque cursor returned by the previous page.
+     */
+    'page[after]'?: string;
+    /**
+     * Number of results to return. Defaults to 25; maximum is 100.
+     */
+    'page[size]'?: number;
+}
+export interface ThreadRetrieveParams {
+    /**
+     * Path param: Email inbox UUID.
+     */
+    inbox_id: string;
+    /**
+     * Query param: Opaque message cursor returned by the previous thread-detail page.
+     */
+    'page[after]'?: string;
+    /**
+     * Query param: Number of thread messages to return. Defaults to 25; maximum
+     * is 100.
+     */
+    'page[size]'?: number;
+}
+export declare namespace Threads {
+    export { type EmailPaginationMeta as EmailPaginationMeta, type InboundEmailAddress as InboundEmailAddress, type InboundThread as InboundThread, type InboundThreadDetail as InboundThreadDetail, type InboundThreadListResponse as InboundThreadListResponse, type ThreadMessage as ThreadMessage, type ThreadRetrieveResponse as ThreadRetrieveResponse, type ThreadListParams as ThreadListParams, type ThreadRetrieveParams as ThreadRetrieveParams, };
+    export { Labels as Labels, type LabelCreateResponse as LabelCreateResponse, type LabelDeleteAllResponse as LabelDeleteAllResponse, type LabelDeleteAllParams as LabelDeleteAllParams, type LabelCreateParams as LabelCreateParams, };
+}
+//# sourceMappingURL=threads.d.mts.map

package/resources/email-inboxes/threads/threads.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"threads.d.mts","sourceRoot":"","sources":["../../../src/resources/email-inboxes/threads/threads.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,mCAA+B;AACrD,OAAO,KAAK,SAAS,qBAAiB;AACtC,OAAO,EACL,iBAAiB,EACjB,mBAAmB,EACnB,oBAAoB,EACpB,sBAAsB,EACtB,MAAM,EACP,qBAAiB;AAClB,OAAO,EAAE,UAAU,EAAE,sCAAkC;AACvD,OAAO,EAAE,cAAc,EAAE,8CAA0C;AAGnE;;GAEG;AACH,qBAAa,OAAQ,SAAQ,WAAW;IACtC,MAAM,EAAE,SAAS,CAAC,MAAM,CAAsC;IAE9D;;;;;;;;;;OAUG;IACH,IAAI,CACF,OAAO,EAAE,MAAM,EACf,KAAK,GAAE,gBAAgB,GAAG,IAAI,GAAG,SAAc,EAC/C,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,yBAAyB,CAAC;IAIxC;;;;;;;;;;;OAWG;IACH,QAAQ,CACN,QAAQ,EAAE,MAAM,EAChB,MAAM,EAAE,oBAAoB,EAC5B,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,sBAAsB,CAAC;CAItC;AAED,MAAM,WAAW,mBAAmB;IAClC,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB;AAED,MAAM,WAAW,mBAAmB;IAClC,KAAK,EAAE,MAAM,CAAC;IAEd,IAAI,CAAC,EAAE,MAAM,CAAC;CACf;AAED,MAAM,WAAW,aAAa;IAC5B,EAAE,EAAE,MAAM,CAAC;IAEX,UAAU,EAAE,MAAM,CAAC;IAEnB,QAAQ,EAAE,MAAM,CAAC;IAEjB;;;;OAIG;IACH,MAAM,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAEtB,eAAe,EAAE,MAAM,CAAC;IAExB,eAAe,EAAE,MAAM,CAAC;IAExB;;OAEG;IACH,aAAa,EAAE,MAAM,CAAC;IAEtB,OAAO,EAAE,MAAM,GAAG,IAAI,CAAC;IAEvB,WAAW,EAAE,cAAc,CAAC;IAE5B,OAAO,EAAE,MAAM,GAAG,IAAI,CAAC;IAEvB;;OAEG;IACH,YAAY,EAAE,MAAM,CAAC;IAErB,UAAU,EAAE,MAAM,CAAC;CACpB;AAED,MAAM,WAAW,mBAAoB,SAAQ,aAAa;IACxD,QAAQ,EAAE,KAAK,CAAC,aAAa,CAAC,CAAC;CAChC;AAED,MAAM,WAAW,yBAAyB;IACxC,IAAI,EAAE,KAAK,CAAC,aAAa,CAAC,CAAC;IAE3B,IAAI,EAAE,mBAAmB,CAAC;CAC3B;AAED,MAAM,WAAW,aAAa;IAC5B,EAAE,EAAE,MAAM,CAAC;IAEX,WAAW,EAAE,KAAK,CAAC;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAE,CAAC,CAAC;IAE/C,GAAG,EAAE,KAAK,CAAC,mBAAmB,CAAC,CAAC;IAEhC,EAAE,EAAE,KAAK,CAAC,mBAAmB,CAAC,CAAC;IAE/B,UAAU,EAAE,MAAM,CAAC;IAEnB,SAAS,EAAE,SAAS,GAAG,UAAU,CAAC;IAElC,IAAI,EAAE,mBAAmB,CAAC;IAE1B;;;OAGG;IACH,eAAe,EAAE,OAAO,CAAC;IAEzB,OAAO,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAE,CAAC;IAEpC;;;;OAIG;IACH,aAAa,EAAE,MAAM,GAAG,IAAI,CAAC;IAE7B,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;IAE3B,QAAQ,EAAE,MAAM,CAAC;IAEjB,YAAY,EAAE,KAAK,CAAC;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAE,CAAC,CAAC;IAEhD;;;;;;OAMG;IACH,MAAM,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAEtB;;OAEG;IACH,UAAU,EAAE,MAAM,GAAG,IAAI,CAAC;IAE1B;;OAEG;IACH,OAAO,EAAE,MAAM,GAAG,IAAI,CAAC;IAEvB;;OAEG;IACH,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;IAE3B,WAAW,EAAE,eAAe,CAAC;IAE7B;;OAEG;IACH,UAAU,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAE1B;;;;OAIG;IACH,UAAU,EAAE,MAAM,GAAG,IAAI,CAAC;IAE1B,QAAQ,EAAE,KAAK,CAAC,mBAAmB,CAAC,CAAC;IAErC;;OAEG;IACH,OAAO,EAAE,MAAM,GAAG,IAAI,CAAC;IAEvB;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf,OAAO,EAAE,MAAM,GAAG,IAAI,CAAC;IAEvB;;;;;OAKG;IACH,aAAa,EAAE,MAAM,GAAG,IAAI,CAAC;IAE7B,SAAS,EAAE,MAAM,CAAC;IAElB,EAAE,EAAE,KAAK,CAAC,mBAAmB,CAAC,CAAC;IAE/B,UAAU,EAAE,MAAM,CAAC;CACpB;AAED,MAAM,WAAW,sBAAsB;IACrC,IAAI,EAAE,mBAAmB,CAAC;IAE1B,IAAI,EAAE,mBAAmB,CAAC;CAC3B;AAED,MAAM,WAAW,gBAAgB;IAC/B;;;OAGG;IACH,eAAe,CAAC,EAAE,MAAM,CAAC;IAEzB;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;IAEvB;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;CACvB;AAED,MAAM,WAAW,oBAAoB;IACnC;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;IAEvB;;;OAGG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;CACvB;AAID,MAAM,CAAC,OAAO,WAAW,OAAO,CAAC;IAC/B,OAAO,EACL,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,aAAa,IAAI,aAAa,EACnC,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,yBAAyB,IAAI,yBAAyB,EAC3D,KAAK,aAAa,IAAI,aAAa,EACnC,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,gBAAgB,IAAI,gBAAgB,EACzC,KAAK,oBAAoB,IAAI,oBAAoB,GAClD,CAAC;IAEF,OAAO,EACL,MAAM,IAAI,MAAM,EAChB,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,iBAAiB,IAAI,iBAAiB,GAC5C,CAAC;CACH"}

package/resources/email-inboxes/threads/threads.d.ts

@@ -0,0 +1,199 @@
+import { APIResource } from "../../../core/resource.js";
+import * as LabelsAPI from "./labels.js";
+import { LabelCreateParams, LabelCreateResponse, LabelDeleteAllParams, LabelDeleteAllResponse, Labels } from "./labels.js";
+import { APIPromise } from "../../../core/api-promise.js";
+import { RequestOptions } from "../../../internal/request-options.js";
+/**
+ * Create and manage agent inboxes, retrieve inbound messages and threads, and reply to or forward messages.
+ */
+export declare class Threads extends APIResource {
+    labels: LabelsAPI.Labels;
+    /**
+     * Lists thread summaries newest first using stable cursor pagination.
+     *
+     * @example
+     * ```ts
+     * const inboundThreadListResponse =
+     *   await client.emailInboxes.threads.list(
+     *     '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
+     *   );
+     * ```
+     */
+    list(inboxID: string, query?: ThreadListParams | null | undefined, options?: RequestOptions): APIPromise<InboundThreadListResponse>;
+    /**
+     * Returns a bounded page of inbound and outbound thread messages interleaved in
+     * chronological order using stable cursor pagination.
+     *
+     * @example
+     * ```ts
+     * const thread = await client.emailInboxes.threads.retrieve(
+     *   '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
+     *   { inbox_id: '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e' },
+     * );
+     * ```
+     */
+    retrieve(threadID: string, params: ThreadRetrieveParams, options?: RequestOptions): APIPromise<ThreadRetrieveResponse>;
+}
+export interface EmailPaginationMeta {
+    page_size: number;
+    /**
+     * Cursor for the next page, when more results are available.
+     */
+    page_cursor?: string;
+}
+export interface InboundEmailAddress {
+    email: string;
+    name?: string;
+}
+export interface InboundThread {
+    id: string;
+    created_at: string;
+    inbox_id: string;
+    /**
+     * Mutable thread labels used for agent workflow state. Independent of the labels
+     * on the thread's messages, and distinct from the send-time `tags` on outbound
+     * messages.
+     */
+    labels: Array<string>;
+    last_message_at: string;
+    last_message_id: string;
+    /**
+     * Total inbound and outbound messages in the thread.
+     */
+    message_count: number;
+    preview: string | null;
+    record_type: 'email_thread';
+    subject: string | null;
+    /**
+     * Unread inbound messages; outbound messages never increment this count.
+     */
+    unread_count: number;
+    updated_at: string;
+}
+export interface InboundThreadDetail extends InboundThread {
+    messages: Array<ThreadMessage>;
+}
+export interface InboundThreadListResponse {
+    data: Array<InboundThread>;
+    meta: EmailPaginationMeta;
+}
+export interface ThreadMessage {
+    id: string;
+    attachments: Array<{
+        [key: string]: unknown;
+    }>;
+    bcc: Array<InboundEmailAddress>;
+    cc: Array<InboundEmailAddress>;
+    created_at: string;
+    direction: 'inbound' | 'outbound';
+    from: InboundEmailAddress;
+    /**
+     * Whether conservative plain-text extraction detected a quoted tail. False does
+     * not prove that the source contains no quoted content.
+     */
+    has_quoted_text: boolean;
+    headers: {
+        [key: string]: unknown;
+    };
+    /**
+     * URL for an offloaded HTML body. Null means the body is not offloaded to a URL;
+     * an inline HTML body may still exist but is not returned on list reads. Reply
+     * extraction uses only the plain-text body during ingest.
+     */
+    html_body_url: string | null;
+    in_reply_to: string | null;
+    inbox_id: string;
+    inline_files: Array<{
+        [key: string]: unknown;
+    }>;
+    /**
+     * Mutable message labels used for agent workflow state (for example `spam`,
+     * `needs_review`, `processed`). Distinct from the immutable send-time `tags` on
+     * outbound messages: labels are never propagated to Email Detail Records or
+     * Mission Control reporting. Always empty for outbound messages. Labels on a
+     * message are independent of the labels on its thread.
+     */
+    labels: Array<string>;
+    /**
+     * RFC Message-ID header. Null is possible for legacy outbound messages.
+     */
+    message_id: string | null;
+    /**
+     * Time the inbound message was marked read. Null means unread.
+     */
+    read_at: string | null;
+    /**
+     * Receipt time for inbound messages; null for outbound messages.
+     */
+    received_at: string | null;
+    record_type: 'email_message';
+    /**
+     * Ordered RFC Message-ID values from the References header.
+     */
+    references: Array<string>;
+    /**
+     * Conservatively extracted new-reply content persisted from the plain-text body
+     * during ingest. Null means no plain-text extraction input was available or
+     * extraction was skipped or failed; HTML bodies are not parsed.
+     */
+    reply_text: string | null;
+    reply_to: Array<InboundEmailAddress>;
+    /**
+     * Creation/send-acceptance time for outbound messages; null for inbound messages.
+     */
+    sent_at: string | null;
+    /**
+     * Received for inbound messages; the current send status for outbound messages.
+     */
+    status: string;
+    subject: string | null;
+    /**
+     * URL for an offloaded plain-text body. Null means the body is not offloaded to a
+     * URL; an inline plain-text body may still exist but is not returned on list
+     * reads. `reply_text` and `has_quoted_text` are persisted during ingest before any
+     * body offload.
+     */
+    text_body_url: string | null;
+    thread_id: string;
+    to: Array<InboundEmailAddress>;
+    updated_at: string;
+}
+export interface ThreadRetrieveResponse {
+    data: InboundThreadDetail;
+    meta: EmailPaginationMeta;
+}
+export interface ThreadListParams {
+    /**
+     * Returns only threads carrying this label. Thread labels are independent of the
+     * labels on the thread's messages.
+     */
+    'filter[label]'?: string;
+    /**
+     * Opaque cursor returned by the previous page.
+     */
+    'page[after]'?: string;
+    /**
+     * Number of results to return. Defaults to 25; maximum is 100.
+     */
+    'page[size]'?: number;
+}
+export interface ThreadRetrieveParams {
+    /**
+     * Path param: Email inbox UUID.
+     */
+    inbox_id: string;
+    /**
+     * Query param: Opaque message cursor returned by the previous thread-detail page.
+     */
+    'page[after]'?: string;
+    /**
+     * Query param: Number of thread messages to return. Defaults to 25; maximum
+     * is 100.
+     */
+    'page[size]'?: number;
+}
+export declare namespace Threads {
+    export { type EmailPaginationMeta as EmailPaginationMeta, type InboundEmailAddress as InboundEmailAddress, type InboundThread as InboundThread, type InboundThreadDetail as InboundThreadDetail, type InboundThreadListResponse as InboundThreadListResponse, type ThreadMessage as ThreadMessage, type ThreadRetrieveResponse as ThreadRetrieveResponse, type ThreadListParams as ThreadListParams, type ThreadRetrieveParams as ThreadRetrieveParams, };
+    export { Labels as Labels, type LabelCreateResponse as LabelCreateResponse, type LabelDeleteAllResponse as LabelDeleteAllResponse, type LabelDeleteAllParams as LabelDeleteAllParams, type LabelCreateParams as LabelCreateParams, };
+}
+//# sourceMappingURL=threads.d.ts.map

package/resources/email-inboxes/threads/threads.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"threads.d.ts","sourceRoot":"","sources":["../../../src/resources/email-inboxes/threads/threads.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,kCAA+B;AACrD,OAAO,KAAK,SAAS,oBAAiB;AACtC,OAAO,EACL,iBAAiB,EACjB,mBAAmB,EACnB,oBAAoB,EACpB,sBAAsB,EACtB,MAAM,EACP,oBAAiB;AAClB,OAAO,EAAE,UAAU,EAAE,qCAAkC;AACvD,OAAO,EAAE,cAAc,EAAE,6CAA0C;AAGnE;;GAEG;AACH,qBAAa,OAAQ,SAAQ,WAAW;IACtC,MAAM,EAAE,SAAS,CAAC,MAAM,CAAsC;IAE9D;;;;;;;;;;OAUG;IACH,IAAI,CACF,OAAO,EAAE,MAAM,EACf,KAAK,GAAE,gBAAgB,GAAG,IAAI,GAAG,SAAc,EAC/C,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,yBAAyB,CAAC;IAIxC;;;;;;;;;;;OAWG;IACH,QAAQ,CACN,QAAQ,EAAE,MAAM,EAChB,MAAM,EAAE,oBAAoB,EAC5B,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,sBAAsB,CAAC;CAItC;AAED,MAAM,WAAW,mBAAmB;IAClC,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB;AAED,MAAM,WAAW,mBAAmB;IAClC,KAAK,EAAE,MAAM,CAAC;IAEd,IAAI,CAAC,EAAE,MAAM,CAAC;CACf;AAED,MAAM,WAAW,aAAa;IAC5B,EAAE,EAAE,MAAM,CAAC;IAEX,UAAU,EAAE,MAAM,CAAC;IAEnB,QAAQ,EAAE,MAAM,CAAC;IAEjB;;;;OAIG;IACH,MAAM,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAEtB,eAAe,EAAE,MAAM,CAAC;IAExB,eAAe,EAAE,MAAM,CAAC;IAExB;;OAEG;IACH,aAAa,EAAE,MAAM,CAAC;IAEtB,OAAO,EAAE,MAAM,GAAG,IAAI,CAAC;IAEvB,WAAW,EAAE,cAAc,CAAC;IAE5B,OAAO,EAAE,MAAM,GAAG,IAAI,CAAC;IAEvB;;OAEG;IACH,YAAY,EAAE,MAAM,CAAC;IAErB,UAAU,EAAE,MAAM,CAAC;CACpB;AAED,MAAM,WAAW,mBAAoB,SAAQ,aAAa;IACxD,QAAQ,EAAE,KAAK,CAAC,aAAa,CAAC,CAAC;CAChC;AAED,MAAM,WAAW,yBAAyB;IACxC,IAAI,EAAE,KAAK,CAAC,aAAa,CAAC,CAAC;IAE3B,IAAI,EAAE,mBAAmB,CAAC;CAC3B;AAED,MAAM,WAAW,aAAa;IAC5B,EAAE,EAAE,MAAM,CAAC;IAEX,WAAW,EAAE,KAAK,CAAC;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAE,CAAC,CAAC;IAE/C,GAAG,EAAE,KAAK,CAAC,mBAAmB,CAAC,CAAC;IAEhC,EAAE,EAAE,KAAK,CAAC,mBAAmB,CAAC,CAAC;IAE/B,UAAU,EAAE,MAAM,CAAC;IAEnB,SAAS,EAAE,SAAS,GAAG,UAAU,CAAC;IAElC,IAAI,EAAE,mBAAmB,CAAC;IAE1B;;;OAGG;IACH,eAAe,EAAE,OAAO,CAAC;IAEzB,OAAO,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAE,CAAC;IAEpC;;;;OAIG;IACH,aAAa,EAAE,MAAM,GAAG,IAAI,CAAC;IAE7B,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;IAE3B,QAAQ,EAAE,MAAM,CAAC;IAEjB,YAAY,EAAE,KAAK,CAAC;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAE,CAAC,CAAC;IAEhD;;;;;;OAMG;IACH,MAAM,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAEtB;;OAEG;IACH,UAAU,EAAE,MAAM,GAAG,IAAI,CAAC;IAE1B;;OAEG;IACH,OAAO,EAAE,MAAM,GAAG,IAAI,CAAC;IAEvB;;OAEG;IACH,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;IAE3B,WAAW,EAAE,eAAe,CAAC;IAE7B;;OAEG;IACH,UAAU,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAE1B;;;;OAIG;IACH,UAAU,EAAE,MAAM,GAAG,IAAI,CAAC;IAE1B,QAAQ,EAAE,KAAK,CAAC,mBAAmB,CAAC,CAAC;IAErC;;OAEG;IACH,OAAO,EAAE,MAAM,GAAG,IAAI,CAAC;IAEvB;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf,OAAO,EAAE,MAAM,GAAG,IAAI,CAAC;IAEvB;;;;;OAKG;IACH,aAAa,EAAE,MAAM,GAAG,IAAI,CAAC;IAE7B,SAAS,EAAE,MAAM,CAAC;IAElB,EAAE,EAAE,KAAK,CAAC,mBAAmB,CAAC,CAAC;IAE/B,UAAU,EAAE,MAAM,CAAC;CACpB;AAED,MAAM,WAAW,sBAAsB;IACrC,IAAI,EAAE,mBAAmB,CAAC;IAE1B,IAAI,EAAE,mBAAmB,CAAC;CAC3B;AAED,MAAM,WAAW,gBAAgB;IAC/B;;;OAGG;IACH,eAAe,CAAC,EAAE,MAAM,CAAC;IAEzB;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;IAEvB;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;CACvB;AAED,MAAM,WAAW,oBAAoB;IACnC;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;IAEvB;;;OAGG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;CACvB;AAID,MAAM,CAAC,OAAO,WAAW,OAAO,CAAC;IAC/B,OAAO,EACL,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,aAAa,IAAI,aAAa,EACnC,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,yBAAyB,IAAI,yBAAyB,EAC3D,KAAK,aAAa,IAAI,aAAa,EACnC,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,gBAAgB,IAAI,gBAAgB,EACzC,KAAK,oBAAoB,IAAI,oBAAoB,GAClD,CAAC;IAEF,OAAO,EACL,MAAM,IAAI,MAAM,EAChB,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,iBAAiB,IAAI,iBAAiB,GAC5C,CAAC;CACH"}