@epilot/message-client
Version:
API Client for epilot Message API
1,472 lines (1,470 loc) • 117 kB
TypeScript
/* eslint-disable */
import type {
OpenAPIClient,
Parameters,
UnknownParamsObject,
OperationResponse,
AxiosRequestConfig,
} from 'openapi-client-axios';
declare namespace Components {
namespace Responses {
export type BadRequest = Schemas.ErrorResponse;
export type Conflict = Schemas.ErrorResponse;
export type Forbidden = Schemas.ErrorResponse;
export type InternalServerError = Schemas.ErrorResponse;
export type NotFound = Schemas.ErrorResponse;
}
namespace Schemas {
export interface Address {
/**
* Email address alias
* example:
* epilot
*/
name?: string;
/**
* Email address
* example:
* messaging@epilot.cloud
*/
address: string;
/**
* Type of the email, Internal (360 Agents), Partners, External users(Customers)
*
*/
email_type?: "INTERNAL" | "EXTERNAL" | "PARTNER";
/**
* Sent message status regarding to this recipient. Reference at <https://docs.aws.amazon.com/ses/latest/DeveloperGuide/monitor-sending-activity.html>
*
*/
send_status?: "SEND" | "DELIVERY" | "REJECT" | "COMPLAINT" | "BOUNCE" | "ERROR";
/**
* Information about reject, complaint or bounce event. Only available if `send_status` is REJECT, COMPLAINT, BOUNCE or ERROR. JSON object is defined by AWS SES. Reference at <https://docs.aws.amazon.com/ses/latest/DeveloperGuide/notification-contents.html>
*
*/
send_error?: {
[key: string]: any;
};
}
/**
* Message attachments
*/
export interface AttachmentsRelation {
/**
* It's normal entity relation with some additional properties for sending message attachment.
*/
$relation?: File[];
}
export interface BaseEntity {
/**
* Entity ID
* example:
* 3fa85f64-5717-4562-b3fc-2c963f66afa6
*/
_id: string;
/**
* Entity title
*/
_title: string;
/**
* Organization ID the entity belongs to
* example:
* 206801
*/
_org: string;
/**
* URL-friendly identifier for the entity schema
* example:
* message
*/
_schema: string;
/**
* Entity tags
* example:
* [
* "pricing",
* "INBOX"
* ]
*/
_tags?: string[];
/**
* Created date
* example:
* 2021-02-09T12:41:43.662Z
*/
_created_at: string; // date-time
/**
* Updated date
* example:
* 2021-02-10T09:14:31.990Z
*/
_updated_at: string; // date-time
}
export interface BulkActionsPayload {
/**
* Array of threads you wish to perform bulk actions on
* example:
* [
* "6b299eda-4018-4554-8965-c4b5598e6531"
* ]
*/
ids: string[];
}
export interface BulkActionsPayloadWithScopes {
/**
* Array of threads you wish to perform bulk actions on
* example:
* [
* "6b299eda-4018-4554-8965-c4b5598e6531"
* ]
*/
ids: string[];
/**
* The scopes to be used when marking an item as read or unread. The read status will be synced for all provided scopes.
* example:
* [
* "organization",
* "user"
* ]
*/
scopes?: /* Who is marking an item as read or unread. */ ReadingScope[];
}
export interface ErrorResponse {
/**
* Error message
* example:
* Thread not found
*/
error?: string;
}
/**
* List of entity fields to include or exclude in the response
*
* Use ! to exclude fields, e.g. `!_id` to exclude the `_id` field.
*
* Globbing and globstart (**) is supported for nested fields.
*
* example:
* [
* "_id",
* "_title",
* "first_name",
* "account",
* "!account.*._files",
* "**._product"
* ]
*/
export type FieldsParam = string[];
export interface File {
/**
* File entity ID
* example:
* f820ce3b-07b0-45ae-bcc6-babb2f53f79f
*/
entity_id: string;
/**
* File name
* example:
* Produktinformationen_epilot360_Double_Opt_in.pdf
*/
filename?: string;
/**
* To indicate this file relation is message attachment. If false then this file will not be sent and simply kept as a file relation.
*/
is_message_attachment?: boolean;
/**
* To indicate this file relation may be signature attachment. If true then this file will be sent as signature attachment and not related to any entity.
*/
may_be_signature_attachment?: boolean;
/**
* Content ID (for inline)
* example:
* fb222496-a1a5-4639-94f2-07b5e35e4068
*/
cid?: string;
/**
* If true then this attachment should not be offered for download (at least not in the main attachments list). The usecase is CID embedded image (aka inline image).
*
*/
inline?: boolean;
/**
* If true then this attachment is sent via link. The link have to be inserted to email body by API caller. In this case, service doesn't process this attachment.
*
*/
send_as_link?: boolean;
}
export interface Message {
/**
* Message ID which is from email provider. If you provide `message-id`, API overrides by its own value.
* example:
* <0102017b97a502f8-a67f01c2-68cc-4928-b91b-45853f34e259-000000@eu-west-1.amazonses.com>
*/
message_id?: string;
/**
* User ID of user sends the message.
* example:
* 206801
*/
sender?: string;
/**
* Subject
* example:
* Request for solar panel price
*/
subject: string;
/**
* HTML body
* example:
* <div>We at ABC GmbH would like to request a price quote for the solar panel.</div>
*/
html?: string;
/**
* Text body
* example:
* We at ABC GmbH would like to request a price quote for the solar panel.
*/
text?: string;
from: Address;
reply_to?: Address;
/**
* To email addresses
*/
to?: Address[];
/**
* Cc email addresses
*/
cc?: Address[];
/**
* Bcc email addresses
*/
bcc?: Address[];
file?: /* Message attachments */ AttachmentsRelation;
/**
* References header. Value is the series of `message_id` which is reparated by space to indicate that message has parent. The last message ID in references identifies the parent. The first message ID in references identifies the first message in the thread. The basic idea is that sender should copy `references` from the parent and append the parent's `message_id` when replying.
*
* example:
* <0102017b97a502f8-a67f01c2-68cc-4928-b91b-45853f34e259-000000@eu-west-1.amazonses.com> <CALHgQpziyxW9NaFUs+nRMykzr6Ljq6vjq4WO9SaihAuMasuDyg@mail.gmail.com>
*/
references?: string;
/**
* In-Reply-To header. Value is the `message_id` of parent message.
*
* example:
* <CALHgQpziyxW9NaFUs+nRMykzr6Ljq6vjq4WO9SaihAuMasuDyg@mail.gmail.com>
*/
in_reply_to?: string;
/**
* User ID of user read the message.
* example:
* [
* "206801",
* "200109"
* ]
*/
user_read_message?: string[];
/**
* Organization ID of organization read the message.
* example:
* [
* "789372",
* "210291"
* ]
*/
org_read_message?: string[];
/**
* Sent message status. The array contains sending message status corresponding to all recipients. For more detail, check `send_status` of each recipient in `to`, `cc`, `bcc` Reference at <https://docs.aws.amazon.com/ses/latest/DeveloperGuide/monitor-sending-activity.html>
*
*/
send_status?: ("SEND" | "DELIVERY" | "REJECT" | "COMPLAINT" | "BOUNCE" | "ERROR")[];
/**
* Message type
*/
type?: "SENT" | "RECEIVED";
/**
* Template ID used for sending message.
* example:
* 3f34ce73-089c-4d45-a5ee-c161234e41c3
*/
template_id?: string;
}
export interface MessageRequestParams {
[name: string]: any;
/**
* Open new thread when sending the very first message in conversation. Thread should contains context related to all messages in it (eg. topic, brand_id, opportunity_id, assigned_to,...). Thread properties depend on API caller as it's not pre-defined. We do recommend having at least `topic` property for categorizing. `thread` or `parent_id` must be provided either.
*
* example:
* {
* "topic": "CUSTOMER_MESSAGE",
* "assigned_to": [
* "206801",
* "200109"
* ],
* "opportunity_id": 829072
* }
*/
thread?: {
/**
* Message topic (e.g. which service sends the message or message category)
*/
topic: string;
/**
* User ID of who the message is assigned to. Default is the user who sends message.
*/
assigned_to?: string[];
};
/**
* Entity ID of parent message which this message replies to or forwards from. If both `parent_id` and `thread` are provided, `thread` is discarded.
*
* example:
* 44d7a3eb-0cce-4bd3-a7cd-0b3e652de0c2
*/
parent_id?: string;
/**
* Subject
* example:
* Request for solar panel price
*/
subject: string;
/**
* HTML body
* example:
* <div>We at ABC GmbH would like to request a price quote for the solar panel.</div>
*/
html?: string;
/**
* Text body. If not provided, text body is converted from HTML body using [html-to-text](https://www.npmjs.com/package/html-to-text)
* example:
* We at ABC GmbH would like to request a price quote for the solar panel.
*/
text?: string;
from: Address;
reply_to?: Address;
/**
* To email addresses
*/
to?: Address[];
/**
* Cc email addresses
*/
cc?: Address[];
/**
* Bcc email addresses
*/
bcc?: Address[];
file?: /* Message attachments */ AttachmentsRelation;
/**
* Template ID used for sending message.
* example:
* 3f34ce73-089c-4d45-a5ee-c161234e41c3
*/
template_id?: string;
}
export interface MessageV2 {
/**
* Entity ID
* example:
* 3fa85f64-5717-4562-b3fc-2c963f66afa6
*/
_id: string;
/**
* Entity title
*/
_title: string;
/**
* Organization ID the entity belongs to
* example:
* 206801
*/
_org: string;
/**
* URL-friendly identifier for the entity schema
* example:
* message
*/
_schema: string;
/**
* Entity tags
* example:
* [
* "pricing",
* "INBOX"
* ]
*/
_tags?: string[];
/**
* Created date
* example:
* 2021-02-09T12:41:43.662Z
*/
_created_at: string; // date-time
/**
* Updated date
* example:
* 2021-02-10T09:14:31.990Z
*/
_updated_at: string; // date-time
/**
* Message ID which is from email provider. If you provide `message-id`, API overrides by its own value.
* example:
* <0102017b97a502f8-a67f01c2-68cc-4928-b91b-45853f34e259-000000@eu-west-1.amazonses.com>
*/
message_id?: string;
/**
* User ID of user sends the message.
* example:
* 206801
*/
sender?: string;
/**
* Subject
* example:
* Request for solar panel price
*/
subject: string;
/**
* HTML body
* example:
* <div>We at ABC GmbH would like to request a price quote for the solar panel.</div>
*/
html?: string;
/**
* Text body
* example:
* We at ABC GmbH would like to request a price quote for the solar panel.
*/
text?: string;
from: Address;
reply_to?: Address;
/**
* To email addresses
*/
to?: Address[];
/**
* Cc email addresses
*/
cc?: Address[];
/**
* Bcc email addresses
*/
bcc?: Address[];
file?: /* Message attachments */ AttachmentsRelation;
/**
* References header. Value is the series of `message_id` which is reparated by space to indicate that message has parent. The last message ID in references identifies the parent. The first message ID in references identifies the first message in the thread. The basic idea is that sender should copy `references` from the parent and append the parent's `message_id` when replying.
*
* example:
* <0102017b97a502f8-a67f01c2-68cc-4928-b91b-45853f34e259-000000@eu-west-1.amazonses.com> <CALHgQpziyxW9NaFUs+nRMykzr6Ljq6vjq4WO9SaihAuMasuDyg@mail.gmail.com>
*/
references?: string;
/**
* In-Reply-To header. Value is the `message_id` of parent message.
*
* example:
* <CALHgQpziyxW9NaFUs+nRMykzr6Ljq6vjq4WO9SaihAuMasuDyg@mail.gmail.com>
*/
in_reply_to?: string;
/**
* User ID of user read the message.
* example:
* [
* "206801",
* "200109"
* ]
*/
user_read_message?: string[];
/**
* Organization ID of organization read the message.
* example:
* [
* "789372",
* "210291"
* ]
*/
org_read_message?: string[];
/**
* Sent message status. The array contains sending message status corresponding to all recipients. For more detail, check `send_status` of each recipient in `to`, `cc`, `bcc` Reference at <https://docs.aws.amazon.com/ses/latest/DeveloperGuide/monitor-sending-activity.html>
*
*/
send_status?: ("SEND" | "DELIVERY" | "REJECT" | "COMPLAINT" | "BOUNCE" | "ERROR")[];
/**
* Message type
*/
type?: "SENT" | "RECEIVED";
/**
* Template ID used for sending message.
* example:
* 3f34ce73-089c-4d45-a5ee-c161234e41c3
*/
template_id?: string;
/**
* If true then html is not provided and must be downloaded using the html_download_url
*/
html_omitted?: boolean;
/**
* HTML body download URL
* example:
* https://s3.eu-central-1.amazonaws.com/epilot-attachments/3f34ce73-089c-4d45-a5ee-c161234e41c3/3f34ce73-089c-4d45-a5ee-c161234e41c3.html
*/
html_download_url?: string;
}
export interface MoveThreadPayload {
/**
* Inbox ID
* example:
* 3f34ce73-089c-4d45-a5ee-c161234e41c3
*/
inbox_id: string;
}
export interface ReadMessagePayload {
/**
* The scopes to be used when marking an item as read or unread. The read status will be synced for all provided scopes.
* example:
* [
* "organization",
* "user"
* ]
*/
scopes: /* Who is marking an item as read or unread. */ ReadingScope[];
}
/**
* Who is marking an item as read or unread.
*/
export type ReadingScope = "organization" | "user";
export interface SearchIDParams {
/**
* Lucene query syntax supported with ElasticSearch
* example:
* subject:"Request for solar panel price" AND _tags:INBOX
*/
q?: string;
}
export interface SearchParams {
/**
* Lucene query syntax supported with ElasticSearch
* example:
* subject:"Request for solar panel price" AND _tags:INBOX
*/
q: string;
from?: number;
size?: number;
hydrate?: boolean;
}
export interface SearchParamsV2 {
inbox_id?: string | string[];
/**
* Lucene query syntax supported with ElasticSearch
* example:
* subject:"Request for solar panel price" AND _tags:INBOX
*/
q: string;
fields?: /**
* List of entity fields to include or exclude in the response
*
* Use ! to exclude fields, e.g. `!_id` to exclude the `_id` field.
*
* Globbing and globstart (**) is supported for nested fields.
*
* example:
* [
* "_id",
* "_title",
* "first_name",
* "account",
* "!account.*._files",
* "**._product"
* ]
*/
FieldsParam;
from?: number;
size?: number;
hydrate?: boolean;
include_scores?: boolean;
sort?: string;
highlight?: any;
}
/**
* Thread properties depend on API caller as it's not pre-defined. We do recommend having at least `topic` property for categorizing.
*/
export interface Thread {
/**
* Message topic (e.g. which service sends the message or message category)
* example:
* CUSTOMER_MESSAGE
*/
topic: string;
/**
* User ID of who the message is assigned to. Default is the user who sends message.
* example:
* [
* "206801",
* "200109"
* ]
*/
assigned_to?: string[];
/**
* Organization ID of organization read the message.
* example:
* [
* "789372",
* "210291"
* ]
*/
org_read_message?: string[];
/**
* Whether the thread is marked as Done
* example:
* false
*/
done?: boolean;
latest_message?: Message;
latest_trash_message?: Message;
/**
* The date of the latest message time in the thread
* example:
* 2024-02-10T09:14:31.990Z
*/
latest_message_at?: string;
}
export interface ThreadDoneEvent {
type: "THREAD_DONE";
/**
* User ID of the user who marked the thread as done
* example:
* 123
*/
user_id: string;
/**
* Organization ID of the organization who marked the thread as done
* example:
* 456
*/
organization_id: string;
}
export interface ThreadOpenEvent {
type: "THREAD_OPEN";
/**
* User ID of the user who marked the thread as open
* example:
* 123
*/
user_id: string;
/**
* Organization ID of the organization who marked the thread as open
* example:
* 456
*/
organization_id: string;
}
export interface ThreadTimeline {
events: TimelineEvent[];
}
export interface TimelineEvent {
data: TimelineEventData;
/**
* Timestamp of the event
* example:
* 2024-01-01T00:00:00.000Z
*/
timestamp: string;
}
export type TimelineEventData = ThreadDoneEvent | ThreadOpenEvent;
}
}
declare namespace Paths {
namespace AssignThread {
namespace Parameters {
export type Id = string;
}
export interface PathParameters {
id: Parameters.Id;
}
/**
* Entities which thread is assigned to
*/
export type RequestBody = {
/**
* Entity slug
* example:
* contact
*/
slug?: string;
/**
* Entity ID
* example:
* 3f34ce73-089c-4d45-a5ee-c161234e41c3
*/
entity_id?: string;
/**
* Organization ID
* example:
* 206801
*/
org_id?: string;
/**
* To indicate this is main entity
* example:
* true
*/
is_main_entity?: boolean;
}[];
namespace Responses {
export interface $204 {
}
export interface $403 {
}
}
}
namespace AssignUsers {
namespace Parameters {
export type Id = string;
}
export interface PathParameters {
id: Parameters.Id;
}
/**
* User IDs of users assigned to thread
*/
export interface RequestBody {
/**
* IDs of users assigned to thread
*/
assigned_to?: string[];
}
namespace Responses {
export interface $204 {
}
export interface $403 {
}
}
}
namespace CreateDraft {
export type RequestBody = Components.Schemas.MessageRequestParams;
namespace Responses {
export interface $201 {
/**
* Entity ID
* example:
* 3fa85f64-5717-4562-b3fc-2c963f66afa6
*/
_id: string;
/**
* Entity title
*/
_title: string;
/**
* Organization ID the entity belongs to
* example:
* 206801
*/
_org: string;
/**
* URL-friendly identifier for the entity schema
* example:
* message
*/
_schema: string;
/**
* Entity tags
* example:
* [
* "pricing",
* "INBOX"
* ]
*/
_tags?: string[];
/**
* Created date
* example:
* 2021-02-09T12:41:43.662Z
*/
_created_at: string; // date-time
/**
* Updated date
* example:
* 2021-02-10T09:14:31.990Z
*/
_updated_at: string; // date-time
/**
* Message ID which is from email provider. If you provide `message-id`, API overrides by its own value.
* example:
* <0102017b97a502f8-a67f01c2-68cc-4928-b91b-45853f34e259-000000@eu-west-1.amazonses.com>
*/
message_id?: string;
/**
* User ID of user sends the message.
* example:
* 206801
*/
sender?: string;
/**
* Subject
* example:
* Request for solar panel price
*/
subject: string;
/**
* HTML body
* example:
* <div>We at ABC GmbH would like to request a price quote for the solar panel.</div>
*/
html?: string;
/**
* Text body
* example:
* We at ABC GmbH would like to request a price quote for the solar panel.
*/
text?: string;
from: Components.Schemas.Address;
reply_to?: Components.Schemas.Address;
/**
* To email addresses
*/
to?: Components.Schemas.Address[];
/**
* Cc email addresses
*/
cc?: Components.Schemas.Address[];
/**
* Bcc email addresses
*/
bcc?: Components.Schemas.Address[];
file?: /* Message attachments */ Components.Schemas.AttachmentsRelation;
/**
* References header. Value is the series of `message_id` which is reparated by space to indicate that message has parent. The last message ID in references identifies the parent. The first message ID in references identifies the first message in the thread. The basic idea is that sender should copy `references` from the parent and append the parent's `message_id` when replying.
*
* example:
* <0102017b97a502f8-a67f01c2-68cc-4928-b91b-45853f34e259-000000@eu-west-1.amazonses.com> <CALHgQpziyxW9NaFUs+nRMykzr6Ljq6vjq4WO9SaihAuMasuDyg@mail.gmail.com>
*/
references?: string;
/**
* In-Reply-To header. Value is the `message_id` of parent message.
*
* example:
* <CALHgQpziyxW9NaFUs+nRMykzr6Ljq6vjq4WO9SaihAuMasuDyg@mail.gmail.com>
*/
in_reply_to?: string;
/**
* User ID of user read the message.
* example:
* [
* "206801",
* "200109"
* ]
*/
user_read_message?: string[];
/**
* Organization ID of organization read the message.
* example:
* [
* "789372",
* "210291"
* ]
*/
org_read_message?: string[];
/**
* Sent message status. The array contains sending message status corresponding to all recipients. For more detail, check `send_status` of each recipient in `to`, `cc`, `bcc` Reference at <https://docs.aws.amazon.com/ses/latest/DeveloperGuide/monitor-sending-activity.html>
*
*/
send_status?: ("SEND" | "DELIVERY" | "REJECT" | "COMPLAINT" | "BOUNCE" | "ERROR")[];
/**
* Message type
*/
type?: "SENT" | "RECEIVED";
/**
* Template ID used for sending message.
* example:
* 3f34ce73-089c-4d45-a5ee-c161234e41c3
*/
template_id?: string;
}
export interface $403 {
}
}
}
namespace DeleteMessage {
namespace Parameters {
export type Id = string;
}
export interface PathParameters {
id: Parameters.Id;
}
namespace Responses {
export interface $204 {
}
export interface $403 {
}
}
}
namespace DeleteThread {
namespace Parameters {
export type Id = string;
}
export interface PathParameters {
id: Parameters.Id;
}
namespace Responses {
export interface $204 {
}
export interface $403 {
}
}
}
namespace GetMessage {
namespace Parameters {
/**
* example:
* 4d74976d-fb64-47fd-85e2-65eea140f5eb
*/
export type Id = string;
}
export interface PathParameters {
id: /**
* example:
* 4d74976d-fb64-47fd-85e2-65eea140f5eb
*/
Parameters.Id;
}
namespace Responses {
export interface $200 {
/**
* Entity ID
* example:
* 3fa85f64-5717-4562-b3fc-2c963f66afa6
*/
_id: string;
/**
* Entity title
*/
_title: string;
/**
* Organization ID the entity belongs to
* example:
* 206801
*/
_org: string;
/**
* URL-friendly identifier for the entity schema
* example:
* message
*/
_schema: string;
/**
* Entity tags
* example:
* [
* "pricing",
* "INBOX"
* ]
*/
_tags?: string[];
/**
* Created date
* example:
* 2021-02-09T12:41:43.662Z
*/
_created_at: string; // date-time
/**
* Updated date
* example:
* 2021-02-10T09:14:31.990Z
*/
_updated_at: string; // date-time
/**
* Message ID which is from email provider. If you provide `message-id`, API overrides by its own value.
* example:
* <0102017b97a502f8-a67f01c2-68cc-4928-b91b-45853f34e259-000000@eu-west-1.amazonses.com>
*/
message_id?: string;
/**
* User ID of user sends the message.
* example:
* 206801
*/
sender?: string;
/**
* Subject
* example:
* Request for solar panel price
*/
subject: string;
/**
* HTML body
* example:
* <div>We at ABC GmbH would like to request a price quote for the solar panel.</div>
*/
html?: string;
/**
* Text body
* example:
* We at ABC GmbH would like to request a price quote for the solar panel.
*/
text?: string;
from: Components.Schemas.Address;
reply_to?: Components.Schemas.Address;
/**
* To email addresses
*/
to?: Components.Schemas.Address[];
/**
* Cc email addresses
*/
cc?: Components.Schemas.Address[];
/**
* Bcc email addresses
*/
bcc?: Components.Schemas.Address[];
file?: /* Message attachments */ Components.Schemas.AttachmentsRelation;
/**
* References header. Value is the series of `message_id` which is reparated by space to indicate that message has parent. The last message ID in references identifies the parent. The first message ID in references identifies the first message in the thread. The basic idea is that sender should copy `references` from the parent and append the parent's `message_id` when replying.
*
* example:
* <0102017b97a502f8-a67f01c2-68cc-4928-b91b-45853f34e259-000000@eu-west-1.amazonses.com> <CALHgQpziyxW9NaFUs+nRMykzr6Ljq6vjq4WO9SaihAuMasuDyg@mail.gmail.com>
*/
references?: string;
/**
* In-Reply-To header. Value is the `message_id` of parent message.
*
* example:
* <CALHgQpziyxW9NaFUs+nRMykzr6Ljq6vjq4WO9SaihAuMasuDyg@mail.gmail.com>
*/
in_reply_to?: string;
/**
* User ID of user read the message.
* example:
* [
* "206801",
* "200109"
* ]
*/
user_read_message?: string[];
/**
* Organization ID of organization read the message.
* example:
* [
* "789372",
* "210291"
* ]
*/
org_read_message?: string[];
/**
* Sent message status. The array contains sending message status corresponding to all recipients. For more detail, check `send_status` of each recipient in `to`, `cc`, `bcc` Reference at <https://docs.aws.amazon.com/ses/latest/DeveloperGuide/monitor-sending-activity.html>
*
*/
send_status?: ("SEND" | "DELIVERY" | "REJECT" | "COMPLAINT" | "BOUNCE" | "ERROR")[];
/**
* Message type
*/
type?: "SENT" | "RECEIVED";
/**
* Template ID used for sending message.
* example:
* 3f34ce73-089c-4d45-a5ee-c161234e41c3
*/
template_id?: string;
}
export interface $302 {
}
export interface $403 {
}
}
}
namespace GetMessageV2 {
namespace Parameters {
/**
* example:
* 4d74976d-fb64-47fd-85e2-65eea140f5eb
*/
export type Id = string;
}
export interface PathParameters {
id: /**
* example:
* 4d74976d-fb64-47fd-85e2-65eea140f5eb
*/
Parameters.Id;
}
namespace Responses {
export interface $200 {
/**
* Entity ID
* example:
* 3fa85f64-5717-4562-b3fc-2c963f66afa6
*/
_id: string;
/**
* Entity title
*/
_title: string;
/**
* Organization ID the entity belongs to
* example:
* 206801
*/
_org: string;
/**
* URL-friendly identifier for the entity schema
* example:
* message
*/
_schema: string;
/**
* Entity tags
* example:
* [
* "pricing",
* "INBOX"
* ]
*/
_tags?: string[];
/**
* Created date
* example:
* 2021-02-09T12:41:43.662Z
*/
_created_at: string; // date-time
/**
* Updated date
* example:
* 2021-02-10T09:14:31.990Z
*/
_updated_at: string; // date-time
/**
* Message ID which is from email provider. If you provide `message-id`, API overrides by its own value.
* example:
* <0102017b97a502f8-a67f01c2-68cc-4928-b91b-45853f34e259-000000@eu-west-1.amazonses.com>
*/
message_id?: string;
/**
* User ID of user sends the message.
* example:
* 206801
*/
sender?: string;
/**
* Subject
* example:
* Request for solar panel price
*/
subject: string;
/**
* HTML body
* example:
* <div>We at ABC GmbH would like to request a price quote for the solar panel.</div>
*/
html?: string;
/**
* Text body
* example:
* We at ABC GmbH would like to request a price quote for the solar panel.
*/
text?: string;
from: Components.Schemas.Address;
reply_to?: Components.Schemas.Address;
/**
* To email addresses
*/
to?: Components.Schemas.Address[];
/**
* Cc email addresses
*/
cc?: Components.Schemas.Address[];
/**
* Bcc email addresses
*/
bcc?: Components.Schemas.Address[];
file?: /* Message attachments */ Components.Schemas.AttachmentsRelation;
/**
* References header. Value is the series of `message_id` which is reparated by space to indicate that message has parent. The last message ID in references identifies the parent. The first message ID in references identifies the first message in the thread. The basic idea is that sender should copy `references` from the parent and append the parent's `message_id` when replying.
*
* example:
* <0102017b97a502f8-a67f01c2-68cc-4928-b91b-45853f34e259-000000@eu-west-1.amazonses.com> <CALHgQpziyxW9NaFUs+nRMykzr6Ljq6vjq4WO9SaihAuMasuDyg@mail.gmail.com>
*/
references?: string;
/**
* In-Reply-To header. Value is the `message_id` of parent message.
*
* example:
* <CALHgQpziyxW9NaFUs+nRMykzr6Ljq6vjq4WO9SaihAuMasuDyg@mail.gmail.com>
*/
in_reply_to?: string;
/**
* User ID of user read the message.
* example:
* [
* "206801",
* "200109"
* ]
*/
user_read_message?: string[];
/**
* Organization ID of organization read the message.
* example:
* [
* "789372",
* "210291"
* ]
*/
org_read_message?: string[];
/**
* Sent message status. The array contains sending message status corresponding to all recipients. For more detail, check `send_status` of each recipient in `to`, `cc`, `bcc` Reference at <https://docs.aws.amazon.com/ses/latest/DeveloperGuide/monitor-sending-activity.html>
*
*/
send_status?: ("SEND" | "DELIVERY" | "REJECT" | "COMPLAINT" | "BOUNCE" | "ERROR")[];
/**
* Message type
*/
type?: "SENT" | "RECEIVED";
/**
* Template ID used for sending message.
* example:
* 3f34ce73-089c-4d45-a5ee-c161234e41c3
*/
template_id?: string;
/**
* If true then html is not provided and must be downloaded using the html_download_url
*/
html_omitted?: boolean;
/**
* HTML body download URL
* example:
* https://s3.eu-central-1.amazonaws.com/epilot-attachments/3f34ce73-089c-4d45-a5ee-c161234e41c3/3f34ce73-089c-4d45-a5ee-c161234e41c3.html
*/
html_download_url?: string;
}
export interface $403 {
}
}
}
namespace GetThreadTimeline {
namespace Parameters {
export type Id = string;
}
export interface PathParameters {
id: Parameters.Id;
}
namespace Responses {
export type $200 = Components.Schemas.ThreadTimeline;
export interface $403 {
}
}
}
namespace GetUnread {
namespace Parameters {
export type Actor = "organization" | "user";
export type EmailFilter = string[] | string;
}
export interface PathParameters {
actor: Parameters.Actor;
}
export interface QueryParameters {
email_filter?: Parameters.EmailFilter;
}
namespace Responses {
export interface $200 {
/**
* Total of unread messages
* example:
* 14
*/
count: number;
/**
* Total of unread messages
* example:
* 0
*/
unread?: number;
/**
* Total of drafts messages
* example:
* 12
*/
drafts?: number;
/**
* Total of unassigned messages
* example:
* 1
*/
unassigned?: number;
}
export interface $403 {
}
}
}
namespace MarkReadMessage {
namespace Parameters {
export type Id = string;
}
export interface PathParameters {
id: Parameters.Id;
}
namespace Responses {
export interface $204 {
}
export interface $403 {
}
}
}
namespace MarkReadMessageV2 {
namespace Parameters {
export type Id = string;
}
export interface PathParameters {
id: Parameters.Id;
}
export type RequestBody = Components.Schemas.ReadMessagePayload;
namespace Responses {
export interface $204 {
}
export interface $403 {
}
}
}
namespace MarkReadThread {
namespace Parameters {
export type Id = string;
}
export interface PathParameters {
id: Parameters.Id;
}
namespace Responses {
export interface $200 {
}
export interface $403 {
}
}
}
namespace MarkReadThreadV2 {
namespace Parameters {
export type Id = string;
}
export interface PathParameters {
id: Parameters.Id;
}
export type RequestBody = Components.Schemas.ReadMessagePayload;
namespace Responses {
export interface $200 {
}
export interface $403 {
}
}
}
namespace MarkThreadAsDone {
namespace Parameters {
export type Id = string;
}
export interface PathParameters {
id: Parameters.Id;
}
namespace Responses {
export interface $204 {
}
export interface $400 {
}
}
}
namespace MarkThreadAsOpen {
namespace Parameters {
export type Id = string;
}
export interface PathParameters {
id: Parameters.Id;
}
namespace Responses {
export interface $204 {
}
export interface $400 {
}
}
}
namespace MarkUnreadMessage {
namespace Parameters {
export type Id = string;
}
export interface PathParameters {
id: Parameters.Id;
}
namespace Responses {
export interface $204 {
}
export interface $403 {
}
}
}
namespace MarkUnreadMessageV2 {
namespace Parameters {
export type Id = string;
}
export interface PathParameters {
id: Parameters.Id;
}
export type RequestBody = Components.Schemas.ReadMessagePayload;
namespace Responses {
export interface $204 {
}
export interface $403 {
}
}
}
namespace MarkUnreadThread {
namespace Parameters {
export type Id = string;
}
export interface PathParameters {
id: Parameters.Id;
}
namespace Responses {
export interface $200 {
}
export interface $403 {
}
}
}
namespace MarkUnreadThreadV2 {
namespace Parameters {
export type Id = string;
}
export interface PathParameters {
id: Parameters.Id;
}
export type RequestBody = Components.Schemas.ReadMessagePayload;
namespace Responses {
export interface $200 {
}
export interface $403 {
}
}
}
namespace MoveThread {
namespace Parameters {
export type Id = string;
}
export interface PathParameters {
id: Parameters.Id;
}
export type RequestBody = Components.Schemas.MoveThreadPayload;
namespace Responses {
export interface $204 {
}
export type $400 = Components.Responses.BadRequest;
export type $403 = Components.Responses.Forbidden;
export type $404 = Components.Responses.NotFound;
export type $409 = Components.Responses.Conflict;
export type $500 = Components.Responses.InternalServerError;
}
}
namespace PinThread {
namespace Parameters {
export type Id = string;
}
export interface PathParameters {
id: Parameters.Id;
}
namespace Responses {
export interface $204 {
}
export interface $400 {
}
export interface $404 {
}
export interface $409 {
}
export i