@epilot/message-client 1.8.0 → 1.10.0

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.
@@ -1 +1 @@
1
- (()=>{"use strict";var e={914:function(e,a,r){var s=this&&this.__importDefault||function(e){return e&&e.__esModule?e:{default:e}};Object.defineProperty(a,"__esModule",{value:!0});var t=s(r(240));a.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":{}}}},"put":{"operationId":"updateMessage"}},"/v1/message/messages/{id}":{"get":{"operationId":"getMessage","parameters":[{"name":"id","in":"path","required":true}]},"delete":{"operationId":"deleteMessage","parameters":[{"name":"id","in":"path","required":true}]}},"/v1/message/messages/{id}/trash":{"post":{"operationId":"trashMessage","parameters":[{"name":"id","in":"path","required":true}]}},"/v1/message/messages/{id}/untrash":{"post":{"operationId":"untrashMessage","parameters":[{"name":"id","in":"path","required":true}]}},"/v1/message/messages/{id}/read":{"post":{"operationId":"markReadMessage","parameters":[{"name":"id","in":"path","required":true}]}},"/v1/message/messages/{id}/unread":{"post":{"operationId":"markUnreadMessage","parameters":[{"name":"id","in":"path","required":true}]}},"/v1/message/threads:search":{"post":{"operationId":"searchThreads","requestBody":{"content":{"application/json":{}}}}},"/v1/message/threads":{"put":{"operationId":"updateThread"}},"/v1/message/threads/{id}":{"delete":{"operationId":"deleteThread","parameters":[{"name":"id","in":"path","required":true}]}},"/v1/message/threads/{id}/trash":{"post":{"operationId":"trashThread","parameters":[{"name":"id","in":"path","required":true}]}},"/v1/message/threads/{id}/untrash":{"post":{"operationId":"untrashThread","parameters":[{"name":"id","in":"path","required":true}]}},"/v1/message/threads/{id}/read":{"post":{"operationId":"markReadThread","parameters":[{"name":"id","in":"path","required":true}]}},"/v1/message/threads/{id}/unread":{"post":{"operationId":"markUnreadThread","parameters":[{"name":"id","in":"path","required":true}]}},"/v1/message/threads/{id}/assign":{"post":{"operationId":"assignThread","parameters":[{"name":"id","in":"path","required":true}],"requestBody":{"required":true,"content":{"application/json":{}}}}},"/v1/message/threads/{id}/assign:users":{"post":{"operationId":"assignUsers","parameters":[{"name":"id","in":"path","required":true}],"requestBody":{"required":true,"content":{"application/json":{}}}}},"/v1/message/drafts":{"post":{"operationId":"createDraft","requestBody":{"content":{"application/json":{}}}}},"/v1/message/drafts:send":{"post":{"operationId":"sendDraft"}},"/v2/message/messages/{id}":{"get":{"operationId":"getMessageV2","parameters":[{"name":"id","in":"path","required":true}]}}},"components":{},"servers":[{"url":"https://message.sls.epilot.io"}]}')}},a={},r=function r(s){var t=a[s];if(void 0!==t)return t.exports;var d=a[s]={exports:{}};return e[s].call(d.exports,d,d.exports,r),d.exports}(914),s=exports;for(var t in r)s[t]=r[t];r.__esModule&&Object.defineProperty(s,"__esModule",{value:!0})})();
1
+ (()=>{"use strict";var e={914:function(e,a,r){var s=this&&this.__importDefault||function(e){return e&&e.__esModule?e:{default:e}};Object.defineProperty(a,"__esModule",{value:!0});var t=s(r(240));a.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":{}}}},"put":{"operationId":"updateMessage"}},"/v1/message/messages/{id}":{"get":{"operationId":"getMessage","parameters":[{"name":"id","in":"path","required":true}]},"delete":{"operationId":"deleteMessage","parameters":[{"name":"id","in":"path","required":true}]}},"/v1/message/messages/{id}/trash":{"post":{"operationId":"trashMessage","parameters":[{"name":"id","in":"path","required":true}]}},"/v1/message/messages/{id}/untrash":{"post":{"operationId":"untrashMessage","parameters":[{"name":"id","in":"path","required":true}]}},"/v1/message/messages/{id}/read":{"post":{"operationId":"markReadMessage","parameters":[{"name":"id","in":"path","required":true}]}},"/v1/message/messages/{id}/unread":{"post":{"operationId":"markUnreadMessage","parameters":[{"name":"id","in":"path","required":true}]}},"/v1/message/threads:search":{"post":{"operationId":"searchThreads","requestBody":{"content":{"application/json":{}}}}},"/v1/message/threads":{"put":{"operationId":"updateThread"}},"/v1/message/threads/{id}":{"delete":{"operationId":"deleteThread","parameters":[{"name":"id","in":"path","required":true}]}},"/v1/message/threads/{id}/trash":{"post":{"operationId":"trashThread","parameters":[{"name":"id","in":"path","required":true}]}},"/v1/message/threads/{id}/untrash":{"post":{"operationId":"untrashThread","parameters":[{"name":"id","in":"path","required":true}]}},"/v1/message/threads/{id}/read":{"post":{"operationId":"markReadThread","parameters":[{"name":"id","in":"path","required":true}]}},"/v1/message/threads/{id}/unread":{"post":{"operationId":"markUnreadThread","parameters":[{"name":"id","in":"path","required":true}]}},"/v1/message/threads/{id}/assign":{"post":{"operationId":"assignThread","parameters":[{"name":"id","in":"path","required":true}],"requestBody":{"required":true,"content":{"application/json":{}}}}},"/v1/message/threads/{id}/assign:users":{"post":{"operationId":"assignUsers","parameters":[{"name":"id","in":"path","required":true}],"requestBody":{"required":true,"content":{"application/json":{}}}}},"/v1/message/drafts":{"post":{"operationId":"createDraft","requestBody":{"content":{"application/json":{}}}}},"/v1/message/drafts:send":{"post":{"operationId":"sendDraft"}},"/v2/message/messages/{id}":{"get":{"operationId":"getMessageV2","parameters":[{"name":"id","in":"path","required":true}]}},"/v1/message/messages/{messageId}/genai:reply":{"post":{"operationId":"generateSuggestedReply","parameters":[{"name":"messageId","in":"path","required":true},{"name":"threadId","in":"query","required":true}]}},"/v1/message/threads/{threadId}/genai:info":{"get":{"operationId":"getInfo","parameters":[{"name":"threadId","in":"path","required":true},{"name":"messageId","in":"query"}]}},"/v1/message/threads/{threadId}/messages/{messageId}/genai:info":{"patch":{"operationId":"patchInfo","parameters":[{"name":"threadId","in":"path","required":true},{"name":"messageId","in":"path","required":true}],"requestBody":{"required":true,"content":{"application/json":{}}}}}},"components":{},"servers":[{"url":"https://message.sls.epilot.io"}]}')}},a={},r=function r(s){var t=a[s];if(void 0!==t)return t.exports;var d=a[s]={exports:{}};return e[s].call(d.exports,d,d.exports,r),d.exports}(914),s=exports;for(var t in r)s[t]=r[t];r.__esModule&&Object.defineProperty(s,"__esModule",{value:!0})})();
@@ -231,6 +231,62 @@
231
231
  }
232
232
  ]
233
233
  }
234
+ },
235
+ "/v1/message/messages/{messageId}/genai:reply": {
236
+ "post": {
237
+ "operationId": "generateSuggestedReply",
238
+ "parameters": [
239
+ {
240
+ "name": "messageId",
241
+ "in": "path",
242
+ "required": true
243
+ },
244
+ {
245
+ "name": "threadId",
246
+ "in": "query",
247
+ "required": true
248
+ }
249
+ ]
250
+ }
251
+ },
252
+ "/v1/message/threads/{threadId}/genai:info": {
253
+ "get": {
254
+ "operationId": "getInfo",
255
+ "parameters": [
256
+ {
257
+ "name": "threadId",
258
+ "in": "path",
259
+ "required": true
260
+ },
261
+ {
262
+ "name": "messageId",
263
+ "in": "query"
264
+ }
265
+ ]
266
+ }
267
+ },
268
+ "/v1/message/threads/{threadId}/messages/{messageId}/genai:info": {
269
+ "patch": {
270
+ "operationId": "patchInfo",
271
+ "parameters": [
272
+ {
273
+ "name": "threadId",
274
+ "in": "path",
275
+ "required": true
276
+ },
277
+ {
278
+ "name": "messageId",
279
+ "in": "path",
280
+ "required": true
281
+ }
282
+ ],
283
+ "requestBody": {
284
+ "required": true,
285
+ "content": {
286
+ "application/json": {}
287
+ }
288
+ }
289
+ }
234
290
  }
235
291
  },
236
292
  "components": {},
package/dist/openapi.d.ts CHANGED
@@ -23,14 +23,12 @@ declare namespace Components {
23
23
  */
24
24
  address: string;
25
25
  /**
26
- * Sent message status regarding to this recipient.\
27
- * Reference at <https://docs.aws.amazon.com/ses/latest/DeveloperGuide/monitor-sending-activity.html>
26
+ * Sent message status regarding to this recipient. Reference at <https://docs.aws.amazon.com/ses/latest/DeveloperGuide/monitor-sending-activity.html>
28
27
  *
29
28
  */
30
29
  send_status?: "SEND" | "DELIVERY" | "REJECT" | "COMPLAINT" | "BOUNCE" | "ERROR";
31
30
  /**
32
- * Information about reject, complaint or bounce event. Only available if `send_status` is REJECT, COMPLAINT, BOUNCE or ERROR.\
33
- * JSON object is defined by AWS SES. Reference at <https://docs.aws.amazon.com/ses/latest/DeveloperGuide/notification-contents.html>
31
+ * Information about reject, complaint or bounce event. Only available if `send_status` is REJECT, COMPLAINT, BOUNCE or ERROR. JSON object is defined by AWS SES. Reference at <https://docs.aws.amazon.com/ses/latest/DeveloperGuide/notification-contents.html>
34
32
  *
35
33
  */
36
34
  send_error?: {
@@ -115,18 +113,103 @@ declare namespace Components {
115
113
  */
116
114
  cid?: string;
117
115
  /**
118
- * If true then this attachment should not be offered for download (at least not in the main attachments list).\
119
- * The usecase is CID embedded image (aka inline image).
116
+ * 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).
120
117
  *
121
118
  */
122
119
  inline?: boolean;
123
120
  /**
124
- * If true then this attachment is sent via link. The link have to be inserted to email body by API caller.\
125
- * In this case, service doesn't process this attachment.
121
+ * 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.
126
122
  *
127
123
  */
128
124
  send_as_link?: boolean;
129
125
  }
126
+ export interface GenAIInfoJobOutputPayload {
127
+ /**
128
+ * Generated summary
129
+ * example:
130
+ * [
131
+ * "Customer is interested in solar panels"
132
+ * ]
133
+ */
134
+ summary?: string[] | null;
135
+ /**
136
+ * Topic of the GenAI Summary
137
+ * example:
138
+ * Product enquiry
139
+ */
140
+ topic?: string | null;
141
+ /**
142
+ * Next steps
143
+ * example:
144
+ * Send a quote
145
+ */
146
+ next_steps?: string | null;
147
+ /**
148
+ * Tags
149
+ * example:
150
+ * [
151
+ * "solar",
152
+ * "quote"
153
+ * ]
154
+ */
155
+ tags?: string[] | null;
156
+ }
157
+ export interface GenAIJobOutput {
158
+ /**
159
+ * Organization ID
160
+ * example:
161
+ * 739224
162
+ */
163
+ org_id?: string;
164
+ /**
165
+ * Thread ID
166
+ * example:
167
+ * 07b8b522-a993-4021-8fae-fd19f330ee60
168
+ */
169
+ thread_id?: string;
170
+ /**
171
+ * Message ID
172
+ * example:
173
+ * c03eb411-9f75-4ff0-9404-5a61c5b8798d
174
+ */
175
+ message_id?: string;
176
+ /**
177
+ * Job type
178
+ */
179
+ type?: "INFO" | "REPLY";
180
+ }
181
+ export interface GenAIJobOutputPayload {
182
+ /**
183
+ * Status of the GenAI job
184
+ * example:
185
+ * COMPLETED
186
+ */
187
+ status?: "IN_PROGRESS" | "COMPLETED" | "FAILED";
188
+ /**
189
+ * Progress of the GenAI job in percentage
190
+ * example:
191
+ * 100
192
+ */
193
+ progress?: number;
194
+ /**
195
+ * Error message if the job failed
196
+ * example:
197
+ * Failed to generate summary
198
+ */
199
+ error?: string | null;
200
+ /**
201
+ * Job created date
202
+ * example:
203
+ * 1612900000000
204
+ */
205
+ created_at?: number;
206
+ /**
207
+ * Job last updated date
208
+ * example:
209
+ * 1612900000000
210
+ */
211
+ updated_at?: number;
212
+ }
130
213
  export interface Message {
131
214
  /**
132
215
  * Message ID which is from email provider. If you provide `message-id`, API overrides by its own value.
@@ -174,9 +257,7 @@ declare namespace Components {
174
257
  bcc?: Address[];
175
258
  file?: /* Message attachments */ AttachmentsRelation;
176
259
  /**
177
- * References header. Value is the series of `message_id` which is reparated by space to indicate that message has parent.\
178
- * The last message ID in references identifies the parent. The first message ID in references identifies the first message in the thread.\
179
- * The basic idea is that sender should copy `references` from the parent and append the parent's `message_id` when replying.
260
+ * 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.
180
261
  *
181
262
  * example:
182
263
  * <0102017b97a502f8-a67f01c2-68cc-4928-b91b-45853f34e259-000000@eu-west-1.amazonses.com> <CALHgQpziyxW9NaFUs+nRMykzr6Ljq6vjq4WO9SaihAuMasuDyg@mail.gmail.com>
@@ -198,8 +279,7 @@ declare namespace Components {
198
279
  */
199
280
  org_read_message?: string[];
200
281
  /**
201
- * 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`\
202
- * Reference at <https://docs.aws.amazon.com/ses/latest/DeveloperGuide/monitor-sending-activity.html>
282
+ * 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>
203
283
  *
204
284
  */
205
285
  send_status?: ("SEND" | "DELIVERY" | "REJECT" | "COMPLAINT" | "BOUNCE" | "ERROR")[];
@@ -211,9 +291,7 @@ declare namespace Components {
211
291
  export interface MessageRequestParams {
212
292
  [name: string]: any;
213
293
  /**
214
- * Open new thread when sending the very first message in conversation. Thread should contains context related to all messages in it (eg. topic, brand_id, opportunity_id, assigned_to,...).\
215
- * Thread properties depend on API caller as it's not pre-defined. We do recommend having at least `topic` property for categorizing.\
216
- * `thread` or `parent_id` must be provided either.
294
+ * Open new thread when sending the very first message in conversation. Thread should contains context related to all messages in it (eg. topic, brand_id, opportunity_id, assigned_to,...). Thread properties depend on API caller as it's not pre-defined. We do recommend having at least `topic` property for categorizing. `thread` or `parent_id` must be provided either.
217
295
  *
218
296
  * example:
219
297
  * {
@@ -236,8 +314,7 @@ declare namespace Components {
236
314
  assigned_to?: string[];
237
315
  };
238
316
  /**
239
- * Entity ID of parent message which this message replies to or forwards from.\
240
- * If both `parent_id` and `thread` are provided, `thread` is discarded.
317
+ * Entity ID of parent message which this message replies to or forwards from. If both `parent_id` and `thread` are provided, `thread` is discarded.
241
318
  *
242
319
  * example:
243
320
  * 44d7a3eb-0cce-4bd3-a7cd-0b3e652de0c2
@@ -367,9 +444,7 @@ declare namespace Components {
367
444
  bcc?: Address[];
368
445
  file?: /* Message attachments */ AttachmentsRelation;
369
446
  /**
370
- * References header. Value is the series of `message_id` which is reparated by space to indicate that message has parent.\
371
- * The last message ID in references identifies the parent. The first message ID in references identifies the first message in the thread.\
372
- * The basic idea is that sender should copy `references` from the parent and append the parent's `message_id` when replying.
447
+ * 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.
373
448
  *
374
449
  * example:
375
450
  * <0102017b97a502f8-a67f01c2-68cc-4928-b91b-45853f34e259-000000@eu-west-1.amazonses.com> <CALHgQpziyxW9NaFUs+nRMykzr6Ljq6vjq4WO9SaihAuMasuDyg@mail.gmail.com>
@@ -391,8 +466,7 @@ declare namespace Components {
391
466
  */
392
467
  org_read_message?: string[];
393
468
  /**
394
- * 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`\
395
- * Reference at <https://docs.aws.amazon.com/ses/latest/DeveloperGuide/monitor-sending-activity.html>
469
+ * 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>
396
470
  *
397
471
  */
398
472
  send_status?: ("SEND" | "DELIVERY" | "REJECT" | "COMPLAINT" | "BOUNCE" | "ERROR")[];
@@ -610,9 +684,7 @@ declare namespace Paths {
610
684
  bcc?: Components.Schemas.Address[];
611
685
  file?: /* Message attachments */ Components.Schemas.AttachmentsRelation;
612
686
  /**
613
- * References header. Value is the series of `message_id` which is reparated by space to indicate that message has parent.\
614
- * The last message ID in references identifies the parent. The first message ID in references identifies the first message in the thread.\
615
- * The basic idea is that sender should copy `references` from the parent and append the parent's `message_id` when replying.
687
+ * 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.
616
688
  *
617
689
  * example:
618
690
  * <0102017b97a502f8-a67f01c2-68cc-4928-b91b-45853f34e259-000000@eu-west-1.amazonses.com> <CALHgQpziyxW9NaFUs+nRMykzr6Ljq6vjq4WO9SaihAuMasuDyg@mail.gmail.com>
@@ -634,8 +706,7 @@ declare namespace Paths {
634
706
  */
635
707
  org_read_message?: string[];
636
708
  /**
637
- * 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`\
638
- * Reference at <https://docs.aws.amazon.com/ses/latest/DeveloperGuide/monitor-sending-activity.html>
709
+ * 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>
639
710
  *
640
711
  */
641
712
  send_status?: ("SEND" | "DELIVERY" | "REJECT" | "COMPLAINT" | "BOUNCE" | "ERROR")[];
@@ -676,6 +747,125 @@ declare namespace Paths {
676
747
  }
677
748
  }
678
749
  }
750
+ namespace GenerateSuggestedReply {
751
+ namespace Parameters {
752
+ export type MessageId = string; // UUID
753
+ export type ThreadId = string; // UUID
754
+ }
755
+ export interface PathParameters {
756
+ messageId: Parameters.MessageId /* UUID */;
757
+ }
758
+ export interface QueryParameters {
759
+ threadId: Parameters.ThreadId /* UUID */;
760
+ }
761
+ namespace Responses {
762
+ export interface $202 {
763
+ }
764
+ export interface $403 {
765
+ }
766
+ }
767
+ }
768
+ namespace GetInfo {
769
+ namespace Parameters {
770
+ export type MessageId = string; // UUID
771
+ export type ThreadId = string; // UUID
772
+ }
773
+ export interface PathParameters {
774
+ threadId: Parameters.ThreadId /* UUID */;
775
+ }
776
+ export interface QueryParameters {
777
+ messageId?: Parameters.MessageId /* UUID */;
778
+ }
779
+ namespace Responses {
780
+ export interface $200 {
781
+ /**
782
+ * Organization ID
783
+ * example:
784
+ * 739224
785
+ */
786
+ org_id?: string;
787
+ /**
788
+ * Thread ID
789
+ * example:
790
+ * 07b8b522-a993-4021-8fae-fd19f330ee60
791
+ */
792
+ thread_id?: string;
793
+ /**
794
+ * Message ID
795
+ * example:
796
+ * c03eb411-9f75-4ff0-9404-5a61c5b8798d
797
+ */
798
+ message_id?: string;
799
+ /**
800
+ * Job type
801
+ */
802
+ type?: "INFO" | "REPLY";
803
+ payload?: {
804
+ /**
805
+ * Generated summary
806
+ * example:
807
+ * [
808
+ * "Customer is interested in solar panels"
809
+ * ]
810
+ */
811
+ summary?: string[] | null;
812
+ /**
813
+ * Topic of the GenAI Summary
814
+ * example:
815
+ * Product enquiry
816
+ */
817
+ topic?: string | null;
818
+ /**
819
+ * Next steps
820
+ * example:
821
+ * Send a quote
822
+ */
823
+ next_steps?: string | null;
824
+ /**
825
+ * Tags
826
+ * example:
827
+ * [
828
+ * "solar",
829
+ * "quote"
830
+ * ]
831
+ */
832
+ tags?: string[] | null;
833
+ /**
834
+ * Status of the GenAI job
835
+ * example:
836
+ * COMPLETED
837
+ */
838
+ status?: "IN_PROGRESS" | "COMPLETED" | "FAILED";
839
+ /**
840
+ * Progress of the GenAI job in percentage
841
+ * example:
842
+ * 100
843
+ */
844
+ progress?: number;
845
+ /**
846
+ * Error message if the job failed
847
+ * example:
848
+ * Failed to generate summary
849
+ */
850
+ error?: string | null;
851
+ /**
852
+ * Job created date
853
+ * example:
854
+ * 1612900000000
855
+ */
856
+ created_at?: number;
857
+ /**
858
+ * Job last updated date
859
+ * example:
860
+ * 1612900000000
861
+ */
862
+ updated_at?: number;
863
+ };
864
+ }
865
+ export interface $403 {
866
+ }
867
+ }
868
+ }
679
869
  namespace GetMessage {
680
870
  namespace Parameters {
681
871
  /**
@@ -782,9 +972,7 @@ declare namespace Paths {
782
972
  bcc?: Components.Schemas.Address[];
783
973
  file?: /* Message attachments */ Components.Schemas.AttachmentsRelation;
784
974
  /**
785
- * References header. Value is the series of `message_id` which is reparated by space to indicate that message has parent.\
786
- * The last message ID in references identifies the parent. The first message ID in references identifies the first message in the thread.\
787
- * The basic idea is that sender should copy `references` from the parent and append the parent's `message_id` when replying.
975
+ * 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.
788
976
  *
789
977
  * example:
790
978
  * <0102017b97a502f8-a67f01c2-68cc-4928-b91b-45853f34e259-000000@eu-west-1.amazonses.com> <CALHgQpziyxW9NaFUs+nRMykzr6Ljq6vjq4WO9SaihAuMasuDyg@mail.gmail.com>
@@ -806,8 +994,7 @@ declare namespace Paths {
806
994
  */
807
995
  org_read_message?: string[];
808
996
  /**
809
- * 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`\
810
- * Reference at <https://docs.aws.amazon.com/ses/latest/DeveloperGuide/monitor-sending-activity.html>
997
+ * 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>
811
998
  *
812
999
  */
813
1000
  send_status?: ("SEND" | "DELIVERY" | "REJECT" | "COMPLAINT" | "BOUNCE" | "ERROR")[];
@@ -928,9 +1115,7 @@ declare namespace Paths {
928
1115
  bcc?: Components.Schemas.Address[];
929
1116
  file?: /* Message attachments */ Components.Schemas.AttachmentsRelation;
930
1117
  /**
931
- * References header. Value is the series of `message_id` which is reparated by space to indicate that message has parent.\
932
- * The last message ID in references identifies the parent. The first message ID in references identifies the first message in the thread.\
933
- * The basic idea is that sender should copy `references` from the parent and append the parent's `message_id` when replying.
1118
+ * 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.
934
1119
  *
935
1120
  * example:
936
1121
  * <0102017b97a502f8-a67f01c2-68cc-4928-b91b-45853f34e259-000000@eu-west-1.amazonses.com> <CALHgQpziyxW9NaFUs+nRMykzr6Ljq6vjq4WO9SaihAuMasuDyg@mail.gmail.com>
@@ -952,8 +1137,7 @@ declare namespace Paths {
952
1137
  */
953
1138
  org_read_message?: string[];
954
1139
  /**
955
- * 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`\
956
- * Reference at <https://docs.aws.amazon.com/ses/latest/DeveloperGuide/monitor-sending-activity.html>
1140
+ * 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>
957
1141
  *
958
1142
  */
959
1143
  send_status?: ("SEND" | "DELIVERY" | "REJECT" | "COMPLAINT" | "BOUNCE" | "ERROR")[];
@@ -1032,6 +1216,122 @@ declare namespace Paths {
1032
1216
  }
1033
1217
  }
1034
1218
  }
1219
+ namespace PatchInfo {
1220
+ namespace Parameters {
1221
+ export type MessageId = string; // UUID
1222
+ export type ThreadId = string; // UUID
1223
+ }
1224
+ export interface PathParameters {
1225
+ threadId: Parameters.ThreadId /* UUID */;
1226
+ messageId: Parameters.MessageId /* UUID */;
1227
+ }
1228
+ export interface RequestBody {
1229
+ [name: string]: any;
1230
+ /**
1231
+ * example:
1232
+ * positive
1233
+ */
1234
+ rating?: string | null;
1235
+ }
1236
+ namespace Responses {
1237
+ export interface $200 {
1238
+ /**
1239
+ * Organization ID
1240
+ * example:
1241
+ * 739224
1242
+ */
1243
+ org_id?: string;
1244
+ /**
1245
+ * Thread ID
1246
+ * example:
1247
+ * 07b8b522-a993-4021-8fae-fd19f330ee60
1248
+ */
1249
+ thread_id?: string;
1250
+ /**
1251
+ * Message ID
1252
+ * example:
1253
+ * c03eb411-9f75-4ff0-9404-5a61c5b8798d
1254
+ */
1255
+ message_id?: string;
1256
+ /**
1257
+ * Job type
1258
+ */
1259
+ type?: "INFO" | "REPLY";
1260
+ payload?: {
1261
+ /**
1262
+ * Generated summary
1263
+ * example:
1264
+ * [
1265
+ * "Customer is interested in solar panels"
1266
+ * ]
1267
+ */
1268
+ summary?: string[] | null;
1269
+ /**
1270
+ * Topic of the GenAI Summary
1271
+ * example:
1272
+ * Product enquiry
1273
+ */
1274
+ topic?: string | null;
1275
+ /**
1276
+ * Next steps
1277
+ * example:
1278
+ * Send a quote
1279
+ */
1280
+ next_steps?: string | null;
1281
+ /**
1282
+ * Tags
1283
+ * example:
1284
+ * [
1285
+ * "solar",
1286
+ * "quote"
1287
+ * ]
1288
+ */
1289
+ tags?: string[] | null;
1290
+ /**
1291
+ * Status of the GenAI job
1292
+ * example:
1293
+ * COMPLETED
1294
+ */
1295
+ status?: "IN_PROGRESS" | "COMPLETED" | "FAILED";
1296
+ /**
1297
+ * Progress of the GenAI job in percentage
1298
+ * example:
1299
+ * 100
1300
+ */
1301
+ progress?: number;
1302
+ /**
1303
+ * Error message if the job failed
1304
+ * example:
1305
+ * Failed to generate summary
1306
+ */
1307
+ error?: string | null;
1308
+ /**
1309
+ * Job created date
1310
+ * example:
1311
+ * 1612900000000
1312
+ */
1313
+ created_at?: number;
1314
+ /**
1315
+ * Job last updated date
1316
+ * example:
1317
+ * 1612900000000
1318
+ */
1319
+ updated_at?: number;
1320
+ };
1321
+ }
1322
+ export interface $400 {
1323
+ }
1324
+ export interface $403 {
1325
+ }
1326
+ export interface $500 {
1327
+ /**
1328
+ * example:
1329
+ * Internal server error
1330
+ */
1331
+ error?: string;
1332
+ }
1333
+ }
1334
+ }
1035
1335
  namespace SearchThreads {
1036
1336
  export type RequestBody = Components.Schemas.SearchParams;
1037
1337
  namespace Responses {
@@ -1209,9 +1509,7 @@ declare namespace Paths {
1209
1509
  bcc?: Components.Schemas.Address[];
1210
1510
  file?: /* Message attachments */ Components.Schemas.AttachmentsRelation;
1211
1511
  /**
1212
- * References header. Value is the series of `message_id` which is reparated by space to indicate that message has parent.\
1213
- * The last message ID in references identifies the parent. The first message ID in references identifies the first message in the thread.\
1214
- * The basic idea is that sender should copy `references` from the parent and append the parent's `message_id` when replying.
1512
+ * 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.
1215
1513
  *
1216
1514
  * example:
1217
1515
  * <0102017b97a502f8-a67f01c2-68cc-4928-b91b-45853f34e259-000000@eu-west-1.amazonses.com> <CALHgQpziyxW9NaFUs+nRMykzr6Ljq6vjq4WO9SaihAuMasuDyg@mail.gmail.com>
@@ -1233,8 +1531,7 @@ declare namespace Paths {
1233
1531
  */
1234
1532
  org_read_message?: string[];
1235
1533
  /**
1236
- * 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`\
1237
- * Reference at <https://docs.aws.amazon.com/ses/latest/DeveloperGuide/monitor-sending-activity.html>
1534
+ * 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>
1238
1535
  *
1239
1536
  */
1240
1537
  send_status?: ("SEND" | "DELIVERY" | "REJECT" | "COMPLAINT" | "BOUNCE" | "ERROR")[];
@@ -1409,9 +1706,7 @@ declare namespace Paths {
1409
1706
  bcc?: Components.Schemas.Address[];
1410
1707
  file?: /* Message attachments */ Components.Schemas.AttachmentsRelation;
1411
1708
  /**
1412
- * References header. Value is the series of `message_id` which is reparated by space to indicate that message has parent.\
1413
- * The last message ID in references identifies the parent. The first message ID in references identifies the first message in the thread.\
1414
- * The basic idea is that sender should copy `references` from the parent and append the parent's `message_id` when replying.
1709
+ * 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.
1415
1710
  *
1416
1711
  * example:
1417
1712
  * <0102017b97a502f8-a67f01c2-68cc-4928-b91b-45853f34e259-000000@eu-west-1.amazonses.com> <CALHgQpziyxW9NaFUs+nRMykzr6Ljq6vjq4WO9SaihAuMasuDyg@mail.gmail.com>
@@ -1433,8 +1728,7 @@ declare namespace Paths {
1433
1728
  */
1434
1729
  org_read_message?: string[];
1435
1730
  /**
1436
- * 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`\
1437
- * Reference at <https://docs.aws.amazon.com/ses/latest/DeveloperGuide/monitor-sending-activity.html>
1731
+ * 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>
1438
1732
  *
1439
1733
  */
1440
1734
  send_status?: ("SEND" | "DELIVERY" | "REJECT" | "COMPLAINT" | "BOUNCE" | "ERROR")[];
@@ -1694,7 +1988,7 @@ export interface OperationMethods {
1694
1988
  /**
1695
1989
  * assignUsers - assignUsers
1696
1990
  *
1697
- * Assign users to thread for receiving notifications.
1991
+ * Assign users to thread for receiving notifications.
1698
1992
  * The operation replaces all existing assigned users in thread.
1699
1993
  *
1700
1994
  */
@@ -1743,6 +2037,36 @@ export interface OperationMethods {
1743
2037
  data?: any,
1744
2038
  config?: AxiosRequestConfig
1745
2039
  ): OperationResponse<Paths.GetMessageV2.Responses.$200>
2040
+ /**
2041
+ * generateSuggestedReply - generateSuggestedReply
2042
+ *
2043
+ * Generate suggested reply of the message in the thread
2044
+ */
2045
+ 'generateSuggestedReply'(
2046
+ parameters?: Parameters<Paths.GenerateSuggestedReply.PathParameters & Paths.GenerateSuggestedReply.QueryParameters> | null,
2047
+ data?: any,
2048
+ config?: AxiosRequestConfig
2049
+ ): OperationResponse<Paths.GenerateSuggestedReply.Responses.$202>
2050
+ /**
2051
+ * getInfo - getInfo
2052
+ *
2053
+ * Get generated information of the thread
2054
+ */
2055
+ 'getInfo'(
2056
+ parameters?: Parameters<Paths.GetInfo.PathParameters & Paths.GetInfo.QueryParameters> | null,
2057
+ data?: any,
2058
+ config?: AxiosRequestConfig
2059
+ ): OperationResponse<Paths.GetInfo.Responses.$200>
2060
+ /**
2061
+ * patchInfo - patchInfo
2062
+ *
2063
+ * patch generated information of the thread
2064
+ */
2065
+ 'patchInfo'(
2066
+ parameters?: Parameters<Paths.PatchInfo.PathParameters> | null,
2067
+ data?: Paths.PatchInfo.RequestBody,
2068
+ config?: AxiosRequestConfig
2069
+ ): OperationResponse<Paths.PatchInfo.Responses.$200>
1746
2070
  }
1747
2071
 
1748
2072
  export interface PathsDictionary {
@@ -1943,7 +2267,7 @@ export interface PathsDictionary {
1943
2267
  /**
1944
2268
  * assignUsers - assignUsers
1945
2269
  *
1946
- * Assign users to thread for receiving notifications.
2270
+ * Assign users to thread for receiving notifications.
1947
2271
  * The operation replaces all existing assigned users in thread.
1948
2272
  *
1949
2273
  */
@@ -1999,6 +2323,42 @@ export interface PathsDictionary {
1999
2323
  config?: AxiosRequestConfig
2000
2324
  ): OperationResponse<Paths.GetMessageV2.Responses.$200>
2001
2325
  }
2326
+ ['/v1/message/messages/{messageId}/genai:reply']: {
2327
+ /**
2328
+ * generateSuggestedReply - generateSuggestedReply
2329
+ *
2330
+ * Generate suggested reply of the message in the thread
2331
+ */
2332
+ 'post'(
2333
+ parameters?: Parameters<Paths.GenerateSuggestedReply.PathParameters & Paths.GenerateSuggestedReply.QueryParameters> | null,
2334
+ data?: any,
2335
+ config?: AxiosRequestConfig
2336
+ ): OperationResponse<Paths.GenerateSuggestedReply.Responses.$202>
2337
+ }
2338
+ ['/v1/message/threads/{threadId}/genai:info']: {
2339
+ /**
2340
+ * getInfo - getInfo
2341
+ *
2342
+ * Get generated information of the thread
2343
+ */
2344
+ 'get'(
2345
+ parameters?: Parameters<Paths.GetInfo.PathParameters & Paths.GetInfo.QueryParameters> | null,
2346
+ data?: any,
2347
+ config?: AxiosRequestConfig
2348
+ ): OperationResponse<Paths.GetInfo.Responses.$200>
2349
+ }
2350
+ ['/v1/message/threads/{threadId}/messages/{messageId}/genai:info']: {
2351
+ /**
2352
+ * patchInfo - patchInfo
2353
+ *
2354
+ * patch generated information of the thread
2355
+ */
2356
+ 'patch'(
2357
+ parameters?: Parameters<Paths.PatchInfo.PathParameters> | null,
2358
+ data?: Paths.PatchInfo.RequestBody,
2359
+ config?: AxiosRequestConfig
2360
+ ): OperationResponse<Paths.PatchInfo.Responses.$200>
2361
+ }
2002
2362
  }
2003
2363
 
2004
2364
  export type Client = OpenAPIClient<OperationMethods, PathsDictionary>
package/dist/openapi.json CHANGED
@@ -22,6 +22,9 @@
22
22
  },
23
23
  {
24
24
  "name": "Drafts"
25
+ },
26
+ {
27
+ "name": "GenAI"
25
28
  }
26
29
  ],
27
30
  "paths": {
@@ -599,7 +602,7 @@
599
602
  "post": {
600
603
  "operationId": "assignUsers",
601
604
  "summary": "assignUsers",
602
- "description": "Assign users to thread for receiving notifications. \nThe operation replaces all existing assigned users in thread.\n",
605
+ "description": "Assign users to thread for receiving notifications.\nThe operation replaces all existing assigned users in thread.\n",
603
606
  "tags": [
604
607
  "Threads"
605
608
  ],
@@ -758,6 +761,215 @@
758
761
  }
759
762
  }
760
763
  }
764
+ },
765
+ "/v1/message/messages/{messageId}/genai:reply": {
766
+ "post": {
767
+ "operationId": "generateSuggestedReply",
768
+ "summary": "generateSuggestedReply",
769
+ "description": "Generate suggested reply of the message in the thread",
770
+ "tags": [
771
+ "GenAI"
772
+ ],
773
+ "parameters": [
774
+ {
775
+ "name": "messageId",
776
+ "description": "Message ID",
777
+ "in": "path",
778
+ "required": true,
779
+ "schema": {
780
+ "type": "string",
781
+ "format": "UUID"
782
+ }
783
+ },
784
+ {
785
+ "name": "threadId",
786
+ "description": "Thread ID",
787
+ "in": "query",
788
+ "required": true,
789
+ "schema": {
790
+ "type": "string",
791
+ "format": "UUID"
792
+ }
793
+ }
794
+ ],
795
+ "responses": {
796
+ "202": {
797
+ "description": "Success"
798
+ },
799
+ "403": {
800
+ "description": "Forbidden"
801
+ }
802
+ }
803
+ }
804
+ },
805
+ "/v1/message/threads/{threadId}/genai:info": {
806
+ "get": {
807
+ "operationId": "getInfo",
808
+ "summary": "getInfo",
809
+ "description": "Get generated information of the thread",
810
+ "tags": [
811
+ "GenAI"
812
+ ],
813
+ "parameters": [
814
+ {
815
+ "name": "threadId",
816
+ "description": "Thread ID",
817
+ "in": "path",
818
+ "required": true,
819
+ "schema": {
820
+ "type": "string",
821
+ "format": "UUID"
822
+ }
823
+ },
824
+ {
825
+ "name": "messageId",
826
+ "description": "Message ID, If not passed defaults to latest message ID in the thread",
827
+ "in": "query",
828
+ "schema": {
829
+ "type": "string",
830
+ "format": "UUID"
831
+ }
832
+ }
833
+ ],
834
+ "responses": {
835
+ "200": {
836
+ "description": "Success",
837
+ "content": {
838
+ "application/json": {
839
+ "schema": {
840
+ "allOf": [
841
+ {
842
+ "$ref": "#/components/schemas/GenAIJobOutput"
843
+ },
844
+ {
845
+ "type": "object",
846
+ "properties": {
847
+ "payload": {
848
+ "allOf": [
849
+ {
850
+ "$ref": "#/components/schemas/GenAIInfoJobOutputPayload"
851
+ },
852
+ {
853
+ "$ref": "#/components/schemas/GenAIJobOutputPayload"
854
+ }
855
+ ]
856
+ }
857
+ }
858
+ }
859
+ ]
860
+ }
861
+ }
862
+ }
863
+ },
864
+ "403": {
865
+ "description": "Forbidden"
866
+ }
867
+ }
868
+ }
869
+ },
870
+ "/v1/message/threads/{threadId}/messages/{messageId}/genai:info": {
871
+ "patch": {
872
+ "operationId": "patchInfo",
873
+ "summary": "patchInfo",
874
+ "description": "patch generated information of the thread",
875
+ "tags": [
876
+ "GenAI"
877
+ ],
878
+ "parameters": [
879
+ {
880
+ "name": "threadId",
881
+ "description": "Thread ID",
882
+ "in": "path",
883
+ "required": true,
884
+ "schema": {
885
+ "type": "string",
886
+ "format": "UUID"
887
+ }
888
+ },
889
+ {
890
+ "name": "messageId",
891
+ "description": "Message ID",
892
+ "in": "path",
893
+ "required": true,
894
+ "schema": {
895
+ "type": "string",
896
+ "format": "UUID"
897
+ }
898
+ }
899
+ ],
900
+ "requestBody": {
901
+ "description": "Request body for genai info update",
902
+ "required": true,
903
+ "content": {
904
+ "application/json": {
905
+ "schema": {
906
+ "type": "object",
907
+ "properties": {
908
+ "rating": {
909
+ "type": "string",
910
+ "nullable": true,
911
+ "example": "positive"
912
+ }
913
+ },
914
+ "additionalProperties": true
915
+ }
916
+ }
917
+ }
918
+ },
919
+ "responses": {
920
+ "200": {
921
+ "description": "Successfully updated, returns the updated info",
922
+ "content": {
923
+ "application/json": {
924
+ "schema": {
925
+ "allOf": [
926
+ {
927
+ "$ref": "#/components/schemas/GenAIJobOutput"
928
+ },
929
+ {
930
+ "type": "object",
931
+ "properties": {
932
+ "payload": {
933
+ "allOf": [
934
+ {
935
+ "$ref": "#/components/schemas/GenAIInfoJobOutputPayload"
936
+ },
937
+ {
938
+ "$ref": "#/components/schemas/GenAIJobOutputPayload"
939
+ }
940
+ ]
941
+ }
942
+ }
943
+ }
944
+ ]
945
+ }
946
+ }
947
+ }
948
+ },
949
+ "400": {
950
+ "description": "Invalid input"
951
+ },
952
+ "403": {
953
+ "description": "Forbidden"
954
+ },
955
+ "500": {
956
+ "description": "Internal server error",
957
+ "content": {
958
+ "application/json": {
959
+ "schema": {
960
+ "type": "object",
961
+ "properties": {
962
+ "error": {
963
+ "type": "string",
964
+ "example": "Internal server error"
965
+ }
966
+ }
967
+ }
968
+ }
969
+ }
970
+ }
971
+ }
972
+ }
761
973
  }
762
974
  },
763
975
  "components": {
@@ -945,7 +1157,7 @@
945
1157
  },
946
1158
  "references": {
947
1159
  "type": "string",
948
- "description": "References header. Value is the series of `message_id` which is reparated by space to indicate that message has parent.\\\nThe last message ID in references identifies the parent. The first message ID in references identifies the first message in the thread.\\\nThe basic idea is that sender should copy `references` from the parent and append the parent's `message_id` when replying.\n",
1160
+ "description": "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.\n",
949
1161
  "example": "<0102017b97a502f8-a67f01c2-68cc-4928-b91b-45853f34e259-000000@eu-west-1.amazonses.com> <CALHgQpziyxW9NaFUs+nRMykzr6Ljq6vjq4WO9SaihAuMasuDyg@mail.gmail.com>"
950
1162
  },
951
1163
  "in_reply_to": {
@@ -977,7 +1189,7 @@
977
1189
  },
978
1190
  "send_status": {
979
1191
  "type": "array",
980
- "description": "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`\\\nReference at <https://docs.aws.amazon.com/ses/latest/DeveloperGuide/monitor-sending-activity.html>\n",
1192
+ "description": "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>\n",
981
1193
  "items": {
982
1194
  "type": "string",
983
1195
  "enum": [
@@ -1040,7 +1252,7 @@
1040
1252
  },
1041
1253
  "send_status": {
1042
1254
  "type": "string",
1043
- "description": "Sent message status regarding to this recipient.\\\nReference at <https://docs.aws.amazon.com/ses/latest/DeveloperGuide/monitor-sending-activity.html>\n",
1255
+ "description": "Sent message status regarding to this recipient. Reference at <https://docs.aws.amazon.com/ses/latest/DeveloperGuide/monitor-sending-activity.html>\n",
1044
1256
  "enum": [
1045
1257
  "SEND",
1046
1258
  "DELIVERY",
@@ -1052,7 +1264,7 @@
1052
1264
  },
1053
1265
  "send_error": {
1054
1266
  "type": "object",
1055
- "description": "Information about reject, complaint or bounce event. Only available if `send_status` is REJECT, COMPLAINT, BOUNCE or ERROR.\\\nJSON object is defined by AWS SES. Reference at <https://docs.aws.amazon.com/ses/latest/DeveloperGuide/notification-contents.html>\n"
1267
+ "description": "Information about reject, complaint or bounce event. Only available if `send_status` is REJECT, COMPLAINT, BOUNCE or ERROR. JSON object is defined by AWS SES. Reference at <https://docs.aws.amazon.com/ses/latest/DeveloperGuide/notification-contents.html>\n"
1056
1268
  }
1057
1269
  }
1058
1270
  },
@@ -1096,12 +1308,12 @@
1096
1308
  },
1097
1309
  "inline": {
1098
1310
  "type": "boolean",
1099
- "description": "If true then this attachment should not be offered for download (at least not in the main attachments list).\\\nThe usecase is CID embedded image (aka inline image).\n",
1311
+ "description": "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).\n",
1100
1312
  "default": false
1101
1313
  },
1102
1314
  "send_as_link": {
1103
1315
  "type": "boolean",
1104
- "description": "If true then this attachment is sent via link. The link have to be inserted to email body by API caller.\\\nIn this case, service doesn't process this attachment.\n",
1316
+ "description": "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.\n",
1105
1317
  "default": false
1106
1318
  }
1107
1319
  }
@@ -1118,7 +1330,7 @@
1118
1330
  "required": [
1119
1331
  "topic"
1120
1332
  ],
1121
- "description": "Open new thread when sending the very first message in conversation. Thread should contains context related to all messages in it (eg. topic, brand_id, opportunity_id, assigned_to,...).\\\nThread properties depend on API caller as it's not pre-defined. We do recommend having at least `topic` property for categorizing.\\\n`thread` or `parent_id` must be provided either.\n",
1333
+ "description": "Open new thread when sending the very first message in conversation. Thread should contains context related to all messages in it (eg. topic, brand_id, opportunity_id, assigned_to,...). Thread properties depend on API caller as it's not pre-defined. We do recommend having at least `topic` property for categorizing. `thread` or `parent_id` must be provided either.\n",
1122
1334
  "properties": {
1123
1335
  "topic": {
1124
1336
  "type": "string",
@@ -1143,7 +1355,7 @@
1143
1355
  },
1144
1356
  "parent_id": {
1145
1357
  "type": "string",
1146
- "description": "Entity ID of parent message which this message replies to or forwards from.\\\nIf both `parent_id` and `thread` are provided, `thread` is discarded.\n",
1358
+ "description": "Entity ID of parent message which this message replies to or forwards from. If both `parent_id` and `thread` are provided, `thread` is discarded.\n",
1147
1359
  "example": "44d7a3eb-0cce-4bd3-a7cd-0b3e652de0c2"
1148
1360
  },
1149
1361
  "subject": {
@@ -1215,6 +1427,110 @@
1215
1427
  "default": 10
1216
1428
  }
1217
1429
  }
1430
+ },
1431
+ "GenAIJobOutput": {
1432
+ "type": "object",
1433
+ "properties": {
1434
+ "org_id": {
1435
+ "type": "string",
1436
+ "description": "Organization ID",
1437
+ "example": "739224"
1438
+ },
1439
+ "thread_id": {
1440
+ "type": "string",
1441
+ "description": "Thread ID",
1442
+ "example": "07b8b522-a993-4021-8fae-fd19f330ee60"
1443
+ },
1444
+ "message_id": {
1445
+ "type": "string",
1446
+ "description": "Message ID",
1447
+ "example": "c03eb411-9f75-4ff0-9404-5a61c5b8798d"
1448
+ },
1449
+ "type": {
1450
+ "type": "string",
1451
+ "description": "Job type",
1452
+ "enum": [
1453
+ "INFO",
1454
+ "REPLY"
1455
+ ]
1456
+ }
1457
+ }
1458
+ },
1459
+ "GenAIJobOutputPayload": {
1460
+ "type": "object",
1461
+ "properties": {
1462
+ "status": {
1463
+ "type": "string",
1464
+ "enum": [
1465
+ "IN_PROGRESS",
1466
+ "COMPLETED",
1467
+ "FAILED"
1468
+ ],
1469
+ "description": "Status of the GenAI job",
1470
+ "example": "COMPLETED"
1471
+ },
1472
+ "progress": {
1473
+ "type": "number",
1474
+ "description": "Progress of the GenAI job in percentage",
1475
+ "example": 100
1476
+ },
1477
+ "error": {
1478
+ "type": "string",
1479
+ "description": "Error message if the job failed",
1480
+ "example": "Failed to generate summary",
1481
+ "nullable": true
1482
+ },
1483
+ "created_at": {
1484
+ "type": "number",
1485
+ "description": "Job created date",
1486
+ "example": 1612900000000
1487
+ },
1488
+ "updated_at": {
1489
+ "type": "number",
1490
+ "description": "Job last updated date",
1491
+ "example": 1612900000000
1492
+ }
1493
+ }
1494
+ },
1495
+ "GenAIInfoJobOutputPayload": {
1496
+ "type": "object",
1497
+ "properties": {
1498
+ "summary": {
1499
+ "type": "array",
1500
+ "description": "Generated summary",
1501
+ "items": {
1502
+ "type": "string"
1503
+ },
1504
+ "example": [
1505
+ "Customer is interested in solar panels"
1506
+ ],
1507
+ "nullable": true
1508
+ },
1509
+ "topic": {
1510
+ "type": "string",
1511
+ "description": "Topic of the GenAI Summary",
1512
+ "example": "Product enquiry",
1513
+ "nullable": true
1514
+ },
1515
+ "next_steps": {
1516
+ "type": "string",
1517
+ "description": "Next steps",
1518
+ "example": "Send a quote",
1519
+ "nullable": true
1520
+ },
1521
+ "tags": {
1522
+ "type": "array",
1523
+ "description": "Tags",
1524
+ "items": {
1525
+ "type": "string"
1526
+ },
1527
+ "example": [
1528
+ "solar",
1529
+ "quote"
1530
+ ],
1531
+ "nullable": true
1532
+ }
1533
+ }
1218
1534
  }
1219
1535
  }
1220
1536
  },
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@epilot/message-client",
3
- "version": "1.8.0",
3
+ "version": "1.10.0",
4
4
  "description": "API Client for epilot Message API",
5
5
  "main": "dist/index.js",
6
6
  "types": "dist/index.d.ts",
@@ -22,7 +22,7 @@
22
22
  "test": "jest",
23
23
  "typescript": "tsc",
24
24
  "bundle-definition": "webpack",
25
- "openapi": "node ../../scripts/update-openapi.js /Users/keremnalbant/Development/epilot/server/svc-centralized-message-api/lambda/HandlerFunction/openapi.yml",
25
+ "openapi": "node ../../scripts/update-openapi.js https://docs.api.epilot.io/message.yaml",
26
26
  "typegen": "echo '/* eslint-disable */' > src/openapi.d.ts && typegen ./src/openapi.json >> src/openapi.d.ts",
27
27
  "build": "tsc && npm run bundle-definition",
28
28
  "build:watch": "npm run build && tsc -w",