Client

import { Client } from '@cloak-software/bot-sdk';

const client = new Client({
  token: process.env.CLOAK_TOKEN!,
  keystorePath: './bot.cloak-keystore.json',
  requiredPermissions: ['message_send', 'reaction_add'],
});

client.on('messageCreate', async (msg) => {
  if (msg.authorId === client.user?.id) return;
  if (msg.isDM || !msg.serverId) return;
  if (msg.content.trim() === '!ping') await msg.channel.send('pong');
});

await client.login();

login(): Promise<void>

watch(serverId: string, channelId: string, groupId?: string): Promise<void>

destroy(): Promise<void>

send(serverId: string, channelId: string, text: string, opts?: SendOptions): Promise<void>

import { userMention } from '@cloak-software/bot-sdk';

await client.send(serverId, channelId, `${userMention(msg.authorId)} on it`, {
  mentions: [{ userId: msg.authorId }],
  replyTo: msg,
});

sendDM(userId: string, text: string, opts?: SendOptions): Promise<void>

sendCard(serverId: string, channelId: string, card: CardMessage): Promise<void>

sendEmbed(serverId: string, channelId: string, post: UnencryptedWebhookPost): Promise<void>

sendCommand(
  serverId: string,
  channelId: string,
  name: string,
  args?: CommandArgs,
  opts?: { botId: string; decl?: CommandDeclaration; groupId?: string },
): Promise<void>

sendTyping(serverId: string, channelId: string, isTyping?: boolean, groupId?: string): Promise<void>

setStatus(status: BotStatus): Promise<void>

setAvatar(iconUrl: string | null, miniIconUrl?: string | null): Promise<void>

fetchMessages(
  serverId: string,
  channelId: string,
  opts?: {
    before?: Date | Message;
    after?: Date | Message;
    around?: Date | Message;
    limit?: number;
    groupId?: string;
  },
): Promise<Message[]>

messageLocation(messageId: string): MessageLocation | undefined

fetchEmojis(): Promise<{ emojis: unknown; category: unknown }>

fetchRoles(serverId: string): Promise<Role[]>

fetchBans(serverId: string): Promise<BanInfo[]>

fetchMembers(serverId: string): Promise<Member[]>

kick(serverId: string, userId: string): Promise<void>

ban(serverId: string, userId: string, reason?: string): Promise<void>

unban(serverId: string, userId: string): Promise<void>

timeout(serverId: string, userId: string, durationSeconds: number): Promise<void>

removeTimeout(serverId: string, userId: string): Promise<void>

createChannel(serverId: string, name: string, groupId: string, channelType?: number): Promise<string>

editChannel(serverId: string, channelId: string, groupId: string, newName: string): Promise<void>

deleteChannel(serverId: string, channelId: string, groupId: string): Promise<void>

moveChannel(
  serverId: string,
  channelId: string,
  fromGroupId: string,
  toGroupId: string,
  newOrder: number,
): Promise<void>

createGroup(serverId: string, name: string): Promise<string | undefined>

editGroup(serverId: string, groupId: string, newName: string): Promise<void>

deleteGroup(serverId: string, groupId: string): Promise<void>

joinVoice(
  serverId: string,
  channelId: string,
  opts?: { groupId?: string; muted?: boolean; deafened?: boolean },
): Promise<VoiceConnection>

leaveVoice(): Promise<void>

voiceConnection(): VoiceConnection | null

setVoiceSelfState(state: { muted?: boolean; deafened?: boolean }): Promise<void>

voiceRoster(channelId: string): VoiceParticipant[]

refreshVoiceRoster(serverId: string): Promise<void>

can(permission: PermissionName, serverId: string): boolean

permissions(serverId: string): PermissionSet | undefined

visibleChannelIds(serverId: string): string[]

encryptFor(serverId: string, text: string): string

decryptFrom(serverId: string, wire: string): string

client.on('messageCreate', (msg) => {
  // msg is typed as Message
});

guild(serverId: string)

if (msg.isDM || !msg.serverId) return; // serverId is null in a DM

const g = client.guild(msg.serverId);
await g.timeout(msg.authorId, 300);
const roles = await g.fetchRoles();
const history = await g.fetchMessages(msg.channelId, { limit: 100 });