dfx 0.99.1 → 0.100.1

package/types.d.ts

@@ -90,6 +90,34 @@ export declare const ActivityFlag: {
     readonly PARTY_PRIVACY_VOICE_CHANNEL: number;
     readonly EMBEDDED: number;
 };
+export interface ActivityInstance {
+    /** Application ID */
+    readonly application_id: Snowflake;
+    /** Activity Instance ID */
+    readonly instance_id: string;
+    /** Unique identifier for the launch */
+    readonly launch_id: Snowflake;
+    /** The Location the instance is runnning in */
+    readonly location: ActivityLocation;
+    /** The IDs of the Users currently connected to the instance */
+    readonly users: Array<Snowflake>;
+}
+export interface ActivityLocation {
+    /** The unique identifier for the location */
+    readonly id: string;
+    /** Enum describing kind of location */
+    readonly kind: ActivityLocationKind;
+    /** The id of the Channel */
+    readonly channel_id: Snowflake;
+    /** The id of the Guild */
+    readonly guild_id?: Snowflake | null;
+}
+export declare enum ActivityLocationKind {
+    /** The Location is a Guild Channel */
+    GC = "'gc'",
+    /** The Location is a Private Channel, such as a DM or GDM */
+    PC = "'pc'"
+}
 export interface ActivityParty {
     /** ID of the party */
     readonly id?: string;
@@ -148,6 +176,12 @@ export declare enum AllowedMentionType {
     /** Controls @everyone and @here mentions */
     EVERYONE_MENTIONS = "everyone"
 }
+export declare enum AnimationType {
+    /** A fun animation, sent by a Nitro subscriber */
+    PREMIUM = 0,
+    /** The standard animation */
+    BASIC = 1
+}
 export interface Application {
     /** ID of the app */
     readonly id: Snowflake;
@@ -191,6 +225,8 @@ export interface Application {
     readonly flags?: number;
     /** Approximate count of guilds the app has been added to */
     readonly approximate_guild_count?: number;
+    /** Approximate count of users that have installed the app */
+    readonly approximate_user_install_count?: number;
     /** Array of redirect URIs for the app */
     readonly redirect_uris?: Array<string>;
     /** Interactions endpoint URL for the app */
@@ -239,21 +275,23 @@ export interface ApplicationCommand {
     readonly contexts?: Array<InteractionContextType> | null;
     /** Autoincrementing version identifier updated during substantial record changes */
     readonly version: Snowflake;
+    /** Determines whether the interaction is handled by the app's interactions handler or by Discord */
+    readonly handler?: EntryPointCommandHandlerType;
 }
 export interface ApplicationCommandDatum {
-    /** the ID of the invoked command */
+    /** ID of the invoked command */
     readonly id: Snowflake;
-    /** the name of the invoked command */
+    /** name of the invoked command */
     readonly name: string;
-    /** the type of the invoked command */
+    /** type of the invoked command */
     readonly type: number;
-    /** converted users + roles + channels + attachments */
+    /** Converted users + roles + channels + attachments */
     readonly resolved?: ResolvedDatum;
-    /** the params + values from the user */
+    /** Params + values from the user */
     readonly options?: Array<ApplicationCommandInteractionDataOption>;
-    /** the id of the guild the command is registered to */
+    /** ID of the guild the command is registered to */
     readonly guild_id?: Snowflake;
-    /** id of the user or message targeted by a user or message command */
+    /** ID of the user or message targeted by a user or message command */
     readonly target_id?: Snowflake;
 }
 export interface ApplicationCommandInteractionDataOption {
@@ -339,7 +377,9 @@ export declare enum ApplicationCommandType {
     /** A UI-based command that shows up when you right click or tap on a user */
     USER = 2,
     /** A UI-based command that shows up when you right click or tap on a message */
-    MESSAGE = 3
+    MESSAGE = 3,
+    /** A UI-based command that represents the primary way to invoke an app's Activity */
+    PRIMARY_ENTRY_POINT = 4
 }
 export declare const ApplicationFlag: {
     /** Indicates if an app uses the Auto Moderation API */
@@ -1473,7 +1513,9 @@ export declare enum EmbedType {
     /** article embed */
     ARTICLE = "article",
     /** link embed */
-    LINK = "link"
+    LINK = "link",
+    /** poll result embed */
+    POLL_RESULT = "poll_result"
 }
 export interface EmbedVideo {
     /** source url of video */
@@ -1554,7 +1596,7 @@ export interface Endpoints<O> {
     createGuildSticker: (guildId: string, params?: Partial<CreateGuildStickerParams>, options?: O) => RestResponse<Sticker>;
     /** Creates a template for the guild. Requires the MANAGE_GUILD permission. Returns the created guild template object on success. */
     createGuildTemplate: (guildId: string, params?: Partial<CreateGuildTemplateParams>, options?: O) => RestResponse<GuildTemplate>;
-    /** Create a response to an Interaction from the gateway. Body is an interaction response. Returns 204 No Content. */
+    /** Create a response to an Interaction. Body is an interaction response. Returns 204 unless with_response is set to true which returns 200 with the body as  interaction response. */
     createInteractionResponse: (interactionId: string, interactionToken: string, params?: Partial<InteractionResponse>, options?: O) => RestResponse<InteractionResponse>;
     createMessage: (channelId: string, params?: Partial<CreateMessageParams>, options?: O) => RestResponse<Message>;
     /** Create a reaction for the message. This endpoint requires the READ_MESSAGE_HISTORY permission to be present on the current user. Additionally, if nobody else has reacted to the message using this emoji, this endpoint requires the ADD_REACTIONS permission to be present on the current user. Returns a 204 empty response on success. Fires a Message Reaction Add Gateway event.
@@ -1650,6 +1692,8 @@ export interface Endpoints<O> {
     followAnnouncementChannel: (channelId: string, params?: Partial<FollowAnnouncementChannelParams>, options?: O) => RestResponse<FollowedChannel>;
     /** Get a list of users that voted for this specific answer. */
     getAnswerVoters: (channelId: string, messageId: string, answerId: string, params?: Partial<GetAnswerVoterParams>, options?: O) => RestResponse<GetAnswerVoterResponse>;
+    /** Returns a serialized activity instance, if it exists. Useful for preventing unwanted activity sessions. */
+    getApplicationActivityInstance: (applicationId: string, instanceId: string, options?: O) => RestResponse<any>;
     /** Fetches permissions for a specific command for your application in a guild. Returns a guild application command permissions object. */
     getApplicationCommandPermissions: (applicationId: string, guildId: string, commandId: string, options?: O) => RestResponse<GuildApplicationCommandPermission>;
     /** Returns an emoji object for the given application and emoji IDs. Includes the user field. */
@@ -1723,6 +1767,8 @@ export interface Endpoints<O> {
     getGuildPreview: (guildId: string, options?: O) => RestResponse<GuildPreview>;
     /** Returns an object with one pruned key indicating the number of members that would be removed in a prune operation. Requires the MANAGE_GUILD and KICK_MEMBERS permissions. */
     getGuildPruneCount: (guildId: string, params?: Partial<GetGuildPruneCountParams>, options?: O) => RestResponse<any>;
+    /** Returns a role object for the specified role. */
+    getGuildRole: (guildId: string, roleId: string, options?: O) => RestResponse<Role>;
     /** Returns a list of role objects for the guild. */
     getGuildRoles: (guildId: string, options?: O) => RestResponse<Array<Role>>;
     /** Get a guild scheduled event. Returns a guild scheduled event object on success. */
@@ -1762,6 +1808,8 @@ export interface Endpoints<O> {
     getStageInstance: (channelId: string, options?: O) => RestResponse<any>;
     /** Returns a sticker object for the given sticker ID. */
     getSticker: (stickerId: string, options?: O) => RestResponse<Sticker>;
+    /** Returns a sticker pack object for the given sticker pack ID. */
+    getStickerPack: (packId: string, options?: O) => RestResponse<StickerPack>;
     /** Returns a thread member object for the specified user if they are a member of the thread, returns a 404 response otherwise. */
     getThreadMember: (channelId: string, userId: string, params?: Partial<GetThreadMemberParams>, options?: O) => RestResponse<ThreadMember>;
     /** Returns a user object for a given user ID. */
@@ -1932,6 +1980,10 @@ export declare enum EntitlementType {
     APPLICATION_SUBSCRIPTION = 8
 }
 export type EntitlementUpdateEvent = Entitlement;
+export declare enum EntryPointCommandHandlerType {
+    APP_HANDLER = 1,
+    DISCORD_LAUNCH_ACTIVITY = 2
+}
 export declare enum EventType {
     /** when a member sends or edits a message in the guild */
     MESSAGE_SEND = 1,
@@ -2639,7 +2691,7 @@ export interface GuildScheduledEventRecurrenceRule {
     readonly end?: string | null;
     /** How often the event occurs */
     readonly frequency: GuildScheduledEventRecurrenceRuleFrequency;
-    /** The spacing between the events, defined by frequency. For example, frecency of WEEKLY and an interval of 2 would be "every-other week" */
+    /** The spacing between the events, defined by frequency. For example, frequency of WEEKLY and an interval of 2 would be "every-other week" */
     readonly interval: number;
     /** Set of specific days within a week for the event to recur on */
     readonly by_weekday?: Array<GuildScheduledEventRecurrenceRuleWeekday> | null;
@@ -2920,54 +2972,88 @@ export interface Interaction {
     /** Context where the interaction was triggered from */
     readonly context?: InteractionContextType;
 }
+export interface InteractionCallback {
+    /**  */
+    readonly id: Snowflake;
+    /** Interaction type */
+    readonly type: InteractionType;
+    /** Instance ID of the Activity if one was launched or joined */
+    readonly activity_instance_id?: string;
+    /** ID of the message that was created by the interaction */
+    readonly response_message_id?: Snowflake;
+    /** Whether or not the message is in a loading state */
+    readonly response_message_loading?: boolean;
+    /** Whether or not the response message was ephemeral */
+    readonly response_message_ephemeral?: boolean;
+}
+export interface InteractionCallbackActivityInstanceResource {
+    /** Instance ID of the Activity if one was launched or joined. */
+    readonly id: string;
+}
 export interface InteractionCallbackAutocomplete {
     /** autocomplete choices (max of 25 choices) */
     readonly choices: Array<ApplicationCommandOptionChoice>;
 }
 export type InteractionCallbackDatum = InteractionCallbackAutocomplete | InteractionCallbackMessage | InteractionCallbackModal;
 export interface InteractionCallbackMessage {
-    /** is the response TTS */
+    /** Whether the response is TTS */
     readonly tts?: boolean;
-    /** message content */
+    /** Message content */
     readonly content?: string;
-    /** supports up to 10 embeds */
+    /** Supports up to 10 embeds */
     readonly embeds?: Array<Embed>;
-    /** allowed mentions object */
+    /** Allowed mentions object */
     readonly allowed_mentions?: AllowedMention;
-    /** message flags combined as a bitfield (only SUPPRESS_EMBEDS, EPHEMERAL, and SUPPRESS_NOTIFICATIONS can be set) */
+    /** Message flags combined as a bitfield (only SUPPRESS_EMBEDS, EPHEMERAL, and SUPPRESS_NOTIFICATIONS can be set) */
     readonly flags?: number;
-    /** message components */
+    /** Message components */
     readonly components?: Array<Component>;
-    /** attachment objects with filename and description */
+    /** Attachment objects with filename and description */
     readonly attachments?: Array<Attachment>;
-    /** A poll! */
+    /** Details about the poll */
     readonly poll?: PollCreateRequest;
 }
 export interface InteractionCallbackModal {
-    /** a developer-defined identifier for the modal, max 100 characters */
+    /** Developer-defined identifier for the modal, max 100 characters */
     readonly custom_id: string;
-    /** the title of the popup modal, max 45 characters */
+    /** Title of the popup modal, max 45 characters */
     readonly title: string;
-    /** between 1 and 5 (inclusive) components that make up the modal */
+    /** Between 1 and 5 (inclusive) components that make up the modal */
     readonly components: Array<Component>;
 }
+export interface InteractionCallbackResource {
+    /** Interaction callback type */
+    readonly type: InteractionCallbackType;
+    /** Represents the Activity launched by this interaction. */
+    readonly activity_instance?: InteractionCallbackActivityInstanceResource;
+    /** Message created by the interaction. */
+    readonly message?: Message;
+}
+export interface InteractionCallbackResponse {
+    /** The interaction object associated with the */
+    readonly interaction: InteractionCallback;
+    /** The resource that was created by the interaction response. */
+    readonly resource?: InteractionCallbackResource;
+}
 export declare enum InteractionCallbackType {
     /** ACK a Ping */
     PONG = 1,
-    /** respond to an interaction with a message */
+    /** Respond to an interaction with a message */
     CHANNEL_MESSAGE_WITH_SOURCE = 4,
     /** ACK an interaction and edit a response later, the user sees a loading state */
     DEFERRED_CHANNEL_MESSAGE_WITH_SOURCE = 5,
-    /** for components, ACK an interaction and edit the original message later; the user does not see a loading state */
+    /** For components, ACK an interaction and edit the original message later; the user does not see a loading state */
     DEFERRED_UPDATE_MESSAGE = 6,
-    /** for components, edit the message the component was attached to */
+    /** For components, edit the message the component was attached to */
     UPDATE_MESSAGE = 7,
-    /** respond to an autocomplete interaction with suggested choices */
+    /** Respond to an autocomplete interaction with suggested choices */
     APPLICATION_COMMAND_AUTOCOMPLETE_RESULT = 8,
-    /** respond to an interaction with a popup modal */
+    /** Respond to an interaction with a popup modal */
     MODAL = 9,
     /** Deprecated; respond to an interaction with an upgrade button, only available for apps with monetization enabled */
-    PREMIUM_REQUIRED = 10
+    PREMIUM_REQUIRED = 10,
+    /** Launch the Activity associated with the app. Only available for apps with Activities enabled */
+    LAUNCH_ACTIVITY = 12
 }
 export declare enum InteractionContextType {
     /** Interaction can be used within servers */
@@ -2980,9 +3066,9 @@ export declare enum InteractionContextType {
 export type InteractionCreateEvent = Interaction;
 export type InteractionDatum = ApplicationCommandDatum | MessageComponentDatum | ModalSubmitDatum;
 export interface InteractionResponse {
-    /** the type of response */
+    /** Type of response */
     readonly type: InteractionCallbackType;
-    /** an optional response message */
+    /** An optional response message */
     readonly data?: InteractionCallbackDatum;
 }
 export declare enum InteractionType {
@@ -3323,13 +3409,13 @@ export interface MessageCall {
     readonly ended_timestamp?: string | null;
 }
 export interface MessageComponentDatum {
-    /** the custom_id of the component */
+    /** custom_id of the component */
     readonly custom_id: string;
-    /** the type of the component */
+    /** type of the component */
     readonly component_type: ComponentType;
-    /** values the user selected in a select menu component */
+    /** Values the user selected in a select menu component */
     readonly values?: Array<SelectOption>;
-    /** resolved entities from selected options */
+    /** Resolved entities from selected options */
     readonly resolved?: ResolvedDatum;
 }
 export type MessageCreateEvent = Message & MessageCreateExtra;
@@ -3547,7 +3633,8 @@ export declare enum MessageType {
     GUILD_INCIDENT_ALERT_MODE_DISABLED = 37,
     GUILD_INCIDENT_REPORT_RAID = 38,
     GUILD_INCIDENT_REPORT_FALSE_ALARM = 39,
-    PURCHASE_NOTIFICATION = 44
+    PURCHASE_NOTIFICATION = 44,
+    POLL_RESULT = 46
 }
 export type MessageUpdateEvent = MessageCreateEvent;
 export declare enum MfaLevel {
@@ -3557,9 +3644,9 @@ export declare enum MfaLevel {
     ELEVATED = 1
 }
 export interface ModalSubmitDatum {
-    /** the custom_id of the modal */
+    /** custom_id of the modal */
     readonly custom_id: string;
-    /** the values submitted by the user */
+    /** Values submitted by the user */
     readonly components: Array<Component>;
 }
 export interface ModifyApplicationEmojiParams {
@@ -3805,7 +3892,7 @@ export interface ModifyGuildScheduledEventParams {
     /** the cover image of the scheduled event */
     readonly image?: string;
     /** the definition for how often this event should recur */
-    readonly recurrence_rule?: GuildScheduledEventRecurrenceRule;
+    readonly recurrence_rule?: GuildScheduledEventRecurrenceRule | null;
 }
 export interface ModifyGuildStickerParams {
     /** name of the sticker (2-30 characters) */
@@ -4195,7 +4282,7 @@ export interface ReadyEvent {
     /** Contains id and flags */
     readonly application: Application;
 }
-export type ReceiveEvent = HelloEvent | ReadyEvent | ResumedEvent | ReconnectEvent | InvalidSessionEvent | ApplicationCommandPermissionsUpdateEvent | AutoModerationRuleCreateEvent | AutoModerationRuleUpdateEvent | AutoModerationRuleDeleteEvent | AutoModerationActionExecutionEvent | ChannelCreateEvent | ChannelUpdateEvent | ChannelDeleteEvent | ChannelPinsUpdateEvent | ThreadCreateEvent | ThreadUpdateEvent | ThreadDeleteEvent | ThreadListSyncEvent | ThreadMemberUpdateEvent | ThreadMembersUpdateEvent | EntitlementCreateEvent | EntitlementUpdateEvent | EntitlementDeleteEvent | GuildCreateEvent | GuildUpdateEvent | GuildDeleteEvent | GuildAuditLogEntryCreateEvent | GuildBanAddEvent | GuildBanRemoveEvent | GuildEmojisUpdateEvent | GuildStickersUpdateEvent | GuildIntegrationsUpdateEvent | GuildMemberAddEvent | GuildMemberRemoveEvent | GuildMemberUpdateEvent | GuildMembersChunkEvent | GuildRoleCreateEvent | GuildRoleUpdateEvent | GuildRoleDeleteEvent | GuildScheduledEventCreateEvent | GuildScheduledEventUpdateEvent | GuildScheduledEventDeleteEvent | GuildScheduledEventUserAddEvent | GuildScheduledEventUserRemoveEvent | IntegrationCreateEvent | IntegrationUpdateEvent | IntegrationDeleteEvent | InteractionCreateEvent | InviteCreateEvent | InviteDeleteEvent | MessageCreateEvent | MessageUpdateEvent | MessageDeleteEvent | MessageDeleteBulkEvent | MessageReactionAddEvent | MessageReactionRemoveEvent | MessageReactionRemoveAllEvent | MessageReactionRemoveEmojiEvent | PresenceUpdateEvent | StageInstanceCreateEvent | StageInstanceUpdateEvent | StageInstanceDeleteEvent | TypingStartEvent | UserUpdateEvent | VoiceStateUpdateEvent | VoiceServerUpdateEvent | WebhooksUpdateEvent | MessagePollVoteAddEvent | MessagePollVoteRemoveEvent;
+export type ReceiveEvent = HelloEvent | ReadyEvent | ResumedEvent | ReconnectEvent | InvalidSessionEvent | ApplicationCommandPermissionsUpdateEvent | AutoModerationRuleCreateEvent | AutoModerationRuleUpdateEvent | AutoModerationRuleDeleteEvent | AutoModerationActionExecutionEvent | ChannelCreateEvent | ChannelUpdateEvent | ChannelDeleteEvent | ChannelPinsUpdateEvent | ThreadCreateEvent | ThreadUpdateEvent | ThreadDeleteEvent | ThreadListSyncEvent | ThreadMemberUpdateEvent | ThreadMembersUpdateEvent | EntitlementCreateEvent | EntitlementUpdateEvent | EntitlementDeleteEvent | GuildCreateEvent | GuildUpdateEvent | GuildDeleteEvent | GuildAuditLogEntryCreateEvent | GuildBanAddEvent | GuildBanRemoveEvent | GuildEmojisUpdateEvent | GuildStickersUpdateEvent | GuildIntegrationsUpdateEvent | GuildMemberAddEvent | GuildMemberRemoveEvent | GuildMemberUpdateEvent | GuildMembersChunkEvent | GuildRoleCreateEvent | GuildRoleUpdateEvent | GuildRoleDeleteEvent | GuildScheduledEventCreateEvent | GuildScheduledEventUpdateEvent | GuildScheduledEventDeleteEvent | GuildScheduledEventUserAddEvent | GuildScheduledEventUserRemoveEvent | IntegrationCreateEvent | IntegrationUpdateEvent | IntegrationDeleteEvent | InteractionCreateEvent | InviteCreateEvent | InviteDeleteEvent | MessageCreateEvent | MessageUpdateEvent | MessageDeleteEvent | MessageDeleteBulkEvent | MessageReactionAddEvent | MessageReactionRemoveEvent | MessageReactionRemoveAllEvent | MessageReactionRemoveEmojiEvent | PresenceUpdateEvent | StageInstanceCreateEvent | StageInstanceUpdateEvent | StageInstanceDeleteEvent | TypingStartEvent | UserUpdateEvent | VoiceChannelEffectSendEvent | VoiceStateUpdateEvent | VoiceServerUpdateEvent | WebhooksUpdateEvent | MessagePollVoteAddEvent | MessagePollVoteRemoveEvent;
 export interface ReceiveEvents {
     HELLO: HelloEvent;
     READY: ReadyEvent;
@@ -4261,6 +4348,7 @@ export interface ReceiveEvents {
     STAGE_INSTANCE_DELETE: StageInstanceDeleteEvent;
     TYPING_START: TypingStartEvent;
     USER_UPDATE: UserUpdateEvent;
+    VOICE_CHANNEL_EFFECT_SEND: VoiceChannelEffectSendEvent;
     VOICE_STATE_UPDATE: VoiceStateUpdateEvent;
     VOICE_SERVER_UPDATE: VoiceServerUpdateEvent;
     WEBHOOKS_UPDATE: WebhooksUpdateEvent;
@@ -4283,17 +4371,17 @@ export interface RequestGuildMember {
     readonly nonce?: string;
 }
 export interface ResolvedDatum {
-    /** the ids and User objects */
+    /** IDs and User objects */
     readonly users?: Record<Snowflake, User>;
-    /** the ids and partial Member objects */
+    /** IDs and partial Member objects */
     readonly members?: Record<Snowflake, GuildMember>;
-    /** the ids and Role objects */
+    /** IDs and Role objects */
     readonly roles?: Record<Snowflake, Role>;
-    /** the ids and partial Channel objects */
+    /** IDs and partial Channel objects */
     readonly channels?: Record<Snowflake, Channel>;
-    /** the ids and partial Message objects */
+    /** IDs and partial Message objects */
     readonly messages?: Record<Snowflake, Message>;
-    /** the ids and attachment objects */
+    /** IDs and attachment objects */
     readonly attachments?: Record<Snowflake, Attachment>;
 }
 export interface Response {
@@ -4907,6 +4995,24 @@ export declare enum VisibilityType {
     /** visible to everyone */
     EVERYONE = 1
 }
+export interface VoiceChannelEffectSendEvent {
+    /** ID of the channel the effect was sent in */
+    readonly channel_id: Snowflake;
+    /** ID of the guild the effect was sent in */
+    readonly guild_id: Snowflake;
+    /** ID of the user who sent the effect */
+    readonly user_id: Snowflake;
+    /** The emoji sent, for emoji reaction and soundboard effects */
+    readonly emoji?: Emoji | null;
+    /** The type of emoji animation, for emoji reaction and soundboard effects */
+    readonly animation_type?: AnimationType | null;
+    /** The ID of the emoji animation, for emoji reaction and soundboard effects */
+    readonly animation_id?: number;
+    /** The ID of the soundboard sound, for soundboard effects */
+    readonly sound_id?: Snowflake;
+    /** The volume of the soundboard sound, from 0 to 1, for soundboard effects */
+    readonly sound_volume?: number;
+}
 export declare enum VoiceOpcode {
     /** Begin a voice websocket connection. */
     IDENTIFY = 0,