@epilot/message-client 1.8.0 → 1.9.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.
- package/dist/definition.js +1 -1
- package/dist/openapi-runtime.json +57 -6
- package/dist/openapi.d.ts +310 -50
- package/dist/openapi.json +287 -15
- package/package.json +2 -2
package/dist/definition.js
CHANGED
|
@@ -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}]}}},"
|
|
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":{}}')}},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,12 +231,63 @@
|
|
|
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
|
-
"components": {}
|
|
237
|
-
"servers": [
|
|
238
|
-
{
|
|
239
|
-
"url": "https://message.sls.epilot.io"
|
|
240
|
-
}
|
|
241
|
-
]
|
|
292
|
+
"components": {}
|
|
242
293
|
}
|
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,95 @@ 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
|
+
* Customer is interested in solar panels
|
|
131
|
+
*/
|
|
132
|
+
summary?: string | null;
|
|
133
|
+
/**
|
|
134
|
+
* Next steps
|
|
135
|
+
* example:
|
|
136
|
+
* Send a quote
|
|
137
|
+
*/
|
|
138
|
+
next_steps?: string | null;
|
|
139
|
+
/**
|
|
140
|
+
* Tags
|
|
141
|
+
* example:
|
|
142
|
+
* [
|
|
143
|
+
* "solar",
|
|
144
|
+
* "quote"
|
|
145
|
+
* ]
|
|
146
|
+
*/
|
|
147
|
+
tags?: string[] | null;
|
|
148
|
+
}
|
|
149
|
+
export interface GenAIJobOutput {
|
|
150
|
+
/**
|
|
151
|
+
* Organization ID
|
|
152
|
+
* example:
|
|
153
|
+
* 739224
|
|
154
|
+
*/
|
|
155
|
+
org_id?: string;
|
|
156
|
+
/**
|
|
157
|
+
* Thread ID
|
|
158
|
+
* example:
|
|
159
|
+
* 07b8b522-a993-4021-8fae-fd19f330ee60
|
|
160
|
+
*/
|
|
161
|
+
thread_id?: string;
|
|
162
|
+
/**
|
|
163
|
+
* Message ID
|
|
164
|
+
* example:
|
|
165
|
+
* c03eb411-9f75-4ff0-9404-5a61c5b8798d
|
|
166
|
+
*/
|
|
167
|
+
message_id?: string;
|
|
168
|
+
/**
|
|
169
|
+
* Job type
|
|
170
|
+
*/
|
|
171
|
+
type?: "INFO" | "REPLY";
|
|
172
|
+
}
|
|
173
|
+
export interface GenAIJobOutputPayload {
|
|
174
|
+
/**
|
|
175
|
+
* Status of the GenAI job
|
|
176
|
+
* example:
|
|
177
|
+
* COMPLETED
|
|
178
|
+
*/
|
|
179
|
+
status?: "IN_PROGRESS" | "COMPLETED" | "FAILED";
|
|
180
|
+
/**
|
|
181
|
+
* Progress of the GenAI job in percentage
|
|
182
|
+
* example:
|
|
183
|
+
* 100
|
|
184
|
+
*/
|
|
185
|
+
progress?: number;
|
|
186
|
+
/**
|
|
187
|
+
* Error message if the job failed
|
|
188
|
+
* example:
|
|
189
|
+
* Failed to generate summary
|
|
190
|
+
*/
|
|
191
|
+
error?: string | null;
|
|
192
|
+
/**
|
|
193
|
+
* Job created date
|
|
194
|
+
* example:
|
|
195
|
+
* 1612900000000
|
|
196
|
+
*/
|
|
197
|
+
created_at?: number;
|
|
198
|
+
/**
|
|
199
|
+
* Job last updated date
|
|
200
|
+
* example:
|
|
201
|
+
* 1612900000000
|
|
202
|
+
*/
|
|
203
|
+
updated_at?: number;
|
|
204
|
+
}
|
|
130
205
|
export interface Message {
|
|
131
206
|
/**
|
|
132
207
|
* Message ID which is from email provider. If you provide `message-id`, API overrides by its own value.
|
|
@@ -174,9 +249,7 @@ declare namespace Components {
|
|
|
174
249
|
bcc?: Address[];
|
|
175
250
|
file?: /* Message attachments */ AttachmentsRelation;
|
|
176
251
|
/**
|
|
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.
|
|
252
|
+
* 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
253
|
*
|
|
181
254
|
* example:
|
|
182
255
|
* <0102017b97a502f8-a67f01c2-68cc-4928-b91b-45853f34e259-000000@eu-west-1.amazonses.com> <CALHgQpziyxW9NaFUs+nRMykzr6Ljq6vjq4WO9SaihAuMasuDyg@mail.gmail.com>
|
|
@@ -198,8 +271,7 @@ declare namespace Components {
|
|
|
198
271
|
*/
|
|
199
272
|
org_read_message?: string[];
|
|
200
273
|
/**
|
|
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>
|
|
274
|
+
* 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
275
|
*
|
|
204
276
|
*/
|
|
205
277
|
send_status?: ("SEND" | "DELIVERY" | "REJECT" | "COMPLAINT" | "BOUNCE" | "ERROR")[];
|
|
@@ -211,9 +283,7 @@ declare namespace Components {
|
|
|
211
283
|
export interface MessageRequestParams {
|
|
212
284
|
[name: string]: any;
|
|
213
285
|
/**
|
|
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.
|
|
286
|
+
* 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
287
|
*
|
|
218
288
|
* example:
|
|
219
289
|
* {
|
|
@@ -236,8 +306,7 @@ declare namespace Components {
|
|
|
236
306
|
assigned_to?: string[];
|
|
237
307
|
};
|
|
238
308
|
/**
|
|
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.
|
|
309
|
+
* 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
310
|
*
|
|
242
311
|
* example:
|
|
243
312
|
* 44d7a3eb-0cce-4bd3-a7cd-0b3e652de0c2
|
|
@@ -367,9 +436,7 @@ declare namespace Components {
|
|
|
367
436
|
bcc?: Address[];
|
|
368
437
|
file?: /* Message attachments */ AttachmentsRelation;
|
|
369
438
|
/**
|
|
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.
|
|
439
|
+
* 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
440
|
*
|
|
374
441
|
* example:
|
|
375
442
|
* <0102017b97a502f8-a67f01c2-68cc-4928-b91b-45853f34e259-000000@eu-west-1.amazonses.com> <CALHgQpziyxW9NaFUs+nRMykzr6Ljq6vjq4WO9SaihAuMasuDyg@mail.gmail.com>
|
|
@@ -391,8 +458,7 @@ declare namespace Components {
|
|
|
391
458
|
*/
|
|
392
459
|
org_read_message?: string[];
|
|
393
460
|
/**
|
|
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>
|
|
461
|
+
* 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
462
|
*
|
|
397
463
|
*/
|
|
398
464
|
send_status?: ("SEND" | "DELIVERY" | "REJECT" | "COMPLAINT" | "BOUNCE" | "ERROR")[];
|
|
@@ -610,9 +676,7 @@ declare namespace Paths {
|
|
|
610
676
|
bcc?: Components.Schemas.Address[];
|
|
611
677
|
file?: /* Message attachments */ Components.Schemas.AttachmentsRelation;
|
|
612
678
|
/**
|
|
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.
|
|
679
|
+
* 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
680
|
*
|
|
617
681
|
* example:
|
|
618
682
|
* <0102017b97a502f8-a67f01c2-68cc-4928-b91b-45853f34e259-000000@eu-west-1.amazonses.com> <CALHgQpziyxW9NaFUs+nRMykzr6Ljq6vjq4WO9SaihAuMasuDyg@mail.gmail.com>
|
|
@@ -634,8 +698,7 @@ declare namespace Paths {
|
|
|
634
698
|
*/
|
|
635
699
|
org_read_message?: string[];
|
|
636
700
|
/**
|
|
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>
|
|
701
|
+
* 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
702
|
*
|
|
640
703
|
*/
|
|
641
704
|
send_status?: ("SEND" | "DELIVERY" | "REJECT" | "COMPLAINT" | "BOUNCE" | "ERROR")[];
|
|
@@ -676,6 +739,117 @@ declare namespace Paths {
|
|
|
676
739
|
}
|
|
677
740
|
}
|
|
678
741
|
}
|
|
742
|
+
namespace GenerateSuggestedReply {
|
|
743
|
+
namespace Parameters {
|
|
744
|
+
export type MessageId = string; // UUID
|
|
745
|
+
export type ThreadId = string; // UUID
|
|
746
|
+
}
|
|
747
|
+
export interface PathParameters {
|
|
748
|
+
messageId: Parameters.MessageId /* UUID */;
|
|
749
|
+
}
|
|
750
|
+
export interface QueryParameters {
|
|
751
|
+
threadId: Parameters.ThreadId /* UUID */;
|
|
752
|
+
}
|
|
753
|
+
namespace Responses {
|
|
754
|
+
export interface $202 {
|
|
755
|
+
}
|
|
756
|
+
export interface $403 {
|
|
757
|
+
}
|
|
758
|
+
}
|
|
759
|
+
}
|
|
760
|
+
namespace GetInfo {
|
|
761
|
+
namespace Parameters {
|
|
762
|
+
export type MessageId = string; // UUID
|
|
763
|
+
export type ThreadId = string; // UUID
|
|
764
|
+
}
|
|
765
|
+
export interface PathParameters {
|
|
766
|
+
threadId: Parameters.ThreadId /* UUID */;
|
|
767
|
+
}
|
|
768
|
+
export interface QueryParameters {
|
|
769
|
+
messageId?: Parameters.MessageId /* UUID */;
|
|
770
|
+
}
|
|
771
|
+
namespace Responses {
|
|
772
|
+
export interface $200 {
|
|
773
|
+
/**
|
|
774
|
+
* Organization ID
|
|
775
|
+
* example:
|
|
776
|
+
* 739224
|
|
777
|
+
*/
|
|
778
|
+
org_id?: string;
|
|
779
|
+
/**
|
|
780
|
+
* Thread ID
|
|
781
|
+
* example:
|
|
782
|
+
* 07b8b522-a993-4021-8fae-fd19f330ee60
|
|
783
|
+
*/
|
|
784
|
+
thread_id?: string;
|
|
785
|
+
/**
|
|
786
|
+
* Message ID
|
|
787
|
+
* example:
|
|
788
|
+
* c03eb411-9f75-4ff0-9404-5a61c5b8798d
|
|
789
|
+
*/
|
|
790
|
+
message_id?: string;
|
|
791
|
+
/**
|
|
792
|
+
* Job type
|
|
793
|
+
*/
|
|
794
|
+
type?: "INFO" | "REPLY";
|
|
795
|
+
payload?: {
|
|
796
|
+
/**
|
|
797
|
+
* Generated summary
|
|
798
|
+
* example:
|
|
799
|
+
* Customer is interested in solar panels
|
|
800
|
+
*/
|
|
801
|
+
summary?: string | null;
|
|
802
|
+
/**
|
|
803
|
+
* Next steps
|
|
804
|
+
* example:
|
|
805
|
+
* Send a quote
|
|
806
|
+
*/
|
|
807
|
+
next_steps?: string | null;
|
|
808
|
+
/**
|
|
809
|
+
* Tags
|
|
810
|
+
* example:
|
|
811
|
+
* [
|
|
812
|
+
* "solar",
|
|
813
|
+
* "quote"
|
|
814
|
+
* ]
|
|
815
|
+
*/
|
|
816
|
+
tags?: string[] | null;
|
|
817
|
+
/**
|
|
818
|
+
* Status of the GenAI job
|
|
819
|
+
* example:
|
|
820
|
+
* COMPLETED
|
|
821
|
+
*/
|
|
822
|
+
status?: "IN_PROGRESS" | "COMPLETED" | "FAILED";
|
|
823
|
+
/**
|
|
824
|
+
* Progress of the GenAI job in percentage
|
|
825
|
+
* example:
|
|
826
|
+
* 100
|
|
827
|
+
*/
|
|
828
|
+
progress?: number;
|
|
829
|
+
/**
|
|
830
|
+
* Error message if the job failed
|
|
831
|
+
* example:
|
|
832
|
+
* Failed to generate summary
|
|
833
|
+
*/
|
|
834
|
+
error?: string | null;
|
|
835
|
+
/**
|
|
836
|
+
* Job created date
|
|
837
|
+
* example:
|
|
838
|
+
* 1612900000000
|
|
839
|
+
*/
|
|
840
|
+
created_at?: number;
|
|
841
|
+
/**
|
|
842
|
+
* Job last updated date
|
|
843
|
+
* example:
|
|
844
|
+
* 1612900000000
|
|
845
|
+
*/
|
|
846
|
+
updated_at?: number;
|
|
847
|
+
};
|
|
848
|
+
}
|
|
849
|
+
export interface $403 {
|
|
850
|
+
}
|
|
851
|
+
}
|
|
852
|
+
}
|
|
679
853
|
namespace GetMessage {
|
|
680
854
|
namespace Parameters {
|
|
681
855
|
/**
|
|
@@ -782,9 +956,7 @@ declare namespace Paths {
|
|
|
782
956
|
bcc?: Components.Schemas.Address[];
|
|
783
957
|
file?: /* Message attachments */ Components.Schemas.AttachmentsRelation;
|
|
784
958
|
/**
|
|
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.
|
|
959
|
+
* 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
960
|
*
|
|
789
961
|
* example:
|
|
790
962
|
* <0102017b97a502f8-a67f01c2-68cc-4928-b91b-45853f34e259-000000@eu-west-1.amazonses.com> <CALHgQpziyxW9NaFUs+nRMykzr6Ljq6vjq4WO9SaihAuMasuDyg@mail.gmail.com>
|
|
@@ -806,8 +978,7 @@ declare namespace Paths {
|
|
|
806
978
|
*/
|
|
807
979
|
org_read_message?: string[];
|
|
808
980
|
/**
|
|
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>
|
|
981
|
+
* 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
982
|
*
|
|
812
983
|
*/
|
|
813
984
|
send_status?: ("SEND" | "DELIVERY" | "REJECT" | "COMPLAINT" | "BOUNCE" | "ERROR")[];
|
|
@@ -928,9 +1099,7 @@ declare namespace Paths {
|
|
|
928
1099
|
bcc?: Components.Schemas.Address[];
|
|
929
1100
|
file?: /* Message attachments */ Components.Schemas.AttachmentsRelation;
|
|
930
1101
|
/**
|
|
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.
|
|
1102
|
+
* 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
1103
|
*
|
|
935
1104
|
* example:
|
|
936
1105
|
* <0102017b97a502f8-a67f01c2-68cc-4928-b91b-45853f34e259-000000@eu-west-1.amazonses.com> <CALHgQpziyxW9NaFUs+nRMykzr6Ljq6vjq4WO9SaihAuMasuDyg@mail.gmail.com>
|
|
@@ -952,8 +1121,7 @@ declare namespace Paths {
|
|
|
952
1121
|
*/
|
|
953
1122
|
org_read_message?: string[];
|
|
954
1123
|
/**
|
|
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>
|
|
1124
|
+
* 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
1125
|
*
|
|
958
1126
|
*/
|
|
959
1127
|
send_status?: ("SEND" | "DELIVERY" | "REJECT" | "COMPLAINT" | "BOUNCE" | "ERROR")[];
|
|
@@ -1032,6 +1200,38 @@ declare namespace Paths {
|
|
|
1032
1200
|
}
|
|
1033
1201
|
}
|
|
1034
1202
|
}
|
|
1203
|
+
namespace PatchInfo {
|
|
1204
|
+
namespace Parameters {
|
|
1205
|
+
export type MessageId = string; // UUID
|
|
1206
|
+
export type ThreadId = string; // UUID
|
|
1207
|
+
}
|
|
1208
|
+
export interface PathParameters {
|
|
1209
|
+
threadId: Parameters.ThreadId /* UUID */;
|
|
1210
|
+
messageId: Parameters.MessageId /* UUID */;
|
|
1211
|
+
}
|
|
1212
|
+
export interface RequestBody {
|
|
1213
|
+
/**
|
|
1214
|
+
* example:
|
|
1215
|
+
* positive
|
|
1216
|
+
*/
|
|
1217
|
+
rating?: string;
|
|
1218
|
+
}
|
|
1219
|
+
namespace Responses {
|
|
1220
|
+
export interface $204 {
|
|
1221
|
+
}
|
|
1222
|
+
export interface $400 {
|
|
1223
|
+
}
|
|
1224
|
+
export interface $403 {
|
|
1225
|
+
}
|
|
1226
|
+
export interface $500 {
|
|
1227
|
+
/**
|
|
1228
|
+
* example:
|
|
1229
|
+
* Internal server error
|
|
1230
|
+
*/
|
|
1231
|
+
error?: string;
|
|
1232
|
+
}
|
|
1233
|
+
}
|
|
1234
|
+
}
|
|
1035
1235
|
namespace SearchThreads {
|
|
1036
1236
|
export type RequestBody = Components.Schemas.SearchParams;
|
|
1037
1237
|
namespace Responses {
|
|
@@ -1209,9 +1409,7 @@ declare namespace Paths {
|
|
|
1209
1409
|
bcc?: Components.Schemas.Address[];
|
|
1210
1410
|
file?: /* Message attachments */ Components.Schemas.AttachmentsRelation;
|
|
1211
1411
|
/**
|
|
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.
|
|
1412
|
+
* 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
1413
|
*
|
|
1216
1414
|
* example:
|
|
1217
1415
|
* <0102017b97a502f8-a67f01c2-68cc-4928-b91b-45853f34e259-000000@eu-west-1.amazonses.com> <CALHgQpziyxW9NaFUs+nRMykzr6Ljq6vjq4WO9SaihAuMasuDyg@mail.gmail.com>
|
|
@@ -1233,8 +1431,7 @@ declare namespace Paths {
|
|
|
1233
1431
|
*/
|
|
1234
1432
|
org_read_message?: string[];
|
|
1235
1433
|
/**
|
|
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>
|
|
1434
|
+
* 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
1435
|
*
|
|
1239
1436
|
*/
|
|
1240
1437
|
send_status?: ("SEND" | "DELIVERY" | "REJECT" | "COMPLAINT" | "BOUNCE" | "ERROR")[];
|
|
@@ -1409,9 +1606,7 @@ declare namespace Paths {
|
|
|
1409
1606
|
bcc?: Components.Schemas.Address[];
|
|
1410
1607
|
file?: /* Message attachments */ Components.Schemas.AttachmentsRelation;
|
|
1411
1608
|
/**
|
|
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.
|
|
1609
|
+
* 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
1610
|
*
|
|
1416
1611
|
* example:
|
|
1417
1612
|
* <0102017b97a502f8-a67f01c2-68cc-4928-b91b-45853f34e259-000000@eu-west-1.amazonses.com> <CALHgQpziyxW9NaFUs+nRMykzr6Ljq6vjq4WO9SaihAuMasuDyg@mail.gmail.com>
|
|
@@ -1433,8 +1628,7 @@ declare namespace Paths {
|
|
|
1433
1628
|
*/
|
|
1434
1629
|
org_read_message?: string[];
|
|
1435
1630
|
/**
|
|
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>
|
|
1631
|
+
* 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
1632
|
*
|
|
1439
1633
|
*/
|
|
1440
1634
|
send_status?: ("SEND" | "DELIVERY" | "REJECT" | "COMPLAINT" | "BOUNCE" | "ERROR")[];
|
|
@@ -1694,7 +1888,7 @@ export interface OperationMethods {
|
|
|
1694
1888
|
/**
|
|
1695
1889
|
* assignUsers - assignUsers
|
|
1696
1890
|
*
|
|
1697
|
-
* Assign users to thread for receiving notifications.
|
|
1891
|
+
* Assign users to thread for receiving notifications.
|
|
1698
1892
|
* The operation replaces all existing assigned users in thread.
|
|
1699
1893
|
*
|
|
1700
1894
|
*/
|
|
@@ -1743,6 +1937,36 @@ export interface OperationMethods {
|
|
|
1743
1937
|
data?: any,
|
|
1744
1938
|
config?: AxiosRequestConfig
|
|
1745
1939
|
): OperationResponse<Paths.GetMessageV2.Responses.$200>
|
|
1940
|
+
/**
|
|
1941
|
+
* generateSuggestedReply - generateSuggestedReply
|
|
1942
|
+
*
|
|
1943
|
+
* Generate suggested reply of the message in the thread
|
|
1944
|
+
*/
|
|
1945
|
+
'generateSuggestedReply'(
|
|
1946
|
+
parameters?: Parameters<Paths.GenerateSuggestedReply.PathParameters & Paths.GenerateSuggestedReply.QueryParameters> | null,
|
|
1947
|
+
data?: any,
|
|
1948
|
+
config?: AxiosRequestConfig
|
|
1949
|
+
): OperationResponse<Paths.GenerateSuggestedReply.Responses.$202>
|
|
1950
|
+
/**
|
|
1951
|
+
* getInfo - getInfo
|
|
1952
|
+
*
|
|
1953
|
+
* Get generated information of the thread
|
|
1954
|
+
*/
|
|
1955
|
+
'getInfo'(
|
|
1956
|
+
parameters?: Parameters<Paths.GetInfo.PathParameters & Paths.GetInfo.QueryParameters> | null,
|
|
1957
|
+
data?: any,
|
|
1958
|
+
config?: AxiosRequestConfig
|
|
1959
|
+
): OperationResponse<Paths.GetInfo.Responses.$200>
|
|
1960
|
+
/**
|
|
1961
|
+
* patchInfo - patchInfo
|
|
1962
|
+
*
|
|
1963
|
+
* patch generated information of the thread
|
|
1964
|
+
*/
|
|
1965
|
+
'patchInfo'(
|
|
1966
|
+
parameters?: Parameters<Paths.PatchInfo.PathParameters> | null,
|
|
1967
|
+
data?: Paths.PatchInfo.RequestBody,
|
|
1968
|
+
config?: AxiosRequestConfig
|
|
1969
|
+
): OperationResponse<Paths.PatchInfo.Responses.$204>
|
|
1746
1970
|
}
|
|
1747
1971
|
|
|
1748
1972
|
export interface PathsDictionary {
|
|
@@ -1943,7 +2167,7 @@ export interface PathsDictionary {
|
|
|
1943
2167
|
/**
|
|
1944
2168
|
* assignUsers - assignUsers
|
|
1945
2169
|
*
|
|
1946
|
-
* Assign users to thread for receiving notifications.
|
|
2170
|
+
* Assign users to thread for receiving notifications.
|
|
1947
2171
|
* The operation replaces all existing assigned users in thread.
|
|
1948
2172
|
*
|
|
1949
2173
|
*/
|
|
@@ -1999,6 +2223,42 @@ export interface PathsDictionary {
|
|
|
1999
2223
|
config?: AxiosRequestConfig
|
|
2000
2224
|
): OperationResponse<Paths.GetMessageV2.Responses.$200>
|
|
2001
2225
|
}
|
|
2226
|
+
['/v1/message/messages/{messageId}/genai:reply']: {
|
|
2227
|
+
/**
|
|
2228
|
+
* generateSuggestedReply - generateSuggestedReply
|
|
2229
|
+
*
|
|
2230
|
+
* Generate suggested reply of the message in the thread
|
|
2231
|
+
*/
|
|
2232
|
+
'post'(
|
|
2233
|
+
parameters?: Parameters<Paths.GenerateSuggestedReply.PathParameters & Paths.GenerateSuggestedReply.QueryParameters> | null,
|
|
2234
|
+
data?: any,
|
|
2235
|
+
config?: AxiosRequestConfig
|
|
2236
|
+
): OperationResponse<Paths.GenerateSuggestedReply.Responses.$202>
|
|
2237
|
+
}
|
|
2238
|
+
['/v1/message/threads/{threadId}/genai:info']: {
|
|
2239
|
+
/**
|
|
2240
|
+
* getInfo - getInfo
|
|
2241
|
+
*
|
|
2242
|
+
* Get generated information of the thread
|
|
2243
|
+
*/
|
|
2244
|
+
'get'(
|
|
2245
|
+
parameters?: Parameters<Paths.GetInfo.PathParameters & Paths.GetInfo.QueryParameters> | null,
|
|
2246
|
+
data?: any,
|
|
2247
|
+
config?: AxiosRequestConfig
|
|
2248
|
+
): OperationResponse<Paths.GetInfo.Responses.$200>
|
|
2249
|
+
}
|
|
2250
|
+
['/v1/message/threads/{threadId}/messages/{messageId}/genai:info']: {
|
|
2251
|
+
/**
|
|
2252
|
+
* patchInfo - patchInfo
|
|
2253
|
+
*
|
|
2254
|
+
* patch generated information of the thread
|
|
2255
|
+
*/
|
|
2256
|
+
'patch'(
|
|
2257
|
+
parameters?: Parameters<Paths.PatchInfo.PathParameters> | null,
|
|
2258
|
+
data?: Paths.PatchInfo.RequestBody,
|
|
2259
|
+
config?: AxiosRequestConfig
|
|
2260
|
+
): OperationResponse<Paths.PatchInfo.Responses.$204>
|
|
2261
|
+
}
|
|
2002
2262
|
}
|
|
2003
2263
|
|
|
2004
2264
|
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
|
|
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,187 @@
|
|
|
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
|
+
"example": "positive"
|
|
911
|
+
}
|
|
912
|
+
}
|
|
913
|
+
}
|
|
914
|
+
}
|
|
915
|
+
}
|
|
916
|
+
},
|
|
917
|
+
"responses": {
|
|
918
|
+
"204": {
|
|
919
|
+
"description": "Successfully updated, no content to return"
|
|
920
|
+
},
|
|
921
|
+
"400": {
|
|
922
|
+
"description": "Invalid input"
|
|
923
|
+
},
|
|
924
|
+
"403": {
|
|
925
|
+
"description": "Forbidden"
|
|
926
|
+
},
|
|
927
|
+
"500": {
|
|
928
|
+
"description": "Internal server error",
|
|
929
|
+
"content": {
|
|
930
|
+
"application/json": {
|
|
931
|
+
"schema": {
|
|
932
|
+
"type": "object",
|
|
933
|
+
"properties": {
|
|
934
|
+
"error": {
|
|
935
|
+
"type": "string",
|
|
936
|
+
"example": "Internal server error"
|
|
937
|
+
}
|
|
938
|
+
}
|
|
939
|
+
}
|
|
940
|
+
}
|
|
941
|
+
}
|
|
942
|
+
}
|
|
943
|
+
}
|
|
944
|
+
}
|
|
761
945
|
}
|
|
762
946
|
},
|
|
763
947
|
"components": {
|
|
@@ -945,7 +1129,7 @@
|
|
|
945
1129
|
},
|
|
946
1130
|
"references": {
|
|
947
1131
|
"type": "string",
|
|
948
|
-
"description": "References header. Value is the series of `message_id` which is reparated by space to indicate that message has parent
|
|
1132
|
+
"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
1133
|
"example": "<0102017b97a502f8-a67f01c2-68cc-4928-b91b-45853f34e259-000000@eu-west-1.amazonses.com> <CALHgQpziyxW9NaFUs+nRMykzr6Ljq6vjq4WO9SaihAuMasuDyg@mail.gmail.com>"
|
|
950
1134
|
},
|
|
951
1135
|
"in_reply_to": {
|
|
@@ -977,7 +1161,7 @@
|
|
|
977
1161
|
},
|
|
978
1162
|
"send_status": {
|
|
979
1163
|
"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
|
|
1164
|
+
"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
1165
|
"items": {
|
|
982
1166
|
"type": "string",
|
|
983
1167
|
"enum": [
|
|
@@ -1040,7 +1224,7 @@
|
|
|
1040
1224
|
},
|
|
1041
1225
|
"send_status": {
|
|
1042
1226
|
"type": "string",
|
|
1043
|
-
"description": "Sent message status regarding to this recipient
|
|
1227
|
+
"description": "Sent message status regarding to this recipient. Reference at <https://docs.aws.amazon.com/ses/latest/DeveloperGuide/monitor-sending-activity.html>\n",
|
|
1044
1228
|
"enum": [
|
|
1045
1229
|
"SEND",
|
|
1046
1230
|
"DELIVERY",
|
|
@@ -1052,7 +1236,7 @@
|
|
|
1052
1236
|
},
|
|
1053
1237
|
"send_error": {
|
|
1054
1238
|
"type": "object",
|
|
1055
|
-
"description": "Information about reject, complaint or bounce event. Only available if `send_status` is REJECT, COMPLAINT, BOUNCE or ERROR
|
|
1239
|
+
"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
1240
|
}
|
|
1057
1241
|
}
|
|
1058
1242
|
},
|
|
@@ -1096,12 +1280,12 @@
|
|
|
1096
1280
|
},
|
|
1097
1281
|
"inline": {
|
|
1098
1282
|
"type": "boolean",
|
|
1099
|
-
"description": "If true then this attachment should not be offered for download (at least not in the main attachments list)
|
|
1283
|
+
"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
1284
|
"default": false
|
|
1101
1285
|
},
|
|
1102
1286
|
"send_as_link": {
|
|
1103
1287
|
"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
|
|
1288
|
+
"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
1289
|
"default": false
|
|
1106
1290
|
}
|
|
1107
1291
|
}
|
|
@@ -1118,7 +1302,7 @@
|
|
|
1118
1302
|
"required": [
|
|
1119
1303
|
"topic"
|
|
1120
1304
|
],
|
|
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,...)
|
|
1305
|
+
"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
1306
|
"properties": {
|
|
1123
1307
|
"topic": {
|
|
1124
1308
|
"type": "string",
|
|
@@ -1143,7 +1327,7 @@
|
|
|
1143
1327
|
},
|
|
1144
1328
|
"parent_id": {
|
|
1145
1329
|
"type": "string",
|
|
1146
|
-
"description": "Entity ID of parent message which this message replies to or forwards from
|
|
1330
|
+
"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
1331
|
"example": "44d7a3eb-0cce-4bd3-a7cd-0b3e652de0c2"
|
|
1148
1332
|
},
|
|
1149
1333
|
"subject": {
|
|
@@ -1215,12 +1399,100 @@
|
|
|
1215
1399
|
"default": 10
|
|
1216
1400
|
}
|
|
1217
1401
|
}
|
|
1402
|
+
},
|
|
1403
|
+
"GenAIJobOutput": {
|
|
1404
|
+
"type": "object",
|
|
1405
|
+
"properties": {
|
|
1406
|
+
"org_id": {
|
|
1407
|
+
"type": "string",
|
|
1408
|
+
"description": "Organization ID",
|
|
1409
|
+
"example": "739224"
|
|
1410
|
+
},
|
|
1411
|
+
"thread_id": {
|
|
1412
|
+
"type": "string",
|
|
1413
|
+
"description": "Thread ID",
|
|
1414
|
+
"example": "07b8b522-a993-4021-8fae-fd19f330ee60"
|
|
1415
|
+
},
|
|
1416
|
+
"message_id": {
|
|
1417
|
+
"type": "string",
|
|
1418
|
+
"description": "Message ID",
|
|
1419
|
+
"example": "c03eb411-9f75-4ff0-9404-5a61c5b8798d"
|
|
1420
|
+
},
|
|
1421
|
+
"type": {
|
|
1422
|
+
"type": "string",
|
|
1423
|
+
"description": "Job type",
|
|
1424
|
+
"enum": [
|
|
1425
|
+
"INFO",
|
|
1426
|
+
"REPLY"
|
|
1427
|
+
]
|
|
1428
|
+
}
|
|
1429
|
+
}
|
|
1430
|
+
},
|
|
1431
|
+
"GenAIJobOutputPayload": {
|
|
1432
|
+
"type": "object",
|
|
1433
|
+
"properties": {
|
|
1434
|
+
"status": {
|
|
1435
|
+
"type": "string",
|
|
1436
|
+
"enum": [
|
|
1437
|
+
"IN_PROGRESS",
|
|
1438
|
+
"COMPLETED",
|
|
1439
|
+
"FAILED"
|
|
1440
|
+
],
|
|
1441
|
+
"description": "Status of the GenAI job",
|
|
1442
|
+
"example": "COMPLETED"
|
|
1443
|
+
},
|
|
1444
|
+
"progress": {
|
|
1445
|
+
"type": "number",
|
|
1446
|
+
"description": "Progress of the GenAI job in percentage",
|
|
1447
|
+
"example": 100
|
|
1448
|
+
},
|
|
1449
|
+
"error": {
|
|
1450
|
+
"type": "string",
|
|
1451
|
+
"description": "Error message if the job failed",
|
|
1452
|
+
"example": "Failed to generate summary",
|
|
1453
|
+
"nullable": true
|
|
1454
|
+
},
|
|
1455
|
+
"created_at": {
|
|
1456
|
+
"type": "number",
|
|
1457
|
+
"description": "Job created date",
|
|
1458
|
+
"example": 1612900000000
|
|
1459
|
+
},
|
|
1460
|
+
"updated_at": {
|
|
1461
|
+
"type": "number",
|
|
1462
|
+
"description": "Job last updated date",
|
|
1463
|
+
"example": 1612900000000
|
|
1464
|
+
}
|
|
1465
|
+
}
|
|
1466
|
+
},
|
|
1467
|
+
"GenAIInfoJobOutputPayload": {
|
|
1468
|
+
"type": "object",
|
|
1469
|
+
"properties": {
|
|
1470
|
+
"summary": {
|
|
1471
|
+
"type": "string",
|
|
1472
|
+
"description": "Generated summary",
|
|
1473
|
+
"example": "Customer is interested in solar panels",
|
|
1474
|
+
"nullable": true
|
|
1475
|
+
},
|
|
1476
|
+
"next_steps": {
|
|
1477
|
+
"type": "string",
|
|
1478
|
+
"description": "Next steps",
|
|
1479
|
+
"example": "Send a quote",
|
|
1480
|
+
"nullable": true
|
|
1481
|
+
},
|
|
1482
|
+
"tags": {
|
|
1483
|
+
"type": "array",
|
|
1484
|
+
"description": "Tags",
|
|
1485
|
+
"items": {
|
|
1486
|
+
"type": "string"
|
|
1487
|
+
},
|
|
1488
|
+
"example": [
|
|
1489
|
+
"solar",
|
|
1490
|
+
"quote"
|
|
1491
|
+
],
|
|
1492
|
+
"nullable": true
|
|
1493
|
+
}
|
|
1494
|
+
}
|
|
1218
1495
|
}
|
|
1219
1496
|
}
|
|
1220
|
-
}
|
|
1221
|
-
"servers": [
|
|
1222
|
-
{
|
|
1223
|
-
"url": "https://message.sls.epilot.io"
|
|
1224
|
-
}
|
|
1225
|
-
]
|
|
1497
|
+
}
|
|
1226
1498
|
}
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@epilot/message-client",
|
|
3
|
-
"version": "1.
|
|
3
|
+
"version": "1.9.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
|
|
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",
|