@stream-io/node-sdk 0.7.52 → 0.7.54
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 +204 -5
- package/dist/index.cjs.js.map +1 -1
- package/dist/index.es.mjs +204 -5
- package/dist/index.es.mjs.map +1 -1
- package/dist/src/gen/feeds/FeedsApi.d.ts +16 -1
- package/dist/src/gen/models/index.d.ts +253 -22
- package/dist/src/gen/moderation/ModerationApi.d.ts +6 -2
- package/dist/src/gen/video/VideoApi.d.ts +2 -1
- package/package.json +1 -1
- package/src/gen/feeds/FeedsApi.ts +121 -2
- package/src/gen/model-decoders/decoders.ts +131 -0
- package/src/gen/models/index.ts +342 -25
- package/src/gen/moderation/ModerationApi.ts +39 -4
- package/src/gen/video/VideoApi.ts +29 -0
|
@@ -299,16 +299,6 @@ export interface ActivityFeedbackResponse {
|
|
|
299
299
|
activity_id: string;
|
|
300
300
|
duration: string;
|
|
301
301
|
}
|
|
302
|
-
export interface ActivityLocation {
|
|
303
|
-
/**
|
|
304
|
-
* Latitude coordinate
|
|
305
|
-
*/
|
|
306
|
-
lat: number;
|
|
307
|
-
/**
|
|
308
|
-
* Longitude coordinate
|
|
309
|
-
*/
|
|
310
|
-
lng: number;
|
|
311
|
-
}
|
|
312
302
|
export interface ActivityMarkEvent {
|
|
313
303
|
/**
|
|
314
304
|
* Date/time of creation
|
|
@@ -538,7 +528,7 @@ export interface ActivityRequest {
|
|
|
538
528
|
* Custom data for the activity
|
|
539
529
|
*/
|
|
540
530
|
custom?: Record<string, any>;
|
|
541
|
-
location?:
|
|
531
|
+
location?: Location;
|
|
542
532
|
/**
|
|
543
533
|
* Additional data for search indexing
|
|
544
534
|
*/
|
|
@@ -697,7 +687,7 @@ export interface ActivityResponse {
|
|
|
697
687
|
*/
|
|
698
688
|
friend_reactions?: FeedsReactionResponse[];
|
|
699
689
|
current_feed?: FeedResponse;
|
|
700
|
-
location?:
|
|
690
|
+
location?: Location;
|
|
701
691
|
metrics?: Record<string, number>;
|
|
702
692
|
moderation?: ModerationV2Response;
|
|
703
693
|
notification_context?: NotificationContext;
|
|
@@ -839,6 +829,7 @@ export interface AddActivityRequest {
|
|
|
839
829
|
* Expiration time for the activity
|
|
840
830
|
*/
|
|
841
831
|
expires_at?: string;
|
|
832
|
+
force_moderation?: boolean;
|
|
842
833
|
/**
|
|
843
834
|
* Optional ID for the activity
|
|
844
835
|
*/
|
|
@@ -903,7 +894,7 @@ export interface AddActivityRequest {
|
|
|
903
894
|
* Custom data for the activity
|
|
904
895
|
*/
|
|
905
896
|
custom?: Record<string, any>;
|
|
906
|
-
location?:
|
|
897
|
+
location?: Location;
|
|
907
898
|
/**
|
|
908
899
|
* Additional data for search indexing
|
|
909
900
|
*/
|
|
@@ -934,6 +925,23 @@ export interface AddBookmarkResponse {
|
|
|
934
925
|
duration: string;
|
|
935
926
|
bookmark: BookmarkResponse;
|
|
936
927
|
}
|
|
928
|
+
export interface AddCommentBookmarkRequest {
|
|
929
|
+
/**
|
|
930
|
+
* ID of the folder to add the bookmark to
|
|
931
|
+
*/
|
|
932
|
+
folder_id?: string;
|
|
933
|
+
user_id?: string;
|
|
934
|
+
/**
|
|
935
|
+
* Custom data for the bookmark
|
|
936
|
+
*/
|
|
937
|
+
custom?: Record<string, any>;
|
|
938
|
+
new_folder?: AddFolderRequest;
|
|
939
|
+
user?: UserRequest;
|
|
940
|
+
}
|
|
941
|
+
export interface AddCommentBookmarkResponse {
|
|
942
|
+
duration: string;
|
|
943
|
+
bookmark: BookmarkResponse;
|
|
944
|
+
}
|
|
937
945
|
export interface AddCommentReactionRequest {
|
|
938
946
|
/**
|
|
939
947
|
* The type of reaction, eg upvote, like, ...
|
|
@@ -986,6 +994,10 @@ export interface AddCommentRequest {
|
|
|
986
994
|
* Whether to create a notification activity for this comment
|
|
987
995
|
*/
|
|
988
996
|
create_notification_activity?: boolean;
|
|
997
|
+
/**
|
|
998
|
+
* If true, forces moderation to run for server-side requests. By default, server-side requests skip moderation. Client-side requests always run moderation regardless of this field.
|
|
999
|
+
*/
|
|
1000
|
+
force_moderation?: boolean;
|
|
989
1001
|
/**
|
|
990
1002
|
* Optional custom ID for the comment (max 255 characters). If not provided, a UUID will be generated.
|
|
991
1003
|
*/
|
|
@@ -1151,6 +1163,10 @@ export interface AggregatedActivityResponse {
|
|
|
1151
1163
|
is_watched?: boolean;
|
|
1152
1164
|
}
|
|
1153
1165
|
export interface AggregationConfig {
|
|
1166
|
+
/**
|
|
1167
|
+
* Order of member activities inside each aggregated group for non-stories feeds: created_at_desc (newest first, default) or created_at_asc (oldest first). Stories feeds ignore this and always use oldest first.
|
|
1168
|
+
*/
|
|
1169
|
+
activities_sort?: 'created_at_asc' | 'created_at_desc';
|
|
1154
1170
|
/**
|
|
1155
1171
|
* Format for activity aggregation
|
|
1156
1172
|
*/
|
|
@@ -1792,12 +1808,22 @@ export interface BookmarkResponse {
|
|
|
1792
1808
|
* When the bookmark was created
|
|
1793
1809
|
*/
|
|
1794
1810
|
created_at: Date;
|
|
1811
|
+
/**
|
|
1812
|
+
* ID of the bookmarked object
|
|
1813
|
+
*/
|
|
1814
|
+
object_id: string;
|
|
1815
|
+
/**
|
|
1816
|
+
* Type of the bookmarked object (activity or comment)
|
|
1817
|
+
*/
|
|
1818
|
+
object_type: string;
|
|
1795
1819
|
/**
|
|
1796
1820
|
* When the bookmark was last updated
|
|
1797
1821
|
*/
|
|
1798
1822
|
updated_at: Date;
|
|
1799
1823
|
activity: ActivityResponse;
|
|
1800
1824
|
user: UserResponse;
|
|
1825
|
+
activity_id?: string;
|
|
1826
|
+
comment?: CommentResponse;
|
|
1801
1827
|
/**
|
|
1802
1828
|
* Custom data for the bookmark
|
|
1803
1829
|
*/
|
|
@@ -1854,6 +1880,22 @@ export interface BulkImageModerationResponse {
|
|
|
1854
1880
|
*/
|
|
1855
1881
|
task_id: string;
|
|
1856
1882
|
}
|
|
1883
|
+
export interface BypassActionRequest {
|
|
1884
|
+
enabled?: boolean;
|
|
1885
|
+
}
|
|
1886
|
+
export interface BypassRequest {
|
|
1887
|
+
/**
|
|
1888
|
+
* Whether to enable moderation bypass for this user
|
|
1889
|
+
*/
|
|
1890
|
+
enabled: boolean;
|
|
1891
|
+
/**
|
|
1892
|
+
* ID of the user to update
|
|
1893
|
+
*/
|
|
1894
|
+
target_user_id: string;
|
|
1895
|
+
}
|
|
1896
|
+
export interface BypassResponse {
|
|
1897
|
+
duration: string;
|
|
1898
|
+
}
|
|
1857
1899
|
export interface CallAcceptedEvent {
|
|
1858
1900
|
call_cid: string;
|
|
1859
1901
|
created_at: Date;
|
|
@@ -2672,8 +2714,12 @@ export interface CallStatsParticipantCounts {
|
|
|
2672
2714
|
peak_concurrent_users: number;
|
|
2673
2715
|
publishers: number;
|
|
2674
2716
|
sessions: number;
|
|
2717
|
+
sfus_used: number;
|
|
2718
|
+
average_jitter_ms?: number;
|
|
2719
|
+
average_latency_ms?: number;
|
|
2675
2720
|
call_event_count?: number;
|
|
2676
2721
|
cq_score?: number;
|
|
2722
|
+
max_freezes_duration_ms?: number;
|
|
2677
2723
|
total_participant_duration?: number;
|
|
2678
2724
|
}
|
|
2679
2725
|
export interface CallStatsParticipantSession {
|
|
@@ -2687,6 +2733,9 @@ export interface CallStatsParticipantSession {
|
|
|
2687
2733
|
current_sfu?: string;
|
|
2688
2734
|
distance_to_sfu_kilometers?: number;
|
|
2689
2735
|
ended_at?: Date;
|
|
2736
|
+
freezes_duration_ms?: number;
|
|
2737
|
+
jitter_ms?: number;
|
|
2738
|
+
latency_ms?: number;
|
|
2690
2739
|
os?: string;
|
|
2691
2740
|
publisher_type?: string;
|
|
2692
2741
|
sdk?: string;
|
|
@@ -2703,6 +2752,7 @@ export interface CallStatsReportReadyEvent {
|
|
|
2703
2752
|
* Call session ID
|
|
2704
2753
|
*/
|
|
2705
2754
|
session_id: string;
|
|
2755
|
+
counts: CallStatsParticipantCounts;
|
|
2706
2756
|
/**
|
|
2707
2757
|
* The type of event, "call.report_ready" in this case
|
|
2708
2758
|
*/
|
|
@@ -2726,6 +2776,15 @@ export interface CallStatsReportSummaryResponse {
|
|
|
2726
2776
|
min_user_rating?: number;
|
|
2727
2777
|
quality_score?: number;
|
|
2728
2778
|
}
|
|
2779
|
+
export interface CallStatsSessionResponse {
|
|
2780
|
+
call_id: string;
|
|
2781
|
+
call_session_id: string;
|
|
2782
|
+
call_type: string;
|
|
2783
|
+
generated_at: Date;
|
|
2784
|
+
counts: CallStatsParticipantCounts;
|
|
2785
|
+
call_ended_at?: Date;
|
|
2786
|
+
call_started_at?: Date;
|
|
2787
|
+
}
|
|
2729
2788
|
export interface CallTranscription {
|
|
2730
2789
|
end_time: Date;
|
|
2731
2790
|
filename: string;
|
|
@@ -4212,6 +4271,7 @@ export interface CommentReactionUpdatedEvent {
|
|
|
4212
4271
|
user?: UserResponseCommonFields;
|
|
4213
4272
|
}
|
|
4214
4273
|
export interface CommentResponse {
|
|
4274
|
+
bookmark_count: number;
|
|
4215
4275
|
/**
|
|
4216
4276
|
* Confidence score of the comment
|
|
4217
4277
|
*/
|
|
@@ -5349,6 +5409,10 @@ export interface DeleteCommandResponse {
|
|
|
5349
5409
|
*/
|
|
5350
5410
|
name: string;
|
|
5351
5411
|
}
|
|
5412
|
+
export interface DeleteCommentBookmarkResponse {
|
|
5413
|
+
duration: string;
|
|
5414
|
+
bookmark: BookmarkResponse;
|
|
5415
|
+
}
|
|
5352
5416
|
export interface DeleteCommentReactionResponse {
|
|
5353
5417
|
duration: string;
|
|
5354
5418
|
comment: CommentResponse;
|
|
@@ -5729,6 +5793,20 @@ export interface DraftResponse {
|
|
|
5729
5793
|
parent_message?: MessageResponse;
|
|
5730
5794
|
quoted_message?: MessageResponse;
|
|
5731
5795
|
}
|
|
5796
|
+
export interface EMAUStatsResponse {
|
|
5797
|
+
/**
|
|
5798
|
+
* Per-day unique engaged user counts
|
|
5799
|
+
*/
|
|
5800
|
+
daily: DailyMetricResponse[];
|
|
5801
|
+
/**
|
|
5802
|
+
* Rolling 30-day engaged user count snapshots
|
|
5803
|
+
*/
|
|
5804
|
+
last_30_days: DailyMetricResponse[];
|
|
5805
|
+
/**
|
|
5806
|
+
* Calendar month-to-date engaged user count snapshots
|
|
5807
|
+
*/
|
|
5808
|
+
month_to_date: DailyMetricResponse[];
|
|
5809
|
+
}
|
|
5732
5810
|
export interface EdgeResponse {
|
|
5733
5811
|
continent_code: string;
|
|
5734
5812
|
country_iso_code: string;
|
|
@@ -5841,10 +5919,6 @@ export interface EnrichmentOptions {
|
|
|
5841
5919
|
* Default: false. When true, includes fetching and enriching own_followings (follows where activity author's feeds follow current user's feeds).
|
|
5842
5920
|
*/
|
|
5843
5921
|
enrich_own_followings?: boolean;
|
|
5844
|
-
/**
|
|
5845
|
-
* Default: false. When true, includes the top-level flat 'activities' array in responses for aggregated feeds. By default, aggregated feeds only return 'aggregated_activities'.
|
|
5846
|
-
*/
|
|
5847
|
-
include_flat_activities?: boolean;
|
|
5848
5922
|
/**
|
|
5849
5923
|
* Default: false. When true, includes score_vars in activity responses containing variable values used at ranking time.
|
|
5850
5924
|
*/
|
|
@@ -5945,6 +6019,7 @@ export interface EntityCreatorResponse {
|
|
|
5945
6019
|
custom: Record<string, any>;
|
|
5946
6020
|
avg_response_time?: number;
|
|
5947
6021
|
ban_expires?: Date;
|
|
6022
|
+
bypass_moderation?: boolean;
|
|
5948
6023
|
deactivated_at?: Date;
|
|
5949
6024
|
deleted_at?: Date;
|
|
5950
6025
|
image?: string;
|
|
@@ -6263,6 +6338,7 @@ export interface FeedInput {
|
|
|
6263
6338
|
filter_tags?: string[];
|
|
6264
6339
|
members?: FeedMemberRequest[];
|
|
6265
6340
|
custom?: Record<string, any>;
|
|
6341
|
+
location?: Location;
|
|
6266
6342
|
}
|
|
6267
6343
|
export interface FeedMemberAddedEvent {
|
|
6268
6344
|
/**
|
|
@@ -6450,6 +6526,7 @@ export interface FeedRequest {
|
|
|
6450
6526
|
* Custom data for the feed
|
|
6451
6527
|
*/
|
|
6452
6528
|
custom?: Record<string, any>;
|
|
6529
|
+
location?: Location;
|
|
6453
6530
|
}
|
|
6454
6531
|
export interface FeedResponse {
|
|
6455
6532
|
activity_count: number;
|
|
@@ -6526,6 +6603,7 @@ export interface FeedResponse {
|
|
|
6526
6603
|
* Custom data for the feed
|
|
6527
6604
|
*/
|
|
6528
6605
|
custom?: Record<string, any>;
|
|
6606
|
+
location?: Location;
|
|
6529
6607
|
own_membership?: FeedMemberResponse;
|
|
6530
6608
|
}
|
|
6531
6609
|
export interface FeedSuggestionResponse {
|
|
@@ -6606,6 +6684,7 @@ export interface FeedSuggestionResponse {
|
|
|
6606
6684
|
* Custom data for the feed
|
|
6607
6685
|
*/
|
|
6608
6686
|
custom?: Record<string, any>;
|
|
6687
|
+
location?: Location;
|
|
6609
6688
|
own_membership?: FeedMemberResponse;
|
|
6610
6689
|
}
|
|
6611
6690
|
export interface FeedUpdatedEvent {
|
|
@@ -6936,6 +7015,10 @@ export interface FollowBatchRequest {
|
|
|
6936
7015
|
* List of follow relationships to create
|
|
6937
7016
|
*/
|
|
6938
7017
|
follows: FollowRequest[];
|
|
7018
|
+
/**
|
|
7019
|
+
* If true, auto-creates users referenced by source/target FIDs in the batch when they don't already exist. Server-side only. Defaults to false. This top-level field is the only supported batch/upsert create_users control.
|
|
7020
|
+
*/
|
|
7021
|
+
create_users?: boolean;
|
|
6939
7022
|
/**
|
|
6940
7023
|
* If true, enriches the follow's source_feed and target_feed with own_* fields (own_follows, own_followings, own_capabilities, own_membership). Defaults to false for performance.
|
|
6941
7024
|
*/
|
|
@@ -7004,6 +7087,10 @@ export interface FollowRequest {
|
|
|
7004
7087
|
* Whether to create a notification activity for this follow
|
|
7005
7088
|
*/
|
|
7006
7089
|
create_notification_activity?: boolean;
|
|
7090
|
+
/**
|
|
7091
|
+
* If true, auto-creates users referenced by the source and target FIDs when they don't already exist. Server-side only. Defaults to false. For FollowBatch/GetOrCreateFollows, use the top-level create_users field; per-item follows[i].create_users is rejected.
|
|
7092
|
+
*/
|
|
7093
|
+
create_users?: boolean;
|
|
7007
7094
|
/**
|
|
7008
7095
|
* If true, enriches the follow's source_feed and target_feed with own_* fields (own_follows, own_followings, own_capabilities, own_membership). Defaults to false for performance.
|
|
7009
7096
|
*/
|
|
@@ -7130,6 +7217,7 @@ export interface FullUserResponse {
|
|
|
7130
7217
|
custom: Record<string, any>;
|
|
7131
7218
|
avg_response_time?: number;
|
|
7132
7219
|
ban_expires?: Date;
|
|
7220
|
+
bypass_moderation?: boolean;
|
|
7133
7221
|
deactivated_at?: Date;
|
|
7134
7222
|
deleted_at?: Date;
|
|
7135
7223
|
image?: string;
|
|
@@ -7468,6 +7556,7 @@ export interface GetImportV2TaskResponse {
|
|
|
7468
7556
|
state: number;
|
|
7469
7557
|
updated_at: Date;
|
|
7470
7558
|
settings: ImportV2TaskSettings;
|
|
7559
|
+
result?: Record<string, any>;
|
|
7471
7560
|
}
|
|
7472
7561
|
export interface GetManyMessagesResponse {
|
|
7473
7562
|
duration: string;
|
|
@@ -7929,12 +8018,14 @@ export interface ImportV2TaskItem {
|
|
|
7929
8018
|
state: number;
|
|
7930
8019
|
updated_at: Date;
|
|
7931
8020
|
settings: ImportV2TaskSettings;
|
|
8021
|
+
result?: Record<string, any>;
|
|
7932
8022
|
}
|
|
7933
8023
|
export interface ImportV2TaskSettings {
|
|
7934
8024
|
merge_custom?: boolean;
|
|
7935
8025
|
mode?: string;
|
|
7936
8026
|
path?: string;
|
|
7937
8027
|
skip_references_check?: boolean;
|
|
8028
|
+
source?: string;
|
|
7938
8029
|
s3?: ImportV2TaskSettingsS3;
|
|
7939
8030
|
}
|
|
7940
8031
|
export interface ImportV2TaskSettingsS3 {
|
|
@@ -8393,6 +8484,16 @@ export interface ListUserGroupsResponse {
|
|
|
8393
8484
|
*/
|
|
8394
8485
|
user_groups: UserGroupResponse[];
|
|
8395
8486
|
}
|
|
8487
|
+
export interface Location {
|
|
8488
|
+
/**
|
|
8489
|
+
* Latitude coordinate
|
|
8490
|
+
*/
|
|
8491
|
+
lat: number;
|
|
8492
|
+
/**
|
|
8493
|
+
* Longitude coordinate
|
|
8494
|
+
*/
|
|
8495
|
+
lng: number;
|
|
8496
|
+
}
|
|
8396
8497
|
export interface LocationResponse {
|
|
8397
8498
|
/**
|
|
8398
8499
|
* Continent code
|
|
@@ -11107,6 +11208,28 @@ export interface QueryCallSessionParticipantStatsTimelineResponse {
|
|
|
11107
11208
|
user_session_id: string;
|
|
11108
11209
|
events: CallParticipantTimeline[];
|
|
11109
11210
|
}
|
|
11211
|
+
export interface QueryCallSessionStatsRequest {
|
|
11212
|
+
limit?: number;
|
|
11213
|
+
next?: string;
|
|
11214
|
+
prev?: string;
|
|
11215
|
+
/**
|
|
11216
|
+
* Array of sort parameters
|
|
11217
|
+
*/
|
|
11218
|
+
sort?: SortParamRequest[];
|
|
11219
|
+
/**
|
|
11220
|
+
* Filter conditions to apply to the query
|
|
11221
|
+
*/
|
|
11222
|
+
filter_conditions?: Record<string, any>;
|
|
11223
|
+
}
|
|
11224
|
+
export interface QueryCallSessionStatsResponse {
|
|
11225
|
+
/**
|
|
11226
|
+
* Duration of the request in milliseconds
|
|
11227
|
+
*/
|
|
11228
|
+
duration: string;
|
|
11229
|
+
call_stats: CallStatsSessionResponse[];
|
|
11230
|
+
next?: string;
|
|
11231
|
+
prev?: string;
|
|
11232
|
+
}
|
|
11110
11233
|
export interface QueryCallStatsMapResponse {
|
|
11111
11234
|
call_id: string;
|
|
11112
11235
|
call_session_id: string;
|
|
@@ -11287,7 +11410,7 @@ export interface QueryCommentReactionsResponse {
|
|
|
11287
11410
|
}
|
|
11288
11411
|
export interface QueryCommentsRequest {
|
|
11289
11412
|
/**
|
|
11290
|
-
*
|
|
11413
|
+
* Filter to apply to the query
|
|
11291
11414
|
*/
|
|
11292
11415
|
filter: Record<string, any>;
|
|
11293
11416
|
/**
|
|
@@ -11301,7 +11424,7 @@ export interface QueryCommentsRequest {
|
|
|
11301
11424
|
next?: string;
|
|
11302
11425
|
prev?: string;
|
|
11303
11426
|
/**
|
|
11304
|
-
*
|
|
11427
|
+
* Array of sort parameters
|
|
11305
11428
|
*/
|
|
11306
11429
|
sort?: 'first' | 'last' | 'top' | 'best' | 'controversial';
|
|
11307
11430
|
user_id?: string;
|
|
@@ -11448,6 +11571,7 @@ export interface QueryFeedsUsageStatsResponse {
|
|
|
11448
11571
|
api_requests: DailyMetricStatsResponse;
|
|
11449
11572
|
follows: DailyMetricStatsResponse;
|
|
11450
11573
|
openai_requests: DailyMetricStatsResponse;
|
|
11574
|
+
emau?: EMAUStatsResponse;
|
|
11451
11575
|
}
|
|
11452
11576
|
export interface QueryFollowsRequest {
|
|
11453
11577
|
limit?: number;
|
|
@@ -12123,6 +12247,7 @@ export interface RankingConfig {
|
|
|
12123
12247
|
}
|
|
12124
12248
|
export interface RawRecordSettings {
|
|
12125
12249
|
mode: 'available' | 'disabled' | 'auto-on';
|
|
12250
|
+
audio_only?: boolean;
|
|
12126
12251
|
}
|
|
12127
12252
|
export interface RawRecordingResponse {
|
|
12128
12253
|
status: string;
|
|
@@ -12132,9 +12257,14 @@ export interface RawRecordingSettingsRequest {
|
|
|
12132
12257
|
* Recording mode. One of: available, disabled, auto-on
|
|
12133
12258
|
*/
|
|
12134
12259
|
mode: 'available' | 'disabled' | 'auto-on';
|
|
12260
|
+
/**
|
|
12261
|
+
* If true, only audio tracks will be recorded
|
|
12262
|
+
*/
|
|
12263
|
+
audio_only?: boolean;
|
|
12135
12264
|
}
|
|
12136
12265
|
export interface RawRecordingSettingsResponse {
|
|
12137
12266
|
mode: 'available' | 'disabled' | 'auto-on';
|
|
12267
|
+
audio_only?: boolean;
|
|
12138
12268
|
}
|
|
12139
12269
|
export interface Reaction {
|
|
12140
12270
|
activity_id: string;
|
|
@@ -13965,7 +14095,7 @@ export interface SubmitActionRequest {
|
|
|
13965
14095
|
/**
|
|
13966
14096
|
* Type of moderation action to perform. One of: mark_reviewed, delete_message, delete_activity, delete_comment, delete_reaction, ban, custom, unban, restore, delete_user, unblock, block, shadow_block, unmask, kick_user, end_call, escalate, de_escalate
|
|
13967
14097
|
*/
|
|
13968
|
-
action_type: 'flag' | 'mark_reviewed' | 'delete_message' | 'delete_activity' | 'delete_comment' | 'delete_reaction' | 'ban' | 'custom' | 'unban' | 'restore' | 'delete_user' | 'unblock' | 'block' | 'shadow_block' | 'unmask' | 'kick_user' | 'end_call' | 'reject_appeal' | 'escalate' | 'de_escalate';
|
|
14098
|
+
action_type: 'flag' | 'mark_reviewed' | 'delete_message' | 'delete_activity' | 'delete_comment' | 'delete_reaction' | 'ban' | 'custom' | 'unban' | 'restore' | 'delete_user' | 'unblock' | 'block' | 'shadow_block' | 'unmask' | 'kick_user' | 'end_call' | 'reject_appeal' | 'escalate' | 'de_escalate' | 'bypass';
|
|
13969
14099
|
/**
|
|
13970
14100
|
* UUID of the appeal to act on (required for reject_appeal, optional for other actions)
|
|
13971
14101
|
*/
|
|
@@ -13977,6 +14107,7 @@ export interface SubmitActionRequest {
|
|
|
13977
14107
|
user_id?: string;
|
|
13978
14108
|
ban?: BanActionRequestPayload;
|
|
13979
14109
|
block?: BlockActionRequestPayload;
|
|
14110
|
+
bypass?: BypassActionRequest;
|
|
13980
14111
|
custom?: CustomActionRequestPayload;
|
|
13981
14112
|
delete_activity?: DeleteActivityRequestPayload;
|
|
13982
14113
|
delete_comment?: DeleteCommentRequestPayload;
|
|
@@ -14219,6 +14350,7 @@ export interface ThreadUpdatedEvent {
|
|
|
14219
14350
|
thread?: ThreadResponse;
|
|
14220
14351
|
}
|
|
14221
14352
|
export interface ThreadedCommentResponse {
|
|
14353
|
+
bookmark_count: number;
|
|
14222
14354
|
confidence_score: number;
|
|
14223
14355
|
created_at: Date;
|
|
14224
14356
|
downvote_count: number;
|
|
@@ -14619,6 +14751,10 @@ export interface UpdateActivitiesPartialBatchRequest {
|
|
|
14619
14751
|
* List of activity changes to apply. Each change specifies an activity ID and the fields to set/unset
|
|
14620
14752
|
*/
|
|
14621
14753
|
changes: UpdateActivityPartialChangeRequest[];
|
|
14754
|
+
/**
|
|
14755
|
+
* If true, forces moderation to run for server-side requests. By default, server-side requests skip moderation. Client-side requests always run moderation regardless of this field.
|
|
14756
|
+
*/
|
|
14757
|
+
force_moderation?: boolean;
|
|
14622
14758
|
}
|
|
14623
14759
|
export interface UpdateActivitiesPartialBatchResponse {
|
|
14624
14760
|
duration: string;
|
|
@@ -14660,6 +14796,10 @@ export interface UpdateActivityPartialRequest {
|
|
|
14660
14796
|
* If true, enriches the activity's current_feed with own_* fields (own_follows, own_followings, own_capabilities, own_membership). Defaults to false for performance.
|
|
14661
14797
|
*/
|
|
14662
14798
|
enrich_own_fields?: boolean;
|
|
14799
|
+
/**
|
|
14800
|
+
* If true, forces moderation to run for server-side requests. By default, server-side requests skip moderation. Client-side requests always run moderation regardless of this field.
|
|
14801
|
+
*/
|
|
14802
|
+
force_moderation?: boolean;
|
|
14663
14803
|
/**
|
|
14664
14804
|
* If true, creates notification activities for newly mentioned users and deletes notifications for users no longer mentioned
|
|
14665
14805
|
*/
|
|
@@ -14697,6 +14837,10 @@ export interface UpdateActivityRequest {
|
|
|
14697
14837
|
* Time when the activity will expire
|
|
14698
14838
|
*/
|
|
14699
14839
|
expires_at?: Date;
|
|
14840
|
+
/**
|
|
14841
|
+
* If true, forces moderation to run for server-side requests. By default, server-side requests skip moderation. Client-side requests always run moderation regardless of this field.
|
|
14842
|
+
*/
|
|
14843
|
+
force_moderation?: boolean;
|
|
14700
14844
|
/**
|
|
14701
14845
|
* If true, creates notification activities for newly mentioned users and deletes notifications for users no longer mentioned
|
|
14702
14846
|
*/
|
|
@@ -14758,7 +14902,7 @@ export interface UpdateActivityRequest {
|
|
|
14758
14902
|
* Custom data for the activity
|
|
14759
14903
|
*/
|
|
14760
14904
|
custom?: Record<string, any>;
|
|
14761
|
-
location?:
|
|
14905
|
+
location?: Location;
|
|
14762
14906
|
/**
|
|
14763
14907
|
* Additional data for search indexing
|
|
14764
14908
|
*/
|
|
@@ -14855,9 +14999,12 @@ export interface UpdateBookmarkFolderResponse {
|
|
|
14855
14999
|
}
|
|
14856
15000
|
export interface UpdateBookmarkRequest {
|
|
14857
15001
|
/**
|
|
14858
|
-
* ID of the folder
|
|
15002
|
+
* ID of the folder containing the bookmark
|
|
14859
15003
|
*/
|
|
14860
15004
|
folder_id?: string;
|
|
15005
|
+
/**
|
|
15006
|
+
* Move the bookmark to this folder (empty string removes the folder)
|
|
15007
|
+
*/
|
|
14861
15008
|
new_folder_id?: string;
|
|
14862
15009
|
user_id?: string;
|
|
14863
15010
|
/**
|
|
@@ -15155,12 +15302,37 @@ export interface UpdateCommandResponse {
|
|
|
15155
15302
|
duration: string;
|
|
15156
15303
|
command?: Command;
|
|
15157
15304
|
}
|
|
15305
|
+
export interface UpdateCommentBookmarkRequest {
|
|
15306
|
+
/**
|
|
15307
|
+
* ID of the folder containing the bookmark
|
|
15308
|
+
*/
|
|
15309
|
+
folder_id?: string;
|
|
15310
|
+
/**
|
|
15311
|
+
* Move the bookmark to this folder (empty string removes the folder)
|
|
15312
|
+
*/
|
|
15313
|
+
new_folder_id?: string;
|
|
15314
|
+
user_id?: string;
|
|
15315
|
+
/**
|
|
15316
|
+
* Custom data for the bookmark
|
|
15317
|
+
*/
|
|
15318
|
+
custom?: Record<string, any>;
|
|
15319
|
+
new_folder?: AddFolderRequest;
|
|
15320
|
+
user?: UserRequest;
|
|
15321
|
+
}
|
|
15322
|
+
export interface UpdateCommentBookmarkResponse {
|
|
15323
|
+
duration: string;
|
|
15324
|
+
bookmark: BookmarkResponse;
|
|
15325
|
+
}
|
|
15158
15326
|
export interface UpdateCommentPartialRequest {
|
|
15159
15327
|
/**
|
|
15160
15328
|
* @deprecated
|
|
15161
15329
|
* Whether to copy custom data to notification activities Deprecated: use notification_context.trigger.custom and notification_context.target.custom instead
|
|
15162
15330
|
*/
|
|
15163
15331
|
copy_custom_to_notification?: boolean;
|
|
15332
|
+
/**
|
|
15333
|
+
* If true, forces moderation to run for server-side requests. By default, server-side requests skip moderation. Client-side requests always run moderation regardless of this field.
|
|
15334
|
+
*/
|
|
15335
|
+
force_moderation?: boolean;
|
|
15164
15336
|
/**
|
|
15165
15337
|
* Whether to handle mention notification changes
|
|
15166
15338
|
*/
|
|
@@ -15198,6 +15370,10 @@ export interface UpdateCommentRequest {
|
|
|
15198
15370
|
* Whether to copy custom data to the notification activity (only applies when handle_mention_notifications creates notifications) Deprecated: use notification_context.trigger.custom and notification_context.target.custom instead
|
|
15199
15371
|
*/
|
|
15200
15372
|
copy_custom_to_notification?: boolean;
|
|
15373
|
+
/**
|
|
15374
|
+
* If true, forces moderation to run for server-side requests. By default, server-side requests skip moderation. Client-side requests always run moderation regardless of this field.
|
|
15375
|
+
*/
|
|
15376
|
+
force_moderation?: boolean;
|
|
15201
15377
|
/**
|
|
15202
15378
|
* If true, creates notification activities for newly mentioned users and deletes notifications for users no longer mentioned
|
|
15203
15379
|
*/
|
|
@@ -15300,6 +15476,10 @@ export interface UpdateFeedMembersResponse {
|
|
|
15300
15476
|
updated: FeedMemberResponse[];
|
|
15301
15477
|
}
|
|
15302
15478
|
export interface UpdateFeedRequest {
|
|
15479
|
+
/**
|
|
15480
|
+
* If true, removes the geographic location from the feed
|
|
15481
|
+
*/
|
|
15482
|
+
clear_location?: boolean;
|
|
15303
15483
|
/**
|
|
15304
15484
|
* ID of the new feed creator (owner)
|
|
15305
15485
|
*/
|
|
@@ -15324,6 +15504,7 @@ export interface UpdateFeedRequest {
|
|
|
15324
15504
|
* Custom data for the feed
|
|
15325
15505
|
*/
|
|
15326
15506
|
custom?: Record<string, any>;
|
|
15507
|
+
location?: Location;
|
|
15327
15508
|
}
|
|
15328
15509
|
export interface UpdateFeedResponse {
|
|
15329
15510
|
duration: string;
|
|
@@ -15373,6 +15554,10 @@ export interface UpdateFollowRequest {
|
|
|
15373
15554
|
* Whether to create a notification activity for this follow
|
|
15374
15555
|
*/
|
|
15375
15556
|
create_notification_activity?: boolean;
|
|
15557
|
+
/**
|
|
15558
|
+
* If true, auto-creates users referenced by the source and target FIDs when they don't already exist. Server-side only. Defaults to false. For FollowBatch/GetOrCreateFollows, use the top-level create_users field; per-item follows[i].create_users is rejected.
|
|
15559
|
+
*/
|
|
15560
|
+
create_users?: boolean;
|
|
15376
15561
|
/**
|
|
15377
15562
|
* If true, enriches the follow's source_feed and target_feed with own_* fields (own_follows, own_followings, own_capabilities, own_membership). Defaults to false for performance.
|
|
15378
15563
|
*/
|
|
@@ -15767,6 +15952,10 @@ export interface UpsertActivitiesRequest {
|
|
|
15767
15952
|
* If true, enriches the activities' current_feed with own_* fields (own_follows, own_followings, own_capabilities, own_membership). Defaults to false for performance.
|
|
15768
15953
|
*/
|
|
15769
15954
|
enrich_own_fields?: boolean;
|
|
15955
|
+
/**
|
|
15956
|
+
* If true, forces moderation to run for server-side requests. By default, server-side requests skip moderation. Client-side requests always run moderation regardless of this field.
|
|
15957
|
+
*/
|
|
15958
|
+
force_moderation?: boolean;
|
|
15770
15959
|
}
|
|
15771
15960
|
export interface UpsertActivitiesResponse {
|
|
15772
15961
|
duration: string;
|
|
@@ -15805,6 +15994,9 @@ export interface UpsertConfigRequest {
|
|
|
15805
15994
|
* Team associated with the configuration
|
|
15806
15995
|
*/
|
|
15807
15996
|
team?: string;
|
|
15997
|
+
/**
|
|
15998
|
+
* Optional user ID to associate with the audit log entry
|
|
15999
|
+
*/
|
|
15808
16000
|
user_id?: string;
|
|
15809
16001
|
ai_image_config?: AIImageConfig;
|
|
15810
16002
|
ai_text_config?: AITextConfig;
|
|
@@ -15843,18 +16035,56 @@ export interface UpsertExternalStorageResponse {
|
|
|
15843
16035
|
duration: string;
|
|
15844
16036
|
}
|
|
15845
16037
|
export interface UpsertModerationRuleRequest {
|
|
16038
|
+
/**
|
|
16039
|
+
* Unique rule name
|
|
16040
|
+
*/
|
|
15846
16041
|
name: string;
|
|
16042
|
+
/**
|
|
16043
|
+
* Type of rule: user, content, or call
|
|
16044
|
+
*/
|
|
15847
16045
|
rule_type: string;
|
|
16046
|
+
/**
|
|
16047
|
+
* Duration before rule can trigger again (e.g. 24h, 7d)
|
|
16048
|
+
*/
|
|
15848
16049
|
cooldown_period?: string;
|
|
16050
|
+
/**
|
|
16051
|
+
* Optional description of the rule
|
|
16052
|
+
*/
|
|
15849
16053
|
description?: string;
|
|
16054
|
+
/**
|
|
16055
|
+
* Whether the rule is active
|
|
16056
|
+
*/
|
|
15850
16057
|
enabled?: boolean;
|
|
16058
|
+
/**
|
|
16059
|
+
* Logical operator between conditions/groups: AND or OR
|
|
16060
|
+
*/
|
|
15851
16061
|
logic?: string;
|
|
16062
|
+
/**
|
|
16063
|
+
* Team scope for the rule
|
|
16064
|
+
*/
|
|
15852
16065
|
team?: string;
|
|
16066
|
+
/**
|
|
16067
|
+
* Optional user ID to associate with the audit log entry
|
|
16068
|
+
*/
|
|
16069
|
+
user_id?: string;
|
|
16070
|
+
/**
|
|
16071
|
+
* Escalation sequences for call rules
|
|
16072
|
+
*/
|
|
15853
16073
|
action_sequences?: CallRuleActionSequence[];
|
|
16074
|
+
/**
|
|
16075
|
+
* Flat list of conditions (legacy)
|
|
16076
|
+
*/
|
|
15854
16077
|
conditions?: RuleBuilderCondition[];
|
|
16078
|
+
/**
|
|
16079
|
+
* List of config keys this rule applies to
|
|
16080
|
+
*/
|
|
15855
16081
|
config_keys?: string[];
|
|
16082
|
+
/**
|
|
16083
|
+
* Nested condition groups
|
|
16084
|
+
*/
|
|
15856
16085
|
groups?: RuleBuilderConditionGroup[];
|
|
15857
16086
|
action?: RuleBuilderAction;
|
|
16087
|
+
user?: UserRequest;
|
|
15858
16088
|
}
|
|
15859
16089
|
export interface UpsertModerationRuleResponse {
|
|
15860
16090
|
/**
|
|
@@ -16370,6 +16600,7 @@ export interface UserResponse {
|
|
|
16370
16600
|
* Date when ban expires
|
|
16371
16601
|
*/
|
|
16372
16602
|
ban_expires?: Date;
|
|
16603
|
+
bypass_moderation?: boolean;
|
|
16373
16604
|
/**
|
|
16374
16605
|
* Date of deactivation
|
|
16375
16606
|
*/
|
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
import { ApiClient, StreamResponse } from '../../gen-imports';
|
|
2
|
-
import { AppealRequest, AppealResponse, BanRequest, BanResponse, BulkImageModerationRequest, BulkImageModerationResponse, CheckRequest, CheckResponse, CheckS3AccessRequest, CheckS3AccessResponse, CustomCheckRequest, CustomCheckResponse, DeleteModerationConfigResponse, DeleteModerationRuleResponse, DeleteModerationTemplateResponse, FlagRequest, FlagResponse, GetAppealResponse, GetConfigResponse, GetFlagCountRequest, GetFlagCountResponse, GetModerationRuleResponse, GetReviewQueueItemResponse, InsertActionLogRequest, InsertActionLogResponse, MuteRequest, MuteResponse, QueryAppealsRequest, QueryAppealsResponse, QueryFeedModerationTemplatesResponse, QueryModerationConfigsRequest, QueryModerationConfigsResponse, QueryModerationFlagsRequest, QueryModerationFlagsResponse, QueryModerationLogsRequest, QueryModerationLogsResponse, QueryModerationRulesRequest, QueryModerationRulesResponse, QueryReviewQueueRequest, QueryReviewQueueResponse, SubmitActionRequest, SubmitActionResponse, UnbanRequest, UnbanResponse, UnmuteRequest, UnmuteResponse, UpsertConfigRequest, UpsertConfigResponse, UpsertModerationRuleRequest, UpsertModerationRuleResponse, UpsertModerationTemplateRequest, UpsertModerationTemplateResponse } from '../models';
|
|
2
|
+
import { AppealRequest, AppealResponse, BanRequest, BanResponse, BulkImageModerationRequest, BulkImageModerationResponse, BypassRequest, BypassResponse, CheckRequest, CheckResponse, CheckS3AccessRequest, CheckS3AccessResponse, CustomCheckRequest, CustomCheckResponse, DeleteModerationConfigResponse, DeleteModerationRuleResponse, DeleteModerationTemplateResponse, FlagRequest, FlagResponse, GetAppealResponse, GetConfigResponse, GetFlagCountRequest, GetFlagCountResponse, GetModerationRuleResponse, GetReviewQueueItemResponse, InsertActionLogRequest, InsertActionLogResponse, MuteRequest, MuteResponse, QueryAppealsRequest, QueryAppealsResponse, QueryFeedModerationTemplatesResponse, QueryModerationConfigsRequest, QueryModerationConfigsResponse, QueryModerationFlagsRequest, QueryModerationFlagsResponse, QueryModerationLogsRequest, QueryModerationLogsResponse, QueryModerationRulesRequest, QueryModerationRulesResponse, QueryReviewQueueRequest, QueryReviewQueueResponse, SubmitActionRequest, SubmitActionResponse, UnbanRequest, UnbanResponse, UnmuteRequest, UnmuteResponse, UpsertConfigRequest, UpsertConfigResponse, UpsertModerationRuleRequest, UpsertModerationRuleResponse, UpsertModerationTemplateRequest, UpsertModerationTemplateResponse } from '../models';
|
|
3
3
|
export declare class ModerationApi {
|
|
4
4
|
readonly apiClient: ApiClient;
|
|
5
5
|
constructor(apiClient: ApiClient);
|
|
@@ -11,12 +11,14 @@ export declare class ModerationApi {
|
|
|
11
11
|
queryAppeals(request?: QueryAppealsRequest): Promise<StreamResponse<QueryAppealsResponse>>;
|
|
12
12
|
ban(request: BanRequest): Promise<StreamResponse<BanResponse>>;
|
|
13
13
|
bulkImageModeration(request: BulkImageModerationRequest): Promise<StreamResponse<BulkImageModerationResponse>>;
|
|
14
|
+
bypass(request: BypassRequest): Promise<StreamResponse<BypassResponse>>;
|
|
14
15
|
check(request: CheckRequest): Promise<StreamResponse<CheckResponse>>;
|
|
15
16
|
checkS3Access(request?: CheckS3AccessRequest): Promise<StreamResponse<CheckS3AccessResponse>>;
|
|
16
17
|
upsertConfig(request: UpsertConfigRequest): Promise<StreamResponse<UpsertConfigResponse>>;
|
|
17
18
|
deleteConfig(request: {
|
|
18
19
|
key: string;
|
|
19
20
|
team?: string;
|
|
21
|
+
user_id?: string;
|
|
20
22
|
}): Promise<StreamResponse<DeleteModerationConfigResponse>>;
|
|
21
23
|
getConfig(request: {
|
|
22
24
|
key: string;
|
|
@@ -32,7 +34,9 @@ export declare class ModerationApi {
|
|
|
32
34
|
queryModerationFlags(request?: QueryModerationFlagsRequest): Promise<StreamResponse<QueryModerationFlagsResponse>>;
|
|
33
35
|
queryModerationLogs(request?: QueryModerationLogsRequest): Promise<StreamResponse<QueryModerationLogsResponse>>;
|
|
34
36
|
upsertModerationRule(request: UpsertModerationRuleRequest): Promise<StreamResponse<UpsertModerationRuleResponse>>;
|
|
35
|
-
deleteModerationRule(
|
|
37
|
+
deleteModerationRule(request?: {
|
|
38
|
+
user_id?: string;
|
|
39
|
+
}): Promise<StreamResponse<DeleteModerationRuleResponse>>;
|
|
36
40
|
getModerationRule(): Promise<StreamResponse<GetModerationRuleResponse>>;
|
|
37
41
|
queryModerationRules(request?: QueryModerationRulesRequest): Promise<StreamResponse<QueryModerationRulesResponse>>;
|
|
38
42
|
mute(request: MuteRequest): Promise<StreamResponse<MuteResponse>>;
|