@amityco/ts-sdk 6.12.2-d74459e.0 → 6.12.2-e855934.0

package/src/@types/core/model.ts

@@ -7,7 +7,7 @@ declare global {
      * @hidden
      */
     type Models = {
-      user: Amity.User;
+      user: Amity.InternalUser;
       file: Amity.File;
       role: Amity.Role;
 
@@ -26,7 +26,7 @@ declare global {
       userMarker: Amity.UserMarker;
 
       community: Amity.Community;
-      category: Amity.Category;
+      category: Amity.InternalCategory;
       communityUsers: Amity.Membership<'community'>;
       post: Amity.Post;
       comment: Amity.InternalComment;
@@ -52,7 +52,7 @@ declare global {
      * @hidden
      */
     type Minimal = {
-      user: Pick<Amity.User, 'userId'>;
+      user: Pick<Amity.InternalUser, 'userId'>;
       file: Pick<Amity.File, 'fileId'>;
       role: Pick<Amity.Role, 'roleId'>;
 
@@ -71,7 +71,7 @@ declare global {
       userMarker: Pick<Amity.UserMarker, 'userId'>;
 
       community: Pick<Amity.Community, 'communityId'>;
-      category: Pick<Amity.Category, 'categoryId'>;
+      category: Pick<Amity.InternalCategory, 'categoryId'>;
       communityUsers: Pick<Amity.Membership<'community'>, 'communityId' | 'userId'>;
       post: Pick<Amity.Post, 'postId'>;
       comment: Pick<Amity.InternalComment, 'commentId'>;

package/src/@types/core/payload.ts

@@ -21,7 +21,7 @@ declare global {
     };
 
     type UserPayload = {
-      users: Amity.User[];
+      users: Amity.InternalUser[];
       files: Amity.File<'image'>[];
     };
 
@@ -117,14 +117,14 @@ declare global {
       contentMarkers: Amity.MessageMarker[];
       feedMarkers: Amity.FeedMarker[];
       userFeedMarkers: UserFeedMarkerResponse[];
-      publicUserIds: Amity.User['userId'][];
+      publicUserIds: Amity.InternalUser['userId'][];
     };
 
     type DeliveredUserPayload = {
       contentMarkers: Amity.MessageMarker[];
       feedMarkers: Amity.FeedMarker[];
       userFeedMarkers: UserFeedMarkerResponse[];
-      publicUserIds: Amity.User['userId'][];
+      publicUserIds: Amity.InternalUser['userId'][];
     };
 
     type StartReadingPayload = {
@@ -167,7 +167,7 @@ declare global {
     type SubChannelPayload<T extends Amity.MessageContentType = any> = {
       messageFeeds: Amity.RawSubChannel[];
       messages: Amity.RawMessage<T>[];
-      users: Amity.User[];
+      users: Amity.InternalUser[];
       files: Amity.File[];
     };
 
@@ -179,7 +179,7 @@ declare global {
     type ProcessedSubChannelPayload<T extends Amity.MessageContentType = any> = {
       messageFeeds: Amity.SubChannel[];
       messages: Amity.Message<T>[];
-      users: Amity.User[];
+      users: Amity.InternalUser[];
       files: Amity.File[];
     };
 
@@ -210,7 +210,7 @@ declare global {
     type ProcessedMessagePayload<T extends Amity.MessageContentType = any> = {
       messages: Amity.Message<T>[];
       messageFeeds: Amity.SubChannel[];
-      users: Amity.User[];
+      users: Amity.InternalUser[];
       files: Amity.File[];
       reactions: Amity.Reactor[];
     };
@@ -225,16 +225,16 @@ declare global {
 
     type StreamPayload = {
       videoStreamings: Amity.Stream[];
-      users: Amity.User[];
+      users: Amity.InternalUser[];
       files: Amity.File<'image'>[];
     };
 
     type CommunityPayload = {
       communities: Amity.RawCommunity[];
       communityUsers: Amity.RawMembership<'community'>[];
-      categories: Amity.Category[];
+      categories: Amity.InternalCategory[];
       feeds: Amity.Feed[];
-      users: Amity.User[];
+      users: Amity.InternalUser[];
       files: Amity.File[];
     };
 
@@ -249,16 +249,16 @@ declare global {
     };
 
     type CategoryPayload = {
-      categories: Amity.Category[];
+      categories: Amity.InternalCategory[];
       files: Amity.File[];
     };
 
     type CommunityMembershipPayload = {
       communities: Amity.RawCommunity[];
       communityUsers: Amity.RawMembership<'community'>[];
-      categories: Amity.Category[];
+      categories: Amity.InternalCategory[];
       feeds: Amity.Feed[];
-      users: Amity.User[];
+      users: Amity.InternalUser[];
       files: Amity.File[];
     };
 
@@ -280,10 +280,10 @@ declare global {
       postChildren: Amity.Post[];
       communities: Amity.RawCommunity[];
       communityUsers: Amity.RawMembership<'community'>[];
-      categories: Amity.Category[];
+      categories: Amity.InternalCategory[];
       comments: Amity.InternalComment[];
       feeds: Amity.Feed[];
-      users: Amity.User[];
+      users: Amity.InternalUser[];
       files: Amity.File[];
     };
 
@@ -300,19 +300,19 @@ declare global {
     type CommentPayload<T extends Amity.CommentContentType = any> = {
       comments: Amity.InternalComment<T>[];
       commentChildren: Amity.InternalComment[];
-      users: Amity.User[];
+      users: Amity.InternalUser[];
       files: Amity.File[];
       communityUsers: Amity.Membership<'community'>[];
     };
 
     type PollPayload = {
-      users: Amity.User[];
+      users: Amity.InternalUser[];
       polls: Amity.Poll[];
     };
 
     type ReactionPayload = {
       reactions: Amity.Reaction[];
-      users: Amity.User[];
+      users: Amity.InternalUser[];
     };
 
     type GlobalFeedPayload = Amity.PostPayload;

package/src/@types/domains/block.ts

@@ -14,7 +14,7 @@ declare global {
     type BlockedUsersLiveCollection = Amity.LiveCollectionParams<QueryBlockedUser>;
 
     type BlockedUserLiveCollectionCache = Amity.LiveCollectionCache<
-      Amity.User['userId'],
+      Amity.InternalUser['userId'],
       {
         page: Amity.Page;
         total: number;

package/src/@types/domains/category.ts

@@ -2,7 +2,7 @@ export {};
 
 declare global {
   namespace Amity {
-    type Category = {
+    type InternalCategory = {
       categoryId: string;
       name: string;
       avatarFileId?: Amity.File<'image'>['fileId'];
@@ -10,6 +10,10 @@ declare global {
       Amity.Timestamps &
       Amity.SoftDelete;
 
+    type Category = InternalCategory & {
+      avatar?: Amity.File<'image'> | null;
+    };
+
     type QueryCategories = {
       includeDeleted?: boolean;
       sortBy?: 'name' | 'firstCreated' | 'lastCreated';
@@ -19,7 +23,7 @@ declare global {
     type CategoryLiveCollection = Amity.LiveCollectionParams<Omit<QueryCategories, 'page'>>;
 
     type CategoryLiveCollectionCache = Amity.LiveCollectionCache<
-      Amity.Category['categoryId'],
+      Amity.InternalCategory['categoryId'],
       Pick<QueryCategories, 'page'>
     >;
   }

package/src/@types/domains/client.ts

@@ -119,8 +119,8 @@ declare global {
     };
 
     type ConnectClientParams = {
-      userId: Amity.User['userId'];
-      displayName?: Amity.User['displayName'];
+      userId: Amity.InternalUser['userId'];
+      displayName?: Amity.InternalUser['displayName'];
       authToken?: string;
       deviceId?: Amity.Device['deviceId'];
     };
@@ -129,7 +129,7 @@ declare global {
       disableRTE: boolean;
     };
 
-    type ActiveUser = Pick<Amity.User, '_id' | 'userId' | 'path' | 'displayName'>;
+    type ActiveUser = Pick<Amity.InternalUser, '_id' | 'userId' | 'path' | 'displayName'>;
 
     type UserUnread = Pick<Amity.UserMarker, 'unreadCount' | 'hasMentioned'>;
   }

package/src/@types/domains/comment.ts

@@ -40,7 +40,7 @@ declare global {
     type CommentTarget = {
       type: InternalComment['targetType'] | 'unknown';
       communityId?: Amity.Community['communityId'];
-      userId?: Amity.User['userId'];
+      userId?: Amity.InternalUser['userId'];
       contentId?: string;
       creatorMember?: Amity.Membership<'community'>;
     };

package/src/@types/domains/community.ts

@@ -46,7 +46,7 @@ declare global {
       description?: string;
 
       channelId: Amity.Channel['channelId'];
-      userId: Amity.User['userId'];
+      userId: Amity.InternalUser['userId'];
 
       isOfficial?: boolean;
       isPublic?: boolean;
@@ -57,7 +57,7 @@ declare global {
       postsCount: number;
       membersCount: number;
 
-      categoryIds: Amity.Category['categoryId'][];
+      categoryIds: Amity.InternalCategory['categoryId'][];
 
       hasFlaggedComment: boolean;
       hasFlaggedPost: boolean;
@@ -74,7 +74,7 @@ declare global {
     type QueryCommunities = {
       displayName?: string;
       membership?: 'all' | 'member' | 'notMember';
-      categoryId?: Amity.Category['categoryId'];
+      categoryId?: Amity.InternalCategory['categoryId'];
       includeDeleted?: boolean;
       tags?: Amity.Taggable['tags'];
       sortBy?: 'displayName' | 'firstCreated' | 'lastCreated';
@@ -93,7 +93,7 @@ declare global {
       membership?: ('banned' | 'member')[];
       roles?: string[];
       sortBy?: 'firstCreated' | 'lastCreated';
-      search?: Amity.User['displayName'] | Amity.User['userId'];
+      search?: Amity.InternalUser['displayName'] | Amity.InternalUser['userId'];
       page?: Amity.Page;
     };
 

package/src/@types/domains/follow.ts

@@ -14,14 +14,14 @@ declare global {
     type FollowStatusType = 'all' | 'pending' | 'accepted' | 'blocked' | 'none';
 
     type FollowStatus = {
-      from: Amity.User['userId'];
-      to: Amity.User['userId'];
+      from: Amity.InternalUser['userId'];
+      to: Amity.InternalUser['userId'];
       status: Exclude<FollowStatusType, 'all'>;
     } & Amity.CreatedAt &
       Amity.UpdatedAt;
 
     type FollowCount = {
-      userId: Amity.User['userId'];
+      userId: Amity.InternalUser['userId'];
       followerCount: number;
       followingCount: number;
       pendingCount: number;
@@ -32,7 +32,7 @@ declare global {
     } & FollowCount;
 
     type QueryFollowers = {
-      userId: Amity.User['userId'];
+      userId: Amity.InternalUser['userId'];
       status?: Exclude<Amity.FollowStatusType, 'none'>;
       page?: Amity.PageRaw;
     };

package/src/@types/domains/group.ts

@@ -9,7 +9,7 @@ declare global {
     };
 
     type Member<T extends GroupType> = {
-      userId: Amity.User['userId'];
+      userId: Amity.InternalUser['userId'];
     } & (T extends 'channel'
       ? {
           channelId: Amity.Channel['channelId'];
@@ -25,7 +25,7 @@ declare global {
       : never) &
       Amity.Timestamps;
 
-    type MemberWithUser<T extends GroupType> = Member<T> & { user: Amity.User | undefined };
+    type MemberWithUser<T extends GroupType> = Member<T> & { user: Amity.InternalUser | undefined };
 
     type RawMembership<T extends GroupType, WithUser = false> = {
       isBanned: boolean;

package/src/@types/domains/messagePreview.ts

@@ -12,10 +12,10 @@ declare global {
       isDeleted?: boolean;
       segment: number;
       subChannelUpdatedAt: Amity.timestamp;
-      creatorId: Amity.User['userId'];
+      creatorId: Amity.InternalUser['userId'];
     } & Amity.Timestamps;
 
-    type MessagePreview = Omit<InternalMessagePreview, 'creatorId'> & { user?: Amity.User };
+    type MessagePreview = Omit<InternalMessagePreview, 'creatorId'> & { user?: Amity.InternalUser };
 
     const enum MessagePreviewSetting {
       NO_MESSAGE_PREVIEW = 'no-message-preview',

package/src/@types/domains/poll.ts

@@ -25,7 +25,7 @@ declare global {
       closedIn?: number;
       isVoted?: boolean;
       status: PollStatus;
-      userId: Amity.User['userId'];
+      userId: Amity.InternalUser['userId'];
     } & Amity.Timestamps &
       Amity.SoftDelete;
   }

package/src/@types/domains/post.ts

@@ -29,7 +29,7 @@ declare global {
 
     type Post<T extends PostContentType = any> = {
       postId: string;
-      postedUserId: Amity.User['userId']; // API-FIX: it should be "userId"
+      postedUserId: Amity.InternalUser['userId']; // API-FIX: it should be "userId"
       parentId: Post['postId'];
       targetType: PostTargetType;
       targetId: string;

package/src/@types/domains/reaction.ts

@@ -9,7 +9,7 @@ declare global {
     type Reactor = {
       reactionId: string;
       reactionName: string;
-      userId: Amity.User['userId'];
+      userId: Amity.InternalUser['userId'];
     } & Amity.Timestamps;
 
     type Reactable = {

package/src/@types/domains/stream.ts

@@ -55,7 +55,7 @@ declare global {
       isLive?: boolean;
       endedAt: Amity.timestamp;
       startedAt: Amity.timestamp;
-      userId: Amity.User['userId'];
+      userId: Amity.InternalUser['userId'];
       resolution: StreamResolution;
 
       streamerUrl: StreamEndpoint;
@@ -68,7 +68,7 @@ declare global {
     type QueryStreams = {
       isLive?: boolean;
       statuses?: Amity.StreamStatus[];
-      userPublicIds?: Amity.User['userId'][];
+      userPublicIds?: Amity.InternalUser['userId'][];
       sortBy?: 'lastCreated' | 'firstCreated';
       isDeleted?: Amity.Stream['isDeleted'];
       page?: Amity.Page;

package/src/@types/domains/user.ts

@@ -10,9 +10,10 @@ declare global {
       | 'onUnflagged'
       | 'onFlagCleared';
 
-    type User = {
+    type InternalUser = {
       _id: string;
       userId: string;
+      isGlobalBanned: boolean;
       displayName?: string;
       avatarFileId?: Amity.File<'image'>['fileId'];
       avatarCustomUrl?: string;
@@ -25,8 +26,12 @@ declare global {
       Amity.SoftDelete &
       Amity.Subscribable;
 
+    type User = Amity.InternalUser & {
+      avatar?: Amity.File<'image'> | null;
+    };
+
     type QueryUsers = {
-      displayName?: Amity.User['displayName'];
+      displayName?: Amity.InternalUser['displayName'];
       filter?: 'all' | 'flagged';
       sortBy?: 'displayName' | 'firstCreated' | 'lastCreated';
       page?: Amity.Page;
@@ -37,7 +42,7 @@ declare global {
     type UserSearchLiveCollection = Amity.LiveCollectionParams<Omit<QueryUsers, 'sortBy'>>;
 
     type UserLiveCollectionCache = Amity.LiveCollectionCache<
-      Amity.User['userId'],
+      Amity.InternalUser['userId'],
       Pick<QueryUsers, 'page'>
     >;
   }

package/src/cache/api/pushToCache.ts

@@ -5,7 +5,7 @@ import { encodeKey } from '../utils';
 /**
  * ```js
  * import { pushToCache } from '@amityco/ts-sdk'
- * pushToCache<Amity.User>(["user", "foobar"], user)
+ * pushToCache<Amity.InternalUser>(["user", "foobar"], user)
  * ```
  *
  * Saves any provided value as {@link Amity.CacheEntry} for the matching {@link Amity.CacheKey}

package/src/cache/api/upsertInCache.ts

@@ -7,7 +7,7 @@ import { mergeInCache } from './mergeInCache';
 /**
  * ```js
  * import { upsertInCache } from '@amityco/ts-sdk'
- * upsertInCache<Amity.User>(["user", "foobar"], user)
+ * upsertInCache<Amity.InternalUser>(["user", "foobar"], user)
  * ```
  *
  * Insert or update any provided value as {@link Amity.CacheEntry} for

package/src/categoryRepository/api/getCategory.ts

@@ -1,7 +1,8 @@
 import { getActiveClient } from '~/client/api/activeClient';
 
-import { pullFromCache, dropFromCache } from '~/cache/api';
+import { pullFromCache } from '~/cache/api';
 import { ingestInCache } from '~/cache/api/ingestInCache';
+import { categoryLinkedObject } from '~/utils/linkedObject/categoryLinkedObject';
 
 /* begin_public_function
   id: community.category.get
@@ -36,7 +37,7 @@ export const getCategory = async (
   const { categories } = data;
 
   return {
-    data: categories.find(category => category.categoryId === categoryId)!,
+    data: categoryLinkedObject(categories.find(category => category.categoryId === categoryId)!),
     cachedAt,
   };
 };

package/src/categoryRepository/api/queryCategories.ts

@@ -7,6 +7,7 @@ import { ingestInCache } from '~/cache/api/ingestInCache';
 import { getResolver } from '~/core/model';
 
 import { inferIsDeleted } from '~/utils/inferIsDeleted';
+import { LinkedObject } from '~/utils/linkedObject';
 
 /**
  * ```js
@@ -62,7 +63,12 @@ export const queryCategories = async (
   const nextPage = toPage(paging.next);
   const prevPage = toPage(paging.previous);
 
-  return { data: categories, cachedAt, prevPage, nextPage };
+  return {
+    data: categories.map(category => LinkedObject.category(category)),
+    cachedAt,
+    prevPage,
+    nextPage,
+  };
 };
 
 /**

package/src/categoryRepository/observers/getCategories.ts

@@ -17,6 +17,7 @@ import {
   ENABLE_CACHE_MESSAGE,
 } from '~/utils/constants';
 import { queryCategories } from '../api/queryCategories';
+import { LinkedObject } from '~/utils/linkedObject';
 
 /* begin_public_function
   id: community.category.query
@@ -62,9 +63,9 @@ export const getCategories = (
   const responder = (data: Amity.CategoryLiveCollectionCache) => {
     let categories: Amity.Category[] =
       data.data
-        .map(categoryId => pullFromCache<Amity.Category>(['category', 'get', categoryId])!)
+        .map(categoryId => pullFromCache<Amity.InternalCategory>(['category', 'get', categoryId])!)
         .filter(Boolean)
-        .map(({ data }) => data) ?? [];
+        .map(({ data }) => LinkedObject.category(data)) ?? [];
 
     if (!params.includeDeleted) {
       categories = filterByPropEquality(categories, 'isDeleted', false);

package/src/categoryRepository/observers/tests/getCategories.test.ts

@@ -12,6 +12,7 @@ import {
 import { sortByName } from '~/core/query';
 
 import { getCategories } from '../getCategories';
+import { LinkedObject } from '~/utils/linkedObject';
 
 const getSnapshot = (params?: Record<string, any>) => {
   return {
@@ -48,7 +49,7 @@ describe('getCategories', () => {
       2,
       expect.objectContaining(
         getSnapshot({
-          data: payload.categories,
+          data: payload.categories.map(category => LinkedObject.category(category)),
           loading: false,
         }),
       ),

package/src/channelRepsitory/api/createChannel.ts

@@ -22,7 +22,7 @@ import { prepareChannelPayload } from '../utils';
  * @async
  */
 export const createChannel = async <T extends Amity.ChannelType>(
-  bundle: { type: T; userIds?: Amity.User['userId'][] } & Pick<
+  bundle: { type: T; userIds?: Amity.InternalUser['userId'][] } & Pick<
     Amity.Channel<T>,
     'displayName' | 'avatarFileId' | 'tags' | 'metadata'
   >,

package/src/channelRepsitory/channelMembership/api/addMembers.ts

@@ -14,18 +14,18 @@ import { prepareChannelPayload } from '../../utils';
  * const updated = await addMembers(channelId, ['foo', 'bar'])
  * ```
  *
- * Adds a list of {@link Amity.User} to a {@link Amity.Channel}
+ * Adds a list of {@link Amity.InternalUser} to a {@link Amity.Channel}
  *
  * @param channelId The ID of the {@link Amity.Channel} to perform
- * @param userIds The list of IDs {@link Amity.User} to add
- * @returns A success boolean if the {@link Amity.User} were added to the {@link Amity.Channel}
+ * @param userIds The list of IDs {@link Amity.InternalUser} to add
+ * @returns A success boolean if the {@link Amity.InternalUser} were added to the {@link Amity.Channel}
  *
  * @category Channel API
  * @async
  */
 export const addMembers = async (
   channelId: Amity.Channel['channelId'],
-  userIds: Amity.User['userId'][],
+  userIds: Amity.InternalUser['userId'][],
 ): Promise<boolean> => {
   const client = getActiveClient();
   client.log('channel/addMembers', channelId, userIds);

package/src/channelRepsitory/channelMembership/api/removeMembers.ts

@@ -14,18 +14,18 @@ import { prepareChannelPayload } from '../../utils';
  * const updated = await removeMembers(channelId, ['foo', 'bar'])
  * ```
  *
- * Removes a list of {@link Amity.User} from a {@link Amity.Channel}
+ * Removes a list of {@link Amity.InternalUser} from a {@link Amity.Channel}
  *
  * @param channelId The ID of the {@link Amity.Channel} to perform
- * @param userIds The list of IDs {@link Amity.User} to remove
- * @returns A success boolean if the list of {@link Amity.User} were removed from the {@link Amity.Channel}
+ * @param userIds The list of IDs {@link Amity.InternalUser} to remove
+ * @returns A success boolean if the list of {@link Amity.InternalUser} were removed from the {@link Amity.Channel}
  *
  * @category Channel API
  * @async
  */
 export const removeMembers = async (
   channelId: Amity.Channel['channelId'],
-  userIds: Amity.User['userId'][],
+  userIds: Amity.InternalUser['userId'][],
 ): Promise<boolean> => {
   const client = getActiveClient();
   client.log('channel/removeMembers', channelId, userIds);

package/src/channelRepsitory/channelMembership/observers/tests/getMembers.test.ts

@@ -63,7 +63,7 @@ describe('getMembers', () => {
     string,
     keyof Amity.Events,
     Amity.RawMembership<'channel'>,
-    Amity.User,
+    Amity.InternalUser,
     Amity.Membership<'channel'>[],
   ][] = [
     [

package/src/channelRepsitory/channelMembership/observers/tests/searchMembers.test.ts

@@ -8,14 +8,12 @@ import {
   channelUserModel,
   channelUserQueryResponse,
   channelUserQueryResponsePage2,
-  channelUserQueryResponsePage3,
   channelUserWithRole,
   client,
   connectClient,
   convertRawChannelPayload,
   disconnectClient,
   emptyChannelUserQueryResponse,
-  mutedChannelUser,
   pause,
   rawBannedChannelUser,
   rawChannelUser,
@@ -94,7 +92,7 @@ describe('searchMembers', () => {
     string,
     keyof Amity.Events,
     Amity.RawMembership<'channel'>,
-    Amity.User,
+    Amity.InternalUser,
     Amity.Membership<'channel'>[],
   ][] = [
     [

package/src/channelRepsitory/channelModeration/api/addRole.ts

@@ -14,12 +14,12 @@ import { fireEvent } from '~/core/events';
  * const updated = await addRole(channelId, 'foo', ['bar'])
  * ```
  *
- * Adds an {@link Amity.Role} to a list of {@link Amity.User} on a {@link Amity.Channel}
+ * Adds an {@link Amity.Role} to a list of {@link Amity.InternalUser} on a {@link Amity.Channel}
  *
  * @param channelId The ID of the {@link Amity.Channel} to perform
  * @param roleId The ID of the {@link Amity.Role} to apply
- * @param userId Array of IDs of the {@link Amity.User} to perform
- * @returns A success boolean if the {@link Amity.Role} were added to list of {@link Amity.User} in the {@link Amity.Channel}
+ * @param userId Array of IDs of the {@link Amity.InternalUser} to perform
+ * @returns A success boolean if the {@link Amity.Role} were added to list of {@link Amity.InternalUser} in the {@link Amity.Channel}
  *
  * @category Channel API
  * @async
@@ -27,7 +27,7 @@ import { fireEvent } from '~/core/events';
 export const addRole = async (
   channelId: Amity.Channel['channelId'],
   roleId: Amity.Role['roleId'],
-  userIds: Amity.User['userId'][],
+  userIds: Amity.InternalUser['userId'][],
 ): Promise<boolean> => {
   const client = getActiveClient();
   client.log('channel/addRole', channelId, roleId, userIds);

package/src/channelRepsitory/channelModeration/api/banMembers.ts

@@ -15,7 +15,7 @@ import { prepareChannelPayload } from '../../utils';
  * ```
  *
  * @param channelId of {@link Amity.Channel} from which the users should be banned
- * @param userIds of the {@link Amity.User}'s to be banned
+ * @param userIds of the {@link Amity.InternalUser}'s to be banned
  * @returns the updated {@link Amity.Membership}'s object
  *
  * @category Channel API
@@ -23,7 +23,7 @@ import { prepareChannelPayload } from '../../utils';
  * */
 export const banMembers = async (
   channelId: Amity.Channel['channelId'],
-  userIds: Amity.User['userId'][],
+  userIds: Amity.InternalUser['userId'][],
 ): Promise<Amity.Cached<Amity.Membership<'channel'>[]>> => {
   const client = getActiveClient();
   client.log('channel/banMembers', { userIds, channelId });