daenamnu/discordeno
1
0
Fork 0
mirror of https://github.com/discordeno/discordeno.git synced 2026-05-31 07:50:07 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
3bbb03b8e361dec86b66fd0beb9d6e2c101ac26b
discordeno/website/docs/generated/modules_client.md
Skillz4Killz 3bbb03b8e3 cleanup cleanup cleanup on isle dd (#2792) 
* cleanup cleanup cleanup on isle dd

* fix: rest manager import in test
2023-02-25 20:11:15 -06:00

79 KiB
Raw Blame History

discordeno-monorepo / Modules / @discordeno/client

Module: @discordeno/client

Table of contents

References

Enumerations

Classes

Interfaces

Type Aliases

Variables

Functions

References

default

Renames and re-exports Client

Type Aliases

ActionRowComponents

Ƭ ActionRowComponents: Button | SelectMenu

Defined in

packages/client/src/typings.ts:131

ActivityType

Ƭ ActivityType: ActivityTypes

Defined in

packages/client/src/typings.ts:135

AnyChannel

Ƭ AnyChannel: AnyGuildChannel | PrivateChannel | PossiblyUncachedTextable

Defined in

packages/client/src/typings.ts:120

AnyGuildChannel

Ƭ AnyGuildChannel: GuildTextableChannel | AnyVoiceChannel | CategoryChannel | AnyThreadChannel

Defined in

packages/client/src/typings.ts:121

AnyThreadChannel

Ƭ AnyThreadChannel: NewsThreadChannel | PrivateThreadChannel | PublicThreadChannel

Defined in

packages/client/src/typings.ts:122

AnyVoiceChannel

Ƭ AnyVoiceChannel: TextVoiceChannel | StageChannel

Defined in

packages/client/src/typings.ts:123

ApiVersions

Ƭ ApiVersions: 10

The API versions that are supported.

Defined in

packages/client/src/Client.ts:2439

ApplicationCommandOptions

Ƭ ApplicationCommandOptions: ApplicationCommandOptionsSubCommand | ApplicationCommandOptionsSubCommandGroup | ApplicationCommandOptionsWithValue

Defined in

packages/client/src/typings.ts:48

ApplicationCommandOptionsBoolean

Ƭ ApplicationCommandOptionsBoolean: ApplicationCommandOption<ApplicationCommandOptionTypes.Boolean>

Defined in

packages/client/src/typings.ts:52

ApplicationCommandOptionsChannel

Ƭ ApplicationCommandOptionsChannel: ApplicationCommandOption<ApplicationCommandOptionTypes.Channel>

Defined in

packages/client/src/typings.ts:53

ApplicationCommandOptionsInteger

Ƭ ApplicationCommandOptionsInteger: ApplicationCommandOptionsIntegerWithAutocomplete | ApplicationCommandOptionsIntegerWithoutAutocomplete | ApplicationCommandOptionsIntegerWithMinMax

Defined in

packages/client/src/typings.ts:54

ApplicationCommandOptionsIntegerWithAutocomplete

Ƭ ApplicationCommandOptionsIntegerWithAutocomplete: Omit<ApplicationCommandOptionWithChoices<ApplicationCommandOptionTypes.Integer>, "choices" | "min_value" | "max_value"> & AutocompleteEnabled

Defined in

packages/client/src/typings.ts:58

ApplicationCommandOptionsIntegerWithMinMax

Ƭ ApplicationCommandOptionsIntegerWithMinMax: Omit<ApplicationCommandOptionWithChoices<ApplicationCommandOptionTypes.Integer>, "choices" | "autocomplete"> & AutocompleteDisabledIntegerMinMax

Defined in

packages/client/src/typings.ts:68

ApplicationCommandOptionsIntegerWithoutAutocomplete

Ƭ ApplicationCommandOptionsIntegerWithoutAutocomplete: Omit<ApplicationCommandOptionWithChoices<ApplicationCommandOptionTypes.Integer>, "autocomplete" | "min_value" | "max_value"> & AutocompleteDisabledInteger

Defined in

packages/client/src/typings.ts:63

ApplicationCommandOptionsMentionable

Ƭ ApplicationCommandOptionsMentionable: ApplicationCommandOption<ApplicationCommandOptionTypes.Mentionable>

Defined in

packages/client/src/typings.ts:73

ApplicationCommandOptionsNumber

Ƭ ApplicationCommandOptionsNumber: ApplicationCommandOptionsNumberWithAutocomplete | ApplicationCommandOptionsNumberWithoutAutocomplete | ApplicationCommandOptionsNumberWithMinMax

Defined in

packages/client/src/typings.ts:74

ApplicationCommandOptionsNumberWithAutocomplete

Ƭ ApplicationCommandOptionsNumberWithAutocomplete: Omit<ApplicationCommandOptionWithChoices<ApplicationCommandOptionTypes.Number>, "choices" | "min_value" | "max_value"> & AutocompleteEnabled

Defined in

packages/client/src/typings.ts:78

ApplicationCommandOptionsNumberWithMinMax

Ƭ ApplicationCommandOptionsNumberWithMinMax: Omit<ApplicationCommandOptionWithChoices<ApplicationCommandOptionTypes.Number>, "choices" | "autocomplete"> & AutocompleteDisabledIntegerMinMax

Defined in

packages/client/src/typings.ts:88

ApplicationCommandOptionsNumberWithoutAutocomplete

Ƭ ApplicationCommandOptionsNumberWithoutAutocomplete: Omit<ApplicationCommandOptionWithChoices<ApplicationCommandOptionTypes.Number>, "autocomplete" | "min_value" | "max_value"> & AutocompleteDisabledInteger

Defined in

packages/client/src/typings.ts:83

ApplicationCommandOptionsRole

Ƭ ApplicationCommandOptionsRole: ApplicationCommandOption<ApplicationCommandOptionTypes.Role>

Defined in

packages/client/src/typings.ts:93

ApplicationCommandOptionsString

Ƭ ApplicationCommandOptionsString: ApplicationCommandOptionsStringWithAutocomplete | ApplicationCommandOptionsStringWithoutAutocomplete

Defined in

packages/client/src/typings.ts:94

ApplicationCommandOptionsStringWithAutocomplete

Ƭ ApplicationCommandOptionsStringWithAutocomplete: Omit<ApplicationCommandOptionWithChoices<ApplicationCommandOptionTypes.String>, "choices"> & AutocompleteEnabled

Defined in

packages/client/src/typings.ts:95

ApplicationCommandOptionsStringWithoutAutocomplete

Ƭ ApplicationCommandOptionsStringWithoutAutocomplete: Omit<ApplicationCommandOptionWithChoices<ApplicationCommandOptionTypes.String>, "autocomplete"> & AutocompleteDisabled

Defined in

packages/client/src/typings.ts:100

ApplicationCommandOptionsUser

Ƭ ApplicationCommandOptionsUser: ApplicationCommandOption<ApplicationCommandOptionTypes.User>

Defined in

packages/client/src/typings.ts:105

ApplicationCommandOptionsWithValue

Ƭ ApplicationCommandOptionsWithValue: ApplicationCommandOptionsString | ApplicationCommandOptionsInteger | ApplicationCommandOptionsBoolean | ApplicationCommandOptionsUser | ApplicationCommandOptionsChannel | ApplicationCommandOptionsRole | ApplicationCommandOptionsMentionable | ApplicationCommandOptionsNumber

Defined in

packages/client/src/typings.ts:106

ApplicationCommandStructure

Ƭ ApplicationCommandStructure: ChatInputApplicationCommandStructure | MessageApplicationCommandStructure | UserApplicationCommandStructure

Defined in

packages/client/src/typings.ts:41

AutoArchiveDuration

Ƭ AutoArchiveDuration: 60 | 1440 | 4320 | 10080

Defined in

packages/client/src/typings.ts:139

BigString

Ƭ BigString: bigint | string

A union type of string or bigint to help make it easier for users to switch between one another.

Defined in

packages/client/src/Client.ts:2437

BotActivityType

Ƭ BotActivityType: Exclude<ActivityTypes, ActivityTypes.Custom>

Defined in

packages/client/src/typings.ts:136

Button

Ƭ Button: InteractionButton | URLButton

Defined in

packages/client/src/typings.ts:132

ChatInputApplicationCommand

Ƭ ChatInputApplicationCommand: ApplicationCommand<ApplicationCommandTypes.ChatInput>

Defined in

packages/client/src/typings.ts:42

ChatInputApplicationCommandStructure

Ƭ ChatInputApplicationCommandStructure: Omit<ChatInputApplicationCommand, "id" | "application_id" | "guild_id">

Defined in

packages/client/src/typings.ts:43

GuildTextableChannel

Ƭ GuildTextableChannel: TextChannel | TextVoiceChannel | NewsChannel

Defined in

packages/client/src/typings.ts:124

ImageFormat

Ƭ ImageFormat: "jpg" | "jpeg" | "png" | "webp" | "gif"

The formats for images that are supported.

Defined in

packages/client/src/Client.ts:2443

ImageSize

Ƭ ImageSize: 16 | 32 | 64 | 128 | 256 | 512 | 1024 | 2048 | 4096

The sizes for images that are supported.

Defined in

packages/client/src/Client.ts:2441

InteractionContent

Ƭ InteractionContent: Pick<WebhookPayload, "content" | "embeds" | "allowedMentions" | "tts" | "flags" | "components" | "file">

Defined in

packages/client/src/typings.ts:129

InteractionContentEdit

Ƭ InteractionContentEdit: Pick<WebhookPayload, "content" | "embeds" | "allowedMentions" | "components" | "file">

Defined in

packages/client/src/typings.ts:130

MessageApplicationCommand

Ƭ MessageApplicationCommand: Omit<ApplicationCommand<ApplicationCommandTypes.Message>, "description" | "options">

Defined in

packages/client/src/typings.ts:44

MessageApplicationCommandStructure

Ƭ MessageApplicationCommandStructure: Omit<MessageApplicationCommand, "id" | "application_id" | "guild_id">

Defined in

packages/client/src/typings.ts:45

MessageContent

Ƭ MessageContent: string | AdvancedMessageContent

Defined in

packages/client/src/typings.ts:133

MessageContentEdit

Ƭ MessageContentEdit: string | AdvancedMessageContentEdit

Defined in

packages/client/src/typings.ts:134

MessageWebhookContent

Ƭ MessageWebhookContent: Pick<WebhookPayload, "content" | "embeds" | "file" | "allowedMentions" | "components">

Defined in

packages/client/src/typings.ts:140

PossiblyUncachedTextable

Ƭ PossiblyUncachedTextable: Textable | Uncached

Defined in

packages/client/src/typings.ts:125

RequestMethod

Ƭ RequestMethod: "GET" | "POST" | "PUT" | "DELETE" | "PATCH"

The methods that are acceptable for REST.

Defined in

packages/client/src/Client.ts:2445

SelfStatus

Ƭ SelfStatus: Status | "invisible"

Defined in

packages/client/src/typings.ts:138

Status

Ƭ Status: "online" | "idle" | "dnd"

Defined in

packages/client/src/typings.ts:137

TextVoiceChannelTypes

Ƭ TextVoiceChannelTypes: ChannelTypes.GuildVoice | ChannelTypes.GuildStageVoice

Defined in

packages/client/src/typings.ts:128

TextableChannel

Ƭ TextableChannel: GuildTextable & GuildTextableChannel | ThreadTextable & AnyThreadChannel | Textable & PrivateChannel

Defined in

packages/client/src/typings.ts:126

UserApplicationCommand

Ƭ UserApplicationCommand: Omit<ApplicationCommand<ApplicationCommandTypes.User>, "description" | "options">

Defined in

packages/client/src/typings.ts:46

UserApplicationCommandStructure

Ƭ UserApplicationCommandStructure: Omit<UserApplicationCommand, "id" | "application_id" | "guild_id">

Defined in

packages/client/src/typings.ts:47

VideoQualityMode

Ƭ VideoQualityMode: VideoQualityModes.Auto | VideoQualityModes.Full

Defined in

packages/client/src/typings.ts:127

Variables

CHANNELS

• Const CHANNELS: "/channels"

Defined in

packages/client/src/Endpoints.ts:30

DISCOVERY_CATEGORIES

• Const DISCOVERY_CATEGORIES: "/discovery/categories"

Defined in

packages/client/src/Endpoints.ts:32

DISCOVERY_VALIDATION

• Const DISCOVERY_VALIDATION: "/discovery/valid-term"

Defined in

packages/client/src/Endpoints.ts:33

GATEWAY

• Const GATEWAY: "/gateway"

Defined in

packages/client/src/Endpoints.ts:34

GATEWAY_BOT

• Const GATEWAY_BOT: "/gateway/bot"

Defined in

packages/client/src/Endpoints.ts:35

GUILDS

• Const GUILDS: "/guilds"

Defined in

packages/client/src/Endpoints.ts:77

MessageFlags

• Const MessageFlags: Object

Type declaration

Name Type
CROSSPOSTED number
EPHEMERAL number
HAS_THREAD number
IS_CROSSPOST number
LOADING number
SOURCE_MESSAGE_DELETED number
SUPPRESS_EMBEDS number
URGENT number

Defined in

packages/client/src/typings.ts:878

STAGE_INSTANCES

• Const STAGE_INSTANCES: "/stage-instances"

Defined in

packages/client/src/Endpoints.ts:82

STICKER_PACKS

• Const STICKER_PACKS: "/sticker-packs"

Defined in

packages/client/src/Endpoints.ts:84

USERS

• Const USERS: "/users"

Defined in

packages/client/src/Endpoints.ts:109

VOICE_REGIONS

• Const VOICE_REGIONS: "/voice/regions"

Defined in

packages/client/src/Endpoints.ts:110

Functions

ACHIEVEMENT_ICON

▸ ACHIEVEMENT_ICON(applicationID, achievementID, icon): string

CDN Endpoints

Parameters

Name Type
applicationID BigString
achievementID BigString
icon string

Returns

string

Defined in

packages/client/src/Endpoints.ts:118

APPLICATION_ASSET

▸ APPLICATION_ASSET(applicationID, asset): string

Parameters

Name Type
applicationID BigString
asset string

Returns

string

Defined in

packages/client/src/Endpoints.ts:120

APPLICATION_ICON

▸ APPLICATION_ICON(applicationID, icon): string

Parameters

Name Type
applicationID BigString
icon string

Returns

string

Defined in

packages/client/src/Endpoints.ts:121

BANNER

▸ BANNER(guildOrUserID, hash): string

Parameters

Name Type
guildOrUserID BigString
hash string

Returns

string

Defined in

packages/client/src/Endpoints.ts:122

CHANNEL

▸ CHANNEL(chanID): string

Parameters

Name Type
chanID BigString

Returns

string

Defined in

packages/client/src/Endpoints.ts:9

CHANNEL_BULK_DELETE

▸ CHANNEL_BULK_DELETE(chanID): string

Parameters

Name Type
chanID BigString

Returns

string

Defined in

packages/client/src/Endpoints.ts:10

CHANNEL_CALL_RING

▸ CHANNEL_CALL_RING(chanID): string

Parameters

Name Type
chanID BigString

Returns

string

Defined in

packages/client/src/Endpoints.ts:11

CHANNEL_CROSSPOST

▸ CHANNEL_CROSSPOST(chanID, msgID): string

Parameters

Name Type
chanID BigString
msgID BigString

Returns

string

Defined in

packages/client/src/Endpoints.ts:12

CHANNEL_FOLLOW

▸ CHANNEL_FOLLOW(chanID): string

Parameters

Name Type
chanID BigString

Returns

string

Defined in

packages/client/src/Endpoints.ts:13

CHANNEL_ICON

▸ CHANNEL_ICON(chanID, chanIcon): string

Parameters

Name Type
chanID BigString
chanIcon string

Returns

string

Defined in

packages/client/src/Endpoints.ts:123

CHANNEL_INVITES

▸ CHANNEL_INVITES(chanID): string

Parameters

Name Type
chanID BigString

Returns

string

Defined in

packages/client/src/Endpoints.ts:14

CHANNEL_MESSAGE

▸ CHANNEL_MESSAGE(chanID, msgID): string

Parameters

Name Type
chanID BigString
msgID BigString

Returns

string

Defined in

packages/client/src/Endpoints.ts:20

CHANNEL_MESSAGES

▸ CHANNEL_MESSAGES(chanID): string

Parameters

Name Type
chanID BigString

Returns

string

Defined in

packages/client/src/Endpoints.ts:21

CHANNEL_MESSAGES_SEARCH

▸ CHANNEL_MESSAGES_SEARCH(chanID): string

Parameters

Name Type
chanID BigString

Returns

string

Defined in

packages/client/src/Endpoints.ts:22

CHANNEL_MESSAGE_REACTION

▸ CHANNEL_MESSAGE_REACTION(chanID, msgID, reaction): string

Parameters

Name Type
chanID BigString
msgID BigString
reaction string

Returns

string

Defined in

packages/client/src/Endpoints.ts:15

CHANNEL_MESSAGE_REACTIONS

▸ CHANNEL_MESSAGE_REACTIONS(chanID, msgID): string

Parameters

Name Type
chanID BigString
msgID BigString

Returns

string

Defined in

packages/client/src/Endpoints.ts:19

CHANNEL_MESSAGE_REACTION_USER

▸ CHANNEL_MESSAGE_REACTION_USER(chanID, msgID, reaction, userID): string

Parameters

Name Type
chanID BigString
msgID BigString
reaction string
userID BigString

Returns

string

Defined in

packages/client/src/Endpoints.ts:17

CHANNEL_PERMISSION

▸ CHANNEL_PERMISSION(chanID, overID): string

Parameters

Name Type
chanID BigString
overID BigString

Returns

string

Defined in

packages/client/src/Endpoints.ts:23

CHANNEL_PERMISSIONS

▸ CHANNEL_PERMISSIONS(chanID): string

Parameters

Name Type
chanID BigString

Returns

string

Defined in

packages/client/src/Endpoints.ts:24

CHANNEL_PIN

▸ CHANNEL_PIN(chanID, msgID): string

Parameters

Name Type
chanID BigString
msgID BigString

Returns

string

Defined in

packages/client/src/Endpoints.ts:25

CHANNEL_PINS

▸ CHANNEL_PINS(chanID): string

Parameters

Name Type
chanID BigString

Returns

string

Defined in

packages/client/src/Endpoints.ts:26

CHANNEL_RECIPIENT

▸ CHANNEL_RECIPIENT(groupID, userID): string

Parameters

Name Type
groupID BigString
userID BigString

Returns

string

Defined in

packages/client/src/Endpoints.ts:27

CHANNEL_TYPING

▸ CHANNEL_TYPING(chanID): string

Parameters

Name Type
chanID BigString

Returns

string

Defined in

packages/client/src/Endpoints.ts:28

CHANNEL_WEBHOOKS

▸ CHANNEL_WEBHOOKS(chanID): string

Parameters

Name Type
chanID BigString

Returns

string

Defined in

packages/client/src/Endpoints.ts:29

COMMAND

▸ COMMAND(applicationID, commandID): string

Parameters

Name Type
applicationID BigString
commandID BigString

Returns

string

Defined in

packages/client/src/Endpoints.ts:5

COMMANDS

▸ COMMANDS(applicationID): string

Parameters

Name Type
applicationID BigString

Returns

string

Defined in

packages/client/src/Endpoints.ts:6

COMMAND_PERMISSIONS

▸ COMMAND_PERMISSIONS(applicationID, guildID, commandID): string

Parameters

Name Type
applicationID BigString
guildID BigString
commandID BigString

Returns

string

Defined in

packages/client/src/Endpoints.ts:7

CUSTOM_EMOJI

▸ CUSTOM_EMOJI(emojiID): string

Parameters

Name Type
emojiID BigString

Returns

string

Defined in

packages/client/src/Endpoints.ts:124

CUSTOM_EMOJI_GUILD

▸ CUSTOM_EMOJI_GUILD(emojiID): string

Parameters

Name Type
emojiID BigString

Returns

string

Defined in

packages/client/src/Endpoints.ts:31

DEFAULT_USER_AVATAR

▸ DEFAULT_USER_AVATAR(userDiscriminator): string

Parameters

Name Type
userDiscriminator string

Returns

string

Defined in

packages/client/src/Endpoints.ts:125

GUILD

▸ GUILD(guildID): string

Parameters

Name Type
guildID BigString

Returns

string

Defined in

packages/client/src/Endpoints.ts:36

GUILD_AUDIT_LOGS

▸ GUILD_AUDIT_LOGS(guildID): string

Parameters

Name Type
guildID BigString

Returns

string

Defined in

packages/client/src/Endpoints.ts:37

GUILD_AVATAR

▸ GUILD_AVATAR(guildID, userID, guildAvatar): string

Parameters

Name Type
guildID BigString
userID BigString
guildAvatar string

Returns

string

Defined in

packages/client/src/Endpoints.ts:126

GUILD_BAN

▸ GUILD_BAN(guildID, memberID): string

Parameters

Name Type
guildID BigString
memberID BigString

Returns

string

Defined in

packages/client/src/Endpoints.ts:38

GUILD_BANS

▸ GUILD_BANS(guildID): string

Parameters

Name Type
guildID BigString

Returns

string

Defined in

packages/client/src/Endpoints.ts:39

GUILD_CHANNELS

▸ GUILD_CHANNELS(guildID): string

Parameters

Name Type
guildID BigString

Returns

string

Defined in

packages/client/src/Endpoints.ts:40

GUILD_COMMAND

▸ GUILD_COMMAND(applicationID, guildID, commandID): string

Parameters

Name Type
applicationID BigString
guildID BigString
commandID BigString

Returns

string

Defined in

packages/client/src/Endpoints.ts:41

GUILD_COMMANDS

▸ GUILD_COMMANDS(applicationID, guildID): string

Parameters

Name Type
applicationID BigString
guildID BigString

Returns

string

Defined in

packages/client/src/Endpoints.ts:45

GUILD_COMMAND_PERMISSIONS

▸ GUILD_COMMAND_PERMISSIONS(applicationID, guildID): string

Parameters

Name Type
applicationID BigString
guildID BigString

Returns

string

Defined in

packages/client/src/Endpoints.ts:43

GUILD_DISCOVERY

▸ GUILD_DISCOVERY(guildID): string

Parameters

Name Type
guildID BigString

Returns

string

Defined in

packages/client/src/Endpoints.ts:46

GUILD_DISCOVERY_CATEGORY

▸ GUILD_DISCOVERY_CATEGORY(guildID, categoryID): string

Parameters

Name Type
guildID BigString
categoryID BigString

Returns

string

Defined in

packages/client/src/Endpoints.ts:47

GUILD_DISCOVERY_SPLASH

▸ GUILD_DISCOVERY_SPLASH(guildID, guildDiscoverySplash): string

Parameters

Name Type
guildID BigString
guildDiscoverySplash string

Returns

string

Defined in

packages/client/src/Endpoints.ts:128

GUILD_EMOJI

▸ GUILD_EMOJI(guildID, emojiID): string

Parameters

Name Type
guildID BigString
emojiID BigString

Returns

string

Defined in

packages/client/src/Endpoints.ts:48

GUILD_EMOJIS

▸ GUILD_EMOJIS(guildID): string

Parameters

Name Type
guildID BigString

Returns

string

Defined in

packages/client/src/Endpoints.ts:49

GUILD_ICON

▸ GUILD_ICON(guildID, guildIcon): string

Parameters

Name Type
guildID BigString
guildIcon string

Returns

string

Defined in

packages/client/src/Endpoints.ts:129

GUILD_INTEGRATION

▸ GUILD_INTEGRATION(guildID, inteID): string

Parameters

Name Type
guildID BigString
inteID BigString

Returns

string

Defined in

packages/client/src/Endpoints.ts:50

GUILD_INTEGRATIONS

▸ GUILD_INTEGRATIONS(guildID): string

Parameters

Name Type
guildID BigString

Returns

string

Defined in

packages/client/src/Endpoints.ts:52

GUILD_INTEGRATION_SYNC

▸ GUILD_INTEGRATION_SYNC(guildID, inteID): string

Parameters

Name Type
guildID BigString
inteID BigString

Returns

string

Defined in

packages/client/src/Endpoints.ts:51

GUILD_INVITES

▸ GUILD_INVITES(guildID): string

Parameters

Name Type
guildID BigString

Returns

string

Defined in

packages/client/src/Endpoints.ts:53

GUILD_MEMBER

▸ GUILD_MEMBER(guildID, memberID): string

Parameters

Name Type
guildID BigString
memberID BigString

Returns

string

Defined in

packages/client/src/Endpoints.ts:55

GUILD_MEMBERS

▸ GUILD_MEMBERS(guildID): string

Parameters

Name Type
guildID BigString

Returns

string

Defined in

packages/client/src/Endpoints.ts:59

GUILD_MEMBERS_SEARCH

▸ GUILD_MEMBERS_SEARCH(guildID): string

Parameters

Name Type
guildID BigString

Returns

string

Defined in

packages/client/src/Endpoints.ts:60

GUILD_MEMBER_NICK

▸ GUILD_MEMBER_NICK(guildID, memberID): string

Parameters

Name Type
guildID BigString
memberID BigString

Returns

string

Defined in

packages/client/src/Endpoints.ts:56

GUILD_MEMBER_ROLE

▸ GUILD_MEMBER_ROLE(guildID, memberID, roleID): string

Parameters

Name Type
guildID BigString
memberID BigString
roleID BigString

Returns

string

Defined in

packages/client/src/Endpoints.ts:57

GUILD_MESSAGES_SEARCH

▸ GUILD_MESSAGES_SEARCH(guildID): string

Parameters

Name Type
guildID BigString

Returns

string

Defined in

packages/client/src/Endpoints.ts:61

GUILD_PREVIEW

▸ GUILD_PREVIEW(guildID): string

Parameters

Name Type
guildID BigString

Returns

string

Defined in

packages/client/src/Endpoints.ts:62

GUILD_PRUNE

▸ GUILD_PRUNE(guildID): string

Parameters

Name Type
guildID BigString

Returns

string

Defined in

packages/client/src/Endpoints.ts:63

GUILD_ROLE

▸ GUILD_ROLE(guildID, roleID): string

Parameters

Name Type
guildID BigString
roleID BigString

Returns

string

Defined in

packages/client/src/Endpoints.ts:64

GUILD_ROLES

▸ GUILD_ROLES(guildID): string

Parameters

Name Type
guildID BigString

Returns

string

Defined in

packages/client/src/Endpoints.ts:65

GUILD_SPLASH

▸ GUILD_SPLASH(guildID, guildSplash): string

Parameters

Name Type
guildID BigString
guildSplash string

Returns

string

Defined in

packages/client/src/Endpoints.ts:130

GUILD_STICKER

▸ GUILD_STICKER(guildID, stickerID): string

Parameters

Name Type
guildID BigString
stickerID BigString

Returns

string

Defined in

packages/client/src/Endpoints.ts:66

GUILD_STICKERS

▸ GUILD_STICKERS(guildID): string

Parameters

Name Type
guildID BigString

Returns

string

Defined in

packages/client/src/Endpoints.ts:67

GUILD_TEMPLATE

▸ GUILD_TEMPLATE(code): string

Parameters

Name Type
code string

Returns

string

Defined in

packages/client/src/Endpoints.ts:68

GUILD_TEMPLATES

▸ GUILD_TEMPLATES(guildID): string

Parameters

Name Type
guildID BigString

Returns

string

Defined in

packages/client/src/Endpoints.ts:69

GUILD_TEMPLATE_GUILD

▸ GUILD_TEMPLATE_GUILD(guildID, code): string

Parameters

Name Type
guildID BigString
code string

Returns

string

Defined in

packages/client/src/Endpoints.ts:70

GUILD_VANITY_URL

▸ GUILD_VANITY_URL(guildID): string

Parameters

Name Type
guildID BigString

Returns

string

Defined in

packages/client/src/Endpoints.ts:54

GUILD_VOICE_REGIONS

▸ GUILD_VOICE_REGIONS(guildID): string

Parameters

Name Type
guildID BigString

Returns

string

Defined in

packages/client/src/Endpoints.ts:71

GUILD_VOICE_STATE

▸ GUILD_VOICE_STATE(guildID, user): string

Parameters

Name Type
guildID BigString
user BigString

Returns

string

Defined in

packages/client/src/Endpoints.ts:76

GUILD_WEBHOOKS

▸ GUILD_WEBHOOKS(guildID): string

Parameters

Name Type
guildID BigString

Returns

string

Defined in

packages/client/src/Endpoints.ts:72

GUILD_WELCOME_SCREEN

▸ GUILD_WELCOME_SCREEN(guildID): string

Parameters

Name Type
guildID BigString

Returns

string

Defined in

packages/client/src/Endpoints.ts:73

GUILD_WIDGET

▸ GUILD_WIDGET(guildID): string

Parameters

Name Type
guildID BigString

Returns

string

Defined in

packages/client/src/Endpoints.ts:74

GUILD_WIDGET_SETTINGS

▸ GUILD_WIDGET_SETTINGS(guildID): string

Parameters

Name Type
guildID BigString

Returns

string

Defined in

packages/client/src/Endpoints.ts:75

INTERACTION_RESPOND

▸ INTERACTION_RESPOND(interactID, interactToken): string

Parameters

Name Type
interactID BigString
interactToken string

Returns

string

Defined in

packages/client/src/Endpoints.ts:78

INVITE

▸ INVITE(inviteID): string

Parameters

Name Type
inviteID string

Returns

string

Defined in

packages/client/src/Endpoints.ts:79

MESSAGE_LINK

▸ MESSAGE_LINK(guildID, channelID, messageID): string

Client Endpoints

Parameters

Name Type
guildID BigString
channelID BigString
messageID BigString

Returns

string

Defined in

packages/client/src/Endpoints.ts:136

OAUTH2_APPLICATION

▸ OAUTH2_APPLICATION(appID): string

Parameters

Name Type
appID BigString

Returns

string

Defined in

packages/client/src/Endpoints.ts:80

ORIGINAL_INTERACTION_RESPONSE

▸ ORIGINAL_INTERACTION_RESPONSE(appID, interactToken): string

Parameters

Name Type
appID BigString
interactToken string

Returns

string

Defined in

packages/client/src/Endpoints.ts:4

ROLE_ICON

▸ ROLE_ICON(roleID, roleIcon): string

Parameters

Name Type
roleID BigString
roleIcon string

Returns

string

Defined in

packages/client/src/Endpoints.ts:131

STAGE_INSTANCE

▸ STAGE_INSTANCE(channelID): string

Parameters

Name Type
channelID BigString

Returns

string

Defined in

packages/client/src/Endpoints.ts:81

STICKER

▸ STICKER(stickerID): string

Parameters

Name Type
stickerID BigString

Returns

string

Defined in

packages/client/src/Endpoints.ts:83

TEAM_ICON

▸ TEAM_ICON(teamID, teamIcon): string

Parameters

Name Type
teamID BigString
teamIcon string

Returns

string

Defined in

packages/client/src/Endpoints.ts:132

THREADS_ACTIVE

▸ THREADS_ACTIVE(channelID): string

Parameters

Name Type
channelID BigString

Returns

string

Defined in

packages/client/src/Endpoints.ts:89

THREADS_ARCHIVED

▸ THREADS_ARCHIVED(channelID, type): string

Parameters

Name Type
channelID BigString
type string

Returns

string

Defined in

packages/client/src/Endpoints.ts:90

THREADS_ARCHIVED_JOINED

▸ THREADS_ARCHIVED_JOINED(channelID): string

Parameters

Name Type
channelID BigString

Returns

string

Defined in

packages/client/src/Endpoints.ts:91

THREADS_GUILD_ACTIVE

▸ THREADS_GUILD_ACTIVE(guildID): string

Parameters

Name Type
guildID BigString

Returns

string

Defined in

packages/client/src/Endpoints.ts:92

THREAD_MEMBER

▸ THREAD_MEMBER(channelID, userID): string

Parameters

Name Type
channelID BigString
userID BigString

Returns

string

Defined in

packages/client/src/Endpoints.ts:85

THREAD_MEMBERS

▸ THREAD_MEMBERS(channelID): string

Parameters

Name Type
channelID BigString

Returns

string

Defined in

packages/client/src/Endpoints.ts:86

THREAD_WITHOUT_MESSAGE

▸ THREAD_WITHOUT_MESSAGE(channelID): string

Parameters

Name Type
channelID BigString

Returns

string

Defined in

packages/client/src/Endpoints.ts:88

THREAD_WITH_MESSAGE

▸ THREAD_WITH_MESSAGE(channelID, msgID): string

Parameters

Name Type
channelID BigString
msgID BigString

Returns

string

Defined in

packages/client/src/Endpoints.ts:87

USER

▸ USER(userID): string

Parameters

Name Type
userID BigString

Returns

string

Defined in

packages/client/src/Endpoints.ts:93

USER_AVATAR

▸ USER_AVATAR(userID, userAvatar): string

Parameters

Name Type
userID BigString
userAvatar string

Returns

string

Defined in

packages/client/src/Endpoints.ts:133

USER_BILLING

▸ USER_BILLING(userID): string

Parameters

Name Type
userID BigString

Returns

string

Defined in

packages/client/src/Endpoints.ts:94

USER_BILLING_PAYMENTS

▸ USER_BILLING_PAYMENTS(userID): string

Parameters

Name Type
userID BigString

Returns

string

Defined in

packages/client/src/Endpoints.ts:95

USER_BILLING_PREMIUM_SUBSCRIPTION

▸ USER_BILLING_PREMIUM_SUBSCRIPTION(userID): string

Parameters

Name Type
userID BigString

Returns

string

Defined in

packages/client/src/Endpoints.ts:96

USER_CHANNELS

▸ USER_CHANNELS(userID): string

Parameters

Name Type
userID BigString

Returns

string

Defined in

packages/client/src/Endpoints.ts:97

USER_CONNECTIONS

▸ USER_CONNECTIONS(userID): string

Parameters

Name Type
userID BigString

Returns

string

Defined in

packages/client/src/Endpoints.ts:98

USER_CONNECTION_PLATFORM

▸ USER_CONNECTION_PLATFORM(userID, platform, id): string

Parameters

Name Type
userID BigString
platform string
id string

Returns

string

Defined in

packages/client/src/Endpoints.ts:99

USER_GUILD

▸ USER_GUILD(userID, guildID): string

Parameters

Name Type
userID BigString
guildID BigString

Returns

string

Defined in

packages/client/src/Endpoints.ts:100

USER_GUILDS

▸ USER_GUILDS(userID): string

Parameters

Name Type
userID BigString

Returns

string

Defined in

packages/client/src/Endpoints.ts:101

USER_MFA_CODES

▸ USER_MFA_CODES(userID): string

Parameters

Name Type
userID BigString

Returns

string

Defined in

packages/client/src/Endpoints.ts:102

USER_MFA_TOTP_DISABLE

▸ USER_MFA_TOTP_DISABLE(userID): string

Parameters

Name Type
userID BigString

Returns

string

Defined in

packages/client/src/Endpoints.ts:103

USER_MFA_TOTP_ENABLE

▸ USER_MFA_TOTP_ENABLE(userID): string

Parameters

Name Type
userID BigString

Returns

string

Defined in

packages/client/src/Endpoints.ts:104

USER_NOTE

▸ USER_NOTE(userID, targetID): string

Parameters

Name Type
userID BigString
targetID BigString

Returns

string

Defined in

packages/client/src/Endpoints.ts:105

USER_PROFILE

▸ USER_PROFILE(userID): string

Parameters

Name Type
userID BigString

Returns

string

Defined in

packages/client/src/Endpoints.ts:106

USER_RELATIONSHIP

▸ USER_RELATIONSHIP(userID, relID): string

Parameters

Name Type
userID BigString
relID BigString

Returns

string

Defined in

packages/client/src/Endpoints.ts:107

USER_SETTINGS

▸ USER_SETTINGS(userID): string

Parameters

Name Type
userID BigString

Returns

string

Defined in

packages/client/src/Endpoints.ts:108

WEBHOOK

▸ WEBHOOK(hookID): string

Parameters

Name Type
hookID BigString

Returns

string

Defined in

packages/client/src/Endpoints.ts:111

WEBHOOK_MESSAGE

▸ WEBHOOK_MESSAGE(hookID, token, msgID): string

Parameters

Name Type
hookID BigString
token string
msgID BigString

Returns

string

Defined in

packages/client/src/Endpoints.ts:112

WEBHOOK_SLACK

▸ WEBHOOK_SLACK(hookID): string

Parameters

Name Type
hookID BigString

Returns

string

Defined in

packages/client/src/Endpoints.ts:113

WEBHOOK_TOKEN

▸ WEBHOOK_TOKEN(hookID, token): string

Parameters

Name Type
hookID BigString
token string

Returns

string

Defined in

packages/client/src/Endpoints.ts:114

WEBHOOK_TOKEN_SLACK

▸ WEBHOOK_TOKEN_SLACK(hookID, token): string

Parameters

Name Type
hookID BigString
token string

Returns

string

Defined in

packages/client/src/Endpoints.ts:115

Reference in New Issue View Git Blame Copy Permalink