glitch-javascript-sdk 0.0.1 → 0.0.2

package/dist/esm/api/Auth.d.ts

@@ -1,5 +1,37 @@
+import Response from "../util/Response";
+import { AxiosPromise } from "axios";
 declare class Auth {
-    static login(login: string, password: string): Promise<import("../util/Response").default<unknown>>;
-    static register(data: object): Promise<import("../util/Response").default<unknown> | undefined>;
+    /**
+     * Attempts to authenticate a user using their email address.
+     *
+     * @see https://api.glitch.fun/api/documentation#/Authentication%20Route/authLogin
+     *
+     * @param email The email address of the user
+     * @param password The password of the user
+     *
+     * @returns A promise
+     */
+    static loginWithEmail<T>(email: string, password: string): AxiosPromise<Response<T>>;
+    /**
+     * Attempts to authenticate a user using their username.
+     *
+     * @see https://api.glitch.fun/api/documentation#/Authentication%20Route/authLogin
+     *
+     * @param username The username of the user
+     * @param password The password of the user
+     *
+     * @returns A promise
+     */
+    static loginWithUsername<T>(username: string, password: string): AxiosPromise<Response<T>>;
+    /**
+     * Attempts to register a user.
+     *
+     * @see https://api.glitch.fun/api/documentation#/Authentication%20Route/authRegister
+     *
+     * @param data The data the user can register with.
+     *
+     * @returns A promise
+     */
+    static register<T>(data: object): AxiosPromise<Response<T>>;
 }
 export default Auth;

package/dist/esm/api/Competitions.d.ts

@@ -1,8 +1,53 @@
+import Response from "../util/Response";
+import { AxiosPromise } from "axios";
 declare class Competitions {
-    static list(): Promise<import("../util/Response").default<unknown> | undefined>;
-    static create(data: object): Promise<import("../util/Response").default<unknown> | undefined>;
-    static update(competition_id: string, data: object): Promise<import("../util/Response").default<unknown> | undefined>;
-    static view(competition_id: string): Promise<import("../util/Response").default<unknown> | undefined>;
-    static delete(competition_id: string): Promise<import("../util/Response").default<unknown> | undefined>;
+    /**
+     * List all the competitions
+     *
+     * @see https://api.glitch.fun/api/documentation#/Competitions%20Route/resourceList
+     *
+     * @returns promise
+     */
+    static list<T>(): AxiosPromise<Response<T>>;
+    /**
+     * Create a new competition
+     *
+     * @see https://api.glitch.fun/api/documentation#/Competitions%20Route/newResourceStorage
+     *
+     * @param data The date to be passed when creating a competiton.
+     *
+     * @returns Promise
+     */
+    static create<T>(data: object): AxiosPromise<Response<T>>;
+    /**
+     * Update a competition
+     *
+     * @see https://api.glitch.fun/api/documentation#/Competitions%20Route/updateStorage
+     *
+     * @param competition_id The id of the competition to update.
+     * @param data The data to update.
+     *
+     * @returns promise
+     */
+    static update<T>(competition_id: string, data: object): AxiosPromise<Response<T>>;
+    /**
+     * Retrieve the information for a single competition.
+     *
+     * @see https://api.glitch.fun/api/documentation#/Competitions%20Route/showStorage
+     *
+     * @param competition_id The id fo the competition to retrieve.
+     *
+     * @returns promise
+     */
+    static view<T>(competition_id: string): AxiosPromise<Response<T>>;
+    /**
+     * Deletes a competition.
+     *
+     * @see https://api.glitch.fun/api/documentation#/Competitions%20Route/destoryStorage
+     *
+     * @param competition_id The id of the competition to delete.
+     * @returns promise
+     */
+    static delete<T>(competition_id: string): AxiosPromise<Response<T>>;
 }
 export default Competitions;