seyfert 1.5.0 → 2.1.0

package/lib/types/rest/monetization.d.ts

@@ -0,0 +1,103 @@
+import type { Snowflake } from '..';
+import type { APIEntitlement, APISKU, APISubscription } from '../payloads';
+/**
+ * https://discord.com/developers/docs/monetization/entitlements#list-entitlements
+ */
+export interface RESTGetAPIEntitlementsQuery {
+    /**
+     * User ID to look up entitlements for
+     */
+    user_id?: Snowflake | undefined;
+    /**
+     * Optional list of SKU IDs to check entitlements for
+     * Comma-delimited set of snowflakes
+     */
+    sku_ids?: string | undefined;
+    /**
+     * Retrieve entitlements before this entitlement ID
+     */
+    before?: Snowflake | undefined;
+    /**
+     * Retrieve entitlements after this entitlement ID
+     */
+    after?: Snowflake | undefined;
+    /**
+     * Number of entitlements to return (1-100)
+     *
+     * @default 100
+     */
+    limit?: number | undefined;
+    /**
+     * Guild ID to look up entitlements for
+     */
+    guild_id?: Snowflake | undefined;
+    /**
+     * Whether ended entitlements should be omitted
+     */
+    exclude_ended?: boolean | undefined;
+}
+/**
+ * https://discord.com/developers/docs/monetization/entitlements#list-entitlements
+ */
+export type RESTGetAPIEntitlementsResult = APIEntitlement[];
+/**
+ * https://discord.com/developers/docs/monetization/entitlements#create-test-entitlement
+ */
+export interface RESTPostAPIEntitlementBody {
+    /**
+     * ID of the SKU to grant the entitlement to
+     */
+    sku_id: Snowflake;
+    /**
+     * ID of the guild or user to grant the entitlement to
+     */
+    owner_id: Snowflake;
+    /**
+     * The type of entitlement owner
+     */
+    owner_type: EntitlementOwnerType;
+}
+/**
+ * https://discord.com/developers/docs/monetization/entitlements#create-test-entitlement
+ */
+export type RESTPostAPIEntitlementResult = Partial<Omit<APIEntitlement, 'ends_at' | 'starts_at'>>;
+/**
+ * https://discord.com/developers/docs/monetization/entitlements#create-test-entitlement
+ */
+export declare enum EntitlementOwnerType {
+    Guild = 1,
+    User = 2
+}
+/**
+ * https://discord.com/developers/docs/monetization/entitlements#delete-test-entitlement
+ */
+export type RESTDeleteAPIEntitlementResult = never;
+/**
+ * https://discord.com/developers/docs/monetization/skus#list-skus
+ */
+export type RESTGetAPISKUsResult = APISKU[];
+/**
+ * https://discord.com/developers/docs/monetization/entitlements#consume-an-entitlement
+ */
+export type RESTPostAPIEntitlementConsumeResult = never;
+/**
+ * https://canary.discord.com/developers/docs/resources/subscription#query-string-params
+ */
+export interface RESTGetAPISKUSubscriptionsQuery {
+    /** List subscriptions before this ID */
+    before?: string;
+    /** List subscriptions after this ID */
+    after?: string;
+    /** Number of results to return (1-100) */
+    limit?: number;
+    /** User ID for which to return subscriptions. Required except for OAuth queries. */
+    user_id?: string;
+}
+/**
+ * https://canary.discord.com/developers/docs/resources/subscription#list-sku-subscriptions
+ */
+export type RESTGetAPISKUSubscriptionsResult = APISubscription[];
+/**
+ * https://canary.discord.com/developers/docs/resources/subscription#get-sku-subscription
+ */
+export type RESTGetAPISKUSubscriptionResult = APISubscription;

package/lib/types/rest/monetization.js

@@ -0,0 +1,11 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.EntitlementOwnerType = void 0;
+/**
+ * https://discord.com/developers/docs/monetization/entitlements#create-test-entitlement
+ */
+var EntitlementOwnerType;
+(function (EntitlementOwnerType) {
+    EntitlementOwnerType[EntitlementOwnerType["Guild"] = 1] = "Guild";
+    EntitlementOwnerType[EntitlementOwnerType["User"] = 2] = "User";
+})(EntitlementOwnerType || (exports.EntitlementOwnerType = EntitlementOwnerType = {}));

package/lib/types/rest/oauth2.d.ts

@@ -0,0 +1,172 @@
+import type { Snowflake } from '..';
+import type { APIApplication, OAuth2Scopes, APIUser, APIGuild, APIWebhook } from '../payloads';
+/**
+ * https://discord.com/developers/docs/topics/oauth2#get-current-bot-application-information
+ */
+export type RESTGetAPIOAuth2CurrentApplicationResult = Omit<APIApplication, 'flags'>;
+/**
+ * https://discord.com/developers/docs/topics/oauth2#get-current-authorization-information
+ */
+export interface RESTGetAPIOAuth2CurrentAuthorizationResult {
+    /**
+     * the current application
+     */
+    application: Partial<APIApplication>;
+    /**
+     * the scopes the user has authorized the application for
+     */
+    scopes: OAuth2Scopes[];
+    /**
+     * when the access token expires
+     */
+    expires: string;
+    /**
+     * the user who has authorized, if the user has authorized with the `identify` scope
+     */
+    user?: APIUser;
+}
+/**
+ * https://discord.com/developers/docs/topics/oauth2#authorization-code-grant
+ */
+export interface RESTOAuth2AuthorizationQuery {
+    response_type: 'code';
+    client_id: Snowflake;
+    scope: string;
+    redirect_uri?: string;
+    state?: string;
+    prompt?: 'consent' | 'none';
+}
+/**
+ * https://discord.com/developers/docs/topics/oauth2#authorization-code-grant-redirect-url-example
+ */
+export interface RESTOAuth2AuthorizationQueryResult {
+    code: string;
+    state?: string;
+}
+/**
+ * https://discord.com/developers/docs/topics/oauth2#authorization-code-grant-redirect-url-example
+ */
+export interface RESTPostOAuth2AccessTokenURLEncodedData {
+    client_id: Snowflake;
+    client_secret: string;
+    grant_type: 'authorization_code';
+    code: string;
+    redirect_uri?: string;
+}
+/**
+ * https://discord.com/developers/docs/topics/oauth2#authorization-code-grant-access-token-response
+ */
+export interface RESTPostOAuth2AccessTokenResult {
+    access_token: string;
+    token_type: string;
+    expires_in: number;
+    refresh_token: string;
+    scope: string;
+}
+/**
+ * https://discord.com/developers/docs/topics/oauth2#authorization-code-grant-refresh-token-exchange-example
+ */
+export interface RESTPostOAuth2RefreshTokenURLEncodedData {
+    client_id: Snowflake;
+    client_secret: string;
+    grant_type: 'refresh_token';
+    refresh_token: string;
+}
+export type RESTPostOAuth2RefreshTokenResult = RESTPostOAuth2AccessTokenResult;
+/**
+ * https://discord.com/developers/docs/topics/oauth2#implicit-grant
+ */
+export interface RESTOAuth2ImplicitAuthorizationQuery {
+    response_type: 'token';
+    client_id: Snowflake;
+    scope: string;
+    redirect_uri?: string;
+    state?: string;
+    prompt?: 'consent' | 'none';
+}
+/**
+ * https://discord.com/developers/docs/topics/oauth2#implicit-grant-redirect-url-example
+ */
+export type RESTOAuth2ImplicitAuthorizationURLFragmentResult = Omit<RESTPostOAuth2AccessTokenResult, 'refresh_token'>;
+/**
+ * https://discord.com/developers/docs/topics/oauth2#client-credentials-grant
+ */
+export interface RESTPostOAuth2ClientCredentialsURLEncodedData {
+    grant_type: 'client_credentials';
+    scope: string;
+}
+export type RESTPostOAuth2ClientCredentialsResult = RESTOAuth2ImplicitAuthorizationURLFragmentResult;
+/**
+ * https://discord.com/developers/docs/topics/oauth2#bot-authorization-flow-bot-auth-parameters
+ */
+export interface RESTOAuth2BotAuthorizationQuery {
+    /**
+     * Your app's client id
+     */
+    client_id: Snowflake;
+    /**
+     * Needs to include bot for the bot flow
+     */
+    scope: OAuth2Scopes.Bot | `${OAuth2Scopes.Bot}${' ' | '%20'}${string}` | `${string}${' ' | '%20'}${OAuth2Scopes.Bot}` | `${string}${' ' | '%20'}${OAuth2Scopes.Bot}${string}${' ' | '%20'}`;
+    /**
+     * The permissions you're requesting
+     *
+     * See https://discord.com/developers/docs/topics/permissions
+     */
+    permissions?: Permissions;
+    /**
+     * Pre-fills the dropdown picker with a guild for the user
+     */
+    guild_id?: Snowflake;
+    /**
+     * `true` or `false`—disallows the user from changing the guild dropdown
+     */
+    disable_guild_select?: boolean;
+}
+/**
+ * https://discord.com/developers/docs/topics/oauth2#advanced-bot-authorization
+ */
+export interface RESTOAuth2AdvancedBotAuthorizationQuery {
+    client_id: Snowflake;
+    /**
+     * This assumes you include the `bot` scope alongside others (like `identify` for example)
+     */
+    scope: OAuth2Scopes.Bot | `${OAuth2Scopes.Bot}${' ' | '%20'}${string}` | `${string}${' ' | '%20'}${OAuth2Scopes.Bot}` | `${string}${' ' | '%20'}${OAuth2Scopes.Bot}${string}${' ' | '%20'}`;
+    /**
+     * The required permissions bitfield, stringified
+     */
+    permissions?: Permissions;
+    guild_id?: Snowflake;
+    disable_guild_select?: boolean;
+    response_type: string;
+    redirect_uri?: string;
+}
+export interface RESTOAuth2AdvancedBotAuthorizationQueryResult {
+    code: string;
+    state?: string;
+    guild_id: Snowflake;
+    permissions: Permissions;
+}
+/**
+ * https://discord.com/developers/docs/topics/oauth2#advanced-bot-authorization-extended-bot-authorization-access-token-example
+ */
+export interface RESTPostOAuth2AccessTokenWithBotAndGuildsScopeResult {
+    access_token: string;
+    token_type: string;
+    expires_in: number;
+    refresh_token: string;
+    scope: string;
+    guild: APIGuild;
+}
+/**
+ * https://discord.com/developers/docs/topics/oauth2#webhooks-webhook-token-response-example
+ */
+export interface RESTPostOAuth2AccessTokenWithBotAndWebhookIncomingScopeResult {
+    access_token: string;
+    token_type: string;
+    expires_in: number;
+    refresh_token: string;
+    scope: string;
+    webhook: APIWebhook;
+}
+export type RESTPostOAuth2AccessTokenWithBotAndGuildsAndWebhookIncomingScopeResult = RESTPostOAuth2AccessTokenWithBotAndGuildsScopeResult & RESTPostOAuth2AccessTokenWithBotAndWebhookIncomingScopeResult;

package/lib/types/rest/oauth2.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/lib/types/rest/poll.d.ts

@@ -0,0 +1,44 @@
+import type { Snowflake, APIMessage, APIPoll, APIPollAnswer, APIUser } from '../index';
+/**
+ * https://discord.com/developers/docs/resources/poll#get-answer-voters
+ */
+export interface RESTGetAPIPollAnswerVotersQuery {
+    /**
+     * Get users after this user ID
+     */
+    after?: Snowflake;
+    /**
+     * Max number of users to return (1-100)
+     *
+     * @default 25
+     */
+    limit?: number;
+}
+/**
+ * https://discord.com/developers/docs/resources/poll#poll-create-request-object-poll-create-request-object-structure
+ */
+export interface RESTAPIPollCreate extends Omit<APIPoll, 'allow_multiselect' | 'answers' | 'expiry' | 'layout_type' | 'results'>, Partial<Pick<APIPoll, 'allow_multiselect' | 'layout_type'>> {
+    /**
+     * Each of the answers available in the poll, up to 10
+     */
+    answers: Omit<APIPollAnswer, 'answer_id'>[];
+    /**
+     * Number of hours the poll should be open for, up to 32 days
+     *
+     * @default 24
+     */
+    duration?: number;
+}
+/**
+ * https://discord.com/developers/docs/resources/poll#get-answer-voters
+ */
+export interface RESTGetAPIPollAnswerVotersResult {
+    /**
+     * Users who voted for this answer
+     */
+    users: APIUser[];
+}
+/**
+ * https://discord.com/developers/docs/resources/poll#expire-poll
+ */
+export type RESTPostAPIPollExpireResult = APIMessage;

package/lib/types/rest/poll.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/lib/types/rest/stageInstance.d.ts

@@ -0,0 +1,58 @@
+import type { Snowflake } from '..';
+import type { StageInstancePrivacyLevel, APIStageInstance } from '../payloads';
+/**
+ * https://discord.com/developers/docs/resources/stage-instance#create-stage-instance
+ */
+export interface RESTPostAPIStageInstanceJSONBody {
+    /**
+     * The id of the stage channel
+     */
+    channel_id: Snowflake;
+    /**
+     * The topic of the stage instance (1-120 characters)
+     */
+    topic: string;
+    /**
+     * The privacy level of the stage instance
+     *
+     * @default GuildOnly
+     */
+    privacy_level?: StageInstancePrivacyLevel | undefined;
+    /**
+     * Notify @everyone that a stage instance has started
+     */
+    send_start_notification?: boolean | undefined;
+    /**
+     * The guild scheduled event associated with this stage instance
+     */
+    guild_scheduled_event_id?: Snowflake | undefined;
+}
+/**
+ * https://discord.com/developers/docs/resources/stage-instance#create-stage-instance
+ */
+export type RESTPostAPIStageInstanceResult = APIStageInstance;
+/**
+ * https://discord.com/developers/docs/resources/stage-instance#get-stage-instance
+ */
+export type RESTGetAPIStageInstanceResult = APIStageInstance;
+/**
+ * https://discord.com/developers/docs/resources/stage-instance#modify-stage-instance
+ */
+export interface RESTPatchAPIStageInstanceJSONBody {
+    /**
+     * The topic of the stage instance (1-120 characters)
+     */
+    topic?: string | undefined;
+    /**
+     * The privacy level of the stage instance
+     */
+    privacy_level?: StageInstancePrivacyLevel | undefined;
+}
+/**
+ * https://discord.com/developers/docs/resources/stage-instance#modify-stage-instance
+ */
+export type RESTPatchAPIStageInstanceResult = APIStageInstance;
+/**
+ * https://discord.com/developers/docs/resources/stage-instance#delete-stage-instance
+ */
+export type RESTDeleteAPIStageInstanceResult = never;

package/lib/types/rest/stageInstance.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/lib/types/rest/sticker.d.ts

@@ -0,0 +1,77 @@
+import type { APISticker, APIStickerPack } from '../payloads';
+/**
+ * https://discord.com/developers/docs/resources/sticker#get-sticker
+ */
+export type RESTGetAPIStickerResult = APISticker;
+/**
+ * https://discord.com/developers/docs/resources/sticker#list-sticker-packs
+ */
+export interface RESTGetStickerPacksResult {
+    sticker_packs: APIStickerPack[];
+}
+/**
+ * https://discord.com/developers/docs/resources/sticker#list-sticker-packs
+ *
+ * @deprecated Use `RESTGetStickerPacksResult` instead
+ */
+export type RESTGetNitroStickerPacksResult = RESTGetStickerPacksResult;
+/**
+ * https://discord.com/developers/docs/resources/sticker#list-guild-stickers
+ */
+export type RESTGetAPIGuildStickersResult = APISticker[];
+/**
+ * https://discord.com/developers/docs/resources/sticker#get-guild-sticker
+ */
+export type RESTGetAPIGuildStickerResult = APISticker;
+/**
+ * https://discord.com/developers/docs/resources/sticker#create-guild-sticker
+ */
+export interface RESTPostAPIGuildStickerFormDataBody {
+    /**
+     * Name of the sticker (2-30 characters)
+     */
+    name: string;
+    /**
+     * Description of the sticker (empty or 2-100 characters)
+     */
+    description: string;
+    /**
+     * The Discord name of a unicode emoji representing the sticker's expression (2-200 characters)
+     */
+    tags: string;
+    /**
+     * The sticker file to upload, must be a PNG, APNG, GIF, or Lottie JSON file, max 512 KB
+     *
+     * Uploaded stickers are constrained to 5 seconds in length for animated stickers, and 320 x 320 pixels.
+     */
+    file: unknown;
+}
+/**
+ * https://discord.com/developers/docs/resources/sticker#create-guild-sticker
+ */
+export type RESTPostAPIGuildStickerResult = APISticker;
+/**
+ * https://discord.com/developers/docs/resources/sticker#modify-guild-sticker
+ */
+export interface RESTPatchAPIGuildStickerJSONBody {
+    /**
+     * Name of the sticker (2-30 characters)
+     */
+    name?: string | undefined;
+    /**
+     * Description of the sticker (2-100 characters)
+     */
+    description?: string | null | undefined;
+    /**
+     * The Discord name of a unicode emoji representing the sticker's expression (2-200 characters)
+     */
+    tags?: string | undefined;
+}
+/**
+ * https://discord.com/developers/docs/resources/sticker#modify-guild-sticker
+ */
+export type RESTPatchAPIGuildStickerResult = APISticker;
+/**
+ * https://discord.com/developers/docs/resources/sticker#delete-guild-sticker
+ */
+export type RESTDeleteAPIGuildStickerResult = never;

package/lib/types/rest/sticker.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/lib/types/rest/template.d.ts

@@ -0,0 +1,62 @@
+import type { APITemplate, APIGuild } from '../payloads';
+import type { StrictPartial } from '../utils';
+/**
+ * https://discord.com/developers/docs/resources/guild-template#get-guild-template
+ */
+export type RESTGetAPITemplateResult = APITemplate;
+/**
+ * https://discord.com/developers/docs/resources/guild-template#create-guild-from-guild-template
+ */
+export interface RESTPostAPITemplateCreateGuildJSONBody {
+    /**
+     * Name of the guild (2-100 characters)
+     */
+    name: string;
+    /**
+     * base64 1024x1024 png/jpeg image for the guild icon
+     *
+     * See https://discord.com/developers/docs/reference#image-data
+     */
+    icon?: string | undefined;
+}
+/**
+ * https://discord.com/developers/docs/resources/guild-template#create-guild-from-guild-template
+ */
+export type RESTPostAPITemplateCreateGuildResult = APIGuild;
+/**
+ * https://discord.com/developers/docs/resources/guild-template#get-guild-templates
+ */
+export type RESTGetAPIGuildTemplatesResult = APITemplate[];
+/**
+ * https://discord.com/developers/docs/resources/guild-template#create-guild-template
+ */
+export interface RESTPostAPIGuildTemplatesJSONBody {
+    /**
+     * Name of the template (1-100 characters)
+     */
+    name: string;
+    /**
+     * Description for the template (0-120 characters)
+     */
+    description?: string | null | undefined;
+}
+/**
+ * https://discord.com/developers/docs/resources/guild-template#create-guild-template
+ */
+export type RESTPostAPIGuildTemplatesResult = APITemplate;
+/**
+ * https://discord.com/developers/docs/resources/guild-template#sync-guild-template
+ */
+export type RESTPutAPIGuildTemplateSyncResult = APITemplate;
+/**
+ * https://discord.com/developers/docs/resources/guild-template#modify-guild-template
+ */
+export type RESTPatchAPIGuildTemplateJSONBody = StrictPartial<RESTPostAPIGuildTemplatesJSONBody>;
+/**
+ * https://discord.com/developers/docs/resources/guild-template#modify-guild-template
+ */
+export type RESTPatchAPIGuildTemplateResult = APITemplate;
+/**
+ * https://discord.com/developers/docs/resources/guild-template#delete-guild-template
+ */
+export type RESTDeleteAPIGuildTemplateResult = APITemplate;

package/lib/types/rest/template.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/lib/types/rest/user.d.ts

@@ -0,0 +1,120 @@
+import type { Snowflake } from '..';
+import type { APIUser, APIGuildMember, GuildFeature, APIChannel, APIConnection, APIApplicationRoleConnection } from '../payloads';
+/**
+ * https://discord.com/developers/docs/resources/user#get-current-user
+ */
+export type RESTGetAPICurrentUserResult = APIUser;
+/**
+ * https://discord.com/developers/docs/resources/user#get-user
+ */
+export type RESTGetAPIUserResult = APIUser;
+/**
+ * https://discord.com/developers/docs/resources/user#get-current-user-guild-member
+ */
+export type RESTGetCurrentUserGuildMemberResult = APIGuildMember;
+/**
+ * https://discord.com/developers/docs/resources/user#modify-current-user
+ */
+export interface RESTPatchAPICurrentUserJSONBody {
+    /**
+     * User's username, if changed may cause the user's discriminator to be randomized
+     */
+    username?: string | undefined;
+    /**
+     * If passed, modifies the user's avatar
+     */
+    avatar?: string | null | undefined;
+    /**
+     * If passed, modifies the user's banner
+     */
+    banner?: string | null | undefined;
+}
+/**
+ * https://discord.com/developers/docs/resources/user#modify-current-user
+ */
+export type RESTPatchAPICurrentUserResult = APIUser;
+/**
+ * https://discord.com/developers/docs/resources/user#get-current-user-guilds
+ */
+export interface RESTGetAPICurrentUserGuildsQuery {
+    /**
+     * Get guilds before this guild ID
+     */
+    before?: Snowflake;
+    /**
+     * Get guilds after this guild ID
+     */
+    after?: Snowflake;
+    /**
+     * Max number of guilds to return (1-200)
+     *
+     * @default 200
+     */
+    limit?: number;
+    /**
+     * Include approximate member and presence counts in response
+     *
+     * @default false
+     */
+    with_counts?: boolean;
+}
+export interface RESTAPIPartialCurrentUserGuild {
+    id: Snowflake;
+    name: string;
+    icon: string | null;
+    owner: boolean;
+    features: GuildFeature[];
+    permissions: Permissions;
+    approximate_member_count?: number;
+    approximate_presence_count?: number;
+}
+/**
+ * https://discord.com/developers/docs/resources/user#get-current-user-guilds
+ */
+export type RESTGetAPICurrentUserGuildsResult = RESTAPIPartialCurrentUserGuild[];
+/**
+ * https://discord.com/developers/docs/resources/user#leave-guild
+ */
+export type RESTDeleteAPICurrentUserGuildResult = never;
+/**
+ * https://discord.com/developers/docs/resources/user#create-dm
+ */
+export interface RESTPostAPICurrentUserCreateDMChannelJSONBody {
+    /**
+     * The recipient to open a DM channel with
+     */
+    recipient_id: string;
+}
+/**
+ * https://discord.com/developers/docs/resources/user#create-dm
+ */
+export type RESTPostAPICurrentUserCreateDMChannelResult = APIChannel;
+/**
+ * https://discord.com/developers/docs/resources/user#get-user-connections
+ */
+export type RESTGetAPICurrentUserConnectionsResult = APIConnection[];
+/**
+ * https://discord.com/developers/docs/resources/user#get-user-application-role-connection
+ */
+export type RESTGetAPICurrentUserApplicationRoleConnectionResult = APIApplicationRoleConnection;
+/**
+ * https://discord.com/developers/docs/resources/user#update-user-application-role-connection
+ */
+export interface RESTPutAPICurrentUserApplicationRoleConnectionJSONBody {
+    /**
+     * The vanity name of the platform a bot has connected (max 50 characters)
+     */
+    platform_name?: string | undefined;
+    /**
+     * The username on the platform a bot has connected (max 100 characters)
+     */
+    platform_username?: string | undefined;
+    /**
+     * Object mapping application role connection metadata keys to their `string`-ified value (max 100 characters) for the user on the platform a bot has connected
+     */
+    metadata?: Record<string, number | string> | undefined;
+}
+/**
+ * https://discord.com/developers/docs/resources/user#update-user-application-role-connection
+ */
+export type RESTPutAPICurrentUserApplicationRoleConnectionResult = APIApplicationRoleConnection;

package/lib/types/rest/user.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });