stream-chat 4.4.3 → 5.1.0

package/src/types.ts

@@ -24,15 +24,14 @@ export type RequireAtLeastOne<T> = {
   [K in keyof T]-?: Required<Pick<T, K>> & Partial<Pick<T, Exclude<keyof T, K>>>;
 }[keyof T];
 
-export type RequireOnlyOne<T, Keys extends keyof T = keyof T> = Pick<
-  T,
-  Exclude<keyof T, Keys>
-> &
+export 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 type UnknownType = Record<string, unknown>;
+/* Unknown Record */
+export type UR = Record<string, unknown>;
+export type UnknownType = UR; //alias to avoid breaking change
 
 export type Unpacked<T> = T extends (infer U)[]
   ? U // eslint-disable-next-line @typescript-eslint/no-explicit-any
@@ -50,9 +49,7 @@ export type APIResponse = {
   duration: string;
 };
 
-export type AppSettingsAPIResponse<
-  CommandType extends string = LiteralStringForUnion
-> = APIResponse & {
+export type AppSettingsAPIResponse<CommandType extends string = LiteralStringForUnion> = APIResponse & {
   app?: {
     channel_configs: Record<
       string,
@@ -129,22 +126,15 @@ export type ModerationResult = {
 };
 
 export type MessageFlagsResponse<
-  ChannelType extends UnknownType = UnknownType,
+  ChannelType extends UR = UR,
   CommandType extends string = LiteralStringForUnion,
-  UserType extends UnknownType = UnknownType,
-  AttachmentType = UnknownType,
-  MessageType = UnknownType,
-  ReactionType = UnknownType
+  UserType extends UR = UR,
+  AttachmentType = UR,
+  MessageType = UR,
+  ReactionType = UR
 > = APIResponse & {
   flags?: Array<{
-    message: MessageResponse<
-      AttachmentType,
-      ChannelType,
-      CommandType,
-      MessageType,
-      ReactionType,
-      UserType
-    >;
+    message: MessageResponse<AttachmentType, ChannelType, CommandType, MessageType, ReactionType, UserType>;
     user: UserResponse<UserType>;
     approved_at?: string;
     created_at?: string;
@@ -157,10 +147,52 @@ export type MessageFlagsResponse<
   }>;
 };
 
+export type FlagReport<
+  ChannelType extends UR = UR,
+  CommandType extends string = LiteralStringForUnion,
+  UserType extends UR = UR,
+  AttachmentType = UR,
+  MessageType = UR,
+  ReactionType = UR
+> = {
+  flags_count: number;
+  id: string;
+  message: MessageResponse<AttachmentType, ChannelType, CommandType, MessageType, ReactionType, UserType>;
+  user: UserResponse<UserType>;
+  created_at?: string;
+  review_details?: Object;
+  review_result?: string;
+  reviewed_at?: string;
+  reviewed_by?: UserResponse<UserType>;
+  updated_at?: string;
+};
+
+export type FlagReportsResponse<
+  ChannelType extends UR = UR,
+  CommandType extends string = LiteralStringForUnion,
+  UserType extends UR = UR,
+  AttachmentType = UR,
+  MessageType = UR,
+  ReactionType = UR
+> = APIResponse & {
+  flag_reports: Array<FlagReport<ChannelType, CommandType, UserType, AttachmentType, MessageType, ReactionType>>;
+};
+
+export type ReviewFlagReportResponse<
+  ChannelType extends UR = UR,
+  CommandType extends string = LiteralStringForUnion,
+  UserType extends UR = UR,
+  AttachmentType = UR,
+  MessageType = UR,
+  ReactionType = UR
+> = APIResponse & {
+  flag_report: FlagReport<ChannelType, CommandType, UserType, AttachmentType, MessageType, ReactionType>;
+};
+
 export type BannedUsersResponse<
-  ChannelType extends UnknownType = UnknownType,
+  ChannelType extends UR = UR,
   CommandType extends string = LiteralStringForUnion,
-  UserType extends UnknownType = UnknownType
+  UserType extends UR = UR
 > = APIResponse & {
   bans?: Array<{
     user: UserResponse<UserType>;
@@ -179,9 +211,9 @@ export type BlockListResponse = BlockList & {
 };
 
 export type ChannelResponse<
-  ChannelType = UnknownType,
+  ChannelType = UR,
   CommandType extends string = LiteralStringForUnion,
-  UserType = UnknownType
+  UserType = UR
 > = ChannelType & {
   cid: string;
   disabled: boolean;
@@ -205,35 +237,22 @@ export type ChannelResponse<
   name?: string;
   own_capabilities?: string[];
   team?: string;
+  truncated_at?: string;
   updated_at?: string;
 };
 
 export type ChannelAPIResponse<
-  AttachmentType = UnknownType,
-  ChannelType = UnknownType,
+  AttachmentType = UR,
+  ChannelType = UR,
   CommandType extends string = LiteralStringForUnion,
-  MessageType = UnknownType,
-  ReactionType = UnknownType,
-  UserType = UnknownType
+  MessageType = UR,
+  ReactionType = UR,
+  UserType = UR
 > = APIResponse & {
   channel: ChannelResponse<ChannelType, CommandType, UserType>;
   members: ChannelMemberResponse<UserType>[];
-  messages: MessageResponse<
-    AttachmentType,
-    ChannelType,
-    CommandType,
-    MessageType,
-    ReactionType,
-    UserType
-  >[];
-  pinned_messages: MessageResponse<
-    AttachmentType,
-    ChannelType,
-    CommandType,
-    MessageType,
-    ReactionType,
-    UserType
-  >[];
+  messages: MessageResponse<AttachmentType, ChannelType, CommandType, MessageType, ReactionType, UserType>[];
+  pinned_messages: MessageResponse<AttachmentType, ChannelType, CommandType, MessageType, ReactionType, UserType>[];
   hidden?: boolean;
   membership?: ChannelMembership<UserType> | null;
   read?: ReadResponse<UserType>[];
@@ -241,11 +260,16 @@ export type ChannelAPIResponse<
   watchers?: UserResponse<UserType>[];
 };
 
-export type ChannelMemberAPIResponse<UserType = UnknownType> = APIResponse & {
+export type ChannelUpdateOptions = {
+  hide_history?: boolean;
+  skip_push?: boolean;
+};
+
+export type ChannelMemberAPIResponse<UserType = UR> = APIResponse & {
   members: ChannelMemberResponse<UserType>[];
 };
 
-export type ChannelMemberResponse<UserType = UnknownType> = {
+export type ChannelMemberResponse<UserType = UR> = {
   banned?: boolean;
   channel_role?: Role;
   created_at?: string;
@@ -277,9 +301,7 @@ export type CheckSQSResponse = APIResponse & {
   error?: string;
 };
 
-export type CommandResponse<
-  CommandType extends string = LiteralStringForUnion
-> = Partial<CreatedAtUpdatedAt> & {
+export type CommandResponse<CommandType extends string = LiteralStringForUnion> = Partial<CreatedAtUpdatedAt> & {
   args?: string;
   description?: string;
   name?: CommandVariants<CommandType>;
@@ -287,56 +309,44 @@ export type CommandResponse<
 };
 
 export type ConnectAPIResponse<
-  ChannelType extends UnknownType = UnknownType,
+  ChannelType extends UR = UR,
   CommandType extends string = LiteralStringForUnion,
-  UserType extends UnknownType = UnknownType
+  UserType extends UR = UR
 > = Promise<void | ConnectionOpen<ChannelType, CommandType, UserType>>;
 
-export type CreateChannelResponse<
-  CommandType extends string = LiteralStringForUnion
-> = APIResponse &
+export type CreateChannelResponse<CommandType extends string = LiteralStringForUnion> = APIResponse &
   Omit<CreateChannelOptions<CommandType>, 'client_id' | 'connection_id'> & {
     created_at: string;
     updated_at: string;
     grants?: Record<string, string[]>;
   };
 
-export type CreateCommandResponse<
-  CommandType extends string = LiteralStringForUnion
-> = APIResponse & { command: CreateCommandOptions<CommandType> & CreatedAtUpdatedAt };
+export type CreateCommandResponse<CommandType extends string = LiteralStringForUnion> = APIResponse & {
+  command: CreateCommandOptions<CommandType> & CreatedAtUpdatedAt;
+};
 
 export type DeleteChannelAPIResponse<
-  ChannelType = UnknownType,
+  ChannelType = UR,
   CommandType extends string = LiteralStringForUnion,
-  UserType = UnknownType
+  UserType = UR
 > = APIResponse & {
   channel: ChannelResponse<ChannelType, CommandType, UserType>;
 };
 
-export type DeleteCommandResponse<
-  CommandType extends string = LiteralStringForUnion
-> = APIResponse & {
+export type DeleteCommandResponse<CommandType extends string = LiteralStringForUnion> = APIResponse & {
   name?: CommandVariants<CommandType>;
 };
 
 export type EventAPIResponse<
-  AttachmentType extends UnknownType = UnknownType,
-  ChannelType extends UnknownType = UnknownType,
+  AttachmentType extends UR = UR,
+  ChannelType extends UR = UR,
   CommandType extends string = LiteralStringForUnion,
-  EventType extends UnknownType = UnknownType,
-  MessageType extends UnknownType = UnknownType,
-  ReactionType extends UnknownType = UnknownType,
-  UserType extends UnknownType = UnknownType
+  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
-  >;
+  event: Event<AttachmentType, ChannelType, CommandType, EventType, MessageType, ReactionType, UserType>;
 };
 
 export type ExportChannelResponse = {
@@ -350,7 +360,7 @@ export type ExportChannelStatusResponse = {
   updated_at?: string;
 };
 
-export type FlagMessageResponse<UserType = UnknownType> = APIResponse & {
+export type FlagMessageResponse<UserType = UR> = APIResponse & {
   flag: {
     created_at: string;
     created_by_automod: boolean;
@@ -358,13 +368,14 @@ export type FlagMessageResponse<UserType = UnknownType> = APIResponse & {
     updated_at: string;
     user: UserResponse<UserType>;
     approved_at?: string;
+    details?: Object; // Any JSON
     rejected_at?: string;
     reviewed_at?: string;
     reviewed_by?: string;
   };
 };
 
-export type FlagUserResponse<UserType = UnknownType> = APIResponse & {
+export type FlagUserResponse<UserType = UR> = APIResponse & {
   flag: {
     created_at: string;
     created_by_automod: boolean;
@@ -372,6 +383,7 @@ export type FlagUserResponse<UserType = UnknownType> = APIResponse & {
     updated_at: string;
     user: UserResponse<UserType>;
     approved_at?: string;
+    details?: Object; // Any JSON
     rejected_at?: string;
     reviewed_at?: string;
     reviewed_by?: string;
@@ -379,12 +391,12 @@ export type FlagUserResponse<UserType = UnknownType> = APIResponse & {
 };
 
 export type FormatMessageResponse<
-  AttachmentType = UnknownType,
-  ChannelType = UnknownType,
+  AttachmentType = UR,
+  ChannelType = UR,
   CommandType extends string = LiteralStringForUnion,
-  MessageType = UnknownType,
-  ReactionType = UnknownType,
-  UserType = UnknownType
+  MessageType = UR,
+  ReactionType = UR,
+  UserType = UR
 > = Omit<
   MessageResponse<AttachmentType, ChannelType, CommandType, {}, ReactionType, UserType>,
   'created_at' | 'pinned_at' | 'updated_at' | 'status'
@@ -396,9 +408,7 @@ export type FormatMessageResponse<
     updated_at: Date;
   };
 
-export type GetChannelTypeResponse<
-  CommandType extends string = LiteralStringForUnion
-> = APIResponse &
+export type GetChannelTypeResponse<CommandType extends string = LiteralStringForUnion> = APIResponse &
   Omit<CreateChannelOptions<CommandType>, 'client_id' | 'connection_id' | 'commands'> & {
     created_at: string;
     updated_at: string;
@@ -406,26 +416,19 @@ export type GetChannelTypeResponse<
     grants?: Record<string, string[]>;
   };
 
-export type GetCommandResponse<
-  CommandType extends string = LiteralStringForUnion
-> = APIResponse & CreateCommandOptions<CommandType> & CreatedAtUpdatedAt;
+export type GetCommandResponse<CommandType extends string = LiteralStringForUnion> = APIResponse &
+  CreateCommandOptions<CommandType> &
+  CreatedAtUpdatedAt;
 
 export type GetMultipleMessagesAPIResponse<
-  AttachmentType = UnknownType,
-  ChannelType = UnknownType,
+  AttachmentType = UR,
+  ChannelType = UR,
   CommandType extends string = LiteralStringForUnion,
-  MessageType = UnknownType,
-  ReactionType = UnknownType,
-  UserType = UnknownType
+  MessageType = UR,
+  ReactionType = UR,
+  UserType = UR
 > = APIResponse & {
-  messages: MessageResponse<
-    AttachmentType,
-    ChannelType,
-    CommandType,
-    MessageType,
-    ReactionType,
-    UserType
-  >[];
+  messages: MessageResponse<AttachmentType, ChannelType, CommandType, MessageType, ReactionType, UserType>[];
 };
 
 export type GetRateLimitsResponse = APIResponse & {
@@ -435,40 +438,25 @@ export type GetRateLimitsResponse = APIResponse & {
   web?: RateLimitsMap;
 };
 
-export type GetReactionsAPIResponse<
-  ReactionType = UnknownType,
-  UserType = UnknownType
-> = APIResponse & {
+export type GetReactionsAPIResponse<ReactionType = UR, UserType = UR> = APIResponse & {
   reactions: ReactionResponse<ReactionType, UserType>[];
 };
 
 export type GetRepliesAPIResponse<
-  AttachmentType = UnknownType,
-  ChannelType = UnknownType,
+  AttachmentType = UR,
+  ChannelType = UR,
   CommandType extends string = LiteralStringForUnion,
-  MessageType = UnknownType,
-  ReactionType = UnknownType,
-  UserType = UnknownType
+  MessageType = UR,
+  ReactionType = UR,
+  UserType = UR
 > = APIResponse & {
-  messages: MessageResponse<
-    AttachmentType,
-    ChannelType,
-    CommandType,
-    MessageType,
-    ReactionType,
-    UserType
-  >[];
+  messages: MessageResponse<AttachmentType, ChannelType, CommandType, MessageType, ReactionType, UserType>[];
 };
 
-export type ListChannelResponse<
-  CommandType extends string = LiteralStringForUnion
-> = APIResponse & {
+export type ListChannelResponse<CommandType extends string = LiteralStringForUnion> = APIResponse & {
   channel_types: Record<
     string,
-    Omit<
-      CreateChannelOptions<CommandType>,
-      'client_id' | 'connection_id' | 'commands'
-    > & {
+    Omit<CreateChannelOptions<CommandType>, 'client_id' | 'connection_id' | 'commands'> & {
       commands: CommandResponse<CommandType>[];
       created_at: string;
       updated_at: string;
@@ -481,16 +469,14 @@ export type ListChannelTypesAPIResponse<
   CommandType extends string = LiteralStringForUnion
 > = ListChannelResponse<CommandType>;
 
-export type ListCommandsResponse<
-  CommandType extends string = LiteralStringForUnion
-> = APIResponse & {
-  commands: Array<CreateCommandOptions<CommandType> & CreatedAtUpdatedAt>;
+export type ListCommandsResponse<CommandType extends string = LiteralStringForUnion> = APIResponse & {
+  commands: Array<CreateCommandOptions<CommandType> & Partial<CreatedAtUpdatedAt>>;
 };
 
 export type MuteChannelAPIResponse<
-  ChannelType extends UnknownType = UnknownType,
+  ChannelType extends UR = UR,
   CommandType extends string = LiteralStringForUnion,
-  UserType extends UnknownType = UnknownType
+  UserType extends UR = UR
 > = APIResponse & {
   channel_mute: ChannelMute<ChannelType, CommandType, UserType>;
   own_user: OwnUserResponse<ChannelType, CommandType, UserType>;
@@ -499,37 +485,23 @@ export type MuteChannelAPIResponse<
 };
 
 export type MessageResponse<
-  AttachmentType = UnknownType,
-  ChannelType = UnknownType,
+  AttachmentType = UR,
+  ChannelType = UR,
   CommandType extends string = LiteralStringForUnion,
-  MessageType = UnknownType,
-  ReactionType = UnknownType,
-  UserType = UnknownType
-> = MessageResponseBase<
-  AttachmentType,
-  ChannelType,
-  CommandType,
-  MessageType,
-  ReactionType,
-  UserType
-> & {
-  quoted_message?: MessageResponseBase<
-    AttachmentType,
-    ChannelType,
-    CommandType,
-    MessageType,
-    ReactionType,
-    UserType
-  >;
+  MessageType = UR,
+  ReactionType = UR,
+  UserType = UR
+> = MessageResponseBase<AttachmentType, ChannelType, CommandType, MessageType, ReactionType, UserType> & {
+  quoted_message?: MessageResponseBase<AttachmentType, ChannelType, CommandType, MessageType, ReactionType, UserType>;
 };
 
 export type MessageResponseBase<
-  AttachmentType = UnknownType,
-  ChannelType = UnknownType,
+  AttachmentType = UR,
+  ChannelType = UR,
   CommandType extends string = LiteralStringForUnion,
-  MessageType = UnknownType,
-  ReactionType = UnknownType,
-  UserType = UnknownType
+  MessageType = UR,
+  ReactionType = UR,
+  UserType = UR
 > = MessageBase<AttachmentType, MessageType, UserType> & {
   args?: string;
   channel?: ChannelResponse<ChannelType, CommandType, UserType>;
@@ -558,7 +530,7 @@ export type MessageResponseBase<
   updated_at?: string;
 };
 
-export type MuteResponse<UserType = UnknownType> = {
+export type MuteResponse<UserType = UR> = {
   user: UserResponse<UserType>;
   created_at?: string;
   expires?: string;
@@ -567,9 +539,9 @@ export type MuteResponse<UserType = UnknownType> = {
 };
 
 export type MuteUserResponse<
-  ChannelType extends UnknownType = UnknownType,
+  ChannelType extends UR = UR,
   CommandType extends string = LiteralStringForUnion,
-  UserType extends UnknownType = UnknownType
+  UserType extends UR = UR
 > = APIResponse & {
   mute?: MuteResponse<UserType>;
   mutes?: Array<Mute<UserType>>;
@@ -577,9 +549,9 @@ export type MuteUserResponse<
 };
 
 export type OwnUserBase<
-  ChannelType extends UnknownType = UnknownType,
+  ChannelType extends UR = UR,
   CommandType extends string = LiteralStringForUnion,
-  UserType extends UnknownType = UnknownType
+  UserType extends UR = UR
 > = {
   channel_mutes: ChannelMute<ChannelType, CommandType, UserType>[];
   devices: Device<UserType>[];
@@ -592,15 +564,15 @@ export type OwnUserBase<
 };
 
 export type OwnUserResponse<
-  ChannelType extends UnknownType = UnknownType,
+  ChannelType extends UR = UR,
   CommandType extends string = LiteralStringForUnion,
-  UserType extends UnknownType = UnknownType
+  UserType extends UR = UR
 > = UserResponse<UserType> & OwnUserBase<ChannelType, CommandType, UserType>;
 
 export type PartialUpdateChannelAPIResponse<
-  ChannelType = UnknownType,
+  ChannelType = UR,
   CommandType extends string = LiteralStringForUnion,
-  UserType = UnknownType
+  UserType = UR
 > = APIResponse & {
   channel: ChannelResponse<ChannelType, CommandType, UserType>;
   members: ChannelMemberResponse<UserType>[];
@@ -615,55 +587,38 @@ export type PermissionsAPIResponse = APIResponse & {
 };
 
 export type ReactionAPIResponse<
-  AttachmentType = UnknownType,
-  ChannelType = UnknownType,
+  AttachmentType = UR,
+  ChannelType = UR,
   CommandType extends string = LiteralStringForUnion,
-  MessageType = UnknownType,
-  ReactionType = UnknownType,
-  UserType = UnknownType
+  MessageType = UR,
+  ReactionType = UR,
+  UserType = UR
 > = APIResponse & {
-  message: MessageResponse<
-    AttachmentType,
-    ChannelType,
-    CommandType,
-    MessageType,
-    ReactionType,
-    UserType
-  >;
+  message: MessageResponse<AttachmentType, ChannelType, CommandType, MessageType, ReactionType, UserType>;
   reaction: ReactionResponse<ReactionType, UserType>;
 };
 
-export type ReactionResponse<
-  ReactionType = UnknownType,
-  UserType = UnknownType
-> = Reaction<ReactionType, UserType> & {
+export type ReactionResponse<ReactionType = UR, UserType = UR> = Reaction<ReactionType, UserType> & {
   created_at: string;
   updated_at: string;
 };
 
-export type ReadResponse<UserType = UnknownType> = {
+export type ReadResponse<UserType = UR> = {
   last_read: string;
   user: UserResponse<UserType>;
   unread_messages?: number;
 };
 
 export type SearchAPIResponse<
-  AttachmentType = UnknownType,
-  ChannelType = UnknownType,
+  AttachmentType = UR,
+  ChannelType = UR,
   CommandType extends string = LiteralStringForUnion,
-  MessageType = UnknownType,
-  ReactionType = UnknownType,
-  UserType = UnknownType
+  MessageType = UR,
+  ReactionType = UR,
+  UserType = UR
 > = APIResponse & {
   results: {
-    message: MessageResponse<
-      AttachmentType,
-      ChannelType,
-      CommandType,
-      MessageType,
-      ReactionType,
-      UserType
-    >;
+    message: MessageResponse<AttachmentType, ChannelType, CommandType, MessageType, ReactionType, UserType>;
   }[];
   next?: string;
   previous?: string;
@@ -679,62 +634,48 @@ export type SearchWarning = {
 export type SendFileAPIResponse = APIResponse & { file: string };
 
 export type SendMessageAPIResponse<
-  AttachmentType = UnknownType,
-  ChannelType = UnknownType,
+  AttachmentType = UR,
+  ChannelType = UR,
   CommandType extends string = LiteralStringForUnion,
-  MessageType = UnknownType,
-  ReactionType = UnknownType,
-  UserType = UnknownType
+  MessageType = UR,
+  ReactionType = UR,
+  UserType = UR
 > = APIResponse & {
-  message: MessageResponse<
-    AttachmentType,
-    ChannelType,
-    CommandType,
-    MessageType,
-    ReactionType,
-    UserType
-  >;
+  message: MessageResponse<AttachmentType, ChannelType, CommandType, MessageType, ReactionType, UserType>;
 };
 
 export type TruncateChannelAPIResponse<
-  ChannelType = UnknownType,
+  ChannelType = UR,
   CommandType extends string = LiteralStringForUnion,
-  UserType = UnknownType
+  UserType = UR,
+  AttachmentType = UR,
+  MessageType = UR,
+  ReactionType = UR
 > = APIResponse & {
   channel: ChannelResponse<ChannelType, CommandType, UserType>;
+  message?: MessageResponse<AttachmentType, ChannelType, CommandType, MessageType, ReactionType, UserType>;
 };
 
 export type UpdateChannelAPIResponse<
-  AttachmentType = UnknownType,
-  ChannelType = UnknownType,
+  AttachmentType = UR,
+  ChannelType = UR,
   CommandType extends string = LiteralStringForUnion,
-  MessageType = UnknownType,
-  ReactionType = UnknownType,
-  UserType = UnknownType
+  MessageType = UR,
+  ReactionType = UR,
+  UserType = UR
 > = APIResponse & {
   channel: ChannelResponse<ChannelType, CommandType, UserType>;
   members: ChannelMemberResponse<UserType>[];
-  message?: MessageResponse<
-    AttachmentType,
-    ChannelType,
-    CommandType,
-    MessageType,
-    ReactionType,
-    UserType
-  >;
+  message?: MessageResponse<AttachmentType, ChannelType, CommandType, MessageType, ReactionType, UserType>;
 };
 
-export type UpdateChannelResponse<
-  CommandType extends string = LiteralStringForUnion
-> = APIResponse &
+export type UpdateChannelResponse<CommandType extends string = LiteralStringForUnion> = APIResponse &
   Omit<CreateChannelOptions<CommandType>, 'client_id' | 'connection_id'> & {
     created_at: string;
     updated_at: string;
   };
 
-export type UpdateCommandResponse<
-  CommandType extends string = LiteralStringForUnion
-> = APIResponse & {
+export type UpdateCommandResponse<CommandType extends string = LiteralStringForUnion> = APIResponse & {
   command: UpdateCommandOptions<CommandType> &
     CreatedAtUpdatedAt & {
       name: CommandVariants<CommandType>;
@@ -742,32 +683,25 @@ export type UpdateCommandResponse<
 };
 
 export type UpdateMessageAPIResponse<
-  AttachmentType = UnknownType,
-  ChannelType = UnknownType,
+  AttachmentType = UR,
+  ChannelType = UR,
   CommandType extends string = LiteralStringForUnion,
-  MessageType = UnknownType,
-  ReactionType = UnknownType,
-  UserType = UnknownType
+  MessageType = UR,
+  ReactionType = UR,
+  UserType = UR
 > = APIResponse & {
-  message: MessageResponse<
-    AttachmentType,
-    ChannelType,
-    CommandType,
-    MessageType,
-    ReactionType,
-    UserType
-  >;
+  message: MessageResponse<AttachmentType, ChannelType, CommandType, MessageType, ReactionType, UserType>;
 };
 
-export type UsersAPIResponse<UserType = UnknownType> = APIResponse & {
+export type UsersAPIResponse<UserType = UR> = APIResponse & {
   users: Array<UserResponse<UserType>>;
 };
 
-export type UpdateUsersAPIResponse<UserType = UnknownType> = APIResponse & {
+export type UpdateUsersAPIResponse<UserType = UR> = APIResponse & {
   users: { [key: string]: UserResponse<UserType> };
 };
 
-export type UserResponse<UserType = UnknownType> = User<UserType> & {
+export type UserResponse<UserType = UR> = User<UserType> & {
   banned?: boolean;
   created_at?: string;
   deactivated_at?: string;
@@ -775,11 +709,17 @@ export type UserResponse<UserType = UnknownType> = User<UserType> & {
   language?: TranslationLanguages | '';
   last_active?: string;
   online?: boolean;
+  push_notifications?: PushNotificationSettings;
   revoke_tokens_issued_before?: string;
   shadow_banned?: boolean;
   updated_at?: string;
 };
 
+export type PushNotificationSettings = {
+  disabled?: boolean;
+  disabled_until?: string | null;
+};
+
 /**
  * Option Types
  */
@@ -789,44 +729,38 @@ export type MessageFlagsPaginationOptions = {
   offset?: number;
 };
 
-export type BannedUsersPaginationOptions = Omit<
-  PaginationOptions,
-  'id_gt' | 'id_gte' | 'id_lt' | 'id_lte'
->;
+export type FlagReportsPaginationOptions = {
+  limit?: number;
+  offset?: number;
+};
+
+export type ReviewFlagReportOptions = {
+  review_details?: Object;
+  user_id?: string;
+};
 
-export type BanUserOptions<UserType = UnknownType> = UnBanUserOptions & {
+export type BannedUsersPaginationOptions = Omit<PaginationOptions, 'id_gt' | 'id_gte' | 'id_lt' | 'id_lte'>;
+
+export 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 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 type ChannelQueryOptions<
-  ChannelType = UnknownType,
-  CommandType extends string = LiteralStringForUnion,
-  UserType = UnknownType
-> = {
+export type ChannelQueryOptions<ChannelType = UR, CommandType extends string = LiteralStringForUnion, UserType = UR> = {
   client_id?: string;
   connection_id?: string;
   data?: ChannelResponse<ChannelType, CommandType, UserType>;
@@ -889,12 +823,12 @@ export type CustomPermissionOptions = {
 
 // TODO: rename to UpdateChannelOptions in the next major update and use it in channel._update and/or channel.update
 export type InviteOptions<
-  AttachmentType = UnknownType,
-  ChannelType = UnknownType,
+  AttachmentType = UR,
+  ChannelType = UR,
   CommandType extends string = LiteralStringForUnion,
-  MessageType = UnknownType,
-  ReactionType = UnknownType,
-  UserType = UnknownType
+  MessageType = UR,
+  ReactionType = UR,
+  UserType = UR
 > = {
   accept_invite?: boolean;
   add_members?: string[];
@@ -904,14 +838,7 @@ export type InviteOptions<
   data?: Omit<ChannelResponse<ChannelType, CommandType, UserType>, 'id' | 'cid'>;
   demote_moderators?: string[];
   invites?: string[];
-  message?: MessageResponse<
-    AttachmentType,
-    ChannelType,
-    CommandType,
-    MessageType,
-    ReactionType,
-    UserType
-  >;
+  message?: MessageResponse<AttachmentType, ChannelType, CommandType, MessageType, ReactionType, UserType>;
   reject_invite?: boolean;
   remove_members?: string[];
   user?: UserResponse<UserType>;
@@ -919,11 +846,9 @@ export type InviteOptions<
 };
 
 /** @deprecated use MarkChannelsReadOptions instead */
-export type MarkAllReadOptions<
-  UserType = UnknownType
-> = MarkChannelsReadOptions<UserType>;
+export type MarkAllReadOptions<UserType = UR> = MarkChannelsReadOptions<UserType>;
 
-export type MarkChannelsReadOptions<UserType = UnknownType> = {
+export type MarkChannelsReadOptions<UserType = UR> = {
   client_id?: string;
   connection_id?: string;
   read_by_channel?: Record<string, string>;
@@ -931,7 +856,7 @@ export type MarkChannelsReadOptions<UserType = UnknownType> = {
   user_id?: string;
 };
 
-export type MarkReadOptions<UserType = UnknownType> = {
+export type MarkReadOptions<UserType = UR> = {
   client_id?: string;
   connection_id?: string;
   message_id?: string;
@@ -939,7 +864,7 @@ export type MarkReadOptions<UserType = UnknownType> = {
   user_id?: string;
 };
 
-export type MuteUserOptions<UserType = UnknownType> = {
+export type MuteUserOptions<UserType = UR> = {
   client_id?: string;
   connection_id?: string;
   id?: string;
@@ -969,6 +894,21 @@ export type MessagePaginationOptions = PaginationOptions & {
   id_around?: string;
 };
 
+export type PinnedMessagePaginationOptions = {
+  id_around?: string;
+  id_gt?: string;
+  id_gte?: string;
+  id_lt?: string;
+  id_lte?: string;
+  limit?: number;
+  offset?: number;
+  pinned_at_after?: string | Date;
+  pinned_at_after_or_equal?: string | Date;
+  pinned_at_around?: string | Date;
+  pinned_at_before?: string | Date;
+  pinned_at_before_or_equal?: string | Date;
+};
+
 export type QueryMembersOptions = {
   limit?: number;
   offset?: number;
@@ -978,7 +918,7 @@ export type QueryMembersOptions = {
   user_id_lte?: string;
 };
 
-export type SearchOptions<MessageType = UnknownType> = {
+export type SearchOptions<MessageType = UR> = {
   limit?: number;
   next?: string;
   offset?: number;
@@ -998,6 +938,8 @@ export 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
@@ -1022,9 +964,10 @@ export type UnBanUserOptions = {
 };
 
 // TODO: rename to UpdateChannelTypeOptions in the next major update
-export type UpdateChannelOptions<
-  CommandType extends string = LiteralStringForUnion
-> = Omit<CreateChannelOptions<CommandType>, 'name'> & {
+export type UpdateChannelOptions<CommandType extends string = LiteralStringForUnion> = Omit<
+  CreateChannelOptions<CommandType>,
+  'name'
+> & {
   created_at?: string;
   updated_at?: string;
 };
@@ -1051,13 +994,13 @@ export type ConnectionChangeEvent = {
 };
 
 export type Event<
-  AttachmentType extends UnknownType = UnknownType,
-  ChannelType extends UnknownType = UnknownType,
+  AttachmentType extends UR = UR,
+  ChannelType extends UR = UR,
   CommandType extends string = LiteralStringForUnion,
-  EventType extends UnknownType = UnknownType,
-  MessageType extends UnknownType = UnknownType,
-  ReactionType extends UnknownType = UnknownType,
-  UserType extends UnknownType = UnknownType
+  EventType extends UR = UR,
+  MessageType extends UR = UR,
+  ReactionType extends UR = UR,
+  UserType extends UR = UR
 > = EventType & {
   type: EventTypes;
   channel?: ChannelResponse<ChannelType, CommandType, UserType>;
@@ -1071,14 +1014,7 @@ export type Event<
   mark_messages_deleted?: boolean;
   me?: OwnUserResponse<ChannelType, CommandType, UserType>;
   member?: ChannelMemberResponse<UserType>;
-  message?: MessageResponse<
-    AttachmentType,
-    ChannelType,
-    CommandType,
-    MessageType,
-    ReactionType,
-    UserType
-  >;
+  message?: MessageResponse<AttachmentType, ChannelType, CommandType, MessageType, ReactionType, UserType>;
   online?: boolean;
   parent_id?: string;
   reaction?: ReactionResponse<ReactionType, UserType>;
@@ -1092,29 +1028,19 @@ export type Event<
   watcher_count?: number;
 };
 
-export type UserCustomEvent<EventType extends UnknownType = UnknownType> = EventType & {
+export type UserCustomEvent<EventType extends UR = UR> = EventType & {
   type: string;
 };
 
 export type EventHandler<
-  AttachmentType extends UnknownType = UnknownType,
-  ChannelType extends UnknownType = UnknownType,
+  AttachmentType extends UR = UR,
+  ChannelType extends UR = UR,
   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;
+  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 type EventTypes =
   | 'all'
@@ -1126,6 +1052,7 @@ export type EventTypes =
   | 'channel.unmuted'
   | 'channel.updated'
   | 'channel.visible'
+  | 'transport.changed' // ws vs longpoll
   | 'connection.changed'
   | 'connection.recovered'
   | 'health.check'
@@ -1176,32 +1103,60 @@ export type MessageFlagsFiltersOptions = {
 export type MessageFlagsFilters = QueryFilters<
   {
     channel_cid?:
-      | RequireOnlyOne<
-          Pick<QueryFilter<MessageFlagsFiltersOptions['channel_cid']>, '$eq' | '$in'>
-        >
+      | RequireOnlyOne<Pick<QueryFilter<MessageFlagsFiltersOptions['channel_cid']>, '$eq' | '$in'>>
       | PrimitiveFilter<MessageFlagsFiltersOptions['channel_cid']>;
   } & {
     team?:
-      | RequireOnlyOne<
-          Pick<QueryFilter<MessageFlagsFiltersOptions['team']>, '$eq' | '$in'>
-        >
+      | RequireOnlyOne<Pick<QueryFilter<MessageFlagsFiltersOptions['team']>, '$eq' | '$in'>>
       | PrimitiveFilter<MessageFlagsFiltersOptions['team']>;
   } & {
     user_id?:
-      | RequireOnlyOne<
-          Pick<QueryFilter<MessageFlagsFiltersOptions['user_id']>, '$eq' | '$in'>
-        >
+      | RequireOnlyOne<Pick<QueryFilter<MessageFlagsFiltersOptions['user_id']>, '$eq' | '$in'>>
       | PrimitiveFilter<MessageFlagsFiltersOptions['user_id']>;
   } & {
-      [Key in keyof Omit<
-        MessageFlagsFiltersOptions,
-        'channel_cid' | 'user_id' | 'is_reviewed'
-      >]:
+      [Key in keyof Omit<MessageFlagsFiltersOptions, 'channel_cid' | 'user_id' | 'is_reviewed'>]:
         | RequireOnlyOne<QueryFilter<MessageFlagsFiltersOptions[Key]>>
         | PrimitiveFilter<MessageFlagsFiltersOptions[Key]>;
     }
 >;
 
+export type FlagReportsFiltersOptions = {
+  is_reviewed?: boolean;
+  message_id?: string;
+  report_id?: string;
+  review_result?: string;
+  reviewed_by?: string;
+  user_id?: string;
+};
+
+export type FlagReportsFilters = QueryFilters<
+  {
+    report_id?:
+      | RequireOnlyOne<Pick<QueryFilter<FlagReportsFiltersOptions['report_id']>, '$eq' | '$in'>>
+      | PrimitiveFilter<FlagReportsFiltersOptions['report_id']>;
+  } & {
+    review_result?:
+      | RequireOnlyOne<Pick<QueryFilter<FlagReportsFiltersOptions['review_result']>, '$eq' | '$in'>>
+      | PrimitiveFilter<FlagReportsFiltersOptions['review_result']>;
+  } & {
+    reviewed_by?:
+      | RequireOnlyOne<Pick<QueryFilter<FlagReportsFiltersOptions['reviewed_by']>, '$eq' | '$in'>>
+      | PrimitiveFilter<FlagReportsFiltersOptions['reviewed_by']>;
+  } & {
+    user_id?:
+      | RequireOnlyOne<Pick<QueryFilter<FlagReportsFiltersOptions['user_id']>, '$eq' | '$in'>>
+      | PrimitiveFilter<FlagReportsFiltersOptions['user_id']>;
+  } & {
+    message_id?:
+      | RequireOnlyOne<Pick<QueryFilter<FlagReportsFiltersOptions['message_id']>, '$eq' | '$in'>>
+      | PrimitiveFilter<FlagReportsFiltersOptions['message_id']>;
+  } & {
+      [Key in keyof Omit<
+        FlagReportsFiltersOptions,
+        'report_id' | 'user_id' | 'message_id' | 'review_result' | 'reviewed_by'
+      >]: RequireOnlyOne<QueryFilter<FlagReportsFiltersOptions[Key]>> | PrimitiveFilter<FlagReportsFiltersOptions[Key]>;
+    }
+>;
 export type BannedUsersFilterOptions = {
   banned_by_id?: string;
   channel_cid?: string;
@@ -1213,9 +1168,7 @@ export type BannedUsersFilterOptions = {
 export type BannedUsersFilters = QueryFilters<
   {
     channel_cid?:
-      | RequireOnlyOne<
-          Pick<QueryFilter<BannedUsersFilterOptions['channel_cid']>, '$eq' | '$in'>
-        >
+      | RequireOnlyOne<Pick<QueryFilter<BannedUsersFilterOptions['channel_cid']>, '$eq' | '$in'>>
       | PrimitiveFilter<BannedUsersFilterOptions['channel_cid']>;
   } & {
     reason?:
@@ -1233,9 +1186,9 @@ export type BannedUsersFilters = QueryFilters<
 >;
 
 export type ChannelFilters<
-  ChannelType = UnknownType,
+  ChannelType = UR,
   CommandType extends string = LiteralStringForUnion,
-  UserType = UnknownType
+  UserType = UR
 > = QueryFilters<
   ContainsOperator<ChannelType> & {
     members?:
@@ -1251,10 +1204,7 @@ export type ChannelFilters<
         >
       | PrimitiveFilter<ChannelResponse<ChannelType, CommandType, UserType>['name']>;
   } & {
-      [Key in keyof Omit<
-        ChannelResponse<{}, CommandType, UserType>,
-        'name' | 'members'
-      >]:
+      [Key in keyof Omit<ChannelResponse<{}, CommandType, UserType>, 'name' | 'members'>]:
         | RequireOnlyOne<QueryFilter<ChannelResponse<{}, CommandType, UserType>[Key]>>
         | PrimitiveFilter<ChannelResponse<{}, CommandType, UserType>[Key]>;
     }
@@ -1275,12 +1225,12 @@ export type ContainsOperator<CustomType = {}> = {
 };
 
 export type MessageFilters<
-  AttachmentType = UnknownType,
-  ChannelType = UnknownType,
+  AttachmentType = UR,
+  ChannelType = UR,
   CommandType extends string = LiteralStringForUnion,
-  MessageType = UnknownType,
-  ReactionType = UnknownType,
-  UserType = UnknownType
+  MessageType = UR,
+  ReactionType = UR,
+  UserType = UR
 > = QueryFilters<
   ContainsOperator<MessageType> & {
     text?:
@@ -1294,78 +1244,29 @@ export type MessageFilters<
               ReactionType,
               UserType
             >['text'];
-            $q?: MessageResponse<
-              AttachmentType,
-              ChannelType,
-              CommandType,
-              MessageType,
-              ReactionType,
-              UserType
-            >['text'];
+            $q?: MessageResponse<AttachmentType, ChannelType, CommandType, MessageType, ReactionType, UserType>['text'];
           } & QueryFilter<
-            MessageResponse<
-              AttachmentType,
-              ChannelType,
-              CommandType,
-              MessageType,
-              ReactionType,
-              UserType
-            >['text']
+            MessageResponse<AttachmentType, ChannelType, CommandType, MessageType, ReactionType, UserType>['text']
           >
         >
       | PrimitiveFilter<
-          MessageResponse<
-            AttachmentType,
-            ChannelType,
-            CommandType,
-            MessageType,
-            ReactionType,
-            UserType
-          >['text']
+          MessageResponse<AttachmentType, ChannelType, CommandType, MessageType, ReactionType, UserType>['text']
         >;
   } & {
       [Key in keyof Omit<
-        MessageResponse<
-          AttachmentType,
-          ChannelType,
-          CommandType,
-          {},
-          ReactionType,
-          UserType
-        >,
+        MessageResponse<AttachmentType, ChannelType, CommandType, {}, ReactionType, UserType>,
         'text'
       >]?:
         | RequireOnlyOne<
-            QueryFilter<
-              MessageResponse<
-                AttachmentType,
-                ChannelType,
-                CommandType,
-                {},
-                ReactionType,
-                UserType
-              >[Key]
-            >
+            QueryFilter<MessageResponse<AttachmentType, ChannelType, CommandType, {}, ReactionType, UserType>[Key]>
           >
-        | PrimitiveFilter<
-            MessageResponse<
-              AttachmentType,
-              ChannelType,
-              CommandType,
-              {},
-              ReactionType,
-              UserType
-            >[Key]
-          >;
+        | PrimitiveFilter<MessageResponse<AttachmentType, ChannelType, CommandType, {}, ReactionType, UserType>[Key]>;
     }
 >;
 
 export type PrimitiveFilter<ObjectType> = ObjectType | null;
 
-export type QueryFilter<ObjectType = string> = NonNullable<ObjectType> extends
-  | string
-  | number
-  | boolean
+export type QueryFilter<ObjectType = string> = NonNullable<ObjectType> extends string | number | boolean
   ? {
       $eq?: PrimitiveFilter<ObjectType>;
       $exists?: boolean;
@@ -1396,21 +1297,13 @@ export type QueryLogicalOperators<Operators> = {
   $or?: ArrayTwoOrMore<QueryFilters<Operators>>;
 };
 
-export type UserFilters<UserType = UnknownType> = QueryFilters<
+export type UserFilters<UserType = UR> = QueryFilters<
   ContainsOperator<UserType> & {
     id?:
-      | RequireOnlyOne<
-          { $autocomplete?: UserResponse<UserType>['id'] } & QueryFilter<
-            UserResponse<UserType>['id']
-          >
-        >
+      | RequireOnlyOne<{ $autocomplete?: UserResponse<UserType>['id'] } & QueryFilter<UserResponse<UserType>['id']>>
       | PrimitiveFilter<UserResponse<UserType>['id']>;
     name?:
-      | RequireOnlyOne<
-          { $autocomplete?: UserResponse<UserType>['name'] } & QueryFilter<
-            UserResponse<UserType>['name']
-          >
-        >
+      | RequireOnlyOne<{ $autocomplete?: UserResponse<UserType>['name'] } & QueryFilter<UserResponse<UserType>['name']>>
       | PrimitiveFilter<UserResponse<UserType>['name']>;
     teams?:
       | RequireOnlyOne<{
@@ -1420,9 +1313,7 @@ export type UserFilters<UserType = UnknownType> = QueryFilters<
       | PrimitiveFilter<UserResponse<UserType>['teams']>;
     username?:
       | RequireOnlyOne<
-          { $autocomplete?: UserResponse<UserType>['username'] } & QueryFilter<
-            UserResponse<UserType>['username']
-          >
+          { $autocomplete?: UserResponse<UserType>['username'] } & QueryFilter<UserResponse<UserType>['username']>
         >
       | PrimitiveFilter<UserResponse<UserType>['username']>;
   } & {
@@ -1440,11 +1331,9 @@ export type BannedUsersSort = BannedUsersSortBase | Array<BannedUsersSortBase>;
 
 export type BannedUsersSortBase = { created_at?: AscDesc };
 
-export type ChannelSort<ChannelType = UnknownType> =
-  | ChannelSortBase<ChannelType>
-  | Array<ChannelSortBase<ChannelType>>;
+export type ChannelSort<ChannelType = UR> = ChannelSortBase<ChannelType> | Array<ChannelSortBase<ChannelType>>;
 
-export type ChannelSortBase<ChannelType = UnknownType> = Sort<ChannelType> & {
+export type ChannelSortBase<ChannelType = UR> = Sort<ChannelType> & {
   created_at?: AscDesc;
   has_unread?: AscDesc;
   last_message_at?: AscDesc;
@@ -1454,19 +1343,20 @@ export type ChannelSortBase<ChannelType = UnknownType> = Sort<ChannelType> & {
   updated_at?: AscDesc;
 };
 
+export type PinnedMessagesSort = PinnedMessagesSortBase | Array<PinnedMessagesSortBase>;
+export type PinnedMessagesSortBase = { pinned_at?: AscDesc };
+
 export type Sort<T> = {
   [P in keyof T]?: AscDesc;
 };
 
-export type UserSort<UserType = UnknownType> =
-  | Sort<UserResponse<UserType>>
-  | Array<Sort<UserResponse<UserType>>>;
+export type UserSort<UserType = UR> = Sort<UserResponse<UserType>> | Array<Sort<UserResponse<UserType>>>;
 
-export type MemberSort<UserType = UnknownType> =
+export type MemberSort<UserType = UR> =
   | Sort<Pick<UserResponse<UserType>, 'id' | 'created_at' | 'name'>>
   | Array<Sort<Pick<UserResponse<UserType>, 'id' | 'created_at' | 'name'>>>;
 
-export type SearchMessageSortBase<MessageType = UnknownType> = Sort<MessageType> & {
+export type SearchMessageSortBase<MessageType = UR> = Sort<MessageType> & {
   attachments?: AscDesc;
   'attachments.type'?: AscDesc;
   created_at?: AscDesc;
@@ -1482,15 +1372,11 @@ export type SearchMessageSortBase<MessageType = UnknownType> = Sort<MessageType>
   'user.id'?: AscDesc;
 };
 
-export type SearchMessageSort<MessageType = UnknownType> =
+export type SearchMessageSort<MessageType = UR> =
   | SearchMessageSortBase<MessageType>
   | Array<SearchMessageSortBase<MessageType>>;
 
-export type QuerySort<
-  ChannelType = UnknownType,
-  UserType = UnknownType,
-  MessageType = UnknownType
-> =
+export type QuerySort<ChannelType = UR, UserType = UR, MessageType = UR> =
   | BannedUsersSort
   | ChannelSort<ChannelType>
   | SearchMessageSort<MessageType>
@@ -1567,7 +1453,7 @@ export type AppSettings = {
   webhook_url?: string;
 };
 
-export type Attachment<T = UnknownType> = T & {
+export type Attachment<T = UR> = T & {
   actions?: Action[];
   asset_url?: string;
   author_icon?: string;
@@ -1606,9 +1492,7 @@ export type BlockList = {
   words: string[];
 };
 
-export type ChannelConfig<
-  CommandType extends string = LiteralStringForUnion
-> = ChannelConfigFields &
+export type ChannelConfig<CommandType extends string = LiteralStringForUnion> = ChannelConfigFields &
   CreatedAtUpdatedAt & {
     commands?: CommandVariants<CommandType>[];
   };
@@ -1644,19 +1528,17 @@ export type ChannelConfigFields = {
   url_enrichment?: boolean;
 };
 
-export type ChannelConfigWithInfo<
-  CommandType extends string = LiteralStringForUnion
-> = ChannelConfigFields &
+export type ChannelConfigWithInfo<CommandType extends string = LiteralStringForUnion> = ChannelConfigFields &
   CreatedAtUpdatedAt & {
     commands?: CommandResponse<CommandType>[];
   };
 
-export type ChannelData<ChannelType = UnknownType> = ChannelType & {
+export type ChannelData<ChannelType = UR> = ChannelType & {
   members?: string[];
   name?: string;
 };
 
-export type ChannelMembership<UserType = UnknownType> = {
+export type ChannelMembership<UserType = UR> = {
   banned?: boolean;
   channel_role?: Role;
   created_at?: string;
@@ -1668,9 +1550,9 @@ export type ChannelMembership<UserType = UnknownType> = {
 };
 
 export type ChannelMute<
-  ChannelType extends UnknownType = UnknownType,
+  ChannelType extends UR = UR,
   CommandType extends string = LiteralStringForUnion,
-  UserType extends UnknownType = UnknownType
+  UserType extends UR = UR
 > = {
   user: UserResponse<UserType>;
   channel?: ChannelResponse<ChannelType, CommandType, UserType>;
@@ -1687,7 +1569,7 @@ export type ChannelRole = {
   same_team?: boolean;
 };
 
-export type CheckPushInput<UserType = UnknownType> = {
+export type CheckPushInput<UserType = UR> = {
   apn_template?: string;
   client_id?: string;
   connection_id?: string;
@@ -1717,9 +1599,9 @@ export type Configs<CommandType extends string = LiteralStringForUnion> = {
 };
 
 export type ConnectionOpen<
-  ChannelType extends UnknownType = UnknownType,
+  ChannelType extends UR = UR,
   CommandType extends string = LiteralStringForUnion,
-  UserType extends UnknownType = UnknownType
+  UserType extends UR = UR
 > = {
   connection_id: string;
   cid?: string;
@@ -1733,7 +1615,7 @@ export type CreatedAtUpdatedAt = {
   updated_at: string;
 };
 
-export type Device<UserType = UnknownType> = DeviceFields & {
+export type Device<UserType = UR> = DeviceFields & {
   provider?: string;
   user?: UserResponse<UserType>;
   user_id?: string;
@@ -1839,13 +1721,16 @@ export type EndpointName =
 export type ExportChannelRequest = {
   id: string;
   type: string;
+  cid?: string;
   messages_since?: Date;
   messages_until?: Date;
 };
 
 export type ExportChannelOptions = {
   clear_deleted_message_text?: boolean;
+  export_users?: boolean;
   include_truncated_messages?: boolean;
+  version?: string;
 };
 
 export type Field = {
@@ -1875,31 +1760,25 @@ export type HuaweiConfig = {
 
 export type LiteralStringForUnion = string & {};
 
-export type Logger = (
-  logLevel: 'info' | 'error' | 'warn',
-  message: string,
-  extraData?: Record<string, unknown>,
-) => void;
-
-export type Message<
-  AttachmentType = UnknownType,
-  MessageType = UnknownType,
-  UserType = UnknownType
-> = Partial<MessageBase<AttachmentType, MessageType, UserType>> & {
+export type LogLevel = 'info' | 'error' | 'warn';
+
+export type Logger = (logLevel: LogLevel, message: string, extraData?: Record<string, unknown>) => void;
+
+export type Message<AttachmentType = UR, MessageType = UR, UserType = UR> = Partial<
+  MessageBase<AttachmentType, MessageType, UserType>
+> & {
   mentioned_users?: string[];
 };
 
-export type MessageBase<
-  AttachmentType = UnknownType,
-  MessageType = UnknownType,
-  UserType = UnknownType
-> = MessageType & {
+export type MessageBase<AttachmentType = UR, MessageType = UR, UserType = UR> = MessageType & {
   id: string;
   attachments?: Attachment<AttachmentType>[];
   html?: string;
   mml?: string;
   parent_id?: string;
+  pin_expires?: string;
   pinned?: boolean;
+  pinned_at?: string;
   quoted_message_id?: string;
   show_in_channel?: boolean;
   text?: string;
@@ -1907,38 +1786,32 @@ export type MessageBase<
   user_id?: string;
 };
 
-export type MessageLabel =
-  | 'deleted'
-  | 'ephemeral'
-  | 'error'
-  | 'regular'
-  | 'reply'
-  | 'system';
+export type MessageLabel = 'deleted' | 'ephemeral' | 'error' | 'regular' | 'reply' | 'system';
 
-export type Mute<UserType = UnknownType> = {
+export type Mute<UserType = UR> = {
   created_at: string;
   target: UserResponse<UserType>;
   updated_at: string;
   user: UserResponse<UserType>;
 };
 
-export type PartialUpdateChannel<ChannelType = UnknownType> = {
+export type PartialUpdateChannel<ChannelType = UR> = {
   set?: Partial<ChannelResponse<ChannelType>>;
   unset?: Array<keyof ChannelResponse<ChannelType>>;
 };
 
-export type PartialUserUpdate<UserType = UnknownType> = {
+export type PartialUserUpdate<UserType = UR> = {
   id: string;
   set?: Partial<UserResponse<UserType>>;
   unset?: Array<keyof UserResponse<UserType>>;
 };
 
-export type MessageUpdatableFields<MessageType = UnknownType> = Omit<
+export type MessageUpdatableFields<MessageType = UR> = Omit<
   MessageResponse<MessageType>,
   'cid' | 'created_at' | 'updated_at' | 'deleted_at' | 'user' | 'user_id'
 >;
 
-export type PartialMessageUpdate<MessageType = UnknownType> = {
+export type PartialMessageUpdate<MessageType = UR> = {
   set?: Partial<MessageUpdatableFields<MessageType>>;
   unset?: Array<keyof MessageUpdatableFields<MessageType>>;
 };
@@ -1949,6 +1822,7 @@ export type PermissionAPIObject = {
   custom?: boolean;
   description?: string;
   id?: string;
+  level?: string;
   name?: string;
   owner?: boolean;
   same_team?: boolean;
@@ -1982,10 +1856,7 @@ export type RateLimitsInfo = {
 
 export type RateLimitsMap = Record<EndpointName, RateLimitsInfo>;
 
-export type Reaction<
-  ReactionType = UnknownType,
-  UserType = UnknownType
-> = ReactionType & {
+export type Reaction<ReactionType = UR, UserType = UR> = ReactionType & {
   type: string;
   message_id?: string;
   score?: number;
@@ -2014,12 +1885,12 @@ export type Resource =
   | 'UploadAttachment';
 
 export type SearchPayload<
-  AttachmentType = UnknownType,
-  ChannelType = UnknownType,
+  AttachmentType = UR,
+  ChannelType = UR,
   CommandType extends string = LiteralStringForUnion,
-  MessageType = UnknownType,
-  ReactionType = UnknownType,
-  UserType = UnknownType
+  MessageType = UR,
+  ReactionType = UR,
+  UserType = UR
 > = Omit<SearchOptions<MessageType>, 'sort'> & {
   client_id?: string;
   connection_id?: string;
@@ -2118,26 +1989,33 @@ export type TranslationLanguages =
 
 export type TypingStartEvent = Event;
 
+export type ReservedMessageFields =
+  | 'command'
+  | 'created_at'
+  | 'html'
+  | 'latest_reactions'
+  | 'own_reactions'
+  | 'quoted_message'
+  | 'reaction_counts'
+  | 'reply_count'
+  | 'type'
+  | 'updated_at'
+  | 'user'
+  | '__html';
+
 export type UpdatedMessage<
-  AttachmentType = UnknownType,
-  ChannelType = UnknownType,
+  AttachmentType = UR,
+  ChannelType = UR,
   CommandType extends string = LiteralStringForUnion,
-  MessageType = UnknownType,
-  ReactionType = UnknownType,
-  UserType = UnknownType
+  MessageType = UR,
+  ReactionType = UR,
+  UserType = UR
 > = Omit<
-  MessageResponse<
-    AttachmentType,
-    ChannelType,
-    CommandType,
-    MessageType,
-    ReactionType,
-    UserType
-  >,
+  MessageResponse<AttachmentType, ChannelType, CommandType, MessageType, ReactionType, UserType>,
   'mentioned_users'
 > & { mentioned_users?: string[] };
 
-export type User<UserType = UnknownType> = UserType & {
+export type User<UserType = UR> = UserType & {
   id: string;
   anon?: boolean;
   name?: string;
@@ -2203,14 +2081,7 @@ export type CampaignData = {
 
 export type CampaignStatus = {
   errors: string[];
-  status:
-    | 'draft'
-    | 'stopped'
-    | 'scheduled'
-    | 'completed'
-    | 'failed'
-    | 'canceled'
-    | 'in_progress';
+  status: 'draft' | 'stopped' | 'scheduled' | 'completed' | 'failed' | 'canceled' | 'in_progress';
   completed_at?: string;
   failed_at?: string;
   progress?: number;
@@ -2236,5 +2107,12 @@ export type TaskStatus = {
     description: string;
     type: string;
   };
-  result?: UnknownType;
+  result?: UR;
+};
+
+export type TruncateOptions<AttachmentType, MessageType, UserType> = {
+  hard_delete?: boolean;
+  message?: Message<AttachmentType, MessageType, UserType>;
+  skip_push?: boolean;
+  truncated_at?: Date;
 };