glitch-javascript-sdk 0.0.2 → 0.0.3

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

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

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

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

package/dist/index.d.ts

@@ -106,10 +106,125 @@ declare class Competitions {
     static delete<T>(competition_id: string): AxiosPromise<Response<T>>;
 }
 
+declare class Users {
+    /**
+     * List all the users.
+     *
+     * @see https://api.glitch.fun/api/documentation#/Users%20Route/userList
+     *
+     * @returns promise
+     */
+    static list<T>(): AxiosPromise<Response<T>>;
+    /**
+     * Updates a users information. Requires the users JSON Web Token (JWT) for them to update their profile.
+     *
+     * @see https://api.glitch.fun/api/documentation#/Users%20Route/updateUser
+     *
+     * @param data The date to be passed when creating a competiton.
+     *
+     * @returns Promise
+     */
+    static update<T>(data: object): AxiosPromise<Response<T>>;
+    /**
+     * Gets the current users information based on the current Json Web Token (JWT).
+     *
+     * @see https://api.glitch.fun/api/documentation#/Users%20Route/showMe
+     *
+     * @param user_id The id of the user to update.
+     * @param data The data to update.
+     *
+     * @returns promise
+     */
+    static me<T>(): AxiosPromise<Response<T>>;
+    /**
+     * Will follow and unfollow a user. If the user is not being following, it will follow the user. If they are following, it will unfollow the user. The current JWT is used for the follower.
+     *
+     * @see https://api.glitch.fun/api/documentation#/Users%20Route/userToggleFollow
+     *
+     * @param user_id The id fo the user to retrieve.
+     *
+     * @returns promise
+     */
+    static followToggle<T>(user_id: string): AxiosPromise<Response<T>>;
+    /**
+     * Show a users profile.
+     *
+     * @see https://api.glitch.fun/api/documentation#/Users%20Route/showUser
+     *
+     * @param user_id The id of the user to delete.
+     * @returns promise
+     */
+    static profile<T>(user_id: string): AxiosPromise<Response<T>>;
+    /**
+     * Retrieves a user's one time login token based on a users JWT.
+     *
+     * @see https://api.glitch.fun/api/documentation#/Users%20Route/userOneTimeLoginToken
+     *
+     *
+     * @returns promise
+     */
+    static oneTimeLoginToken<T>(): AxiosPromise<Response<T>>;
+}
+
+declare class Events {
+    /**
+     * List all the events
+     *
+     * @see https://api.glitch.fun/api/documentation#/Event%20Route/resourceEventList
+     *
+     * @returns promise
+     */
+    static list<T>(): AxiosPromise<Response<T>>;
+    /**
+     * Create a new event.
+     *
+     * @see https://api.glitch.fun/api/documentation#/Event%20Route/newEventResourceStorage
+     *
+     * @param data The data to be passed when creating an event.
+     *
+     * @returns Promise
+     */
+    static create<T>(data: object): AxiosPromise<Response<T>>;
+    /**
+     * Update a event
+     *
+     * @see https://api.glitch.fun/api/documentation#/Event%20Route/updateEventStorage
+     *
+     * @param event_id The id of the event to update.
+     * @param data The data to update.
+     *
+     * @returns promise
+     */
+    static update<T>(event_id: string, data: object): AxiosPromise<Response<T>>;
+    /**
+     * Retrieve the information for a single event.
+     *
+     * @see https://api.glitch.fun/api/documentation#/Event%20Route/showEventStorage
+     *
+     * @param event_id The id fo the event to retrieve.
+     *
+     * @returns promise
+     */
+    static view<T>(event_id: string): AxiosPromise<Response<T>>;
+    /**
+     * Deletes a event.
+     *
+     * @see https://api.glitch.fun/api/documentation#/Event%20Route/destoryEventStorage
+     *
+     * @param event_id The id of the event to delete.
+     * @returns promise
+     */
+    static delete<T>(event_id: string): AxiosPromise<Response<T>>;
+}
+
 declare class Glitch {
     static config: typeof Config;
-    static auth: typeof Auth;
-    static competitions: typeof Competitions;
+    static api: {
+        Auth: typeof Auth;
+        Competitions: typeof Competitions;
+        Users: typeof Users;
+        Events: typeof Events;
+    };
 }
 
 export { Glitch };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "glitch-javascript-sdk",
-  "version": "0.0.2",
+  "version": "0.0.3",
   "description": "Javascrip SDK for GLitch",
   "main": "dist/cjs/index.js",
   "module": "dist/esm/index.js",

package/src/api/Events.ts

@@ -0,0 +1,81 @@
+import EventsRoutes from "../routes/EventsRoute";
+import Requests from "../util/Requests";
+import Response from "../util/Response";
+import { AxiosPromise } from "axios";
+
+class Events {
+
+    /**
+     * List all the events
+     * 
+     * @see https://api.glitch.fun/api/documentation#/Event%20Route/resourceEventList
+     * 
+     * @returns promise
+     */
+    public static list<T>() :  AxiosPromise<Response<T>> {
+        return Requests.processRoute(EventsRoutes.routes.list);
+    }
+
+    /**
+     * Create a new event.
+     * 
+     * @see https://api.glitch.fun/api/documentation#/Event%20Route/newEventResourceStorage
+     * 
+     * @param data The data to be passed when creating an event.
+     * 
+     * @returns Promise
+     */
+    public static create<T>(data : object) :  AxiosPromise<Response<T>> {
+
+        return Requests.processRoute(EventsRoutes.routes.create, data);
+    }
+
+    /**
+     * Update a event
+     * 
+     * @see https://api.glitch.fun/api/documentation#/Event%20Route/updateEventStorage
+     * 
+     * @param event_id The id of the event to update.
+     * @param data The data to update.
+     * 
+     * @returns promise
+     */
+    public static update<T>(event_id : string, data : object)  :  AxiosPromise<Response<T>>{
+
+        return Requests.processRoute(EventsRoutes.routes.create, data, {event_id : event_id});
+    }
+
+    /**
+     * Retrieve the information for a single event.
+     * 
+     * @see https://api.glitch.fun/api/documentation#/Event%20Route/showEventStorage
+     * 
+     * @param event_id The id fo the event to retrieve.
+     * 
+     * @returns promise
+     */
+    public static view<T>(event_id : string) :  AxiosPromise<Response<T>> {
+
+        return Requests.processRoute(EventsRoutes.routes.view, {}, {event_id : event_id});
+    }
+
+    /**
+     * Deletes a event.
+     * 
+     * @see https://api.glitch.fun/api/documentation#/Event%20Route/destoryEventStorage
+     * 
+     * @param event_id The id of the event to delete.
+     * @returns promise
+     */
+    public static delete<T>(event_id : string) :  AxiosPromise<Response<T>> {
+
+        return Requests.processRoute(EventsRoutes.routes.delete, {}, {event_id : event_id});
+    }
+
+    
+
+    
+
+}
+
+export default Events;

package/src/api/Users.ts

@@ -0,0 +1,92 @@
+import UserRoutes from "../routes/UserRoutes";
+import Requests from "../util/Requests";
+import Response from "../util/Response";
+import { AxiosPromise } from "axios";
+
+class Users {
+
+    /**
+     * List all the users.
+     * 
+     * @see https://api.glitch.fun/api/documentation#/Users%20Route/userList
+     * 
+     * @returns promise
+     */
+    public static list<T>(): AxiosPromise<Response<T>> {
+        return Requests.processRoute(UserRoutes.routes.list);
+    }
+
+    /**
+     * Updates a users information. Requires the users JSON Web Token (JWT) for them to update their profile.
+     * 
+     * @see https://api.glitch.fun/api/documentation#/Users%20Route/updateUser
+     * 
+     * @param data The date to be passed when creating a competiton.
+     * 
+     * @returns Promise
+     */
+    public static update<T>(data: object): AxiosPromise<Response<T>> {
+
+        return Requests.processRoute(UserRoutes.routes.update, data);
+    }
+
+    /**
+     * Gets the current users information based on the current Json Web Token (JWT).
+     * 
+     * @see https://api.glitch.fun/api/documentation#/Users%20Route/showMe
+     * 
+     * @param user_id The id of the user to update.
+     * @param data The data to update.
+     * 
+     * @returns promise
+     */
+    public static me<T>(): AxiosPromise<Response<T>> {
+
+        return Requests.processRoute(UserRoutes.routes.me, {});
+    }
+
+    /**
+     * Will follow and unfollow a user. If the user is not being following, it will follow the user. If they are following, it will unfollow the user. The current JWT is used for the follower.
+     * 
+     * @see https://api.glitch.fun/api/documentation#/Users%20Route/userToggleFollow
+     * 
+     * @param user_id The id fo the user to retrieve.
+     * 
+     * @returns promise
+     */
+    public static followToggle<T>(user_id: string): AxiosPromise<Response<T>> {
+
+        return Requests.processRoute(UserRoutes.routes.follow, {}, { user_id: user_id });
+    }
+
+    /**
+     * Show a users profile.
+     * 
+     * @see https://api.glitch.fun/api/documentation#/Users%20Route/showUser
+     * 
+     * @param user_id The id of the user to delete.
+     * @returns promise
+     */
+    public static profile<T>(user_id: string): AxiosPromise<Response<T>> {
+
+        return Requests.processRoute(UserRoutes.routes.profile, {}, { user_id: user_id });
+    }
+
+    /**
+     * Retrieves a user's one time login token based on a users JWT.
+     * 
+     * @see https://api.glitch.fun/api/documentation#/Users%20Route/userOneTimeLoginToken
+     * 
+     * 
+     * @returns promise
+     */
+    public static oneTimeLoginToken<T>(): AxiosPromise<Response<T>> {
+
+        return Requests.processRoute(UserRoutes.routes.oneTimeToken, {});
+    }
+
+
+
+}
+
+export default Users;

package/src/api/index.ts

@@ -1,5 +1,9 @@
 import Auth from "./Auth";
 import Competitions from "./Competitions";
+import Users from "./Users";
+import Events from "./Events";
 
 export {Auth};
-export {Competitions};
+export {Competitions};
+export {Users};
+export {Events};

package/src/index.ts

@@ -5,13 +5,19 @@ import Config from "./config/Config";
 //API
 import { Auth } from "./api";
 import { Competitions } from "./api";
+import { Users } from "./api";
+import {Events} from "./api";
 
 class Glitch {
 
     public static config: typeof Config = Config;
 
-    public static auth: typeof Auth = Auth;
-    public static competitions: typeof Competitions = Competitions;
+    public static api : {
+        Auth : typeof Auth,
+        Competitions: typeof Competitions,
+        Users: typeof Users
+        Events : typeof Events
+    }
 
 
   }

package/src/routes/EventsRoute.ts

@@ -0,0 +1,33 @@
+import Route from "./interface";
+import HTTP_METHODS from "../constants/HttpMethods";
+
+class EventsRoutes {
+    
+    public static routes: { [key: string]: Route } = {
+      list: { url: '/events', method: HTTP_METHODS.GET },
+      create: { url: '/events', method: HTTP_METHODS.POST  },
+      view : { url: '/events/{event_id}', method: HTTP_METHODS.GET  },
+      update  :{ url: '/events/{event_id}', method: HTTP_METHODS.PUT  },
+      delete : { url: '/events/{event_id}', method: HTTP_METHODS.DELETE },
+      updateInvirtu : {url : '/events/{uuid}/invirtu', method: HTTP_METHODS.PUT },
+      updateRTMPSource : {url : '/events/{uuid}/updateRTMPSource/{subid}', method: HTTP_METHODS.PUT },
+      removeRTMPSource : {url : '/events/{uuid}/removeRTMPSource/{subid}', method: HTTP_METHODS.DELETE},
+      uploadMainImage : {url : '/events/{uuid}/removeRTMPSource/{subid}', method: HTTP_METHODS.POST},
+      uploadBannerImage : {url : '/events/{uuid}/uploadBannerImage', method: HTTP_METHODS.POST},
+      enableBroadcastMode : {url : '/events/{uuid}/uploadBannerImage', method: HTTP_METHODS.POST},
+      enableLiestreamMode  : {url : '/events/{uuid}/enableLivestreamMode', method: HTTP_METHODS.POST},
+      sendOnScreenContent : {url : '/events/{uuid}/sendOnScreenContent', method: HTTP_METHODS.POST},
+      addOveleray : {url : '/events/{uuid}/addOverlay', method : HTTP_METHODS.POST},
+      removeOverlay : {url : '/events/{uuid}/removeOverlay/{subid}',  method : HTTP_METHODS.DELETE},
+      enableOverlay : {url : '/events/{uuid}/enableOverlay/{subid}', method : HTTP_METHODS.POST},
+      disableOverlay : {url : '/events/{uuid}/disableOverlay', method: HTTP_METHODS.POST},
+      enableDonations : {url : '/events/{uuid}/enableDonations', method: HTTP_METHODS.POST},
+      disableDonations : {url : '/events/{uuid}/disableDonations', method : HTTP_METHODS.POST},
+      sendInvite : {url : '/events/{uuid}/sendInvite', method : HTTP_METHODS.POST},
+      acceptInvite : {url : '/events/{uuid}/sendInvite', method : HTTP_METHODS.POST}
+
+    };
+
+  }
+
+  export default EventsRoutes;

package/src/routes/UserRoutes.ts

@@ -0,0 +1,20 @@
+import Route from "./interface";
+import HTTP_METHODS from "../constants/HttpMethods";
+
+class UserRoutes {
+    
+    public static routes: { [key: string]: Route } = {
+      list: { url: '/users', method: HTTP_METHODS.GET },
+      update: { url: '/users', method: HTTP_METHODS.PUT  },
+      follow : { url: '/users/{user_id}/follow', method: HTTP_METHODS.POST  },
+      profile  :{ url: '/users/{uuid}/profile', method: HTTP_METHODS.GET  },
+      me : { url: '/users/me', method: HTTP_METHODS.GET },
+      oneTimeToken : { url: '/users/oneTimeToken', method: HTTP_METHODS.GET },
+      uploadAvatar : { url: '/users/uploadAvatarImage', method: HTTP_METHODS.POST },
+      uploadBanner : { url: '/users/uploadBannerImage', method: HTTP_METHODS.POST },
+      createDonationPage : { url: '/users/createDonationPage', method: HTTP_METHODS.POST },
+    };
+
+  }
+
+  export default UserRoutes;