chapterjs 0.1.1 → 0.1.4

package/dist/discord/types/soundboard.d.ts

@@ -0,0 +1,71 @@
+import type { ImageData, Snowflake } from './common.js';
+import type { RawUser } from './user.js';
+/**
+ * Soundboard Sound Structure
+ * @see https://docs.discord.com/developers/resources/soundboard#soundboard-sound-object-soundboard-sound-structure
+ */
+export interface RawSoundboardSound {
+    /** the name of this sound */
+    name: string;
+    /** the id of this sound */
+    sound_id: Snowflake;
+    /** the volume of this sound, from 0 to 1 */
+    volume: number;
+    /** the id of this sound's custom emoji */
+    emoji_id: Snowflake | null;
+    /** the unicode character of this sound's standard emoji */
+    emoji_name: string | null;
+    /** the id of the guild this sound is in */
+    guild_id?: Snowflake;
+    /** whether this sound can be used, may be false due to loss of Server Boosts */
+    available: boolean;
+    /** the user who created this sound */
+    user?: RawUser;
+}
+/**
+ * JSON Params
+ * @see https://docs.discord.com/developers/resources/soundboard#send-soundboard-sound-json-params
+ */
+export interface SendSoundboardSoundJSONParams {
+    /** the id of the soundboard sound to play */
+    sound_id: Snowflake;
+    /** the id of the guild the soundboard sound is from, required to play sounds from different servers */
+    source_guild_id?: Snowflake;
+}
+/**
+ * Response Structure
+ * @see https://docs.discord.com/developers/resources/soundboard#list-guild-soundboard-sounds-response-structure
+ */
+export interface ListGuildSoundboardSoundsResponse {
+    items: RawSoundboardSound[];
+}
+/**
+ * JSON Params
+ * @see https://docs.discord.com/developers/resources/soundboard#create-guild-soundboard-sound-json-params
+ */
+export interface CreateGuildSoundboardSoundJSONParams {
+    /** name of the soundboard sound (2-32 characters) */
+    name: string;
+    /** the mp3 or ogg sound data, base64 encoded, similar to image data */
+    sound: ImageData;
+    /** the volume of the soundboard sound, from 0 to 1, defaults to 1 */
+    volume?: number | null;
+    /** the id of the custom emoji for the soundboard sound */
+    emoji_id?: Snowflake | null;
+    /** the unicode character of a standard emoji for the soundboard sound */
+    emoji_name?: string | null;
+}
+/**
+ * JSON Params
+ * @see https://docs.discord.com/developers/resources/soundboard#modify-guild-soundboard-sound-json-params
+ */
+export interface ModifyGuildSoundboardSoundJSONParams {
+    /** name of the soundboard sound (2-32 characters) */
+    name?: string;
+    /** the volume of the soundboard sound, from 0 to 1 */
+    volume?: number | null;
+    /** the id of the custom emoji for the soundboard sound */
+    emoji_id?: Snowflake | null;
+    /** the unicode character of a standard emoji for the soundboard sound */
+    emoji_name?: string | null;
+}

package/dist/discord/types/soundboard.js

@@ -0,0 +1 @@
+export {};

package/dist/discord/types/stage-instance.d.ts

@@ -0,0 +1,58 @@
+import type { Snowflake } from './common.js';
+/**
+ * Stage Instance Structure
+ * @see https://docs.discord.com/developers/resources/stage-instance#stage-instance-object-stage-instance-structure
+ */
+export interface RawStageInstance {
+    /** The id of this Stage instance */
+    id: Snowflake;
+    /** The guild id of the associated Stage channel */
+    guild_id: Snowflake;
+    /** The id of the associated Stage channel */
+    channel_id: Snowflake;
+    /** The topic of the Stage instance (1-120 characters) */
+    topic: string;
+    /** The privacy level of the Stage instance */
+    privacy_level: StageInstancePrivacyLevel;
+    /** Whether or not Stage Discovery is disabled (deprecated) */
+    discoverable_disabled: boolean;
+    /** The id of the scheduled event for this Stage instance */
+    guild_scheduled_event_id: Snowflake | null;
+}
+/**
+ * Privacy Level
+ * @see https://docs.discord.com/developers/resources/stage-instance#stage-instance-object-privacy-level
+ */
+export declare const StageInstancePrivacyLevel: {
+    /** The Stage instance is visible publicly. (deprecated) */
+    readonly Public: 1;
+    /** The Stage instance is visible to only guild members. */
+    readonly GuildOnly: 2;
+};
+export type StageInstancePrivacyLevel = (typeof StageInstancePrivacyLevel)[keyof typeof StageInstancePrivacyLevel];
+/**
+ * JSON Params
+ * @see https://docs.discord.com/developers/resources/stage-instance#create-stage-instance-json-params
+ */
+export interface CreateStageInstanceJSONParams {
+    /** 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 GUILD_ONLY) */
+    privacy_level?: StageInstancePrivacyLevel;
+    /** Notify @everyone that a Stage instance has started */
+    send_start_notification?: boolean;
+    /** The guild scheduled event associated with this Stage instance */
+    guild_scheduled_event_id?: Snowflake;
+}
+/**
+ * JSON Params
+ * @see https://docs.discord.com/developers/resources/stage-instance#modify-stage-instance-json-params
+ */
+export interface ModifyStageInstanceJSONParams {
+    /** The topic of the Stage instance (1-120 characters) */
+    topic?: string;
+    /** The privacy level of the Stage instance */
+    privacy_level?: StageInstancePrivacyLevel;
+}

package/dist/discord/types/stage-instance.js

@@ -0,0 +1,10 @@
+/**
+ * Privacy Level
+ * @see https://docs.discord.com/developers/resources/stage-instance#stage-instance-object-privacy-level
+ */
+export const StageInstancePrivacyLevel = {
+    /** The Stage instance is visible publicly. (deprecated) */
+    Public: 1,
+    /** The Stage instance is visible to only guild members. */
+    GuildOnly: 2,
+};

package/dist/discord/types/sticker.d.ts

@@ -0,0 +1,115 @@
+import type { Snowflake } from './common.js';
+import type { RawUser } from './user.js';
+/**
+ * Sticker Structure
+ * @see https://docs.discord.com/developers/resources/sticker#sticker-object-sticker-structure
+ */
+export interface RawSticker {
+    /** id of the sticker */
+    id: Snowflake;
+    /** for standard stickers, id of the pack the sticker is from */
+    pack_id?: Snowflake;
+    /** name of the sticker */
+    name: string;
+    /** description of the sticker */
+    description: string | null;
+    /** autocomplete/suggestion tags for the sticker (max 200 characters) */
+    tags: string;
+    /** type of sticker */
+    type: StickerType;
+    /** type of sticker format */
+    format_type: StickerFormatType;
+    /** whether this guild sticker can be used, may be false due to loss of Server Boosts */
+    available?: boolean;
+    /** id of the guild that owns this sticker */
+    guild_id?: Snowflake;
+    /** the user that uploaded the guild sticker */
+    user?: RawUser;
+    /** the standard sticker's sort order within its pack */
+    sort_value?: number;
+}
+/**
+ * Sticker Types
+ * @see https://docs.discord.com/developers/resources/sticker#sticker-object-sticker-types
+ */
+export declare const StickerType: {
+    /** an official sticker in a pack */
+    readonly Standard: 1;
+    /** a sticker uploaded to a guild for the guild's members */
+    readonly Guild: 2;
+};
+export type StickerType = (typeof StickerType)[keyof typeof StickerType];
+/**
+ * Sticker Format Types
+ * @see https://docs.discord.com/developers/resources/sticker#sticker-object-sticker-format-types
+ */
+export declare const StickerFormatType: {
+    readonly Png: 1;
+    readonly Apng: 2;
+    readonly Lottie: 3;
+    readonly Gif: 4;
+};
+export type StickerFormatType = (typeof StickerFormatType)[keyof typeof StickerFormatType];
+/**
+ * Sticker Item Structure
+ * @see https://docs.discord.com/developers/resources/sticker#sticker-item-object-sticker-item-structure
+ */
+export interface RawStickerItem {
+    /** id of the sticker */
+    id: Snowflake;
+    /** name of the sticker */
+    name: string;
+    /** type of sticker format */
+    format_type: StickerFormatType;
+}
+/**
+ * Sticker Pack Structure
+ * @see https://docs.discord.com/developers/resources/sticker#sticker-pack-object-sticker-pack-structure
+ */
+export interface RawStickerPack {
+    /** id of the sticker pack */
+    id: Snowflake;
+    /** the stickers in the pack */
+    stickers: RawSticker[];
+    /** name of the sticker pack */
+    name: string;
+    /** id of the pack's SKU */
+    sku_id: Snowflake;
+    /** id of a sticker in the pack which is shown as the pack's icon */
+    cover_sticker_id?: Snowflake;
+    /** description of the sticker pack */
+    description: string;
+    /** id of the sticker pack's banner image */
+    banner_asset_id?: Snowflake;
+}
+/**
+ * Response Structure
+ * @see https://docs.discord.com/developers/resources/sticker#list-sticker-packs-response-structure
+ */
+export interface ListStickerPacksResponse {
+    sticker_packs: RawStickerPack[];
+}
+/**
+ * Form Params
+ * @see https://docs.discord.com/developers/resources/sticker#create-guild-sticker-form-params
+ */
+export interface CreateGuildStickerJSONParams {
+    /** name of the sticker (2-30 characters) */
+    name: string;
+    /** description of the sticker (empty or 2-100 characters) */
+    description: string;
+    /** autocomplete/suggestion tags for the sticker (max 200 characters) */
+    tags: string;
+}
+/**
+ * JSON Params
+ * @see https://docs.discord.com/developers/resources/sticker#modify-guild-sticker-json-params
+ */
+export interface ModifyGuildStickerJSONParams {
+    /** name of the sticker (2-30 characters) */
+    name?: string;
+    /** description of the sticker (2-100 characters) */
+    description?: string | null;
+    /** autocomplete/suggestion tags for the sticker (max 200 characters) */
+    tags?: string;
+}

package/dist/discord/types/sticker.js

@@ -0,0 +1,20 @@
+/**
+ * Sticker Types
+ * @see https://docs.discord.com/developers/resources/sticker#sticker-object-sticker-types
+ */
+export const StickerType = {
+    /** an official sticker in a pack */
+    Standard: 1,
+    /** a sticker uploaded to a guild for the guild's members */
+    Guild: 2,
+};
+/**
+ * Sticker Format Types
+ * @see https://docs.discord.com/developers/resources/sticker#sticker-object-sticker-format-types
+ */
+export const StickerFormatType = {
+    Png: 1,
+    Apng: 2,
+    Lottie: 3,
+    Gif: 4,
+};

package/dist/discord/types/subscription.d.ts

@@ -0,0 +1,54 @@
+import type { ISO8601Timestamp, Snowflake } from './common.js';
+/**
+ * Subscription Object
+ * @see https://docs.discord.com/developers/resources/subscription#subscription-object
+ */
+export interface RawSubscription {
+    /** ID of the subscription */
+    id: Snowflake;
+    /** ID of the user who is subscribed */
+    user_id: Snowflake;
+    /** List of SKUs subscribed to */
+    sku_ids: Snowflake[];
+    /** List of entitlements granted for this subscription */
+    entitlement_ids: Snowflake[];
+    /** List of SKUs that this user will be subscribed to at renewal */
+    renewal_sku_ids: Snowflake[] | null;
+    /** Start of the current subscription period */
+    current_period_start: ISO8601Timestamp;
+    /** End of the current subscription period */
+    current_period_end: ISO8601Timestamp;
+    /** Current status of the subscription */
+    status: SubscriptionStatus;
+    /** When the subscription was canceled */
+    canceled_at: ISO8601Timestamp | null;
+    /** ISO3166-1 alpha-2 country code of the payment source used to purchase the subscription. Missing unless queried with a private OAuth scope. */
+    country?: string;
+}
+/**
+ * Subscription Statuses
+ * @see https://docs.discord.com/developers/resources/subscription#subscription-statuses
+ */
+export declare const SubscriptionStatus: {
+    /** Subscription is active and scheduled to renew. */
+    readonly Active: 0;
+    /** Subscription is inactive and not being charged. */
+    readonly Inactive: 1;
+    /** Subscription is active but will not renew. */
+    readonly Ending: 2;
+};
+export type SubscriptionStatus = (typeof SubscriptionStatus)[keyof typeof SubscriptionStatus];
+/**
+ * Query String Params
+ * @see https://docs.discord.com/developers/resources/subscription#query-string-params
+ */
+export interface ListSkuSubscriptionsQuery {
+    /** List subscriptions before this ID */
+    before?: Snowflake;
+    /** List subscriptions after this ID */
+    after?: Snowflake;
+    /** Number of results to return (1-100) */
+    limit?: number;
+    /** User ID for which to return subscriptions. Required except for OAuth queries. */
+    user_id?: Snowflake;
+}

package/dist/discord/types/subscription.js

@@ -0,0 +1,12 @@
+/**
+ * Subscription Statuses
+ * @see https://docs.discord.com/developers/resources/subscription#subscription-statuses
+ */
+export const SubscriptionStatus = {
+    /** Subscription is active and scheduled to renew. */
+    Active: 0,
+    /** Subscription is inactive and not being charged. */
+    Inactive: 1,
+    /** Subscription is active but will not renew. */
+    Ending: 2,
+};

package/dist/discord/types/team.d.ts

@@ -0,0 +1,55 @@
+import type { Snowflake } from './common.js';
+import type { RawUser } from './user.js';
+/**
+ * Team Member Role Types
+ * @see https://docs.discord.com/developers/topics/teams#team-member-roles-team-member-role-types
+ */
+export declare const TeamMemberRole: {
+    /** Owners are the most permissible role, and can take destructive, irreversible actions like deleting team-owned apps or the team itself. Teams are limited to 1 owner. */
+    /** Admins have similar access as owners, except they cannot take destructive actions on the team or team-owned apps. */
+    readonly Admin: 'admin';
+    /** Developers can access information about team-owned apps, like the client secret or public key. They can also take limited actions on team-owned apps, like configuring interaction endpoints or resetting the bot token. Members with the Developer role *cannot* manage the team or its members, or take destructive actions on team-owned apps. */
+    readonly Developer: 'developer';
+    /** Read-only members can access information about a team and any team-owned apps. Some examples include getting the IDs of applications and exporting payout records. Members can also invite bots associated with team-owned apps that are marked private. */
+    readonly ReadOnly: 'read_only';
+};
+export type TeamMemberRole = (typeof TeamMemberRole)[keyof typeof TeamMemberRole];
+/**
+ * Team Object
+ * @see https://docs.discord.com/developers/topics/teams#data-models-team-object
+ */
+export interface RawTeam {
+    /** Hash of the image of the team's icon */
+    icon: string | null;
+    /** Unique ID of the team */
+    id: Snowflake;
+    /** Members of the team */
+    members: RawTeamMember[];
+    /** Name of the team */
+    name: string;
+    /** User ID of the current team owner */
+    owner_user_id: Snowflake;
+}
+/**
+ * Team Member Object
+ * @see https://docs.discord.com/developers/topics/teams#data-models-team-member-object
+ */
+export interface RawTeamMember {
+    /** User's membership state on the team */
+    membership_state: TeamMembershipState;
+    /** ID of the parent team of which they are a member */
+    team_id: Snowflake;
+    /** User object of the team member */
+    user: RawUser;
+    /** Role of the team member */
+    role: TeamMemberRole;
+}
+/**
+ * Membership State Enum
+ * @see https://docs.discord.com/developers/topics/teams#data-models-membership-state-enum
+ */
+export declare const TeamMembershipState: {
+    readonly Invited: 1;
+    readonly Accepted: 2;
+};
+export type TeamMembershipState = (typeof TeamMembershipState)[keyof typeof TeamMembershipState];

package/dist/discord/types/team.js

@@ -0,0 +1,21 @@
+/**
+ * Team Member Role Types
+ * @see https://docs.discord.com/developers/topics/teams#team-member-roles-team-member-role-types
+ */
+export const TeamMemberRole = {
+    /** Owners are the most permissible role, and can take destructive, irreversible actions like deleting team-owned apps or the team itself. Teams are limited to 1 owner. */
+    /** Admins have similar access as owners, except they cannot take destructive actions on the team or team-owned apps. */
+    Admin: 'admin',
+    /** Developers can access information about team-owned apps, like the client secret or public key. They can also take limited actions on team-owned apps, like configuring interaction endpoints or resetting the bot token. Members with the Developer role *cannot* manage the team or its members, or take destructive actions on team-owned apps. */
+    Developer: 'developer',
+    /** Read-only members can access information about a team and any team-owned apps. Some examples include getting the IDs of applications and exporting payout records. Members can also invite bots associated with team-owned apps that are marked private. */
+    ReadOnly: 'read_only',
+};
+/**
+ * Membership State Enum
+ * @see https://docs.discord.com/developers/topics/teams#data-models-membership-state-enum
+ */
+export const TeamMembershipState = {
+    Invited: 1,
+    Accepted: 2,
+};