magmastream 2.9.3-dev.9 → 2.10.0

package/dist/structures/Rest.d.ts

@@ -0,0 +1,93 @@
+import { Node } from "./Node";
+import { Manager } from "./Manager";
+import { LavaPlayer, RestPlayOptions } from "./Types";
+/** Handles the requests sent to the Lavalink REST API. */
+export declare class Rest {
+    /** The Node that this Rest instance is connected to. */
+    private node;
+    /** The ID of the current session. */
+    private sessionId;
+    /** The password for the Node. */
+    private readonly password;
+    /** The URL of the Node. */
+    private readonly url;
+    /** The Manager instance. */
+    manager: Manager;
+    /** Whether the node is a NodeLink. */
+    isNodeLink: boolean;
+    constructor(node: Node, manager: Manager);
+    /**
+     * Sets the session ID.
+     * This method is used to set the session ID after a resume operation is done.
+     * @param {string} sessionId The session ID to set.
+     * @returns {string} Returns the set session ID.
+     */
+    setSessionId(sessionId: string): string;
+    /**
+     * Retrieves one the player that is currently running on the node.
+     * @returns {Promise<unknown>} Returns the result of the GET request.
+     */
+    getPlayer(guildId: string): Promise<LavaPlayer>;
+    /**
+     * Sends a PATCH request to update player related data.
+     * @param {RestPlayOptions} options The options to update the player with.
+     * @returns {Promise<unknown>} Returns the result of the PATCH request.
+     */
+    updatePlayer(options: RestPlayOptions): Promise<unknown>;
+    /**
+     * Sends a DELETE request to the server to destroy the player.
+     * @param {string} guildId The guild ID of the player to destroy.
+     * @returns {Promise<unknown>} Returns the result of the DELETE request.
+     */
+    destroyPlayer(guildId: string): Promise<unknown>;
+    /**
+     * Updates the session status for resuming.
+     * This method sends a PATCH request to update the session's resuming status and timeout.
+     *
+     * @param {boolean} resuming - Indicates whether the session should be set to resuming.
+     * @param {number} timeout - The timeout duration for the session resume.
+     * @returns {Promise<unknown>} The result of the PATCH request.
+     */
+    updateSession(resuming: boolean, timeout: number): Promise<unknown>;
+    /**
+     * Sends a request to the specified endpoint and returns the response data.
+     * @param {string} method The HTTP method to use for the request.
+     * @param {string} endpoint The endpoint to send the request to.
+     * @param {unknown} [body] The data to send in the request body.
+     * @returns {Promise<unknown>} The response data of the request.
+     */
+    private request;
+    /**
+     * Sends a GET request to the specified endpoint and returns the response data.
+     * @param {string} endpoint The endpoint to send the GET request to.
+     * @returns {Promise<unknown>} The response data of the GET request.
+     */
+    get(endpoint: string): Promise<unknown>;
+    /**
+     * Sends a PATCH request to the specified endpoint and returns the response data.
+     * @param {string} endpoint The endpoint to send the PATCH request to.
+     * @param {unknown} body The data to send in the request body.
+     * @returns {Promise<unknown>} The response data of the PATCH request.
+     */
+    patch(endpoint: string, body: unknown): Promise<unknown>;
+    /**
+     * Sends a POST request to the specified endpoint and returns the response data.
+     * @param {string} endpoint The endpoint to send the POST request to.
+     * @param {unknown} body The data to send in the request body.
+     * @returns {Promise<unknown>} The response data of the POST request.
+     */
+    post(endpoint: string, body: unknown): Promise<unknown>;
+    /**
+     * Sends a PUT request to the specified endpoint and returns the response data.
+     * @param {string} endpoint The endpoint to send the PUT request to.
+     * @param {unknown} body The data to send in the request body.
+     * @returns {Promise<unknown>} The response data of the PUT request.
+     */
+    put(endpoint: string, body: unknown): Promise<unknown>;
+    /**
+     * Sends a DELETE request to the specified endpoint.
+     * @param {string} endpoint - The endpoint to send the DELETE request to.
+     * @returns {Promise<unknown>} The response data of the DELETE request.
+     */
+    delete(endpoint: string): Promise<unknown>;
+}