@epilot/message-client 1.15.1 → 1.15.3

package/README.md

@@ -7,7 +7,7 @@
 
 API Client for epilot [Message API](https://docs.epilot.io/api/message).
 
-Uses [`openapi-client-axios`](https://github.com/anttiviljami/openapi-client-axios)
+Uses [`openapi-client-axios`](https://github.com/openapistack/openapi-client-axios)
 
 ## Installation
 
@@ -86,4 +86,4 @@ const sendResponse = await messageClient.sendMessage(null, {
 
 ## Documentation
 
-https://docs.epilot.io/docs/messaging/message-api
+https://docs.epilot.io/docs/messaging/message-api

package/dist/definition.js

@@ -1 +1 @@
-(()=>{"use strict";var e={914:function(e,s,r){var a=this&&this.__importDefault||function(e){return e&&e.__esModule?e:{default:e}};Object.defineProperty(s,"__esModule",{value:!0});var t=a(r(240));s.default=t.default},240:e=>{e.exports=JSON.parse('{"openapi":"3.0.2","info":{"title":"","version":""},"paths":{"/v1/message/messages":{"post":{"operationId":"sendMessage","parameters":[{"in":"query","name":"do_not_create_entities"}],"requestBody":{"content":{"application/json":{}}},"responses":{}},"put":{"operationId":"updateMessage","responses":{}}},"/v1/message/messages/{id}":{"get":{"operationId":"getMessage","parameters":[{"name":"id","in":"path","required":true}],"responses":{}},"delete":{"operationId":"deleteMessage","parameters":[{"name":"id","in":"path","required":true}],"responses":{}}},"/v1/message/messages/{id}/trash":{"post":{"operationId":"trashMessage","parameters":[{"name":"id","in":"path","required":true}],"responses":{}}},"/v1/message/messages/{id}/untrash":{"post":{"operationId":"untrashMessage","parameters":[{"name":"id","in":"path","required":true}],"responses":{}}},"/v1/message/messages/{id}/read":{"post":{"operationId":"markReadMessage","parameters":[{"name":"id","in":"path","required":true}],"responses":{}}},"/v1/message/messages/{id}/unread":{"post":{"operationId":"markUnreadMessage","parameters":[{"name":"id","in":"path","required":true}],"responses":{}}},"/v1/message/threads:search":{"post":{"operationId":"searchThreads","requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v1/message/threads":{"put":{"operationId":"updateThread","responses":{}}},"/v1/message/threads/{id}":{"delete":{"operationId":"deleteThread","parameters":[{"name":"id","in":"path","required":true}],"responses":{}}},"/v1/message/threads/{id}/trash":{"post":{"operationId":"trashThread","parameters":[{"name":"id","in":"path","required":true}],"responses":{}}},"/v1/message/threads/{id}/untrash":{"post":{"operationId":"untrashThread","parameters":[{"name":"id","in":"path","required":true}],"responses":{}}},"/v1/message/threads/{id}/read":{"post":{"operationId":"markReadThread","parameters":[{"name":"id","in":"path","required":true}],"responses":{}}},"/v1/message/threads/{id}/unread":{"post":{"operationId":"markUnreadThread","parameters":[{"name":"id","in":"path","required":true}],"responses":{}}},"/v1/message/threads/{id}/assign":{"post":{"operationId":"assignThread","parameters":[{"name":"id","in":"path","required":true}],"requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}},"/v1/message/threads/{id}/unassign":{"post":{"operationId":"unassignThread","parameters":[{"name":"id","in":"path","required":true}],"requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}},"/v1/message/threads/{id}/assign:users":{"post":{"operationId":"assignUsers","parameters":[{"name":"id","in":"path","required":true}],"requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}},"/v1/message/drafts":{"post":{"operationId":"createDraft","requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v1/message/drafts:send":{"post":{"operationId":"sendDraft","responses":{}}},"/v2/message/messages/{id}":{"get":{"operationId":"getMessageV2","parameters":[{"name":"id","in":"path","required":true}],"responses":{}}}},"components":{},"servers":[{"url":"https://message.sls.epilot.io"}]}')}},s={},r=function r(a){var t=s[a];if(void 0!==t)return t.exports;var n=s[a]={exports:{}};return e[a].call(n.exports,n,n.exports,r),n.exports}(914),a=exports;for(var t in r)a[t]=r[t];r.__esModule&&Object.defineProperty(a,"__esModule",{value:!0})})();
+(()=>{"use strict";var e={914:function(e,s,r){var a=this&&this.__importDefault||function(e){return e&&e.__esModule?e:{default:e}};Object.defineProperty(s,"__esModule",{value:!0});var t=a(r(240));s.default=t.default},240:e=>{e.exports=JSON.parse('{"openapi":"3.0.2","info":{"title":"","version":""},"paths":{"/v1/message/messages":{"post":{"operationId":"sendMessage","parameters":[{"in":"query","name":"do_not_create_entities"}],"requestBody":{"content":{"application/json":{}}},"responses":{}},"put":{"operationId":"updateMessage","responses":{}}},"/v1/message/messages/{id}":{"get":{"operationId":"getMessage","parameters":[{"name":"id","in":"path","required":true}],"responses":{}},"delete":{"operationId":"deleteMessage","parameters":[{"name":"id","in":"path","required":true}],"responses":{}}},"/v1/message/messages/{id}/trash":{"post":{"operationId":"trashMessage","parameters":[{"name":"id","in":"path","required":true}],"responses":{}}},"/v1/message/messages/{id}/untrash":{"post":{"operationId":"untrashMessage","parameters":[{"name":"id","in":"path","required":true}],"responses":{}}},"/v1/message/messages/{id}/read":{"post":{"operationId":"markReadMessage","parameters":[{"name":"id","in":"path","required":true}],"responses":{}}},"/v2/message/messages/{id}/read":{"post":{"operationId":"markReadMessageV2","parameters":[{"name":"id","in":"path","required":true}],"requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}},"/v1/message/messages/{id}/unread":{"post":{"operationId":"markUnreadMessage","parameters":[{"name":"id","in":"path","required":true}],"responses":{}}},"/v2/message/messages/{id}/unread":{"post":{"operationId":"markUnreadMessageV2","parameters":[{"name":"id","in":"path","required":true}],"requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}},"/v1/message/threads:search":{"post":{"operationId":"searchThreads","requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v1/message/threads":{"put":{"operationId":"updateThread","responses":{}}},"/v1/message/threads/{id}":{"delete":{"operationId":"deleteThread","parameters":[{"name":"id","in":"path","required":true}],"responses":{}}},"/v1/message/threads/{id}:markAsDone":{"post":{"operationId":"markThreadAsDone","parameters":[{"name":"id","in":"path","required":true}],"responses":{}}},"/v1/message/threads/{id}:markAsOpen":{"post":{"operationId":"markThreadAsOpen","parameters":[{"name":"id","in":"path","required":true}],"responses":{}}},"/v1/message/threads/{id}/trash":{"post":{"operationId":"trashThread","parameters":[{"name":"id","in":"path","required":true}],"responses":{}}},"/v1/message/threads/{id}/untrash":{"post":{"operationId":"untrashThread","parameters":[{"name":"id","in":"path","required":true}],"responses":{}}},"/v1/message/threads/{id}/read":{"post":{"operationId":"markReadThread","parameters":[{"name":"id","in":"path","required":true}],"responses":{}}},"/v2/message/threads/{id}/read":{"post":{"operationId":"markReadThreadV2","parameters":[{"name":"id","in":"path","required":true}],"requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}},"/v1/message/threads/{id}/unread":{"post":{"operationId":"markUnreadThread","parameters":[{"name":"id","in":"path","required":true}],"responses":{}}},"/v2/message/threads/{id}/unread":{"post":{"operationId":"markUnreadThreadV2","parameters":[{"name":"id","in":"path","required":true}],"requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}},"/v1/message/threads/{id}/assign":{"post":{"operationId":"assignThread","parameters":[{"name":"id","in":"path","required":true}],"requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}},"/v1/message/threads/{id}/unassign":{"post":{"operationId":"unassignThread","parameters":[{"name":"id","in":"path","required":true}],"requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}},"/v1/message/threads/{id}/assign:users":{"post":{"operationId":"assignUsers","parameters":[{"name":"id","in":"path","required":true}],"requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}},"/v1/message/drafts":{"post":{"operationId":"createDraft","requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v1/message/drafts:send":{"post":{"operationId":"sendDraft","responses":{}}},"/v2/message/messages/{id}":{"get":{"operationId":"getMessageV2","parameters":[{"name":"id","in":"path","required":true}],"responses":{}}}},"components":{},"servers":[{"url":"https://message.sls.epilot.io"}]}')}},s={},r=function r(a){var t=s[a];if(void 0!==t)return t.exports;var n=s[a]={exports:{}};return e[a].call(n.exports,n,n.exports,r),n.exports}(914),a=exports;for(var t in r)a[t]=r[t];r.__esModule&&Object.defineProperty(a,"__esModule",{value:!0})})();

package/dist/openapi-runtime.json

@@ -89,6 +89,25 @@
         "responses": {}
       }
     },
+    "/v2/message/messages/{id}/read": {
+      "post": {
+        "operationId": "markReadMessageV2",
+        "parameters": [
+          {
+            "name": "id",
+            "in": "path",
+            "required": true
+          }
+        ],
+        "requestBody": {
+          "required": true,
+          "content": {
+            "application/json": {}
+          }
+        },
+        "responses": {}
+      }
+    },
     "/v1/message/messages/{id}/unread": {
       "post": {
         "operationId": "markUnreadMessage",
@@ -102,6 +121,25 @@
         "responses": {}
       }
     },
+    "/v2/message/messages/{id}/unread": {
+      "post": {
+        "operationId": "markUnreadMessageV2",
+        "parameters": [
+          {
+            "name": "id",
+            "in": "path",
+            "required": true
+          }
+        ],
+        "requestBody": {
+          "required": true,
+          "content": {
+            "application/json": {}
+          }
+        },
+        "responses": {}
+      }
+    },
     "/v1/message/threads:search": {
       "post": {
         "operationId": "searchThreads",
@@ -132,6 +170,32 @@
         "responses": {}
       }
     },
+    "/v1/message/threads/{id}:markAsDone": {
+      "post": {
+        "operationId": "markThreadAsDone",
+        "parameters": [
+          {
+            "name": "id",
+            "in": "path",
+            "required": true
+          }
+        ],
+        "responses": {}
+      }
+    },
+    "/v1/message/threads/{id}:markAsOpen": {
+      "post": {
+        "operationId": "markThreadAsOpen",
+        "parameters": [
+          {
+            "name": "id",
+            "in": "path",
+            "required": true
+          }
+        ],
+        "responses": {}
+      }
+    },
     "/v1/message/threads/{id}/trash": {
       "post": {
         "operationId": "trashThread",
@@ -171,6 +235,25 @@
         "responses": {}
       }
     },
+    "/v2/message/threads/{id}/read": {
+      "post": {
+        "operationId": "markReadThreadV2",
+        "parameters": [
+          {
+            "name": "id",
+            "in": "path",
+            "required": true
+          }
+        ],
+        "requestBody": {
+          "required": true,
+          "content": {
+            "application/json": {}
+          }
+        },
+        "responses": {}
+      }
+    },
     "/v1/message/threads/{id}/unread": {
       "post": {
         "operationId": "markUnreadThread",
@@ -184,6 +267,25 @@
         "responses": {}
       }
     },
+    "/v2/message/threads/{id}/unread": {
+      "post": {
+        "operationId": "markUnreadThreadV2",
+        "parameters": [
+          {
+            "name": "id",
+            "in": "path",
+            "required": true
+          }
+        ],
+        "requestBody": {
+          "required": true,
+          "content": {
+            "application/json": {}
+          }
+        },
+        "responses": {}
+      }
+    },
     "/v1/message/threads/{id}/assign": {
       "post": {
         "operationId": "assignThread",

package/dist/openapi.d.ts

@@ -62,7 +62,7 @@ declare namespace Components {
              */
             _title: string;
             /**
-             * Ivy Organization ID the entity belongs to
+             * Organization ID the entity belongs to
              * example:
              * 206801
              */
@@ -112,6 +112,10 @@ declare namespace Components {
              * 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:
@@ -137,7 +141,7 @@ declare namespace Components {
              */
             message_id?: string;
             /**
-             * Ivy User ID of user sends the message.
+             * User ID of user sends the message.
              * example:
              * 206801
              */
@@ -190,11 +194,11 @@ declare namespace Components {
              */
             in_reply_to?: string;
             /**
-             * Ivy User ID of user read the message.
+             * User ID of user read the message.
              */
             user_read_message?: string[];
             /**
-             * Ivy Organization ID of organization read the message.
+             * Organization ID of organization read the message.
              */
             org_read_message?: string[];
             /**
@@ -234,7 +238,7 @@ declare namespace Components {
                  */
                 topic: string;
                 /**
-                 * Ivy User ID of who the message is assigned to. Default is the user who sends message.
+                 * User ID of who the message is assigned to. Default is the user who sends message.
                  */
                 assigned_to?: string[];
             };
@@ -297,7 +301,7 @@ declare namespace Components {
              */
             _title: string;
             /**
-             * Ivy Organization ID the entity belongs to
+             * Organization ID the entity belongs to
              * example:
              * 206801
              */
@@ -336,7 +340,7 @@ declare namespace Components {
              */
             message_id?: string;
             /**
-             * Ivy User ID of user sends the message.
+             * User ID of user sends the message.
              * example:
              * 206801
              */
@@ -389,11 +393,11 @@ declare namespace Components {
              */
             in_reply_to?: string;
             /**
-             * Ivy User ID of user read the message.
+             * User ID of user read the message.
              */
             user_read_message?: string[];
             /**
-             * Ivy Organization ID of organization read the message.
+             * Organization ID of organization read the message.
              */
             org_read_message?: string[];
             /**
@@ -422,6 +426,21 @@ declare namespace Components {
              */
             html_download_url?: 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 SearchParams {
             /**
              * Lucene query syntax supported with ElasticSearch
@@ -431,6 +450,7 @@ declare namespace Components {
             q: string;
             from?: number;
             size?: number;
+            hydrate?: boolean;
         }
         /**
          * Thread properties depend on API caller as it's not pre-defined. We do recommend having at least `topic` property for categorizing.
@@ -443,13 +463,19 @@ declare namespace Components {
              */
             topic: string;
             /**
-             * Ivy User ID of who the message is assigned to. Default is the user who sends message.
+             * 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.
+             * Organization ID of organization read the message.
              */
             org_read_message?: string[];
+            /**
+             * Whether the thread is marked as Done
+             * example:
+             * false
+             */
+            done?: boolean;
             /**
              * Latest message of thread
              */
@@ -491,6 +517,12 @@ declare namespace Paths {
              * 3f34ce73-089c-4d45-a5ee-c161234e41c3
              */
             entity_id?: string;
+            /**
+             * Organization ID
+             * example:
+             * 206801
+             */
+            org_id?: string;
             /**
              * To indicate this is main entity
              * example:
@@ -543,7 +575,7 @@ declare namespace Paths {
                  */
                 _title: string;
                 /**
-                 * Ivy Organization ID the entity belongs to
+                 * Organization ID the entity belongs to
                  * example:
                  * 206801
                  */
@@ -582,7 +614,7 @@ declare namespace Paths {
                  */
                 message_id?: string;
                 /**
-                 * Ivy User ID of user sends the message.
+                 * User ID of user sends the message.
                  * example:
                  * 206801
                  */
@@ -635,11 +667,11 @@ declare namespace Paths {
                  */
                 in_reply_to?: string;
                 /**
-                 * Ivy User ID of user read the message.
+                 * User ID of user read the message.
                  */
                 user_read_message?: string[];
                 /**
-                 * Ivy Organization ID of organization read the message.
+                 * Organization ID of organization read the message.
                  */
                 org_read_message?: string[];
                 /**
@@ -718,7 +750,7 @@ declare namespace Paths {
                  */
                 _title: string;
                 /**
-                 * Ivy Organization ID the entity belongs to
+                 * Organization ID the entity belongs to
                  * example:
                  * 206801
                  */
@@ -757,7 +789,7 @@ declare namespace Paths {
                  */
                 message_id?: string;
                 /**
-                 * Ivy User ID of user sends the message.
+                 * User ID of user sends the message.
                  * example:
                  * 206801
                  */
@@ -810,11 +842,11 @@ declare namespace Paths {
                  */
                 in_reply_to?: string;
                 /**
-                 * Ivy User ID of user read the message.
+                 * User ID of user read the message.
                  */
                 user_read_message?: string[];
                 /**
-                 * Ivy Organization ID of organization read the message.
+                 * Organization ID of organization read the message.
                  */
                 org_read_message?: string[];
                 /**
@@ -867,7 +899,7 @@ declare namespace Paths {
                  */
                 _title: string;
                 /**
-                 * Ivy Organization ID the entity belongs to
+                 * Organization ID the entity belongs to
                  * example:
                  * 206801
                  */
@@ -906,7 +938,7 @@ declare namespace Paths {
                  */
                 message_id?: string;
                 /**
-                 * Ivy User ID of user sends the message.
+                 * User ID of user sends the message.
                  * example:
                  * 206801
                  */
@@ -959,11 +991,11 @@ declare namespace Paths {
                  */
                 in_reply_to?: string;
                 /**
-                 * Ivy User ID of user read the message.
+                 * User ID of user read the message.
                  */
                 user_read_message?: string[];
                 /**
-                 * Ivy Organization ID of organization read the message.
+                 * Organization ID of organization read the message.
                  */
                 org_read_message?: string[];
                 /**
@@ -1010,6 +1042,21 @@ declare namespace Paths {
             }
         }
     }
+    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;
@@ -1024,6 +1071,49 @@ declare namespace Paths {
             }
         }
     }
+    namespace MarkReadThreadV2 {
+        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 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;
@@ -1038,6 +1128,21 @@ declare namespace Paths {
             }
         }
     }
+    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;
@@ -1052,6 +1157,21 @@ declare namespace Paths {
             }
         }
     }
+    namespace MarkUnreadThreadV2 {
+        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 SearchThreads {
         export type RequestBody = Components.Schemas.SearchParams;
         namespace Responses {
@@ -1077,7 +1197,7 @@ declare namespace Paths {
                      */
                     _title: string;
                     /**
-                     * Ivy Organization ID the entity belongs to
+                     * Organization ID the entity belongs to
                      * example:
                      * 206801
                      */
@@ -1116,13 +1236,19 @@ declare namespace Paths {
                      */
                     topic: string;
                     /**
-                     * Ivy User ID of who the message is assigned to. Default is the user who sends message.
+                     * 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.
+                     * Organization ID of organization read the message.
                      */
                     org_read_message?: string[];
+                    /**
+                     * Whether the thread is marked as Done
+                     * example:
+                     * false
+                     */
+                    done?: boolean;
                     latest_message?: Components.Schemas.Message;
                     latest_trash_message?: Components.Schemas.Message;
                     /**
@@ -1151,7 +1277,7 @@ declare namespace Paths {
                  */
                 _title: string;
                 /**
-                 * Ivy Organization ID the entity belongs to
+                 * Organization ID the entity belongs to
                  * example:
                  * 206801
                  */
@@ -1190,7 +1316,7 @@ declare namespace Paths {
                  */
                 message_id?: string;
                 /**
-                 * Ivy User ID of user sends the message.
+                 * User ID of user sends the message.
                  * example:
                  * 206801
                  */
@@ -1243,11 +1369,11 @@ declare namespace Paths {
                  */
                 in_reply_to?: string;
                 /**
-                 * Ivy User ID of user read the message.
+                 * User ID of user read the message.
                  */
                 user_read_message?: string[];
                 /**
-                 * Ivy Organization ID of organization read the message.
+                 * Organization ID of organization read the message.
                  */
                 org_read_message?: string[];
                 /**
@@ -1385,7 +1511,7 @@ declare namespace Paths {
                  */
                 _title: string;
                 /**
-                 * Ivy Organization ID the entity belongs to
+                 * Organization ID the entity belongs to
                  * example:
                  * 206801
                  */
@@ -1424,7 +1550,7 @@ declare namespace Paths {
                  */
                 message_id?: string;
                 /**
-                 * Ivy User ID of user sends the message.
+                 * User ID of user sends the message.
                  * example:
                  * 206801
                  */
@@ -1477,11 +1603,11 @@ declare namespace Paths {
                  */
                 in_reply_to?: string;
                 /**
-                 * Ivy User ID of user read the message.
+                 * User ID of user read the message.
                  */
                 user_read_message?: string[];
                 /**
-                 * Ivy Organization ID of organization read the message.
+                 * Organization ID of organization read the message.
                  */
                 org_read_message?: string[];
                 /**
@@ -1521,7 +1647,7 @@ declare namespace Paths {
                  */
                 _title: string;
                 /**
-                 * Ivy Organization ID the entity belongs to
+                 * Organization ID the entity belongs to
                  * example:
                  * 206801
                  */
@@ -1560,13 +1686,19 @@ declare namespace Paths {
                  */
                 topic: string;
                 /**
-                 * Ivy User ID of who the message is assigned to. Default is the user who sends message.
+                 * 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.
+                 * Organization ID of organization read the message.
                  */
                 org_read_message?: string[];
+                /**
+                 * Whether the thread is marked as Done
+                 * example:
+                 * false
+                 */
+                done?: boolean;
                 latest_message?: Components.Schemas.Message;
                 latest_trash_message?: Components.Schemas.Message;
                 /**
@@ -1653,6 +1785,16 @@ export interface OperationMethods {
     data?: any,
     config?: AxiosRequestConfig  
   ): OperationResponse<Paths.MarkReadMessage.Responses.$204>
+  /**
+   * markReadMessageV2 - markReadMessageV2
+   * 
+   * Mark message as read within a scope
+   */
+  'markReadMessageV2'(
+    parameters?: Parameters<Paths.MarkReadMessageV2.PathParameters> | null,
+    data?: Paths.MarkReadMessageV2.RequestBody,
+    config?: AxiosRequestConfig  
+  ): OperationResponse<Paths.MarkReadMessageV2.Responses.$204>
   /**
    * markUnreadMessage - markUnreadMessage
    * 
@@ -1663,6 +1805,16 @@ export interface OperationMethods {
     data?: any,
     config?: AxiosRequestConfig  
   ): OperationResponse<Paths.MarkUnreadMessage.Responses.$204>
+  /**
+   * markUnreadMessageV2 - markUnreadMessageV2
+   * 
+   * Mark message as unread within a scope
+   */
+  'markUnreadMessageV2'(
+    parameters?: Parameters<Paths.MarkUnreadMessageV2.PathParameters> | null,
+    data?: Paths.MarkUnreadMessageV2.RequestBody,
+    config?: AxiosRequestConfig  
+  ): OperationResponse<Paths.MarkUnreadMessageV2.Responses.$204>
   /**
    * searchThreads - searchThreads
    * 
@@ -1698,6 +1850,26 @@ export interface OperationMethods {
     data?: any,
     config?: AxiosRequestConfig  
   ): OperationResponse<Paths.DeleteThread.Responses.$204>
+  /**
+   * markThreadAsDone - markThreadAsDone
+   * 
+   * Mark thread as done
+   */
+  'markThreadAsDone'(
+    parameters?: Parameters<Paths.MarkThreadAsDone.PathParameters> | null,
+    data?: any,
+    config?: AxiosRequestConfig  
+  ): OperationResponse<Paths.MarkThreadAsDone.Responses.$204>
+  /**
+   * markThreadAsOpen - markThreadAsOpen
+   * 
+   * Mark thread as open
+   */
+  'markThreadAsOpen'(
+    parameters?: Parameters<Paths.MarkThreadAsOpen.PathParameters> | null,
+    data?: any,
+    config?: AxiosRequestConfig  
+  ): OperationResponse<Paths.MarkThreadAsOpen.Responses.$204>
   /**
    * trashThread - trashThread
    * 
@@ -1728,6 +1900,16 @@ export interface OperationMethods {
     data?: any,
     config?: AxiosRequestConfig  
   ): OperationResponse<Paths.MarkReadThread.Responses.$204>
+  /**
+   * markReadThreadV2 - markReadThreadV2
+   * 
+   * Mark thread as read within a scope
+   */
+  'markReadThreadV2'(
+    parameters?: Parameters<Paths.MarkReadThreadV2.PathParameters> | null,
+    data?: Paths.MarkReadThreadV2.RequestBody,
+    config?: AxiosRequestConfig  
+  ): OperationResponse<Paths.MarkReadThreadV2.Responses.$204>
   /**
    * markUnreadThread - markUnreadThread
    * 
@@ -1738,6 +1920,16 @@ export interface OperationMethods {
     data?: any,
     config?: AxiosRequestConfig  
   ): OperationResponse<Paths.MarkUnreadThread.Responses.$204>
+  /**
+   * markUnreadThreadV2 - markUnreadThreadV2
+   * 
+   * Mark thread as unread within a scope
+   */
+  'markUnreadThreadV2'(
+    parameters?: Parameters<Paths.MarkUnreadThreadV2.PathParameters> | null,
+    data?: Paths.MarkUnreadThreadV2.RequestBody,
+    config?: AxiosRequestConfig  
+  ): OperationResponse<Paths.MarkUnreadThreadV2.Responses.$204>
   /**
    * assignThread - assignThread
    * 
@@ -1893,6 +2085,18 @@ export interface PathsDictionary {
       config?: AxiosRequestConfig  
     ): OperationResponse<Paths.MarkReadMessage.Responses.$204>
   }
+  ['/v2/message/messages/{id}/read']: {
+    /**
+     * markReadMessageV2 - markReadMessageV2
+     * 
+     * Mark message as read within a scope
+     */
+    'post'(
+      parameters?: Parameters<Paths.MarkReadMessageV2.PathParameters> | null,
+      data?: Paths.MarkReadMessageV2.RequestBody,
+      config?: AxiosRequestConfig  
+    ): OperationResponse<Paths.MarkReadMessageV2.Responses.$204>
+  }
   ['/v1/message/messages/{id}/unread']: {
     /**
      * markUnreadMessage - markUnreadMessage
@@ -1905,6 +2109,18 @@ export interface PathsDictionary {
       config?: AxiosRequestConfig  
     ): OperationResponse<Paths.MarkUnreadMessage.Responses.$204>
   }
+  ['/v2/message/messages/{id}/unread']: {
+    /**
+     * markUnreadMessageV2 - markUnreadMessageV2
+     * 
+     * Mark message as unread within a scope
+     */
+    'post'(
+      parameters?: Parameters<Paths.MarkUnreadMessageV2.PathParameters> | null,
+      data?: Paths.MarkUnreadMessageV2.RequestBody,
+      config?: AxiosRequestConfig  
+    ): OperationResponse<Paths.MarkUnreadMessageV2.Responses.$204>
+  }
   ['/v1/message/threads:search']: {
     /**
      * searchThreads - searchThreads
@@ -1946,6 +2162,30 @@ export interface PathsDictionary {
       config?: AxiosRequestConfig  
     ): OperationResponse<Paths.DeleteThread.Responses.$204>
   }
+  ['/v1/message/threads/{id}:markAsDone']: {
+    /**
+     * markThreadAsDone - markThreadAsDone
+     * 
+     * Mark thread as done
+     */
+    'post'(
+      parameters?: Parameters<Paths.MarkThreadAsDone.PathParameters> | null,
+      data?: any,
+      config?: AxiosRequestConfig  
+    ): OperationResponse<Paths.MarkThreadAsDone.Responses.$204>
+  }
+  ['/v1/message/threads/{id}:markAsOpen']: {
+    /**
+     * markThreadAsOpen - markThreadAsOpen
+     * 
+     * Mark thread as open
+     */
+    'post'(
+      parameters?: Parameters<Paths.MarkThreadAsOpen.PathParameters> | null,
+      data?: any,
+      config?: AxiosRequestConfig  
+    ): OperationResponse<Paths.MarkThreadAsOpen.Responses.$204>
+  }
   ['/v1/message/threads/{id}/trash']: {
     /**
      * trashThread - trashThread
@@ -1982,6 +2222,18 @@ export interface PathsDictionary {
       config?: AxiosRequestConfig  
     ): OperationResponse<Paths.MarkReadThread.Responses.$204>
   }
+  ['/v2/message/threads/{id}/read']: {
+    /**
+     * markReadThreadV2 - markReadThreadV2
+     * 
+     * Mark thread as read within a scope
+     */
+    'post'(
+      parameters?: Parameters<Paths.MarkReadThreadV2.PathParameters> | null,
+      data?: Paths.MarkReadThreadV2.RequestBody,
+      config?: AxiosRequestConfig  
+    ): OperationResponse<Paths.MarkReadThreadV2.Responses.$204>
+  }
   ['/v1/message/threads/{id}/unread']: {
     /**
      * markUnreadThread - markUnreadThread
@@ -1994,6 +2246,18 @@ export interface PathsDictionary {
       config?: AxiosRequestConfig  
     ): OperationResponse<Paths.MarkUnreadThread.Responses.$204>
   }
+  ['/v2/message/threads/{id}/unread']: {
+    /**
+     * markUnreadThreadV2 - markUnreadThreadV2
+     * 
+     * Mark thread as unread within a scope
+     */
+    'post'(
+      parameters?: Parameters<Paths.MarkUnreadThreadV2.PathParameters> | null,
+      data?: Paths.MarkUnreadThreadV2.RequestBody,
+      config?: AxiosRequestConfig  
+    ): OperationResponse<Paths.MarkUnreadThreadV2.Responses.$204>
+  }
   ['/v1/message/threads/{id}/assign']: {
     /**
      * assignThread - assignThread
@@ -2089,5 +2353,7 @@ export type File = Components.Schemas.File;
 export type Message = Components.Schemas.Message;
 export type MessageRequestParams = Components.Schemas.MessageRequestParams;
 export type MessageV2 = Components.Schemas.MessageV2;
+export type ReadMessagePayload = Components.Schemas.ReadMessagePayload;
+export type ReadingScope = Components.Schemas.ReadingScope;
 export type SearchParams = Components.Schemas.SearchParams;
 export type Thread = Components.Schemas.Thread;

package/dist/openapi.json

@@ -22,6 +22,33 @@
     },
     {
       "name": "Drafts"
+    },
+    {
+      "name": "message_schema",
+      "x-displayName": "Message",
+      "description": "<SchemaDefinition schemaRef=\"#/components/schemas/Message\" />\n"
+    },
+    {
+      "name": "thread_schema",
+      "x-displayName": "Thread",
+      "description": "<SchemaDefinition schemaRef=\"#/components/schemas/Thread\" />\n"
+    }
+  ],
+  "x-tagGroups": [
+    {
+      "name": "APIs",
+      "tags": [
+        "Messages",
+        "Threads",
+        "Drafts"
+      ]
+    },
+    {
+      "name": "Schemas",
+      "tags": [
+        "message_schema",
+        "thread_schema"
+      ]
     }
   ],
   "paths": {
@@ -270,6 +297,45 @@
         }
       }
     },
+    "/v2/message/messages/{id}/read": {
+      "post": {
+        "operationId": "markReadMessageV2",
+        "summary": "markReadMessageV2",
+        "description": "Mark message as read within a scope",
+        "tags": [
+          "Messages"
+        ],
+        "parameters": [
+          {
+            "name": "id",
+            "description": "Message ID",
+            "in": "path",
+            "required": true,
+            "schema": {
+              "type": "string"
+            }
+          }
+        ],
+        "requestBody": {
+          "required": true,
+          "content": {
+            "application/json": {
+              "schema": {
+                "$ref": "#/components/schemas/ReadMessagePayload"
+              }
+            }
+          }
+        },
+        "responses": {
+          "204": {
+            "description": "Success"
+          },
+          "403": {
+            "description": "Forbidden"
+          }
+        }
+      }
+    },
     "/v1/message/messages/{id}/unread": {
       "post": {
         "operationId": "markUnreadMessage",
@@ -299,6 +365,45 @@
         }
       }
     },
+    "/v2/message/messages/{id}/unread": {
+      "post": {
+        "operationId": "markUnreadMessageV2",
+        "summary": "markUnreadMessageV2",
+        "description": "Mark message as unread within a scope",
+        "tags": [
+          "Messages"
+        ],
+        "parameters": [
+          {
+            "name": "id",
+            "description": "Message ID",
+            "in": "path",
+            "required": true,
+            "schema": {
+              "type": "string"
+            }
+          }
+        ],
+        "requestBody": {
+          "required": true,
+          "content": {
+            "application/json": {
+              "schema": {
+                "$ref": "#/components/schemas/ReadMessagePayload"
+              }
+            }
+          }
+        },
+        "responses": {
+          "204": {
+            "description": "Success"
+          },
+          "403": {
+            "description": "Forbidden"
+          }
+        }
+      }
+    },
     "/v1/message/threads:search": {
       "post": {
         "operationId": "searchThreads",
@@ -419,6 +524,64 @@
         }
       }
     },
+    "/v1/message/threads/{id}:markAsDone": {
+      "post": {
+        "operationId": "markThreadAsDone",
+        "summary": "markThreadAsDone",
+        "description": "Mark thread as done",
+        "tags": [
+          "Threads"
+        ],
+        "parameters": [
+          {
+            "name": "id",
+            "description": "Thread ID",
+            "in": "path",
+            "required": true,
+            "schema": {
+              "type": "string"
+            }
+          }
+        ],
+        "responses": {
+          "204": {
+            "description": "Success"
+          },
+          "400": {
+            "description": "Bad Request"
+          }
+        }
+      }
+    },
+    "/v1/message/threads/{id}:markAsOpen": {
+      "post": {
+        "operationId": "markThreadAsOpen",
+        "summary": "markThreadAsOpen",
+        "description": "Mark thread as open",
+        "tags": [
+          "Threads"
+        ],
+        "parameters": [
+          {
+            "name": "id",
+            "description": "Thread ID",
+            "in": "path",
+            "required": true,
+            "schema": {
+              "type": "string"
+            }
+          }
+        ],
+        "responses": {
+          "204": {
+            "description": "Success"
+          },
+          "400": {
+            "description": "Bad Request"
+          }
+        }
+      }
+    },
     "/v1/message/threads/{id}/trash": {
       "post": {
         "operationId": "trashThread",
@@ -506,6 +669,45 @@
         }
       }
     },
+    "/v2/message/threads/{id}/read": {
+      "post": {
+        "operationId": "markReadThreadV2",
+        "summary": "markReadThreadV2",
+        "description": "Mark thread as read within a scope",
+        "tags": [
+          "Threads"
+        ],
+        "parameters": [
+          {
+            "name": "id",
+            "description": "Thread ID",
+            "in": "path",
+            "required": true,
+            "schema": {
+              "type": "string"
+            }
+          }
+        ],
+        "requestBody": {
+          "required": true,
+          "content": {
+            "application/json": {
+              "schema": {
+                "$ref": "#/components/schemas/ReadMessagePayload"
+              }
+            }
+          }
+        },
+        "responses": {
+          "204": {
+            "description": "Success"
+          },
+          "403": {
+            "description": "Forbidden"
+          }
+        }
+      }
+    },
     "/v1/message/threads/{id}/unread": {
       "post": {
         "operationId": "markUnreadThread",
@@ -535,6 +737,45 @@
         }
       }
     },
+    "/v2/message/threads/{id}/unread": {
+      "post": {
+        "operationId": "markUnreadThreadV2",
+        "summary": "markUnreadThreadV2",
+        "description": "Mark thread as unread within a scope",
+        "tags": [
+          "Threads"
+        ],
+        "parameters": [
+          {
+            "name": "id",
+            "description": "Thread ID",
+            "in": "path",
+            "required": true,
+            "schema": {
+              "type": "string"
+            }
+          }
+        ],
+        "requestBody": {
+          "required": true,
+          "content": {
+            "application/json": {
+              "schema": {
+                "$ref": "#/components/schemas/ReadMessagePayload"
+              }
+            }
+          }
+        },
+        "responses": {
+          "204": {
+            "description": "Success"
+          },
+          "403": {
+            "description": "Forbidden"
+          }
+        }
+      }
+    },
     "/v1/message/threads/{id}/assign": {
       "post": {
         "operationId": "assignThread",
@@ -574,6 +815,11 @@
                       "type": "string",
                       "example": "3f34ce73-089c-4d45-a5ee-c161234e41c3"
                     },
+                    "org_id": {
+                      "description": "Organization ID",
+                      "type": "string",
+                      "example": "206801"
+                    },
                     "is_main_entity": {
                       "description": "To indicate this is main entity",
                       "type": "boolean",
@@ -853,7 +1099,7 @@
           },
           "_org": {
             "type": "string",
-            "description": "Ivy Organization ID the entity belongs to",
+            "description": "Organization ID the entity belongs to",
             "example": "206801"
           },
           "_schema": {
@@ -899,7 +1145,7 @@
           },
           "assigned_to": {
             "type": "array",
-            "description": "Ivy User ID of who the message is assigned to. Default is the user who sends message.",
+            "description": "User ID of who the message is assigned to. Default is the user who sends message.",
             "items": {
               "type": "string",
               "example": [
@@ -910,7 +1156,7 @@
           },
           "org_read_message": {
             "type": "array",
-            "description": "Ivy Organization ID of organization read the message.",
+            "description": "Organization ID of organization read the message.",
             "items": {
               "type": "string",
               "example": [
@@ -919,6 +1165,11 @@
               ]
             }
           },
+          "done": {
+            "type": "boolean",
+            "description": "Whether the thread is marked as Done",
+            "example": false
+          },
           "latest_message": {
             "type": "object",
             "description": "Latest message of thread",
@@ -950,7 +1201,7 @@
           },
           "sender": {
             "type": "string",
-            "description": "Ivy User ID of user sends the message.",
+            "description": "User ID of user sends the message.",
             "example": "206801"
           },
           "subject": {
@@ -1010,7 +1261,7 @@
           },
           "user_read_message": {
             "type": "array",
-            "description": "Ivy User ID of user read the message.",
+            "description": "User ID of user read the message.",
             "items": {
               "type": "string",
               "example": [
@@ -1021,7 +1272,7 @@
           },
           "org_read_message": {
             "type": "array",
-            "description": "Ivy Organization ID of organization read the message.",
+            "description": "Organization ID of organization read the message.",
             "items": {
               "type": "string",
               "example": [
@@ -1159,6 +1410,10 @@
             "type": "boolean",
             "description": "To indicate this file relation is message attachment. If false then this file will not be sent and simply kept as a file relation."
           },
+          "may_be_signature_attachment": {
+            "type": "boolean",
+            "description": "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."
+          },
           "cid": {
             "type": "string",
             "description": "Content ID (for inline)",
@@ -1196,7 +1451,7 @@
               },
               "assigned_to": {
                 "type": "array",
-                "description": "Ivy User ID of who the message is assigned to. Default is the user who sends message.",
+                "description": "User ID of who the message is assigned to. Default is the user who sends message.",
                 "items": {
                   "type": "string"
                 }
@@ -1288,12 +1543,50 @@
             "type": "integer",
             "minimum": 1,
             "default": 10
+          },
+          "hydrate": {
+            "type": "boolean",
+            "default": false
           }
         }
+      },
+      "ReadMessagePayload": {
+        "type": "object",
+        "required": [
+          "scopes"
+        ],
+        "properties": {
+          "scopes": {
+            "description": "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"
+            ],
+            "type": "array",
+            "default": [
+              "organization",
+              "user"
+            ],
+            "items": {
+              "$ref": "#/components/schemas/ReadingScope"
+            }
+          }
+        }
+      },
+      "ReadingScope": {
+        "description": "Who is marking an item as read or unread.",
+        "type": "string",
+        "enum": [
+          "organization",
+          "user"
+        ]
       }
     }
   },
   "servers": [
+    {
+      "url": "https://message.sls.epilot.io"
+    },
     {
       "url": "https://message.sls.epilot.io"
     }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@epilot/message-client",
-  "version": "1.15.1",
+  "version": "1.15.3",
   "description": "API Client for epilot Message API",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -25,7 +25,7 @@
     "openapi": "node ../../scripts/update-openapi.js https://docs.api.epilot.io/message.yaml",
     "typegen": "openapi typegen src/openapi.json --client -b '/* eslint-disable */' > src/openapi.d.ts",
     "build": "tsc && npm run build:patch && npm run bundle-definition",
-    "build:patch": "sed -i '/^__exportStar.*openapi.*$/d' dist/index.js",
+    "build:patch": "sed -i'' -e '/^__exportStar.*openapi.*$/d' dist/index.js",
     "build:watch": "npm run build && tsc -w",
     "prepublishOnly": "npm run typegen && npm run build",
     "lint": "../../node_modules/eslint/bin/eslint.js src"
@@ -71,5 +71,5 @@
     "webpack": "^5.18.0",
     "webpack-cli": "^4.4.0"
   },
-  "gitHead": "cb7e6acc938eb178e531c19834ea8bd0d6445e6f"
-}
+  "gitHead": "39426e86cfb320fa3227dc03f60ee6a10848e7c7"
+}

package/LICENSE

@@ -1,21 +0,0 @@
-The MIT License (MIT)
-
-Copyright (c) 2022 epilot GmbH
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in
-all copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
-THE SOFTWARE.