stageInstance.ts

import type { Snowflake } from '../../globals.ts';
import type { APIGuildMember } from './guild.ts';

/**
 * https://discord.com/developers/docs/resources/stage-instance#stage-instance-object
 */
export interface APIStageInstance {
	/**
	 * The id of the 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
	 *
	 * See https://discord.com/developers/docs/resources/stage-instance#stage-instance-object-privacy-level
	 */
	privacy_level: StageInstancePrivacyLevel;
	/**
	 * Whether or not stage discovery is disabled
	 */
	discoverable_disabled: boolean;
}

/**
 * https://discord.com/developers/docs/resources/stage-instance#stage-instance-object-privacy-level
 */
export enum StageInstancePrivacyLevel {
	/**
	 * The stage instance is visible publicly, such as on stage discovery
	 */
	Public = 1,
	/**
	 * The stage instance is visible to only guild members
	 */
	GuildOnly,
}

/**
 * https://discord.com/developers/docs/resources/invite#invite-stage-instance-object-invite-stage-instance-structure
 */
export interface APIInviteStageInstance {
	/**
	 * The topic of the stage instance (1-120 characters)
	 */
	topic: string;
	/**
	 * The number of users in the stage
	 */
	participant_count: number;
	/**
	 * The number of users speaking in the stage
	 */
	speaker_count: number;
	/**
	 * The members speaking in the stage
	 *
	 * See https://discord.com/developers/docs/resources/guild#guild-member-object-guild-member-structure
	 */
	members: APIGuildMember[];
}