@epilot/message-client 0.0.1

package/dist/openapi.d.ts

@@ -0,0 +1,791 @@
+/* eslint-disable */
+import {
+  OpenAPIClient,
+  Parameters,
+  UnknownParamsObject,
+  OperationResponse,
+  AxiosRequestConfig,
+} from 'openapi-client-axios'; 
+
+declare namespace Components {
+  namespace Schemas {
+    export interface Address {
+      /**
+       * Email address alias
+       * example:
+       * epilot
+       */
+      name?: string;
+      /**
+       * Email address
+       * example:
+       * messaging@epilot.cloud
+       */
+      address: string;
+    }
+    export interface Attachment {
+      /**
+       * Attachment ID
+       * example:
+       * f820ce3b-07b0-45ae-bcc6-babb2f53f79f
+       */
+      cid?: string;
+      /**
+       * File name
+       * example:
+       * Produktinformationen_epilot360_Double_Opt_in.pdf
+       */
+      filename: string;
+      /**
+       * File size in bytes
+       * example:
+       * 451349
+       */
+      size: number;
+      /**
+       * Content type
+       * example:
+       * application/pdf
+       */
+      content_type: string;
+      /**
+       * URL to download the attachment.
+       * example:
+       * https://go.epilot.cloud/attachments/3e7c616a-3e89-4f92-b4c5-ea5ab140e3dd/Produktinformationen_epilot360_Double_Opt_in.pdf
+       */
+      url: string;
+      /**
+       * S3 bucket where file is stored
+       * example:
+       * 893487340562-message-attachment
+       */
+      bucket: string;
+      /**
+       * S3 object apiKey
+       * example:
+       * attachments/3e7c616a-3e89-4f92-b4c5-ea5ab140e3dd/Produktinformationen_epilot360_Double_Opt_in.pdf
+       */
+      object_key: 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 is already inserted to email body by API caller. In this case, service doesn't process this attachment.
+       */
+      send_as_link?: boolean;
+      /**
+       * If true then this attachment is copied to the message and replaces corresponding one. The new attachment has different `cid`, `url`, `object_key`. This property supports for forwarding message.\
+       * If both `send_as_link` and `copy_to_message` are provided, `copy_to_message` is discarded.
+       * 
+       */
+      copy_to_message?: boolean;
+    }
+    export interface AttachmentUploadUrl {
+      /**
+       * URL to download the attachment. This URL is not accessible until attachment is uploaded successfully.
+       * example:
+       * https://go.epilot.cloud/attachments/3e7c616a-3e89-4f92-b4c5-ea5ab140e3dd/Produktinformationen_epilot360_Double_Opt_in.pdf
+       */
+      download_url: string;
+      upload_url: {
+        /**
+         * URL to upload the attachment
+         * example:
+         * https://s3.eu-central-1.amazonaws.com/893487340562-message-attachment
+         */
+        url: number;
+        /**
+         * Fields are provided by AWS to authenticate and validate the request. All fields should be included in form-data when performing upload request.
+         * example:
+         * {}
+         */
+        fields: {
+        };
+      };
+    }
+    export interface BaseEntity {
+      /**
+       * Entity ID
+       * example:
+       * 3fa85f64-5717-4562-b3fc-2c963f66afa6
+       */
+      _id: string;
+      /**
+       * Entity title
+       */
+      _title: string;
+      /**
+       * Ivy 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 CreateAttachmentUploadUrlParams {
+      /**
+       * File name
+       * example:
+       * Produktinformationen_epilot360_Double_Opt_in.pdf
+       */
+      filename: string;
+      /**
+       * Content type
+       * example:
+       * application/pdf
+       */
+      content_type: string;
+    }
+    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;
+      /**
+       * Ivy 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[];
+      /**
+       * Message attachments
+       */
+      attachments?: Attachment[];
+      /**
+       * 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;
+      /**
+       * Ivy User ID of user read the message.
+       */
+      user_read_message?: string[];
+      /**
+       * Message status. Only apply for sent message.
+       * Reference at <https://docs.aws.amazon.com/ses/latest/DeveloperGuide/monitor-sending-activity.html>
+       * 
+       */
+      status?: "SEND" | "REJECT" | "BOUNCE" | "COMPLAINT" | "DELIVERY" | "null";
+      /**
+       * Message type
+       */
+      type?: "SENT" | "RECEIVED";
+    }
+    export interface MessageRequestParams {
+      /**
+       * 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;
+        /**
+         * Ivy 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
+       * 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[];
+      /**
+       * Message attachments
+       */
+      attachments?: Attachment[];
+    }
+    export interface SearchParams {
+      /**
+       * Lucene queries supported with ElasticSearch
+       * example:
+       * subject:"Request for solar panel price" AND _tags:INBOX
+       */
+      q: string;
+      from?: number;
+      size?: number;
+    }
+    /**
+     * 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;
+      /**
+       * Ivy User ID of who the message is assigned to. Default is the user who sends message.
+       */
+      assigned_to?: string[];
+      /**
+       * Latest message of thread
+       */
+      latest_message?: Message;
+      /**
+       * Latest trash message of thread
+       */
+      latest_trash_message?: Message;
+    }
+  }
+}
+declare namespace Paths {
+  namespace CreateAttachmentUploadUrl {
+    export type RequestBody = Components.Schemas.CreateAttachmentUploadUrlParams;
+    namespace Responses {
+      export type $200 = Components.Schemas.AttachmentUploadUrl;
+    }
+  }
+  namespace DeleteMessage {
+    namespace Parameters {
+      export type Id = string;
+    }
+    export interface PathParameters {
+      id: Parameters.Id;
+    }
+  }
+  namespace DeleteThread {
+    namespace Parameters {
+      export type Id = string;
+    }
+    export interface PathParameters {
+      id: Parameters.Id;
+    }
+  }
+  namespace SearchThreads {
+    export type RequestBody = Components.Schemas.SearchParams;
+    namespace Responses {
+      export interface $200 {
+        /**
+         * Total of matched threads
+         * example:
+         * 14
+         */
+        hits: number;
+        /**
+         * Matched threads
+         */
+        results: {
+          /**
+           * Entity ID
+           * example:
+           * 3fa85f64-5717-4562-b3fc-2c963f66afa6
+           */
+          _id: string;
+          /**
+           * Entity title
+           */
+          _title: string;
+          /**
+           * Ivy 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 topic (e.g. which service sends the message or message category)
+           * example:
+           * CUSTOMER_MESSAGE
+           */
+          topic: string;
+          /**
+           * Ivy User ID of who the message is assigned to. Default is the user who sends message.
+           */
+          assigned_to?: string[];
+          /**
+           * Latest message of thread
+           */
+          latest_message?: Components.Schemas.Message;
+          /**
+           * Latest trash message of thread
+           */
+          latest_trash_message?: Components.Schemas.Message;
+        }[];
+      }
+    }
+  }
+  namespace SendMessage {
+    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;
+        /**
+         * Ivy 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;
+        /**
+         * Ivy 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[];
+        /**
+         * Message attachments
+         */
+        attachments?: Components.Schemas.Attachment[];
+        /**
+         * 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;
+        /**
+         * Ivy User ID of user read the message.
+         */
+        user_read_message?: string[];
+        /**
+         * Message status. Only apply for sent message.
+         * Reference at <https://docs.aws.amazon.com/ses/latest/DeveloperGuide/monitor-sending-activity.html>
+         * 
+         */
+        status?: "SEND" | "REJECT" | "BOUNCE" | "COMPLAINT" | "DELIVERY" | "null";
+        /**
+         * Message type
+         */
+        type?: "SENT" | "RECEIVED";
+      }
+    }
+  }
+  namespace TrashMessage {
+    namespace Parameters {
+      export type Id = string;
+    }
+    export interface PathParameters {
+      id: Parameters.Id;
+    }
+  }
+  namespace UntrashMessage {
+    namespace Parameters {
+      export type Id = string;
+    }
+    export interface PathParameters {
+      id: Parameters.Id;
+    }
+  }
+  namespace UpdateThread {
+    export type RequestBody = Components.Schemas.Thread;
+  }
+}
+
+export interface OperationMethods {
+  /**
+   * sendMessage - sendMessage
+   * 
+   * Send the specified message to the recipients.
+   */
+  'sendMessage'(
+    parameters?: Parameters<UnknownParamsObject> | null,
+    data?: Paths.SendMessage.RequestBody,
+    config?: AxiosRequestConfig  
+  ): OperationResponse<Paths.SendMessage.Responses.$201>
+  /**
+   * deleteMessage - deleteMessage
+   * 
+   * Immediately and permanently deletes the specified message. This operation cannot be undone.
+   */
+  'deleteMessage'(
+    parameters?: Parameters<Paths.DeleteMessage.PathParameters> | null,
+    data?: any,
+    config?: AxiosRequestConfig  
+  ): OperationResponse<any>
+  /**
+   * trashMessage - trashMessage
+   * 
+   * Moves the specified message to the trash.
+   */
+  'trashMessage'(
+    parameters?: Parameters<Paths.TrashMessage.PathParameters> | null,
+    data?: any,
+    config?: AxiosRequestConfig  
+  ): OperationResponse<any>
+  /**
+   * untrashMessage - untrashMessage
+   * 
+   * Removes the specified message from the trash.
+   */
+  'untrashMessage'(
+    parameters?: Parameters<Paths.UntrashMessage.PathParameters> | null,
+    data?: any,
+    config?: AxiosRequestConfig  
+  ): OperationResponse<any>
+  /**
+   * searchThreads - searchThreads
+   * 
+   * Search for message entity and return threads which contain matched message. If message doesn't have any reply yet, evaluate it as a thread with single message.\
+   * Supports pagination. Lucene query syntax supported for complex querying.
+   * 
+   */
+  'searchThreads'(
+    parameters?: Parameters<UnknownParamsObject> | null,
+    data?: Paths.SearchThreads.RequestBody,
+    config?: AxiosRequestConfig  
+  ): OperationResponse<Paths.SearchThreads.Responses.$200>
+  /**
+   * updateThread - updateThread
+   * 
+   * Modify the thread.
+   */
+  'updateThread'(
+    parameters?: Parameters<UnknownParamsObject> | null,
+    data?: Paths.UpdateThread.RequestBody,
+    config?: AxiosRequestConfig  
+  ): OperationResponse<any>
+  /**
+   * deleteThread - deleteThread
+   * 
+   * Immediately and permanently deletes the specified thread. This operation cannot be undone.
+   */
+  'deleteThread'(
+    parameters?: Parameters<Paths.DeleteThread.PathParameters> | null,
+    data?: any,
+    config?: AxiosRequestConfig  
+  ): OperationResponse<any>
+  /**
+   * createAttachmentUploadUrl - createAttachmentUploadUrl
+   * 
+   * Create S3 POST presigned URL to upload attachment. The URL is valid in 30 minutes. Maximum file size is 100MB.
+   */
+  'createAttachmentUploadUrl'(
+    parameters?: Parameters<UnknownParamsObject> | null,
+    data?: Paths.CreateAttachmentUploadUrl.RequestBody,
+    config?: AxiosRequestConfig  
+  ): OperationResponse<Paths.CreateAttachmentUploadUrl.Responses.$200>
+}
+
+export interface PathsDictionary {
+  ['/messages']: {
+    /**
+     * sendMessage - sendMessage
+     * 
+     * Send the specified message to the recipients.
+     */
+    'post'(
+      parameters?: Parameters<UnknownParamsObject> | null,
+      data?: Paths.SendMessage.RequestBody,
+      config?: AxiosRequestConfig  
+    ): OperationResponse<Paths.SendMessage.Responses.$201>
+  }
+  ['/messages/{id}']: {
+    /**
+     * deleteMessage - deleteMessage
+     * 
+     * Immediately and permanently deletes the specified message. This operation cannot be undone.
+     */
+    'delete'(
+      parameters?: Parameters<Paths.DeleteMessage.PathParameters> | null,
+      data?: any,
+      config?: AxiosRequestConfig  
+    ): OperationResponse<any>
+  }
+  ['/messages/{id}/trash']: {
+    /**
+     * trashMessage - trashMessage
+     * 
+     * Moves the specified message to the trash.
+     */
+    'post'(
+      parameters?: Parameters<Paths.TrashMessage.PathParameters> | null,
+      data?: any,
+      config?: AxiosRequestConfig  
+    ): OperationResponse<any>
+  }
+  ['/messages/{id}/untrash']: {
+    /**
+     * untrashMessage - untrashMessage
+     * 
+     * Removes the specified message from the trash.
+     */
+    'post'(
+      parameters?: Parameters<Paths.UntrashMessage.PathParameters> | null,
+      data?: any,
+      config?: AxiosRequestConfig  
+    ): OperationResponse<any>
+  }
+  ['/threads:search']: {
+    /**
+     * searchThreads - searchThreads
+     * 
+     * Search for message entity and return threads which contain matched message. If message doesn't have any reply yet, evaluate it as a thread with single message.\
+     * Supports pagination. Lucene query syntax supported for complex querying.
+     * 
+     */
+    'post'(
+      parameters?: Parameters<UnknownParamsObject> | null,
+      data?: Paths.SearchThreads.RequestBody,
+      config?: AxiosRequestConfig  
+    ): OperationResponse<Paths.SearchThreads.Responses.$200>
+  }
+  ['/threads']: {
+    /**
+     * updateThread - updateThread
+     * 
+     * Modify the thread.
+     */
+    'put'(
+      parameters?: Parameters<UnknownParamsObject> | null,
+      data?: Paths.UpdateThread.RequestBody,
+      config?: AxiosRequestConfig  
+    ): OperationResponse<any>
+  }
+  ['/threads/{id}']: {
+    /**
+     * deleteThread - deleteThread
+     * 
+     * Immediately and permanently deletes the specified thread. This operation cannot be undone.
+     */
+    'delete'(
+      parameters?: Parameters<Paths.DeleteThread.PathParameters> | null,
+      data?: any,
+      config?: AxiosRequestConfig  
+    ): OperationResponse<any>
+  }
+  ['/attachments/upload-url']: {
+    /**
+     * createAttachmentUploadUrl - createAttachmentUploadUrl
+     * 
+     * Create S3 POST presigned URL to upload attachment. The URL is valid in 30 minutes. Maximum file size is 100MB.
+     */
+    'post'(
+      parameters?: Parameters<UnknownParamsObject> | null,
+      data?: Paths.CreateAttachmentUploadUrl.RequestBody,
+      config?: AxiosRequestConfig  
+    ): OperationResponse<Paths.CreateAttachmentUploadUrl.Responses.$200>
+  }
+}
+
+export type Client = OpenAPIClient<OperationMethods, PathsDictionary>