@stream-io/node-sdk 0.8.11 → 0.8.13
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 +26 -0
- package/__tests__/docs-snippets/README.md +87 -0
- package/dist/index.cjs.js +233 -13
- package/dist/index.cjs.js.map +1 -1
- package/dist/index.d.ts +2 -1
- package/dist/index.es.mjs +232 -14
- package/dist/index.es.mjs.map +1 -1
- package/dist/src/StreamChannel.d.ts +8 -1
- package/dist/src/StreamChatClient.d.ts +12 -0
- package/dist/src/gen/common/CommonApi.d.ts +2 -1
- package/dist/src/gen/feeds/FeedsApi.d.ts +4 -1
- package/dist/src/gen/models/index.d.ts +581 -11
- package/dist/src/gen/video/VideoApi.d.ts +2 -1
- package/index.ts +2 -0
- package/package.json +6 -1
- package/src/ApiClient.ts +3 -2
- package/src/StreamChannel.ts +23 -1
- package/src/StreamChatClient.ts +29 -1
- package/src/StreamClient.ts +13 -6
- package/src/gen/common/CommonApi.ts +25 -0
- package/src/gen/feeds/FeedsApi.ts +30 -0
- package/src/gen/model-decoders/decoders.ts +118 -2
- package/src/gen/models/index.ts +595 -11
- package/src/gen/moderation/ModerationApi.ts +2 -0
- package/src/gen/video/VideoApi.ts +25 -0
package/src/gen/models/index.ts
CHANGED
|
@@ -1,12 +1,31 @@
|
|
|
1
1
|
export interface AIAudioConfigRequest {
|
|
2
|
+
/**
|
|
3
|
+
* Bodyguard credentials profile to classify transcripts with. Applies to the NLP engine only; ignored when LLM configurability is enabled. Empty falls back to the app-pinned profile, then the organization's top-level credentials
|
|
4
|
+
*/
|
|
2
5
|
profile?: string;
|
|
6
|
+
/**
|
|
7
|
+
* Deprecated pre-split rule list. Still the live config while no engine config exists; once one does it is kept as a fallback for whichever engine has none of its own
|
|
8
|
+
*/
|
|
3
9
|
rules?: Array<BodyguardRule>;
|
|
10
|
+
ai_text_config?: AITextConfig;
|
|
11
|
+
llm_config?: LLMConfig;
|
|
4
12
|
}
|
|
5
13
|
|
|
6
14
|
export interface AIAudioConfigResponse {
|
|
15
|
+
/**
|
|
16
|
+
* Whether the engine selected by the application's LLM configurability flag has a rule that does something. Derived, not stored
|
|
17
|
+
*/
|
|
7
18
|
enabled: boolean;
|
|
19
|
+
/**
|
|
20
|
+
* Bodyguard credentials profile transcripts are classified with. Applies to the NLP engine only
|
|
21
|
+
*/
|
|
8
22
|
profile: string;
|
|
23
|
+
/**
|
|
24
|
+
* The active engine's rules, flattened into the pre-split shape for clients that predate the per-engine configs. This is the whole config for a policy that has no per-engine config stored
|
|
25
|
+
*/
|
|
9
26
|
rules: Array<BodyguardRule>;
|
|
27
|
+
ai_text_config?: AITextConfig;
|
|
28
|
+
llm_config?: LLMConfig;
|
|
10
29
|
}
|
|
11
30
|
|
|
12
31
|
export interface AIImageConfig {
|
|
@@ -890,6 +909,10 @@ export interface ActivitySelectorConfig {
|
|
|
890
909
|
* 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
910
|
*/
|
|
892
911
|
ranking_candidate_limit?: number;
|
|
912
|
+
/**
|
|
913
|
+
* Maximum time in milliseconds this selector may take (25-5000). A selector that runs over its budget is dropped from that read instead of failing it, and stays out for the rest of that pagination session. The budget can only tighten the default, never extend it. Omit to use the default. Only supported on the popular, proximity, interest, query and follow_suggestion selectors
|
|
914
|
+
*/
|
|
915
|
+
time_budget_ms?: number;
|
|
893
916
|
/**
|
|
894
917
|
* Sort parameters for activity selection
|
|
895
918
|
*/
|
|
@@ -930,6 +953,10 @@ export interface ActivitySelectorConfigResponse {
|
|
|
930
953
|
* Maximum number of candidate activities this selector contributes to a ranked feed
|
|
931
954
|
*/
|
|
932
955
|
ranking_candidate_limit?: number;
|
|
956
|
+
/**
|
|
957
|
+
* Maximum time in milliseconds this selector may take before it is dropped from the read
|
|
958
|
+
*/
|
|
959
|
+
time_budget_ms?: number;
|
|
933
960
|
/**
|
|
934
961
|
* Sort parameters for activity selection
|
|
935
962
|
*/
|
|
@@ -1449,7 +1476,7 @@ export interface AggregationConfig {
|
|
|
1449
1476
|
*/
|
|
1450
1477
|
format?: string;
|
|
1451
1478
|
/**
|
|
1452
|
-
* Maximum number of activities kept in each aggregated group. Omit to use the default
|
|
1479
|
+
* Maximum number of activities kept in each aggregated group. Omit to use the default: 15 for apps migrated from Feeds v2 or created on or after 2026-10-11, 100 otherwise. Must be between 1 and 100 when set.
|
|
1453
1480
|
*/
|
|
1454
1481
|
group_size?: number;
|
|
1455
1482
|
/**
|
|
@@ -1578,7 +1605,13 @@ export interface AnalyzeTextField {
|
|
|
1578
1605
|
|
|
1579
1606
|
export interface AppResponseFields {
|
|
1580
1607
|
allow_multi_user_devices: boolean;
|
|
1608
|
+
/**
|
|
1609
|
+
* A boolean value determining if async url enrichment is enabled.
|
|
1610
|
+
*/
|
|
1581
1611
|
async_url_enrich_enabled: boolean;
|
|
1612
|
+
/**
|
|
1613
|
+
* A boolean value determining if auto translation is enabled.
|
|
1614
|
+
*/
|
|
1582
1615
|
auto_translation_enabled: boolean;
|
|
1583
1616
|
before_message_send_hook_system_messages: boolean;
|
|
1584
1617
|
campaign_enabled: boolean;
|
|
@@ -1603,6 +1636,9 @@ export interface AppResponseFields {
|
|
|
1603
1636
|
moderation_video_call_moderation_enabled: boolean;
|
|
1604
1637
|
moderation_webhook_url: string;
|
|
1605
1638
|
multi_tenant_enabled: boolean;
|
|
1639
|
+
/**
|
|
1640
|
+
* The name of the app.
|
|
1641
|
+
*/
|
|
1606
1642
|
name: string;
|
|
1607
1643
|
organization: string;
|
|
1608
1644
|
permission_version: string;
|
|
@@ -1832,6 +1868,17 @@ export interface AsyncExportErrorEvent {
|
|
|
1832
1868
|
received_at?: Date;
|
|
1833
1869
|
}
|
|
1834
1870
|
|
|
1871
|
+
export interface AsyncExportLabelResultsEvent {
|
|
1872
|
+
created_at: Date;
|
|
1873
|
+
finished_at: Date;
|
|
1874
|
+
started_at: Date;
|
|
1875
|
+
task_id: string;
|
|
1876
|
+
url: string;
|
|
1877
|
+
custom: Record<string, any>;
|
|
1878
|
+
type: string;
|
|
1879
|
+
received_at?: Date;
|
|
1880
|
+
}
|
|
1881
|
+
|
|
1835
1882
|
export interface AsyncExportModerationLogsEvent {
|
|
1836
1883
|
created_at: Date;
|
|
1837
1884
|
finished_at: Date;
|
|
@@ -1865,6 +1912,31 @@ export interface AsyncExportUsersEvent {
|
|
|
1865
1912
|
received_at?: Date;
|
|
1866
1913
|
}
|
|
1867
1914
|
|
|
1915
|
+
export interface AsyncImportErrorEvent {
|
|
1916
|
+
created_at: Date;
|
|
1917
|
+
error: string;
|
|
1918
|
+
finished_at: Date;
|
|
1919
|
+
product: string;
|
|
1920
|
+
state: string;
|
|
1921
|
+
task_id: string;
|
|
1922
|
+
custom: Record<string, any>;
|
|
1923
|
+
type: string;
|
|
1924
|
+
received_at?: Date;
|
|
1925
|
+
started_at?: Date;
|
|
1926
|
+
}
|
|
1927
|
+
|
|
1928
|
+
export interface AsyncImportSuccessEvent {
|
|
1929
|
+
created_at: Date;
|
|
1930
|
+
finished_at: Date;
|
|
1931
|
+
product: string;
|
|
1932
|
+
state: string;
|
|
1933
|
+
task_id: string;
|
|
1934
|
+
custom: Record<string, any>;
|
|
1935
|
+
type: string;
|
|
1936
|
+
received_at?: Date;
|
|
1937
|
+
started_at?: Date;
|
|
1938
|
+
}
|
|
1939
|
+
|
|
1868
1940
|
export interface AsyncModerationCallbackConfig {
|
|
1869
1941
|
mode?: 'CALLBACK_MODE_NONE' | 'CALLBACK_MODE_REST' | 'CALLBACK_MODE_TWIRP';
|
|
1870
1942
|
server_url?: string;
|
|
@@ -2108,6 +2180,10 @@ export interface BanRequest {
|
|
|
2108
2180
|
* ID of the user to ban
|
|
2109
2181
|
*/
|
|
2110
2182
|
target_user_id: string;
|
|
2183
|
+
/**
|
|
2184
|
+
* Whether to also ban the user from future channels created by the banner
|
|
2185
|
+
*/
|
|
2186
|
+
ban_from_future_channels?: boolean;
|
|
2111
2187
|
/**
|
|
2112
2188
|
* ID of the user performing the ban
|
|
2113
2189
|
*/
|
|
@@ -2117,6 +2193,10 @@ export interface BanRequest {
|
|
|
2117
2193
|
*/
|
|
2118
2194
|
channel_cid?: string;
|
|
2119
2195
|
delete_messages?: 'soft' | 'pruning' | 'hard';
|
|
2196
|
+
/**
|
|
2197
|
+
* Whether to delete reactions by the banned user on other users' messages
|
|
2198
|
+
*/
|
|
2199
|
+
delete_reactions?: boolean;
|
|
2120
2200
|
/**
|
|
2121
2201
|
* Whether to ban the user's IP address
|
|
2122
2202
|
*/
|
|
@@ -2259,7 +2339,7 @@ export interface BlockListResponse {
|
|
|
2259
2339
|
*/
|
|
2260
2340
|
name: string;
|
|
2261
2341
|
/**
|
|
2262
|
-
* Block list type. One of: regex, domain, domain_allowlist, email, email_allowlist, word
|
|
2342
|
+
* Block list type. One of: regex, domain, domain_allowlist, email, email_allowlist, word, word_allowlist
|
|
2263
2343
|
*/
|
|
2264
2344
|
type: string;
|
|
2265
2345
|
/**
|
|
@@ -3461,6 +3541,51 @@ export interface CallRingEvent {
|
|
|
3461
3541
|
ring_id?: string;
|
|
3462
3542
|
}
|
|
3463
3543
|
|
|
3544
|
+
export interface CallRingSettledEvent {
|
|
3545
|
+
call_cid: string;
|
|
3546
|
+
created_at: Date;
|
|
3547
|
+
/**
|
|
3548
|
+
* ID of the user who rang
|
|
3549
|
+
*/
|
|
3550
|
+
initiated_by: string;
|
|
3551
|
+
/**
|
|
3552
|
+
* Final outcome of the ring: answered_all, answered_some, rejected_all, missed_all, cancelled or mixed
|
|
3553
|
+
*/
|
|
3554
|
+
outcome: string;
|
|
3555
|
+
/**
|
|
3556
|
+
* When the ring was sent
|
|
3557
|
+
*/
|
|
3558
|
+
rang_at: Date;
|
|
3559
|
+
/**
|
|
3560
|
+
* Identifies this ring of the call session, as carried on call.ring
|
|
3561
|
+
*/
|
|
3562
|
+
ring_id: string;
|
|
3563
|
+
/**
|
|
3564
|
+
* Call session ID
|
|
3565
|
+
*/
|
|
3566
|
+
session_id: string;
|
|
3567
|
+
/**
|
|
3568
|
+
* Why the ring closed: answered, rejected, cancel, timeout, ended or auto_end
|
|
3569
|
+
*/
|
|
3570
|
+
settle_reason: string;
|
|
3571
|
+
/**
|
|
3572
|
+
* When the outcome left ringing
|
|
3573
|
+
*/
|
|
3574
|
+
settled_at: Date;
|
|
3575
|
+
/**
|
|
3576
|
+
* ID of the user whose action closed the ring, or 'server' for the missed-call deadline and automatic ends
|
|
3577
|
+
*/
|
|
3578
|
+
settled_by: string;
|
|
3579
|
+
/**
|
|
3580
|
+
* Final state of every rung user, keyed by user ID
|
|
3581
|
+
*/
|
|
3582
|
+
targets: Record<string, RingSettledTarget>;
|
|
3583
|
+
/**
|
|
3584
|
+
* The type of event: "call.ring_settled" in this case
|
|
3585
|
+
*/
|
|
3586
|
+
type: string;
|
|
3587
|
+
}
|
|
3588
|
+
|
|
3464
3589
|
export interface CallRtmpBroadcastFailedEvent {
|
|
3465
3590
|
/**
|
|
3466
3591
|
* The unique identifier for a call (<type>:<id>)
|
|
@@ -4847,7 +4972,13 @@ export type ChannelOwnCapability =
|
|
|
4847
4972
|
(typeof ChannelOwnCapability)[keyof typeof ChannelOwnCapability];
|
|
4848
4973
|
|
|
4849
4974
|
export interface ChannelPushPreferencesResponse {
|
|
4975
|
+
/**
|
|
4976
|
+
* The scope level of the push notifications.
|
|
4977
|
+
*/
|
|
4850
4978
|
chat_level?: string;
|
|
4979
|
+
/**
|
|
4980
|
+
* If provided the notifications will be disabled until the set date.
|
|
4981
|
+
*/
|
|
4851
4982
|
disabled_until?: Date;
|
|
4852
4983
|
chat_preferences?: ChatPreferencesResponse;
|
|
4853
4984
|
}
|
|
@@ -4980,6 +5111,9 @@ export interface ChannelStateResponse {
|
|
|
4980
5111
|
channel?: ChannelResponse;
|
|
4981
5112
|
draft?: DraftResponse;
|
|
4982
5113
|
membership?: ChannelMemberResponse;
|
|
5114
|
+
/**
|
|
5115
|
+
* The push preference details.
|
|
5116
|
+
*/
|
|
4983
5117
|
push_preferences?: ChannelPushPreferencesResponse;
|
|
4984
5118
|
}
|
|
4985
5119
|
|
|
@@ -5031,6 +5165,9 @@ export interface ChannelStateResponseFields {
|
|
|
5031
5165
|
channel?: ChannelResponse;
|
|
5032
5166
|
draft?: DraftResponse;
|
|
5033
5167
|
membership?: ChannelMemberResponse;
|
|
5168
|
+
/**
|
|
5169
|
+
* The push preference details.
|
|
5170
|
+
*/
|
|
5034
5171
|
push_preferences?: ChannelPushPreferencesResponse;
|
|
5035
5172
|
}
|
|
5036
5173
|
|
|
@@ -5451,6 +5588,37 @@ export interface CheckExternalStorageResponse {
|
|
|
5451
5588
|
file_url: string;
|
|
5452
5589
|
}
|
|
5453
5590
|
|
|
5591
|
+
export interface CheckGCPPubSubRequest {
|
|
5592
|
+
/**
|
|
5593
|
+
* Publish the test message with an ordering key through the regional endpoint, as a hook with ordering enabled would; requires gcp_pubsub_region
|
|
5594
|
+
*/
|
|
5595
|
+
gcp_pubsub_event_based_ordering_key_enabled?: boolean;
|
|
5596
|
+
/**
|
|
5597
|
+
* GCP region used for the regional Pub/Sub endpoint when ordering is enabled
|
|
5598
|
+
*/
|
|
5599
|
+
gcp_pubsub_region?: string;
|
|
5600
|
+
/**
|
|
5601
|
+
* Fully qualified GCP Pub/Sub topic name (projects/{project}/topics/{topic})
|
|
5602
|
+
*/
|
|
5603
|
+
gcp_pubsub_topic?: string;
|
|
5604
|
+
}
|
|
5605
|
+
|
|
5606
|
+
export interface CheckGCPPubSubResponse {
|
|
5607
|
+
duration: string;
|
|
5608
|
+
/**
|
|
5609
|
+
* Validation result. One of: ok, error
|
|
5610
|
+
*/
|
|
5611
|
+
status: string;
|
|
5612
|
+
/**
|
|
5613
|
+
* Error text
|
|
5614
|
+
*/
|
|
5615
|
+
error?: string;
|
|
5616
|
+
/**
|
|
5617
|
+
* Error data
|
|
5618
|
+
*/
|
|
5619
|
+
data?: Record<string, any>;
|
|
5620
|
+
}
|
|
5621
|
+
|
|
5454
5622
|
export interface CheckPushRequest {
|
|
5455
5623
|
/**
|
|
5456
5624
|
* Push message template for APN
|
|
@@ -5961,6 +6129,68 @@ export interface CommentDeletedEvent {
|
|
|
5961
6129
|
user?: UserResponseCommonFields;
|
|
5962
6130
|
}
|
|
5963
6131
|
|
|
6132
|
+
export interface CommentFeedbackEvent {
|
|
6133
|
+
/**
|
|
6134
|
+
* Date/time of creation
|
|
6135
|
+
*/
|
|
6136
|
+
created_at: Date;
|
|
6137
|
+
comment_feedback: CommentFeedbackEventPayload;
|
|
6138
|
+
custom: Record<string, any>;
|
|
6139
|
+
/**
|
|
6140
|
+
* The type of event: "feeds.comment.feedback" in this case
|
|
6141
|
+
*/
|
|
6142
|
+
type: string;
|
|
6143
|
+
received_at?: Date;
|
|
6144
|
+
user?: UserResponseCommonFields;
|
|
6145
|
+
}
|
|
6146
|
+
|
|
6147
|
+
export interface CommentFeedbackEventPayload {
|
|
6148
|
+
/**
|
|
6149
|
+
* The comment that received feedback
|
|
6150
|
+
*/
|
|
6151
|
+
comment_id: string;
|
|
6152
|
+
/**
|
|
6153
|
+
* When the feedback was created
|
|
6154
|
+
*/
|
|
6155
|
+
created_at: Date;
|
|
6156
|
+
/**
|
|
6157
|
+
* Whether the comment is hidden for the user
|
|
6158
|
+
*/
|
|
6159
|
+
hide: boolean;
|
|
6160
|
+
/**
|
|
6161
|
+
* When the feedback was last updated
|
|
6162
|
+
*/
|
|
6163
|
+
updated_at: Date;
|
|
6164
|
+
/**
|
|
6165
|
+
* User response object
|
|
6166
|
+
*/
|
|
6167
|
+
user: UserResponse;
|
|
6168
|
+
}
|
|
6169
|
+
|
|
6170
|
+
export interface CommentFeedbackRequest {
|
|
6171
|
+
/**
|
|
6172
|
+
* Whether to hide this comment for the user
|
|
6173
|
+
*/
|
|
6174
|
+
hide?: boolean;
|
|
6175
|
+
user_id?: string;
|
|
6176
|
+
/**
|
|
6177
|
+
* User request object
|
|
6178
|
+
*/
|
|
6179
|
+
user?: UserRequest;
|
|
6180
|
+
}
|
|
6181
|
+
|
|
6182
|
+
export interface CommentFeedbackResponse {
|
|
6183
|
+
/**
|
|
6184
|
+
* The ID of the comment that received feedback
|
|
6185
|
+
*/
|
|
6186
|
+
comment_id: string;
|
|
6187
|
+
duration: string;
|
|
6188
|
+
/**
|
|
6189
|
+
* Whether the comment is hidden for the user
|
|
6190
|
+
*/
|
|
6191
|
+
hide: boolean;
|
|
6192
|
+
}
|
|
6193
|
+
|
|
5964
6194
|
export interface CommentReactionAddedEvent {
|
|
5965
6195
|
/**
|
|
5966
6196
|
* Date/time of creation
|
|
@@ -6030,6 +6260,10 @@ export interface CommentResponse {
|
|
|
6030
6260
|
* Number of downvotes for this comment
|
|
6031
6261
|
*/
|
|
6032
6262
|
downvote_count: number;
|
|
6263
|
+
/**
|
|
6264
|
+
* Only true in QueryComments results filtered with hidden: true
|
|
6265
|
+
*/
|
|
6266
|
+
hidden: boolean;
|
|
6033
6267
|
/**
|
|
6034
6268
|
* Unique identifier for the comment
|
|
6035
6269
|
*/
|
|
@@ -6284,6 +6518,11 @@ export interface ContentCountRuleParameters {
|
|
|
6284
6518
|
time_window?: string;
|
|
6285
6519
|
}
|
|
6286
6520
|
|
|
6521
|
+
export interface ContentCountryCodeParameters {
|
|
6522
|
+
operator?: string;
|
|
6523
|
+
country_codes?: Array<string>;
|
|
6524
|
+
}
|
|
6525
|
+
|
|
6287
6526
|
export interface ContentCustomPropertyCountParameters {
|
|
6288
6527
|
operator?: string;
|
|
6289
6528
|
property_key?: string;
|
|
@@ -6333,7 +6572,7 @@ export interface CreateBlockListRequest {
|
|
|
6333
6572
|
is_substring_matching_enabled?: boolean;
|
|
6334
6573
|
team?: string;
|
|
6335
6574
|
/**
|
|
6336
|
-
* Block list type. One of: regex, domain, domain_allowlist, email, email_allowlist, word
|
|
6575
|
+
* Block list type. One of: regex, domain, domain_allowlist, email, email_allowlist, word, word_allowlist
|
|
6337
6576
|
*/
|
|
6338
6577
|
type?:
|
|
6339
6578
|
| 'regex'
|
|
@@ -6341,7 +6580,8 @@ export interface CreateBlockListRequest {
|
|
|
6341
6580
|
| 'domain_allowlist'
|
|
6342
6581
|
| 'email'
|
|
6343
6582
|
| 'email_allowlist'
|
|
6344
|
-
| 'word'
|
|
6583
|
+
| 'word'
|
|
6584
|
+
| 'word_allowlist';
|
|
6345
6585
|
user_id?: string;
|
|
6346
6586
|
/**
|
|
6347
6587
|
* User request object
|
|
@@ -7034,6 +7274,9 @@ export interface CreatePollRequest {
|
|
|
7034
7274
|
max_votes_allowed?: number;
|
|
7035
7275
|
team?: string;
|
|
7036
7276
|
user_id?: string;
|
|
7277
|
+
/**
|
|
7278
|
+
* Represents the visibility of votes in a poll.
|
|
7279
|
+
*/
|
|
7037
7280
|
voting_visibility?: 'anonymous' | 'public';
|
|
7038
7281
|
options?: Array<PollOptionInput>;
|
|
7039
7282
|
/**
|
|
@@ -7718,7 +7961,7 @@ export interface DeleteFeedsBatchResponse {
|
|
|
7718
7961
|
}
|
|
7719
7962
|
|
|
7720
7963
|
export interface DeleteFeedsRetentionPolicyRequest {
|
|
7721
|
-
policy:
|
|
7964
|
+
policy: string;
|
|
7722
7965
|
}
|
|
7723
7966
|
|
|
7724
7967
|
export interface DeleteFeedsRetentionPolicyResponse {
|
|
@@ -8022,11 +8265,11 @@ export interface DeviceErrorInfo {
|
|
|
8022
8265
|
|
|
8023
8266
|
export interface DeviceResponse {
|
|
8024
8267
|
/**
|
|
8025
|
-
*
|
|
8268
|
+
* The date when the device was created.
|
|
8026
8269
|
*/
|
|
8027
8270
|
created_at: Date;
|
|
8028
8271
|
/**
|
|
8029
|
-
*
|
|
8272
|
+
* The device identifier.
|
|
8030
8273
|
*/
|
|
8031
8274
|
id: string;
|
|
8032
8275
|
/**
|
|
@@ -8401,6 +8644,9 @@ export interface EntityCreatorResponse {
|
|
|
8401
8644
|
name?: string;
|
|
8402
8645
|
revoke_tokens_issued_before?: Date;
|
|
8403
8646
|
devices?: Array<DeviceResponse>;
|
|
8647
|
+
/**
|
|
8648
|
+
* The privacy settings of the user.
|
|
8649
|
+
*/
|
|
8404
8650
|
privacy_settings?: PrivacySettingsResponse;
|
|
8405
8651
|
push_notifications?: PushNotificationSettingsResponse;
|
|
8406
8652
|
teams_role?: Record<string, string>;
|
|
@@ -8437,6 +8683,10 @@ export interface EscalationMetadata {
|
|
|
8437
8683
|
export interface EventHook {
|
|
8438
8684
|
created_at?: Date;
|
|
8439
8685
|
enabled?: boolean;
|
|
8686
|
+
gcp_pubsub_auth_type?: string;
|
|
8687
|
+
gcp_pubsub_event_based_ordering_key_enabled?: boolean;
|
|
8688
|
+
gcp_pubsub_region?: string;
|
|
8689
|
+
gcp_pubsub_topic?: string;
|
|
8440
8690
|
hook_type?: string;
|
|
8441
8691
|
id?: string;
|
|
8442
8692
|
product?: string;
|
|
@@ -9299,6 +9549,11 @@ export interface FeedsNotificationTrigger {
|
|
|
9299
9549
|
custom?: Record<string, any>;
|
|
9300
9550
|
}
|
|
9301
9551
|
|
|
9552
|
+
export interface FeedsPolicyConfig {
|
|
9553
|
+
max_age_hours: number;
|
|
9554
|
+
feed_groups?: Array<string>;
|
|
9555
|
+
}
|
|
9556
|
+
|
|
9302
9557
|
export interface FeedsPreferences {
|
|
9303
9558
|
/**
|
|
9304
9559
|
* Push notification preference for comments on user's activities. One of: all, none
|
|
@@ -9364,6 +9619,13 @@ export interface FeedsReactionResponse {
|
|
|
9364
9619
|
custom?: Record<string, any>;
|
|
9365
9620
|
}
|
|
9366
9621
|
|
|
9622
|
+
export interface FeedsRetentionPolicy {
|
|
9623
|
+
app_pk: number;
|
|
9624
|
+
enabled_at: Date;
|
|
9625
|
+
policy: string;
|
|
9626
|
+
config: FeedsPolicyConfig;
|
|
9627
|
+
}
|
|
9628
|
+
|
|
9367
9629
|
export interface FeedsRetentionRunResponse {
|
|
9368
9630
|
app_pk: number;
|
|
9369
9631
|
date: string;
|
|
@@ -9441,6 +9703,7 @@ export interface FeedsV3CommentResponse {
|
|
|
9441
9703
|
confidence_score: number;
|
|
9442
9704
|
created_at: Date;
|
|
9443
9705
|
downvote_count: number;
|
|
9706
|
+
hidden: boolean;
|
|
9444
9707
|
id: string;
|
|
9445
9708
|
object_id: string;
|
|
9446
9709
|
object_type: string;
|
|
@@ -9515,6 +9778,10 @@ export interface FilterConfigResponse {
|
|
|
9515
9778
|
* 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.
|
|
9516
9779
|
*/
|
|
9517
9780
|
ai_image_labels?: Array<string>;
|
|
9781
|
+
/**
|
|
9782
|
+
* Labels the image OCR pipeline can flag, available as filter values on the `label` field under the ai_image category. The app's LLM labels when LLM configurability is enabled, otherwise the AI text labels. OCR and image-classification labels share the `label` field, so a name present in both matches either.
|
|
9783
|
+
*/
|
|
9784
|
+
ai_image_ocr_labels?: Array<string>;
|
|
9518
9785
|
/**
|
|
9519
9786
|
* AI text moderation labels available as filter values
|
|
9520
9787
|
*/
|
|
@@ -9937,6 +10204,9 @@ export interface FullUserResponse {
|
|
|
9937
10204
|
name?: string;
|
|
9938
10205
|
revoke_tokens_issued_before?: Date;
|
|
9939
10206
|
latest_hidden_channels?: Array<string>;
|
|
10207
|
+
/**
|
|
10208
|
+
* The privacy settings of the user.
|
|
10209
|
+
*/
|
|
9940
10210
|
privacy_settings?: PrivacySettingsResponse;
|
|
9941
10211
|
teams_role?: Record<string, string>;
|
|
9942
10212
|
}
|
|
@@ -10012,6 +10282,9 @@ export interface GetApplicationResponse {
|
|
|
10012
10282
|
* Duration of the request in milliseconds
|
|
10013
10283
|
*/
|
|
10014
10284
|
duration: string;
|
|
10285
|
+
/**
|
|
10286
|
+
* A type representing the app settings.
|
|
10287
|
+
*/
|
|
10015
10288
|
app: AppResponseFields;
|
|
10016
10289
|
}
|
|
10017
10290
|
|
|
@@ -10351,7 +10624,7 @@ export interface GetFeedsRetentionPolicyResponse {
|
|
|
10351
10624
|
*/
|
|
10352
10625
|
duration: string;
|
|
10353
10626
|
enabled: boolean;
|
|
10354
|
-
policies: Array<
|
|
10627
|
+
policies: Array<FeedsRetentionPolicy>;
|
|
10355
10628
|
}
|
|
10356
10629
|
|
|
10357
10630
|
export interface GetFeedsRetentionPolicyRunsRequest {
|
|
@@ -10591,6 +10864,10 @@ export interface GetOrCreateFeedRequest {
|
|
|
10591
10864
|
user_id?: string;
|
|
10592
10865
|
view?: string;
|
|
10593
10866
|
watch?: boolean;
|
|
10867
|
+
/**
|
|
10868
|
+
* Feature-gated; not available for all apps. Request-scoped list of actor/user IDs whose activities are filtered from this GetOrCreateFeed response only. Merged (union) into the viewing user's in-memory blocked authors for this request; never persisted to blocked_users. Max: 1000.
|
|
10869
|
+
*/
|
|
10870
|
+
discard_actors?: Array<string>;
|
|
10594
10871
|
data?: FeedInput;
|
|
10595
10872
|
/**
|
|
10596
10873
|
* Options to skip specific enrichments to improve performance. Default is false (enrichments are included). Setting a field to true skips that enrichment.
|
|
@@ -10610,6 +10887,7 @@ export interface GetOrCreateFeedRequest {
|
|
|
10610
10887
|
* User request object
|
|
10611
10888
|
*/
|
|
10612
10889
|
user?: UserRequest;
|
|
10890
|
+
viewer_location?: Location;
|
|
10613
10891
|
}
|
|
10614
10892
|
|
|
10615
10893
|
export interface GetOrCreateFeedResponse {
|
|
@@ -10627,6 +10905,10 @@ export interface GetOrCreateFeedResponse {
|
|
|
10627
10905
|
feed: FeedResponse;
|
|
10628
10906
|
next?: string;
|
|
10629
10907
|
prev?: string;
|
|
10908
|
+
/**
|
|
10909
|
+
* Activity selectors dropped from this read because they exceeded their time budget (see the time_budget_ms selector setting). Their activities are missing from this page, and they stay out for the rest of this pagination session. Omitted when every selector completed
|
|
10910
|
+
*/
|
|
10911
|
+
degraded_selectors?: Array<string>;
|
|
10630
10912
|
followers_pagination?: PagerResponse;
|
|
10631
10913
|
following_pagination?: PagerResponse;
|
|
10632
10914
|
member_pagination?: PagerResponse;
|
|
@@ -12364,6 +12646,9 @@ export interface MemberUserRequest {
|
|
|
12364
12646
|
role?: string;
|
|
12365
12647
|
teams?: Array<string>;
|
|
12366
12648
|
custom?: Record<string, any>;
|
|
12649
|
+
/**
|
|
12650
|
+
* The privacy settings of the user.
|
|
12651
|
+
*/
|
|
12367
12652
|
privacy_settings?: PrivacySettingsResponse;
|
|
12368
12653
|
teams_role?: Record<string, string>;
|
|
12369
12654
|
}
|
|
@@ -12637,6 +12922,9 @@ export interface MessageModerationResult {
|
|
|
12637
12922
|
* User who moderated the message
|
|
12638
12923
|
*/
|
|
12639
12924
|
moderated_by?: string;
|
|
12925
|
+
/**
|
|
12926
|
+
* Response from AI moderation
|
|
12927
|
+
*/
|
|
12640
12928
|
ai_moderation_response?: ModerationResponse;
|
|
12641
12929
|
/**
|
|
12642
12930
|
* Sets thresholds for AI moderation
|
|
@@ -13744,9 +14032,21 @@ export interface ModerationQueueResponse {
|
|
|
13744
14032
|
}
|
|
13745
14033
|
|
|
13746
14034
|
export interface ModerationResponse {
|
|
14035
|
+
/**
|
|
14036
|
+
* Action taken by automod
|
|
14037
|
+
*/
|
|
13747
14038
|
action: string;
|
|
14039
|
+
/**
|
|
14040
|
+
* Explicit score
|
|
14041
|
+
*/
|
|
13748
14042
|
explicit: number;
|
|
14043
|
+
/**
|
|
14044
|
+
* Spam score
|
|
14045
|
+
*/
|
|
13749
14046
|
spam: number;
|
|
14047
|
+
/**
|
|
14048
|
+
* Toxicity score
|
|
14049
|
+
*/
|
|
13750
14050
|
toxic: number;
|
|
13751
14051
|
}
|
|
13752
14052
|
|
|
@@ -14359,7 +14659,13 @@ export interface OwnUserResponse {
|
|
|
14359
14659
|
revoke_tokens_issued_before?: Date;
|
|
14360
14660
|
blocked_user_ids?: Array<string>;
|
|
14361
14661
|
latest_hidden_channels?: Array<string>;
|
|
14662
|
+
/**
|
|
14663
|
+
* The privacy settings of the user.
|
|
14664
|
+
*/
|
|
14362
14665
|
privacy_settings?: PrivacySettingsResponse;
|
|
14666
|
+
/**
|
|
14667
|
+
* The push preference details.
|
|
14668
|
+
*/
|
|
14363
14669
|
push_preferences?: PushPreferencesResponse;
|
|
14364
14670
|
teams_role?: Record<string, string>;
|
|
14365
14671
|
total_unread_count_by_team?: Record<string, number>;
|
|
@@ -14986,8 +15292,17 @@ export interface PredefinedFilterStatsResponse {
|
|
|
14986
15292
|
}
|
|
14987
15293
|
|
|
14988
15294
|
export interface PrivacySettingsResponse {
|
|
15295
|
+
/**
|
|
15296
|
+
* The settings for the delivery receipt events.
|
|
15297
|
+
*/
|
|
14989
15298
|
delivery_receipts?: DeliveryReceiptsResponse;
|
|
15299
|
+
/**
|
|
15300
|
+
* The settings for the read receipt events.
|
|
15301
|
+
*/
|
|
14990
15302
|
read_receipts?: ReadReceiptsResponse;
|
|
15303
|
+
/**
|
|
15304
|
+
* The settings for typing indicator events.
|
|
15305
|
+
*/
|
|
14991
15306
|
typing_indicators?: TypingIndicatorsResponse;
|
|
14992
15307
|
}
|
|
14993
15308
|
|
|
@@ -15123,7 +15438,13 @@ export interface PushPreferenceInput {
|
|
|
15123
15438
|
|
|
15124
15439
|
export interface PushPreferencesResponse {
|
|
15125
15440
|
call_level?: string;
|
|
15441
|
+
/**
|
|
15442
|
+
* The scope level of the push notifications.
|
|
15443
|
+
*/
|
|
15126
15444
|
chat_level?: string;
|
|
15445
|
+
/**
|
|
15446
|
+
* If provided the notifications will be disabled until the set date.
|
|
15447
|
+
*/
|
|
15127
15448
|
disabled_until?: Date;
|
|
15128
15449
|
feeds_level?: string;
|
|
15129
15450
|
chat_preferences?: ChatPreferencesResponse;
|
|
@@ -15586,6 +15907,48 @@ export interface QueryCallParticipantsResponse {
|
|
|
15586
15907
|
call: CallResponse;
|
|
15587
15908
|
}
|
|
15588
15909
|
|
|
15910
|
+
export interface QueryCallRingAttemptsRequest {
|
|
15911
|
+
/**
|
|
15912
|
+
* Call ID
|
|
15913
|
+
*/
|
|
15914
|
+
id: string;
|
|
15915
|
+
/**
|
|
15916
|
+
* The type of call
|
|
15917
|
+
*/
|
|
15918
|
+
type: string;
|
|
15919
|
+
/**
|
|
15920
|
+
* Limit the attempts to one call session; omit to read every session of the call
|
|
15921
|
+
*/
|
|
15922
|
+
call_session_id?: string;
|
|
15923
|
+
}
|
|
15924
|
+
|
|
15925
|
+
export interface QueryCallRingAttemptsResponse {
|
|
15926
|
+
/**
|
|
15927
|
+
* The ID of the call the attempts belong to
|
|
15928
|
+
*/
|
|
15929
|
+
call_id: string;
|
|
15930
|
+
/**
|
|
15931
|
+
* The type of the call the attempts belong to
|
|
15932
|
+
*/
|
|
15933
|
+
call_type: string;
|
|
15934
|
+
/**
|
|
15935
|
+
* The number of attempts returned
|
|
15936
|
+
*/
|
|
15937
|
+
count: number;
|
|
15938
|
+
/**
|
|
15939
|
+
* Duration of the request in milliseconds
|
|
15940
|
+
*/
|
|
15941
|
+
duration: string;
|
|
15942
|
+
/**
|
|
15943
|
+
* The attempts, newest first
|
|
15944
|
+
*/
|
|
15945
|
+
ring_attempts: Array<RingAttemptResponse>;
|
|
15946
|
+
/**
|
|
15947
|
+
* The call session the attempts were limited to, null when every session was read
|
|
15948
|
+
*/
|
|
15949
|
+
call_session_id?: string;
|
|
15950
|
+
}
|
|
15951
|
+
|
|
15589
15952
|
export interface QueryCallSessionParticipantStatsResponse {
|
|
15590
15953
|
call_id: string;
|
|
15591
15954
|
call_session_id: string;
|
|
@@ -15858,7 +16221,7 @@ export interface QueryCommentsRequest {
|
|
|
15858
16221
|
*/
|
|
15859
16222
|
id_around?: string;
|
|
15860
16223
|
/**
|
|
15861
|
-
* When true, include soft-deleted comments in the result. Server-side only, and requires an object_id filter.
|
|
16224
|
+
* When true, include soft-deleted comments in the result. Server-side only, and requires an object_id filter. Covers comments removed via deleteComment and via soft user-data deletion. Moderation-actioned comments (removed, hidden, shadow_blocked) remain excluded, as are comments whose parent activity is itself deleted.
|
|
15862
16225
|
*/
|
|
15863
16226
|
include_soft_deleted_comments?: boolean;
|
|
15864
16227
|
/**
|
|
@@ -16933,6 +17296,10 @@ export interface RankingConfig {
|
|
|
16933
17296
|
* Type of ranking algorithm. Required. One of: expression, interest
|
|
16934
17297
|
*/
|
|
16935
17298
|
type: 'expression' | 'interest';
|
|
17299
|
+
/**
|
|
17300
|
+
* Activities scoring strictly below this value are dropped from the ranked feed. Not supported on aggregated feeds
|
|
17301
|
+
*/
|
|
17302
|
+
exclude_below?: number;
|
|
16936
17303
|
/**
|
|
16937
17304
|
* Scoring formula. Required when type is 'expression' or 'interest'
|
|
16938
17305
|
*/
|
|
@@ -17832,6 +18199,7 @@ export interface ReviewQueueItemResponse {
|
|
|
17832
18199
|
*/
|
|
17833
18200
|
confidence_score?: number;
|
|
17834
18201
|
config_key?: string;
|
|
18202
|
+
country_code?: string;
|
|
17835
18203
|
/**
|
|
17836
18204
|
* ID of who created the entity
|
|
17837
18205
|
*/
|
|
@@ -17897,6 +18265,69 @@ export interface RevisionHistoryResponse {
|
|
|
17897
18265
|
previous_obj_serialized?: Record<string, any>;
|
|
17898
18266
|
}
|
|
17899
18267
|
|
|
18268
|
+
export interface RingAttemptResponse {
|
|
18269
|
+
/**
|
|
18270
|
+
* The application this ring belongs to
|
|
18271
|
+
*/
|
|
18272
|
+
app_pk: number;
|
|
18273
|
+
/**
|
|
18274
|
+
* The ID of the call that was rung
|
|
18275
|
+
*/
|
|
18276
|
+
call_id: string;
|
|
18277
|
+
/**
|
|
18278
|
+
* The type of the call that was rung
|
|
18279
|
+
*/
|
|
18280
|
+
call_type: string;
|
|
18281
|
+
/**
|
|
18282
|
+
* When the ring went out
|
|
18283
|
+
*/
|
|
18284
|
+
created_at: Date;
|
|
18285
|
+
/**
|
|
18286
|
+
* When the ring expires, i.e. when the missed call deadline fires
|
|
18287
|
+
*/
|
|
18288
|
+
expires_at: Date;
|
|
18289
|
+
/**
|
|
18290
|
+
* The user that started the ring
|
|
18291
|
+
*/
|
|
18292
|
+
initiated_by: string;
|
|
18293
|
+
/**
|
|
18294
|
+
* The derived outcome: ringing, answered_some, answered_all, rejected_all, missed_all, cancelled or mixed
|
|
18295
|
+
*/
|
|
18296
|
+
outcome: string;
|
|
18297
|
+
/**
|
|
18298
|
+
* The ring, as published in the ring_id of the call.ring event
|
|
18299
|
+
*/
|
|
18300
|
+
ring_id: string;
|
|
18301
|
+
/**
|
|
18302
|
+
* The call session that was rung
|
|
18303
|
+
*/
|
|
18304
|
+
session_id: string;
|
|
18305
|
+
/**
|
|
18306
|
+
* Why the ring settled: answered, rejected, cancel, timeout, ended or auto_end; empty while it is still ringing
|
|
18307
|
+
*/
|
|
18308
|
+
settle_reason: string;
|
|
18309
|
+
/**
|
|
18310
|
+
* The user that settled the ring, or 'server'; empty while it is still ringing
|
|
18311
|
+
*/
|
|
18312
|
+
settled_by: string;
|
|
18313
|
+
/**
|
|
18314
|
+
* Opaque context stored on the ring by the caller
|
|
18315
|
+
*/
|
|
18316
|
+
custom: Record<string, any>;
|
|
18317
|
+
/**
|
|
18318
|
+
* The rung users, keyed by user ID
|
|
18319
|
+
*/
|
|
18320
|
+
targets: Record<string, RingTargetResponse>;
|
|
18321
|
+
/**
|
|
18322
|
+
* When the ring was deleted
|
|
18323
|
+
*/
|
|
18324
|
+
deleted_at?: Date;
|
|
18325
|
+
/**
|
|
18326
|
+
* When the outcome left ringing
|
|
18327
|
+
*/
|
|
18328
|
+
settled_at?: Date;
|
|
18329
|
+
}
|
|
18330
|
+
|
|
17900
18331
|
export interface RingCallRequest {
|
|
17901
18332
|
/**
|
|
17902
18333
|
* Indicate if call should be video
|
|
@@ -17924,6 +18355,37 @@ export interface RingCallResponse {
|
|
|
17924
18355
|
ring_id?: string;
|
|
17925
18356
|
}
|
|
17926
18357
|
|
|
18358
|
+
export interface RingDeliveryResponse {
|
|
18359
|
+
/**
|
|
18360
|
+
* The transport the ring was dispatched over: ws, apns_voip, apns or fcm
|
|
18361
|
+
*/
|
|
18362
|
+
channel: string;
|
|
18363
|
+
/**
|
|
18364
|
+
* When the ring was dispatched
|
|
18365
|
+
*/
|
|
18366
|
+
sent_at: Date;
|
|
18367
|
+
/**
|
|
18368
|
+
* When the device acknowledged the ring; not populated yet
|
|
18369
|
+
*/
|
|
18370
|
+
acked_at?: Date;
|
|
18371
|
+
/**
|
|
18372
|
+
* The device the ring was dispatched to, empty for websocket deliveries which fan out to every connection
|
|
18373
|
+
*/
|
|
18374
|
+
device_id?: string;
|
|
18375
|
+
/**
|
|
18376
|
+
* When the device displayed the ring; not populated yet
|
|
18377
|
+
*/
|
|
18378
|
+
displayed_at?: Date;
|
|
18379
|
+
/**
|
|
18380
|
+
* When the device fetched the call; not populated yet
|
|
18381
|
+
*/
|
|
18382
|
+
fetched_at?: Date;
|
|
18383
|
+
/**
|
|
18384
|
+
* When the push provider accepted the dispatch; not populated yet
|
|
18385
|
+
*/
|
|
18386
|
+
provider_accepted_at?: Date;
|
|
18387
|
+
}
|
|
18388
|
+
|
|
17927
18389
|
export interface RingSettings {
|
|
17928
18390
|
auto_cancel_timeout_ms: number;
|
|
17929
18391
|
incoming_call_timeout_ms: number;
|
|
@@ -17951,6 +18413,31 @@ export interface RingSettingsResponse {
|
|
|
17951
18413
|
missed_call_timeout_ms: number;
|
|
17952
18414
|
}
|
|
17953
18415
|
|
|
18416
|
+
export interface RingSettledTarget {
|
|
18417
|
+
state: string;
|
|
18418
|
+
state_at: Date;
|
|
18419
|
+
reason?: string;
|
|
18420
|
+
}
|
|
18421
|
+
|
|
18422
|
+
export interface RingTargetResponse {
|
|
18423
|
+
/**
|
|
18424
|
+
* The reject or cancel reason, empty otherwise
|
|
18425
|
+
*/
|
|
18426
|
+
reason: string;
|
|
18427
|
+
/**
|
|
18428
|
+
* The target's state for this ring: pending, accepted, rejected, missed or cancelled
|
|
18429
|
+
*/
|
|
18430
|
+
state: string;
|
|
18431
|
+
/**
|
|
18432
|
+
* When the target last changed state
|
|
18433
|
+
*/
|
|
18434
|
+
state_at: Date;
|
|
18435
|
+
/**
|
|
18436
|
+
* The dispatches of this ring to the target's devices
|
|
18437
|
+
*/
|
|
18438
|
+
deliveries: Array<RingDeliveryResponse>;
|
|
18439
|
+
}
|
|
18440
|
+
|
|
17954
18441
|
export interface Role {
|
|
17955
18442
|
/**
|
|
17956
18443
|
* Date/time of creation
|
|
@@ -18009,6 +18496,7 @@ export interface RuleBuilderCondition {
|
|
|
18009
18496
|
channel_message_count_rule_params?: ChannelMessageCountRuleParameters;
|
|
18010
18497
|
closed_caption_rule_params?: ClosedCaptionRuleParameters;
|
|
18011
18498
|
content_count_rule_params?: ContentCountRuleParameters;
|
|
18499
|
+
content_country_code_params?: ContentCountryCodeParameters;
|
|
18012
18500
|
content_custom_property_count_params?: ContentCustomPropertyCountParameters;
|
|
18013
18501
|
content_custom_property_params?: ContentCustomPropertyParameters;
|
|
18014
18502
|
content_flag_count_rule_params?: FlagCountRuleParameters;
|
|
@@ -18817,8 +19305,9 @@ export interface SessionWarningResponse {
|
|
|
18817
19305
|
|
|
18818
19306
|
export interface SetFeedsRetentionPolicyRequest {
|
|
18819
19307
|
max_age_hours: number;
|
|
18820
|
-
policy:
|
|
19308
|
+
policy: string;
|
|
18821
19309
|
enabled?: boolean;
|
|
19310
|
+
feed_groups?: Array<string>;
|
|
18822
19311
|
}
|
|
18823
19312
|
|
|
18824
19313
|
export interface SetFeedsRetentionPolicyResponse {
|
|
@@ -18827,7 +19316,7 @@ export interface SetFeedsRetentionPolicyResponse {
|
|
|
18827
19316
|
*/
|
|
18828
19317
|
duration: string;
|
|
18829
19318
|
enabled: boolean;
|
|
18830
|
-
policy:
|
|
19319
|
+
policy: FeedsRetentionPolicy;
|
|
18831
19320
|
}
|
|
18832
19321
|
|
|
18833
19322
|
export interface SetRetentionPolicyRequest {
|
|
@@ -18930,14 +19419,42 @@ export interface SharedLocationResponse {
|
|
|
18930
19419
|
}
|
|
18931
19420
|
|
|
18932
19421
|
export interface SharedLocationResponseData {
|
|
19422
|
+
/**
|
|
19423
|
+
* The CID (type:id) of the channel that the location is attached to.
|
|
19424
|
+
*/
|
|
18933
19425
|
channel_cid: string;
|
|
19426
|
+
/**
|
|
19427
|
+
* The date when the location was created.
|
|
19428
|
+
*/
|
|
18934
19429
|
created_at: Date;
|
|
19430
|
+
/**
|
|
19431
|
+
* The ID of the device that created the location.
|
|
19432
|
+
*/
|
|
18935
19433
|
created_by_device_id: string;
|
|
19434
|
+
/**
|
|
19435
|
+
* The latitude of the location.
|
|
19436
|
+
*/
|
|
18936
19437
|
latitude: number;
|
|
19438
|
+
/**
|
|
19439
|
+
* The longitude of the location.
|
|
19440
|
+
*/
|
|
18937
19441
|
longitude: number;
|
|
19442
|
+
/**
|
|
19443
|
+
* The ID of the message that the location is attached to.
|
|
19444
|
+
*/
|
|
18938
19445
|
message_id: string;
|
|
19446
|
+
/**
|
|
19447
|
+
* The date when the location was updated.
|
|
19448
|
+
*/
|
|
18939
19449
|
updated_at: Date;
|
|
19450
|
+
/**
|
|
19451
|
+
* The ID of the user that created the location.
|
|
19452
|
+
*/
|
|
18940
19453
|
user_id: string;
|
|
19454
|
+
/**
|
|
19455
|
+
* The date when the location sharing ends.
|
|
19456
|
+
* If it's empty, it means the location sharing is static instead of live.
|
|
19457
|
+
*/
|
|
18941
19458
|
end_at?: Date;
|
|
18942
19459
|
/**
|
|
18943
19460
|
* Represents channel in chat
|
|
@@ -19829,6 +20346,7 @@ export interface ThreadedCommentResponse {
|
|
|
19829
20346
|
confidence_score: number;
|
|
19830
20347
|
created_at: Date;
|
|
19831
20348
|
downvote_count: number;
|
|
20349
|
+
hidden: boolean;
|
|
19832
20350
|
id: string;
|
|
19833
20351
|
object_id: string;
|
|
19834
20352
|
object_type: string;
|
|
@@ -20512,14 +21030,32 @@ export interface UnreadCountsBatchResponse {
|
|
|
20512
21030
|
}
|
|
20513
21031
|
|
|
20514
21032
|
export interface UnreadCountsChannel {
|
|
21033
|
+
/**
|
|
21034
|
+
* The channel CID (type:id).
|
|
21035
|
+
*/
|
|
20515
21036
|
channel_id: string;
|
|
21037
|
+
/**
|
|
21038
|
+
* The date which the current user last read the channel.
|
|
21039
|
+
*/
|
|
20516
21040
|
last_read: Date;
|
|
21041
|
+
/**
|
|
21042
|
+
* The number of unread messages inside the channel.
|
|
21043
|
+
*/
|
|
20517
21044
|
unread_count: number;
|
|
20518
21045
|
}
|
|
20519
21046
|
|
|
20520
21047
|
export interface UnreadCountsChannelType {
|
|
21048
|
+
/**
|
|
21049
|
+
* The number of unread channels of this channel type.
|
|
21050
|
+
*/
|
|
20521
21051
|
channel_count: number;
|
|
21052
|
+
/**
|
|
21053
|
+
* The channel type.
|
|
21054
|
+
*/
|
|
20522
21055
|
channel_type: string;
|
|
21056
|
+
/**
|
|
21057
|
+
* The number of unread messages of all the channels with this type.
|
|
21058
|
+
*/
|
|
20523
21059
|
unread_count: number;
|
|
20524
21060
|
}
|
|
20525
21061
|
|
|
@@ -20533,9 +21069,21 @@ export interface UnreadCountsResponse {
|
|
|
20533
21069
|
}
|
|
20534
21070
|
|
|
20535
21071
|
export interface UnreadCountsThread {
|
|
21072
|
+
/**
|
|
21073
|
+
* The date which the current user last read the thread.
|
|
21074
|
+
*/
|
|
20536
21075
|
last_read: Date;
|
|
21076
|
+
/**
|
|
21077
|
+
* The id of the last reply which the current user read in the thread.
|
|
21078
|
+
*/
|
|
20537
21079
|
last_read_message_id: string;
|
|
21080
|
+
/**
|
|
21081
|
+
* The message id of the root of the thread.
|
|
21082
|
+
*/
|
|
20538
21083
|
parent_message_id: string;
|
|
21084
|
+
/**
|
|
21085
|
+
* The number of unread replies inside the thread.
|
|
21086
|
+
*/
|
|
20539
21087
|
unread_count: number;
|
|
20540
21088
|
}
|
|
20541
21089
|
|
|
@@ -22905,6 +23453,9 @@ export interface UserRequest {
|
|
|
22905
23453
|
* Custom user data
|
|
22906
23454
|
*/
|
|
22907
23455
|
custom?: Record<string, any>;
|
|
23456
|
+
/**
|
|
23457
|
+
* The privacy settings of the user.
|
|
23458
|
+
*/
|
|
22908
23459
|
privacy_settings?: PrivacySettingsResponse;
|
|
22909
23460
|
/**
|
|
22910
23461
|
* Map of team-specific roles for the user
|
|
@@ -22986,6 +23537,9 @@ export interface UserResponse {
|
|
|
22986
23537
|
* List of devices user is using
|
|
22987
23538
|
*/
|
|
22988
23539
|
devices?: Array<DeviceResponse>;
|
|
23540
|
+
/**
|
|
23541
|
+
* The privacy settings of the user.
|
|
23542
|
+
*/
|
|
22989
23543
|
privacy_settings?: PrivacySettingsResponse;
|
|
22990
23544
|
push_notifications?: PushNotificationSettingsResponse;
|
|
22991
23545
|
teams_role?: Record<string, string>;
|
|
@@ -23031,6 +23585,9 @@ export interface UserResponsePrivacyFields {
|
|
|
23031
23585
|
last_active?: Date;
|
|
23032
23586
|
name?: string;
|
|
23033
23587
|
revoke_tokens_issued_before?: Date;
|
|
23588
|
+
/**
|
|
23589
|
+
* The privacy settings of the user.
|
|
23590
|
+
*/
|
|
23034
23591
|
privacy_settings?: PrivacySettingsResponse;
|
|
23035
23592
|
teams_role?: Record<string, string>;
|
|
23036
23593
|
}
|
|
@@ -23294,6 +23851,7 @@ export type WHEvent =
|
|
|
23294
23851
|
| ({ type: 'call.recording_stopped' } & CallRecordingStoppedEvent)
|
|
23295
23852
|
| ({ type: 'call.rejected' } & CallRejectedEvent)
|
|
23296
23853
|
| ({ type: 'call.ring' } & CallRingEvent)
|
|
23854
|
+
| ({ type: 'call.ring_settled' } & CallRingSettledEvent)
|
|
23297
23855
|
| ({ type: 'call.rtmp_broadcast_failed' } & CallRtmpBroadcastFailedEvent)
|
|
23298
23856
|
| ({ type: 'call.rtmp_broadcast_started' } & CallRtmpBroadcastStartedEvent)
|
|
23299
23857
|
| ({ type: 'call.rtmp_broadcast_stopped' } & CallRtmpBroadcastStoppedEvent)
|
|
@@ -23339,6 +23897,8 @@ export type WHEvent =
|
|
|
23339
23897
|
} & AsyncBulkImageModerationEvent)
|
|
23340
23898
|
| ({ type: 'export.channels.error' } & AsyncExportErrorEvent)
|
|
23341
23899
|
| ({ type: 'export.channels.success' } & AsyncExportChannelsEvent)
|
|
23900
|
+
| ({ type: 'export.label_results.error' } & AsyncExportErrorEvent)
|
|
23901
|
+
| ({ type: 'export.label_results.success' } & AsyncExportLabelResultsEvent)
|
|
23342
23902
|
| ({ type: 'export.moderation_logs.error' } & AsyncExportErrorEvent)
|
|
23343
23903
|
| ({
|
|
23344
23904
|
type: 'export.moderation_logs.success';
|
|
@@ -23368,6 +23928,7 @@ export type WHEvent =
|
|
|
23368
23928
|
| ({ type: 'feeds.bookmark_folder.updated' } & BookmarkFolderUpdatedEvent)
|
|
23369
23929
|
| ({ type: 'feeds.comment.added' } & CommentAddedEvent)
|
|
23370
23930
|
| ({ type: 'feeds.comment.deleted' } & CommentDeletedEvent)
|
|
23931
|
+
| ({ type: 'feeds.comment.feedback' } & CommentFeedbackEvent)
|
|
23371
23932
|
| ({ type: 'feeds.comment.reaction.added' } & CommentReactionAddedEvent)
|
|
23372
23933
|
| ({ type: 'feeds.comment.reaction.deleted' } & CommentReactionDeletedEvent)
|
|
23373
23934
|
| ({ type: 'feeds.comment.reaction.updated' } & CommentReactionUpdatedEvent)
|
|
@@ -23388,6 +23949,8 @@ export type WHEvent =
|
|
|
23388
23949
|
| ({ type: 'feeds.notification_feed.updated' } & NotificationFeedUpdatedEvent)
|
|
23389
23950
|
| ({ type: 'feeds.stories_feed.updated' } & StoriesFeedUpdatedEvent)
|
|
23390
23951
|
| ({ type: 'flag.updated' } & FlagUpdatedEvent)
|
|
23952
|
+
| ({ type: 'import.error' } & AsyncImportErrorEvent)
|
|
23953
|
+
| ({ type: 'import.success' } & AsyncImportSuccessEvent)
|
|
23391
23954
|
| ({ type: 'ingress.error' } & IngressErrorEvent)
|
|
23392
23955
|
| ({ type: 'ingress.started' } & IngressStartedEvent)
|
|
23393
23956
|
| ({ type: 'ingress.stopped' } & IngressStoppedEvent)
|
|
@@ -23469,6 +24032,9 @@ export interface WSEvent {
|
|
|
23469
24032
|
thread_id?: string;
|
|
23470
24033
|
user_id?: string;
|
|
23471
24034
|
watcher_count?: number;
|
|
24035
|
+
/**
|
|
24036
|
+
* Response from AI moderation
|
|
24037
|
+
*/
|
|
23472
24038
|
automoderation_scores?: ModerationResponse;
|
|
23473
24039
|
/**
|
|
23474
24040
|
* Represents channel in chat
|
|
@@ -23513,11 +24079,29 @@ export interface WrappedUnreadCountsResponse {
|
|
|
23513
24079
|
* Duration of the request in milliseconds
|
|
23514
24080
|
*/
|
|
23515
24081
|
duration: string;
|
|
24082
|
+
/**
|
|
24083
|
+
* The total number of unread messages.
|
|
24084
|
+
*/
|
|
23516
24085
|
total_unread_count: number;
|
|
24086
|
+
/**
|
|
24087
|
+
* The total number of unread threads.
|
|
24088
|
+
*/
|
|
23517
24089
|
total_unread_threads_count: number;
|
|
24090
|
+
/**
|
|
24091
|
+
* The unread information per channel type.
|
|
24092
|
+
*/
|
|
23518
24093
|
channel_type: Array<UnreadCountsChannelType>;
|
|
24094
|
+
/**
|
|
24095
|
+
* The unread information per channel.
|
|
24096
|
+
*/
|
|
23519
24097
|
channels: Array<UnreadCountsChannel>;
|
|
24098
|
+
/**
|
|
24099
|
+
* The unread information per thread.
|
|
24100
|
+
*/
|
|
23520
24101
|
threads: Array<UnreadCountsThread>;
|
|
24102
|
+
/**
|
|
24103
|
+
* The total number of unread messages grouped by team.
|
|
24104
|
+
*/
|
|
23521
24105
|
total_unread_count_by_team?: Record<string, number>;
|
|
23522
24106
|
}
|
|
23523
24107
|
|