stream-chat 4.4.3-dev.2 → 5.0.0

package/dist/types/types.d.ts

@@ -21,7 +21,8 @@ export declare type RequireAtLeastOne<T> = {
 export declare type RequireOnlyOne<T, Keys extends keyof T = keyof T> = Pick<T, Exclude<keyof T, Keys>> & {
     [K in Keys]-?: Required<Pick<T, K>> & Partial<Record<Exclude<Keys, K>, undefined>>;
 }[Keys];
-export declare type UnknownType = Record<string, unknown>;
+export declare type UR = Record<string, unknown>;
+export declare type UnknownType = UR;
 export declare type Unpacked<T> = T extends (infer U)[] ? U : T extends (...args: any[]) => infer U ? U : T extends Promise<infer U> ? U : T;
 /**
  * Response Types
@@ -100,7 +101,7 @@ export declare type ModerationResult = {
     blocklist_name?: string;
     moderated_by?: string;
 };
-export declare type MessageFlagsResponse<ChannelType extends UnknownType = UnknownType, CommandType extends string = LiteralStringForUnion, UserType extends UnknownType = UnknownType, AttachmentType = UnknownType, MessageType = UnknownType, ReactionType = UnknownType> = APIResponse & {
+export declare type MessageFlagsResponse<ChannelType extends UR = UR, CommandType extends string = LiteralStringForUnion, UserType extends UR = UR, AttachmentType = UR, MessageType = UR, ReactionType = UR> = APIResponse & {
     flags?: Array<{
         message: MessageResponse<AttachmentType, ChannelType, CommandType, MessageType, ReactionType, UserType>;
         user: UserResponse<UserType>;
@@ -114,7 +115,7 @@ export declare type MessageFlagsResponse<ChannelType extends UnknownType = Unkno
         updated_at?: string;
     }>;
 };
-export declare type BannedUsersResponse<ChannelType extends UnknownType = UnknownType, CommandType extends string = LiteralStringForUnion, UserType extends UnknownType = UnknownType> = APIResponse & {
+export declare type BannedUsersResponse<ChannelType extends UR = UR, CommandType extends string = LiteralStringForUnion, UserType extends UR = UR> = APIResponse & {
     bans?: Array<{
         user: UserResponse<UserType>;
         banned_by?: UserResponse<UserType>;
@@ -129,7 +130,7 @@ export declare type BlockListResponse = BlockList & {
     created_at?: string;
     updated_at?: string;
 };
-export declare type ChannelResponse<ChannelType = UnknownType, CommandType extends string = LiteralStringForUnion, UserType = UnknownType> = ChannelType & {
+export declare type ChannelResponse<ChannelType = UR, CommandType extends string = LiteralStringForUnion, UserType = UR> = ChannelType & {
     cid: string;
     disabled: boolean;
     frozen: boolean;
@@ -152,9 +153,10 @@ export declare type ChannelResponse<ChannelType = UnknownType, CommandType exten
     name?: string;
     own_capabilities?: string[];
     team?: string;
+    truncated_at?: string;
     updated_at?: string;
 };
-export declare type ChannelAPIResponse<AttachmentType = UnknownType, ChannelType = UnknownType, CommandType extends string = LiteralStringForUnion, MessageType = UnknownType, ReactionType = UnknownType, UserType = UnknownType> = APIResponse & {
+export declare type ChannelAPIResponse<AttachmentType = UR, ChannelType = UR, CommandType extends string = LiteralStringForUnion, MessageType = UR, ReactionType = UR, UserType = UR> = APIResponse & {
     channel: ChannelResponse<ChannelType, CommandType, UserType>;
     members: ChannelMemberResponse<UserType>[];
     messages: MessageResponse<AttachmentType, ChannelType, CommandType, MessageType, ReactionType, UserType>[];
@@ -165,10 +167,14 @@ export declare type ChannelAPIResponse<AttachmentType = UnknownType, ChannelType
     watcher_count?: number;
     watchers?: UserResponse<UserType>[];
 };
-export declare type ChannelMemberAPIResponse<UserType = UnknownType> = APIResponse & {
+export declare type ChannelUpdateOptions = {
+    hide_history?: boolean;
+    skip_push?: boolean;
+};
+export declare type ChannelMemberAPIResponse<UserType = UR> = APIResponse & {
     members: ChannelMemberResponse<UserType>[];
 };
-export declare type ChannelMemberResponse<UserType = UnknownType> = {
+export declare type ChannelMemberResponse<UserType = UR> = {
     banned?: boolean;
     channel_role?: Role;
     created_at?: string;
@@ -203,7 +209,7 @@ export declare type CommandResponse<CommandType extends string = LiteralStringFo
     name?: CommandVariants<CommandType>;
     set?: CommandVariants<CommandType>;
 };
-export declare type ConnectAPIResponse<ChannelType extends UnknownType = UnknownType, CommandType extends string = LiteralStringForUnion, UserType extends UnknownType = UnknownType> = Promise<void | ConnectionOpen<ChannelType, CommandType, UserType>>;
+export declare type ConnectAPIResponse<ChannelType extends UR = UR, CommandType extends string = LiteralStringForUnion, UserType extends UR = UR> = Promise<void | ConnectionOpen<ChannelType, CommandType, UserType>>;
 export declare type CreateChannelResponse<CommandType extends string = LiteralStringForUnion> = APIResponse & Omit<CreateChannelOptions<CommandType>, 'client_id' | 'connection_id'> & {
     created_at: string;
     updated_at: string;
@@ -212,13 +218,13 @@ export declare type CreateChannelResponse<CommandType extends string = LiteralSt
 export declare type CreateCommandResponse<CommandType extends string = LiteralStringForUnion> = APIResponse & {
     command: CreateCommandOptions<CommandType> & CreatedAtUpdatedAt;
 };
-export declare type DeleteChannelAPIResponse<ChannelType = UnknownType, CommandType extends string = LiteralStringForUnion, UserType = UnknownType> = APIResponse & {
+export declare type DeleteChannelAPIResponse<ChannelType = UR, CommandType extends string = LiteralStringForUnion, UserType = UR> = APIResponse & {
     channel: ChannelResponse<ChannelType, CommandType, UserType>;
 };
 export declare type DeleteCommandResponse<CommandType extends string = LiteralStringForUnion> = APIResponse & {
     name?: CommandVariants<CommandType>;
 };
-export declare type EventAPIResponse<AttachmentType extends UnknownType = UnknownType, ChannelType extends UnknownType = UnknownType, CommandType extends string = LiteralStringForUnion, EventType extends UnknownType = UnknownType, MessageType extends UnknownType = UnknownType, ReactionType extends UnknownType = UnknownType, UserType extends UnknownType = UnknownType> = APIResponse & {
+export declare type EventAPIResponse<AttachmentType extends UR = UR, ChannelType extends UR = UR, CommandType extends string = LiteralStringForUnion, EventType extends UR = UR, MessageType extends UR = UR, ReactionType extends UR = UR, UserType extends UR = UR> = APIResponse & {
     event: Event<AttachmentType, ChannelType, CommandType, EventType, MessageType, ReactionType, UserType>;
 };
 export declare type ExportChannelResponse = {
@@ -230,7 +236,7 @@ export declare type ExportChannelStatusResponse = {
     result?: {};
     updated_at?: string;
 };
-export declare type FlagMessageResponse<UserType = UnknownType> = APIResponse & {
+export declare type FlagMessageResponse<UserType = UR> = APIResponse & {
     flag: {
         created_at: string;
         created_by_automod: boolean;
@@ -243,7 +249,7 @@ export declare type FlagMessageResponse<UserType = UnknownType> = APIResponse &
         reviewed_by?: string;
     };
 };
-export declare type FlagUserResponse<UserType = UnknownType> = APIResponse & {
+export declare type FlagUserResponse<UserType = UR> = APIResponse & {
     flag: {
         created_at: string;
         created_by_automod: boolean;
@@ -256,7 +262,7 @@ export declare type FlagUserResponse<UserType = UnknownType> = APIResponse & {
         reviewed_by?: string;
     };
 };
-export declare type FormatMessageResponse<AttachmentType = UnknownType, ChannelType = UnknownType, CommandType extends string = LiteralStringForUnion, MessageType = UnknownType, ReactionType = UnknownType, UserType = UnknownType> = Omit<MessageResponse<AttachmentType, ChannelType, CommandType, {}, ReactionType, UserType>, 'created_at' | 'pinned_at' | 'updated_at' | 'status'> & MessageType & {
+export declare type FormatMessageResponse<AttachmentType = UR, ChannelType = UR, CommandType extends string = LiteralStringForUnion, MessageType = UR, ReactionType = UR, UserType = UR> = Omit<MessageResponse<AttachmentType, ChannelType, CommandType, {}, ReactionType, UserType>, 'created_at' | 'pinned_at' | 'updated_at' | 'status'> & MessageType & {
     created_at: Date;
     pinned_at: Date | null;
     status: string;
@@ -269,7 +275,7 @@ export declare type GetChannelTypeResponse<CommandType extends string = LiteralS
     grants?: Record<string, string[]>;
 };
 export declare type GetCommandResponse<CommandType extends string = LiteralStringForUnion> = APIResponse & CreateCommandOptions<CommandType> & CreatedAtUpdatedAt;
-export declare type GetMultipleMessagesAPIResponse<AttachmentType = UnknownType, ChannelType = UnknownType, CommandType extends string = LiteralStringForUnion, MessageType = UnknownType, ReactionType = UnknownType, UserType = UnknownType> = APIResponse & {
+export declare type GetMultipleMessagesAPIResponse<AttachmentType = UR, ChannelType = UR, CommandType extends string = LiteralStringForUnion, MessageType = UR, ReactionType = UR, UserType = UR> = APIResponse & {
     messages: MessageResponse<AttachmentType, ChannelType, CommandType, MessageType, ReactionType, UserType>[];
 };
 export declare type GetRateLimitsResponse = APIResponse & {
@@ -278,10 +284,10 @@ export declare type GetRateLimitsResponse = APIResponse & {
     server_side?: RateLimitsMap;
     web?: RateLimitsMap;
 };
-export declare type GetReactionsAPIResponse<ReactionType = UnknownType, UserType = UnknownType> = APIResponse & {
+export declare type GetReactionsAPIResponse<ReactionType = UR, UserType = UR> = APIResponse & {
     reactions: ReactionResponse<ReactionType, UserType>[];
 };
-export declare type GetRepliesAPIResponse<AttachmentType = UnknownType, ChannelType = UnknownType, CommandType extends string = LiteralStringForUnion, MessageType = UnknownType, ReactionType = UnknownType, UserType = UnknownType> = APIResponse & {
+export declare type GetRepliesAPIResponse<AttachmentType = UR, ChannelType = UR, CommandType extends string = LiteralStringForUnion, MessageType = UR, ReactionType = UR, UserType = UR> = APIResponse & {
     messages: MessageResponse<AttachmentType, ChannelType, CommandType, MessageType, ReactionType, UserType>[];
 };
 export declare type ListChannelResponse<CommandType extends string = LiteralStringForUnion> = APIResponse & {
@@ -296,16 +302,16 @@ export declare type ListChannelTypesAPIResponse<CommandType extends string = Lit
 export declare type ListCommandsResponse<CommandType extends string = LiteralStringForUnion> = APIResponse & {
     commands: Array<CreateCommandOptions<CommandType> & CreatedAtUpdatedAt>;
 };
-export declare type MuteChannelAPIResponse<ChannelType extends UnknownType = UnknownType, CommandType extends string = LiteralStringForUnion, UserType extends UnknownType = UnknownType> = APIResponse & {
+export declare type MuteChannelAPIResponse<ChannelType extends UR = UR, CommandType extends string = LiteralStringForUnion, UserType extends UR = UR> = APIResponse & {
     channel_mute: ChannelMute<ChannelType, CommandType, UserType>;
     own_user: OwnUserResponse<ChannelType, CommandType, UserType>;
     channel_mutes?: ChannelMute<ChannelType, CommandType, UserType>[];
     mute?: MuteResponse<UserType>;
 };
-export declare type MessageResponse<AttachmentType = UnknownType, ChannelType = UnknownType, CommandType extends string = LiteralStringForUnion, MessageType = UnknownType, ReactionType = UnknownType, UserType = UnknownType> = MessageResponseBase<AttachmentType, ChannelType, CommandType, MessageType, ReactionType, UserType> & {
+export declare type MessageResponse<AttachmentType = UR, ChannelType = UR, CommandType extends string = LiteralStringForUnion, MessageType = UR, ReactionType = UR, UserType = UR> = MessageResponseBase<AttachmentType, ChannelType, CommandType, MessageType, ReactionType, UserType> & {
     quoted_message?: MessageResponseBase<AttachmentType, ChannelType, CommandType, MessageType, ReactionType, UserType>;
 };
-export declare type MessageResponseBase<AttachmentType = UnknownType, ChannelType = UnknownType, CommandType extends string = LiteralStringForUnion, MessageType = UnknownType, ReactionType = UnknownType, UserType = UnknownType> = MessageBase<AttachmentType, MessageType, UserType> & {
+export declare type MessageResponseBase<AttachmentType = UR, ChannelType = UR, CommandType extends string = LiteralStringForUnion, MessageType = UR, ReactionType = UR, UserType = UR> = MessageBase<AttachmentType, MessageType, UserType> & {
     args?: string;
     channel?: ChannelResponse<ChannelType, CommandType, UserType>;
     cid?: string;
@@ -338,19 +344,19 @@ export declare type MessageResponseBase<AttachmentType = UnknownType, ChannelTyp
     type?: MessageLabel;
     updated_at?: string;
 };
-export declare type MuteResponse<UserType = UnknownType> = {
+export declare type MuteResponse<UserType = UR> = {
     user: UserResponse<UserType>;
     created_at?: string;
     expires?: string;
     target?: UserResponse<UserType>;
     updated_at?: string;
 };
-export declare type MuteUserResponse<ChannelType extends UnknownType = UnknownType, CommandType extends string = LiteralStringForUnion, UserType extends UnknownType = UnknownType> = APIResponse & {
+export declare type MuteUserResponse<ChannelType extends UR = UR, CommandType extends string = LiteralStringForUnion, UserType extends UR = UR> = APIResponse & {
     mute?: MuteResponse<UserType>;
     mutes?: Array<Mute<UserType>>;
     own_user?: OwnUserResponse<ChannelType, CommandType, UserType>;
 };
-export declare type OwnUserBase<ChannelType extends UnknownType = UnknownType, CommandType extends string = LiteralStringForUnion, UserType extends UnknownType = UnknownType> = {
+export declare type OwnUserBase<ChannelType extends UR = UR, CommandType extends string = LiteralStringForUnion, UserType extends UR = UR> = {
     channel_mutes: ChannelMute<ChannelType, CommandType, UserType>[];
     devices: Device<UserType>[];
     mutes: Mute<UserType>[];
@@ -360,8 +366,8 @@ export declare type OwnUserBase<ChannelType extends UnknownType = UnknownType, C
     invisible?: boolean;
     roles?: string[];
 };
-export declare type OwnUserResponse<ChannelType extends UnknownType = UnknownType, CommandType extends string = LiteralStringForUnion, UserType extends UnknownType = UnknownType> = UserResponse<UserType> & OwnUserBase<ChannelType, CommandType, UserType>;
-export declare type PartialUpdateChannelAPIResponse<ChannelType = UnknownType, CommandType extends string = LiteralStringForUnion, UserType = UnknownType> = APIResponse & {
+export declare type OwnUserResponse<ChannelType extends UR = UR, CommandType extends string = LiteralStringForUnion, UserType extends UR = UR> = UserResponse<UserType> & OwnUserBase<ChannelType, CommandType, UserType>;
+export declare type PartialUpdateChannelAPIResponse<ChannelType = UR, CommandType extends string = LiteralStringForUnion, UserType = UR> = APIResponse & {
     channel: ChannelResponse<ChannelType, CommandType, UserType>;
     members: ChannelMemberResponse<UserType>[];
 };
@@ -371,20 +377,20 @@ export declare type PermissionAPIResponse = APIResponse & {
 export declare type PermissionsAPIResponse = APIResponse & {
     permissions?: PermissionAPIObject[];
 };
-export declare type ReactionAPIResponse<AttachmentType = UnknownType, ChannelType = UnknownType, CommandType extends string = LiteralStringForUnion, MessageType = UnknownType, ReactionType = UnknownType, UserType = UnknownType> = APIResponse & {
+export declare type ReactionAPIResponse<AttachmentType = UR, ChannelType = UR, CommandType extends string = LiteralStringForUnion, MessageType = UR, ReactionType = UR, UserType = UR> = APIResponse & {
     message: MessageResponse<AttachmentType, ChannelType, CommandType, MessageType, ReactionType, UserType>;
     reaction: ReactionResponse<ReactionType, UserType>;
 };
-export declare type ReactionResponse<ReactionType = UnknownType, UserType = UnknownType> = Reaction<ReactionType, UserType> & {
+export declare type ReactionResponse<ReactionType = UR, UserType = UR> = Reaction<ReactionType, UserType> & {
     created_at: string;
     updated_at: string;
 };
-export declare type ReadResponse<UserType = UnknownType> = {
+export declare type ReadResponse<UserType = UR> = {
     last_read: string;
     user: UserResponse<UserType>;
     unread_messages?: number;
 };
-export declare type SearchAPIResponse<AttachmentType = UnknownType, ChannelType = UnknownType, CommandType extends string = LiteralStringForUnion, MessageType = UnknownType, ReactionType = UnknownType, UserType = UnknownType> = APIResponse & {
+export declare type SearchAPIResponse<AttachmentType = UR, ChannelType = UR, CommandType extends string = LiteralStringForUnion, MessageType = UR, ReactionType = UR, UserType = UR> = APIResponse & {
     results: {
         message: MessageResponse<AttachmentType, ChannelType, CommandType, MessageType, ReactionType, UserType>;
     }[];
@@ -401,13 +407,14 @@ export declare type SearchWarning = {
 export declare type SendFileAPIResponse = APIResponse & {
     file: string;
 };
-export declare type SendMessageAPIResponse<AttachmentType = UnknownType, ChannelType = UnknownType, CommandType extends string = LiteralStringForUnion, MessageType = UnknownType, ReactionType = UnknownType, UserType = UnknownType> = APIResponse & {
+export declare type SendMessageAPIResponse<AttachmentType = UR, ChannelType = UR, CommandType extends string = LiteralStringForUnion, MessageType = UR, ReactionType = UR, UserType = UR> = APIResponse & {
     message: MessageResponse<AttachmentType, ChannelType, CommandType, MessageType, ReactionType, UserType>;
 };
-export declare type TruncateChannelAPIResponse<ChannelType = UnknownType, CommandType extends string = LiteralStringForUnion, UserType = UnknownType> = APIResponse & {
+export declare type TruncateChannelAPIResponse<ChannelType = UR, CommandType extends string = LiteralStringForUnion, UserType = UR, AttachmentType = UR, MessageType = UR, ReactionType = UR> = APIResponse & {
     channel: ChannelResponse<ChannelType, CommandType, UserType>;
+    message?: MessageResponse<AttachmentType, ChannelType, CommandType, MessageType, ReactionType, UserType>;
 };
-export declare type UpdateChannelAPIResponse<AttachmentType = UnknownType, ChannelType = UnknownType, CommandType extends string = LiteralStringForUnion, MessageType = UnknownType, ReactionType = UnknownType, UserType = UnknownType> = APIResponse & {
+export declare type UpdateChannelAPIResponse<AttachmentType = UR, ChannelType = UR, CommandType extends string = LiteralStringForUnion, MessageType = UR, ReactionType = UR, UserType = UR> = APIResponse & {
     channel: ChannelResponse<ChannelType, CommandType, UserType>;
     members: ChannelMemberResponse<UserType>[];
     message?: MessageResponse<AttachmentType, ChannelType, CommandType, MessageType, ReactionType, UserType>;
@@ -421,18 +428,18 @@ export declare type UpdateCommandResponse<CommandType extends string = LiteralSt
         name: CommandVariants<CommandType>;
     };
 };
-export declare type UpdateMessageAPIResponse<AttachmentType = UnknownType, ChannelType = UnknownType, CommandType extends string = LiteralStringForUnion, MessageType = UnknownType, ReactionType = UnknownType, UserType = UnknownType> = APIResponse & {
+export declare type UpdateMessageAPIResponse<AttachmentType = UR, ChannelType = UR, CommandType extends string = LiteralStringForUnion, MessageType = UR, ReactionType = UR, UserType = UR> = APIResponse & {
     message: MessageResponse<AttachmentType, ChannelType, CommandType, MessageType, ReactionType, UserType>;
 };
-export declare type UsersAPIResponse<UserType = UnknownType> = APIResponse & {
+export declare type UsersAPIResponse<UserType = UR> = APIResponse & {
     users: Array<UserResponse<UserType>>;
 };
-export declare type UpdateUsersAPIResponse<UserType = UnknownType> = APIResponse & {
+export declare type UpdateUsersAPIResponse<UserType = UR> = APIResponse & {
     users: {
         [key: string]: UserResponse<UserType>;
     };
 };
-export declare type UserResponse<UserType = UnknownType> = User<UserType> & {
+export declare type UserResponse<UserType = UR> = User<UserType> & {
     banned?: boolean;
     created_at?: string;
     deactivated_at?: string;
@@ -452,35 +459,24 @@ export declare type MessageFlagsPaginationOptions = {
     offset?: number;
 };
 export declare type BannedUsersPaginationOptions = Omit<PaginationOptions, 'id_gt' | 'id_gte' | 'id_lt' | 'id_lte'>;
-export declare type BanUserOptions<UserType = UnknownType> = UnBanUserOptions & {
+export declare type BanUserOptions<UserType = UR> = UnBanUserOptions & {
     banned_by?: UserResponse<UserType>;
     banned_by_id?: string;
     ip_ban?: boolean;
     reason?: string;
     timeout?: number;
-    /**
-     * @deprecated please use banned_by
-     */
-    user?: UserResponse<UserType>;
-    /**
-     * @deprecated please use banned_by_id
-     */
-    user_id?: string;
 };
 export declare type ChannelOptions = {
-    last_message_ids?: {
-        [key: string]: string;
-    };
     limit?: number;
+    member_limit?: number;
     message_limit?: number;
     offset?: number;
     presence?: boolean;
-    recovery?: boolean;
     state?: boolean;
     user_id?: string;
     watch?: boolean;
 };
-export declare type ChannelQueryOptions<ChannelType = UnknownType, CommandType extends string = LiteralStringForUnion, UserType = UnknownType> = {
+export declare type ChannelQueryOptions<ChannelType = UR, CommandType extends string = LiteralStringForUnion, UserType = UR> = {
     client_id?: string;
     connection_id?: string;
     data?: ChannelResponse<ChannelType, CommandType, UserType>;
@@ -536,7 +532,7 @@ export declare type CustomPermissionOptions = {
     owner?: boolean;
     same_team?: boolean;
 };
-export declare type InviteOptions<AttachmentType = UnknownType, ChannelType = UnknownType, CommandType extends string = LiteralStringForUnion, MessageType = UnknownType, ReactionType = UnknownType, UserType = UnknownType> = {
+export declare type InviteOptions<AttachmentType = UR, ChannelType = UR, CommandType extends string = LiteralStringForUnion, MessageType = UR, ReactionType = UR, UserType = UR> = {
     accept_invite?: boolean;
     add_members?: string[];
     add_moderators?: string[];
@@ -552,22 +548,22 @@ export declare type InviteOptions<AttachmentType = UnknownType, ChannelType = Un
     user_id?: string;
 };
 /** @deprecated use MarkChannelsReadOptions instead */
-export declare type MarkAllReadOptions<UserType = UnknownType> = MarkChannelsReadOptions<UserType>;
-export declare type MarkChannelsReadOptions<UserType = UnknownType> = {
+export declare type MarkAllReadOptions<UserType = UR> = MarkChannelsReadOptions<UserType>;
+export declare type MarkChannelsReadOptions<UserType = UR> = {
     client_id?: string;
     connection_id?: string;
     read_by_channel?: Record<string, string>;
     user?: UserResponse<UserType>;
     user_id?: string;
 };
-export declare type MarkReadOptions<UserType = UnknownType> = {
+export declare type MarkReadOptions<UserType = UR> = {
     client_id?: string;
     connection_id?: string;
     message_id?: string;
     user?: UserResponse<UserType>;
     user_id?: string;
 };
-export declare type MuteUserOptions<UserType = UnknownType> = {
+export declare type MuteUserOptions<UserType = UR> = {
     client_id?: string;
     connection_id?: string;
     id?: string;
@@ -602,7 +598,7 @@ export declare type QueryMembersOptions = {
     user_id_lt?: string;
     user_id_lte?: string;
 };
-export declare type SearchOptions<MessageType = UnknownType> = {
+export declare type SearchOptions<MessageType = UR> = {
     limit?: number;
     next?: string;
     offset?: number;
@@ -621,6 +617,8 @@ export declare type StreamChatOptions = AxiosRequestConfig & {
     browser?: boolean;
     device?: BaseDeviceFields;
     enableInsights?: boolean;
+    /** experimental feature, please contact support if you want this feature enabled for you */
+    enableWSFallback?: boolean;
     logger?: Logger;
     /**
      * When network is recovered, we re-query the active channels on client. But in single query, you can recover
@@ -663,7 +661,7 @@ export declare type ConnectionChangeEvent = {
     type: EventTypes;
     online?: boolean;
 };
-export declare type Event<AttachmentType extends UnknownType = UnknownType, ChannelType extends UnknownType = UnknownType, CommandType extends string = LiteralStringForUnion, EventType extends UnknownType = UnknownType, MessageType extends UnknownType = UnknownType, ReactionType extends UnknownType = UnknownType, UserType extends UnknownType = UnknownType> = EventType & {
+export declare type Event<AttachmentType extends UR = UR, ChannelType extends UR = UR, CommandType extends string = LiteralStringForUnion, EventType extends UR = UR, MessageType extends UR = UR, ReactionType extends UR = UR, UserType extends UR = UR> = EventType & {
     type: EventTypes;
     channel?: ChannelResponse<ChannelType, CommandType, UserType>;
     channel_id?: string;
@@ -689,10 +687,10 @@ export declare type Event<AttachmentType extends UnknownType = UnknownType, Chan
     user_id?: string;
     watcher_count?: number;
 };
-export declare type UserCustomEvent<EventType extends UnknownType = UnknownType> = EventType & {
+export declare type UserCustomEvent<EventType extends UR = UR> = EventType & {
     type: string;
 };
-export declare type EventHandler<AttachmentType extends UnknownType = UnknownType, ChannelType extends UnknownType = UnknownType, CommandType extends string = LiteralStringForUnion, EventType extends UnknownType = UnknownType, MessageType extends UnknownType = UnknownType, ReactionType extends UnknownType = UnknownType, UserType extends UnknownType = UnknownType> = (event: Event<AttachmentType, ChannelType, CommandType, EventType, MessageType, ReactionType, UserType>) => void;
+export declare type EventHandler<AttachmentType extends UR = UR, ChannelType extends UR = UR, CommandType extends string = LiteralStringForUnion, EventType extends UR = UR, MessageType extends UR = UR, ReactionType extends UR = UR, UserType extends UR = UR> = (event: Event<AttachmentType, ChannelType, CommandType, EventType, MessageType, ReactionType, UserType>) => void;
 export declare type EventTypes = 'all' | 'channel.created' | 'channel.deleted' | 'channel.hidden' | 'channel.muted' | 'channel.truncated' | 'channel.unmuted' | 'channel.updated' | 'channel.visible' | 'connection.changed' | 'connection.recovered' | 'health.check' | 'member.added' | 'member.removed' | 'member.updated' | 'message.deleted' | 'message.new' | 'message.read' | 'message.updated' | 'notification.added_to_channel' | 'notification.channel_deleted' | 'notification.channel_mutes_updated' | 'notification.channel_truncated' | 'notification.invite_accepted' | 'notification.invite_rejected' | 'notification.invited' | 'notification.mark_read' | 'notification.message_new' | 'notification.mutes_updated' | 'notification.removed_from_channel' | 'reaction.deleted' | 'reaction.new' | 'reaction.updated' | 'typing.start' | 'typing.stop' | 'user.banned' | 'user.deleted' | 'user.presence.changed' | 'user.unbanned' | 'user.updated' | 'user.watching.start' | 'user.watching.stop';
 /**
  * Filter Types
@@ -729,7 +727,7 @@ export declare type BannedUsersFilters = QueryFilters<{
 } & {
     [Key in keyof Omit<BannedUsersFilterOptions, 'channel_cid' | 'reason'>]: RequireOnlyOne<QueryFilter<BannedUsersFilterOptions[Key]>> | PrimitiveFilter<BannedUsersFilterOptions[Key]>;
 }>;
-export declare type ChannelFilters<ChannelType = UnknownType, CommandType extends string = LiteralStringForUnion, UserType = UnknownType> = QueryFilters<ContainsOperator<ChannelType> & {
+export declare type ChannelFilters<ChannelType = UR, CommandType extends string = LiteralStringForUnion, UserType = UR> = QueryFilters<ContainsOperator<ChannelType> & {
     members?: RequireOnlyOne<Pick<QueryFilter<string>, '$in' | '$nin'>> | RequireOnlyOne<Pick<QueryFilter<string[]>, '$eq'>> | PrimitiveFilter<string[]>;
 } & {
     name?: RequireOnlyOne<{
@@ -743,7 +741,7 @@ export declare type ContainsOperator<CustomType = {}> = {
         $contains?: ContainType extends object ? PrimitiveFilter<RequireAtLeastOne<ContainType>> : PrimitiveFilter<ContainType>;
     } & QueryFilter<PrimitiveFilter<ContainType>[]>> | PrimitiveFilter<PrimitiveFilter<ContainType>[]> : RequireOnlyOne<QueryFilter<CustomType[Key]>> | PrimitiveFilter<CustomType[Key]>;
 };
-export declare type MessageFilters<AttachmentType = UnknownType, ChannelType = UnknownType, CommandType extends string = LiteralStringForUnion, MessageType = UnknownType, ReactionType = UnknownType, UserType = UnknownType> = QueryFilters<ContainsOperator<MessageType> & {
+export declare type MessageFilters<AttachmentType = UR, ChannelType = UR, CommandType extends string = LiteralStringForUnion, MessageType = UR, ReactionType = UR, UserType = UR> = QueryFilters<ContainsOperator<MessageType> & {
     text?: RequireOnlyOne<{
         $autocomplete?: MessageResponse<AttachmentType, ChannelType, CommandType, MessageType, ReactionType, UserType>['text'];
         $q?: MessageResponse<AttachmentType, ChannelType, CommandType, MessageType, ReactionType, UserType>['text'];
@@ -777,7 +775,7 @@ export declare type QueryLogicalOperators<Operators> = {
     $nor?: ArrayOneOrMore<QueryFilters<Operators>>;
     $or?: ArrayTwoOrMore<QueryFilters<Operators>>;
 };
-export declare type UserFilters<UserType = UnknownType> = QueryFilters<ContainsOperator<UserType> & {
+export declare type UserFilters<UserType = UR> = QueryFilters<ContainsOperator<UserType> & {
     id?: RequireOnlyOne<{
         $autocomplete?: UserResponse<UserType>['id'];
     } & QueryFilter<UserResponse<UserType>['id']>> | PrimitiveFilter<UserResponse<UserType>['id']>;
@@ -801,8 +799,8 @@ export declare type BannedUsersSort = BannedUsersSortBase | Array<BannedUsersSor
 export declare type BannedUsersSortBase = {
     created_at?: AscDesc;
 };
-export declare type ChannelSort<ChannelType = UnknownType> = ChannelSortBase<ChannelType> | Array<ChannelSortBase<ChannelType>>;
-export declare type ChannelSortBase<ChannelType = UnknownType> = Sort<ChannelType> & {
+export declare type ChannelSort<ChannelType = UR> = ChannelSortBase<ChannelType> | Array<ChannelSortBase<ChannelType>>;
+export declare type ChannelSortBase<ChannelType = UR> = Sort<ChannelType> & {
     created_at?: AscDesc;
     has_unread?: AscDesc;
     last_message_at?: AscDesc;
@@ -814,9 +812,9 @@ export declare type ChannelSortBase<ChannelType = UnknownType> = Sort<ChannelTyp
 export declare type Sort<T> = {
     [P in keyof T]?: AscDesc;
 };
-export declare type UserSort<UserType = UnknownType> = Sort<UserResponse<UserType>> | Array<Sort<UserResponse<UserType>>>;
-export declare type MemberSort<UserType = UnknownType> = Sort<Pick<UserResponse<UserType>, 'id' | 'created_at' | 'name'>> | Array<Sort<Pick<UserResponse<UserType>, 'id' | 'created_at' | 'name'>>>;
-export declare type SearchMessageSortBase<MessageType = UnknownType> = Sort<MessageType> & {
+export declare type UserSort<UserType = UR> = Sort<UserResponse<UserType>> | Array<Sort<UserResponse<UserType>>>;
+export declare type MemberSort<UserType = UR> = Sort<Pick<UserResponse<UserType>, 'id' | 'created_at' | 'name'>> | Array<Sort<Pick<UserResponse<UserType>, 'id' | 'created_at' | 'name'>>>;
+export declare type SearchMessageSortBase<MessageType = UR> = Sort<MessageType> & {
     attachments?: AscDesc;
     'attachments.type'?: AscDesc;
     created_at?: AscDesc;
@@ -831,8 +829,8 @@ export declare type SearchMessageSortBase<MessageType = UnknownType> = Sort<Mess
     updated_at?: AscDesc;
     'user.id'?: AscDesc;
 };
-export declare type SearchMessageSort<MessageType = UnknownType> = SearchMessageSortBase<MessageType> | Array<SearchMessageSortBase<MessageType>>;
-export declare type QuerySort<ChannelType = UnknownType, UserType = UnknownType, MessageType = UnknownType> = BannedUsersSort | ChannelSort<ChannelType> | SearchMessageSort<MessageType> | UserSort<UserType>;
+export declare type SearchMessageSort<MessageType = UR> = SearchMessageSortBase<MessageType> | Array<SearchMessageSortBase<MessageType>>;
+export declare type QuerySort<ChannelType = UR, UserType = UR, MessageType = UR> = BannedUsersSort | ChannelSort<ChannelType> | SearchMessageSort<MessageType> | UserSort<UserType>;
 /**
  * Base Types
  */
@@ -898,7 +896,7 @@ export declare type AppSettings = {
     webhook_events?: Array<string> | null;
     webhook_url?: string;
 };
-export declare type Attachment<T = UnknownType> = T & {
+export declare type Attachment<T = UR> = T & {
     actions?: Action[];
     asset_url?: string;
     author_icon?: string;
@@ -976,11 +974,11 @@ export declare type ChannelConfigFields = {
 export declare type ChannelConfigWithInfo<CommandType extends string = LiteralStringForUnion> = ChannelConfigFields & CreatedAtUpdatedAt & {
     commands?: CommandResponse<CommandType>[];
 };
-export declare type ChannelData<ChannelType = UnknownType> = ChannelType & {
+export declare type ChannelData<ChannelType = UR> = ChannelType & {
     members?: string[];
     name?: string;
 };
-export declare type ChannelMembership<UserType = UnknownType> = {
+export declare type ChannelMembership<UserType = UR> = {
     banned?: boolean;
     channel_role?: Role;
     created_at?: string;
@@ -990,7 +988,7 @@ export declare type ChannelMembership<UserType = UnknownType> = {
     updated_at?: string;
     user?: UserResponse<UserType>;
 };
-export declare type ChannelMute<ChannelType extends UnknownType = UnknownType, CommandType extends string = LiteralStringForUnion, UserType extends UnknownType = UnknownType> = {
+export declare type ChannelMute<ChannelType extends UR = UR, CommandType extends string = LiteralStringForUnion, UserType extends UR = UR> = {
     user: UserResponse<UserType>;
     channel?: ChannelResponse<ChannelType, CommandType, UserType>;
     created_at?: string;
@@ -1004,7 +1002,7 @@ export declare type ChannelRole = {
     resource?: string;
     same_team?: boolean;
 };
-export declare type CheckPushInput<UserType = UnknownType> = {
+export declare type CheckPushInput<UserType = UR> = {
     apn_template?: string;
     client_id?: string;
     connection_id?: string;
@@ -1019,7 +1017,7 @@ export declare type CommandVariants<CommandType extends string = LiteralStringFo
 export declare type Configs<CommandType extends string = LiteralStringForUnion> = {
     [channel_type: string]: ChannelConfigWithInfo<CommandType> | undefined;
 };
-export declare type ConnectionOpen<ChannelType extends UnknownType = UnknownType, CommandType extends string = LiteralStringForUnion, UserType extends UnknownType = UnknownType> = {
+export declare type ConnectionOpen<ChannelType extends UR = UR, CommandType extends string = LiteralStringForUnion, UserType extends UR = UR> = {
     connection_id: string;
     cid?: string;
     created_at?: string;
@@ -1030,7 +1028,7 @@ export declare type CreatedAtUpdatedAt = {
     created_at: string;
     updated_at: string;
 };
-export declare type Device<UserType = UnknownType> = DeviceFields & {
+export declare type Device<UserType = UR> = DeviceFields & {
     provider?: string;
     user?: UserResponse<UserType>;
     user_id?: string;
@@ -1077,11 +1075,12 @@ export declare type HuaweiConfig = {
     enabled?: boolean;
 };
 export declare type LiteralStringForUnion = string & {};
-export declare type Logger = (logLevel: 'info' | 'error' | 'warn', message: string, extraData?: Record<string, unknown>) => void;
-export declare type Message<AttachmentType = UnknownType, MessageType = UnknownType, UserType = UnknownType> = Partial<MessageBase<AttachmentType, MessageType, UserType>> & {
+export declare type LogLevel = 'info' | 'error' | 'warn';
+export declare type Logger = (logLevel: LogLevel, message: string, extraData?: Record<string, unknown>) => void;
+export declare type Message<AttachmentType = UR, MessageType = UR, UserType = UR> = Partial<MessageBase<AttachmentType, MessageType, UserType>> & {
     mentioned_users?: string[];
 };
-export declare type MessageBase<AttachmentType = UnknownType, MessageType = UnknownType, UserType = UnknownType> = MessageType & {
+export declare type MessageBase<AttachmentType = UR, MessageType = UR, UserType = UR> = MessageType & {
     id: string;
     attachments?: Attachment<AttachmentType>[];
     html?: string;
@@ -1095,23 +1094,23 @@ export declare type MessageBase<AttachmentType = UnknownType, MessageType = Unkn
     user_id?: string;
 };
 export declare type MessageLabel = 'deleted' | 'ephemeral' | 'error' | 'regular' | 'reply' | 'system';
-export declare type Mute<UserType = UnknownType> = {
+export declare type Mute<UserType = UR> = {
     created_at: string;
     target: UserResponse<UserType>;
     updated_at: string;
     user: UserResponse<UserType>;
 };
-export declare type PartialUpdateChannel<ChannelType = UnknownType> = {
+export declare type PartialUpdateChannel<ChannelType = UR> = {
     set?: Partial<ChannelResponse<ChannelType>>;
     unset?: Array<keyof ChannelResponse<ChannelType>>;
 };
-export declare type PartialUserUpdate<UserType = UnknownType> = {
+export declare type PartialUserUpdate<UserType = UR> = {
     id: string;
     set?: Partial<UserResponse<UserType>>;
     unset?: Array<keyof UserResponse<UserType>>;
 };
-export declare type MessageUpdatableFields<MessageType = UnknownType> = Omit<MessageResponse<MessageType>, 'cid' | 'created_at' | 'updated_at' | 'deleted_at' | 'user' | 'user_id'>;
-export declare type PartialMessageUpdate<MessageType = UnknownType> = {
+export declare type MessageUpdatableFields<MessageType = UR> = Omit<MessageResponse<MessageType>, 'cid' | 'created_at' | 'updated_at' | 'deleted_at' | 'user' | 'user_id'>;
+export declare type PartialMessageUpdate<MessageType = UR> = {
     set?: Partial<MessageUpdatableFields<MessageType>>;
     unset?: Array<keyof MessageUpdatableFields<MessageType>>;
 };
@@ -1149,7 +1148,7 @@ export declare type RateLimitsInfo = {
     reset: number;
 };
 export declare type RateLimitsMap = Record<EndpointName, RateLimitsInfo>;
-export declare type Reaction<ReactionType = UnknownType, UserType = UnknownType> = ReactionType & {
+export declare type Reaction<ReactionType = UR, UserType = UR> = ReactionType & {
     type: string;
     message_id?: string;
     score?: number;
@@ -1157,7 +1156,7 @@ export declare type Reaction<ReactionType = UnknownType, UserType = UnknownType>
     user_id?: string;
 };
 export declare type Resource = 'AddLinks' | 'BanUser' | 'CreateChannel' | 'CreateMessage' | 'CreateReaction' | 'DeleteAttachment' | 'DeleteChannel' | 'DeleteMessage' | 'DeleteReaction' | 'EditUser' | 'MuteUser' | 'ReadChannel' | 'RunMessageAction' | 'UpdateChannel' | 'UpdateChannelMembers' | 'UpdateMessage' | 'UpdateUser' | 'UploadAttachment';
-export declare type SearchPayload<AttachmentType = UnknownType, ChannelType = UnknownType, CommandType extends string = LiteralStringForUnion, MessageType = UnknownType, ReactionType = UnknownType, UserType = UnknownType> = Omit<SearchOptions<MessageType>, 'sort'> & {
+export declare type SearchPayload<AttachmentType = UR, ChannelType = UR, CommandType extends string = LiteralStringForUnion, MessageType = UR, ReactionType = UR, UserType = UR> = Omit<SearchOptions<MessageType>, 'sort'> & {
     client_id?: string;
     connection_id?: string;
     filter_conditions?: ChannelFilters<ChannelType, CommandType, UserType>;
@@ -1185,10 +1184,11 @@ export declare type TokenOrProvider = null | string | TokenProvider | undefined;
 export declare type TokenProvider = () => Promise<string>;
 export declare type TranslationLanguages = '' | 'af' | 'am' | 'ar' | 'az' | 'bg' | 'bn' | 'bs' | 'cs' | 'da' | 'de' | 'el' | 'en' | 'es' | 'es-MX' | 'et' | 'fa' | 'fa-AF' | 'fi' | 'fr' | 'fr-CA' | 'ha' | 'he' | 'hi' | 'hr' | 'hu' | 'id' | 'it' | 'ja' | 'ka' | 'ko' | 'lv' | 'ms' | 'nl' | 'no' | 'pl' | 'ps' | 'pt' | 'ro' | 'ru' | 'sk' | 'sl' | 'so' | 'sq' | 'sr' | 'sv' | 'sw' | 'ta' | 'th' | 'tl' | 'tr' | 'uk' | 'ur' | 'vi' | 'zh' | 'zh-TW';
 export declare type TypingStartEvent = Event;
-export declare type UpdatedMessage<AttachmentType = UnknownType, ChannelType = UnknownType, CommandType extends string = LiteralStringForUnion, MessageType = UnknownType, ReactionType = UnknownType, UserType = UnknownType> = Omit<MessageResponse<AttachmentType, ChannelType, CommandType, MessageType, ReactionType, UserType>, 'mentioned_users'> & {
+export declare type ReservedMessageFields = 'command' | 'created_at' | 'html' | 'latest_reactions' | 'own_reactions' | 'quoted_message' | 'reaction_counts' | 'reply_count' | 'type' | 'updated_at' | 'user' | '__html';
+export declare type UpdatedMessage<AttachmentType = UR, ChannelType = UR, CommandType extends string = LiteralStringForUnion, MessageType = UR, ReactionType = UR, UserType = UR> = Omit<MessageResponse<AttachmentType, ChannelType, CommandType, MessageType, ReactionType, UserType>, 'mentioned_users'> & {
     mentioned_users?: string[];
 };
-export declare type User<UserType = UnknownType> = UserType & {
+export declare type User<UserType = UR> = UserType & {
     id: string;
     anon?: boolean;
     name?: string;
@@ -1259,6 +1259,12 @@ export declare type TaskStatus = {
         description: string;
         type: string;
     };
-    result?: UnknownType;
+    result?: UR;
+};
+export declare type TruncateOptions<AttachmentType, MessageType, UserType> = {
+    hard_delete?: boolean;
+    message?: Message<AttachmentType, MessageType, UserType>;
+    skip_push?: boolean;
+    truncated_at?: Date;
 };
 //# sourceMappingURL=types.d.ts.map