@epilot/message-client 1.15.1 → 1.15.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md CHANGED
@@ -7,7 +7,7 @@
7
7
 
8
8
  API Client for epilot [Message API](https://docs.epilot.io/api/message).
9
9
 
10
- Uses [`openapi-client-axios`](https://github.com/anttiviljami/openapi-client-axios)
10
+ Uses [`openapi-client-axios`](https://github.com/openapistack/openapi-client-axios)
11
11
 
12
12
  ## Installation
13
13
 
@@ -86,4 +86,4 @@ const sendResponse = await messageClient.sendMessage(null, {
86
86
 
87
87
  ## Documentation
88
88
 
89
- https://docs.epilot.io/docs/messaging/message-api
89
+ https://docs.epilot.io/docs/messaging/message-api
package/dist/client.d.ts CHANGED
File without changes
package/dist/client.js CHANGED
File without changes
File without changes
@@ -1 +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})})();
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":{}}},"/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}/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/index.d.ts CHANGED
File without changes
package/dist/index.js CHANGED
File without changes
@@ -89,6 +89,25 @@
89
89
  "responses": {}
90
90
  }
91
91
  },
92
+ "/v2/message/messages/{id}/read": {
93
+ "post": {
94
+ "operationId": "markReadMessageV2",
95
+ "parameters": [
96
+ {
97
+ "name": "id",
98
+ "in": "path",
99
+ "required": true
100
+ }
101
+ ],
102
+ "requestBody": {
103
+ "required": true,
104
+ "content": {
105
+ "application/json": {}
106
+ }
107
+ },
108
+ "responses": {}
109
+ }
110
+ },
92
111
  "/v1/message/messages/{id}/unread": {
93
112
  "post": {
94
113
  "operationId": "markUnreadMessage",
@@ -102,6 +121,25 @@
102
121
  "responses": {}
103
122
  }
104
123
  },
124
+ "/v2/message/messages/{id}/unread": {
125
+ "post": {
126
+ "operationId": "markUnreadMessageV2",
127
+ "parameters": [
128
+ {
129
+ "name": "id",
130
+ "in": "path",
131
+ "required": true
132
+ }
133
+ ],
134
+ "requestBody": {
135
+ "required": true,
136
+ "content": {
137
+ "application/json": {}
138
+ }
139
+ },
140
+ "responses": {}
141
+ }
142
+ },
105
143
  "/v1/message/threads:search": {
106
144
  "post": {
107
145
  "operationId": "searchThreads",
@@ -171,6 +209,25 @@
171
209
  "responses": {}
172
210
  }
173
211
  },
212
+ "/v2/message/threads/{id}/read": {
213
+ "post": {
214
+ "operationId": "markReadThreadV2",
215
+ "parameters": [
216
+ {
217
+ "name": "id",
218
+ "in": "path",
219
+ "required": true
220
+ }
221
+ ],
222
+ "requestBody": {
223
+ "required": true,
224
+ "content": {
225
+ "application/json": {}
226
+ }
227
+ },
228
+ "responses": {}
229
+ }
230
+ },
174
231
  "/v1/message/threads/{id}/unread": {
175
232
  "post": {
176
233
  "operationId": "markUnreadThread",
@@ -184,6 +241,25 @@
184
241
  "responses": {}
185
242
  }
186
243
  },
244
+ "/v2/message/threads/{id}/unread": {
245
+ "post": {
246
+ "operationId": "markUnreadThreadV2",
247
+ "parameters": [
248
+ {
249
+ "name": "id",
250
+ "in": "path",
251
+ "required": true
252
+ }
253
+ ],
254
+ "requestBody": {
255
+ "required": true,
256
+ "content": {
257
+ "application/json": {}
258
+ }
259
+ },
260
+ "responses": {}
261
+ }
262
+ },
187
263
  "/v1/message/threads/{id}/assign": {
188
264
  "post": {
189
265
  "operationId": "assignThread",
package/dist/openapi.d.ts CHANGED
@@ -62,7 +62,7 @@ declare namespace Components {
62
62
  */
63
63
  _title: string;
64
64
  /**
65
- * Ivy Organization ID the entity belongs to
65
+ * Organization ID the entity belongs to
66
66
  * example:
67
67
  * 206801
68
68
  */
@@ -112,6 +112,10 @@ declare namespace Components {
112
112
  * To indicate this file relation is message attachment. If false then this file will not be sent and simply kept as a file relation.
113
113
  */
114
114
  is_message_attachment?: boolean;
115
+ /**
116
+ * 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.
117
+ */
118
+ may_be_signature_attachment?: boolean;
115
119
  /**
116
120
  * Content ID (for inline)
117
121
  * example:
@@ -137,7 +141,7 @@ declare namespace Components {
137
141
  */
138
142
  message_id?: string;
139
143
  /**
140
- * Ivy User ID of user sends the message.
144
+ * User ID of user sends the message.
141
145
  * example:
142
146
  * 206801
143
147
  */
@@ -190,11 +194,11 @@ declare namespace Components {
190
194
  */
191
195
  in_reply_to?: string;
192
196
  /**
193
- * Ivy User ID of user read the message.
197
+ * User ID of user read the message.
194
198
  */
195
199
  user_read_message?: string[];
196
200
  /**
197
- * Ivy Organization ID of organization read the message.
201
+ * Organization ID of organization read the message.
198
202
  */
199
203
  org_read_message?: string[];
200
204
  /**
@@ -234,7 +238,7 @@ declare namespace Components {
234
238
  */
235
239
  topic: string;
236
240
  /**
237
- * Ivy User ID of who the message is assigned to. Default is the user who sends message.
241
+ * User ID of who the message is assigned to. Default is the user who sends message.
238
242
  */
239
243
  assigned_to?: string[];
240
244
  };
@@ -297,7 +301,7 @@ declare namespace Components {
297
301
  */
298
302
  _title: string;
299
303
  /**
300
- * Ivy Organization ID the entity belongs to
304
+ * Organization ID the entity belongs to
301
305
  * example:
302
306
  * 206801
303
307
  */
@@ -336,7 +340,7 @@ declare namespace Components {
336
340
  */
337
341
  message_id?: string;
338
342
  /**
339
- * Ivy User ID of user sends the message.
343
+ * User ID of user sends the message.
340
344
  * example:
341
345
  * 206801
342
346
  */
@@ -389,11 +393,11 @@ declare namespace Components {
389
393
  */
390
394
  in_reply_to?: string;
391
395
  /**
392
- * Ivy User ID of user read the message.
396
+ * User ID of user read the message.
393
397
  */
394
398
  user_read_message?: string[];
395
399
  /**
396
- * Ivy Organization ID of organization read the message.
400
+ * Organization ID of organization read the message.
397
401
  */
398
402
  org_read_message?: string[];
399
403
  /**
@@ -422,6 +426,21 @@ declare namespace Components {
422
426
  */
423
427
  html_download_url?: string;
424
428
  }
429
+ export interface ReadMessagePayload {
430
+ /**
431
+ * The scopes to be used when marking an item as read or unread. The read status will be synced for all provided scopes.
432
+ * example:
433
+ * [
434
+ * "organization",
435
+ * "user"
436
+ * ]
437
+ */
438
+ scopes: /* Who is marking an item as read or unread. */ ReadingScope[];
439
+ }
440
+ /**
441
+ * Who is marking an item as read or unread.
442
+ */
443
+ export type ReadingScope = "organization" | "user";
425
444
  export interface SearchParams {
426
445
  /**
427
446
  * Lucene query syntax supported with ElasticSearch
@@ -443,11 +462,11 @@ declare namespace Components {
443
462
  */
444
463
  topic: string;
445
464
  /**
446
- * Ivy User ID of who the message is assigned to. Default is the user who sends message.
465
+ * User ID of who the message is assigned to. Default is the user who sends message.
447
466
  */
448
467
  assigned_to?: string[];
449
468
  /**
450
- * Ivy Organization ID of organization read the message.
469
+ * Organization ID of organization read the message.
451
470
  */
452
471
  org_read_message?: string[];
453
472
  /**
@@ -543,7 +562,7 @@ declare namespace Paths {
543
562
  */
544
563
  _title: string;
545
564
  /**
546
- * Ivy Organization ID the entity belongs to
565
+ * Organization ID the entity belongs to
547
566
  * example:
548
567
  * 206801
549
568
  */
@@ -582,7 +601,7 @@ declare namespace Paths {
582
601
  */
583
602
  message_id?: string;
584
603
  /**
585
- * Ivy User ID of user sends the message.
604
+ * User ID of user sends the message.
586
605
  * example:
587
606
  * 206801
588
607
  */
@@ -635,11 +654,11 @@ declare namespace Paths {
635
654
  */
636
655
  in_reply_to?: string;
637
656
  /**
638
- * Ivy User ID of user read the message.
657
+ * User ID of user read the message.
639
658
  */
640
659
  user_read_message?: string[];
641
660
  /**
642
- * Ivy Organization ID of organization read the message.
661
+ * Organization ID of organization read the message.
643
662
  */
644
663
  org_read_message?: string[];
645
664
  /**
@@ -718,7 +737,7 @@ declare namespace Paths {
718
737
  */
719
738
  _title: string;
720
739
  /**
721
- * Ivy Organization ID the entity belongs to
740
+ * Organization ID the entity belongs to
722
741
  * example:
723
742
  * 206801
724
743
  */
@@ -757,7 +776,7 @@ declare namespace Paths {
757
776
  */
758
777
  message_id?: string;
759
778
  /**
760
- * Ivy User ID of user sends the message.
779
+ * User ID of user sends the message.
761
780
  * example:
762
781
  * 206801
763
782
  */
@@ -810,11 +829,11 @@ declare namespace Paths {
810
829
  */
811
830
  in_reply_to?: string;
812
831
  /**
813
- * Ivy User ID of user read the message.
832
+ * User ID of user read the message.
814
833
  */
815
834
  user_read_message?: string[];
816
835
  /**
817
- * Ivy Organization ID of organization read the message.
836
+ * Organization ID of organization read the message.
818
837
  */
819
838
  org_read_message?: string[];
820
839
  /**
@@ -867,7 +886,7 @@ declare namespace Paths {
867
886
  */
868
887
  _title: string;
869
888
  /**
870
- * Ivy Organization ID the entity belongs to
889
+ * Organization ID the entity belongs to
871
890
  * example:
872
891
  * 206801
873
892
  */
@@ -906,7 +925,7 @@ declare namespace Paths {
906
925
  */
907
926
  message_id?: string;
908
927
  /**
909
- * Ivy User ID of user sends the message.
928
+ * User ID of user sends the message.
910
929
  * example:
911
930
  * 206801
912
931
  */
@@ -959,11 +978,11 @@ declare namespace Paths {
959
978
  */
960
979
  in_reply_to?: string;
961
980
  /**
962
- * Ivy User ID of user read the message.
981
+ * User ID of user read the message.
963
982
  */
964
983
  user_read_message?: string[];
965
984
  /**
966
- * Ivy Organization ID of organization read the message.
985
+ * Organization ID of organization read the message.
967
986
  */
968
987
  org_read_message?: string[];
969
988
  /**
@@ -1010,6 +1029,21 @@ declare namespace Paths {
1010
1029
  }
1011
1030
  }
1012
1031
  }
1032
+ namespace MarkReadMessageV2 {
1033
+ namespace Parameters {
1034
+ export type Id = string;
1035
+ }
1036
+ export interface PathParameters {
1037
+ id: Parameters.Id;
1038
+ }
1039
+ export type RequestBody = Components.Schemas.ReadMessagePayload;
1040
+ namespace Responses {
1041
+ export interface $204 {
1042
+ }
1043
+ export interface $403 {
1044
+ }
1045
+ }
1046
+ }
1013
1047
  namespace MarkReadThread {
1014
1048
  namespace Parameters {
1015
1049
  export type Id = string;
@@ -1024,6 +1058,21 @@ declare namespace Paths {
1024
1058
  }
1025
1059
  }
1026
1060
  }
1061
+ namespace MarkReadThreadV2 {
1062
+ namespace Parameters {
1063
+ export type Id = string;
1064
+ }
1065
+ export interface PathParameters {
1066
+ id: Parameters.Id;
1067
+ }
1068
+ export type RequestBody = Components.Schemas.ReadMessagePayload;
1069
+ namespace Responses {
1070
+ export interface $204 {
1071
+ }
1072
+ export interface $403 {
1073
+ }
1074
+ }
1075
+ }
1027
1076
  namespace MarkUnreadMessage {
1028
1077
  namespace Parameters {
1029
1078
  export type Id = string;
@@ -1038,6 +1087,21 @@ declare namespace Paths {
1038
1087
  }
1039
1088
  }
1040
1089
  }
1090
+ namespace MarkUnreadMessageV2 {
1091
+ namespace Parameters {
1092
+ export type Id = string;
1093
+ }
1094
+ export interface PathParameters {
1095
+ id: Parameters.Id;
1096
+ }
1097
+ export type RequestBody = Components.Schemas.ReadMessagePayload;
1098
+ namespace Responses {
1099
+ export interface $204 {
1100
+ }
1101
+ export interface $403 {
1102
+ }
1103
+ }
1104
+ }
1041
1105
  namespace MarkUnreadThread {
1042
1106
  namespace Parameters {
1043
1107
  export type Id = string;
@@ -1052,6 +1116,21 @@ declare namespace Paths {
1052
1116
  }
1053
1117
  }
1054
1118
  }
1119
+ namespace MarkUnreadThreadV2 {
1120
+ namespace Parameters {
1121
+ export type Id = string;
1122
+ }
1123
+ export interface PathParameters {
1124
+ id: Parameters.Id;
1125
+ }
1126
+ export type RequestBody = Components.Schemas.ReadMessagePayload;
1127
+ namespace Responses {
1128
+ export interface $204 {
1129
+ }
1130
+ export interface $403 {
1131
+ }
1132
+ }
1133
+ }
1055
1134
  namespace SearchThreads {
1056
1135
  export type RequestBody = Components.Schemas.SearchParams;
1057
1136
  namespace Responses {
@@ -1077,7 +1156,7 @@ declare namespace Paths {
1077
1156
  */
1078
1157
  _title: string;
1079
1158
  /**
1080
- * Ivy Organization ID the entity belongs to
1159
+ * Organization ID the entity belongs to
1081
1160
  * example:
1082
1161
  * 206801
1083
1162
  */
@@ -1116,11 +1195,11 @@ declare namespace Paths {
1116
1195
  */
1117
1196
  topic: string;
1118
1197
  /**
1119
- * Ivy User ID of who the message is assigned to. Default is the user who sends message.
1198
+ * User ID of who the message is assigned to. Default is the user who sends message.
1120
1199
  */
1121
1200
  assigned_to?: string[];
1122
1201
  /**
1123
- * Ivy Organization ID of organization read the message.
1202
+ * Organization ID of organization read the message.
1124
1203
  */
1125
1204
  org_read_message?: string[];
1126
1205
  latest_message?: Components.Schemas.Message;
@@ -1151,7 +1230,7 @@ declare namespace Paths {
1151
1230
  */
1152
1231
  _title: string;
1153
1232
  /**
1154
- * Ivy Organization ID the entity belongs to
1233
+ * Organization ID the entity belongs to
1155
1234
  * example:
1156
1235
  * 206801
1157
1236
  */
@@ -1190,7 +1269,7 @@ declare namespace Paths {
1190
1269
  */
1191
1270
  message_id?: string;
1192
1271
  /**
1193
- * Ivy User ID of user sends the message.
1272
+ * User ID of user sends the message.
1194
1273
  * example:
1195
1274
  * 206801
1196
1275
  */
@@ -1243,11 +1322,11 @@ declare namespace Paths {
1243
1322
  */
1244
1323
  in_reply_to?: string;
1245
1324
  /**
1246
- * Ivy User ID of user read the message.
1325
+ * User ID of user read the message.
1247
1326
  */
1248
1327
  user_read_message?: string[];
1249
1328
  /**
1250
- * Ivy Organization ID of organization read the message.
1329
+ * Organization ID of organization read the message.
1251
1330
  */
1252
1331
  org_read_message?: string[];
1253
1332
  /**
@@ -1385,7 +1464,7 @@ declare namespace Paths {
1385
1464
  */
1386
1465
  _title: string;
1387
1466
  /**
1388
- * Ivy Organization ID the entity belongs to
1467
+ * Organization ID the entity belongs to
1389
1468
  * example:
1390
1469
  * 206801
1391
1470
  */
@@ -1424,7 +1503,7 @@ declare namespace Paths {
1424
1503
  */
1425
1504
  message_id?: string;
1426
1505
  /**
1427
- * Ivy User ID of user sends the message.
1506
+ * User ID of user sends the message.
1428
1507
  * example:
1429
1508
  * 206801
1430
1509
  */
@@ -1477,11 +1556,11 @@ declare namespace Paths {
1477
1556
  */
1478
1557
  in_reply_to?: string;
1479
1558
  /**
1480
- * Ivy User ID of user read the message.
1559
+ * User ID of user read the message.
1481
1560
  */
1482
1561
  user_read_message?: string[];
1483
1562
  /**
1484
- * Ivy Organization ID of organization read the message.
1563
+ * Organization ID of organization read the message.
1485
1564
  */
1486
1565
  org_read_message?: string[];
1487
1566
  /**
@@ -1521,7 +1600,7 @@ declare namespace Paths {
1521
1600
  */
1522
1601
  _title: string;
1523
1602
  /**
1524
- * Ivy Organization ID the entity belongs to
1603
+ * Organization ID the entity belongs to
1525
1604
  * example:
1526
1605
  * 206801
1527
1606
  */
@@ -1560,11 +1639,11 @@ declare namespace Paths {
1560
1639
  */
1561
1640
  topic: string;
1562
1641
  /**
1563
- * Ivy User ID of who the message is assigned to. Default is the user who sends message.
1642
+ * User ID of who the message is assigned to. Default is the user who sends message.
1564
1643
  */
1565
1644
  assigned_to?: string[];
1566
1645
  /**
1567
- * Ivy Organization ID of organization read the message.
1646
+ * Organization ID of organization read the message.
1568
1647
  */
1569
1648
  org_read_message?: string[];
1570
1649
  latest_message?: Components.Schemas.Message;
@@ -1653,6 +1732,16 @@ export interface OperationMethods {
1653
1732
  data?: any,
1654
1733
  config?: AxiosRequestConfig
1655
1734
  ): OperationResponse<Paths.MarkReadMessage.Responses.$204>
1735
+ /**
1736
+ * markReadMessageV2 - markReadMessageV2
1737
+ *
1738
+ * Mark message as read within a scope
1739
+ */
1740
+ 'markReadMessageV2'(
1741
+ parameters?: Parameters<Paths.MarkReadMessageV2.PathParameters> | null,
1742
+ data?: Paths.MarkReadMessageV2.RequestBody,
1743
+ config?: AxiosRequestConfig
1744
+ ): OperationResponse<Paths.MarkReadMessageV2.Responses.$204>
1656
1745
  /**
1657
1746
  * markUnreadMessage - markUnreadMessage
1658
1747
  *
@@ -1663,6 +1752,16 @@ export interface OperationMethods {
1663
1752
  data?: any,
1664
1753
  config?: AxiosRequestConfig
1665
1754
  ): OperationResponse<Paths.MarkUnreadMessage.Responses.$204>
1755
+ /**
1756
+ * markUnreadMessageV2 - markUnreadMessageV2
1757
+ *
1758
+ * Mark message as unread within a scope
1759
+ */
1760
+ 'markUnreadMessageV2'(
1761
+ parameters?: Parameters<Paths.MarkUnreadMessageV2.PathParameters> | null,
1762
+ data?: Paths.MarkUnreadMessageV2.RequestBody,
1763
+ config?: AxiosRequestConfig
1764
+ ): OperationResponse<Paths.MarkUnreadMessageV2.Responses.$204>
1666
1765
  /**
1667
1766
  * searchThreads - searchThreads
1668
1767
  *
@@ -1728,6 +1827,16 @@ export interface OperationMethods {
1728
1827
  data?: any,
1729
1828
  config?: AxiosRequestConfig
1730
1829
  ): OperationResponse<Paths.MarkReadThread.Responses.$204>
1830
+ /**
1831
+ * markReadThreadV2 - markReadThreadV2
1832
+ *
1833
+ * Mark thread as read within a scope
1834
+ */
1835
+ 'markReadThreadV2'(
1836
+ parameters?: Parameters<Paths.MarkReadThreadV2.PathParameters> | null,
1837
+ data?: Paths.MarkReadThreadV2.RequestBody,
1838
+ config?: AxiosRequestConfig
1839
+ ): OperationResponse<Paths.MarkReadThreadV2.Responses.$204>
1731
1840
  /**
1732
1841
  * markUnreadThread - markUnreadThread
1733
1842
  *
@@ -1738,6 +1847,16 @@ export interface OperationMethods {
1738
1847
  data?: any,
1739
1848
  config?: AxiosRequestConfig
1740
1849
  ): OperationResponse<Paths.MarkUnreadThread.Responses.$204>
1850
+ /**
1851
+ * markUnreadThreadV2 - markUnreadThreadV2
1852
+ *
1853
+ * Mark thread as unread within a scope
1854
+ */
1855
+ 'markUnreadThreadV2'(
1856
+ parameters?: Parameters<Paths.MarkUnreadThreadV2.PathParameters> | null,
1857
+ data?: Paths.MarkUnreadThreadV2.RequestBody,
1858
+ config?: AxiosRequestConfig
1859
+ ): OperationResponse<Paths.MarkUnreadThreadV2.Responses.$204>
1741
1860
  /**
1742
1861
  * assignThread - assignThread
1743
1862
  *
@@ -1893,6 +2012,18 @@ export interface PathsDictionary {
1893
2012
  config?: AxiosRequestConfig
1894
2013
  ): OperationResponse<Paths.MarkReadMessage.Responses.$204>
1895
2014
  }
2015
+ ['/v2/message/messages/{id}/read']: {
2016
+ /**
2017
+ * markReadMessageV2 - markReadMessageV2
2018
+ *
2019
+ * Mark message as read within a scope
2020
+ */
2021
+ 'post'(
2022
+ parameters?: Parameters<Paths.MarkReadMessageV2.PathParameters> | null,
2023
+ data?: Paths.MarkReadMessageV2.RequestBody,
2024
+ config?: AxiosRequestConfig
2025
+ ): OperationResponse<Paths.MarkReadMessageV2.Responses.$204>
2026
+ }
1896
2027
  ['/v1/message/messages/{id}/unread']: {
1897
2028
  /**
1898
2029
  * markUnreadMessage - markUnreadMessage
@@ -1905,6 +2036,18 @@ export interface PathsDictionary {
1905
2036
  config?: AxiosRequestConfig
1906
2037
  ): OperationResponse<Paths.MarkUnreadMessage.Responses.$204>
1907
2038
  }
2039
+ ['/v2/message/messages/{id}/unread']: {
2040
+ /**
2041
+ * markUnreadMessageV2 - markUnreadMessageV2
2042
+ *
2043
+ * Mark message as unread within a scope
2044
+ */
2045
+ 'post'(
2046
+ parameters?: Parameters<Paths.MarkUnreadMessageV2.PathParameters> | null,
2047
+ data?: Paths.MarkUnreadMessageV2.RequestBody,
2048
+ config?: AxiosRequestConfig
2049
+ ): OperationResponse<Paths.MarkUnreadMessageV2.Responses.$204>
2050
+ }
1908
2051
  ['/v1/message/threads:search']: {
1909
2052
  /**
1910
2053
  * searchThreads - searchThreads
@@ -1982,6 +2125,18 @@ export interface PathsDictionary {
1982
2125
  config?: AxiosRequestConfig
1983
2126
  ): OperationResponse<Paths.MarkReadThread.Responses.$204>
1984
2127
  }
2128
+ ['/v2/message/threads/{id}/read']: {
2129
+ /**
2130
+ * markReadThreadV2 - markReadThreadV2
2131
+ *
2132
+ * Mark thread as read within a scope
2133
+ */
2134
+ 'post'(
2135
+ parameters?: Parameters<Paths.MarkReadThreadV2.PathParameters> | null,
2136
+ data?: Paths.MarkReadThreadV2.RequestBody,
2137
+ config?: AxiosRequestConfig
2138
+ ): OperationResponse<Paths.MarkReadThreadV2.Responses.$204>
2139
+ }
1985
2140
  ['/v1/message/threads/{id}/unread']: {
1986
2141
  /**
1987
2142
  * markUnreadThread - markUnreadThread
@@ -1994,6 +2149,18 @@ export interface PathsDictionary {
1994
2149
  config?: AxiosRequestConfig
1995
2150
  ): OperationResponse<Paths.MarkUnreadThread.Responses.$204>
1996
2151
  }
2152
+ ['/v2/message/threads/{id}/unread']: {
2153
+ /**
2154
+ * markUnreadThreadV2 - markUnreadThreadV2
2155
+ *
2156
+ * Mark thread as unread within a scope
2157
+ */
2158
+ 'post'(
2159
+ parameters?: Parameters<Paths.MarkUnreadThreadV2.PathParameters> | null,
2160
+ data?: Paths.MarkUnreadThreadV2.RequestBody,
2161
+ config?: AxiosRequestConfig
2162
+ ): OperationResponse<Paths.MarkUnreadThreadV2.Responses.$204>
2163
+ }
1997
2164
  ['/v1/message/threads/{id}/assign']: {
1998
2165
  /**
1999
2166
  * assignThread - assignThread
@@ -2089,5 +2256,7 @@ export type File = Components.Schemas.File;
2089
2256
  export type Message = Components.Schemas.Message;
2090
2257
  export type MessageRequestParams = Components.Schemas.MessageRequestParams;
2091
2258
  export type MessageV2 = Components.Schemas.MessageV2;
2259
+ export type ReadMessagePayload = Components.Schemas.ReadMessagePayload;
2260
+ export type ReadingScope = Components.Schemas.ReadingScope;
2092
2261
  export type SearchParams = Components.Schemas.SearchParams;
2093
2262
  export type Thread = Components.Schemas.Thread;
package/dist/openapi.json CHANGED
@@ -270,6 +270,45 @@
270
270
  }
271
271
  }
272
272
  },
273
+ "/v2/message/messages/{id}/read": {
274
+ "post": {
275
+ "operationId": "markReadMessageV2",
276
+ "summary": "markReadMessageV2",
277
+ "description": "Mark message as read within a scope",
278
+ "tags": [
279
+ "Messages"
280
+ ],
281
+ "parameters": [
282
+ {
283
+ "name": "id",
284
+ "description": "Message ID",
285
+ "in": "path",
286
+ "required": true,
287
+ "schema": {
288
+ "type": "string"
289
+ }
290
+ }
291
+ ],
292
+ "requestBody": {
293
+ "required": true,
294
+ "content": {
295
+ "application/json": {
296
+ "schema": {
297
+ "$ref": "#/components/schemas/ReadMessagePayload"
298
+ }
299
+ }
300
+ }
301
+ },
302
+ "responses": {
303
+ "204": {
304
+ "description": "Success"
305
+ },
306
+ "403": {
307
+ "description": "Forbidden"
308
+ }
309
+ }
310
+ }
311
+ },
273
312
  "/v1/message/messages/{id}/unread": {
274
313
  "post": {
275
314
  "operationId": "markUnreadMessage",
@@ -299,6 +338,45 @@
299
338
  }
300
339
  }
301
340
  },
341
+ "/v2/message/messages/{id}/unread": {
342
+ "post": {
343
+ "operationId": "markUnreadMessageV2",
344
+ "summary": "markUnreadMessageV2",
345
+ "description": "Mark message as unread within a scope",
346
+ "tags": [
347
+ "Messages"
348
+ ],
349
+ "parameters": [
350
+ {
351
+ "name": "id",
352
+ "description": "Message ID",
353
+ "in": "path",
354
+ "required": true,
355
+ "schema": {
356
+ "type": "string"
357
+ }
358
+ }
359
+ ],
360
+ "requestBody": {
361
+ "required": true,
362
+ "content": {
363
+ "application/json": {
364
+ "schema": {
365
+ "$ref": "#/components/schemas/ReadMessagePayload"
366
+ }
367
+ }
368
+ }
369
+ },
370
+ "responses": {
371
+ "204": {
372
+ "description": "Success"
373
+ },
374
+ "403": {
375
+ "description": "Forbidden"
376
+ }
377
+ }
378
+ }
379
+ },
302
380
  "/v1/message/threads:search": {
303
381
  "post": {
304
382
  "operationId": "searchThreads",
@@ -506,6 +584,45 @@
506
584
  }
507
585
  }
508
586
  },
587
+ "/v2/message/threads/{id}/read": {
588
+ "post": {
589
+ "operationId": "markReadThreadV2",
590
+ "summary": "markReadThreadV2",
591
+ "description": "Mark thread as read within a scope",
592
+ "tags": [
593
+ "Threads"
594
+ ],
595
+ "parameters": [
596
+ {
597
+ "name": "id",
598
+ "description": "Thread ID",
599
+ "in": "path",
600
+ "required": true,
601
+ "schema": {
602
+ "type": "string"
603
+ }
604
+ }
605
+ ],
606
+ "requestBody": {
607
+ "required": true,
608
+ "content": {
609
+ "application/json": {
610
+ "schema": {
611
+ "$ref": "#/components/schemas/ReadMessagePayload"
612
+ }
613
+ }
614
+ }
615
+ },
616
+ "responses": {
617
+ "204": {
618
+ "description": "Success"
619
+ },
620
+ "403": {
621
+ "description": "Forbidden"
622
+ }
623
+ }
624
+ }
625
+ },
509
626
  "/v1/message/threads/{id}/unread": {
510
627
  "post": {
511
628
  "operationId": "markUnreadThread",
@@ -535,6 +652,45 @@
535
652
  }
536
653
  }
537
654
  },
655
+ "/v2/message/threads/{id}/unread": {
656
+ "post": {
657
+ "operationId": "markUnreadThreadV2",
658
+ "summary": "markUnreadThreadV2",
659
+ "description": "Mark thread as unread within a scope",
660
+ "tags": [
661
+ "Threads"
662
+ ],
663
+ "parameters": [
664
+ {
665
+ "name": "id",
666
+ "description": "Thread ID",
667
+ "in": "path",
668
+ "required": true,
669
+ "schema": {
670
+ "type": "string"
671
+ }
672
+ }
673
+ ],
674
+ "requestBody": {
675
+ "required": true,
676
+ "content": {
677
+ "application/json": {
678
+ "schema": {
679
+ "$ref": "#/components/schemas/ReadMessagePayload"
680
+ }
681
+ }
682
+ }
683
+ },
684
+ "responses": {
685
+ "204": {
686
+ "description": "Success"
687
+ },
688
+ "403": {
689
+ "description": "Forbidden"
690
+ }
691
+ }
692
+ }
693
+ },
538
694
  "/v1/message/threads/{id}/assign": {
539
695
  "post": {
540
696
  "operationId": "assignThread",
@@ -853,7 +1009,7 @@
853
1009
  },
854
1010
  "_org": {
855
1011
  "type": "string",
856
- "description": "Ivy Organization ID the entity belongs to",
1012
+ "description": "Organization ID the entity belongs to",
857
1013
  "example": "206801"
858
1014
  },
859
1015
  "_schema": {
@@ -899,7 +1055,7 @@
899
1055
  },
900
1056
  "assigned_to": {
901
1057
  "type": "array",
902
- "description": "Ivy User ID of who the message is assigned to. Default is the user who sends message.",
1058
+ "description": "User ID of who the message is assigned to. Default is the user who sends message.",
903
1059
  "items": {
904
1060
  "type": "string",
905
1061
  "example": [
@@ -910,7 +1066,7 @@
910
1066
  },
911
1067
  "org_read_message": {
912
1068
  "type": "array",
913
- "description": "Ivy Organization ID of organization read the message.",
1069
+ "description": "Organization ID of organization read the message.",
914
1070
  "items": {
915
1071
  "type": "string",
916
1072
  "example": [
@@ -950,7 +1106,7 @@
950
1106
  },
951
1107
  "sender": {
952
1108
  "type": "string",
953
- "description": "Ivy User ID of user sends the message.",
1109
+ "description": "User ID of user sends the message.",
954
1110
  "example": "206801"
955
1111
  },
956
1112
  "subject": {
@@ -1010,7 +1166,7 @@
1010
1166
  },
1011
1167
  "user_read_message": {
1012
1168
  "type": "array",
1013
- "description": "Ivy User ID of user read the message.",
1169
+ "description": "User ID of user read the message.",
1014
1170
  "items": {
1015
1171
  "type": "string",
1016
1172
  "example": [
@@ -1021,7 +1177,7 @@
1021
1177
  },
1022
1178
  "org_read_message": {
1023
1179
  "type": "array",
1024
- "description": "Ivy Organization ID of organization read the message.",
1180
+ "description": "Organization ID of organization read the message.",
1025
1181
  "items": {
1026
1182
  "type": "string",
1027
1183
  "example": [
@@ -1159,6 +1315,10 @@
1159
1315
  "type": "boolean",
1160
1316
  "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."
1161
1317
  },
1318
+ "may_be_signature_attachment": {
1319
+ "type": "boolean",
1320
+ "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."
1321
+ },
1162
1322
  "cid": {
1163
1323
  "type": "string",
1164
1324
  "description": "Content ID (for inline)",
@@ -1196,7 +1356,7 @@
1196
1356
  },
1197
1357
  "assigned_to": {
1198
1358
  "type": "array",
1199
- "description": "Ivy User ID of who the message is assigned to. Default is the user who sends message.",
1359
+ "description": "User ID of who the message is assigned to. Default is the user who sends message.",
1200
1360
  "items": {
1201
1361
  "type": "string"
1202
1362
  }
@@ -1290,10 +1450,44 @@
1290
1450
  "default": 10
1291
1451
  }
1292
1452
  }
1453
+ },
1454
+ "ReadMessagePayload": {
1455
+ "type": "object",
1456
+ "required": [
1457
+ "scopes"
1458
+ ],
1459
+ "properties": {
1460
+ "scopes": {
1461
+ "description": "The scopes to be used when marking an item as read or unread. The read status will be synced for all provided scopes.",
1462
+ "example": [
1463
+ "organization",
1464
+ "user"
1465
+ ],
1466
+ "type": "array",
1467
+ "default": [
1468
+ "organization",
1469
+ "user"
1470
+ ],
1471
+ "items": {
1472
+ "$ref": "#/components/schemas/ReadingScope"
1473
+ }
1474
+ }
1475
+ }
1476
+ },
1477
+ "ReadingScope": {
1478
+ "description": "Who is marking an item as read or unread.",
1479
+ "type": "string",
1480
+ "enum": [
1481
+ "organization",
1482
+ "user"
1483
+ ]
1293
1484
  }
1294
1485
  }
1295
1486
  },
1296
1487
  "servers": [
1488
+ {
1489
+ "url": "https://message.sls.epilot.io"
1490
+ },
1297
1491
  {
1298
1492
  "url": "https://message.sls.epilot.io"
1299
1493
  }
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@epilot/message-client",
3
- "version": "1.15.1",
3
+ "version": "1.15.2",
4
4
  "description": "API Client for epilot Message API",
5
5
  "main": "dist/index.js",
6
6
  "types": "dist/index.d.ts",
@@ -25,7 +25,7 @@
25
25
  "openapi": "node ../../scripts/update-openapi.js https://docs.api.epilot.io/message.yaml",
26
26
  "typegen": "openapi typegen src/openapi.json --client -b '/* eslint-disable */' > src/openapi.d.ts",
27
27
  "build": "tsc && npm run build:patch && npm run bundle-definition",
28
- "build:patch": "sed -i '/^__exportStar.*openapi.*$/d' dist/index.js",
28
+ "build:patch": "sed -i'' -e '/^__exportStar.*openapi.*$/d' dist/index.js",
29
29
  "build:watch": "npm run build && tsc -w",
30
30
  "prepublishOnly": "npm run typegen && npm run build",
31
31
  "lint": "../../node_modules/eslint/bin/eslint.js src"
@@ -71,5 +71,5 @@
71
71
  "webpack": "^5.18.0",
72
72
  "webpack-cli": "^4.4.0"
73
73
  },
74
- "gitHead": "cb7e6acc938eb178e531c19834ea8bd0d6445e6f"
74
+ "gitHead": "39426e86cfb320fa3227dc03f60ee6a10848e7c7"
75
75
  }
package/LICENSE DELETED
@@ -1,21 +0,0 @@
1
- The MIT License (MIT)
2
-
3
- Copyright (c) 2022 epilot GmbH
4
-
5
- Permission is hereby granted, free of charge, to any person obtaining a copy
6
- of this software and associated documentation files (the "Software"), to deal
7
- in the Software without restriction, including without limitation the rights
8
- to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
- copies of the Software, and to permit persons to whom the Software is
10
- furnished to do so, subject to the following conditions:
11
-
12
- The above copyright notice and this permission notice shall be included in
13
- all copies or substantial portions of the Software.
14
-
15
- THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
- IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
- FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
- AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
- LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
- OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
21
- THE SOFTWARE.