@discordjs/rest 0.6.0-dev.1655597378-3a77ce0 → 0.6.0-dev.1655640258-358c3f4

package/dist/index.d.ts

@@ -1,8 +1,765 @@
-export * from './lib/CDN';
-export * from './lib/errors/DiscordAPIError';
-export * from './lib/errors/HTTPError';
-export * from './lib/errors/RateLimitError';
-export * from './lib/RequestManager';
-export * from './lib/REST';
-export * from './lib/utils/constants';
-export { makeURLSearchParams, parseResponse } from './lib/utils/utils';
+import { EventEmitter } from 'node:events';
+import { Collection } from '@discordjs/collection';
+import { Dispatcher, BodyInit, Agent, request } from 'undici';
+import { URLSearchParams as URLSearchParams$1 } from 'node:url';
+
+interface IHandler {
+    queueRequest: (routeId: RouteData, url: string, options: RequestOptions, requestData: HandlerRequestData) => Promise<Dispatcher.ResponseData>;
+    get inactive(): boolean;
+    readonly id: string;
+}
+
+/**
+ * Represents a file to be added to the request
+ */
+interface RawFile {
+    /**
+     * The name of the file
+     */
+    name: string;
+    /**
+     * An explicit key to use for key of the formdata field for this file.
+     * When not provided, the index of the file in the files array is used in the form `files[${index}]`.
+     * If you wish to alter the placeholder snowflake, you must provide this property in the same form (`files[${placeholder}]`)
+     */
+    key?: string;
+    /**
+     * The actual data for the file
+     */
+    data: string | number | boolean | Buffer;
+}
+/**
+ * Represents possible data to be given to an endpoint
+ */
+interface RequestData {
+    /**
+     * Whether to append JSON data to form data instead of `payload_json` when sending files
+     */
+    appendToFormData?: boolean;
+    /**
+     * If this request needs the `Authorization` header
+     * @default true
+     */
+    auth?: boolean;
+    /**
+     * The authorization prefix to use for this request, useful if you use this with bearer tokens
+     * @default 'Bot'
+     */
+    authPrefix?: 'Bot' | 'Bearer';
+    /**
+     * The body to send to this request.
+     * If providing as BodyInit, set `passThroughBody: true`
+     */
+    body?: BodyInit | unknown;
+    /**
+     * The {@link https://undici.nodejs.org/#/docs/api/Agent Agent} to use for the request.
+     */
+    dispatcher?: Agent;
+    /**
+     * Files to be attached to this request
+     */
+    files?: RawFile[] | undefined;
+    /**
+     * Additional headers to add to this request
+     */
+    headers?: Record<string, string>;
+    /**
+     * Whether to pass-through the body property directly to `fetch()`.
+     * <warn>This only applies when files is NOT present</warn>
+     */
+    passThroughBody?: boolean;
+    /**
+     * Query string parameters to append to the called endpoint
+     */
+    query?: URLSearchParams;
+    /**
+     * Reason to show in the audit logs
+     */
+    reason?: string;
+    /**
+     * If this request should be versioned
+     * @default true
+     */
+    versioned?: boolean;
+}
+/**
+ * Possible headers for an API call
+ */
+interface RequestHeaders {
+    Authorization?: string;
+    'User-Agent': string;
+    'X-Audit-Log-Reason'?: string;
+}
+/**
+ * Possible API methods to be used when doing requests
+ */
+declare const enum RequestMethod {
+    Delete = "DELETE",
+    Get = "GET",
+    Patch = "PATCH",
+    Post = "POST",
+    Put = "PUT"
+}
+declare type RouteLike = `/${string}`;
+/**
+ * Internal request options
+ *
+ * @internal
+ */
+interface InternalRequest extends RequestData {
+    method: RequestMethod;
+    fullRoute: RouteLike;
+}
+declare type HandlerRequestData = Pick<InternalRequest, 'files' | 'body' | 'auth'>;
+/**
+ * Parsed route data for an endpoint
+ *
+ * @internal
+ */
+interface RouteData {
+    majorParameter: string;
+    bucketRoute: string;
+    original: RouteLike;
+}
+/**
+ * Represents a hash and its associated fields
+ *
+ * @internal
+ */
+interface HashData {
+    value: string;
+    lastAccess: number;
+}
+interface RequestManager {
+    on: (<K extends keyof RestEvents>(event: K, listener: (...args: RestEvents[K]) => void) => this) & (<S extends string | symbol>(event: Exclude<S, keyof RestEvents>, listener: (...args: any[]) => void) => this);
+    once: (<K extends keyof RestEvents>(event: K, listener: (...args: RestEvents[K]) => void) => this) & (<S extends string | symbol>(event: Exclude<S, keyof RestEvents>, listener: (...args: any[]) => void) => this);
+    emit: (<K extends keyof RestEvents>(event: K, ...args: RestEvents[K]) => boolean) & (<S extends string | symbol>(event: Exclude<S, keyof RestEvents>, ...args: any[]) => boolean);
+    off: (<K extends keyof RestEvents>(event: K, listener: (...args: RestEvents[K]) => void) => this) & (<S extends string | symbol>(event: Exclude<S, keyof RestEvents>, listener: (...args: any[]) => void) => this);
+    removeAllListeners: (<K extends keyof RestEvents>(event?: K) => this) & (<S extends string | symbol>(event?: Exclude<S, keyof RestEvents>) => this);
+}
+/**
+ * Represents the class that manages handlers for endpoints
+ */
+declare class RequestManager extends EventEmitter {
+    #private;
+    /**
+     * The {@link https://undici.nodejs.org/#/docs/api/Agent Agent} for all requests
+     * performed by this manager.
+     */
+    agent: Dispatcher | null;
+    /**
+     * The number of requests remaining in the global bucket
+     */
+    globalRemaining: number;
+    /**
+     * The promise used to wait out the global rate limit
+     */
+    globalDelay: Promise<void> | null;
+    /**
+     * The timestamp at which the global bucket resets
+     */
+    globalReset: number;
+    /**
+     * API bucket hashes that are cached from provided routes
+     */
+    readonly hashes: Collection<string, HashData>;
+    /**
+     * Request handlers created from the bucket hash and the major parameters
+     */
+    readonly handlers: Collection<string, IHandler>;
+    private hashTimer;
+    private handlerTimer;
+    readonly options: RESTOptions;
+    constructor(options: Partial<RESTOptions>);
+    private setupSweepers;
+    /**
+     * Sets the default agent to use for requests performed by this manager
+     * @param agent The agent to use
+     */
+    setAgent(agent: Dispatcher): this;
+    /**
+     * Sets the authorization token that should be used for requests
+     * @param token The authorization token to use
+     */
+    setToken(token: string): this;
+    /**
+     * Queues a request to be sent
+     * @param request All the information needed to make a request
+     * @returns The response from the api request
+     */
+    queueRequest(request: InternalRequest): Promise<Dispatcher.ResponseData>;
+    /**
+     * Creates a new rate limit handler from a hash, based on the hash and the major parameter
+     * @param hash The hash for the route
+     * @param majorParameter The major parameter for this handler
+     * @private
+     */
+    private createHandler;
+    /**
+     * Formats the request data to a usable format for fetch
+     * @param request The request data
+     */
+    private resolveRequest;
+    /**
+     * Stops the hash sweeping interval
+     */
+    clearHashSweeper(): void;
+    /**
+     * Stops the request handler sweeping interval
+     */
+    clearHandlerSweeper(): void;
+    /**
+     * Generates route data for an endpoint:method
+     * @param endpoint The raw endpoint to generalize
+     * @param method The HTTP method this endpoint is called without
+     * @private
+     */
+    private static generateRouteData;
+}
+
+/**
+ * Options to be passed when creating the REST instance
+ */
+interface RESTOptions {
+    /**
+     * The agent to set globally
+     */
+    agent: Dispatcher;
+    /**
+     * The base api path, without version
+     * @default 'https://discord.com/api'
+     */
+    api: string;
+    /**
+     * The authorization prefix to use for requests, useful if you want to use
+     * bearer tokens
+     * @default 'Bot'
+     */
+    authPrefix: 'Bot' | 'Bearer';
+    /**
+     * The cdn path
+     * @default 'https://cdn.discordapp.com'
+     */
+    cdn: string;
+    /**
+     * Additional headers to send for all API requests
+     * @default {}
+     */
+    headers: Record<string, string>;
+    /**
+     * The number of invalid REST requests (those that return 401, 403, or 429) in a 10 minute window between emitted warnings (0 for no warnings).
+     * That is, if set to 500, warnings will be emitted at invalid request number 500, 1000, 1500, and so on.
+     * @default 0
+     */
+    invalidRequestWarningInterval: number;
+    /**
+     * How many requests to allow sending per second (Infinity for unlimited, 50 for the standard global limit used by Discord)
+     * @default 50
+     */
+    globalRequestsPerSecond: number;
+    /**
+     * The extra offset to add to rate limits in milliseconds
+     * @default 50
+     */
+    offset: number;
+    /**
+     * Determines how rate limiting and pre-emptive throttling should be handled.
+     * When an array of strings, each element is treated as a prefix for the request route
+     * (e.g. `/channels` to match any route starting with `/channels` such as `/channels/:id/messages`)
+     * for which to throw {@link RateLimitError}s. All other request routes will be queued normally
+     * @default null
+     */
+    rejectOnRateLimit: string[] | RateLimitQueueFilter | null;
+    /**
+     * The number of retries for errors with the 500 code, or errors
+     * that timeout
+     * @default 3
+     */
+    retries: number;
+    /**
+     * The time to wait in milliseconds before a request is aborted
+     * @default 15_000
+     */
+    timeout: number;
+    /**
+     * Extra information to add to the user agent
+     * @default `Node.js ${process.version}`
+     */
+    userAgentAppendix: string;
+    /**
+     * The version of the API to use
+     * @default '10'
+     */
+    version: string;
+    /**
+     * The amount of time in milliseconds that passes between each hash sweep. (defaults to 4h)
+     * @default 14_400_000
+     */
+    hashSweepInterval: number;
+    /**
+     * The maximum amount of time a hash can exist in milliseconds without being hit with a request (defaults to 24h)
+     * @default 86_400_000
+     */
+    hashLifetime: number;
+    /**
+     * The amount of time in milliseconds that passes between each hash sweep. (defaults to 1h)
+     * @default 3_600_000
+     */
+    handlerSweepInterval: number;
+}
+/**
+ * Data emitted on `RESTEvents.RateLimited`
+ */
+interface RateLimitData {
+    /**
+     * The time, in milliseconds, until the request-lock is reset
+     */
+    timeToReset: number;
+    /**
+     * The amount of requests we can perform before locking requests
+     */
+    limit: number;
+    /**
+     * The HTTP method being performed
+     */
+    method: string;
+    /**
+     * The bucket hash for this request
+     */
+    hash: string;
+    /**
+     * The full URL for this request
+     */
+    url: string;
+    /**
+     * The route being hit in this request
+     */
+    route: string;
+    /**
+     * The major parameter of the route
+     *
+     * For example, in `/channels/x`, this will be `x`.
+     * If there is no major parameter (e.g: `/bot/gateway`) this will be `global`.
+     */
+    majorParameter: string;
+    /**
+     * Whether the rate limit that was reached was the global limit
+     */
+    global: boolean;
+}
+/**
+ * A function that determines whether the rate limit hit should throw an Error
+ */
+declare type RateLimitQueueFilter = (rateLimitData: RateLimitData) => boolean | Promise<boolean>;
+interface APIRequest {
+    /**
+     * The HTTP method used in this request
+     */
+    method: string;
+    /**
+     * The full path used to make the request
+     */
+    path: RouteLike;
+    /**
+     * The API route identifying the ratelimit for this request
+     */
+    route: string;
+    /**
+     * Additional HTTP options for this request
+     */
+    options: RequestOptions;
+    /**
+     * The data that was used to form the body of this request
+     */
+    data: HandlerRequestData;
+    /**
+     * The number of times this request has been attempted
+     */
+    retries: number;
+}
+interface InvalidRequestWarningData {
+    /**
+     * Number of invalid requests that have been made in the window
+     */
+    count: number;
+    /**
+     * Time in milliseconds remaining before the count resets
+     */
+    remainingTime: number;
+}
+interface RestEvents {
+    invalidRequestWarning: [invalidRequestInfo: InvalidRequestWarningData];
+    restDebug: [info: string];
+    rateLimited: [rateLimitInfo: RateLimitData];
+    response: [request: APIRequest, response: Dispatcher.ResponseData];
+    newListener: [name: string, listener: (...args: any) => void];
+    removeListener: [name: string, listener: (...args: any) => void];
+    hashSweep: [sweptHashes: Collection<string, HashData>];
+    handlerSweep: [sweptHandlers: Collection<string, IHandler>];
+}
+declare type RequestOptions = Exclude<Parameters<typeof request>[1], undefined>;
+interface REST {
+    on: (<K extends keyof RestEvents>(event: K, listener: (...args: RestEvents[K]) => void) => this) & (<S extends string | symbol>(event: Exclude<S, keyof RestEvents>, listener: (...args: any[]) => void) => this);
+    once: (<K extends keyof RestEvents>(event: K, listener: (...args: RestEvents[K]) => void) => this) & (<S extends string | symbol>(event: Exclude<S, keyof RestEvents>, listener: (...args: any[]) => void) => this);
+    emit: (<K extends keyof RestEvents>(event: K, ...args: RestEvents[K]) => boolean) & (<S extends string | symbol>(event: Exclude<S, keyof RestEvents>, ...args: any[]) => boolean);
+    off: (<K extends keyof RestEvents>(event: K, listener: (...args: RestEvents[K]) => void) => this) & (<S extends string | symbol>(event: Exclude<S, keyof RestEvents>, listener: (...args: any[]) => void) => this);
+    removeAllListeners: (<K extends keyof RestEvents>(event?: K) => this) & (<S extends string | symbol>(event?: Exclude<S, keyof RestEvents>) => this);
+}
+declare class REST extends EventEmitter {
+    readonly cdn: CDN;
+    readonly requestManager: RequestManager;
+    constructor(options?: Partial<RESTOptions>);
+    /**
+     * Gets the agent set for this instance
+     */
+    getAgent(): Dispatcher | null;
+    /**
+     * Sets the default agent to use for requests performed by this instance
+     * @param agent Sets the agent to use
+     */
+    setAgent(agent: Dispatcher): this;
+    /**
+     * Sets the authorization token that should be used for requests
+     * @param token The authorization token to use
+     */
+    setToken(token: string): this;
+    /**
+     * Runs a get request from the api
+     * @param fullRoute The full route to query
+     * @param options Optional request options
+     */
+    get(fullRoute: RouteLike, options?: RequestData): Promise<unknown>;
+    /**
+     * Runs a delete request from the api
+     * @param fullRoute The full route to query
+     * @param options Optional request options
+     */
+    delete(fullRoute: RouteLike, options?: RequestData): Promise<unknown>;
+    /**
+     * Runs a post request from the api
+     * @param fullRoute The full route to query
+     * @param options Optional request options
+     */
+    post(fullRoute: RouteLike, options?: RequestData): Promise<unknown>;
+    /**
+     * Runs a put request from the api
+     * @param fullRoute The full route to query
+     * @param options Optional request options
+     */
+    put(fullRoute: RouteLike, options?: RequestData): Promise<unknown>;
+    /**
+     * Runs a patch request from the api
+     * @param fullRoute The full route to query
+     * @param options Optional request options
+     */
+    patch(fullRoute: RouteLike, options?: RequestData): Promise<unknown>;
+    /**
+     * Runs a request from the api
+     * @param options Request options
+     */
+    request(options: InternalRequest): Promise<unknown>;
+    /**
+     * Runs a request from the API, yielding the raw Response object
+     * @param options Request options
+     */
+    raw(options: InternalRequest): Promise<Dispatcher.ResponseData>;
+}
+
+declare const DefaultUserAgent: string;
+declare const DefaultRestOptions: Required<RESTOptions>;
+/**
+ * The events that the REST manager emits
+ */
+declare const enum RESTEvents {
+    Debug = "restDebug",
+    InvalidRequestWarning = "invalidRequestWarning",
+    RateLimited = "rateLimited",
+    Response = "response",
+    HashSweep = "hashSweep",
+    HandlerSweep = "handlerSweep"
+}
+declare const ALLOWED_EXTENSIONS: readonly ["webp", "png", "jpg", "jpeg", "gif"];
+declare const ALLOWED_STICKER_EXTENSIONS: readonly ["png", "json"];
+declare const ALLOWED_SIZES: readonly [16, 32, 64, 128, 256, 512, 1024, 2048, 4096];
+declare type ImageExtension = typeof ALLOWED_EXTENSIONS[number];
+declare type StickerExtension = typeof ALLOWED_STICKER_EXTENSIONS[number];
+declare type ImageSize = typeof ALLOWED_SIZES[number];
+
+/**
+ * The options used for image URLs
+ */
+interface BaseImageURLOptions {
+    /**
+     * The extension to use for the image URL
+     * @default 'webp'
+     */
+    extension?: ImageExtension;
+    /**
+     * The size specified in the image URL
+     */
+    size?: ImageSize;
+}
+/**
+ * The options used for image URLs with animated content
+ */
+interface ImageURLOptions extends BaseImageURLOptions {
+    /**
+     * Whether or not to prefer the static version of an image asset.
+     */
+    forceStatic?: boolean;
+}
+/**
+ * The options to use when making a CDN URL
+ */
+interface MakeURLOptions {
+    /**
+     * The extension to use for the image URL
+     * @default 'webp'
+     */
+    extension?: string | undefined;
+    /**
+     * The size specified in the image URL
+     */
+    size?: ImageSize;
+    /**
+     * The allowed extensions that can be used
+     */
+    allowedExtensions?: ReadonlyArray<string>;
+}
+/**
+ * The CDN link builder
+ */
+declare class CDN {
+    private readonly base;
+    constructor(base?: string);
+    /**
+     * Generates an app asset URL for a client's asset.
+     * @param clientId The client id that has the asset
+     * @param assetHash The hash provided by Discord for this asset
+     * @param options Optional options for the asset
+     */
+    appAsset(clientId: string, assetHash: string, options?: Readonly<BaseImageURLOptions>): string;
+    /**
+     * Generates an app icon URL for a client's icon.
+     * @param clientId The client id that has the icon
+     * @param iconHash The hash provided by Discord for this icon
+     * @param options Optional options for the icon
+     */
+    appIcon(clientId: string, iconHash: string, options?: Readonly<BaseImageURLOptions>): string;
+    /**
+     * Generates an avatar URL, e.g. for a user or a webhook.
+     * @param id The id that has the icon
+     * @param avatarHash The hash provided by Discord for this avatar
+     * @param options Optional options for the avatar
+     */
+    avatar(id: string, avatarHash: string, options?: Readonly<ImageURLOptions>): string;
+    /**
+     * Generates a banner URL, e.g. for a user or a guild.
+     * @param id The id that has the banner splash
+     * @param bannerHash The hash provided by Discord for this banner
+     * @param options Optional options for the banner
+     */
+    banner(id: string, bannerHash: string, options?: Readonly<ImageURLOptions>): string;
+    /**
+     * Generates an icon URL for a channel, e.g. a group DM.
+     * @param channelId The channel id that has the icon
+     * @param iconHash The hash provided by Discord for this channel
+     * @param options Optional options for the icon
+     */
+    channelIcon(channelId: string, iconHash: string, options?: Readonly<BaseImageURLOptions>): string;
+    /**
+     * Generates the default avatar URL for a discriminator.
+     * @param discriminator The discriminator modulo 5
+     */
+    defaultAvatar(discriminator: number): string;
+    /**
+     * Generates a discovery splash URL for a guild's discovery splash.
+     * @param guildId The guild id that has the discovery splash
+     * @param splashHash The hash provided by Discord for this splash
+     * @param options Optional options for the splash
+     */
+    discoverySplash(guildId: string, splashHash: string, options?: Readonly<BaseImageURLOptions>): string;
+    /**
+     * Generates an emoji's URL for an emoji.
+     * @param emojiId The emoji id
+     * @param extension The extension of the emoji
+     */
+    emoji(emojiId: string, extension?: ImageExtension): string;
+    /**
+     * Generates a guild member avatar URL.
+     * @param guildId The id of the guild
+     * @param userId The id of the user
+     * @param avatarHash The hash provided by Discord for this avatar
+     * @param options Optional options for the avatar
+     */
+    guildMemberAvatar(guildId: string, userId: string, avatarHash: string, options?: Readonly<ImageURLOptions>): string;
+    /**
+     * Generates a guild member banner URL.
+     * @param guildId The id of the guild
+     * @param userId The id of the user
+     * @param bannerHash The hash provided by Discord for this banner
+     * @param options Optional options for the banner
+     */
+    guildMemberBanner(guildId: string, userId: string, bannerHash: string, options?: Readonly<ImageURLOptions>): string;
+    /**
+     * Generates an icon URL, e.g. for a guild.
+     * @param id The id that has the icon splash
+     * @param iconHash The hash provided by Discord for this icon
+     * @param options Optional options for the icon
+     */
+    icon(id: string, iconHash: string, options?: Readonly<ImageURLOptions>): string;
+    /**
+     * Generates a URL for the icon of a role
+     * @param roleId The id of the role that has the icon
+     * @param roleIconHash The hash provided by Discord for this role icon
+     * @param options Optional options for the role icon
+     */
+    roleIcon(roleId: string, roleIconHash: string, options?: Readonly<BaseImageURLOptions>): string;
+    /**
+     * Generates a guild invite splash URL for a guild's invite splash.
+     * @param guildId The guild id that has the invite splash
+     * @param splashHash The hash provided by Discord for this splash
+     * @param options Optional options for the splash
+     */
+    splash(guildId: string, splashHash: string, options?: Readonly<BaseImageURLOptions>): string;
+    /**
+     * Generates a sticker URL.
+     * @param stickerId The sticker id
+     * @param extension The extension of the sticker
+     */
+    sticker(stickerId: string, extension?: StickerExtension): string;
+    /**
+     * Generates a sticker pack banner URL.
+     * @param bannerId The banner id
+     * @param options Optional options for the banner
+     */
+    stickerPackBanner(bannerId: string, options?: Readonly<BaseImageURLOptions>): string;
+    /**
+     * Generates a team icon URL for a team's icon.
+     * @param teamId The team id that has the icon
+     * @param iconHash The hash provided by Discord for this icon
+     * @param options Optional options for the icon
+     */
+    teamIcon(teamId: string, iconHash: string, options?: Readonly<BaseImageURLOptions>): string;
+    /**
+     * Generates a cover image for a guild scheduled event.
+     * @param scheduledEventId The scheduled event id
+     * @param coverHash The hash provided by discord for this cover image
+     * @param options Optional options for the cover image
+     */
+    guildScheduledEventCover(scheduledEventId: string, coverHash: string, options?: Readonly<BaseImageURLOptions>): string;
+    /**
+     * Constructs the URL for the resource, checking whether or not `hash` starts with `a_` if `dynamic` is set to `true`.
+     * @param route The base cdn route
+     * @param hash The hash provided by Discord for this icon
+     * @param options Optional options for the link
+     */
+    private dynamicMakeURL;
+    /**
+     * Constructs the URL for the resource
+     * @param route The base cdn route
+     * @param options The extension/size options for the link
+     */
+    private makeURL;
+}
+
+interface DiscordErrorFieldInformation {
+    code: string;
+    message: string;
+}
+interface DiscordErrorGroupWrapper {
+    _errors: DiscordError[];
+}
+declare type DiscordError = DiscordErrorGroupWrapper | DiscordErrorFieldInformation | {
+    [k: string]: DiscordError;
+} | string;
+interface DiscordErrorData {
+    code: number;
+    message: string;
+    errors?: DiscordError;
+}
+interface OAuthErrorData {
+    error: string;
+    error_description?: string;
+}
+interface RequestBody {
+    files: RawFile[] | undefined;
+    json: unknown | undefined;
+}
+/**
+ * Represents an API error returned by Discord
+ * @extends Error
+ */
+declare class DiscordAPIError extends Error {
+    rawError: DiscordErrorData | OAuthErrorData;
+    code: number | string;
+    status: number;
+    method: string;
+    url: string;
+    requestBody: RequestBody;
+    /**
+     * @param rawError The error reported by Discord
+     * @param code The error code reported by Discord
+     * @param status The status code of the response
+     * @param method The method of the request that erred
+     * @param url The url of the request that erred
+     * @param bodyData The unparsed data for the request that errored
+     */
+    constructor(rawError: DiscordErrorData | OAuthErrorData, code: number | string, status: number, method: string, url: string, bodyData: Pick<InternalRequest, 'files' | 'body'>);
+    /**
+     * The name of the error
+     */
+    get name(): string;
+    private static getMessage;
+    private static flattenDiscordError;
+}
+
+/**
+ * Represents a HTTP error
+ */
+declare class HTTPError extends Error {
+    name: string;
+    status: number;
+    method: string;
+    url: string;
+    requestBody: RequestBody;
+    /**
+     * @param name The name of the error
+     * @param status The status code of the response
+     * @param method The method of the request that erred
+     * @param url The url of the request that erred
+     * @param bodyData The unparsed data for the request that errored
+     */
+    constructor(name: string, status: number, method: string, url: string, bodyData: Pick<InternalRequest, 'files' | 'body'>);
+}
+
+declare class RateLimitError extends Error implements RateLimitData {
+    timeToReset: number;
+    limit: number;
+    method: string;
+    hash: string;
+    url: string;
+    route: string;
+    majorParameter: string;
+    global: boolean;
+    constructor({ timeToReset, limit, method, hash, url, route, majorParameter, global }: RateLimitData);
+    /**
+     * The name of the error
+     */
+    get name(): string;
+}
+
+/**
+ * Creates and populates an URLSearchParams instance from an object, stripping
+ * out null and undefined values, while also coercing non-strings to strings.
+ * @param options The options to use
+ * @returns A populated URLSearchParams instance
+ */
+declare function makeURLSearchParams(options?: Record<string, unknown>): URLSearchParams$1;
+/**
+ * Converts the response to usable data
+ * @param res The fetch response
+ */
+declare function parseResponse(res: Dispatcher.ResponseData): Promise<unknown>;
+
+export { ALLOWED_EXTENSIONS, ALLOWED_SIZES, ALLOWED_STICKER_EXTENSIONS, APIRequest, BaseImageURLOptions, CDN, DefaultRestOptions, DefaultUserAgent, DiscordAPIError, DiscordErrorData, HTTPError, HandlerRequestData, HashData, ImageExtension, ImageSize, ImageURLOptions, InternalRequest, InvalidRequestWarningData, MakeURLOptions, OAuthErrorData, REST, RESTEvents, RESTOptions, RateLimitData, RateLimitError, RateLimitQueueFilter, RawFile, RequestBody, RequestData, RequestHeaders, RequestManager, RequestMethod, RequestOptions, RestEvents, RouteData, RouteLike, StickerExtension, makeURLSearchParams, parseResponse };