@stream-io/node-sdk 0.8.8 → 0.8.9
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/CHANGELOG.md +8 -0
- package/dist/index.cjs.js +1171 -2372
- package/dist/index.cjs.js.map +1 -1
- package/dist/index.es.mjs +1171 -2372
- package/dist/index.es.mjs.map +1 -1
- package/dist/src/ApiClient.d.ts +1 -2
- package/dist/src/gen/feeds/FeedsApi.d.ts +7 -1
- package/dist/src/gen/models/index.d.ts +279 -8
- package/package.json +1 -1
- package/src/ApiClient.ts +1 -1
- package/src/gen/chat/ChatApi.ts +563 -659
- package/src/gen/common/CommonApi.ts +545 -517
- package/src/gen/feeds/FeedsApi.ts +799 -856
- package/src/gen/model-decoders/decoders.ts +29 -0
- package/src/gen/models/index.ts +293 -8
- package/src/gen/moderation/ModerationApi.ts +339 -408
- package/src/gen/video/VideoApi.ts +470 -566
|
@@ -3023,6 +3023,15 @@ decoders['GetFeedViewResponse'] = (input?: { [key: string]: any }) => {
|
|
|
3023
3023
|
return decode(typeMappings, input);
|
|
3024
3024
|
};
|
|
3025
3025
|
|
|
3026
|
+
decoders['GetFeedsRetentionPolicyResponse'] = (input?: {
|
|
3027
|
+
[key: string]: any;
|
|
3028
|
+
}) => {
|
|
3029
|
+
const typeMappings: TypeMapping = {
|
|
3030
|
+
policies: { type: 'RetentionPolicy', isSingle: false },
|
|
3031
|
+
};
|
|
3032
|
+
return decode(typeMappings, input);
|
|
3033
|
+
};
|
|
3034
|
+
|
|
3026
3035
|
decoders['GetFollowSuggestionsResponse'] = (input?: { [key: string]: any }) => {
|
|
3027
3036
|
const typeMappings: TypeMapping = {
|
|
3028
3037
|
suggestions: { type: 'FeedSuggestionResponse', isSingle: false },
|
|
@@ -3283,6 +3292,15 @@ decoders['IngressStoppedEvent'] = (input?: { [key: string]: any }) => {
|
|
|
3283
3292
|
return decode(typeMappings, input);
|
|
3284
3293
|
};
|
|
3285
3294
|
|
|
3295
|
+
decoders['IntentDetectedEvent'] = (input?: { [key: string]: any }) => {
|
|
3296
|
+
const typeMappings: TypeMapping = {
|
|
3297
|
+
created_at: { type: 'DatetimeType', isSingle: true },
|
|
3298
|
+
|
|
3299
|
+
received_at: { type: 'DatetimeType', isSingle: true },
|
|
3300
|
+
};
|
|
3301
|
+
return decode(typeMappings, input);
|
|
3302
|
+
};
|
|
3303
|
+
|
|
3286
3304
|
decoders['KickedUserEvent'] = (input?: { [key: string]: any }) => {
|
|
3287
3305
|
const typeMappings: TypeMapping = {
|
|
3288
3306
|
created_at: { type: 'DatetimeType', isSingle: true },
|
|
@@ -4879,6 +4897,8 @@ decoders['ReminderResponseData'] = (input?: { [key: string]: any }) => {
|
|
|
4879
4897
|
|
|
4880
4898
|
updated_at: { type: 'DatetimeType', isSingle: true },
|
|
4881
4899
|
|
|
4900
|
+
expires_at: { type: 'DatetimeType', isSingle: true },
|
|
4901
|
+
|
|
4882
4902
|
remind_at: { type: 'DatetimeType', isSingle: true },
|
|
4883
4903
|
|
|
4884
4904
|
channel: { type: 'ChannelResponse', isSingle: true },
|
|
@@ -5190,6 +5210,15 @@ decoders['SessionWarningResponse'] = (input?: { [key: string]: any }) => {
|
|
|
5190
5210
|
return decode(typeMappings, input);
|
|
5191
5211
|
};
|
|
5192
5212
|
|
|
5213
|
+
decoders['SetFeedsRetentionPolicyResponse'] = (input?: {
|
|
5214
|
+
[key: string]: any;
|
|
5215
|
+
}) => {
|
|
5216
|
+
const typeMappings: TypeMapping = {
|
|
5217
|
+
policy: { type: 'RetentionPolicy', isSingle: true },
|
|
5218
|
+
};
|
|
5219
|
+
return decode(typeMappings, input);
|
|
5220
|
+
};
|
|
5221
|
+
|
|
5193
5222
|
decoders['SetRetentionPolicyResponse'] = (input?: { [key: string]: any }) => {
|
|
5194
5223
|
const typeMappings: TypeMapping = {
|
|
5195
5224
|
policy: { type: 'RetentionPolicy', isSingle: true },
|
package/src/gen/models/index.ts
CHANGED
|
@@ -815,6 +815,10 @@ export interface ActivityResponse {
|
|
|
815
815
|
* Text content of the activity
|
|
816
816
|
*/
|
|
817
817
|
text?: string;
|
|
818
|
+
/**
|
|
819
|
+
* Number of top-level comments (comments directly on the activity, excluding replies). Only returned by GetActivity when include_top_level_comment_count=true; never set on feed reads or events. Same status/deletion rules as comment_count; not adjusted per viewer.
|
|
820
|
+
*/
|
|
821
|
+
top_level_comment_count?: number;
|
|
818
822
|
/**
|
|
819
823
|
* If visibility is 'tag', this is the tag name
|
|
820
824
|
*/
|
|
@@ -882,6 +886,10 @@ export interface ActivitySelectorConfig {
|
|
|
882
886
|
* Minimum popularity threshold. For the 'popular' selector, omit to use the default (5); values below 1 are rejected
|
|
883
887
|
*/
|
|
884
888
|
min_popularity?: number;
|
|
889
|
+
/**
|
|
890
|
+
* Maximum number of candidate activities this selector contributes to a ranked feed (1-1000). Omit to use the default ranking buffer. Only supported on the popular, proximity, interest and query selectors, and ignored on feeds without ranking
|
|
891
|
+
*/
|
|
892
|
+
ranking_candidate_limit?: number;
|
|
885
893
|
/**
|
|
886
894
|
* Sort parameters for activity selection
|
|
887
895
|
*/
|
|
@@ -918,6 +926,10 @@ export interface ActivitySelectorConfigResponse {
|
|
|
918
926
|
* Minimum popularity threshold. For the 'popular' selector, values below 1 are normalized to the default (5) at read time.
|
|
919
927
|
*/
|
|
920
928
|
min_popularity?: number;
|
|
929
|
+
/**
|
|
930
|
+
* Maximum number of candidate activities this selector contributes to a ranked feed
|
|
931
|
+
*/
|
|
932
|
+
ranking_candidate_limit?: number;
|
|
921
933
|
/**
|
|
922
934
|
* Sort parameters for activity selection
|
|
923
935
|
*/
|
|
@@ -2646,7 +2658,8 @@ export interface BulkActionAppealsRequest {
|
|
|
2646
2658
|
*/
|
|
2647
2659
|
unban?: UnbanActionRequestPayload;
|
|
2648
2660
|
/**
|
|
2649
|
-
*
|
|
2661
|
+
* @deprecated
|
|
2662
|
+
* Deprecated: Use restore instead, which now also reverses a block or shadow block. Configuration for unblock action.
|
|
2650
2663
|
*/
|
|
2651
2664
|
unblock?: UnblockActionRequestPayload;
|
|
2652
2665
|
/**
|
|
@@ -4234,6 +4247,9 @@ export interface ChannelConfig {
|
|
|
4234
4247
|
blocklist_behavior?: 'flag' | 'block' | 'shadow_block';
|
|
4235
4248
|
partition_size?: number;
|
|
4236
4249
|
partition_ttl?: string;
|
|
4250
|
+
/**
|
|
4251
|
+
* Sets the push notification level for a channel type
|
|
4252
|
+
*/
|
|
4237
4253
|
push_level?: 'all' | 'all_mentions' | 'mentions' | 'direct_mentions' | 'none';
|
|
4238
4254
|
allowed_flag_reasons?: Array<string>;
|
|
4239
4255
|
blocklists?: Array<BlockListOptions>;
|
|
@@ -4332,6 +4348,9 @@ export interface ChannelConfigWithInfo {
|
|
|
4332
4348
|
blocklist_behavior?: 'flag' | 'block' | 'shadow_block';
|
|
4333
4349
|
partition_size?: number;
|
|
4334
4350
|
partition_ttl?: string;
|
|
4351
|
+
/**
|
|
4352
|
+
* Sets the push notification level for a channel type
|
|
4353
|
+
*/
|
|
4335
4354
|
push_level?: 'all' | 'all_mentions' | 'mentions' | 'direct_mentions' | 'none';
|
|
4336
4355
|
allowed_flag_reasons?: Array<string>;
|
|
4337
4356
|
blocklists?: Array<BlockListOptions>;
|
|
@@ -5095,6 +5114,9 @@ export interface ChannelTypeConfig {
|
|
|
5095
5114
|
blocklist_behavior?: 'flag' | 'block' | 'shadow_block';
|
|
5096
5115
|
partition_size?: number;
|
|
5097
5116
|
partition_ttl?: string;
|
|
5117
|
+
/**
|
|
5118
|
+
* Sets the push notification level for a channel type
|
|
5119
|
+
*/
|
|
5098
5120
|
push_level?: 'all' | 'all_mentions' | 'mentions' | 'direct_mentions' | 'none';
|
|
5099
5121
|
allowed_flag_reasons?: Array<string>;
|
|
5100
5122
|
blocklists?: Array<BlockListOptions>;
|
|
@@ -5553,6 +5575,22 @@ export interface CheckResponse {
|
|
|
5553
5575
|
* Status of the moderation check (completed or pending)
|
|
5554
5576
|
*/
|
|
5555
5577
|
status: string;
|
|
5578
|
+
/**
|
|
5579
|
+
* Intent topic label matched by this request's text (test mode only; omitted when no topic matched)
|
|
5580
|
+
*/
|
|
5581
|
+
intent_matched_topic?: string;
|
|
5582
|
+
/**
|
|
5583
|
+
* Stage 2 conversation score (0-100) computed synchronously against this request's texts (test mode only). Omitted -- not zero -- when intent_matched_topic is set but scoring could not be completed (matched topic disabled/removed, or the scoring call itself failed); only present when a real score was computed
|
|
5584
|
+
*/
|
|
5585
|
+
intent_score?: number;
|
|
5586
|
+
/**
|
|
5587
|
+
* The matched topic's configured score_threshold, for comparison against intent_score (test mode only). Same omitted-not-zero rule as intent_score
|
|
5588
|
+
*/
|
|
5589
|
+
intent_score_threshold?: number;
|
|
5590
|
+
/**
|
|
5591
|
+
* Whether intent_score clears intent_score_threshold, i.e. whether this would fire moderation.intent_detected in production (test mode only). Same omitted-not-zero rule as intent_score
|
|
5592
|
+
*/
|
|
5593
|
+
intent_would_fire?: boolean;
|
|
5556
5594
|
/**
|
|
5557
5595
|
* ID of the running moderation task
|
|
5558
5596
|
*/
|
|
@@ -5562,6 +5600,9 @@ export interface CheckResponse {
|
|
|
5562
5600
|
*/
|
|
5563
5601
|
triggered_rules?: Array<TriggeredRuleResponse>;
|
|
5564
5602
|
item?: ReviewQueueItemResponse;
|
|
5603
|
+
/**
|
|
5604
|
+
* @deprecated
|
|
5605
|
+
*/
|
|
5565
5606
|
triggered_rule?: TriggeredRuleResponse;
|
|
5566
5607
|
}
|
|
5567
5608
|
|
|
@@ -6142,6 +6183,9 @@ export interface ConfigOverridesRequest {
|
|
|
6142
6183
|
* Maximum message length
|
|
6143
6184
|
*/
|
|
6144
6185
|
max_message_length?: number;
|
|
6186
|
+
/**
|
|
6187
|
+
* Overrides the push notification level for this channel
|
|
6188
|
+
*/
|
|
6145
6189
|
push_level?: 'all' | 'all_mentions' | 'mentions' | 'direct_mentions' | 'none';
|
|
6146
6190
|
/**
|
|
6147
6191
|
* Enable/disable quotes
|
|
@@ -6229,6 +6273,7 @@ export interface ConfigResponse {
|
|
|
6229
6273
|
automod_toxicity_config?: AutomodToxicityConfig;
|
|
6230
6274
|
block_list_config?: BlockListConfig;
|
|
6231
6275
|
flood_config?: FloodConfig;
|
|
6276
|
+
intent_config?: IntentConfigResponse;
|
|
6232
6277
|
llm_config?: LLMConfig;
|
|
6233
6278
|
velocity_filter_config?: VelocityFilterConfig;
|
|
6234
6279
|
video_call_rule_config?: VideoCallRuleConfig;
|
|
@@ -6545,6 +6590,9 @@ export interface CreateChannelTypeResponse {
|
|
|
6545
6590
|
created_at: Date;
|
|
6546
6591
|
custom_events: boolean;
|
|
6547
6592
|
delivery_events: boolean;
|
|
6593
|
+
/**
|
|
6594
|
+
* Duration of the request in milliseconds
|
|
6595
|
+
*/
|
|
6548
6596
|
duration: string;
|
|
6549
6597
|
mark_messages_pending: boolean;
|
|
6550
6598
|
max_message_length: number;
|
|
@@ -6573,6 +6621,9 @@ export interface CreateChannelTypeResponse {
|
|
|
6573
6621
|
blocklist_behavior?: 'flag' | 'block' | 'shadow_block';
|
|
6574
6622
|
partition_size?: number;
|
|
6575
6623
|
partition_ttl?: string;
|
|
6624
|
+
/**
|
|
6625
|
+
* Sets the push notification level for a channel type
|
|
6626
|
+
*/
|
|
6576
6627
|
push_level?: 'all' | 'all_mentions' | 'mentions' | 'direct_mentions' | 'none';
|
|
6577
6628
|
allowed_flag_reasons?: Array<string>;
|
|
6578
6629
|
blocklists?: Array<BlockListOptions>;
|
|
@@ -7037,6 +7088,7 @@ export interface CreateQueueRequest {
|
|
|
7037
7088
|
}
|
|
7038
7089
|
|
|
7039
7090
|
export interface CreateReminderRequest {
|
|
7091
|
+
expires_at?: Date;
|
|
7040
7092
|
remind_at?: Date;
|
|
7041
7093
|
user_id?: string;
|
|
7042
7094
|
/**
|
|
@@ -7665,6 +7717,17 @@ export interface DeleteFeedsBatchResponse {
|
|
|
7665
7717
|
task_id: string;
|
|
7666
7718
|
}
|
|
7667
7719
|
|
|
7720
|
+
export interface DeleteFeedsRetentionPolicyRequest {
|
|
7721
|
+
policy: 'old-activities';
|
|
7722
|
+
}
|
|
7723
|
+
|
|
7724
|
+
export interface DeleteFeedsRetentionPolicyResponse {
|
|
7725
|
+
/**
|
|
7726
|
+
* Duration of the request in milliseconds
|
|
7727
|
+
*/
|
|
7728
|
+
duration: string;
|
|
7729
|
+
}
|
|
7730
|
+
|
|
7668
7731
|
export interface DeleteImportV2TaskResponse {
|
|
7669
7732
|
/**
|
|
7670
7733
|
* Duration of the request in milliseconds
|
|
@@ -9301,6 +9364,13 @@ export interface FeedsReactionResponse {
|
|
|
9301
9364
|
custom?: Record<string, any>;
|
|
9302
9365
|
}
|
|
9303
9366
|
|
|
9367
|
+
export interface FeedsRetentionRunResponse {
|
|
9368
|
+
app_pk: number;
|
|
9369
|
+
date: string;
|
|
9370
|
+
policy: string;
|
|
9371
|
+
stats: RunStats;
|
|
9372
|
+
}
|
|
9373
|
+
|
|
9304
9374
|
export interface FeedsShareResponse {
|
|
9305
9375
|
activity_id: string;
|
|
9306
9376
|
created_at: Date;
|
|
@@ -9629,6 +9699,7 @@ export interface FloodSimilarConfig {
|
|
|
9629
9699
|
}
|
|
9630
9700
|
|
|
9631
9701
|
export interface FloodSimilarRuleParameters {
|
|
9702
|
+
min_text_length?: number;
|
|
9632
9703
|
similarity_distance?: number;
|
|
9633
9704
|
threshold?: number;
|
|
9634
9705
|
time_window?: string;
|
|
@@ -9843,6 +9914,10 @@ export interface FullUserResponse {
|
|
|
9843
9914
|
shadow_banned: boolean;
|
|
9844
9915
|
total_unread_count: number;
|
|
9845
9916
|
unread_channels: number;
|
|
9917
|
+
/**
|
|
9918
|
+
* @deprecated
|
|
9919
|
+
* Deprecated: Use total_unread_count instead.
|
|
9920
|
+
*/
|
|
9846
9921
|
unread_count: number;
|
|
9847
9922
|
unread_threads: number;
|
|
9848
9923
|
updated_at: Date;
|
|
@@ -10072,6 +10147,9 @@ export interface GetChannelTypeResponse {
|
|
|
10072
10147
|
blocklist_behavior?: 'flag' | 'block' | 'shadow_block';
|
|
10073
10148
|
partition_size?: number;
|
|
10074
10149
|
partition_ttl?: string;
|
|
10150
|
+
/**
|
|
10151
|
+
* Sets the push notification level for a channel type
|
|
10152
|
+
*/
|
|
10075
10153
|
push_level?: 'all' | 'all_mentions' | 'mentions' | 'direct_mentions' | 'none';
|
|
10076
10154
|
allowed_flag_reasons?: Array<string>;
|
|
10077
10155
|
blocklists?: Array<BlockListOptions>;
|
|
@@ -10112,6 +10190,10 @@ export interface GetCommentResponse {
|
|
|
10112
10190
|
}
|
|
10113
10191
|
|
|
10114
10192
|
export interface GetCommentsResponse {
|
|
10193
|
+
/**
|
|
10194
|
+
* Total number of comments on the object, including replies at every depth
|
|
10195
|
+
*/
|
|
10196
|
+
comment_count: number;
|
|
10115
10197
|
duration: string;
|
|
10116
10198
|
/**
|
|
10117
10199
|
* Sort order used for the comments (first, last, top, best, controversial)
|
|
@@ -10123,6 +10205,10 @@ export interface GetCommentsResponse {
|
|
|
10123
10205
|
comments: Array<ThreadedCommentResponse>;
|
|
10124
10206
|
next?: string;
|
|
10125
10207
|
prev?: string;
|
|
10208
|
+
/**
|
|
10209
|
+
* Number of comments directly on the object, excluding replies. Independent of depth, replies_limit and id_around, and not adjusted per viewer. Only present when include_top_level_comment_count is set
|
|
10210
|
+
*/
|
|
10211
|
+
top_level_comment_count?: number;
|
|
10126
10212
|
}
|
|
10127
10213
|
|
|
10128
10214
|
export interface GetConfigResponse {
|
|
@@ -10259,6 +10345,39 @@ export interface GetFeedsRateLimitsResponse {
|
|
|
10259
10345
|
web?: Record<string, LimitInfoResponse>;
|
|
10260
10346
|
}
|
|
10261
10347
|
|
|
10348
|
+
export interface GetFeedsRetentionPolicyResponse {
|
|
10349
|
+
/**
|
|
10350
|
+
* Duration of the request in milliseconds
|
|
10351
|
+
*/
|
|
10352
|
+
duration: string;
|
|
10353
|
+
enabled: boolean;
|
|
10354
|
+
policies: Array<RetentionPolicy>;
|
|
10355
|
+
}
|
|
10356
|
+
|
|
10357
|
+
export interface GetFeedsRetentionPolicyRunsRequest {
|
|
10358
|
+
limit?: number;
|
|
10359
|
+
next?: string;
|
|
10360
|
+
prev?: string;
|
|
10361
|
+
/**
|
|
10362
|
+
* Array of sort parameters
|
|
10363
|
+
*/
|
|
10364
|
+
sort?: Array<SortParamRequest>;
|
|
10365
|
+
/**
|
|
10366
|
+
* Filter conditions to apply to the query
|
|
10367
|
+
*/
|
|
10368
|
+
filter_conditions?: Record<string, any>;
|
|
10369
|
+
}
|
|
10370
|
+
|
|
10371
|
+
export interface GetFeedsRetentionPolicyRunsResponse {
|
|
10372
|
+
/**
|
|
10373
|
+
* Duration of the request in milliseconds
|
|
10374
|
+
*/
|
|
10375
|
+
duration: string;
|
|
10376
|
+
runs: Array<FeedsRetentionRunResponse>;
|
|
10377
|
+
next?: string;
|
|
10378
|
+
prev?: string;
|
|
10379
|
+
}
|
|
10380
|
+
|
|
10262
10381
|
export interface GetFlagCountRequest {
|
|
10263
10382
|
/**
|
|
10264
10383
|
* ID of the user whose content was flagged
|
|
@@ -11271,6 +11390,136 @@ export interface InsertActionLogResponse {
|
|
|
11271
11390
|
duration: string;
|
|
11272
11391
|
}
|
|
11273
11392
|
|
|
11393
|
+
export interface IntentBufferedItem {
|
|
11394
|
+
/**
|
|
11395
|
+
* The ID of the user who authored the buffered message or comment
|
|
11396
|
+
*/
|
|
11397
|
+
author_user_id: string;
|
|
11398
|
+
/**
|
|
11399
|
+
* When the buffered message or comment was created
|
|
11400
|
+
*/
|
|
11401
|
+
created_at: Date;
|
|
11402
|
+
/**
|
|
11403
|
+
* The ID of the buffered message or comment
|
|
11404
|
+
*/
|
|
11405
|
+
id: string;
|
|
11406
|
+
/**
|
|
11407
|
+
* The text of the buffered message or comment
|
|
11408
|
+
*/
|
|
11409
|
+
text: string;
|
|
11410
|
+
}
|
|
11411
|
+
|
|
11412
|
+
export interface IntentConfigRequest {
|
|
11413
|
+
/**
|
|
11414
|
+
* Topics to classify conversation text against (max 20, labels must be unique)
|
|
11415
|
+
*/
|
|
11416
|
+
topics?: Array<IntentTopicRequest>;
|
|
11417
|
+
}
|
|
11418
|
+
|
|
11419
|
+
export interface IntentConfigResponse {
|
|
11420
|
+
/**
|
|
11421
|
+
* Topics conversation text is classified against
|
|
11422
|
+
*/
|
|
11423
|
+
topics: Array<IntentTopicResponse>;
|
|
11424
|
+
}
|
|
11425
|
+
|
|
11426
|
+
export interface IntentDetectedEvent {
|
|
11427
|
+
/**
|
|
11428
|
+
* The channel CID (chat) or feed ID (feeds) the buffered conversation belongs to
|
|
11429
|
+
*/
|
|
11430
|
+
conversation_id: string;
|
|
11431
|
+
created_at: Date;
|
|
11432
|
+
/**
|
|
11433
|
+
* The ID of the most recently buffered entity
|
|
11434
|
+
*/
|
|
11435
|
+
entity_id: string;
|
|
11436
|
+
/**
|
|
11437
|
+
* The type of the most recently buffered entity (chat message or feed comment)
|
|
11438
|
+
*/
|
|
11439
|
+
entity_type: string;
|
|
11440
|
+
/**
|
|
11441
|
+
* The configured intent topic label that started the buffer
|
|
11442
|
+
*/
|
|
11443
|
+
matched_topic: string;
|
|
11444
|
+
/**
|
|
11445
|
+
* The Stage 2 conversation score (0-100) that cleared score_threshold
|
|
11446
|
+
*/
|
|
11447
|
+
score: number;
|
|
11448
|
+
/**
|
|
11449
|
+
* The ID of the user whose conversation was scored
|
|
11450
|
+
*/
|
|
11451
|
+
user_id: string;
|
|
11452
|
+
/**
|
|
11453
|
+
* The buffered items that were scored, in the order they were captured
|
|
11454
|
+
*/
|
|
11455
|
+
items: Array<IntentBufferedItem>;
|
|
11456
|
+
custom: Record<string, any>;
|
|
11457
|
+
type: string;
|
|
11458
|
+
received_at?: Date;
|
|
11459
|
+
}
|
|
11460
|
+
|
|
11461
|
+
export interface IntentTopicRequest {
|
|
11462
|
+
/**
|
|
11463
|
+
* Unique topic label (e.g. purchase_intent)
|
|
11464
|
+
*/
|
|
11465
|
+
label: string;
|
|
11466
|
+
/**
|
|
11467
|
+
* How long the buffer collects items before scoring runs
|
|
11468
|
+
*/
|
|
11469
|
+
analysis_cooldown_seconds?: number;
|
|
11470
|
+
/**
|
|
11471
|
+
* Optional description used in the classification prompt; the label alone is used when empty
|
|
11472
|
+
*/
|
|
11473
|
+
description?: string;
|
|
11474
|
+
/**
|
|
11475
|
+
* Whether this topic is evaluated
|
|
11476
|
+
*/
|
|
11477
|
+
enabled?: boolean;
|
|
11478
|
+
/**
|
|
11479
|
+
* Items buffered per conversation before scoring runs early
|
|
11480
|
+
*/
|
|
11481
|
+
max_captured_items?: number;
|
|
11482
|
+
/**
|
|
11483
|
+
* Suppresses this topic for a user and conversation after it fires; 0 uses the default
|
|
11484
|
+
*/
|
|
11485
|
+
refire_cooldown_seconds?: number;
|
|
11486
|
+
/**
|
|
11487
|
+
* Conversation score (0-100) required to fire moderation.intent_detected
|
|
11488
|
+
*/
|
|
11489
|
+
score_threshold?: number;
|
|
11490
|
+
}
|
|
11491
|
+
|
|
11492
|
+
export interface IntentTopicResponse {
|
|
11493
|
+
/**
|
|
11494
|
+
* How long the buffer collects items before scoring runs
|
|
11495
|
+
*/
|
|
11496
|
+
analysis_cooldown_seconds: number;
|
|
11497
|
+
/**
|
|
11498
|
+
* Whether this topic is evaluated
|
|
11499
|
+
*/
|
|
11500
|
+
enabled: boolean;
|
|
11501
|
+
/**
|
|
11502
|
+
* Unique topic label (e.g. purchase_intent)
|
|
11503
|
+
*/
|
|
11504
|
+
label: string;
|
|
11505
|
+
/**
|
|
11506
|
+
* Items buffered per conversation before scoring runs early
|
|
11507
|
+
*/
|
|
11508
|
+
max_captured_items: number;
|
|
11509
|
+
/**
|
|
11510
|
+
* Conversation score (0-100) required to fire moderation.intent_detected
|
|
11511
|
+
*/
|
|
11512
|
+
score_threshold: number;
|
|
11513
|
+
/**
|
|
11514
|
+
* Optional description used in the classification prompt; the label alone is used when empty
|
|
11515
|
+
*/
|
|
11516
|
+
description?: string;
|
|
11517
|
+
/**
|
|
11518
|
+
* Suppresses this topic for a user and conversation after it fires; 0 uses the default
|
|
11519
|
+
*/
|
|
11520
|
+
refire_cooldown_seconds?: number;
|
|
11521
|
+
}
|
|
11522
|
+
|
|
11274
11523
|
export interface InterestTagResponse {
|
|
11275
11524
|
/**
|
|
11276
11525
|
* Lifetime number of distinct reacted-to activities tagged with this value, without decay; 0 for manually set tags
|
|
@@ -14089,6 +14338,10 @@ export interface OwnUserResponse {
|
|
|
14089
14338
|
role: string;
|
|
14090
14339
|
total_unread_count: number;
|
|
14091
14340
|
unread_channels: number;
|
|
14341
|
+
/**
|
|
14342
|
+
* @deprecated
|
|
14343
|
+
* Deprecated: Use total_unread_count instead.
|
|
14344
|
+
*/
|
|
14092
14345
|
unread_count: number;
|
|
14093
14346
|
unread_threads: number;
|
|
14094
14347
|
updated_at: Date;
|
|
@@ -15600,10 +15853,6 @@ export interface QueryCommentsRequest {
|
|
|
15600
15853
|
* Returns the comment with the specified ID along with surrounding comments for context
|
|
15601
15854
|
*/
|
|
15602
15855
|
id_around?: string;
|
|
15603
|
-
/**
|
|
15604
|
-
* When true, include soft-deleted comments in the result. Server-side only, and requires an object_id filter. Returns comments deleted by any path, including user-data deletion. Moderation-actioned comments (removed, hidden) remain excluded, and comments whose parent activity is itself deleted are not returned.
|
|
15605
|
-
*/
|
|
15606
|
-
include_soft_deleted_comments?: boolean;
|
|
15607
15856
|
/**
|
|
15608
15857
|
* Maximum number of comments to return
|
|
15609
15858
|
*/
|
|
@@ -16316,7 +16565,7 @@ export interface QueryReviewQueueRequest {
|
|
|
16316
16565
|
*/
|
|
16317
16566
|
sort?: Array<SortParamRequest>;
|
|
16318
16567
|
/**
|
|
16319
|
-
* 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.
|
|
16568
|
+
* 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. content_text searches the moderated text: "$q" is a keyword search (terms ANDed, no adjacency) over the indexed tsvector, while "$eq" (or "$in" for several wordings) matches the text exactly. The exact form is unindexed, so scope it with date_range rather than running it across the whole queue.
|
|
16320
16569
|
*/
|
|
16321
16570
|
filter?: Record<string, any>;
|
|
16322
16571
|
/**
|
|
@@ -17214,6 +17463,7 @@ export interface ReminderResponseData {
|
|
|
17214
17463
|
message_id: string;
|
|
17215
17464
|
updated_at: Date;
|
|
17216
17465
|
user_id: string;
|
|
17466
|
+
expires_at?: Date;
|
|
17217
17467
|
remind_at?: Date;
|
|
17218
17468
|
/**
|
|
17219
17469
|
* Represents channel in chat
|
|
@@ -17748,6 +17998,7 @@ export interface RuleBuilderCondition {
|
|
|
17748
17998
|
ocr_content_params?: OCRContentParameters;
|
|
17749
17999
|
text_content_params?: TextContentParameters;
|
|
17750
18000
|
text_rule_params?: TextRuleParameters;
|
|
18001
|
+
user_channel_count_params?: UserChannelCountRuleParameters;
|
|
17751
18002
|
user_created_within_params?: UserCreatedWithinParameters;
|
|
17752
18003
|
user_custom_property_params?: UserCustomPropertyParameters;
|
|
17753
18004
|
user_flag_count_rule_params?: FlagCountRuleParameters;
|
|
@@ -18539,6 +18790,21 @@ export interface SessionWarningResponse {
|
|
|
18539
18790
|
time?: Date;
|
|
18540
18791
|
}
|
|
18541
18792
|
|
|
18793
|
+
export interface SetFeedsRetentionPolicyRequest {
|
|
18794
|
+
max_age_hours: number;
|
|
18795
|
+
policy: 'old-activities';
|
|
18796
|
+
enabled?: boolean;
|
|
18797
|
+
}
|
|
18798
|
+
|
|
18799
|
+
export interface SetFeedsRetentionPolicyResponse {
|
|
18800
|
+
/**
|
|
18801
|
+
* Duration of the request in milliseconds
|
|
18802
|
+
*/
|
|
18803
|
+
duration: string;
|
|
18804
|
+
enabled: boolean;
|
|
18805
|
+
policy: RetentionPolicy;
|
|
18806
|
+
}
|
|
18807
|
+
|
|
18542
18808
|
export interface SetRetentionPolicyRequest {
|
|
18543
18809
|
max_age_hours: number;
|
|
18544
18810
|
policy: 'old-messages' | 'inactive-channels';
|
|
@@ -19161,7 +19427,8 @@ export interface SubmitActionRequest {
|
|
|
19161
19427
|
*/
|
|
19162
19428
|
unban?: UnbanActionRequestPayload;
|
|
19163
19429
|
/**
|
|
19164
|
-
*
|
|
19430
|
+
* @deprecated
|
|
19431
|
+
* Deprecated: Use restore instead, which now also reverses a block or shadow block. Configuration for unblock action.
|
|
19165
19432
|
*/
|
|
19166
19433
|
unblock?: UnblockActionRequestPayload;
|
|
19167
19434
|
/**
|
|
@@ -20019,6 +20286,7 @@ export interface UnbanRequest {
|
|
|
20019
20286
|
*/
|
|
20020
20287
|
unbanned_by_id?: string;
|
|
20021
20288
|
/**
|
|
20289
|
+
* @deprecated
|
|
20022
20290
|
* User request object
|
|
20023
20291
|
*/
|
|
20024
20292
|
unbanned_by?: UserRequest;
|
|
@@ -20804,6 +21072,9 @@ export interface UpdateChannelTypeRequest {
|
|
|
20804
21072
|
partition_size?: number;
|
|
20805
21073
|
partition_ttl?: string;
|
|
20806
21074
|
polls?: boolean;
|
|
21075
|
+
/**
|
|
21076
|
+
* Sets the push notification level for a channel type
|
|
21077
|
+
*/
|
|
20807
21078
|
push_level?: 'all' | 'all_mentions' | 'mentions' | 'direct_mentions' | 'none';
|
|
20808
21079
|
push_notifications?: boolean;
|
|
20809
21080
|
quotes?: boolean;
|
|
@@ -20841,6 +21112,9 @@ export interface UpdateChannelTypeResponse {
|
|
|
20841
21112
|
created_at: Date;
|
|
20842
21113
|
custom_events: boolean;
|
|
20843
21114
|
delivery_events: boolean;
|
|
21115
|
+
/**
|
|
21116
|
+
* Duration of the request in milliseconds
|
|
21117
|
+
*/
|
|
20844
21118
|
duration: string;
|
|
20845
21119
|
mark_messages_pending: boolean;
|
|
20846
21120
|
max_message_length: number;
|
|
@@ -20869,6 +21143,9 @@ export interface UpdateChannelTypeResponse {
|
|
|
20869
21143
|
blocklist_behavior?: 'flag' | 'block' | 'shadow_block';
|
|
20870
21144
|
partition_size?: number;
|
|
20871
21145
|
partition_ttl?: string;
|
|
21146
|
+
/**
|
|
21147
|
+
* Sets the push notification level for a channel type
|
|
21148
|
+
*/
|
|
20872
21149
|
push_level?: 'all' | 'all_mentions' | 'mentions' | 'direct_mentions' | 'none';
|
|
20873
21150
|
allowed_flag_reasons?: Array<string>;
|
|
20874
21151
|
blocklists?: Array<BlockListOptions>;
|
|
@@ -21513,6 +21790,7 @@ export interface UpdateQueueRequest {
|
|
|
21513
21790
|
}
|
|
21514
21791
|
|
|
21515
21792
|
export interface UpdateReminderRequest {
|
|
21793
|
+
expires_at?: Date;
|
|
21516
21794
|
remind_at?: Date;
|
|
21517
21795
|
user_id?: string;
|
|
21518
21796
|
/**
|
|
@@ -21707,7 +21985,7 @@ export interface UpdateUsersResponse {
|
|
|
21707
21985
|
duration: string;
|
|
21708
21986
|
/**
|
|
21709
21987
|
* @deprecated
|
|
21710
|
-
* Deprecated:
|
|
21988
|
+
* Deprecated: Always empty. Removing a user from a team no longer deletes their memberships in that team's channels, so there is no task to poll.
|
|
21711
21989
|
*/
|
|
21712
21990
|
membership_deletion_task_id: string;
|
|
21713
21991
|
/**
|
|
@@ -21917,6 +22195,7 @@ export interface UpsertConfigRequest {
|
|
|
21917
22195
|
bodyguard_config?: AITextConfig;
|
|
21918
22196
|
flood_config?: FloodConfig;
|
|
21919
22197
|
google_vision_config?: GoogleVisionConfig;
|
|
22198
|
+
intent_config?: IntentConfigRequest;
|
|
21920
22199
|
llm_config?: LLMConfig;
|
|
21921
22200
|
rule_builder_config?: RuleBuilderConfig;
|
|
21922
22201
|
/**
|
|
@@ -22222,6 +22501,11 @@ export interface UserBannedEvent {
|
|
|
22222
22501
|
created_by?: UserResponseCommonFields;
|
|
22223
22502
|
}
|
|
22224
22503
|
|
|
22504
|
+
export interface UserChannelCountRuleParameters {
|
|
22505
|
+
threshold?: number;
|
|
22506
|
+
time_window?: string;
|
|
22507
|
+
}
|
|
22508
|
+
|
|
22225
22509
|
export interface UserCreatedWithinParameters {
|
|
22226
22510
|
max_age?: string;
|
|
22227
22511
|
}
|
|
@@ -23099,6 +23383,7 @@ export type WHEvent =
|
|
|
23099
23383
|
| ({
|
|
23100
23384
|
type: 'moderation.image_analysis.complete';
|
|
23101
23385
|
} & ModerationImageAnalysisCompleteEvent)
|
|
23386
|
+
| ({ type: 'moderation.intent_detected' } & IntentDetectedEvent)
|
|
23102
23387
|
| ({ type: 'moderation.mark_reviewed' } & ModerationMarkReviewedEvent)
|
|
23103
23388
|
| ({
|
|
23104
23389
|
type: 'moderation.text_analysis.complete';
|