glitch-javascript-sdk 0.0.3 → 0.0.6

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

@@ -0,0 +1,179 @@
+import Response from "../util/Response";
+import { AxiosPromise } from "axios";
+declare class Teams {
+    /**
+     * List all the teams
+     *
+     * @see https://api.glitch.fun/api/documentation#/Teams%20Route/teamsList
+     *
+     * @returns promise
+     */
+    static list<T>(): AxiosPromise<Response<T>>;
+    /**
+     * Create a new team.
+     *
+     * @see https://api.glitch.fun/api/documentation#/Teams%20Route/teamCreate
+     *
+     * @param data The data to be passed when creating a team.
+     *
+     * @returns Promise
+     */
+    static create<T>(data: object): AxiosPromise<Response<T>>;
+    /**
+     * Update a team.
+     *
+     * @see https://api.glitch.fun/api/documentation#/Teams%20Route/teamUpdate
+     *
+     * @param team_id The id of the team to update.
+     * @param data The data to update.
+     *
+     * @returns promise
+     */
+    static update<T>(team_id: string, data: object): AxiosPromise<Response<T>>;
+    /**
+     * Retrieve the information for a single team.
+     *
+     * @see https://api.glitch.fun/api/documentation#/Teams%20Route/teamShow
+     *
+     * @param team_id The id fo the team to retrieve.
+     *
+     * @returns promise
+     */
+    static view<T>(team_id: string): AxiosPromise<Response<T>>;
+    /**
+     * Deletes a team.
+     *
+     * @see https://api.glitch.fun/api/documentation#/Teams%20Route/teamDelete
+     *
+     * @param team_id The id of the team to delete.
+     * @returns promise
+     */
+    static delete<T>(team_id: string): AxiosPromise<Response<T>>;
+    /**
+     * Updates the main image for the team using a File object.
+     *
+     * @see https://api.glitch.fun/api/documentation#/Teams%20Route/teamUploadMainImage
+     *
+     * @param file The file object to upload.
+     * @param data Any additional data to pass along to the upload.
+     *
+     * @returns promise
+     */
+    static uploadMainImageFile<T>(team_id: string, file: File, data?: object): AxiosPromise<Response<T>>;
+    /**
+     * Updates the main image for the team using a Blob.
+     *
+     * @see https://api.glitch.fun/api/documentation#/Teams%20Route/teamUploadMainImage
+     *
+     * @param blob The blob to upload.
+     * @param data Any additional data to pass along to the upload
+     *
+     * @returns promise
+     */
+    static uploadMainImageBlob<T>(team_id: string, blob: Blob, data?: object): AxiosPromise<Response<T>>;
+    /**
+     * Updates the banner image for the team using a File object.
+     *
+     * @see https://api.glitch.fun/api/documentation#/Teams%20Route/teamUploadMainImage
+     *
+     * @param file The file object to upload.
+     * @param data Any additional data to pass along to the upload.
+     *
+     * @returns promise
+     */
+    static uploadBannerImageFile<T>(team_id: string, file: File, data?: object): AxiosPromise<Response<T>>;
+    /**
+     * Updates the banner image for the team using a Blob.
+     *
+     * @see https://api.glitch.fun/api/documentation#/Teams%20Route/teamUploadMainImage
+     *
+     * @param blob The blob to upload.
+     * @param data Any additional data to pass along to the upload
+     *
+     * @returns promise
+     */
+    static uploadBannerImageBlob<T>(team_id: string, blob: Blob, data?: object): AxiosPromise<Response<T>>;
+    /**
+     * List the invites that have been sent for the team to users.
+     *
+     * @see https://api.glitch.fun/api/documentation#/Teams%20Route/teamsUserInviteList
+     *
+     * @param team_id The id of the team
+     *
+     * @returns promise
+     */
+    static listInvites<T>(team_id: string): AxiosPromise<Response<T>>;
+    /**
+     * Send an invitation to a user to join the team.
+     *
+     * @see https://api.glitch.fun/api/documentation#/Teams%20Route/teamSendInvite
+     *
+     * @param team_id The id of the team.
+     * @param data The data that will be passed into sending an invite.
+     *
+     * @returns promise
+     */
+    static sendInvite<T>(team_id: string, data?: object): AxiosPromise<Response<T>>;
+    /**
+     * Accept an invite to a team. The JSON Web Token (JWT) must be related to the token.
+     *
+     * @see https://api.glitch.fun/api/documentation#/Teams%20Route/teamAcceptInvite
+     *
+     * @param team_id The id of the team
+     * @param token The token required to accept the user.
+     *
+     * @returns promise
+     */
+    static acceptInvite<T>(team_id: string, token: string): AxiosPromise<Response<T>>;
+    /**
+     * List the users who are currently associated with the team.
+     *
+     * @see https://api.glitch.fun/api/documentation#/Teams%20Route/teamUserList
+     *
+     * @param team_id The id of the team.
+     *
+     * @returns promise
+     */
+    static listUsers<T>(team_id: string): AxiosPromise<Response<T>>;
+    /**
+     * Add a user to a team.
+     *
+     * @see https://api.glitch.fun/api/documentation#/Teams%20Route/createTeamUser
+     *
+     * @param team_id The id of the team.
+     * @param data The data to be passed when adding a user.
+     *
+     * @returns promise
+     */
+    static addUser<T>(team_id: string, data?: object): AxiosPromise<Response<T>>;
+    /**
+     * Retrieves a single user and their information that is associated with a team.
+     *
+     * @see https://api.glitch.fun/api/documentation#/Teams%20Route/showTeamUser
+     *
+     * @param team_id The id of the team.
+     * @param user_id The id of the user.
+     *
+     * @returns promise
+     */
+    static getUser<T>(team_id: string, user_id: string): AxiosPromise<Response<T>>;
+    /**
+     * Updates the users information associated with the team.
+     *
+     * @param team_id The id of the team.
+     * @param user_id The id of the user.
+     *
+     * @returns promise
+     */
+    static updatetUser<T>(team_id: string, user_id: string, data?: object): AxiosPromise<Response<T>>;
+    /**
+     * Removes a user from a team.
+     *
+     * @param team_id The id of team.
+     * @param user_id The id of the user.
+     *
+     * @returns promise
+     */
+    static removetUser<T>(team_id: string, user_id: string): AxiosPromise<Response<T>>;
+}
+export default Teams;

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

@@ -58,5 +58,58 @@ declare class Users {
      * @returns promise
      */
     static oneTimeLoginToken<T>(): AxiosPromise<Response<T>>;
+    /**
+     * Updates the avatar image for the user using a File object.
+     *
+     * @see https://api.glitch.fun/api/documentation#/Users%20Route/userUploadAvatarImage
+     *
+     * @param file The file object to upload.
+     * @param data Any additional data to pass along to the upload.
+     *
+     * @returns promise
+     */
+    static uploadAvatarImageFile<T>(file: File, data?: object): AxiosPromise<Response<T>>;
+    /**
+     * Updates the avatar image for the user using a Blob.
+     *
+     * @see https://api.glitch.fun/api/documentation#/Users%20Route/userUploadAvatarImage
+     *
+     * @param blob The blob to upload.
+     * @param data Any additional data to pass along to the upload
+     *
+     * @returns promise
+     */
+    static uploadAvatarImageBlob<T>(blob: Blob, data?: object): AxiosPromise<Response<T>>;
+    /**
+     * Upload a banner image for the user, as a File object.
+     *
+     * @see https://api.glitch.fun/api/documentation#/Users%20Route/userUploadBannerImage
+     *
+     * @param file The file object to upload.
+     * @param data Any additional data to pass along to the upload.
+     *
+     * @returns promise
+     */
+    static uploadBannerImageFile<T>(file: File, data?: object): AxiosPromise<Response<T>>;
+    /**
+     * Upload a banner image for the user, as a Blob.
+     *
+     * @see https://api.glitch.fun/api/documentation#/Users%20Route/userUploadBannerImage
+     *
+     * @param file The blob to upload.
+     * @param data Any additional data to pass along to the upload.
+     *
+     * @returns promise
+     */
+    static uploadBannerImageBlob<T>(blob: Blob, data?: object): AxiosPromise<Response<T>>;
+    /**
+     * Creates a donation page for that user by syncing their information with various
+     * payment service.
+     *
+     * @see https://api.glitch.fun/api/documentation#/Users%20Route/userCreateDonationPage
+     *
+     * @returns promise
+     */
+    static createDonationPage<T>(): AxiosPromise<Response<T>>;
 }
 export default Users;

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

@@ -0,0 +1,53 @@
+import Response from "../util/Response";
+import { AxiosPromise } from "axios";
+declare class Teams {
+    /**
+     * List all the waitlist sign-ups.
+     *
+     * @see https://api.glitch.fun/api/documentation#/Waitlist%20Route/waitlistList
+     *
+     * @returns promise
+     */
+    static list<T>(): AxiosPromise<Response<T>>;
+    /**
+     * Sign-up to the waitlist.
+     *
+     * @see https://api.glitch.fun/api/documentation#/Waitlist%20Route/waitlistCreate
+     *
+     * @param data The data to be passed when creating a team.
+     *
+     * @returns Promise
+     */
+    static create<T>(data: object): AxiosPromise<Response<T>>;
+    /**
+     * Update a waitlist.
+     *
+     * @see https://api.glitch.fun/api/documentation#/Waitlist%20Route/waitlistUpdate
+     *
+     * @param waitlist_id The id of the team to update.
+     * @param data The data to update.
+     *
+     * @returns promise
+     */
+    static update<T>(waitlist_id: string, data: object): AxiosPromise<Response<T>>;
+    /**
+     * Retrieve the information for a single user who signed-up to the waitlist.
+     *
+     * @see https://api.glitch.fun/api/documentation#/Waitlist%20Route/waitlistUpdate
+     *
+     * @param waitlist_id The id fo the team to retrieve.
+     *
+     * @returns promise
+     */
+    static view<T>(waitlist_id: string): AxiosPromise<Response<T>>;
+    /**
+     * Deletes an entry from the waitlist.
+     *
+     * @see https://api.glitch.fun/api/documentation#/Waitlist%20Route/waitlistDelete
+     *
+     * @param waitlist_id The id of the team to delete.
+     * @returns promise
+     */
+    static delete<T>(waitlist_id: string): AxiosPromise<Response<T>>;
+}
+export default Teams;

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

@@ -2,7 +2,9 @@ import Auth from "./Auth";
 import Competitions from "./Competitions";
 import Users from "./Users";
 import Events from "./Events";
+import Teams from "./Teams";
 export { Auth };
 export { Competitions };
 export { Users };
 export { Events };
+export { Teams };

package/dist/esm/index.d.ts

@@ -3,13 +3,15 @@ import { Auth } from "./api";
 import { Competitions } from "./api";
 import { Users } from "./api";
 import { Events } from "./api";
+import { Teams } from "./api";
 declare class Glitch {
-    static config: typeof Config;
+    static config: Config;
     static api: {
-        Auth: typeof Auth;
-        Competitions: typeof Competitions;
-        Users: typeof Users;
-        Events: typeof Events;
+        Auth: Auth;
+        Competitions: Competitions;
+        Users: Users;
+        Events: Events;
+        Teams: Teams;
     };
 }
 export { Glitch };