glitch-javascript-sdk 0.2.0 → 0.2.2

package/dist/esm/routes/CommunitiesRoute.d.ts

@@ -0,0 +1,7 @@
+import Route from "./interface";
+declare class CommunitiesRoute {
+    static routes: {
+        [key: string]: Route;
+    };
+}
+export default CommunitiesRoute;

package/dist/esm/routes/TemplatesRoute.d.ts

@@ -0,0 +1,7 @@
+import Route from "./interface";
+declare class TemplatesRoute {
+    static routes: {
+        [key: string]: Route;
+    };
+}
+export default TemplatesRoute;

package/dist/index.d.ts

@@ -568,6 +568,205 @@ declare class Competitions {
     static uploadVenueMainImageBlob<T>(competition_id: string, blob: Blob, data?: object): AxiosPromise<Response<T>>;
 }
 
+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>>;
+}
+
 declare class Users {
     /**
      * List all the users.
@@ -1165,6 +1364,101 @@ declare class Waitlists {
     static delete<T>(waitlist_id: string): AxiosPromise<Response<T>>;
 }
 
+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>>;
+}
+
 interface Route {
     url: string;
     method: string;
@@ -1332,9 +1626,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: {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "glitch-javascript-sdk",
-  "version": "0.2.0",
+  "version": "0.2.2",
   "description": "Javascript SDK for Glitch",
   "main": "dist/cjs/index.js",
   "module": "dist/esm/index.js",

package/src/api/Communities.ts

@@ -0,0 +1,290 @@
+import CommunitiesRoute from "../routes/CommunitiesRoute";
+import Requests from "../util/Requests";
+import Response from "../util/Response";
+import { AxiosPromise } from "axios";
+
+class Communities {
+
+    /**
+     * List all the communities.
+     * 
+     * @see https://api.glitch.fun/api/documentation#/Community%20Route/resourceCommunityList
+     * 
+     * @returns promise
+     */
+    public static list<T>() :  AxiosPromise<Response<T>> {
+        return Requests.processRoute(CommunitiesRoute.routes.list);
+    }
+
+    /**
+     * 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
+     */
+    public static create<T>(data : object) :  AxiosPromise<Response<T>> {
+
+        return Requests.processRoute(CommunitiesRoute.routes.create, data);
+    }
+
+    /**
+     * 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
+     */
+    public static update<T>(community_id : string, data : object)  :  AxiosPromise<Response<T>>{
+
+        return Requests.processRoute(CommunitiesRoute.routes.create, data, {community_id : community_id});
+    }
+
+    /**
+     * 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
+     */
+    public static view<T>(community_id : string) :  AxiosPromise<Response<T>> {
+
+        return Requests.processRoute(CommunitiesRoute.routes.view, {}, {community_id : community_id});
+    }
+
+    /**
+     * 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
+     */
+    public static delete<T>(community_id : string) :  AxiosPromise<Response<T>> {
+
+        return Requests.processRoute(CommunitiesRoute.routes.delete, {}, {community_id : community_id});
+    }
+
+    /**
+     * 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
+     */
+    public static uploadLogoFile<T>(community_id: string, file : File, data? : object): AxiosPromise<Response<T>> {
+
+        let url = CommunitiesRoute.routes.uploadLogo.url.replace('{community_id}', community_id);
+
+        return Requests.uploadFile(url, 'image', file, data);
+    }
+
+    /**
+     * 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
+     */
+    public static uploadLogoBlob<T>(community_id: string, blob : Blob, data? : object): AxiosPromise<Response<T>> {
+
+        let url = CommunitiesRoute.routes.uploadLogo.url.replace('{community_id}', community_id);
+
+        return Requests.uploadBlob(url, 'image', blob, data);
+    }
+
+    /**
+     * 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
+     */
+    public static uploadBannerImageFile<T>(community_id: string, file : File, data? : object): AxiosPromise<Response<T>> {
+
+        let url = CommunitiesRoute.routes.uploadBannerImage.url.replace('{community_id}', community_id);
+
+        return Requests.uploadFile(url, 'image', file, data);
+    }
+
+    /**
+     * 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
+     */
+    public static uploadBannerImageBlob<T>(community_id: string, blob : Blob, data? : object): AxiosPromise<Response<T>> {
+
+        let url = CommunitiesRoute.routes.uploadBannerImage.url.replace('{community_id}', community_id);
+
+        return Requests.uploadBlob(url, 'image', blob, data);
+    }
+
+     /**
+     * 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
+     */
+     public static uploadVideoLogoFile<T>(community_id: string, file : File, data? : object): AxiosPromise<Response<T>> {
+
+        let url = CommunitiesRoute.routes.uploadVideoLogo.url.replace('{community_id}', community_id);
+
+        return Requests.uploadFile(url, 'image', file, data);
+    }
+
+    /**
+     * 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
+     */
+    public static uploadVideoLogoBlob<T>(community_id: string, blob : Blob, data? : object): AxiosPromise<Response<T>> {
+
+        let url = CommunitiesRoute.routes.uploadVideoLogo.url.replace('{community_id}', community_id);
+
+        return Requests.uploadBlob(url, 'image', blob, data);
+    }
+
+    /**
+     * 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
+     */
+    public static listInvites<T>(community_id : string): AxiosPromise<Response<T>> {
+        return Requests.processRoute(CommunitiesRoute.routes.listInvites, {}, {community_id : community_id});  
+    }
+
+    /**
+     * 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
+     */
+    public static sendInvite<T>(community_id : string, data? : object): AxiosPromise<Response<T>> {
+        return Requests.processRoute(CommunitiesRoute.routes.sendInvite, data, {community_id : community_id});  
+    }
+
+    /**
+     * 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
+     */
+    public static acceptInvite<T>(community_id : string, token : string): AxiosPromise<Response<T>> {
+        return Requests.processRoute(CommunitiesRoute.routes.acceptInvite, {}, {community_id : community_id});  
+    }
+
+    /**
+     * 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
+     */
+    public static listUsers<T>(community_id : string): AxiosPromise<Response<T>> {
+        return Requests.processRoute(CommunitiesRoute.routes.listUsers, {}, {community_id : community_id});  
+    }
+
+    /**
+     * 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
+     */
+    public static addUser<T>(community_id : string, data? : object): AxiosPromise<Response<T>> {
+        return Requests.processRoute(CommunitiesRoute.routes.addUser, data, {community_id : community_id});  
+    }
+
+    /**
+     * 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
+     */
+    public static getUser<T>(community_id : string, user_id : string): AxiosPromise<Response<T>> {
+        return Requests.processRoute(CommunitiesRoute.routes.showUser, {}, {community_id : community_id, user_id});  
+    }
+
+    /**
+     * 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
+     */
+    public static updatetUser<T>(community_id : string, user_id : string, data? : object): AxiosPromise<Response<T>> {
+        return Requests.processRoute(CommunitiesRoute.routes.updateUser, data, {community_id : community_id, user_id});  
+    }
+
+    /**
+     * Removes a user from a community.
+     * 
+     * @param community_id The id of community. 
+     * @param user_id The id of the user.
+     * 
+     * @returns promise
+     */
+    public static removetUser<T>(community_id : string, user_id : string): AxiosPromise<Response<T>> {
+        return Requests.processRoute(CommunitiesRoute.routes.removeUser, {}, {community_id : community_id, user_id});  
+    }
+
+
+    
+
+    
+
+}
+
+export default Communities;