glitch-javascript-sdk 0.2.0 → 0.2.2

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

@@ -0,0 +1,201 @@
+import Response from "../util/Response";
+import { AxiosPromise } from "axios";
+declare class Communities {
+    /**
+     * List all the communities.
+     *
+     * @see https://api.glitch.fun/api/documentation#/Community%20Route/resourceCommunityList
+     *
+     * @returns promise
+     */
+    static list<T>(): AxiosPromise<Response<T>>;
+    /**
+     * Create a new community.
+     *
+     * @see https://api.glitch.fun/api/documentation#/Community%20Route/newCommunityResourceStorage
+     *
+     * @param data The data to be passed when creating a community.
+     *
+     * @returns Promise
+     */
+    static create<T>(data: object): AxiosPromise<Response<T>>;
+    /**
+     * Update a community.
+     *
+     * @see https://api.glitch.fun/api/documentation#/Community%20Route/updateCommunityStorage
+     *
+     * @param community_id The id of the community to update.
+     * @param data The data to update.
+     *
+     * @returns promise
+     */
+    static update<T>(community_id: string, data: object): AxiosPromise<Response<T>>;
+    /**
+     * Retrieve the information for a single community.
+     *
+     * @see https://api.glitch.fun/api/documentation#/Community%20Route/showCommunityStorage
+     *
+     * @param community_id The id fo the community to retrieve.
+     *
+     * @returns promise
+     */
+    static view<T>(community_id: string): AxiosPromise<Response<T>>;
+    /**
+     * Deletes a community.
+     *
+     * @see https://api.glitch.fun/api/documentation#/Community%20Route/destoryCommunityStorage
+     *
+     * @param community_id The id of the community to delete.
+     * @returns promise
+     */
+    static delete<T>(community_id: string): AxiosPromise<Response<T>>;
+    /**
+     * Updates the main image for the community using a File object.
+     *
+     * @see https://api.glitch.fun/api/documentation#/Community%20Route/uploadLogoCommunityImage
+     *
+     * @param file The file object to upload.
+     * @param data Any additional data to pass along to the upload.
+     *
+     * @returns promise
+     */
+    static uploadLogoFile<T>(community_id: string, file: File, data?: object): AxiosPromise<Response<T>>;
+    /**
+     * Updates the main image for the community using a Blob.
+     *
+     * @see https://api.glitch.fun/api/documentation#/Community%20Route/uploadLogoCommunityImage
+     *
+     * @param blob The blob to upload.
+     * @param data Any additional data to pass along to the upload
+     *
+     * @returns promise
+     */
+    static uploadLogoBlob<T>(community_id: string, blob: Blob, data?: object): AxiosPromise<Response<T>>;
+    /**
+     * Updates the banner image for the community using a File object.
+     *
+     * @see https://api.glitch.fun/api/documentation#/Community%20Route/uploadBannerCommunityImage
+     *
+     * @param file The file object to upload.
+     * @param data Any additional data to pass along to the upload.
+     *
+     * @returns promise
+     */
+    static uploadBannerImageFile<T>(community_id: string, file: File, data?: object): AxiosPromise<Response<T>>;
+    /**
+     * Updates the banner image for the community using a Blob.
+     *
+     * @see https://api.glitch.fun/api/documentation#/Community%20Route/uploadBannerCommunityImage
+     *
+     * @param blob The blob to upload.
+     * @param data Any additional data to pass along to the upload
+     *
+     * @returns promise
+     */
+    static uploadBannerImageBlob<T>(community_id: string, blob: Blob, data?: object): AxiosPromise<Response<T>>;
+    /**
+    * Updates the banner image for the community using a File object.
+    *
+    * @see https://api.glitch.fun/api/documentation#/Community%20Route/uploadBannerCommunityImage
+    *
+    * @param file The file object to upload.
+    * @param data Any additional data to pass along to the upload.
+    *
+    * @returns promise
+    */
+    static uploadVideoLogoFile<T>(community_id: string, file: File, data?: object): AxiosPromise<Response<T>>;
+    /**
+     * Updates the banner image for the community using a Blob.
+     *
+     * @see https://api.glitch.fun/api/documentation#/Community%20Route/uploadBannerCommunityImage
+     *
+     * @param blob The blob to upload.
+     * @param data Any additional data to pass along to the upload
+     *
+     * @returns promise
+     */
+    static uploadVideoLogoBlob<T>(community_id: string, blob: Blob, data?: object): AxiosPromise<Response<T>>;
+    /**
+     * List the invites that have been sent for the community to users.
+     *
+     * @see https://api.glitch.fun/api/documentation#/communitys%20Route/communitysUserInviteList
+     *
+     * @param community_id The id of the community
+     *
+     * @returns promise
+     */
+    static listInvites<T>(community_id: string): AxiosPromise<Response<T>>;
+    /**
+     * Send an invitation to a user to join the community.
+     *
+     * @see https://api.glitch.fun/api/documentation#/communitys%20Route/communitySendInvite
+     *
+     * @param community_id The id of the community.
+     * @param data The data that will be passed into sending an invite.
+     *
+     * @returns promise
+     */
+    static sendInvite<T>(community_id: string, data?: object): AxiosPromise<Response<T>>;
+    /**
+     * Accept an invite to a community. The JSON Web Token (JWT) must be related to the token.
+     *
+     * @see https://api.glitch.fun/api/documentation#/communitys%20Route/communityAcceptInvite
+     *
+     * @param community_id The id of the community
+     * @param token The token required to accept the user.
+     *
+     * @returns promise
+     */
+    static acceptInvite<T>(community_id: string, token: string): AxiosPromise<Response<T>>;
+    /**
+     * List the users who are currently associated with the community.
+     *
+     * @see https://api.glitch.fun/api/documentation#/communitys%20Route/communityUserList
+     *
+     * @param community_id The id of the community.
+     *
+     * @returns promise
+     */
+    static listUsers<T>(community_id: string): AxiosPromise<Response<T>>;
+    /**
+     * Add a user to a community.
+     *
+     * @see https://api.glitch.fun/api/documentation#/communitys%20Route/createcommunityUser
+     *
+     * @param community_id The id of the community.
+     * @param data The data to be passed when adding a user.
+     *
+     * @returns promise
+     */
+    static addUser<T>(community_id: string, data?: object): AxiosPromise<Response<T>>;
+    /**
+     * Retrieves a single user and their information that is associated with a community.
+     *
+     * @see https://api.glitch.fun/api/documentation#/communitys%20Route/showcommunityUser
+     *
+     * @param community_id The id of the community.
+     * @param user_id The id of the user.
+     *
+     * @returns promise
+     */
+    static getUser<T>(community_id: string, user_id: string): AxiosPromise<Response<T>>;
+    /**
+     * Updates the users information associated with the community.
+     *
+     * @param community_id The id of the community.
+     * @param user_id The id of the user.
+     *
+     * @returns promise
+     */
+    static updatetUser<T>(community_id: string, user_id: string, data?: object): AxiosPromise<Response<T>>;
+    /**
+     * Removes a user from a community.
+     *
+     * @param community_id The id of community.
+     * @param user_id The id of the user.
+     *
+     * @returns promise
+     */
+    static removetUser<T>(community_id: string, user_id: string): AxiosPromise<Response<T>>;
+}
+export default Communities;

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

@@ -0,0 +1,97 @@
+import Response from "../util/Response";
+import { AxiosPromise } from "axios";
+declare class Templates {
+    /**
+     * List all the templates.
+     *
+     * @see https://api.glitch.fun/api/documentation#/Template%20Route/resourceTemplateList
+     *
+     * @returns promise
+     */
+    static list<T>(): AxiosPromise<Response<T>>;
+    /**
+     * Create a new template.
+     *
+     * @see https://api.glitch.fun/api/documentation#/Template%20Route/newTemplateResourceStorage
+     *
+     * @param data The data to be passed when creating a template.
+     *
+     * @returns Promise
+     */
+    static create<T>(data: object): AxiosPromise<Response<T>>;
+    /**
+     * Update a template.
+     *
+     * @see https://api.glitch.fun/api/documentation#/Template%20Route/updateTemplateStorage
+     *
+     * @param template_id The id of the template to update.
+     * @param data The data to update.
+     *
+     * @returns promise
+     */
+    static update<T>(template_id: string, data: object): AxiosPromise<Response<T>>;
+    /**
+     * Retrieve the information for a single template.
+     *
+     * @see https://api.glitch.fun/api/documentation#/Template%20Route/showTemplateStorage
+     *
+     * @param template_id The id fo the template to retrieve.
+     *
+     * @returns promise
+     */
+    static view<T>(template_id: string): AxiosPromise<Response<T>>;
+    /**
+     * Deletes a template.
+     *
+     * @see https://api.glitch.fun/api/documentation#/Template%20Route/destoryTemplateStorage
+     *
+     * @param template_id The id of the template to delete.
+     * @returns promise
+     */
+    static delete<T>(template_id: string): AxiosPromise<Response<T>>;
+    /**
+     * Updates the logo for the template using a File object.
+     *
+     * @see https://api.glitch.fun/api/documentation#/Template%20Route/uploadLogoTemplateImage
+     *
+     * @param file The file object to upload.
+     * @param data Any additional data to pass along to the upload.
+     *
+     * @returns promise
+     */
+    static uploadLogoFile<T>(template_id: string, file: File, data?: object): AxiosPromise<Response<T>>;
+    /**
+     * Updates the logo for the template using a Blob.
+     *
+     * @see https://api.glitch.fun/api/documentation#/Template%20Route/uploadLogoTemplateImage
+     *
+     * @param blob The blob to upload.
+     * @param data Any additional data to pass along to the upload
+     *
+     * @returns promise
+     */
+    static uploadLogoBlob<T>(template_id: string, blob: Blob, data?: object): AxiosPromise<Response<T>>;
+    /**
+     * Updates the main image for the template using a File object.
+     *
+     * @see https://api.glitch.fun/api/documentation#/Template%20Route/uploadMainTemplateImage
+     *
+     * @param file The file object to upload.
+     * @param data Any additional data to pass along to the upload.
+     *
+     * @returns promise
+     */
+    static uploadMainImageFile<T>(template_id: string, file: File, data?: object): AxiosPromise<Response<T>>;
+    /**
+     * Updates the main image for the template using a Blob.
+     *
+     * @see https://api.glitch.fun/api/documentation#/Template%20Route/uploadMainTemplateImage
+     *
+     * @param blob The blob to upload.
+     * @param data Any additional data to pass along to the upload
+     *
+     * @returns promise
+     */
+    static uploadMainImageBlob<T>(template_id: string, blob: Blob, data?: object): AxiosPromise<Response<T>>;
+}
+export default Templates;

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

@@ -1,12 +1,16 @@
 import Auth from "./Auth";
 import Competitions from "./Competitions";
+import Communities from "./Communities";
 import Users from "./Users";
 import Events from "./Events";
 import Teams from "./Teams";
 import Waitlists from "./Waitlist";
+import Templates from "./Templates";
 export { Auth };
 export { Competitions };
+export { Communities };
 export { Users };
 export { Events };
 export { Teams };
 export { Waitlists };
+export { Templates };

package/dist/esm/index.d.ts

@@ -1,9 +1,11 @@
 import { Config } from "./config";
 import Auth from "./api/Auth";
 import Competitions from "./api/Competitions";
+import { Communities } from "./api";
 import { Users } from "./api";
 import { Events } from "./api";
 import { Teams } from "./api";
+import { Templates } from "./api";
 import { Waitlists } from "./api";
 import Requests from "./util/Requests";
 import Parser from "./util/Parser";
@@ -24,9 +26,11 @@ declare class Glitch {
     static api: {
         Auth: typeof Auth;
         Competitions: typeof Competitions;
+        Communities: typeof Communities;
         Users: typeof Users;
         Events: typeof Events;
         Teams: typeof Teams;
+        Templates: typeof Templates;
         Waitlists: typeof Waitlists;
     };
     static util: {