glitch-javascript-sdk 0.0.2 → 0.0.4

package/src/api/Events.ts

@@ -0,0 +1,379 @@
+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 });
+    }
+
+    /**
+     * The event is synced with Invirtu for the lie streams. This will allow you to update
+     * 
+     * 
+     * @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 updateInvirtuEvent<T>(event_id: string, data: object): AxiosPromise<Response<T>> {
+
+        return Requests.processRoute(EventsRoutes.routes.updateInvirtu, data, { event_id: event_id });
+    }
+
+    /**
+     * Add an RTMP source to multicast a stream too.
+     * 
+     * @see https://api.glitch.fun/api/documentation#/Event%20Route/addRTMPSource
+     * 
+     * @param event_id The id of the event.
+     * @param data The data to be passed when adding an RTMP source.
+     *  
+     * @returns promise
+     */
+    public static addRTMPSource<T>(event_id: string, data?: object): AxiosPromise<Response<T>> {
+
+        return Requests.processRoute(EventsRoutes.routes.addRTMPSource, data, { event_id: event_id });
+    }
+
+    /**
+     * Update an RTMP Source for multicasing.
+     * 
+     * @see https://api.glitch.fun/api/documentation#/Event%20Route/addRTMPSource
+     * 
+     * @param event_id The id of the event.
+     * @param data The data to be passed when adding an RTMP source.
+     *  
+     * @returns promise
+     */
+    public static updateRTMPSource<T>(event_id: string, stream_id: string, data?: object): AxiosPromise<Response<T>> {
+
+        return Requests.processRoute(EventsRoutes.routes.updateRTMPSource, data, { event_id: event_id, subid: stream_id });
+    }
+
+    /**
+     * Remove a RTMP source for multicasing.
+     * 
+     * @see https://api.glitch.fun/api/documentation#/Event%20Route/addRTMPSource
+     * 
+     * @param event_id The id of the event.
+     * @param data The data to be passed when adding an RTMP source.
+     *  
+     * @returns promise
+     */
+    public static removeRTMPSource<T>(event_id: string, stream_id: string): AxiosPromise<Response<T>> {
+
+        return Requests.processRoute(EventsRoutes.routes.removeRTMPSource, {}, { event_id: event_id, subid: stream_id });
+    }
+
+    /**
+     * A function that should be run on an interval to set the event as live when the live stream is active.
+     * 
+     * @see https://api.glitch.fun/api/documentation#/Event%20Route/syncLive
+     * 
+     * @param event_id The id of the event.
+     *  
+     * @returns promise
+     */
+    public static syncAsLive<T>(event_id: string): AxiosPromise<Response<T>> {
+
+        return Requests.processRoute(EventsRoutes.routes.syncAsLive, {}, { event_id: event_id });
+    }
+
+    /**
+         * Updates the main image for the event using a File object.
+         * 
+         * @see https://api.glitch.fun/api/documentation#/Event%20Route/uploadMainEventImage
+         * 
+         * @param file The file object to upload.
+         * @param data Any additional data to pass along to the upload.
+         * 
+         * @returns promise
+         */
+    public static uploadMainImageFile<T>(event_id: string, file: File, data?: object): AxiosPromise<Response<T>> {
+
+        let url = EventsRoutes.routes.uploadMainImage.url.replace('{event_id}', event_id);
+
+        return Requests.uploadFile(url, 'image', file, data);
+    }
+
+    /**
+     * Updates the main image for the event using a Blob.
+     * 
+     * @see https://api.glitch.fun/api/documentation#/Event%20Route/uploadMainEventImage
+     * 
+     * @param blob The blob to upload.
+     * @param data Any additional data to pass along to the upload
+     * 
+     * @returns promise
+     */
+    public static uploadMainImageBlob<T>(event_id: string, blob: Blob, data?: object): AxiosPromise<Response<T>> {
+
+        let url = EventsRoutes.routes.uploadMainImage.url.replace('{event_id}', event_id);
+
+        return Requests.uploadBlob(url, 'image', blob, data);
+    }
+
+    /**
+     * Updates the banner image for the team using a File object.
+     * 
+     * @see https://api.glitch.fun/api/documentation#/Event%20Route/uploadBannerEventImage
+     * 
+     * @param file The file object to upload.
+     * @param data Any additional data to pass along to the upload.
+     * 
+     * @returns promise
+     */
+    public static uploadBannerImageFile<T>(event_id: string, file: File, data?: object): AxiosPromise<Response<T>> {
+
+        let url = EventsRoutes.routes.uploadBannerImage.url.replace('{event_id}', event_id);
+    
+        return Requests.uploadFile(url, 'image', file, data);
+    }
+
+    /**
+     * Updates the banner image for the team using a Blob.
+     * 
+     * @see https://api.glitch.fun/api/documentation#/Event%20Route/uploadBannerEventImage
+     * 
+     * @param blob The blob to upload.
+     * @param data Any additional data to pass along to the upload
+     * 
+     * @returns promise
+     */
+    public static uploadBannerImageBlob<T>(event_id: string, blob: Blob, data?: object): AxiosPromise<Response<T>> {
+
+        let url = EventsRoutes.routes.uploadBannerImage.url.replace('{event_id}', event_id);
+
+        return Requests.uploadBlob(url, 'image', blob, data);
+    }
+
+    /**
+     * Enable Broadcast Mode. Broadcast mode is when the live stream is broadcasted from the game play through a protocol
+     * such as screen sharing.
+     * 
+     * @see https://api.glitch.fun/api/documentation#/Event%20Route/enableBroadcastMode
+     * 
+     * @param event_id The id of the event.
+     * 
+     * @returns promise
+     */
+    public static enableBroadcastMode<T>(event_id: string): AxiosPromise<Response<T>> {
+
+        return Requests.processRoute(EventsRoutes.routes.enableBroadcastMode, {}, { event_id: event_id });
+    }
+
+    /**
+     * Enable livestream mode, in which the stream will be delivered to the invirtu RTMP endpoint for
+     * streaming.
+     * 
+     * @param event_id The id of the event.
+     *  
+     * @returns promise
+     */
+    public static enableLivestreamMode<T>(event_id: string): AxiosPromise<Response<T>> {
+
+        return Requests.processRoute(EventsRoutes.routes.enableLivestreamMode, {}, { event_id: event_id });
+    }
+
+    /**
+     * Sends content that will appear on-screen to the user.
+     * 
+     * @see https://api.glitch.fun/api/documentation#/Event%20Route/sendOnScreenContent
+     * 
+     * @param event_id The id of the event.
+     * @param data The information to send on-screen.
+     * 
+     * @returns promise
+     */
+    public static sendOnScreenContent<T>(event_id: string, data : object): AxiosPromise<Response<T>> {
+
+        return Requests.processRoute(EventsRoutes.routes.enableLivestreamMode, data, { event_id: event_id });
+    }
+
+    /**
+     * Uploads an image that can be used and overlay later. A File object is used.
+     * 
+     * @see https://api.glitch.fun/api/documentation#/Event%20Route/uploadOverlayImage
+     * 
+     * @param event_id The id of the event.
+     * @param file The image as a file.
+     * @param data Any additional data to be sent in the request.
+     * 
+     * @returns promise
+     */
+    public static addOverlayAsFile<T>(event_id: string, file: File, data?: object): AxiosPromise<Response<T>> {
+
+        let url = EventsRoutes.routes.addOverlay.url.replace('{event_id}', event_id);
+    
+        return Requests.uploadFile(url, 'image', file, data);
+    }
+
+    /**
+     * Uploads an image that can be used and overlay later. A blob is used.
+     * 
+     * @see https://api.glitch.fun/api/documentation#/Event%20Route/uploadOverlayImage
+     * 
+     * @param event_id The id of the event.
+     * @param blob Image data as a blob
+     * @param data Any additional data to be sent in the request.
+     * 
+     * @returns promise
+     */
+    public static addOverlayAsBlob<T>(event_id: string, blob: Blob, data?: object): AxiosPromise<Response<T>> {
+
+        let url = EventsRoutes.routes.addOverlay.url.replace('{event_id}', event_id);
+    
+        return Requests.uploadBlob(url, 'image', blob, data);
+    }
+
+    /**
+     * Deletes an overlay image.
+     * 
+     * @see https://api.glitch.fun/api/documentation#/Event%20Route/destoryOverlayStorage
+     * 
+     * @param event_id The id of the event.
+     * @param overlay_id The id of the overlay.
+     * 
+     * @returns promise
+     */
+    public static removeOverlay<T>(event_id: string, overlay_id : string): AxiosPromise<Response<T>> {
+
+        return Requests.processRoute(EventsRoutes.routes.removeOverlay, {}, { event_id: event_id, subid : overlay_id });
+    }
+
+    /**
+     * Enables an overlay so that it will appear on screen.
+     * 
+     * @see https://api.glitch.fun/api/documentation#/Event%20Route/enableOverlayImage
+     * 
+     * @param event_id The id of the event.
+     * @param overlay_id The id of the overlay.
+     * 
+     * @returns promise
+     */
+    public static enableOverlay<T>(event_id: string, overlay_id : string): AxiosPromise<Response<T>> {
+
+        return Requests.processRoute(EventsRoutes.routes.enableOverlay, {}, { event_id: event_id, subid : overlay_id });
+    }
+
+    /**
+     * Disables the overlay so it no longer appears on-screen.
+     * 
+     * @see https://api.glitch.fun/api/documentation#/Event%20Route/disableOverlay
+     * 
+     * @param event_id The id of the event.
+     * 
+     * @returns promise
+     */
+    public static disableOverlay<T>(event_id: string): AxiosPromise<Response<T>> {
+
+        return Requests.processRoute(EventsRoutes.routes.disableOverlay, {}, { event_id: event_id });
+    }
+
+    /**
+     * Enable the donations to appear on-screen
+     * 
+     * @see https://api.glitch.fun/api/documentation#/Event%20Route/enableDonations
+     * 
+     * @param event_id The id of the event.
+     * 
+     * @returns promise
+     */
+    public static enableDonations<T>(event_id: string): AxiosPromise<Response<T>> {
+
+        return Requests.processRoute(EventsRoutes.routes.enableDonations, {}, { event_id: event_id });
+    }
+
+    /**
+     * Disable the donations and remove from the screen.
+     * 
+     * @param event_id 
+     * @returns 
+     */
+    public static disableDonations<T>(event_id: string): AxiosPromise<Response<T>> {
+
+        return Requests.processRoute(EventsRoutes.routes.disableDonations, {}, { event_id: event_id });
+    }
+
+    public static sendInvite<T>(event_id: string, data : object): AxiosPromise<Response<T>> {
+
+        return Requests.processRoute(EventsRoutes.routes.sendInvite, data, { event_id: event_id });
+    }
+
+    public static acceptInvite<T>(event_id: string, token : string): AxiosPromise<Response<T>> {
+
+        return Requests.processRoute(EventsRoutes.routes.acceptInvite, {token : token}, { event_id: event_id });
+    }
+
+
+}
+
+export default Events;

package/src/api/Teams.ts

@@ -0,0 +1,256 @@
+import TeamsRoutes from "../routes/TeamsRoute";
+import Requests from "../util/Requests";
+import Response from "../util/Response";
+import { AxiosPromise } from "axios";
+
+class Teams {
+
+    /**
+     * List all the teams
+     * 
+     * @see https://api.glitch.fun/api/documentation#/Teams%20Route/teamsList
+     * 
+     * @returns promise
+     */
+    public static list<T>() :  AxiosPromise<Response<T>> {
+        return Requests.processRoute(TeamsRoutes.routes.list);
+    }
+
+    /**
+     * 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
+     */
+    public static create<T>(data : object) :  AxiosPromise<Response<T>> {
+
+        return Requests.processRoute(TeamsRoutes.routes.create, data);
+    }
+
+    /**
+     * 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
+     */
+    public static update<T>(team_id : string, data : object)  :  AxiosPromise<Response<T>>{
+
+        return Requests.processRoute(TeamsRoutes.routes.create, data, {team_id : team_id});
+    }
+
+    /**
+     * 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
+     */
+    public static view<T>(team_id : string) :  AxiosPromise<Response<T>> {
+
+        return Requests.processRoute(TeamsRoutes.routes.view, {}, {team_id : team_id});
+    }
+
+    /**
+     * 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
+     */
+    public static delete<T>(team_id : string) :  AxiosPromise<Response<T>> {
+
+        return Requests.processRoute(TeamsRoutes.routes.delete, {}, {team_id : team_id});
+    }
+
+    /**
+     * 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
+     */
+    public static uploadMainImageFile<T>(team_id: string, file : File, data? : object): AxiosPromise<Response<T>> {
+
+        let url = TeamsRoutes.routes.uploadMainImage.url.replace('{team_id}', team_id);
+
+        return Requests.uploadFile(url, 'image', file, data);
+    }
+
+    /**
+     * 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
+     */
+    public static uploadMainImageBlob<T>(team_id: string, blob : Blob, data? : object): AxiosPromise<Response<T>> {
+
+        let url = TeamsRoutes.routes.uploadMainImage.url.replace('{team_id}', team_id);
+
+        return Requests.uploadBlob(url, 'image', blob, data);
+    }
+
+    /**
+     * 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
+     */
+    public static uploadBannerImageFile<T>(team_id: string, file : File, data? : object): AxiosPromise<Response<T>> {
+
+        let url = TeamsRoutes.routes.uploadBannerImage.url.replace('{team_id}', team_id);
+
+        return Requests.uploadFile(TeamsRoutes.routes.uploadBannerImage.url, 'image', file, data);
+    }
+
+    /**
+     * 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
+     */
+    public static uploadBannerImageBlob<T>(team_id: string, blob : Blob, data? : object): AxiosPromise<Response<T>> {
+
+        let url = TeamsRoutes.routes.uploadBannerImage.url.replace('{team_id}', team_id);
+
+        return Requests.uploadBlob(url, 'image', blob, data);
+    }
+
+    /**
+     * 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
+     */
+    public static listInvites<T>(team_id : string): AxiosPromise<Response<T>> {
+        return Requests.processRoute(TeamsRoutes.routes.listInvites, {}, {team_id : team_id});  
+    }
+
+    /**
+     * 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
+     */
+    public static sendInvite<T>(team_id : string, data? : object): AxiosPromise<Response<T>> {
+        return Requests.processRoute(TeamsRoutes.routes.sendInvite, data, {team_id : team_id});  
+    }
+
+    /**
+     * 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
+     */
+    public static acceptInvite<T>(team_id : string, token : string): AxiosPromise<Response<T>> {
+        return Requests.processRoute(TeamsRoutes.routes.acceptInvite, {}, {team_id : team_id});  
+    }
+
+    /**
+     * 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
+     */
+    public static listUsers<T>(team_id : string): AxiosPromise<Response<T>> {
+        return Requests.processRoute(TeamsRoutes.routes.listTeamUsers, {}, {team_id : team_id});  
+    }
+
+    /**
+     * 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
+     */
+    public static addUser<T>(team_id : string, data? : object): AxiosPromise<Response<T>> {
+        return Requests.processRoute(TeamsRoutes.routes.addTeamUser, data, {team_id : team_id});  
+    }
+
+    /**
+     * 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
+     */
+    public static getUser<T>(team_id : string, user_id : string): AxiosPromise<Response<T>> {
+        return Requests.processRoute(TeamsRoutes.routes.showTeamUser, {}, {team_id : team_id, user_id});  
+    }
+
+    /**
+     * 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
+     */
+    public static updatetUser<T>(team_id : string, user_id : string, data? : object): AxiosPromise<Response<T>> {
+        return Requests.processRoute(TeamsRoutes.routes.updateTeamUser, data, {team_id : team_id, user_id});  
+    }
+
+    /**
+     * Removes a user from a team.
+     * 
+     * @param team_id The id of team. 
+     * @param user_id The id of the user.
+     * 
+     * @returns promise
+     */
+    public static removetUser<T>(team_id : string, user_id : string): AxiosPromise<Response<T>> {
+        return Requests.processRoute(TeamsRoutes.routes.removeTeamUser, {}, {team_id : team_id, user_id});  
+    }
+
+
+    
+
+    
+
+}
+
+export default Teams;