@epilot/message-client 0.0.1 → 1.0.0

package/dist/openapi.d.ts

@@ -22,6 +22,19 @@ declare namespace Components {
        * messaging@epilot.cloud
        */
       address: string;
+      /**
+       * 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?: {
+      };
     }
     export interface Attachment {
       /**
@@ -77,7 +90,7 @@ declare namespace Components {
        */
       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 true then this attachment is copied to the message and replaces corresponding one. The new attachment has different `url`, `object_key`. This property supports for forwarding message and copying attachments from email template.\
        * If both `send_as_link` and `copy_to_message` are provided, `copy_to_message` is discarded.
        * 
        */
@@ -235,11 +248,11 @@ declare namespace Components {
        */
       user_read_message?: string[];
       /**
-       * Message status. Only apply for sent message.
+       * 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>
        * 
        */
-      status?: "SEND" | "REJECT" | "BOUNCE" | "COMPLAINT" | "DELIVERY" | "null";
+      send_status?: ("SEND" | "DELIVERY" | "REJECT" | "COMPLAINT" | "BOUNCE" | "ERROR")[];
       /**
        * Message type
        */
@@ -292,7 +305,7 @@ declare namespace Components {
        */
       html?: string;
       /**
-       * Text body
+       * 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.
        */
@@ -318,7 +331,7 @@ declare namespace Components {
     }
     export interface SearchParams {
       /**
-       * Lucene queries supported with ElasticSearch
+       * Lucene query syntax supported with ElasticSearch
        * example:
        * subject:"Request for solar panel price" AND _tags:INBOX
        */
@@ -569,11 +582,11 @@ declare namespace Paths {
          */
         user_read_message?: string[];
         /**
-         * Message status. Only apply for sent message.
+         * 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>
          * 
          */
-        status?: "SEND" | "REJECT" | "BOUNCE" | "COMPLAINT" | "DELIVERY" | "null";
+        send_status?: ("SEND" | "DELIVERY" | "REJECT" | "COMPLAINT" | "BOUNCE" | "ERROR")[];
         /**
          * Message type
          */
@@ -589,6 +602,14 @@ declare namespace Paths {
       id: Parameters.Id;
     }
   }
+  namespace TrashThread {
+    namespace Parameters {
+      export type Id = string;
+    }
+    export interface PathParameters {
+      id: Parameters.Id;
+    }
+  }
   namespace UntrashMessage {
     namespace Parameters {
       export type Id = string;
@@ -597,16 +618,229 @@ declare namespace Paths {
       id: Parameters.Id;
     }
   }
+  namespace UntrashThread {
+    namespace Parameters {
+      export type Id = string;
+    }
+    export interface PathParameters {
+      id: Parameters.Id;
+    }
+  }
+  namespace UpdateMessage {
+    export type RequestBody = Components.Schemas.Message;
+    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[];
+        /**
+         * 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";
+      }
+    }
+  }
   namespace UpdateThread {
-    export type RequestBody = Components.Schemas.Thread;
+    namespace Responses {
+      /**
+       * Thread properties depend on API caller as it's not pre-defined. We do recommend having at least `topic` property for categorizing.
+       */
+      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 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;
+      }
+    }
   }
 }
 
 export interface OperationMethods {
+  /**
+   * updateMessage - updateMessage
+   * 
+   * Update message metadata
+   */
+  'updateMessage'(
+    parameters?: Parameters<UnknownParamsObject> | null,
+    data?: Paths.UpdateMessage.RequestBody,
+    config?: AxiosRequestConfig  
+  ): OperationResponse<Paths.UpdateMessage.Responses.$201>
   /**
    * sendMessage - sendMessage
    * 
-   * Send the specified message to the recipients.
+   * Send an email message
    */
   'sendMessage'(
     parameters?: Parameters<UnknownParamsObject> | null,
@@ -616,7 +850,7 @@ export interface OperationMethods {
   /**
    * deleteMessage - deleteMessage
    * 
-   * Immediately and permanently deletes the specified message. This operation cannot be undone.
+   * Immediately and permanently delete a message. This operation cannot be undone.
    */
   'deleteMessage'(
     parameters?: Parameters<Paths.DeleteMessage.PathParameters> | null,
@@ -626,7 +860,7 @@ export interface OperationMethods {
   /**
    * trashMessage - trashMessage
    * 
-   * Moves the specified message to the trash.
+   * Move a message to the trash
    */
   'trashMessage'(
     parameters?: Parameters<Paths.TrashMessage.PathParameters> | null,
@@ -636,7 +870,7 @@ export interface OperationMethods {
   /**
    * untrashMessage - untrashMessage
    * 
-   * Removes the specified message from the trash.
+   * Restore a trashed message
    */
   'untrashMessage'(
     parameters?: Parameters<Paths.UntrashMessage.PathParameters> | null,
@@ -646,8 +880,11 @@ export interface OperationMethods {
   /**
    * 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.
+   * Search for threads of email messages.
+   * 
+   * Messages with no replies yet are treated as threads with single message.
+   * 
+   * Lucene syntax supported.
    * 
    */
   'searchThreads'(
@@ -658,23 +895,43 @@ export interface OperationMethods {
   /**
    * updateThread - updateThread
    * 
-   * Modify the thread.
+   * Modify thread metadata
    */
   'updateThread'(
     parameters?: Parameters<UnknownParamsObject> | null,
-    data?: Paths.UpdateThread.RequestBody,
+    data?: any,
     config?: AxiosRequestConfig  
-  ): OperationResponse<any>
+  ): OperationResponse<Paths.UpdateThread.Responses.$201>
   /**
    * deleteThread - deleteThread
    * 
-   * Immediately and permanently deletes the specified thread. This operation cannot be undone.
+   * Immediately and permanently delete a thread. This operation cannot be undone.
    */
   'deleteThread'(
     parameters?: Parameters<Paths.DeleteThread.PathParameters> | null,
     data?: any,
     config?: AxiosRequestConfig  
   ): OperationResponse<any>
+  /**
+   * trashThread - trashThread
+   * 
+   * Move a thread to trash
+   */
+  'trashThread'(
+    parameters?: Parameters<Paths.TrashThread.PathParameters> | null,
+    data?: any,
+    config?: AxiosRequestConfig  
+  ): OperationResponse<any>
+  /**
+   * untrashThread - untrashThread
+   * 
+   * Restore a trashed thread
+   */
+  'untrashThread'(
+    parameters?: Parameters<Paths.UntrashThread.PathParameters> | null,
+    data?: any,
+    config?: AxiosRequestConfig  
+  ): OperationResponse<any>
   /**
    * createAttachmentUploadUrl - createAttachmentUploadUrl
    * 
@@ -688,23 +945,33 @@ export interface OperationMethods {
 }
 
 export interface PathsDictionary {
-  ['/messages']: {
+  ['/v1/message/messages']: {
     /**
      * sendMessage - sendMessage
      * 
-     * Send the specified message to the recipients.
+     * Send an email message
      */
     'post'(
       parameters?: Parameters<UnknownParamsObject> | null,
       data?: Paths.SendMessage.RequestBody,
       config?: AxiosRequestConfig  
     ): OperationResponse<Paths.SendMessage.Responses.$201>
+    /**
+     * updateMessage - updateMessage
+     * 
+     * Update message metadata
+     */
+    'put'(
+      parameters?: Parameters<UnknownParamsObject> | null,
+      data?: Paths.UpdateMessage.RequestBody,
+      config?: AxiosRequestConfig  
+    ): OperationResponse<Paths.UpdateMessage.Responses.$201>
   }
-  ['/messages/{id}']: {
+  ['/v1/message/messages/{id}']: {
     /**
      * deleteMessage - deleteMessage
      * 
-     * Immediately and permanently deletes the specified message. This operation cannot be undone.
+     * Immediately and permanently delete a message. This operation cannot be undone.
      */
     'delete'(
       parameters?: Parameters<Paths.DeleteMessage.PathParameters> | null,
@@ -712,11 +979,11 @@ export interface PathsDictionary {
       config?: AxiosRequestConfig  
     ): OperationResponse<any>
   }
-  ['/messages/{id}/trash']: {
+  ['/v1/message/messages/{id}/trash']: {
     /**
      * trashMessage - trashMessage
      * 
-     * Moves the specified message to the trash.
+     * Move a message to the trash
      */
     'post'(
       parameters?: Parameters<Paths.TrashMessage.PathParameters> | null,
@@ -724,11 +991,11 @@ export interface PathsDictionary {
       config?: AxiosRequestConfig  
     ): OperationResponse<any>
   }
-  ['/messages/{id}/untrash']: {
+  ['/v1/message/messages/{id}/untrash']: {
     /**
      * untrashMessage - untrashMessage
      * 
-     * Removes the specified message from the trash.
+     * Restore a trashed message
      */
     'post'(
       parameters?: Parameters<Paths.UntrashMessage.PathParameters> | null,
@@ -736,12 +1003,15 @@ export interface PathsDictionary {
       config?: AxiosRequestConfig  
     ): OperationResponse<any>
   }
-  ['/threads:search']: {
+  ['/v1/message/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.
+     * Search for threads of email messages.
+     * 
+     * Messages with no replies yet are treated as threads with single message.
+     * 
+     * Lucene syntax supported.
      * 
      */
     'post'(
@@ -750,23 +1020,23 @@ export interface PathsDictionary {
       config?: AxiosRequestConfig  
     ): OperationResponse<Paths.SearchThreads.Responses.$200>
   }
-  ['/threads']: {
+  ['/v1/message/threads']: {
     /**
      * updateThread - updateThread
      * 
-     * Modify the thread.
+     * Modify thread metadata
      */
     'put'(
       parameters?: Parameters<UnknownParamsObject> | null,
-      data?: Paths.UpdateThread.RequestBody,
+      data?: any,
       config?: AxiosRequestConfig  
-    ): OperationResponse<any>
+    ): OperationResponse<Paths.UpdateThread.Responses.$201>
   }
-  ['/threads/{id}']: {
+  ['/v1/message/threads/{id}']: {
     /**
      * deleteThread - deleteThread
      * 
-     * Immediately and permanently deletes the specified thread. This operation cannot be undone.
+     * Immediately and permanently delete a thread. This operation cannot be undone.
      */
     'delete'(
       parameters?: Parameters<Paths.DeleteThread.PathParameters> | null,
@@ -774,7 +1044,31 @@ export interface PathsDictionary {
       config?: AxiosRequestConfig  
     ): OperationResponse<any>
   }
-  ['/attachments/upload-url']: {
+  ['/v1/message/threads/{id}/trash']: {
+    /**
+     * trashThread - trashThread
+     * 
+     * Move a thread to trash
+     */
+    'post'(
+      parameters?: Parameters<Paths.TrashThread.PathParameters> | null,
+      data?: any,
+      config?: AxiosRequestConfig  
+    ): OperationResponse<any>
+  }
+  ['/v1/message/threads/{id}/untrash']: {
+    /**
+     * untrashThread - untrashThread
+     * 
+     * Restore a trashed thread
+     */
+    'post'(
+      parameters?: Parameters<Paths.UntrashThread.PathParameters> | null,
+      data?: any,
+      config?: AxiosRequestConfig  
+    ): OperationResponse<any>
+  }
+  ['/v1/message/attachments/upload-url']: {
     /**
      * createAttachmentUploadUrl - createAttachmentUploadUrl
      *