snowtransfer 0.18.0 → 0.19.0

package/dist/methods/Bot.d.ts

@@ -0,0 +1,65 @@
+import type { RequestHandler } from "../RequestHandler";
+import type { RESTGetAPIGatewayBotResult, RESTGetAPIGatewayResult, APIApplication, RESTPatchCurrentApplicationJSONBody } from "discord-api-types/v10";
+/**
+ * Methods for interacting with bot specific endpoints
+ * @since 0.1.0
+ */
+declare class BotMethods {
+    readonly requestHandler: RequestHandler;
+    /**
+     * Create a new Bot Method Handler
+     *
+     * Usually SnowTransfer creates a method handler for you, this is here for completion
+     *
+     * You can access the methods listed via `client.bot.method`, where `client` is an initialized SnowTransfer instance
+     * @param requestHandler request handler that calls the rest api
+     */
+    constructor(requestHandler: RequestHandler);
+    /**
+     * Get the gateway url to connect to
+     * @since 0.1.0
+     * @returns [Gateway data](https://discord.com/developers/docs/topics/gateway#get-gateway-example-response)
+     *
+     * @example
+     * const client = new SnowTransfer("TOKEN")
+     * const result = await client.bot.getGateway()
+     * // result should be something like { url: "wss://gateway.discord.gg" }
+     */
+    getGateway(): Promise<RESTGetAPIGatewayResult>;
+    /**
+     * Get the gateway url to connect to and a recommended amount of shards to use
+     * @since 0.1.0
+     * @returns [Gateway data](https://discord.com/developers/docs/topics/gateway#get-gateway-example-response)
+     *
+     * @example
+     * const client = new SnowTransfer("TOKEN")
+     * const result = await client.bot.getGatewayBot()
+     * // result should be something like { url: "wss://gateway.discord.gg", shards: 1, session_start_limit: { total: 1000, remaining: 999, reset_after: 14400000, max_concurrency: 1 } }
+     */
+    getGatewayBot(): Promise<RESTGetAPIGatewayBotResult>;
+    /**
+     * Get the Application Object for the Current User
+     * @since 0.11.0
+     * @returns An [Application object](https://discord.com/developers/docs/resources/application#application-object-application-structure)
+     *
+     * @example
+     * const client = new SnowTransfer("TOKEN")
+     * const result = await client.bot.getApplicationInfo()
+     */
+    getApplicationInfo(): Promise<APIApplication>;
+    /**
+     * Update the Application Object for the Current User
+     * @since 0.18.0
+     * @returns An [Application object](https://discord.com/developers/docs/resources/application#application-object-application-structure)
+     *
+     * @example
+     * const client = new SnowTransfer("TOKEN")
+     * const appData = {
+     * 	description: "My new bot description",
+     * 	interactions_endpoint_url: "https://mycoolbot.example/api/interactions"
+     * };
+     * client.bot.editApplicationInfo(appData)
+     */
+    editApplicationInfo(data: RESTPatchCurrentApplicationJSONBody): Promise<APIApplication>;
+}
+export = BotMethods;

package/dist/methods/Bot.js

@@ -0,0 +1,75 @@
+"use strict";
+const Endpoints = require("../Endpoints");
+/**
+ * Methods for interacting with bot specific endpoints
+ * @since 0.1.0
+ */
+class BotMethods {
+    requestHandler;
+    /**
+     * Create a new Bot Method Handler
+     *
+     * Usually SnowTransfer creates a method handler for you, this is here for completion
+     *
+     * You can access the methods listed via `client.bot.method`, where `client` is an initialized SnowTransfer instance
+     * @param requestHandler request handler that calls the rest api
+     */
+    constructor(requestHandler) {
+        this.requestHandler = requestHandler;
+    }
+    /**
+     * Get the gateway url to connect to
+     * @since 0.1.0
+     * @returns [Gateway data](https://discord.com/developers/docs/topics/gateway#get-gateway-example-response)
+     *
+     * @example
+     * const client = new SnowTransfer("TOKEN")
+     * const result = await client.bot.getGateway()
+     * // result should be something like { url: "wss://gateway.discord.gg" }
+     */
+    async getGateway() {
+        return this.requestHandler.request(Endpoints.GATEWAY, {}, "get", "json");
+    }
+    /**
+     * Get the gateway url to connect to and a recommended amount of shards to use
+     * @since 0.1.0
+     * @returns [Gateway data](https://discord.com/developers/docs/topics/gateway#get-gateway-example-response)
+     *
+     * @example
+     * const client = new SnowTransfer("TOKEN")
+     * const result = await client.bot.getGatewayBot()
+     * // result should be something like { url: "wss://gateway.discord.gg", shards: 1, session_start_limit: { total: 1000, remaining: 999, reset_after: 14400000, max_concurrency: 1 } }
+     */
+    async getGatewayBot() {
+        return this.requestHandler.request(Endpoints.GATEWAY_BOT, {}, "get", "json");
+    }
+    /**
+     * Get the Application Object for the Current User
+     * @since 0.11.0
+     * @returns An [Application object](https://discord.com/developers/docs/resources/application#application-object-application-structure)
+     *
+     * @example
+     * const client = new SnowTransfer("TOKEN")
+     * const result = await client.bot.getApplicationInfo()
+     */
+    async getApplicationInfo() {
+        return this.requestHandler.request(Endpoints.OAUTH2_APPLICATION("@me"), {}, "get", "json");
+    }
+    /**
+     * Update the Application Object for the Current User
+     * @since 0.18.0
+     * @returns An [Application object](https://discord.com/developers/docs/resources/application#application-object-application-structure)
+     *
+     * @example
+     * const client = new SnowTransfer("TOKEN")
+     * const appData = {
+     * 	description: "My new bot description",
+     * 	interactions_endpoint_url: "https://mycoolbot.example/api/interactions"
+     * };
+     * client.bot.editApplicationInfo(appData)
+     */
+    async editApplicationInfo(data) {
+        return this.requestHandler.request(Endpoints.OAUTH2_APPLICATION("@me"), {}, "patch", "json", data);
+    }
+}
+module.exports = BotMethods;