Add get activity instance route

Author: DonovanDMC

lib/Constants.ts

@@ -1508,6 +1508,11 @@ export enum MemberJoinSourceType {
     MANUAL_MEMBER_VERIFICATION = 7,
 }
 
+export enum ActivityLocationKind {
+    GUILD_CHANNEL   = "gc",
+    PRIVATE_CHANNEL = "pc",
+}
+
 // entries are intentionally not aligned
 /** The error codes that can be received. See [Discord's Documentation](https://discord.com/developers/docs/topics/opcodes-and-status-codes#json). */
 export enum JSONErrorCodes {

lib/routes/Applications.ts

@@ -28,13 +28,15 @@ import Entitlement from "../structures/Entitlement";
 import TestEntitlement from "../structures/TestEntitlement";
 import ClientApplication from "../structures/ClientApplication";
 import type {
+    ActivityInstance,
     ApplicationEmoji,
     ApplicationEmojis,
     CreateApplicationEmojiOptions,
     CreatePrimaryEntryPointApplicationCommandOptions,
     EditApplicationEmojiOptions,
     EditApplicationOptions,
     RESTApplication,
+    RawActivityInstance,
     RawApplicationEmoji,
     RawApplicationEmojis,
     RawClientApplication,
@@ -387,6 +389,29 @@ export default class Applications {
         });
     }
 
+    /**
+     * Get an activity instance.
+     * @param applicationID The ID of the application.
+     * @param instanceID The ID of the instance.
+     */
+    async getActivityInstance(applicationID: string, instanceID: string): Promise<ActivityInstance> {
+        return this._manager.authRequest<RawActivityInstance>({
+            method: "GET",
+            path:   Routes.APPLICATION_ACTIVITY_INSTANCE(applicationID, instanceID)
+        }).then(data => ({
+            applicationID: data.application_id,
+            instanceID:    data.instance_id,
+            launchID:      data.launch_id,
+            location:      {
+                channelID: data.location.channel_id,
+                guildID:   data.location.guild_id,
+                id:        data.location.id,
+                kind:      data.location.kind
+            },
+            users: data.users
+        }));
+    }
+
     /**
      * Get the currently authenticated bot's application info as a bare {@link ClientApplication | ClientApplication}.
      * @caching This method **does not** cache its result.

lib/structures/ClientApplication.ts

@@ -27,7 +27,8 @@ import type {
     ApplicationEmoji,
     ApplicationEmojis,
     CreateApplicationEmojiOptions,
-    EditApplicationEmojiOptions
+    EditApplicationEmojiOptions,
+    ActivityInstance
 } from "../types/applications";
 import type { JSONClientApplication } from "../types/json";
 import type { ApplicationCommandTypes } from "../Constants";
@@ -199,6 +200,14 @@ export default class ClientApplication extends Base {
         return this.client.rest.applications.editGuildCommandPermissions(this.id, guildID, commandID, options);
     }
 
+    /**
+     * Get an activity instance.
+     * @param instanceID The ID of the instance.
+     */
+    async getActivityInstance(instanceID: string): Promise<ActivityInstance> {
+        return this.client.rest.applications.getActivityInstance(this.id, instanceID);
+    }
+
     /**
      * Get an emoji for this application.
      * @param emojiID The ID of the emoji to get.

lib/types/applications.d.ts

@@ -3,6 +3,7 @@ import type { ImplementedChannels, InstallParams, RawOAuthGuild, RawUser } from
 import type { ExclusifyUnion } from "./shared";
 import type { Emoji, WithRequired } from "./misc";
 import type {
+    ActivityLocationKind,
     ApplicationCommandOptionTypes,
     ApplicationCommandPermissionTypes,
     ApplicationCommandTypes,
@@ -518,3 +519,44 @@ export interface SearchSKUSubscriptions {
     /** Required except for OAuth queries. */
     userID?: string;
 }
+
+export interface RawActivityInstance {
+    application_id: string;
+    instance_id: string;
+    launch_id: string;
+    location: RawActivityLocation;
+    users: Array<string>;
+}
+
+
+export interface RawActivityLocation {
+    channel_id: string;
+    guild_id?: string | null;
+    id: string;
+    kind: ActivityLocationKind;
+}
+
+export interface ActivityInstance {
+    /** Application ID. */
+    applicationID: string;
+    /** Activity Instance ID. */
+    instanceID: string;
+    /** Unique identifier for the launch. */
+    launchID: string;
+    /** Location the instance is runnning in. */
+    location: ActivityLocation;
+    /** IDs of the Users currently connected to the instance. */
+    users: Array<string>;
+}
+
+
+export interface ActivityLocation {
+    /**	ID of the Channel. */
+    channelID: string;
+    /** ID of the Guild. */
+    guildID?: string | null;
+    /** Unique identifier for the location. */
+    id: string;
+    /**	Enum describing kind of location. `gc` = guild channel, `pc` = private channel (dm, gdm). */
+    kind: ActivityLocationKind;
+}

lib/util/Routes.ts

@@ -157,6 +157,7 @@ export const SKU_SUBSCRIPTIONS                     = (skuID: string) => encode`/
 export const SKU_SUBSCRIPTION                      = (skuID: string, subscriptionID: string) => encode`/skus/${skuID}/subscriptions/${subscriptionID}`;
 export const APPLICATION_EMOJIS                    = (applicationID: string) => encode`/applications/${applicationID}/emojis`;
 export const APPLICATION_EMOJI                     = (applicationID: string, emojiID: string) => encode`/applications/${applicationID}/emojis/${emojiID}`;
+export const APPLICATION_ACTIVITY_INSTANCE         = (applicationID: string, instanceID: string) => encode`/applications/${applicationID}/activity-instances/${instanceID}`;
 
 // Misc
 export const GATEWAY                   = "/gateway";