@satorijs/adapter-discord 4.1.3 → 4.1.4

package/src/types/user.ts

@@ -0,0 +1,154 @@
+import { integer, Integration, Internal, snowflake } from '.'
+
+/** https://discord.com/developers/docs/resources/user#user-object-user-structure */
+export interface User {
+  /** the user's id */
+  id: snowflake
+  /** the user's username, not unique across the platform */
+  username: string
+  /** the user's 4-digit discord-tag */
+  discriminator: string
+  /** the user's avatar hash */
+  avatar?: string
+  /** whether the user belongs to an OAuth2 application */
+  bot?: boolean
+  /** whether the user is an Official Discord System user (part of the urgent message system) */
+  system?: boolean
+  /** whether the user has two factor enabled on their account */
+  mfa_enabled?: boolean
+  /** the user's banner hash */
+  banner?: string
+  /** the user's banner color encoded as an integer representation of hexadecimal color code */
+  accent_color?: integer
+  /** the user's chosen language option */
+  locale?: string
+  /** whether the email on this account has been verified */
+  verified?: boolean
+  /** the user's email */
+  email?: string
+  /** the flags on a user's account */
+  flags?: integer
+  /** the type of Nitro subscription on a user's account */
+  premium_type?: PremiumType
+  /** the public flags on a user's account */
+  public_flags?: integer
+}
+
+export namespace User {
+  export namespace Params {
+    /** https://discord.com/developers/docs/resources/user#modify-current-user-json-params */
+    export interface Modify {
+      /** user's username, if changed may cause the user's discriminator to be randomized. */
+      username: string
+      /** if passed, modifies the user's avatar */
+      avatar?: string
+    }
+  }
+}
+
+/** https://discord.com/developers/docs/resources/user#user-object-user-flags */
+export enum UserFlag {
+  NONE = 0,
+  DISCORD_EMPLOYEE = 1 << 0,
+  PARTNERED_SERVER_OWNER = 1 << 1,
+  HYPESQUAD_EVENTS = 1 << 2,
+  BUG_HUNTER_LEVEL_1 = 1 << 3,
+  HOUSE_BRAVERY = 1 << 6,
+  HOUSE_BRILLIANCE = 1 << 7,
+  HOUSE_BALANCE = 1 << 8,
+  EARLY_SUPPORTER = 1 << 9,
+  TEAM_USER = 1 << 10,
+  BUG_HUNTER_LEVEL_2 = 1 << 14,
+  VERIFIED_BOT = 1 << 16,
+  EARLY_VERIFIED_BOT_DEVELOPER = 1 << 17,
+  DISCORD_CERTIFIED_MODERATOR = 1 << 18,
+  BOT_HTTP_INTERACTIONS = 1 << 19,
+  ACTIVE_DEVELOPER = 1 << 22,
+}
+
+/** https://discord.com/developers/docs/resources/user#user-object-premium-types */
+export enum PremiumType {
+  NONE = 0,
+  NITRO_CLASSIC = 1,
+  NITRO = 2,
+  NITRO_BASIC = 3,
+}
+
+/** https://discord.com/developers/docs/resources/user#connection-object-connection-structure */
+export interface Connection {
+  /** id of the connection account */
+  id: string
+  /** the username of the connection account */
+  name: string
+  /** the service of the connection (twitch, youtube) */
+  type: string
+  /** whether the connection is revoked */
+  revoked?: boolean
+  /** an array of partial server integrations */
+  integrations?: Partial<Integration>[]
+  /** whether the connection is verified */
+  verified: boolean
+  /** whether friend sync is enabled for this connection */
+  friend_sync: boolean
+  /** whether activities related to this connection will be shown in presence updates */
+  show_activity: boolean
+  /** whether this connection has a corresponding third party OAuth2 token */
+  two_way_link: boolean
+  /** visibility of this connection */
+  visibility: integer
+}
+
+/** https://discord.com/developers/docs/resources/user#connection-object-visibility-types */
+export enum VisibilityType {
+  /** invisible to everyone except the user themselves */
+  NONE = 0,
+  /** visible to everyone */
+  EVERYONE = 1,
+}
+
+export interface UserUpdateEvent extends User {}
+
+declare module './gateway' {
+  interface GatewayEvents {
+    /** properties about the user changed */
+    USER_UPDATE: UserUpdateEvent
+  }
+}
+
+declare module './internal' {
+  interface Internal {
+    /**
+     * Returns the user object of the requester's account. For OAuth2, this requires the identify scope, which will return the object without an email, and optionally the email scope, which returns the object with an email.
+     * @see https://discord.com/developers/docs/resources/user#get-current-user
+     */
+    getCurrentUser(): Promise<User>
+    /**
+     * Returns a user object for a given user ID.
+     * @see https://discord.com/developers/docs/resources/user#get-user
+     */
+    getUser(id: snowflake): Promise<User>
+    /**
+     * Modify the requester's user account settings. Returns a user object on success.
+     * @see https://discord.com/developers/docs/resources/user#modify-current-user
+     */
+    modifyCurrentUser(params: User.Params.Modify): Promise<User>
+    /**
+     * Returns a list of connection objects. Requires the connections OAuth2 scope.
+     * @see https://discord.com/developers/docs/resources/user#get-user-connections
+     */
+    getUserConnections(): Promise<Connection[]>
+  }
+}
+
+Internal.define({
+  '/users/@me': {
+    GET: 'getCurrentUser',
+    PATCH: 'modifyCurrentUser',
+  },
+  '/users/{user.id}': {
+    GET: 'getUser',
+  },
+  '/users/@me/connections': {
+    GET: 'getUserConnections',
+  },
+})

package/src/types/voice.ts

@@ -0,0 +1,124 @@
+import { GuildMember, Internal, snowflake, timestamp } from '.'
+
+/** https://discord.com/developers/docs/resources/voice#voice-state-object-voice-state-structure */
+export interface VoiceState {
+  /** the guild id this voice state is for */
+  guild_id?: snowflake
+  /** the channel id this user is connected to */
+  channel_id?: snowflake
+  /** the user id this voice state is for */
+  user_id: snowflake
+  /** the guild member this voice state is for */
+  member?: GuildMember
+  /** the session id for this voice state */
+  session_id: string
+  /** whether this user is deafened by the server */
+  deaf: boolean
+  /** whether this user is muted by the server */
+  mute: boolean
+  /** whether this user is locally deafened */
+  self_deaf: boolean
+  /** whether this user is locally muted */
+  self_mute: boolean
+  /** whether this user is streaming using "Go Live" */
+  self_stream?: boolean
+  /** whether this user's camera is enabled */
+  self_video: boolean
+  /** whether this user is muted by the current user */
+  suppress: boolean
+  /** the time at which the user requested to speak */
+  request_to_speak_timestamp?: timestamp
+}
+
+export namespace VoiceState {
+  export namespace Params {
+    /** https://discord.com/developers/docs/resources/guild#modify-current-user-voice-state-json-params */
+    export interface ModifyCurrent extends Modify {
+      /** sets the user's request to speak */
+      request_to_speak_timestamp?: timestamp
+    }
+
+    /** https://discord.com/developers/docs/resources/guild#modify-user-voice-state-json-params */
+    export interface Modify {
+      /** the id of the channel the user is currently in */
+      channel_id: snowflake
+      /** toggles the user's suppress state */
+      suppress?: boolean
+    }
+  }
+}
+
+/** https://discord.com/developers/docs/resources/voice#voice-region-object-voice-region-structure */
+export interface VoiceRegion {
+  /** unique ID for the region */
+  id: string
+  /** name of the region */
+  name: string
+  /** true for a single server that is closest to the current user's client */
+  optimal: boolean
+  /** whether this is a deprecated voice region (avoid switching to these) */
+  deprecated: boolean
+  /** whether this is a custom voice region (used for events/etc) */
+  custom: boolean
+}
+
+export interface VoiceStateUpdateEvent extends VoiceState {}
+
+/** https://discord.com/developers/docs/topics/gateway-events#voice-server-update-voice-server-update-event-fields */
+export interface VoiceServerUpdateEvent {
+  /** voice connection token */
+  token: string
+  /** the guild this voice server update is for */
+  guild_id: snowflake
+  /** the voice server host */
+  endpoint?: string
+}
+
+declare module './gateway' {
+  interface GatewayEvents {
+    /** someone joined, left, or moved a voice channel */
+    VOICE_STATE_UPDATE: VoiceStateUpdateEvent
+    /** guild's voice server was updated */
+    VOICE_SERVER_UPDATE: VoiceServerUpdateEvent
+  }
+}
+
+declare module './internal' {
+  interface Internal {
+    /**
+     * Returns an array of voice region objects that can be used when setting a voice or stage channel's rtc_region.
+     * @see https://discord.com/developers/docs/resources/voice#list-voice-regions
+     */
+    listVoiceRegions(): Promise<VoiceRegion[]>
+    /**
+     * Returns a list of voice region objects for the guild. Unlike the similar /voice route, this returns VIP servers when the guild is VIP-enabled.
+     * @see https://discord.com/developers/docs/resources/guild#get-guild-voice-regions
+     */
+    getGuildVoiceRegions(guild_id: snowflake): Promise<VoiceRegion[]>
+    /**
+     * Updates the current user's voice state.
+     * @see https://discord.com/developers/docs/resources/guild#modify-current-user-voice-state
+     */
+    modifyCurrentUserVoiceState(guild_id: snowflake, params: VoiceState.Params.ModifyCurrent): Promise<VoiceState>
+    /**
+     * Updates another user's voice state.
+     * @see https://discord.com/developers/docs/resources/guild#modify-user-voice-state
+     */
+    modifyUserVoiceState(guild_id: snowflake, user_id: snowflake, params: VoiceState.Params.Modify): Promise<VoiceState>
+  }
+}
+
+Internal.define({
+  '/voice/regions': {
+    GET: 'listVoiceRegions',
+  },
+  '/guilds/{guild.id}/regions': {
+    GET: 'getGuildVoiceRegions',
+  },
+  '/guilds/{guild.id}/voice-states/@me': {
+    PATCH: 'modifyCurrentUserVoiceState',
+  },
+  '/guilds/{guild.id}/voice-states/{user.id}': {
+    PATCH: 'modifyUserVoiceState',
+  },
+})

package/src/types/webhook.ts

@@ -0,0 +1,246 @@
+import { AllowedMentions, Attachment, Channel, Component, Embed, Guild, integer, Internal, Message, snowflake, User } from '.'
+
+/** https://discord.com/developers/docs/resources/webhook#webhook-object-webhook-structure */
+export interface Webhook {
+  /** the id of the webhook */
+  id: snowflake
+  /** the type of the webhook */
+  type: Webhook.Type
+  /** the guild id this webhook is for, if any */
+  guild_id?: snowflake
+  /** the channel id this webhook is for, if any */
+  channel_id?: snowflake
+  /** the user this webhook was created by (not returned when getting a webhook with its token) */
+  user?: User
+  /** the default name of the webhook */
+  name?: string
+  /** the default user avatar hash of the webhook */
+  avatar?: string
+  /** the secure token of the webhook (returned for Incoming Webhooks) */
+  token?: string
+  /** the bot/OAuth2 application that created this webhook */
+  application_id?: snowflake
+  /** the guild of the channel that this webhook is following (returned for Channel Follower Webhooks) */
+  source_guild?: Partial<Guild>
+  /** the channel that this webhook is following (returned for Channel Follower Webhooks) */
+  source_channel?: Partial<Channel>
+  /** the url used for executing the webhook (returned by the webhooks OAuth2 flow) */
+  url?: string
+}
+
+export namespace Webhook {
+  /** https://discord.com/developers/docs/resources/webhook#webhook-object-webhook-types */
+  export enum Type {
+    /** Incoming Webhooks can post messages to channels with a generated token */
+    INCOMING = 1,
+    /** Channel Follower Webhooks are internal webhooks used with Channel Following to post new messages into channels */
+    CHANNEL_FOLLOWER = 2,
+    /** Application webhooks are webhooks used with Interactions */
+    APPLICATION = 3,
+  }
+
+  /** https://discord.com/developers/docs/resources/webhook#create-webhook-json-params */
+  export interface CreateParams {
+    /** name of the webhook (1-80 characters) */
+    name: string
+    /** image for the default webhook avatar */
+    avatar?: string
+  }
+
+  /** https://discord.com/developers/docs/resources/webhook#modify-webhook-json-params */
+  export interface ModifyParams {
+    /** the default name of the webhook */
+    name: string
+    /** image for the default webhook avatar */
+    avatar?: string
+    /** the new channel id this webhook should be moved to */
+    channel_id: snowflake
+  }
+
+  /** https://discord.com/developers/docs/resources/webhook#execute-webhook-query-string-params */
+  export interface ExecuteParams {
+    /** waits for server confirmation of message send before response, and returns the created message body (defaults to false; when false a message that is not saved does not return an error) */
+    wait: boolean
+    /** Send a message to the specified thread within a webhook's channel. The thread will automatically be unarchived. */
+    thread_id: snowflake
+  }
+
+  /** https://discord.com/developers/docs/resources/webhook#execute-webhook-jsonform-params */
+  export interface ExecuteBody {
+    /** the message contents (up to 2000 characters) */
+    content: string
+    /** override the default username of the webhook */
+    username: string
+    /** override the default avatar of the webhook */
+    avatar_url: string
+    /** true if this is a TTS message */
+    tts: boolean
+    /** embedded rich content */
+    embeds: Embed[]
+    /** allowed mentions for the message */
+    allowed_mentions: AllowedMentions
+    /** the components to include with the message */
+    components: Component[]
+    /** the contents of the file being sent */
+    files: any
+    /** JSON encoded body of non-file params */
+    payload_json: string
+    /** attachment objects with filename and description */
+    attachments: Partial<Attachment>[]
+    /** message flags combined as a bitfield (only SUPPRESS_EMBEDS can be set) */
+    flags: integer
+    /** name of thread to create (requires the webhook channel to be a forum channel) */
+    thread_name: string
+  }
+
+  /** https://discord.com/developers/docs/resources/webhook#get-webhook-message-query-string-params */
+  export interface MessageParams {
+    /** id of the thread the message is in */
+    thread_id: snowflake
+  }
+
+  /** https://discord.com/developers/docs/resources/webhook#edit-webhook-message-jsonform-params */
+  export interface MessageBody {
+    /** the message contents (up to 2000 characters) */
+    content: string
+    /** embedded rich content */
+    embeds: Embed[]
+    /** allowed mentions for the message */
+    allowed_mentions: AllowedMentions
+    /** the components to include with the message */
+    components: Component[]
+    /** the contents of the file being sent/edited */
+    files: any
+    /** JSON encoded body of non-file params (multipart/form-data only) */
+    payload_json: string
+    /** attached files to keep and possible descriptions for new files */
+    attachments: Partial<Attachment>[]
+  }
+}
+
+/** https://discord.com/developers/docs/topics/gateway-events#webhooks-update-webhooks-update-event-fields */
+export interface WebhooksUpdateEvent {
+  /** id of the guild */
+  guild_id: snowflake
+  /** id of the channel */
+  channel_id: snowflake
+}
+
+declare module './gateway' {
+  interface GatewayEvents {
+    /** guild channel webhook was created, update, or deleted */
+    WEBHOOKS_UPDATE: WebhooksUpdateEvent
+  }
+}
+
+declare module './internal' {
+  interface Internal {
+    /**
+     * Create a new webhook. Requires the MANAGE_WEBHOOKS permission. Returns a webhook object on success. Webhook names follow our naming restrictions that can be found in our Usernames and Nicknames documentation, with the following additional stipulations:
+     * @see https://discord.com/developers/docs/resources/webhook#create-webhook
+     */
+    createWebhook(channel_id: snowflake, params: Webhook.CreateParams): Promise<Webhook>
+    /**
+     * Returns a list of channel webhook objects. Requires the MANAGE_WEBHOOKS permission.
+     * @see https://discord.com/developers/docs/resources/webhook#get-channel-webhooks
+     */
+    getChannelWebhooks(channel_id: snowflake): Promise<Webhook[]>
+    /**
+     * Returns a list of guild webhook objects. Requires the MANAGE_WEBHOOKS permission.
+     * @see https://discord.com/developers/docs/resources/webhook#get-guild-webhooks
+     */
+    getGuildWebhooks(guild_id: snowflake): Promise<Webhook[]>
+    /**
+     * Returns the new webhook object for the given id.
+     * @see https://discord.com/developers/docs/resources/webhook#get-webhook
+     */
+    getWebhook(webhook_id: snowflake): Promise<Webhook>
+    /**
+     * Same as above, except this call does not require authentication and returns no user in the webhook object.
+     * @see https://discord.com/developers/docs/resources/webhook#get-webhook-with-token
+     */
+    getWebhookWithToken(webhook_id: snowflake, token: string): Promise<Webhook>
+    /**
+     * Modify a webhook. Requires the MANAGE_WEBHOOKS permission. Returns the updated webhook object on success.
+     * @see https://discord.com/developers/docs/resources/webhook#modify-webhook
+     */
+    modifyWebhook(webhook_id: snowflake, params: Webhook.ModifyParams): Promise<Webhook>
+    /**
+     * Same as above, except this call does not require authentication, does not accept a channel_id parameter in the body, and does not return a user in the webhook object.
+     * @see https://discord.com/developers/docs/resources/webhook#modify-webhook-with-token
+     */
+    modifyWebhookWithToken(webhook_id: snowflake, token: string, params: Webhook.ModifyParams): Promise<Webhook>
+    /**
+     * Delete a webhook permanently. Requires the MANAGE_WEBHOOKS permission. Returns a 204 No Content response on success.
+     * @see https://discord.com/developers/docs/resources/webhook#delete-webhook
+     */
+    deleteWebhook(webhook_id: snowflake): Promise<void>
+    /**
+     * Same as above, except this call does not require authentication.
+     * @see https://discord.com/developers/docs/resources/webhook#delete-webhook-with-token
+     */
+    deleteWebhookwithToken(webhook_id: snowflake, token: string): Promise<void>
+    /**
+     * Refer to Uploading Files for details on attachments and multipart/form-data requests.
+     * @see https://discord.com/developers/docs/resources/webhook#execute-webhook
+     */
+    executeWebhook(webhook_id: snowflake, token: string, body: Webhook.ExecuteBody, query: Webhook.ExecuteParams): Promise<void>
+    /**
+     * Refer to Slack's documentation for more information. We do not support Slack's channel, icon_emoji, mrkdwn, or mrkdwn_in properties.
+     * @see https://discord.com/developers/docs/resources/webhook#execute-slackcompatible-webhook
+     */
+    executeSlackCompatibleWebhook(webhook_id: snowflake, token: string, body: null, query: Webhook.ExecuteParams): Promise<void>
+    /**
+     * Add a new webhook to your GitHub repo (in the repo's settings), and use this endpoint as the "Payload URL." You can choose what events your Discord channel receives by choosing the "Let me select individual events" option and selecting individual events for the new webhook you're configuring.
+     * @see https://discord.com/developers/docs/resources/webhook#execute-githubcompatible-webhook
+     */
+    executeGitHubCompatibleWebhook(webhook_id: snowflake, token: string, body: null, query: Webhook.ExecuteParams): Promise<void>
+    /**
+     * Returns a previously-sent webhook message from the same token. Returns a message object on success.
+     * @see https://discord.com/developers/docs/resources/webhook#get-webhook-message
+     */
+    getWebhookMessage(webhook_id: snowflake, token: string, message_id: snowflake, params: Webhook.MessageParams): Promise<Message>
+    /**
+     * Edits a previously-sent webhook message from the same token. Returns a message object on success.
+     * @see https://discord.com/developers/docs/resources/webhook#edit-webhook-message
+     */
+    editWebhookMessage(webhook_id: snowflake, token: string, message_id: snowflake, body: Webhook.MessageBody, query: Webhook.MessageParams): Promise<void>
+    /**
+     * Deletes a message that was created by the webhook. Returns a 204 No Content response on success.
+     * @see https://discord.com/developers/docs/resources/webhook#delete-webhook-message
+     */
+    deleteWebhookMessage(webhook_id: snowflake, token: string, message_id: snowflake, params: Webhook.MessageParams): Promise<void>
+  }
+}
+
+Internal.define({
+  '/channels/{channel.id}/webhooks': {
+    POST: 'createWebhook',
+    GET: 'getChannelWebhooks',
+  },
+  '/guilds/{guild.id}/webhooks': {
+    GET: 'getGuildWebhooks',
+  },
+  '/webhooks/{webhook.id}': {
+    GET: 'getWebhook',
+    PATCH: 'modifyWebhook',
+    DELETE: 'deleteWebhook',
+  },
+  '/webhooks/{webhook.id}/{webhook.token}': {
+    GET: 'getWebhookwithToken',
+    PATCH: 'modifyWebhookwithToken',
+    DELETE: 'deleteWebhookwithToken',
+    POST: 'executeWebhook',
+  },
+  '/webhooks/{webhook.id}/{webhook.token}/slack': {
+    POST: 'executeSlackCompatibleWebhook',
+  },
+  '/webhooks/{webhook.id}/{webhook.token}/github': {
+    POST: 'executeGitHubCompatibleWebhook',
+  },
+  '/webhooks/{webhook.id}/{webhook.token}/messages/{message.id}': {
+    GET: 'getWebhookMessage',
+    PATCH: 'editWebhookMessage',
+    DELETE: 'deleteWebhookMessage',
+  },
+})