@epilot/message-client 1.11.0 → 1.13.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 +0 -56
- package/dist/openapi.d.ts +53 -601
- package/dist/openapi.json +20 -385
- package/package.json +1 -1
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}]}}},"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,62 +231,6 @@
|
|
|
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
|
-
}
|
|
290
234
|
}
|
|
291
235
|
},
|
|
292
236
|
"components": {},
|
package/dist/openapi.d.ts
CHANGED
|
@@ -22,6 +22,11 @@ declare namespace Components {
|
|
|
22
22
|
* messaging@epilot.cloud
|
|
23
23
|
*/
|
|
24
24
|
address: string;
|
|
25
|
+
/**
|
|
26
|
+
* Type of the email, Internal (360 Agents), Partners, External users(Customers)
|
|
27
|
+
*
|
|
28
|
+
*/
|
|
29
|
+
email_type?: "INTERNAL" | "EXTERNAL" | "PARTNER";
|
|
25
30
|
/**
|
|
26
31
|
* Sent message status regarding to this recipient. Reference at <https://docs.aws.amazon.com/ses/latest/DeveloperGuide/monitor-sending-activity.html>
|
|
27
32
|
*
|
|
@@ -123,131 +128,6 @@ declare namespace Components {
|
|
|
123
128
|
*/
|
|
124
129
|
send_as_link?: boolean;
|
|
125
130
|
}
|
|
126
|
-
export interface GenAIFeedbackPayload {
|
|
127
|
-
/**
|
|
128
|
-
* Rating of the suggested reply
|
|
129
|
-
* example:
|
|
130
|
-
* positive
|
|
131
|
-
*/
|
|
132
|
-
rating?: string | null;
|
|
133
|
-
/**
|
|
134
|
-
* Feedback of the suggested reply
|
|
135
|
-
* example:
|
|
136
|
-
* Good summary
|
|
137
|
-
*/
|
|
138
|
-
feedback?: string | null;
|
|
139
|
-
}
|
|
140
|
-
export interface GenAIInfoJobOutputPayload {
|
|
141
|
-
/**
|
|
142
|
-
* Generated summary
|
|
143
|
-
* example:
|
|
144
|
-
* [
|
|
145
|
-
* "Customer is interested in solar panels"
|
|
146
|
-
* ]
|
|
147
|
-
*/
|
|
148
|
-
summary?: string[] | null;
|
|
149
|
-
/**
|
|
150
|
-
* Topics of the email thread
|
|
151
|
-
* example:
|
|
152
|
-
* [
|
|
153
|
-
* "Product enquiry"
|
|
154
|
-
* ]
|
|
155
|
-
*/
|
|
156
|
-
topics?: string[] | null;
|
|
157
|
-
/**
|
|
158
|
-
* Recommended next steps
|
|
159
|
-
* example:
|
|
160
|
-
* [
|
|
161
|
-
* "The agent should approve the refund"
|
|
162
|
-
* ]
|
|
163
|
-
*/
|
|
164
|
-
next_steps?: string[] | null;
|
|
165
|
-
/**
|
|
166
|
-
* Tags
|
|
167
|
-
* example:
|
|
168
|
-
* [
|
|
169
|
-
* "solar",
|
|
170
|
-
* "quote"
|
|
171
|
-
* ]
|
|
172
|
-
*/
|
|
173
|
-
tags?: string[] | null;
|
|
174
|
-
}
|
|
175
|
-
export interface GenAIJobOutput {
|
|
176
|
-
/**
|
|
177
|
-
* Organization ID
|
|
178
|
-
* example:
|
|
179
|
-
* 739224
|
|
180
|
-
*/
|
|
181
|
-
org_id?: string;
|
|
182
|
-
/**
|
|
183
|
-
* Thread ID
|
|
184
|
-
* example:
|
|
185
|
-
* 07b8b522-a993-4021-8fae-fd19f330ee60
|
|
186
|
-
*/
|
|
187
|
-
thread_id?: string;
|
|
188
|
-
/**
|
|
189
|
-
* Message ID
|
|
190
|
-
* example:
|
|
191
|
-
* c03eb411-9f75-4ff0-9404-5a61c5b8798d
|
|
192
|
-
*/
|
|
193
|
-
message_id?: string;
|
|
194
|
-
/**
|
|
195
|
-
* Job type
|
|
196
|
-
*/
|
|
197
|
-
type?: "INFO" | "REPLY";
|
|
198
|
-
}
|
|
199
|
-
export interface GenAIJobOutputPayload {
|
|
200
|
-
/**
|
|
201
|
-
* Rating of the suggested reply
|
|
202
|
-
* example:
|
|
203
|
-
* positive
|
|
204
|
-
*/
|
|
205
|
-
rating?: string | null;
|
|
206
|
-
/**
|
|
207
|
-
* Feedback of the suggested reply
|
|
208
|
-
* example:
|
|
209
|
-
* Good summary
|
|
210
|
-
*/
|
|
211
|
-
feedback?: string | null;
|
|
212
|
-
/**
|
|
213
|
-
* Status of the GenAI job
|
|
214
|
-
* example:
|
|
215
|
-
* COMPLETED
|
|
216
|
-
*/
|
|
217
|
-
status?: "INITIATED" | "IN_PROGRESS" | "COMPLETED" | "FAILED";
|
|
218
|
-
/**
|
|
219
|
-
* Progress of the GenAI job in percentage
|
|
220
|
-
* example:
|
|
221
|
-
* 100
|
|
222
|
-
*/
|
|
223
|
-
progress?: number;
|
|
224
|
-
/**
|
|
225
|
-
* Error message if the job failed
|
|
226
|
-
* example:
|
|
227
|
-
* Failed to generate summary
|
|
228
|
-
*/
|
|
229
|
-
error?: string | null;
|
|
230
|
-
/**
|
|
231
|
-
* Job created date
|
|
232
|
-
* example:
|
|
233
|
-
* 1612900000000
|
|
234
|
-
*/
|
|
235
|
-
created_at?: number;
|
|
236
|
-
/**
|
|
237
|
-
* Job last updated date
|
|
238
|
-
* example:
|
|
239
|
-
* 1612900000000
|
|
240
|
-
*/
|
|
241
|
-
updated_at?: number;
|
|
242
|
-
}
|
|
243
|
-
export interface GenAIReplyJobOutputPayload {
|
|
244
|
-
/**
|
|
245
|
-
* Suggested reply
|
|
246
|
-
* example:
|
|
247
|
-
* Thank you for your inquiry. We will get back to you shortly.
|
|
248
|
-
*/
|
|
249
|
-
suggested_reply?: string | null;
|
|
250
|
-
}
|
|
251
131
|
export interface Message {
|
|
252
132
|
/**
|
|
253
133
|
* Message ID which is from email provider. If you provide `message-id`, API overrides by its own value.
|
|
@@ -325,6 +205,12 @@ declare namespace Components {
|
|
|
325
205
|
* Message type
|
|
326
206
|
*/
|
|
327
207
|
type?: "SENT" | "RECEIVED";
|
|
208
|
+
/**
|
|
209
|
+
* Template ID used for sending message.
|
|
210
|
+
* example:
|
|
211
|
+
* 3f34ce73-089c-4d45-a5ee-c161234e41c3
|
|
212
|
+
*/
|
|
213
|
+
template_id?: string;
|
|
328
214
|
}
|
|
329
215
|
export interface MessageRequestParams {
|
|
330
216
|
[name: string]: any;
|
|
@@ -391,6 +277,12 @@ declare namespace Components {
|
|
|
391
277
|
*/
|
|
392
278
|
bcc?: Address[];
|
|
393
279
|
file?: /* Message attachments */ AttachmentsRelation;
|
|
280
|
+
/**
|
|
281
|
+
* Template ID used for sending message.
|
|
282
|
+
* example:
|
|
283
|
+
* 3f34ce73-089c-4d45-a5ee-c161234e41c3
|
|
284
|
+
*/
|
|
285
|
+
template_id?: string;
|
|
394
286
|
}
|
|
395
287
|
export interface MessageV2 {
|
|
396
288
|
/**
|
|
@@ -512,6 +404,12 @@ declare namespace Components {
|
|
|
512
404
|
* Message type
|
|
513
405
|
*/
|
|
514
406
|
type?: "SENT" | "RECEIVED";
|
|
407
|
+
/**
|
|
408
|
+
* Template ID used for sending message.
|
|
409
|
+
* example:
|
|
410
|
+
* 3f34ce73-089c-4d45-a5ee-c161234e41c3
|
|
411
|
+
*/
|
|
412
|
+
template_id?: string;
|
|
515
413
|
/**
|
|
516
414
|
* If true then html is not provided and must be downloaded using the html_download_url
|
|
517
415
|
*/
|
|
@@ -752,6 +650,12 @@ declare namespace Paths {
|
|
|
752
650
|
* Message type
|
|
753
651
|
*/
|
|
754
652
|
type?: "SENT" | "RECEIVED";
|
|
653
|
+
/**
|
|
654
|
+
* Template ID used for sending message.
|
|
655
|
+
* example:
|
|
656
|
+
* 3f34ce73-089c-4d45-a5ee-c161234e41c3
|
|
657
|
+
*/
|
|
658
|
+
template_id?: string;
|
|
755
659
|
}
|
|
756
660
|
export interface $403 {
|
|
757
661
|
}
|
|
@@ -785,215 +689,6 @@ declare namespace Paths {
|
|
|
785
689
|
}
|
|
786
690
|
}
|
|
787
691
|
}
|
|
788
|
-
namespace GenerateSuggestedReply {
|
|
789
|
-
namespace Parameters {
|
|
790
|
-
export type MessageId = string; // UUID
|
|
791
|
-
export type ThreadId = string; // UUID
|
|
792
|
-
}
|
|
793
|
-
export interface PathParameters {
|
|
794
|
-
messageId: Parameters.MessageId /* UUID */;
|
|
795
|
-
}
|
|
796
|
-
export interface QueryParameters {
|
|
797
|
-
threadId: Parameters.ThreadId /* UUID */;
|
|
798
|
-
}
|
|
799
|
-
namespace Responses {
|
|
800
|
-
export interface $200 {
|
|
801
|
-
/**
|
|
802
|
-
* Organization ID
|
|
803
|
-
* example:
|
|
804
|
-
* 739224
|
|
805
|
-
*/
|
|
806
|
-
org_id?: string;
|
|
807
|
-
/**
|
|
808
|
-
* Thread ID
|
|
809
|
-
* example:
|
|
810
|
-
* 07b8b522-a993-4021-8fae-fd19f330ee60
|
|
811
|
-
*/
|
|
812
|
-
thread_id?: string;
|
|
813
|
-
/**
|
|
814
|
-
* Message ID
|
|
815
|
-
* example:
|
|
816
|
-
* c03eb411-9f75-4ff0-9404-5a61c5b8798d
|
|
817
|
-
*/
|
|
818
|
-
message_id?: string;
|
|
819
|
-
/**
|
|
820
|
-
* Job type
|
|
821
|
-
*/
|
|
822
|
-
type?: "INFO" | "REPLY";
|
|
823
|
-
payload?: {
|
|
824
|
-
/**
|
|
825
|
-
* Suggested reply
|
|
826
|
-
* example:
|
|
827
|
-
* Thank you for your inquiry. We will get back to you shortly.
|
|
828
|
-
*/
|
|
829
|
-
suggested_reply?: string | null;
|
|
830
|
-
/**
|
|
831
|
-
* Rating of the suggested reply
|
|
832
|
-
* example:
|
|
833
|
-
* positive
|
|
834
|
-
*/
|
|
835
|
-
rating?: string | null;
|
|
836
|
-
/**
|
|
837
|
-
* Feedback of the suggested reply
|
|
838
|
-
* example:
|
|
839
|
-
* Good summary
|
|
840
|
-
*/
|
|
841
|
-
feedback?: string | null;
|
|
842
|
-
/**
|
|
843
|
-
* Status of the GenAI job
|
|
844
|
-
* example:
|
|
845
|
-
* COMPLETED
|
|
846
|
-
*/
|
|
847
|
-
status?: "INITIATED" | "IN_PROGRESS" | "COMPLETED" | "FAILED";
|
|
848
|
-
/**
|
|
849
|
-
* Progress of the GenAI job in percentage
|
|
850
|
-
* example:
|
|
851
|
-
* 100
|
|
852
|
-
*/
|
|
853
|
-
progress?: number;
|
|
854
|
-
/**
|
|
855
|
-
* Error message if the job failed
|
|
856
|
-
* example:
|
|
857
|
-
* Failed to generate summary
|
|
858
|
-
*/
|
|
859
|
-
error?: string | null;
|
|
860
|
-
/**
|
|
861
|
-
* Job created date
|
|
862
|
-
* example:
|
|
863
|
-
* 1612900000000
|
|
864
|
-
*/
|
|
865
|
-
created_at?: number;
|
|
866
|
-
/**
|
|
867
|
-
* Job last updated date
|
|
868
|
-
* example:
|
|
869
|
-
* 1612900000000
|
|
870
|
-
*/
|
|
871
|
-
updated_at?: number;
|
|
872
|
-
};
|
|
873
|
-
}
|
|
874
|
-
export interface $202 {
|
|
875
|
-
}
|
|
876
|
-
export interface $403 {
|
|
877
|
-
}
|
|
878
|
-
}
|
|
879
|
-
}
|
|
880
|
-
namespace GetInfo {
|
|
881
|
-
namespace Parameters {
|
|
882
|
-
export type MessageId = string; // UUID
|
|
883
|
-
export type ThreadId = string; // UUID
|
|
884
|
-
}
|
|
885
|
-
export interface PathParameters {
|
|
886
|
-
threadId: Parameters.ThreadId /* UUID */;
|
|
887
|
-
}
|
|
888
|
-
export interface QueryParameters {
|
|
889
|
-
messageId?: Parameters.MessageId /* UUID */;
|
|
890
|
-
}
|
|
891
|
-
namespace Responses {
|
|
892
|
-
export interface $200 {
|
|
893
|
-
/**
|
|
894
|
-
* Organization ID
|
|
895
|
-
* example:
|
|
896
|
-
* 739224
|
|
897
|
-
*/
|
|
898
|
-
org_id?: string;
|
|
899
|
-
/**
|
|
900
|
-
* Thread ID
|
|
901
|
-
* example:
|
|
902
|
-
* 07b8b522-a993-4021-8fae-fd19f330ee60
|
|
903
|
-
*/
|
|
904
|
-
thread_id?: string;
|
|
905
|
-
/**
|
|
906
|
-
* Message ID
|
|
907
|
-
* example:
|
|
908
|
-
* c03eb411-9f75-4ff0-9404-5a61c5b8798d
|
|
909
|
-
*/
|
|
910
|
-
message_id?: string;
|
|
911
|
-
/**
|
|
912
|
-
* Job type
|
|
913
|
-
*/
|
|
914
|
-
type?: "INFO" | "REPLY";
|
|
915
|
-
payload?: {
|
|
916
|
-
/**
|
|
917
|
-
* Generated summary
|
|
918
|
-
* example:
|
|
919
|
-
* [
|
|
920
|
-
* "Customer is interested in solar panels"
|
|
921
|
-
* ]
|
|
922
|
-
*/
|
|
923
|
-
summary?: string[] | null;
|
|
924
|
-
/**
|
|
925
|
-
* Topics of the email thread
|
|
926
|
-
* example:
|
|
927
|
-
* [
|
|
928
|
-
* "Product enquiry"
|
|
929
|
-
* ]
|
|
930
|
-
*/
|
|
931
|
-
topics?: string[] | null;
|
|
932
|
-
/**
|
|
933
|
-
* Recommended next steps
|
|
934
|
-
* example:
|
|
935
|
-
* [
|
|
936
|
-
* "The agent should approve the refund"
|
|
937
|
-
* ]
|
|
938
|
-
*/
|
|
939
|
-
next_steps?: string[] | null;
|
|
940
|
-
/**
|
|
941
|
-
* Tags
|
|
942
|
-
* example:
|
|
943
|
-
* [
|
|
944
|
-
* "solar",
|
|
945
|
-
* "quote"
|
|
946
|
-
* ]
|
|
947
|
-
*/
|
|
948
|
-
tags?: string[] | null;
|
|
949
|
-
/**
|
|
950
|
-
* Rating of the suggested reply
|
|
951
|
-
* example:
|
|
952
|
-
* positive
|
|
953
|
-
*/
|
|
954
|
-
rating?: string | null;
|
|
955
|
-
/**
|
|
956
|
-
* Feedback of the suggested reply
|
|
957
|
-
* example:
|
|
958
|
-
* Good summary
|
|
959
|
-
*/
|
|
960
|
-
feedback?: string | null;
|
|
961
|
-
/**
|
|
962
|
-
* Status of the GenAI job
|
|
963
|
-
* example:
|
|
964
|
-
* COMPLETED
|
|
965
|
-
*/
|
|
966
|
-
status?: "INITIATED" | "IN_PROGRESS" | "COMPLETED" | "FAILED";
|
|
967
|
-
/**
|
|
968
|
-
* Progress of the GenAI job in percentage
|
|
969
|
-
* example:
|
|
970
|
-
* 100
|
|
971
|
-
*/
|
|
972
|
-
progress?: number;
|
|
973
|
-
/**
|
|
974
|
-
* Error message if the job failed
|
|
975
|
-
* example:
|
|
976
|
-
* Failed to generate summary
|
|
977
|
-
*/
|
|
978
|
-
error?: string | null;
|
|
979
|
-
/**
|
|
980
|
-
* Job created date
|
|
981
|
-
* example:
|
|
982
|
-
* 1612900000000
|
|
983
|
-
*/
|
|
984
|
-
created_at?: number;
|
|
985
|
-
/**
|
|
986
|
-
* Job last updated date
|
|
987
|
-
* example:
|
|
988
|
-
* 1612900000000
|
|
989
|
-
*/
|
|
990
|
-
updated_at?: number;
|
|
991
|
-
};
|
|
992
|
-
}
|
|
993
|
-
export interface $403 {
|
|
994
|
-
}
|
|
995
|
-
}
|
|
996
|
-
}
|
|
997
692
|
namespace GetMessage {
|
|
998
693
|
namespace Parameters {
|
|
999
694
|
/**
|
|
@@ -1130,6 +825,12 @@ declare namespace Paths {
|
|
|
1130
825
|
* Message type
|
|
1131
826
|
*/
|
|
1132
827
|
type?: "SENT" | "RECEIVED";
|
|
828
|
+
/**
|
|
829
|
+
* Template ID used for sending message.
|
|
830
|
+
* example:
|
|
831
|
+
* 3f34ce73-089c-4d45-a5ee-c161234e41c3
|
|
832
|
+
*/
|
|
833
|
+
template_id?: string;
|
|
1133
834
|
}
|
|
1134
835
|
export interface $302 {
|
|
1135
836
|
}
|
|
@@ -1273,6 +974,12 @@ declare namespace Paths {
|
|
|
1273
974
|
* Message type
|
|
1274
975
|
*/
|
|
1275
976
|
type?: "SENT" | "RECEIVED";
|
|
977
|
+
/**
|
|
978
|
+
* Template ID used for sending message.
|
|
979
|
+
* example:
|
|
980
|
+
* 3f34ce73-089c-4d45-a5ee-c161234e41c3
|
|
981
|
+
*/
|
|
982
|
+
template_id?: string;
|
|
1276
983
|
/**
|
|
1277
984
|
* If true then html is not provided and must be downloaded using the html_download_url
|
|
1278
985
|
*/
|
|
@@ -1344,207 +1051,6 @@ declare namespace Paths {
|
|
|
1344
1051
|
}
|
|
1345
1052
|
}
|
|
1346
1053
|
}
|
|
1347
|
-
namespace PatchInfo {
|
|
1348
|
-
namespace Parameters {
|
|
1349
|
-
export type MessageId = string; // UUID
|
|
1350
|
-
export type ThreadId = string; // UUID
|
|
1351
|
-
}
|
|
1352
|
-
export interface PathParameters {
|
|
1353
|
-
threadId: Parameters.ThreadId /* UUID */;
|
|
1354
|
-
messageId: Parameters.MessageId /* UUID */;
|
|
1355
|
-
}
|
|
1356
|
-
export interface RequestBody {
|
|
1357
|
-
/**
|
|
1358
|
-
* Generated summary
|
|
1359
|
-
* example:
|
|
1360
|
-
* [
|
|
1361
|
-
* "Customer is interested in solar panels"
|
|
1362
|
-
* ]
|
|
1363
|
-
*/
|
|
1364
|
-
summary?: string[] | null;
|
|
1365
|
-
/**
|
|
1366
|
-
* Topics of the email thread
|
|
1367
|
-
* example:
|
|
1368
|
-
* [
|
|
1369
|
-
* "Product enquiry"
|
|
1370
|
-
* ]
|
|
1371
|
-
*/
|
|
1372
|
-
topics?: string[] | null;
|
|
1373
|
-
/**
|
|
1374
|
-
* Recommended next steps
|
|
1375
|
-
* example:
|
|
1376
|
-
* [
|
|
1377
|
-
* "The agent should approve the refund"
|
|
1378
|
-
* ]
|
|
1379
|
-
*/
|
|
1380
|
-
next_steps?: string[] | null;
|
|
1381
|
-
/**
|
|
1382
|
-
* Tags
|
|
1383
|
-
* example:
|
|
1384
|
-
* [
|
|
1385
|
-
* "solar",
|
|
1386
|
-
* "quote"
|
|
1387
|
-
* ]
|
|
1388
|
-
*/
|
|
1389
|
-
tags?: string[] | null;
|
|
1390
|
-
/**
|
|
1391
|
-
* Rating of the suggested reply
|
|
1392
|
-
* example:
|
|
1393
|
-
* positive
|
|
1394
|
-
*/
|
|
1395
|
-
rating?: string | null;
|
|
1396
|
-
/**
|
|
1397
|
-
* Feedback of the suggested reply
|
|
1398
|
-
* example:
|
|
1399
|
-
* Good summary
|
|
1400
|
-
*/
|
|
1401
|
-
feedback?: string | null;
|
|
1402
|
-
/**
|
|
1403
|
-
* Status of the GenAI job
|
|
1404
|
-
* example:
|
|
1405
|
-
* COMPLETED
|
|
1406
|
-
*/
|
|
1407
|
-
status?: "INITIATED" | "IN_PROGRESS" | "COMPLETED" | "FAILED";
|
|
1408
|
-
/**
|
|
1409
|
-
* Progress of the GenAI job in percentage
|
|
1410
|
-
* example:
|
|
1411
|
-
* 100
|
|
1412
|
-
*/
|
|
1413
|
-
progress?: number;
|
|
1414
|
-
/**
|
|
1415
|
-
* Error message if the job failed
|
|
1416
|
-
* example:
|
|
1417
|
-
* Failed to generate summary
|
|
1418
|
-
*/
|
|
1419
|
-
error?: string | null;
|
|
1420
|
-
/**
|
|
1421
|
-
* Job created date
|
|
1422
|
-
* example:
|
|
1423
|
-
* 1612900000000
|
|
1424
|
-
*/
|
|
1425
|
-
created_at?: number;
|
|
1426
|
-
/**
|
|
1427
|
-
* Job last updated date
|
|
1428
|
-
* example:
|
|
1429
|
-
* 1612900000000
|
|
1430
|
-
*/
|
|
1431
|
-
updated_at?: number;
|
|
1432
|
-
}
|
|
1433
|
-
namespace Responses {
|
|
1434
|
-
export interface $200 {
|
|
1435
|
-
/**
|
|
1436
|
-
* Organization ID
|
|
1437
|
-
* example:
|
|
1438
|
-
* 739224
|
|
1439
|
-
*/
|
|
1440
|
-
org_id?: string;
|
|
1441
|
-
/**
|
|
1442
|
-
* Thread ID
|
|
1443
|
-
* example:
|
|
1444
|
-
* 07b8b522-a993-4021-8fae-fd19f330ee60
|
|
1445
|
-
*/
|
|
1446
|
-
thread_id?: string;
|
|
1447
|
-
/**
|
|
1448
|
-
* Message ID
|
|
1449
|
-
* example:
|
|
1450
|
-
* c03eb411-9f75-4ff0-9404-5a61c5b8798d
|
|
1451
|
-
*/
|
|
1452
|
-
message_id?: string;
|
|
1453
|
-
/**
|
|
1454
|
-
* Job type
|
|
1455
|
-
*/
|
|
1456
|
-
type?: "INFO" | "REPLY";
|
|
1457
|
-
payload?: {
|
|
1458
|
-
/**
|
|
1459
|
-
* Generated summary
|
|
1460
|
-
* example:
|
|
1461
|
-
* [
|
|
1462
|
-
* "Customer is interested in solar panels"
|
|
1463
|
-
* ]
|
|
1464
|
-
*/
|
|
1465
|
-
summary?: string[] | null;
|
|
1466
|
-
/**
|
|
1467
|
-
* Topics of the email thread
|
|
1468
|
-
* example:
|
|
1469
|
-
* [
|
|
1470
|
-
* "Product enquiry"
|
|
1471
|
-
* ]
|
|
1472
|
-
*/
|
|
1473
|
-
topics?: string[] | null;
|
|
1474
|
-
/**
|
|
1475
|
-
* Recommended next steps
|
|
1476
|
-
* example:
|
|
1477
|
-
* [
|
|
1478
|
-
* "The agent should approve the refund"
|
|
1479
|
-
* ]
|
|
1480
|
-
*/
|
|
1481
|
-
next_steps?: string[] | null;
|
|
1482
|
-
/**
|
|
1483
|
-
* Tags
|
|
1484
|
-
* example:
|
|
1485
|
-
* [
|
|
1486
|
-
* "solar",
|
|
1487
|
-
* "quote"
|
|
1488
|
-
* ]
|
|
1489
|
-
*/
|
|
1490
|
-
tags?: string[] | null;
|
|
1491
|
-
/**
|
|
1492
|
-
* Rating of the suggested reply
|
|
1493
|
-
* example:
|
|
1494
|
-
* positive
|
|
1495
|
-
*/
|
|
1496
|
-
rating?: string | null;
|
|
1497
|
-
/**
|
|
1498
|
-
* Feedback of the suggested reply
|
|
1499
|
-
* example:
|
|
1500
|
-
* Good summary
|
|
1501
|
-
*/
|
|
1502
|
-
feedback?: string | null;
|
|
1503
|
-
/**
|
|
1504
|
-
* Status of the GenAI job
|
|
1505
|
-
* example:
|
|
1506
|
-
* COMPLETED
|
|
1507
|
-
*/
|
|
1508
|
-
status?: "INITIATED" | "IN_PROGRESS" | "COMPLETED" | "FAILED";
|
|
1509
|
-
/**
|
|
1510
|
-
* Progress of the GenAI job in percentage
|
|
1511
|
-
* example:
|
|
1512
|
-
* 100
|
|
1513
|
-
*/
|
|
1514
|
-
progress?: number;
|
|
1515
|
-
/**
|
|
1516
|
-
* Error message if the job failed
|
|
1517
|
-
* example:
|
|
1518
|
-
* Failed to generate summary
|
|
1519
|
-
*/
|
|
1520
|
-
error?: string | null;
|
|
1521
|
-
/**
|
|
1522
|
-
* Job created date
|
|
1523
|
-
* example:
|
|
1524
|
-
* 1612900000000
|
|
1525
|
-
*/
|
|
1526
|
-
created_at?: number;
|
|
1527
|
-
/**
|
|
1528
|
-
* Job last updated date
|
|
1529
|
-
* example:
|
|
1530
|
-
* 1612900000000
|
|
1531
|
-
*/
|
|
1532
|
-
updated_at?: number;
|
|
1533
|
-
};
|
|
1534
|
-
}
|
|
1535
|
-
export interface $400 {
|
|
1536
|
-
}
|
|
1537
|
-
export interface $403 {
|
|
1538
|
-
}
|
|
1539
|
-
export interface $500 {
|
|
1540
|
-
/**
|
|
1541
|
-
* example:
|
|
1542
|
-
* Internal server error
|
|
1543
|
-
*/
|
|
1544
|
-
error?: string;
|
|
1545
|
-
}
|
|
1546
|
-
}
|
|
1547
|
-
}
|
|
1548
1054
|
namespace SearchThreads {
|
|
1549
1055
|
export type RequestBody = Components.Schemas.SearchParams;
|
|
1550
1056
|
namespace Responses {
|
|
@@ -1752,6 +1258,12 @@ declare namespace Paths {
|
|
|
1752
1258
|
* Message type
|
|
1753
1259
|
*/
|
|
1754
1260
|
type?: "SENT" | "RECEIVED";
|
|
1261
|
+
/**
|
|
1262
|
+
* Template ID used for sending message.
|
|
1263
|
+
* example:
|
|
1264
|
+
* 3f34ce73-089c-4d45-a5ee-c161234e41c3
|
|
1265
|
+
*/
|
|
1266
|
+
template_id?: string;
|
|
1755
1267
|
}
|
|
1756
1268
|
export interface $403 {
|
|
1757
1269
|
}
|
|
@@ -1949,6 +1461,12 @@ declare namespace Paths {
|
|
|
1949
1461
|
* Message type
|
|
1950
1462
|
*/
|
|
1951
1463
|
type?: "SENT" | "RECEIVED";
|
|
1464
|
+
/**
|
|
1465
|
+
* Template ID used for sending message.
|
|
1466
|
+
* example:
|
|
1467
|
+
* 3f34ce73-089c-4d45-a5ee-c161234e41c3
|
|
1468
|
+
*/
|
|
1469
|
+
template_id?: string;
|
|
1952
1470
|
}
|
|
1953
1471
|
export interface $403 {
|
|
1954
1472
|
}
|
|
@@ -2250,36 +1768,6 @@ export interface OperationMethods {
|
|
|
2250
1768
|
data?: any,
|
|
2251
1769
|
config?: AxiosRequestConfig
|
|
2252
1770
|
): OperationResponse<Paths.GetMessageV2.Responses.$200>
|
|
2253
|
-
/**
|
|
2254
|
-
* generateSuggestedReply - generateSuggestedReply
|
|
2255
|
-
*
|
|
2256
|
-
* Generate suggested reply of the message in the thread
|
|
2257
|
-
*/
|
|
2258
|
-
'generateSuggestedReply'(
|
|
2259
|
-
parameters?: Parameters<Paths.GenerateSuggestedReply.PathParameters & Paths.GenerateSuggestedReply.QueryParameters> | null,
|
|
2260
|
-
data?: any,
|
|
2261
|
-
config?: AxiosRequestConfig
|
|
2262
|
-
): OperationResponse<Paths.GenerateSuggestedReply.Responses.$200 | Paths.GenerateSuggestedReply.Responses.$202>
|
|
2263
|
-
/**
|
|
2264
|
-
* getInfo - getInfo
|
|
2265
|
-
*
|
|
2266
|
-
* Get generated information of the thread
|
|
2267
|
-
*/
|
|
2268
|
-
'getInfo'(
|
|
2269
|
-
parameters?: Parameters<Paths.GetInfo.PathParameters & Paths.GetInfo.QueryParameters> | null,
|
|
2270
|
-
data?: any,
|
|
2271
|
-
config?: AxiosRequestConfig
|
|
2272
|
-
): OperationResponse<Paths.GetInfo.Responses.$200>
|
|
2273
|
-
/**
|
|
2274
|
-
* patchInfo - patchInfo
|
|
2275
|
-
*
|
|
2276
|
-
* patch generated information of the thread
|
|
2277
|
-
*/
|
|
2278
|
-
'patchInfo'(
|
|
2279
|
-
parameters?: Parameters<Paths.PatchInfo.PathParameters> | null,
|
|
2280
|
-
data?: Paths.PatchInfo.RequestBody,
|
|
2281
|
-
config?: AxiosRequestConfig
|
|
2282
|
-
): OperationResponse<Paths.PatchInfo.Responses.$200>
|
|
2283
1771
|
}
|
|
2284
1772
|
|
|
2285
1773
|
export interface PathsDictionary {
|
|
@@ -2536,42 +2024,6 @@ export interface PathsDictionary {
|
|
|
2536
2024
|
config?: AxiosRequestConfig
|
|
2537
2025
|
): OperationResponse<Paths.GetMessageV2.Responses.$200>
|
|
2538
2026
|
}
|
|
2539
|
-
['/v1/message/messages/{messageId}/genai:reply']: {
|
|
2540
|
-
/**
|
|
2541
|
-
* generateSuggestedReply - generateSuggestedReply
|
|
2542
|
-
*
|
|
2543
|
-
* Generate suggested reply of the message in the thread
|
|
2544
|
-
*/
|
|
2545
|
-
'post'(
|
|
2546
|
-
parameters?: Parameters<Paths.GenerateSuggestedReply.PathParameters & Paths.GenerateSuggestedReply.QueryParameters> | null,
|
|
2547
|
-
data?: any,
|
|
2548
|
-
config?: AxiosRequestConfig
|
|
2549
|
-
): OperationResponse<Paths.GenerateSuggestedReply.Responses.$200 | Paths.GenerateSuggestedReply.Responses.$202>
|
|
2550
|
-
}
|
|
2551
|
-
['/v1/message/threads/{threadId}/genai:info']: {
|
|
2552
|
-
/**
|
|
2553
|
-
* getInfo - getInfo
|
|
2554
|
-
*
|
|
2555
|
-
* Get generated information of the thread
|
|
2556
|
-
*/
|
|
2557
|
-
'get'(
|
|
2558
|
-
parameters?: Parameters<Paths.GetInfo.PathParameters & Paths.GetInfo.QueryParameters> | null,
|
|
2559
|
-
data?: any,
|
|
2560
|
-
config?: AxiosRequestConfig
|
|
2561
|
-
): OperationResponse<Paths.GetInfo.Responses.$200>
|
|
2562
|
-
}
|
|
2563
|
-
['/v1/message/threads/{threadId}/messages/{messageId}/genai:info']: {
|
|
2564
|
-
/**
|
|
2565
|
-
* patchInfo - patchInfo
|
|
2566
|
-
*
|
|
2567
|
-
* patch generated information of the thread
|
|
2568
|
-
*/
|
|
2569
|
-
'patch'(
|
|
2570
|
-
parameters?: Parameters<Paths.PatchInfo.PathParameters> | null,
|
|
2571
|
-
data?: Paths.PatchInfo.RequestBody,
|
|
2572
|
-
config?: AxiosRequestConfig
|
|
2573
|
-
): OperationResponse<Paths.PatchInfo.Responses.$200>
|
|
2574
|
-
}
|
|
2575
2027
|
}
|
|
2576
2028
|
|
|
2577
2029
|
export type Client = OpenAPIClient<OperationMethods, PathsDictionary>
|
package/dist/openapi.json
CHANGED
|
@@ -22,9 +22,6 @@
|
|
|
22
22
|
},
|
|
23
23
|
{
|
|
24
24
|
"name": "Drafts"
|
|
25
|
-
},
|
|
26
|
-
{
|
|
27
|
-
"name": "GenAI"
|
|
28
25
|
}
|
|
29
26
|
],
|
|
30
27
|
"paths": {
|
|
@@ -761,243 +758,6 @@
|
|
|
761
758
|
}
|
|
762
759
|
}
|
|
763
760
|
}
|
|
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
|
-
"200": {
|
|
797
|
-
"description": "Success",
|
|
798
|
-
"content": {
|
|
799
|
-
"application/json": {
|
|
800
|
-
"schema": {
|
|
801
|
-
"allOf": [
|
|
802
|
-
{
|
|
803
|
-
"$ref": "#/components/schemas/GenAIJobOutput"
|
|
804
|
-
},
|
|
805
|
-
{
|
|
806
|
-
"type": "object",
|
|
807
|
-
"properties": {
|
|
808
|
-
"payload": {
|
|
809
|
-
"allOf": [
|
|
810
|
-
{
|
|
811
|
-
"$ref": "#/components/schemas/GenAIReplyJobOutputPayload"
|
|
812
|
-
},
|
|
813
|
-
{
|
|
814
|
-
"$ref": "#/components/schemas/GenAIJobOutputPayload"
|
|
815
|
-
}
|
|
816
|
-
]
|
|
817
|
-
}
|
|
818
|
-
}
|
|
819
|
-
}
|
|
820
|
-
]
|
|
821
|
-
}
|
|
822
|
-
}
|
|
823
|
-
}
|
|
824
|
-
},
|
|
825
|
-
"202": {
|
|
826
|
-
"description": "Accepted"
|
|
827
|
-
},
|
|
828
|
-
"403": {
|
|
829
|
-
"description": "Forbidden"
|
|
830
|
-
}
|
|
831
|
-
}
|
|
832
|
-
}
|
|
833
|
-
},
|
|
834
|
-
"/v1/message/threads/{threadId}/genai:info": {
|
|
835
|
-
"get": {
|
|
836
|
-
"operationId": "getInfo",
|
|
837
|
-
"summary": "getInfo",
|
|
838
|
-
"description": "Get generated information of the thread",
|
|
839
|
-
"tags": [
|
|
840
|
-
"GenAI"
|
|
841
|
-
],
|
|
842
|
-
"parameters": [
|
|
843
|
-
{
|
|
844
|
-
"name": "threadId",
|
|
845
|
-
"description": "Thread ID",
|
|
846
|
-
"in": "path",
|
|
847
|
-
"required": true,
|
|
848
|
-
"schema": {
|
|
849
|
-
"type": "string",
|
|
850
|
-
"format": "UUID"
|
|
851
|
-
}
|
|
852
|
-
},
|
|
853
|
-
{
|
|
854
|
-
"name": "messageId",
|
|
855
|
-
"description": "Message ID, If not passed defaults to latest message ID in the thread",
|
|
856
|
-
"in": "query",
|
|
857
|
-
"schema": {
|
|
858
|
-
"type": "string",
|
|
859
|
-
"format": "UUID"
|
|
860
|
-
}
|
|
861
|
-
}
|
|
862
|
-
],
|
|
863
|
-
"responses": {
|
|
864
|
-
"200": {
|
|
865
|
-
"description": "Success",
|
|
866
|
-
"content": {
|
|
867
|
-
"application/json": {
|
|
868
|
-
"schema": {
|
|
869
|
-
"allOf": [
|
|
870
|
-
{
|
|
871
|
-
"$ref": "#/components/schemas/GenAIJobOutput"
|
|
872
|
-
},
|
|
873
|
-
{
|
|
874
|
-
"type": "object",
|
|
875
|
-
"properties": {
|
|
876
|
-
"payload": {
|
|
877
|
-
"allOf": [
|
|
878
|
-
{
|
|
879
|
-
"$ref": "#/components/schemas/GenAIInfoJobOutputPayload"
|
|
880
|
-
},
|
|
881
|
-
{
|
|
882
|
-
"$ref": "#/components/schemas/GenAIJobOutputPayload"
|
|
883
|
-
}
|
|
884
|
-
]
|
|
885
|
-
}
|
|
886
|
-
}
|
|
887
|
-
}
|
|
888
|
-
]
|
|
889
|
-
}
|
|
890
|
-
}
|
|
891
|
-
}
|
|
892
|
-
},
|
|
893
|
-
"403": {
|
|
894
|
-
"description": "Forbidden"
|
|
895
|
-
}
|
|
896
|
-
}
|
|
897
|
-
}
|
|
898
|
-
},
|
|
899
|
-
"/v1/message/threads/{threadId}/messages/{messageId}/genai:info": {
|
|
900
|
-
"patch": {
|
|
901
|
-
"operationId": "patchInfo",
|
|
902
|
-
"summary": "patchInfo",
|
|
903
|
-
"description": "patch generated information of the thread",
|
|
904
|
-
"tags": [
|
|
905
|
-
"GenAI"
|
|
906
|
-
],
|
|
907
|
-
"parameters": [
|
|
908
|
-
{
|
|
909
|
-
"name": "threadId",
|
|
910
|
-
"description": "Thread ID",
|
|
911
|
-
"in": "path",
|
|
912
|
-
"required": true,
|
|
913
|
-
"schema": {
|
|
914
|
-
"type": "string",
|
|
915
|
-
"format": "UUID"
|
|
916
|
-
}
|
|
917
|
-
},
|
|
918
|
-
{
|
|
919
|
-
"name": "messageId",
|
|
920
|
-
"description": "Message ID",
|
|
921
|
-
"in": "path",
|
|
922
|
-
"required": true,
|
|
923
|
-
"schema": {
|
|
924
|
-
"type": "string",
|
|
925
|
-
"format": "UUID"
|
|
926
|
-
}
|
|
927
|
-
}
|
|
928
|
-
],
|
|
929
|
-
"requestBody": {
|
|
930
|
-
"description": "Request body for genai info update",
|
|
931
|
-
"required": true,
|
|
932
|
-
"content": {
|
|
933
|
-
"application/json": {
|
|
934
|
-
"schema": {
|
|
935
|
-
"allOf": [
|
|
936
|
-
{
|
|
937
|
-
"$ref": "#/components/schemas/GenAIInfoJobOutputPayload"
|
|
938
|
-
},
|
|
939
|
-
{
|
|
940
|
-
"$ref": "#/components/schemas/GenAIJobOutputPayload"
|
|
941
|
-
}
|
|
942
|
-
]
|
|
943
|
-
}
|
|
944
|
-
}
|
|
945
|
-
}
|
|
946
|
-
},
|
|
947
|
-
"responses": {
|
|
948
|
-
"200": {
|
|
949
|
-
"description": "Successfully updated, returns the updated info",
|
|
950
|
-
"content": {
|
|
951
|
-
"application/json": {
|
|
952
|
-
"schema": {
|
|
953
|
-
"allOf": [
|
|
954
|
-
{
|
|
955
|
-
"$ref": "#/components/schemas/GenAIJobOutput"
|
|
956
|
-
},
|
|
957
|
-
{
|
|
958
|
-
"type": "object",
|
|
959
|
-
"properties": {
|
|
960
|
-
"payload": {
|
|
961
|
-
"allOf": [
|
|
962
|
-
{
|
|
963
|
-
"$ref": "#/components/schemas/GenAIInfoJobOutputPayload"
|
|
964
|
-
},
|
|
965
|
-
{
|
|
966
|
-
"$ref": "#/components/schemas/GenAIJobOutputPayload"
|
|
967
|
-
}
|
|
968
|
-
]
|
|
969
|
-
}
|
|
970
|
-
}
|
|
971
|
-
}
|
|
972
|
-
]
|
|
973
|
-
}
|
|
974
|
-
}
|
|
975
|
-
}
|
|
976
|
-
},
|
|
977
|
-
"400": {
|
|
978
|
-
"description": "Invalid input"
|
|
979
|
-
},
|
|
980
|
-
"403": {
|
|
981
|
-
"description": "Forbidden"
|
|
982
|
-
},
|
|
983
|
-
"500": {
|
|
984
|
-
"description": "Internal server error",
|
|
985
|
-
"content": {
|
|
986
|
-
"application/json": {
|
|
987
|
-
"schema": {
|
|
988
|
-
"type": "object",
|
|
989
|
-
"properties": {
|
|
990
|
-
"error": {
|
|
991
|
-
"type": "string",
|
|
992
|
-
"example": "Internal server error"
|
|
993
|
-
}
|
|
994
|
-
}
|
|
995
|
-
}
|
|
996
|
-
}
|
|
997
|
-
}
|
|
998
|
-
}
|
|
999
|
-
}
|
|
1000
|
-
}
|
|
1001
761
|
}
|
|
1002
762
|
},
|
|
1003
763
|
"components": {
|
|
@@ -1237,6 +997,11 @@
|
|
|
1237
997
|
"SENT",
|
|
1238
998
|
"RECEIVED"
|
|
1239
999
|
]
|
|
1000
|
+
},
|
|
1001
|
+
"template_id": {
|
|
1002
|
+
"type": "string",
|
|
1003
|
+
"description": "Template ID used for sending message.",
|
|
1004
|
+
"example": "3f34ce73-089c-4d45-a5ee-c161234e41c3"
|
|
1240
1005
|
}
|
|
1241
1006
|
}
|
|
1242
1007
|
},
|
|
@@ -1278,6 +1043,16 @@
|
|
|
1278
1043
|
"description": "Email address",
|
|
1279
1044
|
"example": "messaging@epilot.cloud"
|
|
1280
1045
|
},
|
|
1046
|
+
"email_type": {
|
|
1047
|
+
"type": "string",
|
|
1048
|
+
"description": "Type of the email, Internal (360 Agents), Partners, External users(Customers)\n",
|
|
1049
|
+
"nullable": true,
|
|
1050
|
+
"enum": [
|
|
1051
|
+
"INTERNAL",
|
|
1052
|
+
"EXTERNAL",
|
|
1053
|
+
"PARTNER"
|
|
1054
|
+
]
|
|
1055
|
+
},
|
|
1281
1056
|
"send_status": {
|
|
1282
1057
|
"type": "string",
|
|
1283
1058
|
"description": "Sent message status regarding to this recipient. Reference at <https://docs.aws.amazon.com/ses/latest/DeveloperGuide/monitor-sending-activity.html>\n",
|
|
@@ -1430,6 +1205,11 @@
|
|
|
1430
1205
|
},
|
|
1431
1206
|
"file": {
|
|
1432
1207
|
"$ref": "#/components/schemas/AttachmentsRelation"
|
|
1208
|
+
},
|
|
1209
|
+
"template_id": {
|
|
1210
|
+
"type": "string",
|
|
1211
|
+
"description": "Template ID used for sending message.",
|
|
1212
|
+
"example": "3f34ce73-089c-4d45-a5ee-c161234e41c3"
|
|
1433
1213
|
}
|
|
1434
1214
|
}
|
|
1435
1215
|
},
|
|
@@ -1455,151 +1235,6 @@
|
|
|
1455
1235
|
"default": 10
|
|
1456
1236
|
}
|
|
1457
1237
|
}
|
|
1458
|
-
},
|
|
1459
|
-
"GenAIJobOutput": {
|
|
1460
|
-
"properties": {
|
|
1461
|
-
"org_id": {
|
|
1462
|
-
"type": "string",
|
|
1463
|
-
"description": "Organization ID",
|
|
1464
|
-
"example": "739224"
|
|
1465
|
-
},
|
|
1466
|
-
"thread_id": {
|
|
1467
|
-
"type": "string",
|
|
1468
|
-
"description": "Thread ID",
|
|
1469
|
-
"example": "07b8b522-a993-4021-8fae-fd19f330ee60"
|
|
1470
|
-
},
|
|
1471
|
-
"message_id": {
|
|
1472
|
-
"type": "string",
|
|
1473
|
-
"description": "Message ID",
|
|
1474
|
-
"example": "c03eb411-9f75-4ff0-9404-5a61c5b8798d"
|
|
1475
|
-
},
|
|
1476
|
-
"type": {
|
|
1477
|
-
"type": "string",
|
|
1478
|
-
"description": "Job type",
|
|
1479
|
-
"enum": [
|
|
1480
|
-
"INFO",
|
|
1481
|
-
"REPLY"
|
|
1482
|
-
]
|
|
1483
|
-
}
|
|
1484
|
-
}
|
|
1485
|
-
},
|
|
1486
|
-
"GenAIJobOutputPayload": {
|
|
1487
|
-
"allOf": [
|
|
1488
|
-
{
|
|
1489
|
-
"$ref": "#/components/schemas/GenAIFeedbackPayload"
|
|
1490
|
-
}
|
|
1491
|
-
],
|
|
1492
|
-
"properties": {
|
|
1493
|
-
"status": {
|
|
1494
|
-
"type": "string",
|
|
1495
|
-
"enum": [
|
|
1496
|
-
"INITIATED",
|
|
1497
|
-
"IN_PROGRESS",
|
|
1498
|
-
"COMPLETED",
|
|
1499
|
-
"FAILED"
|
|
1500
|
-
],
|
|
1501
|
-
"description": "Status of the GenAI job",
|
|
1502
|
-
"example": "COMPLETED"
|
|
1503
|
-
},
|
|
1504
|
-
"progress": {
|
|
1505
|
-
"type": "number",
|
|
1506
|
-
"description": "Progress of the GenAI job in percentage",
|
|
1507
|
-
"example": 100
|
|
1508
|
-
},
|
|
1509
|
-
"error": {
|
|
1510
|
-
"type": "string",
|
|
1511
|
-
"description": "Error message if the job failed",
|
|
1512
|
-
"example": "Failed to generate summary",
|
|
1513
|
-
"nullable": true
|
|
1514
|
-
},
|
|
1515
|
-
"created_at": {
|
|
1516
|
-
"type": "number",
|
|
1517
|
-
"description": "Job created date",
|
|
1518
|
-
"example": 1612900000000
|
|
1519
|
-
},
|
|
1520
|
-
"updated_at": {
|
|
1521
|
-
"type": "number",
|
|
1522
|
-
"description": "Job last updated date",
|
|
1523
|
-
"example": 1612900000000
|
|
1524
|
-
}
|
|
1525
|
-
}
|
|
1526
|
-
},
|
|
1527
|
-
"GenAIInfoJobOutputPayload": {
|
|
1528
|
-
"properties": {
|
|
1529
|
-
"summary": {
|
|
1530
|
-
"type": "array",
|
|
1531
|
-
"description": "Generated summary",
|
|
1532
|
-
"items": {
|
|
1533
|
-
"type": "string"
|
|
1534
|
-
},
|
|
1535
|
-
"example": [
|
|
1536
|
-
"Customer is interested in solar panels"
|
|
1537
|
-
],
|
|
1538
|
-
"nullable": true
|
|
1539
|
-
},
|
|
1540
|
-
"topics": {
|
|
1541
|
-
"type": "array",
|
|
1542
|
-
"description": "Topics of the email thread",
|
|
1543
|
-
"items": {
|
|
1544
|
-
"type": "string"
|
|
1545
|
-
},
|
|
1546
|
-
"example": [
|
|
1547
|
-
"Product enquiry"
|
|
1548
|
-
],
|
|
1549
|
-
"nullable": true
|
|
1550
|
-
},
|
|
1551
|
-
"next_steps": {
|
|
1552
|
-
"type": "array",
|
|
1553
|
-
"description": "Recommended next steps",
|
|
1554
|
-
"items": {
|
|
1555
|
-
"type": "string"
|
|
1556
|
-
},
|
|
1557
|
-
"example": [
|
|
1558
|
-
"The agent should approve the refund"
|
|
1559
|
-
],
|
|
1560
|
-
"nullable": true
|
|
1561
|
-
},
|
|
1562
|
-
"tags": {
|
|
1563
|
-
"type": "array",
|
|
1564
|
-
"description": "Tags",
|
|
1565
|
-
"items": {
|
|
1566
|
-
"type": "string"
|
|
1567
|
-
},
|
|
1568
|
-
"example": [
|
|
1569
|
-
"solar",
|
|
1570
|
-
"quote"
|
|
1571
|
-
],
|
|
1572
|
-
"nullable": true
|
|
1573
|
-
}
|
|
1574
|
-
}
|
|
1575
|
-
},
|
|
1576
|
-
"GenAIReplyJobOutputPayload": {
|
|
1577
|
-
"type": "object",
|
|
1578
|
-
"properties": {
|
|
1579
|
-
"suggested_reply": {
|
|
1580
|
-
"type": "string",
|
|
1581
|
-
"description": "Suggested reply",
|
|
1582
|
-
"example": "Thank you for your inquiry. We will get back to you shortly.",
|
|
1583
|
-
"nullable": true
|
|
1584
|
-
}
|
|
1585
|
-
}
|
|
1586
|
-
},
|
|
1587
|
-
"GenAIFeedbackPayload": {
|
|
1588
|
-
"type": "object",
|
|
1589
|
-
"properties": {
|
|
1590
|
-
"rating": {
|
|
1591
|
-
"type": "string",
|
|
1592
|
-
"description": "Rating of the suggested reply",
|
|
1593
|
-
"example": "positive",
|
|
1594
|
-
"nullable": true
|
|
1595
|
-
},
|
|
1596
|
-
"feedback": {
|
|
1597
|
-
"type": "string",
|
|
1598
|
-
"description": "Feedback of the suggested reply",
|
|
1599
|
-
"example": "Good summary",
|
|
1600
|
-
"nullable": true
|
|
1601
|
-
}
|
|
1602
|
-
}
|
|
1603
1238
|
}
|
|
1604
1239
|
}
|
|
1605
1240
|
},
|