ChatApi.h

// Copyright 2026 Stream.IO, Inc. All Rights Reserved.
 
#pragma once
 
#include "ChannelFlags.h"
#include "CoreMinimal.h"
#include "Request/Channel/ChannelRequestDto.h"
#include "Request/Channel/MessagePaginationParamsRequestDto.h"
#include "Request/Channel/PaginationParamsRequestDto.h"
#include "Request/Message/MessageRequestDto.h"
#include "Request/SortParamRequestDto.h"
#include "RequestBuilder.h"
#include "StreamJson.h"
 
#include <type_traits>
 
class FHttpClient;
class FRequestBuilder;
class FTokenManager;
enum class EPushProvider : uint8;
struct FBlockUserResponseDto;
struct FChannelResponseDto;
struct FChannelSortOption;
struct FChannelStateResponseDto;
struct FChannelsResponseDto;
struct FDeleteChannelResponseDto;
struct FEventResponseDto;
struct FFlagResponseDto;
struct FGetBlockedUsersResponseDto;
struct FGetReactionsResponseDto;
struct FGuestResponseDto;
struct FHttpResponse;
struct FListDevicesResponseDto;
struct FMarkReadRequestDto;
struct FMarkReadResponseDto;
struct FMembersResponseDto;
struct FMessageResponseDto;
struct FMuteChannelResponseDto;
struct FMuteUserResponseDto;
struct FQueryBannedUsersResponseDto;
struct FReactionRequestDto;
struct FReactionResponseDto;
struct FResponseDto;
struct FSearchResponseDto;
struct FToken;
struct FTruncateChannelResponseDto;
struct FUpdateChannelPartialResponseDto;
struct FUpdateChannelRequestDto;
struct FUpdateChannelResponseDto;
struct FUpdateUsersResponseDto;
struct FUserObjectRequestDto;
struct FUsersResponseDto;
 
template <class T>
using TCallback = TFunction<void(const TResponse<T>&)>;
 
class STREAMCHATAPI_API FChatApi : public TSharedFromThis<FChatApi>
{
public:
    static TSharedRef<FChatApi> Create(const FString& InApiKey, const FString& InHost, const TSharedPtr<FTokenManager>&);
 
#pragma region Moderation
    void BanUser(
        const FString& TargetUserId,
        const FString& Type = {},
        const FString& Id = {},
        const TOptional<FTimespan>& Timeout = {},
        const TOptional<FString>& Reason = {},
        bool bShadow = false,
        bool bIpBan = false,
        TCallback<FResponseDto> Callback = {}) const;
 
    void UnbanUser(const FString& TargetUserId, const FString& Type = {}, const FString& Id = {}, TCallback<FResponseDto> Callback = {}) const;
 
    void QueryBannedUsers(
        const TSharedRef<FJsonObject>& Filter,
        const TArray<FSortParamRequestDto>& SortOptions = {},
        const TOptional<FDateTime> CreatedAtAfterOrEqual = {},
        const TOptional<FDateTime> CreatedAtAfter = {},
        const TOptional<FDateTime> CreatedAtBeforeOrEqual = {},
        const TOptional<FDateTime> CreatedAtBefore = {},
        TOptional<uint32> Limit = {},
        TOptional<uint32> Offset = {},
        TCallback<FQueryBannedUsersResponseDto> Callback = {}) const;
 
    void Flag(const FString& TargetMessageId = {}, const FString& TargetUserId = {}, TCallback<FFlagResponseDto> Callback = {}) const;
 
    void MuteUsers(const TArray<FString>& TargetUserIds, TOptional<FTimespan> Timeout = {}, TCallback<FMuteUserResponseDto> Callback = {}) const;
 
    void UnmuteUsers(const TArray<FString>& TargetUserIds, TCallback<FResponseDto> Callback = {}) const;
 
    void MuteChannels(const TArray<FString>& TargetCids, TOptional<FTimespan> Timeout = {}, TCallback<FMuteChannelResponseDto> Callback = {}) const;
 
    void UnmuteChannels(const TArray<FString>& TargetCids, TCallback<FResponseDto> Callback = {}) const;
 
    void BlockUser(const FString& TargetUserId, TCallback<FBlockUserResponseDto> Callback = {}) const;
 
    void UnblockUser(const FString& TargetUserId, TCallback<FResponseDto> Callback = {}) const;
 
    void GetBlockedUsers(TCallback<FGetBlockedUsersResponseDto> Callback = {}) const;
 
#pragma endregion Moderation
 
#pragma region Channels
    void QueryChannel(
        const FString& ChannelType,
        const FString& ConnectionId,
        EChannelFlags Flags = EChannelFlags::State,
        const FChannelRequestDto& Data = {},
        const TOptional<FString>& ChannelId = {},
        const TOptional<FMessagePaginationParamsRequestDto> MessagePagination = {},
        const TOptional<FPaginationParamsRequestDto> MemberPagination = {},
        const TOptional<FPaginationParamsRequestDto> WatcherPagination = {},
        TCallback<FChannelStateResponseDto> Callback = {}) const;
 
    void DeleteChannel(const FString& ChannelType, const FString& ChannelId, TCallback<FDeleteChannelResponseDto> Callback = {}) const;
 
    void PartialUpdateChannel(
        const FString& ChannelType,
        const FString& ChannelId,
        const TSharedRef<FJsonObject>& Set,
        const TArray<FString>& Unset,
        TCallback<FUpdateChannelPartialResponseDto> Callback = {}) const;
 
    void UpdateChannel(
        const FString& ChannelType,
        const FString& ChannelId,
        const FUpdateChannelRequestDto& Data,
        TCallback<FUpdateChannelResponseDto> Callback = {}) const;
 
    void HideChannel(const FString& ChannelType, const FString& ChannelId, bool bClearHistory = false, TCallback<FResponseDto> Callback = {}) const;
 
    void ShowChannel(const FString& ChannelType, const FString& ChannelId, TCallback<FResponseDto> Callback = {}) const;
 
    void QueryChannels(
        const FString& ConnectionId,
        EChannelFlags Flags = EChannelFlags::State | EChannelFlags::Watch,
        const TOptional<TSharedRef<FJsonObject>>& Filter = {},
        const TArray<FSortParamRequestDto>& SortOptions = {},
        TOptional<uint32> MemberLimit = {},
        TOptional<uint32> MessageLimit = {},
        TOptional<uint32> Limit = {},
        TOptional<uint32> Offset = {},
        TCallback<FChannelsResponseDto> Callback = {}) const;
 
    void StopWatchingChannel(const FString& ChannelType, const FString& ChannelId, const FString& ConnectionId, TCallback<FResponseDto> Callback = {}) const;
 
    void SearchMessages(
        const TSharedRef<FJsonObject>& ChannelFilter,
        const TOptional<FString>& Query = {},
        const TOptional<TSharedRef<FJsonObject>>& MessageFilter = {},
        const TArray<FSortParamRequestDto>& Sort = {},
        TOptional<uint32> MessageLimit = {},
        TOptional<uint32> Offset = {},
        TOptional<FString> Next = {},
        TCallback<FSearchResponseDto> Callback = {}) const;
 
    void MarkChannelsRead(TCallback<FMarkReadResponseDto> Callback = {}) const;
 
    void MarkChannelRead(
        const FString& ChannelType,
        const FString& ChannelId,
        const TOptional<FString>& MessageId = {},
        TCallback<FMarkReadResponseDto> Callback = {}) const;
 
    void QueryMembers(
        const FString& ChannelType,
        const TOptional<TSharedRef<FJsonObject>>& Filter = {},
        const TOptional<FString>& ChannelId = {},
        const TOptional<TArray<FString>>& Members = {},
        const TArray<FSortParamRequestDto>& SortOptions = {},
        const FMessagePaginationParamsRequestDto& Pagination = {},
        TCallback<FMembersResponseDto> Callback = {}) const;
 
    void TruncateChannel(
        const FString& ChannelType,
        const FString& ChannelId,
        bool bHardDelete = false,
        const TOptional<FDateTime>& TruncatedAt = {},
        const TOptional<FMessageRequestDto>& Message = {},
        bool bSkipPush = false,
        TCallback<FTruncateChannelResponseDto> Callback = {}) const;
 
#pragma endregion Channels
 
#pragma region Messages
    void GetMessage(const FString& MessageId, TCallback<FMessageResponseDto> Callback = {}) const;
 
    void SendNewMessage(
        const FString& ChannelType,
        const FString& ChannelId,
        const FMessageRequestDto& MessageRequest,
        bool bSkipPush = false,
        TCallback<FMessageResponseDto> Callback = {}) const;
 
    void UpdateMessage(const FMessageRequestDto& MessageRequest, TCallback<FMessageResponseDto> Callback = {}) const;
 
    void DeleteMessage(const FString& Id, bool bHard = false, TCallback<FMessageResponseDto> Callback = {}) const;
 
    void SendReaction(
        const FString& MessageId,
        const FName& Type,
        bool bEnforceUnique = true,
        TOptional<uint32> Score = {},
        bool bSkipPush = false,
        TCallback<FReactionResponseDto> Callback = {}) const;
 
    void DeleteReaction(const FString& MessageId, const FName& Type, TCallback<FReactionResponseDto> Callback = {}) const;
 
    void GetReactions(const FString& MessageId, TOptional<uint32> Limit, TOptional<uint32> Offset, TCallback<FGetReactionsResponseDto> Callback = {}) const;
 
#pragma endregion Messages
 
#pragma region Events
    template <class TEvent>
    void SendChannelEvent(const FString& ChannelType, const FString& ChannelId, const TEvent&, TCallback<FEventResponseDto> Callback = {});
 
#pragma endregion Events
 
#pragma region Files
#pragma endregion Files
 
#pragma region Users
    void QueryUsers(
        const FString& ConnectionId,
        bool bPresence = true,
        const TOptional<TSharedRef<FJsonObject>>& Filter = {},
        const TArray<FSortParamRequestDto>& SortOptions = {},
        TOptional<uint32> Limit = {},
        TOptional<uint32> Offset = {},
        TCallback<FUsersResponseDto> Callback = {}) const;
 
    void CreateGuest(const FUserObjectRequestDto& User, TCallback<FGuestResponseDto> Callback = {}) const;
 
    struct FPartialUpdateUser
    {
        const FString& UserId;
        const TSharedRef<FJsonObject>& Set;
        const TArray<FString>& Unset;
    };
 
    void PartialUpdateUsers(const TArray<FPartialUpdateUser>& Users, TCallback<FUpdateUsersResponseDto> Callback = {}) const;
 
    void UpsertUsers(const TMap<FString, FUserObjectRequestDto>& Users, TCallback<FUpdateUsersResponseDto> Callback = {}) const;
 
#pragma endregion Users
 
#pragma region Devices
    void AddDevice(const FString& DeviceId, EPushProvider PushProvider, TCallback<FResponseDto> Callback = {}) const;
 
    void RemoveDevice(const FString& DeviceId, TCallback<FResponseDto> Callback = {}) const;
 
    void ListDevices(TCallback<FListDevicesResponseDto> Callback = {}) const;
 
#pragma endregion Devices
 
private:
    explicit FChatApi(const FString& InApiKey, const FString& InHost, const TSharedPtr<FTokenManager>&);
    void SendChannelEventInternal(
        const FString& ChannelType,
        const FString& ChannelId,
        const TSharedRef<FJsonObject>& Event,
        TCallback<FEventResponseDto> Callback = {}) const;
 
    FString BuildUrl(const FString& Path) const;
 
    void AddAuth(FRequestBuilder&, const FToken& Token) const;
    void OnRequest(FRequestBuilder&) const;
    void OnError(const FHttpResponse&, FRequestBuilder&) const;
 
    TSharedPtr<FTokenManager> TokenManager;
    FString ApiKey;
 
    TSharedPtr<FHttpClient> Client;
    FString Scheme;
    FString Host;
};
 
template <class TEvent>
void FChatApi::SendChannelEvent(const FString& ChannelType, const FString& ChannelId, const TEvent& Event, const TCallback<FEventResponseDto> Callback)
{
    static_assert(
        std::is_same_v<decltype(TEvent::StaticType()), FName>,
        "TEvent must have a static method 'StaticType' which returns a FName to use with SendChannelEvent.");
    SendChannelEventInternal(ChannelType, ChannelId, JsonObject::UStructToJsonObject<TEvent>(Event), Callback);
}