@epilot/message-client 1.0.0 → 1.0.1

package/dist/openapi.d.ts

@@ -36,89 +36,6 @@ declare namespace Components {
       send_error?: {
       };
     }
-    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 `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.
-       * 
-       */
-      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
@@ -164,19 +81,49 @@ declare namespace Components {
        */
       _updated_at: string; // date-time
     }
-    export interface CreateAttachmentUploadUrlParams {
-      /**
-       * File name
-       * example:
-       * Produktinformationen_epilot360_Double_Opt_in.pdf
-       */
-      filename: string;
+    /**
+     * Message attachments
+     */
+    export interface File {
       /**
-       * Content type
-       * example:
-       * application/pdf
+       * It's normal entity relation with some additional properties for sending message attachment.
        */
-      content_type: string;
+      $relation?: {
+        /**
+         * 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.
+         */
+        is_message_attachment?: boolean;
+        /**
+         * Content ID
+         * 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 {
       /**
@@ -223,10 +170,7 @@ declare namespace Components {
        * Bcc email addresses
        */
       bcc?: Address[];
-      /**
-       * Message attachments
-       */
-      attachments?: Attachment[];
+      file?: File;
       /**
        * 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.\
@@ -247,6 +191,10 @@ declare namespace Components {
        * Ivy User ID of user read the message.
        */
       user_read_message?: string[];
+      /**
+       * Ivy Organization ID of organization read the message.
+       */
+      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>
@@ -324,10 +272,7 @@ declare namespace Components {
        * Bcc email addresses
        */
       bcc?: Address[];
-      /**
-       * Message attachments
-       */
-      attachments?: Attachment[];
+      file?: File;
     }
     export interface SearchParams {
       /**
@@ -353,6 +298,10 @@ declare namespace Components {
        * Ivy User ID of who the message is assigned to. Default is the user who sends message.
        */
       assigned_to?: string[];
+      /**
+       * Ivy Organization ID of organization read the message.
+       */
+      org_read_message?: string[];
       /**
        * Latest message of thread
        */
@@ -365,10 +314,133 @@ declare namespace Components {
   }
 }
 declare namespace Paths {
-  namespace CreateAttachmentUploadUrl {
-    export type RequestBody = Components.Schemas.CreateAttachmentUploadUrlParams;
+  namespace CreateDraft {
+    export type RequestBody = Components.Schemas.MessageRequestParams;
     namespace Responses {
-      export type $200 = Components.Schemas.AttachmentUploadUrl;
+      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[];
+        file?: Components.Schemas.File;
+        /**
+         * 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[];
+        /**
+         * Ivy Organization ID of organization read the message.
+         */
+        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";
+      }
     }
   }
   namespace DeleteMessage {
@@ -387,6 +459,38 @@ declare namespace Paths {
       id: Parameters.Id;
     }
   }
+  namespace MarkReadMessage {
+    namespace Parameters {
+      export type Id = string;
+    }
+    export interface PathParameters {
+      id: Parameters.Id;
+    }
+  }
+  namespace MarkReadThread {
+    namespace Parameters {
+      export type Id = string;
+    }
+    export interface PathParameters {
+      id: Parameters.Id;
+    }
+  }
+  namespace MarkUnreadMessage {
+    namespace Parameters {
+      export type Id = string;
+    }
+    export interface PathParameters {
+      id: Parameters.Id;
+    }
+  }
+  namespace MarkUnreadThread {
+    namespace Parameters {
+      export type Id = string;
+    }
+    export interface PathParameters {
+      id: Parameters.Id;
+    }
+  }
   namespace SearchThreads {
     export type RequestBody = Components.Schemas.SearchParams;
     namespace Responses {
@@ -454,6 +558,10 @@ declare namespace Paths {
            * Ivy User ID of who the message is assigned to. Default is the user who sends message.
            */
           assigned_to?: string[];
+          /**
+           * Ivy Organization ID of organization read the message.
+           */
+          org_read_message?: string[];
           /**
            * Latest message of thread
            */
@@ -466,8 +574,7 @@ declare namespace Paths {
       }
     }
   }
-  namespace SendMessage {
-    export type RequestBody = Components.Schemas.MessageRequestParams;
+  namespace SendDraft {
     namespace Responses {
       export interface $201 {
         /**
@@ -557,10 +664,136 @@ declare namespace Paths {
          * Bcc email addresses
          */
         bcc?: Components.Schemas.Address[];
+        file?: Components.Schemas.File;
+        /**
+         * 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[];
+        /**
+         * Ivy Organization ID of organization read the message.
+         */
+        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";
+      }
+    }
+  }
+  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[];
         /**
-         * Message attachments
+         * Created date
+         * example:
+         * "2021-02-09T12:41:43.662Z"
+         */
+        _created_at: string; // date-time
+        /**
+         * Updated date
+         * example:
+         * "2021-02-10T09:14:31.990Z"
          */
-        attachments?: Components.Schemas.Attachment[];
+        _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[];
+        file?: Components.Schemas.File;
         /**
          * 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.\
@@ -581,6 +814,10 @@ declare namespace Paths {
          * Ivy User ID of user read the message.
          */
         user_read_message?: string[];
+        /**
+         * Ivy Organization ID of organization read the message.
+         */
+        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>
@@ -627,7 +864,6 @@ declare namespace Paths {
     }
   }
   namespace UpdateMessage {
-    export type RequestBody = Components.Schemas.Message;
     namespace Responses {
       export interface $201 {
         /**
@@ -717,10 +953,7 @@ declare namespace Paths {
          * Bcc email addresses
          */
         bcc?: Components.Schemas.Address[];
-        /**
-         * Message attachments
-         */
-        attachments?: Components.Schemas.Attachment[];
+        file?: Components.Schemas.File;
         /**
          * 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.\
@@ -741,6 +974,10 @@ declare namespace Paths {
          * Ivy User ID of user read the message.
          */
         user_read_message?: string[];
+        /**
+         * Ivy Organization ID of organization read the message.
+         */
+        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>
@@ -813,6 +1050,10 @@ declare namespace Paths {
          * Ivy User ID of who the message is assigned to. Default is the user who sends message.
          */
         assigned_to?: string[];
+        /**
+         * Ivy Organization ID of organization read the message.
+         */
+        org_read_message?: string[];
         /**
          * Latest message of thread
          */
@@ -834,7 +1075,7 @@ export interface OperationMethods {
    */
   'updateMessage'(
     parameters?: Parameters<UnknownParamsObject> | null,
-    data?: Paths.UpdateMessage.RequestBody,
+    data?: any,
     config?: AxiosRequestConfig  
   ): OperationResponse<Paths.UpdateMessage.Responses.$201>
   /**
@@ -877,6 +1118,26 @@ export interface OperationMethods {
     data?: any,
     config?: AxiosRequestConfig  
   ): OperationResponse<any>
+  /**
+   * markReadMessage - markReadMessage
+   * 
+   * Mark message as read
+   */
+  'markReadMessage'(
+    parameters?: Parameters<Paths.MarkReadMessage.PathParameters> | null,
+    data?: any,
+    config?: AxiosRequestConfig  
+  ): OperationResponse<any>
+  /**
+   * markUnreadMessage - markUnreadMessage
+   * 
+   * Mark message as unread
+   */
+  'markUnreadMessage'(
+    parameters?: Parameters<Paths.MarkUnreadMessage.PathParameters> | null,
+    data?: any,
+    config?: AxiosRequestConfig  
+  ): OperationResponse<any>
   /**
    * searchThreads - searchThreads
    * 
@@ -933,15 +1194,45 @@ export interface OperationMethods {
     config?: AxiosRequestConfig  
   ): OperationResponse<any>
   /**
-   * createAttachmentUploadUrl - createAttachmentUploadUrl
+   * markReadThread - markReadThread
+   * 
+   * Mark thread as read
+   */
+  'markReadThread'(
+    parameters?: Parameters<Paths.MarkReadThread.PathParameters> | null,
+    data?: any,
+    config?: AxiosRequestConfig  
+  ): OperationResponse<any>
+  /**
+   * markUnreadThread - markUnreadThread
    * 
-   * Create S3 POST presigned URL to upload attachment. The URL is valid in 30 minutes. Maximum file size is 100MB.
+   * Mark thread as unread
    */
-  'createAttachmentUploadUrl'(
+  'markUnreadThread'(
+    parameters?: Parameters<Paths.MarkUnreadThread.PathParameters> | null,
+    data?: any,
+    config?: AxiosRequestConfig  
+  ): OperationResponse<any>
+  /**
+   * createDraft - createDraft
+   * 
+   * Create a new draft
+   */
+  'createDraft'(
+    parameters?: Parameters<UnknownParamsObject> | null,
+    data?: Paths.CreateDraft.RequestBody,
+    config?: AxiosRequestConfig  
+  ): OperationResponse<Paths.CreateDraft.Responses.$201>
+  /**
+   * sendDraft - sendDraft
+   * 
+   * Send the existing draft to the recipients
+   */
+  'sendDraft'(
     parameters?: Parameters<UnknownParamsObject> | null,
-    data?: Paths.CreateAttachmentUploadUrl.RequestBody,
+    data?: any,
     config?: AxiosRequestConfig  
-  ): OperationResponse<Paths.CreateAttachmentUploadUrl.Responses.$200>
+  ): OperationResponse<Paths.SendDraft.Responses.$201>
 }
 
 export interface PathsDictionary {
@@ -963,7 +1254,7 @@ export interface PathsDictionary {
      */
     'put'(
       parameters?: Parameters<UnknownParamsObject> | null,
-      data?: Paths.UpdateMessage.RequestBody,
+      data?: any,
       config?: AxiosRequestConfig  
     ): OperationResponse<Paths.UpdateMessage.Responses.$201>
   }
@@ -1003,6 +1294,30 @@ export interface PathsDictionary {
       config?: AxiosRequestConfig  
     ): OperationResponse<any>
   }
+  ['/v1/message/messages/{id}/read']: {
+    /**
+     * markReadMessage - markReadMessage
+     * 
+     * Mark message as read
+     */
+    'post'(
+      parameters?: Parameters<Paths.MarkReadMessage.PathParameters> | null,
+      data?: any,
+      config?: AxiosRequestConfig  
+    ): OperationResponse<any>
+  }
+  ['/v1/message/messages/{id}/unread']: {
+    /**
+     * markUnreadMessage - markUnreadMessage
+     * 
+     * Mark message as unread
+     */
+    'post'(
+      parameters?: Parameters<Paths.MarkUnreadMessage.PathParameters> | null,
+      data?: any,
+      config?: AxiosRequestConfig  
+    ): OperationResponse<any>
+  }
   ['/v1/message/threads:search']: {
     /**
      * searchThreads - searchThreads
@@ -1068,17 +1383,53 @@ export interface PathsDictionary {
       config?: AxiosRequestConfig  
     ): OperationResponse<any>
   }
-  ['/v1/message/attachments/upload-url']: {
+  ['/v1/message/threads/{id}/read']: {
+    /**
+     * markReadThread - markReadThread
+     * 
+     * Mark thread as read
+     */
+    'post'(
+      parameters?: Parameters<Paths.MarkReadThread.PathParameters> | null,
+      data?: any,
+      config?: AxiosRequestConfig  
+    ): OperationResponse<any>
+  }
+  ['/v1/message/threads/{id}/unread']: {
+    /**
+     * markUnreadThread - markUnreadThread
+     * 
+     * Mark thread as unread
+     */
+    'post'(
+      parameters?: Parameters<Paths.MarkUnreadThread.PathParameters> | null,
+      data?: any,
+      config?: AxiosRequestConfig  
+    ): OperationResponse<any>
+  }
+  ['/v1/message/drafts']: {
     /**
-     * createAttachmentUploadUrl - createAttachmentUploadUrl
+     * createDraft - createDraft
      * 
-     * Create S3 POST presigned URL to upload attachment. The URL is valid in 30 minutes. Maximum file size is 100MB.
+     * Create a new draft
      */
     'post'(
       parameters?: Parameters<UnknownParamsObject> | null,
-      data?: Paths.CreateAttachmentUploadUrl.RequestBody,
+      data?: Paths.CreateDraft.RequestBody,
+      config?: AxiosRequestConfig  
+    ): OperationResponse<Paths.CreateDraft.Responses.$201>
+  }
+  ['/v1/message/drafts:send']: {
+    /**
+     * sendDraft - sendDraft
+     * 
+     * Send the existing draft to the recipients
+     */
+    'post'(
+      parameters?: Parameters<UnknownParamsObject> | null,
+      data?: any,
       config?: AxiosRequestConfig  
-    ): OperationResponse<Paths.CreateAttachmentUploadUrl.Responses.$200>
+    ): OperationResponse<Paths.SendDraft.Responses.$201>
   }
 }