@epilot/message-client 1.15.3 → 1.16.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 +143 -0
- package/dist/openapi.d.ts +605 -18
- package/dist/openapi.json +592 -9
- package/package.json +2 -2
package/dist/openapi.d.ts
CHANGED
|
@@ -95,6 +95,35 @@ declare namespace Components {
|
|
|
95
95
|
*/
|
|
96
96
|
_updated_at: string; // date-time
|
|
97
97
|
}
|
|
98
|
+
export interface BulkActionsPayload {
|
|
99
|
+
/**
|
|
100
|
+
* Array of threads you wish to perform bulk actions on
|
|
101
|
+
* example:
|
|
102
|
+
* [
|
|
103
|
+
* "6b299eda-4018-4554-8965-c4b5598e6531"
|
|
104
|
+
* ]
|
|
105
|
+
*/
|
|
106
|
+
ids: string[];
|
|
107
|
+
}
|
|
108
|
+
export interface BulkActionsPayloadWithScopes {
|
|
109
|
+
/**
|
|
110
|
+
* Array of threads you wish to perform bulk actions on
|
|
111
|
+
* example:
|
|
112
|
+
* [
|
|
113
|
+
* "6b299eda-4018-4554-8965-c4b5598e6531"
|
|
114
|
+
* ]
|
|
115
|
+
*/
|
|
116
|
+
ids: string[];
|
|
117
|
+
/**
|
|
118
|
+
* The scopes to be used when marking an item as read or unread. The read status will be synced for all provided scopes.
|
|
119
|
+
* example:
|
|
120
|
+
* [
|
|
121
|
+
* "organization",
|
|
122
|
+
* "user"
|
|
123
|
+
* ]
|
|
124
|
+
*/
|
|
125
|
+
scopes?: /* Who is marking an item as read or unread. */ ReadingScope[];
|
|
126
|
+
}
|
|
98
127
|
export interface File {
|
|
99
128
|
/**
|
|
100
129
|
* File entity ID
|
|
@@ -441,6 +470,14 @@ declare namespace Components {
|
|
|
441
470
|
* Who is marking an item as read or unread.
|
|
442
471
|
*/
|
|
443
472
|
export type ReadingScope = "organization" | "user";
|
|
473
|
+
export interface SearchIDParams {
|
|
474
|
+
/**
|
|
475
|
+
* Lucene query syntax supported with ElasticSearch
|
|
476
|
+
* example:
|
|
477
|
+
* subject:"Request for solar panel price" AND _tags:INBOX
|
|
478
|
+
*/
|
|
479
|
+
q?: string;
|
|
480
|
+
}
|
|
444
481
|
export interface SearchParams {
|
|
445
482
|
/**
|
|
446
483
|
* Lucene query syntax supported with ElasticSearch
|
|
@@ -452,6 +489,20 @@ declare namespace Components {
|
|
|
452
489
|
size?: number;
|
|
453
490
|
hydrate?: boolean;
|
|
454
491
|
}
|
|
492
|
+
export interface SearchParamsV2 {
|
|
493
|
+
/**
|
|
494
|
+
* Lucene query syntax supported with ElasticSearch
|
|
495
|
+
* example:
|
|
496
|
+
* subject:"Request for solar panel price" AND _tags:INBOX
|
|
497
|
+
*/
|
|
498
|
+
q: string;
|
|
499
|
+
from?: number;
|
|
500
|
+
size?: number;
|
|
501
|
+
hydrate?: boolean;
|
|
502
|
+
include_scores?: boolean;
|
|
503
|
+
sort?: string;
|
|
504
|
+
highlight?: any;
|
|
505
|
+
}
|
|
455
506
|
/**
|
|
456
507
|
* Thread properties depend on API caller as it's not pre-defined. We do recommend having at least `topic` property for categorizing.
|
|
457
508
|
*/
|
|
@@ -491,6 +542,49 @@ declare namespace Components {
|
|
|
491
542
|
*/
|
|
492
543
|
latest_message_at?: string;
|
|
493
544
|
}
|
|
545
|
+
export interface ThreadDoneEvent {
|
|
546
|
+
type: "THREAD_DONE";
|
|
547
|
+
/**
|
|
548
|
+
* User ID of the user who marked the thread as done
|
|
549
|
+
* example:
|
|
550
|
+
* 123
|
|
551
|
+
*/
|
|
552
|
+
user_id: string;
|
|
553
|
+
/**
|
|
554
|
+
* Organization ID of the organization who marked the thread as done
|
|
555
|
+
* example:
|
|
556
|
+
* 456
|
|
557
|
+
*/
|
|
558
|
+
organization_id: string;
|
|
559
|
+
}
|
|
560
|
+
export interface ThreadOpenEvent {
|
|
561
|
+
type: "THREAD_OPEN";
|
|
562
|
+
/**
|
|
563
|
+
* User ID of the user who marked the thread as open
|
|
564
|
+
* example:
|
|
565
|
+
* 123
|
|
566
|
+
*/
|
|
567
|
+
user_id: string;
|
|
568
|
+
/**
|
|
569
|
+
* Organization ID of the organization who marked the thread as open
|
|
570
|
+
* example:
|
|
571
|
+
* 456
|
|
572
|
+
*/
|
|
573
|
+
organization_id: string;
|
|
574
|
+
}
|
|
575
|
+
export interface ThreadTimeline {
|
|
576
|
+
events: TimelineEvent[];
|
|
577
|
+
}
|
|
578
|
+
export interface TimelineEvent {
|
|
579
|
+
data: TimelineEventData;
|
|
580
|
+
/**
|
|
581
|
+
* Timestamp of the event
|
|
582
|
+
* example:
|
|
583
|
+
* 2024-01-01T00:00:00.000Z
|
|
584
|
+
*/
|
|
585
|
+
timestamp: string;
|
|
586
|
+
}
|
|
587
|
+
export type TimelineEventData = ThreadDoneEvent | ThreadOpenEvent;
|
|
494
588
|
}
|
|
495
589
|
}
|
|
496
590
|
declare namespace Paths {
|
|
@@ -1028,6 +1122,19 @@ declare namespace Paths {
|
|
|
1028
1122
|
}
|
|
1029
1123
|
}
|
|
1030
1124
|
}
|
|
1125
|
+
namespace GetThreadTimeline {
|
|
1126
|
+
namespace Parameters {
|
|
1127
|
+
export type Id = string;
|
|
1128
|
+
}
|
|
1129
|
+
export interface PathParameters {
|
|
1130
|
+
id: Parameters.Id;
|
|
1131
|
+
}
|
|
1132
|
+
namespace Responses {
|
|
1133
|
+
export type $200 = Components.Schemas.ThreadTimeline;
|
|
1134
|
+
export interface $403 {
|
|
1135
|
+
}
|
|
1136
|
+
}
|
|
1137
|
+
}
|
|
1031
1138
|
namespace MarkReadMessage {
|
|
1032
1139
|
namespace Parameters {
|
|
1033
1140
|
export type Id = string;
|
|
@@ -1065,7 +1172,7 @@ declare namespace Paths {
|
|
|
1065
1172
|
id: Parameters.Id;
|
|
1066
1173
|
}
|
|
1067
1174
|
namespace Responses {
|
|
1068
|
-
export interface $
|
|
1175
|
+
export interface $200 {
|
|
1069
1176
|
}
|
|
1070
1177
|
export interface $403 {
|
|
1071
1178
|
}
|
|
@@ -1080,7 +1187,7 @@ declare namespace Paths {
|
|
|
1080
1187
|
}
|
|
1081
1188
|
export type RequestBody = Components.Schemas.ReadMessagePayload;
|
|
1082
1189
|
namespace Responses {
|
|
1083
|
-
export interface $
|
|
1190
|
+
export interface $200 {
|
|
1084
1191
|
}
|
|
1085
1192
|
export interface $403 {
|
|
1086
1193
|
}
|
|
@@ -1151,7 +1258,7 @@ declare namespace Paths {
|
|
|
1151
1258
|
id: Parameters.Id;
|
|
1152
1259
|
}
|
|
1153
1260
|
namespace Responses {
|
|
1154
|
-
export interface $
|
|
1261
|
+
export interface $200 {
|
|
1155
1262
|
}
|
|
1156
1263
|
export interface $403 {
|
|
1157
1264
|
}
|
|
@@ -1166,7 +1273,26 @@ declare namespace Paths {
|
|
|
1166
1273
|
}
|
|
1167
1274
|
export type RequestBody = Components.Schemas.ReadMessagePayload;
|
|
1168
1275
|
namespace Responses {
|
|
1169
|
-
export interface $
|
|
1276
|
+
export interface $200 {
|
|
1277
|
+
}
|
|
1278
|
+
export interface $403 {
|
|
1279
|
+
}
|
|
1280
|
+
}
|
|
1281
|
+
}
|
|
1282
|
+
namespace SearchIds {
|
|
1283
|
+
export type RequestBody = Components.Schemas.SearchIDParams;
|
|
1284
|
+
namespace Responses {
|
|
1285
|
+
export interface $200 {
|
|
1286
|
+
/**
|
|
1287
|
+
* Total of matched threads
|
|
1288
|
+
* example:
|
|
1289
|
+
* 14
|
|
1290
|
+
*/
|
|
1291
|
+
hits: number;
|
|
1292
|
+
/**
|
|
1293
|
+
* Matched threads ids
|
|
1294
|
+
*/
|
|
1295
|
+
results: string[];
|
|
1170
1296
|
}
|
|
1171
1297
|
export interface $403 {
|
|
1172
1298
|
}
|
|
@@ -1263,6 +1389,97 @@ declare namespace Paths {
|
|
|
1263
1389
|
}
|
|
1264
1390
|
}
|
|
1265
1391
|
}
|
|
1392
|
+
namespace SearchThreadsV2 {
|
|
1393
|
+
export type RequestBody = Components.Schemas.SearchParamsV2;
|
|
1394
|
+
namespace Responses {
|
|
1395
|
+
export interface $200 {
|
|
1396
|
+
/**
|
|
1397
|
+
* Total of matched threads
|
|
1398
|
+
* example:
|
|
1399
|
+
* 14
|
|
1400
|
+
*/
|
|
1401
|
+
hits: number;
|
|
1402
|
+
/**
|
|
1403
|
+
* Matched threads
|
|
1404
|
+
*/
|
|
1405
|
+
results: {
|
|
1406
|
+
/**
|
|
1407
|
+
* Entity ID
|
|
1408
|
+
* example:
|
|
1409
|
+
* 3fa85f64-5717-4562-b3fc-2c963f66afa6
|
|
1410
|
+
*/
|
|
1411
|
+
_id: string;
|
|
1412
|
+
/**
|
|
1413
|
+
* Entity title
|
|
1414
|
+
*/
|
|
1415
|
+
_title: string;
|
|
1416
|
+
/**
|
|
1417
|
+
* Organization ID the entity belongs to
|
|
1418
|
+
* example:
|
|
1419
|
+
* 206801
|
|
1420
|
+
*/
|
|
1421
|
+
_org: string;
|
|
1422
|
+
/**
|
|
1423
|
+
* URL-friendly identifier for the entity schema
|
|
1424
|
+
* example:
|
|
1425
|
+
* message
|
|
1426
|
+
*/
|
|
1427
|
+
_schema: string;
|
|
1428
|
+
/**
|
|
1429
|
+
* Entity tags
|
|
1430
|
+
* example:
|
|
1431
|
+
* [
|
|
1432
|
+
* "pricing",
|
|
1433
|
+
* "INBOX"
|
|
1434
|
+
* ]
|
|
1435
|
+
*/
|
|
1436
|
+
_tags?: string[];
|
|
1437
|
+
/**
|
|
1438
|
+
* Created date
|
|
1439
|
+
* example:
|
|
1440
|
+
* 2021-02-09T12:41:43.662Z
|
|
1441
|
+
*/
|
|
1442
|
+
_created_at: string; // date-time
|
|
1443
|
+
/**
|
|
1444
|
+
* Updated date
|
|
1445
|
+
* example:
|
|
1446
|
+
* 2021-02-10T09:14:31.990Z
|
|
1447
|
+
*/
|
|
1448
|
+
_updated_at: string; // date-time
|
|
1449
|
+
/**
|
|
1450
|
+
* Message topic (e.g. which service sends the message or message category)
|
|
1451
|
+
* example:
|
|
1452
|
+
* CUSTOMER_MESSAGE
|
|
1453
|
+
*/
|
|
1454
|
+
topic: string;
|
|
1455
|
+
/**
|
|
1456
|
+
* User ID of who the message is assigned to. Default is the user who sends message.
|
|
1457
|
+
*/
|
|
1458
|
+
assigned_to?: string[];
|
|
1459
|
+
/**
|
|
1460
|
+
* Organization ID of organization read the message.
|
|
1461
|
+
*/
|
|
1462
|
+
org_read_message?: string[];
|
|
1463
|
+
/**
|
|
1464
|
+
* Whether the thread is marked as Done
|
|
1465
|
+
* example:
|
|
1466
|
+
* false
|
|
1467
|
+
*/
|
|
1468
|
+
done?: boolean;
|
|
1469
|
+
latest_message?: Components.Schemas.Message;
|
|
1470
|
+
latest_trash_message?: Components.Schemas.Message;
|
|
1471
|
+
/**
|
|
1472
|
+
* The date of the latest message time in the thread
|
|
1473
|
+
* example:
|
|
1474
|
+
* 2024-02-10T09:14:31.990Z
|
|
1475
|
+
*/
|
|
1476
|
+
latest_message_at?: string;
|
|
1477
|
+
}[];
|
|
1478
|
+
}
|
|
1479
|
+
export interface $403 {
|
|
1480
|
+
}
|
|
1481
|
+
}
|
|
1482
|
+
}
|
|
1266
1483
|
namespace SendDraft {
|
|
1267
1484
|
namespace Responses {
|
|
1268
1485
|
export interface $201 {
|
|
@@ -1410,6 +1627,87 @@ declare namespace Paths {
|
|
|
1410
1627
|
}
|
|
1411
1628
|
}
|
|
1412
1629
|
}
|
|
1630
|
+
namespace ThreadBulkActionsDelete {
|
|
1631
|
+
export type RequestBody = Components.Schemas.BulkActionsPayload;
|
|
1632
|
+
namespace Responses {
|
|
1633
|
+
export interface $200 {
|
|
1634
|
+
}
|
|
1635
|
+
export interface $403 {
|
|
1636
|
+
}
|
|
1637
|
+
}
|
|
1638
|
+
}
|
|
1639
|
+
namespace ThreadBulkActionsDone {
|
|
1640
|
+
export type RequestBody = Components.Schemas.BulkActionsPayload;
|
|
1641
|
+
namespace Responses {
|
|
1642
|
+
export interface $200 {
|
|
1643
|
+
}
|
|
1644
|
+
export interface $403 {
|
|
1645
|
+
}
|
|
1646
|
+
}
|
|
1647
|
+
}
|
|
1648
|
+
namespace ThreadBulkActionsFavorite {
|
|
1649
|
+
export type RequestBody = Components.Schemas.BulkActionsPayload;
|
|
1650
|
+
namespace Responses {
|
|
1651
|
+
export interface $200 {
|
|
1652
|
+
}
|
|
1653
|
+
export interface $403 {
|
|
1654
|
+
}
|
|
1655
|
+
}
|
|
1656
|
+
}
|
|
1657
|
+
namespace ThreadBulkActionsOpen {
|
|
1658
|
+
export type RequestBody = Components.Schemas.BulkActionsPayload;
|
|
1659
|
+
namespace Responses {
|
|
1660
|
+
export interface $200 {
|
|
1661
|
+
}
|
|
1662
|
+
export interface $403 {
|
|
1663
|
+
}
|
|
1664
|
+
}
|
|
1665
|
+
}
|
|
1666
|
+
namespace ThreadBulkActionsRead {
|
|
1667
|
+
export type RequestBody = Components.Schemas.BulkActionsPayloadWithScopes;
|
|
1668
|
+
namespace Responses {
|
|
1669
|
+
export interface $200 {
|
|
1670
|
+
}
|
|
1671
|
+
export interface $403 {
|
|
1672
|
+
}
|
|
1673
|
+
}
|
|
1674
|
+
}
|
|
1675
|
+
namespace ThreadBulkActionsTrash {
|
|
1676
|
+
export type RequestBody = Components.Schemas.BulkActionsPayload;
|
|
1677
|
+
namespace Responses {
|
|
1678
|
+
export interface $200 {
|
|
1679
|
+
}
|
|
1680
|
+
export interface $403 {
|
|
1681
|
+
}
|
|
1682
|
+
}
|
|
1683
|
+
}
|
|
1684
|
+
namespace ThreadBulkActionsUnfavorite {
|
|
1685
|
+
export type RequestBody = Components.Schemas.BulkActionsPayload;
|
|
1686
|
+
namespace Responses {
|
|
1687
|
+
export interface $200 {
|
|
1688
|
+
}
|
|
1689
|
+
export interface $403 {
|
|
1690
|
+
}
|
|
1691
|
+
}
|
|
1692
|
+
}
|
|
1693
|
+
namespace ThreadBulkActionsUnread {
|
|
1694
|
+
export type RequestBody = Components.Schemas.BulkActionsPayloadWithScopes;
|
|
1695
|
+
namespace Responses {
|
|
1696
|
+
export interface $200 {
|
|
1697
|
+
}
|
|
1698
|
+
export interface $403 {
|
|
1699
|
+
}
|
|
1700
|
+
}
|
|
1701
|
+
}
|
|
1702
|
+
namespace ThreadBulkActionsUntrash {
|
|
1703
|
+
export type RequestBody = Components.Schemas.BulkActionsPayload;
|
|
1704
|
+
namespace Responses {
|
|
1705
|
+
export interface $200 {
|
|
1706
|
+
}
|
|
1707
|
+
export interface $403 {
|
|
1708
|
+
}
|
|
1709
|
+
}
|
|
1710
|
+
}
|
|
1413
1711
|
namespace TrashMessage {
|
|
1414
1712
|
namespace Parameters {
|
|
1415
1713
|
export type Id = string;
|
|
@@ -1432,7 +1730,7 @@ declare namespace Paths {
|
|
|
1432
1730
|
id: Parameters.Id;
|
|
1433
1731
|
}
|
|
1434
1732
|
namespace Responses {
|
|
1435
|
-
export interface $
|
|
1733
|
+
export interface $200 {
|
|
1436
1734
|
}
|
|
1437
1735
|
export interface $403 {
|
|
1438
1736
|
}
|
|
@@ -1491,7 +1789,7 @@ declare namespace Paths {
|
|
|
1491
1789
|
id: Parameters.Id;
|
|
1492
1790
|
}
|
|
1493
1791
|
namespace Responses {
|
|
1494
|
-
export interface $
|
|
1792
|
+
export interface $200 {
|
|
1495
1793
|
}
|
|
1496
1794
|
export interface $403 {
|
|
1497
1795
|
}
|
|
@@ -1830,6 +2128,34 @@ export interface OperationMethods {
|
|
|
1830
2128
|
data?: Paths.SearchThreads.RequestBody,
|
|
1831
2129
|
config?: AxiosRequestConfig
|
|
1832
2130
|
): OperationResponse<Paths.SearchThreads.Responses.$200>
|
|
2131
|
+
/**
|
|
2132
|
+
* searchThreadsV2 - searchThreadsV2
|
|
2133
|
+
*
|
|
2134
|
+
* Search for threads of email messages.
|
|
2135
|
+
*
|
|
2136
|
+
* Messages with no replies yet are treated as threads with single message.
|
|
2137
|
+
*
|
|
2138
|
+
* Lucene syntax supported.
|
|
2139
|
+
*
|
|
2140
|
+
*/
|
|
2141
|
+
'searchThreadsV2'(
|
|
2142
|
+
parameters?: Parameters<UnknownParamsObject> | null,
|
|
2143
|
+
data?: Paths.SearchThreadsV2.RequestBody,
|
|
2144
|
+
config?: AxiosRequestConfig
|
|
2145
|
+
): OperationResponse<Paths.SearchThreadsV2.Responses.$200>
|
|
2146
|
+
/**
|
|
2147
|
+
* searchIds - Search threads and return all id's
|
|
2148
|
+
*
|
|
2149
|
+
* Return all thread id's that match a criteria
|
|
2150
|
+
*
|
|
2151
|
+
* Lucene syntax supported.
|
|
2152
|
+
*
|
|
2153
|
+
*/
|
|
2154
|
+
'searchIds'(
|
|
2155
|
+
parameters?: Parameters<UnknownParamsObject> | null,
|
|
2156
|
+
data?: Paths.SearchIds.RequestBody,
|
|
2157
|
+
config?: AxiosRequestConfig
|
|
2158
|
+
): OperationResponse<Paths.SearchIds.Responses.$200>
|
|
1833
2159
|
/**
|
|
1834
2160
|
* updateThread - updateThread
|
|
1835
2161
|
*
|
|
@@ -1870,6 +2196,16 @@ export interface OperationMethods {
|
|
|
1870
2196
|
data?: any,
|
|
1871
2197
|
config?: AxiosRequestConfig
|
|
1872
2198
|
): OperationResponse<Paths.MarkThreadAsOpen.Responses.$204>
|
|
2199
|
+
/**
|
|
2200
|
+
* getThreadTimeline - getThreadTimeline
|
|
2201
|
+
*
|
|
2202
|
+
* Get thread timeline
|
|
2203
|
+
*/
|
|
2204
|
+
'getThreadTimeline'(
|
|
2205
|
+
parameters?: Parameters<Paths.GetThreadTimeline.PathParameters> | null,
|
|
2206
|
+
data?: any,
|
|
2207
|
+
config?: AxiosRequestConfig
|
|
2208
|
+
): OperationResponse<Paths.GetThreadTimeline.Responses.$200>
|
|
1873
2209
|
/**
|
|
1874
2210
|
* trashThread - trashThread
|
|
1875
2211
|
*
|
|
@@ -1879,7 +2215,7 @@ export interface OperationMethods {
|
|
|
1879
2215
|
parameters?: Parameters<Paths.TrashThread.PathParameters> | null,
|
|
1880
2216
|
data?: any,
|
|
1881
2217
|
config?: AxiosRequestConfig
|
|
1882
|
-
): OperationResponse<Paths.TrashThread.Responses.$
|
|
2218
|
+
): OperationResponse<Paths.TrashThread.Responses.$200>
|
|
1883
2219
|
/**
|
|
1884
2220
|
* untrashThread - untrashThread
|
|
1885
2221
|
*
|
|
@@ -1889,7 +2225,97 @@ export interface OperationMethods {
|
|
|
1889
2225
|
parameters?: Parameters<Paths.UntrashThread.PathParameters> | null,
|
|
1890
2226
|
data?: any,
|
|
1891
2227
|
config?: AxiosRequestConfig
|
|
1892
|
-
): OperationResponse<Paths.UntrashThread.Responses.$
|
|
2228
|
+
): OperationResponse<Paths.UntrashThread.Responses.$200>
|
|
2229
|
+
/**
|
|
2230
|
+
* threadBulkActionsRead - threadBulkActionsRead
|
|
2231
|
+
*
|
|
2232
|
+
* Perform a bulk action of marking an array of thread ids as read
|
|
2233
|
+
*/
|
|
2234
|
+
'threadBulkActionsRead'(
|
|
2235
|
+
parameters?: Parameters<UnknownParamsObject> | null,
|
|
2236
|
+
data?: Paths.ThreadBulkActionsRead.RequestBody,
|
|
2237
|
+
config?: AxiosRequestConfig
|
|
2238
|
+
): OperationResponse<Paths.ThreadBulkActionsRead.Responses.$200>
|
|
2239
|
+
/**
|
|
2240
|
+
* threadBulkActionsUnread - threadBulkActionsUnread
|
|
2241
|
+
*
|
|
2242
|
+
* Perform a bulk action of marking an array of thread ids as unread
|
|
2243
|
+
*/
|
|
2244
|
+
'threadBulkActionsUnread'(
|
|
2245
|
+
parameters?: Parameters<UnknownParamsObject> | null,
|
|
2246
|
+
data?: Paths.ThreadBulkActionsUnread.RequestBody,
|
|
2247
|
+
config?: AxiosRequestConfig
|
|
2248
|
+
): OperationResponse<Paths.ThreadBulkActionsUnread.Responses.$200>
|
|
2249
|
+
/**
|
|
2250
|
+
* threadBulkActionsFavorite - threadBulkActionsFavorite
|
|
2251
|
+
*
|
|
2252
|
+
* Perform a bulk action of marking an array of thread ids favorite
|
|
2253
|
+
*/
|
|
2254
|
+
'threadBulkActionsFavorite'(
|
|
2255
|
+
parameters?: Parameters<UnknownParamsObject> | null,
|
|
2256
|
+
data?: Paths.ThreadBulkActionsFavorite.RequestBody,
|
|
2257
|
+
config?: AxiosRequestConfig
|
|
2258
|
+
): OperationResponse<Paths.ThreadBulkActionsFavorite.Responses.$200>
|
|
2259
|
+
/**
|
|
2260
|
+
* threadBulkActionsUnfavorite - threadBulkActionsUnfavorite
|
|
2261
|
+
*
|
|
2262
|
+
* Perform a bulk action of marking an array of thread ids unfavorited
|
|
2263
|
+
*/
|
|
2264
|
+
'threadBulkActionsUnfavorite'(
|
|
2265
|
+
parameters?: Parameters<UnknownParamsObject> | null,
|
|
2266
|
+
data?: Paths.ThreadBulkActionsUnfavorite.RequestBody,
|
|
2267
|
+
config?: AxiosRequestConfig
|
|
2268
|
+
): OperationResponse<Paths.ThreadBulkActionsUnfavorite.Responses.$200>
|
|
2269
|
+
/**
|
|
2270
|
+
* threadBulkActionsTrash - threadBulkActionsTrash
|
|
2271
|
+
*
|
|
2272
|
+
* Perform a bulk action of trashing an array of threads
|
|
2273
|
+
*/
|
|
2274
|
+
'threadBulkActionsTrash'(
|
|
2275
|
+
parameters?: Parameters<UnknownParamsObject> | null,
|
|
2276
|
+
data?: Paths.ThreadBulkActionsTrash.RequestBody,
|
|
2277
|
+
config?: AxiosRequestConfig
|
|
2278
|
+
): OperationResponse<Paths.ThreadBulkActionsTrash.Responses.$200>
|
|
2279
|
+
/**
|
|
2280
|
+
* threadBulkActionsUntrash - threadBulkActionsUntrash
|
|
2281
|
+
*
|
|
2282
|
+
* Perform a bulk action of untrashing an array of threads
|
|
2283
|
+
*/
|
|
2284
|
+
'threadBulkActionsUntrash'(
|
|
2285
|
+
parameters?: Parameters<UnknownParamsObject> | null,
|
|
2286
|
+
data?: Paths.ThreadBulkActionsUntrash.RequestBody,
|
|
2287
|
+
config?: AxiosRequestConfig
|
|
2288
|
+
): OperationResponse<Paths.ThreadBulkActionsUntrash.Responses.$200>
|
|
2289
|
+
/**
|
|
2290
|
+
* threadBulkActionsDelete - threadBulkActionsDelete
|
|
2291
|
+
*
|
|
2292
|
+
* Performs a bulk permanent delete for all threads
|
|
2293
|
+
*/
|
|
2294
|
+
'threadBulkActionsDelete'(
|
|
2295
|
+
parameters?: Parameters<UnknownParamsObject> | null,
|
|
2296
|
+
data?: Paths.ThreadBulkActionsDelete.RequestBody,
|
|
2297
|
+
config?: AxiosRequestConfig
|
|
2298
|
+
): OperationResponse<Paths.ThreadBulkActionsDelete.Responses.$200>
|
|
2299
|
+
/**
|
|
2300
|
+
* threadBulkActionsDone - threadBulkActionsDone
|
|
2301
|
+
*
|
|
2302
|
+
* Perform a bulk action of marking an array of threads as done
|
|
2303
|
+
*/
|
|
2304
|
+
'threadBulkActionsDone'(
|
|
2305
|
+
parameters?: Parameters<UnknownParamsObject> | null,
|
|
2306
|
+
data?: Paths.ThreadBulkActionsDone.RequestBody,
|
|
2307
|
+
config?: AxiosRequestConfig
|
|
2308
|
+
): OperationResponse<Paths.ThreadBulkActionsDone.Responses.$200>
|
|
2309
|
+
/**
|
|
2310
|
+
* threadBulkActionsOpen - threadBulkActionsOpen
|
|
2311
|
+
*
|
|
2312
|
+
* Perform a bulk action of marking an array of threads as open
|
|
2313
|
+
*/
|
|
2314
|
+
'threadBulkActionsOpen'(
|
|
2315
|
+
parameters?: Parameters<UnknownParamsObject> | null,
|
|
2316
|
+
data?: Paths.ThreadBulkActionsOpen.RequestBody,
|
|
2317
|
+
config?: AxiosRequestConfig
|
|
2318
|
+
): OperationResponse<Paths.ThreadBulkActionsOpen.Responses.$200>
|
|
1893
2319
|
/**
|
|
1894
2320
|
* markReadThread - markReadThread
|
|
1895
2321
|
*
|
|
@@ -1899,7 +2325,7 @@ export interface OperationMethods {
|
|
|
1899
2325
|
parameters?: Parameters<Paths.MarkReadThread.PathParameters> | null,
|
|
1900
2326
|
data?: any,
|
|
1901
2327
|
config?: AxiosRequestConfig
|
|
1902
|
-
): OperationResponse<Paths.MarkReadThread.Responses.$
|
|
2328
|
+
): OperationResponse<Paths.MarkReadThread.Responses.$200>
|
|
1903
2329
|
/**
|
|
1904
2330
|
* markReadThreadV2 - markReadThreadV2
|
|
1905
2331
|
*
|
|
@@ -1909,7 +2335,7 @@ export interface OperationMethods {
|
|
|
1909
2335
|
parameters?: Parameters<Paths.MarkReadThreadV2.PathParameters> | null,
|
|
1910
2336
|
data?: Paths.MarkReadThreadV2.RequestBody,
|
|
1911
2337
|
config?: AxiosRequestConfig
|
|
1912
|
-
): OperationResponse<Paths.MarkReadThreadV2.Responses.$
|
|
2338
|
+
): OperationResponse<Paths.MarkReadThreadV2.Responses.$200>
|
|
1913
2339
|
/**
|
|
1914
2340
|
* markUnreadThread - markUnreadThread
|
|
1915
2341
|
*
|
|
@@ -1919,7 +2345,7 @@ export interface OperationMethods {
|
|
|
1919
2345
|
parameters?: Parameters<Paths.MarkUnreadThread.PathParameters> | null,
|
|
1920
2346
|
data?: any,
|
|
1921
2347
|
config?: AxiosRequestConfig
|
|
1922
|
-
): OperationResponse<Paths.MarkUnreadThread.Responses.$
|
|
2348
|
+
): OperationResponse<Paths.MarkUnreadThread.Responses.$200>
|
|
1923
2349
|
/**
|
|
1924
2350
|
* markUnreadThreadV2 - markUnreadThreadV2
|
|
1925
2351
|
*
|
|
@@ -1929,7 +2355,7 @@ export interface OperationMethods {
|
|
|
1929
2355
|
parameters?: Parameters<Paths.MarkUnreadThreadV2.PathParameters> | null,
|
|
1930
2356
|
data?: Paths.MarkUnreadThreadV2.RequestBody,
|
|
1931
2357
|
config?: AxiosRequestConfig
|
|
1932
|
-
): OperationResponse<Paths.MarkUnreadThreadV2.Responses.$
|
|
2358
|
+
): OperationResponse<Paths.MarkUnreadThreadV2.Responses.$200>
|
|
1933
2359
|
/**
|
|
1934
2360
|
* assignThread - assignThread
|
|
1935
2361
|
*
|
|
@@ -2138,6 +2564,38 @@ export interface PathsDictionary {
|
|
|
2138
2564
|
config?: AxiosRequestConfig
|
|
2139
2565
|
): OperationResponse<Paths.SearchThreads.Responses.$200>
|
|
2140
2566
|
}
|
|
2567
|
+
['/v2/message/threads:search']: {
|
|
2568
|
+
/**
|
|
2569
|
+
* searchThreadsV2 - searchThreadsV2
|
|
2570
|
+
*
|
|
2571
|
+
* Search for threads of email messages.
|
|
2572
|
+
*
|
|
2573
|
+
* Messages with no replies yet are treated as threads with single message.
|
|
2574
|
+
*
|
|
2575
|
+
* Lucene syntax supported.
|
|
2576
|
+
*
|
|
2577
|
+
*/
|
|
2578
|
+
'post'(
|
|
2579
|
+
parameters?: Parameters<UnknownParamsObject> | null,
|
|
2580
|
+
data?: Paths.SearchThreadsV2.RequestBody,
|
|
2581
|
+
config?: AxiosRequestConfig
|
|
2582
|
+
): OperationResponse<Paths.SearchThreadsV2.Responses.$200>
|
|
2583
|
+
}
|
|
2584
|
+
['/v1/message/threads:searchIds']: {
|
|
2585
|
+
/**
|
|
2586
|
+
* searchIds - Search threads and return all id's
|
|
2587
|
+
*
|
|
2588
|
+
* Return all thread id's that match a criteria
|
|
2589
|
+
*
|
|
2590
|
+
* Lucene syntax supported.
|
|
2591
|
+
*
|
|
2592
|
+
*/
|
|
2593
|
+
'post'(
|
|
2594
|
+
parameters?: Parameters<UnknownParamsObject> | null,
|
|
2595
|
+
data?: Paths.SearchIds.RequestBody,
|
|
2596
|
+
config?: AxiosRequestConfig
|
|
2597
|
+
): OperationResponse<Paths.SearchIds.Responses.$200>
|
|
2598
|
+
}
|
|
2141
2599
|
['/v1/message/threads']: {
|
|
2142
2600
|
/**
|
|
2143
2601
|
* updateThread - updateThread
|
|
@@ -2186,6 +2644,18 @@ export interface PathsDictionary {
|
|
|
2186
2644
|
config?: AxiosRequestConfig
|
|
2187
2645
|
): OperationResponse<Paths.MarkThreadAsOpen.Responses.$204>
|
|
2188
2646
|
}
|
|
2647
|
+
['/v1/message/threads/{id}/timeline']: {
|
|
2648
|
+
/**
|
|
2649
|
+
* getThreadTimeline - getThreadTimeline
|
|
2650
|
+
*
|
|
2651
|
+
* Get thread timeline
|
|
2652
|
+
*/
|
|
2653
|
+
'get'(
|
|
2654
|
+
parameters?: Parameters<Paths.GetThreadTimeline.PathParameters> | null,
|
|
2655
|
+
data?: any,
|
|
2656
|
+
config?: AxiosRequestConfig
|
|
2657
|
+
): OperationResponse<Paths.GetThreadTimeline.Responses.$200>
|
|
2658
|
+
}
|
|
2189
2659
|
['/v1/message/threads/{id}/trash']: {
|
|
2190
2660
|
/**
|
|
2191
2661
|
* trashThread - trashThread
|
|
@@ -2196,7 +2666,7 @@ export interface PathsDictionary {
|
|
|
2196
2666
|
parameters?: Parameters<Paths.TrashThread.PathParameters> | null,
|
|
2197
2667
|
data?: any,
|
|
2198
2668
|
config?: AxiosRequestConfig
|
|
2199
|
-
): OperationResponse<Paths.TrashThread.Responses.$
|
|
2669
|
+
): OperationResponse<Paths.TrashThread.Responses.$200>
|
|
2200
2670
|
}
|
|
2201
2671
|
['/v1/message/threads/{id}/untrash']: {
|
|
2202
2672
|
/**
|
|
@@ -2208,7 +2678,115 @@ export interface PathsDictionary {
|
|
|
2208
2678
|
parameters?: Parameters<Paths.UntrashThread.PathParameters> | null,
|
|
2209
2679
|
data?: any,
|
|
2210
2680
|
config?: AxiosRequestConfig
|
|
2211
|
-
): OperationResponse<Paths.UntrashThread.Responses.$
|
|
2681
|
+
): OperationResponse<Paths.UntrashThread.Responses.$200>
|
|
2682
|
+
}
|
|
2683
|
+
['/v1/message/threads/bulk:read']: {
|
|
2684
|
+
/**
|
|
2685
|
+
* threadBulkActionsRead - threadBulkActionsRead
|
|
2686
|
+
*
|
|
2687
|
+
* Perform a bulk action of marking an array of thread ids as read
|
|
2688
|
+
*/
|
|
2689
|
+
'post'(
|
|
2690
|
+
parameters?: Parameters<UnknownParamsObject> | null,
|
|
2691
|
+
data?: Paths.ThreadBulkActionsRead.RequestBody,
|
|
2692
|
+
config?: AxiosRequestConfig
|
|
2693
|
+
): OperationResponse<Paths.ThreadBulkActionsRead.Responses.$200>
|
|
2694
|
+
}
|
|
2695
|
+
['/v1/message/threads/bulk:unread']: {
|
|
2696
|
+
/**
|
|
2697
|
+
* threadBulkActionsUnread - threadBulkActionsUnread
|
|
2698
|
+
*
|
|
2699
|
+
* Perform a bulk action of marking an array of thread ids as unread
|
|
2700
|
+
*/
|
|
2701
|
+
'post'(
|
|
2702
|
+
parameters?: Parameters<UnknownParamsObject> | null,
|
|
2703
|
+
data?: Paths.ThreadBulkActionsUnread.RequestBody,
|
|
2704
|
+
config?: AxiosRequestConfig
|
|
2705
|
+
): OperationResponse<Paths.ThreadBulkActionsUnread.Responses.$200>
|
|
2706
|
+
}
|
|
2707
|
+
['/v1/message/threads/bulk:favorite']: {
|
|
2708
|
+
/**
|
|
2709
|
+
* threadBulkActionsFavorite - threadBulkActionsFavorite
|
|
2710
|
+
*
|
|
2711
|
+
* Perform a bulk action of marking an array of thread ids favorite
|
|
2712
|
+
*/
|
|
2713
|
+
'post'(
|
|
2714
|
+
parameters?: Parameters<UnknownParamsObject> | null,
|
|
2715
|
+
data?: Paths.ThreadBulkActionsFavorite.RequestBody,
|
|
2716
|
+
config?: AxiosRequestConfig
|
|
2717
|
+
): OperationResponse<Paths.ThreadBulkActionsFavorite.Responses.$200>
|
|
2718
|
+
}
|
|
2719
|
+
['/v1/message/threads/bulk:unfavorite']: {
|
|
2720
|
+
/**
|
|
2721
|
+
* threadBulkActionsUnfavorite - threadBulkActionsUnfavorite
|
|
2722
|
+
*
|
|
2723
|
+
* Perform a bulk action of marking an array of thread ids unfavorited
|
|
2724
|
+
*/
|
|
2725
|
+
'post'(
|
|
2726
|
+
parameters?: Parameters<UnknownParamsObject> | null,
|
|
2727
|
+
data?: Paths.ThreadBulkActionsUnfavorite.RequestBody,
|
|
2728
|
+
config?: AxiosRequestConfig
|
|
2729
|
+
): OperationResponse<Paths.ThreadBulkActionsUnfavorite.Responses.$200>
|
|
2730
|
+
}
|
|
2731
|
+
['/v1/message/threads/bulk:trash']: {
|
|
2732
|
+
/**
|
|
2733
|
+
* threadBulkActionsTrash - threadBulkActionsTrash
|
|
2734
|
+
*
|
|
2735
|
+
* Perform a bulk action of trashing an array of threads
|
|
2736
|
+
*/
|
|
2737
|
+
'post'(
|
|
2738
|
+
parameters?: Parameters<UnknownParamsObject> | null,
|
|
2739
|
+
data?: Paths.ThreadBulkActionsTrash.RequestBody,
|
|
2740
|
+
config?: AxiosRequestConfig
|
|
2741
|
+
): OperationResponse<Paths.ThreadBulkActionsTrash.Responses.$200>
|
|
2742
|
+
}
|
|
2743
|
+
['/v1/message/threads/bulk:untrash']: {
|
|
2744
|
+
/**
|
|
2745
|
+
* threadBulkActionsUntrash - threadBulkActionsUntrash
|
|
2746
|
+
*
|
|
2747
|
+
* Perform a bulk action of untrashing an array of threads
|
|
2748
|
+
*/
|
|
2749
|
+
'post'(
|
|
2750
|
+
parameters?: Parameters<UnknownParamsObject> | null,
|
|
2751
|
+
data?: Paths.ThreadBulkActionsUntrash.RequestBody,
|
|
2752
|
+
config?: AxiosRequestConfig
|
|
2753
|
+
): OperationResponse<Paths.ThreadBulkActionsUntrash.Responses.$200>
|
|
2754
|
+
}
|
|
2755
|
+
['/v1/message/threads/bulk:delete']: {
|
|
2756
|
+
/**
|
|
2757
|
+
* threadBulkActionsDelete - threadBulkActionsDelete
|
|
2758
|
+
*
|
|
2759
|
+
* Performs a bulk permanent delete for all threads
|
|
2760
|
+
*/
|
|
2761
|
+
'post'(
|
|
2762
|
+
parameters?: Parameters<UnknownParamsObject> | null,
|
|
2763
|
+
data?: Paths.ThreadBulkActionsDelete.RequestBody,
|
|
2764
|
+
config?: AxiosRequestConfig
|
|
2765
|
+
): OperationResponse<Paths.ThreadBulkActionsDelete.Responses.$200>
|
|
2766
|
+
}
|
|
2767
|
+
['/v1/message/threads/bulk:done']: {
|
|
2768
|
+
/**
|
|
2769
|
+
* threadBulkActionsDone - threadBulkActionsDone
|
|
2770
|
+
*
|
|
2771
|
+
* Perform a bulk action of marking an array of threads as done
|
|
2772
|
+
*/
|
|
2773
|
+
'post'(
|
|
2774
|
+
parameters?: Parameters<UnknownParamsObject> | null,
|
|
2775
|
+
data?: Paths.ThreadBulkActionsDone.RequestBody,
|
|
2776
|
+
config?: AxiosRequestConfig
|
|
2777
|
+
): OperationResponse<Paths.ThreadBulkActionsDone.Responses.$200>
|
|
2778
|
+
}
|
|
2779
|
+
['/v1/message/threads/bulk:open']: {
|
|
2780
|
+
/**
|
|
2781
|
+
* threadBulkActionsOpen - threadBulkActionsOpen
|
|
2782
|
+
*
|
|
2783
|
+
* Perform a bulk action of marking an array of threads as open
|
|
2784
|
+
*/
|
|
2785
|
+
'post'(
|
|
2786
|
+
parameters?: Parameters<UnknownParamsObject> | null,
|
|
2787
|
+
data?: Paths.ThreadBulkActionsOpen.RequestBody,
|
|
2788
|
+
config?: AxiosRequestConfig
|
|
2789
|
+
): OperationResponse<Paths.ThreadBulkActionsOpen.Responses.$200>
|
|
2212
2790
|
}
|
|
2213
2791
|
['/v1/message/threads/{id}/read']: {
|
|
2214
2792
|
/**
|
|
@@ -2220,7 +2798,7 @@ export interface PathsDictionary {
|
|
|
2220
2798
|
parameters?: Parameters<Paths.MarkReadThread.PathParameters> | null,
|
|
2221
2799
|
data?: any,
|
|
2222
2800
|
config?: AxiosRequestConfig
|
|
2223
|
-
): OperationResponse<Paths.MarkReadThread.Responses.$
|
|
2801
|
+
): OperationResponse<Paths.MarkReadThread.Responses.$200>
|
|
2224
2802
|
}
|
|
2225
2803
|
['/v2/message/threads/{id}/read']: {
|
|
2226
2804
|
/**
|
|
@@ -2232,7 +2810,7 @@ export interface PathsDictionary {
|
|
|
2232
2810
|
parameters?: Parameters<Paths.MarkReadThreadV2.PathParameters> | null,
|
|
2233
2811
|
data?: Paths.MarkReadThreadV2.RequestBody,
|
|
2234
2812
|
config?: AxiosRequestConfig
|
|
2235
|
-
): OperationResponse<Paths.MarkReadThreadV2.Responses.$
|
|
2813
|
+
): OperationResponse<Paths.MarkReadThreadV2.Responses.$200>
|
|
2236
2814
|
}
|
|
2237
2815
|
['/v1/message/threads/{id}/unread']: {
|
|
2238
2816
|
/**
|
|
@@ -2244,7 +2822,7 @@ export interface PathsDictionary {
|
|
|
2244
2822
|
parameters?: Parameters<Paths.MarkUnreadThread.PathParameters> | null,
|
|
2245
2823
|
data?: any,
|
|
2246
2824
|
config?: AxiosRequestConfig
|
|
2247
|
-
): OperationResponse<Paths.MarkUnreadThread.Responses.$
|
|
2825
|
+
): OperationResponse<Paths.MarkUnreadThread.Responses.$200>
|
|
2248
2826
|
}
|
|
2249
2827
|
['/v2/message/threads/{id}/unread']: {
|
|
2250
2828
|
/**
|
|
@@ -2256,7 +2834,7 @@ export interface PathsDictionary {
|
|
|
2256
2834
|
parameters?: Parameters<Paths.MarkUnreadThreadV2.PathParameters> | null,
|
|
2257
2835
|
data?: Paths.MarkUnreadThreadV2.RequestBody,
|
|
2258
2836
|
config?: AxiosRequestConfig
|
|
2259
|
-
): OperationResponse<Paths.MarkUnreadThreadV2.Responses.$
|
|
2837
|
+
): OperationResponse<Paths.MarkUnreadThreadV2.Responses.$200>
|
|
2260
2838
|
}
|
|
2261
2839
|
['/v1/message/threads/{id}/assign']: {
|
|
2262
2840
|
/**
|
|
@@ -2349,11 +2927,20 @@ export type Client = OpenAPIClient<OperationMethods, PathsDictionary>
|
|
|
2349
2927
|
export type Address = Components.Schemas.Address;
|
|
2350
2928
|
export type AttachmentsRelation = Components.Schemas.AttachmentsRelation;
|
|
2351
2929
|
export type BaseEntity = Components.Schemas.BaseEntity;
|
|
2930
|
+
export type BulkActionsPayload = Components.Schemas.BulkActionsPayload;
|
|
2931
|
+
export type BulkActionsPayloadWithScopes = Components.Schemas.BulkActionsPayloadWithScopes;
|
|
2352
2932
|
export type File = Components.Schemas.File;
|
|
2353
2933
|
export type Message = Components.Schemas.Message;
|
|
2354
2934
|
export type MessageRequestParams = Components.Schemas.MessageRequestParams;
|
|
2355
2935
|
export type MessageV2 = Components.Schemas.MessageV2;
|
|
2356
2936
|
export type ReadMessagePayload = Components.Schemas.ReadMessagePayload;
|
|
2357
2937
|
export type ReadingScope = Components.Schemas.ReadingScope;
|
|
2938
|
+
export type SearchIDParams = Components.Schemas.SearchIDParams;
|
|
2358
2939
|
export type SearchParams = Components.Schemas.SearchParams;
|
|
2940
|
+
export type SearchParamsV2 = Components.Schemas.SearchParamsV2;
|
|
2359
2941
|
export type Thread = Components.Schemas.Thread;
|
|
2942
|
+
export type ThreadDoneEvent = Components.Schemas.ThreadDoneEvent;
|
|
2943
|
+
export type ThreadOpenEvent = Components.Schemas.ThreadOpenEvent;
|
|
2944
|
+
export type ThreadTimeline = Components.Schemas.ThreadTimeline;
|
|
2945
|
+
export type TimelineEvent = Components.Schemas.TimelineEvent;
|
|
2946
|
+
export type TimelineEventData = Components.Schemas.TimelineEventData;
|