mirror of
https://github.com/discordjs/discord-api-types.git
synced 2026-05-28 06:20:11 +00:00
Compare commits
116 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
fe08e2d1e2 | ||
|
|
4afd0c13fd | ||
|
|
03f02a5a9e | ||
|
|
b4285c1d7e | ||
|
|
295276a581 | ||
|
|
46bb280690 | ||
|
|
cda030d74e | ||
|
|
79534f2e9d | ||
|
|
e6c12634e9 | ||
|
|
a41e646d3d | ||
|
|
a72e4545a3 | ||
|
|
0785436e2f | ||
|
|
5cd2511798 | ||
|
|
b760be279a | ||
|
|
c47e14570d | ||
|
|
30f95bc938 | ||
|
|
fe220db046 | ||
|
|
2f3b892feb | ||
|
|
574e5c12bd | ||
|
|
3eb77eb89e | ||
|
|
cbee43cdcd | ||
|
|
ecb4c336c0 | ||
|
|
9b68f04fb7 | ||
|
|
82f8ec4366 | ||
|
|
92b6632981 | ||
|
|
a8faa02857 | ||
|
|
1fee6339bf | ||
|
|
3245f7de92 | ||
|
|
b238cc5b67 | ||
|
|
e2ce6a3d2d | ||
|
|
f1d456de8c | ||
|
|
71c6d2609f | ||
|
|
7fbb3e3310 | ||
|
|
ef1f32acd0 | ||
|
|
6b05db5a2f | ||
|
|
ab926eb038 | ||
|
|
3e394aa44b | ||
|
|
077623299d | ||
|
|
fa5ab47b5e | ||
|
|
77cb32746f | ||
|
|
60e2b679f8 | ||
|
|
818d4ee6e7 | ||
|
|
31f07f9e5b | ||
|
|
91d851628d | ||
|
|
b2da18c634 | ||
|
|
9ae89dd9d8 | ||
|
|
c60f8d2e29 | ||
|
|
bb713c0aec | ||
|
|
28bb65f85a | ||
|
|
c76dd317b4 | ||
|
|
6df612809b | ||
|
|
7a18245abf | ||
|
|
ba70b0573c | ||
|
|
d71276cb5f | ||
|
|
121fb47f4c | ||
|
|
83d34ef00c | ||
|
|
c670a2551a | ||
|
|
ebf313c49c | ||
|
|
1d8f79e6b2 | ||
|
|
7d92c012c7 | ||
|
|
5d72696e20 | ||
|
|
10bf20b000 | ||
|
|
b16b065d04 | ||
|
|
61cda0c1fb | ||
|
|
7020afbe84 | ||
|
|
a2f3a7e79b | ||
|
|
a51261d2f2 | ||
|
|
de98a67b41 | ||
|
|
a822bc3f77 | ||
|
|
923aae517f | ||
|
|
8c61ed12dc | ||
|
|
e37ebed680 | ||
|
|
3cfa7f8ea7 | ||
|
|
f4b750062d | ||
|
|
0909412254 | ||
|
|
58fa897069 | ||
|
|
b7857315c4 | ||
|
|
64855f3451 | ||
|
|
da23f132f4 | ||
|
|
9daac44f1d | ||
|
|
72b8c830ee | ||
|
|
b360b2e6a7 | ||
|
|
544bd94be5 | ||
|
|
f25ea9dd1f | ||
|
|
c531fe2ff1 | ||
|
|
8d56c85160 | ||
|
|
653bba0bad | ||
|
|
90711463b6 | ||
|
|
17e1173e3d | ||
|
|
b0eed606a0 | ||
|
|
631be006d7 | ||
|
|
565918591b | ||
|
|
38fe58bc1a | ||
|
|
210ed49724 | ||
|
|
fda19fd863 | ||
|
|
4b84659fff | ||
|
|
b1244f1117 | ||
|
|
6a103d6b8a | ||
|
|
3af2ae2b85 | ||
|
|
a5d949e650 | ||
|
|
42acecced8 | ||
|
|
21420c3028 | ||
|
|
ca206593ef | ||
|
|
c64362a711 | ||
|
|
f5eb4b9e35 | ||
|
|
06ca2741f0 | ||
|
|
0479cafa1b | ||
|
|
bfaf36e42e | ||
|
|
5049f81b39 | ||
|
|
6437928821 | ||
|
|
07c9d4aab2 | ||
|
|
4b0a3af12b | ||
|
|
7196d8772d | ||
|
|
7d1d55fdc7 | ||
|
|
04ee6ac7f1 | ||
|
|
f5f850eb10 |
@@ -1,187 +0,0 @@
|
||||
import { AST_NODE_TYPES, ESLintUtils, TSESTree } from '@typescript-eslint/utils';
|
||||
import * as typescript from 'typescript';
|
||||
import * as tsutils from 'tsutils';
|
||||
|
||||
type Options = [
|
||||
{
|
||||
interfaceEndings: string[];
|
||||
},
|
||||
];
|
||||
|
||||
function shouldRun(eslNode: TSESTree.TSPropertySignature, interfaceEndings: string[]): boolean {
|
||||
// The first parent is the TSInterfaceBody, the second is the TSInterfaceDeclaration
|
||||
const interfaceNode = eslNode.parent?.parent;
|
||||
if (!(interfaceNode && 'id' in interfaceNode && interfaceNode.id?.type === AST_NODE_TYPES.Identifier)) {
|
||||
return false;
|
||||
}
|
||||
|
||||
const { name } = interfaceNode.id;
|
||||
if (typeof name !== 'string') {
|
||||
return false;
|
||||
}
|
||||
|
||||
return interfaceEndings.some((ending) => name.endsWith(ending));
|
||||
}
|
||||
|
||||
const schema = [
|
||||
{
|
||||
type: 'object',
|
||||
properties: {
|
||||
interfaceEndings: {
|
||||
type: 'array',
|
||||
items: {
|
||||
type: 'string',
|
||||
},
|
||||
},
|
||||
},
|
||||
},
|
||||
] as const;
|
||||
|
||||
const REST_TYPE_NAME_REGEX =
|
||||
/^REST(?:Get|Patch|Post|Put|Delete)[a-zA-Z0-9]+(?:JSONBody|FormDataBody|URLEncodedData|Result|Query)$/;
|
||||
|
||||
export = {
|
||||
rules: {
|
||||
'explicitly-optional-undefined-properties': ESLintUtils.RuleCreator.withoutDocs<Options, 'missingOptional'>({
|
||||
create: (context) => {
|
||||
const { interfaceEndings } = context.options[0];
|
||||
return {
|
||||
TSPropertySignature: (eslNode) => {
|
||||
if (!shouldRun(eslNode, interfaceEndings)) {
|
||||
return;
|
||||
}
|
||||
|
||||
if (eslNode.optional) {
|
||||
return;
|
||||
}
|
||||
|
||||
const parserServices = ESLintUtils.getParserServices(context);
|
||||
const checker = parserServices.program.getTypeChecker();
|
||||
const tsNode = parserServices.esTreeNodeToTSNodeMap.get(eslNode);
|
||||
const type = checker.getApparentType(checker.getTypeAtLocation(tsNode));
|
||||
const unionParts = tsutils.unionTypeParts(type);
|
||||
|
||||
// If our prop is not optional, but has undefined in its union, we should report
|
||||
if (!unionParts.some((ty) => tsutils.isTypeFlagSet(ty, typescript.TypeFlags.Undefined))) {
|
||||
return;
|
||||
}
|
||||
|
||||
context.report({
|
||||
node: eslNode,
|
||||
messageId: 'missingOptional',
|
||||
fix: (fixer) => fixer.insertTextAfter(eslNode.key, '?'),
|
||||
});
|
||||
},
|
||||
};
|
||||
},
|
||||
meta: {
|
||||
fixable: 'code',
|
||||
messages: {
|
||||
missingOptional: 'When a property has `| undefined`, it should be marked as optional.',
|
||||
},
|
||||
type: 'problem',
|
||||
schema: schema,
|
||||
},
|
||||
defaultOptions: [{ interfaceEndings: [] }],
|
||||
}),
|
||||
'explicit-undefined-on-optional-properties': ESLintUtils.RuleCreator.withoutDocs<Options, 'missingUndefined'>({
|
||||
create: (context) => {
|
||||
const { interfaceEndings } = context.options[0];
|
||||
return {
|
||||
// This is done naively because type-checking the node will always include `| undefined`
|
||||
// due to it being optional. ideally, we'd have a way to get the type of the node disregarding
|
||||
// the optional flag, which would make this check a lot more trivial
|
||||
TSPropertySignature: (eslNode) => {
|
||||
if (!shouldRun(eslNode, interfaceEndings)) {
|
||||
return;
|
||||
}
|
||||
|
||||
// If our prop is't optional or if it doesn't have a type annotation, we don't need to do anything
|
||||
if (!eslNode.optional || !eslNode.typeAnnotation) {
|
||||
return;
|
||||
}
|
||||
|
||||
const { typeAnnotation } = eslNode.typeAnnotation;
|
||||
switch (typeAnnotation.type) {
|
||||
case AST_NODE_TYPES.TSUnionType: {
|
||||
if (typeAnnotation.types.some((t) => t.type === AST_NODE_TYPES.TSUndefinedKeyword)) {
|
||||
return;
|
||||
}
|
||||
|
||||
break;
|
||||
}
|
||||
|
||||
case AST_NODE_TYPES.TSUndefinedKeyword: {
|
||||
return;
|
||||
}
|
||||
}
|
||||
|
||||
context.report({
|
||||
node: eslNode,
|
||||
messageId: 'missingUndefined',
|
||||
fix: (fixer) => fixer.insertTextAfter(eslNode.typeAnnotation!, ' | undefined'),
|
||||
});
|
||||
},
|
||||
};
|
||||
},
|
||||
meta: {
|
||||
fixable: 'code',
|
||||
messages: {
|
||||
missingUndefined: 'When a property is optional, explicitly include `undefined` in the union.',
|
||||
},
|
||||
type: 'suggestion',
|
||||
schema: schema,
|
||||
},
|
||||
defaultOptions: [{ interfaceEndings: [] }],
|
||||
}),
|
||||
'rest-type-naming-convention': ESLintUtils.RuleCreator.withoutDocs<[{ whitelist: string[] }], 'invalidName'>({
|
||||
create: (context) => {
|
||||
const { whitelist } = context.options[0];
|
||||
const whitelistSet = new Set(whitelist);
|
||||
|
||||
return {
|
||||
'TSTypeAliasDeclaration, TSInterfaceDeclaration': (
|
||||
node: TSESTree.TSTypeAliasDeclaration | TSESTree.TSInterfaceDeclaration,
|
||||
) => {
|
||||
if (node.id.type !== AST_NODE_TYPES.Identifier) {
|
||||
return;
|
||||
}
|
||||
|
||||
const { name } = node.id;
|
||||
if (whitelistSet.has(name)) {
|
||||
return;
|
||||
}
|
||||
|
||||
if (!REST_TYPE_NAME_REGEX.test(name)) {
|
||||
context.report({
|
||||
node: node.id,
|
||||
messageId: 'invalidName',
|
||||
data: { name },
|
||||
});
|
||||
}
|
||||
},
|
||||
};
|
||||
},
|
||||
meta: {
|
||||
messages: {
|
||||
invalidName: `{{ name }} does not match REST type naming convention. Must match ${REST_TYPE_NAME_REGEX.source}.`,
|
||||
},
|
||||
type: 'problem',
|
||||
schema: [
|
||||
{
|
||||
type: 'object',
|
||||
properties: {
|
||||
whitelist: {
|
||||
type: 'array',
|
||||
items: {
|
||||
type: 'string',
|
||||
},
|
||||
},
|
||||
},
|
||||
},
|
||||
] as const,
|
||||
},
|
||||
defaultOptions: [{ whitelist: [] }],
|
||||
}),
|
||||
},
|
||||
};
|
||||
@@ -1,9 +0,0 @@
|
||||
{
|
||||
"extends": "../tsconfig.json",
|
||||
"compilerOptions": {
|
||||
"declaration": false,
|
||||
"declarationMap": false,
|
||||
"skipLibCheck": true
|
||||
},
|
||||
"include": ["./index.ts"]
|
||||
}
|
||||
@@ -1,12 +0,0 @@
|
||||
deno/
|
||||
|
||||
gateway/v6/*
|
||||
payloads/v6/*
|
||||
rest/v6/*
|
||||
v6.ts
|
||||
|
||||
gateway/v8/*
|
||||
payloads/v8/*
|
||||
rest/v8/*
|
||||
utils/v8.ts
|
||||
v8.ts
|
||||
@@ -1,73 +0,0 @@
|
||||
{
|
||||
"extends": ["neon/common", "neon/node", "neon/typescript", "neon/prettier"],
|
||||
"parser": "@typescript-eslint/parser",
|
||||
"parserOptions": {
|
||||
"project": "./tsconfig.eslint.json"
|
||||
},
|
||||
"plugins": ["local"],
|
||||
"rules": {
|
||||
"local/explicit-undefined-on-optional-properties": ["error", { "interfaceEndings": ["JSONBody"] }],
|
||||
"local/explicitly-optional-undefined-properties": ["error", { "interfaceEndings": ["JSONBody"] }],
|
||||
"@typescript-eslint/consistent-type-definitions": ["error", "interface"],
|
||||
"@typescript-eslint/prefer-literal-enum-member": "off",
|
||||
"@typescript-eslint/sort-type-union-intersection-members": "off",
|
||||
"import/extensions": "off",
|
||||
"tsdoc/syntax": "off",
|
||||
"typescript-sort-keys/interface": "off",
|
||||
"typescript-sort-keys/string-enum": "off",
|
||||
"unicorn/prefer-math-trunc": "off",
|
||||
"jsdoc/no-undefined-types": "off"
|
||||
},
|
||||
"overrides": [
|
||||
{
|
||||
"files": ["rest/v10/*.ts", "rest/v9/*.ts"],
|
||||
"excludedFiles": ["rest/v10/index.ts", "rest/v9/index.ts"],
|
||||
"rules": {
|
||||
"local/rest-type-naming-convention": [
|
||||
"error",
|
||||
{
|
||||
"whitelist": [
|
||||
"RESTAPIAttachment",
|
||||
"RESTAPIChannelPatchOverwrite",
|
||||
"RESTAPIGuildChannelResolvable",
|
||||
"RESTAPIGuildCreateOverwrite",
|
||||
"RESTAPIGuildCreatePartialChannel",
|
||||
"RESTAPIGuildCreateRole",
|
||||
"RESTAPIGuildOnboardingPrompt",
|
||||
"RESTAPIGuildOnboardingPromptOption",
|
||||
"RESTAPIInteractionCallbackActivityInstanceResource",
|
||||
"RESTAPIInteractionCallbackObject",
|
||||
"RESTAPIInteractionCallbackResourceObject",
|
||||
"RESTAPIMessageReference",
|
||||
"RESTAPIPartialCurrentUserGuild",
|
||||
"RESTAPIPoll",
|
||||
|
||||
"RESTOAuth2AdvancedBotAuthorizationQuery",
|
||||
"RESTOAuth2AdvancedBotAuthorizationQueryResult",
|
||||
"RESTOAuth2AuthorizationQuery",
|
||||
"RESTOAuth2BotAuthorizationQuery",
|
||||
"RESTOAuth2ImplicitAuthorizationQuery",
|
||||
"RESTOAuth2ImplicitAuthorizationURLFragmentResult",
|
||||
|
||||
// Deprecated types
|
||||
"APIChannelPatchOverwrite",
|
||||
"APIGuildChannelResolvable",
|
||||
"APIGuildCreateOverwrite",
|
||||
"APIGuildCreatePartialChannel",
|
||||
"APIGuildCreateRole",
|
||||
"APIMessageReferenceSend",
|
||||
"GetAPIVoiceRegionsResult",
|
||||
"RESTAPIModifyGuildOnboardingPromptData",
|
||||
"RESTAPIModifyGuildOnboardingPromptOptionData",
|
||||
"RESTAPIPollCreate",
|
||||
"RESTDeleteAPIChannelMessageOwnReaction",
|
||||
"RESTGetAPIStickerPack",
|
||||
"RESTOAuth2AuthorizationQueryResult",
|
||||
"RESTPostAPIEntitlementBody"
|
||||
]
|
||||
}
|
||||
]
|
||||
}
|
||||
}
|
||||
]
|
||||
}
|
||||
2
.github/CONTRIBUTING.md
vendored
2
.github/CONTRIBUTING.md
vendored
@@ -13,11 +13,9 @@
|
||||
- Checkout a topic branch from a base branch, e.g. `main`, and merge back against that branch.
|
||||
|
||||
- If adding a new feature:
|
||||
|
||||
- Provide a convincing reason to add this feature. Ideally, you should open a suggestion issue first and have it approved before working on it.
|
||||
|
||||
- If fixing a bug:
|
||||
|
||||
- If you are resolving a special issue, add `fix/close #xxxx[,#xxxx]` (#xxxx is the issue id) in your PR body for a better release log, e.g.
|
||||
|
||||
```
|
||||
|
||||
32
.github/workflows/check-deno.yml
vendored
32
.github/workflows/check-deno.yml
vendored
@@ -1,32 +0,0 @@
|
||||
name: Deno
|
||||
|
||||
on:
|
||||
pull_request:
|
||||
types:
|
||||
- opened
|
||||
- synchronize
|
||||
|
||||
jobs:
|
||||
check_deno:
|
||||
name: Ensure Deno types are in sync with the code
|
||||
runs-on: ubuntu-latest
|
||||
permissions:
|
||||
contents: write
|
||||
pull-requests: write
|
||||
|
||||
steps:
|
||||
- name: Checkout Project
|
||||
uses: actions/checkout@v4
|
||||
|
||||
- name: Use Node.js v20
|
||||
uses: actions/setup-node@v4
|
||||
with:
|
||||
node-version: 20
|
||||
|
||||
- name: Install Dependencies
|
||||
run: npm ci
|
||||
|
||||
- name: Run Check Script
|
||||
run: node ./scripts/actions/report-deno-not-ran.mjs
|
||||
env:
|
||||
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
|
||||
17
.github/workflows/cicd.yml
vendored
17
.github/workflows/cicd.yml
vendored
@@ -17,21 +17,20 @@ jobs:
|
||||
- name: Add problem matcher
|
||||
run: echo "::add-matcher::.github/problemMatchers/eslint.json" && echo "::add-matcher::.github/problemMatchers/tsc.json"
|
||||
|
||||
- name: Use Node.js v20
|
||||
- name: Use Node.js
|
||||
uses: actions/setup-node@v4
|
||||
with:
|
||||
node-version: 20
|
||||
cache: npm
|
||||
registry-url: https://registry.npmjs.org/
|
||||
cache: 'yarn'
|
||||
node-version-file: package.json
|
||||
|
||||
- name: Install dependencies
|
||||
run: npm ci
|
||||
- name: Install Dependencies
|
||||
run: yarn
|
||||
|
||||
- name: Check lint on discord-api-types
|
||||
run: npm run test:lint
|
||||
run: yarn test:lint
|
||||
|
||||
- name: Run TSC
|
||||
run: npm run build:ci
|
||||
run: yarn build:ci
|
||||
|
||||
- name: Run Type Tests
|
||||
run: npm run test:types
|
||||
run: yarn test:types
|
||||
|
||||
@@ -21,14 +21,14 @@ jobs:
|
||||
with:
|
||||
fetch-depth: 0
|
||||
|
||||
- name: Install Node v20
|
||||
- name: Use Node.js
|
||||
uses: actions/setup-node@v4
|
||||
with:
|
||||
node-version: 20
|
||||
registry-url: https://registry.npmjs.org/
|
||||
cache: 'yarn'
|
||||
node-version-file: package.json
|
||||
|
||||
- name: Install dependencies
|
||||
run: npm ci
|
||||
- name: Install Dependencies
|
||||
run: yarn
|
||||
|
||||
- name: Install website dependencies
|
||||
run: pushd website && npm ci --ignore-scripts && popd
|
||||
@@ -41,14 +41,14 @@ jobs:
|
||||
- name: Bump version
|
||||
run: node ./scripts/bump-version.mjs
|
||||
env:
|
||||
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
|
||||
GITHUB_TOKEN: ${{ secrets.USER_PAT }}
|
||||
|
||||
- name: Create branch for changes, add all changes and push
|
||||
run: |
|
||||
git checkout -b "chore/release/$(jq --raw-output '.version' package.json)"
|
||||
|
||||
# Run changelog generation, deno script, website version bump
|
||||
npm run ci:pr
|
||||
yarn ci:pr
|
||||
|
||||
# Add all changes, commit and push
|
||||
git add --all .
|
||||
@@ -60,7 +60,7 @@ jobs:
|
||||
- name: Create Pull Request
|
||||
run: node ./scripts/actions/create-pr.mjs
|
||||
env:
|
||||
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
|
||||
GITHUB_TOKEN: ${{ secrets.USER_PAT }}
|
||||
|
||||
create_release:
|
||||
name: Create release and publish
|
||||
@@ -77,21 +77,22 @@ jobs:
|
||||
with:
|
||||
fetch-depth: 0
|
||||
|
||||
- name: Install Node v20
|
||||
- name: Use Node.js
|
||||
uses: actions/setup-node@v4
|
||||
with:
|
||||
node-version: 20
|
||||
registry-url: https://registry.npmjs.org/
|
||||
cache: 'yarn'
|
||||
node-version-file: package.json
|
||||
|
||||
- name: Install dependencies
|
||||
run: npm ci
|
||||
- name: Install Dependencies
|
||||
run: yarn
|
||||
|
||||
- name: Publish release to npm
|
||||
run: npm publish
|
||||
run: |
|
||||
yarn npm publish
|
||||
env:
|
||||
NODE_AUTH_TOKEN: ${{ secrets.NPM_PUBLISH_TOKEN }}
|
||||
YARN_NPM_AUTH_TOKEN: ${{ secrets.NPM_PUBLISH_TOKEN }}
|
||||
|
||||
- name: Create GitHub release
|
||||
run: node ./scripts/actions/create-release.mjs
|
||||
env:
|
||||
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
|
||||
GITHUB_TOKEN: ${{ secrets.USER_PAT }}
|
||||
|
||||
241
.github/workflows/documentation.yml
vendored
Normal file
241
.github/workflows/documentation.yml
vendored
Normal file
@@ -0,0 +1,241 @@
|
||||
name: Documentation
|
||||
|
||||
on:
|
||||
push:
|
||||
branches:
|
||||
- 'main'
|
||||
paths:
|
||||
- '**'
|
||||
- '!website/**'
|
||||
tags:
|
||||
- '**'
|
||||
workflow_dispatch:
|
||||
inputs:
|
||||
ref:
|
||||
description: 'The branch, tag or SHA to checkout'
|
||||
required: true
|
||||
ref_type:
|
||||
type: choice
|
||||
description: 'Branch or tag'
|
||||
options:
|
||||
- branch
|
||||
- tag
|
||||
required: true
|
||||
|
||||
concurrency:
|
||||
group: ${{ github.workflow }}-${{ github.head_ref || github.ref }}
|
||||
cancel-in-progress: true
|
||||
|
||||
env:
|
||||
ACTION_PACKAGE: discord-api-types
|
||||
|
||||
jobs:
|
||||
build-docs:
|
||||
name: Build & upload documentation
|
||||
runs-on: ubuntu-latest
|
||||
env:
|
||||
REF_TYPE: ${{ inputs.ref_type || github.ref_type }}
|
||||
if: github.repository_owner == 'discordjs'
|
||||
|
||||
steps:
|
||||
- name: Checkout discord-api-types
|
||||
uses: actions/checkout@v4
|
||||
with:
|
||||
ref: ${{ inputs.ref || '' }}
|
||||
|
||||
- name: Use Node.js
|
||||
uses: actions/setup-node@v4
|
||||
with:
|
||||
cache: 'yarn'
|
||||
node-version-file: package.json
|
||||
|
||||
- name: Install Dependencies for discord-api-types
|
||||
run: yarn
|
||||
|
||||
#region DJS start (mostly from discord.js/packages/actions/src/pnpmCache)
|
||||
# pnpm --filter="*api-*" --filter="scripts" --filter="actions" run build
|
||||
|
||||
- name: Checkout discord.js
|
||||
uses: actions/checkout@v4
|
||||
with:
|
||||
repository: discordjs/discord.js
|
||||
path: djs
|
||||
|
||||
- name: Set up swap space
|
||||
if: runner.os == 'Linux'
|
||||
uses: pierotofy/set-swap-space@v1.0
|
||||
with:
|
||||
swap-size-gb: 10
|
||||
|
||||
- uses: pnpm/action-setup@v4.1.0
|
||||
name: Install pnpm
|
||||
with:
|
||||
run_install: false
|
||||
package_json_file: djs/package.json
|
||||
|
||||
- name: Expose pnpm config(s) through "$GITHUB_OUTPUT"
|
||||
id: pnpm-config
|
||||
shell: bash
|
||||
run: |
|
||||
echo "STORE_PATH=$(pnpm store path)" >> $GITHUB_OUTPUT
|
||||
|
||||
- name: Cache rotation keys
|
||||
id: cache-rotation
|
||||
shell: bash
|
||||
run: |
|
||||
echo "YEAR_MONTH=$(/bin/date -u "+%Y%m")" >> $GITHUB_OUTPUT
|
||||
|
||||
- uses: actions/cache@v4
|
||||
name: Setup pnpm cache
|
||||
with:
|
||||
path: ${{ steps.pnpm-config.outputs.STORE_PATH }}
|
||||
key: ${{ runner.os }}-pnpm-store-cache-${{ steps.cache-rotation.outputs.YEAR_MONTH }}-${{ hashFiles('**/pnpm-lock.yaml') }}
|
||||
restore-keys: |
|
||||
${{ runner.os }}-pnpm-store-cache-${{ steps.cache-rotation.outputs.YEAR_MONTH }}-
|
||||
|
||||
- name: Install djs dependencies
|
||||
working-directory: djs
|
||||
shell: bash
|
||||
run: |
|
||||
pnpm install --filter="*api-*" --filter="scripts" --filter="actions" --frozen-lockfile --prefer-offline --loglevel error
|
||||
env:
|
||||
HUSKY: '0'
|
||||
|
||||
- name: Build djs
|
||||
working-directory: djs
|
||||
shell: bash
|
||||
run: |
|
||||
pnpm --filter="*api-*" --filter="scripts" --filter="actions" run build
|
||||
|
||||
#endregion
|
||||
|
||||
- name: Extract package and semver from tag
|
||||
if: ${{ env.REF_TYPE == 'tag' }}
|
||||
id: extract-tag
|
||||
uses: ./djs/packages/actions/src/formatTag
|
||||
with:
|
||||
tag: ${{ inputs.ref || github.ref_name }}
|
||||
|
||||
- name: Apply tag to api-extractor config
|
||||
if: ${{ env.REF_TYPE == 'tag' && !inputs.ref }}
|
||||
run: sed -i 's!https://github.com/discordjs/discord-api-types/tree/main!https://github.com/discordjs/discord-api-types/tree/${{ github.ref_name }}!' "api-extractor.json"
|
||||
|
||||
- name: Build docs
|
||||
shell: bash
|
||||
run: |
|
||||
yarn prepack
|
||||
./djs/packages/api-extractor/bin/api-extractor run --local --minify
|
||||
./djs/packages/scripts/bin/generateSplitDocumentation.js
|
||||
yarn postpack
|
||||
|
||||
- name: Upload documentation to database
|
||||
if: ${{ env.REF_TYPE == 'tag' && (!inputs.ref || inputs.ref == 'main') }}
|
||||
env:
|
||||
CF_D1_DOCS_API_KEY: ${{ secrets.CF_D1_DOCS_API_KEY }}
|
||||
CF_D1_DOCS_ID: ${{ secrets.CF_D1_DOCS_ID }}
|
||||
CF_ACCOUNT_ID: ${{ secrets.CF_ACCOUNT_ID }}
|
||||
CF_R2_DOCS_URL: ${{ secrets.CF_R2_DOCS_URL }}
|
||||
CF_R2_DOCS_ACCESS_KEY_ID: ${{ secrets.CF_R2_DOCS_ACCESS_KEY_ID }}
|
||||
CF_R2_DOCS_SECRET_ACCESS_KEY: ${{ secrets.CF_R2_DOCS_SECRET_ACCESS_KEY }}
|
||||
CF_R2_DOCS_BUCKET: ${{ secrets.CF_R2_DOCS_BUCKET }}
|
||||
CF_R2_DOCS_BUCKET_URL: ${{ secrets.CF_R2_DOCS_BUCKET_URL }}
|
||||
ACTION_PACKAGE: ${{ env.ACTION_PACKAGE }}
|
||||
ACTION_VERSION: ${{ steps.extract-tag.outputs.semver }}
|
||||
run: |
|
||||
yarn tsx ./scripts/actions/documentation/uploadDocumentation.ts
|
||||
|
||||
- name: Upload documentation to database
|
||||
if: ${{ env.REF_TYPE == 'tag' && inputs.ref && inputs.ref != 'main' }}
|
||||
env:
|
||||
CF_D1_DOCS_API_KEY: ${{ secrets.CF_D1_DOCS_API_KEY }}
|
||||
CF_D1_DOCS_ID: ${{ secrets.CF_D1_DOCS_ID }}
|
||||
CF_ACCOUNT_ID: ${{ secrets.CF_ACCOUNT_ID }}
|
||||
CF_R2_DOCS_URL: ${{ secrets.CF_R2_DOCS_URL }}
|
||||
CF_R2_DOCS_ACCESS_KEY_ID: ${{ secrets.CF_R2_DOCS_ACCESS_KEY_ID }}
|
||||
CF_R2_DOCS_SECRET_ACCESS_KEY: ${{ secrets.CF_R2_DOCS_SECRET_ACCESS_KEY }}
|
||||
CF_R2_DOCS_BUCKET: ${{ secrets.CF_R2_DOCS_BUCKET }}
|
||||
CF_R2_DOCS_BUCKET_URL: ${{ secrets.CF_R2_DOCS_BUCKET_URL }}
|
||||
ACTION_PACKAGE: ${{ env.ACTION_PACKAGE }}
|
||||
ACTION_VERSION: ${{ steps.extract-tag.outputs.semver }}
|
||||
run: |
|
||||
yarn tsx ./scripts/actions/documentation/uploadDocumentation.ts
|
||||
|
||||
- name: Upload split documentation to blob storage
|
||||
if: ${{ env.REF_TYPE == 'tag' && (!inputs.ref || inputs.ref == 'main') }}
|
||||
env:
|
||||
CF_R2_DOCS_URL: ${{ secrets.CF_R2_DOCS_URL }}
|
||||
CF_R2_DOCS_ACCESS_KEY_ID: ${{ secrets.CF_R2_DOCS_ACCESS_KEY_ID }}
|
||||
CF_R2_DOCS_SECRET_ACCESS_KEY: ${{ secrets.CF_R2_DOCS_SECRET_ACCESS_KEY }}
|
||||
CF_R2_DOCS_BUCKET: ${{ secrets.CF_R2_DOCS_BUCKET }}
|
||||
ACTION_PACKAGE: ${{ env.ACTION_PACKAGE }}
|
||||
ACTION_VERSION: ${{ steps.extract-tag.outputs.semver }}
|
||||
run: |
|
||||
yarn tsx ./scripts/actions/documentation/uploadSplitDocumentation.ts
|
||||
|
||||
- name: Upload split documentation to blob storage
|
||||
if: ${{ env.REF_TYPE == 'tag' && inputs.ref && inputs.ref != 'main' }}
|
||||
env:
|
||||
CF_R2_DOCS_URL: ${{ secrets.CF_R2_DOCS_URL }}
|
||||
CF_R2_DOCS_ACCESS_KEY_ID: ${{ secrets.CF_R2_DOCS_ACCESS_KEY_ID }}
|
||||
CF_R2_DOCS_SECRET_ACCESS_KEY: ${{ secrets.CF_R2_DOCS_SECRET_ACCESS_KEY }}
|
||||
CF_R2_DOCS_BUCKET: ${{ secrets.CF_R2_DOCS_BUCKET }}
|
||||
ACTION_PACKAGE: ${{ env.ACTION_PACKAGE }}
|
||||
ACTION_VERSION: ${{ steps.extract-tag.outputs.semver }}
|
||||
run: |
|
||||
yarn tsx ./scripts/actions/documentation/uploadSplitDocumentation.ts
|
||||
|
||||
- name: Upload documentation to database
|
||||
if: ${{ env.REF_TYPE == 'branch' && (!inputs.ref || inputs.ref == 'main') }}
|
||||
env:
|
||||
CF_D1_DOCS_API_KEY: ${{ secrets.CF_D1_DOCS_API_KEY }}
|
||||
CF_D1_DOCS_ID: ${{ secrets.CF_D1_DOCS_ID }}
|
||||
CF_ACCOUNT_ID: ${{ secrets.CF_ACCOUNT_ID }}
|
||||
CF_R2_DOCS_URL: ${{ secrets.CF_R2_DOCS_URL }}
|
||||
CF_R2_DOCS_ACCESS_KEY_ID: ${{ secrets.CF_R2_DOCS_ACCESS_KEY_ID }}
|
||||
CF_R2_DOCS_SECRET_ACCESS_KEY: ${{ secrets.CF_R2_DOCS_SECRET_ACCESS_KEY }}
|
||||
CF_R2_DOCS_BUCKET: ${{ secrets.CF_R2_DOCS_BUCKET }}
|
||||
CF_R2_DOCS_BUCKET_URL: ${{ secrets.CF_R2_DOCS_BUCKET_URL }}
|
||||
ACTION_PACKAGE: ${{ env.ACTION_PACKAGE }}
|
||||
ACTION_VERSION: ${{ steps.extract-tag.outputs.semver }}
|
||||
run: |
|
||||
yarn tsx ./scripts/actions/documentation/uploadDocumentation.ts
|
||||
|
||||
- name: Upload documentation to database
|
||||
if: ${{ env.REF_TYPE == 'branch' && inputs.ref && inputs.ref != 'main' }}
|
||||
env:
|
||||
CF_D1_DOCS_API_KEY: ${{ secrets.CF_D1_DOCS_API_KEY }}
|
||||
CF_D1_DOCS_ID: ${{ secrets.CF_D1_DOCS_ID }}
|
||||
CF_ACCOUNT_ID: ${{ secrets.CF_ACCOUNT_ID }}
|
||||
CF_R2_DOCS_URL: ${{ secrets.CF_R2_DOCS_URL }}
|
||||
CF_R2_DOCS_ACCESS_KEY_ID: ${{ secrets.CF_R2_DOCS_ACCESS_KEY_ID }}
|
||||
CF_R2_DOCS_SECRET_ACCESS_KEY: ${{ secrets.CF_R2_DOCS_SECRET_ACCESS_KEY }}
|
||||
CF_R2_DOCS_BUCKET: ${{ secrets.CF_R2_DOCS_BUCKET }}
|
||||
CF_R2_DOCS_BUCKET_URL: ${{ secrets.CF_R2_DOCS_BUCKET_URL }}
|
||||
ACTION_PACKAGE: ${{ env.ACTION_PACKAGE }}
|
||||
ACTION_VERSION: ${{ steps.extract-tag.outputs.semver }}
|
||||
run: |
|
||||
yarn tsx ./scripts/actions/documentation/uploadDocumentation.ts
|
||||
|
||||
- name: Upload split documentation to blob storage
|
||||
if: ${{ env.REF_TYPE == 'branch' && (!inputs.ref || inputs.ref == 'main') }}
|
||||
env:
|
||||
CF_R2_DOCS_URL: ${{ secrets.CF_R2_DOCS_URL }}
|
||||
CF_R2_DOCS_ACCESS_KEY_ID: ${{ secrets.CF_R2_DOCS_ACCESS_KEY_ID }}
|
||||
CF_R2_DOCS_SECRET_ACCESS_KEY: ${{ secrets.CF_R2_DOCS_SECRET_ACCESS_KEY }}
|
||||
CF_R2_DOCS_BUCKET: ${{ secrets.CF_R2_DOCS_BUCKET }}
|
||||
ACTION_PACKAGE: ${{ env.ACTION_PACKAGE }}
|
||||
ACTION_VERSION: ${{ steps.extract-tag.outputs.semver }}
|
||||
run: |
|
||||
yarn tsx ./scripts/actions/documentation/uploadSplitDocumentation.ts
|
||||
|
||||
- name: Upload split documentation to blob storage
|
||||
if: ${{ env.REF_TYPE == 'branch' && inputs.ref && inputs.ref != 'main' }}
|
||||
env:
|
||||
CF_R2_DOCS_URL: ${{ secrets.CF_R2_DOCS_URL }}
|
||||
CF_R2_DOCS_ACCESS_KEY_ID: ${{ secrets.CF_R2_DOCS_ACCESS_KEY_ID }}
|
||||
CF_R2_DOCS_SECRET_ACCESS_KEY: ${{ secrets.CF_R2_DOCS_SECRET_ACCESS_KEY }}
|
||||
CF_R2_DOCS_BUCKET: ${{ secrets.CF_R2_DOCS_BUCKET }}
|
||||
ACTION_PACKAGE: ${{ env.ACTION_PACKAGE }}
|
||||
ACTION_VERSION: ${{ steps.extract-tag.outputs.semver }}
|
||||
run: |
|
||||
yarn tsx ./scripts/actions/documentation/uploadSplitDocumentation.ts
|
||||
29
.github/workflows/publish-next.yml
vendored
29
.github/workflows/publish-next.yml
vendored
@@ -13,41 +13,40 @@ jobs:
|
||||
cancel-in-progress: true
|
||||
|
||||
name: Publish @next release to npm
|
||||
|
||||
runs-on: ubuntu-latest
|
||||
|
||||
permissions:
|
||||
id-token: write
|
||||
if: github.repository_owner == 'discordjs' && !(github.event_name == 'push' && startsWith(github.event.head_commit.message, 'chore(release)'))
|
||||
steps:
|
||||
# - name: Cancel previous publish attempts
|
||||
# uses: styfle/cancel-workflow-action@0.12.1
|
||||
# with:
|
||||
# access_token: ${{ github.token }}
|
||||
|
||||
if: github.repository_owner == 'discordjs' && !(github.event_name == 'push' && startsWith(github.event.head_commit.message, 'chore(release)'))
|
||||
|
||||
steps:
|
||||
- name: Checkout repository
|
||||
uses: actions/checkout@v4
|
||||
with:
|
||||
fetch-depth: 0
|
||||
|
||||
- name: Install Node v20
|
||||
- name: Use Node.js
|
||||
uses: actions/setup-node@v4
|
||||
with:
|
||||
node-version: 20
|
||||
registry-url: https://registry.npmjs.org/
|
||||
cache: 'yarn'
|
||||
node-version-file: package.json
|
||||
|
||||
- name: Install dependencies
|
||||
run: npm ci
|
||||
- name: Install Dependencies
|
||||
run: yarn
|
||||
|
||||
- name: Bump version
|
||||
run: node ./scripts/bump-version.mjs
|
||||
|
||||
- name: Deprecate old @next versions
|
||||
run: npx npm-deprecate --name "*next*" --package discord-api-types --message "No longer supported. Install the latest @next release" || true
|
||||
run: yarn npm-deprecate --name "*next*" --package discord-api-types --message "No longer supported. Install the latest @next release" || true
|
||||
env:
|
||||
NODE_AUTH_TOKEN: ${{ secrets.NPM_PUBLISH_TOKEN }}
|
||||
|
||||
- name: Publish new @next version
|
||||
run: |
|
||||
npm version $(jq --raw-output '.version' package.json)-next.$(git rev-parse --short HEAD).$(date +%s)
|
||||
npm publish --tag next
|
||||
yarn version $(jq --raw-output '.version' package.json)-next.$(git rev-parse --short HEAD).$(date +%s)
|
||||
yarn npm publish --tag next
|
||||
env:
|
||||
NODE_AUTH_TOKEN: ${{ secrets.NPM_PUBLISH_TOKEN }}
|
||||
YARN_NPM_AUTH_TOKEN: ${{ secrets.NPM_PUBLISH_TOKEN }}
|
||||
|
||||
41
.github/workflows/validate-pull-request.yml
vendored
Normal file
41
.github/workflows/validate-pull-request.yml
vendored
Normal file
@@ -0,0 +1,41 @@
|
||||
name: Validate Pull Request
|
||||
on:
|
||||
pull_request:
|
||||
jobs:
|
||||
deno:
|
||||
name: Ensure Deno types are synchronized
|
||||
runs-on: ubuntu-latest
|
||||
permissions:
|
||||
contents: write
|
||||
pull-requests: write
|
||||
steps:
|
||||
- name: Checkout Project
|
||||
uses: actions/checkout@v4
|
||||
|
||||
- name: Use Node.js
|
||||
uses: actions/setup-node@v4
|
||||
with:
|
||||
cache: 'yarn'
|
||||
node-version-file: package.json
|
||||
|
||||
- name: Install Dependencies
|
||||
run: yarn
|
||||
|
||||
- name: Run Check Script
|
||||
run: node ./scripts/actions/report-deno-not-ran.mjs
|
||||
env:
|
||||
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
|
||||
validate-supported-versions:
|
||||
runs-on: ubuntu-latest
|
||||
name: Disallow unsupported API versions
|
||||
steps:
|
||||
- name: Check for unsupported API changes
|
||||
env:
|
||||
GH_TOKEN: ${{ github.token }}
|
||||
run: |
|
||||
PATTERNS="gateway/v6.ts|gateway/v8.ts|payloads/v6/|payloads/v8/|rest/v6/|rest/v8/|rpc/v8.ts|utils/v8.ts|voice/v8.ts|^v6.ts$|^v8.ts$"
|
||||
|
||||
if gh pr view ${{ github.event.pull_request.number }} --repo ${{github.repository}} --json files --jq ".files[].path | select(test(\"$PATTERNS\"))" | grep -q .; then
|
||||
echo "::error::Unsupported API versions modified. Please make changes to current API versions only."
|
||||
exit 1
|
||||
fi
|
||||
10
.gitignore
vendored
10
.gitignore
vendored
@@ -1,4 +1,5 @@
|
||||
node_modules/
|
||||
.yarn/install-state.gz
|
||||
|
||||
# Custom ESLint rules
|
||||
.eslint-plugin-local/*
|
||||
@@ -56,5 +57,14 @@ voice/**/*.map
|
||||
voice/**/*.d.ts
|
||||
voice/**/*.mjs
|
||||
|
||||
# Don't commit generated docs
|
||||
tsdoc-metadata.json
|
||||
docs/*
|
||||
|
||||
# macOS files
|
||||
.DS_Store
|
||||
|
||||
# djs repo clone
|
||||
djs
|
||||
|
||||
_generated_
|
||||
|
||||
@@ -1 +1 @@
|
||||
npx --no-install commitlint --edit $1
|
||||
yarn commitlint --edit $1
|
||||
|
||||
@@ -1 +1 @@
|
||||
npx --no-install pretty-quick --staged && npx --no-install lint-staged && npm run build:deno && git add deno
|
||||
yarn pretty-quick --staged && yarn lint-staged && yarn build:deno && git add deno
|
||||
|
||||
@@ -13,12 +13,12 @@ website/build
|
||||
|
||||
# Don't format build outputs
|
||||
*.js
|
||||
!eslint.config.js
|
||||
*.d.ts
|
||||
*.mjs
|
||||
|
||||
# Miscellaneous
|
||||
CODEOWNERS
|
||||
renovate.json
|
||||
CHANGELOG.md
|
||||
|
||||
# Format all of scripts
|
||||
@@ -36,3 +36,7 @@ payloads/v8/*
|
||||
rest/v8/*
|
||||
utils/v8.ts
|
||||
v8.ts
|
||||
|
||||
.yarn/*
|
||||
djs/*
|
||||
_generated_
|
||||
|
||||
67
.yarn/plugins/postinstallDev.cjs
vendored
Normal file
67
.yarn/plugins/postinstallDev.cjs
vendored
Normal file
@@ -0,0 +1,67 @@
|
||||
/**
|
||||
* Altered from https://github.com/sachinraja/yarn-plugin-postinstall-dev/blob/main/sources/index.ts
|
||||
|
||||
MIT License
|
||||
|
||||
Copyright (c) 2021-2022 Sachin Raja
|
||||
|
||||
Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||
of this software and associated documentation files (the "Software"), to deal
|
||||
in the Software without restriction, including without limitation the rights
|
||||
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
||||
copies of the Software, and to permit persons to whom the Software is
|
||||
furnished to do so, subject to the following conditions:
|
||||
|
||||
The above copyright notice and this permission notice shall be included in all
|
||||
copies or substantial portions of the Software.
|
||||
|
||||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||||
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
||||
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
||||
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
||||
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
||||
SOFTWARE.
|
||||
*/
|
||||
|
||||
const scriptName = 'postinstallDev';
|
||||
|
||||
module.exports = {
|
||||
name: 'postinstall-dev-script',
|
||||
factory: (require) => ({
|
||||
hooks: {
|
||||
/**
|
||||
* @param {import('@yarnpkg/core').Project} project
|
||||
* @param {Parameters<import('@yarnpkg/core').Hooks['afterAllInstalled']>[1]} options
|
||||
*/
|
||||
async afterAllInstalled(project, options) {
|
||||
/**
|
||||
* @type {import('@yarnpkg/core')}
|
||||
*/
|
||||
const { scriptUtils, InstallMode } = require('@yarnpkg/core');
|
||||
|
||||
if (options.mode === InstallMode.UpdateLockfile) {
|
||||
return;
|
||||
}
|
||||
|
||||
const locator = project.topLevelWorkspace.anchoredLocator;
|
||||
|
||||
if (await scriptUtils.hasPackageScript(locator, scriptName, { project })) {
|
||||
const exitCode = await scriptUtils.executePackageScript(locator, scriptName, [], {
|
||||
project,
|
||||
stdin: process.stdin,
|
||||
stdout: process.stdout,
|
||||
stderr: process.stderr,
|
||||
});
|
||||
|
||||
if (exitCode !== 0) {
|
||||
const error = new Error(`${scriptName} script failed with exit code ${exitCode}`);
|
||||
error.stack = undefined;
|
||||
|
||||
throw error;
|
||||
}
|
||||
}
|
||||
},
|
||||
},
|
||||
}),
|
||||
};
|
||||
942
.yarn/releases/yarn-4.9.2.cjs
vendored
Executable file
942
.yarn/releases/yarn-4.9.2.cjs
vendored
Executable file
File diff suppressed because one or more lines are too long
8
.yarnrc.yml
Normal file
8
.yarnrc.yml
Normal file
@@ -0,0 +1,8 @@
|
||||
enableGlobalCache: true
|
||||
|
||||
nodeLinker: node-modules
|
||||
|
||||
yarnPath: .yarn/releases/yarn-4.9.2.cjs
|
||||
|
||||
plugins:
|
||||
- path: ./.yarn/plugins/postinstallDev.cjs
|
||||
167
CHANGELOG.md
167
CHANGELOG.md
@@ -1,3 +1,170 @@
|
||||
## [0.38.18](https://github.com/discordjs/discord-api-types/compare/0.38.17...0.38.18) (2025-07-31)
|
||||
|
||||
|
||||
### Bug Fixes
|
||||
|
||||
* Deprecate API related to guild ownership ([#1316](https://github.com/discordjs/discord-api-types/issues/1316)) ([4afd0c1](https://github.com/discordjs/discord-api-types/commit/4afd0c13fde05fa7117ecdeaf20534545cfdb005))
|
||||
|
||||
|
||||
### Features
|
||||
|
||||
* **GuildFeature:** add `GUILD_TAGS` ([#1315](https://github.com/discordjs/discord-api-types/issues/1315)) ([03f02a5](https://github.com/discordjs/discord-api-types/commit/03f02a5a9ee2e533b58b7790c4deb7ad571e5a92))
|
||||
|
||||
|
||||
|
||||
## [0.38.17](https://github.com/discordjs/discord-api-types/compare/0.38.16...0.38.17) (2025-07-24)
|
||||
|
||||
|
||||
### Features
|
||||
|
||||
* **auditLog:** add `AUTO_MODERATION_QUARANTINE_USER` ([#1310](https://github.com/discordjs/discord-api-types/issues/1310)) ([a72e454](https://github.com/discordjs/discord-api-types/commit/a72e4545a3409388a9c5ec0b5555ecc258de0ac2))
|
||||
* **GuildMemberFlags:** add `AutoModQuarantinedGuildTag` ([#1309](https://github.com/discordjs/discord-api-types/issues/1309)) ([a41e646](https://github.com/discordjs/discord-api-types/commit/a41e646d3d9b9f6bb15c2f6165043ef8042b26bf))
|
||||
|
||||
|
||||
|
||||
## [0.38.16](https://github.com/discordjs/discord-api-types/compare/0.38.15...0.38.16) (2025-07-13)
|
||||
|
||||
|
||||
### Bug Fixes
|
||||
|
||||
* **APIApplicationCommandChannelOption:** exclude directory channels ([#1300](https://github.com/discordjs/discord-api-types/issues/1300)) ([574e5c1](https://github.com/discordjs/discord-api-types/commit/574e5c12bddd2c515fd2b96b5705b5ef9f9d2787))
|
||||
|
||||
|
||||
|
||||
## [0.38.15](https://github.com/discordjs/discord-api-types/compare/0.38.14...0.38.15) (2025-07-03)
|
||||
|
||||
|
||||
### Bug Fixes
|
||||
|
||||
* **CDNRoutes:** correct `guildTagBadge` route ([#1291](https://github.com/discordjs/discord-api-types/issues/1291)) ([1fee633](https://github.com/discordjs/discord-api-types/commit/1fee6339bf05a98900d8703207c77b8e6d047f24))
|
||||
|
||||
|
||||
### Features
|
||||
|
||||
* user guild tags ([#1287](https://github.com/discordjs/discord-api-types/issues/1287)) ([3245f7d](https://github.com/discordjs/discord-api-types/commit/3245f7de92c40d3b74014dbf97a2c0eafea8bcd2))
|
||||
|
||||
|
||||
|
||||
## [0.38.14](https://github.com/discordjs/discord-api-types/compare/0.38.13...0.38.14) (2025-06-30)
|
||||
|
||||
|
||||
### Features
|
||||
|
||||
* role gradient colors ([#1281](https://github.com/discordjs/discord-api-types/issues/1281)) ([7fbb3e3](https://github.com/discordjs/discord-api-types/commit/7fbb3e3310bde5ea0e977afb83ea21bda0220633))
|
||||
* support new pinned messages routes ([#1254](https://github.com/discordjs/discord-api-types/issues/1254)) ([71c6d26](https://github.com/discordjs/discord-api-types/commit/71c6d2609f1713827e95c5f617011c053cd3eb6a))
|
||||
* **voice:** add close codes 4021 and 4022 ([#1283](https://github.com/discordjs/discord-api-types/issues/1283)) ([6b05db5](https://github.com/discordjs/discord-api-types/commit/6b05db5a2f9ea540e34e8429c07b96411d418b73))
|
||||
|
||||
|
||||
|
||||
## [0.38.13](https://github.com/discordjs/discord-api-types/compare/0.38.12...0.38.13) (2025-06-23)
|
||||
|
||||
|
||||
### Features
|
||||
|
||||
* **APIUser:** add `collectibles` ([#1274](https://github.com/discordjs/discord-api-types/issues/1274)) ([77cb327](https://github.com/discordjs/discord-api-types/commit/77cb32746f47247a4229910db8ec64f844038529))
|
||||
|
||||
|
||||
|
||||
## [0.38.12](https://github.com/discordjs/discord-api-types/compare/0.38.11...0.38.12) (2025-06-16)
|
||||
|
||||
|
||||
### Features
|
||||
|
||||
* **APIApplication:** add `approximate_user_authorization_count` ([#1272](https://github.com/discordjs/discord-api-types/issues/1272)) ([91d8516](https://github.com/discordjs/discord-api-types/commit/91d851628d2078e70b79e4aa7e464297eca745ce))
|
||||
* **APIUnfurledMediaItem:** add `attachment_id` ([#1273](https://github.com/discordjs/discord-api-types/issues/1273)) ([b2da18c](https://github.com/discordjs/discord-api-types/commit/b2da18c634c4e20112ce13a8e0a5e6db50063acc))
|
||||
|
||||
|
||||
|
||||
## [0.38.11](https://github.com/discordjs/discord-api-types/compare/0.38.10...0.38.11) (2025-06-04)
|
||||
|
||||
|
||||
### Bug Fixes
|
||||
|
||||
* **voice:** add `max_dave_protocol_version` to identify ([#1260](https://github.com/discordjs/discord-api-types/issues/1260)) ([83d34ef](https://github.com/discordjs/discord-api-types/commit/83d34ef00c4e25d5050c7fc47562b3faa9125215))
|
||||
* **voice:** add clients connect and client disconnect recieve payload ([#1261](https://github.com/discordjs/discord-api-types/issues/1261)) ([121fb47](https://github.com/discordjs/discord-api-types/commit/121fb47f4c0c51d6149bcf051ffc5bae04b1bba8))
|
||||
* **voice:** fix remaining payload typos ([#1262](https://github.com/discordjs/discord-api-types/issues/1262)) ([d71276c](https://github.com/discordjs/discord-api-types/commit/d71276cb5f3423a81780494d041694356b8cb49c))
|
||||
|
||||
|
||||
### Features
|
||||
|
||||
* voice v8 payloads & MLS voice opcodes ([#1257](https://github.com/discordjs/discord-api-types/issues/1257)) ([ebf313c](https://github.com/discordjs/discord-api-types/commit/ebf313c49c1d78cb1aaf238cfbae7c114f6215cf))
|
||||
|
||||
|
||||
|
||||
## [0.38.10](https://github.com/discordjs/discord-api-types/compare/0.38.9...0.38.10) (2025-06-02)
|
||||
|
||||
|
||||
|
||||
## [0.38.9](https://github.com/discordjs/discord-api-types/compare/0.38.8...0.38.9) (2025-05-31)
|
||||
|
||||
|
||||
### Bug Fixes
|
||||
|
||||
* discriminated thread channel types ([#1247](https://github.com/discordjs/discord-api-types/issues/1247)) ([72b8c83](https://github.com/discordjs/discord-api-types/commit/72b8c830ee6ed369085644e93b3e27849b0274ed))
|
||||
* optional `client_id` and `client_secret` in access token data ([#1248](https://github.com/discordjs/discord-api-types/issues/1248)) ([b360b2e](https://github.com/discordjs/discord-api-types/commit/b360b2e6a767fa34d48b2f02fd19511a2db98ecb))
|
||||
|
||||
|
||||
### Features
|
||||
|
||||
* deauthorised webhook events ([#1253](https://github.com/discordjs/discord-api-types/issues/1253)) ([9daac44](https://github.com/discordjs/discord-api-types/commit/9daac44f1d056115755e92fcc22995a9c05012be))
|
||||
|
||||
|
||||
|
||||
## [0.38.8](https://github.com/discordjs/discord-api-types/compare/0.38.7...0.38.8) (2025-05-15)
|
||||
|
||||
|
||||
|
||||
## [0.38.7](https://github.com/discordjs/discord-api-types/compare/0.38.6...0.38.7) (2025-05-15)
|
||||
|
||||
|
||||
|
||||
## [0.38.6](https://github.com/discordjs/discord-api-types/compare/0.38.5...0.38.6) (2025-05-15)
|
||||
|
||||
|
||||
### Bug Fixes
|
||||
|
||||
* wrong exports reported by ae ([#1239](https://github.com/discordjs/discord-api-types/issues/1239)) ([a5d949e](https://github.com/discordjs/discord-api-types/commit/a5d949e650fbc325c6b619da00edfa66d28abc72))
|
||||
|
||||
|
||||
### Features
|
||||
|
||||
* experimental new docs gen ([#1240](https://github.com/discordjs/discord-api-types/issues/1240)) ([3af2ae2](https://github.com/discordjs/discord-api-types/commit/3af2ae2b85550c83ec9bf1e124226d16e6a8ca7e))
|
||||
|
||||
|
||||
|
||||
## [0.38.5](https://github.com/discordjs/discord-api-types/compare/0.38.4...0.38.5) (2025-05-12)
|
||||
|
||||
|
||||
### Bug Fixes
|
||||
|
||||
* imports ([#1237](https://github.com/discordjs/discord-api-types/issues/1237)) ([c64362a](https://github.com/discordjs/discord-api-types/commit/c64362a711940a5fb5b0cb56c374ebc003fb3b0d))
|
||||
|
||||
|
||||
### Features
|
||||
|
||||
* `APIWebhookSourceChannel` ([#1235](https://github.com/discordjs/discord-api-types/issues/1235)) ([ca20659](https://github.com/discordjs/discord-api-types/commit/ca206593efd1dd8f09a59c832baef0187a7cc963))
|
||||
* `APIWebhookSourceGuild` ([#1236](https://github.com/discordjs/discord-api-types/issues/1236)) ([21420c3](https://github.com/discordjs/discord-api-types/commit/21420c3028afd8cc0e73cd1081c6ecdd02c81571))
|
||||
* invite channel ([#1232](https://github.com/discordjs/discord-api-types/issues/1232)) ([0479caf](https://github.com/discordjs/discord-api-types/commit/0479cafa1bedd549d54b7cc6c915fc6beb2ba6ec))
|
||||
|
||||
|
||||
|
||||
## [0.38.4](https://github.com/discordjs/discord-api-types/compare/0.38.3...0.38.4) (2025-05-08)
|
||||
|
||||
|
||||
### Features
|
||||
|
||||
* Specific typings for application emojis ([#1228](https://github.com/discordjs/discord-api-types/issues/1228)) ([4b0a3af](https://github.com/discordjs/discord-api-types/commit/4b0a3af12badba5221604a3304efaeb3d0b46dd7))
|
||||
|
||||
|
||||
|
||||
## [0.38.3](https://github.com/discordjs/discord-api-types/compare/0.38.2...0.38.3) (2025-05-05)
|
||||
|
||||
|
||||
|
||||
## [0.38.2](https://github.com/discordjs/discord-api-types/compare/0.38.1...0.38.2) (2025-05-01)
|
||||
|
||||
|
||||
|
||||
# [0.38.1](https://github.com/discordjs/discord-api-types/compare/0.37.120...0.38.1) (2025-04-22)
|
||||
|
||||
|
||||
|
||||
@@ -82,15 +82,12 @@ The exports of each API version is split into three main parts:
|
||||
- Everything exported with the `Gateway` prefix represents data that ONLY comes from or is directly related to the Gateway.
|
||||
|
||||
- Everything exported with the `REST` prefix represents data that ONLY comes from or is directly related to the REST API.
|
||||
|
||||
- For endpoint options, they will follow the following structure: `REST<HTTP Method><Type><Query|(JSON|FormData)Body|Result>` where the type represents what it will return.
|
||||
|
||||
- For example, `RESTPostAPIChannelMessageJSONBody` or `RESTGetAPIGatewayBotInfoResult`.
|
||||
|
||||
- Some exported types (specifically OAuth2 related ones) may not respect this entire structure due to the nature of the fields. They will start with either `RESTOAuth2` or with something similar to `REST<HTTP Method>OAuth2`
|
||||
|
||||
- If a type ends with `Result`, then it represents the expected result by calling its accompanying route.
|
||||
|
||||
- Types that are exported as `never` usually mean the result will be a `204 No Content`, so you can safely ignore it. This does **not** account for errors.
|
||||
|
||||
- Anything else that is miscellaneous will be exported based on what it represents (for example the `REST` route object).
|
||||
|
||||
104
api-extractor.json
Normal file
104
api-extractor.json
Normal file
@@ -0,0 +1,104 @@
|
||||
{
|
||||
"$schema": "../discord.js/packages/api-extractor/src/schemas/api-extractor.schema.json",
|
||||
|
||||
"mainEntryPointFilePath": "<projectFolder>/v10.d.ts",
|
||||
"mainEntryPointName": "v10",
|
||||
|
||||
"additionalEntryPoints": [
|
||||
{ "modulePath": "v9", "filePath": "<projectFolder>/v9.d.ts" },
|
||||
{ "modulePath": "rpc/v10", "filePath": "<projectFolder>/rpc/v10.d.ts" },
|
||||
{ "modulePath": "voice/v4", "filePath": "<projectFolder>/voice/v4.d.ts" },
|
||||
{ "modulePath": "voice/v8", "filePath": "<projectFolder>/voice/v8.d.ts" }
|
||||
],
|
||||
|
||||
"bundledPackages": [],
|
||||
|
||||
"compiler": {
|
||||
"overrideTsconfig": {
|
||||
"compilerOptions": {
|
||||
"allowUnreachableCode": false,
|
||||
"allowUnusedLabels": false,
|
||||
"exactOptionalPropertyTypes": true,
|
||||
"noFallthroughCasesInSwitch": true,
|
||||
"noImplicitOverride": true,
|
||||
"noImplicitReturns": true,
|
||||
"noPropertyAccessFromIndexSignature": false,
|
||||
"noUncheckedIndexedAccess": true,
|
||||
"noUnusedLocals": true,
|
||||
"noUnusedParameters": true,
|
||||
"strict": true,
|
||||
|
||||
"allowArbitraryExtensions": false,
|
||||
"allowImportingTsExtensions": false,
|
||||
"module": "ESNext",
|
||||
"moduleResolution": "nodenext",
|
||||
"resolveJsonModule": true,
|
||||
"resolvePackageJsonExports": false,
|
||||
"resolvePackageJsonImports": false,
|
||||
|
||||
"declaration": true,
|
||||
"declarationMap": true,
|
||||
"importHelpers": false,
|
||||
"newLine": "lf",
|
||||
"noEmitHelpers": true,
|
||||
"outDir": "dist",
|
||||
"removeComments": false,
|
||||
"sourceMap": true,
|
||||
|
||||
"esModuleInterop": false,
|
||||
"forceConsistentCasingInFileNames": true,
|
||||
"isolatedModules": true,
|
||||
|
||||
"experimentalDecorators": true,
|
||||
"lib": ["ESNext"],
|
||||
"target": "ES2022",
|
||||
"useDefineForClassFields": true
|
||||
},
|
||||
"exclude": ["djs/**/*", "website/**/*", "node_modules/**/*"]
|
||||
}
|
||||
},
|
||||
"apiReport": {
|
||||
"enabled": false
|
||||
},
|
||||
|
||||
"docModel": {
|
||||
"enabled": true,
|
||||
|
||||
"apiJsonFilePath": "<projectFolder>/docs/docs.api.json",
|
||||
"projectFolderUrl": "https://github.com/discordjs/discord-api-types/tree/main"
|
||||
},
|
||||
|
||||
"dtsRollup": {
|
||||
"enabled": false,
|
||||
|
||||
"untrimmedFilePath": "<projectFolder>/v10.d.ts"
|
||||
},
|
||||
|
||||
"tsdocMetadata": {},
|
||||
|
||||
"newlineKind": "lf",
|
||||
|
||||
"messages": {
|
||||
"compilerMessageReporting": {
|
||||
"default": {
|
||||
"logLevel": "warning"
|
||||
}
|
||||
},
|
||||
|
||||
"extractorMessageReporting": {
|
||||
"default": {
|
||||
"logLevel": "warning"
|
||||
},
|
||||
|
||||
"ae-missing-release-tag": {
|
||||
"logLevel": "none"
|
||||
}
|
||||
},
|
||||
|
||||
"tsdocMessageReporting": {
|
||||
"default": {
|
||||
"logLevel": "warning"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
167
deno/CHANGELOG.md
generated
167
deno/CHANGELOG.md
generated
@@ -1,3 +1,170 @@
|
||||
## [0.38.18](https://github.com/discordjs/discord-api-types/compare/0.38.17...0.38.18) (2025-07-31)
|
||||
|
||||
|
||||
### Bug Fixes
|
||||
|
||||
* Deprecate API related to guild ownership ([#1316](https://github.com/discordjs/discord-api-types/issues/1316)) ([4afd0c1](https://github.com/discordjs/discord-api-types/commit/4afd0c13fde05fa7117ecdeaf20534545cfdb005))
|
||||
|
||||
|
||||
### Features
|
||||
|
||||
* **GuildFeature:** add `GUILD_TAGS` ([#1315](https://github.com/discordjs/discord-api-types/issues/1315)) ([03f02a5](https://github.com/discordjs/discord-api-types/commit/03f02a5a9ee2e533b58b7790c4deb7ad571e5a92))
|
||||
|
||||
|
||||
|
||||
## [0.38.17](https://github.com/discordjs/discord-api-types/compare/0.38.16...0.38.17) (2025-07-24)
|
||||
|
||||
|
||||
### Features
|
||||
|
||||
* **auditLog:** add `AUTO_MODERATION_QUARANTINE_USER` ([#1310](https://github.com/discordjs/discord-api-types/issues/1310)) ([a72e454](https://github.com/discordjs/discord-api-types/commit/a72e4545a3409388a9c5ec0b5555ecc258de0ac2))
|
||||
* **GuildMemberFlags:** add `AutoModQuarantinedGuildTag` ([#1309](https://github.com/discordjs/discord-api-types/issues/1309)) ([a41e646](https://github.com/discordjs/discord-api-types/commit/a41e646d3d9b9f6bb15c2f6165043ef8042b26bf))
|
||||
|
||||
|
||||
|
||||
## [0.38.16](https://github.com/discordjs/discord-api-types/compare/0.38.15...0.38.16) (2025-07-13)
|
||||
|
||||
|
||||
### Bug Fixes
|
||||
|
||||
* **APIApplicationCommandChannelOption:** exclude directory channels ([#1300](https://github.com/discordjs/discord-api-types/issues/1300)) ([574e5c1](https://github.com/discordjs/discord-api-types/commit/574e5c12bddd2c515fd2b96b5705b5ef9f9d2787))
|
||||
|
||||
|
||||
|
||||
## [0.38.15](https://github.com/discordjs/discord-api-types/compare/0.38.14...0.38.15) (2025-07-03)
|
||||
|
||||
|
||||
### Bug Fixes
|
||||
|
||||
* **CDNRoutes:** correct `guildTagBadge` route ([#1291](https://github.com/discordjs/discord-api-types/issues/1291)) ([1fee633](https://github.com/discordjs/discord-api-types/commit/1fee6339bf05a98900d8703207c77b8e6d047f24))
|
||||
|
||||
|
||||
### Features
|
||||
|
||||
* user guild tags ([#1287](https://github.com/discordjs/discord-api-types/issues/1287)) ([3245f7d](https://github.com/discordjs/discord-api-types/commit/3245f7de92c40d3b74014dbf97a2c0eafea8bcd2))
|
||||
|
||||
|
||||
|
||||
## [0.38.14](https://github.com/discordjs/discord-api-types/compare/0.38.13...0.38.14) (2025-06-30)
|
||||
|
||||
|
||||
### Features
|
||||
|
||||
* role gradient colors ([#1281](https://github.com/discordjs/discord-api-types/issues/1281)) ([7fbb3e3](https://github.com/discordjs/discord-api-types/commit/7fbb3e3310bde5ea0e977afb83ea21bda0220633))
|
||||
* support new pinned messages routes ([#1254](https://github.com/discordjs/discord-api-types/issues/1254)) ([71c6d26](https://github.com/discordjs/discord-api-types/commit/71c6d2609f1713827e95c5f617011c053cd3eb6a))
|
||||
* **voice:** add close codes 4021 and 4022 ([#1283](https://github.com/discordjs/discord-api-types/issues/1283)) ([6b05db5](https://github.com/discordjs/discord-api-types/commit/6b05db5a2f9ea540e34e8429c07b96411d418b73))
|
||||
|
||||
|
||||
|
||||
## [0.38.13](https://github.com/discordjs/discord-api-types/compare/0.38.12...0.38.13) (2025-06-23)
|
||||
|
||||
|
||||
### Features
|
||||
|
||||
* **APIUser:** add `collectibles` ([#1274](https://github.com/discordjs/discord-api-types/issues/1274)) ([77cb327](https://github.com/discordjs/discord-api-types/commit/77cb32746f47247a4229910db8ec64f844038529))
|
||||
|
||||
|
||||
|
||||
## [0.38.12](https://github.com/discordjs/discord-api-types/compare/0.38.11...0.38.12) (2025-06-16)
|
||||
|
||||
|
||||
### Features
|
||||
|
||||
* **APIApplication:** add `approximate_user_authorization_count` ([#1272](https://github.com/discordjs/discord-api-types/issues/1272)) ([91d8516](https://github.com/discordjs/discord-api-types/commit/91d851628d2078e70b79e4aa7e464297eca745ce))
|
||||
* **APIUnfurledMediaItem:** add `attachment_id` ([#1273](https://github.com/discordjs/discord-api-types/issues/1273)) ([b2da18c](https://github.com/discordjs/discord-api-types/commit/b2da18c634c4e20112ce13a8e0a5e6db50063acc))
|
||||
|
||||
|
||||
|
||||
## [0.38.11](https://github.com/discordjs/discord-api-types/compare/0.38.10...0.38.11) (2025-06-04)
|
||||
|
||||
|
||||
### Bug Fixes
|
||||
|
||||
* **voice:** add `max_dave_protocol_version` to identify ([#1260](https://github.com/discordjs/discord-api-types/issues/1260)) ([83d34ef](https://github.com/discordjs/discord-api-types/commit/83d34ef00c4e25d5050c7fc47562b3faa9125215))
|
||||
* **voice:** add clients connect and client disconnect recieve payload ([#1261](https://github.com/discordjs/discord-api-types/issues/1261)) ([121fb47](https://github.com/discordjs/discord-api-types/commit/121fb47f4c0c51d6149bcf051ffc5bae04b1bba8))
|
||||
* **voice:** fix remaining payload typos ([#1262](https://github.com/discordjs/discord-api-types/issues/1262)) ([d71276c](https://github.com/discordjs/discord-api-types/commit/d71276cb5f3423a81780494d041694356b8cb49c))
|
||||
|
||||
|
||||
### Features
|
||||
|
||||
* voice v8 payloads & MLS voice opcodes ([#1257](https://github.com/discordjs/discord-api-types/issues/1257)) ([ebf313c](https://github.com/discordjs/discord-api-types/commit/ebf313c49c1d78cb1aaf238cfbae7c114f6215cf))
|
||||
|
||||
|
||||
|
||||
## [0.38.10](https://github.com/discordjs/discord-api-types/compare/0.38.9...0.38.10) (2025-06-02)
|
||||
|
||||
|
||||
|
||||
## [0.38.9](https://github.com/discordjs/discord-api-types/compare/0.38.8...0.38.9) (2025-05-31)
|
||||
|
||||
|
||||
### Bug Fixes
|
||||
|
||||
* discriminated thread channel types ([#1247](https://github.com/discordjs/discord-api-types/issues/1247)) ([72b8c83](https://github.com/discordjs/discord-api-types/commit/72b8c830ee6ed369085644e93b3e27849b0274ed))
|
||||
* optional `client_id` and `client_secret` in access token data ([#1248](https://github.com/discordjs/discord-api-types/issues/1248)) ([b360b2e](https://github.com/discordjs/discord-api-types/commit/b360b2e6a767fa34d48b2f02fd19511a2db98ecb))
|
||||
|
||||
|
||||
### Features
|
||||
|
||||
* deauthorised webhook events ([#1253](https://github.com/discordjs/discord-api-types/issues/1253)) ([9daac44](https://github.com/discordjs/discord-api-types/commit/9daac44f1d056115755e92fcc22995a9c05012be))
|
||||
|
||||
|
||||
|
||||
## [0.38.8](https://github.com/discordjs/discord-api-types/compare/0.38.7...0.38.8) (2025-05-15)
|
||||
|
||||
|
||||
|
||||
## [0.38.7](https://github.com/discordjs/discord-api-types/compare/0.38.6...0.38.7) (2025-05-15)
|
||||
|
||||
|
||||
|
||||
## [0.38.6](https://github.com/discordjs/discord-api-types/compare/0.38.5...0.38.6) (2025-05-15)
|
||||
|
||||
|
||||
### Bug Fixes
|
||||
|
||||
* wrong exports reported by ae ([#1239](https://github.com/discordjs/discord-api-types/issues/1239)) ([a5d949e](https://github.com/discordjs/discord-api-types/commit/a5d949e650fbc325c6b619da00edfa66d28abc72))
|
||||
|
||||
|
||||
### Features
|
||||
|
||||
* experimental new docs gen ([#1240](https://github.com/discordjs/discord-api-types/issues/1240)) ([3af2ae2](https://github.com/discordjs/discord-api-types/commit/3af2ae2b85550c83ec9bf1e124226d16e6a8ca7e))
|
||||
|
||||
|
||||
|
||||
## [0.38.5](https://github.com/discordjs/discord-api-types/compare/0.38.4...0.38.5) (2025-05-12)
|
||||
|
||||
|
||||
### Bug Fixes
|
||||
|
||||
* imports ([#1237](https://github.com/discordjs/discord-api-types/issues/1237)) ([c64362a](https://github.com/discordjs/discord-api-types/commit/c64362a711940a5fb5b0cb56c374ebc003fb3b0d))
|
||||
|
||||
|
||||
### Features
|
||||
|
||||
* `APIWebhookSourceChannel` ([#1235](https://github.com/discordjs/discord-api-types/issues/1235)) ([ca20659](https://github.com/discordjs/discord-api-types/commit/ca206593efd1dd8f09a59c832baef0187a7cc963))
|
||||
* `APIWebhookSourceGuild` ([#1236](https://github.com/discordjs/discord-api-types/issues/1236)) ([21420c3](https://github.com/discordjs/discord-api-types/commit/21420c3028afd8cc0e73cd1081c6ecdd02c81571))
|
||||
* invite channel ([#1232](https://github.com/discordjs/discord-api-types/issues/1232)) ([0479caf](https://github.com/discordjs/discord-api-types/commit/0479cafa1bedd549d54b7cc6c915fc6beb2ba6ec))
|
||||
|
||||
|
||||
|
||||
## [0.38.4](https://github.com/discordjs/discord-api-types/compare/0.38.3...0.38.4) (2025-05-08)
|
||||
|
||||
|
||||
### Features
|
||||
|
||||
* Specific typings for application emojis ([#1228](https://github.com/discordjs/discord-api-types/issues/1228)) ([4b0a3af](https://github.com/discordjs/discord-api-types/commit/4b0a3af12badba5221604a3304efaeb3d0b46dd7))
|
||||
|
||||
|
||||
|
||||
## [0.38.3](https://github.com/discordjs/discord-api-types/compare/0.38.2...0.38.3) (2025-05-05)
|
||||
|
||||
|
||||
|
||||
## [0.38.2](https://github.com/discordjs/discord-api-types/compare/0.38.1...0.38.2) (2025-05-01)
|
||||
|
||||
|
||||
|
||||
# [0.38.1](https://github.com/discordjs/discord-api-types/compare/0.37.120...0.38.1) (2025-04-22)
|
||||
|
||||
|
||||
|
||||
3
deno/README.md
generated
3
deno/README.md
generated
@@ -82,15 +82,12 @@ The exports of each API version is split into three main parts:
|
||||
- Everything exported with the `Gateway` prefix represents data that ONLY comes from or is directly related to the Gateway.
|
||||
|
||||
- Everything exported with the `REST` prefix represents data that ONLY comes from or is directly related to the REST API.
|
||||
|
||||
- For endpoint options, they will follow the following structure: `REST<HTTP Method><Type><Query|(JSON|FormData)Body|Result>` where the type represents what it will return.
|
||||
|
||||
- For example, `RESTPostAPIChannelMessageJSONBody` or `RESTGetAPIGatewayBotInfoResult`.
|
||||
|
||||
- Some exported types (specifically OAuth2 related ones) may not respect this entire structure due to the nature of the fields. They will start with either `RESTOAuth2` or with something similar to `REST<HTTP Method>OAuth2`
|
||||
|
||||
- If a type ends with `Result`, then it represents the expected result by calling its accompanying route.
|
||||
|
||||
- Types that are exported as `never` usually mean the result will be a `204 No Content`, so you can safely ignore it. This does **not** account for errors.
|
||||
|
||||
- Anything else that is miscellaneous will be exported based on what it represents (for example the `REST` route object).
|
||||
|
||||
214
deno/gateway/v10.ts
generated
214
deno/gateway/v10.ts
generated
@@ -3,7 +3,6 @@
|
||||
*/
|
||||
|
||||
import type { Snowflake } from '../globals.ts';
|
||||
import type { GatewayPresenceUpdate } from '../payloads/v10/gateway.ts';
|
||||
import type {
|
||||
APIApplication,
|
||||
APIApplicationCommandPermission,
|
||||
@@ -16,7 +15,6 @@ import type {
|
||||
APIGuildMember,
|
||||
APIGuildScheduledEvent,
|
||||
APIInteraction,
|
||||
APIMessage,
|
||||
APIRole,
|
||||
APIStageInstance,
|
||||
APISticker,
|
||||
@@ -25,8 +23,8 @@ import type {
|
||||
APIUnavailableGuild,
|
||||
APIUser,
|
||||
GatewayActivity,
|
||||
GatewayPresenceUpdate as RawGatewayPresenceUpdate,
|
||||
GatewayThreadListSync as RawGatewayThreadListSync,
|
||||
GatewayPresenceUpdate,
|
||||
GatewayThreadListSync,
|
||||
GatewayThreadMembersUpdate as RawGatewayThreadMembersUpdate,
|
||||
APIVoiceState,
|
||||
InviteTargetType,
|
||||
@@ -39,11 +37,21 @@ import type {
|
||||
APISoundboardSound,
|
||||
GuildChannelType,
|
||||
ThreadChannelType,
|
||||
APIBaseGuild,
|
||||
APIBaseGuildMember,
|
||||
APIBaseVoiceState,
|
||||
APIBaseVoiceGuildMember,
|
||||
APIGuildMemberJoined,
|
||||
APIFlaggedGuildMember,
|
||||
APIGuildMemberAvatar,
|
||||
APIGuildMemberUser,
|
||||
GatewayGuildMembersChunkPresence,
|
||||
APIBaseMessage,
|
||||
} from '../payloads/v10/mod.ts';
|
||||
import type { ReactionType } from '../rest/v10/mod.ts';
|
||||
import type { _Nullable } from '../utils/internals.ts';
|
||||
|
||||
export * from './common.ts';
|
||||
export type * from './common.ts';
|
||||
|
||||
export const GatewayVersion = '10';
|
||||
|
||||
@@ -789,9 +797,7 @@ export type GatewayEntitlementModifyDispatch = _DataPayload<
|
||||
/**
|
||||
* @see {@link https://discord.com/developers/docs/topics/gateway-events#entitlement-create}
|
||||
*/
|
||||
export type GatewayEntitlementCreateDispatchData = Omit<GatewayEntitlementModifyDispatchData, 'ends_at'> & {
|
||||
ends_at: GatewayEntitlementModifyDispatchData['ends_at'] | null;
|
||||
};
|
||||
export type GatewayEntitlementCreateDispatchData = GatewayEntitlementModifyDispatchData;
|
||||
|
||||
/**
|
||||
* @see {@link https://discord.com/developers/docs/topics/gateway-events#entitlement-create}
|
||||
@@ -873,7 +879,7 @@ export interface GatewayGuildCreateDispatchData extends APIGuild {
|
||||
*
|
||||
* @see {@link https://discord.com/developers/docs/resources/voice#voice-state-object}
|
||||
*/
|
||||
voice_states: Omit<APIVoiceState, 'guild_id'>[];
|
||||
voice_states: APIBaseVoiceState[];
|
||||
/**
|
||||
* Users in the guild
|
||||
*
|
||||
@@ -953,7 +959,7 @@ export type GatewayGuildDeleteDispatch = _DataPayload<
|
||||
/**
|
||||
* @see {@link https://discord.com/developers/docs/topics/gateway-events#guild-delete}
|
||||
*/
|
||||
export interface GatewayGuildDeleteDispatchData extends Omit<APIUnavailableGuild, 'unavailable'> {
|
||||
export interface GatewayGuildDeleteDispatchData extends APIBaseGuild {
|
||||
/**
|
||||
* `true` if this guild is unavailable due to an outage
|
||||
*
|
||||
@@ -1127,15 +1133,18 @@ export type GatewayGuildMemberUpdateDispatch = _DataPayload<
|
||||
/**
|
||||
* @see {@link https://discord.com/developers/docs/topics/gateway-events#guild-member-update}
|
||||
*/
|
||||
export type GatewayGuildMemberUpdateDispatchData = _Nullable<Pick<APIGuildMember, 'joined_at'>> &
|
||||
Omit<APIGuildMember, 'deaf' | 'flags' | 'joined_at' | 'mute' | 'user'> &
|
||||
Partial<Pick<APIGuildMember, 'deaf' | 'flags' | 'mute'>> &
|
||||
Required<Pick<APIGuildMember, 'avatar' | 'banner' | 'user'>> & {
|
||||
/**
|
||||
* The id of the guild
|
||||
*/
|
||||
guild_id: Snowflake;
|
||||
};
|
||||
export interface GatewayGuildMemberUpdateDispatchData
|
||||
extends _Nullable<APIGuildMemberJoined>,
|
||||
APIBaseGuildMember,
|
||||
Partial<APIBaseVoiceGuildMember>,
|
||||
Partial<APIFlaggedGuildMember>,
|
||||
Required<APIGuildMemberAvatar>,
|
||||
Required<APIGuildMemberUser> {
|
||||
/**
|
||||
* The id of the guild
|
||||
*/
|
||||
guild_id: Snowflake;
|
||||
}
|
||||
|
||||
/**
|
||||
* @see {@link https://discord.com/developers/docs/topics/gateway-events#guild-members-chunk}
|
||||
@@ -1145,11 +1154,6 @@ export type GatewayGuildMembersChunkDispatch = _DataPayload<
|
||||
GatewayGuildMembersChunkDispatchData
|
||||
>;
|
||||
|
||||
/**
|
||||
* @see {@link https://discord.com/developers/docs/topics/gateway-events#update-presence}
|
||||
*/
|
||||
export type GatewayGuildMembersChunkPresence = Omit<RawGatewayPresenceUpdate, 'guild_id'>;
|
||||
|
||||
/**
|
||||
* @see {@link https://discord.com/developers/docs/topics/gateway-events#guild-members-chunk}
|
||||
*/
|
||||
@@ -1597,7 +1601,7 @@ export type GatewayMessageCreateDispatch = _DataPayload<
|
||||
/**
|
||||
* @see {@link https://discord.com/developers/docs/topics/gateway-events#message-create}
|
||||
*/
|
||||
export type GatewayMessageCreateDispatchData = GatewayMessageEventExtraFields & Omit<APIMessage, 'mentions'>;
|
||||
export interface GatewayMessageCreateDispatchData extends GatewayMessageEventExtraFields, APIBaseMessage {}
|
||||
|
||||
/**
|
||||
* @see {@link https://discord.com/developers/docs/topics/gateway-events#message-update}
|
||||
@@ -1610,7 +1614,24 @@ export type GatewayMessageUpdateDispatch = _DataPayload<
|
||||
/**
|
||||
* @see {@link https://discord.com/developers/docs/topics/gateway-events#message-update}
|
||||
*/
|
||||
export type GatewayMessageUpdateDispatchData = GatewayMessageEventExtraFields & Omit<APIMessage, 'mentions'>;
|
||||
export interface GatewayMessageUpdateDispatchData extends GatewayMessageEventExtraFields, APIBaseMessage {}
|
||||
|
||||
export interface APIGuildMemberNoUser
|
||||
extends APIBaseGuildMember,
|
||||
APIFlaggedGuildMember,
|
||||
APIGuildMemberAvatar,
|
||||
APIGuildMemberJoined,
|
||||
APIBaseVoiceGuildMember {}
|
||||
|
||||
export interface APIUserWithMember extends APIUser {
|
||||
/**
|
||||
* The `member` field is only present in `MESSAGE_CREATE` and `MESSAGE_UPDATE` events
|
||||
* from text-based guild channels
|
||||
*
|
||||
* @see {@link https://discord.com/developers/docs/resources/guild#guild-member-object}
|
||||
*/
|
||||
member?: APIGuildMemberNoUser;
|
||||
}
|
||||
|
||||
/**
|
||||
* @see {@link https://discord.com/developers/docs/topics/gateway-events#message-create-message-create-extra-fields}
|
||||
@@ -1628,17 +1649,13 @@ export interface GatewayMessageEventExtraFields {
|
||||
*
|
||||
* @see {@link https://discord.com/developers/docs/resources/guild#guild-member-object}
|
||||
*/
|
||||
member?: Omit<APIGuildMember, 'user'>;
|
||||
member?: APIGuildMemberNoUser;
|
||||
/**
|
||||
* Users specifically mentioned in the message
|
||||
*
|
||||
* The `member` field is only present in `MESSAGE_CREATE` and `MESSAGE_UPDATE` events
|
||||
* from text-based guild channels
|
||||
*
|
||||
* @see {@link https://discord.com/developers/docs/resources/user#user-object}
|
||||
* @see {@link https://discord.com/developers/docs/resources/guild#guild-member-object}
|
||||
*/
|
||||
mentions: (APIUser & { member?: Omit<APIGuildMember, 'user'> })[];
|
||||
mentions: APIUserWithMember[];
|
||||
}
|
||||
|
||||
/**
|
||||
@@ -1696,25 +1713,74 @@ export interface GatewayMessageDeleteBulkDispatchData {
|
||||
/**
|
||||
* @see {@link https://discord.com/developers/docs/topics/gateway-events#message-reaction-add}
|
||||
*/
|
||||
export type GatewayMessageReactionAddDispatch = GatewayMessageReactionData<GatewayDispatchEvents.MessageReactionAdd>;
|
||||
export interface GatewayMessageReactionAddDispatchData extends GatewayMessageReactionRemoveDispatchData {
|
||||
/**
|
||||
* The member who reacted if this happened in a guild
|
||||
*
|
||||
* @see {@link https://discord.com/developers/docs/resources/guild#guild-member-object}
|
||||
*/
|
||||
member?: APIGuildMember;
|
||||
/**
|
||||
* The id of the user that posted the message that was reacted to
|
||||
*/
|
||||
message_author_id?: Snowflake;
|
||||
/**
|
||||
* Colors used for super-reaction animation in "#rrggbb" format
|
||||
*/
|
||||
burst_colors?: string[];
|
||||
}
|
||||
|
||||
/**
|
||||
* @see {@link https://discord.com/developers/docs/topics/gateway-events#message-reaction-add}
|
||||
*/
|
||||
export type GatewayMessageReactionAddDispatchData = GatewayMessageReactionAddDispatch['d'];
|
||||
|
||||
/**
|
||||
* @see {@link https://discord.com/developers/docs/topics/gateway-events#message-reaction-remove}
|
||||
*/
|
||||
export type GatewayMessageReactionRemoveDispatch = GatewayMessageReactionData<
|
||||
GatewayDispatchEvents.MessageReactionRemove,
|
||||
'burst_colors' | 'member' | 'message_author_id'
|
||||
export type GatewayMessageReactionAddDispatch = _DataPayload<
|
||||
GatewayDispatchEvents.MessageReactionAdd,
|
||||
GatewayMessageReactionAddDispatchData
|
||||
>;
|
||||
|
||||
/**
|
||||
* @see {@link https://discord.com/developers/docs/topics/gateway-events#message-reaction-remove}
|
||||
*/
|
||||
export type GatewayMessageReactionRemoveDispatchData = GatewayMessageReactionRemoveDispatch['d'];
|
||||
export interface GatewayMessageReactionRemoveDispatchData {
|
||||
/**
|
||||
* The id of the user
|
||||
*/
|
||||
user_id: Snowflake;
|
||||
/**
|
||||
* The id of the channel
|
||||
*/
|
||||
channel_id: Snowflake;
|
||||
/**
|
||||
* The id of the message
|
||||
*/
|
||||
message_id: Snowflake;
|
||||
/**
|
||||
* The id of the guild
|
||||
*/
|
||||
guild_id?: Snowflake;
|
||||
/**
|
||||
* The emoji used to react
|
||||
*
|
||||
* @see {@link https://discord.com/developers/docs/resources/emoji#emoji-object}
|
||||
*/
|
||||
emoji: APIEmoji;
|
||||
/**
|
||||
* True if this is a super-reaction
|
||||
*/
|
||||
burst: boolean;
|
||||
/**
|
||||
* The type of reaction
|
||||
*/
|
||||
type: ReactionType;
|
||||
}
|
||||
|
||||
/**
|
||||
* @see {@link https://discord.com/developers/docs/topics/gateway-events#message-reaction-remove}
|
||||
*/
|
||||
export type GatewayMessageReactionRemoveDispatch = _DataPayload<
|
||||
GatewayDispatchEvents.MessageReactionRemove,
|
||||
GatewayMessageReactionRemoveDispatchData
|
||||
>;
|
||||
|
||||
/**
|
||||
* @see {@link https://discord.com/developers/docs/topics/gateway-events#message-reaction-remove-all}
|
||||
@@ -1758,7 +1824,7 @@ export type GatewayPresenceUpdateDispatch = _DataPayload<
|
||||
/**
|
||||
* @see {@link https://discord.com/developers/docs/topics/gateway-events#presence-update}
|
||||
*/
|
||||
export type GatewayPresenceUpdateDispatchData = RawGatewayPresenceUpdate;
|
||||
export type GatewayPresenceUpdateDispatchData = GatewayPresenceUpdate;
|
||||
|
||||
/**
|
||||
* @see {@link https://discord.com/developers/docs/topics/gateway-events#stage-instance-create}
|
||||
@@ -1810,7 +1876,7 @@ export type GatewayThreadListSyncDispatch = _DataPayload<
|
||||
/**
|
||||
* @see {@link https://discord.com/developers/docs/topics/gateway-events#thread-list-sync}
|
||||
*/
|
||||
export type GatewayThreadListSyncDispatchData = RawGatewayThreadListSync;
|
||||
export type GatewayThreadListSyncDispatchData = GatewayThreadListSync;
|
||||
|
||||
/**
|
||||
* @see {@link https://discord.com/developers/docs/topics/gateway-events#thread-members-update}
|
||||
@@ -2415,7 +2481,7 @@ export type GatewayActivityUpdateData = Pick<GatewayActivity, 'name' | 'state' |
|
||||
// #endregion Sendable Payloads
|
||||
|
||||
// #region Shared
|
||||
export interface _BasePayload {
|
||||
export interface _BaseBasePayload {
|
||||
/**
|
||||
* Opcode for the payload
|
||||
*/
|
||||
@@ -2424,6 +2490,9 @@ export interface _BasePayload {
|
||||
* Event data
|
||||
*/
|
||||
d?: unknown;
|
||||
}
|
||||
|
||||
export interface _BasePayload {
|
||||
/**
|
||||
* Sequence number, used for resuming sessions and heartbeats
|
||||
*/
|
||||
@@ -2434,10 +2503,10 @@ export interface _BasePayload {
|
||||
t?: string;
|
||||
}
|
||||
|
||||
export type _NonDispatchPayload = Omit<_BasePayload, 's' | 't'> & {
|
||||
export interface _NonDispatchPayload extends _BaseBasePayload {
|
||||
t: null;
|
||||
s: null;
|
||||
};
|
||||
}
|
||||
|
||||
export interface _DataPayload<Event extends GatewayDispatchEvents, D = unknown> extends _BasePayload {
|
||||
op: GatewayOpcodes.Dispatch;
|
||||
@@ -2445,57 +2514,10 @@ export interface _DataPayload<Event extends GatewayDispatchEvents, D = unknown>
|
||||
d: D;
|
||||
}
|
||||
|
||||
// This is not used internally anymore, just remains to be non-breaking
|
||||
export type GatewayMessageReactionData<E extends GatewayDispatchEvents, O extends string = never> = _DataPayload<
|
||||
E,
|
||||
Omit<
|
||||
{
|
||||
/**
|
||||
* The id of the user
|
||||
*/
|
||||
user_id: Snowflake;
|
||||
/**
|
||||
* The id of the channel
|
||||
*/
|
||||
channel_id: Snowflake;
|
||||
/**
|
||||
* The id of the message
|
||||
*/
|
||||
message_id: Snowflake;
|
||||
/**
|
||||
* The id of the guild
|
||||
*/
|
||||
guild_id?: Snowflake;
|
||||
/**
|
||||
* The member who reacted if this happened in a guild
|
||||
*
|
||||
* @see {@link https://discord.com/developers/docs/resources/guild#guild-member-object}
|
||||
*/
|
||||
member?: APIGuildMember;
|
||||
/**
|
||||
* The emoji used to react
|
||||
*
|
||||
* @see {@link https://discord.com/developers/docs/resources/emoji#emoji-object}
|
||||
*/
|
||||
emoji: APIEmoji;
|
||||
/**
|
||||
* The id of the user that posted the message that was reacted to
|
||||
*/
|
||||
message_author_id?: Snowflake;
|
||||
/**
|
||||
* True if this is a super-reaction
|
||||
*/
|
||||
burst: boolean;
|
||||
/**
|
||||
* Colors used for super-reaction animation in "#rrggbb" format
|
||||
*/
|
||||
burst_colors: string[];
|
||||
/**
|
||||
* The type of reaction
|
||||
*/
|
||||
type: ReactionType;
|
||||
},
|
||||
O
|
||||
>
|
||||
Omit<GatewayMessageReactionAddDispatchData, O>
|
||||
>;
|
||||
|
||||
export interface GatewayMessageReactionRemoveData {
|
||||
|
||||
4
deno/gateway/v6.ts
generated
4
deno/gateway/v6.ts
generated
@@ -18,7 +18,7 @@ import type {
|
||||
PresenceUpdateStatus,
|
||||
} from '../payloads/v6/mod.ts';
|
||||
|
||||
export * from './common.ts';
|
||||
export type * from './common.ts';
|
||||
|
||||
/**
|
||||
* @deprecated Gateway v6 is deprecated and the types will not receive further updates, please update to v8.
|
||||
@@ -313,7 +313,6 @@ export type GatewayReadyDispatch = DataPayload<
|
||||
*/
|
||||
export type GatewayResumedDispatch = DataPayload<GatewayDispatchEvents.Resumed, never>;
|
||||
|
||||
/* eslint-disable @typescript-eslint/indent */
|
||||
/**
|
||||
* https://discord.com/developers/docs/topics/gateway#channel-create
|
||||
* https://discord.com/developers/docs/topics/gateway#channel-update
|
||||
@@ -325,7 +324,6 @@ export type GatewayChannelModifyDispatch = DataPayload<
|
||||
GatewayDispatchEvents.ChannelCreate | GatewayDispatchEvents.ChannelDelete | GatewayDispatchEvents.ChannelUpdate,
|
||||
APIChannel
|
||||
>;
|
||||
/* eslint-enable @typescript-eslint/indent */
|
||||
|
||||
/**
|
||||
* @deprecated Gateway v6 is deprecated and the types will not receive further updates, please update to v8.
|
||||
|
||||
2
deno/gateway/v8.ts
generated
2
deno/gateway/v8.ts
generated
@@ -26,7 +26,7 @@ import type {
|
||||
} from '../payloads/v8/mod.ts';
|
||||
import type { _Nullable } from '../utils/internals.ts';
|
||||
|
||||
export * from './common.ts';
|
||||
export type * from './common.ts';
|
||||
|
||||
/**
|
||||
* @deprecated API and gateway v8 are deprecated and the types will not receive further updates, please update to v10.
|
||||
|
||||
216
deno/gateway/v9.ts
generated
216
deno/gateway/v9.ts
generated
@@ -3,7 +3,6 @@
|
||||
*/
|
||||
|
||||
import type { Snowflake } from '../globals.ts';
|
||||
import type { GatewayPresenceUpdate } from '../payloads/v9/gateway.ts';
|
||||
import type {
|
||||
APIApplication,
|
||||
APIApplicationCommandPermission,
|
||||
@@ -16,7 +15,6 @@ import type {
|
||||
APIGuildMember,
|
||||
APIGuildScheduledEvent,
|
||||
APIInteraction,
|
||||
APIMessage,
|
||||
APIRole,
|
||||
APIStageInstance,
|
||||
APISticker,
|
||||
@@ -25,8 +23,8 @@ import type {
|
||||
APIUnavailableGuild,
|
||||
APIUser,
|
||||
GatewayActivity,
|
||||
GatewayPresenceUpdate as RawGatewayPresenceUpdate,
|
||||
GatewayThreadListSync as RawGatewayThreadListSync,
|
||||
GatewayPresenceUpdate,
|
||||
GatewayThreadListSync,
|
||||
GatewayThreadMembersUpdate as RawGatewayThreadMembersUpdate,
|
||||
APIVoiceState,
|
||||
InviteTargetType,
|
||||
@@ -38,12 +36,22 @@ import type {
|
||||
APISoundboardSound,
|
||||
GuildChannelType,
|
||||
ThreadChannelType,
|
||||
APIEntitlement,
|
||||
APIBaseGuild,
|
||||
APIBaseGuildMember,
|
||||
APIBaseVoiceState,
|
||||
APIBaseVoiceGuildMember,
|
||||
APIFlaggedGuildMember,
|
||||
APIGuildMemberUser,
|
||||
APIGuildMemberAvatar,
|
||||
GatewayGuildMembersChunkPresence,
|
||||
APIBaseMessage,
|
||||
APIGuildMemberJoined,
|
||||
} from '../payloads/v9/mod.ts';
|
||||
import type { ReactionType } from '../rest/v9/mod.ts';
|
||||
import type { _Nullable } from '../utils/internals.ts';
|
||||
import type { APIEntitlement } from '../v10.ts';
|
||||
|
||||
export * from './common.ts';
|
||||
export type * from './common.ts';
|
||||
|
||||
export const GatewayVersion = '9';
|
||||
|
||||
@@ -788,9 +796,7 @@ export type GatewayEntitlementModifyDispatch = _DataPayload<
|
||||
/**
|
||||
* @see {@link https://discord.com/developers/docs/topics/gateway-events#entitlement-create}
|
||||
*/
|
||||
export type GatewayEntitlementCreateDispatchData = Omit<GatewayEntitlementModifyDispatchData, 'ends_at'> & {
|
||||
ends_at: GatewayEntitlementModifyDispatchData['ends_at'] | null;
|
||||
};
|
||||
export type GatewayEntitlementCreateDispatchData = GatewayEntitlementModifyDispatchData;
|
||||
|
||||
/**
|
||||
* @see {@link https://discord.com/developers/docs/topics/gateway-events#entitlement-create}
|
||||
@@ -872,7 +878,7 @@ export interface GatewayGuildCreateDispatchData extends APIGuild {
|
||||
*
|
||||
* @see {@link https://discord.com/developers/docs/resources/voice#voice-state-object}
|
||||
*/
|
||||
voice_states: Omit<APIVoiceState, 'guild_id'>[];
|
||||
voice_states: APIBaseVoiceState[];
|
||||
/**
|
||||
* Users in the guild
|
||||
*
|
||||
@@ -952,7 +958,7 @@ export type GatewayGuildDeleteDispatch = _DataPayload<
|
||||
/**
|
||||
* @see {@link https://discord.com/developers/docs/topics/gateway-events#guild-delete}
|
||||
*/
|
||||
export interface GatewayGuildDeleteDispatchData extends Omit<APIUnavailableGuild, 'unavailable'> {
|
||||
export interface GatewayGuildDeleteDispatchData extends APIBaseGuild {
|
||||
/**
|
||||
* `true` if this guild is unavailable due to an outage
|
||||
*
|
||||
@@ -1126,15 +1132,18 @@ export type GatewayGuildMemberUpdateDispatch = _DataPayload<
|
||||
/**
|
||||
* @see {@link https://discord.com/developers/docs/topics/gateway-events#guild-member-update}
|
||||
*/
|
||||
export type GatewayGuildMemberUpdateDispatchData = _Nullable<Pick<APIGuildMember, 'joined_at'>> &
|
||||
Omit<APIGuildMember, 'deaf' | 'flags' | 'joined_at' | 'mute' | 'user'> &
|
||||
Partial<Pick<APIGuildMember, 'deaf' | 'flags' | 'mute'>> &
|
||||
Required<Pick<APIGuildMember, 'avatar' | 'banner' | 'user'>> & {
|
||||
/**
|
||||
* The id of the guild
|
||||
*/
|
||||
guild_id: Snowflake;
|
||||
};
|
||||
export interface GatewayGuildMemberUpdateDispatchData
|
||||
extends _Nullable<APIGuildMemberJoined>,
|
||||
APIBaseGuildMember,
|
||||
Partial<APIBaseVoiceGuildMember>,
|
||||
Partial<APIFlaggedGuildMember>,
|
||||
Required<APIGuildMemberUser>,
|
||||
Required<APIGuildMemberAvatar> {
|
||||
/**
|
||||
* The id of the guild
|
||||
*/
|
||||
guild_id: Snowflake;
|
||||
}
|
||||
|
||||
/**
|
||||
* @see {@link https://discord.com/developers/docs/topics/gateway-events#guild-members-chunk}
|
||||
@@ -1144,11 +1153,6 @@ export type GatewayGuildMembersChunkDispatch = _DataPayload<
|
||||
GatewayGuildMembersChunkDispatchData
|
||||
>;
|
||||
|
||||
/**
|
||||
* @see {@link https://discord.com/developers/docs/topics/gateway-events#update-presence}
|
||||
*/
|
||||
export type GatewayGuildMembersChunkPresence = Omit<RawGatewayPresenceUpdate, 'guild_id'>;
|
||||
|
||||
/**
|
||||
* @see {@link https://discord.com/developers/docs/topics/gateway-events#guild-members-chunk}
|
||||
*/
|
||||
@@ -1596,7 +1600,7 @@ export type GatewayMessageCreateDispatch = _DataPayload<
|
||||
/**
|
||||
* @see {@link https://discord.com/developers/docs/topics/gateway-events#message-create}
|
||||
*/
|
||||
export type GatewayMessageCreateDispatchData = GatewayMessageEventExtraFields & Omit<APIMessage, 'mentions'>;
|
||||
export interface GatewayMessageCreateDispatchData extends GatewayMessageEventExtraFields, APIBaseMessage {}
|
||||
|
||||
/**
|
||||
* @see {@link https://discord.com/developers/docs/topics/gateway-events#message-update}
|
||||
@@ -1609,7 +1613,24 @@ export type GatewayMessageUpdateDispatch = _DataPayload<
|
||||
/**
|
||||
* @see {@link https://discord.com/developers/docs/topics/gateway-events#message-update}
|
||||
*/
|
||||
export type GatewayMessageUpdateDispatchData = GatewayMessageEventExtraFields & Omit<APIMessage, 'mentions'>;
|
||||
export interface GatewayMessageUpdateDispatchData extends GatewayMessageEventExtraFields, APIBaseMessage {}
|
||||
|
||||
export interface APIGuildMemberNoUser
|
||||
extends APIBaseGuildMember,
|
||||
APIFlaggedGuildMember,
|
||||
APIGuildMemberAvatar,
|
||||
APIGuildMemberJoined,
|
||||
APIBaseVoiceGuildMember {}
|
||||
|
||||
export interface APIUserWithMember extends APIUser {
|
||||
/**
|
||||
* The `member` field is only present in `MESSAGE_CREATE` and `MESSAGE_UPDATE` events
|
||||
* from text-based guild channels
|
||||
*
|
||||
* @see {@link https://discord.com/developers/docs/resources/guild#guild-member-object}
|
||||
*/
|
||||
member?: APIGuildMemberNoUser;
|
||||
}
|
||||
|
||||
/**
|
||||
* @see {@link https://discord.com/developers/docs/topics/gateway-events#message-create-message-create-extra-fields}
|
||||
@@ -1627,17 +1648,13 @@ export interface GatewayMessageEventExtraFields {
|
||||
*
|
||||
* @see {@link https://discord.com/developers/docs/resources/guild#guild-member-object}
|
||||
*/
|
||||
member?: Omit<APIGuildMember, 'user'>;
|
||||
member?: APIGuildMemberNoUser;
|
||||
/**
|
||||
* Users specifically mentioned in the message
|
||||
*
|
||||
* The `member` field is only present in `MESSAGE_CREATE` and `MESSAGE_UPDATE` events
|
||||
* from text-based guild channels
|
||||
*
|
||||
* @see {@link https://discord.com/developers/docs/resources/user#user-object}
|
||||
* @see {@link https://discord.com/developers/docs/resources/guild#guild-member-object}
|
||||
*/
|
||||
mentions: (APIUser & { member?: Omit<APIGuildMember, 'user'> })[];
|
||||
mentions: APIUserWithMember[];
|
||||
}
|
||||
|
||||
/**
|
||||
@@ -1695,25 +1712,74 @@ export interface GatewayMessageDeleteBulkDispatchData {
|
||||
/**
|
||||
* @see {@link https://discord.com/developers/docs/topics/gateway-events#message-reaction-add}
|
||||
*/
|
||||
export type GatewayMessageReactionAddDispatch = GatewayMessageReactionData<GatewayDispatchEvents.MessageReactionAdd>;
|
||||
export interface GatewayMessageReactionAddDispatchData extends GatewayMessageReactionRemoveDispatchData {
|
||||
/**
|
||||
* The member who reacted if this happened in a guild
|
||||
*
|
||||
* @see {@link https://discord.com/developers/docs/resources/guild#guild-member-object}
|
||||
*/
|
||||
member?: APIGuildMember;
|
||||
/**
|
||||
* The id of the user that posted the message that was reacted to
|
||||
*/
|
||||
message_author_id?: Snowflake;
|
||||
/**
|
||||
* Colors used for super-reaction animation in "#rrggbb" format
|
||||
*/
|
||||
burst_colors?: string[];
|
||||
}
|
||||
|
||||
/**
|
||||
* @see {@link https://discord.com/developers/docs/topics/gateway-events#message-reaction-add}
|
||||
*/
|
||||
export type GatewayMessageReactionAddDispatchData = GatewayMessageReactionAddDispatch['d'];
|
||||
|
||||
/**
|
||||
* @see {@link https://discord.com/developers/docs/topics/gateway-events#message-reaction-remove}
|
||||
*/
|
||||
export type GatewayMessageReactionRemoveDispatch = GatewayMessageReactionData<
|
||||
GatewayDispatchEvents.MessageReactionRemove,
|
||||
'burst_colors' | 'member' | 'message_author_id'
|
||||
export type GatewayMessageReactionAddDispatch = _DataPayload<
|
||||
GatewayDispatchEvents.MessageReactionAdd,
|
||||
GatewayMessageReactionAddDispatchData
|
||||
>;
|
||||
|
||||
/**
|
||||
* @see {@link https://discord.com/developers/docs/topics/gateway-events#message-reaction-remove}
|
||||
*/
|
||||
export type GatewayMessageReactionRemoveDispatchData = GatewayMessageReactionRemoveDispatch['d'];
|
||||
export interface GatewayMessageReactionRemoveDispatchData {
|
||||
/**
|
||||
* The id of the user
|
||||
*/
|
||||
user_id: Snowflake;
|
||||
/**
|
||||
* The id of the channel
|
||||
*/
|
||||
channel_id: Snowflake;
|
||||
/**
|
||||
* The id of the message
|
||||
*/
|
||||
message_id: Snowflake;
|
||||
/**
|
||||
* The id of the guild
|
||||
*/
|
||||
guild_id?: Snowflake;
|
||||
/**
|
||||
* The emoji used to react
|
||||
*
|
||||
* @see {@link https://discord.com/developers/docs/resources/emoji#emoji-object}
|
||||
*/
|
||||
emoji: APIEmoji;
|
||||
/**
|
||||
* True if this is a super-reaction
|
||||
*/
|
||||
burst: boolean;
|
||||
/**
|
||||
* The type of reaction
|
||||
*/
|
||||
type: ReactionType;
|
||||
}
|
||||
|
||||
/**
|
||||
* @see {@link https://discord.com/developers/docs/topics/gateway-events#message-reaction-remove}
|
||||
*/
|
||||
export type GatewayMessageReactionRemoveDispatch = _DataPayload<
|
||||
GatewayDispatchEvents.MessageReactionRemove,
|
||||
GatewayMessageReactionRemoveDispatchData
|
||||
>;
|
||||
|
||||
/**
|
||||
* @see {@link https://discord.com/developers/docs/topics/gateway-events#message-reaction-remove-all}
|
||||
@@ -1757,7 +1823,7 @@ export type GatewayPresenceUpdateDispatch = _DataPayload<
|
||||
/**
|
||||
* @see {@link https://discord.com/developers/docs/topics/gateway-events#presence-update}
|
||||
*/
|
||||
export type GatewayPresenceUpdateDispatchData = RawGatewayPresenceUpdate;
|
||||
export type GatewayPresenceUpdateDispatchData = GatewayPresenceUpdate;
|
||||
|
||||
/**
|
||||
* @see {@link https://discord.com/developers/docs/topics/gateway-events#stage-instance-create}
|
||||
@@ -1809,7 +1875,7 @@ export type GatewayThreadListSyncDispatch = _DataPayload<
|
||||
/**
|
||||
* @see {@link https://discord.com/developers/docs/topics/gateway-events#thread-list-sync}
|
||||
*/
|
||||
export type GatewayThreadListSyncDispatchData = RawGatewayThreadListSync;
|
||||
export type GatewayThreadListSyncDispatchData = GatewayThreadListSync;
|
||||
|
||||
/**
|
||||
* @see {@link https://discord.com/developers/docs/topics/gateway-events#thread-members-update}
|
||||
@@ -2414,7 +2480,8 @@ export type GatewayActivityUpdateData = Pick<GatewayActivity, 'name' | 'state' |
|
||||
// #endregion Sendable Payloads
|
||||
|
||||
// #region Shared
|
||||
export interface _BasePayload {
|
||||
|
||||
export interface _BaseBasePayload {
|
||||
/**
|
||||
* Opcode for the payload
|
||||
*/
|
||||
@@ -2423,6 +2490,8 @@ export interface _BasePayload {
|
||||
* Event data
|
||||
*/
|
||||
d?: unknown;
|
||||
}
|
||||
export interface _BasePayload extends _BaseBasePayload {
|
||||
/**
|
||||
* Sequence number, used for resuming sessions and heartbeats
|
||||
*/
|
||||
@@ -2433,10 +2502,10 @@ export interface _BasePayload {
|
||||
t?: string;
|
||||
}
|
||||
|
||||
export type _NonDispatchPayload = Omit<_BasePayload, 's' | 't'> & {
|
||||
export interface _NonDispatchPayload extends _BaseBasePayload {
|
||||
t: null;
|
||||
s: null;
|
||||
};
|
||||
}
|
||||
|
||||
export interface _DataPayload<Event extends GatewayDispatchEvents, D = unknown> extends _BasePayload {
|
||||
op: GatewayOpcodes.Dispatch;
|
||||
@@ -2444,57 +2513,10 @@ export interface _DataPayload<Event extends GatewayDispatchEvents, D = unknown>
|
||||
d: D;
|
||||
}
|
||||
|
||||
// This is not used internally anymore, just remains to be non-breaking
|
||||
export type GatewayMessageReactionData<E extends GatewayDispatchEvents, O extends string = never> = _DataPayload<
|
||||
E,
|
||||
Omit<
|
||||
{
|
||||
/**
|
||||
* The id of the user
|
||||
*/
|
||||
user_id: Snowflake;
|
||||
/**
|
||||
* The id of the channel
|
||||
*/
|
||||
channel_id: Snowflake;
|
||||
/**
|
||||
* The id of the message
|
||||
*/
|
||||
message_id: Snowflake;
|
||||
/**
|
||||
* The id of the guild
|
||||
*/
|
||||
guild_id?: Snowflake;
|
||||
/**
|
||||
* The member who reacted if this happened in a guild
|
||||
*
|
||||
* @see {@link https://discord.com/developers/docs/resources/guild#guild-member-object}
|
||||
*/
|
||||
member?: APIGuildMember;
|
||||
/**
|
||||
* The emoji used to react
|
||||
*
|
||||
* @see {@link https://discord.com/developers/docs/resources/emoji#emoji-object}
|
||||
*/
|
||||
emoji: APIEmoji;
|
||||
/**
|
||||
* The id of the user that posted the message that was reacted to
|
||||
*/
|
||||
message_author_id?: Snowflake;
|
||||
/**
|
||||
* True if this is a super-reaction
|
||||
*/
|
||||
burst: boolean;
|
||||
/**
|
||||
* Colors used for super-reaction animation in "#rrggbb" format
|
||||
*/
|
||||
burst_colors?: string[];
|
||||
/**
|
||||
* The type of reaction
|
||||
*/
|
||||
type: ReactionType;
|
||||
},
|
||||
O
|
||||
>
|
||||
Omit<GatewayMessageReactionAddDispatchData, O>
|
||||
>;
|
||||
|
||||
export interface GatewayMessageReactionRemoveData {
|
||||
|
||||
1
deno/globals.ts
generated
1
deno/globals.ts
generated
@@ -52,7 +52,6 @@ export const FormattingPatterns = {
|
||||
* The `fullName` (possibly including `name`, `subcommandOrGroup` and `subcommand`) and `id` group properties are present on the `exec` result of this expression
|
||||
*/
|
||||
SlashCommand:
|
||||
// eslint-disable-next-line unicorn/no-unsafe-regex
|
||||
/<\/(?<fullName>(?<name>[-_\p{Letter}\p{Number}\p{sc=Deva}\p{sc=Thai}]{1,32})(?: (?<subcommandOrGroup>[-_\p{Letter}\p{Number}\p{sc=Deva}\p{sc=Thai}]{1,32}))?(?: (?<subcommand>[-_\p{Letter}\p{Number}\p{sc=Deva}\p{sc=Thai}]{1,32}))?):(?<id>\d{17,20})>/u,
|
||||
/**
|
||||
* Regular expression for matching a custom emoji, either static or animated
|
||||
|
||||
2
deno/payloads/common.ts
generated
2
deno/payloads/common.ts
generated
@@ -17,7 +17,7 @@ export const PermissionFlagsBits = {
|
||||
/**
|
||||
* Allows kicking members
|
||||
*/
|
||||
// eslint-disable-next-line sonarjs/no-identical-expressions
|
||||
|
||||
KickMembers: 1n << 1n,
|
||||
/**
|
||||
* Allows banning members
|
||||
|
||||
@@ -5,7 +5,7 @@ import type { ApplicationCommandOptionType } from './shared.ts';
|
||||
|
||||
export interface APIApplicationCommandChannelOption
|
||||
extends APIApplicationCommandOptionBase<ApplicationCommandOptionType.Channel> {
|
||||
channel_types?: Exclude<ChannelType, ChannelType.DM | ChannelType.GroupDM>[];
|
||||
channel_types?: Exclude<ChannelType, ChannelType.DM | ChannelType.GroupDM | ChannelType.GuildDirectory>[];
|
||||
}
|
||||
|
||||
export type APIApplicationCommandInteractionDataChannelOption = APIInteractionDataOptionBase<
|
||||
|
||||
@@ -47,19 +47,19 @@ import type {
|
||||
} from './_chatInput/user.ts';
|
||||
import type { APIBaseApplicationCommandInteractionData } from './internals.ts';
|
||||
|
||||
export * from './_chatInput/attachment.ts';
|
||||
export * from './_chatInput/base.ts';
|
||||
export * from './_chatInput/boolean.ts';
|
||||
export * from './_chatInput/channel.ts';
|
||||
export * from './_chatInput/integer.ts';
|
||||
export * from './_chatInput/mentionable.ts';
|
||||
export * from './_chatInput/number.ts';
|
||||
export * from './_chatInput/role.ts';
|
||||
export type * from './_chatInput/attachment.ts';
|
||||
export type * from './_chatInput/base.ts';
|
||||
export type * from './_chatInput/boolean.ts';
|
||||
export type * from './_chatInput/channel.ts';
|
||||
export type * from './_chatInput/integer.ts';
|
||||
export type * from './_chatInput/mentionable.ts';
|
||||
export type * from './_chatInput/number.ts';
|
||||
export type * from './_chatInput/role.ts';
|
||||
export * from './_chatInput/shared.ts';
|
||||
export * from './_chatInput/string.ts';
|
||||
export * from './_chatInput/subcommand.ts';
|
||||
export * from './_chatInput/subcommandGroup.ts';
|
||||
export * from './_chatInput/user.ts';
|
||||
export type * from './_chatInput/string.ts';
|
||||
export type * from './_chatInput/subcommand.ts';
|
||||
export type * from './_chatInput/subcommandGroup.ts';
|
||||
export type * from './_chatInput/user.ts';
|
||||
|
||||
/**
|
||||
* @see {@link https://discord.com/developers/docs/interactions/application-commands#application-command-object-application-command-option-structure}
|
||||
|
||||
@@ -23,10 +23,10 @@ import type { APIBaseInteraction } from './base.ts';
|
||||
import type { InteractionType } from './responses.ts';
|
||||
|
||||
export * from './_applicationCommands/chatInput.ts';
|
||||
export * from './_applicationCommands/contextMenu.ts';
|
||||
export type * from './_applicationCommands/contextMenu.ts';
|
||||
export * from './_applicationCommands/permissions.ts';
|
||||
export * from './_applicationCommands/entryPoint.ts';
|
||||
export * from './_applicationCommands/internals.ts';
|
||||
export type * from './_applicationCommands/entryPoint.ts';
|
||||
export type * from './_applicationCommands/internals.ts';
|
||||
|
||||
/**
|
||||
* @see {@link https://discord.com/developers/docs/interactions/application-commands#application-command-object}
|
||||
@@ -95,15 +95,21 @@ export interface APIApplicationCommand {
|
||||
*/
|
||||
default_permission?: boolean;
|
||||
/**
|
||||
* Indicates whether the command is age-restricted, defaults to `false`
|
||||
* Indicates whether the command is age-restricted
|
||||
*
|
||||
* @defaultValue `false`
|
||||
*/
|
||||
nsfw?: boolean;
|
||||
/**
|
||||
* Installation context(s) where the command is available, only for globally-scoped commands. Defaults to `GUILD_INSTALL ([0])`
|
||||
* Installation context(s) where the command is available, only for globally-scoped commands
|
||||
*
|
||||
* @defaultValue `[ApplicationIntegrationType.GuildInstall]`
|
||||
*/
|
||||
integration_types?: ApplicationIntegrationType[];
|
||||
/**
|
||||
* Interaction context(s) where the command can be used, only for globally-scoped commands. By default, all interaction context types included for new commands `[0,1,2]`.
|
||||
* Interaction context(s) where the command can be used, only for globally-scoped commands
|
||||
*
|
||||
* @defaultValue `[InteractionContextType.Guild, InteractionContextType.BotDM, InteractionContextType.PrivateChannel]`
|
||||
*/
|
||||
contexts?: InteractionContextType[] | null;
|
||||
/**
|
||||
|
||||
15
deno/payloads/v10/_interactions/base.ts
generated
15
deno/payloads/v10/_interactions/base.ts
generated
@@ -9,7 +9,14 @@ import type {
|
||||
ChannelType,
|
||||
ThreadChannelType,
|
||||
} from '../channel.ts';
|
||||
import type { APIGuildMember, APIPartialInteractionGuild } from '../guild.ts';
|
||||
import type {
|
||||
APIBaseGuildMember,
|
||||
APIFlaggedGuildMember,
|
||||
APIGuildMember,
|
||||
APIGuildMemberAvatar,
|
||||
APIGuildMemberJoined,
|
||||
APIPartialInteractionGuild,
|
||||
} from '../guild.ts';
|
||||
import type { APIEntitlement } from '../monetization.ts';
|
||||
import type { APIUser } from '../user.ts';
|
||||
import type { InteractionType } from './responses.ts';
|
||||
@@ -253,7 +260,11 @@ export type APIInteractionDataResolvedChannel =
|
||||
/**
|
||||
* @see {@link https://discord.com/developers/docs/resources/guild#guild-member-object}
|
||||
*/
|
||||
export interface APIInteractionDataResolvedGuildMember extends Omit<APIGuildMember, 'deaf' | 'mute' | 'user'> {
|
||||
export interface APIInteractionDataResolvedGuildMember
|
||||
extends APIBaseGuildMember,
|
||||
APIFlaggedGuildMember,
|
||||
APIGuildMemberAvatar,
|
||||
APIGuildMemberJoined {
|
||||
permissions: Permissions;
|
||||
}
|
||||
|
||||
|
||||
5
deno/payloads/v10/_interactions/modalSubmit.ts
generated
5
deno/payloads/v10/_interactions/modalSubmit.ts
generated
@@ -1,4 +1,4 @@
|
||||
import type { APIActionRowComponent, APIComponentInModalActionRow } from '../channel.ts';
|
||||
import type { APIBaseComponent } from '../channel.ts';
|
||||
import type {
|
||||
APIBaseInteraction,
|
||||
APIDMInteractionWrapper,
|
||||
@@ -13,8 +13,7 @@ export interface ModalSubmitComponent {
|
||||
value: string;
|
||||
}
|
||||
|
||||
export interface ModalSubmitActionRowComponent
|
||||
extends Omit<APIActionRowComponent<APIComponentInModalActionRow>, 'components'> {
|
||||
export interface ModalSubmitActionRowComponent extends APIBaseComponent<ComponentType.ActionRow> {
|
||||
components: ModalSubmitComponent[];
|
||||
}
|
||||
|
||||
|
||||
10
deno/payloads/v10/application.ts
generated
10
deno/payloads/v10/application.ts
generated
@@ -111,9 +111,13 @@ export interface APIApplication {
|
||||
*/
|
||||
approximate_guild_count?: number;
|
||||
/**
|
||||
* Approximate count of users that have installed the app
|
||||
* Approximate count of users that have installed the app (authorized with `application.commands` as a scope)
|
||||
*/
|
||||
approximate_user_install_count?: number;
|
||||
/**
|
||||
* Approximate count of users that have OAuth2 authorizations for the app
|
||||
*/
|
||||
approximate_user_authorization_count?: number;
|
||||
/**
|
||||
* Array of redirect URIs for the application
|
||||
*/
|
||||
@@ -227,11 +231,11 @@ export enum ApplicationFlags {
|
||||
*/
|
||||
Embedded = 1 << 17,
|
||||
/**
|
||||
* Intent required for bots in 100 or more servers to receive {@link https://support-dev.discord.com/hc/en-us/articles/4404772028055 | message content}
|
||||
* Intent required for bots in 100 or more servers to receive {@link https://support-dev.discord.com/hc/articles/6207308062871 | message content}
|
||||
*/
|
||||
GatewayMessageContent = 1 << 18,
|
||||
/**
|
||||
* Intent required for bots in under 100 servers to receive {@link https://support-dev.discord.com/hc/en-us/articles/4404772028055 | message content},
|
||||
* Intent required for bots in under 100 servers to receive {@link https://support-dev.discord.com/hc/articles/6207308062871 | message content},
|
||||
* found in Bot Settings
|
||||
*/
|
||||
GatewayMessageContentLimited = 1 << 19,
|
||||
|
||||
6
deno/payloads/v10/auditLog.ts
generated
6
deno/payloads/v10/auditLog.ts
generated
@@ -207,6 +207,7 @@ export enum AuditLogEvent {
|
||||
AutoModerationBlockMessage,
|
||||
AutoModerationFlagToChannel,
|
||||
AutoModerationUserCommunicationDisabled,
|
||||
AutoModerationQuarantineUser,
|
||||
|
||||
CreatorMonetizationRequestCreated = 150,
|
||||
CreatorMonetizationTermsAccepted,
|
||||
@@ -232,6 +233,7 @@ export interface APIAuditLogOptions {
|
||||
* - AUTO_MODERATION_BLOCK_MESSAGE
|
||||
* - AUTO_MODERATION_FLAG_TO_CHANNEL
|
||||
* - AUTO_MODERATION_USER_COMMUNICATION_DISABLED
|
||||
* - AUTO_MODERATION_QUARANTINE_USER
|
||||
*/
|
||||
auto_moderation_rule_name?: string;
|
||||
/**
|
||||
@@ -241,6 +243,7 @@ export interface APIAuditLogOptions {
|
||||
* - AUTO_MODERATION_BLOCK_MESSAGE
|
||||
* - AUTO_MODERATION_FLAG_TO_CHANNEL
|
||||
* - AUTO_MODERATION_USER_COMMUNICATION_DISABLED
|
||||
* - AUTO_MODERATION_QUARANTINE_USER
|
||||
*/
|
||||
auto_moderation_rule_trigger_type?: AuditLogRuleTriggerType;
|
||||
/**
|
||||
@@ -272,6 +275,7 @@ export interface APIAuditLogOptions {
|
||||
* - AUTO_MODERATION_BLOCK_MESSAGE
|
||||
* - AUTO_MODERATION_FLAG_TO_CHANNEL
|
||||
* - AUTO_MODERATION_USER_COMMUNICATION_DISABLED
|
||||
* - AUTO_MODERATION_QUARANTINE_USER
|
||||
*/
|
||||
channel_id?: Snowflake;
|
||||
|
||||
@@ -325,7 +329,7 @@ export interface APIAuditLogOptions {
|
||||
* - CHANNEL_OVERWRITE_UPDATE
|
||||
* - CHANNEL_OVERWRITE_DELETE
|
||||
*
|
||||
* **Present only if the {@link APIAuditLogOptions.type | entry type} is "0"**
|
||||
* **Present only if the {@link APIAuditLogOptions."type" | entry type} is "0"**
|
||||
*/
|
||||
role_name?: string;
|
||||
|
||||
|
||||
552
deno/payloads/v10/channel.ts
generated
552
deno/payloads/v10/channel.ts
generated
File diff suppressed because it is too large
Load Diff
31
deno/payloads/v10/emoji.ts
generated
31
deno/payloads/v10/emoji.ts
generated
@@ -3,6 +3,7 @@
|
||||
*/
|
||||
|
||||
import type { Snowflake } from '../../globals.ts';
|
||||
import type { _NonNullableFields } from '../../utils/internals.ts';
|
||||
import type { APIRole } from './permissions.ts';
|
||||
import type { APIUser } from './user.ts';
|
||||
|
||||
@@ -49,3 +50,33 @@ export interface APIEmoji extends APIPartialEmoji {
|
||||
*/
|
||||
available?: boolean;
|
||||
}
|
||||
|
||||
/**
|
||||
* @see {@link https://discord.com/developers/docs/resources/emoji#emoji-object-applicationowned-emoji}
|
||||
*/
|
||||
export type APIApplicationEmoji = _NonNullableFields<Required<Pick<APIEmoji, 'animated' | 'id' | 'name' | 'user'>>> & {
|
||||
/**
|
||||
* Roles allowed to use this emoji.
|
||||
*
|
||||
* @remarks Always empty.
|
||||
*/
|
||||
roles: [];
|
||||
/**
|
||||
* Whether this emoji must be wrapped in colons.
|
||||
*
|
||||
* @remarks Always `true`.
|
||||
*/
|
||||
require_colons: true;
|
||||
/**
|
||||
* Whether this emoji is managed.
|
||||
*
|
||||
* @remarks Always `false`.
|
||||
*/
|
||||
managed: false;
|
||||
/**
|
||||
* Whether this emoji is available.
|
||||
*
|
||||
* @remarks Always `true`.
|
||||
*/
|
||||
available: true;
|
||||
};
|
||||
|
||||
18
deno/payloads/v10/gateway.ts
generated
18
deno/payloads/v10/gateway.ts
generated
@@ -60,9 +60,9 @@ export interface APIGatewaySessionStartLimit {
|
||||
}
|
||||
|
||||
/**
|
||||
* @see {@link https://discord.com/developers/docs/topics/gateway-events#presence-update-presence-update-event-fields}
|
||||
* @see {@link https://discord.com/developers/docs/topics/gateway-events#update-presence}
|
||||
*/
|
||||
export interface GatewayPresenceUpdate {
|
||||
export interface GatewayGuildMembersChunkPresence {
|
||||
/**
|
||||
* The user presence is being updated for
|
||||
*
|
||||
@@ -72,10 +72,6 @@ export interface GatewayPresenceUpdate {
|
||||
* @see {@link https://discord.com/developers/docs/resources/user#user-object}
|
||||
*/
|
||||
user: Partial<APIUser> & Pick<APIUser, 'id'>;
|
||||
/**
|
||||
* ID of the guild
|
||||
*/
|
||||
guild_id: Snowflake;
|
||||
/**
|
||||
* Either "idle", "dnd", "online", or "offline"
|
||||
*/
|
||||
@@ -94,6 +90,16 @@ export interface GatewayPresenceUpdate {
|
||||
client_status?: GatewayPresenceClientStatus;
|
||||
}
|
||||
|
||||
/**
|
||||
* @see {@link https://discord.com/developers/docs/topics/gateway-events#presence-update-presence-update-event-fields}
|
||||
*/
|
||||
export interface GatewayPresenceUpdate extends GatewayGuildMembersChunkPresence {
|
||||
/**
|
||||
* ID of the guild
|
||||
*/
|
||||
guild_id: Snowflake;
|
||||
}
|
||||
|
||||
/**
|
||||
* @see {@link https://discord.com/developers/docs/topics/gateway-events#update-presence-status-types}
|
||||
*/
|
||||
|
||||
155
deno/payloads/v10/guild.ts
generated
155
deno/payloads/v10/guild.ts
generated
@@ -11,14 +11,17 @@ import type { APIRole } from './permissions.ts';
|
||||
import type { APISticker } from './sticker.ts';
|
||||
import type { APIAvatarDecorationData, APIUser } from './user.ts';
|
||||
|
||||
/**
|
||||
* @see {@link https://discord.com/developers/docs/resources/guild#unavailable-guild-object}
|
||||
*/
|
||||
export interface APIUnavailableGuild {
|
||||
export interface APIBaseGuild {
|
||||
/**
|
||||
* Guild id
|
||||
*/
|
||||
id: Snowflake;
|
||||
}
|
||||
|
||||
/**
|
||||
* @see {@link https://discord.com/developers/docs/resources/guild#unavailable-guild-object}
|
||||
*/
|
||||
export interface APIUnavailableGuild extends APIBaseGuild {
|
||||
/**
|
||||
* `true` if this guild is unavailable due to an outage
|
||||
*/
|
||||
@@ -28,7 +31,7 @@ export interface APIUnavailableGuild {
|
||||
/**
|
||||
* @see {@link https://discord.com/developers/docs/resources/guild#guild-object-guild-structure}
|
||||
*/
|
||||
export interface APIPartialGuild extends Omit<APIUnavailableGuild, 'unavailable'>, Pick<APIGuild, 'welcome_screen'> {
|
||||
export interface APIPartialGuild extends APIBaseGuild {
|
||||
/**
|
||||
* Guild name (2-100 characters, excluding trailing and leading whitespace)
|
||||
*/
|
||||
@@ -71,8 +74,19 @@ export interface APIPartialGuild extends Omit<APIUnavailableGuild, 'unavailable'
|
||||
* The vanity url code for the guild
|
||||
*/
|
||||
vanity_url_code?: string | null;
|
||||
/**
|
||||
* The welcome screen of a Community guild, shown to new members
|
||||
*
|
||||
* Returned in the invite object
|
||||
*/
|
||||
welcome_screen?: APIGuildWelcomeScreen;
|
||||
}
|
||||
|
||||
/**
|
||||
* Source guild of channel follower webhooks.
|
||||
*/
|
||||
export type APIWebhookSourceGuild = Pick<APIPartialGuild, 'icon' | 'id' | 'name'>;
|
||||
|
||||
/**
|
||||
* @see {@link https://discord.com/developers/docs/resources/guild#guild-object-guild-structure}
|
||||
*/
|
||||
@@ -223,7 +237,7 @@ export interface APIGuild extends APIPartialGuild {
|
||||
*/
|
||||
premium_subscription_count?: number;
|
||||
/**
|
||||
* The preferred locale of a Community guild; used in guild discovery and notices from Discord; defaults to "en-US"
|
||||
* The preferred locale of a Community guild; used in guild discovery and notices from Discord
|
||||
*
|
||||
* @defaultValue `"en-US"`
|
||||
*/
|
||||
@@ -250,12 +264,6 @@ export interface APIGuild extends APIPartialGuild {
|
||||
* returned from the `GET /guilds/<id>` and `/users/@me/guilds` (OAuth2) endpoints when `with_counts` is `true`
|
||||
*/
|
||||
approximate_presence_count?: number;
|
||||
/**
|
||||
* The welcome screen of a Community guild, shown to new members
|
||||
*
|
||||
* Returned in the invite object
|
||||
*/
|
||||
welcome_screen?: APIGuildWelcomeScreen;
|
||||
/**
|
||||
* The nsfw level of the guild
|
||||
*
|
||||
@@ -291,7 +299,7 @@ export interface APIGuild extends APIPartialGuild {
|
||||
*/
|
||||
export interface APIPartialInteractionGuild extends Pick<APIGuild, 'features' | 'id'> {
|
||||
/**
|
||||
* The preferred locale of a Community guild; used in guild discovery and notices from Discord; defaults to "en-US"
|
||||
* The preferred locale of a Community guild; used in guild discovery and notices from Discord
|
||||
*
|
||||
* @unstable https://github.com/discord/discord-api-docs/issues/6938
|
||||
* @defaultValue `"en-US"`
|
||||
@@ -557,6 +565,14 @@ export enum GuildFeature {
|
||||
* Guild has enabled the welcome screen
|
||||
*/
|
||||
WelcomeScreenEnabled = 'WELCOME_SCREEN_ENABLED',
|
||||
/**
|
||||
* Guild has access to set guild tags
|
||||
*/
|
||||
GuildTags = 'GUILD_TAGS',
|
||||
/**
|
||||
* Guild is able to set gradient colors to roles
|
||||
*/
|
||||
EnhancedRoleColors = 'ENHANCED_ROLE_COLORS',
|
||||
}
|
||||
|
||||
/**
|
||||
@@ -636,55 +652,23 @@ export interface APIGuildWidgetSettings {
|
||||
/**
|
||||
* @see {@link https://discord.com/developers/docs/resources/guild#guild-member-object}
|
||||
*/
|
||||
export interface APIGuildMember {
|
||||
/**
|
||||
* The user this guild member represents
|
||||
*
|
||||
* **This field won't be included in the member object attached to `MESSAGE_CREATE` and `MESSAGE_UPDATE` gateway events.**
|
||||
*
|
||||
* @see {@link https://discord.com/developers/docs/resources/user#user-object}
|
||||
*/
|
||||
user: APIUser;
|
||||
export interface APIBaseGuildMember {
|
||||
/**
|
||||
* This users guild nickname
|
||||
*/
|
||||
nick?: string | null;
|
||||
/**
|
||||
* The member's guild avatar hash
|
||||
*/
|
||||
avatar?: string | null;
|
||||
/**
|
||||
* The member's guild banner hash
|
||||
*/
|
||||
banner?: string | null;
|
||||
/**
|
||||
* Array of role object ids
|
||||
*
|
||||
* @see {@link https://discord.com/developers/docs/topics/permissions#role-object}
|
||||
*/
|
||||
roles: Snowflake[];
|
||||
/**
|
||||
* When the user joined the guild
|
||||
*/
|
||||
joined_at: string;
|
||||
/**
|
||||
* When the user started boosting the guild
|
||||
*
|
||||
* @see {@link https://support.discord.com/hc/articles/360028038352}
|
||||
*/
|
||||
premium_since?: string | null;
|
||||
/**
|
||||
* Whether the user is deafened in voice channels
|
||||
*/
|
||||
deaf: boolean;
|
||||
/**
|
||||
* Whether the user is muted in voice channels
|
||||
*/
|
||||
mute: boolean;
|
||||
/**
|
||||
* Guild member flags represented as a bit set, defaults to `0`
|
||||
*/
|
||||
flags: GuildMemberFlags;
|
||||
/**
|
||||
* Whether the user has not yet passed the guild's Membership Screening requirements
|
||||
*
|
||||
@@ -703,6 +687,81 @@ export interface APIGuildMember {
|
||||
avatar_decoration_data?: APIAvatarDecorationData | null;
|
||||
}
|
||||
|
||||
/**
|
||||
* @see {@link https://discord.com/developers/docs/resources/guild#guild-member-object}
|
||||
*/
|
||||
export interface APIFlaggedGuildMember {
|
||||
/**
|
||||
* Guild member flags represented as a bit set
|
||||
*
|
||||
* @defaultValue `0`
|
||||
*/
|
||||
flags: GuildMemberFlags;
|
||||
}
|
||||
|
||||
/**
|
||||
* @see {@link https://discord.com/developers/docs/resources/guild#guild-member-object}
|
||||
*/
|
||||
export interface APIGuildMemberJoined {
|
||||
/**
|
||||
* When the user joined the guild
|
||||
*/
|
||||
joined_at: string;
|
||||
}
|
||||
|
||||
/**
|
||||
* @see {@link https://discord.com/developers/docs/resources/guild#guild-member-object}
|
||||
*/
|
||||
export interface APIGuildMemberAvatar {
|
||||
/**
|
||||
* The member's guild avatar hash
|
||||
*/
|
||||
avatar?: string | null;
|
||||
/**
|
||||
* The member's guild banner hash
|
||||
*/
|
||||
banner?: string | null;
|
||||
}
|
||||
|
||||
/**
|
||||
* @see {@link https://discord.com/developers/docs/resources/guild#guild-member-object}
|
||||
*/
|
||||
export interface APIBaseVoiceGuildMember {
|
||||
/**
|
||||
* Whether the user is deafened in voice channels
|
||||
*/
|
||||
deaf: boolean;
|
||||
/**
|
||||
* Whether the user is muted in voice channels
|
||||
*/
|
||||
mute: boolean;
|
||||
}
|
||||
|
||||
/**
|
||||
* @see {@link https://discord.com/developers/docs/resources/guild#guild-member-object}
|
||||
*/
|
||||
export interface APIGuildMemberUser {
|
||||
/**
|
||||
* The user this guild member represents
|
||||
*
|
||||
* **This field won't be included in the member object attached to `MESSAGE_CREATE` and `MESSAGE_UPDATE` gateway events.**
|
||||
*
|
||||
* @see {@link https://discord.com/developers/docs/resources/user#user-object}
|
||||
*/
|
||||
user: APIUser;
|
||||
}
|
||||
|
||||
/**
|
||||
* @see {@link https://discord.com/developers/docs/resources/guild#guild-member-object}
|
||||
*/
|
||||
export interface APIGuildMember
|
||||
extends APIBaseGuildMember,
|
||||
APIBaseVoiceGuildMember,
|
||||
APIFlaggedGuildMember,
|
||||
APIGuildMemberAvatar,
|
||||
APIGuildMemberJoined,
|
||||
APIGuildMemberUser {}
|
||||
|
||||
/**
|
||||
* @see {@link https://discord.com/developers/docs/resources/guild#guild-member-object-guild-member-flags}
|
||||
*/
|
||||
@@ -748,6 +807,10 @@ export enum GuildMemberFlags {
|
||||
* Member has dismissed the DM settings upsell
|
||||
*/
|
||||
DmSettingsUpsellAcknowledged = 1 << 9,
|
||||
/**
|
||||
* Member's guild tag is blocked by AutoMod
|
||||
*/
|
||||
AutoModQuarantinedGuildTag = 1 << 10,
|
||||
}
|
||||
|
||||
/**
|
||||
|
||||
10
deno/payloads/v10/interactions.ts
generated
10
deno/payloads/v10/interactions.ts
generated
@@ -21,11 +21,11 @@ import type {
|
||||
import type { APIPingInteraction } from './_interactions/ping.ts';
|
||||
|
||||
export * from './_interactions/applicationCommands.ts';
|
||||
export * from './_interactions/autocomplete.ts';
|
||||
export * from './_interactions/base.ts';
|
||||
export * from './_interactions/messageComponents.ts';
|
||||
export * from './_interactions/modalSubmit.ts';
|
||||
export * from './_interactions/ping.ts';
|
||||
export type * from './_interactions/autocomplete.ts';
|
||||
export type * from './_interactions/base.ts';
|
||||
export type * from './_interactions/messageComponents.ts';
|
||||
export type * from './_interactions/modalSubmit.ts';
|
||||
export type * from './_interactions/ping.ts';
|
||||
export * from './_interactions/responses.ts';
|
||||
|
||||
/**
|
||||
|
||||
4
deno/payloads/v10/invite.ts
generated
4
deno/payloads/v10/invite.ts
generated
@@ -3,7 +3,7 @@
|
||||
*/
|
||||
|
||||
import type { APIApplication } from './application.ts';
|
||||
import type { APIPartialChannel } from './channel.ts';
|
||||
import type { APIInviteChannel } from './channel.ts';
|
||||
import type { APIGuild } from './guild.ts';
|
||||
import type { APIGuildScheduledEvent } from './guildScheduledEvent.ts';
|
||||
import type { APIInviteStageInstance } from './stageInstance.ts';
|
||||
@@ -43,7 +43,7 @@ export interface APIInvite {
|
||||
*
|
||||
* @see {@link https://discord.com/developers/docs/resources/channel#channel-object}
|
||||
*/
|
||||
channel: Required<APIPartialChannel> | null;
|
||||
channel: APIInviteChannel | null;
|
||||
/**
|
||||
* The user who created the invite
|
||||
*
|
||||
|
||||
8
deno/payloads/v10/mod.ts
generated
8
deno/payloads/v10/mod.ts
generated
@@ -3,7 +3,7 @@ export * from './application.ts';
|
||||
export * from './auditLog.ts';
|
||||
export * from './autoModeration.ts';
|
||||
export * from './channel.ts';
|
||||
export * from './emoji.ts';
|
||||
export type * from './emoji.ts';
|
||||
export * from './gateway.ts';
|
||||
export * from './guild.ts';
|
||||
export * from './guildScheduledEvent.ts';
|
||||
@@ -13,11 +13,11 @@ export * from './monetization.ts';
|
||||
export * from './oauth2.ts';
|
||||
export * from './permissions.ts';
|
||||
export * from './poll.ts';
|
||||
export * from './soundboard.ts';
|
||||
export type * from './soundboard.ts';
|
||||
export * from './stageInstance.ts';
|
||||
export * from './sticker.ts';
|
||||
export * from './teams.ts';
|
||||
export * from './template.ts';
|
||||
export type * from './template.ts';
|
||||
export * from './user.ts';
|
||||
export * from './voice.ts';
|
||||
export type * from './voice.ts';
|
||||
export * from './webhook.ts';
|
||||
|
||||
26
deno/payloads/v10/permissions.ts
generated
26
deno/payloads/v10/permissions.ts
generated
@@ -18,8 +18,14 @@ export interface APIRole {
|
||||
name: string;
|
||||
/**
|
||||
* Integer representation of hexadecimal color code
|
||||
*
|
||||
* @remarks `color` will still be returned by the API, but using the `colors` field is recommended when doing requests.
|
||||
*/
|
||||
color: number;
|
||||
/**
|
||||
* The role's colors
|
||||
*/
|
||||
colors?: APIRoleColors;
|
||||
/**
|
||||
* If this role is pinned in the user listing
|
||||
*/
|
||||
@@ -99,3 +105,23 @@ export enum RoleFlags {
|
||||
*/
|
||||
InPrompt = 1 << 0,
|
||||
}
|
||||
|
||||
/**
|
||||
* @see {@link https://discord.com/developers/docs/topics/permissions#role-colors-object}
|
||||
*/
|
||||
export interface APIRoleColors {
|
||||
/**
|
||||
* The primary color for the role
|
||||
*/
|
||||
primary_color: number;
|
||||
/**
|
||||
* The secondary color for the role, this will make the role a gradient between the other provided colors
|
||||
*/
|
||||
secondary_color: number | null;
|
||||
/**
|
||||
* The tertiary color for the role, this will turn the gradient into a holographic style
|
||||
*
|
||||
* @remarks When sending `tertiary_color` the API enforces the role color to be a holographic style with values of `primary_color = 11127295`, `secondary_color = 16759788`, and `tertiary_color = 16761760`.
|
||||
*/
|
||||
tertiary_color: number | null;
|
||||
}
|
||||
|
||||
49
deno/payloads/v10/poll.ts
generated
49
deno/payloads/v10/poll.ts
generated
@@ -4,22 +4,14 @@
|
||||
|
||||
import type { APIPartialEmoji } from './emoji.ts';
|
||||
|
||||
/**
|
||||
* @see {@link https://discord.com/developers/docs/resources/poll#poll-object-poll-object-structure}
|
||||
*/
|
||||
export interface APIPoll {
|
||||
export interface APIBasePoll {
|
||||
/**
|
||||
* The question of the poll
|
||||
*/
|
||||
question: APIPollMedia;
|
||||
/**
|
||||
* Each of the answers available in the poll, up to 10
|
||||
*/
|
||||
answers: APIPollAnswer[];
|
||||
/**
|
||||
* The time when the poll ends (IS08601 timestamp)
|
||||
*/
|
||||
expiry: string;
|
||||
}
|
||||
|
||||
export interface APIPollDefaults {
|
||||
/**
|
||||
* Whether a user can select multiple answers
|
||||
*
|
||||
@@ -32,6 +24,20 @@ export interface APIPoll {
|
||||
* @defaultValue `PollLayoutType.Default`
|
||||
*/
|
||||
layout_type: PollLayoutType;
|
||||
}
|
||||
|
||||
/**
|
||||
* @see {@link https://discord.com/developers/docs/resources/poll#poll-object-poll-object-structure}
|
||||
*/
|
||||
export interface APIPoll extends APIBasePoll, APIPollDefaults {
|
||||
/**
|
||||
* Each of the answers available in the poll, up to 10
|
||||
*/
|
||||
answers: APIPollAnswer[];
|
||||
/**
|
||||
* The time when the poll ends (IS08601 timestamp)
|
||||
*/
|
||||
expiry: string;
|
||||
/**
|
||||
* The results of the poll
|
||||
*/
|
||||
@@ -64,20 +70,23 @@ export interface APIPollMedia {
|
||||
emoji?: APIPartialEmoji;
|
||||
}
|
||||
|
||||
/**
|
||||
* @see {@link https://discord.com/developers/docs/resources/poll#poll-answer-object-poll-answer-object-structure}
|
||||
*/
|
||||
export interface APIPollAnswer {
|
||||
/**
|
||||
* The ID of the answer. Starts at `1` for the first answer and goes up sequentially
|
||||
*/
|
||||
answer_id: number;
|
||||
export interface APIBasePollAnswer {
|
||||
/**
|
||||
* The data of the answer
|
||||
*/
|
||||
poll_media: APIPollMedia;
|
||||
}
|
||||
|
||||
/**
|
||||
* @see {@link https://discord.com/developers/docs/resources/poll#poll-answer-object-poll-answer-object-structure}
|
||||
*/
|
||||
export interface APIPollAnswer extends APIBasePollAnswer {
|
||||
/**
|
||||
* The ID of the answer. Starts at `1` for the first answer and goes up sequentially
|
||||
*/
|
||||
answer_id: number;
|
||||
}
|
||||
|
||||
/**
|
||||
* @see {@link https://discord.com/developers/docs/resources/poll#poll-results-object-poll-results-object-structure}
|
||||
*/
|
||||
|
||||
90
deno/payloads/v10/user.ts
generated
90
deno/payloads/v10/user.ts
generated
@@ -96,6 +96,18 @@ export interface APIUser {
|
||||
* @see {@link https://discord.com/developers/docs/resources/user#avatar-decoration-data-object}
|
||||
*/
|
||||
avatar_decoration_data?: APIAvatarDecorationData | null;
|
||||
/**
|
||||
* The data for the user's collectibles
|
||||
*
|
||||
* @see {@link https://discord.com/developers/docs/resources/user#collectibles}
|
||||
*/
|
||||
collectibles?: APICollectibles | null;
|
||||
/**
|
||||
* The user's primary guild
|
||||
*
|
||||
* @see {@link https://discord.com/developers/docs/resources/user#user-object-user-primary-guild}
|
||||
*/
|
||||
primary_guild?: APIUserPrimaryGuild | null;
|
||||
}
|
||||
|
||||
/**
|
||||
@@ -348,3 +360,81 @@ export interface APIAvatarDecorationData {
|
||||
*/
|
||||
sku_id: Snowflake;
|
||||
}
|
||||
|
||||
/**
|
||||
* The collectibles the user has, excluding Avatar Decorations and Profile Effects.
|
||||
*
|
||||
* @see {@link https://discord.com/developers/docs/resources/user#collectibles}
|
||||
*/
|
||||
export interface APICollectibles {
|
||||
/**
|
||||
* Object mapping of {@link APINameplateData}
|
||||
*/
|
||||
nameplate?: APINameplateData;
|
||||
}
|
||||
|
||||
/**
|
||||
* @see {@link https://discord.com/developers/docs/resources/user#nameplate}
|
||||
*/
|
||||
export interface APINameplateData {
|
||||
/**
|
||||
* ID of the nameplate SKU
|
||||
*/
|
||||
sku_id: Snowflake;
|
||||
/**
|
||||
* Path to the nameplate asset
|
||||
*
|
||||
* @example `nameplates/nameplates/twilight/`
|
||||
*/
|
||||
asset: string;
|
||||
/**
|
||||
* The label of this nameplate. Currently unused
|
||||
*/
|
||||
label: string;
|
||||
/**
|
||||
* Background color of the nameplate
|
||||
*/
|
||||
palette: NameplatePalette;
|
||||
}
|
||||
|
||||
/**
|
||||
* Background color of a nameplate.
|
||||
*/
|
||||
export enum NameplatePalette {
|
||||
Berry = 'berry',
|
||||
BubbleGum = 'bubble_gum',
|
||||
Clover = 'clover',
|
||||
Cobalt = 'cobalt',
|
||||
Crimson = 'crimson',
|
||||
Forest = 'forest',
|
||||
Lemon = 'lemon',
|
||||
Sky = 'sky',
|
||||
Teal = 'teal',
|
||||
Violet = 'violet',
|
||||
White = 'white',
|
||||
}
|
||||
|
||||
/**
|
||||
* @see {@link https://discord.com/developers/docs/resources/user#user-object-user-primary-guild}
|
||||
*/
|
||||
export interface APIUserPrimaryGuild {
|
||||
/**
|
||||
* The id of the user's primary guild
|
||||
*/
|
||||
identity_guild_id: Snowflake | null;
|
||||
/**
|
||||
* Whether the user is displaying the primary guild's server tag.
|
||||
* This can be `null` if the system clears the identity, e.g. because the server no longer supports tags
|
||||
*/
|
||||
identity_enabled: boolean | null;
|
||||
/**
|
||||
* The text of the user's server tag. Limited to 4 characters
|
||||
*/
|
||||
tag: string | null;
|
||||
/**
|
||||
* The server tag badge hash
|
||||
*
|
||||
* @see {@link https://discord.com/developers/docs/reference#image-formatting}
|
||||
*/
|
||||
badge: string | null;
|
||||
}
|
||||
|
||||
16
deno/payloads/v10/voice.ts
generated
16
deno/payloads/v10/voice.ts
generated
@@ -14,11 +14,7 @@ export type GatewayVoiceState = APIVoiceState;
|
||||
/**
|
||||
* @see {@link https://discord.com/developers/docs/resources/voice#voice-state-object}
|
||||
*/
|
||||
export interface APIVoiceState {
|
||||
/**
|
||||
* The guild id this voice state is for
|
||||
*/
|
||||
guild_id?: Snowflake;
|
||||
export interface APIBaseVoiceState {
|
||||
/**
|
||||
* The channel id this user is connected to
|
||||
*/
|
||||
@@ -71,6 +67,16 @@ export interface APIVoiceState {
|
||||
request_to_speak_timestamp: string | null;
|
||||
}
|
||||
|
||||
/**
|
||||
* @see {@link https://discord.com/developers/docs/resources/voice#voice-state-object}
|
||||
*/
|
||||
export interface APIVoiceState extends APIBaseVoiceState {
|
||||
/**
|
||||
* The guild id this voice state is for
|
||||
*/
|
||||
guild_id?: Snowflake;
|
||||
}
|
||||
|
||||
/**
|
||||
* @see {@link https://discord.com/developers/docs/resources/voice#voice-region-object}
|
||||
*/
|
||||
|
||||
23
deno/payloads/v10/webhook.ts
generated
23
deno/payloads/v10/webhook.ts
generated
@@ -6,11 +6,11 @@ import type { Snowflake } from '../../globals.ts';
|
||||
import type {
|
||||
APIEntitlement,
|
||||
APIGuild,
|
||||
APIPartialChannel,
|
||||
APIPartialGuild,
|
||||
APIUser,
|
||||
APIWebhookSourceGuild,
|
||||
ApplicationIntegrationType,
|
||||
OAuth2Scopes,
|
||||
APIWebhookSourceChannel,
|
||||
} from './mod.ts';
|
||||
|
||||
/**
|
||||
@@ -60,11 +60,11 @@ export interface APIWebhook {
|
||||
/**
|
||||
* The guild of the channel that this webhook is following (returned for Channel Follower Webhooks)
|
||||
*/
|
||||
source_guild?: APIPartialGuild;
|
||||
source_guild?: APIWebhookSourceGuild;
|
||||
/**
|
||||
* The channel that this webhook is following (returned for Channel Follower Webhooks)
|
||||
*/
|
||||
source_channel?: APIPartialChannel;
|
||||
source_channel?: APIWebhookSourceChannel;
|
||||
/**
|
||||
* The url used for executing the webhook (returned by the webhooks OAuth2 flow)
|
||||
*/
|
||||
@@ -86,6 +86,10 @@ export type APIWebhookEventBody =
|
||||
ApplicationWebhookEventType.ApplicationAuthorized,
|
||||
APIWebhookEventApplicationAuthorizedData
|
||||
>
|
||||
| APIWebhookEventEventBase<
|
||||
ApplicationWebhookEventType.ApplicationDeauthorized,
|
||||
APIWebhookEventApplicationDeauthorizedData
|
||||
>
|
||||
| APIWebhookEventEventBase<ApplicationWebhookEventType.EntitlementCreate, APIWebhookEventEntitlementCreateData>
|
||||
| APIWebhookEventEventBase<ApplicationWebhookEventType.QuestUserEnrollment, APIWebhookEventQuestUserEnrollmentData>;
|
||||
|
||||
@@ -108,6 +112,13 @@ export interface APIWebhookEventApplicationAuthorizedData {
|
||||
guild?: APIGuild;
|
||||
}
|
||||
|
||||
export interface APIWebhookEventApplicationDeauthorizedData {
|
||||
/**
|
||||
* User who deauthorized the app
|
||||
*/
|
||||
user: APIUser;
|
||||
}
|
||||
|
||||
export type APIWebhookEventEntitlementCreateData = APIEntitlement;
|
||||
|
||||
export type APIWebhookEventQuestUserEnrollmentData = never;
|
||||
@@ -168,6 +179,10 @@ export enum ApplicationWebhookEventType {
|
||||
* Sent when an app was authorized by a user to a server or their account
|
||||
*/
|
||||
ApplicationAuthorized = 'APPLICATION_AUTHORIZED',
|
||||
/**
|
||||
* Sent when an app was deauthorized by a user
|
||||
*/
|
||||
ApplicationDeauthorized = 'APPLICATION_DEAUTHORIZED',
|
||||
/**
|
||||
* Entitlement was created
|
||||
*/
|
||||
|
||||
@@ -5,7 +5,7 @@ import type { ApplicationCommandOptionType } from './shared.ts';
|
||||
|
||||
export interface APIApplicationCommandChannelOption
|
||||
extends APIApplicationCommandOptionBase<ApplicationCommandOptionType.Channel> {
|
||||
channel_types?: Exclude<ChannelType, ChannelType.DM | ChannelType.GroupDM>[];
|
||||
channel_types?: Exclude<ChannelType, ChannelType.DM | ChannelType.GroupDM | ChannelType.GuildDirectory>[];
|
||||
}
|
||||
|
||||
export type APIApplicationCommandInteractionDataChannelOption = APIInteractionDataOptionBase<
|
||||
|
||||
@@ -47,19 +47,19 @@ import type {
|
||||
} from './_chatInput/user.ts';
|
||||
import type { APIBaseApplicationCommandInteractionData } from './internals.ts';
|
||||
|
||||
export * from './_chatInput/attachment.ts';
|
||||
export * from './_chatInput/base.ts';
|
||||
export * from './_chatInput/boolean.ts';
|
||||
export * from './_chatInput/channel.ts';
|
||||
export * from './_chatInput/integer.ts';
|
||||
export * from './_chatInput/mentionable.ts';
|
||||
export * from './_chatInput/number.ts';
|
||||
export * from './_chatInput/role.ts';
|
||||
export type * from './_chatInput/attachment.ts';
|
||||
export type * from './_chatInput/base.ts';
|
||||
export type * from './_chatInput/boolean.ts';
|
||||
export type * from './_chatInput/channel.ts';
|
||||
export type * from './_chatInput/integer.ts';
|
||||
export type * from './_chatInput/mentionable.ts';
|
||||
export type * from './_chatInput/number.ts';
|
||||
export type * from './_chatInput/role.ts';
|
||||
export * from './_chatInput/shared.ts';
|
||||
export * from './_chatInput/string.ts';
|
||||
export * from './_chatInput/subcommand.ts';
|
||||
export * from './_chatInput/subcommandGroup.ts';
|
||||
export * from './_chatInput/user.ts';
|
||||
export type * from './_chatInput/string.ts';
|
||||
export type * from './_chatInput/subcommand.ts';
|
||||
export type * from './_chatInput/subcommandGroup.ts';
|
||||
export type * from './_chatInput/user.ts';
|
||||
|
||||
/**
|
||||
* @see {@link https://discord.com/developers/docs/interactions/application-commands#application-command-object-application-command-option-structure}
|
||||
|
||||
@@ -23,10 +23,10 @@ import type { APIBaseInteraction } from './base.ts';
|
||||
import type { InteractionType } from './responses.ts';
|
||||
|
||||
export * from './_applicationCommands/chatInput.ts';
|
||||
export * from './_applicationCommands/contextMenu.ts';
|
||||
export type * from './_applicationCommands/contextMenu.ts';
|
||||
export * from './_applicationCommands/permissions.ts';
|
||||
export * from './_applicationCommands/entryPoint.ts';
|
||||
export * from './_applicationCommands/internals.ts';
|
||||
export type * from './_applicationCommands/entryPoint.ts';
|
||||
export type * from './_applicationCommands/internals.ts';
|
||||
|
||||
/**
|
||||
* @see {@link https://discord.com/developers/docs/interactions/application-commands#application-command-object}
|
||||
@@ -95,15 +95,19 @@ export interface APIApplicationCommand {
|
||||
*/
|
||||
default_permission?: boolean;
|
||||
/**
|
||||
* Indicates whether the command is age-restricted, defaults to `false`
|
||||
* Indicates whether the command is age-restricted
|
||||
*/
|
||||
nsfw?: boolean;
|
||||
/**
|
||||
* Installation context(s) where the command is available, only for globally-scoped commands. Defaults to `GUILD_INSTALL ([0])`
|
||||
* Installation context(s) where the command is available, only for globally-scoped commands
|
||||
*
|
||||
* @defaultValue `[ApplicationIntegrationType.GuildInstall]`
|
||||
*/
|
||||
integration_types?: ApplicationIntegrationType[];
|
||||
/**
|
||||
* Interaction context(s) where the command can be used, only for globally-scoped commands. By default, all interaction context types included for new commands `[0,1,2]`.
|
||||
* Interaction context(s) where the command can be used, only for globally-scoped commands
|
||||
*
|
||||
* @defaultValue `[InteractionContextType.Guild, InteractionContextType.BotDM, InteractionContextType.PrivateChannel]`
|
||||
*/
|
||||
contexts?: InteractionContextType[] | null;
|
||||
/**
|
||||
|
||||
15
deno/payloads/v9/_interactions/base.ts
generated
15
deno/payloads/v9/_interactions/base.ts
generated
@@ -9,7 +9,14 @@ import type {
|
||||
ChannelType,
|
||||
ThreadChannelType,
|
||||
} from '../channel.ts';
|
||||
import type { APIGuildMember, APIPartialInteractionGuild } from '../guild.ts';
|
||||
import type {
|
||||
APIBaseGuildMember,
|
||||
APIFlaggedGuildMember,
|
||||
APIGuildMember,
|
||||
APIGuildMemberAvatar,
|
||||
APIGuildMemberJoined,
|
||||
APIPartialInteractionGuild,
|
||||
} from '../guild.ts';
|
||||
import type { APIEntitlement } from '../monetization.ts';
|
||||
import type { APIUser } from '../user.ts';
|
||||
import type { InteractionType } from './responses.ts';
|
||||
@@ -256,7 +263,11 @@ export type APIInteractionDataResolvedChannel =
|
||||
/**
|
||||
* @see {@link https://discord.com/developers/docs/resources/guild#guild-member-object}
|
||||
*/
|
||||
export interface APIInteractionDataResolvedGuildMember extends Omit<APIGuildMember, 'deaf' | 'mute' | 'user'> {
|
||||
export interface APIInteractionDataResolvedGuildMember
|
||||
extends APIBaseGuildMember,
|
||||
APIFlaggedGuildMember,
|
||||
APIGuildMemberAvatar,
|
||||
APIGuildMemberJoined {
|
||||
permissions: Permissions;
|
||||
}
|
||||
|
||||
|
||||
5
deno/payloads/v9/_interactions/modalSubmit.ts
generated
5
deno/payloads/v9/_interactions/modalSubmit.ts
generated
@@ -1,4 +1,4 @@
|
||||
import type { APIActionRowComponent, APIComponentInModalActionRow } from '../channel.ts';
|
||||
import type { APIBaseComponent } from '../channel.ts';
|
||||
import type {
|
||||
APIBaseInteraction,
|
||||
APIDMInteractionWrapper,
|
||||
@@ -13,8 +13,7 @@ export interface ModalSubmitComponent {
|
||||
value: string;
|
||||
}
|
||||
|
||||
export interface ModalSubmitActionRowComponent
|
||||
extends Omit<APIActionRowComponent<APIComponentInModalActionRow>, 'components'> {
|
||||
export interface ModalSubmitActionRowComponent extends APIBaseComponent<ComponentType.ActionRow> {
|
||||
components: ModalSubmitComponent[];
|
||||
}
|
||||
|
||||
|
||||
10
deno/payloads/v9/application.ts
generated
10
deno/payloads/v9/application.ts
generated
@@ -111,9 +111,13 @@ export interface APIApplication {
|
||||
*/
|
||||
approximate_guild_count?: number;
|
||||
/**
|
||||
* Approximate count of users that have installed the app
|
||||
* Approximate count of users that have installed the app (authorized with `application.commands` as a scope)
|
||||
*/
|
||||
approximate_user_install_count?: number;
|
||||
/**
|
||||
* Approximate count of users that have OAuth2 authorizations for the app
|
||||
*/
|
||||
approximate_user_authorization_count?: number;
|
||||
/**
|
||||
* Array of redirect URIs for the application
|
||||
*/
|
||||
@@ -227,11 +231,11 @@ export enum ApplicationFlags {
|
||||
*/
|
||||
Embedded = 1 << 17,
|
||||
/**
|
||||
* Intent required for bots in 100 or more servers to receive {@link https://support-dev.discord.com/hc/en-us/articles/4404772028055 | message content}
|
||||
* Intent required for bots in 100 or more servers to receive {@link https://support-dev.discord.com/hc/articles/6207308062871 | message content}
|
||||
*/
|
||||
GatewayMessageContent = 1 << 18,
|
||||
/**
|
||||
* Intent required for bots in under 100 servers to receive {@link https://support-dev.discord.com/hc/en-us/articles/4404772028055 | message content},
|
||||
* Intent required for bots in under 100 servers to receive {@link https://support-dev.discord.com/hc/articles/6207308062871 | message content},
|
||||
* found in Bot Settings
|
||||
*/
|
||||
GatewayMessageContentLimited = 1 << 19,
|
||||
|
||||
6
deno/payloads/v9/auditLog.ts
generated
6
deno/payloads/v9/auditLog.ts
generated
@@ -207,6 +207,7 @@ export enum AuditLogEvent {
|
||||
AutoModerationBlockMessage,
|
||||
AutoModerationFlagToChannel,
|
||||
AutoModerationUserCommunicationDisabled,
|
||||
AutoModerationQuarantineUser,
|
||||
|
||||
CreatorMonetizationRequestCreated = 150,
|
||||
CreatorMonetizationTermsAccepted,
|
||||
@@ -232,6 +233,7 @@ export interface APIAuditLogOptions {
|
||||
* - AUTO_MODERATION_BLOCK_MESSAGE
|
||||
* - AUTO_MODERATION_FLAG_TO_CHANNEL
|
||||
* - AUTO_MODERATION_USER_COMMUNICATION_DISABLED
|
||||
* - AUTO_MODERATION_QUARANTINE_USER
|
||||
*/
|
||||
auto_moderation_rule_name?: string;
|
||||
/**
|
||||
@@ -241,6 +243,7 @@ export interface APIAuditLogOptions {
|
||||
* - AUTO_MODERATION_BLOCK_MESSAGE
|
||||
* - AUTO_MODERATION_FLAG_TO_CHANNEL
|
||||
* - AUTO_MODERATION_USER_COMMUNICATION_DISABLED
|
||||
* - AUTO_MODERATION_QUARANTINE_USER
|
||||
*/
|
||||
auto_moderation_rule_trigger_type?: AuditLogRuleTriggerType;
|
||||
/**
|
||||
@@ -272,6 +275,7 @@ export interface APIAuditLogOptions {
|
||||
* - AUTO_MODERATION_BLOCK_MESSAGE
|
||||
* - AUTO_MODERATION_FLAG_TO_CHANNEL
|
||||
* - AUTO_MODERATION_USER_COMMUNICATION_DISABLED
|
||||
* - AUTO_MODERATION_QUARANTINE_USER
|
||||
*/
|
||||
channel_id?: Snowflake;
|
||||
|
||||
@@ -325,7 +329,7 @@ export interface APIAuditLogOptions {
|
||||
* - CHANNEL_OVERWRITE_UPDATE
|
||||
* - CHANNEL_OVERWRITE_DELETE
|
||||
*
|
||||
* **Present only if the {@link APIAuditLogOptions.type | entry type} is "0"**
|
||||
* **Present only if the {@link APIAuditLogOptions."type" | entry type} is "0"**
|
||||
*/
|
||||
role_name?: string;
|
||||
|
||||
|
||||
550
deno/payloads/v9/channel.ts
generated
550
deno/payloads/v9/channel.ts
generated
File diff suppressed because it is too large
Load Diff
31
deno/payloads/v9/emoji.ts
generated
31
deno/payloads/v9/emoji.ts
generated
@@ -3,6 +3,7 @@
|
||||
*/
|
||||
|
||||
import type { Snowflake } from '../../globals.ts';
|
||||
import type { _NonNullableFields } from '../../utils/internals.ts';
|
||||
import type { APIRole } from './permissions.ts';
|
||||
import type { APIUser } from './user.ts';
|
||||
|
||||
@@ -49,3 +50,33 @@ export interface APIEmoji extends APIPartialEmoji {
|
||||
*/
|
||||
available?: boolean;
|
||||
}
|
||||
|
||||
/**
|
||||
* @see {@link https://discord.com/developers/docs/resources/emoji#emoji-object-applicationowned-emoji}
|
||||
*/
|
||||
export type APIApplicationEmoji = _NonNullableFields<Required<Pick<APIEmoji, 'animated' | 'id' | 'name' | 'user'>>> & {
|
||||
/**
|
||||
* Roles allowed to use this emoji.
|
||||
*
|
||||
* @remarks Always empty.
|
||||
*/
|
||||
roles: [];
|
||||
/**
|
||||
* Whether this emoji must be wrapped in colons.
|
||||
*
|
||||
* @remarks Always `true`.
|
||||
*/
|
||||
require_colons: true;
|
||||
/**
|
||||
* Whether this emoji is managed.
|
||||
*
|
||||
* @remarks Always `false`.
|
||||
*/
|
||||
managed: false;
|
||||
/**
|
||||
* Whether this emoji is available.
|
||||
*
|
||||
* @remarks Always `true`.
|
||||
*/
|
||||
available: true;
|
||||
};
|
||||
|
||||
18
deno/payloads/v9/gateway.ts
generated
18
deno/payloads/v9/gateway.ts
generated
@@ -60,9 +60,9 @@ export interface APIGatewaySessionStartLimit {
|
||||
}
|
||||
|
||||
/**
|
||||
* @see {@link https://discord.com/developers/docs/topics/gateway-events#presence-update-presence-update-event-fields}
|
||||
* @see {@link https://discord.com/developers/docs/topics/gateway-events#update-presence}
|
||||
*/
|
||||
export interface GatewayPresenceUpdate {
|
||||
export interface GatewayGuildMembersChunkPresence {
|
||||
/**
|
||||
* The user presence is being updated for
|
||||
*
|
||||
@@ -72,10 +72,6 @@ export interface GatewayPresenceUpdate {
|
||||
* @see {@link https://discord.com/developers/docs/resources/user#user-object}
|
||||
*/
|
||||
user: Partial<APIUser> & Pick<APIUser, 'id'>;
|
||||
/**
|
||||
* ID of the guild
|
||||
*/
|
||||
guild_id: Snowflake;
|
||||
/**
|
||||
* Either "idle", "dnd", "online", or "offline"
|
||||
*/
|
||||
@@ -94,6 +90,16 @@ export interface GatewayPresenceUpdate {
|
||||
client_status?: GatewayPresenceClientStatus;
|
||||
}
|
||||
|
||||
/**
|
||||
* @see {@link https://discord.com/developers/docs/topics/gateway-events#presence-update-presence-update-event-fields}
|
||||
*/
|
||||
export interface GatewayPresenceUpdate extends GatewayGuildMembersChunkPresence {
|
||||
/**
|
||||
* ID of the guild
|
||||
*/
|
||||
guild_id: Snowflake;
|
||||
}
|
||||
|
||||
/**
|
||||
* @see {@link https://discord.com/developers/docs/topics/gateway-events#update-presence-status-types}
|
||||
*/
|
||||
|
||||
155
deno/payloads/v9/guild.ts
generated
155
deno/payloads/v9/guild.ts
generated
@@ -11,14 +11,17 @@ import type { APIRole } from './permissions.ts';
|
||||
import type { APISticker } from './sticker.ts';
|
||||
import type { APIAvatarDecorationData, APIUser } from './user.ts';
|
||||
|
||||
/**
|
||||
* @see {@link https://discord.com/developers/docs/resources/guild#unavailable-guild-object}
|
||||
*/
|
||||
export interface APIUnavailableGuild {
|
||||
export interface APIBaseGuild {
|
||||
/**
|
||||
* Guild id
|
||||
*/
|
||||
id: Snowflake;
|
||||
}
|
||||
|
||||
/**
|
||||
* @see {@link https://discord.com/developers/docs/resources/guild#unavailable-guild-object}
|
||||
*/
|
||||
export interface APIUnavailableGuild extends APIBaseGuild {
|
||||
/**
|
||||
* `true` if this guild is unavailable due to an outage
|
||||
*/
|
||||
@@ -28,7 +31,7 @@ export interface APIUnavailableGuild {
|
||||
/**
|
||||
* @see {@link https://discord.com/developers/docs/resources/guild#guild-object-guild-structure}
|
||||
*/
|
||||
export interface APIPartialGuild extends Omit<APIUnavailableGuild, 'unavailable'>, Pick<APIGuild, 'welcome_screen'> {
|
||||
export interface APIPartialGuild extends APIBaseGuild {
|
||||
/**
|
||||
* Guild name (2-100 characters, excluding trailing and leading whitespace)
|
||||
*/
|
||||
@@ -71,8 +74,19 @@ export interface APIPartialGuild extends Omit<APIUnavailableGuild, 'unavailable'
|
||||
* The vanity url code for the guild
|
||||
*/
|
||||
vanity_url_code?: string | null;
|
||||
/**
|
||||
* The welcome screen of a Community guild, shown to new members
|
||||
*
|
||||
* Returned in the invite object
|
||||
*/
|
||||
welcome_screen?: APIGuildWelcomeScreen;
|
||||
}
|
||||
|
||||
/**
|
||||
* Source guild of channel follower webhooks.
|
||||
*/
|
||||
export type APIWebhookSourceGuild = Pick<APIPartialGuild, 'icon' | 'id' | 'name'>;
|
||||
|
||||
/**
|
||||
* @see {@link https://discord.com/developers/docs/resources/guild#guild-object-guild-structure}
|
||||
*/
|
||||
@@ -223,7 +237,7 @@ export interface APIGuild extends APIPartialGuild {
|
||||
*/
|
||||
premium_subscription_count?: number;
|
||||
/**
|
||||
* The preferred locale of a Community guild; used in guild discovery and notices from Discord; defaults to "en-US"
|
||||
* The preferred locale of a Community guild; used in guild discovery and notices from Discord
|
||||
*
|
||||
* @defaultValue `"en-US"`
|
||||
*/
|
||||
@@ -250,12 +264,6 @@ export interface APIGuild extends APIPartialGuild {
|
||||
* returned from the `GET /guilds/<id>` and `/users/@me/guilds` (OAuth2) endpoints when `with_counts` is `true`
|
||||
*/
|
||||
approximate_presence_count?: number;
|
||||
/**
|
||||
* The welcome screen of a Community guild, shown to new members
|
||||
*
|
||||
* Returned in the invite object
|
||||
*/
|
||||
welcome_screen?: APIGuildWelcomeScreen;
|
||||
/**
|
||||
* The nsfw level of the guild
|
||||
*
|
||||
@@ -291,7 +299,7 @@ export interface APIGuild extends APIPartialGuild {
|
||||
*/
|
||||
export interface APIPartialInteractionGuild extends Pick<APIGuild, 'features' | 'id'> {
|
||||
/**
|
||||
* The preferred locale of a Community guild; used in guild discovery and notices from Discord; defaults to "en-US"
|
||||
* The preferred locale of a Community guild; used in guild discovery and notices from Discord
|
||||
*
|
||||
* @unstable https://github.com/discord/discord-api-docs/issues/6938
|
||||
* @defaultValue `"en-US"`
|
||||
@@ -549,6 +557,14 @@ export enum GuildFeature {
|
||||
* Guild has enabled the welcome screen
|
||||
*/
|
||||
WelcomeScreenEnabled = 'WELCOME_SCREEN_ENABLED',
|
||||
/**
|
||||
* Guild has access to set guild tags
|
||||
*/
|
||||
GuildTags = 'GUILD_TAGS',
|
||||
/**
|
||||
* Guild is able to set gradient colors to roles
|
||||
*/
|
||||
EnhancedRoleColors = 'ENHANCED_ROLE_COLORS',
|
||||
}
|
||||
|
||||
/**
|
||||
@@ -628,55 +644,23 @@ export interface APIGuildWidgetSettings {
|
||||
/**
|
||||
* @see {@link https://discord.com/developers/docs/resources/guild#guild-member-object}
|
||||
*/
|
||||
export interface APIGuildMember {
|
||||
/**
|
||||
* The user this guild member represents
|
||||
*
|
||||
* **This field won't be included in the member object attached to `MESSAGE_CREATE` and `MESSAGE_UPDATE` gateway events.**
|
||||
*
|
||||
* @see {@link https://discord.com/developers/docs/resources/user#user-object}
|
||||
*/
|
||||
user: APIUser;
|
||||
export interface APIBaseGuildMember {
|
||||
/**
|
||||
* This users guild nickname
|
||||
*/
|
||||
nick?: string | null;
|
||||
/**
|
||||
* The member's guild avatar hash
|
||||
*/
|
||||
avatar?: string | null;
|
||||
/**
|
||||
* The member's guild banner hash
|
||||
*/
|
||||
banner?: string | null;
|
||||
/**
|
||||
* Array of role object ids
|
||||
*
|
||||
* @see {@link https://discord.com/developers/docs/topics/permissions#role-object}
|
||||
*/
|
||||
roles: Snowflake[];
|
||||
/**
|
||||
* When the user joined the guild
|
||||
*/
|
||||
joined_at: string;
|
||||
/**
|
||||
* When the user started boosting the guild
|
||||
*
|
||||
* @see {@link https://support.discord.com/hc/articles/360028038352}
|
||||
*/
|
||||
premium_since?: string | null;
|
||||
/**
|
||||
* Whether the user is deafened in voice channels
|
||||
*/
|
||||
deaf: boolean;
|
||||
/**
|
||||
* Whether the user is muted in voice channels
|
||||
*/
|
||||
mute: boolean;
|
||||
/**
|
||||
* Guild member flags represented as a bit set, defaults to `0`
|
||||
*/
|
||||
flags: GuildMemberFlags;
|
||||
/**
|
||||
* Whether the user has not yet passed the guild's Membership Screening requirements
|
||||
*
|
||||
@@ -695,6 +679,81 @@ export interface APIGuildMember {
|
||||
avatar_decoration_data?: APIAvatarDecorationData | null;
|
||||
}
|
||||
|
||||
/**
|
||||
* @see {@link https://discord.com/developers/docs/resources/guild#guild-member-object}
|
||||
*/
|
||||
export interface APIFlaggedGuildMember {
|
||||
/**
|
||||
* Guild member flags represented as a bit set
|
||||
*
|
||||
* @defaultValue `0`
|
||||
*/
|
||||
flags: GuildMemberFlags;
|
||||
}
|
||||
|
||||
/**
|
||||
* @see {@link https://discord.com/developers/docs/resources/guild#guild-member-object}
|
||||
*/
|
||||
export interface APIGuildMemberJoined {
|
||||
/**
|
||||
* When the user joined the guild
|
||||
*/
|
||||
joined_at: string;
|
||||
}
|
||||
|
||||
/**
|
||||
* @see {@link https://discord.com/developers/docs/resources/guild#guild-member-object}
|
||||
*/
|
||||
export interface APIGuildMemberAvatar {
|
||||
/**
|
||||
* The member's guild avatar hash
|
||||
*/
|
||||
avatar?: string | null;
|
||||
/**
|
||||
* The member's guild banner hash
|
||||
*/
|
||||
banner?: string | null;
|
||||
}
|
||||
|
||||
/**
|
||||
* @see {@link https://discord.com/developers/docs/resources/guild#guild-member-object}
|
||||
*/
|
||||
export interface APIBaseVoiceGuildMember {
|
||||
/**
|
||||
* Whether the user is deafened in voice channels
|
||||
*/
|
||||
deaf: boolean;
|
||||
/**
|
||||
* Whether the user is muted in voice channels
|
||||
*/
|
||||
mute: boolean;
|
||||
}
|
||||
|
||||
/**
|
||||
* @see {@link https://discord.com/developers/docs/resources/guild#guild-member-object}
|
||||
*/
|
||||
export interface APIGuildMemberUser {
|
||||
/**
|
||||
* The user this guild member represents
|
||||
*
|
||||
* **This field won't be included in the member object attached to `MESSAGE_CREATE` and `MESSAGE_UPDATE` gateway events.**
|
||||
*
|
||||
* @see {@link https://discord.com/developers/docs/resources/user#user-object}
|
||||
*/
|
||||
user: APIUser;
|
||||
}
|
||||
|
||||
/**
|
||||
* @see {@link https://discord.com/developers/docs/resources/guild#guild-member-object}
|
||||
*/
|
||||
export interface APIGuildMember
|
||||
extends APIBaseGuildMember,
|
||||
APIBaseVoiceGuildMember,
|
||||
APIFlaggedGuildMember,
|
||||
APIGuildMemberAvatar,
|
||||
APIGuildMemberJoined,
|
||||
APIGuildMemberUser {}
|
||||
|
||||
/**
|
||||
* @see {@link https://discord.com/developers/docs/resources/guild#guild-member-object-guild-member-flags}
|
||||
*/
|
||||
@@ -740,6 +799,10 @@ export enum GuildMemberFlags {
|
||||
* Member has dismissed the DM settings upsell
|
||||
*/
|
||||
DmSettingsUpsellAcknowledged = 1 << 9,
|
||||
/**
|
||||
* Member's guild tag is blocked by AutoMod
|
||||
*/
|
||||
AutoModQuarantinedGuildTag = 1 << 10,
|
||||
}
|
||||
|
||||
/**
|
||||
|
||||
10
deno/payloads/v9/interactions.ts
generated
10
deno/payloads/v9/interactions.ts
generated
@@ -21,11 +21,11 @@ import type {
|
||||
import type { APIPingInteraction } from './_interactions/ping.ts';
|
||||
|
||||
export * from './_interactions/applicationCommands.ts';
|
||||
export * from './_interactions/autocomplete.ts';
|
||||
export * from './_interactions/base.ts';
|
||||
export * from './_interactions/messageComponents.ts';
|
||||
export * from './_interactions/modalSubmit.ts';
|
||||
export * from './_interactions/ping.ts';
|
||||
export type * from './_interactions/autocomplete.ts';
|
||||
export type * from './_interactions/base.ts';
|
||||
export type * from './_interactions/messageComponents.ts';
|
||||
export type * from './_interactions/modalSubmit.ts';
|
||||
export type * from './_interactions/ping.ts';
|
||||
export * from './_interactions/responses.ts';
|
||||
|
||||
/**
|
||||
|
||||
4
deno/payloads/v9/invite.ts
generated
4
deno/payloads/v9/invite.ts
generated
@@ -3,7 +3,7 @@
|
||||
*/
|
||||
|
||||
import type { APIApplication } from './application.ts';
|
||||
import type { APIPartialChannel } from './channel.ts';
|
||||
import type { APIInviteChannel } from './channel.ts';
|
||||
import type { APIGuild } from './guild.ts';
|
||||
import type { APIGuildScheduledEvent } from './guildScheduledEvent.ts';
|
||||
import type { APIInviteStageInstance } from './stageInstance.ts';
|
||||
@@ -43,7 +43,7 @@ export interface APIInvite {
|
||||
*
|
||||
* @see {@link https://discord.com/developers/docs/resources/channel#channel-object}
|
||||
*/
|
||||
channel: Required<APIPartialChannel> | null;
|
||||
channel: APIInviteChannel | null;
|
||||
/**
|
||||
* The user who created the invite
|
||||
*
|
||||
|
||||
8
deno/payloads/v9/mod.ts
generated
8
deno/payloads/v9/mod.ts
generated
@@ -3,7 +3,7 @@ export * from './application.ts';
|
||||
export * from './auditLog.ts';
|
||||
export * from './autoModeration.ts';
|
||||
export * from './channel.ts';
|
||||
export * from './emoji.ts';
|
||||
export type * from './emoji.ts';
|
||||
export * from './gateway.ts';
|
||||
export * from './guild.ts';
|
||||
export * from './guildScheduledEvent.ts';
|
||||
@@ -13,11 +13,11 @@ export * from './monetization.ts';
|
||||
export * from './oauth2.ts';
|
||||
export * from './permissions.ts';
|
||||
export * from './poll.ts';
|
||||
export * from './soundboard.ts';
|
||||
export type * from './soundboard.ts';
|
||||
export * from './stageInstance.ts';
|
||||
export * from './sticker.ts';
|
||||
export * from './teams.ts';
|
||||
export * from './template.ts';
|
||||
export type * from './template.ts';
|
||||
export * from './user.ts';
|
||||
export * from './voice.ts';
|
||||
export type * from './voice.ts';
|
||||
export * from './webhook.ts';
|
||||
|
||||
26
deno/payloads/v9/permissions.ts
generated
26
deno/payloads/v9/permissions.ts
generated
@@ -18,8 +18,14 @@ export interface APIRole {
|
||||
name: string;
|
||||
/**
|
||||
* Integer representation of hexadecimal color code
|
||||
*
|
||||
* @remarks `color` will still be returned by the API, but using the `colors` field is recommended when doing requests.
|
||||
*/
|
||||
color: number;
|
||||
/**
|
||||
* The role's colors
|
||||
*/
|
||||
colors?: APIRoleColors;
|
||||
/**
|
||||
* If this role is pinned in the user listing
|
||||
*/
|
||||
@@ -99,3 +105,23 @@ export enum RoleFlags {
|
||||
*/
|
||||
InPrompt = 1 << 0,
|
||||
}
|
||||
|
||||
/**
|
||||
* @see {@link https://discord.com/developers/docs/topics/permissions#role-colors-object}
|
||||
*/
|
||||
export interface APIRoleColors {
|
||||
/**
|
||||
* The primary color for the role
|
||||
*/
|
||||
primary_color: number;
|
||||
/**
|
||||
* The secondary color for the role, this will make the role a gradient between the other provided colors
|
||||
*/
|
||||
secondary_color: number | null;
|
||||
/**
|
||||
* The tertiary color for the role, this will turn the gradient into a holographic style
|
||||
*
|
||||
* @remarks When sending `tertiary_color` the API enforces the role color to be a holographic style with values of `primary_color = 11127295`, `secondary_color = 16759788`, and `tertiary_color = 16761760`.
|
||||
*/
|
||||
tertiary_color: number | null;
|
||||
}
|
||||
|
||||
49
deno/payloads/v9/poll.ts
generated
49
deno/payloads/v9/poll.ts
generated
@@ -4,22 +4,14 @@
|
||||
|
||||
import type { APIPartialEmoji } from './emoji.ts';
|
||||
|
||||
/**
|
||||
* @see {@link https://discord.com/developers/docs/resources/poll#poll-object-poll-object-structure}
|
||||
*/
|
||||
export interface APIPoll {
|
||||
export interface APIBasePoll {
|
||||
/**
|
||||
* The question of the poll
|
||||
*/
|
||||
question: APIPollMedia;
|
||||
/**
|
||||
* Each of the answers available in the poll, up to 10
|
||||
*/
|
||||
answers: APIPollAnswer[];
|
||||
/**
|
||||
* The time when the poll ends (IS08601 timestamp)
|
||||
*/
|
||||
expiry: string;
|
||||
}
|
||||
|
||||
export interface APIPollDefaults {
|
||||
/**
|
||||
* Whether a user can select multiple answers
|
||||
*
|
||||
@@ -32,6 +24,20 @@ export interface APIPoll {
|
||||
* @defaultValue `PollLayoutType.Default`
|
||||
*/
|
||||
layout_type: PollLayoutType;
|
||||
}
|
||||
|
||||
/**
|
||||
* @see {@link https://discord.com/developers/docs/resources/poll#poll-object-poll-object-structure}
|
||||
*/
|
||||
export interface APIPoll extends APIBasePoll, APIPollDefaults {
|
||||
/**
|
||||
* Each of the answers available in the poll, up to 10
|
||||
*/
|
||||
answers: APIPollAnswer[];
|
||||
/**
|
||||
* The time when the poll ends (IS08601 timestamp)
|
||||
*/
|
||||
expiry: string;
|
||||
/**
|
||||
* The results of the poll
|
||||
*/
|
||||
@@ -64,20 +70,23 @@ export interface APIPollMedia {
|
||||
emoji?: APIPartialEmoji;
|
||||
}
|
||||
|
||||
/**
|
||||
* @see {@link https://discord.com/developers/docs/resources/poll#poll-answer-object-poll-answer-object-structure}
|
||||
*/
|
||||
export interface APIPollAnswer {
|
||||
/**
|
||||
* The ID of the answer. Starts at `1` for the first answer and goes up sequentially
|
||||
*/
|
||||
answer_id: number;
|
||||
export interface APIBasePollAnswer {
|
||||
/**
|
||||
* The data of the answer
|
||||
*/
|
||||
poll_media: APIPollMedia;
|
||||
}
|
||||
|
||||
/**
|
||||
* @see {@link https://discord.com/developers/docs/resources/poll#poll-answer-object-poll-answer-object-structure}
|
||||
*/
|
||||
export interface APIPollAnswer extends APIBasePollAnswer {
|
||||
/**
|
||||
* The ID of the answer. Starts at `1` for the first answer and goes up sequentially
|
||||
*/
|
||||
answer_id: number;
|
||||
}
|
||||
|
||||
/**
|
||||
* @see {@link https://discord.com/developers/docs/resources/poll#poll-results-object-poll-results-object-structure}
|
||||
*/
|
||||
|
||||
90
deno/payloads/v9/user.ts
generated
90
deno/payloads/v9/user.ts
generated
@@ -96,6 +96,18 @@ export interface APIUser {
|
||||
* @see {@link https://discord.com/developers/docs/resources/user#avatar-decoration-data-object}
|
||||
*/
|
||||
avatar_decoration_data?: APIAvatarDecorationData | null;
|
||||
/**
|
||||
* The data for the user's collectibles
|
||||
*
|
||||
* @see {@link https://discord.com/developers/docs/resources/user#collectibles}
|
||||
*/
|
||||
collectibles?: APICollectibles | null;
|
||||
/**
|
||||
* The user's primary guild
|
||||
*
|
||||
* @see {@link https://discord.com/developers/docs/resources/user#user-object-user-primary-guild}
|
||||
*/
|
||||
primary_guild?: APIUserPrimaryGuild | null;
|
||||
}
|
||||
|
||||
/**
|
||||
@@ -348,3 +360,81 @@ export interface APIAvatarDecorationData {
|
||||
*/
|
||||
sku_id: Snowflake;
|
||||
}
|
||||
|
||||
/**
|
||||
* The collectibles the user has, excluding Avatar Decorations and Profile Effects.
|
||||
*
|
||||
* @see {@link https://discord.com/developers/docs/resources/user#collectibles}
|
||||
*/
|
||||
export interface APICollectibles {
|
||||
/**
|
||||
* Object mapping of {@link APINameplateData}
|
||||
*/
|
||||
nameplate?: APINameplateData;
|
||||
}
|
||||
|
||||
/**
|
||||
* @see {@link https://discord.com/developers/docs/resources/user#nameplate}
|
||||
*/
|
||||
export interface APINameplateData {
|
||||
/**
|
||||
* ID of the nameplate SKU
|
||||
*/
|
||||
sku_id: Snowflake;
|
||||
/**
|
||||
* Path to the nameplate asset
|
||||
*
|
||||
* @example `nameplates/nameplates/twilight/`
|
||||
*/
|
||||
asset: string;
|
||||
/**
|
||||
* The label of this nameplate. Currently unused
|
||||
*/
|
||||
label: string;
|
||||
/**
|
||||
* Background color of the nameplate
|
||||
*/
|
||||
palette: NameplatePalette;
|
||||
}
|
||||
|
||||
/**
|
||||
* Background color of a nameplate.
|
||||
*/
|
||||
export enum NameplatePalette {
|
||||
Berry = 'berry',
|
||||
BubbleGum = 'bubble_gum',
|
||||
Clover = 'clover',
|
||||
Cobalt = 'cobalt',
|
||||
Crimson = 'crimson',
|
||||
Forest = 'forest',
|
||||
Lemon = 'lemon',
|
||||
Sky = 'sky',
|
||||
Teal = 'teal',
|
||||
Violet = 'violet',
|
||||
White = 'white',
|
||||
}
|
||||
|
||||
/**
|
||||
* @see {@link https://discord.com/developers/docs/resources/user#user-object-user-primary-guild}
|
||||
*/
|
||||
export interface APIUserPrimaryGuild {
|
||||
/**
|
||||
* The id of the user's primary guild
|
||||
*/
|
||||
identity_guild_id: Snowflake | null;
|
||||
/**
|
||||
* Whether the user is displaying the primary guild's server tag.
|
||||
* This can be `null` if the system clears the identity, e.g. because the server no longer supports tags
|
||||
*/
|
||||
identity_enabled: boolean | null;
|
||||
/**
|
||||
* The text of the user's server tag. Limited to 4 characters
|
||||
*/
|
||||
tag: string | null;
|
||||
/**
|
||||
* The server tag badge hash
|
||||
*
|
||||
* @see {@link https://discord.com/developers/docs/reference#image-formatting}
|
||||
*/
|
||||
badge: string | null;
|
||||
}
|
||||
|
||||
19
deno/payloads/v9/voice.ts
generated
19
deno/payloads/v9/voice.ts
generated
@@ -11,14 +11,7 @@ import type { APIGuildMember } from './guild.ts';
|
||||
*/
|
||||
export type GatewayVoiceState = APIVoiceState;
|
||||
|
||||
/**
|
||||
* @see {@link https://discord.com/developers/docs/resources/voice#voice-state-object}
|
||||
*/
|
||||
export interface APIVoiceState {
|
||||
/**
|
||||
* The guild id this voice state is for
|
||||
*/
|
||||
guild_id?: Snowflake;
|
||||
export interface APIBaseVoiceState {
|
||||
/**
|
||||
* The channel id this user is connected to
|
||||
*/
|
||||
@@ -71,6 +64,16 @@ export interface APIVoiceState {
|
||||
request_to_speak_timestamp: string | null;
|
||||
}
|
||||
|
||||
/**
|
||||
* @see {@link https://discord.com/developers/docs/resources/voice#voice-state-object}
|
||||
*/
|
||||
export interface APIVoiceState extends APIBaseVoiceState {
|
||||
/**
|
||||
* The guild id this voice state is for
|
||||
*/
|
||||
guild_id?: Snowflake;
|
||||
}
|
||||
|
||||
/**
|
||||
* @see {@link https://discord.com/developers/docs/resources/voice#voice-region-object}
|
||||
*/
|
||||
|
||||
23
deno/payloads/v9/webhook.ts
generated
23
deno/payloads/v9/webhook.ts
generated
@@ -6,11 +6,11 @@ import type { Snowflake } from '../../globals.ts';
|
||||
import type {
|
||||
APIEntitlement,
|
||||
APIGuild,
|
||||
APIPartialChannel,
|
||||
APIPartialGuild,
|
||||
APIUser,
|
||||
APIWebhookSourceGuild,
|
||||
ApplicationIntegrationType,
|
||||
OAuth2Scopes,
|
||||
APIWebhookSourceChannel,
|
||||
} from './mod.ts';
|
||||
|
||||
/**
|
||||
@@ -60,11 +60,11 @@ export interface APIWebhook {
|
||||
/**
|
||||
* The guild of the channel that this webhook is following (returned for Channel Follower Webhooks)
|
||||
*/
|
||||
source_guild?: APIPartialGuild;
|
||||
source_guild?: APIWebhookSourceGuild;
|
||||
/**
|
||||
* The channel that this webhook is following (returned for Channel Follower Webhooks)
|
||||
*/
|
||||
source_channel?: APIPartialChannel;
|
||||
source_channel?: APIWebhookSourceChannel;
|
||||
/**
|
||||
* The url used for executing the webhook (returned by the webhooks OAuth2 flow)
|
||||
*/
|
||||
@@ -86,6 +86,10 @@ export type APIWebhookEventBody =
|
||||
ApplicationWebhookEventType.ApplicationAuthorized,
|
||||
APIWebhookEventApplicationAuthorizedData
|
||||
>
|
||||
| APIWebhookEventEventBase<
|
||||
ApplicationWebhookEventType.ApplicationDeauthorized,
|
||||
APIWebhookEventApplicationDeauthorizedData
|
||||
>
|
||||
| APIWebhookEventEventBase<ApplicationWebhookEventType.EntitlementCreate, APIWebhookEventEntitlementCreateData>
|
||||
| APIWebhookEventEventBase<ApplicationWebhookEventType.QuestUserEnrollment, APIWebhookEventQuestUserEnrollmentData>;
|
||||
|
||||
@@ -108,6 +112,13 @@ export interface APIWebhookEventApplicationAuthorizedData {
|
||||
guild?: APIGuild;
|
||||
}
|
||||
|
||||
export interface APIWebhookEventApplicationDeauthorizedData {
|
||||
/**
|
||||
* User who deauthorized the app
|
||||
*/
|
||||
user: APIUser;
|
||||
}
|
||||
|
||||
export type APIWebhookEventEntitlementCreateData = APIEntitlement;
|
||||
|
||||
export type APIWebhookEventQuestUserEnrollmentData = never;
|
||||
@@ -168,6 +179,10 @@ export enum ApplicationWebhookEventType {
|
||||
* Sent when an app was authorized by a user to a server or their account
|
||||
*/
|
||||
ApplicationAuthorized = 'APPLICATION_AUTHORIZED',
|
||||
/**
|
||||
* Sent when an app was deauthorized by a user
|
||||
*/
|
||||
ApplicationDeauthorized = 'APPLICATION_DEAUTHORIZED',
|
||||
/**
|
||||
* Entitlement was created
|
||||
*/
|
||||
|
||||
64
deno/rest/v10/channel.ts
generated
64
deno/rest/v10/channel.ts
generated
@@ -24,6 +24,7 @@ import type {
|
||||
ChannelFlags,
|
||||
APIAttachment,
|
||||
APIMessageTopLevelComponent,
|
||||
APIMessagePin,
|
||||
} from '../../payloads/v10/mod.ts';
|
||||
import type { _AddUndefinedToPossiblyUndefinedPropertiesOfInterface, _StrictPartial } from '../../utils/internals.ts';
|
||||
import type { RESTAPIPoll } from './poll.ts';
|
||||
@@ -308,7 +309,7 @@ export interface RESTPostAPIChannelMessageJSONBody {
|
||||
/**
|
||||
* The components to include with the message
|
||||
*
|
||||
* @see {@link https://discord.com/developers/docs/interactions/message-components#component-object}
|
||||
* @see {@link https://discord.com/developers/docs/components/reference}
|
||||
*/
|
||||
components?: APIMessageTopLevelComponent[] | undefined;
|
||||
/**
|
||||
@@ -461,7 +462,7 @@ export interface RESTPatchAPIChannelMessageJSONBody {
|
||||
/**
|
||||
* The components to include with the message
|
||||
*
|
||||
* @see {@link https://discord.com/developers/docs/interactions/message-components#component-object}
|
||||
* @see {@link https://discord.com/developers/docs/components/reference}
|
||||
*/
|
||||
components?: APIMessageTopLevelComponent[] | null | undefined;
|
||||
}
|
||||
@@ -617,17 +618,60 @@ export type RESTPostAPIChannelFollowersResult = APIFollowedChannel;
|
||||
export type RESTPostAPIChannelTypingResult = never;
|
||||
|
||||
/**
|
||||
* @see {@link https://discord.com/developers/docs/resources/channel#get-pinned-messages}
|
||||
* @see {@link https://discord.com/developers/docs/resources/message#get-channel-pins}
|
||||
*/
|
||||
export interface RESTGetAPIChannelMessagesPinsQuery {
|
||||
/**
|
||||
* Get messages pinned before this timestamp
|
||||
*/
|
||||
before?: string;
|
||||
/**
|
||||
* Maximum number of pins to return (1-50).
|
||||
*
|
||||
* @defaultValue `50`
|
||||
*/
|
||||
limit?: number;
|
||||
}
|
||||
|
||||
/**
|
||||
* @see {@link https://discord.com/developers/docs/resources/message#get-channel-pins}
|
||||
*/
|
||||
export interface RESTGetAPIChannelMessagesPinsResult {
|
||||
/**
|
||||
* Array of pinned messages
|
||||
*/
|
||||
items: APIMessagePin[];
|
||||
/**
|
||||
* Whether there are more items available
|
||||
*/
|
||||
has_more: boolean;
|
||||
}
|
||||
|
||||
/**
|
||||
* @see {@link https://discord.com/developers/docs/resources/message#pin-message}
|
||||
*/
|
||||
export type RESTPutAPIChannelMessagesPinResult = never;
|
||||
|
||||
/**
|
||||
* @see {@link https://discord.com/developers/docs/resources/message#unpin-message}
|
||||
*/
|
||||
export type RESTDeleteAPIChannelMessagesPinResult = never;
|
||||
|
||||
/**
|
||||
* @see {@link https://discord.com/developers/docs/resources/message#get-pinned-messages-deprecated}
|
||||
* @deprecated
|
||||
*/
|
||||
export type RESTGetAPIChannelPinsResult = APIMessage[];
|
||||
|
||||
/**
|
||||
* @see {@link https://discord.com/developers/docs/resources/channel#pin-message}
|
||||
* @see {@link https://discord.com/developers/docs/resources/message#pin-message-deprecated}
|
||||
* @deprecated
|
||||
*/
|
||||
export type RESTPutAPIChannelPinResult = never;
|
||||
|
||||
/**
|
||||
* @see {@link https://discord.com/developers/docs/resources/channel#unpin-message}
|
||||
* @see {@link https://discord.com/developers/docs/resources/message#unpin-message-deprecated}
|
||||
* @deprecated
|
||||
*/
|
||||
export type RESTDeleteAPIChannelPinResult = never;
|
||||
|
||||
@@ -709,11 +753,9 @@ export interface RESTPostAPIChannelThreadsJSONBody extends RESTPostAPIChannelMes
|
||||
/**
|
||||
* The type of thread to create
|
||||
*
|
||||
* In API v9 and v10, `type` defaults to `PRIVATE_THREAD`.
|
||||
* In a future API version this will be changed to be a required field, with no default.
|
||||
*
|
||||
* @see {@link https://discord.com/developers/docs/resources/channel#channel-object-channel-types}
|
||||
* @defaultValue `ChannelType.PrivateThread`
|
||||
* @defaultValue `ChannelType.PrivateThread` in API v9 and v10.
|
||||
* In a future API version this will be changed to be a required field, with no default.
|
||||
*/
|
||||
type?: ThreadChannelType | undefined;
|
||||
/**
|
||||
@@ -765,7 +807,9 @@ export interface RESTGetAPIChannelThreadMembersQuery {
|
||||
*/
|
||||
after?: Snowflake;
|
||||
/**
|
||||
* Max number of thread members to return (1-100). Defaults to 100
|
||||
* Max number of thread members to return (1-100)
|
||||
*
|
||||
* @defaultValue `100`
|
||||
*/
|
||||
limit?: number;
|
||||
}
|
||||
|
||||
10
deno/rest/v10/emoji.ts
generated
10
deno/rest/v10/emoji.ts
generated
@@ -1,5 +1,5 @@
|
||||
import type { Snowflake } from '../../globals.ts';
|
||||
import type { APIEmoji } from '../../payloads/v10/mod.ts';
|
||||
import type { APIApplicationEmoji, APIEmoji } from '../../payloads/v10/mod.ts';
|
||||
|
||||
/**
|
||||
* @see {@link https://discord.com/developers/docs/resources/emoji#list-guild-emojis}
|
||||
@@ -64,13 +64,13 @@ export type RESTDeleteAPIGuildEmojiResult = never;
|
||||
* @see {@link https://discord.com/developers/docs/resources/emoji#list-application-emojis}
|
||||
*/
|
||||
export interface RESTGetAPIApplicationEmojisResult {
|
||||
items: APIEmoji[];
|
||||
items: APIApplicationEmoji[];
|
||||
}
|
||||
|
||||
/**
|
||||
* @see {@link https://discord.com/developers/docs/resources/emoji#get-application-emoji}
|
||||
*/
|
||||
export type RESTGetAPIApplicationEmojiResult = APIEmoji;
|
||||
export type RESTGetAPIApplicationEmojiResult = APIApplicationEmoji;
|
||||
|
||||
/**
|
||||
* @see {@link https://discord.com/developers/docs/resources/emoji#create-application-emoji-json-params}
|
||||
@@ -80,7 +80,7 @@ export type RESTPostAPIApplicationEmojiJSONBody = Pick<RESTPostAPIGuildEmojiJSON
|
||||
/**
|
||||
* @see {@link https://discord.com/developers/docs/resources/emoji#create-application-emoji}
|
||||
*/
|
||||
export type RESTPostAPIApplicationEmojiResult = APIEmoji;
|
||||
export type RESTPostAPIApplicationEmojiResult = APIApplicationEmoji;
|
||||
|
||||
/**
|
||||
* @see {@link https://discord.com/developers/docs/resources/emoji#modify-application-emoji}
|
||||
@@ -90,7 +90,7 @@ export type RESTPatchAPIApplicationEmojiJSONBody = Pick<RESTPatchAPIGuildEmojiJS
|
||||
/**
|
||||
* @see {@link https://discord.com/developers/docs/resources/emoji#modify-application-emoji}
|
||||
*/
|
||||
export type RESTPatchAPIApplicationEmojiResult = APIEmoji;
|
||||
export type RESTPatchAPIApplicationEmojiResult = APIApplicationEmoji;
|
||||
|
||||
/**
|
||||
* @see {@link https://discord.com/developers/docs/resources/emoji#delete-application-emoji}
|
||||
|
||||
87
deno/rest/v10/guild.ts
generated
87
deno/rest/v10/guild.ts
generated
@@ -26,6 +26,7 @@ import type {
|
||||
GuildWidgetStyle,
|
||||
APIGuildOnboardingPrompt,
|
||||
APIGuildOnboardingPromptOption,
|
||||
APIRoleColors,
|
||||
} from '../../payloads/v10/mod.ts';
|
||||
import type {
|
||||
_AddUndefinedToPossiblyUndefinedPropertiesOfInterface,
|
||||
@@ -96,7 +97,8 @@ export interface RESTAPIGuildCreateRole extends RESTPostAPIGuildRoleJSONBody {
|
||||
export type APIGuildCreateRole = RESTAPIGuildCreateRole;
|
||||
|
||||
/**
|
||||
* @see {@link https://discord.com/developers/docs/resources/guild#create-guild}
|
||||
* @see {@link https://discord.com/developers/docs/change-log#guild-create-deprecation}
|
||||
* @deprecated
|
||||
*/
|
||||
export interface RESTPostAPIGuildsJSONBody {
|
||||
/**
|
||||
@@ -184,12 +186,14 @@ export interface RESTPostAPIGuildsJSONBody {
|
||||
}
|
||||
|
||||
/**
|
||||
* @see {@link https://discord.com/developers/docs/resources/guild#create-guild}
|
||||
* @see {@link https://discord.com/developers/docs/change-log#guild-create-deprecation}
|
||||
* @deprecated
|
||||
*/
|
||||
export type RESTPostAPIGuildsResult = APIGuild;
|
||||
|
||||
/**
|
||||
* @see {@link https://discord.com/developers/docs/resources/guild#modify-guild-mfa-level}
|
||||
* @see {@link https://discord.com/developers/docs/change-log#guild-create-deprecation}
|
||||
* @deprecated
|
||||
*/
|
||||
export interface RESTPostAPIGuildsMFAJSONBody {
|
||||
/**
|
||||
@@ -201,7 +205,8 @@ export interface RESTPostAPIGuildsMFAJSONBody {
|
||||
}
|
||||
|
||||
/**
|
||||
* @see {@link https://discord.com/developers/docs/resources/guild#modify-guild-mfa-level}
|
||||
* @see {@link https://discord.com/developers/docs/change-log#guild-create-deprecation}
|
||||
* @deprecated
|
||||
*/
|
||||
export type RESTPostAPIGuildsMFAResult = RESTPostAPIGuildsMFAJSONBody;
|
||||
|
||||
@@ -275,6 +280,8 @@ export interface RESTPatchAPIGuildJSONBody {
|
||||
icon?: string | null | undefined;
|
||||
/**
|
||||
* User id to transfer guild ownership to (must be owner)
|
||||
*
|
||||
* @deprecated
|
||||
*/
|
||||
owner_id?: Snowflake | undefined;
|
||||
/**
|
||||
@@ -310,7 +317,7 @@ export interface RESTPatchAPIGuildJSONBody {
|
||||
*/
|
||||
public_updates_channel_id?: Snowflake | null | undefined;
|
||||
/**
|
||||
* The preferred locale of a Community guild used in server discovery and notices from Discord; defaults to "en-US"
|
||||
* The preferred locale of a Community guild used in server discovery and notices from Discord
|
||||
*
|
||||
* @defaultValue `"en-US"` (if the value is set to `null`)
|
||||
*/
|
||||
@@ -341,7 +348,8 @@ export interface RESTPatchAPIGuildJSONBody {
|
||||
export type RESTPatchAPIGuildResult = APIGuild;
|
||||
|
||||
/**
|
||||
* @see {@link https://discord.com/developers/docs/resources/guild#delete-guild}
|
||||
* @see {@link https://discord.com/developers/docs/change-log#guild-create-deprecation}
|
||||
* @deprecated
|
||||
*/
|
||||
export type RESTDeleteAPIGuildResult = never;
|
||||
|
||||
@@ -676,8 +684,15 @@ export interface RESTPostAPIGuildRoleJSONBody {
|
||||
* RGB color value
|
||||
*
|
||||
* @defaultValue `0`
|
||||
* @remarks `color` will still be returned by the API, but using the `colors` field is recommended when doing requests.
|
||||
*/
|
||||
color?: number | null | undefined;
|
||||
/**
|
||||
* The role's colors
|
||||
*
|
||||
* @defaultValue `{ "primary_color": 0, "secondary_color": null, "tertiary_color": null }`
|
||||
*/
|
||||
colors?: APIRoleColors | undefined;
|
||||
/**
|
||||
* Whether the role should be displayed separately in the sidebar
|
||||
*
|
||||
@@ -738,8 +753,14 @@ export interface RESTPatchAPIGuildRoleJSONBody {
|
||||
permissions?: Permissions | null | undefined;
|
||||
/**
|
||||
* RGB color value
|
||||
*
|
||||
* @remarks `color` will still be returned by the API, but using the `colors` field is recommended when doing requests.
|
||||
*/
|
||||
color?: number | null | undefined;
|
||||
/**
|
||||
* The role's colors
|
||||
*/
|
||||
colors?: APIRoleColors | undefined;
|
||||
/**
|
||||
* Whether the role should be displayed separately in the sidebar
|
||||
*/
|
||||
@@ -952,38 +973,40 @@ export type RESTPutAPIGuildOnboardingJSONBody = _AddUndefinedToPossiblyUndefined
|
||||
prompts?: RESTAPIGuildOnboardingPrompt[] | undefined;
|
||||
};
|
||||
|
||||
export type RESTAPIGuildOnboardingPrompt = _AddUndefinedToPossiblyUndefinedPropertiesOfInterface<
|
||||
Partial<Omit<APIGuildOnboardingPrompt, 'guild_id' | 'id' | 'options' | 'title'>>
|
||||
> &
|
||||
Pick<APIGuildOnboardingPrompt, 'id' | 'title'> & {
|
||||
/**
|
||||
* Options available within the prompt
|
||||
*/
|
||||
options: RESTAPIGuildOnboardingPromptOption[];
|
||||
};
|
||||
export interface RESTAPIGuildOnboardingPrompt
|
||||
extends _AddUndefinedToPossiblyUndefinedPropertiesOfInterface<
|
||||
Partial<Omit<APIGuildOnboardingPrompt, 'guild_id' | 'id' | 'options' | 'title'>>
|
||||
>,
|
||||
Pick<APIGuildOnboardingPrompt, 'id' | 'title'> {
|
||||
/**
|
||||
* Options available within the prompt
|
||||
*/
|
||||
options: RESTAPIGuildOnboardingPromptOption[];
|
||||
}
|
||||
|
||||
/**
|
||||
* @deprecated Use {@link RESTAPIGuildOnboardingPrompt} instead.
|
||||
*/
|
||||
export type RESTAPIModifyGuildOnboardingPromptData = RESTAPIGuildOnboardingPrompt;
|
||||
|
||||
export type RESTAPIGuildOnboardingPromptOption = _AddUndefinedToPossiblyUndefinedPropertiesOfInterface<
|
||||
Partial<Omit<APIGuildOnboardingPromptOption, 'emoji' | 'guild_id' | 'title'>>
|
||||
> &
|
||||
Pick<APIGuildOnboardingPromptOption, 'title'> & {
|
||||
/**
|
||||
* Emoji id
|
||||
*/
|
||||
emoji_id?: Snowflake | null | undefined;
|
||||
/**
|
||||
* Emoji name
|
||||
*/
|
||||
emoji_name?: string | null | undefined;
|
||||
/**
|
||||
* Whether this emoji is animated
|
||||
*/
|
||||
emoji_animated?: boolean | null | undefined;
|
||||
};
|
||||
export interface RESTAPIGuildOnboardingPromptOption
|
||||
extends _AddUndefinedToPossiblyUndefinedPropertiesOfInterface<
|
||||
Partial<Omit<APIGuildOnboardingPromptOption, 'emoji' | 'guild_id' | 'title'>>
|
||||
>,
|
||||
Pick<APIGuildOnboardingPromptOption, 'title'> {
|
||||
/**
|
||||
* Emoji id
|
||||
*/
|
||||
emoji_id?: Snowflake | null | undefined;
|
||||
/**
|
||||
* Emoji name
|
||||
*/
|
||||
emoji_name?: string | null | undefined;
|
||||
/**
|
||||
* Whether this emoji is animated
|
||||
*/
|
||||
emoji_animated?: boolean | null | undefined;
|
||||
}
|
||||
|
||||
/**
|
||||
* @deprecated Use {@link RESTAPIGuildOnboardingPromptOption} instead.
|
||||
|
||||
23
deno/rest/v10/guildScheduledEvent.ts
generated
23
deno/rest/v10/guildScheduledEvent.ts
generated
@@ -94,17 +94,18 @@ export type RESTGetAPIGuildScheduledEventResult = APIGuildScheduledEvent;
|
||||
/**
|
||||
* @see {@link https://discord.com/developers/docs/resources/guild-scheduled-event#modify-guild-scheduled-event}
|
||||
*/
|
||||
export type RESTPatchAPIGuildScheduledEventJSONBody = _Nullable<
|
||||
Pick<RESTPostAPIGuildScheduledEventJSONBody, 'description' | 'entity_metadata' | 'recurrence_rule'>
|
||||
> &
|
||||
_StrictPartial<
|
||||
Omit<RESTPostAPIGuildScheduledEventJSONBody, 'description' | 'entity_metadata' | 'recurrence_rule'>
|
||||
> & {
|
||||
/**
|
||||
* The status of the scheduled event
|
||||
*/
|
||||
status?: GuildScheduledEventStatus | undefined;
|
||||
};
|
||||
export interface RESTPatchAPIGuildScheduledEventJSONBody
|
||||
extends _Nullable<
|
||||
Pick<RESTPostAPIGuildScheduledEventJSONBody, 'description' | 'entity_metadata' | 'recurrence_rule'>
|
||||
>,
|
||||
_StrictPartial<
|
||||
Omit<RESTPostAPIGuildScheduledEventJSONBody, 'description' | 'entity_metadata' | 'recurrence_rule'>
|
||||
> {
|
||||
/**
|
||||
* The status of the scheduled event
|
||||
*/
|
||||
status?: GuildScheduledEventStatus | undefined;
|
||||
}
|
||||
|
||||
/**
|
||||
* @see {@link https://discord.com/developers/docs/resources/guild-scheduled-event#modify-guild-scheduled-event}
|
||||
|
||||
43
deno/rest/v10/interactions.ts
generated
43
deno/rest/v10/interactions.ts
generated
@@ -47,26 +47,29 @@ export type RESTGetAPIApplicationCommandsResult = APIApplicationCommand[];
|
||||
*/
|
||||
export type RESTGetAPIApplicationCommandResult = APIApplicationCommand;
|
||||
|
||||
export type RESTPostAPIBaseApplicationCommandsJSONBody = _AddUndefinedToPossiblyUndefinedPropertiesOfInterface<
|
||||
Omit<
|
||||
APIApplicationCommand,
|
||||
| 'application_id'
|
||||
| 'contexts'
|
||||
| 'default_member_permissions'
|
||||
| 'description_localized'
|
||||
| 'description'
|
||||
| 'guild_id'
|
||||
| 'id'
|
||||
| 'integration_types'
|
||||
| 'name_localized'
|
||||
| 'type'
|
||||
| 'version'
|
||||
> &
|
||||
Partial<
|
||||
_NonNullableFields<Pick<APIApplicationCommand, 'contexts'>> &
|
||||
Pick<APIApplicationCommand, 'default_member_permissions' | 'integration_types'>
|
||||
>
|
||||
>;
|
||||
export interface RESTPostAPIBaseApplicationCommandsJSONBody
|
||||
extends _AddUndefinedToPossiblyUndefinedPropertiesOfInterface<
|
||||
Omit<
|
||||
APIApplicationCommand,
|
||||
| 'application_id'
|
||||
| 'contexts'
|
||||
| 'default_member_permissions'
|
||||
| 'description_localized'
|
||||
| 'description'
|
||||
| 'guild_id'
|
||||
| 'id'
|
||||
| 'integration_types'
|
||||
| 'name_localized'
|
||||
| 'type'
|
||||
| 'version'
|
||||
>
|
||||
>,
|
||||
_AddUndefinedToPossiblyUndefinedPropertiesOfInterface<
|
||||
Partial<
|
||||
_NonNullableFields<Pick<APIApplicationCommand, 'contexts'>> &
|
||||
Pick<APIApplicationCommand, 'default_member_permissions' | 'integration_types'>
|
||||
>
|
||||
> {}
|
||||
|
||||
/**
|
||||
* @see {@link https://discord.com/developers/docs/interactions/application-commands#create-global-application-command}
|
||||
|
||||
3
deno/rest/v10/invite.ts
generated
3
deno/rest/v10/invite.ts
generated
@@ -11,6 +11,9 @@ export interface RESTGetAPIInviteQuery {
|
||||
with_counts?: boolean;
|
||||
/**
|
||||
* Whether the invite should contain the expiration date
|
||||
*
|
||||
* @deprecated The expiration date is always returned, regardless of this query parameter.
|
||||
* @see {@link https://github.com/discord/discord-api-docs/pull/7424}
|
||||
*/
|
||||
with_expiration?: boolean;
|
||||
/**
|
||||
|
||||
78
deno/rest/v10/mod.ts
generated
78
deno/rest/v10/mod.ts
generated
@@ -2,26 +2,26 @@ import type { Snowflake } from '../../globals.ts';
|
||||
import { urlSafeCharacters } from '../../utils/internals.ts';
|
||||
|
||||
export * from '../common.ts';
|
||||
export * from './application.ts';
|
||||
export * from './auditLog.ts';
|
||||
export * from './autoModeration.ts';
|
||||
export type * from './application.ts';
|
||||
export type * from './auditLog.ts';
|
||||
export type * from './autoModeration.ts';
|
||||
export * from './channel.ts';
|
||||
export * from './emoji.ts';
|
||||
export * from './gateway.ts';
|
||||
export * from './guild.ts';
|
||||
export * from './guildScheduledEvent.ts';
|
||||
export * from './interactions.ts';
|
||||
export * from './invite.ts';
|
||||
export type * from './emoji.ts';
|
||||
export type * from './gateway.ts';
|
||||
export type * from './guild.ts';
|
||||
export type * from './guildScheduledEvent.ts';
|
||||
export type * from './interactions.ts';
|
||||
export type * from './invite.ts';
|
||||
export * from './monetization.ts';
|
||||
export * from './oauth2.ts';
|
||||
export * from './poll.ts';
|
||||
export * from './soundboard.ts';
|
||||
export * from './stageInstance.ts';
|
||||
export * from './sticker.ts';
|
||||
export * from './template.ts';
|
||||
export * from './user.ts';
|
||||
export * from './voice.ts';
|
||||
export * from './webhook.ts';
|
||||
export type * from './oauth2.ts';
|
||||
export type * from './poll.ts';
|
||||
export type * from './soundboard.ts';
|
||||
export type * from './stageInstance.ts';
|
||||
export type * from './sticker.ts';
|
||||
export type * from './template.ts';
|
||||
export type * from './user.ts';
|
||||
export type * from './voice.ts';
|
||||
export type * from './webhook.ts';
|
||||
|
||||
export const APIVersion = '10';
|
||||
|
||||
@@ -181,9 +181,28 @@ export const Routes = {
|
||||
return `/channels/${channelId}/typing` as const;
|
||||
},
|
||||
|
||||
/**
|
||||
* Route for:
|
||||
* - GET `/channels/{channel.id}/messages/pins`
|
||||
*/
|
||||
channelMessagesPins(channelId: Snowflake) {
|
||||
return `/channels/${channelId}/messages/pins` as const;
|
||||
},
|
||||
|
||||
/**
|
||||
* Route for:
|
||||
* - PUT `/channels/{channel.id}/messages/pins/{message.id}`
|
||||
* - DELETE `/channels/{channel.id}/messages/pins/{message.id}`
|
||||
*/
|
||||
channelMessagesPin(channelId: Snowflake, messageId: Snowflake) {
|
||||
return `/channels/${channelId}/messages/pins/${messageId}` as const;
|
||||
},
|
||||
|
||||
/**
|
||||
* Route for:
|
||||
* - GET `/channels/{channel.id}/pins`
|
||||
*
|
||||
* @deprecated Use {@link Routes.channelMessagesPins} instead.
|
||||
*/
|
||||
channelPins(channelId: Snowflake) {
|
||||
return `/channels/${channelId}/pins` as const;
|
||||
@@ -193,6 +212,8 @@ export const Routes = {
|
||||
* Route for:
|
||||
* - PUT `/channels/{channel.id}/pins/{message.id}`
|
||||
* - DELETE `/channels/{channel.id}/pins/{message.id}`
|
||||
*
|
||||
* @deprecated Use {@link Routes.channelMessagesPin} instead.
|
||||
*/
|
||||
channelPin(channelId: Snowflake, messageId: Snowflake) {
|
||||
return `/channels/${channelId}/pins/${messageId}` as const;
|
||||
@@ -229,6 +250,8 @@ export const Routes = {
|
||||
/**
|
||||
* Route for:
|
||||
* - POST `/guilds`
|
||||
*
|
||||
* @deprecated {@link https://discord.com/developers/docs/change-log#guild-create-deprecation}
|
||||
*/
|
||||
guilds() {
|
||||
return '/guilds' as const;
|
||||
@@ -238,7 +261,7 @@ export const Routes = {
|
||||
* Route for:
|
||||
* - GET `/guilds/{guild.id}`
|
||||
* - PATCH `/guilds/{guild.id}`
|
||||
* - DELETE `/guilds/{guild.id}`
|
||||
* - DELETE `/guilds/{guild.id}` (**deprecated**)
|
||||
*/
|
||||
guild(guildId: Snowflake) {
|
||||
return `/guilds/${guildId}` as const;
|
||||
@@ -312,6 +335,8 @@ export const Routes = {
|
||||
/**
|
||||
* Route for:
|
||||
* - POST `/guilds/{guild.id}/mfa`
|
||||
*
|
||||
* @deprecated
|
||||
*/
|
||||
guildMFA(guildId: Snowflake) {
|
||||
return `/guilds/${guildId}/mfa` as const;
|
||||
@@ -441,7 +466,7 @@ export const Routes = {
|
||||
/**
|
||||
* Route for:
|
||||
* - GET `/guilds/templates/{template.code}`
|
||||
* - POST `/guilds/templates/{template.code}`
|
||||
* - POST `/guilds/templates/{template.code}` (**deprecated**)
|
||||
*/
|
||||
template(code: string) {
|
||||
return `/guilds/templates/${code}` as const;
|
||||
@@ -549,7 +574,7 @@ export const Routes = {
|
||||
* - GET `/users/{user.id}`
|
||||
* - PATCH `/users/@me`
|
||||
*
|
||||
* @param [userId] - The user ID, defaulted to `@me`
|
||||
* @param userId - The user ID, defaulted to `@me`
|
||||
*/
|
||||
user(userId: Snowflake | '@me' = '@me') {
|
||||
return `/users/${userId}` as const;
|
||||
@@ -1382,6 +1407,16 @@ export const CDNRoutes = {
|
||||
soundboardSound(soundId: Snowflake) {
|
||||
return `/soundboard-sounds/${soundId}` as const;
|
||||
},
|
||||
|
||||
/**
|
||||
* Route for:
|
||||
* - GET `/guild-tag-badges/{guild.id}/{badge}.{png|jpeg|webp}`
|
||||
*
|
||||
* This route supports the extensions: PNG, JPEG, WebP
|
||||
*/
|
||||
guildTagBadge<Format extends GuildTagBadgeFormat>(guildId: Snowflake, guildTagBadge: string, format: Format) {
|
||||
return `/guild-tag-badges/${guildId}/${guildTagBadge}.${format}` as const;
|
||||
},
|
||||
};
|
||||
|
||||
for (const [key, fn] of Object.entries(CDNRoutes)) {
|
||||
@@ -1428,6 +1463,7 @@ export type StickerFormat = Extract<ImageFormat, ImageFormat.GIF | ImageFormat.L
|
||||
export type RoleIconFormat = Exclude<ImageFormat, ImageFormat.GIF | ImageFormat.Lottie>;
|
||||
export type GuildScheduledEventCoverFormat = Exclude<ImageFormat, ImageFormat.GIF | ImageFormat.Lottie>;
|
||||
export type GuildMemberBannerFormat = Exclude<ImageFormat, ImageFormat.Lottie>;
|
||||
export type GuildTagBadgeFormat = Exclude<ImageFormat, ImageFormat.GIF | ImageFormat.Lottie>;
|
||||
|
||||
/**
|
||||
* @deprecated Use {@link DefaultUserAvatarFormat} instead.
|
||||
|
||||
8
deno/rest/v10/monetization.ts
generated
8
deno/rest/v10/monetization.ts
generated
@@ -33,11 +33,15 @@ export interface RESTGetAPIEntitlementsQuery {
|
||||
*/
|
||||
guild_id?: Snowflake | undefined;
|
||||
/**
|
||||
* Whether ended entitlements should be omitted. Defaults to `false`, ended entitlements are included by default
|
||||
* Whether ended entitlements should be omitted
|
||||
*
|
||||
* @defaultValue `false` ended entitlements are included by default
|
||||
*/
|
||||
exclude_ended?: boolean | undefined;
|
||||
/**
|
||||
* Whether deleted entitlements should be omitted. Defaults to `true`, deleted entitlements are not included by default
|
||||
* Whether deleted entitlements should be omitted
|
||||
*
|
||||
* @defaultValue `true` deleted entitlements are not included by default
|
||||
*/
|
||||
exclude_deleted?: boolean | undefined;
|
||||
}
|
||||
|
||||
22
deno/rest/v10/oauth2.ts
generated
22
deno/rest/v10/oauth2.ts
generated
@@ -62,15 +62,20 @@ export interface RESTPostOAuth2AuthorizationQueryResult {
|
||||
export type RESTOAuth2AuthorizationQueryResult = RESTPostOAuth2AuthorizationQueryResult;
|
||||
|
||||
/**
|
||||
* @remarks
|
||||
* This endpoint requires either HTTP Basic authentication using `client_id:client_secret`,
|
||||
* or the `client_id` and `client_secret` must be provided in the form body.
|
||||
* @see {@link https://discord.com/developers/docs/topics/oauth2#authorization-code-grant-redirect-url-example}
|
||||
*/
|
||||
export interface RESTPostOAuth2AccessTokenURLEncodedData {
|
||||
client_id: Snowflake;
|
||||
client_secret: string;
|
||||
export type RESTPostOAuth2AccessTokenURLEncodedData = RESTOAuth2TokenOptionalClientCredentials & {
|
||||
grant_type: 'authorization_code';
|
||||
code: string;
|
||||
redirect_uri?: string;
|
||||
}
|
||||
};
|
||||
|
||||
export type RESTOAuth2TokenOptionalClientCredentials =
|
||||
| { client_id: Snowflake; client_secret: string }
|
||||
| { client_id?: never; client_secret?: never };
|
||||
|
||||
/**
|
||||
* @see {@link https://discord.com/developers/docs/topics/oauth2#authorization-code-grant-access-token-response}
|
||||
@@ -84,14 +89,15 @@ export interface RESTPostOAuth2AccessTokenResult {
|
||||
}
|
||||
|
||||
/**
|
||||
* @remarks
|
||||
* This endpoint requires either HTTP Basic authentication using `client_id:client_secret`,
|
||||
* or the `client_id` and `client_secret` must be provided in the form body.
|
||||
* @see {@link https://discord.com/developers/docs/topics/oauth2#authorization-code-grant-refresh-token-exchange-example}
|
||||
*/
|
||||
export interface RESTPostOAuth2RefreshTokenURLEncodedData {
|
||||
client_id: Snowflake;
|
||||
client_secret: string;
|
||||
export type RESTPostOAuth2RefreshTokenURLEncodedData = RESTOAuth2TokenOptionalClientCredentials & {
|
||||
grant_type: 'refresh_token';
|
||||
refresh_token: string;
|
||||
}
|
||||
};
|
||||
|
||||
export type RESTPostOAuth2RefreshTokenResult = RESTPostOAuth2AccessTokenResult;
|
||||
|
||||
|
||||
8
deno/rest/v10/poll.ts
generated
8
deno/rest/v10/poll.ts
generated
@@ -1,5 +1,5 @@
|
||||
import type { Snowflake } from '../../globals.ts';
|
||||
import type { APIMessage, APIPoll, APIPollAnswer, APIUser } from '../../v10.ts';
|
||||
import type { APIBasePoll, APIBasePollAnswer, APIMessage, APIPollDefaults, APIUser } from '../../v10.ts';
|
||||
|
||||
/**
|
||||
* @see {@link https://discord.com/developers/docs/resources/poll#get-answer-voters}
|
||||
@@ -20,13 +20,11 @@ export interface RESTGetAPIPollAnswerVotersQuery {
|
||||
/**
|
||||
* @see {@link https://discord.com/developers/docs/resources/poll#poll-create-request-object-poll-create-request-object-structure}
|
||||
*/
|
||||
export interface RESTAPIPoll
|
||||
extends Omit<APIPoll, 'allow_multiselect' | 'answers' | 'expiry' | 'layout_type' | 'results'>,
|
||||
Partial<Pick<APIPoll, 'allow_multiselect' | 'layout_type'>> {
|
||||
export interface RESTAPIPoll extends APIBasePoll, Partial<APIPollDefaults> {
|
||||
/**
|
||||
* Each of the answers available in the poll, up to 10
|
||||
*/
|
||||
answers: Omit<APIPollAnswer, 'answer_id'>[];
|
||||
answers: APIBasePollAnswer[];
|
||||
/**
|
||||
* Number of hours the poll should be open for, up to 32 days
|
||||
*
|
||||
|
||||
6
deno/rest/v10/template.ts
generated
6
deno/rest/v10/template.ts
generated
@@ -7,7 +7,8 @@ import type { _StrictPartial } from '../../utils/internals.ts';
|
||||
export type RESTGetAPITemplateResult = APITemplate;
|
||||
|
||||
/**
|
||||
* @see {@link https://discord.com/developers/docs/resources/guild-template#create-guild-from-guild-template}
|
||||
* @see {@link https://discord.com/developers/docs/change-log#guild-create-deprecation}
|
||||
* @deprecated
|
||||
*/
|
||||
export interface RESTPostAPITemplateCreateGuildJSONBody {
|
||||
/**
|
||||
@@ -23,7 +24,8 @@ export interface RESTPostAPITemplateCreateGuildJSONBody {
|
||||
}
|
||||
|
||||
/**
|
||||
* @see {@link https://discord.com/developers/docs/resources/guild-template#create-guild-from-guild-template}
|
||||
* @see {@link https://discord.com/developers/docs/change-log#guild-create-deprecation}
|
||||
* @deprecated
|
||||
*/
|
||||
export type RESTPostAPITemplateCreateGuildResult = APIGuild;
|
||||
|
||||
|
||||
8
deno/rest/v10/webhook.ts
generated
8
deno/rest/v10/webhook.ts
generated
@@ -131,9 +131,9 @@ export interface RESTPostAPIWebhookWithTokenJSONBody {
|
||||
/**
|
||||
* The components to include with the message
|
||||
*
|
||||
* Requires an application-owned webhook
|
||||
* Application-owned webhooks can always send components. Non-application-owned webhooks cannot send interactive components, and the `components` field will be ignored unless they set the `with_components` query param.
|
||||
*
|
||||
* @see {@link https://discord.com/developers/docs/interactions/message-components#component-object}
|
||||
* @see {@link https://discord.com/developers/docs/components/reference}
|
||||
*/
|
||||
components?: APIMessageTopLevelComponent[] | undefined;
|
||||
/**
|
||||
@@ -178,7 +178,7 @@ export type RESTPostAPIWebhookWithTokenFormDataBody =
|
||||
export interface RESTPostAPIWebhookWithTokenQuery {
|
||||
/**
|
||||
* 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)
|
||||
* (when `false` a message that is not saved does not return an error)
|
||||
*
|
||||
* @defaultValue `false`
|
||||
*/
|
||||
@@ -191,7 +191,7 @@ export interface RESTPostAPIWebhookWithTokenQuery {
|
||||
thread_id?: Snowflake;
|
||||
/**
|
||||
* Whether to allow sending (non-interactive) components for non-application-owned webhooks
|
||||
* (defaults to `false`; ignored for application-owned webhooks)
|
||||
* (ignored for application-owned webhooks)
|
||||
*
|
||||
* @defaultValue `false`
|
||||
*/
|
||||
|
||||
61
deno/rest/v9/channel.ts
generated
61
deno/rest/v9/channel.ts
generated
@@ -24,6 +24,7 @@ import type {
|
||||
ChannelFlags,
|
||||
APIAttachment,
|
||||
APIMessageTopLevelComponent,
|
||||
APIMessagePin,
|
||||
} from '../../payloads/v9/mod.ts';
|
||||
import type { _AddUndefinedToPossiblyUndefinedPropertiesOfInterface, _StrictPartial } from '../../utils/internals.ts';
|
||||
import type { RESTAPIPoll } from './poll.ts';
|
||||
@@ -315,7 +316,7 @@ export interface RESTPostAPIChannelMessageJSONBody {
|
||||
/**
|
||||
* The components to include with the message
|
||||
*
|
||||
* @see {@link https://discord.com/developers/docs/interactions/message-components#component-object}
|
||||
* @see {@link https://discord.com/developers/docs/components/reference}
|
||||
*/
|
||||
components?: APIMessageTopLevelComponent[] | undefined;
|
||||
/**
|
||||
@@ -475,7 +476,7 @@ export interface RESTPatchAPIChannelMessageJSONBody {
|
||||
/**
|
||||
* The components to include with the message
|
||||
*
|
||||
* @see {@link https://discord.com/developers/docs/interactions/message-components#component-object}
|
||||
* @see {@link https://discord.com/developers/docs/components/reference}
|
||||
*/
|
||||
components?: APIMessageTopLevelComponent[] | null | undefined;
|
||||
}
|
||||
@@ -631,12 +632,54 @@ export type RESTPostAPIChannelFollowersResult = APIFollowedChannel;
|
||||
export type RESTPostAPIChannelTypingResult = never;
|
||||
|
||||
/**
|
||||
* @see {@link https://discord.com/developers/docs/resources/channel#get-pinned-messages}
|
||||
* @see {@link https://discord.com/developers/docs/resources/message#get-channel-pins}
|
||||
*/
|
||||
export interface RESTGetAPIChannelMessagesPinsQuery {
|
||||
/**
|
||||
* Get messages pinned before this timestamp
|
||||
*/
|
||||
before?: string;
|
||||
/**
|
||||
* Maximum number of pins to return (1-50).
|
||||
*
|
||||
* @defaultValue `50`
|
||||
*/
|
||||
limit?: number;
|
||||
}
|
||||
|
||||
/**
|
||||
* @see {@link https://discord.com/developers/docs/resources/message#get-channel-pins}
|
||||
*/
|
||||
export interface RESTGetAPIChannelMessagesPinsResult {
|
||||
/**
|
||||
* Array of pinned messages
|
||||
*/
|
||||
items: APIMessagePin[];
|
||||
/**
|
||||
* Whether there are more items available
|
||||
*/
|
||||
has_more: boolean;
|
||||
}
|
||||
|
||||
/**
|
||||
* @see {@link https://discord.com/developers/docs/resources/message#pin-message}
|
||||
*/
|
||||
export type RESTPutAPIChannelMessagesPinResult = never;
|
||||
|
||||
/**
|
||||
* @see {@link https://discord.com/developers/docs/resources/message#unpin-message}
|
||||
*/
|
||||
export type RESTDeleteAPIChannelMessagesPinResult = never;
|
||||
|
||||
/**
|
||||
* @see {@link https://discord.com/developers/docs/resources/message#get-pinned-messages-deprecated}
|
||||
* @deprecated
|
||||
*/
|
||||
export type RESTGetAPIChannelPinsResult = APIMessage[];
|
||||
|
||||
/**
|
||||
* @see {@link https://discord.com/developers/docs/resources/channel#pin-message}
|
||||
* @see {@link https://discord.com/developers/docs/resources/message#pin-message-deprecated}
|
||||
* @deprecated
|
||||
*/
|
||||
export type RESTPutAPIChannelPinResult = never;
|
||||
|
||||
@@ -723,11 +766,9 @@ export interface RESTPostAPIChannelThreadsJSONBody extends RESTPostAPIChannelMes
|
||||
/**
|
||||
* The type of thread to create
|
||||
*
|
||||
* In API v9, `type` defaults to `PRIVATE_THREAD`.
|
||||
* In a future API version this will be changed to be a required field, with no default.
|
||||
*
|
||||
* @see {@link https://discord.com/developers/docs/resources/channel#channel-object-channel-types}
|
||||
* @defaultValue `ChannelType.PrivateThread`
|
||||
* @defaultValue `ChannelType.PrivateThread` in API v9.
|
||||
* In a future API version this will be changed to be a required field, with no default.
|
||||
*/
|
||||
type?: ThreadChannelType | undefined;
|
||||
/**
|
||||
@@ -779,7 +820,9 @@ export interface RESTGetAPIChannelThreadMembersQuery {
|
||||
*/
|
||||
after?: Snowflake;
|
||||
/**
|
||||
* Max number of thread members to return (1-100). Defaults to 100
|
||||
* Max number of thread members to return (1-100)
|
||||
*
|
||||
* @defaultValue `100`
|
||||
*/
|
||||
limit?: number;
|
||||
}
|
||||
|
||||
10
deno/rest/v9/emoji.ts
generated
10
deno/rest/v9/emoji.ts
generated
@@ -1,5 +1,5 @@
|
||||
import type { Snowflake } from '../../globals.ts';
|
||||
import type { APIEmoji } from '../../payloads/v9/mod.ts';
|
||||
import type { APIApplicationEmoji, APIEmoji } from '../../payloads/v9/mod.ts';
|
||||
|
||||
/**
|
||||
* @see {@link https://discord.com/developers/docs/resources/emoji#list-guild-emojis}
|
||||
@@ -64,13 +64,13 @@ export type RESTDeleteAPIGuildEmojiResult = never;
|
||||
* @see {@link https://discord.com/developers/docs/resources/emoji#list-application-emojis}
|
||||
*/
|
||||
export interface RESTGetAPIApplicationEmojisResult {
|
||||
items: APIEmoji[];
|
||||
items: APIApplicationEmoji[];
|
||||
}
|
||||
|
||||
/**
|
||||
* @see {@link https://discord.com/developers/docs/resources/emoji#get-application-emoji}
|
||||
*/
|
||||
export type RESTGetAPIApplicationEmojiResult = APIEmoji;
|
||||
export type RESTGetAPIApplicationEmojiResult = APIApplicationEmoji;
|
||||
|
||||
/**
|
||||
* @see {@link https://discord.com/developers/docs/resources/emoji#create-application-emoji-json-params}
|
||||
@@ -80,7 +80,7 @@ export type RESTPostAPIApplicationEmojiJSONBody = Pick<RESTPostAPIGuildEmojiJSON
|
||||
/**
|
||||
* @see {@link https://discord.com/developers/docs/resources/emoji#create-application-emoji}
|
||||
*/
|
||||
export type RESTPostAPIApplicationEmojiResult = APIEmoji;
|
||||
export type RESTPostAPIApplicationEmojiResult = APIApplicationEmoji;
|
||||
|
||||
/**
|
||||
* @see {@link https://discord.com/developers/docs/resources/emoji#modify-application-emoji}
|
||||
@@ -90,7 +90,7 @@ export type RESTPatchAPIApplicationEmojiJSONBody = Pick<RESTPatchAPIGuildEmojiJS
|
||||
/**
|
||||
* @see {@link https://discord.com/developers/docs/resources/emoji#modify-application-emoji}
|
||||
*/
|
||||
export type RESTPatchAPIApplicationEmojiResult = APIEmoji;
|
||||
export type RESTPatchAPIApplicationEmojiResult = APIApplicationEmoji;
|
||||
|
||||
/**
|
||||
* @see {@link https://discord.com/developers/docs/resources/emoji#delete-application-emoji}
|
||||
|
||||
85
deno/rest/v9/guild.ts
generated
85
deno/rest/v9/guild.ts
generated
@@ -26,6 +26,7 @@ import type {
|
||||
APIGroupDMChannel,
|
||||
APIGuildOnboardingPrompt,
|
||||
APIGuildOnboardingPromptOption,
|
||||
APIRoleColors,
|
||||
} from '../../payloads/v9/mod.ts';
|
||||
import type {
|
||||
_AddUndefinedToPossiblyUndefinedPropertiesOfInterface,
|
||||
@@ -97,6 +98,7 @@ export type APIGuildCreateRole = RESTAPIGuildCreateRole;
|
||||
|
||||
/**
|
||||
* @see {@link https://discord.com/developers/docs/resources/guild#create-guild}
|
||||
* @deprecated {@link https://discord.com/developers/docs/change-log#guild-create-deprecation}
|
||||
*/
|
||||
export interface RESTPostAPIGuildsJSONBody {
|
||||
/**
|
||||
@@ -184,12 +186,14 @@ export interface RESTPostAPIGuildsJSONBody {
|
||||
}
|
||||
|
||||
/**
|
||||
* @see {@link https://discord.com/developers/docs/resources/guild#create-guild}
|
||||
* @see {@link https://discord.com/developers/docs/change-log#guild-create-deprecation}
|
||||
* @deprecated
|
||||
*/
|
||||
export type RESTPostAPIGuildsResult = APIGuild;
|
||||
|
||||
/**
|
||||
* @see {@link https://discord.com/developers/docs/resources/guild#modify-guild-mfa-level}
|
||||
* @see {@link https://discord.com/developers/docs/change-log#guild-create-deprecation}
|
||||
* @deprecated
|
||||
*/
|
||||
export interface RESTPostAPIGuildsMFAJSONBody {
|
||||
/**
|
||||
@@ -201,7 +205,8 @@ export interface RESTPostAPIGuildsMFAJSONBody {
|
||||
}
|
||||
|
||||
/**
|
||||
* @see {@link https://discord.com/developers/docs/resources/guild#modify-guild-mfa-level}
|
||||
* @see {@link https://discord.com/developers/docs/change-log#guild-create-deprecation}
|
||||
* @deprecated
|
||||
*/
|
||||
export type RESTPostAPIGuildsMFAResult = RESTPostAPIGuildsMFAJSONBody;
|
||||
|
||||
@@ -275,6 +280,8 @@ export interface RESTPatchAPIGuildJSONBody {
|
||||
icon?: string | null | undefined;
|
||||
/**
|
||||
* User id to transfer guild ownership to (must be owner)
|
||||
*
|
||||
* @deprecated
|
||||
*/
|
||||
owner_id?: Snowflake | undefined;
|
||||
/**
|
||||
@@ -310,7 +317,7 @@ export interface RESTPatchAPIGuildJSONBody {
|
||||
*/
|
||||
public_updates_channel_id?: Snowflake | null | undefined;
|
||||
/**
|
||||
* The preferred locale of a Community guild used in server discovery and notices from Discord; defaults to "en-US"
|
||||
* The preferred locale of a Community guild used in server discovery and notices from Discord
|
||||
*
|
||||
* @defaultValue `"en-US"` (if the value is set to `null`)
|
||||
*/
|
||||
@@ -341,7 +348,8 @@ export interface RESTPatchAPIGuildJSONBody {
|
||||
export type RESTPatchAPIGuildResult = APIGuild;
|
||||
|
||||
/**
|
||||
* @see {@link https://discord.com/developers/docs/resources/guild#delete-guild}
|
||||
* @see {@link https://discord.com/developers/docs/change-log#guild-create-deprecation}
|
||||
* @deprecated
|
||||
*/
|
||||
export type RESTDeleteAPIGuildResult = never;
|
||||
|
||||
@@ -682,8 +690,15 @@ export interface RESTPostAPIGuildRoleJSONBody {
|
||||
* RGB color value
|
||||
*
|
||||
* @defaultValue `0`
|
||||
* @remarks `color` will still be returned by the API, but using the `colors` field is recommended when doing requests.
|
||||
*/
|
||||
color?: number | null | undefined;
|
||||
/**
|
||||
* The role's colors
|
||||
*
|
||||
* @defaultValue `{ "primary_color": 0, "secondary_color": null, "tertiary_color": null }`
|
||||
*/
|
||||
colors?: APIRoleColors | undefined;
|
||||
/**
|
||||
* Whether the role should be displayed separately in the sidebar
|
||||
*
|
||||
@@ -744,8 +759,14 @@ export interface RESTPatchAPIGuildRoleJSONBody {
|
||||
permissions?: Permissions | null | undefined;
|
||||
/**
|
||||
* RGB color value
|
||||
*
|
||||
* @remarks `color` will still be returned by the API, but using the `colors` field is recommended when doing requests.
|
||||
*/
|
||||
color?: number | null | undefined;
|
||||
/**
|
||||
* The role's colors
|
||||
*/
|
||||
colors?: APIRoleColors | undefined;
|
||||
/**
|
||||
* Whether the role should be displayed separately in the sidebar
|
||||
*/
|
||||
@@ -958,38 +979,40 @@ export type RESTPutAPIGuildOnboardingJSONBody = _AddUndefinedToPossiblyUndefined
|
||||
prompts?: RESTAPIGuildOnboardingPrompt[] | undefined;
|
||||
};
|
||||
|
||||
export type RESTAPIGuildOnboardingPrompt = _AddUndefinedToPossiblyUndefinedPropertiesOfInterface<
|
||||
Partial<Omit<APIGuildOnboardingPrompt, 'guild_id' | 'id' | 'options' | 'title'>>
|
||||
> &
|
||||
Pick<APIGuildOnboardingPrompt, 'id' | 'title'> & {
|
||||
/**
|
||||
* Options available within the prompt
|
||||
*/
|
||||
options: RESTAPIGuildOnboardingPromptOption[];
|
||||
};
|
||||
export interface RESTAPIGuildOnboardingPrompt
|
||||
extends _AddUndefinedToPossiblyUndefinedPropertiesOfInterface<
|
||||
Partial<Omit<APIGuildOnboardingPrompt, 'guild_id' | 'id' | 'options' | 'title'>>
|
||||
>,
|
||||
Pick<APIGuildOnboardingPrompt, 'id' | 'title'> {
|
||||
/**
|
||||
* Options available within the prompt
|
||||
*/
|
||||
options: RESTAPIGuildOnboardingPromptOption[];
|
||||
}
|
||||
|
||||
/**
|
||||
* @deprecated Use {@link RESTAPIGuildOnboardingPrompt} instead.
|
||||
*/
|
||||
export type RESTAPIModifyGuildOnboardingPromptData = RESTAPIGuildOnboardingPrompt;
|
||||
|
||||
export type RESTAPIGuildOnboardingPromptOption = _AddUndefinedToPossiblyUndefinedPropertiesOfInterface<
|
||||
Partial<Omit<APIGuildOnboardingPromptOption, 'emoji' | 'guild_id' | 'title'>>
|
||||
> &
|
||||
Pick<APIGuildOnboardingPromptOption, 'title'> & {
|
||||
/**
|
||||
* Emoji id
|
||||
*/
|
||||
emoji_id?: Snowflake | null | undefined;
|
||||
/**
|
||||
* Emoji name
|
||||
*/
|
||||
emoji_name?: string | null | undefined;
|
||||
/**
|
||||
* Whether this emoji is animated
|
||||
*/
|
||||
emoji_animated?: boolean | null | undefined;
|
||||
};
|
||||
export interface RESTAPIGuildOnboardingPromptOption
|
||||
extends _AddUndefinedToPossiblyUndefinedPropertiesOfInterface<
|
||||
Partial<Omit<APIGuildOnboardingPromptOption, 'emoji' | 'guild_id' | 'title'>>
|
||||
>,
|
||||
Pick<APIGuildOnboardingPromptOption, 'title'> {
|
||||
/**
|
||||
* Emoji id
|
||||
*/
|
||||
emoji_id?: Snowflake | null | undefined;
|
||||
/**
|
||||
* Emoji name
|
||||
*/
|
||||
emoji_name?: string | null | undefined;
|
||||
/**
|
||||
* Whether this emoji is animated
|
||||
*/
|
||||
emoji_animated?: boolean | null | undefined;
|
||||
}
|
||||
|
||||
/**
|
||||
* @deprecated Use {@link RESTAPIGuildOnboardingPromptOption} instead.
|
||||
|
||||
23
deno/rest/v9/guildScheduledEvent.ts
generated
23
deno/rest/v9/guildScheduledEvent.ts
generated
@@ -94,17 +94,18 @@ export type RESTGetAPIGuildScheduledEventResult = APIGuildScheduledEvent;
|
||||
/**
|
||||
* @see {@link https://discord.com/developers/docs/resources/guild-scheduled-event#modify-guild-scheduled-event}
|
||||
*/
|
||||
export type RESTPatchAPIGuildScheduledEventJSONBody = _Nullable<
|
||||
Pick<RESTPostAPIGuildScheduledEventJSONBody, 'description' | 'entity_metadata' | 'recurrence_rule'>
|
||||
> &
|
||||
_StrictPartial<
|
||||
Omit<RESTPostAPIGuildScheduledEventJSONBody, 'description' | 'entity_metadata' | 'recurrence_rule'>
|
||||
> & {
|
||||
/**
|
||||
* The status of the scheduled event
|
||||
*/
|
||||
status?: GuildScheduledEventStatus | undefined;
|
||||
};
|
||||
export interface RESTPatchAPIGuildScheduledEventJSONBody
|
||||
extends _Nullable<
|
||||
Pick<RESTPostAPIGuildScheduledEventJSONBody, 'description' | 'entity_metadata' | 'recurrence_rule'>
|
||||
>,
|
||||
_StrictPartial<
|
||||
Omit<RESTPostAPIGuildScheduledEventJSONBody, 'description' | 'entity_metadata' | 'recurrence_rule'>
|
||||
> {
|
||||
/**
|
||||
* The status of the scheduled event
|
||||
*/
|
||||
status?: GuildScheduledEventStatus | undefined;
|
||||
}
|
||||
|
||||
/**
|
||||
* @see {@link https://discord.com/developers/docs/resources/guild-scheduled-event#modify-guild-scheduled-event}
|
||||
|
||||
43
deno/rest/v9/interactions.ts
generated
43
deno/rest/v9/interactions.ts
generated
@@ -47,26 +47,29 @@ export type RESTGetAPIApplicationCommandsResult = APIApplicationCommand[];
|
||||
*/
|
||||
export type RESTGetAPIApplicationCommandResult = APIApplicationCommand;
|
||||
|
||||
export type RESTPostAPIBaseApplicationCommandsJSONBody = _AddUndefinedToPossiblyUndefinedPropertiesOfInterface<
|
||||
Omit<
|
||||
APIApplicationCommand,
|
||||
| 'application_id'
|
||||
| 'contexts'
|
||||
| 'default_member_permissions'
|
||||
| 'description_localized'
|
||||
| 'description'
|
||||
| 'guild_id'
|
||||
| 'id'
|
||||
| 'integration_types'
|
||||
| 'name_localized'
|
||||
| 'type'
|
||||
| 'version'
|
||||
> &
|
||||
Partial<
|
||||
_NonNullableFields<Pick<APIApplicationCommand, 'contexts'>> &
|
||||
Pick<APIApplicationCommand, 'default_member_permissions' | 'integration_types'>
|
||||
>
|
||||
>;
|
||||
export interface RESTPostAPIBaseApplicationCommandsJSONBody
|
||||
extends _AddUndefinedToPossiblyUndefinedPropertiesOfInterface<
|
||||
Omit<
|
||||
APIApplicationCommand,
|
||||
| 'application_id'
|
||||
| 'contexts'
|
||||
| 'default_member_permissions'
|
||||
| 'description_localized'
|
||||
| 'description'
|
||||
| 'guild_id'
|
||||
| 'id'
|
||||
| 'integration_types'
|
||||
| 'name_localized'
|
||||
| 'type'
|
||||
| 'version'
|
||||
>
|
||||
>,
|
||||
_AddUndefinedToPossiblyUndefinedPropertiesOfInterface<
|
||||
Partial<
|
||||
_NonNullableFields<Pick<APIApplicationCommand, 'contexts'>> &
|
||||
Pick<APIApplicationCommand, 'default_member_permissions' | 'integration_types'>
|
||||
>
|
||||
> {}
|
||||
|
||||
/**
|
||||
* @see {@link https://discord.com/developers/docs/interactions/application-commands#create-global-application-command}
|
||||
|
||||
3
deno/rest/v9/invite.ts
generated
3
deno/rest/v9/invite.ts
generated
@@ -11,6 +11,9 @@ export interface RESTGetAPIInviteQuery {
|
||||
with_counts?: boolean;
|
||||
/**
|
||||
* Whether the invite should contain the expiration date
|
||||
*
|
||||
* @deprecated The expiration date is always returned, regardless of this query parameter.
|
||||
* @see {@link https://github.com/discord/discord-api-docs/pull/7424}
|
||||
*/
|
||||
with_expiration?: boolean;
|
||||
/**
|
||||
|
||||
78
deno/rest/v9/mod.ts
generated
78
deno/rest/v9/mod.ts
generated
@@ -2,26 +2,26 @@ import type { Snowflake } from '../../globals.ts';
|
||||
import { urlSafeCharacters } from '../../utils/internals.ts';
|
||||
|
||||
export * from '../common.ts';
|
||||
export * from './application.ts';
|
||||
export * from './auditLog.ts';
|
||||
export * from './autoModeration.ts';
|
||||
export type * from './application.ts';
|
||||
export type * from './auditLog.ts';
|
||||
export type * from './autoModeration.ts';
|
||||
export * from './channel.ts';
|
||||
export * from './emoji.ts';
|
||||
export * from './gateway.ts';
|
||||
export * from './guild.ts';
|
||||
export * from './guildScheduledEvent.ts';
|
||||
export * from './interactions.ts';
|
||||
export * from './invite.ts';
|
||||
export type * from './emoji.ts';
|
||||
export type * from './gateway.ts';
|
||||
export type * from './guild.ts';
|
||||
export type * from './guildScheduledEvent.ts';
|
||||
export type * from './interactions.ts';
|
||||
export type * from './invite.ts';
|
||||
export * from './monetization.ts';
|
||||
export * from './oauth2.ts';
|
||||
export * from './poll.ts';
|
||||
export * from './soundboard.ts';
|
||||
export * from './stageInstance.ts';
|
||||
export * from './sticker.ts';
|
||||
export * from './template.ts';
|
||||
export * from './user.ts';
|
||||
export * from './voice.ts';
|
||||
export * from './webhook.ts';
|
||||
export type * from './oauth2.ts';
|
||||
export type * from './poll.ts';
|
||||
export type * from './soundboard.ts';
|
||||
export type * from './stageInstance.ts';
|
||||
export type * from './sticker.ts';
|
||||
export type * from './template.ts';
|
||||
export type * from './user.ts';
|
||||
export type * from './voice.ts';
|
||||
export type * from './webhook.ts';
|
||||
|
||||
export const APIVersion = '9';
|
||||
|
||||
@@ -181,9 +181,28 @@ export const Routes = {
|
||||
return `/channels/${channelId}/typing` as const;
|
||||
},
|
||||
|
||||
/**
|
||||
* Route for:
|
||||
* - GET `/channels/{channel.id}/messages/pins`
|
||||
*/
|
||||
channelMessagesPins(channelId: Snowflake) {
|
||||
return `/channels/${channelId}/messages/pins` as const;
|
||||
},
|
||||
|
||||
/**
|
||||
* Route for:
|
||||
* - PUT `/channels/{channel.id}/messages/pins/{message.id}`
|
||||
* - DELETE `/channels/{channel.id}/messages/pins/{message.id}`
|
||||
*/
|
||||
channelMessagesPin(channelId: Snowflake, messageId: Snowflake) {
|
||||
return `/channels/${channelId}/messages/pins/${messageId}` as const;
|
||||
},
|
||||
|
||||
/**
|
||||
* Route for:
|
||||
* - GET `/channels/{channel.id}/pins`
|
||||
*
|
||||
* @deprecated Use {@link Routes.channelMessagesPins} instead.
|
||||
*/
|
||||
channelPins(channelId: Snowflake) {
|
||||
return `/channels/${channelId}/pins` as const;
|
||||
@@ -193,6 +212,8 @@ export const Routes = {
|
||||
* Route for:
|
||||
* - PUT `/channels/{channel.id}/pins/{message.id}`
|
||||
* - DELETE `/channels/{channel.id}/pins/{message.id}`
|
||||
*
|
||||
* @deprecated Use {@link Routes.channelMessagesPin} instead.
|
||||
*/
|
||||
channelPin(channelId: Snowflake, messageId: Snowflake) {
|
||||
return `/channels/${channelId}/pins/${messageId}` as const;
|
||||
@@ -229,6 +250,8 @@ export const Routes = {
|
||||
/**
|
||||
* Route for:
|
||||
* - POST `/guilds`
|
||||
*
|
||||
* @deprecated {@link https://discord.com/developers/docs/change-log#guild-create-deprecation}
|
||||
*/
|
||||
guilds() {
|
||||
return '/guilds' as const;
|
||||
@@ -238,7 +261,7 @@ export const Routes = {
|
||||
* Route for:
|
||||
* - GET `/guilds/{guild.id}`
|
||||
* - PATCH `/guilds/{guild.id}`
|
||||
* - DELETE `/guilds/{guild.id}`
|
||||
* - DELETE `/guilds/{guild.id}` (**deprecated**)
|
||||
*/
|
||||
guild(guildId: Snowflake) {
|
||||
return `/guilds/${guildId}` as const;
|
||||
@@ -312,6 +335,8 @@ export const Routes = {
|
||||
/**
|
||||
* Route for:
|
||||
* - POST `/guilds/{guild.id}/mfa`
|
||||
*
|
||||
* @deprecated
|
||||
*/
|
||||
guildMFA(guildId: Snowflake) {
|
||||
return `/guilds/${guildId}/mfa` as const;
|
||||
@@ -441,7 +466,7 @@ export const Routes = {
|
||||
/**
|
||||
* Route for:
|
||||
* - GET `/guilds/templates/{template.code}`
|
||||
* - POST `/guilds/templates/{template.code}`
|
||||
* - POST `/guilds/templates/{template.code}` (**deprecated**)
|
||||
*/
|
||||
template(code: string) {
|
||||
return `/guilds/templates/${code}` as const;
|
||||
@@ -558,7 +583,7 @@ export const Routes = {
|
||||
* - GET `/users/{user.id}`
|
||||
* - PATCH `/users/@me`
|
||||
*
|
||||
* @param [userId] - The user ID, defaulted to `@me`
|
||||
* @param userId - The user ID, defaulted to `@me`
|
||||
*/
|
||||
user(userId: Snowflake | '@me' = '@me') {
|
||||
return `/users/${userId}` as const;
|
||||
@@ -1391,6 +1416,16 @@ export const CDNRoutes = {
|
||||
soundboardSound(soundId: Snowflake) {
|
||||
return `/soundboard-sounds/${soundId}` as const;
|
||||
},
|
||||
|
||||
/**
|
||||
* Route for:
|
||||
* - GET `/guild-tag-badges/{guild.id}/{badge}.{png|jpeg|webp}`
|
||||
*
|
||||
* This route supports the extensions: PNG, JPEG, WebP
|
||||
*/
|
||||
guildTagBadge<Format extends GuildTagBadgeFormat>(guildId: Snowflake, guildTagBadge: string, format: Format) {
|
||||
return `/guild-tag-badges/${guildId}/${guildTagBadge}.${format}` as const;
|
||||
},
|
||||
};
|
||||
|
||||
for (const [key, fn] of Object.entries(CDNRoutes)) {
|
||||
@@ -1437,6 +1472,7 @@ export type StickerFormat = Extract<ImageFormat, ImageFormat.GIF | ImageFormat.L
|
||||
export type RoleIconFormat = Exclude<ImageFormat, ImageFormat.GIF | ImageFormat.Lottie>;
|
||||
export type GuildScheduledEventCoverFormat = Exclude<ImageFormat, ImageFormat.GIF | ImageFormat.Lottie>;
|
||||
export type GuildMemberBannerFormat = Exclude<ImageFormat, ImageFormat.Lottie>;
|
||||
export type GuildTagBadgeFormat = Exclude<ImageFormat, ImageFormat.GIF | ImageFormat.Lottie>;
|
||||
|
||||
/**
|
||||
* @deprecated Use {@link DefaultUserAvatarFormat} instead.
|
||||
|
||||
8
deno/rest/v9/monetization.ts
generated
8
deno/rest/v9/monetization.ts
generated
@@ -33,11 +33,15 @@ export interface RESTGetAPIEntitlementsQuery {
|
||||
*/
|
||||
guild_id?: Snowflake | undefined;
|
||||
/**
|
||||
* Whether ended entitlements should be omitted. Defaults to `false`, ended entitlements are included by default
|
||||
* Whether ended entitlements should be omitted
|
||||
*
|
||||
* @defaultValue `false` ended entitlements are included by default
|
||||
*/
|
||||
exclude_ended?: boolean | undefined;
|
||||
/**
|
||||
* Whether deleted entitlements should be omitted. Defaults to `true`, deleted entitlements are not included by default
|
||||
* Whether deleted entitlements should be omitted
|
||||
*
|
||||
* @defaultValue `true` deleted entitlements are not included by default
|
||||
*/
|
||||
exclude_deleted?: boolean | undefined;
|
||||
}
|
||||
|
||||
22
deno/rest/v9/oauth2.ts
generated
22
deno/rest/v9/oauth2.ts
generated
@@ -62,15 +62,20 @@ export interface RESTPostOAuth2AuthorizationQueryResult {
|
||||
export type RESTOAuth2AuthorizationQueryResult = RESTPostOAuth2AuthorizationQueryResult;
|
||||
|
||||
/**
|
||||
* @remarks
|
||||
* This endpoint requires either HTTP Basic authentication using `client_id:client_secret`,
|
||||
* or the `client_id` and `client_secret` must be provided in the form body.
|
||||
* @see {@link https://discord.com/developers/docs/topics/oauth2#authorization-code-grant-redirect-url-example}
|
||||
*/
|
||||
export interface RESTPostOAuth2AccessTokenURLEncodedData {
|
||||
client_id: Snowflake;
|
||||
client_secret: string;
|
||||
export type RESTPostOAuth2AccessTokenURLEncodedData = RESTOAuth2TokenOptionalClientCredentials & {
|
||||
grant_type: 'authorization_code';
|
||||
code: string;
|
||||
redirect_uri?: string;
|
||||
}
|
||||
};
|
||||
|
||||
export type RESTOAuth2TokenOptionalClientCredentials =
|
||||
| { client_id: Snowflake; client_secret: string }
|
||||
| { client_id?: never; client_secret?: never };
|
||||
|
||||
/**
|
||||
* @see {@link https://discord.com/developers/docs/topics/oauth2#authorization-code-grant-access-token-response}
|
||||
@@ -84,14 +89,15 @@ export interface RESTPostOAuth2AccessTokenResult {
|
||||
}
|
||||
|
||||
/**
|
||||
* @remarks
|
||||
* This endpoint requires either HTTP Basic authentication using `client_id:client_secret`,
|
||||
* or the `client_id` and `client_secret` must be provided in the form body.
|
||||
* @see {@link https://discord.com/developers/docs/topics/oauth2#authorization-code-grant-refresh-token-exchange-example}
|
||||
*/
|
||||
export interface RESTPostOAuth2RefreshTokenURLEncodedData {
|
||||
client_id: Snowflake;
|
||||
client_secret: string;
|
||||
export type RESTPostOAuth2RefreshTokenURLEncodedData = RESTOAuth2TokenOptionalClientCredentials & {
|
||||
grant_type: 'refresh_token';
|
||||
refresh_token: string;
|
||||
}
|
||||
};
|
||||
|
||||
export type RESTPostOAuth2RefreshTokenResult = RESTPostOAuth2AccessTokenResult;
|
||||
|
||||
|
||||
8
deno/rest/v9/poll.ts
generated
8
deno/rest/v9/poll.ts
generated
@@ -1,5 +1,5 @@
|
||||
import type { Snowflake } from '../../globals.ts';
|
||||
import type { APIMessage, APIPoll, APIPollAnswer, APIUser } from '../../v9.ts';
|
||||
import type { APIBasePoll, APIBasePollAnswer, APIMessage, APIPollDefaults, APIUser } from '../../v9.ts';
|
||||
|
||||
/**
|
||||
* @see {@link https://discord.com/developers/docs/resources/poll#get-answer-voters}
|
||||
@@ -20,13 +20,11 @@ export interface RESTGetAPIPollAnswerVotersQuery {
|
||||
/**
|
||||
* @see {@link https://discord.com/developers/docs/resources/poll#poll-create-request-object-poll-create-request-object-structure}
|
||||
*/
|
||||
export interface RESTAPIPoll
|
||||
extends Omit<APIPoll, 'allow_multiselect' | 'answers' | 'expiry' | 'layout_type' | 'results'>,
|
||||
Partial<Pick<APIPoll, 'allow_multiselect' | 'layout_type'>> {
|
||||
export interface RESTAPIPoll extends APIBasePoll, Partial<APIPollDefaults> {
|
||||
/**
|
||||
* Each of the answers available in the poll, up to 10
|
||||
*/
|
||||
answers: Omit<APIPollAnswer, 'answer_id'>[];
|
||||
answers: APIBasePollAnswer[];
|
||||
/**
|
||||
* Number of hours the poll should be open for, up to 32 days
|
||||
*
|
||||
|
||||
2
deno/rest/v9/soundboard.ts
generated
2
deno/rest/v9/soundboard.ts
generated
@@ -1,5 +1,5 @@
|
||||
import type { Snowflake } from '../../globals.ts';
|
||||
import type { APISoundboardSound } from '../../payloads/v10/mod.ts';
|
||||
import type { APISoundboardSound } from '../../payloads/v9/mod.ts';
|
||||
|
||||
/**
|
||||
* @see {@link https://discord.com/developers/docs/resources/soundboard#send-soundboard-sound}
|
||||
|
||||
6
deno/rest/v9/template.ts
generated
6
deno/rest/v9/template.ts
generated
@@ -7,7 +7,8 @@ import type { _StrictPartial } from '../../utils/internals.ts';
|
||||
export type RESTGetAPITemplateResult = APITemplate;
|
||||
|
||||
/**
|
||||
* @see {@link https://discord.com/developers/docs/resources/guild-template#create-guild-from-guild-template}
|
||||
* @see {@link https://discord.com/developers/docs/change-log#guild-create-deprecation}
|
||||
* @deprecated
|
||||
*/
|
||||
export interface RESTPostAPITemplateCreateGuildJSONBody {
|
||||
/**
|
||||
@@ -23,12 +24,13 @@ export interface RESTPostAPITemplateCreateGuildJSONBody {
|
||||
}
|
||||
|
||||
/**
|
||||
* @see {@link https://discord.com/developers/docs/resources/guild-template#create-guild-from-guild-template}
|
||||
* @see {@link https://discord.com/developers/docs/change-log#guild-create-deprecation}
|
||||
*/
|
||||
export type RESTPostAPITemplateCreateGuildResult = APIGuild;
|
||||
|
||||
/**
|
||||
* @see {@link https://discord.com/developers/docs/resources/guild-template#get-guild-templates}
|
||||
* @deprecated
|
||||
*/
|
||||
export type RESTGetAPIGuildTemplatesResult = APITemplate[];
|
||||
|
||||
|
||||
8
deno/rest/v9/webhook.ts
generated
8
deno/rest/v9/webhook.ts
generated
@@ -131,9 +131,9 @@ export interface RESTPostAPIWebhookWithTokenJSONBody {
|
||||
/**
|
||||
* The components to include with the message
|
||||
*
|
||||
* Requires an application-owned webhook
|
||||
* Application-owned webhooks can always send components. Non-application-owned webhooks cannot send interactive components, and the `components` field will be ignored unless they set the `with_components` query param.
|
||||
*
|
||||
* @see {@link https://discord.com/developers/docs/interactions/message-components#component-object}
|
||||
* @see {@link https://discord.com/developers/docs/components/reference}
|
||||
*/
|
||||
components?: APIMessageTopLevelComponent[] | undefined;
|
||||
/**
|
||||
@@ -178,7 +178,7 @@ export type RESTPostAPIWebhookWithTokenFormDataBody =
|
||||
export interface RESTPostAPIWebhookWithTokenQuery {
|
||||
/**
|
||||
* 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)
|
||||
* (when `false` a message that is not saved does not return an error)
|
||||
*
|
||||
* @defaultValue `false`
|
||||
*/
|
||||
@@ -191,7 +191,7 @@ export interface RESTPostAPIWebhookWithTokenQuery {
|
||||
thread_id?: Snowflake;
|
||||
/**
|
||||
* Whether to allow sending (non-interactive) components for non-application-owned webhooks
|
||||
* (defaults to `false`; ignored for application-owned webhooks)
|
||||
* (ignored for application-owned webhooks)
|
||||
*
|
||||
* @defaultValue `false`
|
||||
*/
|
||||
|
||||
49
deno/rpc/common.ts
generated
49
deno/rpc/common.ts
generated
@@ -1,5 +1,4 @@
|
||||
import type { Snowflake } from '../globals.ts';
|
||||
import type { APIMessage, APIUser, RPCVoiceConnectionStatusDispatchData } from '../v10.ts';
|
||||
|
||||
/**
|
||||
* @unstable The ping object for the `VOICE_CONNECTION_STATUS` dispatched {@link RPCVoiceConnectionStatusDispatchData.pings} field,
|
||||
@@ -27,12 +26,18 @@ export interface RPCAPIMessageParsedContentOriginalMatch {
|
||||
/**
|
||||
* @unstable
|
||||
*/
|
||||
export interface RPCAPIMessageParsedContentText {
|
||||
export interface RPCAPIBaseMessageParsedContentText {
|
||||
type: 'text';
|
||||
originalMatch: RPCAPIMessageParsedContentOriginalMatch;
|
||||
content: string;
|
||||
}
|
||||
|
||||
/**
|
||||
* @unstable
|
||||
*/
|
||||
export interface RPCAPIMessageParsedContentText extends RPCAPIBaseMessageParsedContentText {
|
||||
originalMatch: RPCAPIMessageParsedContentOriginalMatch;
|
||||
}
|
||||
|
||||
/**
|
||||
* @unstable
|
||||
*/
|
||||
@@ -45,25 +50,7 @@ export interface RPCAPIMessageParsedContentMention {
|
||||
* Same as {@link RPCAPIMessageParsedContentMention.userId}
|
||||
*/
|
||||
parsedUserId: RPCAPIMessageParsedContentMention['userId'];
|
||||
content: Omit<RPCAPIMessageParsedContentText, 'originalMatch'>;
|
||||
}
|
||||
|
||||
/**
|
||||
* @unstable
|
||||
*/
|
||||
export interface RPCAPIMessage extends Omit<APIMessage, 'channel_id'> {
|
||||
/**
|
||||
* The nickname of the user who sent the message
|
||||
*/
|
||||
nick?: string;
|
||||
/**
|
||||
* The color of the author's name
|
||||
*/
|
||||
author_color?: number;
|
||||
/**
|
||||
* The content of the message parsed into an array
|
||||
*/
|
||||
content_parsed: (RPCAPIMessageParsedContentMention | RPCAPIMessageParsedContentText)[];
|
||||
content: RPCAPIBaseMessageParsedContentText;
|
||||
}
|
||||
|
||||
/**
|
||||
@@ -329,24 +316,6 @@ export enum RelationshipType {
|
||||
Implicit,
|
||||
}
|
||||
|
||||
/**
|
||||
* @unstable
|
||||
*/
|
||||
export interface Relationship {
|
||||
/**
|
||||
* The id of the user
|
||||
*/
|
||||
id: Snowflake;
|
||||
/**
|
||||
* Relationship type
|
||||
*/
|
||||
type: RelationshipType;
|
||||
/**
|
||||
* User
|
||||
*/
|
||||
user: APIUser;
|
||||
}
|
||||
|
||||
/**
|
||||
* @see {@link https://discord.com/developers/docs/topics/opcodes-and-status-codes#rpc-rpc-error-codes}
|
||||
*/
|
||||
|
||||
53
deno/rpc/v10.ts
generated
53
deno/rpc/v10.ts
generated
@@ -1,7 +1,9 @@
|
||||
/* eslint-disable @typescript-eslint/no-empty-interface */
|
||||
import type {
|
||||
APIBaseMessageNoChannel,
|
||||
APIInvite,
|
||||
APIMessage,
|
||||
APIMessageMentions,
|
||||
APIPartialChannel,
|
||||
APIPartialGuild,
|
||||
APIUser,
|
||||
@@ -9,8 +11,12 @@ import type {
|
||||
ChannelType,
|
||||
GatewayActivity,
|
||||
OAuth2Scopes,
|
||||
Relationship,
|
||||
RPCAPIMessage,
|
||||
Snowflake,
|
||||
} from '../v10.ts';
|
||||
import type {
|
||||
RelationshipType,
|
||||
RPCAPIMessageParsedContentMention,
|
||||
RPCAPIMessageParsedContentText,
|
||||
RPCCertifiedDevice,
|
||||
RPCErrorCodes,
|
||||
RPCOAuth2Application,
|
||||
@@ -18,14 +24,49 @@ import type {
|
||||
RPCVoiceSettingsInput,
|
||||
RPCVoiceSettingsMode,
|
||||
RPCVoiceSettingsOutput,
|
||||
Snowflake,
|
||||
VoiceConnectionStates,
|
||||
} from '../v10.ts';
|
||||
} from './common.ts';
|
||||
|
||||
export * from './common.ts';
|
||||
|
||||
export const RPCVersion = '1';
|
||||
|
||||
/**
|
||||
* @unstable
|
||||
*/
|
||||
export interface Relationship {
|
||||
/**
|
||||
* The id of the user
|
||||
*/
|
||||
id: Snowflake;
|
||||
/**
|
||||
* Relationship type
|
||||
*/
|
||||
type: RelationshipType;
|
||||
/**
|
||||
* User
|
||||
*/
|
||||
user: APIUser;
|
||||
}
|
||||
|
||||
/**
|
||||
* @unstable
|
||||
*/
|
||||
export interface RPCAPIMessage extends APIBaseMessageNoChannel, APIMessageMentions {
|
||||
/**
|
||||
* The nickname of the user who sent the message
|
||||
*/
|
||||
nick?: string;
|
||||
/**
|
||||
* The color of the author's name
|
||||
*/
|
||||
author_color?: number;
|
||||
/**
|
||||
* The content of the message parsed into an array
|
||||
*/
|
||||
content_parsed: (RPCAPIMessageParsedContentMention | RPCAPIMessageParsedContentText)[];
|
||||
}
|
||||
|
||||
/**
|
||||
* @see {@link https://discord.com/developers/docs/topics/rpc#commands-and-events-rpc-commands}
|
||||
*/
|
||||
@@ -435,7 +476,9 @@ export interface RPCSetUserVoiceSettingsArgs {
|
||||
*/
|
||||
pan?: RPCVoicePan;
|
||||
/**
|
||||
* Set the volume of user (defaults to 100, min 0, max 200)
|
||||
* Set the volume of user (min 0, max 200)
|
||||
*
|
||||
* @defaultValue `100`
|
||||
*/
|
||||
volume?: number;
|
||||
/**
|
||||
|
||||
40
deno/rpc/v8.ts
generated
40
deno/rpc/v8.ts
generated
@@ -1 +1,41 @@
|
||||
import type { Snowflake } from '../globals.ts';
|
||||
import type { APIMessage, APIUser } from '../v8.ts';
|
||||
import type { RelationshipType, RPCAPIMessageParsedContentMention, RPCAPIMessageParsedContentText } from './common.ts';
|
||||
|
||||
export * from './common.ts';
|
||||
|
||||
/**
|
||||
* @unstable
|
||||
*/
|
||||
export interface Relationship {
|
||||
/**
|
||||
* The id of the user
|
||||
*/
|
||||
id: Snowflake;
|
||||
/**
|
||||
* Relationship type
|
||||
*/
|
||||
type: RelationshipType;
|
||||
/**
|
||||
* User
|
||||
*/
|
||||
user: APIUser;
|
||||
}
|
||||
|
||||
/**
|
||||
* @unstable
|
||||
*/
|
||||
export interface RPCAPIMessage extends Omit<APIMessage, 'channel_id'> {
|
||||
/**
|
||||
* The nickname of the user who sent the message
|
||||
*/
|
||||
nick?: string;
|
||||
/**
|
||||
* The color of the author's name
|
||||
*/
|
||||
author_color?: number;
|
||||
/**
|
||||
* The content of the message parsed into an array
|
||||
*/
|
||||
content_parsed: (RPCAPIMessageParsedContentMention | RPCAPIMessageParsedContentText)[];
|
||||
}
|
||||
40
deno/rpc/v9.ts
generated
40
deno/rpc/v9.ts
generated
@@ -1 +1,41 @@
|
||||
import type { Snowflake } from '../globals.ts';
|
||||
import type { APIBaseMessageNoChannel, APIMessageMentions, APIUser } from '../v9.ts';
|
||||
import type { RelationshipType, RPCAPIMessageParsedContentMention, RPCAPIMessageParsedContentText } from './common.ts';
|
||||
|
||||
export * from './common.ts';
|
||||
|
||||
/**
|
||||
* @unstable
|
||||
*/
|
||||
export interface Relationship {
|
||||
/**
|
||||
* The id of the user
|
||||
*/
|
||||
id: Snowflake;
|
||||
/**
|
||||
* Relationship type
|
||||
*/
|
||||
type: RelationshipType;
|
||||
/**
|
||||
* User
|
||||
*/
|
||||
user: APIUser;
|
||||
}
|
||||
|
||||
/**
|
||||
* @unstable
|
||||
*/
|
||||
export interface RPCAPIMessage extends APIBaseMessageNoChannel, APIMessageMentions {
|
||||
/**
|
||||
* The nickname of the user who sent the message
|
||||
*/
|
||||
nick?: string;
|
||||
/**
|
||||
* The color of the author's name
|
||||
*/
|
||||
author_color?: number;
|
||||
/**
|
||||
* The content of the message parsed into an array
|
||||
*/
|
||||
content_parsed: (RPCAPIMessageParsedContentMention | RPCAPIMessageParsedContentText)[];
|
||||
}
|
||||
|
||||
16
deno/utils/v8.ts
generated
16
deno/utils/v8.ts
generated
@@ -19,7 +19,7 @@ import { ButtonStyle } from '../payloads/v8/mod.ts';
|
||||
/**
|
||||
* A type-guard check for DM interactions
|
||||
*
|
||||
* @param interaction The interaction to check against
|
||||
* @param interaction - The interaction to check against
|
||||
* @returns A boolean that indicates if the interaction was received in a DM channel
|
||||
* @deprecated API and gateway v8 are deprecated and the types will not receive further updates, please update to v10.
|
||||
*/
|
||||
@@ -30,7 +30,7 @@ export function isDMInteraction(interaction: APIInteraction): interaction is API
|
||||
/**
|
||||
* A type-guard check for guild interactions
|
||||
*
|
||||
* @param interaction The interaction to check against
|
||||
* @param interaction - The interaction to check against
|
||||
* @returns A boolean that indicates if the interaction was received in a guild
|
||||
* @deprecated API and gateway v8 are deprecated and the types will not receive further updates, please update to v10.
|
||||
*/
|
||||
@@ -43,7 +43,7 @@ export function isGuildInteraction(interaction: APIInteraction): interaction is
|
||||
/**
|
||||
* A type-guard check for DM application command interactions
|
||||
*
|
||||
* @param interaction The application command interaction to check against
|
||||
* @param interaction - The application command interaction to check against
|
||||
* @returns A boolean that indicates if the application command interaction was received in a DM channel
|
||||
* @deprecated API and gateway v8 are deprecated and the types will not receive further updates, please update to v10.
|
||||
*/
|
||||
@@ -56,7 +56,7 @@ export function isApplicationCommandDMInteraction(
|
||||
/**
|
||||
* A type-guard check for guild application command interactions
|
||||
*
|
||||
* @param interaction The interaction to check against
|
||||
* @param interaction - The interaction to check against
|
||||
* @returns A boolean that indicates if the application command interaction was received in a guild
|
||||
* @deprecated API and gateway v8 are deprecated and the types will not receive further updates, please update to v10.
|
||||
*/
|
||||
@@ -71,7 +71,7 @@ export function isApplicationCommandGuildInteraction(
|
||||
/**
|
||||
* A type-guard check for DM message component interactions
|
||||
*
|
||||
* @param interaction The message component interaction to check against
|
||||
* @param interaction - The message component interaction to check against
|
||||
* @returns A boolean that indicates if the message component interaction was received in a DM channel
|
||||
* @deprecated API and gateway v8 are deprecated and the types will not receive further updates, please update to v10.
|
||||
*/
|
||||
@@ -84,7 +84,7 @@ export function isMessageComponentDMInteraction(
|
||||
/**
|
||||
* A type-guard check for guild message component interactions
|
||||
*
|
||||
* @param interaction The interaction to check against
|
||||
* @param interaction - The interaction to check against
|
||||
* @returns A boolean that indicates if the message component interaction was received in a guild
|
||||
* @deprecated API and gateway v8 are deprecated and the types will not receive further updates, please update to v10.
|
||||
*/
|
||||
@@ -99,7 +99,7 @@ export function isMessageComponentGuildInteraction(
|
||||
/**
|
||||
* A type-guard check for buttons that have a `url` attached to them.
|
||||
*
|
||||
* @param component The button to check against
|
||||
* @param component - The button to check against
|
||||
* @returns A boolean that indicates if the button has a `url` attached to it
|
||||
* @deprecated API and gateway v8 are deprecated and the types will not receive further updates, please update to v10.
|
||||
*/
|
||||
@@ -110,7 +110,7 @@ export function isLinkButton(component: APIButtonComponent): component is APIBut
|
||||
/**
|
||||
* A type-guard check for buttons that have a `custom_id` attached to them.
|
||||
*
|
||||
* @param component The button to check against
|
||||
* @param component - The button to check against
|
||||
* @returns A boolean that indicates if the button has a `custom_id` attached to it
|
||||
* @deprecated API and gateway v8 are deprecated and the types will not receive further updates, please update to v10.
|
||||
*/
|
||||
|
||||
2
deno/voice/mod.ts
generated
2
deno/voice/mod.ts
generated
@@ -1,4 +1,4 @@
|
||||
// This file exports all the types available in the recommended voice gateway version
|
||||
// Thereby, things MAY break in the future. Try sticking to imports from a specific version
|
||||
|
||||
export * from './v4.ts';
|
||||
export * from './v8.ts';
|
||||
|
||||
62
deno/voice/v4.ts
generated
62
deno/voice/v4.ts
generated
@@ -45,13 +45,63 @@ export enum VoiceOpcodes {
|
||||
*/
|
||||
Resumed,
|
||||
/**
|
||||
* A client has connected to the voice channel
|
||||
* One or more clients have connected to the voice channel
|
||||
*/
|
||||
ClientConnect = 12,
|
||||
ClientsConnect = 11,
|
||||
/**
|
||||
* Previously for when a client has connected to the voice channel, now unused
|
||||
*
|
||||
* @deprecated Not used
|
||||
*/
|
||||
ClientConnect,
|
||||
/**
|
||||
* A client has disconnected from the voice channel
|
||||
*/
|
||||
ClientDisconnect,
|
||||
/**
|
||||
* A downgrade from the DAVE protocol is upcoming
|
||||
*/
|
||||
DavePrepareTransition = 21,
|
||||
/**
|
||||
* Execute a previously announced protocol transition
|
||||
*/
|
||||
DaveExecuteTransition,
|
||||
/**
|
||||
* Acknowledge readiness previously announced transition
|
||||
*/
|
||||
DaveTransitionReady,
|
||||
/**
|
||||
* A DAVE protocol version or group change is upcoming
|
||||
*/
|
||||
DavePrepareEpoch,
|
||||
/**
|
||||
* Credential and public key for MLS external sender
|
||||
*/
|
||||
DaveMlsExternalSender,
|
||||
/**
|
||||
* MLS Key Package for pending group member
|
||||
*/
|
||||
DaveMlsKeyPackage,
|
||||
/**
|
||||
* MLS Proposals to be appended or revoked
|
||||
*/
|
||||
DaveMlsProposals,
|
||||
/**
|
||||
* MLS Commit with optional MLS Welcome messages
|
||||
*/
|
||||
DaveMlsCommitWelcome,
|
||||
/**
|
||||
* MLS Commit to be processed for upcoming transition
|
||||
*/
|
||||
DaveMlsAnnounceCommitTransition,
|
||||
/**
|
||||
* MLS Welcome to group for upcoming transition
|
||||
*/
|
||||
DaveMlsWelcome,
|
||||
/**
|
||||
* Flag invalid commit or welcome, request re-add
|
||||
*/
|
||||
DaveMlsInvalidCommitWelcome,
|
||||
}
|
||||
|
||||
/**
|
||||
@@ -110,4 +160,12 @@ export enum VoiceCloseCodes {
|
||||
* You sent a malformed request
|
||||
*/
|
||||
BadRequest = 4_020,
|
||||
/**
|
||||
* Disconnect due to rate limit exceeded. Should not reconnect
|
||||
*/
|
||||
RateLimited,
|
||||
/**
|
||||
* Disconnect all clients due to call terminated (channel deleted, voice server changed, etc.). Should not reconnect
|
||||
*/
|
||||
CallTerminated,
|
||||
}
|
||||
|
||||
706
deno/voice/v8.ts
generated
Normal file
706
deno/voice/v8.ts
generated
Normal file
@@ -0,0 +1,706 @@
|
||||
import type { Snowflake } from "../globals";
|
||||
|
||||
export const VoiceGatewayVersion = '8';
|
||||
|
||||
/**
|
||||
* @see {@link https://discord.com/developers/docs/topics/opcodes-and-status-codes#voice-voice-opcodes}
|
||||
*/
|
||||
export enum VoiceOpcodes {
|
||||
/**
|
||||
* Begin a voice websocket connection
|
||||
*/
|
||||
Identify,
|
||||
/**
|
||||
* Select the voice protocol
|
||||
*/
|
||||
SelectProtocol,
|
||||
/**
|
||||
* Complete the websocket handshake
|
||||
*/
|
||||
Ready,
|
||||
/**
|
||||
* Keep the websocket connection alive
|
||||
*/
|
||||
Heartbeat,
|
||||
/**
|
||||
* Describe the session
|
||||
*/
|
||||
SessionDescription,
|
||||
/**
|
||||
* Indicate which users are speaking
|
||||
*/
|
||||
Speaking,
|
||||
/**
|
||||
* Sent to acknowledge a received client heartbeat
|
||||
*/
|
||||
HeartbeatAck,
|
||||
/**
|
||||
* Resume a connection
|
||||
*/
|
||||
Resume,
|
||||
/**
|
||||
* Time to wait between sending heartbeats in milliseconds
|
||||
*/
|
||||
Hello,
|
||||
/**
|
||||
* Acknowledge a successful session resume
|
||||
*/
|
||||
Resumed,
|
||||
/**
|
||||
* One or more clients have connected to the voice channel
|
||||
*/
|
||||
ClientsConnect = 11,
|
||||
/**
|
||||
* A client has disconnected from the voice channel
|
||||
*/
|
||||
ClientDisconnect = 13,
|
||||
/**
|
||||
* A downgrade from the DAVE protocol is upcoming
|
||||
*/
|
||||
DavePrepareTransition = 21,
|
||||
/**
|
||||
* Execute a previously announced protocol transition
|
||||
*/
|
||||
DaveExecuteTransition,
|
||||
/**
|
||||
* Acknowledge readiness previously announced transition
|
||||
*/
|
||||
DaveTransitionReady,
|
||||
/**
|
||||
* A DAVE protocol version or group change is upcoming
|
||||
*/
|
||||
DavePrepareEpoch,
|
||||
/**
|
||||
* Credential and public key for MLS external sender
|
||||
*/
|
||||
DaveMlsExternalSender,
|
||||
/**
|
||||
* MLS Key Package for pending group member
|
||||
*/
|
||||
DaveMlsKeyPackage,
|
||||
/**
|
||||
* MLS Proposals to be appended or revoked
|
||||
*/
|
||||
DaveMlsProposals,
|
||||
/**
|
||||
* MLS Commit with optional MLS Welcome messages
|
||||
*/
|
||||
DaveMlsCommitWelcome,
|
||||
/**
|
||||
* MLS Commit to be processed for upcoming transition
|
||||
*/
|
||||
DaveMlsAnnounceCommitTransition,
|
||||
/**
|
||||
* MLS Welcome to group for upcoming transition
|
||||
*/
|
||||
DaveMlsWelcome,
|
||||
/**
|
||||
* Flag invalid commit or welcome, request re-add
|
||||
*/
|
||||
DaveMlsInvalidCommitWelcome,
|
||||
}
|
||||
|
||||
/**
|
||||
* @see {@link https://discord.com/developers/docs/topics/opcodes-and-status-codes#voice-voice-close-event-codes}
|
||||
*/
|
||||
export enum VoiceCloseCodes {
|
||||
/**
|
||||
* You sent an invalid opcode
|
||||
*/
|
||||
UnknownOpcode = 4_001,
|
||||
/**
|
||||
* You sent a invalid payload in your identifying to the Gateway
|
||||
*/
|
||||
FailedToDecode,
|
||||
/**
|
||||
* You sent a payload before identifying with the Gateway
|
||||
*/
|
||||
NotAuthenticated,
|
||||
/**
|
||||
* The token you sent in your identify payload is incorrect
|
||||
*/
|
||||
AuthenticationFailed,
|
||||
/**
|
||||
* You sent more than one identify payload. Stahp
|
||||
*/
|
||||
AlreadyAuthenticated,
|
||||
/**
|
||||
* Your session is no longer valid
|
||||
*/
|
||||
SessionNoLongerValid,
|
||||
/**
|
||||
* Your session has timed out
|
||||
*/
|
||||
SessionTimeout = 4_009,
|
||||
/**
|
||||
* We can't find the server you're trying to connect to
|
||||
*/
|
||||
ServerNotFound = 4_011,
|
||||
/**
|
||||
* We didn't recognize the protocol you sent
|
||||
*/
|
||||
UnknownProtocol,
|
||||
/**
|
||||
* Either the channel was deleted, you were kicked, or the main gateway session was dropped. Should not reconnect
|
||||
*/
|
||||
Disconnected = 4_014,
|
||||
/**
|
||||
* The server crashed. Our bad! Try resuming
|
||||
*/
|
||||
VoiceServerCrashed,
|
||||
/**
|
||||
* We didn't recognize your encryption
|
||||
*/
|
||||
UnknownEncryptionMode,
|
||||
/**
|
||||
* You sent a malformed request
|
||||
*/
|
||||
BadRequest = 4_020,
|
||||
/**
|
||||
* Disconnect due to rate limit exceeded. Should not reconnect
|
||||
*/
|
||||
RateLimited,
|
||||
/**
|
||||
* Disconnect all clients due to call terminated (channel deleted, voice server changed, etc.). Should not reconnect
|
||||
*/
|
||||
CallTerminated,
|
||||
}
|
||||
|
||||
/**
|
||||
* @see {@link https://discord.com/developers/docs/topics/voice-connections#transport-encryption-modes}
|
||||
*/
|
||||
export enum VoiceEncryptionMode {
|
||||
/**
|
||||
* AEAD AES256-GCM (RTP Size)
|
||||
*/
|
||||
AeadAes256GcmRtpSize = 'aead_aes256_gcm_rtpsize',
|
||||
/**
|
||||
* AEAD XChaCha20 Poly1305 (RTP Size)
|
||||
*/
|
||||
AeadXChaCha20Poly1305RtpSize = 'aead_xchacha20_poly1305_rtpsize',
|
||||
/**
|
||||
* XSalsa20 Poly1305 Lite (RTP Size)
|
||||
*
|
||||
* @deprecated This encryption mode has been discontinued.
|
||||
*/
|
||||
XSalsa20Poly1305LiteRtpSize = 'xsalsa20_poly1305_lite_rtpsize',
|
||||
/**
|
||||
* AEAD AES256-GCM
|
||||
*
|
||||
* @deprecated This encryption mode has been discontinued.
|
||||
*/
|
||||
AeadAes256Gcm = 'aead_aes256_gcm',
|
||||
/**
|
||||
* XSalsa20 Poly1305
|
||||
*
|
||||
* @deprecated This encryption mode has been discontinued.
|
||||
*/
|
||||
XSalsa20Poly1305 = 'xsalsa20_poly1305',
|
||||
/**
|
||||
* XSalsa20 Poly1305 Suffix
|
||||
*
|
||||
* @deprecated This encryption mode has been discontinued.
|
||||
*/
|
||||
XSalsa20Poly1305Suffix = 'xsalsa20_poly1305_suffix',
|
||||
/**
|
||||
* XSalsa20 Poly1305 Lite
|
||||
*
|
||||
* @deprecated This encryption mode has been discontinued.
|
||||
*/
|
||||
XSalsa20Poly1305Lite = 'xsalsa20_poly1305_lite',
|
||||
}
|
||||
|
||||
/**
|
||||
* @see {@link https://discord.com/developers/docs/topics/voice-connections#speaking}
|
||||
*/
|
||||
export enum VoiceSpeakingFlags {
|
||||
/**
|
||||
* Normal transmission of voice audio
|
||||
*/
|
||||
Microphone = 1 << 0,
|
||||
/**
|
||||
* Transmission of context audio for video, no speaking indicator
|
||||
*/
|
||||
Soundshare = 1 << 1,
|
||||
/**
|
||||
* Priority speaker, lowering audio of other speakers
|
||||
*/
|
||||
Priority = 1 << 2,
|
||||
}
|
||||
|
||||
export type VoiceSendPayload =
|
||||
| VoiceDaveMlsInvalidCommitWelcome
|
||||
| VoiceDaveTransitionReady
|
||||
| VoiceHeartbeat
|
||||
| VoiceIdentify
|
||||
| VoiceResume
|
||||
| VoiceSelectProtocol
|
||||
| VoiceSpeakingSend;
|
||||
|
||||
export type VoiceReceivePayload =
|
||||
| VoiceClientDisconnect
|
||||
| VoiceClientsConnect
|
||||
| VoiceDaveExecuteTransition
|
||||
| VoiceDavePrepareEpoch
|
||||
| VoiceDavePrepareTransition
|
||||
| VoiceHeartbeatAck
|
||||
| VoiceHello
|
||||
| VoiceReady
|
||||
| VoiceResumed
|
||||
| VoiceSessionDescription
|
||||
| VoiceSpeaking;
|
||||
|
||||
// #region Server Payloads
|
||||
|
||||
/**
|
||||
* @see {@link https://discord.com/developers/docs/topics/voice-connections#heartbeating}
|
||||
*/
|
||||
export type VoiceHello = _DataPayload<VoiceOpcodes.Hello, VoiceHelloData>;
|
||||
|
||||
/**
|
||||
* @see {@link https://discord.com/developers/docs/topics/voice-connections#heartbeating}
|
||||
*/
|
||||
export interface VoiceHelloData {
|
||||
/**
|
||||
* Voice gateway version
|
||||
*
|
||||
* @see {@link https://discord.com/developers/docs/topics/voice-connections#voice-gateway-versioning-gateway-versions}
|
||||
*/
|
||||
v: number;
|
||||
/**
|
||||
* The interval (in milliseconds) the client should heartbeat with
|
||||
*/
|
||||
heartbeat_interval: number;
|
||||
}
|
||||
|
||||
/**
|
||||
* @see {@link https://discord.com/developers/docs/topics/voice-connections#establishing-a-voice-websocket-connection}
|
||||
*/
|
||||
export type VoiceReady = _DataPayload<VoiceOpcodes.Ready, VoiceReadyData>;
|
||||
|
||||
/**
|
||||
* @see {@link https://discord.com/developers/docs/topics/voice-connections#establishing-a-voice-websocket-connection}
|
||||
*/
|
||||
export interface VoiceReadyData {
|
||||
/**
|
||||
* SSRC identifier
|
||||
*/
|
||||
ssrc: number;
|
||||
/**
|
||||
* UDP IP
|
||||
*/
|
||||
ip: string;
|
||||
/**
|
||||
* UDP port
|
||||
*/
|
||||
port: number;
|
||||
/**
|
||||
* Supported encryption modes
|
||||
*
|
||||
* @see {@link https://discord.com/developers/docs/topics/voice-connections#transport-encryption-modes}
|
||||
*/
|
||||
modes: VoiceEncryptionMode[];
|
||||
}
|
||||
|
||||
/**
|
||||
* @see {@link https://discord.com/developers/docs/topics/voice-connections#heartbeating}
|
||||
*/
|
||||
export type VoiceHeartbeatAck = _DataPayload<VoiceOpcodes.HeartbeatAck, VoiceHeartbeatAckData>;
|
||||
|
||||
/**
|
||||
* @see {@link https://discord.com/developers/docs/topics/voice-connections#heartbeating}
|
||||
*/
|
||||
export interface VoiceHeartbeatAckData {
|
||||
/**
|
||||
* The integer nonce
|
||||
*/
|
||||
t: number;
|
||||
}
|
||||
|
||||
/**
|
||||
* @see {@link https://discord.com/developers/docs/topics/voice-connections#transport-encryption-and-sending-voice}
|
||||
*/
|
||||
export type VoiceSessionDescription = _DataPayload<VoiceOpcodes.SessionDescription, VoiceSessionDescriptionData>;
|
||||
|
||||
/**
|
||||
* @see {@link https://discord.com/developers/docs/topics/voice-connections#transport-encryption-and-sending-voice}
|
||||
*/
|
||||
export interface VoiceSessionDescriptionData {
|
||||
/**
|
||||
* The selected mode
|
||||
*/
|
||||
mode: VoiceEncryptionMode;
|
||||
/**
|
||||
* The secret key
|
||||
*/
|
||||
secret_key: number[];
|
||||
/**
|
||||
* The selected DAVE protocol version
|
||||
*
|
||||
* @see {@link https://daveprotocol.com/#select_protocol_ack-4}
|
||||
*/
|
||||
dave_protocol_version: number;
|
||||
}
|
||||
|
||||
/**
|
||||
* @see {@link https://discord.com/developers/docs/topics/voice-connections#resuming-voice-connection}
|
||||
*/
|
||||
export type VoiceResumed = _DataPayload<VoiceOpcodes.Resumed, null>;
|
||||
|
||||
/**
|
||||
* @see {@link https://discord.com/developers/docs/topics/voice-connections#speaking}
|
||||
*/
|
||||
export type VoiceSpeaking = _DataPayload<VoiceOpcodes.Speaking, VoiceSpeakingData>;
|
||||
|
||||
/**
|
||||
* @see {@link https://discord.com/developers/docs/topics/voice-connections#speaking}
|
||||
*/
|
||||
export interface VoiceSpeakingData {
|
||||
/**
|
||||
* The speaking mode flags
|
||||
*/
|
||||
speaking: VoiceSpeakingFlags;
|
||||
/**
|
||||
* SSRC identifier
|
||||
*/
|
||||
ssrc: number;
|
||||
/**
|
||||
* User id
|
||||
*/
|
||||
user_id: Snowflake;
|
||||
}
|
||||
|
||||
/**
|
||||
* @see {@link https://daveprotocol.com/#clients_connect-11}
|
||||
*/
|
||||
export type VoiceClientsConnect = _DataPayload<VoiceOpcodes.ClientsConnect, VoiceClientsConnectData>;
|
||||
|
||||
/**
|
||||
* @see {@link https://daveprotocol.com/#clients_connect-11}
|
||||
*/
|
||||
export interface VoiceClientsConnectData {
|
||||
/**
|
||||
* The connected user ids
|
||||
*/
|
||||
user_ids: Snowflake[];
|
||||
}
|
||||
|
||||
/**
|
||||
* @see {@link https://discord.com/developers/docs/topics/voice-connections}
|
||||
*/
|
||||
export type VoiceClientDisconnect = _DataPayload<VoiceOpcodes.ClientDisconnect, VoiceClientDisconnectData>;
|
||||
|
||||
/**
|
||||
* @see {@link https://discord.com/developers/docs/topics/voice-connections}
|
||||
*/
|
||||
export interface VoiceClientDisconnectData {
|
||||
/**
|
||||
* The disconnected user id
|
||||
*/
|
||||
user_id: Snowflake;
|
||||
}
|
||||
|
||||
/**
|
||||
* @see {@link https://daveprotocol.com/#dave_protocol_prepare_transition-21}
|
||||
*/
|
||||
export type VoiceDavePrepareTransition = _DataPayload<VoiceOpcodes.DavePrepareTransition, VoiceDavePrepareTransitionData>;
|
||||
|
||||
/**
|
||||
* @see {@link https://daveprotocol.com/#dave_protocol_prepare_transition-21}
|
||||
*/
|
||||
export interface VoiceDavePrepareTransitionData {
|
||||
/**
|
||||
* The protocol version
|
||||
*/
|
||||
protocol_version: number;
|
||||
/**
|
||||
* The transition id
|
||||
*/
|
||||
transition_id: number;
|
||||
}
|
||||
|
||||
/**
|
||||
* @see {@link https://daveprotocol.com/#dave_protocol_execute_transition-22}
|
||||
*/
|
||||
export type VoiceDaveExecuteTransition = _DataPayload<VoiceOpcodes.DaveExecuteTransition, VoiceDaveExecuteTransitionData>;
|
||||
|
||||
/**
|
||||
* @see {@link https://daveprotocol.com/#dave_protocol_execute_transition-22}
|
||||
*/
|
||||
export interface VoiceDaveExecuteTransitionData {
|
||||
/**
|
||||
* The transition id
|
||||
*/
|
||||
transition_id: number;
|
||||
}
|
||||
|
||||
/**
|
||||
* @see {@link https://daveprotocol.com/#dave_mls_external_sender_package-25}
|
||||
*/
|
||||
export type VoiceDaveMlsExternalSender = VoiceBinaryPayload;
|
||||
|
||||
/**
|
||||
* @see {@link https://daveprotocol.com/#dave_mls_proposals-27}
|
||||
*/
|
||||
export type VoiceDaveMlsProposals = VoiceBinaryPayload;
|
||||
|
||||
/**
|
||||
* @see {@link https://daveprotocol.com/#dave_mls_announce_commit_transition-29}
|
||||
*/
|
||||
export type VoiceDaveMlsAnnounceCommitTransition = VoiceBinaryPayload;
|
||||
|
||||
/**
|
||||
* @see {@link https://daveprotocol.com/#dave_mls_welcome-30}
|
||||
*/
|
||||
export type VoiceDaveMlsWelcome = VoiceBinaryPayload;
|
||||
|
||||
// #endregion Server Payloads
|
||||
|
||||
// #region Sendable Payloads
|
||||
|
||||
/**
|
||||
* @see {@link https://discord.com/developers/docs/topics/voice-connections#establishing-a-voice-websocket-connection}
|
||||
*/
|
||||
export interface VoiceIdentify {
|
||||
op: VoiceOpcodes.Identify;
|
||||
d: VoiceIdentifyData;
|
||||
}
|
||||
|
||||
/**
|
||||
* @see {@link https://discord.com/developers/docs/topics/voice-connections#establishing-a-voice-websocket-connection}
|
||||
*/
|
||||
export interface VoiceIdentifyData {
|
||||
/**
|
||||
* The id of the server to connect to
|
||||
*/
|
||||
server_id: Snowflake;
|
||||
/**
|
||||
* The id of the user to connect as
|
||||
*/
|
||||
user_id: Snowflake;
|
||||
/**
|
||||
* Voice state session id
|
||||
*/
|
||||
session_id: string;
|
||||
/**
|
||||
* Voice connection token
|
||||
*/
|
||||
token: string;
|
||||
/**
|
||||
* The maximum DAVE protocol version supported
|
||||
*/
|
||||
max_dave_protocol_version?: number;
|
||||
}
|
||||
|
||||
/**
|
||||
* @see {@link https://discord.com/developers/docs/topics/voice-connections#establishing-a-voice-websocket-connection}
|
||||
*/
|
||||
export interface VoiceHeartbeat {
|
||||
op: VoiceOpcodes.Heartbeat;
|
||||
d: VoiceHeartbeatData;
|
||||
}
|
||||
|
||||
/**
|
||||
* @see {@link https://discord.com/developers/docs/topics/voice-connections#establishing-a-voice-websocket-connection}
|
||||
*/
|
||||
export interface VoiceHeartbeatData {
|
||||
/**
|
||||
* The integer nonce
|
||||
*/
|
||||
t: number;
|
||||
/**
|
||||
* The last sequence number recieved
|
||||
*/
|
||||
seq_ack: number;
|
||||
}
|
||||
|
||||
/**
|
||||
* @see {@link https://discord.com/developers/docs/topics/voice-connections#establishing-a-voice-udp-connection}
|
||||
*/
|
||||
export interface VoiceSelectProtocol {
|
||||
op: VoiceOpcodes.SelectProtocol;
|
||||
d: VoiceSelectProtocolData;
|
||||
}
|
||||
|
||||
/**
|
||||
* @see {@link https://discord.com/developers/docs/topics/voice-connections#establishing-a-voice-udp-connection}
|
||||
*/
|
||||
export interface VoiceSelectProtocolData {
|
||||
/**
|
||||
* Voice protocol
|
||||
*/
|
||||
protocol: string;
|
||||
/**
|
||||
* Data associated with the protocol
|
||||
*/
|
||||
data: VoiceUDPProtocolData;
|
||||
}
|
||||
|
||||
/**
|
||||
* @see {@link https://discord.com/developers/docs/topics/voice-connections#establishing-a-voice-udp-connection}
|
||||
*/
|
||||
export interface VoiceUDPProtocolData {
|
||||
/**
|
||||
* External address
|
||||
*/
|
||||
address: string;
|
||||
/**
|
||||
* External UDP port
|
||||
*/
|
||||
port: number;
|
||||
/**
|
||||
* Selected mode
|
||||
*
|
||||
* @see {@link https://discord.com/developers/docs/topics/voice-connections#transport-encryption-modes}
|
||||
*/
|
||||
mode: VoiceEncryptionMode;
|
||||
}
|
||||
|
||||
/**
|
||||
* @see {@link https://discord.com/developers/docs/topics/voice-connections#resuming-voice-connection}
|
||||
*/
|
||||
export interface VoiceResume {
|
||||
op: VoiceOpcodes.Resume;
|
||||
d: VoiceResumeData;
|
||||
}
|
||||
|
||||
/**
|
||||
* @see {@link https://discord.com/developers/docs/topics/voice-connections#resuming-voice-connection}
|
||||
*/
|
||||
export interface VoiceResumeData {
|
||||
/**
|
||||
* The id of the server to connect to
|
||||
*/
|
||||
server_id: Snowflake;
|
||||
/**
|
||||
* Voice state session id
|
||||
*/
|
||||
session_id: string;
|
||||
/**
|
||||
* Voice connection token
|
||||
*/
|
||||
token: string;
|
||||
/**
|
||||
* Last recieved sequence number
|
||||
*/
|
||||
seq_ack: number;
|
||||
}
|
||||
|
||||
/**
|
||||
* @see {@link https://discord.com/developers/docs/topics/voice-connections#speaking}
|
||||
*/
|
||||
export interface VoiceSpeakingSend {
|
||||
op: VoiceOpcodes.Speaking;
|
||||
d: VoiceSpeakingSendData;
|
||||
}
|
||||
|
||||
/**
|
||||
* @see {@link https://discord.com/developers/docs/topics/voice-connections#speaking}
|
||||
*/
|
||||
export interface VoiceSpeakingSendData {
|
||||
/**
|
||||
* The speaking mode flags
|
||||
*/
|
||||
speaking: VoiceSpeakingFlags;
|
||||
/**
|
||||
* Voice delay
|
||||
*/
|
||||
delay: number;
|
||||
/**
|
||||
* SSRC identifier
|
||||
*/
|
||||
ssrc: number;
|
||||
}
|
||||
|
||||
/**
|
||||
* @see {@link https://daveprotocol.com/#dave_protocol_ready_for_transition-23}
|
||||
*/
|
||||
export interface VoiceDaveTransitionReady {
|
||||
op: VoiceOpcodes.DaveTransitionReady;
|
||||
d: VoiceDaveTransitionReadyData;
|
||||
}
|
||||
|
||||
/**
|
||||
* @see {@link https://daveprotocol.com/#dave_protocol_ready_for_transition-23}
|
||||
*/
|
||||
export interface VoiceDaveTransitionReadyData {
|
||||
/**
|
||||
* The transition id
|
||||
*/
|
||||
transition_id: number;
|
||||
}
|
||||
|
||||
/**
|
||||
* @see {@link https://daveprotocol.com/#dave_protocol_prepare_epoch-24}
|
||||
*/
|
||||
export interface VoiceDavePrepareEpoch {
|
||||
op: VoiceOpcodes.DavePrepareEpoch;
|
||||
d: VoiceDavePrepareEpochData;
|
||||
}
|
||||
|
||||
/**
|
||||
* @see {@link https://daveprotocol.com/#dave_protocol_prepare_epoch-24}
|
||||
*/
|
||||
export interface VoiceDavePrepareEpochData {
|
||||
/**
|
||||
* The protocol version
|
||||
*/
|
||||
protocol_version: number;
|
||||
/**
|
||||
* The epoch id
|
||||
*/
|
||||
epoch: number;
|
||||
}
|
||||
|
||||
/**
|
||||
* @see {@link https://daveprotocol.com/#dave_mls_invalid_commit_welcome-31}
|
||||
*/
|
||||
export interface VoiceDaveMlsInvalidCommitWelcome {
|
||||
op: VoiceOpcodes.DaveMlsInvalidCommitWelcome;
|
||||
d: VoiceDaveMlsInvalidCommitWelcomeData;
|
||||
}
|
||||
|
||||
/**
|
||||
* @see {@link https://daveprotocol.com/#dave_mls_invalid_commit_welcome-31}
|
||||
*/
|
||||
export interface VoiceDaveMlsInvalidCommitWelcomeData {
|
||||
/**
|
||||
* The transition id
|
||||
*/
|
||||
transition_id: number;
|
||||
}
|
||||
|
||||
/**
|
||||
* @see {@link https://daveprotocol.com/#dave_mls_key_package-26}
|
||||
*/
|
||||
export type VoiceDaveMlsKeyPackage = VoiceBinaryPayload;
|
||||
|
||||
/**
|
||||
* @see {@link https://daveprotocol.com/#dave_mls_commit_welcome-28}
|
||||
*/
|
||||
export type VoiceDaveMlsCommitWelcome = VoiceBinaryPayload;
|
||||
// #endregion
|
||||
|
||||
// #region Shared
|
||||
export interface _BasePayload {
|
||||
/**
|
||||
* Opcode for the payload
|
||||
*/
|
||||
op: VoiceOpcodes;
|
||||
/**
|
||||
* Event data
|
||||
*/
|
||||
d?: unknown;
|
||||
/**
|
||||
* Sequence number, used for resuming sessions and heartbeats
|
||||
*/
|
||||
seq?: number;
|
||||
}
|
||||
|
||||
export interface _DataPayload<Op extends VoiceOpcodes, D = unknown> extends _BasePayload {
|
||||
op: Op;
|
||||
d: D;
|
||||
}
|
||||
|
||||
export type VoiceBinaryPayload = ArrayBuffer;
|
||||
// #endregion Shared
|
||||
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user