@epilot/sdk 2.18.14 → 2.18.16

package/dist/{integration-toolkit.d-pP-3dBPT.d.ts → integration-toolkit.d-CoMi10QU.d.ts}

@@ -1562,6 +1562,72 @@ declare namespace Components {
          *
          */
         FileProxyDeliveryConfig;
+        /**
+         * A markdown documentation page of an integration
+         */
+        export interface DocumentationPage {
+            /**
+             * 'general' for the integration-wide page, otherwise the use case ID
+             * example:
+             * general
+             */
+            id: string;
+            integration_id: string; // uuid
+            /**
+             * Whether the page documents the whole integration or a single use case
+             */
+            scope: "integration" | "use_case";
+            /**
+             * The linked use case. Only set when scope is use_case.
+             */
+            use_case_id?: string; // uuid
+            title: string;
+            created_at: string; // date-time
+            /**
+             * User ID that created the page
+             */
+            created_by?: string | null;
+            updated_at: string; // date-time
+            /**
+             * User ID of the last edit
+             */
+            updated_by?: string | null;
+            /**
+             * Markdown source of the page
+             */
+            content: string;
+        }
+        /**
+         * Documentation page metadata without the markdown content
+         */
+        export interface DocumentationPageSummary {
+            /**
+             * 'general' for the integration-wide page, otherwise the use case ID
+             * example:
+             * general
+             */
+            id: string;
+            integration_id: string; // uuid
+            /**
+             * Whether the page documents the whole integration or a single use case
+             */
+            scope: "integration" | "use_case";
+            /**
+             * The linked use case. Only set when scope is use_case.
+             */
+            use_case_id?: string; // uuid
+            title: string;
+            created_at: string; // date-time
+            /**
+             * User ID that created the page
+             */
+            created_by?: string | null;
+            updated_at: string; // date-time
+            /**
+             * User ID of the last edit
+             */
+            updated_by?: string | null;
+        }
         export interface EmbeddedFileProxyUseCaseRequest {
             /**
              * Optional use case ID for update matching.
@@ -2155,6 +2221,14 @@ declare namespace Components {
              */
             status: "PENDING" | "VALIDATING" | "READY" | "PROCESSING" | "IMPORTED" | "FAILED" | "CANCELLING" | "CANCELLED";
             s3_input_ref: S3Reference;
+            /**
+             * Size of the uploaded file, recorded at registration. Present on every job registered from version 1.17.0 onwards; absent on older rows, which were written before it was captured.
+             */
+            size_bytes?: number; // int64
+            /**
+             * How many effective columns the file's header yielded — the length of the `preview.columns` returned at registration, kept so a job loaded later can still describe its file. The preview ROWS are deliberately not stored: they are a sample for the person about to choose a mapping, not job state. Present on every job registered from version 1.17.0 onwards.
+             */
+            column_count?: number;
             validation?: /* Validate-phase summary: what the file will create, and whether it may be confirmed. Absent until the validate phase completes. No per-row detail is kept — a rejected file is corrected and imported again. */ ErpImportValidation;
             progress?: /**
              * How far the currently running phase has got. Written at every batch boundary, so it advances during long runs rather than only at the end.
@@ -7126,6 +7200,13 @@ declare namespace Components {
              */
             change_description?: string;
         }
+        export interface UpsertDocumentationPageRequest {
+            title: string;
+            /**
+             * Markdown source of the page
+             */
+            content: string;
+        }
         /**
          * Request to create or update an integration with embedded use cases (upsert).
          * This is a declarative operation - the request represents the desired state.
@@ -7439,6 +7520,41 @@ declare namespace Paths {
             export type $500 = Components.Responses.InternalServerError;
         }
     }
+    namespace DeleteDocumentationPage {
+        namespace Parameters {
+            export type DocId = string; // ^(general|[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$
+            export type IntegrationId = string; // uuid
+        }
+        export interface PathParameters {
+            integrationId: Parameters.IntegrationId /* uuid */;
+            docId: Parameters.DocId /* ^(general|[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$ */;
+        }
+        namespace Responses {
+            export interface $200 {
+                message?: string;
+            }
+            export type $401 = Components.Responses.Unauthorized;
+            export type $403 = Components.Responses.Forbidden;
+            export interface $404 {
+            }
+            export type $500 = Components.Responses.InternalServerError;
+        }
+    }
+    namespace DeleteErpImport {
+        namespace Parameters {
+            export type ImportId = string;
+        }
+        export interface PathParameters {
+            importId: Parameters.ImportId;
+        }
+        namespace Responses {
+            export interface $204 {
+            }
+            export type $403 = Components.Responses.Forbidden;
+            export type $404 = Components.Responses.NotFound;
+            export type $500 = Components.Responses.InternalServerError;
+        }
+    }
     namespace DeleteIntegration {
         namespace Parameters {
             export type IntegrationId = string; // uuid
@@ -7575,6 +7691,23 @@ declare namespace Paths {
             export type $500 = Components.Responses.InternalServerError;
         }
     }
+    namespace GetDocumentationPage {
+        namespace Parameters {
+            export type DocId = string; // ^(general|[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$
+            export type IntegrationId = string; // uuid
+        }
+        export interface PathParameters {
+            integrationId: Parameters.IntegrationId /* uuid */;
+            docId: Parameters.DocId /* ^(general|[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$ */;
+        }
+        namespace Responses {
+            export type $200 = /* A markdown documentation page of an integration */ Components.Schemas.DocumentationPage;
+            export type $401 = Components.Responses.Unauthorized;
+            export interface $404 {
+            }
+            export type $500 = Components.Responses.InternalServerError;
+        }
+    }
     namespace GetErpImport {
         namespace Parameters {
             export type ImportId = string;
@@ -7791,6 +7924,23 @@ declare namespace Paths {
             export type $500 = Components.Responses.InternalServerError;
         }
     }
+    namespace ListDocumentationPages {
+        namespace Parameters {
+            export type IntegrationId = string; // uuid
+        }
+        export interface PathParameters {
+            integrationId: Parameters.IntegrationId /* uuid */;
+        }
+        namespace Responses {
+            export interface $200 {
+                pages: /* Documentation page metadata without the markdown content */ Components.Schemas.DocumentationPageSummary[];
+            }
+            export type $401 = Components.Responses.Unauthorized;
+            export interface $404 {
+            }
+            export type $500 = Components.Responses.InternalServerError;
+        }
+    }
     namespace ListErpImports {
         namespace Parameters {
             export type Cursor = string;
@@ -8374,6 +8524,26 @@ declare namespace Paths {
             export type $500 = Components.Responses.InternalServerError;
         }
     }
+    namespace UpsertDocumentationPage {
+        namespace Parameters {
+            export type DocId = string; // ^(general|[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$
+            export type IntegrationId = string; // uuid
+        }
+        export interface PathParameters {
+            integrationId: Parameters.IntegrationId /* uuid */;
+            docId: Parameters.DocId /* ^(general|[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$ */;
+        }
+        export type RequestBody = Components.Schemas.UpsertDocumentationPageRequest;
+        namespace Responses {
+            export type $200 = /* A markdown documentation page of an integration */ Components.Schemas.DocumentationPage;
+            export type $400 = Components.Responses.BadRequest;
+            export type $401 = Components.Responses.Unauthorized;
+            export type $403 = Components.Responses.Forbidden;
+            export interface $404 {
+            }
+            export type $500 = Components.Responses.InternalServerError;
+        }
+    }
     namespace ValidateErpImport {
         namespace Parameters {
             export type ImportId = string;
@@ -8614,6 +8784,53 @@ interface OperationMethods {
     data?: any,
     config?: AxiosRequestConfig  
   ): OperationResponse<Paths.ListUseCaseHistory.Responses.$200>
+  /**
+   * listDocumentationPages - listDocumentationPages
+   * 
+   * Retrieve all documentation pages of an integration, without their markdown content.
+   * An integration has at most one general page plus at most one page per use case.
+   * The page id is 'general' for the integration-wide page, otherwise the use case ID.
+   * 
+   */
+  'listDocumentationPages'(
+    parameters?: Parameters<Paths.ListDocumentationPages.PathParameters> | null,
+    data?: any,
+    config?: AxiosRequestConfig  
+  ): OperationResponse<Paths.ListDocumentationPages.Responses.$200>
+  /**
+   * getDocumentationPage - getDocumentationPage
+   * 
+   * Retrieve a single documentation page including its markdown content
+   */
+  'getDocumentationPage'(
+    parameters?: Parameters<Paths.GetDocumentationPage.PathParameters> | null,
+    data?: any,
+    config?: AxiosRequestConfig  
+  ): OperationResponse<Paths.GetDocumentationPage.Responses.$200>
+  /**
+   * upsertDocumentationPage - upsertDocumentationPage
+   * 
+   * Create or update the documentation page identified by docId.
+   * Upsert semantics enforce the invariant of one general page per
+   * integration and one page per use case. For use case pages the
+   * use case must exist.
+   * 
+   */
+  'upsertDocumentationPage'(
+    parameters?: Parameters<Paths.UpsertDocumentationPage.PathParameters> | null,
+    data?: Paths.UpsertDocumentationPage.RequestBody,
+    config?: AxiosRequestConfig  
+  ): OperationResponse<Paths.UpsertDocumentationPage.Responses.$200>
+  /**
+   * deleteDocumentationPage - deleteDocumentationPage
+   * 
+   * Delete a documentation page
+   */
+  'deleteDocumentationPage'(
+    parameters?: Parameters<Paths.DeleteDocumentationPage.PathParameters> | null,
+    data?: any,
+    config?: AxiosRequestConfig  
+  ): OperationResponse<Paths.DeleteDocumentationPage.Responses.$200>
   /**
    * listIntegrationsV2 - listIntegrationsV2
    * 
@@ -9157,6 +9374,16 @@ interface OperationMethods {
     data?: any,
     config?: AxiosRequestConfig  
   ): OperationResponse<Paths.GetErpImport.Responses.$200>
+  /**
+   * deleteErpImport - deleteErpImport
+   * 
+   * Remove an import and the file it owns. Allowed from any status: an import whose run is still in flight is stopped by the deletion, and rows it already wrote stay written.
+   */
+  'deleteErpImport'(
+    parameters?: Parameters<Paths.DeleteErpImport.PathParameters> | null,
+    data?: any,
+    config?: AxiosRequestConfig  
+  ): OperationResponse<Paths.DeleteErpImport.Responses.$204>
   /**
    * validateErpImport - validateErpImport
    * 
@@ -9452,6 +9679,57 @@ interface PathsDictionary {
       config?: AxiosRequestConfig  
     ): OperationResponse<Paths.ListUseCaseHistory.Responses.$200>
   }
+  ['/v1/integrations/{integrationId}/documentation']: {
+    /**
+     * listDocumentationPages - listDocumentationPages
+     * 
+     * Retrieve all documentation pages of an integration, without their markdown content.
+     * An integration has at most one general page plus at most one page per use case.
+     * The page id is 'general' for the integration-wide page, otherwise the use case ID.
+     * 
+     */
+    'get'(
+      parameters?: Parameters<Paths.ListDocumentationPages.PathParameters> | null,
+      data?: any,
+      config?: AxiosRequestConfig  
+    ): OperationResponse<Paths.ListDocumentationPages.Responses.$200>
+  }
+  ['/v1/integrations/{integrationId}/documentation/{docId}']: {
+    /**
+     * getDocumentationPage - getDocumentationPage
+     * 
+     * Retrieve a single documentation page including its markdown content
+     */
+    'get'(
+      parameters?: Parameters<Paths.GetDocumentationPage.PathParameters> | null,
+      data?: any,
+      config?: AxiosRequestConfig  
+    ): OperationResponse<Paths.GetDocumentationPage.Responses.$200>
+    /**
+     * upsertDocumentationPage - upsertDocumentationPage
+     * 
+     * Create or update the documentation page identified by docId.
+     * Upsert semantics enforce the invariant of one general page per
+     * integration and one page per use case. For use case pages the
+     * use case must exist.
+     * 
+     */
+    'put'(
+      parameters?: Parameters<Paths.UpsertDocumentationPage.PathParameters> | null,
+      data?: Paths.UpsertDocumentationPage.RequestBody,
+      config?: AxiosRequestConfig  
+    ): OperationResponse<Paths.UpsertDocumentationPage.Responses.$200>
+    /**
+     * deleteDocumentationPage - deleteDocumentationPage
+     * 
+     * Delete a documentation page
+     */
+    'delete'(
+      parameters?: Parameters<Paths.DeleteDocumentationPage.PathParameters> | null,
+      data?: any,
+      config?: AxiosRequestConfig  
+    ): OperationResponse<Paths.DeleteDocumentationPage.Responses.$200>
+  }
   ['/v2/integrations']: {
     /**
      * listIntegrationsV2 - listIntegrationsV2
@@ -10060,6 +10338,16 @@ interface PathsDictionary {
       data?: any,
       config?: AxiosRequestConfig  
     ): OperationResponse<Paths.GetErpImport.Responses.$200>
+    /**
+     * deleteErpImport - deleteErpImport
+     * 
+     * Remove an import and the file it owns. Allowed from any status: an import whose run is still in flight is stopped by the deletion, and rows it already wrote stay written.
+     */
+    'delete'(
+      parameters?: Parameters<Paths.DeleteErpImport.PathParameters> | null,
+      data?: any,
+      config?: AxiosRequestConfig  
+    ): OperationResponse<Paths.DeleteErpImport.Responses.$204>
   }
   ['/v2/erp/imports/{importId}:validate']: {
     /**
@@ -10139,6 +10427,8 @@ type CreateUseCaseRequest = Components.Schemas.CreateUseCaseRequest;
 type CreateUseCaseRequestBase = Components.Schemas.CreateUseCaseRequestBase;
 type DeleteIntegrationAppMappingRequest = Components.Schemas.DeleteIntegrationAppMappingRequest;
 type DeliveryConfig = Components.Schemas.DeliveryConfig;
+type DocumentationPage = Components.Schemas.DocumentationPage;
+type DocumentationPageSummary = Components.Schemas.DocumentationPageSummary;
 type EmbeddedFileProxyUseCaseRequest = Components.Schemas.EmbeddedFileProxyUseCaseRequest;
 type EmbeddedInboundUseCaseRequest = Components.Schemas.EmbeddedInboundUseCaseRequest;
 type EmbeddedManagedCallUseCaseRequest = Components.Schemas.EmbeddedManagedCallUseCaseRequest;
@@ -10303,6 +10593,7 @@ type UpdateOutboundUseCaseRequest = Components.Schemas.UpdateOutboundUseCaseRequ
 type UpdateSecureProxyUseCaseRequest = Components.Schemas.UpdateSecureProxyUseCaseRequest;
 type UpdateUseCaseRequest = Components.Schemas.UpdateUseCaseRequest;
 type UpdateUseCaseRequestBase = Components.Schemas.UpdateUseCaseRequestBase;
+type UpsertDocumentationPageRequest = Components.Schemas.UpsertDocumentationPageRequest;
 type UpsertIntegrationWithUseCasesRequest = Components.Schemas.UpsertIntegrationWithUseCasesRequest;
 type UseCase = Components.Schemas.UseCase;
 type UseCaseBase = Components.Schemas.UseCaseBase;
@@ -10313,4 +10604,4 @@ type ValidateErpImportRequest = Components.Schemas.ValidateErpImportRequest;
 type WebhookDeliveryConfig = Components.Schemas.WebhookDeliveryConfig;
 type WebhookStatus = Components.Schemas.WebhookStatus;
 
-export { type FileProxyFanOutConfig as $, type AccessLogEntry as A, type EntityPruneScopeUpdate as B, type Client as C, type DeleteIntegrationAppMappingRequest as D, type EmbeddedFileProxyUseCaseRequest as E, type EntityUpdate as F, type EnvVarRefConfig as G, type EnvironmentFieldConfig as H, type ErpEvent as I, type ErpEventV3 as J, type ErpImportError as K, type ErpImportFilePreview as L, type ErpImportIssue as M, type ErpImportJob as N, type OperationMethods as O, Paths as P, type ErpImportList as Q, type ErpImportProgress as R, type ErpImportUseCaseSuggestion as S, type ErpImportValidation as T, type ErpUpdatesEventsV2Request as U, type ErpUpdatesEventsV3Request as V, type ErrorResponseBase as W, type ExecuteErpImportRequest as X, type ExternalMonitoringSpan as Y, type FileProxyAuth as Z, type FileProxyDeliveryConfig as _, Components as a, type NotificationRule as a$, type FileProxyLookup as a0, type FileProxyParam as a1, type FileProxyResponseConfig as a2, type FileProxySecureProxyAttachment as a3, type FileProxyStep as a4, type FileProxyUploadConfig as a5, type FileProxyUrlConfig as a6, type FileProxyUrlParam as a7, type FileProxyUrlParams as a8, type FileProxyUseCase as a9, type IntegrationSettings as aA, type IntegrationWithUseCases as aB, type ManagedCallAuth as aC, type ManagedCallErrorResponse as aD, type ManagedCallExecuteRequest as aE, type ManagedCallExecuteResponse as aF, type ManagedCallOperation as aG, type ManagedCallOperationConfig as aH, type ManagedCallUseCase as aI, type ManagedCallUseCaseHistoryEntry as aJ, type MappingSimulationRequest as aK, type MappingSimulationResponse as aL, type MappingSimulationV2Request as aM, type MappingSimulationWarning as aN, type MeterReadingPruneScopeConfig as aO, type MeterReadingPruneScopeUpdate as aP, type MeterReadingUpdate as aQ, type MeterUniqueIdsConfig as aR, type MonitoringEventV2 as aS, type MonitoringStats as aT, type MonitoringStatsV2 as aU, type MonitoringTraceResponse as aV, type NotificationChannelSet as aW, type NotificationDigestConfig as aX, type NotificationHistoryItem as aY, type NotificationHistoryResponse as aZ, type NotificationRecipient as a_, type FileProxyUseCaseConfiguration as aa, type FileProxyUseCaseHistoryEntry as ab, type GenerateTypesPreviewResponse as ac, type GenerateTypesRequest as ad, type GenerateTypesResponse as ae, type GetMonitoringStatsRequest as af, type GetMonitoringStatsV2Request as ag, type GetMonitoringTimeSeriesRequest as ah, type GetMonitoringTimeSeriesV2Request as ai, type InboundIntegrationEventConfiguration as aj, type InboundMonitoringEvent as ak, type InboundUseCase as al, type InboundUseCaseHistoryEntry as am, type IngestExternalMonitoringEventsRequest as an, type IngestExternalMonitoringEventsResponse as ao, type Integration as ap, type IntegrationAppMapping as aq, type IntegrationConfigurationV1 as ar, type IntegrationConfigurationV2 as as, type IntegrationEditableFields as at, type IntegrationEntity as au, type IntegrationEntityField as av, type IntegrationFieldV1 as aw, type IntegrationMeterReading as ax, type IntegrationNotificationConfig as ay, type IntegrationObjectV1 as az, type PathsDictionary as b, type UpdateFileProxyUseCaseRequest as b$, type NotificationRuleStatus as b0, type NotificationStatusResponse as b1, type OutboundConflict as b2, type OutboundDlqListResponse as b3, type OutboundDlqMessage as b4, type OutboundFileProxyTargetStatus as b5, type OutboundIntegrationEventConfiguration as b6, type OutboundMapping as b7, type OutboundMessage as b8, type OutboundMonitoringEvent as b9, type RepeatableFieldType as bA, type ReplayEventsRequest as bB, type RuleBaselineBucket as bC, type RuleBaselineStatus as bD, type S3Reference as bE, type SecureProxyRequest as bF, type SecureProxyResponse as bG, type SecureProxySummary as bH, type SecureProxyUpstreamError as bI, type SecureProxyUseCase as bJ, type SecureProxyUseCaseConfiguration as bK, type SecureProxyUseCaseHistoryEntry as bL, type SecureProxyWhitelist as bM, type SecureProxyWhitelistUpdate as bN, type SetIntegrationAppMappingRequest as bO, type SuggestErpImportUseCasesResponse as bP, type TestNotificationRequest as bQ, type TestNotificationResponse as bR, type TimeSeriesBreakdownItemV2 as bS, type TimeSeriesBucket as bT, type TimeSeriesBucketV2 as bU, type TriggerErpActionRequest as bV, type TriggerWebhookResp as bW, type TypeAnnotations as bX, type TypeDescriptor as bY, type UnblockOutboundStreamRequest as bZ, type UnblockOutboundStreamResponse as b_, type OutboundPollStatus as ba, type OutboundStatusResponse as bb, type OutboundUseCase as bc, type OutboundUseCaseHistoryEntry as bd, type OutboundUseCaseStatus as be, type PollDeliveryConfig as bf, type PollOutboundMessagesRequest as bg, type PollOutboundMessagesResponse as bh, type PortalOrigin as bi, type PortalRefConfig as bj, type PortalRefFilter as bk, type PruneScopeConfig as bl, type QueryAccessLogsRequest as bm, type QueryEventsRequest as bn, type QueryInboundMonitoringEventsRequest as bo, type QueryMonitoringEventsV2Request as bp, type QueryOutboundMonitoringEventsRequest as bq, type RedriveOutboundDlqRequest as br, type RedriveOutboundDlqResponse as bs, type RedriveOutboundDlqResult as bt, type RelationConfig as bu, type RelationItemConfig as bv, type RelationRefItemConfig as bw, type RelationRefValueConfig as bx, type RelationRefsConfig as by, type RelationUniqueIdField as bz, type AckOutboundMessagesRequest as c, type UpdateInboundUseCaseRequest as c0, type UpdateIntegrationRequest as c1, type UpdateManagedCallUseCaseRequest as c2, type UpdateOutboundUseCaseRequest as c3, type UpdateSecureProxyUseCaseRequest as c4, type UpdateUseCaseRequest as c5, type UpdateUseCaseRequestBase as c6, type UpsertIntegrationWithUseCasesRequest as c7, type UseCase as c8, type UseCaseBase as c9, type UseCaseHistoryEntry as ca, type UseCaseHistoryEntryBase as cb, type UseCaseTypePreview as cc, type ValidateErpImportRequest as cd, type WebhookDeliveryConfig as ce, type WebhookStatus as cf, type AckOutboundMessagesResponse as d, type AckResult as e, type AutoRefreshSettings as f, type CommitTypesRequest as g, type CommitTypesResponse as h, type ConnectorConfig as i, type CreateErpImportRequest as j, type CreateErpImportResponse as k, type CreateFileProxyUseCaseRequest as l, type CreateInboundUseCaseRequest as m, type CreateIntegrationRequest as n, type CreateManagedCallUseCaseRequest as o, type CreateOutboundUseCaseRequest as p, type CreateSecureProxyUseCaseRequest as q, type CreateUseCaseRequest as r, type CreateUseCaseRequestBase as s, type DeliveryConfig as t, type EmbeddedInboundUseCaseRequest as u, type EmbeddedManagedCallUseCaseRequest as v, type EmbeddedOutboundUseCaseRequest as w, type EmbeddedSecureProxyUseCaseRequest as x, type EmbeddedUseCaseRequest as y, type EmbeddedUseCaseRequestBase as z };
+export { type FileProxyAuth as $, type AccessLogEntry as A, type EmbeddedUseCaseRequest as B, type Client as C, type DeleteIntegrationAppMappingRequest as D, type EmbeddedFileProxyUseCaseRequest as E, type EmbeddedUseCaseRequestBase as F, type EntityPruneScopeUpdate as G, type EntityUpdate as H, type EnvVarRefConfig as I, type EnvironmentFieldConfig as J, type ErpEvent as K, type ErpEventV3 as L, type ErpImportError as M, type ErpImportFilePreview as N, type OperationMethods as O, Paths as P, type ErpImportIssue as Q, type ErpImportJob as R, type ErpImportList as S, type ErpImportProgress as T, type ErpImportUseCaseSuggestion as U, type ErpImportValidation as V, type ErpUpdatesEventsV2Request as W, type ErpUpdatesEventsV3Request as X, type ErrorResponseBase as Y, type ExecuteErpImportRequest as Z, type ExternalMonitoringSpan as _, Components as a, type NotificationHistoryResponse as a$, type FileProxyDeliveryConfig as a0, type FileProxyFanOutConfig as a1, type FileProxyLookup as a2, type FileProxyParam as a3, type FileProxyResponseConfig as a4, type FileProxySecureProxyAttachment as a5, type FileProxyStep as a6, type FileProxyUploadConfig as a7, type FileProxyUrlConfig as a8, type FileProxyUrlParam as a9, type IntegrationNotificationConfig as aA, type IntegrationObjectV1 as aB, type IntegrationSettings as aC, type IntegrationWithUseCases as aD, type ManagedCallAuth as aE, type ManagedCallErrorResponse as aF, type ManagedCallExecuteRequest as aG, type ManagedCallExecuteResponse as aH, type ManagedCallOperation as aI, type ManagedCallOperationConfig as aJ, type ManagedCallUseCase as aK, type ManagedCallUseCaseHistoryEntry as aL, type MappingSimulationRequest as aM, type MappingSimulationResponse as aN, type MappingSimulationV2Request as aO, type MappingSimulationWarning as aP, type MeterReadingPruneScopeConfig as aQ, type MeterReadingPruneScopeUpdate as aR, type MeterReadingUpdate as aS, type MeterUniqueIdsConfig as aT, type MonitoringEventV2 as aU, type MonitoringStats as aV, type MonitoringStatsV2 as aW, type MonitoringTraceResponse as aX, type NotificationChannelSet as aY, type NotificationDigestConfig as aZ, type NotificationHistoryItem as a_, type FileProxyUrlParams as aa, type FileProxyUseCase as ab, type FileProxyUseCaseConfiguration as ac, type FileProxyUseCaseHistoryEntry as ad, type GenerateTypesPreviewResponse as ae, type GenerateTypesRequest as af, type GenerateTypesResponse as ag, type GetMonitoringStatsRequest as ah, type GetMonitoringStatsV2Request as ai, type GetMonitoringTimeSeriesRequest as aj, type GetMonitoringTimeSeriesV2Request as ak, type InboundIntegrationEventConfiguration as al, type InboundMonitoringEvent as am, type InboundUseCase as an, type InboundUseCaseHistoryEntry as ao, type IngestExternalMonitoringEventsRequest as ap, type IngestExternalMonitoringEventsResponse as aq, type Integration as ar, type IntegrationAppMapping as as, type IntegrationConfigurationV1 as at, type IntegrationConfigurationV2 as au, type IntegrationEditableFields as av, type IntegrationEntity as aw, type IntegrationEntityField as ax, type IntegrationFieldV1 as ay, type IntegrationMeterReading as az, type PathsDictionary as b, type UnblockOutboundStreamRequest as b$, type NotificationRecipient as b0, type NotificationRule as b1, type NotificationRuleStatus as b2, type NotificationStatusResponse as b3, type OutboundConflict as b4, type OutboundDlqListResponse as b5, type OutboundDlqMessage as b6, type OutboundFileProxyTargetStatus as b7, type OutboundIntegrationEventConfiguration as b8, type OutboundMapping as b9, type RelationRefsConfig as bA, type RelationUniqueIdField as bB, type RepeatableFieldType as bC, type ReplayEventsRequest as bD, type RuleBaselineBucket as bE, type RuleBaselineStatus as bF, type S3Reference as bG, type SecureProxyRequest as bH, type SecureProxyResponse as bI, type SecureProxySummary as bJ, type SecureProxyUpstreamError as bK, type SecureProxyUseCase as bL, type SecureProxyUseCaseConfiguration as bM, type SecureProxyUseCaseHistoryEntry as bN, type SecureProxyWhitelist as bO, type SecureProxyWhitelistUpdate as bP, type SetIntegrationAppMappingRequest as bQ, type SuggestErpImportUseCasesResponse as bR, type TestNotificationRequest as bS, type TestNotificationResponse as bT, type TimeSeriesBreakdownItemV2 as bU, type TimeSeriesBucket as bV, type TimeSeriesBucketV2 as bW, type TriggerErpActionRequest as bX, type TriggerWebhookResp as bY, type TypeAnnotations as bZ, type TypeDescriptor as b_, type OutboundMessage as ba, type OutboundMonitoringEvent as bb, type OutboundPollStatus as bc, type OutboundStatusResponse as bd, type OutboundUseCase as be, type OutboundUseCaseHistoryEntry as bf, type OutboundUseCaseStatus as bg, type PollDeliveryConfig as bh, type PollOutboundMessagesRequest as bi, type PollOutboundMessagesResponse as bj, type PortalOrigin as bk, type PortalRefConfig as bl, type PortalRefFilter as bm, type PruneScopeConfig as bn, type QueryAccessLogsRequest as bo, type QueryEventsRequest as bp, type QueryInboundMonitoringEventsRequest as bq, type QueryMonitoringEventsV2Request as br, type QueryOutboundMonitoringEventsRequest as bs, type RedriveOutboundDlqRequest as bt, type RedriveOutboundDlqResponse as bu, type RedriveOutboundDlqResult as bv, type RelationConfig as bw, type RelationItemConfig as bx, type RelationRefItemConfig as by, type RelationRefValueConfig as bz, type AckOutboundMessagesRequest as c, type UnblockOutboundStreamResponse as c0, type UpdateFileProxyUseCaseRequest as c1, type UpdateInboundUseCaseRequest as c2, type UpdateIntegrationRequest as c3, type UpdateManagedCallUseCaseRequest as c4, type UpdateOutboundUseCaseRequest as c5, type UpdateSecureProxyUseCaseRequest as c6, type UpdateUseCaseRequest as c7, type UpdateUseCaseRequestBase as c8, type UpsertDocumentationPageRequest as c9, type UpsertIntegrationWithUseCasesRequest as ca, type UseCase as cb, type UseCaseBase as cc, type UseCaseHistoryEntry as cd, type UseCaseHistoryEntryBase as ce, type UseCaseTypePreview as cf, type ValidateErpImportRequest as cg, type WebhookDeliveryConfig as ch, type WebhookStatus as ci, type AckOutboundMessagesResponse as d, type AckResult as e, type AutoRefreshSettings as f, type CommitTypesRequest as g, type CommitTypesResponse as h, type ConnectorConfig as i, type CreateErpImportRequest as j, type CreateErpImportResponse as k, type CreateFileProxyUseCaseRequest as l, type CreateInboundUseCaseRequest as m, type CreateIntegrationRequest as n, type CreateManagedCallUseCaseRequest as o, type CreateOutboundUseCaseRequest as p, type CreateSecureProxyUseCaseRequest as q, type CreateUseCaseRequest as r, type CreateUseCaseRequestBase as s, type DeliveryConfig as t, type DocumentationPage as u, type DocumentationPageSummary as v, type EmbeddedInboundUseCaseRequest as w, type EmbeddedManagedCallUseCaseRequest as x, type EmbeddedOutboundUseCaseRequest as y, type EmbeddedSecureProxyUseCaseRequest as z };

package/dist/message-BZN67NTB.js

@@ -0,0 +1,7 @@
+import "./chunk-YPSWSI3M.js";
+
+// 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- [`getUnreadCounts`](#getunreadcounts)\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- [`UnreadCountScope`](#unreadcountscope)\n- [`UnreadCountsPayload`](#unreadcountspayload)\n- [`UnreadCountsResult`](#unreadcountsresult)\n- [`UnreadCountBuckets`](#unreadcountbuckets)\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- [`WorkflowStartedEvent`](#workflowstartedevent)\n- [`ThreadUserAssignedEvent`](#threaduserassignedevent)\n- [`MessageLabelAddedEvent`](#messagelabeladdedevent)\n- [`MessageLabelRemovedEvent`](#messagelabelremovedevent)\n- [`MessageEntityLinkedEvent`](#messageentitylinkedevent)\n- [`MessageEntityUnlinkedEvent`](#messageentityunlinkedevent)\n- [`MessageAutoReplySentEvent`](#messageautoreplysentevent)\n- [`ThreadMovedToInboxEvent`](#threadmovedtoinboxevent)\n- [`ThreadTrashedEvent`](#threadtrashedevent)\n- [`ThreadRestoredEvent`](#threadrestoredevent)\n- [`TimelineLinkedEntity`](#timelinelinkedentity)\n- [`TimelineActor`](#timelineactor)\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### `getUnreadCounts`\n\nUnread counts for several named scopes in one request.\n\n`POST /v1/message/unread:counts`\n\n```ts\nconst { data } = await client.getUnreadCounts(\n  null,\n  {\n    actor: \'organization\',\n    email_filter: [\'string\'],\n    scopes: [\n      {\n        name: \'inbox-support\',\n        type: \'organization\',\n        q: \'_tags.keyword:inbox AND !_tags.keyword:trash\',\n        inbox_id: \'3f34ce73-089c-4d45-a5ee-c161234e41c3\'\n      }\n    ]\n  },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n  "enabled": true,\n  "counts": {},\n  "omitted": ["string"]\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      "id": "string",\n      "data": {\n        "type": "THREAD_DONE",\n        "user_id": "123",\n        "organization_id": "456"\n      },\n      "timestamp": "2024-01-01T00:00:00Z",\n      "message_id": "string",\n      "source": "user",\n      "automated": true,\n      "actor": {\n        "user_id": "string",\n        "email": "string"\n      },\n      "automation": {\n        "id": "string",\n        "name": "string"\n      }\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### `UnreadCountScope`\n\n```ts\ntype UnreadCountScope = {\n  name: string\n  type: "organization" | "shared_inbox" | "saved_view"\n  q?: string\n  inbox_id?: string | string[]\n}\n```\n\n### `UnreadCountsPayload`\n\n```ts\ntype UnreadCountsPayload = {\n  actor: "organization" | "user"\n  email_filter?: string[]\n  scopes: Array<{\n    name: string\n    type: "organization" | "shared_inbox" | "saved_view"\n    q?: string\n    inbox_id?: string | string[]\n  }>\n}\n```\n\n### `UnreadCountsResult`\n\n```ts\ntype UnreadCountsResult = {\n  enabled: boolean\n  counts: Record<string, {\n    unread: number\n    drafts?: number\n    unassigned?: number\n    spam?: number\n  }>\n  omitted?: string[]\n}\n```\n\n### `UnreadCountBuckets`\n\n```ts\ntype UnreadCountBuckets = {\n  unread: number\n  drafts?: number\n  unassigned?: number\n  spam?: number\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    id?: string\n    data: {\n      type: { ... }\n      user_id: { ... }\n      organization_id: { ... }\n    } | {\n      type: { ... }\n      user_id: { ... }\n      organization_id: { ... }\n    } | {\n      type: { ... }\n      workflow_id?: { ... }\n      workflow_name?: { ... }\n    } | {\n      type: { ... }\n      added?: { ... }\n      removed?: { ... }\n    } | {\n      type: { ... }\n      label: { ... }\n      label_name?: { ... }\n    } | {\n      type: { ... }\n      label: { ... }\n      label_name?: { ... }\n    } | {\n      type: { ... }\n      entities?: { ... }\n      link_kind?: { ... }\n    } | {\n      type: { ... }\n      entities?: { ... }\n      link_kind?: { ... }\n    } | {\n      type: { ... }\n      reply_message_id?: { ... }\n      parent_message_id?: { ... }\n    } | {\n      type: { ... }\n      target_inbox_id?: { ... }\n      target_inbox_name?: { ... }\n    } | {\n      type: { ... }\n    } | {\n      type: { ... }\n    }\n    timestamp: string\n    message_id?: string\n    source?: "user" | "automation" | "system"\n    automated?: boolean\n    actor?: {\n      user_id?: { ... }\n      email?: { ... }\n    }\n    automation?: {\n      id?: { ... }\n      name?: { ... }\n    }\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### `WorkflowStartedEvent`\n\n```ts\ntype WorkflowStartedEvent = {\n  type: "WORKFLOW_STARTED"\n  workflow_id?: string\n  workflow_name?: string\n}\n```\n\n### `ThreadUserAssignedEvent`\n\n```ts\ntype ThreadUserAssignedEvent = {\n  type: "THREAD_USER_ASSIGNED"\n  added?: string[]\n  removed?: string[]\n}\n```\n\n### `MessageLabelAddedEvent`\n\n```ts\ntype MessageLabelAddedEvent = {\n  type: "MESSAGE_LABEL_ADDED"\n  label: string\n  label_name?: string\n}\n```\n\n### `MessageLabelRemovedEvent`\n\n```ts\ntype MessageLabelRemovedEvent = {\n  type: "MESSAGE_LABEL_REMOVED"\n  label: string\n  label_name?: string\n}\n```\n\n### `MessageEntityLinkedEvent`\n\n```ts\ntype MessageEntityLinkedEvent = {\n  type: "MESSAGE_ENTITY_LINKED"\n  entities?: Array<{\n    entity_id: string\n    schema?: string\n  }>\n  link_kind?: "manual" | "auto"\n}\n```\n\n### `MessageEntityUnlinkedEvent`\n\n```ts\ntype MessageEntityUnlinkedEvent = {\n  type: "MESSAGE_ENTITY_UNLINKED"\n  entities?: Array<{\n    entity_id: string\n    schema?: string\n  }>\n  link_kind?: "manual" | "auto"\n}\n```\n\n### `MessageAutoReplySentEvent`\n\n```ts\ntype MessageAutoReplySentEvent = {\n  type: "MESSAGE_AUTO_REPLY_SENT"\n  reply_message_id?: string\n  parent_message_id?: string\n}\n```\n\n### `ThreadMovedToInboxEvent`\n\n```ts\ntype ThreadMovedToInboxEvent = {\n  type: "THREAD_MOVED_TO_INBOX"\n  target_inbox_id?: string\n  target_inbox_name?: string\n}\n```\n\n### `ThreadTrashedEvent`\n\n```ts\ntype ThreadTrashedEvent = {\n  type: "THREAD_TRASHED"\n}\n```\n\n### `ThreadRestoredEvent`\n\n```ts\ntype ThreadRestoredEvent = {\n  type: "THREAD_RESTORED"\n}\n```\n\n### `TimelineLinkedEntity`\n\n```ts\ntype TimelineLinkedEntity = {\n  entity_id: string\n  schema?: string\n}\n```\n\n### `TimelineActor`\n\n```ts\ntype TimelineActor = {\n  user_id?: string\n  email?: 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  type: "WORKFLOW_STARTED"\n  workflow_id?: string\n  workflow_name?: string\n} | {\n  type: "THREAD_USER_ASSIGNED"\n  added?: string[]\n  removed?: string[]\n} | {\n  type: "MESSAGE_LABEL_ADDED"\n  label: string\n  label_name?: string\n} | {\n  type: "MESSAGE_LABEL_REMOVED"\n  label: string\n  label_name?: string\n} | {\n  type: "MESSAGE_ENTITY_LINKED"\n  entities?: Array<{\n    entity_id: string\n    schema?: string\n  }>\n  link_kind?: "manual" | "auto"\n} | {\n  type: "MESSAGE_ENTITY_UNLINKED"\n  entities?: Array<{\n    entity_id: string\n    schema?: string\n  }>\n  link_kind?: "manual" | "auto"\n} | {\n  type: "MESSAGE_AUTO_REPLY_SENT"\n  reply_message_id?: string\n  parent_message_id?: string\n} | {\n  type: "THREAD_MOVED_TO_INBOX"\n  target_inbox_id?: string\n  target_inbox_name?: string\n} | {\n  type: "THREAD_TRASHED"\n} | {\n  type: "THREAD_RESTORED"\n}\n```\n\n### `TimelineEvent`\n\n```ts\ntype TimelineEvent = {\n  id?: string\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    type: "WORKFLOW_STARTED"\n    workflow_id?: string\n    workflow_name?: string\n  } | {\n    type: "THREAD_USER_ASSIGNED"\n    added?: string[]\n    removed?: string[]\n  } | {\n    type: "MESSAGE_LABEL_ADDED"\n    label: string\n    label_name?: string\n  } | {\n    type: "MESSAGE_LABEL_REMOVED"\n    label: string\n    label_name?: string\n  } | {\n    type: "MESSAGE_ENTITY_LINKED"\n    entities?: Array<{\n      entity_id: { ... }\n      schema?: { ... }\n    }>\n    link_kind?: "manual" | "auto"\n  } | {\n    type: "MESSAGE_ENTITY_UNLINKED"\n    entities?: Array<{\n      entity_id: { ... }\n      schema?: { ... }\n    }>\n    link_kind?: "manual" | "auto"\n  } | {\n    type: "MESSAGE_AUTO_REPLY_SENT"\n    reply_message_id?: string\n    parent_message_id?: string\n  } | {\n    type: "THREAD_MOVED_TO_INBOX"\n    target_inbox_id?: string\n    target_inbox_name?: string\n  } | {\n    type: "THREAD_TRASHED"\n  } | {\n    type: "THREAD_RESTORED"\n  }\n  timestamp: string\n  message_id?: string\n  source?: "user" | "automation" | "system"\n  automated?: boolean\n  actor?: {\n    user_id?: string\n    email?: string\n  }\n  automation?: {\n    id?: string\n    name?: string\n  }\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';
+export {
+  message_default as default
+};