@alemonjs/discord 2.1.0-alpha.4 → 2.1.0-alpha.5

package/lib/sdk/api.d.ts

@@ -0,0 +1,972 @@
+import * as axios from 'axios'
+import { AxiosRequestConfig } from 'axios'
+import FormData from 'form-data'
+import { Readable } from 'stream'
+
+type MessageData = {
+  content?: string
+  tts?: boolean
+  embeds?: {
+    title?: string
+    description?: string
+  }[]
+  components?: {
+    type: number
+    components:
+      | {
+          type: number
+          style: number
+          label?: string
+          emoji?: any
+          custom_id?: string
+          sku_id?: any
+          url?: string
+          disabled?: boolean
+        }[]
+      | {
+          type: number
+          custom_id?: string
+          options?: {
+            label: string
+            value: string
+            description?: string
+            emoji?: {
+              name?: string
+              id?: string
+            }
+          }[]
+        }[]
+      | {
+          custom_id: string
+          max_values: number
+          min_values: number
+          options: {
+            description?: string
+            emoji?: {
+              name?: string
+              id?: string
+            }
+            label: string
+            value: string
+          }[]
+        }[]
+      | {
+          type: number
+          custom_id: string
+          label: string
+          style: number
+          min_length: number
+          max_length: number
+          placeholder: string
+          required: boolean
+        }[]
+  }[]
+  files?: any[]
+}
+/**
+ * api接口
+ */
+declare class DCAPI {
+  API_URL: string
+  CDB_URL: string
+  /**
+   * 基础请求
+   * @param opstion
+   * @returns
+   */
+  request(options: AxiosRequestConfig): Promise<axios.AxiosResponse<any, any>>
+  /**
+   * cdn基础请求
+   * @param options
+   * @returns
+   */
+  requestCDN(options: AxiosRequestConfig): Promise<axios.AxiosResponse<any, any>>
+  /**
+   * 创建用户url地址
+   * @param user_id
+   * @param avatar_hash
+   * @returns
+   */
+  userAvatar(user_id: string, avatar_hash: string): string
+  /**
+   *
+   * @param user_id
+   * @param avatar_hash
+   * @returns
+   */
+  getUserUrl(user_id: string, avatar_hash: string): Promise<any>
+  /**
+   *
+   * @param channel_id
+   * @param data
+   * @param headers
+   * @returns
+   */
+  channelsMessages(
+    channel_id: string,
+    data: MessageData,
+    headers?: AxiosRequestConfig['headers']
+  ): Promise<any>
+  /**
+   *
+   * @param channel_id
+   * @param img
+   * @returns
+   */
+  channelsMessagesImage(
+    channel_id: string,
+    img: string | Buffer | Readable,
+    param?: MessageData
+  ): Promise<axios.AxiosResponse<any, any>>
+  /**
+   * ************
+   * 消息-图片接口
+   * ***********
+   */
+  /**
+   * 创建form
+   * @param image
+   * @param msg_id
+   * @param content
+   * @param name
+   * @returns
+   */
+  createFrom(image: Buffer, msg_id: string, content: any, Name?: string): Promise<false | FormData>
+  /**
+   * 发送buffer图片
+   * @param id 传子频道id
+   * @param message {消息编号,图片,内容}
+   * @returns
+   */
+  postImage(
+    channel_id: string,
+    message: {
+      msg_id: string
+      image: Buffer
+      content?: string
+      name?: string
+    }
+  ): Promise<any>
+  /**
+   * ***********
+   * 应用程序角色连接元数据接口
+   * **********
+   */
+  /**
+   *
+   * 获取应用程序角色连接元数据记录
+   */
+  applicationRoleConnectionsMetadata(application_id: string): Promise<any>
+  /**
+   *
+   * 更新应用程序角色连接元数据记录
+   */
+  applicationRoleConnectionsMetadataUpdate(application_id: string): Promise<any>
+  /**
+   * ********
+   * 用户api
+   * *******
+   */
+  /**
+   * 获取当前用户详情
+   * @param message
+   * @returns
+   */
+  usersMe(): Promise<any>
+  /**
+   * 根据id获取用户详情
+   * @param message
+   * @returns
+   */
+  userMessage(user_id: string): Promise<any>
+  /**
+   * 获取当前用户频道
+   * @param params :{获取该频道 Id 之前的频道,获取该频道Id后的频道,返回的最大频道数量 (1-200),在响应中包括大概的成员和存在计数 }
+   * @returns
+   */
+  usersMeGuilds(
+    params: {
+      before: string
+      after: string
+      limit: number
+      with_counts: boolean
+    } | null
+  ): Promise<any>
+  /**
+   * *********
+   * 获取当前用户频道成员
+   * *********
+   */
+  usersMeGuildsMember(guild_id: string): Promise<any>
+  /**
+   * *********
+   * 获取频道成员
+   * *********
+   */
+  guildsMember(guild_id: string): Promise<any>
+  /**
+   * *********
+   * 离开频道
+   * *********
+   */
+  usersMeGuildsDelete(guild_id: string): Promise<any>
+  /**
+   * *********
+   * 创建DM
+   * *********
+   */
+  userMeChannels(recipient_id: string): Promise<any>
+  /**
+   * ********
+   * 应用api
+   * *******
+   */
+  /**
+   * *********
+   * 获取当前应用程序
+   * *********
+   */
+  applicationsMe(): Promise<any>
+  /**
+   * *********
+   * 编辑当前应用程序
+   * *********
+   */
+  applicationsMeUpdate(): Promise<any>
+  /**
+   * *********
+   * 获取当前用户连接
+   * *********
+   */
+  usersMeConnections(): Promise<any>
+  /**
+   * *********
+   * 获取当前用户应用程序角色连接
+   * *********
+   */
+  usersMeApplicationsRoleConnection(application_id: string): Promise<any>
+  /**
+   * *********
+   * 更新当前用户应用程序角色连接
+   * *********
+   */
+  usersMeApplicationsRoleConnectionUpdate(application_id: string): Promise<any>
+  /**
+   * **********
+   * 频道api
+   * **********
+   */
+  /**
+   * *********
+   * 创建频道
+   * *********
+   */
+  guildsCreate(): Promise<any>
+  /**
+   * *********
+   * 获取频道
+   * *********
+   */
+  guild(guild_id: string): Promise<any>
+  /**
+   * *********
+   * 获取频道预览
+   * *********
+   */
+  guildsPreview(guild_id: string): Promise<any>
+  /**
+   * *********
+   * 修改频道
+   * *********
+   */
+  guildsUpdate(guild_id: string): Promise<any>
+  /**
+   * *********
+   * 删除频道
+   * *********
+   */
+  guildsDelete(guild_id: string): Promise<any>
+  /**
+   * *********
+   * 列出活跃的频道线程
+   * *********
+   */
+  guildsThreadsActive(guild_id: string): Promise<any>
+  /**
+   * *********
+   * 获取频道成员消息
+   * *********
+   */
+  getGuildMember(guild_id: string, user_id: string): Promise<any>
+  /**
+   * *********
+   * 列出频道成员
+   * *********
+   */
+  guildsMembers(guild_id: string): Promise<any>
+  /**
+   * *********
+   * 搜索频道成员
+   * *********
+   */
+  guildsMembersSearch(guild_id: string): Promise<any>
+  /**
+   * *********
+   * 添加频道成员
+   * *********
+   */
+  guildsMembersAdd(guild_id: string, user_id: string): Promise<any>
+  /**
+   * *********
+   * 修改频道成员
+   * *********
+   */
+  guildsMembersUpdate(guild_id: string, user_id: string): Promise<any>
+  /**
+   * *********
+   * 修改当前成员
+   * *********
+   */
+  guildsMembersMeNick(guild_id: string): Promise<any>
+  /**
+   * *********
+   * 修改当前用户昵称
+   * *********
+   */
+  guildsMembersMeNickUpdate(guild_id: string): Promise<any>
+  /**
+   * *********
+   * 获取频道角色
+   * *********
+   */
+  guildsRoles(guild_id: string): Promise<any>
+  /**
+   * *********
+   * 创建频道角色
+   * *********
+   */
+  guildsRolesCreate(guild_id: string): Promise<any>
+  /**
+   * *********
+   * 修改频道角色位置
+   * *********
+   */
+  guildsRolesUpdate(guild_id: string): Promise<any>
+  /**
+   * *********
+   * 修改频道角色
+   * *********
+   */
+  guildsRolesUpdateById(guild_id: string, role_id: string): Promise<any>
+  /**
+   * *********
+   * 添加频道成员角色
+   * *********
+   */
+  guildsMEmbersRolesAdd(guild_id: string, user_id: string, role_id: string): Promise<any>
+  /**
+   * *********
+   * 删除频道成员角色
+   * *********
+   */
+  guildsMembersRolesDelete(guild_id: string, user_id: string, role_id: string): Promise<any>
+  /**
+   * *********
+   * 删除频道角色
+   * *********
+   */
+  guildsRolesDelete(guild_id: string, role_id: string): Promise<any>
+  /**
+   * *********
+   * 删除频道成员
+   * *********
+   */
+  guildsMembersDelete(guild_id: string, user_id: string): Promise<any>
+  /**
+   * *********
+   * 获取频道禁令
+   * *********
+   */
+  guildsBans(guild_id: string): Promise<any>
+  /**
+   * *********
+   * 获得频道禁令
+   * *********
+   */
+  guildsBansDelete(guild_id: string, user_id: string): Promise<any>
+  /**
+   * *********
+   * 创建频道禁令
+   * *********
+   */
+  guildsBansCreateByUserId(guild_id: string, user_id: string): Promise<any>
+  /**
+   * *********
+   * 解除频道禁令
+   * *********
+   */
+  guildsBansDeleteByUserId(guild_id: string, user_id: string): Promise<any>
+  /**
+   * *********
+   * 修改频道MFA级别
+   * *********
+   */
+  guildsMfa(guild_id: string): Promise<any>
+  /**
+   * *********
+   * 获取频道修剪数量
+   * *********
+   */
+  guildsPrune(guild_id: string): Promise<any>
+  /**
+   * *********
+   * 开始频道修剪
+   * *********
+   */
+  guildsPruneUpdate(guild_id: string): Promise<any>
+  /**
+   * *********
+   * 获取频道邀请
+   * *********
+   */
+  guildsInvites(guild_id: string): Promise<any>
+  /**
+   * *********
+   * 获取频道集成
+   * *********
+   */
+  guildsIntegrations(guild_id: string): Promise<any>
+  /**
+   * *********
+   * 删除频道集成
+   * *********
+   */
+  guildsDeleteByIntegrationsId(guild_id: string, integration_id: string): Promise<any>
+  /**
+   * *********
+   * 获取频道小部件设置
+   * *********
+   */
+  guildsWidget(guild_id: string): Promise<any>
+  /**
+   * *********
+   * 修改频道小部件
+   * *********
+   */
+  guildsWidgetUpdate(guild_id: string): Promise<any>
+  /**
+   * *********
+   * 获取频道小部件
+   * *********
+   */
+  guildsWidgetJSON(guild_id: string): Promise<any>
+  /**
+   * *********
+   * 获取频道个性网址
+   * *********
+   */
+  guildVanityUrl(guild_id: string): Promise<any>
+  /**
+   * *********
+   * 获取频道小部件图像
+   * *********
+   */
+  guildsWidgetPNG(guild_id: string): Promise<any>
+  /**
+   * *********
+   * 获取频道欢迎屏幕
+   * *********
+   */
+  guildsWelconScreen(guild_id: string): Promise<any>
+  /**
+   * *********
+   * 修改频道欢迎界面
+   * *********
+   */
+  guildsWelconmeScreen(guild_id: string): Promise<any>
+  /**
+   * *********
+   * 获取频道入职
+   * *********
+   */
+  guildsOnboarding(guild_id: string): Promise<any>
+  /**
+   * *********
+   * 修改频道入职
+   * *********
+   */
+  guildsOnboardingUpdate(guild_id: string): Promise<any>
+  /**
+   * *********
+   * 获取公会审核日志
+   * *********
+   */
+  guildsAuditLogs(guild_id: string): Promise<any>
+  /**
+   * *********
+   * 获取自动审核规则
+   * *********
+   */
+  guildsAutoModerationsRules(guild_id: string, auto_moderation_rule_id: string): Promise<any>
+  /**
+   * *********
+   * 创建自动审核规则
+   * *********
+   */
+  guildsAutoModerationRulesCreate(guild_id: string): Promise<any>
+  /**
+   * *********
+   * 修改自动审核规则
+   * *********
+   */
+  guildsAutoModerationsRulesUpdate(guild_id: string, auto_moderation_rule_id: string): Promise<any>
+  /**
+   * *********
+   * 删除自动审核规则
+   * *********
+   */
+  guildsAutoModerationsRulesDelete(guild_id: string, auto_moderation_rule_id: string): Promise<any>
+  /**
+   * ************
+   * 子频道api
+   * ***********
+   */
+  /**
+   * *********
+   * 获取所有子频道
+   * *********
+   */
+  guildsanyChannels(guild_id: string): Promise<any>
+  /**
+   * *********
+   * 获取子频道
+   * *********
+   */
+  guildsChannels(channel_id: string): Promise<any>
+  /**
+   * *********
+   * 修改子频道
+   * *********
+   */
+  guildsChannelsUpdate(channel_id: string): Promise<any>
+  /**
+   * *********
+   * 删除子频道
+   * *********
+   */
+  guildsChannelsDELETE(channel_id: string): Promise<any>
+  /**
+   * *********
+   * 创建子频道
+   * *********
+   */
+  guildsChannelsCreate(guild_id: string): Promise<any>
+  /**
+   * *********
+   * 修改子频道位置
+   * *********
+   */
+  guildsChannelsUpdateposi(guild_id: string): Promise<any>
+  /**
+   * *********
+   * 获取频道邀请
+   * *********
+   */
+  getChannelInvites(channel_id: string): Promise<any>
+  /**
+   * *********
+   * 创建频道邀请
+   * *********
+   */
+  createChannelInvites(channel_id: string): Promise<any>
+  /**
+   * *********
+   * 删除频道邀请
+   * *********
+   */
+  deleteChannelInvites(channel_id: string): Promise<any>
+  /**
+   * *********
+   *触发输入指示器
+   * *********
+   */
+  triggerTypingIndicator(channel_id: string): Promise<any>
+  /**
+   * *********
+   *群组 DM 添加收件人
+   * *********
+   */
+  groupDMAddRecipient(channel_id: string, user_id: string): Promise<any>
+  /**
+   * *********
+   *群组DM删除收件人
+   * *********
+   */
+  groupDMdeleteRecipient(channel_id: string, user_id: string): Promise<any>
+  /**
+   * *********
+   *启动消息开始线程
+   * *********
+   */
+  startThreadfromMessage(channel_id: string, message_id: string): Promise<any>
+  /**
+   * *********
+   *启动没有消息的线程
+   * *********
+   */
+  startThreadwithoutMessag(channel_id: string): Promise<any>
+  /**
+   * *********
+   *在论坛或媒体频道中启动话题
+   * *********
+   */
+  startThreadinForum(channel_id: string): Promise<any>
+  /**
+   * *********
+   *加入话题
+   * *********
+   */
+  joinThread(channel_id: string): Promise<any>
+  /**
+   * *********
+   *添加话题成员
+   * *********
+   */
+  addThreadMember(channel_id: string, user_id: string): Promise<any>
+  /**
+   * *********
+   *删除话题
+   * *********
+   */
+  leavethread(channel_id: string): Promise<any>
+  /**
+   * *********
+   *删除线程成员
+   * *********
+   */
+  removeThreadMember(channel_id: string, user_id: string): Promise<any>
+  /**
+   * *********
+   *获取线程成员
+   * *********
+   */
+  getThreadMember(channel_id: string, user_id: string): Promise<any>
+  /**
+   * *********
+   *列出线程成员
+   * *********
+   */
+  listThreadMembers(channel_id: string): Promise<any>
+  /**
+   * *********
+   *列出公共存档主题
+   * *********
+   */
+  listPublicArchivedThread(channel_id: string): Promise<any>
+  /**
+   * *********
+   *列出私有存档线程
+   * *********
+   */
+  listPrivateArchivedThreads(channel_id: string): Promise<any>
+  /**
+   * *********
+   *列出已加入的私人存档主题
+   * *********
+   */
+  listoinedPrivateThreads(channel_id: string): Promise<any>
+  /**
+   * ***********
+   * 频道身份api
+   * ***********
+   */
+  /**
+   * **********
+   * 子频道权限api
+   * **********
+   */
+  /**
+   * *********
+   * 编辑频道权限
+   * *********
+   */
+  editChannelPermissions(channel_id: string, overwrite_id: string): Promise<any>
+  /**
+   * *********
+   * 删除频道权限
+   * *********
+   */
+  deleteChannelPermissions(channel_id: string, overwrite_id: string): Promise<any>
+  /**
+   * *******
+   * 消息api
+   * ********
+   */
+  /**
+   * *********
+   * 获取子频道消息
+   * *********
+   */
+  guildsChannelsanymessages(channel_id: string): Promise<any>
+  /**
+   * *********
+   * 获取单条子频道消息
+   * *********
+   */
+  guildsChannelsmessages(channel_id: string, message_id: string): Promise<any>
+  /**
+   * *********
+   * 创建子频道消息
+   * *********
+   */
+  guildsChannelscreatmess(channel_id: string): Promise<any>
+  /**
+   * *********
+   * 交叉发布消息
+   * *********
+   */
+  crosspostmessages(channel_id: string, message_id: string): Promise<any>
+  /**
+   * *********
+   * 创造反应
+   * *********
+   */
+  createareaction(channel_id: string, message_id: string, emoji: string): Promise<any>
+  /**
+   * *********
+   * 删除自己的反应
+   * *********
+   */
+  deleteownreaction(channel_id: string, message_id: string, emoji: string): Promise<any>
+  /**
+   * *********
+   * 删除别人的反应
+   * *********
+   */
+  deleteareuserction(
+    channel_id: string,
+    message_id: string,
+    emoji: string,
+    user_id: string
+  ): Promise<any>
+  /**
+   * *********
+   * 获取反应
+   * *********
+   */
+  getownreaction(channel_id: string, message_id: string, emoji: string): Promise<any>
+  /**
+   * *********
+   * 删除所有反应
+   * *********
+   */
+  deleteAllreaction(channel_id: string, message_id: string): Promise<any>
+  /**
+   * *********
+   * 删除表情符号的所有反应
+   * *********
+   */
+  deleteAllreactionforEmoji(channel_id: string, message_id: string, emoji: string): Promise<any>
+  /**
+   * *********
+   * 编辑消息
+   * *********
+   */
+  editMessage(channel_id: string, message_id: string): Promise<any>
+  /**
+   * *********
+   * 撤回消息
+   * *********
+   */
+  deleteMessage(channel_id: string, message_id: string): Promise<any>
+  /**
+   * *********
+   * 批量删除消息
+   * *********
+   */
+  bulkdeleteMessage(channel_id: string): Promise<any>
+  /**
+   * ************
+   * 消息频率api
+   * **********
+   */
+  /**
+   * ***********
+   * 私信api
+   * **********
+   */
+  /**
+   * *********
+   * 禁言api
+   * *******
+   */
+  /**
+   * *******
+   * 公告api
+   * *******
+   */
+  /**
+   * *********
+   * 关注公告频道
+   * *********
+   */
+  followAnnouncementChannel(channel_id: string): Promise<any>
+  /**
+   * **********
+   * 精华消息api
+   * **********
+   */
+  /**
+   * *********
+   *获取置顶消息
+   * *********
+   */
+  getPinnedMessages(channel_id: string): Promise<any>
+  /**
+   * *********
+   *置顶消息
+   * *********
+   */
+  pinMessage(channel_id: string, message_id: string): Promise<any>
+  /**
+   * *********
+   *取消置顶消息
+   * *********
+   */
+  deletepinMessage(channel_id: string, message_id: string): Promise<any>
+  /**
+   * ********
+   * 日程api
+   * *******
+   */
+  /**
+   * ***********
+   * 表情表态api
+   * ***********
+   */
+  /**
+   * *********
+   *获取贴纸
+   * *********
+   */
+  getsticker(sticker_id: string): Promise<any>
+  /**
+   * *********
+   *列出贴纸包
+   * *********
+   */
+  listStickerPacks(): Promise<any>
+  /**
+   * *********
+   *列出公会贴纸
+   * *********
+   */
+  listGuildStickers(sticker_id: string): Promise<any>
+  /**
+   * *********
+   *获取公会贴纸
+   * *********
+   */
+  getGuildSticker(guild_id: string, sticker_id: string): Promise<any>
+  /**
+   * *********
+   *创建公会贴纸
+   * *********
+   */
+  createGuildSticker(guild_id: string): Promise<any>
+  /**
+   * *********
+   *修改公会贴纸
+   * *********
+   */
+  modifyGuildSticker(guild_id: string, sticker_id: string): Promise<any>
+  /**
+   * *********
+   *删除公会贴纸
+   * *********
+   */
+  deleteGuildSticker(guild_id: string, sticker_id: string): Promise<any>
+  /**
+   * *********
+   *列出公会表情符号
+   * *********
+   */
+  listGuildEmojis(guild_id: string): Promise<any>
+  /**
+   * *********
+   *获取公会表情符号
+   * *********
+   */
+  getGuildEmoji(guild_id: string, emoji_id: string): Promise<any>
+  /**
+   * *********
+   *创建公会表情符号
+   * *********
+   */
+  createGuildEmoji(guild_id: string): Promise<any>
+  /**
+   * *********
+   *修改公会表情
+   * *********
+   */
+  modifyGuildEmoji(guild_id: string, emoji_id: string): Promise<any>
+  /**
+   * *********
+   *删除公会表情符号
+   * *********
+   */
+  deleteGuildEmoji(guild_id: string, emoji_id: string): Promise<any>
+  /**
+   * ***********
+   * 音频api
+   * **********
+   */
+  /**
+   * *********
+   * 列出语音区域
+   * *********
+   */
+  listVoiceRegions(): Promise<any>
+  /**
+   * *********
+   * 获取频道语音区域
+   * *********
+   */
+  guildsRegions(guild_id: string): Promise<any>
+  /**
+   * *********
+   * 修改当前用户语音状态
+   * *********
+   */
+  guildsVoiveStatesMe(guild_id: string): Promise<any>
+  /**
+   * *********
+   * 修改用户语音状态
+   * *********
+   */
+  guildsVoiceStatesUpdate(guild_id: string, user_id: string): Promise<any>
+  /**
+   * **********
+   * 帖子api
+   * **********
+   */
+  /**
+   * ********
+   * 接口权限api
+   * **********
+   */
+  /**
+   * ********
+   * 通讯api
+   * *********
+   */
+  gateway(): Promise<{
+    url: string
+  }>
+  /**
+   *
+   */
+  interactionsCallback(id: string, token: string, content: string): Promise<any>
+}
+
+export { DCAPI }