@stream-io/node-sdk 0.7.61 → 0.7.63
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/index.cjs.js +825 -62
- package/dist/index.cjs.js.map +1 -1
- package/dist/index.es.mjs +826 -63
- package/dist/index.es.mjs.map +1 -1
- package/dist/src/gen/chat/ChannelApi.d.ts +6 -0
- package/dist/src/gen/chat/ChatApi.d.ts +24 -1
- package/dist/src/gen/common/CommonApi.d.ts +16 -5
- package/dist/src/gen/feeds/FeedApi.d.ts +10 -3
- package/dist/src/gen/feeds/FeedsApi.d.ts +41 -4
- package/dist/src/gen/models/index.d.ts +1852 -193
- package/dist/src/gen/moderation/ModerationApi.d.ts +41 -5
- package/dist/src/gen/video/VideoApi.d.ts +2 -1
- package/package.json +2 -3
- package/src/ApiClient.ts +2 -2
- package/src/gen/chat/ChannelApi.ts +19 -0
- package/src/gen/chat/ChatApi.ts +237 -0
- package/src/gen/common/CommonApi.ts +87 -70
- package/src/gen/feeds/FeedApi.ts +20 -2
- package/src/gen/feeds/FeedsApi.ts +184 -8
- package/src/gen/model-decoders/decoders.ts +430 -31
- package/src/gen/models/index.ts +2648 -229
- package/src/gen/moderation/ModerationApi.ts +492 -14
- package/src/gen/video/VideoApi.ts +25 -0
|
@@ -1,3 +1,12 @@
|
|
|
1
|
+
export interface AIAudioConfigRequest {
|
|
2
|
+
profile?: string;
|
|
3
|
+
rules?: BodyguardRule[];
|
|
4
|
+
}
|
|
5
|
+
export interface AIAudioConfigResponse {
|
|
6
|
+
enabled: boolean;
|
|
7
|
+
profile: string;
|
|
8
|
+
rules: BodyguardRule[];
|
|
9
|
+
}
|
|
1
10
|
export interface AIImageConfig {
|
|
2
11
|
async?: boolean;
|
|
3
12
|
enabled?: boolean;
|
|
@@ -148,6 +157,10 @@ export interface ActionLogResponse {
|
|
|
148
157
|
* Reason for the moderation action
|
|
149
158
|
*/
|
|
150
159
|
reason: string;
|
|
160
|
+
/**
|
|
161
|
+
* Classification of who triggered the action (e.g. user, moderator, automod, api_integration)
|
|
162
|
+
*/
|
|
163
|
+
reporter_type: string;
|
|
151
164
|
/**
|
|
152
165
|
* ID of the user who was the target of the action
|
|
153
166
|
*/
|
|
@@ -692,7 +705,12 @@ export interface ActivityResponse {
|
|
|
692
705
|
* Reactions from users the current user follows or has mutual follows with
|
|
693
706
|
*/
|
|
694
707
|
friend_reactions?: FeedsReactionResponse[];
|
|
708
|
+
/**
|
|
709
|
+
* Recent shares of the activity, one entry per share (org-gated)
|
|
710
|
+
*/
|
|
711
|
+
latest_shares?: ShareResponse[];
|
|
695
712
|
current_feed?: FeedResponse;
|
|
713
|
+
i18n?: Record<string, string>;
|
|
696
714
|
location?: Location;
|
|
697
715
|
metrics?: Record<string, number>;
|
|
698
716
|
moderation?: ModerationV2Response;
|
|
@@ -830,6 +848,7 @@ export interface AddActivityRequest {
|
|
|
830
848
|
* Whether to create notification activities for mentioned users
|
|
831
849
|
*/
|
|
832
850
|
create_notification_activity?: boolean;
|
|
851
|
+
create_users?: boolean;
|
|
833
852
|
enrich_own_fields?: boolean;
|
|
834
853
|
/**
|
|
835
854
|
* Expiration time for the activity
|
|
@@ -968,6 +987,10 @@ export interface AddCommentReactionRequest {
|
|
|
968
987
|
enforce_unique?: boolean;
|
|
969
988
|
skip_push?: boolean;
|
|
970
989
|
user_id?: string;
|
|
990
|
+
/**
|
|
991
|
+
* Optional list of feeds to create a reference (share) activity of the commented-on activity in. The reference activity's type mirrors the reaction type.
|
|
992
|
+
*/
|
|
993
|
+
target_feeds?: string[];
|
|
971
994
|
/**
|
|
972
995
|
* Optional custom data to add to the reaction
|
|
973
996
|
*/
|
|
@@ -982,9 +1005,19 @@ export interface AddCommentReactionResponse {
|
|
|
982
1005
|
comment: CommentResponse;
|
|
983
1006
|
reaction: FeedsReactionResponse;
|
|
984
1007
|
/**
|
|
985
|
-
* Whether
|
|
1008
|
+
* Whether notification creation was accepted for asynchronous processing
|
|
1009
|
+
*/
|
|
1010
|
+
notification_accepted?: boolean;
|
|
1011
|
+
/**
|
|
1012
|
+
* @deprecated
|
|
1013
|
+
* Deprecated. Mirrors notification_accepted; use notification_accepted for async enqueue status Deprecated: use notification_accepted
|
|
986
1014
|
*/
|
|
987
1015
|
notification_created?: boolean;
|
|
1016
|
+
/**
|
|
1017
|
+
* ID of the async notification-creation task; poll GET /tasks/{id} for its status
|
|
1018
|
+
*/
|
|
1019
|
+
notification_task_id?: string;
|
|
1020
|
+
reference_activity?: ActivityResponse;
|
|
988
1021
|
}
|
|
989
1022
|
export interface AddCommentRequest {
|
|
990
1023
|
/**
|
|
@@ -1089,12 +1122,20 @@ export interface AddReactionRequest {
|
|
|
1089
1122
|
* Whether to create a notification activity for this reaction
|
|
1090
1123
|
*/
|
|
1091
1124
|
create_notification_activity?: boolean;
|
|
1125
|
+
/**
|
|
1126
|
+
* Server-side only. If true, auto-creates the reacting user identified by user_id when they don't already exist. Default: false.
|
|
1127
|
+
*/
|
|
1128
|
+
create_users?: boolean;
|
|
1092
1129
|
/**
|
|
1093
1130
|
* Whether to enforce unique reactions per user (remove other reaction types from the user when adding this one)
|
|
1094
1131
|
*/
|
|
1095
1132
|
enforce_unique?: boolean;
|
|
1096
1133
|
skip_push?: boolean;
|
|
1097
1134
|
user_id?: string;
|
|
1135
|
+
/**
|
|
1136
|
+
* Optional list of feeds to create a reference (share) activity of the original activity in. The reference activity's type mirrors the reaction type.
|
|
1137
|
+
*/
|
|
1138
|
+
target_feeds?: string[];
|
|
1098
1139
|
/**
|
|
1099
1140
|
* Custom data for the reaction
|
|
1100
1141
|
*/
|
|
@@ -1106,9 +1147,25 @@ export interface AddReactionResponse {
|
|
|
1106
1147
|
activity: ActivityResponse;
|
|
1107
1148
|
reaction: FeedsReactionResponse;
|
|
1108
1149
|
/**
|
|
1109
|
-
* Whether
|
|
1150
|
+
* Whether notification creation was accepted for asynchronous processing
|
|
1151
|
+
*/
|
|
1152
|
+
notification_accepted?: boolean;
|
|
1153
|
+
/**
|
|
1154
|
+
* @deprecated
|
|
1155
|
+
* Deprecated. Mirrors notification_accepted; use notification_accepted for async enqueue status Deprecated: use notification_accepted
|
|
1110
1156
|
*/
|
|
1111
1157
|
notification_created?: boolean;
|
|
1158
|
+
/**
|
|
1159
|
+
* ID of the async notification-creation task; poll GET /tasks/{id} for its status
|
|
1160
|
+
*/
|
|
1161
|
+
notification_task_id?: string;
|
|
1162
|
+
reference_activity?: ActivityResponse;
|
|
1163
|
+
}
|
|
1164
|
+
export interface AddSegmentTargetsRequest {
|
|
1165
|
+
/**
|
|
1166
|
+
* Target IDs
|
|
1167
|
+
*/
|
|
1168
|
+
target_ids: string[];
|
|
1112
1169
|
}
|
|
1113
1170
|
export interface AddUserGroupMembersRequest {
|
|
1114
1171
|
/**
|
|
@@ -1182,6 +1239,113 @@ export interface AggregationConfig {
|
|
|
1182
1239
|
*/
|
|
1183
1240
|
score_strategy?: 'sum' | 'max' | 'avg';
|
|
1184
1241
|
}
|
|
1242
|
+
export interface AnalyzeImageField {
|
|
1243
|
+
/**
|
|
1244
|
+
* Per-image action: keep | flag | remove.
|
|
1245
|
+
*/
|
|
1246
|
+
action?: string;
|
|
1247
|
+
/**
|
|
1248
|
+
* Highest confidence (0–1) across detected classifications + sub-classifications. Convenience aggregate over the nested values in `classifications`.
|
|
1249
|
+
*/
|
|
1250
|
+
confidence?: number;
|
|
1251
|
+
/**
|
|
1252
|
+
* Set when moderation couldn't be determined for this image — action is absent.
|
|
1253
|
+
*/
|
|
1254
|
+
error?: string;
|
|
1255
|
+
/**
|
|
1256
|
+
* Echo of `content_ids[label]` when supplied on the request; omitted otherwise.
|
|
1257
|
+
*/
|
|
1258
|
+
id?: string;
|
|
1259
|
+
/**
|
|
1260
|
+
* Hierarchical list of L1 (parent) classifications. Each entry: `name`, `confidence` (0–1), and nested `subclassifications` (L2 leaves with their own confidence). Resolved against the app's effective taxonomy (custom taxonomy when configured, otherwise the standard Bodyguard catalogue).
|
|
1261
|
+
*/
|
|
1262
|
+
classifications?: Classification[];
|
|
1263
|
+
/**
|
|
1264
|
+
* Flat list of Bodyguard OCR text-moderation labels on the image's extracted text (e.g. VULGARITY, PII). Each entry: `name` + `severity`. Populated when BG's OCR pipeline returned non-empty results for this image.
|
|
1265
|
+
*/
|
|
1266
|
+
ocr_classifications?: Classification[];
|
|
1267
|
+
}
|
|
1268
|
+
export interface AnalyzeRequest {
|
|
1269
|
+
/**
|
|
1270
|
+
* When true, the response carries no verdicts (status `pending`) and per-modality results arrive via `moderation.text_analysis.complete` and `moderation.image_analysis.complete` webhooks. Image moderation runs on a background worker; text moderation runs synchronously and is then delivered via webhook.
|
|
1271
|
+
*/
|
|
1272
|
+
async_response?: boolean;
|
|
1273
|
+
/**
|
|
1274
|
+
* Moderation policy key. Optional in stateful mode, required in stateless mode.
|
|
1275
|
+
*/
|
|
1276
|
+
config_key?: string;
|
|
1277
|
+
/**
|
|
1278
|
+
* Original timestamp when the content was produced. Used as the `published_at` timestamp on per-content log entries that surface in `matched_contents` on aggregation-rule webhooks.
|
|
1279
|
+
*/
|
|
1280
|
+
content_published_at?: Date;
|
|
1281
|
+
/**
|
|
1282
|
+
* ID of the user who created the content. Required with entity_type + entity_id; omit all three for stateless mode.
|
|
1283
|
+
*/
|
|
1284
|
+
entity_creator_id?: string;
|
|
1285
|
+
/**
|
|
1286
|
+
* Caller-supplied content identifier. Required with entity_type + entity_creator_id; omit all three for stateless mode.
|
|
1287
|
+
*/
|
|
1288
|
+
entity_id?: string;
|
|
1289
|
+
/**
|
|
1290
|
+
* Caller-defined entity type. Required with entity_id + entity_creator_id; omit all three for stateless mode.
|
|
1291
|
+
*/
|
|
1292
|
+
entity_type?: string;
|
|
1293
|
+
user_id?: string;
|
|
1294
|
+
/**
|
|
1295
|
+
* Optional map from a content label (either a `texts` key or an `image:<key>` multipart label) to a caller-supplied per-instance identifier. Echoed on per-field verdicts and surfaced in `matched_contents` when an aggregation rule fires.
|
|
1296
|
+
*/
|
|
1297
|
+
content_ids?: Record<string, string>;
|
|
1298
|
+
/**
|
|
1299
|
+
* Arbitrary metadata surfaced in the dashboard.
|
|
1300
|
+
*/
|
|
1301
|
+
custom?: Record<string, any>;
|
|
1302
|
+
/**
|
|
1303
|
+
* Named text fields to moderate, keyed by caller label (e.g. title, description).
|
|
1304
|
+
*/
|
|
1305
|
+
texts?: Record<string, string>;
|
|
1306
|
+
user?: UserRequest;
|
|
1307
|
+
}
|
|
1308
|
+
export interface AnalyzeResponse {
|
|
1309
|
+
duration: string;
|
|
1310
|
+
/**
|
|
1311
|
+
* Always `complete` — /analyze is sync-only and the full verdict is in the response.
|
|
1312
|
+
*/
|
|
1313
|
+
status: string;
|
|
1314
|
+
/**
|
|
1315
|
+
* Per-image moderation verdicts keyed by caller label.
|
|
1316
|
+
*/
|
|
1317
|
+
images?: Record<string, AnalyzeImageField>;
|
|
1318
|
+
/**
|
|
1319
|
+
* Per-text-field moderation verdicts keyed by caller label.
|
|
1320
|
+
*/
|
|
1321
|
+
texts?: Record<string, AnalyzeTextField>;
|
|
1322
|
+
}
|
|
1323
|
+
export interface AnalyzeTextField {
|
|
1324
|
+
/**
|
|
1325
|
+
* Per-field action: keep | flag | remove.
|
|
1326
|
+
*/
|
|
1327
|
+
action?: string;
|
|
1328
|
+
/**
|
|
1329
|
+
* Set when moderation couldn't be determined for this field — action is absent.
|
|
1330
|
+
*/
|
|
1331
|
+
error?: string;
|
|
1332
|
+
/**
|
|
1333
|
+
* Echo of `content_ids[label]` when supplied on the request; omitted otherwise.
|
|
1334
|
+
*/
|
|
1335
|
+
id?: string;
|
|
1336
|
+
/**
|
|
1337
|
+
* Detected language code.
|
|
1338
|
+
*/
|
|
1339
|
+
language?: string;
|
|
1340
|
+
/**
|
|
1341
|
+
* Aggregate severity across the field: LOW | MEDIUM | HIGH | CRITICAL.
|
|
1342
|
+
*/
|
|
1343
|
+
severity?: string;
|
|
1344
|
+
/**
|
|
1345
|
+
* Flat list of detected Bodyguard text labels (e.g. INSULT, VULGARITY). Each entry carries `name` and `severity`.
|
|
1346
|
+
*/
|
|
1347
|
+
classifications?: Classification[];
|
|
1348
|
+
}
|
|
1185
1349
|
export interface AppResponseFields {
|
|
1186
1350
|
allow_multi_user_devices: boolean;
|
|
1187
1351
|
async_url_enrich_enabled: boolean;
|
|
@@ -1199,6 +1363,7 @@ export interface AppResponseFields {
|
|
|
1199
1363
|
max_aggregated_activities_length: number;
|
|
1200
1364
|
moderation_audio_call_moderation_enabled: boolean;
|
|
1201
1365
|
moderation_enabled: boolean;
|
|
1366
|
+
moderation_flood_rules_enabled: boolean;
|
|
1202
1367
|
moderation_llm_configurability_enabled: boolean;
|
|
1203
1368
|
moderation_multitenant_blocklist_enabled: boolean;
|
|
1204
1369
|
moderation_video_call_moderation_enabled: boolean;
|
|
@@ -1230,10 +1395,13 @@ export interface AppResponseFields {
|
|
|
1230
1395
|
image_upload_config: FileUploadConfig;
|
|
1231
1396
|
policies: Record<string, Policy[]>;
|
|
1232
1397
|
push_notifications: PushNotificationFields;
|
|
1233
|
-
before_message_send_hook_url?: string;
|
|
1234
1398
|
before_message_send_hook_attempt_timeout_ms?: number;
|
|
1399
|
+
before_message_send_hook_url?: string;
|
|
1400
|
+
chat_primary_use_case?: string;
|
|
1401
|
+
moderation_onboarding_complete?: boolean;
|
|
1235
1402
|
moderation_s3_image_access_role_arn?: string;
|
|
1236
1403
|
revoke_tokens_issued_before?: Date;
|
|
1404
|
+
video_primary_use_case?: string;
|
|
1237
1405
|
allowed_flag_reasons?: string[];
|
|
1238
1406
|
geofences?: GeofenceResponse[];
|
|
1239
1407
|
image_moderation_labels?: string[];
|
|
@@ -1281,15 +1449,57 @@ export interface AppealItemResponse {
|
|
|
1281
1449
|
* When the flag was last updated
|
|
1282
1450
|
*/
|
|
1283
1451
|
updated_at: Date;
|
|
1452
|
+
/**
|
|
1453
|
+
* Text severity level assigned by the AI provider
|
|
1454
|
+
*/
|
|
1455
|
+
ai_text_severity?: string;
|
|
1456
|
+
/**
|
|
1457
|
+
* CID of the channel the entity belongs to, if applicable
|
|
1458
|
+
*/
|
|
1459
|
+
channel_cid?: string;
|
|
1460
|
+
/**
|
|
1461
|
+
* Moderation policy key that was applied
|
|
1462
|
+
*/
|
|
1463
|
+
config_key?: string;
|
|
1284
1464
|
/**
|
|
1285
1465
|
* Decision Reason of the Appeal Item
|
|
1286
1466
|
*/
|
|
1287
1467
|
decision_reason?: string;
|
|
1468
|
+
/**
|
|
1469
|
+
* Action recommended by the automated moderation system (e.g. flag, remove, shadow)
|
|
1470
|
+
*/
|
|
1471
|
+
recommended_action?: string;
|
|
1472
|
+
/**
|
|
1473
|
+
* ID of the review queue item linked to this appeal, if the appeal was submitted with one
|
|
1474
|
+
*/
|
|
1475
|
+
review_queue_item_id?: string;
|
|
1476
|
+
/**
|
|
1477
|
+
* Overall content severity score (1–100)
|
|
1478
|
+
*/
|
|
1479
|
+
severity?: number;
|
|
1480
|
+
/**
|
|
1481
|
+
* Full chronological history of all moderation actions on the review queue item
|
|
1482
|
+
*/
|
|
1483
|
+
actions?: ActionLogResponse[];
|
|
1288
1484
|
/**
|
|
1289
1485
|
* Attachments(e.g. Images) of the Appeal Item
|
|
1290
1486
|
*/
|
|
1291
1487
|
attachments?: string[];
|
|
1488
|
+
/**
|
|
1489
|
+
* Classification labels from automated and manual review
|
|
1490
|
+
*/
|
|
1491
|
+
flag_labels?: string[];
|
|
1492
|
+
/**
|
|
1493
|
+
* Types of flags applied to the entity (e.g. user_report, bodyguard)
|
|
1494
|
+
*/
|
|
1495
|
+
flag_types?: string[];
|
|
1496
|
+
/**
|
|
1497
|
+
* Per-provider flag records explaining why the action was taken
|
|
1498
|
+
*/
|
|
1499
|
+
flags?: ModerationFlagResponse[];
|
|
1292
1500
|
entity_content?: ModerationPayload;
|
|
1501
|
+
moderation_action?: ActionLogResponse;
|
|
1502
|
+
original_moderation_action?: ActionLogResponse;
|
|
1293
1503
|
user?: UserResponse;
|
|
1294
1504
|
}
|
|
1295
1505
|
export interface AppealRejectedEvent {
|
|
@@ -1312,6 +1522,10 @@ export interface AppealRequest {
|
|
|
1312
1522
|
* Type of entity being appealed (e.g., message, user)
|
|
1313
1523
|
*/
|
|
1314
1524
|
entity_type: string;
|
|
1525
|
+
/**
|
|
1526
|
+
* ID of the review queue item (flagged message) that triggered the ban. Applicable only for user ban appeals.
|
|
1527
|
+
*/
|
|
1528
|
+
review_queue_item_id?: string;
|
|
1315
1529
|
user_id?: string;
|
|
1316
1530
|
/**
|
|
1317
1531
|
* Array of Attachment URLs(e.g., images)
|
|
@@ -1366,6 +1580,16 @@ export interface AsyncExportModerationLogsEvent {
|
|
|
1366
1580
|
type: string;
|
|
1367
1581
|
received_at?: Date;
|
|
1368
1582
|
}
|
|
1583
|
+
export interface AsyncExportReviewQueueEvent {
|
|
1584
|
+
created_at: Date;
|
|
1585
|
+
finished_at: Date;
|
|
1586
|
+
started_at: Date;
|
|
1587
|
+
task_id: string;
|
|
1588
|
+
url: string;
|
|
1589
|
+
custom: Record<string, any>;
|
|
1590
|
+
type: string;
|
|
1591
|
+
received_at?: Date;
|
|
1592
|
+
}
|
|
1369
1593
|
export interface AsyncExportUsersEvent {
|
|
1370
1594
|
created_at: Date;
|
|
1371
1595
|
finished_at: Date;
|
|
@@ -1543,6 +1767,10 @@ export interface BanInfoResponse {
|
|
|
1543
1767
|
* When the ban was created
|
|
1544
1768
|
*/
|
|
1545
1769
|
created_at: Date;
|
|
1770
|
+
/**
|
|
1771
|
+
* The channel this ban applies to. Empty if this is an app-wide (global) ban rather than a per-channel ban.
|
|
1772
|
+
*/
|
|
1773
|
+
channel_cid?: string;
|
|
1546
1774
|
/**
|
|
1547
1775
|
* When the ban expires
|
|
1548
1776
|
*/
|
|
@@ -1555,6 +1783,7 @@ export interface BanInfoResponse {
|
|
|
1555
1783
|
* Whether this is a shadow ban
|
|
1556
1784
|
*/
|
|
1557
1785
|
shadow?: boolean;
|
|
1786
|
+
channel?: ChannelMetadata;
|
|
1558
1787
|
created_by?: UserResponse;
|
|
1559
1788
|
user?: UserResponse;
|
|
1560
1789
|
}
|
|
@@ -1685,8 +1914,10 @@ export interface BlockListOptions {
|
|
|
1685
1914
|
blocklist: string;
|
|
1686
1915
|
}
|
|
1687
1916
|
export interface BlockListResponse {
|
|
1917
|
+
is_confusable_folding_enabled: boolean;
|
|
1688
1918
|
is_leet_check_enabled: boolean;
|
|
1689
1919
|
is_plural_check_enabled: boolean;
|
|
1920
|
+
is_substring_matching_enabled: boolean;
|
|
1690
1921
|
/**
|
|
1691
1922
|
* Block list name
|
|
1692
1923
|
*/
|
|
@@ -1704,6 +1935,7 @@ export interface BlockListResponse {
|
|
|
1704
1935
|
*/
|
|
1705
1936
|
created_at?: Date;
|
|
1706
1937
|
id?: string;
|
|
1938
|
+
owner_user_id?: string;
|
|
1707
1939
|
team?: string;
|
|
1708
1940
|
/**
|
|
1709
1941
|
* Date/time of the last update
|
|
@@ -1711,7 +1943,7 @@ export interface BlockListResponse {
|
|
|
1711
1943
|
updated_at?: Date;
|
|
1712
1944
|
}
|
|
1713
1945
|
export interface BlockListRule {
|
|
1714
|
-
action: 'flag' | 'mask_flag' | 'shadow' | 'remove' | 'bounce' | 'bounce_flag' | 'bounce_remove';
|
|
1946
|
+
action: 'flag' | 'mask' | 'mask_flag' | 'shadow' | 'remove' | 'bounce' | 'bounce_flag' | 'bounce_remove';
|
|
1715
1947
|
name?: string;
|
|
1716
1948
|
team?: string;
|
|
1717
1949
|
}
|
|
@@ -1779,13 +2011,18 @@ export interface BlockedUserResponse {
|
|
|
1779
2011
|
export interface BodyguardImageAnalysisConfig {
|
|
1780
2012
|
rules?: BodyguardRule[];
|
|
1781
2013
|
}
|
|
2014
|
+
export interface BodyguardProfileSummary {
|
|
2015
|
+
name: string;
|
|
2016
|
+
display_name?: string;
|
|
2017
|
+
text_type?: string;
|
|
2018
|
+
}
|
|
1782
2019
|
export interface BodyguardRule {
|
|
1783
2020
|
label: string;
|
|
1784
|
-
action?: 'flag' | 'shadow' | 'remove' | 'bounce' | 'bounce_flag' | 'bounce_remove';
|
|
2021
|
+
action?: 'keep' | 'flag' | 'mask' | 'mask_flag' | 'shadow' | 'remove' | 'bounce' | 'bounce_flag' | 'bounce_remove';
|
|
1785
2022
|
severity_rules?: BodyguardSeverityRule[];
|
|
1786
2023
|
}
|
|
1787
2024
|
export interface BodyguardSeverityRule {
|
|
1788
|
-
action: 'flag' | 'shadow' | 'remove' | 'bounce' | 'bounce_flag' | 'bounce_remove';
|
|
2025
|
+
action: 'keep' | 'flag' | 'mask' | 'shadow' | 'remove' | 'bounce' | 'bounce_flag' | 'bounce_remove';
|
|
1789
2026
|
severity: 'low' | 'medium' | 'high' | 'critical';
|
|
1790
2027
|
}
|
|
1791
2028
|
export interface BookmarkAddedEvent {
|
|
@@ -1931,6 +2168,57 @@ export interface BrowserDataResponse {
|
|
|
1931
2168
|
name?: string;
|
|
1932
2169
|
version?: string;
|
|
1933
2170
|
}
|
|
2171
|
+
export interface BulkActionAppealsRequest {
|
|
2172
|
+
/**
|
|
2173
|
+
* Action to apply: unban, restore, unblock, mark_reviewed, or reject_appeal
|
|
2174
|
+
*/
|
|
2175
|
+
action_type: 'unban' | 'restore' | 'unblock' | 'mark_reviewed' | 'reject_appeal';
|
|
2176
|
+
/**
|
|
2177
|
+
* List of appeal UUIDs to process
|
|
2178
|
+
*/
|
|
2179
|
+
appeal_ids: string[];
|
|
2180
|
+
user_id?: string;
|
|
2181
|
+
mark_reviewed?: MarkReviewedRequestPayload;
|
|
2182
|
+
reject_appeal?: RejectAppealRequestPayload;
|
|
2183
|
+
restore?: RestoreActionRequestPayload;
|
|
2184
|
+
unban?: UnbanActionRequestPayload;
|
|
2185
|
+
unblock?: UnblockActionRequestPayload;
|
|
2186
|
+
user?: UserRequest;
|
|
2187
|
+
}
|
|
2188
|
+
export interface BulkActionAppealsResponse {
|
|
2189
|
+
duration: string;
|
|
2190
|
+
/**
|
|
2191
|
+
* Appeals that could not be processed, with per-item error messages
|
|
2192
|
+
*/
|
|
2193
|
+
errors: BulkAppealError[];
|
|
2194
|
+
/**
|
|
2195
|
+
* Successfully processed appeals
|
|
2196
|
+
*/
|
|
2197
|
+
results: BulkAppealResult[];
|
|
2198
|
+
}
|
|
2199
|
+
export interface BulkAppealError {
|
|
2200
|
+
appeal_id: string;
|
|
2201
|
+
error: string;
|
|
2202
|
+
}
|
|
2203
|
+
export interface BulkAppealResult {
|
|
2204
|
+
appeal_id: string;
|
|
2205
|
+
appeal_item?: AppealItemResponse;
|
|
2206
|
+
}
|
|
2207
|
+
export interface BulkDeleteActionConfigRequest {
|
|
2208
|
+
/**
|
|
2209
|
+
* UUIDs of the action configs to delete
|
|
2210
|
+
*/
|
|
2211
|
+
ids: string[];
|
|
2212
|
+
user_id?: string;
|
|
2213
|
+
user?: UserRequest;
|
|
2214
|
+
}
|
|
2215
|
+
export interface BulkDeleteActionConfigResponse {
|
|
2216
|
+
/**
|
|
2217
|
+
* Number of action configs deleted
|
|
2218
|
+
*/
|
|
2219
|
+
deleted: number;
|
|
2220
|
+
duration: string;
|
|
2221
|
+
}
|
|
1934
2222
|
export interface BulkImageModerationRequest {
|
|
1935
2223
|
/**
|
|
1936
2224
|
* URL to CSV file containing image URLs to moderate
|
|
@@ -1944,6 +2232,21 @@ export interface BulkImageModerationResponse {
|
|
|
1944
2232
|
*/
|
|
1945
2233
|
task_id: string;
|
|
1946
2234
|
}
|
|
2235
|
+
export interface BulkUpsertActionConfigRequest {
|
|
2236
|
+
/**
|
|
2237
|
+
* List of action configs to create or update
|
|
2238
|
+
*/
|
|
2239
|
+
action_configs: UpsertActionConfigItem[];
|
|
2240
|
+
user_id?: string;
|
|
2241
|
+
user?: UserRequest;
|
|
2242
|
+
}
|
|
2243
|
+
export interface BulkUpsertActionConfigResponse {
|
|
2244
|
+
duration: string;
|
|
2245
|
+
/**
|
|
2246
|
+
* The created or updated action configs in the same order as the request
|
|
2247
|
+
*/
|
|
2248
|
+
action_configs: ModerationActionConfigResponse[];
|
|
2249
|
+
}
|
|
1947
2250
|
export interface BypassActionRequest {
|
|
1948
2251
|
enabled?: boolean;
|
|
1949
2252
|
}
|
|
@@ -2683,6 +2986,7 @@ export interface CallSettingsRequest {
|
|
|
2683
2986
|
audio?: AudioSettingsRequest;
|
|
2684
2987
|
backstage?: BackstageSettingsRequest;
|
|
2685
2988
|
broadcasting?: BroadcastSettingsRequest;
|
|
2989
|
+
encryption?: EncryptionSettingsRequest;
|
|
2686
2990
|
frame_recording?: FrameRecordingSettingsRequest;
|
|
2687
2991
|
geofencing?: GeofenceSettingsRequest;
|
|
2688
2992
|
individual_recording?: IndividualRecordingSettingsRequest;
|
|
@@ -2701,6 +3005,7 @@ export interface CallSettingsResponse {
|
|
|
2701
3005
|
audio: AudioSettingsResponse;
|
|
2702
3006
|
backstage: BackstageSettingsResponse;
|
|
2703
3007
|
broadcasting: BroadcastSettingsResponse;
|
|
3008
|
+
encryption: EncryptionSettingsResponse;
|
|
2704
3009
|
frame_recording: FrameRecordingSettingsResponse;
|
|
2705
3010
|
geofencing: GeofenceSettingsResponse;
|
|
2706
3011
|
individual_recording: IndividualRecordingSettingsResponse;
|
|
@@ -2781,9 +3086,11 @@ export interface CallStatsParticipantCounts {
|
|
|
2781
3086
|
sfus_used: number;
|
|
2782
3087
|
average_jitter_ms?: number;
|
|
2783
3088
|
average_latency_ms?: number;
|
|
3089
|
+
avg_user_rating?: number;
|
|
2784
3090
|
call_event_count?: number;
|
|
2785
3091
|
cq_score?: number;
|
|
2786
3092
|
max_freezes_duration_ms?: number;
|
|
3093
|
+
min_user_rating?: number;
|
|
2787
3094
|
total_participant_duration?: number;
|
|
2788
3095
|
}
|
|
2789
3096
|
export interface CallStatsParticipantSession {
|
|
@@ -2798,6 +3105,7 @@ export interface CallStatsParticipantSession {
|
|
|
2798
3105
|
distance_to_sfu_kilometers?: number;
|
|
2799
3106
|
ended_at?: Date;
|
|
2800
3107
|
freezes_duration_ms?: number;
|
|
3108
|
+
ingress?: string;
|
|
2801
3109
|
jitter_ms?: number;
|
|
2802
3110
|
latency_ms?: number;
|
|
2803
3111
|
os?: string;
|
|
@@ -3002,11 +3310,11 @@ export interface CampaignChannelMember {
|
|
|
3002
3310
|
}
|
|
3003
3311
|
export interface CampaignChannelTemplate {
|
|
3004
3312
|
type: string;
|
|
3005
|
-
custom: Record<string, any>;
|
|
3006
3313
|
id?: string;
|
|
3007
3314
|
team?: string;
|
|
3008
3315
|
members?: string[];
|
|
3009
3316
|
members_template?: CampaignChannelMember[];
|
|
3317
|
+
custom?: Record<string, any>;
|
|
3010
3318
|
}
|
|
3011
3319
|
export interface CampaignCompletedEvent {
|
|
3012
3320
|
created_at: Date;
|
|
@@ -3016,11 +3324,11 @@ export interface CampaignCompletedEvent {
|
|
|
3016
3324
|
campaign?: CampaignResponse;
|
|
3017
3325
|
}
|
|
3018
3326
|
export interface CampaignMessageTemplate {
|
|
3019
|
-
poll_id: string;
|
|
3020
|
-
searchable: boolean;
|
|
3021
3327
|
text: string;
|
|
3022
|
-
|
|
3023
|
-
|
|
3328
|
+
poll_id?: string;
|
|
3329
|
+
searchable?: boolean;
|
|
3330
|
+
attachments?: Attachment[];
|
|
3331
|
+
custom?: Record<string, any>;
|
|
3024
3332
|
}
|
|
3025
3333
|
export interface CampaignResponse {
|
|
3026
3334
|
create_channels: boolean;
|
|
@@ -3063,11 +3371,33 @@ export interface CampaignStatsResponse {
|
|
|
3063
3371
|
stats_users_read: number;
|
|
3064
3372
|
stats_users_sent: number;
|
|
3065
3373
|
}
|
|
3374
|
+
export interface CancelImportV2TaskRequest {
|
|
3375
|
+
}
|
|
3376
|
+
export interface CancelImportV2TaskResponse {
|
|
3377
|
+
/**
|
|
3378
|
+
* Duration of the request in milliseconds
|
|
3379
|
+
*/
|
|
3380
|
+
duration: string;
|
|
3381
|
+
}
|
|
3066
3382
|
export interface CastPollVoteRequest {
|
|
3067
3383
|
user_id?: string;
|
|
3068
3384
|
user?: UserRequest;
|
|
3069
3385
|
vote?: VoteData;
|
|
3070
3386
|
}
|
|
3387
|
+
export interface ChangeFeedVisibilityRequest {
|
|
3388
|
+
/**
|
|
3389
|
+
* Feed visibility level: public, visible, followers, members, or private
|
|
3390
|
+
*/
|
|
3391
|
+
visibility: 'public' | 'visible' | 'followers' | 'members' | 'private';
|
|
3392
|
+
/**
|
|
3393
|
+
* What to do with existing pending follows when loosening visibility from 'followers': auto_approve (default) or reject
|
|
3394
|
+
*/
|
|
3395
|
+
pending_follows_action?: 'auto_approve' | 'reject';
|
|
3396
|
+
}
|
|
3397
|
+
export interface ChangeFeedVisibilityResponse {
|
|
3398
|
+
duration: string;
|
|
3399
|
+
feed: FeedResponse;
|
|
3400
|
+
}
|
|
3071
3401
|
export interface ChannelBatchCompletedEvent {
|
|
3072
3402
|
batch_created_at: Date;
|
|
3073
3403
|
created_at: Date;
|
|
@@ -3152,44 +3482,98 @@ export interface ChannelConfig {
|
|
|
3152
3482
|
automod_thresholds?: Thresholds;
|
|
3153
3483
|
chat_preferences?: ChatPreferences;
|
|
3154
3484
|
}
|
|
3155
|
-
export interface
|
|
3156
|
-
automod: 'disabled' | 'simple' | 'AI';
|
|
3157
|
-
automod_behavior: 'flag' | 'block' | 'shadow_block';
|
|
3158
|
-
connect_events: boolean;
|
|
3159
|
-
count_messages: boolean;
|
|
3160
|
-
created_at: Date;
|
|
3161
|
-
custom_events: boolean;
|
|
3162
|
-
delivery_events: boolean;
|
|
3163
|
-
mark_messages_pending: boolean;
|
|
3164
|
-
max_message_length: number;
|
|
3165
|
-
mutes: boolean;
|
|
3166
|
-
name: string;
|
|
3167
|
-
polls: boolean;
|
|
3168
|
-
push_notifications: boolean;
|
|
3169
|
-
quotes: boolean;
|
|
3170
|
-
reactions: boolean;
|
|
3171
|
-
read_events: boolean;
|
|
3172
|
-
reminders: boolean;
|
|
3173
|
-
replies: boolean;
|
|
3174
|
-
search: boolean;
|
|
3175
|
-
shared_locations: boolean;
|
|
3176
|
-
skip_last_msg_update_for_system_msgs: boolean;
|
|
3177
|
-
typing_events: boolean;
|
|
3178
|
-
updated_at: Date;
|
|
3179
|
-
uploads: boolean;
|
|
3180
|
-
url_enrichment: boolean;
|
|
3181
|
-
user_message_reminders: boolean;
|
|
3182
|
-
commands: Command[];
|
|
3485
|
+
export interface ChannelConfigOverrides {
|
|
3183
3486
|
blocklist?: string;
|
|
3184
|
-
blocklist_behavior?: 'flag' | 'block'
|
|
3185
|
-
|
|
3186
|
-
|
|
3187
|
-
|
|
3188
|
-
|
|
3189
|
-
|
|
3190
|
-
|
|
3191
|
-
|
|
3192
|
-
|
|
3487
|
+
blocklist_behavior?: 'flag' | 'block';
|
|
3488
|
+
/**
|
|
3489
|
+
* Enable/disable message counting
|
|
3490
|
+
*/
|
|
3491
|
+
count_messages?: boolean;
|
|
3492
|
+
/**
|
|
3493
|
+
* Overrides max message length
|
|
3494
|
+
*/
|
|
3495
|
+
max_message_length?: number;
|
|
3496
|
+
/**
|
|
3497
|
+
* Overrides the push notification level for this channel
|
|
3498
|
+
*/
|
|
3499
|
+
push_level?: 'all' | 'all_mentions' | 'mentions' | 'direct_mentions' | 'none';
|
|
3500
|
+
/**
|
|
3501
|
+
* Enables message quotes
|
|
3502
|
+
*/
|
|
3503
|
+
quotes?: boolean;
|
|
3504
|
+
/**
|
|
3505
|
+
* Enables or disables reactions
|
|
3506
|
+
*/
|
|
3507
|
+
reactions?: boolean;
|
|
3508
|
+
/**
|
|
3509
|
+
* Enables message replies (threads)
|
|
3510
|
+
*/
|
|
3511
|
+
replies?: boolean;
|
|
3512
|
+
/**
|
|
3513
|
+
* Enable/disable shared locations
|
|
3514
|
+
*/
|
|
3515
|
+
shared_locations?: boolean;
|
|
3516
|
+
/**
|
|
3517
|
+
* Enables or disables typing events
|
|
3518
|
+
*/
|
|
3519
|
+
typing_events?: boolean;
|
|
3520
|
+
/**
|
|
3521
|
+
* Enables or disables file uploads
|
|
3522
|
+
*/
|
|
3523
|
+
uploads?: boolean;
|
|
3524
|
+
/**
|
|
3525
|
+
* Enables or disables URL enrichment
|
|
3526
|
+
*/
|
|
3527
|
+
url_enrichment?: boolean;
|
|
3528
|
+
/**
|
|
3529
|
+
* Enable/disable user message reminders
|
|
3530
|
+
*/
|
|
3531
|
+
user_message_reminders?: boolean;
|
|
3532
|
+
/**
|
|
3533
|
+
* List of commands that channel supports
|
|
3534
|
+
*/
|
|
3535
|
+
commands?: string[];
|
|
3536
|
+
chat_preferences?: ChatPreferences;
|
|
3537
|
+
grants?: Record<string, string[]>;
|
|
3538
|
+
}
|
|
3539
|
+
export interface ChannelConfigWithInfo {
|
|
3540
|
+
automod: 'disabled' | 'simple' | 'AI';
|
|
3541
|
+
automod_behavior: 'flag' | 'block' | 'shadow_block';
|
|
3542
|
+
connect_events: boolean;
|
|
3543
|
+
count_messages: boolean;
|
|
3544
|
+
created_at: Date;
|
|
3545
|
+
custom_events: boolean;
|
|
3546
|
+
delivery_events: boolean;
|
|
3547
|
+
mark_messages_pending: boolean;
|
|
3548
|
+
max_message_length: number;
|
|
3549
|
+
mutes: boolean;
|
|
3550
|
+
name: string;
|
|
3551
|
+
polls: boolean;
|
|
3552
|
+
push_notifications: boolean;
|
|
3553
|
+
quotes: boolean;
|
|
3554
|
+
reactions: boolean;
|
|
3555
|
+
read_events: boolean;
|
|
3556
|
+
reminders: boolean;
|
|
3557
|
+
replies: boolean;
|
|
3558
|
+
search: boolean;
|
|
3559
|
+
shared_locations: boolean;
|
|
3560
|
+
skip_last_msg_update_for_system_msgs: boolean;
|
|
3561
|
+
typing_events: boolean;
|
|
3562
|
+
updated_at: Date;
|
|
3563
|
+
uploads: boolean;
|
|
3564
|
+
url_enrichment: boolean;
|
|
3565
|
+
user_message_reminders: boolean;
|
|
3566
|
+
commands: Command[];
|
|
3567
|
+
blocklist?: string;
|
|
3568
|
+
blocklist_behavior?: 'flag' | 'block' | 'shadow_block';
|
|
3569
|
+
partition_size?: number;
|
|
3570
|
+
partition_ttl?: string;
|
|
3571
|
+
push_level?: 'all' | 'all_mentions' | 'mentions' | 'direct_mentions' | 'none';
|
|
3572
|
+
allowed_flag_reasons?: string[];
|
|
3573
|
+
blocklists?: BlockListOptions[];
|
|
3574
|
+
automod_thresholds?: Thresholds;
|
|
3575
|
+
chat_preferences?: ChatPreferences;
|
|
3576
|
+
grants?: Record<string, string[]>;
|
|
3193
3577
|
}
|
|
3194
3578
|
export interface ChannelCreatedEvent {
|
|
3195
3579
|
/**
|
|
@@ -3233,7 +3617,7 @@ export interface ChannelDataUpdate {
|
|
|
3233
3617
|
disabled?: boolean;
|
|
3234
3618
|
frozen?: boolean;
|
|
3235
3619
|
team?: string;
|
|
3236
|
-
config_overrides?:
|
|
3620
|
+
config_overrides?: ChannelConfigOverrides;
|
|
3237
3621
|
custom?: Record<string, any>;
|
|
3238
3622
|
}
|
|
3239
3623
|
export interface ChannelDeletedEvent {
|
|
@@ -3393,7 +3777,7 @@ export interface ChannelInput {
|
|
|
3393
3777
|
filter_tags?: string[];
|
|
3394
3778
|
invites?: ChannelMemberRequest[];
|
|
3395
3779
|
members?: ChannelMemberRequest[];
|
|
3396
|
-
config_overrides?:
|
|
3780
|
+
config_overrides?: ChannelConfigOverrides;
|
|
3397
3781
|
created_by?: UserRequest;
|
|
3398
3782
|
custom?: Record<string, any>;
|
|
3399
3783
|
}
|
|
@@ -3409,6 +3793,16 @@ export interface ChannelInputRequest {
|
|
|
3409
3793
|
created_by?: UserRequest;
|
|
3410
3794
|
custom?: Record<string, any>;
|
|
3411
3795
|
}
|
|
3796
|
+
export interface ChannelMemberPartialResponse {
|
|
3797
|
+
/**
|
|
3798
|
+
* Role of the member in the channel
|
|
3799
|
+
*/
|
|
3800
|
+
channel_role: string;
|
|
3801
|
+
/**
|
|
3802
|
+
* Whether the user muted notifications for this channel
|
|
3803
|
+
*/
|
|
3804
|
+
notifications_muted: boolean;
|
|
3805
|
+
}
|
|
3412
3806
|
export interface ChannelMemberRequest {
|
|
3413
3807
|
user_id: string;
|
|
3414
3808
|
/**
|
|
@@ -3473,6 +3867,10 @@ export interface ChannelMemberResponse {
|
|
|
3473
3867
|
deleted_messages?: string[];
|
|
3474
3868
|
user?: UserResponse;
|
|
3475
3869
|
}
|
|
3870
|
+
export interface ChannelMessageCountRuleParameters {
|
|
3871
|
+
operator?: string;
|
|
3872
|
+
threshold?: number;
|
|
3873
|
+
}
|
|
3476
3874
|
export interface ChannelMessagesResponse {
|
|
3477
3875
|
/**
|
|
3478
3876
|
* List of messages
|
|
@@ -3480,6 +3878,17 @@ export interface ChannelMessagesResponse {
|
|
|
3480
3878
|
messages: MessageResponse[];
|
|
3481
3879
|
channel: ChannelResponse;
|
|
3482
3880
|
}
|
|
3881
|
+
export interface ChannelMetadata {
|
|
3882
|
+
cid: string;
|
|
3883
|
+
id: string;
|
|
3884
|
+
type: string;
|
|
3885
|
+
custom: Record<string, any>;
|
|
3886
|
+
last_message_at?: Date;
|
|
3887
|
+
member_count?: number;
|
|
3888
|
+
message_count?: number;
|
|
3889
|
+
push_level?: string;
|
|
3890
|
+
team?: string;
|
|
3891
|
+
}
|
|
3483
3892
|
export interface ChannelMute {
|
|
3484
3893
|
/**
|
|
3485
3894
|
* Date/time of creation
|
|
@@ -3519,6 +3928,7 @@ export declare const ChannelOwnCapability: {
|
|
|
3519
3928
|
readonly CAST_POLL_VOTE: "cast-poll-vote";
|
|
3520
3929
|
readonly CONNECT_EVENTS: "connect-events";
|
|
3521
3930
|
readonly CREATE_ATTACHMENT: "create-attachment";
|
|
3931
|
+
readonly CREATE_MENTION: "create-mention";
|
|
3522
3932
|
readonly DELETE_ANY_MESSAGE: "delete-any-message";
|
|
3523
3933
|
readonly DELETE_CHANNEL: "delete-channel";
|
|
3524
3934
|
readonly DELETE_OWN_MESSAGE: "delete-own-message";
|
|
@@ -3528,6 +3938,10 @@ export declare const ChannelOwnCapability: {
|
|
|
3528
3938
|
readonly JOIN_CHANNEL: "join-channel";
|
|
3529
3939
|
readonly LEAVE_CHANNEL: "leave-channel";
|
|
3530
3940
|
readonly MUTE_CHANNEL: "mute-channel";
|
|
3941
|
+
readonly NOTIFY_CHANNEL: "notify-channel";
|
|
3942
|
+
readonly NOTIFY_GROUP: "notify-group";
|
|
3943
|
+
readonly NOTIFY_HERE: "notify-here";
|
|
3944
|
+
readonly NOTIFY_ROLE: "notify-role";
|
|
3531
3945
|
readonly PIN_MESSAGE: "pin-message";
|
|
3532
3946
|
readonly QUERY_POLL_VOTES: "query-poll-votes";
|
|
3533
3947
|
readonly QUOTE_MESSAGE: "quote-message";
|
|
@@ -3923,6 +4337,90 @@ export interface ChannelVisibleEvent {
|
|
|
3923
4337
|
export interface ChatActivityStatsResponse {
|
|
3924
4338
|
messages?: MessageStatsResponse;
|
|
3925
4339
|
}
|
|
4340
|
+
export interface ChatDraftPayloadResponse {
|
|
4341
|
+
id: string;
|
|
4342
|
+
text: string;
|
|
4343
|
+
custom: Record<string, any>;
|
|
4344
|
+
html?: string;
|
|
4345
|
+
mml?: string;
|
|
4346
|
+
parent_id?: string;
|
|
4347
|
+
poll_id?: string;
|
|
4348
|
+
quoted_message_id?: string;
|
|
4349
|
+
show_in_channel?: boolean;
|
|
4350
|
+
silent?: boolean;
|
|
4351
|
+
type?: string;
|
|
4352
|
+
attachments?: Attachment[];
|
|
4353
|
+
mentioned_users?: UserResponse[];
|
|
4354
|
+
}
|
|
4355
|
+
export interface ChatDraftResponse {
|
|
4356
|
+
channel_cid: string;
|
|
4357
|
+
created_at: Date;
|
|
4358
|
+
message: ChatDraftPayloadResponse;
|
|
4359
|
+
parent_id?: string;
|
|
4360
|
+
parent_message?: ChatMessageResponse;
|
|
4361
|
+
quoted_message?: ChatMessageResponse;
|
|
4362
|
+
}
|
|
4363
|
+
export interface ChatMessageResponse {
|
|
4364
|
+
cid: string;
|
|
4365
|
+
created_at: Date;
|
|
4366
|
+
deleted_reply_count: number;
|
|
4367
|
+
html: string;
|
|
4368
|
+
id: string;
|
|
4369
|
+
mentioned_channel: boolean;
|
|
4370
|
+
mentioned_here: boolean;
|
|
4371
|
+
pinned: boolean;
|
|
4372
|
+
reply_count: number;
|
|
4373
|
+
shadowed: boolean;
|
|
4374
|
+
silent: boolean;
|
|
4375
|
+
text: string;
|
|
4376
|
+
type: string;
|
|
4377
|
+
updated_at: Date;
|
|
4378
|
+
attachments: Attachment[];
|
|
4379
|
+
latest_reactions: ChatReactionResponse[];
|
|
4380
|
+
mentioned_users: UserResponse[];
|
|
4381
|
+
own_reactions: ChatReactionResponse[];
|
|
4382
|
+
restricted_visibility: string[];
|
|
4383
|
+
custom: Record<string, any>;
|
|
4384
|
+
reaction_counts: Record<string, number>;
|
|
4385
|
+
reaction_scores: Record<string, number>;
|
|
4386
|
+
user: UserResponse;
|
|
4387
|
+
command?: string;
|
|
4388
|
+
deleted_at?: Date;
|
|
4389
|
+
deleted_for_me?: boolean;
|
|
4390
|
+
message_text_updated_at?: Date;
|
|
4391
|
+
mml?: string;
|
|
4392
|
+
parent_id?: string;
|
|
4393
|
+
pin_expires?: Date;
|
|
4394
|
+
pinned_at?: Date;
|
|
4395
|
+
poll_id?: string;
|
|
4396
|
+
quoted_message_id?: string;
|
|
4397
|
+
show_in_channel?: boolean;
|
|
4398
|
+
mentioned_group_ids?: string[];
|
|
4399
|
+
mentioned_groups?: UserGroupResponse[];
|
|
4400
|
+
mentioned_roles?: string[];
|
|
4401
|
+
thread_participants?: UserResponse[];
|
|
4402
|
+
draft?: ChatDraftResponse;
|
|
4403
|
+
i18n?: Record<string, string>;
|
|
4404
|
+
image_labels?: Record<string, string[]>;
|
|
4405
|
+
member?: ChannelMemberPartialResponse;
|
|
4406
|
+
moderation?: ChatModerationV2Response;
|
|
4407
|
+
pinned_by?: UserResponse;
|
|
4408
|
+
poll?: PollResponseData;
|
|
4409
|
+
quoted_message?: ChatMessageResponse;
|
|
4410
|
+
reaction_groups?: Record<string, ChatReactionGroupResponse>;
|
|
4411
|
+
reminder?: ChatReminderResponseData;
|
|
4412
|
+
shared_location?: ChatSharedLocationResponseData;
|
|
4413
|
+
}
|
|
4414
|
+
export interface ChatModerationV2Response {
|
|
4415
|
+
action: string;
|
|
4416
|
+
original_text: string;
|
|
4417
|
+
blocklist_matched?: string;
|
|
4418
|
+
platform_circumvented?: boolean;
|
|
4419
|
+
semantic_filter_matched?: string;
|
|
4420
|
+
blocklists_matched?: string[];
|
|
4421
|
+
image_harms?: string[];
|
|
4422
|
+
text_harms?: string[];
|
|
4423
|
+
}
|
|
3926
4424
|
export interface ChatPreferences {
|
|
3927
4425
|
channel_mentions?: string;
|
|
3928
4426
|
default_preference?: string;
|
|
@@ -3951,6 +4449,50 @@ export interface ChatPreferencesResponse {
|
|
|
3951
4449
|
role_mentions?: string;
|
|
3952
4450
|
thread_replies?: string;
|
|
3953
4451
|
}
|
|
4452
|
+
export interface ChatReactionGroupResponse {
|
|
4453
|
+
count: number;
|
|
4454
|
+
first_reaction_at: Date;
|
|
4455
|
+
last_reaction_at: Date;
|
|
4456
|
+
sum_scores: number;
|
|
4457
|
+
latest_reactions_by: ChatReactionGroupUserResponse[];
|
|
4458
|
+
}
|
|
4459
|
+
export interface ChatReactionGroupUserResponse {
|
|
4460
|
+
created_at: Date;
|
|
4461
|
+
user_id: string;
|
|
4462
|
+
user?: UserResponse;
|
|
4463
|
+
}
|
|
4464
|
+
export interface ChatReactionResponse {
|
|
4465
|
+
created_at: Date;
|
|
4466
|
+
message_id: string;
|
|
4467
|
+
score: number;
|
|
4468
|
+
type: string;
|
|
4469
|
+
updated_at: Date;
|
|
4470
|
+
user_id: string;
|
|
4471
|
+
custom: Record<string, any>;
|
|
4472
|
+
user: UserResponse;
|
|
4473
|
+
}
|
|
4474
|
+
export interface ChatReminderResponseData {
|
|
4475
|
+
channel_cid: string;
|
|
4476
|
+
created_at: Date;
|
|
4477
|
+
message_id: string;
|
|
4478
|
+
updated_at: Date;
|
|
4479
|
+
user_id: string;
|
|
4480
|
+
remind_at?: Date;
|
|
4481
|
+
message?: ChatMessageResponse;
|
|
4482
|
+
user?: UserResponse;
|
|
4483
|
+
}
|
|
4484
|
+
export interface ChatSharedLocationResponseData {
|
|
4485
|
+
channel_cid: string;
|
|
4486
|
+
created_at: Date;
|
|
4487
|
+
created_by_device_id: string;
|
|
4488
|
+
latitude: number;
|
|
4489
|
+
longitude: number;
|
|
4490
|
+
message_id: string;
|
|
4491
|
+
updated_at: Date;
|
|
4492
|
+
user_id: string;
|
|
4493
|
+
end_at?: Date;
|
|
4494
|
+
message?: ChatMessageResponse;
|
|
4495
|
+
}
|
|
3954
4496
|
export interface CheckExternalStorageResponse {
|
|
3955
4497
|
/**
|
|
3956
4498
|
* Duration of the request in milliseconds
|
|
@@ -4068,6 +4610,10 @@ export interface CheckResponse {
|
|
|
4068
4610
|
* ID of the running moderation task
|
|
4069
4611
|
*/
|
|
4070
4612
|
task_id?: string;
|
|
4613
|
+
/**
|
|
4614
|
+
* All moderation rules triggered by this check (content, user, and call rules), with their resolved actions
|
|
4615
|
+
*/
|
|
4616
|
+
triggered_rules?: TriggeredRuleResponse[];
|
|
4071
4617
|
item?: ReviewQueueItemResponse;
|
|
4072
4618
|
triggered_rule?: TriggeredRuleResponse;
|
|
4073
4619
|
}
|
|
@@ -4146,6 +4692,122 @@ export interface CheckSQSResponse {
|
|
|
4146
4692
|
*/
|
|
4147
4693
|
data?: Record<string, any>;
|
|
4148
4694
|
}
|
|
4695
|
+
export interface Classification {
|
|
4696
|
+
name: string;
|
|
4697
|
+
confidence?: number;
|
|
4698
|
+
severity?: string;
|
|
4699
|
+
subclassifications?: Classification[];
|
|
4700
|
+
}
|
|
4701
|
+
export interface ClientEvent {
|
|
4702
|
+
/**
|
|
4703
|
+
* Call session ID associated with the attempt. Required on every event except CoordinatorJoin initiation and CoordinatorJoin failure (where the call session is not yet established); optional on MediaDevicePermission.
|
|
4704
|
+
*/
|
|
4705
|
+
call_session_id?: string;
|
|
4706
|
+
/**
|
|
4707
|
+
* Camera permission status: INITIATED, FAILED, GRANTED, or NOT_INITIATED. Required on every MediaDevicePermission event.
|
|
4708
|
+
*/
|
|
4709
|
+
camera_permission_status?: string;
|
|
4710
|
+
/**
|
|
4711
|
+
* UUID generated by the client and shared across every event of the same coordinator connection. Required on every event except JoinInitiated, which is reported before a coordinator connection exists.
|
|
4712
|
+
*/
|
|
4713
|
+
coordinator_connect_id?: string;
|
|
4714
|
+
/**
|
|
4715
|
+
* Milliseconds elapsed between the stage attempt's initiation and this event.
|
|
4716
|
+
*/
|
|
4717
|
+
elapsed_time?: number;
|
|
4718
|
+
/**
|
|
4719
|
+
* Whether the event marks the start (initiated) or resolution (completed) of a stage attempt, or another event-specific value
|
|
4720
|
+
*/
|
|
4721
|
+
event_type?: string;
|
|
4722
|
+
/**
|
|
4723
|
+
* Terminal state of the peer connection. Required on PeerConnectionConnect failure.
|
|
4724
|
+
*/
|
|
4725
|
+
ice_state?: string;
|
|
4726
|
+
/**
|
|
4727
|
+
* Call ID associated with the event. Required on every stage except CoordinatorWS, where it is optional.
|
|
4728
|
+
*/
|
|
4729
|
+
id?: string;
|
|
4730
|
+
/**
|
|
4731
|
+
* UUID generated by the client and shared across JoinInitiated and the join-lifecycle events (CoordinatorJoin, WSJoin, PeerConnectionConnect) of the same overall join attempt. Required on every join event except CoordinatorWS, which is reported before a join attempt is established.
|
|
4732
|
+
*/
|
|
4733
|
+
join_attempt_id?: string;
|
|
4734
|
+
/**
|
|
4735
|
+
* Reason the client initiated the join. Optional on CoordinatorJoin events; empty when not provided.
|
|
4736
|
+
*/
|
|
4737
|
+
join_reason?: string;
|
|
4738
|
+
/**
|
|
4739
|
+
* Microphone permission status: INITIATED, FAILED, GRANTED, or NOT_INITIATED. Required on every MediaDevicePermission event.
|
|
4740
|
+
*/
|
|
4741
|
+
microphone_permission_status?: string;
|
|
4742
|
+
/**
|
|
4743
|
+
* Resolution of a completed event: success or failure. Required on completed join events; forbidden on initiated join events.
|
|
4744
|
+
*/
|
|
4745
|
+
outcome?: string;
|
|
4746
|
+
/**
|
|
4747
|
+
* Which peer connection a PeerConnectionConnect event reports on: publish or subscribe. Required on every PeerConnectionConnect event.
|
|
4748
|
+
*/
|
|
4749
|
+
peer_connection?: string;
|
|
4750
|
+
/**
|
|
4751
|
+
* UTC timestamp at which the ICE connection was established earlier in the session, when applicable
|
|
4752
|
+
*/
|
|
4753
|
+
previously_connected_timestamp?: Date;
|
|
4754
|
+
/**
|
|
4755
|
+
* Total in-stage retries the client made before resolving (0–1000). Required on completed join events.
|
|
4756
|
+
*/
|
|
4757
|
+
retry_count_attempt?: number;
|
|
4758
|
+
/**
|
|
4759
|
+
* Failure code string. Required on CoordinatorJoin, CoordinatorWS, WSJoin, and PeerConnectionConnect failure.
|
|
4760
|
+
*/
|
|
4761
|
+
retry_failure_code?: string;
|
|
4762
|
+
/**
|
|
4763
|
+
* Failure reason string. Required on CoordinatorJoin, CoordinatorWS, WSJoin, and PeerConnectionConnect failure.
|
|
4764
|
+
*/
|
|
4765
|
+
retry_failure_reason?: string;
|
|
4766
|
+
/**
|
|
4767
|
+
* Screen-share permission status: INITIATED, FAILED, GRANTED, or NOT_INITIATED. Optional on MediaDevicePermission events.
|
|
4768
|
+
*/
|
|
4769
|
+
screen_share_status?: string;
|
|
4770
|
+
/**
|
|
4771
|
+
* Version of the client SDK
|
|
4772
|
+
*/
|
|
4773
|
+
sdk_version?: string;
|
|
4774
|
+
/**
|
|
4775
|
+
* Identifier of the SFU the client was attempting to connect to. Required on WSJoin and PeerConnectionConnect failure, and on FirstAudioFrame and FirstVideoFrame.
|
|
4776
|
+
*/
|
|
4777
|
+
sfu_id?: string;
|
|
4778
|
+
/**
|
|
4779
|
+
* Discriminator identifying the event kind. JoinInitiated marks the start of a join attempt; join-lifecycle events use CoordinatorJoin, CoordinatorWS, WSJoin, or PeerConnectionConnect; media-readiness events use FirstAudioFrame or FirstVideoFrame; MediaDevicePermission reports device permission results; other values denote generic client events.
|
|
4780
|
+
*/
|
|
4781
|
+
stage?: string;
|
|
4782
|
+
/**
|
|
4783
|
+
* UUID generated by the client at initiation. Identical on the matching completion event. Absent on JoinInitiated.
|
|
4784
|
+
*/
|
|
4785
|
+
stage_id?: string;
|
|
4786
|
+
/**
|
|
4787
|
+
* UTC timestamp at which the event was recorded
|
|
4788
|
+
*/
|
|
4789
|
+
timestamp?: Date;
|
|
4790
|
+
/**
|
|
4791
|
+
* Identifier of the media track the frame belongs to. Required on FirstVideoFrame; optional on FirstAudioFrame.
|
|
4792
|
+
*/
|
|
4793
|
+
track_id?: string;
|
|
4794
|
+
/**
|
|
4795
|
+
* Call type associated with the event. Required on every stage except CoordinatorWS, where it is optional.
|
|
4796
|
+
*/
|
|
4797
|
+
type?: string;
|
|
4798
|
+
/**
|
|
4799
|
+
* User agent string of the client SDK
|
|
4800
|
+
*/
|
|
4801
|
+
user_agent?: string;
|
|
4802
|
+
/**
|
|
4803
|
+
* ID of the user the event was recorded for
|
|
4804
|
+
*/
|
|
4805
|
+
user_id?: string;
|
|
4806
|
+
/**
|
|
4807
|
+
* Whether the ICE connection had been established earlier in the same session. Required on every PeerConnectionConnect event so reconnects can be distinguished from fresh connects.
|
|
4808
|
+
*/
|
|
4809
|
+
was_previously_connected?: boolean;
|
|
4810
|
+
}
|
|
4149
4811
|
export interface ClientOSDataResponse {
|
|
4150
4812
|
architecture?: string;
|
|
4151
4813
|
name?: string;
|
|
@@ -4161,7 +4823,9 @@ export interface ClosedCaptionEvent {
|
|
|
4161
4823
|
type: string;
|
|
4162
4824
|
}
|
|
4163
4825
|
export interface ClosedCaptionRuleParameters {
|
|
4826
|
+
severity?: string;
|
|
4164
4827
|
threshold?: number;
|
|
4828
|
+
time_window?: string;
|
|
4165
4829
|
harm_labels?: string[];
|
|
4166
4830
|
llm_harm_labels?: Record<string, string>;
|
|
4167
4831
|
}
|
|
@@ -4425,6 +5089,7 @@ export interface CommentResponse {
|
|
|
4425
5089
|
* Custom data for the comment
|
|
4426
5090
|
*/
|
|
4427
5091
|
custom?: Record<string, any>;
|
|
5092
|
+
i18n?: Record<string, string>;
|
|
4428
5093
|
moderation?: ModerationV2Response;
|
|
4429
5094
|
/**
|
|
4430
5095
|
* Grouped reactions by type
|
|
@@ -4554,6 +5219,11 @@ export interface ConfigResponse {
|
|
|
4554
5219
|
* Configurable image moderation label definitions for dashboard rendering
|
|
4555
5220
|
*/
|
|
4556
5221
|
ai_image_label_definitions?: AIImageLabelDefinition[];
|
|
5222
|
+
/**
|
|
5223
|
+
* Names of Bodyguard credential profiles registered on this app. The dashboard uses this list to render the profile picker on the AI Text section.
|
|
5224
|
+
*/
|
|
5225
|
+
available_bodyguard_profiles?: BodyguardProfileSummary[];
|
|
5226
|
+
ai_audio_config?: AIAudioConfigResponse;
|
|
4557
5227
|
ai_image_config?: AIImageConfig;
|
|
4558
5228
|
/**
|
|
4559
5229
|
* Available L2 subclassifications per L1 image moderation label, based on the active provider
|
|
@@ -4565,6 +5235,7 @@ export interface ConfigResponse {
|
|
|
4565
5235
|
automod_semantic_filters_config?: AutomodSemanticFiltersConfig;
|
|
4566
5236
|
automod_toxicity_config?: AutomodToxicityConfig;
|
|
4567
5237
|
block_list_config?: BlockListConfig;
|
|
5238
|
+
flood_config?: FloodConfig;
|
|
4568
5239
|
llm_config?: LLMConfig;
|
|
4569
5240
|
velocity_filter_config?: VelocityFilterConfig;
|
|
4570
5241
|
video_call_rule_config?: VideoCallRuleConfig;
|
|
@@ -4573,6 +5244,16 @@ export interface ContentCountRuleParameters {
|
|
|
4573
5244
|
threshold?: number;
|
|
4574
5245
|
time_window?: string;
|
|
4575
5246
|
}
|
|
5247
|
+
export interface ContentCustomPropertyCountParameters {
|
|
5248
|
+
operator?: string;
|
|
5249
|
+
property_key?: string;
|
|
5250
|
+
threshold?: number;
|
|
5251
|
+
time_window?: string;
|
|
5252
|
+
}
|
|
5253
|
+
export interface ContentCustomPropertyParameters {
|
|
5254
|
+
operator?: string;
|
|
5255
|
+
property_key?: string;
|
|
5256
|
+
}
|
|
4576
5257
|
export interface CoordinatesResponse {
|
|
4577
5258
|
/**
|
|
4578
5259
|
* Latitude coordinate
|
|
@@ -4596,8 +5277,10 @@ export interface CreateBlockListRequest {
|
|
|
4596
5277
|
* List of words to block
|
|
4597
5278
|
*/
|
|
4598
5279
|
words: string[];
|
|
5280
|
+
is_confusable_folding_enabled?: boolean;
|
|
4599
5281
|
is_leet_check_enabled?: boolean;
|
|
4600
5282
|
is_plural_check_enabled?: boolean;
|
|
5283
|
+
is_substring_matching_enabled?: boolean;
|
|
4601
5284
|
team?: string;
|
|
4602
5285
|
/**
|
|
4603
5286
|
* Block list type. One of: regex, domain, domain_allowlist, email, email_allowlist, word
|
|
@@ -4649,6 +5332,63 @@ export interface CreateCallTypeResponse {
|
|
|
4649
5332
|
*/
|
|
4650
5333
|
external_storage?: string;
|
|
4651
5334
|
}
|
|
5335
|
+
export interface CreateCampaignRequest {
|
|
5336
|
+
/**
|
|
5337
|
+
* The user ID of the sender
|
|
5338
|
+
*/
|
|
5339
|
+
sender_id: string;
|
|
5340
|
+
message_template: CampaignMessageTemplate;
|
|
5341
|
+
/**
|
|
5342
|
+
* Whether to create channels for the campaign, if they don't exist
|
|
5343
|
+
*/
|
|
5344
|
+
create_channels?: boolean;
|
|
5345
|
+
/**
|
|
5346
|
+
* The description of the campaign
|
|
5347
|
+
*/
|
|
5348
|
+
description?: string;
|
|
5349
|
+
id?: string;
|
|
5350
|
+
/**
|
|
5351
|
+
* The name of the campaign
|
|
5352
|
+
*/
|
|
5353
|
+
name?: string;
|
|
5354
|
+
/**
|
|
5355
|
+
* The sender mode of the campaign
|
|
5356
|
+
*/
|
|
5357
|
+
sender_mode?: 'exclude' | 'include';
|
|
5358
|
+
/**
|
|
5359
|
+
* The visibility of the created channels for the sender
|
|
5360
|
+
*/
|
|
5361
|
+
sender_visibility?: 'hidden' | 'archived';
|
|
5362
|
+
/**
|
|
5363
|
+
* Whether the campaign should show channels, if they are hidden
|
|
5364
|
+
*/
|
|
5365
|
+
show_channels?: boolean;
|
|
5366
|
+
/**
|
|
5367
|
+
* Whether to skip push notifications
|
|
5368
|
+
*/
|
|
5369
|
+
skip_push?: boolean;
|
|
5370
|
+
/**
|
|
5371
|
+
* Whether to skip webhooks
|
|
5372
|
+
*/
|
|
5373
|
+
skip_webhook?: boolean;
|
|
5374
|
+
/**
|
|
5375
|
+
* The IDs of the segments to send the campaign to. Duplicate user IDs are removed. Use either user_ids or segment_ids, not both
|
|
5376
|
+
*/
|
|
5377
|
+
segment_ids?: string[];
|
|
5378
|
+
/**
|
|
5379
|
+
* The userIDs to send the campaign to. Use either segment ids or user ids not both
|
|
5380
|
+
*/
|
|
5381
|
+
user_ids?: string[];
|
|
5382
|
+
channel_template?: CampaignChannelTemplate;
|
|
5383
|
+
}
|
|
5384
|
+
export interface CreateCampaignResponse {
|
|
5385
|
+
/**
|
|
5386
|
+
* Duration of the request in milliseconds
|
|
5387
|
+
*/
|
|
5388
|
+
duration: string;
|
|
5389
|
+
campaign?: CampaignResponse;
|
|
5390
|
+
users?: PagerResponse;
|
|
5391
|
+
}
|
|
4652
5392
|
export interface CreateChannelTypeRequest {
|
|
4653
5393
|
/**
|
|
4654
5394
|
* Automod. One of: disabled, simple, AI
|
|
@@ -4858,6 +5598,10 @@ export interface CreateDeviceRequest {
|
|
|
4858
5598
|
* Push provider
|
|
4859
5599
|
*/
|
|
4860
5600
|
push_provider: 'firebase' | 'apn' | 'huawei' | 'xiaomi';
|
|
5601
|
+
/**
|
|
5602
|
+
* Stable physical device identifier used to deduplicate pushes across push providers (e.g. APNs VoIP and Firebase on the same iOS device). Distinct from 'id', which is the push token.
|
|
5603
|
+
*/
|
|
5604
|
+
hardware_id?: string;
|
|
4861
5605
|
/**
|
|
4862
5606
|
* Push provider name
|
|
4863
5607
|
*/
|
|
@@ -5092,6 +5836,15 @@ export interface CreatePollRequest {
|
|
|
5092
5836
|
custom?: Record<string, any>;
|
|
5093
5837
|
user?: UserRequest;
|
|
5094
5838
|
}
|
|
5839
|
+
export interface CreateQueueRequest {
|
|
5840
|
+
name: string;
|
|
5841
|
+
type: 'personal_view' | 'operational_queue';
|
|
5842
|
+
description?: string;
|
|
5843
|
+
user_id?: string;
|
|
5844
|
+
sort?: Array<Record<string, any>>;
|
|
5845
|
+
filters?: Record<string, any>;
|
|
5846
|
+
user?: UserRequest;
|
|
5847
|
+
}
|
|
5095
5848
|
export interface CreateReminderRequest {
|
|
5096
5849
|
remind_at?: Date;
|
|
5097
5850
|
user_id?: string;
|
|
@@ -5130,7 +5883,44 @@ export interface CreateSIPTrunkRequest {
|
|
|
5130
5883
|
}
|
|
5131
5884
|
export interface CreateSIPTrunkResponse {
|
|
5132
5885
|
duration: string;
|
|
5133
|
-
sip_trunk?: SIPTrunkResponse;
|
|
5886
|
+
sip_trunk?: SIPTrunkResponse;
|
|
5887
|
+
}
|
|
5888
|
+
export interface CreateSegmentRequest {
|
|
5889
|
+
/**
|
|
5890
|
+
* The type of the segment
|
|
5891
|
+
*/
|
|
5892
|
+
type: 'user' | 'channel';
|
|
5893
|
+
/**
|
|
5894
|
+
* If true, all sender channels are included in the segment
|
|
5895
|
+
*/
|
|
5896
|
+
all_sender_channels?: boolean;
|
|
5897
|
+
/**
|
|
5898
|
+
* If true, all users are included in the segment
|
|
5899
|
+
*/
|
|
5900
|
+
all_users?: boolean;
|
|
5901
|
+
/**
|
|
5902
|
+
* The description of the segment (max 256 characters)
|
|
5903
|
+
*/
|
|
5904
|
+
description?: string;
|
|
5905
|
+
/**
|
|
5906
|
+
* The ID of the segment
|
|
5907
|
+
*/
|
|
5908
|
+
id?: string;
|
|
5909
|
+
/**
|
|
5910
|
+
* The name of the segment (max 128 characters)
|
|
5911
|
+
*/
|
|
5912
|
+
name?: string;
|
|
5913
|
+
/**
|
|
5914
|
+
* Filter to apply to the query
|
|
5915
|
+
*/
|
|
5916
|
+
filter?: Record<string, any>;
|
|
5917
|
+
}
|
|
5918
|
+
export interface CreateSegmentResponse {
|
|
5919
|
+
/**
|
|
5920
|
+
* Duration of the request in milliseconds
|
|
5921
|
+
*/
|
|
5922
|
+
duration: string;
|
|
5923
|
+
segment?: SegmentResponse;
|
|
5134
5924
|
}
|
|
5135
5925
|
export interface CreateUserGroupRequest {
|
|
5136
5926
|
/**
|
|
@@ -5365,6 +6155,13 @@ export interface DecayFunctionConfig {
|
|
|
5365
6155
|
*/
|
|
5366
6156
|
scale?: string;
|
|
5367
6157
|
}
|
|
6158
|
+
export interface DeleteActionConfigResponse {
|
|
6159
|
+
/**
|
|
6160
|
+
* Number of action configs deleted (0 or 1)
|
|
6161
|
+
*/
|
|
6162
|
+
deleted: number;
|
|
6163
|
+
duration: string;
|
|
6164
|
+
}
|
|
5368
6165
|
export interface DeleteActivitiesRequest {
|
|
5369
6166
|
/**
|
|
5370
6167
|
* List of activity IDs to delete
|
|
@@ -5432,6 +6229,12 @@ export interface DeleteCallResponse {
|
|
|
5432
6229
|
call: CallResponse;
|
|
5433
6230
|
task_id?: string;
|
|
5434
6231
|
}
|
|
6232
|
+
export interface DeleteCampaignResponse {
|
|
6233
|
+
/**
|
|
6234
|
+
* Duration of the request in milliseconds
|
|
6235
|
+
*/
|
|
6236
|
+
duration: string;
|
|
6237
|
+
}
|
|
5435
6238
|
export interface DeleteChannelResponse {
|
|
5436
6239
|
/**
|
|
5437
6240
|
* Duration of the request in milliseconds
|
|
@@ -5605,6 +6408,10 @@ export interface DeleteModerationRuleResponse {
|
|
|
5605
6408
|
export interface DeleteModerationTemplateResponse {
|
|
5606
6409
|
duration: string;
|
|
5607
6410
|
}
|
|
6411
|
+
export interface DeleteQueueRequest {
|
|
6412
|
+
user_id?: string;
|
|
6413
|
+
user?: UserRequest;
|
|
6414
|
+
}
|
|
5608
6415
|
export interface DeleteReactionRequestPayload {
|
|
5609
6416
|
/**
|
|
5610
6417
|
* ID of the reaction to delete (alternative to item_id)
|
|
@@ -5760,7 +6567,7 @@ export interface DeliveredMessagePayload {
|
|
|
5760
6567
|
id?: string;
|
|
5761
6568
|
}
|
|
5762
6569
|
export interface DeliveryReceiptsResponse {
|
|
5763
|
-
enabled
|
|
6570
|
+
enabled: boolean;
|
|
5764
6571
|
}
|
|
5765
6572
|
export interface DeviceDataResponse {
|
|
5766
6573
|
name?: string;
|
|
@@ -5796,6 +6603,10 @@ export interface DeviceResponse {
|
|
|
5796
6603
|
* Reason explaining why device had been disabled
|
|
5797
6604
|
*/
|
|
5798
6605
|
disabled_reason?: string;
|
|
6606
|
+
/**
|
|
6607
|
+
* Stable physical device identifier used to deduplicate pushes across push providers
|
|
6608
|
+
*/
|
|
6609
|
+
hardware_id?: string;
|
|
5799
6610
|
/**
|
|
5800
6611
|
* Push provider name
|
|
5801
6612
|
*/
|
|
@@ -5907,6 +6718,18 @@ export interface EgressResponse {
|
|
|
5907
6718
|
individual_recording?: IndividualRecordingResponse;
|
|
5908
6719
|
raw_recording?: RawRecordingResponse;
|
|
5909
6720
|
}
|
|
6721
|
+
export interface EncryptionSettingsRequest {
|
|
6722
|
+
/**
|
|
6723
|
+
* if true, the call is created end-to-end encrypted
|
|
6724
|
+
*/
|
|
6725
|
+
enabled?: boolean;
|
|
6726
|
+
}
|
|
6727
|
+
export interface EncryptionSettingsResponse {
|
|
6728
|
+
/**
|
|
6729
|
+
* whether the call is end-to-end encrypted
|
|
6730
|
+
*/
|
|
6731
|
+
enabled: boolean;
|
|
6732
|
+
}
|
|
5910
6733
|
export interface EndCallRequest {
|
|
5911
6734
|
}
|
|
5912
6735
|
export interface EndCallResponse {
|
|
@@ -5929,15 +6752,6 @@ export interface EnrichedActivity {
|
|
|
5929
6752
|
reaction_counts?: Record<string, number>;
|
|
5930
6753
|
target?: Data;
|
|
5931
6754
|
}
|
|
5932
|
-
export interface EnrichedCollection {
|
|
5933
|
-
created_at: Date;
|
|
5934
|
-
id: string;
|
|
5935
|
-
name: string;
|
|
5936
|
-
status: string;
|
|
5937
|
-
updated_at: Date;
|
|
5938
|
-
user_id: string;
|
|
5939
|
-
custom: Record<string, any>;
|
|
5940
|
-
}
|
|
5941
6755
|
export interface EnrichedCollectionResponse {
|
|
5942
6756
|
/**
|
|
5943
6757
|
* Unique identifier for the collection within its name
|
|
@@ -6105,6 +6919,7 @@ export interface EntityCreatorResponse {
|
|
|
6105
6919
|
teams_role?: Record<string, string>;
|
|
6106
6920
|
}
|
|
6107
6921
|
export interface ErrorResult {
|
|
6922
|
+
description: string;
|
|
6108
6923
|
type: string;
|
|
6109
6924
|
stacktrace?: string;
|
|
6110
6925
|
version?: string;
|
|
@@ -6153,6 +6968,7 @@ export interface EventHook {
|
|
|
6153
6968
|
webhook_url?: string;
|
|
6154
6969
|
event_types?: string[];
|
|
6155
6970
|
callback?: AsyncModerationCallbackConfig;
|
|
6971
|
+
failover_config?: WebhookFailoverConfig;
|
|
6156
6972
|
}
|
|
6157
6973
|
export interface EventNotificationSettings {
|
|
6158
6974
|
enabled: boolean;
|
|
@@ -6805,6 +7621,48 @@ export interface FeedVisibilityResponse {
|
|
|
6805
7621
|
*/
|
|
6806
7622
|
grants: Record<string, string[]>;
|
|
6807
7623
|
}
|
|
7624
|
+
export interface FeedsActivityLocation {
|
|
7625
|
+
lat: number;
|
|
7626
|
+
lng: number;
|
|
7627
|
+
}
|
|
7628
|
+
export interface FeedsBookmarkResponse {
|
|
7629
|
+
created_at: Date;
|
|
7630
|
+
object_id: string;
|
|
7631
|
+
object_type: string;
|
|
7632
|
+
updated_at: Date;
|
|
7633
|
+
user: UserResponse;
|
|
7634
|
+
activity_id?: string;
|
|
7635
|
+
custom?: Record<string, any>;
|
|
7636
|
+
}
|
|
7637
|
+
export interface FeedsEnrichedCollectionResponse {
|
|
7638
|
+
created_at: Date;
|
|
7639
|
+
id: string;
|
|
7640
|
+
name: string;
|
|
7641
|
+
status: string;
|
|
7642
|
+
updated_at: Date;
|
|
7643
|
+
user_id: string;
|
|
7644
|
+
custom: Record<string, any>;
|
|
7645
|
+
}
|
|
7646
|
+
export interface FeedsFeedResponse {
|
|
7647
|
+
activity_count: number;
|
|
7648
|
+
created_at: Date;
|
|
7649
|
+
description: string;
|
|
7650
|
+
feed: string;
|
|
7651
|
+
follower_count: number;
|
|
7652
|
+
following_count: number;
|
|
7653
|
+
group_id: string;
|
|
7654
|
+
id: string;
|
|
7655
|
+
member_count: number;
|
|
7656
|
+
name: string;
|
|
7657
|
+
pin_count: number;
|
|
7658
|
+
updated_at: Date;
|
|
7659
|
+
created_by: UserResponse;
|
|
7660
|
+
deleted_at?: Date;
|
|
7661
|
+
visibility?: string;
|
|
7662
|
+
filter_tags?: string[];
|
|
7663
|
+
custom?: Record<string, any>;
|
|
7664
|
+
location?: FeedsActivityLocation;
|
|
7665
|
+
}
|
|
6808
7666
|
export interface FeedsModerationTemplateConfigPayload {
|
|
6809
7667
|
/**
|
|
6810
7668
|
* Map of data type names to their content types
|
|
@@ -6815,6 +7673,40 @@ export interface FeedsModerationTemplateConfigPayload {
|
|
|
6815
7673
|
*/
|
|
6816
7674
|
config_key?: string;
|
|
6817
7675
|
}
|
|
7676
|
+
export interface FeedsNotificationComment {
|
|
7677
|
+
comment: string;
|
|
7678
|
+
id: string;
|
|
7679
|
+
user_id: string;
|
|
7680
|
+
attachments?: Attachment[];
|
|
7681
|
+
}
|
|
7682
|
+
export interface FeedsNotificationContext {
|
|
7683
|
+
target?: FeedsNotificationTarget;
|
|
7684
|
+
trigger?: FeedsNotificationTrigger;
|
|
7685
|
+
}
|
|
7686
|
+
export interface FeedsNotificationParentActivity {
|
|
7687
|
+
id: string;
|
|
7688
|
+
text?: string;
|
|
7689
|
+
type?: string;
|
|
7690
|
+
user_id?: string;
|
|
7691
|
+
attachments?: Attachment[];
|
|
7692
|
+
}
|
|
7693
|
+
export interface FeedsNotificationTarget {
|
|
7694
|
+
id: string;
|
|
7695
|
+
name?: string;
|
|
7696
|
+
text?: string;
|
|
7697
|
+
type?: string;
|
|
7698
|
+
user_id?: string;
|
|
7699
|
+
attachments?: Attachment[];
|
|
7700
|
+
comment?: FeedsNotificationComment;
|
|
7701
|
+
custom?: Record<string, any>;
|
|
7702
|
+
parent_activity?: FeedsNotificationParentActivity;
|
|
7703
|
+
}
|
|
7704
|
+
export interface FeedsNotificationTrigger {
|
|
7705
|
+
text: string;
|
|
7706
|
+
type: string;
|
|
7707
|
+
comment?: FeedsNotificationComment;
|
|
7708
|
+
custom?: Record<string, any>;
|
|
7709
|
+
}
|
|
6818
7710
|
export interface FeedsPreferences {
|
|
6819
7711
|
/**
|
|
6820
7712
|
* Push notification preference for comments on user's activities. One of: all, none
|
|
@@ -6859,52 +7751,25 @@ export interface FeedsPreferencesResponse {
|
|
|
6859
7751
|
reaction?: string;
|
|
6860
7752
|
custom_activity_types?: Record<string, string>;
|
|
6861
7753
|
}
|
|
6862
|
-
export interface FeedsReactionGroup {
|
|
6863
|
-
count: number;
|
|
6864
|
-
first_reaction_at: Date;
|
|
6865
|
-
last_reaction_at: Date;
|
|
6866
|
-
}
|
|
6867
7754
|
export interface FeedsReactionGroupResponse {
|
|
6868
|
-
/**
|
|
6869
|
-
* Number of reactions in this group
|
|
6870
|
-
*/
|
|
6871
7755
|
count: number;
|
|
6872
|
-
/**
|
|
6873
|
-
* Time of the first reaction
|
|
6874
|
-
*/
|
|
6875
7756
|
first_reaction_at: Date;
|
|
6876
|
-
/**
|
|
6877
|
-
* Time of the most recent reaction
|
|
6878
|
-
*/
|
|
6879
7757
|
last_reaction_at: Date;
|
|
6880
7758
|
}
|
|
6881
7759
|
export interface FeedsReactionResponse {
|
|
6882
|
-
/**
|
|
6883
|
-
* ID of the activity that was reacted to
|
|
6884
|
-
*/
|
|
6885
7760
|
activity_id: string;
|
|
6886
|
-
/**
|
|
6887
|
-
* When the reaction was created
|
|
6888
|
-
*/
|
|
6889
7761
|
created_at: Date;
|
|
6890
|
-
/**
|
|
6891
|
-
* Type of reaction
|
|
6892
|
-
*/
|
|
6893
7762
|
type: string;
|
|
6894
|
-
/**
|
|
6895
|
-
* When the reaction was last updated
|
|
6896
|
-
*/
|
|
6897
7763
|
updated_at: Date;
|
|
6898
7764
|
user: UserResponse;
|
|
6899
|
-
/**
|
|
6900
|
-
* ID of the comment that was reacted to
|
|
6901
|
-
*/
|
|
6902
7765
|
comment_id?: string;
|
|
6903
|
-
/**
|
|
6904
|
-
* Custom data for the reaction
|
|
6905
|
-
*/
|
|
6906
7766
|
custom?: Record<string, any>;
|
|
6907
7767
|
}
|
|
7768
|
+
export interface FeedsShareResponse {
|
|
7769
|
+
activity_id: string;
|
|
7770
|
+
created_at: Date;
|
|
7771
|
+
user: UserResponse;
|
|
7772
|
+
}
|
|
6908
7773
|
export interface FeedsV3ActivityResponse {
|
|
6909
7774
|
bookmark_count: number;
|
|
6910
7775
|
comment_count: number;
|
|
@@ -6925,25 +7790,40 @@ export interface FeedsV3ActivityResponse {
|
|
|
6925
7790
|
feeds: string[];
|
|
6926
7791
|
filter_tags: string[];
|
|
6927
7792
|
interest_tags: string[];
|
|
6928
|
-
latest_reactions:
|
|
7793
|
+
latest_reactions: FeedsReactionResponse[];
|
|
6929
7794
|
mentioned_users: UserResponse[];
|
|
6930
|
-
own_bookmarks:
|
|
6931
|
-
own_reactions:
|
|
6932
|
-
collections: Record<string,
|
|
7795
|
+
own_bookmarks: FeedsBookmarkResponse[];
|
|
7796
|
+
own_reactions: FeedsReactionResponse[];
|
|
7797
|
+
collections: Record<string, FeedsEnrichedCollectionResponse>;
|
|
6933
7798
|
custom: Record<string, any>;
|
|
6934
|
-
reaction_groups: Record<string,
|
|
7799
|
+
reaction_groups: Record<string, FeedsReactionGroupResponse>;
|
|
6935
7800
|
search_data: Record<string, any>;
|
|
6936
7801
|
user: UserResponse;
|
|
6937
7802
|
deleted_at?: Date;
|
|
6938
7803
|
edited_at?: Date;
|
|
6939
7804
|
expires_at?: Date;
|
|
7805
|
+
friend_reaction_count?: number;
|
|
7806
|
+
is_read?: boolean;
|
|
7807
|
+
is_seen?: boolean;
|
|
7808
|
+
is_watched?: boolean;
|
|
6940
7809
|
moderation_action?: string;
|
|
7810
|
+
selector_source?: string;
|
|
6941
7811
|
text?: string;
|
|
6942
7812
|
visibility_tag?: string;
|
|
7813
|
+
friend_reactions?: FeedsReactionResponse[];
|
|
7814
|
+
latest_shares?: FeedsShareResponse[];
|
|
7815
|
+
current_feed?: FeedsFeedResponse;
|
|
7816
|
+
i18n?: Record<string, string>;
|
|
7817
|
+
location?: FeedsActivityLocation;
|
|
6943
7818
|
metrics?: Record<string, number>;
|
|
6944
7819
|
moderation?: ModerationV2Response;
|
|
7820
|
+
notification_context?: FeedsNotificationContext;
|
|
7821
|
+
parent?: FeedsV3ActivityResponse;
|
|
7822
|
+
poll?: PollResponseData;
|
|
7823
|
+
score_vars?: Record<string, any>;
|
|
6945
7824
|
}
|
|
6946
7825
|
export interface FeedsV3CommentResponse {
|
|
7826
|
+
bookmark_count: number;
|
|
6947
7827
|
confidence_score: number;
|
|
6948
7828
|
created_at: Date;
|
|
6949
7829
|
downvote_count: number;
|
|
@@ -6957,7 +7837,7 @@ export interface FeedsV3CommentResponse {
|
|
|
6957
7837
|
updated_at: Date;
|
|
6958
7838
|
upvote_count: number;
|
|
6959
7839
|
mentioned_users: UserResponse[];
|
|
6960
|
-
own_reactions:
|
|
7840
|
+
own_reactions: FeedsReactionResponse[];
|
|
6961
7841
|
user: UserResponse;
|
|
6962
7842
|
controversy_score?: number;
|
|
6963
7843
|
deleted_at?: Date;
|
|
@@ -6965,8 +7845,11 @@ export interface FeedsV3CommentResponse {
|
|
|
6965
7845
|
parent_id?: string;
|
|
6966
7846
|
text?: string;
|
|
6967
7847
|
attachments?: Attachment[];
|
|
7848
|
+
latest_reactions?: FeedsReactionResponse[];
|
|
6968
7849
|
custom?: Record<string, any>;
|
|
7850
|
+
i18n?: Record<string, string>;
|
|
6969
7851
|
moderation?: ModerationV2Response;
|
|
7852
|
+
reaction_groups?: Record<string, FeedsReactionGroupResponse>;
|
|
6970
7853
|
}
|
|
6971
7854
|
export interface Field {
|
|
6972
7855
|
short: boolean;
|
|
@@ -7002,9 +7885,26 @@ export interface FileUploadResponse {
|
|
|
7002
7885
|
thumb_url?: string;
|
|
7003
7886
|
}
|
|
7004
7887
|
export interface FilterConfigResponse {
|
|
7888
|
+
/**
|
|
7889
|
+
* LLM moderation labels available as filter values
|
|
7890
|
+
*/
|
|
7005
7891
|
llm_labels: string[];
|
|
7892
|
+
/**
|
|
7893
|
+
* AI image moderation labels available as filter values. Reflects the app's effective image taxonomy: custom Bodyguard taxonomy when enabled, otherwise the standard L1 label set.
|
|
7894
|
+
*/
|
|
7895
|
+
ai_image_labels?: string[];
|
|
7896
|
+
/**
|
|
7897
|
+
* AI text moderation labels available as filter values
|
|
7898
|
+
*/
|
|
7006
7899
|
ai_text_labels?: string[];
|
|
7900
|
+
/**
|
|
7901
|
+
* Moderation config keys present in the queue, available as filter values
|
|
7902
|
+
*/
|
|
7007
7903
|
config_keys?: string[];
|
|
7904
|
+
/**
|
|
7905
|
+
* The moderation_payload.custom keys the app has configured as review-queue filter chips (via moderation_dashboard_preferences.filterable_custom_keys). Discovery hint for the dashboard only — the filter accepts any custom key regardless of this list.
|
|
7906
|
+
*/
|
|
7907
|
+
filterable_custom_keys?: string[];
|
|
7008
7908
|
}
|
|
7009
7909
|
export interface FirebaseConfig {
|
|
7010
7910
|
apn_template?: string;
|
|
@@ -7025,6 +7925,10 @@ export interface FirebaseConfigFields {
|
|
|
7025
7925
|
export interface FlagCountRuleParameters {
|
|
7026
7926
|
threshold?: number;
|
|
7027
7927
|
}
|
|
7928
|
+
export interface FlagDetails {
|
|
7929
|
+
original_text: string;
|
|
7930
|
+
automod?: AutomodDetailsResponse;
|
|
7931
|
+
}
|
|
7028
7932
|
export interface FlagDetailsResponse {
|
|
7029
7933
|
original_text: string;
|
|
7030
7934
|
automod?: AutomodDetailsResponse;
|
|
@@ -7035,6 +7939,13 @@ export interface FlagFeedbackResponse {
|
|
|
7035
7939
|
message_id: string;
|
|
7036
7940
|
labels: LabelResponse[];
|
|
7037
7941
|
}
|
|
7942
|
+
export interface FlagItemResponse {
|
|
7943
|
+
duration: string;
|
|
7944
|
+
/**
|
|
7945
|
+
* Unique identifier of the created moderation item
|
|
7946
|
+
*/
|
|
7947
|
+
item_id: string;
|
|
7948
|
+
}
|
|
7038
7949
|
export interface FlagMessageDetailsResponse {
|
|
7039
7950
|
pin_changed?: boolean;
|
|
7040
7951
|
should_enrich?: boolean;
|
|
@@ -7067,11 +7978,20 @@ export interface FlagRequest {
|
|
|
7067
7978
|
user?: UserRequest;
|
|
7068
7979
|
}
|
|
7069
7980
|
export interface FlagResponse {
|
|
7070
|
-
|
|
7071
|
-
|
|
7072
|
-
|
|
7073
|
-
|
|
7074
|
-
|
|
7981
|
+
created_at: Date;
|
|
7982
|
+
created_by_automod: boolean;
|
|
7983
|
+
updated_at: Date;
|
|
7984
|
+
approved_at?: Date;
|
|
7985
|
+
reason?: string;
|
|
7986
|
+
rejected_at?: Date;
|
|
7987
|
+
reviewed_at?: Date;
|
|
7988
|
+
reviewed_by?: string;
|
|
7989
|
+
target_message_id?: string;
|
|
7990
|
+
custom?: Record<string, any>;
|
|
7991
|
+
details?: FlagDetails;
|
|
7992
|
+
target_message?: MessageResponse;
|
|
7993
|
+
target_user?: UserResponse;
|
|
7994
|
+
user?: UserResponse;
|
|
7075
7995
|
}
|
|
7076
7996
|
export interface FlagUpdatedEvent {
|
|
7077
7997
|
created_at: Date;
|
|
@@ -7085,6 +8005,32 @@ export interface FlagUpdatedEvent {
|
|
|
7085
8005
|
export interface FlagUserOptions {
|
|
7086
8006
|
reason?: string;
|
|
7087
8007
|
}
|
|
8008
|
+
export interface FloodConfig {
|
|
8009
|
+
identical?: FloodIdenticalConfig;
|
|
8010
|
+
similar?: FloodSimilarConfig;
|
|
8011
|
+
}
|
|
8012
|
+
export interface FloodIdenticalConfig {
|
|
8013
|
+
action?: string;
|
|
8014
|
+
enabled?: boolean;
|
|
8015
|
+
threshold?: number;
|
|
8016
|
+
time_window?: string;
|
|
8017
|
+
}
|
|
8018
|
+
export interface FloodIdenticalRuleParameters {
|
|
8019
|
+
threshold?: number;
|
|
8020
|
+
time_window?: string;
|
|
8021
|
+
}
|
|
8022
|
+
export interface FloodSimilarConfig {
|
|
8023
|
+
action?: string;
|
|
8024
|
+
enabled?: boolean;
|
|
8025
|
+
similarity_distance?: number;
|
|
8026
|
+
threshold?: number;
|
|
8027
|
+
time_window?: string;
|
|
8028
|
+
}
|
|
8029
|
+
export interface FloodSimilarRuleParameters {
|
|
8030
|
+
similarity_distance?: number;
|
|
8031
|
+
threshold?: number;
|
|
8032
|
+
time_window?: string;
|
|
8033
|
+
}
|
|
7088
8034
|
export interface FollowBatchRequest {
|
|
7089
8035
|
/**
|
|
7090
8036
|
* List of follow relationships to create
|
|
@@ -7163,7 +8109,7 @@ export interface FollowRequest {
|
|
|
7163
8109
|
*/
|
|
7164
8110
|
create_notification_activity?: boolean;
|
|
7165
8111
|
/**
|
|
7166
|
-
* If true, auto-creates users referenced by the source and target FIDs when they don't already exist. Server-side only. Defaults to false.
|
|
8112
|
+
* If true, auto-creates users referenced by the source and target FIDs when they don't already exist. Server-side only. Defaults to false. Use directly on single follow endpoints (Follow, GetOrCreateFollow). On batch endpoints (FollowBatch, GetOrCreateFollows), use the top-level create_users field; per-item follows[i].create_users is rejected.
|
|
7167
8113
|
*/
|
|
7168
8114
|
create_users?: boolean;
|
|
7169
8115
|
/**
|
|
@@ -7326,6 +8272,13 @@ export interface GeofenceSettingsRequest {
|
|
|
7326
8272
|
export interface GeofenceSettingsResponse {
|
|
7327
8273
|
names: string[];
|
|
7328
8274
|
}
|
|
8275
|
+
export interface GetActionConfigResponse {
|
|
8276
|
+
duration: string;
|
|
8277
|
+
/**
|
|
8278
|
+
* Moderation action configs grouped by entity type, sorted by order ascending
|
|
8279
|
+
*/
|
|
8280
|
+
action_config: Record<string, ModerationActionConfigResponse[]>;
|
|
8281
|
+
}
|
|
7329
8282
|
export interface GetActiveCallsStatusResponse {
|
|
7330
8283
|
duration: string;
|
|
7331
8284
|
/**
|
|
@@ -7540,22 +8493,6 @@ export interface GetEdgesResponse {
|
|
|
7540
8493
|
duration: string;
|
|
7541
8494
|
edges: EdgeResponse[];
|
|
7542
8495
|
}
|
|
7543
|
-
export interface GetExternalStorageAWSS3Response {
|
|
7544
|
-
bucket: string;
|
|
7545
|
-
region: string;
|
|
7546
|
-
role_arn: string;
|
|
7547
|
-
path_prefix?: string;
|
|
7548
|
-
}
|
|
7549
|
-
export interface GetExternalStorageResponse {
|
|
7550
|
-
created_at: Date;
|
|
7551
|
-
/**
|
|
7552
|
-
* Duration of the request in milliseconds
|
|
7553
|
-
*/
|
|
7554
|
-
duration: string;
|
|
7555
|
-
type: string;
|
|
7556
|
-
updated_at: Date;
|
|
7557
|
-
aws_s3?: GetExternalStorageAWSS3Response;
|
|
7558
|
-
}
|
|
7559
8496
|
export interface GetFeedGroupResponse {
|
|
7560
8497
|
duration: string;
|
|
7561
8498
|
feed_group: FeedGroupResponse;
|
|
@@ -7766,6 +8703,7 @@ export interface GetOrCreateFeedRequest {
|
|
|
7766
8703
|
id_around?: string;
|
|
7767
8704
|
limit?: number;
|
|
7768
8705
|
next?: string;
|
|
8706
|
+
overwrite_interest_weights?: boolean;
|
|
7769
8707
|
prev?: string;
|
|
7770
8708
|
user_id?: string;
|
|
7771
8709
|
view?: string;
|
|
@@ -7939,6 +8877,10 @@ export interface GetSegmentResponse {
|
|
|
7939
8877
|
duration: string;
|
|
7940
8878
|
segment?: SegmentResponse;
|
|
7941
8879
|
}
|
|
8880
|
+
export interface GetSetupSessionResponse {
|
|
8881
|
+
duration: string;
|
|
8882
|
+
setup_session?: SetupSession;
|
|
8883
|
+
}
|
|
7942
8884
|
export interface GetTaskResponse {
|
|
7943
8885
|
created_at: Date;
|
|
7944
8886
|
duration: string;
|
|
@@ -7968,30 +8910,75 @@ export interface GetUserGroupResponse {
|
|
|
7968
8910
|
export interface GetUserInterestsResponse {
|
|
7969
8911
|
duration: string;
|
|
7970
8912
|
/**
|
|
7971
|
-
* Top-N interest tags sorted by descending count, then alphabetically by tag
|
|
8913
|
+
* Top-N interest tags sorted by descending count, then alphabetically by tag
|
|
8914
|
+
*/
|
|
8915
|
+
interests: InterestTagResponse[];
|
|
8916
|
+
}
|
|
8917
|
+
export interface GoLiveRequest {
|
|
8918
|
+
recording_storage_name?: string;
|
|
8919
|
+
start_closed_caption?: boolean;
|
|
8920
|
+
start_composite_recording?: boolean;
|
|
8921
|
+
start_hls?: boolean;
|
|
8922
|
+
start_individual_recording?: boolean;
|
|
8923
|
+
start_raw_recording?: boolean;
|
|
8924
|
+
start_recording?: boolean;
|
|
8925
|
+
start_transcription?: boolean;
|
|
8926
|
+
transcription_storage_name?: string;
|
|
8927
|
+
}
|
|
8928
|
+
export interface GoLiveResponse {
|
|
8929
|
+
/**
|
|
8930
|
+
* Duration of the request in milliseconds
|
|
8931
|
+
*/
|
|
8932
|
+
duration: string;
|
|
8933
|
+
call: CallResponse;
|
|
8934
|
+
}
|
|
8935
|
+
export interface GoogleVisionConfig {
|
|
8936
|
+
enabled?: boolean;
|
|
8937
|
+
}
|
|
8938
|
+
export interface GroupedChannelsBucket {
|
|
8939
|
+
/**
|
|
8940
|
+
* Channels returned for this bucket
|
|
8941
|
+
*/
|
|
8942
|
+
channels: ChannelStateResponseFields[];
|
|
8943
|
+
/**
|
|
8944
|
+
* Cursor for the next page of this group
|
|
8945
|
+
*/
|
|
8946
|
+
next?: string;
|
|
8947
|
+
/**
|
|
8948
|
+
* Cursor for the previous page of this group
|
|
8949
|
+
*/
|
|
8950
|
+
prev?: string;
|
|
8951
|
+
/**
|
|
8952
|
+
* Unread channels currently classified into this bucket
|
|
8953
|
+
*/
|
|
8954
|
+
unread_channels?: number;
|
|
8955
|
+
}
|
|
8956
|
+
export interface GroupedChannelsGroupRequest {
|
|
8957
|
+
limit?: number;
|
|
8958
|
+
next?: string;
|
|
8959
|
+
prev?: string;
|
|
8960
|
+
}
|
|
8961
|
+
export interface GroupedQueryChannelsRequest {
|
|
8962
|
+
/**
|
|
8963
|
+
* Default max channels per group (default 10)
|
|
8964
|
+
*/
|
|
8965
|
+
limit?: number;
|
|
8966
|
+
user_id?: string;
|
|
8967
|
+
/**
|
|
8968
|
+
* Groups to return, keyed by group name. Each group can define limit, next, or prev. 'next' and 'prev' cursors are only allowed when the request contains exactly one group; multi-group pagination is rejected.
|
|
7972
8969
|
*/
|
|
7973
|
-
|
|
7974
|
-
|
|
7975
|
-
export interface GoLiveRequest {
|
|
7976
|
-
recording_storage_name?: string;
|
|
7977
|
-
start_closed_caption?: boolean;
|
|
7978
|
-
start_composite_recording?: boolean;
|
|
7979
|
-
start_hls?: boolean;
|
|
7980
|
-
start_individual_recording?: boolean;
|
|
7981
|
-
start_raw_recording?: boolean;
|
|
7982
|
-
start_recording?: boolean;
|
|
7983
|
-
start_transcription?: boolean;
|
|
7984
|
-
transcription_storage_name?: string;
|
|
8970
|
+
groups?: Record<string, GroupedChannelsGroupRequest>;
|
|
8971
|
+
user?: UserRequest;
|
|
7985
8972
|
}
|
|
7986
|
-
export interface
|
|
8973
|
+
export interface GroupedQueryChannelsResponse {
|
|
7987
8974
|
/**
|
|
7988
8975
|
* Duration of the request in milliseconds
|
|
7989
8976
|
*/
|
|
7990
8977
|
duration: string;
|
|
7991
|
-
|
|
7992
|
-
|
|
7993
|
-
|
|
7994
|
-
|
|
8978
|
+
/**
|
|
8979
|
+
* Predefined channel groups keyed by group name
|
|
8980
|
+
*/
|
|
8981
|
+
groups: Record<string, GroupedChannelsBucket>;
|
|
7995
8982
|
}
|
|
7996
8983
|
export interface GroupedStatsResponse {
|
|
7997
8984
|
name: string;
|
|
@@ -8055,6 +9042,16 @@ export interface HuaweiConfigFields {
|
|
|
8055
9042
|
id?: string;
|
|
8056
9043
|
secret?: string;
|
|
8057
9044
|
}
|
|
9045
|
+
export interface IPContentCountRuleParameters {
|
|
9046
|
+
threshold?: number;
|
|
9047
|
+
time_window?: string;
|
|
9048
|
+
}
|
|
9049
|
+
export interface IPFlagCountRuleParameters {
|
|
9050
|
+
severity?: string;
|
|
9051
|
+
threshold?: number;
|
|
9052
|
+
time_window?: string;
|
|
9053
|
+
harm_labels?: string[];
|
|
9054
|
+
}
|
|
8058
9055
|
export interface ImageContentParameters {
|
|
8059
9056
|
label_operator?: string;
|
|
8060
9057
|
min_confidence?: number;
|
|
@@ -8120,6 +9117,17 @@ export interface Images {
|
|
|
8120
9117
|
fixed_width_still: ImageData;
|
|
8121
9118
|
original: ImageData;
|
|
8122
9119
|
}
|
|
9120
|
+
export interface ImportBlockListRequest {
|
|
9121
|
+
items: string[];
|
|
9122
|
+
chunk_size?: number;
|
|
9123
|
+
}
|
|
9124
|
+
export interface ImportBlockListResponse {
|
|
9125
|
+
/**
|
|
9126
|
+
* Duration of the request in milliseconds
|
|
9127
|
+
*/
|
|
9128
|
+
duration: string;
|
|
9129
|
+
task_id: string;
|
|
9130
|
+
}
|
|
8123
9131
|
export interface ImportTask {
|
|
8124
9132
|
created_at: Date;
|
|
8125
9133
|
id: string;
|
|
@@ -8150,7 +9158,7 @@ export interface ImportV2TaskSettings {
|
|
|
8150
9158
|
mode?: string;
|
|
8151
9159
|
path?: string;
|
|
8152
9160
|
skip_references_check?: boolean;
|
|
8153
|
-
|
|
9161
|
+
use_import_time_as_op_time?: boolean;
|
|
8154
9162
|
s3?: ImportV2TaskSettingsS3;
|
|
8155
9163
|
}
|
|
8156
9164
|
export interface ImportV2TaskSettingsS3 {
|
|
@@ -8350,6 +9358,14 @@ export interface InsertActionLogRequest {
|
|
|
8350
9358
|
* Reason for the action
|
|
8351
9359
|
*/
|
|
8352
9360
|
reason?: string;
|
|
9361
|
+
/**
|
|
9362
|
+
* Type of reporter; 'api_integration' when the action was triggered by an API integration call with no authenticated user
|
|
9363
|
+
*/
|
|
9364
|
+
reporter_type?: string;
|
|
9365
|
+
/**
|
|
9366
|
+
* ID of the user who triggered the action; empty for automated actions
|
|
9367
|
+
*/
|
|
9368
|
+
reporter_user_id?: string;
|
|
8353
9369
|
/**
|
|
8354
9370
|
* Custom metadata for the action log
|
|
8355
9371
|
*/
|
|
@@ -8373,9 +9389,15 @@ export interface JoinCallAPIMetrics {
|
|
|
8373
9389
|
total: number;
|
|
8374
9390
|
latency?: ActiveCallsLatencyStats;
|
|
8375
9391
|
}
|
|
9392
|
+
export interface KeyframeOCRRuleParameters {
|
|
9393
|
+
threshold?: number;
|
|
9394
|
+
time_window?: string;
|
|
9395
|
+
harm_labels?: string[];
|
|
9396
|
+
}
|
|
8376
9397
|
export interface KeyframeRuleParameters {
|
|
8377
9398
|
min_confidence?: number;
|
|
8378
9399
|
threshold?: number;
|
|
9400
|
+
time_window?: string;
|
|
8379
9401
|
harm_labels?: string[];
|
|
8380
9402
|
}
|
|
8381
9403
|
export interface KickUserRequest {
|
|
@@ -8417,9 +9439,9 @@ export interface LLMConfig {
|
|
|
8417
9439
|
severity_descriptions?: Record<string, string>;
|
|
8418
9440
|
}
|
|
8419
9441
|
export interface LLMRule {
|
|
8420
|
-
description: string;
|
|
8421
9442
|
label: string;
|
|
8422
9443
|
action?: 'flag' | 'shadow' | 'remove' | 'bounce' | 'bounce_flag' | 'bounce_remove' | 'keep';
|
|
9444
|
+
description?: string;
|
|
8423
9445
|
severity_rules?: BodyguardSeverityRule[];
|
|
8424
9446
|
}
|
|
8425
9447
|
export interface LabelResponse {
|
|
@@ -8427,6 +9449,66 @@ export interface LabelResponse {
|
|
|
8427
9449
|
harm_labels?: string[];
|
|
8428
9450
|
phrase_list_ids?: number[];
|
|
8429
9451
|
}
|
|
9452
|
+
export interface LabelResultResponse {
|
|
9453
|
+
/**
|
|
9454
|
+
* Category
|
|
9455
|
+
*/
|
|
9456
|
+
category: string;
|
|
9457
|
+
/**
|
|
9458
|
+
* The moderated content
|
|
9459
|
+
*/
|
|
9460
|
+
content: string;
|
|
9461
|
+
content_type: string;
|
|
9462
|
+
/**
|
|
9463
|
+
* Timestamp
|
|
9464
|
+
*/
|
|
9465
|
+
created_at: Date;
|
|
9466
|
+
/**
|
|
9467
|
+
* High-level harm category
|
|
9468
|
+
*/
|
|
9469
|
+
harm_type: string;
|
|
9470
|
+
/**
|
|
9471
|
+
* Unique identifier
|
|
9472
|
+
*/
|
|
9473
|
+
id: string;
|
|
9474
|
+
/**
|
|
9475
|
+
* Detected language
|
|
9476
|
+
*/
|
|
9477
|
+
language: string;
|
|
9478
|
+
/**
|
|
9479
|
+
* Provider recommended action
|
|
9480
|
+
*/
|
|
9481
|
+
recommended_action: string;
|
|
9482
|
+
/**
|
|
9483
|
+
* Severity level
|
|
9484
|
+
*/
|
|
9485
|
+
severity: string;
|
|
9486
|
+
/**
|
|
9487
|
+
* Moderation labels
|
|
9488
|
+
*/
|
|
9489
|
+
labels: string[];
|
|
9490
|
+
/**
|
|
9491
|
+
* Customer-supplied identifier for the moderated content
|
|
9492
|
+
*/
|
|
9493
|
+
content_id?: string;
|
|
9494
|
+
/**
|
|
9495
|
+
* Who the content is directed at (USER, GROUP, EVERYONE, NONE, etc.)
|
|
9496
|
+
*/
|
|
9497
|
+
directed_at?: string;
|
|
9498
|
+
/**
|
|
9499
|
+
* The stored content with every non-whitespace character masked. Present only when recommended_action is not 'keep'. Derived at runtime and never stored.
|
|
9500
|
+
*/
|
|
9501
|
+
fully_masked_content?: string;
|
|
9502
|
+
/**
|
|
9503
|
+
* Content with blocklisted tokens masked (when a blocklist rule with action=mask rewrote the original)
|
|
9504
|
+
*/
|
|
9505
|
+
masked_content?: string;
|
|
9506
|
+
policy?: string;
|
|
9507
|
+
/**
|
|
9508
|
+
* Customer-supplied user identifier for the content author
|
|
9509
|
+
*/
|
|
9510
|
+
user_id?: string;
|
|
9511
|
+
}
|
|
8430
9512
|
export interface LabelThresholds {
|
|
8431
9513
|
/**
|
|
8432
9514
|
* Threshold for automatic message block
|
|
@@ -8437,6 +9519,75 @@ export interface LabelThresholds {
|
|
|
8437
9519
|
*/
|
|
8438
9520
|
flag?: number;
|
|
8439
9521
|
}
|
|
9522
|
+
export interface LabelsRequest {
|
|
9523
|
+
/**
|
|
9524
|
+
* Content to moderate
|
|
9525
|
+
*/
|
|
9526
|
+
content: string;
|
|
9527
|
+
/**
|
|
9528
|
+
* Optional category for filtering (max 128 chars)
|
|
9529
|
+
*/
|
|
9530
|
+
category?: string;
|
|
9531
|
+
/**
|
|
9532
|
+
* Customer-supplied identifier for the moderated content, for tracing
|
|
9533
|
+
*/
|
|
9534
|
+
content_id?: string;
|
|
9535
|
+
/**
|
|
9536
|
+
* Type of content: 'text' (default), 'message', or 'username'. Stored as-sent; only 'username' routes to the username moderation API.
|
|
9537
|
+
*/
|
|
9538
|
+
content_type?: 'text' | 'message' | 'username';
|
|
9539
|
+
/**
|
|
9540
|
+
* When true, run moderation and return labels without persisting the result. Useful for one-off checks (e.g. UI testers) that should not be recorded in the stored history.
|
|
9541
|
+
*/
|
|
9542
|
+
dry_run?: boolean;
|
|
9543
|
+
/**
|
|
9544
|
+
* Optional moderation policy key (max 128 chars). For username moderation, set this to a policy whose key starts with 'username:' (e.g. 'username:default') to opt into the low-latency fast-path: blocklists (customer + Stream-managed defaults) short-circuit the LLM, and the LLM fallback uses gpt-4.1-nano with a 24h Valkey verdict cache. Without a 'username:' prefix the request falls through to the standard Bodyguard Analyze v1 username path.
|
|
9545
|
+
*/
|
|
9546
|
+
policy?: string;
|
|
9547
|
+
/**
|
|
9548
|
+
* Optional customer-supplied user identifier for the content author (max 256 chars). Enables filtering stored results by user_id.
|
|
9549
|
+
*/
|
|
9550
|
+
user_id?: string;
|
|
9551
|
+
}
|
|
9552
|
+
export interface LabelsResponse {
|
|
9553
|
+
duration: string;
|
|
9554
|
+
/**
|
|
9555
|
+
* Provider recommended action
|
|
9556
|
+
*/
|
|
9557
|
+
recommended_action: string;
|
|
9558
|
+
/**
|
|
9559
|
+
* Customer-supplied identifier for the moderated content, for tracing
|
|
9560
|
+
*/
|
|
9561
|
+
content_id?: string;
|
|
9562
|
+
/**
|
|
9563
|
+
* Who the content is directed at (USER, GROUP, EVERYONE, NONE, etc.), when the provider exposes it
|
|
9564
|
+
*/
|
|
9565
|
+
directed_at?: string;
|
|
9566
|
+
/**
|
|
9567
|
+
* The original content with every non-whitespace character masked. Present only when recommended_action is not 'keep'. Derived at runtime and never stored.
|
|
9568
|
+
*/
|
|
9569
|
+
fully_masked_content?: string;
|
|
9570
|
+
/**
|
|
9571
|
+
* High-level harm category
|
|
9572
|
+
*/
|
|
9573
|
+
harm_type?: string;
|
|
9574
|
+
/**
|
|
9575
|
+
* Detected language
|
|
9576
|
+
*/
|
|
9577
|
+
language?: string;
|
|
9578
|
+
/**
|
|
9579
|
+
* Content with blocklisted tokens masked or substituted. Present only when a blocklist rewrote the original content.
|
|
9580
|
+
*/
|
|
9581
|
+
masked_content?: string;
|
|
9582
|
+
/**
|
|
9583
|
+
* Severity level
|
|
9584
|
+
*/
|
|
9585
|
+
severity?: string;
|
|
9586
|
+
/**
|
|
9587
|
+
* Moderation labels detected
|
|
9588
|
+
*/
|
|
9589
|
+
labels?: string[];
|
|
9590
|
+
}
|
|
8440
9591
|
export interface LayoutSettings {
|
|
8441
9592
|
external_app_url: string;
|
|
8442
9593
|
external_css_url: string;
|
|
@@ -8496,6 +9647,7 @@ export interface ListBlockListResponse {
|
|
|
8496
9647
|
*/
|
|
8497
9648
|
duration: string;
|
|
8498
9649
|
blocklists: BlockListResponse[];
|
|
9650
|
+
next_cursor?: string;
|
|
8499
9651
|
}
|
|
8500
9652
|
export interface ListCallTypeResponse {
|
|
8501
9653
|
duration: string;
|
|
@@ -8580,6 +9732,13 @@ export interface ListPushProvidersResponse {
|
|
|
8580
9732
|
duration: string;
|
|
8581
9733
|
push_providers: PushProviderResponse[];
|
|
8582
9734
|
}
|
|
9735
|
+
export interface ListQueuesResponse {
|
|
9736
|
+
/**
|
|
9737
|
+
* Duration of the request in milliseconds
|
|
9738
|
+
*/
|
|
9739
|
+
duration: string;
|
|
9740
|
+
queues: ModerationQueueResponse[];
|
|
9741
|
+
}
|
|
8583
9742
|
export interface ListRecordingsResponse {
|
|
8584
9743
|
duration: string;
|
|
8585
9744
|
recordings: CallRecording[];
|
|
@@ -8746,6 +9905,36 @@ export interface MarkUnreadRequest {
|
|
|
8746
9905
|
user_id?: string;
|
|
8747
9906
|
user?: UserRequest;
|
|
8748
9907
|
}
|
|
9908
|
+
export interface MatchedContent {
|
|
9909
|
+
/**
|
|
9910
|
+
* The `content_ids[label]` value supplied on the `/analyze` request that contributed this entry.
|
|
9911
|
+
*/
|
|
9912
|
+
id: string;
|
|
9913
|
+
/**
|
|
9914
|
+
* `content_published_at` from the contributing `/analyze` request, or server receive time when that field was omitted.
|
|
9915
|
+
*/
|
|
9916
|
+
published_at: Date;
|
|
9917
|
+
/**
|
|
9918
|
+
* Content type that contributed this entry: `image` or `text`.
|
|
9919
|
+
*/
|
|
9920
|
+
type: string;
|
|
9921
|
+
/**
|
|
9922
|
+
* Image-classification entries only. Aggregate (max) confidence score across the entry's classifications + sub-classifications. Absent on text and OCR entries.
|
|
9923
|
+
*/
|
|
9924
|
+
confidence?: number;
|
|
9925
|
+
/**
|
|
9926
|
+
* Text and OCR entries. Aggregate (max) Bodyguard severity level (`LOW` / `MEDIUM` / `HIGH` / `CRITICAL`). Absent on image-classification entries.
|
|
9927
|
+
*/
|
|
9928
|
+
severity?: string;
|
|
9929
|
+
/**
|
|
9930
|
+
* Image-classification entries (keyframe rule, Type=image) carry nested L1 → L2 classifications. Text entries (closed_caption rule, Type=text) carry flat label + severity. Resolved against the app's effective taxonomy on the image side.
|
|
9931
|
+
*/
|
|
9932
|
+
classifications?: Classification[];
|
|
9933
|
+
/**
|
|
9934
|
+
* OCR entries only (keyframe_ocr rule, Type=image). Bodyguard labels that fired against the keyframe's OCR-extracted text (e.g. `INSULT`, `HATE_SPEECH`). Distinct from `classifications` so consumers can route OCR matches separately from image-classification matches.
|
|
9935
|
+
*/
|
|
9936
|
+
ocr_classifications?: Classification[];
|
|
9937
|
+
}
|
|
8749
9938
|
export interface MaxStreakChangedEvent {
|
|
8750
9939
|
created_at: Date;
|
|
8751
9940
|
custom: Record<string, any>;
|
|
@@ -9194,6 +10383,7 @@ export interface MessageNewEvent {
|
|
|
9194
10383
|
thread_participants?: UserResponseCommonFields[];
|
|
9195
10384
|
channel?: ChannelResponse;
|
|
9196
10385
|
channel_custom?: Record<string, any>;
|
|
10386
|
+
grouped_unread_channels?: Record<string, number>;
|
|
9197
10387
|
user?: UserResponseCommonFields;
|
|
9198
10388
|
}
|
|
9199
10389
|
export interface MessageOptions {
|
|
@@ -9486,6 +10676,10 @@ export interface MessageResponse {
|
|
|
9486
10676
|
* List of user group IDs mentioned in the message. Group members who are also channel members will receive push notifications based on their push preferences. Max 10 groups
|
|
9487
10677
|
*/
|
|
9488
10678
|
mentioned_group_ids?: string[];
|
|
10679
|
+
/**
|
|
10680
|
+
* List of mentioned user group objects.
|
|
10681
|
+
*/
|
|
10682
|
+
mentioned_groups?: UserGroupResponse[];
|
|
9489
10683
|
/**
|
|
9490
10684
|
* List of roles mentioned in the message (e.g. admin, channel_moderator, custom roles). Members with matching roles will receive push notifications based on their push preferences. Max 10 roles
|
|
9491
10685
|
*/
|
|
@@ -9503,7 +10697,7 @@ export interface MessageResponse {
|
|
|
9503
10697
|
* Contains image moderation information
|
|
9504
10698
|
*/
|
|
9505
10699
|
image_labels?: Record<string, string[]>;
|
|
9506
|
-
member?:
|
|
10700
|
+
member?: ChannelMemberPartialResponse;
|
|
9507
10701
|
moderation?: ModerationV2Response;
|
|
9508
10702
|
pinned_by?: UserResponse;
|
|
9509
10703
|
poll?: PollResponseData;
|
|
@@ -9742,6 +10936,10 @@ export interface MessageWithChannelResponse {
|
|
|
9742
10936
|
* List of user group IDs mentioned in the message. Group members who are also channel members will receive push notifications based on their push preferences. Max 10 groups
|
|
9743
10937
|
*/
|
|
9744
10938
|
mentioned_group_ids?: string[];
|
|
10939
|
+
/**
|
|
10940
|
+
* List of mentioned user group objects.
|
|
10941
|
+
*/
|
|
10942
|
+
mentioned_groups?: UserGroupResponse[];
|
|
9745
10943
|
/**
|
|
9746
10944
|
* List of roles mentioned in the message (e.g. admin, channel_moderator, custom roles). Members with matching roles will receive push notifications based on their push preferences. Max 10 roles
|
|
9747
10945
|
*/
|
|
@@ -9759,7 +10957,7 @@ export interface MessageWithChannelResponse {
|
|
|
9759
10957
|
* Contains image moderation information
|
|
9760
10958
|
*/
|
|
9761
10959
|
image_labels?: Record<string, string[]>;
|
|
9762
|
-
member?:
|
|
10960
|
+
member?: ChannelMemberPartialResponse;
|
|
9763
10961
|
moderation?: ModerationV2Response;
|
|
9764
10962
|
pinned_by?: UserResponse;
|
|
9765
10963
|
poll?: PollResponseData;
|
|
@@ -9814,6 +11012,7 @@ export interface ModerationActionConfigResponse {
|
|
|
9814
11012
|
* Display order (lower numbers shown first)
|
|
9815
11013
|
*/
|
|
9816
11014
|
order: number;
|
|
11015
|
+
id?: string;
|
|
9817
11016
|
/**
|
|
9818
11017
|
* Queue type this action config belongs to
|
|
9819
11018
|
*/
|
|
@@ -9823,6 +11022,31 @@ export interface ModerationActionConfigResponse {
|
|
|
9823
11022
|
*/
|
|
9824
11023
|
custom?: Record<string, any>;
|
|
9825
11024
|
}
|
|
11025
|
+
export interface ModerationBanResponse {
|
|
11026
|
+
duration: string;
|
|
11027
|
+
}
|
|
11028
|
+
export interface ModerationCallResponse {
|
|
11029
|
+
backstage: boolean;
|
|
11030
|
+
captioning: boolean;
|
|
11031
|
+
cid: string;
|
|
11032
|
+
created_at: Date;
|
|
11033
|
+
current_session_id: string;
|
|
11034
|
+
id: string;
|
|
11035
|
+
recording: boolean;
|
|
11036
|
+
transcribing: boolean;
|
|
11037
|
+
translating: boolean;
|
|
11038
|
+
type: string;
|
|
11039
|
+
updated_at: Date;
|
|
11040
|
+
blocked_user_ids: string[];
|
|
11041
|
+
custom: Record<string, any>;
|
|
11042
|
+
channel_cid?: string;
|
|
11043
|
+
ended_at?: Date;
|
|
11044
|
+
join_ahead_time_seconds?: number;
|
|
11045
|
+
routing_number?: string;
|
|
11046
|
+
starts_at?: Date;
|
|
11047
|
+
team?: string;
|
|
11048
|
+
created_by?: UserResponse;
|
|
11049
|
+
}
|
|
9826
11050
|
export interface ModerationCheckCompletedEvent {
|
|
9827
11051
|
created_at: Date;
|
|
9828
11052
|
/**
|
|
@@ -9860,6 +11084,7 @@ export interface ModerationConfig {
|
|
|
9860
11084
|
automod_semantic_filters_config?: AutomodSemanticFiltersConfig;
|
|
9861
11085
|
automod_toxicity_config?: AutomodToxicityConfig;
|
|
9862
11086
|
block_list_config?: BlockListConfig;
|
|
11087
|
+
flood_config?: FloodConfig;
|
|
9863
11088
|
google_vision_config?: GoogleVisionConfig;
|
|
9864
11089
|
llm_config?: LLMConfig;
|
|
9865
11090
|
velocity_filter_config?: VelocityFilterConfig;
|
|
@@ -9883,13 +11108,17 @@ export interface ModerationCustomActionEvent {
|
|
|
9883
11108
|
}
|
|
9884
11109
|
export interface ModerationDashboardPreferences {
|
|
9885
11110
|
async_review_queue_upsert?: boolean;
|
|
11111
|
+
block_foreign_cdn_attachments?: boolean;
|
|
11112
|
+
custom_views_enabled?: boolean;
|
|
9886
11113
|
disable_audit_logs?: boolean;
|
|
9887
11114
|
disable_flagging_reviewed_entity?: boolean;
|
|
9888
11115
|
escalation_queue_enabled?: boolean;
|
|
9889
11116
|
flag_user_on_flagged_content?: boolean;
|
|
11117
|
+
include_attachment_payload?: boolean;
|
|
9890
11118
|
media_queue_blur_enabled?: boolean;
|
|
9891
11119
|
allowed_moderation_action_reasons?: string[];
|
|
9892
11120
|
escalation_reasons?: string[];
|
|
11121
|
+
filterable_custom_keys?: string[];
|
|
9893
11122
|
keyframe_classifications_map?: Record<string, Record<string, boolean>>;
|
|
9894
11123
|
overview_dashboard?: OverviewDashboardConfig;
|
|
9895
11124
|
}
|
|
@@ -9924,6 +11153,43 @@ export interface ModerationFlaggedEvent {
|
|
|
9924
11153
|
type: string;
|
|
9925
11154
|
received_at?: Date;
|
|
9926
11155
|
}
|
|
11156
|
+
export interface ModerationImageAnalysisCompleteEvent {
|
|
11157
|
+
created_at: Date;
|
|
11158
|
+
type: string;
|
|
11159
|
+
/**
|
|
11160
|
+
* The moderation policy key that was applied.
|
|
11161
|
+
*/
|
|
11162
|
+
config_key?: string;
|
|
11163
|
+
/**
|
|
11164
|
+
* Echo of the `entity_creator_id` on the /analyze request.
|
|
11165
|
+
*/
|
|
11166
|
+
entity_creator_id?: string;
|
|
11167
|
+
/**
|
|
11168
|
+
* Echo of the `entity_id` on the /analyze request.
|
|
11169
|
+
*/
|
|
11170
|
+
entity_id?: string;
|
|
11171
|
+
/**
|
|
11172
|
+
* Echo of the `entity_type` on the /analyze request.
|
|
11173
|
+
*/
|
|
11174
|
+
entity_type?: string;
|
|
11175
|
+
received_at?: Date;
|
|
11176
|
+
/**
|
|
11177
|
+
* Review queue row ID for deep-linking into the dashboard.
|
|
11178
|
+
*/
|
|
11179
|
+
review_queue_item_id?: string;
|
|
11180
|
+
/**
|
|
11181
|
+
* Echo of the `custom` metadata on the /analyze request.
|
|
11182
|
+
*/
|
|
11183
|
+
custom?: Record<string, any>;
|
|
11184
|
+
/**
|
|
11185
|
+
* Per-image verdicts, same shape as the /analyze HTTP response. Each entry carries `id` when the request supplied `content_ids`.
|
|
11186
|
+
*/
|
|
11187
|
+
images?: Record<string, AnalyzeImageField>;
|
|
11188
|
+
/**
|
|
11189
|
+
* Per-text-field verdicts, same shape as the /analyze HTTP response. Each entry carries `id` when the request supplied `content_ids`.
|
|
11190
|
+
*/
|
|
11191
|
+
texts?: Record<string, AnalyzeTextField>;
|
|
11192
|
+
}
|
|
9927
11193
|
export interface ModerationMarkReviewedEvent {
|
|
9928
11194
|
created_at: Date;
|
|
9929
11195
|
custom: Record<string, any>;
|
|
@@ -9933,12 +11199,21 @@ export interface ModerationMarkReviewedEvent {
|
|
|
9933
11199
|
message?: MessageResponse;
|
|
9934
11200
|
}
|
|
9935
11201
|
export interface ModerationPayload {
|
|
11202
|
+
audios?: string[];
|
|
11203
|
+
image_ordered_keys?: string[];
|
|
9936
11204
|
images?: string[];
|
|
11205
|
+
text_ordered_keys?: string[];
|
|
9937
11206
|
texts?: string[];
|
|
9938
11207
|
videos?: string[];
|
|
9939
11208
|
custom?: Record<string, any>;
|
|
11209
|
+
image_ids?: Record<string, string>;
|
|
11210
|
+
text_ids?: Record<string, string>;
|
|
9940
11211
|
}
|
|
9941
11212
|
export interface ModerationPayloadRequest {
|
|
11213
|
+
/**
|
|
11214
|
+
* Audio URLs to moderate
|
|
11215
|
+
*/
|
|
11216
|
+
audios?: string[];
|
|
9942
11217
|
/**
|
|
9943
11218
|
* Image URLs to moderate (max 30)
|
|
9944
11219
|
*/
|
|
@@ -9957,10 +11232,22 @@ export interface ModerationPayloadRequest {
|
|
|
9957
11232
|
custom?: Record<string, any>;
|
|
9958
11233
|
}
|
|
9959
11234
|
export interface ModerationPayloadResponse {
|
|
11235
|
+
/**
|
|
11236
|
+
* Audio URLs to moderate
|
|
11237
|
+
*/
|
|
11238
|
+
audios?: string[];
|
|
11239
|
+
/**
|
|
11240
|
+
* Caller-supplied keys for images, index-aligned with images[]
|
|
11241
|
+
*/
|
|
11242
|
+
image_ordered_keys?: string[];
|
|
9960
11243
|
/**
|
|
9961
11244
|
* Image URLs to moderate
|
|
9962
11245
|
*/
|
|
9963
11246
|
images?: string[];
|
|
11247
|
+
/**
|
|
11248
|
+
* Caller-supplied keys for texts (e.g. "title", "description"), index-aligned with texts[]
|
|
11249
|
+
*/
|
|
11250
|
+
text_ordered_keys?: string[];
|
|
9964
11251
|
/**
|
|
9965
11252
|
* Text content to moderate
|
|
9966
11253
|
*/
|
|
@@ -9973,6 +11260,26 @@ export interface ModerationPayloadResponse {
|
|
|
9973
11260
|
* Custom data for moderation
|
|
9974
11261
|
*/
|
|
9975
11262
|
custom?: Record<string, any>;
|
|
11263
|
+
/**
|
|
11264
|
+
* Caller-supplied content IDs per image key (from content_ids on /analyze)
|
|
11265
|
+
*/
|
|
11266
|
+
image_ids?: Record<string, string>;
|
|
11267
|
+
/**
|
|
11268
|
+
* Caller-supplied content IDs per text key (from content_ids on /analyze)
|
|
11269
|
+
*/
|
|
11270
|
+
text_ids?: Record<string, string>;
|
|
11271
|
+
}
|
|
11272
|
+
export interface ModerationQueueResponse {
|
|
11273
|
+
created_at: Date;
|
|
11274
|
+
created_by: string;
|
|
11275
|
+
description: string;
|
|
11276
|
+
id: string;
|
|
11277
|
+
item_count: number;
|
|
11278
|
+
name: string;
|
|
11279
|
+
type: string;
|
|
11280
|
+
updated_at: Date;
|
|
11281
|
+
sort: Array<Record<string, any>>;
|
|
11282
|
+
filters: Record<string, any>;
|
|
9976
11283
|
}
|
|
9977
11284
|
export interface ModerationResponse {
|
|
9978
11285
|
action: string;
|
|
@@ -10003,36 +11310,73 @@ export interface ModerationRuleV2Response {
|
|
|
10003
11310
|
groups?: RuleBuilderConditionGroup[];
|
|
10004
11311
|
action?: RuleBuilderAction;
|
|
10005
11312
|
}
|
|
10006
|
-
export interface ModerationRulesTriggeredEvent {
|
|
11313
|
+
export interface ModerationRulesTriggeredEvent {
|
|
11314
|
+
created_at: Date;
|
|
11315
|
+
/**
|
|
11316
|
+
* The ID of the entity that triggered the rule
|
|
11317
|
+
*/
|
|
11318
|
+
entity_id: string;
|
|
11319
|
+
/**
|
|
11320
|
+
* The type of the entity (call, user, message, etc.)
|
|
11321
|
+
*/
|
|
11322
|
+
entity_type: string;
|
|
11323
|
+
/**
|
|
11324
|
+
* The ID of the user who triggered the rule
|
|
11325
|
+
*/
|
|
11326
|
+
user_id: string;
|
|
11327
|
+
/**
|
|
11328
|
+
* Array of action types that were triggered
|
|
11329
|
+
*/
|
|
11330
|
+
triggered_actions: string[];
|
|
11331
|
+
custom: Record<string, any>;
|
|
11332
|
+
rule: ModerationRuleInfo;
|
|
11333
|
+
type: string;
|
|
11334
|
+
received_at?: Date;
|
|
11335
|
+
/**
|
|
11336
|
+
* The review queue item ID if applicable
|
|
11337
|
+
*/
|
|
11338
|
+
review_queue_item_id?: string;
|
|
11339
|
+
/**
|
|
11340
|
+
* The violation number for call rules (optional)
|
|
11341
|
+
*/
|
|
11342
|
+
violation_number?: number;
|
|
11343
|
+
/**
|
|
11344
|
+
* Ordered list of contents whose verdicts contributed to an aggregation rule's threshold. Populated only for aggregation rules when callers supplied `content_ids`.
|
|
11345
|
+
*/
|
|
11346
|
+
matched_contents?: MatchedContent[];
|
|
11347
|
+
}
|
|
11348
|
+
export interface ModerationTextAnalysisCompleteEvent {
|
|
10007
11349
|
created_at: Date;
|
|
11350
|
+
type: string;
|
|
10008
11351
|
/**
|
|
10009
|
-
* The
|
|
11352
|
+
* The moderation policy key that was applied.
|
|
10010
11353
|
*/
|
|
10011
|
-
|
|
11354
|
+
config_key?: string;
|
|
10012
11355
|
/**
|
|
10013
|
-
*
|
|
11356
|
+
* Echo of the `entity_creator_id` on the /analyze request.
|
|
10014
11357
|
*/
|
|
10015
|
-
|
|
11358
|
+
entity_creator_id?: string;
|
|
10016
11359
|
/**
|
|
10017
|
-
*
|
|
11360
|
+
* Echo of the `entity_id` on the /analyze request.
|
|
10018
11361
|
*/
|
|
10019
|
-
|
|
11362
|
+
entity_id?: string;
|
|
10020
11363
|
/**
|
|
10021
|
-
*
|
|
11364
|
+
* Echo of the `entity_type` on the /analyze request.
|
|
10022
11365
|
*/
|
|
10023
|
-
|
|
10024
|
-
custom: Record<string, any>;
|
|
10025
|
-
rule: ModerationRuleInfo;
|
|
10026
|
-
type: string;
|
|
11366
|
+
entity_type?: string;
|
|
10027
11367
|
received_at?: Date;
|
|
10028
11368
|
/**
|
|
10029
|
-
*
|
|
11369
|
+
* Review queue row ID for deep-linking into the dashboard.
|
|
10030
11370
|
*/
|
|
10031
11371
|
review_queue_item_id?: string;
|
|
10032
11372
|
/**
|
|
10033
|
-
*
|
|
11373
|
+
* Echo of the `custom` metadata on the /analyze request.
|
|
10034
11374
|
*/
|
|
10035
|
-
|
|
11375
|
+
custom?: Record<string, any>;
|
|
11376
|
+
/**
|
|
11377
|
+
* Per-text-field verdicts, same shape as the /analyze HTTP response. Each entry carries `id` when the request supplied `content_ids`.
|
|
11378
|
+
*/
|
|
11379
|
+
texts?: Record<string, AnalyzeTextField>;
|
|
10036
11380
|
}
|
|
10037
11381
|
export interface ModerationV2Response {
|
|
10038
11382
|
action: string;
|
|
@@ -10235,6 +11579,7 @@ export interface NotificationMarkUnreadEvent {
|
|
|
10235
11579
|
unread_threads?: number;
|
|
10236
11580
|
channel?: ChannelResponse;
|
|
10237
11581
|
channel_custom?: Record<string, any>;
|
|
11582
|
+
grouped_unread_channels?: Record<string, number>;
|
|
10238
11583
|
user?: UserResponseCommonFields;
|
|
10239
11584
|
}
|
|
10240
11585
|
export interface NotificationParentActivity {
|
|
@@ -10390,6 +11735,11 @@ export interface NotificationTrigger {
|
|
|
10390
11735
|
*/
|
|
10391
11736
|
custom?: Record<string, any>;
|
|
10392
11737
|
}
|
|
11738
|
+
export interface OCRContentParameters {
|
|
11739
|
+
label_operator?: string;
|
|
11740
|
+
severity?: string;
|
|
11741
|
+
harm_labels?: string[];
|
|
11742
|
+
}
|
|
10393
11743
|
export interface OCRRule {
|
|
10394
11744
|
action: 'flag' | 'shadow' | 'remove' | 'bounce' | 'bounce_flag' | 'bounce_remove';
|
|
10395
11745
|
label: string;
|
|
@@ -10645,6 +11995,10 @@ export interface Permission {
|
|
|
10645
11995
|
* Whether this permission applies to resource owner or not
|
|
10646
11996
|
*/
|
|
10647
11997
|
owner: boolean;
|
|
11998
|
+
/**
|
|
11999
|
+
* Resource type that defines ownership for this permission's action (e.g. 'Channel' for CreateMessage, 'Message' for UpdateMessage). Identical across all variants of an action; primarily meaningful for owner grants.
|
|
12000
|
+
*/
|
|
12001
|
+
owner_resource: string;
|
|
10648
12002
|
/**
|
|
10649
12003
|
* Whether this permission applies to teammates (multi-tenancy mode only)
|
|
10650
12004
|
*/
|
|
@@ -11125,6 +12479,15 @@ export interface QueryActivityReactionsResponse {
|
|
|
11125
12479
|
next?: string;
|
|
11126
12480
|
prev?: string;
|
|
11127
12481
|
}
|
|
12482
|
+
export interface QueryActivitySharesResponse {
|
|
12483
|
+
/**
|
|
12484
|
+
* Duration of the request in milliseconds
|
|
12485
|
+
*/
|
|
12486
|
+
duration: string;
|
|
12487
|
+
shares: ShareResponse[];
|
|
12488
|
+
next?: string;
|
|
12489
|
+
prev?: string;
|
|
12490
|
+
}
|
|
11128
12491
|
export interface QueryAggregateCallStatsRequest {
|
|
11129
12492
|
from?: string;
|
|
11130
12493
|
to?: string;
|
|
@@ -11234,6 +12597,7 @@ export interface QueryBookmarksRequest {
|
|
|
11234
12597
|
limit?: number;
|
|
11235
12598
|
next?: string;
|
|
11236
12599
|
prev?: string;
|
|
12600
|
+
user_id?: string;
|
|
11237
12601
|
/**
|
|
11238
12602
|
* Sorting parameters for the query
|
|
11239
12603
|
*/
|
|
@@ -11242,6 +12606,7 @@ export interface QueryBookmarksRequest {
|
|
|
11242
12606
|
* Filters to apply to the query
|
|
11243
12607
|
*/
|
|
11244
12608
|
filter?: Record<string, any>;
|
|
12609
|
+
user?: UserRequest;
|
|
11245
12610
|
}
|
|
11246
12611
|
export interface QueryBookmarksResponse {
|
|
11247
12612
|
duration: string;
|
|
@@ -11766,6 +13131,30 @@ export interface QueryFutureChannelBansResponse {
|
|
|
11766
13131
|
*/
|
|
11767
13132
|
bans: FutureChannelBanResponse[];
|
|
11768
13133
|
}
|
|
13134
|
+
export interface QueryLabelResultsRequest {
|
|
13135
|
+
limit?: number;
|
|
13136
|
+
next?: string;
|
|
13137
|
+
prev?: string;
|
|
13138
|
+
user_id?: string;
|
|
13139
|
+
/**
|
|
13140
|
+
* Sorting parameters
|
|
13141
|
+
*/
|
|
13142
|
+
sort?: SortParamRequest[];
|
|
13143
|
+
/**
|
|
13144
|
+
* Filter conditions
|
|
13145
|
+
*/
|
|
13146
|
+
filter?: Record<string, any>;
|
|
13147
|
+
user?: UserRequest;
|
|
13148
|
+
}
|
|
13149
|
+
export interface QueryLabelResultsResponse {
|
|
13150
|
+
duration: string;
|
|
13151
|
+
/**
|
|
13152
|
+
* List of moderation label results
|
|
13153
|
+
*/
|
|
13154
|
+
label_results: LabelResultResponse[];
|
|
13155
|
+
next?: string;
|
|
13156
|
+
prev?: string;
|
|
13157
|
+
}
|
|
11769
13158
|
export interface QueryMembersPayload {
|
|
11770
13159
|
type: string;
|
|
11771
13160
|
/**
|
|
@@ -11954,6 +13343,10 @@ export interface QueryModerationRulesResponse {
|
|
|
11954
13343
|
* Deprecated: use keyframe_label_classifications instead. Available L1 harm labels for keyframe rules
|
|
11955
13344
|
*/
|
|
11956
13345
|
keyframe_labels: string[];
|
|
13346
|
+
/**
|
|
13347
|
+
* Available harm labels for OCR-based rule conditions (keyframe_ocr_rule and ocr_content). Mirrors `closed_caption_labels` today but kept as a separate field so the pickers can diverge later.
|
|
13348
|
+
*/
|
|
13349
|
+
ocr_labels: string[];
|
|
11957
13350
|
/**
|
|
11958
13351
|
* List of moderation rules
|
|
11959
13352
|
*/
|
|
@@ -11966,6 +13359,10 @@ export interface QueryModerationRulesResponse {
|
|
|
11966
13359
|
* Default LLM label descriptions
|
|
11967
13360
|
*/
|
|
11968
13361
|
default_llm_labels: Record<string, string>;
|
|
13362
|
+
/**
|
|
13363
|
+
* Recommended LLM label descriptions for username-scoped policies (key starts with 'username:'). Used by /moderation/v2/labels fast-path.
|
|
13364
|
+
*/
|
|
13365
|
+
default_username_llm_labels: Record<string, string>;
|
|
11969
13366
|
/**
|
|
11970
13367
|
* L1 to L2 mapping of keyframe harm label classifications
|
|
11971
13368
|
*/
|
|
@@ -12092,6 +13489,7 @@ export interface QueryRemindersResponse {
|
|
|
12092
13489
|
prev?: string;
|
|
12093
13490
|
}
|
|
12094
13491
|
export interface QueryReviewQueueRequest {
|
|
13492
|
+
exclude_default_action_config?: boolean;
|
|
12095
13493
|
limit?: number;
|
|
12096
13494
|
/**
|
|
12097
13495
|
* Number of items to lock (1-25)
|
|
@@ -12117,7 +13515,7 @@ export interface QueryReviewQueueRequest {
|
|
|
12117
13515
|
*/
|
|
12118
13516
|
sort?: SortParamRequest[];
|
|
12119
13517
|
/**
|
|
12120
|
-
* Filter conditions for review queue items
|
|
13518
|
+
* Filter conditions for review queue items. Accepts built-in fields (e.g. status, channel_cid, severity, recommended_action) and customer-supplied moderation_payload.custom keys: any key that is not a built-in field is matched against the item's custom moderation data (e.g. {"location_id": "loc-42"}). Use filter_config.filterable_custom_keys to discover which custom keys the app exposes as chips.
|
|
12121
13519
|
*/
|
|
12122
13520
|
filter?: Record<string, any>;
|
|
12123
13521
|
user?: UserRequest;
|
|
@@ -12138,6 +13536,7 @@ export interface QueryReviewQueueResponse {
|
|
|
12138
13536
|
stats: Record<string, any>;
|
|
12139
13537
|
next?: string;
|
|
12140
13538
|
prev?: string;
|
|
13539
|
+
default_action_config?: Record<string, ModerationActionConfigResponse[]>;
|
|
12141
13540
|
filter_config?: FilterConfigResponse;
|
|
12142
13541
|
}
|
|
12143
13542
|
export interface QueryRevisionHistoryRequest {
|
|
@@ -12338,6 +13737,13 @@ export interface QueryUsersResponse {
|
|
|
12338
13737
|
*/
|
|
12339
13738
|
users: FullUserResponse[];
|
|
12340
13739
|
}
|
|
13740
|
+
export interface QueueResponse {
|
|
13741
|
+
/**
|
|
13742
|
+
* Duration of the request in milliseconds
|
|
13743
|
+
*/
|
|
13744
|
+
duration: string;
|
|
13745
|
+
queue?: ModerationQueueResponse;
|
|
13746
|
+
}
|
|
12341
13747
|
export interface RTMPBroadcastRequest {
|
|
12342
13748
|
/**
|
|
12343
13749
|
* Name identifier for RTMP broadcast, must be unique in call
|
|
@@ -12715,7 +14121,7 @@ export interface ReadCollectionsResponse {
|
|
|
12715
14121
|
collections: CollectionResponse[];
|
|
12716
14122
|
}
|
|
12717
14123
|
export interface ReadReceiptsResponse {
|
|
12718
|
-
enabled
|
|
14124
|
+
enabled: boolean;
|
|
12719
14125
|
}
|
|
12720
14126
|
export interface ReadStateResponse {
|
|
12721
14127
|
last_read: Date;
|
|
@@ -12940,6 +14346,18 @@ export interface ReportByHistogramBucket {
|
|
|
12940
14346
|
lower_bound?: Bound;
|
|
12941
14347
|
upper_bound?: Bound;
|
|
12942
14348
|
}
|
|
14349
|
+
export interface ReportClientEventRequest {
|
|
14350
|
+
/**
|
|
14351
|
+
* Client-side events to report (1-100 per request)
|
|
14352
|
+
*/
|
|
14353
|
+
events: ClientEvent[];
|
|
14354
|
+
}
|
|
14355
|
+
export interface ReportClientEventResponse {
|
|
14356
|
+
/**
|
|
14357
|
+
* Duration of the request in milliseconds
|
|
14358
|
+
*/
|
|
14359
|
+
duration: string;
|
|
14360
|
+
}
|
|
12943
14361
|
export interface ReportResponse {
|
|
12944
14362
|
call: CallReportResponse;
|
|
12945
14363
|
participants: ParticipantReportResponse;
|
|
@@ -13168,14 +14586,14 @@ export interface ReviewQueueItemResponse {
|
|
|
13168
14586
|
activity?: EnrichedActivity;
|
|
13169
14587
|
appeal?: AppealItemResponse;
|
|
13170
14588
|
assigned_to?: UserResponse;
|
|
13171
|
-
call?:
|
|
14589
|
+
call?: ModerationCallResponse;
|
|
13172
14590
|
entity_creator?: EntityCreatorResponse;
|
|
13173
14591
|
escalation_metadata?: EscalationMetadata;
|
|
13174
14592
|
feeds_v2_activity?: EnrichedActivity;
|
|
13175
14593
|
feeds_v2_reaction?: Reaction;
|
|
13176
14594
|
feeds_v3_activity?: FeedsV3ActivityResponse;
|
|
13177
14595
|
feeds_v3_comment?: FeedsV3CommentResponse;
|
|
13178
|
-
message?:
|
|
14596
|
+
message?: ChatMessageResponse;
|
|
13179
14597
|
moderation_payload?: ModerationPayloadResponse;
|
|
13180
14598
|
reaction?: Reaction;
|
|
13181
14599
|
}
|
|
@@ -13265,6 +14683,7 @@ export interface Role {
|
|
|
13265
14683
|
scopes: string[];
|
|
13266
14684
|
}
|
|
13267
14685
|
export interface RuleBuilderAction {
|
|
14686
|
+
reason?: string;
|
|
13268
14687
|
skip_inbox?: boolean;
|
|
13269
14688
|
type?: 'ban_user' | 'flag_user' | 'flag_content' | 'block_content' | 'shadow_content' | 'bounce_flag_content' | 'bounce_content' | 'bounce_remove_content' | 'mute_video' | 'mute_audio' | 'blur' | 'call_blur' | 'end_call' | 'kick_user' | 'warning' | 'call_warning' | 'webhook_only';
|
|
13270
14689
|
ban_options?: BanOptions;
|
|
@@ -13277,12 +14696,21 @@ export interface RuleBuilderCondition {
|
|
|
13277
14696
|
call_custom_property_params?: CallCustomPropertyParameters;
|
|
13278
14697
|
call_type_rule_params?: CallTypeRuleParameters;
|
|
13279
14698
|
call_violation_count_params?: CallViolationCountParameters;
|
|
14699
|
+
channel_message_count_rule_params?: ChannelMessageCountRuleParameters;
|
|
13280
14700
|
closed_caption_rule_params?: ClosedCaptionRuleParameters;
|
|
13281
14701
|
content_count_rule_params?: ContentCountRuleParameters;
|
|
14702
|
+
content_custom_property_count_params?: ContentCustomPropertyCountParameters;
|
|
14703
|
+
content_custom_property_params?: ContentCustomPropertyParameters;
|
|
13282
14704
|
content_flag_count_rule_params?: FlagCountRuleParameters;
|
|
14705
|
+
flood_identical_params?: FloodIdenticalRuleParameters;
|
|
14706
|
+
flood_similar_params?: FloodSimilarRuleParameters;
|
|
13283
14707
|
image_content_params?: ImageContentParameters;
|
|
13284
14708
|
image_rule_params?: ImageRuleParameters;
|
|
14709
|
+
ip_content_count_rule_params?: IPContentCountRuleParameters;
|
|
14710
|
+
ip_flag_count_rule_params?: IPFlagCountRuleParameters;
|
|
14711
|
+
keyframe_ocr_rule_params?: KeyframeOCRRuleParameters;
|
|
13285
14712
|
keyframe_rule_params?: KeyframeRuleParameters;
|
|
14713
|
+
ocr_content_params?: OCRContentParameters;
|
|
13286
14714
|
text_content_params?: TextContentParameters;
|
|
13287
14715
|
text_rule_params?: TextRuleParameters;
|
|
13288
14716
|
user_created_within_params?: UserCreatedWithinParameters;
|
|
@@ -13751,13 +15179,14 @@ export interface SearchResultMessage {
|
|
|
13751
15179
|
quoted_message_id?: string;
|
|
13752
15180
|
show_in_channel?: boolean;
|
|
13753
15181
|
mentioned_group_ids?: string[];
|
|
15182
|
+
mentioned_groups?: UserGroupResponse[];
|
|
13754
15183
|
mentioned_roles?: string[];
|
|
13755
15184
|
thread_participants?: UserResponse[];
|
|
13756
15185
|
channel?: ChannelResponse;
|
|
13757
15186
|
draft?: DraftResponse;
|
|
13758
15187
|
i18n?: Record<string, string>;
|
|
13759
15188
|
image_labels?: Record<string, string[]>;
|
|
13760
|
-
member?:
|
|
15189
|
+
member?: ChannelMemberPartialResponse;
|
|
13761
15190
|
moderation?: ModerationV2Response;
|
|
13762
15191
|
pinned_by?: UserResponse;
|
|
13763
15192
|
poll?: PollResponseData;
|
|
@@ -13766,6 +15195,13 @@ export interface SearchResultMessage {
|
|
|
13766
15195
|
reminder?: ReminderResponseData;
|
|
13767
15196
|
shared_location?: SharedLocationResponseData;
|
|
13768
15197
|
}
|
|
15198
|
+
export interface SearchRolesResponse {
|
|
15199
|
+
duration: string;
|
|
15200
|
+
/**
|
|
15201
|
+
* Matching roles, sorted ascending by name
|
|
15202
|
+
*/
|
|
15203
|
+
roles: Role[];
|
|
15204
|
+
}
|
|
13769
15205
|
export interface SearchUserGroupsResponse {
|
|
13770
15206
|
duration: string;
|
|
13771
15207
|
/**
|
|
@@ -13926,12 +15362,31 @@ export interface SetRetentionPolicyResponse {
|
|
|
13926
15362
|
duration: string;
|
|
13927
15363
|
policy: RetentionPolicy;
|
|
13928
15364
|
}
|
|
15365
|
+
export interface SetupSession {
|
|
15366
|
+
created_at: Date;
|
|
15367
|
+
current_step: string;
|
|
15368
|
+
status: string;
|
|
15369
|
+
updated_at: Date;
|
|
15370
|
+
setup_data: Record<string, any>;
|
|
15371
|
+
completed_at?: Date;
|
|
15372
|
+
}
|
|
13929
15373
|
export interface ShadowBlockActionRequestPayload {
|
|
13930
15374
|
/**
|
|
13931
15375
|
* Reason for shadow blocking
|
|
13932
15376
|
*/
|
|
13933
15377
|
reason?: string;
|
|
13934
15378
|
}
|
|
15379
|
+
export interface ShareResponse {
|
|
15380
|
+
/**
|
|
15381
|
+
* ID of the sharing (child) activity
|
|
15382
|
+
*/
|
|
15383
|
+
activity_id: string;
|
|
15384
|
+
/**
|
|
15385
|
+
* When the share occurred
|
|
15386
|
+
*/
|
|
15387
|
+
created_at: Date;
|
|
15388
|
+
user: UserResponse;
|
|
15389
|
+
}
|
|
13935
15390
|
export interface SharedLocation {
|
|
13936
15391
|
latitude: number;
|
|
13937
15392
|
longitude: number;
|
|
@@ -14296,9 +15751,54 @@ export interface SubmitActionRequest {
|
|
|
14296
15751
|
}
|
|
14297
15752
|
export interface SubmitActionResponse {
|
|
14298
15753
|
duration: string;
|
|
15754
|
+
/**
|
|
15755
|
+
* Present when the appeal was accepted but the entity could not be restored automatically. The moderator should restore it manually.
|
|
15756
|
+
*/
|
|
15757
|
+
auto_restore_warning?: string;
|
|
14299
15758
|
appeal_item?: AppealItemResponse;
|
|
14300
15759
|
item?: ReviewQueueItemResponse;
|
|
14301
15760
|
}
|
|
15761
|
+
export interface SubmitModerationFeedbackRequest {
|
|
15762
|
+
/**
|
|
15763
|
+
* The moderated content the moderator is providing feedback on
|
|
15764
|
+
*/
|
|
15765
|
+
message: string;
|
|
15766
|
+
/**
|
|
15767
|
+
* Original publication time of the moderated content (RFC3339)
|
|
15768
|
+
*/
|
|
15769
|
+
published_at: string;
|
|
15770
|
+
/**
|
|
15771
|
+
* Provider-side reference identifying the moderated content
|
|
15772
|
+
*/
|
|
15773
|
+
reference: string;
|
|
15774
|
+
/**
|
|
15775
|
+
* Optional moderation channel UUID for context
|
|
15776
|
+
*/
|
|
15777
|
+
channel_id?: string;
|
|
15778
|
+
/**
|
|
15779
|
+
* Action originally produced by the moderation system
|
|
15780
|
+
*/
|
|
15781
|
+
current_recommended_action?: string;
|
|
15782
|
+
/**
|
|
15783
|
+
* Optional free-form note explaining why the classification was wrong
|
|
15784
|
+
*/
|
|
15785
|
+
description?: string;
|
|
15786
|
+
/**
|
|
15787
|
+
* Optional moderator-supplied action
|
|
15788
|
+
*/
|
|
15789
|
+
expected_recommended_action?: string;
|
|
15790
|
+
/**
|
|
15791
|
+
* Classifications originally produced by the moderation system
|
|
15792
|
+
*/
|
|
15793
|
+
current_labels?: string[];
|
|
15794
|
+
/**
|
|
15795
|
+
* Optional moderator-supplied classifications (up to 16 entries)
|
|
15796
|
+
*/
|
|
15797
|
+
expected_labels?: string[];
|
|
15798
|
+
}
|
|
15799
|
+
export interface SubmitModerationFeedbackResponse {
|
|
15800
|
+
duration: string;
|
|
15801
|
+
}
|
|
14302
15802
|
export interface SubscriberAllMetrics {
|
|
14303
15803
|
audio?: SubscriberAudioMetrics;
|
|
14304
15804
|
rtt_ms?: ActiveCallsLatencyStats;
|
|
@@ -14323,9 +15823,9 @@ export interface SubscribersMetrics {
|
|
|
14323
15823
|
all?: SubscriberAllMetrics;
|
|
14324
15824
|
}
|
|
14325
15825
|
export interface TargetResolution {
|
|
14326
|
-
bitrate: number;
|
|
14327
15826
|
height: number;
|
|
14328
15827
|
width: number;
|
|
15828
|
+
bitrate?: number;
|
|
14329
15829
|
}
|
|
14330
15830
|
export interface TeamUsageStats {
|
|
14331
15831
|
/**
|
|
@@ -14353,6 +15853,8 @@ export interface TextContentParameters {
|
|
|
14353
15853
|
contains_url?: boolean;
|
|
14354
15854
|
label_operator?: string;
|
|
14355
15855
|
severity?: string;
|
|
15856
|
+
text_length?: number;
|
|
15857
|
+
text_length_operator?: string;
|
|
14356
15858
|
blocklist_match?: string[];
|
|
14357
15859
|
harm_labels?: string[];
|
|
14358
15860
|
llm_harm_labels?: Record<string, string>;
|
|
@@ -14551,6 +16053,7 @@ export interface ThreadedCommentResponse {
|
|
|
14551
16053
|
*/
|
|
14552
16054
|
replies?: ThreadedCommentResponse[];
|
|
14553
16055
|
custom?: Record<string, any>;
|
|
16056
|
+
i18n?: Record<string, string>;
|
|
14554
16057
|
meta?: RepliesMeta;
|
|
14555
16058
|
moderation?: ModerationV2Response;
|
|
14556
16059
|
reaction_groups?: Record<string, FeedsReactionGroupResponse>;
|
|
@@ -14652,6 +16155,32 @@ export interface TranscriptionSettingsResponse {
|
|
|
14652
16155
|
speech_segment_config?: SpeechSegmentConfig;
|
|
14653
16156
|
translation?: TranslationSettings;
|
|
14654
16157
|
}
|
|
16158
|
+
export interface TranslateActivityRequest {
|
|
16159
|
+
/**
|
|
16160
|
+
* ISO 639-1 language code to translate to
|
|
16161
|
+
*/
|
|
16162
|
+
language: string;
|
|
16163
|
+
}
|
|
16164
|
+
export interface TranslateActivityResponse {
|
|
16165
|
+
/**
|
|
16166
|
+
* Duration of the request in milliseconds
|
|
16167
|
+
*/
|
|
16168
|
+
duration: string;
|
|
16169
|
+
activity: ActivityResponse;
|
|
16170
|
+
}
|
|
16171
|
+
export interface TranslateCommentRequest {
|
|
16172
|
+
/**
|
|
16173
|
+
* ISO 639-1 language code to translate to
|
|
16174
|
+
*/
|
|
16175
|
+
language: string;
|
|
16176
|
+
}
|
|
16177
|
+
export interface TranslateCommentResponse {
|
|
16178
|
+
/**
|
|
16179
|
+
* Duration of the request in milliseconds
|
|
16180
|
+
*/
|
|
16181
|
+
duration: string;
|
|
16182
|
+
comment: CommentResponse;
|
|
16183
|
+
}
|
|
14655
16184
|
export interface TranslateMessageRequest {
|
|
14656
16185
|
/**
|
|
14657
16186
|
* Language to translate message to
|
|
@@ -14659,8 +16188,8 @@ export interface TranslateMessageRequest {
|
|
|
14659
16188
|
language: 'af' | 'sq' | 'am' | 'ar' | 'az' | 'bn' | 'bs' | 'bg' | 'zh' | 'zh-TW' | 'hr' | 'cs' | 'da' | 'fa-AF' | 'nl' | 'en' | 'et' | 'fi' | 'fr' | 'fr-CA' | 'ka' | 'de' | 'el' | 'ha' | 'he' | 'hi' | 'hu' | 'id' | 'it' | 'ja' | 'ko' | 'lv' | 'ms' | 'no' | 'fa' | 'ps' | 'pl' | 'pt' | 'ro' | 'ru' | 'sr' | 'sk' | 'sl' | 'so' | 'es' | 'es-MX' | 'sw' | 'sv' | 'tl' | 'ta' | 'th' | 'tr' | 'uk' | 'ur' | 'vi' | 'lt' | 'ht';
|
|
14660
16189
|
}
|
|
14661
16190
|
export interface TranslationSettings {
|
|
14662
|
-
enabled
|
|
14663
|
-
languages
|
|
16191
|
+
enabled?: boolean;
|
|
16192
|
+
languages?: string[];
|
|
14664
16193
|
}
|
|
14665
16194
|
export interface TriggeredRuleResponse {
|
|
14666
16195
|
/**
|
|
@@ -14675,6 +16204,10 @@ export interface TriggeredRuleResponse {
|
|
|
14675
16204
|
* Name of the moderation rule that triggered
|
|
14676
16205
|
*/
|
|
14677
16206
|
rule_name?: string;
|
|
16207
|
+
/**
|
|
16208
|
+
* Type of the moderation rule that triggered (content, user, or call)
|
|
16209
|
+
*/
|
|
16210
|
+
type?: string;
|
|
14678
16211
|
/**
|
|
14679
16212
|
* Violation count for action sequence rules (1-based)
|
|
14680
16213
|
*/
|
|
@@ -14711,7 +16244,7 @@ export interface TruncateChannelResponse {
|
|
|
14711
16244
|
message?: MessageResponse;
|
|
14712
16245
|
}
|
|
14713
16246
|
export interface TypingIndicatorsResponse {
|
|
14714
|
-
enabled
|
|
16247
|
+
enabled: boolean;
|
|
14715
16248
|
}
|
|
14716
16249
|
export interface UnbanActionRequestPayload {
|
|
14717
16250
|
/**
|
|
@@ -15086,14 +16619,17 @@ export interface UpdateActivityResponse {
|
|
|
15086
16619
|
export interface UpdateAppRequest {
|
|
15087
16620
|
async_url_enrich_enabled?: boolean;
|
|
15088
16621
|
auto_translation_enabled?: boolean;
|
|
15089
|
-
before_message_send_hook_url?: string;
|
|
15090
16622
|
before_message_send_hook_attempt_timeout_ms?: number;
|
|
16623
|
+
before_message_send_hook_url?: string;
|
|
15091
16624
|
cdn_expiration_seconds?: number;
|
|
15092
16625
|
channel_hide_members_only?: boolean;
|
|
16626
|
+
chat_primary_use_case?: 'messaging' | 'customer-support' | 'community' | 'marketplace' | 'gaming' | 'telehealth' | 'on-demand' | 'workforce-management' | 'dating' | 'education' | 'financial' | 'sports' | 'real-money-gaming';
|
|
15093
16627
|
custom_action_handler_url?: string;
|
|
15094
16628
|
disable_auth_checks?: boolean;
|
|
15095
16629
|
disable_permissions_checks?: boolean;
|
|
16630
|
+
enable_hook_payload_compression?: boolean;
|
|
15096
16631
|
enforce_unique_usernames?: 'no' | 'app' | 'team';
|
|
16632
|
+
feed_audit_logs_enabled?: boolean;
|
|
15097
16633
|
feeds_moderation_enabled?: boolean;
|
|
15098
16634
|
feeds_v2_region?: string;
|
|
15099
16635
|
guest_user_creation_disabled?: boolean;
|
|
@@ -15102,12 +16638,14 @@ export interface UpdateAppRequest {
|
|
|
15102
16638
|
migrate_permissions_to_v2?: boolean;
|
|
15103
16639
|
moderation_analytics_enabled?: boolean;
|
|
15104
16640
|
moderation_enabled?: boolean;
|
|
16641
|
+
moderation_onboarding_complete?: boolean;
|
|
15105
16642
|
moderation_s3_image_access_role_arn?: string;
|
|
15106
16643
|
moderation_webhook_url?: string;
|
|
15107
16644
|
multi_tenant_enabled?: boolean;
|
|
15108
16645
|
permission_version?: 'v1' | 'v2';
|
|
15109
16646
|
reminders_interval?: number;
|
|
15110
16647
|
reminders_max_members?: number;
|
|
16648
|
+
reminders_max_per_user?: number;
|
|
15111
16649
|
revoke_tokens_issued_before?: Date;
|
|
15112
16650
|
sns_key?: string;
|
|
15113
16651
|
sns_secret?: string;
|
|
@@ -15116,6 +16654,7 @@ export interface UpdateAppRequest {
|
|
|
15116
16654
|
sqs_secret?: string;
|
|
15117
16655
|
sqs_url?: string;
|
|
15118
16656
|
user_response_time_enabled?: boolean;
|
|
16657
|
+
video_primary_use_case?: 'video-calling' | 'voice-calling' | 'livestreaming' | 'audio-rooms' | 'ai-agents' | 'live-shopping' | 'other';
|
|
15119
16658
|
webhook_url?: string;
|
|
15120
16659
|
allowed_flag_reasons?: string[];
|
|
15121
16660
|
event_hooks?: EventHook[];
|
|
@@ -15137,8 +16676,10 @@ export interface UpdateAppRequest {
|
|
|
15137
16676
|
xiaomi_config?: XiaomiConfig;
|
|
15138
16677
|
}
|
|
15139
16678
|
export interface UpdateBlockListRequest {
|
|
16679
|
+
is_confusable_folding_enabled?: boolean;
|
|
15140
16680
|
is_leet_check_enabled?: boolean;
|
|
15141
16681
|
is_plural_check_enabled?: boolean;
|
|
16682
|
+
is_substring_matching_enabled?: boolean;
|
|
15142
16683
|
team?: string;
|
|
15143
16684
|
/**
|
|
15144
16685
|
* List of words to block
|
|
@@ -15254,6 +16795,22 @@ export interface UpdateCallTypeResponse {
|
|
|
15254
16795
|
*/
|
|
15255
16796
|
external_storage?: string;
|
|
15256
16797
|
}
|
|
16798
|
+
export interface UpdateCampaignRequest {
|
|
16799
|
+
sender_id: string;
|
|
16800
|
+
message_template: CampaignMessageTemplate;
|
|
16801
|
+
create_channels?: boolean;
|
|
16802
|
+
description?: string;
|
|
16803
|
+
id?: string;
|
|
16804
|
+
name?: string;
|
|
16805
|
+
sender_mode?: 'exclude' | 'include';
|
|
16806
|
+
sender_visibility?: 'hidden' | 'archived';
|
|
16807
|
+
show_channels?: boolean;
|
|
16808
|
+
skip_push?: boolean;
|
|
16809
|
+
skip_webhook?: boolean;
|
|
16810
|
+
segment_ids?: string[];
|
|
16811
|
+
user_ids?: string[];
|
|
16812
|
+
channel_template?: CampaignChannelTemplate;
|
|
16813
|
+
}
|
|
15257
16814
|
export interface UpdateChannelPartialRequest {
|
|
15258
16815
|
user_id?: string;
|
|
15259
16816
|
unset?: string[];
|
|
@@ -15727,7 +17284,7 @@ export interface UpdateFollowRequest {
|
|
|
15727
17284
|
*/
|
|
15728
17285
|
create_notification_activity?: boolean;
|
|
15729
17286
|
/**
|
|
15730
|
-
* If true, auto-creates users referenced by the source and target FIDs when they don't already exist. Server-side only. Defaults to false.
|
|
17287
|
+
* If true, auto-creates users referenced by the source and target FIDs when they don't already exist. Server-side only. Defaults to false. Use directly on single follow endpoints (Follow, GetOrCreateFollow). On batch endpoints (FollowBatch, GetOrCreateFollows), use the top-level create_users field; per-item follows[i].create_users is rejected.
|
|
15731
17288
|
*/
|
|
15732
17289
|
create_users?: boolean;
|
|
15733
17290
|
/**
|
|
@@ -15925,6 +17482,14 @@ export interface UpdatePollRequest {
|
|
|
15925
17482
|
custom?: Record<string, any>;
|
|
15926
17483
|
user?: UserRequest;
|
|
15927
17484
|
}
|
|
17485
|
+
export interface UpdateQueueRequest {
|
|
17486
|
+
description?: string;
|
|
17487
|
+
name?: string;
|
|
17488
|
+
user_id?: string;
|
|
17489
|
+
sort?: Array<Record<string, any>>;
|
|
17490
|
+
filters?: Record<string, any>;
|
|
17491
|
+
user?: UserRequest;
|
|
17492
|
+
}
|
|
15928
17493
|
export interface UpdateReminderRequest {
|
|
15929
17494
|
remind_at?: Date;
|
|
15930
17495
|
user_id?: string;
|
|
@@ -15986,6 +17551,27 @@ export interface UpdateSIPTrunkResponse {
|
|
|
15986
17551
|
duration: string;
|
|
15987
17552
|
sip_trunk?: SIPTrunkResponse;
|
|
15988
17553
|
}
|
|
17554
|
+
export interface UpdateSegmentRequest {
|
|
17555
|
+
/**
|
|
17556
|
+
* The description of the segment (max 256 characters)
|
|
17557
|
+
*/
|
|
17558
|
+
description?: string;
|
|
17559
|
+
/**
|
|
17560
|
+
* The name of the segment (max 128 characters)
|
|
17561
|
+
*/
|
|
17562
|
+
name?: string;
|
|
17563
|
+
/**
|
|
17564
|
+
* Filter to apply to the query
|
|
17565
|
+
*/
|
|
17566
|
+
filter?: Record<string, any>;
|
|
17567
|
+
}
|
|
17568
|
+
export interface UpdateSegmentResponse {
|
|
17569
|
+
/**
|
|
17570
|
+
* Duration of the request in milliseconds
|
|
17571
|
+
*/
|
|
17572
|
+
duration: string;
|
|
17573
|
+
segment: SegmentResponse;
|
|
17574
|
+
}
|
|
15989
17575
|
export interface UpdateThreadPartialRequest {
|
|
15990
17576
|
user_id?: string;
|
|
15991
17577
|
/**
|
|
@@ -16115,11 +17701,68 @@ export interface UploadChannelResponse {
|
|
|
16115
17701
|
*/
|
|
16116
17702
|
upload_sizes?: ImageSize[];
|
|
16117
17703
|
}
|
|
17704
|
+
export interface UpsertActionConfigItem {
|
|
17705
|
+
action: string;
|
|
17706
|
+
entity_type: string;
|
|
17707
|
+
order: number;
|
|
17708
|
+
description?: string;
|
|
17709
|
+
icon?: string;
|
|
17710
|
+
id?: string;
|
|
17711
|
+
queue_type?: string;
|
|
17712
|
+
custom?: Record<string, any>;
|
|
17713
|
+
}
|
|
17714
|
+
export interface UpsertActionConfigRequest {
|
|
17715
|
+
/**
|
|
17716
|
+
* The action to perform (e.g. ban, delete_message, custom)
|
|
17717
|
+
*/
|
|
17718
|
+
action: string;
|
|
17719
|
+
/**
|
|
17720
|
+
* Type of entity this action applies to (e.g. stream:chat:v1:message)
|
|
17721
|
+
*/
|
|
17722
|
+
entity_type: string;
|
|
17723
|
+
/**
|
|
17724
|
+
* Display order in the dashboard (0–100, lower numbers shown first)
|
|
17725
|
+
*/
|
|
17726
|
+
order: number;
|
|
17727
|
+
/**
|
|
17728
|
+
* Human-readable label for the dashboard button
|
|
17729
|
+
*/
|
|
17730
|
+
description?: string;
|
|
17731
|
+
/**
|
|
17732
|
+
* Icon identifier for the dashboard button
|
|
17733
|
+
*/
|
|
17734
|
+
icon?: string;
|
|
17735
|
+
/**
|
|
17736
|
+
* UUID of an existing action config to update; omit to create a new record
|
|
17737
|
+
*/
|
|
17738
|
+
id?: string;
|
|
17739
|
+
/**
|
|
17740
|
+
* Queue this config belongs to; null means the default queue
|
|
17741
|
+
*/
|
|
17742
|
+
queue_type?: string;
|
|
17743
|
+
/**
|
|
17744
|
+
* Optional user ID to associate with the audit log entry
|
|
17745
|
+
*/
|
|
17746
|
+
user_id?: string;
|
|
17747
|
+
/**
|
|
17748
|
+
* Action-specific parameters passed to the action handler
|
|
17749
|
+
*/
|
|
17750
|
+
custom?: Record<string, any>;
|
|
17751
|
+
user?: UserRequest;
|
|
17752
|
+
}
|
|
17753
|
+
export interface UpsertActionConfigResponse {
|
|
17754
|
+
duration: string;
|
|
17755
|
+
action_config?: ModerationActionConfigResponse;
|
|
17756
|
+
}
|
|
16118
17757
|
export interface UpsertActivitiesRequest {
|
|
16119
17758
|
/**
|
|
16120
17759
|
* List of activities to create or update
|
|
16121
17760
|
*/
|
|
16122
17761
|
activities: ActivityRequest[];
|
|
17762
|
+
/**
|
|
17763
|
+
* Server-side only. If true, auto-creates users referenced by activity user_id values that don't already exist. Default: false.
|
|
17764
|
+
*/
|
|
17765
|
+
create_users?: boolean;
|
|
16123
17766
|
/**
|
|
16124
17767
|
* If true, enriches the activities' current_feed with own_* fields (own_follows, own_followings, own_capabilities, own_membership). Defaults to false for performance.
|
|
16125
17768
|
*/
|
|
@@ -16170,6 +17813,7 @@ export interface UpsertConfigRequest {
|
|
|
16170
17813
|
* Optional user ID to associate with the audit log entry
|
|
16171
17814
|
*/
|
|
16172
17815
|
user_id?: string;
|
|
17816
|
+
ai_audio_config?: AIAudioConfigRequest;
|
|
16173
17817
|
ai_image_config?: AIImageConfig;
|
|
16174
17818
|
ai_text_config?: AITextConfig;
|
|
16175
17819
|
ai_video_config?: AIVideoConfig;
|
|
@@ -16179,6 +17823,7 @@ export interface UpsertConfigRequest {
|
|
|
16179
17823
|
aws_rekognition_config?: AIImageConfig;
|
|
16180
17824
|
block_list_config?: BlockListConfig;
|
|
16181
17825
|
bodyguard_config?: AITextConfig;
|
|
17826
|
+
flood_config?: FloodConfig;
|
|
16182
17827
|
google_vision_config?: GoogleVisionConfig;
|
|
16183
17828
|
llm_config?: LLMConfig;
|
|
16184
17829
|
rule_builder_config?: RuleBuilderConfig;
|
|
@@ -16190,29 +17835,13 @@ export interface UpsertConfigResponse {
|
|
|
16190
17835
|
duration: string;
|
|
16191
17836
|
config?: ConfigResponse;
|
|
16192
17837
|
}
|
|
16193
|
-
export interface UpsertExternalStorageAWSS3Request {
|
|
16194
|
-
bucket: string;
|
|
16195
|
-
region: string;
|
|
16196
|
-
role_arn: string;
|
|
16197
|
-
path_prefix?: string;
|
|
16198
|
-
}
|
|
16199
|
-
export interface UpsertExternalStorageRequest {
|
|
16200
|
-
type: 'aws_s3';
|
|
16201
|
-
aws_s3?: UpsertExternalStorageAWSS3Request;
|
|
16202
|
-
}
|
|
16203
|
-
export interface UpsertExternalStorageResponse {
|
|
16204
|
-
/**
|
|
16205
|
-
* Duration of the request in milliseconds
|
|
16206
|
-
*/
|
|
16207
|
-
duration: string;
|
|
16208
|
-
}
|
|
16209
17838
|
export interface UpsertModerationRuleRequest {
|
|
16210
17839
|
/**
|
|
16211
17840
|
* Unique rule name
|
|
16212
17841
|
*/
|
|
16213
17842
|
name: string;
|
|
16214
17843
|
/**
|
|
16215
|
-
* Type of rule: user, content, or
|
|
17844
|
+
* Type of rule: user, content, call, or flood
|
|
16216
17845
|
*/
|
|
16217
17846
|
rule_type: string;
|
|
16218
17847
|
/**
|
|
@@ -16302,7 +17931,7 @@ export interface UpsertPushPreferencesResponse {
|
|
|
16302
17931
|
/**
|
|
16303
17932
|
* The channel specific push notification preferences, only returned for channels you've edited.
|
|
16304
17933
|
*/
|
|
16305
|
-
user_channel_preferences: Record<string, Record<string, ChannelPushPreferencesResponse
|
|
17934
|
+
user_channel_preferences: Record<string, Record<string, ChannelPushPreferencesResponse>>;
|
|
16306
17935
|
/**
|
|
16307
17936
|
* The user preferences, always returned regardless if you edited it
|
|
16308
17937
|
*/
|
|
@@ -16347,6 +17976,24 @@ export interface UpsertPushTemplateResponse {
|
|
|
16347
17976
|
duration: string;
|
|
16348
17977
|
template?: PushTemplateResponse;
|
|
16349
17978
|
}
|
|
17979
|
+
export interface UpsertSetupSessionRequest {
|
|
17980
|
+
/**
|
|
17981
|
+
* The current step of the setup wizard. One of: welcome, input, configure, live
|
|
17982
|
+
*/
|
|
17983
|
+
current_step: 'welcome' | 'input' | 'configure' | 'live';
|
|
17984
|
+
/**
|
|
17985
|
+
* The status of the setup session. One of: in_progress, completed
|
|
17986
|
+
*/
|
|
17987
|
+
status: 'in_progress' | 'completed';
|
|
17988
|
+
/**
|
|
17989
|
+
* Per-step data keyed by step name (welcome, input, configure, live)
|
|
17990
|
+
*/
|
|
17991
|
+
setup_data?: Record<string, any>;
|
|
17992
|
+
}
|
|
17993
|
+
export interface UpsertSetupSessionResponse {
|
|
17994
|
+
duration: string;
|
|
17995
|
+
setup_session?: SetupSession;
|
|
17996
|
+
}
|
|
16350
17997
|
export interface User {
|
|
16351
17998
|
id: string;
|
|
16352
17999
|
data?: Record<string, any>;
|
|
@@ -16385,6 +18032,10 @@ export interface UserBannedEvent {
|
|
|
16385
18032
|
*/
|
|
16386
18033
|
reason?: string;
|
|
16387
18034
|
received_at?: Date;
|
|
18035
|
+
/**
|
|
18036
|
+
* ID of the review queue item (flagged message) that triggered the ban, if the ban was applied from the moderation review queue
|
|
18037
|
+
*/
|
|
18038
|
+
review_queue_item_id?: string;
|
|
16388
18039
|
/**
|
|
16389
18040
|
* Whether the user was shadow banned
|
|
16390
18041
|
*/
|
|
@@ -16936,12 +18587,6 @@ export interface UserUpdatedEvent {
|
|
|
16936
18587
|
type: string;
|
|
16937
18588
|
received_at?: Date;
|
|
16938
18589
|
}
|
|
16939
|
-
export interface ValidateExternalStorageResponse {
|
|
16940
|
-
/**
|
|
16941
|
-
* Duration of the request in milliseconds
|
|
16942
|
-
*/
|
|
16943
|
-
duration: string;
|
|
16944
|
-
}
|
|
16945
18590
|
export interface VelocityFilterConfig {
|
|
16946
18591
|
advanced_filters?: boolean;
|
|
16947
18592
|
async?: boolean;
|
|
@@ -17182,6 +18827,10 @@ export type WHEvent = ({
|
|
|
17182
18827
|
} & AsyncExportErrorEvent) | ({
|
|
17183
18828
|
type: 'export.moderation_logs.success';
|
|
17184
18829
|
} & AsyncExportModerationLogsEvent) | ({
|
|
18830
|
+
type: 'export.review_queue.error';
|
|
18831
|
+
} & AsyncExportErrorEvent) | ({
|
|
18832
|
+
type: 'export.review_queue.success';
|
|
18833
|
+
} & AsyncExportReviewQueueEvent) | ({
|
|
17185
18834
|
type: 'export.users.error';
|
|
17186
18835
|
} & AsyncExportErrorEvent) | ({
|
|
17187
18836
|
type: 'export.users.success';
|
|
@@ -17296,8 +18945,12 @@ export type WHEvent = ({
|
|
|
17296
18945
|
} & ModerationCustomActionEvent) | ({
|
|
17297
18946
|
type: 'moderation.flagged';
|
|
17298
18947
|
} & ModerationFlaggedEvent) | ({
|
|
18948
|
+
type: 'moderation.image_analysis.complete';
|
|
18949
|
+
} & ModerationImageAnalysisCompleteEvent) | ({
|
|
17299
18950
|
type: 'moderation.mark_reviewed';
|
|
17300
18951
|
} & ModerationMarkReviewedEvent) | ({
|
|
18952
|
+
type: 'moderation.text_analysis.complete';
|
|
18953
|
+
} & ModerationTextAnalysisCompleteEvent) | ({
|
|
17301
18954
|
type: 'moderation_check.completed';
|
|
17302
18955
|
} & ModerationCheckCompletedEvent) | ({
|
|
17303
18956
|
type: 'moderation_rule.triggered';
|
|
@@ -17393,6 +19046,12 @@ export interface WSEvent {
|
|
|
17393
19046
|
thread?: ThreadResponse;
|
|
17394
19047
|
user?: UserResponse;
|
|
17395
19048
|
}
|
|
19049
|
+
export interface WebhookFailoverConfig {
|
|
19050
|
+
gcs_bucket?: string;
|
|
19051
|
+
gcs_credentials?: string;
|
|
19052
|
+
gcs_path?: string;
|
|
19053
|
+
type?: string;
|
|
19054
|
+
}
|
|
17396
19055
|
export interface WrappedUnreadCountsResponse {
|
|
17397
19056
|
/**
|
|
17398
19057
|
* Duration of the request in milliseconds
|