@epilot/sdk 2.14.4 → 2.14.6

package/dist/{file.d-BN417xok.d.ts → file.d-zFneCEyY.d.ts}

@@ -2445,6 +2445,12 @@ declare namespace Components {
              * 1.2 MB
              */
             readable_size?: string;
+            /**
+             * Content hash (S3 ETag) of the latest file version. For single-part uploads this is the hex MD5 of the content and is stable across orgs, so identical content yields an identical etag. Used to detect real content changes without re-downloading the bytes.
+             * example:
+             * 9bb58f26192e4ba00f01e2e7b136bbd8
+             */
+            etag?: string;
             access_control?: "private" | "public-read";
             /**
              * Direct URL for file (public only if file access control is public-read)
@@ -2666,6 +2672,12 @@ declare namespace Components {
              * 1.2 MB
              */
             readable_size?: string;
+            /**
+             * Content hash (S3 ETag) of the latest file version. For single-part uploads this is the hex MD5 of the content and is stable across orgs, so identical content yields an identical etag. Used to detect real content changes without re-downloading the bytes.
+             * example:
+             * 9bb58f26192e4ba00f01e2e7b136bbd8
+             */
+            etag?: string;
             access_control: "private" | "public-read";
             /**
              * Direct URL for file (public only if file access control is public-read)
@@ -2757,6 +2769,12 @@ declare namespace Components {
              * image/jpeg
              */
             mime_type?: string;
+            /**
+             * Content hash (S3 ETag) of this file version
+             * example:
+             * 9bb58f26192e4ba00f01e2e7b136bbd8
+             */
+            etag?: string;
         }
         export interface FileRelationItem {
             entity_id: /**
@@ -2818,6 +2836,37 @@ declare namespace Components {
          * Current state of a file summary job.
          */
         export type FileSummaryJobStatus = "queued" | "waiting_for_extraction" | "processing" | "completed" | "failed" | "unsupported" | "stale";
+        export type FileText = {
+            status: /* Availability of the plain-text representation for a file entity. */ FileTextStatus;
+            text?: string;
+            truncated?: boolean;
+            total_chars?: number;
+        } & (FileTextReady | FileTextNotReady | FileTextUnsupported);
+        export interface FileTextNotReady {
+            status: "not_ready";
+        }
+        export interface FileTextReady {
+            status: "ready";
+            /**
+             * Plain-text representation, trimmed and truncated to a server-side limit of 50000 characters.
+             */
+            text: string;
+            /**
+             * True when the returned text was cut off by the character limit.
+             */
+            truncated: boolean;
+            /**
+             * Length of the full text before truncation.
+             */
+            total_chars: number;
+        }
+        /**
+         * Availability of the plain-text representation for a file entity.
+         */
+        export type FileTextStatus = "ready" | "not_ready" | "unsupported";
+        export interface FileTextUnsupported {
+            status: "unsupported";
+        }
         export type FileType = "document" | "document_template" | "text" | "image" | "video" | "audio" | "spreadsheet" | "presentation" | "font" | "archive" | "application" | "unknown";
         export interface FileUpload {
             s3ref?: S3Reference;
@@ -2929,6 +2978,12 @@ declare namespace Components {
              * 1.2 MB
              */
             readable_size?: string;
+            /**
+             * Content hash (S3 ETag) of the latest file version. For single-part uploads this is the hex MD5 of the content and is stable across orgs, so identical content yields an identical etag. Used to detect real content changes without re-downloading the bytes.
+             * example:
+             * 9bb58f26192e4ba00f01e2e7b136bbd8
+             */
+            etag?: string;
             access_control?: "private" | "public-read";
             /**
              * Direct URL for file (public only if file access control is public-read)
@@ -3030,6 +3085,12 @@ declare namespace Components {
              * 1.2 MB
              */
             readable_size?: string;
+            /**
+             * Content hash (S3 ETag) of the latest file version. For single-part uploads this is the hex MD5 of the content and is stable across orgs, so identical content yields an identical etag. Used to detect real content changes without re-downloading the bytes.
+             * example:
+             * 9bb58f26192e4ba00f01e2e7b136bbd8
+             */
+            etag?: string;
             access_control?: "private" | "public-read";
             /**
              * Direct URL for file (public only if file access control is public-read)
@@ -3139,6 +3200,12 @@ declare namespace Components {
              * 1.2 MB
              */
             readable_size?: string;
+            /**
+             * Content hash (S3 ETag) of the latest file version. For single-part uploads this is the hex MD5 of the content and is stable across orgs, so identical content yields an identical etag. Used to detect real content changes without re-downloading the bytes.
+             * example:
+             * 9bb58f26192e4ba00f01e2e7b136bbd8
+             */
+            etag?: string;
             access_control?: "private" | "public-read";
             /**
              * Direct URL for file (public only if file access control is public-read)
@@ -3741,6 +3808,15 @@ declare namespace Paths {
              * }
              */
             Components.Responses.UnauthorizedError;
+            export type $403 = /**
+             * A generic error returned by the API
+             * example:
+             * {
+             *   "status": 403,
+             *   "error": "Forbidden: You do not have permission to access this file"
+             * }
+             */
+            Components.Responses.ForbiddenError;
             export type $404 = /**
              * A generic error returned by the API
              * example:
@@ -4119,6 +4195,66 @@ declare namespace Paths {
             Components.Responses.InternalServerError;
         }
     }
+    namespace GetFileText {
+        namespace Parameters {
+            export type Id = /**
+             * example:
+             * ef7d985c-2385-44f4-9c71-ae06a52264f8
+             */
+            Components.Schemas.FileEntityId;
+        }
+        export interface PathParameters {
+            id: Parameters.Id;
+        }
+        namespace Responses {
+            export type $200 = Components.Schemas.FileText;
+            export type $400 = /**
+             * A generic error returned by the API
+             * example:
+             * {
+             *   "status": 400,
+             *   "error": "Bad Request: filename is required"
+             * }
+             */
+            Components.Responses.BadRequestError;
+            export type $401 = /**
+             * A generic error returned by the API
+             * example:
+             * {
+             *   "status": 401,
+             *   "error": "Unauthorized: Invalid or expired token"
+             * }
+             */
+            Components.Responses.UnauthorizedError;
+            export type $403 = /**
+             * A generic error returned by the API
+             * example:
+             * {
+             *   "status": 403,
+             *   "error": "Forbidden: You do not have permission to access this file"
+             * }
+             */
+            Components.Responses.ForbiddenError;
+            export type $404 = /**
+             * A generic error returned by the API
+             * example:
+             * {
+             *   "status": 404,
+             *   "error": "Not Found: File entity not found"
+             * }
+             */
+            Components.Responses.NotFoundError;
+            export type $500 = /**
+             * A generic error returned by the API
+             * example:
+             * {
+             *   "status": 500,
+             *   "error": "Internal Server Error"
+             * }
+             */
+            Components.Responses.InternalServerError;
+        }
+    }
     namespace GetFilesInCollection {
         namespace Parameters {
             export type CollectionSlug = string;
@@ -4354,6 +4490,10 @@ declare namespace Paths {
         }
         namespace Responses {
             export type $200 = string; // binary
+            export interface $204 {
+            }
+            export interface $302 {
+            }
             export interface $304 {
             }
             export type $403 = /* A generic error returned by the API */ Components.Schemas.ErrorObject;
@@ -5075,6 +5215,16 @@ interface OperationMethods {
     data?: any,
     config?: AxiosRequestConfig  
   ): OperationResponse<Paths.GenerateFileSummary.Responses.$202>
+  /**
+   * getFileText - getFileText
+   * 
+   * Get the plain-text representation of a file entity. Returns status `not_ready` while text is being prepared and `unsupported` when text is unavailable for the file or organization.
+   */
+  'getFileText'(
+    parameters?: Parameters<Paths.GetFileText.PathParameters> | null,
+    data?: any,
+    config?: AxiosRequestConfig  
+  ): OperationResponse<Paths.GetFileText.Responses.$200>
   /**
    * previewFile - previewFile
    * 
@@ -5129,7 +5279,7 @@ interface OperationMethods {
     parameters?: Parameters<Paths.PreviewPublicFile.QueryParameters & Paths.PreviewPublicFile.PathParameters> | null,
     data?: any,
     config?: AxiosRequestConfig  
-  ): OperationResponse<Paths.PreviewPublicFile.Responses.$200>
+  ): OperationResponse<Paths.PreviewPublicFile.Responses.$200 | Paths.PreviewPublicFile.Responses.$204>
   /**
    * getSession - getSession
    * 
@@ -5586,6 +5736,18 @@ interface PathsDictionary {
       config?: AxiosRequestConfig  
     ): OperationResponse<Paths.GenerateFileSummary.Responses.$202>
   }
+  ['/v1/files/{id}/text']: {
+    /**
+     * getFileText - getFileText
+     * 
+     * Get the plain-text representation of a file entity. Returns status `not_ready` while text is being prepared and `unsupported` when text is unavailable for the file or organization.
+     */
+    'get'(
+      parameters?: Parameters<Paths.GetFileText.PathParameters> | null,
+      data?: any,
+      config?: AxiosRequestConfig  
+    ): OperationResponse<Paths.GetFileText.Responses.$200>
+  }
   ['/v1/files/{id}/preview']: {
     /**
      * previewFile - previewFile
@@ -5645,7 +5807,7 @@ interface PathsDictionary {
       parameters?: Parameters<Paths.PreviewPublicFile.QueryParameters & Paths.PreviewPublicFile.PathParameters> | null,
       data?: any,
       config?: AxiosRequestConfig  
-    ): OperationResponse<Paths.PreviewPublicFile.Responses.$200>
+    ): OperationResponse<Paths.PreviewPublicFile.Responses.$200 | Paths.PreviewPublicFile.Responses.$204>
   }
   ['/v1/files/session']: {
     /**
@@ -5898,6 +6060,11 @@ type FileRelationItem = Components.Schemas.FileRelationItem;
 type FileSummary = Components.Schemas.FileSummary;
 type FileSummaryJob = Components.Schemas.FileSummaryJob;
 type FileSummaryJobStatus = Components.Schemas.FileSummaryJobStatus;
+type FileText = Components.Schemas.FileText;
+type FileTextNotReady = Components.Schemas.FileTextNotReady;
+type FileTextReady = Components.Schemas.FileTextReady;
+type FileTextStatus = Components.Schemas.FileTextStatus;
+type FileTextUnsupported = Components.Schemas.FileTextUnsupported;
 type FileType = Components.Schemas.FileType;
 type FileUpload = Components.Schemas.FileUpload;
 type PublicLink = Components.Schemas.PublicLink;
@@ -5912,4 +6079,4 @@ type UploadFilePayload = Components.Schemas.UploadFilePayload;
 type VerifyCustomDownloadUrlPayload = Components.Schemas.VerifyCustomDownloadUrlPayload;
 type ZipJob = Components.Schemas.ZipJob;
 
-export { type ActivityId as A, type BaseEntityAcl as B, type Client as C, type DownloadFilesPayload as D, type EntityId as E, type FileAttributes as F, type SaveFileFromSourceURLPayload as G, type SaveFilePayload as H, type SaveFilePayloadV2 as I, type SaveS3FilePayload as J, type OperationMethods as O, Paths as P, type S3Ref as S, type UploadFilePayload as U, type VerifyCustomDownloadUrlPayload as V, type ZipJob as Z, Components as a, type PathsDictionary as b, type BaseEntityOwner as c, type BatchSaveFileVersionPayload as d, type CommonSaveFilePayload as e, type CreateZipJobPayload as f, type CustomDownloadUrl as g, type CustomDownloadUrlAuth as h, type EntitySlug as i, type ErrorObject as j, type FileCollectionAttributes as k, type FileCollectionCreateRequest as l, type FileCollectionId as m, type FileCollectionItem as n, type FileEntity as o, type FileEntityId as p, type FileItem as q, type FileRelationItem as r, type FileSummary as s, type FileSummaryJob as t, type FileSummaryJobStatus as u, type FileType as v, type FileUpload as w, type PublicLink as x, type S3Reference as y, type SaveCustomFilePayload as z };
+export { type ActivityId as A, type BaseEntityAcl as B, type Client as C, type DownloadFilesPayload as D, type EntityId as E, type FileAttributes as F, type FileType as G, type FileUpload as H, type PublicLink as I, type S3Reference as J, type SaveCustomFilePayload as K, type SaveFileFromSourceURLPayload as L, type SaveFilePayload as M, type SaveFilePayloadV2 as N, type OperationMethods as O, Paths as P, type SaveS3FilePayload as Q, type S3Ref as S, type UploadFilePayload as U, type VerifyCustomDownloadUrlPayload as V, type ZipJob as Z, Components as a, type PathsDictionary as b, type BaseEntityOwner as c, type BatchSaveFileVersionPayload as d, type CommonSaveFilePayload as e, type CreateZipJobPayload as f, type CustomDownloadUrl as g, type CustomDownloadUrlAuth as h, type EntitySlug as i, type ErrorObject as j, type FileCollectionAttributes as k, type FileCollectionCreateRequest as l, type FileCollectionId as m, type FileCollectionItem as n, type FileEntity as o, type FileEntityId as p, type FileItem as q, type FileRelationItem as r, type FileSummary as s, type FileSummaryJob as t, type FileSummaryJobStatus as u, type FileText as v, type FileTextNotReady as w, type FileTextReady as x, type FileTextStatus as y, type FileTextUnsupported as z };

package/dist/index.cjs

@@ -63,7 +63,7 @@ var _chunkWQBBB6BNcjs = require('./chunk-WQBBB6BN.cjs');
 var _chunkFDS727SLcjs = require('./chunk-FDS727SL.cjs');
 
 
-var _chunkLNLUCLPLcjs = require('./chunk-LNLUCLPL.cjs');
+var _chunk3SZOSNO2cjs = require('./chunk-3SZOSNO2.cjs');
 
 
 var _chunkYO4M3BZLcjs = require('./chunk-YO4M3BZL.cjs');
@@ -158,7 +158,7 @@ var _chunkDVM27A7Ecjs = require('./chunk-DVM27A7E.cjs');
 
 
 
-var _chunkOIHW7ECMcjs = require('./chunk-OIHW7ECM.cjs');
+var _chunkBEPK4SMVcjs = require('./chunk-BEPK4SMV.cjs');
 
 
 var _chunkNJK5F5TFcjs = require('./chunk-NJK5F5TF.cjs');
@@ -225,7 +225,7 @@ var resolveClient = (params) => {
   }
   if (!entry.instance) {
     const definition = entry.loader();
-    entry.instance = _chunkOIHW7ECMcjs.createApiClient.call(void 0, {
+    entry.instance = _chunkBEPK4SMVcjs.createApiClient.call(void 0, {
       definition,
       token: state.token,
       headers: state.globalHeaders,
@@ -258,7 +258,7 @@ var resetAllClients = (registry) => {
 };
 
 // src/apis/_registry.ts
-var expandDef = (mod) => _chunkOIHW7ECMcjs.expand.call(void 0, _nullishCoalesce(mod.default, () => ( mod)));
+var expandDef = (mod) => _chunkBEPK4SMVcjs.expand.call(void 0, _nullishCoalesce(mod.default, () => ( mod)));
 var registerBuiltinApis = (registry) => {
   registerApi({
     registry,
@@ -383,7 +383,7 @@ var registerBuiltinApis = (registry) => {
   registerApi({
     registry,
     name: "file",
-    loader: () => expandDef(_chunkLNLUCLPLcjs.require_file_runtime.call(void 0, ))
+    loader: () => expandDef(_chunk3SZOSNO2cjs.require_file_runtime.call(void 0, ))
   });
   registerApi({
     registry,
@@ -601,9 +601,9 @@ var createSDK = () => {
       const available = [...registry.keys()].join(", ");
       throw new Error(`Unknown API: "${name}". Available: ${available}`);
     }
-    return _chunkOIHW7ECMcjs.createApiHandle.call(void 0, {
+    return _chunkBEPK4SMVcjs.createApiHandle.call(void 0, {
       resolveClient: () => resolveClient({ registry, name, state }),
-      createClient: () => _chunkOIHW7ECMcjs.createApiClient.call(void 0, { definition: entry.loader(), apiName: name }),
+      createClient: () => _chunkBEPK4SMVcjs.createApiClient.call(void 0, { definition: entry.loader(), apiName: name }),
       apiName: name
     });
   };
@@ -651,9 +651,9 @@ var createSDK = () => {
           return interceptorUse;
         }
         case "help":
-          return (apiName) => _chunkOIHW7ECMcjs.help.call(void 0, apiName);
+          return (apiName) => _chunkBEPK4SMVcjs.help.call(void 0, apiName);
         case "openapi":
-          return (apiName) => _chunkOIHW7ECMcjs.openapi.call(void 0, apiName);
+          return (apiName) => _chunkBEPK4SMVcjs.openapi.call(void 0, apiName);
         case "then":
         case "catch":
         case "finally":
@@ -683,4 +683,4 @@ var epilot = createSDK();
 
 
 
-exports.applyLargeResponseInterceptor = applyLargeResponseInterceptor; exports.applyRetryInterceptor = applyRetryInterceptor; exports.authorize = _chunkOIHW7ECMcjs.authorize; exports.createSDK = createSDK; exports.epilot = epilot; exports.help = _chunkOIHW7ECMcjs.help; exports.openapi = _chunkOIHW7ECMcjs.openapi;
+exports.applyLargeResponseInterceptor = applyLargeResponseInterceptor; exports.applyRetryInterceptor = applyRetryInterceptor; exports.authorize = _chunkBEPK4SMVcjs.authorize; exports.createSDK = createSDK; exports.epilot = epilot; exports.help = _chunkBEPK4SMVcjs.help; exports.openapi = _chunkBEPK4SMVcjs.openapi;

package/dist/index.d.cts

@@ -27,12 +27,12 @@ import { C as Client$k } from './entity.d-fospShiN.cjs';
 import { C as Client$l } from './entity-mapping.d-DKSW3sfy.cjs';
 import { C as Client$m } from './environments.d-BvqvN-PD.cjs';
 import { C as Client$n } from './event-catalog.d-QIhhewVH.cjs';
-import { C as Client$o } from './file.d-BN417xok.cjs';
+import { C as Client$o } from './file.d-zFneCEyY.cjs';
 import { C as Client$p } from './iban.d-BwdiGbxi.cjs';
 import { C as Client$q } from './integration-toolkit.d-7q19qDTD.cjs';
 import { C as Client$r } from './journey.d-B1sOeMHw.cjs';
 import { C as Client$s } from './kanban.d-BHnSRCYW.cjs';
-import { C as Client$t } from './message.d-VMmPsZVq.cjs';
+import { C as Client$t } from './message.d-b-UwZUNb.cjs';
 import { C as Client$u } from './metering.d-DoC7rUbS.cjs';
 import { C as Client$v } from './notes.d-rbcyHfiB.cjs';
 import { C as Client$w } from './notification.d-r89Jec85.cjs';

package/dist/index.d.ts

@@ -27,12 +27,12 @@ import { C as Client$k } from './entity.d-fospShiN.js';
 import { C as Client$l } from './entity-mapping.d-DKSW3sfy.js';
 import { C as Client$m } from './environments.d-BvqvN-PD.js';
 import { C as Client$n } from './event-catalog.d-QIhhewVH.js';
-import { C as Client$o } from './file.d-BN417xok.js';
+import { C as Client$o } from './file.d-zFneCEyY.js';
 import { C as Client$p } from './iban.d-BwdiGbxi.js';
 import { C as Client$q } from './integration-toolkit.d-7q19qDTD.js';
 import { C as Client$r } from './journey.d-B1sOeMHw.js';
 import { C as Client$s } from './kanban.d-BHnSRCYW.js';
-import { C as Client$t } from './message.d-VMmPsZVq.js';
+import { C as Client$t } from './message.d-b-UwZUNb.js';
 import { C as Client$u } from './metering.d-DoC7rUbS.js';
 import { C as Client$v } from './notes.d-rbcyHfiB.js';
 import { C as Client$w } from './notification.d-r89Jec85.js';

package/dist/index.js

@@ -63,7 +63,7 @@ import {
 } from "./chunk-M4FO2MI4.js";
 import {
   require_file_runtime
-} from "./chunk-G5KVG3RU.js";
+} from "./chunk-G7IFFKKJ.js";
 import {
   require_iban_runtime
 } from "./chunk-5MFHAXBT.js";
@@ -158,7 +158,7 @@ import {
   expand,
   help,
   openapi
-} from "./chunk-YUA47URH.js";
+} from "./chunk-YTG6MIEJ.js";
 import {
   __require
 } from "./chunk-YPSWSI3M.js";

package/dist/message-F4HJQBF5.cjs

@@ -0,0 +1,7 @@
+"use strict";Object.defineProperty(exports, "__esModule", {value: true});require('./chunk-NJK5F5TF.cjs');
+
+// src/docs/message.json
+var message_default = '# Message API\n\n- **Base URL:** `https://message.sls.epilot.io`\n- **Full API Docs:** [https://docs.epilot.io/api/message](https://docs.epilot.io/api/message)\n\n## Usage\n\n```ts\nimport { epilot } from \'@epilot/sdk\'\n\nepilot.authorize(() => \'<token>\')\nconst { data } = await epilot.message.sendMessage(...)\n```\n\n### Tree-shakeable import\n\n```ts\nimport { getClient, authorize } from \'@epilot/sdk/message\'\n\nconst messageClient = getClient()\nauthorize(messageClient, () => \'<token>\')\nconst { data } = await messageClient.sendMessage(...)\n```\n\n## Operations\n\n**Messages**\n- [`sendMessage`](#sendmessage)\n- [`updateMessage`](#updatemessage)\n- [`getMessage`](#getmessage)\n- [`deleteMessage`](#deletemessage)\n- [`getMessageEml`](#getmessageeml)\n- [`searchMessages`](#searchmessages)\n- [`trashMessage`](#trashmessage)\n- [`untrashMessage`](#untrashmessage)\n- [`markReadMessage`](#markreadmessage)\n- [`markReadMessageV2`](#markreadmessagev2)\n- [`markUnreadMessage`](#markunreadmessage)\n- [`getUnread`](#getunread)\n- [`markUnreadMessageV2`](#markunreadmessagev2)\n- [`spamMessage`](#spammessage)\n- [`unspamMessage`](#unspammessage)\n- [`getMessageV2`](#getmessagev2)\n\n**Threads**\n- [`searchThreads`](#searchthreads)\n- [`searchThreadsV2`](#searchthreadsv2)\n- [`searchIds`](#searchids)\n- [`getAssigneeWorkload`](#getassigneeworkload)\n- [`updateThread`](#updatethread)\n- [`deleteThread`](#deletethread)\n- [`moveThread`](#movethread)\n- [`markThreadAsDone`](#markthreadasdone)\n- [`markThreadAsOpen`](#markthreadasopen)\n- [`getThreadTimeline`](#getthreadtimeline)\n- [`trashThread`](#trashthread)\n- [`untrashThread`](#untrashthread)\n- [`spamThread`](#spamthread)\n- [`unspamThread`](#unspamthread)\n- [`bulkMoveThreads`](#bulkmovethreads)\n- [`bulkAssignThreads`](#bulkassignthreads)\n- [`threadBulkActionsRead`](#threadbulkactionsread)\n- [`threadBulkActionsUnread`](#threadbulkactionsunread)\n- [`threadBulkActionsFavorite`](#threadbulkactionsfavorite)\n- [`threadBulkActionsUnfavorite`](#threadbulkactionsunfavorite)\n- [`threadBulkActionsTrash`](#threadbulkactionstrash)\n- [`threadBulkActionsUntrash`](#threadbulkactionsuntrash)\n- [`threadBulkActionsDelete`](#threadbulkactionsdelete)\n- [`threadBulkActionsDone`](#threadbulkactionsdone)\n- [`threadBulkActionsOpen`](#threadbulkactionsopen)\n- [`markReadThread`](#markreadthread)\n- [`markReadThreadV2`](#markreadthreadv2)\n- [`markUnreadThread`](#markunreadthread)\n- [`markUnreadThreadV2`](#markunreadthreadv2)\n- [`assignThread`](#assignthread)\n- [`unassignThread`](#unassignthread)\n- [`assignUsers`](#assignusers)\n- [`assignUsersV2`](#assignusersv2)\n- [`pinThread`](#pinthread)\n- [`unpinThread`](#unpinthread)\n\n**Drafts**\n- [`createDraft`](#createdraft)\n- [`sendDraft`](#senddraft)\n\n**Schemas**\n- [`ErrorResponse`](#errorresponse)\n- [`MoveThreadPayload`](#movethreadpayload)\n- [`BaseEntity`](#baseentity)\n- [`Thread`](#thread)\n- [`Message`](#message)\n- [`MessageV2`](#messagev2)\n- [`Address`](#address)\n- [`AttachmentsRelation`](#attachmentsrelation)\n- [`File`](#file)\n- [`MessageRequestParams`](#messagerequestparams)\n- [`SearchParamsV2`](#searchparamsv2)\n- [`SearchParams`](#searchparams)\n- [`SearchIDParams`](#searchidparams)\n- [`AssigneeWorkloadParams`](#assigneeworkloadparams)\n- [`AssigneeWorkload`](#assigneeworkload)\n- [`AssigneeWorkloadResults`](#assigneeworkloadresults)\n- [`ReadMessagePayload`](#readmessagepayload)\n- [`ReadingScope`](#readingscope)\n- [`ThreadTimeline`](#threadtimeline)\n- [`ThreadDoneEvent`](#threaddoneevent)\n- [`ThreadOpenEvent`](#threadopenevent)\n- [`TimelineEventData`](#timelineeventdata)\n- [`TimelineEvent`](#timelineevent)\n- [`BulkActionsPayloadWithScopes`](#bulkactionspayloadwithscopes)\n- [`BulkActionsPayload`](#bulkactionspayload)\n- [`FieldsParam`](#fieldsparam)\n\n### `sendMessage`\n\nSend an email message\n\n`POST /v1/message/messages`\n\n```ts\nconst { data } = await client.sendMessage(\n  {\n    do_not_create_entities: true,\n  },\n  {},\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{}\n```\n\n</details>\n\n---\n\n### `updateMessage`\n\nUpdate message metadata\n\n`PUT /v1/message/messages`\n\n```ts\nconst { data } = await client.updateMessage()\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n  "_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",\n  "_title": "string",\n  "_org": "206801",\n  "_schema": "message",\n  "_tags": ["pricing", "INBOX"],\n  "_created_at": "2021-02-09T12:41:43.662Z",\n  "_updated_at": "2021-02-10T09:14:31.990Z",\n  "message_id": "<0102017b97a502f8-a67f01c2-68cc-4928-b91b-45853f34e259-000000@eu-west-1.amazonses.com>",\n  "sender": "206801",\n  "updated_by": "206801",\n  "subject": "Request for solar panel price",\n  "html": "<div>We at ABC GmbH would like to request a price quote for the solar panel.</div>",\n  "text": "We at ABC GmbH would like to request a price quote for the solar panel.",\n  "from": {\n    "name": "epilot",\n    "address": "messaging@epilot.cloud",\n    "email_type": "INTERNAL",\n    "send_status": "SEND",\n    "send_error": {}\n  },\n  "reply_to": {\n    "name": "epilot",\n    "address": "messaging@epilot.cloud",\n    "email_type": "INTERNAL",\n    "send_status": "SEND",\n    "send_error": {}\n  },\n  "to": [\n    {\n      "name": "epilot",\n      "address": "messaging@epilot.cloud",\n      "email_type": "INTERNAL",\n      "send_status": "SEND",\n      "send_error": {}\n    }\n  ],\n  "cc": [\n    {\n      "name": "epilot",\n      "address": "messaging@epilot.cloud",\n      "email_type": "INTERNAL",\n      "send_status": "SEND",\n      "send_error": {}\n    }\n  ],\n  "bcc": [\n    {\n      "name": "epilot",\n      "address": "messaging@epilot.cloud",\n      "email_type": "INTERNAL",\n      "send_status": "SEND",\n      "send_error": {}\n    }\n  ],\n  "file": {\n    "$relation": [\n      {\n        "entity_id": "f820ce3b-07b0-45ae-bcc6-babb2f53f79f",\n        "filename": "Produktinformationen_epilot360_Double_Opt_in.pdf",\n        "is_message_attachment": true,\n        "may_be_signature_attachment": true,\n        "cid": "fb222496-a1a5-4639-94f2-07b5e35e4068",\n        "inline": false,\n        "send_as_link": false,\n        "save_to_entity": true\n      }\n    ]\n  },\n  "references": "<0102017b97a502f8-a67f01c2-68cc-4928-b91b-45853f34e259-000000@eu-west-1.amazonses.com> <CALHgQpziyxW9NaFUs+nRMykzr6Ljq6vjq4WO9SaihAuMasuDyg@mail.gmail.com>",\n  "in_reply_to": "<CALHgQpziyxW9NaFUs+nRMykzr6Ljq6vjq4WO9SaihAuMasuDyg@mail.gmail.com>",\n  "user_read_message": ["206801", "200109"],\n  "org_read_message": ["789372", "210291"],\n  "send_status": ["SEND"],\n  "type": "SENT",\n  "template_id": "3f34ce73-089c-4d45-a5ee-c161234e41c3"\n}\n```\n\n</details>\n\n---\n\n### `getMessage`\n\nGet an email message by id\n\n`GET /v1/message/messages/{id}`\n\n```ts\nconst { data } = await client.getMessage({\n  id: \'123e4567-e89b-12d3-a456-426614174000\',\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n  "_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",\n  "_title": "string",\n  "_org": "206801",\n  "_schema": "message",\n  "_tags": ["pricing", "INBOX"],\n  "_created_at": "2021-02-09T12:41:43.662Z",\n  "_updated_at": "2021-02-10T09:14:31.990Z",\n  "message_id": "<0102017b97a502f8-a67f01c2-68cc-4928-b91b-45853f34e259-000000@eu-west-1.amazonses.com>",\n  "sender": "206801",\n  "updated_by": "206801",\n  "subject": "Request for solar panel price",\n  "html": "<div>We at ABC GmbH would like to request a price quote for the solar panel.</div>",\n  "text": "We at ABC GmbH would like to request a price quote for the solar panel.",\n  "from": {\n    "name": "epilot",\n    "address": "messaging@epilot.cloud",\n    "email_type": "INTERNAL",\n    "send_status": "SEND",\n    "send_error": {}\n  },\n  "reply_to": {\n    "name": "epilot",\n    "address": "messaging@epilot.cloud",\n    "email_type": "INTERNAL",\n    "send_status": "SEND",\n    "send_error": {}\n  },\n  "to": [\n    {\n      "name": "epilot",\n      "address": "messaging@epilot.cloud",\n      "email_type": "INTERNAL",\n      "send_status": "SEND",\n      "send_error": {}\n    }\n  ],\n  "cc": [\n    {\n      "name": "epilot",\n      "address": "messaging@epilot.cloud",\n      "email_type": "INTERNAL",\n      "send_status": "SEND",\n      "send_error": {}\n    }\n  ],\n  "bcc": [\n    {\n      "name": "epilot",\n      "address": "messaging@epilot.cloud",\n      "email_type": "INTERNAL",\n      "send_status": "SEND",\n      "send_error": {}\n    }\n  ],\n  "file": {\n    "$relation": [\n      {\n        "entity_id": "f820ce3b-07b0-45ae-bcc6-babb2f53f79f",\n        "filename": "Produktinformationen_epilot360_Double_Opt_in.pdf",\n        "is_message_attachment": true,\n        "may_be_signature_attachment": true,\n        "cid": "fb222496-a1a5-4639-94f2-07b5e35e4068",\n        "inline": false,\n        "send_as_link": false,\n        "save_to_entity": true\n      }\n    ]\n  },\n  "references": "<0102017b97a502f8-a67f01c2-68cc-4928-b91b-45853f34e259-000000@eu-west-1.amazonses.com> <CALHgQpziyxW9NaFUs+nRMykzr6Ljq6vjq4WO9SaihAuMasuDyg@mail.gmail.com>",\n  "in_reply_to": "<CALHgQpziyxW9NaFUs+nRMykzr6Ljq6vjq4WO9SaihAuMasuDyg@mail.gmail.com>",\n  "user_read_message": ["206801", "200109"],\n  "org_read_message": ["789372", "210291"],\n  "send_status": ["SEND"],\n  "type": "SENT",\n  "template_id": "3f34ce73-089c-4d45-a5ee-c161234e41c3"\n}\n```\n\n</details>\n\n---\n\n### `deleteMessage`\n\nImmediately and permanently delete a message. This operation cannot be undone.\n\n`DELETE /v1/message/messages/{id}`\n\n```ts\nconst { data } = await client.deleteMessage({\n  id: \'123e4567-e89b-12d3-a456-426614174000\',\n})\n```\n\n---\n\n### `getMessageEml`\n\nDownload a message as an EML file.\nReturns a 302 redirect to a pre-signed S3 URL where the EML file can be downloaded.\n\n`GET /v1/message/messages/{id}/eml`\n\n```ts\nconst { data } = await client.getMessageEml({\n  id: \'123e4567-e89b-12d3-a456-426614174000\',\n})\n```\n\n---\n\n### `searchMessages`\n\nSearch Messages\n\n`POST /v1/message/messages:search`\n\n```ts\nconst { data } = await client.searchMessages(\n  null,\n  {\n    inbox_id: \'3f34ce73-089c-4d45-a5ee-c161234e41c3\',\n    q: \'subject:"Request for solar panel price" AND _tags:INBOX\',\n    fields: [\'_id\', \'_title\', \'first_name\', \'account\', \'!account.*._files\', \'**._product\'],\n    from: 0,\n    size: 10,\n    hydrate: false,\n    include_scores: false,\n    sort: \'string\',\n    highlight: {}\n  },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n  "hits": 14,\n  "results": [\n    {\n      "_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",\n      "_title": "string",\n      "_org": "206801",\n      "_schema": "message",\n      "_tags": ["pricing", "INBOX"],\n      "_created_at": "2021-02-09T12:41:43.662Z",\n      "_updated_at": "2021-02-10T09:14:31.990Z",\n      "message_id": "<0102017b97a502f8-a67f01c2-68cc-4928-b91b-45853f34e259-000000@eu-west-1.amazonses.com>",\n      "sender": "206801",\n      "updated_by": "206801",\n      "subject": "Request for solar panel price",\n      "html": "<div>We at ABC GmbH would like to request a price quote for the solar panel.</div>",\n      "text": "We at ABC GmbH would like to request a price quote for the solar panel.",\n      "from": {\n        "name": "epilot",\n        "address": "messaging@epilot.cloud",\n        "email_type": "INTERNAL",\n        "send_status": "SEND",\n        "send_error": {}\n      },\n      "reply_to": {\n        "name": "epilot",\n        "address": "messaging@epilot.cloud",\n        "email_type": "INTERNAL",\n        "send_status": "SEND",\n        "send_error": {}\n      },\n      "to": [\n        {\n          "name": "epilot",\n          "address": "messaging@epilot.cloud",\n          "email_type": "INTERNAL",\n          "send_status": "SEND",\n          "send_error": {}\n        }\n      ],\n      "cc": [\n        {\n          "name": "epilot",\n          "address": "messaging@epilot.cloud",\n          "email_type": "INTERNAL",\n          "send_status": "SEND",\n          "send_error": {}\n        }\n      ],\n      "bcc": [\n        {\n          "name": "epilot",\n          "address": "messaging@epilot.cloud",\n          "email_type": "INTERNAL",\n          "send_status": "SEND",\n          "send_error": {}\n        }\n      ],\n      "file": {\n        "$relation": [\n          {\n            "entity_id": "f820ce3b-07b0-45ae-bcc6-babb2f53f79f",\n            "filename": "Produktinformationen_epilot360_Double_Opt_in.pdf",\n            "is_message_attachment": true,\n            "may_be_signature_attachment": true,\n            "cid": "fb222496-a1a5-4639-94f2-07b5e35e4068",\n            "inline": false,\n            "send_as_link": false,\n            "save_to_entity": true\n          }\n        ]\n      },\n      "references": "<0102017b97a502f8-a67f01c2-68cc-4928-b91b-45853f34e259-000000@eu-west-1.amazonses.com> <CALHgQpziyxW9NaFUs+nRMykzr6Ljq6vjq4WO9SaihAuMasuDyg@mail.gmail.com>",\n      "in_reply_to": "<CALHgQpziyxW9NaFUs+nRMykzr6Ljq6vjq4WO9SaihAuMasuDyg@mail.gmail.com>",\n      "user_read_message": ["206801", "200109"],\n      "org_read_message": ["789372", "210291"],\n      "send_status": ["SEND"],\n      "type": "SENT",\n      "template_id": "3f34ce73-089c-4d45-a5ee-c161234e41c3"\n    }\n  ]\n}\n```\n\n</details>\n\n---\n\n### `trashMessage`\n\nMove a message to the trash\n\n`POST /v1/message/messages/{id}/trash`\n\n```ts\nconst { data } = await client.trashMessage({\n  id: \'123e4567-e89b-12d3-a456-426614174000\',\n})\n```\n\n---\n\n### `untrashMessage`\n\nRestore a trashed message\n\n`POST /v1/message/messages/{id}/untrash`\n\n```ts\nconst { data } = await client.untrashMessage({\n  id: \'123e4567-e89b-12d3-a456-426614174000\',\n})\n```\n\n---\n\n### `markReadMessage`\n\nMark message as read\n\n`POST /v1/message/messages/{id}/read`\n\n```ts\nconst { data } = await client.markReadMessage({\n  id: \'123e4567-e89b-12d3-a456-426614174000\',\n})\n```\n\n---\n\n### `markReadMessageV2`\n\nMark message as read within a scope\n\n`POST /v2/message/messages/{id}/read`\n\n```ts\nconst { data } = await client.markReadMessageV2(\n  {\n    id: \'123e4567-e89b-12d3-a456-426614174000\',\n  },\n  {\n    scopes: [\'organization\', \'user\']\n  },\n)\n```\n\n---\n\n### `markUnreadMessage`\n\nMark message as unread\n\n`POST /v1/message/messages/{id}/unread`\n\n```ts\nconst { data } = await client.markUnreadMessage({\n  id: \'123e4567-e89b-12d3-a456-426614174000\',\n})\n```\n\n---\n\n### `getUnread`\n\nGet all unread messages by actor\n\n`GET /v1/message/messages/unread/{actor}`\n\n```ts\nconst { data } = await client.getUnread({\n  actor: \'example\',\n  email_filter: [\'...\'],\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n  "count": 14,\n  "unread": 0,\n  "drafts": 12,\n  "unassigned": 1,\n  "spam": 3\n}\n```\n\n</details>\n\n---\n\n### `markUnreadMessageV2`\n\nMark message as unread within a scope\n\n`POST /v2/message/messages/{id}/unread`\n\n```ts\nconst { data } = await client.markUnreadMessageV2(\n  {\n    id: \'123e4567-e89b-12d3-a456-426614174000\',\n  },\n  {\n    scopes: [\'organization\', \'user\']\n  },\n)\n```\n\n---\n\n### `searchThreads`\n\nSearch for threads of email messages.\n\n`POST /v1/message/threads:search`\n\n```ts\nconst { data } = await client.searchThreads(\n  null,\n  {\n    q: \'subject:"Request for solar panel price" AND _tags:INBOX\',\n    from: 0,\n    size: 10,\n    hydrate: false\n  },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n  "hits": 14,\n  "results": [\n    {\n      "_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",\n      "_title": "string",\n      "_org": "206801",\n      "_schema": "message",\n      "_tags": ["pricing", "INBOX"],\n      "_created_at": "2021-02-09T12:41:43.662Z",\n      "_updated_at": "2021-02-10T09:14:31.990Z",\n      "topic": "CUSTOMER_MESSAGE",\n      "assigned_to": ["206801", "200109"],\n      "org_read_message": ["789372", "210291"],\n      "done": false,\n      "latest_message": {},\n      "latest_trash_message": {},\n      "latest_message_at": "2024-02-10T09:14:31.990Z"\n    }\n  ]\n}\n```\n\n</details>\n\n---\n\n### `searchThreadsV2`\n\nSearch for threads of email messages.\n\n`POST /v2/message/threads:search`\n\n```ts\nconst { data } = await client.searchThreadsV2(\n  null,\n  {\n    inbox_id: \'3f34ce73-089c-4d45-a5ee-c161234e41c3\',\n    q: \'subject:"Request for solar panel price" AND _tags:INBOX\',\n    fields: [\'_id\', \'_title\', \'first_name\', \'account\', \'!account.*._files\', \'**._product\'],\n    from: 0,\n    size: 10,\n    hydrate: false,\n    include_scores: false,\n    sort: \'string\',\n    highlight: {}\n  },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n  "hits": 14,\n  "results": [\n    {\n      "_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",\n      "_title": "string",\n      "_org": "206801",\n      "_schema": "message",\n      "_tags": ["pricing", "INBOX"],\n      "_created_at": "2021-02-09T12:41:43.662Z",\n      "_updated_at": "2021-02-10T09:14:31.990Z",\n      "topic": "CUSTOMER_MESSAGE",\n      "assigned_to": ["206801", "200109"],\n      "org_read_message": ["789372", "210291"],\n      "done": false,\n      "latest_message": {},\n      "latest_trash_message": {},\n      "latest_message_at": "2024-02-10T09:14:31.990Z"\n    }\n  ]\n}\n```\n\n</details>\n\n---\n\n### `searchIds`\n\nSearch threads and return all id\'s\n\n`POST /v1/message/threads:searchIds`\n\n```ts\nconst { data } = await client.searchIds(\n  null,\n  {\n    inbox_id: \'3f34ce73-089c-4d45-a5ee-c161234e41c3\',\n    q: \'subject:"Request for solar panel price" AND _tags:INBOX\'\n  },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n  "hits": 14,\n  "results": ["string"]\n}\n```\n\n</details>\n\n---\n\n### `getAssigneeWorkload`\n\nReturn the open-thread workload for a set of user ids.\n\n`POST /v2/message/threads:workload`\n\n```ts\nconst { data } = await client.getAssigneeWorkload(\n  null,\n  {\n    user_ids: [\'11000902\', \'11001053\']\n  },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n  "workloads": [\n    {\n      "user_id": "11000902",\n      "open_threads": 2\n    }\n  ]\n}\n```\n\n</details>\n\n---\n\n### `updateThread`\n\nModify thread metadata\n\n`PUT /v1/message/threads`\n\n```ts\nconst { data } = await client.updateThread()\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n  "_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",\n  "_title": "string",\n  "_org": "206801",\n  "_schema": "message",\n  "_tags": ["pricing", "INBOX"],\n  "_created_at": "2021-02-09T12:41:43.662Z",\n  "_updated_at": "2021-02-10T09:14:31.990Z",\n  "topic": "CUSTOMER_MESSAGE",\n  "assigned_to": ["206801", "200109"],\n  "org_read_message": ["789372", "210291"],\n  "done": false,\n  "latest_message": {\n    "message_id": "<0102017b97a502f8-a67f01c2-68cc-4928-b91b-45853f34e259-000000@eu-west-1.amazonses.com>",\n    "sender": "206801",\n    "updated_by": "206801",\n    "subject": "Request for solar panel price",\n    "html": "<div>We at ABC GmbH would like to request a price quote for the solar panel.</div>",\n    "text": "We at ABC GmbH would like to request a price quote for the solar panel.",\n    "from": {\n      "name": "epilot",\n      "address": "messaging@epilot.cloud",\n      "email_type": "INTERNAL",\n      "send_status": "SEND",\n      "send_error": {}\n    },\n    "reply_to": {\n      "name": "epilot",\n      "address": "messaging@epilot.cloud",\n      "email_type": "INTERNAL",\n      "send_status": "SEND",\n      "send_error": {}\n    },\n    "to": [\n      {}\n    ],\n    "cc": [\n      {}\n    ],\n    "bcc": [\n      {}\n    ],\n    "file": {\n      "$relation": []\n    },\n    "references": "<0102017b97a502f8-a67f01c2-68cc-4928-b91b-45853f34e259-000000@eu-west-1.amazonses.com> <CALHgQpziyxW9NaFUs+nRMykzr6Ljq6vjq4WO9SaihAuMasuDyg@mail.gmail.com>",\n    "in_reply_to": "<CALHgQpziyxW9NaFUs+nRMykzr6Ljq6vjq4WO9SaihAuMasuDyg@mail.gmail.com>",\n    "user_read_message": ["206801", "200109"],\n    "org_read_message": ["789372", "210291"],\n    "send_status": ["SEND"],\n    "type": "SENT",\n    "template_id": "3f34ce73-089c-4d45-a5ee-c161234e41c3"\n  },\n  "latest_trash_message": {\n    "message_id": "<0102017b97a502f8-a67f01c2-68cc-4928-b91b-45853f34e259-000000@eu-west-1.amazonses.com>",\n    "sender": "206801",\n    "updated_by": "206801",\n    "subject": "Request for solar panel price",\n    "html": "<div>We at ABC GmbH would like to request a price quote for the solar panel.</div>",\n    "text": "We at ABC GmbH would like to request a price quote for the solar panel.",\n    "from": {\n      "name": "epilot",\n      "address": "messaging@epilot.cloud",\n      "email_type": "INTERNAL",\n      "send_status": "SEND",\n      "send_error": {}\n    },\n    "reply_to": {\n      "name": "epilot",\n      "address": "messaging@epilot.cloud",\n      "email_type": "INTERNAL",\n      "send_status": "SEND",\n      "send_error": {}\n    },\n    "to": [\n      {}\n    ],\n    "cc": [\n      {}\n    ],\n    "bcc": [\n      {}\n    ],\n    "file": {\n      "$relation": []\n    },\n    "references": "<0102017b97a502f8-a67f01c2-68cc-4928-b91b-45853f34e259-000000@eu-west-1.amazonses.com> <CALHgQpziyxW9NaFUs+nRMykzr6Ljq6vjq4WO9SaihAuMasuDyg@mail.gmail.com>",\n    "in_reply_to": "<CALHgQpziyxW9NaFUs+nRMykzr6Ljq6vjq4WO9SaihAuMasuDyg@mail.gmail.com>",\n    "user_read_message": ["206801", "200109"],\n    "org_read_message": ["789372", "210291"],\n    "send_status": ["SEND"],\n    "type": "SENT",\n    "template_id": "3f34ce73-089c-4d45-a5ee-c161234e41c3"\n  },\n  "latest_message_at": "2024-02-10T09:14:31.990Z"\n}\n```\n\n</details>\n\n---\n\n### `deleteThread`\n\nImmediately and permanently delete a thread. This operation cannot be undone.\n\n`DELETE /v1/message/threads/{id}`\n\n```ts\nconst { data } = await client.deleteThread({\n  id: \'123e4567-e89b-12d3-a456-426614174000\',\n})\n```\n\n---\n\n### `moveThread`\n\nMove thread to a different Inbox\n\n`POST /v1/message/threads/{id}:move`\n\n```ts\nconst { data } = await client.moveThread(\n  {\n    id: \'123e4567-e89b-12d3-a456-426614174000\',\n  },\n  {\n    inbox_id: \'3f34ce73-089c-4d45-a5ee-c161234e41c3\'\n  },\n)\n```\n\n---\n\n### `markThreadAsDone`\n\nMark thread as done\n\n`POST /v1/message/threads/{id}:markAsDone`\n\n```ts\nconst { data } = await client.markThreadAsDone({\n  id: \'123e4567-e89b-12d3-a456-426614174000\',\n})\n```\n\n---\n\n### `markThreadAsOpen`\n\nMark thread as open\n\n`POST /v1/message/threads/{id}:markAsOpen`\n\n```ts\nconst { data } = await client.markThreadAsOpen({\n  id: \'123e4567-e89b-12d3-a456-426614174000\',\n})\n```\n\n---\n\n### `getThreadTimeline`\n\nGet thread timeline\n\n`GET /v1/message/threads/{id}/timeline`\n\n```ts\nconst { data } = await client.getThreadTimeline({\n  id: \'123e4567-e89b-12d3-a456-426614174000\',\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n  "events": [\n    {\n      "data": {\n        "type": "THREAD_DONE",\n        "user_id": "123",\n        "organization_id": "456"\n      },\n      "timestamp": "2024-01-01T00:00:00.000Z"\n    }\n  ]\n}\n```\n\n</details>\n\n---\n\n### `trashThread`\n\nMove a thread to trash\n\n`POST /v1/message/threads/{id}/trash`\n\n```ts\nconst { data } = await client.trashThread({\n  id: \'123e4567-e89b-12d3-a456-426614174000\',\n})\n```\n\n---\n\n### `untrashThread`\n\nRestore a trashed thread\n\n`POST /v1/message/threads/{id}/untrash`\n\n```ts\nconst { data } = await client.untrashThread({\n  id: \'123e4567-e89b-12d3-a456-426614174000\',\n})\n```\n\n---\n\n### `spamThread`\n\nMark a thread as spam\n\n`POST /v1/message/threads/{id}/spam`\n\n```ts\nconst { data } = await client.spamThread({\n  id: \'123e4567-e89b-12d3-a456-426614174000\',\n})\n```\n\n---\n\n### `unspamThread`\n\nRemove spam marking from a thread\n\n`POST /v1/message/threads/{id}/unspam`\n\n```ts\nconst { data } = await client.unspamThread({\n  id: \'123e4567-e89b-12d3-a456-426614174000\',\n})\n```\n\n---\n\n### `spamMessage`\n\nMark a single message as spam. Also marks the parent thread as spam if all messages in the thread are spam.\n\n`POST /v1/message/messages/{id}/spam`\n\n```ts\nconst { data } = await client.spamMessage({\n  id: \'123e4567-e89b-12d3-a456-426614174000\',\n})\n```\n\n---\n\n### `unspamMessage`\n\nRemove spam marking from a single message. Also removes spam from the parent thread if no other messages are spam.\n\n`POST /v1/message/messages/{id}/unspam`\n\n```ts\nconst { data } = await client.unspamMessage({\n  id: \'123e4567-e89b-12d3-a456-426614174000\',\n})\n```\n\n---\n\n### `bulkMoveThreads`\n\nMove many threads to a different inbox\n\n`POST /v1/message/threads/bulk:move`\n\n```ts\nconst { data } = await client.bulkMoveThreads(\n  null,\n  {\n    ids: [\'6b299eda-4018-4554-8965-c4b5598e6531\'],\n    assign_to: [\'206801\'],\n    inbox_id: \'3f34ce73-089c-4d45-a5ee-c161234e41c3\',\n    scopes: [\'organization\', \'user\']\n  },\n)\n```\n\n---\n\n### `bulkAssignThreads`\n\nAssign many threads\n\n`POST /v1/message/threads/bulk:assign`\n\n```ts\nconst { data } = await client.bulkAssignThreads(\n  null,\n  {\n    ids: [\'6b299eda-4018-4554-8965-c4b5598e6531\'],\n    assign_to: [\'206801\'],\n    inbox_id: \'3f34ce73-089c-4d45-a5ee-c161234e41c3\',\n    scopes: [\'organization\', \'user\']\n  },\n)\n```\n\n---\n\n### `threadBulkActionsRead`\n\nPerform a bulk action of marking an array of thread ids as read\n\n`POST /v1/message/threads/bulk:read`\n\n```ts\nconst { data } = await client.threadBulkActionsRead(\n  null,\n  {\n    ids: [\'6b299eda-4018-4554-8965-c4b5598e6531\'],\n    assign_to: [\'206801\'],\n    inbox_id: \'3f34ce73-089c-4d45-a5ee-c161234e41c3\',\n    scopes: [\'organization\', \'user\']\n  },\n)\n```\n\n---\n\n### `threadBulkActionsUnread`\n\nPerform a bulk action of marking an array of thread ids as unread\n\n`POST /v1/message/threads/bulk:unread`\n\n```ts\nconst { data } = await client.threadBulkActionsUnread(\n  null,\n  {\n    ids: [\'6b299eda-4018-4554-8965-c4b5598e6531\'],\n    assign_to: [\'206801\'],\n    inbox_id: \'3f34ce73-089c-4d45-a5ee-c161234e41c3\',\n    scopes: [\'organization\', \'user\']\n  },\n)\n```\n\n---\n\n### `threadBulkActionsFavorite`\n\nPerform a bulk action of marking an array of thread ids favorite\n\n`POST /v1/message/threads/bulk:favorite`\n\n```ts\nconst { data } = await client.threadBulkActionsFavorite(\n  null,\n  {\n    ids: [\'6b299eda-4018-4554-8965-c4b5598e6531\']\n  },\n)\n```\n\n---\n\n### `threadBulkActionsUnfavorite`\n\nPerform a bulk action of marking an array of thread ids unfavorited\n\n`POST /v1/message/threads/bulk:unfavorite`\n\n```ts\nconst { data } = await client.threadBulkActionsUnfavorite(\n  null,\n  {\n    ids: [\'6b299eda-4018-4554-8965-c4b5598e6531\']\n  },\n)\n```\n\n---\n\n### `threadBulkActionsTrash`\n\nPerform a bulk action of trashing an array of threads\n\n`POST /v1/message/threads/bulk:trash`\n\n```ts\nconst { data } = await client.threadBulkActionsTrash(\n  null,\n  {\n    ids: [\'6b299eda-4018-4554-8965-c4b5598e6531\']\n  },\n)\n```\n\n---\n\n### `threadBulkActionsUntrash`\n\nPerform a bulk action of untrashing an array of threads\n\n`POST /v1/message/threads/bulk:untrash`\n\n```ts\nconst { data } = await client.threadBulkActionsUntrash(\n  null,\n  {\n    ids: [\'6b299eda-4018-4554-8965-c4b5598e6531\']\n  },\n)\n```\n\n---\n\n### `threadBulkActionsDelete`\n\nPerforms a bulk permanent delete for all threads\n\n`POST /v1/message/threads/bulk:delete`\n\n```ts\nconst { data } = await client.threadBulkActionsDelete(\n  null,\n  {\n    ids: [\'6b299eda-4018-4554-8965-c4b5598e6531\']\n  },\n)\n```\n\n---\n\n### `threadBulkActionsDone`\n\nPerform a bulk action of marking an array of threads as done\n\n`POST /v1/message/threads/bulk:done`\n\n```ts\nconst { data } = await client.threadBulkActionsDone(\n  null,\n  {\n    ids: [\'6b299eda-4018-4554-8965-c4b5598e6531\']\n  },\n)\n```\n\n---\n\n### `threadBulkActionsOpen`\n\nPerform a bulk action of marking an array of threads as open\n\n`POST /v1/message/threads/bulk:open`\n\n```ts\nconst { data } = await client.threadBulkActionsOpen(\n  null,\n  {\n    ids: [\'6b299eda-4018-4554-8965-c4b5598e6531\']\n  },\n)\n```\n\n---\n\n### `markReadThread`\n\nMark thread as read\n\n`POST /v1/message/threads/{id}/read`\n\n```ts\nconst { data } = await client.markReadThread({\n  id: \'123e4567-e89b-12d3-a456-426614174000\',\n})\n```\n\n---\n\n### `markReadThreadV2`\n\nMark thread as read within a scope\n\n`POST /v2/message/threads/{id}/read`\n\n```ts\nconst { data } = await client.markReadThreadV2(\n  {\n    id: \'123e4567-e89b-12d3-a456-426614174000\',\n  },\n  {\n    scopes: [\'organization\', \'user\']\n  },\n)\n```\n\n---\n\n### `markUnreadThread`\n\nMark thread as unread\n\n`POST /v1/message/threads/{id}/unread`\n\n```ts\nconst { data } = await client.markUnreadThread({\n  id: \'123e4567-e89b-12d3-a456-426614174000\',\n})\n```\n\n---\n\n### `markUnreadThreadV2`\n\nMark thread as unread within a scope\n\n`POST /v2/message/threads/{id}/unread`\n\n```ts\nconst { data } = await client.markUnreadThreadV2(\n  {\n    id: \'123e4567-e89b-12d3-a456-426614174000\',\n  },\n  {\n    scopes: [\'organization\', \'user\']\n  },\n)\n```\n\n---\n\n### `assignThread`\n\nAssign thread to entities\n\n`POST /v1/message/threads/{id}/assign`\n\n```ts\nconst { data } = await client.assignThread(\n  {\n    id: \'123e4567-e89b-12d3-a456-426614174000\',\n  },\n  [\n    {\n      slug: \'contact\',\n      entity_id: \'3f34ce73-089c-4d45-a5ee-c161234e41c3\',\n      org_id: \'206801\',\n      is_main_entity: true\n    }\n  ],\n)\n```\n\n---\n\n### `unassignThread`\n\nUnassign thread from entities\n\n`POST /v1/message/threads/{id}/unassign`\n\n```ts\nconst { data } = await client.unassignThread(\n  {\n    id: \'123e4567-e89b-12d3-a456-426614174000\',\n    unlink_mapped_entities: true,\n  },\n  [\n    {\n      slug: \'contact\',\n      entity_id: \'3f34ce73-089c-4d45-a5ee-c161234e41c3\'\n    }\n  ],\n)\n```\n\n---\n\n### `assignUsers`\n\nAssign users to thread for receiving notifications.\nThe operation replaces all existing assigned users in thread.\n\n`POST /v1/message/threads/{id}/assign:users`\n\n```ts\nconst { data } = await client.assignUsers(\n  {\n    id: \'123e4567-e89b-12d3-a456-426614174000\',\n  },\n  {\n    assigned_to: [\'206801\']\n  },\n)\n```\n\n---\n\n### `assignUsersV2`\n\nAssign users to thread.\n\n`POST /v2/message/threads/{id}/assign:users`\n\n```ts\nconst { data } = await client.assignUsersV2(\n  {\n    id: \'123e4567-e89b-12d3-a456-426614174000\',\n  },\n  {\n    add: [\'206801\'],\n    remove: [\'206801\']\n  },\n)\n```\n\n---\n\n### `pinThread`\n\nPin a single thread\n\n`POST /v1/message/threads/{id}:pin`\n\n```ts\nconst { data } = await client.pinThread({\n  id: \'123e4567-e89b-12d3-a456-426614174000\',\n})\n```\n\n---\n\n### `unpinThread`\n\nUnpin a single thread\n\n`DELETE /v1/message/threads/{id}:pin`\n\n```ts\nconst { data } = await client.unpinThread({\n  id: \'123e4567-e89b-12d3-a456-426614174000\',\n})\n```\n\n---\n\n### `createDraft`\n\nCreate a new draft\n\n`POST /v1/message/drafts`\n\n```ts\nconst { data } = await client.createDraft(\n  null,\n  {},\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n  "_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",\n  "_title": "string",\n  "_org": "206801",\n  "_schema": "message",\n  "_tags": ["pricing", "INBOX"],\n  "_created_at": "2021-02-09T12:41:43.662Z",\n  "_updated_at": "2021-02-10T09:14:31.990Z",\n  "message_id": "<0102017b97a502f8-a67f01c2-68cc-4928-b91b-45853f34e259-000000@eu-west-1.amazonses.com>",\n  "sender": "206801",\n  "updated_by": "206801",\n  "subject": "Request for solar panel price",\n  "html": "<div>We at ABC GmbH would like to request a price quote for the solar panel.</div>",\n  "text": "We at ABC GmbH would like to request a price quote for the solar panel.",\n  "from": {\n    "name": "epilot",\n    "address": "messaging@epilot.cloud",\n    "email_type": "INTERNAL",\n    "send_status": "SEND",\n    "send_error": {}\n  },\n  "reply_to": {\n    "name": "epilot",\n    "address": "messaging@epilot.cloud",\n    "email_type": "INTERNAL",\n    "send_status": "SEND",\n    "send_error": {}\n  },\n  "to": [\n    {\n      "name": "epilot",\n      "address": "messaging@epilot.cloud",\n      "email_type": "INTERNAL",\n      "send_status": "SEND",\n      "send_error": {}\n    }\n  ],\n  "cc": [\n    {\n      "name": "epilot",\n      "address": "messaging@epilot.cloud",\n      "email_type": "INTERNAL",\n      "send_status": "SEND",\n      "send_error": {}\n    }\n  ],\n  "bcc": [\n    {\n      "name": "epilot",\n      "address": "messaging@epilot.cloud",\n      "email_type": "INTERNAL",\n      "send_status": "SEND",\n      "send_error": {}\n    }\n  ],\n  "file": {\n    "$relation": [\n      {\n        "entity_id": "f820ce3b-07b0-45ae-bcc6-babb2f53f79f",\n        "filename": "Produktinformationen_epilot360_Double_Opt_in.pdf",\n        "is_message_attachment": true,\n        "may_be_signature_attachment": true,\n        "cid": "fb222496-a1a5-4639-94f2-07b5e35e4068",\n        "inline": false,\n        "send_as_link": false,\n        "save_to_entity": true\n      }\n    ]\n  },\n  "references": "<0102017b97a502f8-a67f01c2-68cc-4928-b91b-45853f34e259-000000@eu-west-1.amazonses.com> <CALHgQpziyxW9NaFUs+nRMykzr6Ljq6vjq4WO9SaihAuMasuDyg@mail.gmail.com>",\n  "in_reply_to": "<CALHgQpziyxW9NaFUs+nRMykzr6Ljq6vjq4WO9SaihAuMasuDyg@mail.gmail.com>",\n  "user_read_message": ["206801", "200109"],\n  "org_read_message": ["789372", "210291"],\n  "send_status": ["SEND"],\n  "type": "SENT",\n  "template_id": "3f34ce73-089c-4d45-a5ee-c161234e41c3"\n}\n```\n\n</details>\n\n---\n\n### `sendDraft`\n\nSend the existing draft to the recipients\n\n`POST /v1/message/drafts:send`\n\n```ts\nconst { data } = await client.sendDraft()\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n  "_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",\n  "_title": "string",\n  "_org": "206801",\n  "_schema": "message",\n  "_tags": ["pricing", "INBOX"],\n  "_created_at": "2021-02-09T12:41:43.662Z",\n  "_updated_at": "2021-02-10T09:14:31.990Z",\n  "message_id": "<0102017b97a502f8-a67f01c2-68cc-4928-b91b-45853f34e259-000000@eu-west-1.amazonses.com>",\n  "sender": "206801",\n  "updated_by": "206801",\n  "subject": "Request for solar panel price",\n  "html": "<div>We at ABC GmbH would like to request a price quote for the solar panel.</div>",\n  "text": "We at ABC GmbH would like to request a price quote for the solar panel.",\n  "from": {\n    "name": "epilot",\n    "address": "messaging@epilot.cloud",\n    "email_type": "INTERNAL",\n    "send_status": "SEND",\n    "send_error": {}\n  },\n  "reply_to": {\n    "name": "epilot",\n    "address": "messaging@epilot.cloud",\n    "email_type": "INTERNAL",\n    "send_status": "SEND",\n    "send_error": {}\n  },\n  "to": [\n    {\n      "name": "epilot",\n      "address": "messaging@epilot.cloud",\n      "email_type": "INTERNAL",\n      "send_status": "SEND",\n      "send_error": {}\n    }\n  ],\n  "cc": [\n    {\n      "name": "epilot",\n      "address": "messaging@epilot.cloud",\n      "email_type": "INTERNAL",\n      "send_status": "SEND",\n      "send_error": {}\n    }\n  ],\n  "bcc": [\n    {\n      "name": "epilot",\n      "address": "messaging@epilot.cloud",\n      "email_type": "INTERNAL",\n      "send_status": "SEND",\n      "send_error": {}\n    }\n  ],\n  "file": {\n    "$relation": [\n      {\n        "entity_id": "f820ce3b-07b0-45ae-bcc6-babb2f53f79f",\n        "filename": "Produktinformationen_epilot360_Double_Opt_in.pdf",\n        "is_message_attachment": true,\n        "may_be_signature_attachment": true,\n        "cid": "fb222496-a1a5-4639-94f2-07b5e35e4068",\n        "inline": false,\n        "send_as_link": false,\n        "save_to_entity": true\n      }\n    ]\n  },\n  "references": "<0102017b97a502f8-a67f01c2-68cc-4928-b91b-45853f34e259-000000@eu-west-1.amazonses.com> <CALHgQpziyxW9NaFUs+nRMykzr6Ljq6vjq4WO9SaihAuMasuDyg@mail.gmail.com>",\n  "in_reply_to": "<CALHgQpziyxW9NaFUs+nRMykzr6Ljq6vjq4WO9SaihAuMasuDyg@mail.gmail.com>",\n  "user_read_message": ["206801", "200109"],\n  "org_read_message": ["789372", "210291"],\n  "send_status": ["SEND"],\n  "type": "SENT",\n  "template_id": "3f34ce73-089c-4d45-a5ee-c161234e41c3"\n}\n```\n\n</details>\n\n---\n\n### `getMessageV2`\n\n- Fetches message by ID\n- If the message html is omitted on the entity, then it keeps the content on the message as a signed url\n  {\n    ...\n    _id: "4d74976d-fb64-47fd-85e2-65eea140f5eb",\n    _schem\n\n`GET /v2/message/messages/{id}`\n\n```ts\nconst { data } = await client.getMessageV2({\n  id: \'123e4567-e89b-12d3-a456-426614174000\',\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n  "html_omitted": false,\n  "html_download_url": "https://s3.eu-central-1.amazonaws.com/epilot-attachments/3f34ce73-089c-4d45-a5ee-c161234e41c3/3f34ce73-089c-4d45-a5ee-c161234e41c3.html",\n  "_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",\n  "_title": "string",\n  "_org": "206801",\n  "_schema": "message",\n  "_tags": ["pricing", "INBOX"],\n  "_created_at": "2021-02-09T12:41:43.662Z",\n  "_updated_at": "2021-02-10T09:14:31.990Z",\n  "message_id": "<0102017b97a502f8-a67f01c2-68cc-4928-b91b-45853f34e259-000000@eu-west-1.amazonses.com>",\n  "sender": "206801",\n  "updated_by": "206801",\n  "subject": "Request for solar panel price",\n  "html": "<div>We at ABC GmbH would like to request a price quote for the solar panel.</div>",\n  "text": "We at ABC GmbH would like to request a price quote for the solar panel.",\n  "from": {\n    "name": "epilot",\n    "address": "messaging@epilot.cloud",\n    "email_type": "INTERNAL",\n    "send_status": "SEND",\n    "send_error": {}\n  },\n  "reply_to": {\n    "name": "epilot",\n    "address": "messaging@epilot.cloud",\n    "email_type": "INTERNAL",\n    "send_status": "SEND",\n    "send_error": {}\n  },\n  "to": [\n    {\n      "name": "epilot",\n      "address": "messaging@epilot.cloud",\n      "email_type": "INTERNAL",\n      "send_status": "SEND",\n      "send_error": {}\n    }\n  ],\n  "cc": [\n    {\n      "name": "epilot",\n      "address": "messaging@epilot.cloud",\n      "email_type": "INTERNAL",\n      "send_status": "SEND",\n      "send_error": {}\n    }\n  ],\n  "bcc": [\n    {\n      "name": "epilot",\n      "address": "messaging@epilot.cloud",\n      "email_type": "INTERNAL",\n      "send_status": "SEND",\n      "send_error": {}\n    }\n  ],\n  "file": {\n    "$relation": [\n      {\n        "entity_id": "f820ce3b-07b0-45ae-bcc6-babb2f53f79f",\n        "filename": "Produktinformationen_epilot360_Double_Opt_in.pdf",\n        "is_message_attachment": true,\n        "may_be_signature_attachment": true,\n        "cid": "fb222496-a1a5-4639-94f2-07b5e35e4068",\n        "inline": false,\n        "send_as_link": false,\n        "save_to_entity": true\n      }\n    ]\n  },\n  "references": "<0102017b97a502f8-a67f01c2-68cc-4928-b91b-45853f34e259-000000@eu-west-1.amazonses.com> <CALHgQpziyxW9NaFUs+nRMykzr6Ljq6vjq4WO9SaihAuMasuDyg@mail.gmail.com>",\n  "in_reply_to": "<CALHgQpziyxW9NaFUs+nRMykzr6Ljq6vjq4WO9SaihAuMasuDyg@mail.gmail.com>",\n  "user_read_message": ["206801", "200109"],\n  "org_read_message": ["789372", "210291"],\n  "send_status": ["SEND"],\n  "type": "SENT",\n  "template_id": "3f34ce73-089c-4d45-a5ee-c161234e41c3"\n}\n```\n\n</details>\n\n---\n\n## Schemas\n\n### `ErrorResponse`\n\n```ts\ntype ErrorResponse = {\n  error?: string\n}\n```\n\n### `MoveThreadPayload`\n\n```ts\ntype MoveThreadPayload = {\n  inbox_id: string\n}\n```\n\n### `BaseEntity`\n\n```ts\ntype BaseEntity = {\n  _id: string\n  _title: string\n  _org: string\n  _schema: string\n  _tags?: string[]\n  _created_at: string // date-time\n  _updated_at: string // date-time\n}\n```\n\n### `Thread`\n\nThread properties depend on API caller as it\'s not pre-defined. We do recommend having at least `topic` property for categorizing.\n\n```ts\ntype Thread = {\n  topic: string\n  assigned_to?: string[]\n  org_read_message?: string[]\n  done?: boolean\n  latest_message?: {\n    message_id?: string\n    sender?: string\n    updated_by?: string\n    subject: string\n    html?: string\n    text?: string\n    from: {\n      name?: { ... }\n      address: { ... }\n      email_type?: { ... }\n      send_status?: { ... }\n      send_error?: { ... }\n    }\n    reply_to?: {\n      name?: { ... }\n      address: { ... }\n      email_type?: { ... }\n      send_status?: { ... }\n      send_error?: { ... }\n    }\n    to?: Array<{\n      name?: { ... }\n      address: { ... }\n      email_type?: { ... }\n      send_status?: { ... }\n      send_error?: { ... }\n    }>\n    cc?: Array<{\n      name?: { ... }\n      address: { ... }\n      email_type?: { ... }\n      send_status?: { ... }\n      send_error?: { ... }\n    }>\n    bcc?: Array<{\n      name?: { ... }\n      address: { ... }\n      email_type?: { ... }\n      send_status?: { ... }\n      send_error?: { ... }\n    }>\n    file?: {\n      $relation?: { ... }\n    }\n    references?: string\n    in_reply_to?: string\n    user_read_message?: string[]\n    org_read_message?: string[]\n    send_status?: "SEND" | "DELIVERY" | "REJECT" | "COMPLAINT" | "BOUNCE" | "ERROR"[]\n    type?: "SENT" | "RECEIVED"\n    template_id?: string\n  }\n  latest_trash_message?: {\n    message_id?: string\n    sender?: string\n    updated_by?: string\n    subject: string\n    html?: string\n    text?: string\n    from: {\n      name?: { ... }\n      address: { ... }\n      email_type?: { ... }\n      send_status?: { ... }\n      send_error?: { ... }\n    }\n    reply_to?: {\n      name?: { ... }\n      address: { ... }\n      email_type?: { ... }\n      send_status?: { ... }\n      send_error?: { ... }\n    }\n    to?: Array<{\n      name?: { ... }\n      address: { ... }\n      email_type?: { ... }\n      send_status?: { ... }\n      send_error?: { ... }\n    }>\n    cc?: Array<{\n      name?: { ... }\n      address: { ... }\n      email_type?: { ... }\n      send_status?: { ... }\n      send_error?: { ... }\n    }>\n    bcc?: Array<{\n      name?: { ... }\n      address: { ... }\n      email_type?: { ... }\n      send_status?: { ... }\n      send_error?: { ... }\n    }>\n  // ...\n}\n```\n\n### `Message`\n\n```ts\ntype Message = {\n  message_id?: string\n  sender?: string\n  updated_by?: string\n  subject: string\n  html?: string\n  text?: string\n  from: {\n    name?: string\n    address: string\n    email_type?: "INTERNAL" | "EXTERNAL" | "PARTNER"\n    send_status?: "SEND" | "DELIVERY" | "REJECT" | "COMPLAINT" | "BOUNCE" | "ERROR"\n    send_error?: object\n  }\n  reply_to?: {\n    name?: string\n    address: string\n    email_type?: "INTERNAL" | "EXTERNAL" | "PARTNER"\n    send_status?: "SEND" | "DELIVERY" | "REJECT" | "COMPLAINT" | "BOUNCE" | "ERROR"\n    send_error?: object\n  }\n  to?: Array<{\n    name?: string\n    address: string\n    email_type?: "INTERNAL" | "EXTERNAL" | "PARTNER"\n    send_status?: "SEND" | "DELIVERY" | "REJECT" | "COMPLAINT" | "BOUNCE" | "ERROR"\n    send_error?: object\n  }>\n  cc?: Array<{\n    name?: string\n    address: string\n    email_type?: "INTERNAL" | "EXTERNAL" | "PARTNER"\n    send_status?: "SEND" | "DELIVERY" | "REJECT" | "COMPLAINT" | "BOUNCE" | "ERROR"\n    send_error?: object\n  }>\n  bcc?: Array<{\n    name?: string\n    address: string\n    email_type?: "INTERNAL" | "EXTERNAL" | "PARTNER"\n    send_status?: "SEND" | "DELIVERY" | "REJECT" | "COMPLAINT" | "BOUNCE" | "ERROR"\n    send_error?: object\n  }>\n  file?: {\n    $relation?: Array<{\n      entity_id: { ... }\n      filename?: { ... }\n      is_message_attachment?: { ... }\n      may_be_signature_attachment?: { ... }\n      cid?: { ... }\n      inline?: { ... }\n      send_as_link?: { ... }\n      save_to_entity?: { ... }\n    }>\n  }\n  references?: string\n  in_reply_to?: string\n  user_read_message?: string[]\n  org_read_message?: string[]\n  send_status?: "SEND" | "DELIVERY" | "REJECT" | "COMPLAINT" | "BOUNCE" | "ERROR"[]\n  type?: "SENT" | "RECEIVED"\n  template_id?: string\n}\n```\n\n### `MessageV2`\n\n```ts\ntype MessageV2 = {\n  _id: string\n  _title: string\n  _org: string\n  _schema: string\n  _tags?: string[]\n  _created_at: string // date-time\n  _updated_at: string // date-time\n  message_id?: string\n  sender?: string\n  updated_by?: string\n  subject: string\n  html?: string\n  text?: string\n  from: {\n    name?: string\n    address: string\n    email_type?: "INTERNAL" | "EXTERNAL" | "PARTNER"\n    send_status?: "SEND" | "DELIVERY" | "REJECT" | "COMPLAINT" | "BOUNCE" | "ERROR"\n    send_error?: object\n  }\n  reply_to?: {\n    name?: string\n    address: string\n    email_type?: "INTERNAL" | "EXTERNAL" | "PARTNER"\n    send_status?: "SEND" | "DELIVERY" | "REJECT" | "COMPLAINT" | "BOUNCE" | "ERROR"\n    send_error?: object\n  }\n  to?: Array<{\n    name?: string\n    address: string\n    email_type?: "INTERNAL" | "EXTERNAL" | "PARTNER"\n    send_status?: "SEND" | "DELIVERY" | "REJECT" | "COMPLAINT" | "BOUNCE" | "ERROR"\n    send_error?: object\n  }>\n  cc?: Array<{\n    name?: string\n    address: string\n    email_type?: "INTERNAL" | "EXTERNAL" | "PARTNER"\n    send_status?: "SEND" | "DELIVERY" | "REJECT" | "COMPLAINT" | "BOUNCE" | "ERROR"\n    send_error?: object\n  }>\n  bcc?: Array<{\n    name?: string\n    address: string\n    email_type?: "INTERNAL" | "EXTERNAL" | "PARTNER"\n    send_status?: "SEND" | "DELIVERY" | "REJECT" | "COMPLAINT" | "BOUNCE" | "ERROR"\n    send_error?: object\n  }>\n  file?: {\n    $relation?: Array<{\n      entity_id: { ... }\n      filename?: { ... }\n      is_message_attachment?: { ... }\n      may_be_signature_attachment?: { ... }\n      cid?: { ... }\n      inline?: { ... }\n      send_as_link?: { ... }\n      save_to_entity?: { ... }\n    }>\n  }\n  references?: string\n  in_reply_to?: string\n  user_read_message?: string[]\n  org_read_message?: string[]\n  send_status?: "SEND" | "DELIVERY" | "REJECT" | "COMPLAINT" | "BOUNCE" | "ERROR"[]\n  type?: "SENT" | "RECEIVED"\n  template_id?: string\n}\n```\n\n### `Address`\n\n```ts\ntype Address = {\n  name?: string\n  address: string\n  email_type?: "INTERNAL" | "EXTERNAL" | "PARTNER"\n  send_status?: "SEND" | "DELIVERY" | "REJECT" | "COMPLAINT" | "BOUNCE" | "ERROR"\n  send_error?: object\n}\n```\n\n### `AttachmentsRelation`\n\nMessage attachments\n\n```ts\ntype AttachmentsRelation = {\n  $relation?: Array<{\n    entity_id: string\n    filename?: string\n    is_message_attachment?: boolean\n    may_be_signature_attachment?: boolean\n    cid?: string\n    inline?: boolean\n    send_as_link?: boolean\n    save_to_entity?: boolean\n  }>\n}\n```\n\n### `File`\n\n```ts\ntype File = {\n  entity_id: string\n  filename?: string\n  is_message_attachment?: boolean\n  may_be_signature_attachment?: boolean\n  cid?: string\n  inline?: boolean\n  send_as_link?: boolean\n  save_to_entity?: boolean\n}\n```\n\n### `MessageRequestParams`\n\n```ts\ntype MessageRequestParams = {\n  complete_thread?: boolean\n  mark_thread_as_read?: boolean\n  thread?: {\n    topic: string\n    assigned_to?: string[]\n  }\n  parent_id?: string\n  subject: string\n  html?: string\n  text?: string\n  from: {\n    name?: string\n    address: string\n    email_type?: "INTERNAL" | "EXTERNAL" | "PARTNER"\n    send_status?: "SEND" | "DELIVERY" | "REJECT" | "COMPLAINT" | "BOUNCE" | "ERROR"\n    send_error?: object\n  }\n  reply_to?: {\n    name?: string\n    address: string\n    email_type?: "INTERNAL" | "EXTERNAL" | "PARTNER"\n    send_status?: "SEND" | "DELIVERY" | "REJECT" | "COMPLAINT" | "BOUNCE" | "ERROR"\n    send_error?: object\n  }\n  to?: Array<{\n    name?: string\n    address: string\n    email_type?: "INTERNAL" | "EXTERNAL" | "PARTNER"\n    send_status?: "SEND" | "DELIVERY" | "REJECT" | "COMPLAINT" | "BOUNCE" | "ERROR"\n    send_error?: object\n  }>\n  cc?: Array<{\n    name?: string\n    address: string\n    email_type?: "INTERNAL" | "EXTERNAL" | "PARTNER"\n    send_status?: "SEND" | "DELIVERY" | "REJECT" | "COMPLAINT" | "BOUNCE" | "ERROR"\n    send_error?: object\n  }>\n  bcc?: Array<{\n    name?: string\n    address: string\n    email_type?: "INTERNAL" | "EXTERNAL" | "PARTNER"\n    send_status?: "SEND" | "DELIVERY" | "REJECT" | "COMPLAINT" | "BOUNCE" | "ERROR"\n    send_error?: object\n  }>\n  file?: {\n    $relation?: Array<{\n      entity_id: { ... }\n      filename?: { ... }\n      is_message_attachment?: { ... }\n      may_be_signature_attachment?: { ... }\n      cid?: { ... }\n      inline?: { ... }\n      send_as_link?: { ... }\n      save_to_entity?: { ... }\n    }>\n  }\n  template_id?: string\n  source?: "manual" | "automation" | "workflow" | "partner" | "bulk" | "system"\n}\n```\n\n### `SearchParamsV2`\n\n```ts\ntype SearchParamsV2 = {\n  inbox_id?: string | string[]\n  q: string\n  fields?: string[]\n  from?: number\n  size?: number\n  hydrate?: boolean\n  include_scores?: boolean\n  sort?: string\n  highlight?: unknown\n}\n```\n\n### `SearchParams`\n\n```ts\ntype SearchParams = {\n  q: string\n  from?: number\n  size?: number\n  hydrate?: boolean\n}\n```\n\n### `SearchIDParams`\n\n```ts\ntype SearchIDParams = {\n  inbox_id?: string | string[]\n  q?: string\n}\n```\n\n### `AssigneeWorkloadParams`\n\n```ts\ntype AssigneeWorkloadParams = {\n  user_ids: string[]\n}\n```\n\n### `AssigneeWorkload`\n\n```ts\ntype AssigneeWorkload = {\n  user_id: string\n  open_threads: number\n}\n```\n\n### `AssigneeWorkloadResults`\n\n```ts\ntype AssigneeWorkloadResults = {\n  workloads: Array<{\n    user_id: string\n    open_threads: number\n  }>\n}\n```\n\n### `ReadMessagePayload`\n\n```ts\ntype ReadMessagePayload = {\n  scopes: "organization" | "user"[]\n}\n```\n\n### `ReadingScope`\n\nWho is marking an item as read or unread.\n\n```ts\ntype ReadingScope = "organization" | "user"\n```\n\n### `ThreadTimeline`\n\n```ts\ntype ThreadTimeline = {\n  events: Array<{\n    data: {\n      type: { ... }\n      user_id: { ... }\n      organization_id: { ... }\n    } | {\n      type: { ... }\n      user_id: { ... }\n      organization_id: { ... }\n    }\n    timestamp: string\n  }>\n}\n```\n\n### `ThreadDoneEvent`\n\n```ts\ntype ThreadDoneEvent = {\n  type: "THREAD_DONE"\n  user_id: string\n  organization_id: string\n}\n```\n\n### `ThreadOpenEvent`\n\n```ts\ntype ThreadOpenEvent = {\n  type: "THREAD_OPEN"\n  user_id: string\n  organization_id: string\n}\n```\n\n### `TimelineEventData`\n\n```ts\ntype TimelineEventData = {\n  type: "THREAD_DONE"\n  user_id: string\n  organization_id: string\n} | {\n  type: "THREAD_OPEN"\n  user_id: string\n  organization_id: string\n}\n```\n\n### `TimelineEvent`\n\n```ts\ntype TimelineEvent = {\n  data: {\n    type: "THREAD_DONE"\n    user_id: string\n    organization_id: string\n  } | {\n    type: "THREAD_OPEN"\n    user_id: string\n    organization_id: string\n  }\n  timestamp: string\n}\n```\n\n### `BulkActionsPayloadWithScopes`\n\n```ts\ntype BulkActionsPayloadWithScopes = {\n  ids: string[]\n  assign_to?: string[]\n  inbox_id?: string\n  scopes?: "organization" | "user"[]\n}\n```\n\n### `BulkActionsPayload`\n\n```ts\ntype BulkActionsPayload = {\n  ids: string[]\n}\n```\n\n### `FieldsParam`\n\nList of entity fields to include or exclude in the response\n\nUse ! to exclude fields, e.g. `!_id` to exclude the `_id` field.\n\nGlobbing and globstart (**) is supported for nested fields.\n\n\n```ts\ntype FieldsParam = string[]\n```\n';
+
+
+exports.default = message_default;