Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Breaking changes
1. Chat API – return type change
runMessageAction,commitMessage,translateMessagenow returnPromise<StreamResponse<MessageActionResponse>>instead ofPromise<StreamResponse<MessageResponse>>.MessageResponsewas replaced byMessageActionResponsefor these methods. Code that types the result asMessageResponseor destructures assumingMessageResponsewill break.2. Removed types / decoders (no direct replacement)
ActivityMarkedEvent– removed.AnyEvent– removed.Channel– removed (replaced byChannelResponsein event payloads).ChannelMember– removed (replaced byChannelMemberResponse).ChannelMemberLookup– removed.Device– removed (onlyDeviceResponseremains).Message– removed (useMessageResponse).DeliveryReceipts,ReadReceipts,TypingIndicators– removed.DenormalizedChannelFields– removed.MessageReminder,Poll,PollOption,PollVote– removed.PrivacySettings,PushPreferences– removed (replaced by request/response variants).SessionClient– removed.SortParam– removed.OwnUser– removed (check current exports for replacement).ConfigOverrides,Coordinates,Location,Label,LimitInfo– removed (replaced by*Responseor*Requestvariants).Flag,FlagDetails,FlagFeedback,FlagMessageDetails– removed (replaced by*Response).ModerationActionConfig– removed (replaced byModerationActionConfigResponse).FeedsModerationTemplateConfig– removed (replaced byFeedsModerationTemplateConfigPayload).ChannelMessages– removed (replaced byChannelMessagesResponse).ChannelPushPreferences– removed.ParsedPredefinedFilter– removed (replaced byParsedPredefinedFilterResponse).Any code that imports or references these types/decoders will break.
3. Renamed types (same shape, new name)
AutomodDetailsAutomodDetailsResponseBanBanInfoResponse(andchannel/target→user)MessageResponse(for action endpoints)MessageActionResponseReactionGroupResponse(in Feeds)FeedsReactionGroupResponse4. Request/response type renames
Many request types were renamed with a
PayloadorRequest/Responsesuffix, e.g.:BanActionRequest→BanActionRequestPayloadBlockActionRequest→BlockActionRequestPayloadChannelMemberRequest/ChannelMemberResponse– redefined (previously different shapes).ConfigOverrides→ConfigOverridesRequestCustomActionRequest→CustomActionRequestPayloadDeleteActivityRequest→DeleteActivityRequestPayloadDeleteCommentRequest→DeleteCommentRequestPayloadDeleteMessageRequest→DeleteMessageRequestPayloadDeleteReactionRequest→DeleteReactionRequestPayloadDeleteUserRequest→DeleteUserRequestPayloadMarkReviewedRequest→MarkReviewedRequestPayloadRejectAppealRequest→RejectAppealRequestPayloadRestoreActionRequest→RestoreActionRequestPayloadSIPChallenge→SIPChallengeRequestShadowBlockActionRequest→ShadowBlockActionRequestPayloadUnbanActionRequest→UnbanActionRequestPayloadUnblockActionRequest→UnblockActionRequestPayloadImports or type annotations using the old names will break.
5.
Ban/BanInfoResponseshape changeBan→BanInfoResponse:channelandtargetwere removed.user(replacingtarget) andcreated_byare nowUserResponse.Code that used
Ban.channelorBan.targetwill break.6. Event payloads –
User→UserResponseCommonFieldsChannel and related events now use
UserResponseCommonFieldsinstead ofUserfor theuserfield (e.g.ChannelHiddenEvent,ChannelUpdatedEvent,ChannelVisibleEvent,ChannelCreatedEvent,ChannelDeletedEvent,ChannelMutedEvent,ChannelUnmutedEvent,ChannelTruncatedEvent).Some events also gained
received_atandchannel. Code that typesuserasUserwill break.7.
ActivityResponse(Feeds)reaction_groupstype:ReactionGroupResponse→FeedsReactionGroupResponse.